margo_state_dump is only currently available in margo@master, hence we cannot compile with the latest margo release. To fix, use of margo_state_dump requires Chimbuko to be built with the --enable-margo-state-dump option.

Author: giltirn

app/provdb_admin.cpp

@@ -108,6 +108,7 @@ void client_stop_rpc(const tl::request& req) {
 
 margo_instance_id margo_id;
 
+#ifdef ENABLE_MARGO_STATE_DUMP
 void margo_dump(const std::string &stub){
   std::string fn = stub + "." + getDateTimeFileExt();
   progressStream << "ProvDB Admin: margo dump to " << fn << std::endl;
@@ -118,8 +119,7 @@ void margo_dump_rpc(const tl::request& req) {
   const static std::string stub("margo_dump");
   margo_dump(stub);
 }
-
-
+#endif
 
 
 struct ProvdbArgs{
@@ -229,9 +229,10 @@ int main(int argc, char** argv) {
     engine.define("committer_hello",committer_hello).disable_response();
     engine.define("committer_goodbye",committer_goodbye).disable_response();
     engine.define("stop_server",client_stop_rpc).disable_response();
-    engine.define("margo_dump", margo_dump_rpc).disable_response();
     engine.define("connection_status", connection_status);
-
+#ifdef ENABLE_MARGO_STATE_DUMP
+    engine.define("margo_dump", margo_dump_rpc).disable_response();
+#endif
 
     std::string addr = (std::string)engine.self();  //ip and port of admin
 
@@ -325,7 +326,9 @@ int main(int argc, char** argv) {
 	       ( !committer_has_connected || (committer_has_connected && !committer_connected) )
 	       ){
 	      progressStream << "ProvDB Admin: detected all clients disconnected, shutting down" << std::endl;
+#ifdef ENABLE_MARGO_STATE_DUMP
 	      margo_dump("margo_dump_all_client_disconnected");
+#endif
 	      break;
 	    }
 	  }
@@ -338,11 +341,15 @@ int main(int argc, char** argv) {
 	}
 
 	progressStream << "ProvDB Admin: ending admin scope" << std::endl;
+#ifdef ENABLE_MARGO_STATE_DUMP
 	margo_dump("margo_dump_end_admin_scope");
+#endif
       }//admin scope
 
       progressStream << "ProvDB Admin: ending provider scope" << std::endl;
+#ifdef ENABLE_MARGO_STATE_DUMP
       margo_dump("margo_dump_end_provide_scope");
+#endif
     }//provider scope
 
     progressStream << "ProvDB Admin: shutting down server engine" << std::endl;

app/provdb_dump_state.cpp

@@ -4,6 +4,7 @@ using namespace chimbuko;
 
 int main(int argc, char** argv){
 #ifdef ENABLE_PROVDB
+#  ifdef ENABLE_MARGO_STATE_DUMP
   if(argc != 2){
     std::cout << "Usage: provdb_dump_state <server address e.g. ofi+tcp;ofi_rxm://172.17.0.4:5000>" << std::endl;
     return 1;
@@ -14,6 +15,10 @@ int main(int argc, char** argv){
   ad.disconnect();
 
   return 0;
+#  else
+  std::cout << "Margo dump configuration option is disabled" << std::endl;
+  return 1;
+#  endif
 #else
   std::cout << "ProvDB not in use" << std::endl;
   return 1;

configure.ac

@@ -142,6 +142,12 @@ fi
 #AC_ARG_WITH([perf-metric], AS_HELP_STRING([--with-perf-metric], [Specify use of performance metrics]),[AC_DEFINE([_PERF_METRIC],[1],[Use performance metrics])],[])
 AC_ARG_WITH([perf-metric], AS_HELP_STRING([--with-perf-metric], [Specify use of performance metrics]),[PS_FLAGS+=" -D_PERF_METRIC"],[])
 
+#Enable ProvdDB margo state dump (currently requires master branch of margo)
+AC_ARG_ENABLE([margo-state-dump],
+  [AS_HELP_STRING([--enable-margo-state-dump], [Enable ProvdDB margo state dump (currently requires master branch of margo)] )],
+  [AC_DEFINE([ENABLE_MARGO_STATE_DUMP],[1],[Use margo state dump])],
+  [:]
+)
 
 #Check for boost
 AC_ARG_WITH([boost], AS_HELP_STRING([--with-boost], [Specify Boost install directory]),[],[])

include/chimbuko/ad/ADProvenanceDBclient.hpp

@@ -91,8 +91,9 @@ namespace chimbuko{
     thallium::remote_procedure *m_client_hello; /**< RPC to register client with provDB */
     thallium::remote_procedure *m_client_goodbye; /**< RPC to deregister client with provDB */
     thallium::remote_procedure *m_stop_server; /** RPC to shutdown server*/
+#ifdef ENABLE_MARGO_STATE_DUMP
     thallium::remote_procedure *m_margo_dump; /** RPC to request the server dump its state*/
-    
+#endif    
     bool m_perform_handshake; /**< Optionally disable the client->server registration */
 
     PerfStats *m_stats; /**< Performance data gathering*/
@@ -106,7 +107,11 @@ namespace chimbuko{
     void sendMultipleDataAsync(const std::vector<std::string> &entries, const ProvenanceDataType type, OutstandingRequest *req = nullptr) const;
 
   public:
-    ADProvenanceDBclient(int rank): m_is_connected(false), m_rank(rank), m_client_hello(nullptr), m_client_goodbye(nullptr), m_stats(nullptr), m_stop_server(nullptr), m_margo_dump(nullptr), m_perform_handshake(true){}
+    /**
+     * @brief Constructor
+     * @param The rank of the current process
+     */
+    ADProvenanceDBclient(int rank);
 
     ~ADProvenanceDBclient();
 
@@ -242,10 +247,12 @@ namespace chimbuko{
      */
     void stopServer() const;
 
+#ifdef ENABLE_MARGO_STATE_DUMP
     /**
      * @brief Issue an RPC request telling the server to dump its state
      */
     void serverDumpState() const;
+#endif
 
   };
 

src/ad/ADProvenanceDBclient.cpp

@@ -72,6 +72,12 @@ static void delete_rpc(thallium::remote_procedure* &rpc){
   delete rpc; rpc = nullptr;
 }
 
+ADProvenanceDBclient::ADProvenanceDBclient(int rank): m_is_connected(false), m_rank(rank), m_client_hello(nullptr), m_client_goodbye(nullptr), m_stats(nullptr), m_stop_server(nullptr), m_perform_handshake(true)
+#ifdef ENABLE_MARGO_STATE_DUMP
+    , m_margo_dump(nullptr)
+#endif
+    {}
+
 
 void ADProvenanceDBclient::disconnect(){
   if(m_is_connected){
@@ -90,8 +96,9 @@ void ADProvenanceDBclient::disconnect(){
       delete_rpc(m_client_goodbye);
     }
     delete_rpc(m_stop_server);
+#ifdef ENABLE_MARGO_STATE_DUMP
     delete_rpc(m_margo_dump);
-
+#endif
     m_is_connected = false;
     verboseStream << "ADProvenanceDBclient disconnected" << std::endl;
   }
@@ -153,7 +160,9 @@ void ADProvenanceDBclient::connect(const std::string &addr, const int nshards){
     }      
 
     m_stop_server = new thallium::remote_procedure(eng.define("stop_server").disable_response());
+#ifdef ENABLE_MARGO_STATE_DUMP
     m_margo_dump = new thallium::remote_procedure(eng.define("margo_dump").disable_response());
+#endif
 
     m_is_connected = true;
     verboseStream << "DB client rank " << m_rank << " connected successfully to database" << std::endl;
@@ -355,11 +364,12 @@ void ADProvenanceDBclient::stopServer() const{
   m_stop_server->on(m_server)();
 }
 
+#ifdef ENABLE_MARGO_STATE_DUMP
 void ADProvenanceDBclient::serverDumpState() const{
   verboseStream << "ADProvenanceDBclient requesting server dump its state" << std::endl;
   m_margo_dump->on(m_server)();
 }
-
+#endif
 
 #endif
 

test/mainProvDBclient.cpp

@@ -332,6 +332,7 @@ bool fileExistsMatchingRegex(const std::string &dir, const std::regex &regex){
   return false;
 }
 
+#ifdef ENABLE_MARGO_STATE_DUMP
 TEST(ADProvenanceDBclientTest, TestStateDump){
   if(rank == 0){
     std::regex fn(R"(margo_dump\.)");
@@ -360,7 +361,7 @@ TEST(ADProvenanceDBclientTest, TestStateDump){
     EXPECT_EQ(fail, false);
   }
 }
-
+#endif
 
 
 int main(int argc, char** argv)