6 #pragma GCC diagnostic push
7 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
8 #define _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES 1
9 #include <xmlrpc-c/base.hpp>
10 #include <xmlrpc-c/registry.hpp>
11 #include <xmlrpc-c/server_abyss.hpp>
12 #include <xmlrpc-c/girerr.hpp>
13 #include <xmlrpc-c/client_simple.hpp>
14 #undef _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES
15 #pragma GCC diagnostic pop
21 #define TRACE_NAME "xmlrpc_commander"
24 #include "artdaq-core/Utilities/ExceptionHandler.hh"
25 #include <sys/socket.h>
26 #include <netinet/in.h>
31 #include "canvas/Persistency/Provenance/RunID.h"
32 #include "fhiclcpp/make_ParameterSet.h"
34 #include "artdaq/ExternalComms/xmlrpc_commander.hh"
35 #include "artdaq/DAQdata/Globals.hh"
44 env_wrap() { xmlrpc_env_init(&this->env_c); };
45 ~
env_wrap() { xmlrpc_env_clean(&this->env_c); };
49 static xmlrpc_c::paramList
50 pListFromXmlrpcArray(xmlrpc_value *
const arrayP)
53 XMLRPC_ASSERT_ARRAY_OK(arrayP);
54 unsigned int const arraySize = xmlrpc_array_size(&env.env_c, arrayP);
55 assert(!env.env_c.fault_occurred);
56 xmlrpc_c::paramList paramList(arraySize);
57 for (
unsigned int i = 0; i < arraySize; ++i) {
58 xmlrpc_value * arrayItemP;
59 xmlrpc_array_read_item(&env.env_c, arrayP, i, &arrayItemP);
60 assert(!env.env_c.fault_occurred);
61 paramList.add(xmlrpc_c::value(arrayItemP));
62 xmlrpc_DECREF(arrayItemP);
67 c_executeMethod(xmlrpc_env *
const envP,
68 xmlrpc_value *
const paramArrayP,
69 void *
const methodPtr,
70 void *
const callInfoPtr)
72 xmlrpc_c::method *
const methodP(static_cast<xmlrpc_c::method *>(methodPtr));
73 xmlrpc_c::paramList
const paramList(pListFromXmlrpcArray(paramArrayP));
74 xmlrpc_c::callInfo *
const callInfoP(static_cast<xmlrpc_c::callInfo *>(callInfoPtr));
75 xmlrpc_value * retval;
78 xmlrpc_c::value result;
80 xmlrpc_c::method2 *
const method2P(dynamic_cast<xmlrpc_c::method2 *>(methodP));
82 method2P->execute(paramList, callInfoP, &result);
84 methodP->execute(paramList, &result);
86 catch (xmlrpc_c::fault
const& fault) {
87 xmlrpc_env_set_fault(envP, fault.getCode(),
88 fault.getDescription().c_str());
90 if (!envP->fault_occurred) {
91 if (result.isInstantiated())
92 retval = result.cValue();
94 girerr::throwf(
"Xmlrpc-c user's xmlrpc_c::method object's "
95 "'execute method' failed to set the RPC result "
99 catch (std::exception
const& e) {
100 xmlrpc_faultf(envP,
"Unexpected error executing code for "
101 "particular method, detected by Xmlrpc-c "
102 "method registry code. Method did not "
103 "fail; rather, it did not complete at all. %s",
107 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
108 "Unexpected error executing code for "
109 "particular method, detected by Xmlrpc-c "
110 "method registry code. Method did not "
111 "fail; rather, it did not complete at all.");
127 const std::string& helpText =
"execute request")
129 std::string msg(
"Exception when trying to ");
130 msg.append(helpText);
132 msg.append(er.what());
133 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
144 const std::string& helpText)
146 std::string msg(
"Exception when trying to ");
147 msg.append(helpText);
149 msg.append(er.what());
150 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
161 const std::string& helpText)
163 std::string msg(
"Exception when trying to ");
164 msg.append(helpText);
166 msg.append(er.what());
167 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
178 const std::string& helpText)
180 std::string msg(
"Exception when trying to ");
181 msg.append(helpText);
184 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
206 class cmd_ :
public xmlrpc_c::method
219 _signature = signature;
228 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
final;
239 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value*
const retvalP) = 0;
250 template <
typename T>
251 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
276 template <
typename T>
277 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
283 template <
typename T>
286 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
298 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
300 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as uint64_t.";
301 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
302 return boost::lexical_cast<uint64_t>(paramList.getString(index));
314 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
316 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as string.";
317 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
318 return static_cast<std::string
>(paramList.getString(index));
330 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
332 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as Run Number.";
333 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
334 std::string run_number_string = paramList.getString(index);
335 art::RunNumber_t run_number =
336 boost::lexical_cast<art::RunNumber_t>(run_number_string);
337 art::RunID run_id(run_number);
351 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
353 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
354 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
355 std::string configString = std::string(paramList.getString(index).c_str());
356 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
357 fhicl::ParameterSet pset;
361 fhicl::make_ParameterSet(configString, pset);
363 catch (fhicl::exception e)
365 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
367 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
368 setenv(
"FHICL_FILE_PATH",
".", 0);
370 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
371 fhicl::make_ParameterSet(configString, lookup_policy, pset);
374 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
378 template <
typename T>
382 T val = default_value;
386 val = getParam<T>(paramList, index);
388 catch (
const cet::exception& exception)
397 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
399 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::chrono::milliseconds(250));
416 if (!retvalP->isInstantiated())
418 *retvalP = xmlrpc_c::value_string(
"Success");
424 *retvalP = xmlrpc_c::value_string(problemReport);
427 catch (std::runtime_error& er)
430 *retvalP = xmlrpc_c::value_string(msg);
431 TLOG(TLVL_ERROR) << msg ;
433 catch (art::Exception& er)
436 *retvalP = xmlrpc_c::value_string(msg);
437 TLOG(TLVL_ERROR) << msg ;
439 catch (cet::exception& er)
442 *retvalP = xmlrpc_c::value_string(msg);
443 TLOG(TLVL_ERROR) << msg ;
448 *retvalP = xmlrpc_c::value_string(msg);
449 TLOG(TLVL_ERROR) << msg ;
454 *retvalP = xmlrpc_c::value_string(
"busy");
467 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
469 class NAME ## _: public cmd_ { \
475 explicit NAME ## _(xmlrpc_commander& c): \
476 cmd_(c, "s:sii", DESCRIPTION) {} \
479 static const uint64_t defaultTimeout = 45; \
481 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
484 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP ) { \
485 fhicl::ParameterSet ps; \
487 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
489 *retvalP = xmlrpc_c::value_string ("The "#NAME" message requires a single argument that is a string containing the initialization ParameterSet"); \
493 return _c._commandable.CALL(ps, \
494 getParam<uint64_t>(paramList, 1, defaultTimeout), \
495 getParam<uint64_t>(paramList, 2, defaultTimestamp) \
500 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
502 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
504 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
506 #undef GENERATE_INIT_TRANSITION
521 cmd_(c,
"s:iii",
"start the run")
531 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
535 getParam<art::RunID>(paramList, 0);
539 *retvalP = xmlrpc_c::value_string(
"The start message requires the run number as an argument.");
559 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
561 class NAME ## _: public cmd_ { \
566 NAME ## _(xmlrpc_commander& c): \
567 cmd_(c, "s:ii", DESCRIPTION) {} \
570 static const uint64_t defaultTimeout = TIMEOUT ; \
572 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
576 bool execute_ (const xmlrpc_c::paramList& paramList , xmlrpc_c::value* const ) { \
578 return _c._commandable.CALL( getParam<uint64_t>(paramList, 0, defaultTimeout), \
579 getParam<uint64_t>(paramList, 1, defaultTimestamp) \
584 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
586 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
588 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
590 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
604 cmd_(c,
"s:i",
"shutdown the program")
612 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
636 cmd_(c,
"s:n",
"report the current state")
641 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
660 cmd_(c,
"s:s",
"report statistics")
664 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
668 getParam<std::string>(paramList, 0);
672 *retvalP = xmlrpc_c::value_string(
"The report message requires a single argument that selects the type of statistics to be reported.");
692 cmd_(c,
"s:n",
"return the currently legal commands")
696 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
699 std::string resultString;
701 for (
auto& cmd : cmdList)
703 resultString.append(cmd +
" ");
704 if (cmd ==
"shutdown")
706 resultString.append(
" reset");
709 *retvalP = xmlrpc_c::value_string(resultString);
726 cmd_(c,
"s:s",
"Get notified of a new monitor")
730 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
734 getParam<fhicl::ParameterSet>(paramList, 0);
738 *retvalP = xmlrpc_c::value_string(
"The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
758 cmd_(c,
"s:s",
"Remove a monitor")
762 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
766 getParam<std::string>(paramList, 0);
770 *retvalP = xmlrpc_c::value_string(
"The unregister_monitor command expects a string representing the label of the monitor to be removed");
791 cmd_(c,
"s:ssi",
"Set TRACE mask")
795 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
799 getParam<std::string>(paramList, 0);
800 getParam<std::string>(paramList, 1);
801 getParam<uint64_t>(paramList, 2);
805 *retvalP = xmlrpc_c::value_string(
"The trace_set command expects a mask type (M, S , or T), a name (ALL for all) and a mask");
809 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<uint64_t>(paramList, 2));
824 cmd_(c,
"s:s",
"Get TRACE mask")
828 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
832 getParam<std::string>(paramList, 0);
836 *retvalP = xmlrpc_c::value_string(
"The trace_msgfacility_set command expects a name (ALL for all)");
856 cmd_(c,
"s:ss",
"Run custom command")
860 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
864 getParam<std::string>(paramList, 0);
865 getParam<std::string>(paramList, 1);
869 *retvalP = xmlrpc_c::value_string(
"The meta_command command expects a string command and a string argument");
888 cmd_(c,
"s:i",
"create a new subrun")
896 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
909 class shutdown_ :
public xmlrpc_c::registry::shutdown
912 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
914 virtual void doit(
const std::string& paramString,
void*)
const
916 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
918 << paramString <<
"\"" ;
919 _server->terminate();
922 xmlrpc_c::serverAbyss *_server;
930 , port_(ps.get<int>(
"id", 0))
931 , serverUrl_(ps.get<std::string>(
"server_url",
""))
940 xmlrpc_c::registry registry;
941 struct xmlrpc_method_info3 methodInfo;
942 memset(&methodInfo, 0,
sizeof(methodInfo));
947 #define register_method(m) register_method2(m,0x400000)
950 xmlrpc_registry ***c_registryPPP;
951 c_registryPPP = (xmlrpc_registry ***)(((
char*)®istry) +
sizeof(girmem::autoObject));
953 #define register_method2(m,ss) \
954 xmlrpc_c::method * ptr_ ## m(dynamic_cast<xmlrpc_c::method *>(new m ## _(*this))); \
955 methodInfo.methodName = "daq." #m; \
956 methodInfo.methodFunction = &c_executeMethod; \
957 methodInfo.serverInfo = ptr_ ## m; \
958 methodInfo.stackSize = ss; \
959 methodInfo.signatureString = ptr_ ## m ->signature().c_str(); \
960 methodInfo.help = ptr_ ## m ->help().c_str(); \
961 xmlrpc_env_init(&env); \
962 xmlrpc_registry_add_method3(&env,**c_registryPPP,&methodInfo); \
963 if(env.fault_occurred)throw(girerr::error(env.fault_string)); \
964 xmlrpc_env_clean(&env)
966 register_method2(init, 0x200000);
967 register_method(soft_init);
968 register_method(reinit);
969 register_method(start);
970 register_method(status);
971 register_method(report);
972 register_method(stop);
973 register_method(pause);
974 register_method(resume);
975 register_method(register_monitor);
976 register_method(unregister_monitor);
977 register_method(legal_commands);
978 register_method(trace_set);
979 register_method(trace_get);
980 register_method(meta_command);
981 register_method(rollover_subrun);
983 register_method(shutdown);
986 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
987 registry.addMethod(
"daq.reset", ptr_reset);
989 #undef register_method
1006 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1008 if (socket_file_descriptor < 0)
1010 throw cet::exception(
"xmlrpc_commander::run") <<
1011 "Problem with the socket() call; C-style errno == " <<
1012 errno <<
" (" << strerror(errno) <<
")";
1016 int retval = setsockopt(socket_file_descriptor,
1017 SOL_SOCKET, SO_REUSEADDR,
1018 &enable,
sizeof(
int));
1022 throw cet::exception(
"xmlrpc_commander::run") <<
1023 "Problem with the call to setsockopt(); C-style errno == " <<
1024 errno <<
" (" << strerror(errno) <<
")";
1027 struct sockaddr_in sockAddr;
1029 sockAddr.sin_family = AF_INET;
1030 sockAddr.sin_port = htons(port_);
1031 sockAddr.sin_addr.s_addr = 0;
1033 retval = bind(socket_file_descriptor,
1034 reinterpret_cast<struct sockaddr*>(&sockAddr),
1039 close(socket_file_descriptor);
1040 throw cet::exception(
"xmlrpc_commander::run") <<
1041 "Problem with the bind() call; C-style errno == " <<
1042 errno <<
" (" << strerror(errno) <<
")";
1045 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1048 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1049 registry.setShutdown(&shutdown_obj);
1052 TLOG(TLVL_DEBUG) <<
"running server" ;
1066 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing" ;
1067 close(socket_file_descriptor);
1071 close(socket_file_descriptor);
1072 TLOG(TLVL_DEBUG) <<
"server terminated" ;
1082 if (serverUrl_ ==
"")
1084 std::stringstream errmsg;
1085 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1086 ExceptionHandler(ExceptionHandlerRethrow::yes,
1090 xmlrpc_c::clientSimple myClient;
1091 xmlrpc_c::value result;
1095 myClient.call(serverUrl_,
"daq.register_monitor",
"s", &result, monitor_fhicl.c_str());
1099 std::stringstream errmsg;
1100 errmsg <<
"Problem attempting XML-RPC call on host " << serverUrl_
1101 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1102 ExceptionHandler(ExceptionHandlerRethrow::yes,
1106 return xmlrpc_c::value_string(result);
1111 if (serverUrl_ ==
"")
1113 std::stringstream errmsg;
1114 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1115 ExceptionHandler(ExceptionHandlerRethrow::yes,
1120 xmlrpc_c::clientSimple myClient;
1121 xmlrpc_c::value result;
1125 myClient.call(serverUrl_,
"daq.unregister_monitor",
"s", &result, monitor_label.c_str());
1129 std::stringstream errmsg;
1130 errmsg <<
"Problem attempting to unregister monitor via XML-RPC call on host " << serverUrl_
1131 <<
"; possible causes are that the monitor label \""
1133 <<
"\" is unrecognized by contacted process or process at requested port doesn't exist";
1134 ExceptionHandler(ExceptionHandlerRethrow::no, errmsg.str());
1137 return xmlrpc_c::value_string(result);
This interface defines the functions used to transfer data between artdaq applications.
cmd_(xmlrpc_commander &c, const std::string &signature, const std::string &description)
cmd_ Constructor
static const uint64_t defaultTimeout
std::string send_unregister_monitor(std::string monitor_label) override
Send an unregister_monitor command over XMLRPC
std::string send_register_monitor(std::string monitor_fhicl) override
Send a register_monitor command over XMLRPC
virtual std::string report(std::string const &) const
Default report implementation returns current report_string.
Commandable is the base class for all artdaq components which implement the artdaq state machine...
legal_commands_(xmlrpc_commander &c)
legal_commands_ Constructor
xmlrpc_commander(fhicl::ParameterSet ps, artdaq::Commandable &commandable)
xmlrpc_commander Constructor
Command class representing a start transition.
rollover_subrun_(xmlrpc_commander &c)
shutdown_ Constructor
virtual std::string unregister_monitor(std::string const &)
Perform the unregister_monitor action.
The xmlrpc_commander class serves as the XMLRPC server run in each artdaq application.
static const uint64_t defaultTimestamp
The "cmd_" class serves as the base class for all artdaq's XML-RPC commands.
trace_set_(xmlrpc_commander &c)
unregister_monitor_ Constructor
void run_server() override
Run the XMLRPC server.
std::unique_ptr< xmlrpc_c::serverAbyss > server
XMLRPC server.
std::string status() const
Returns the current state of the Commandable.
std::string exception_msg(const std::runtime_error &er, const std::string &helpText="execute request")
Write an exception message.
virtual bool do_trace_set(std::string const &type, std::string const &name, uint64_t mask)
Set the given TRACE mask for the given TRACE name.
static const uint64_t defaultSequenceID
virtual std::string register_monitor(fhicl::ParameterSet const &)
Perform the register_monitor action.
virtual bool do_meta_command(std::string const &command, std::string const &args)
Run a module-defined command with the given parameter string.
register_monitor_ Command class
legal_commands_ Command class
artdaq::Commandable & _commandable
Reference to the Commandable that this Commander Commands.
xmlrpc_commander & _c
The xmlrpc_commander instance that the command will be sent to.
status_(xmlrpc_commander &c)
status_ Constructor
virtual bool execute_(const xmlrpc_c::paramList &, xmlrpc_c::value *const retvalP)=0
"execute_" is a wrapper function around the call to the commandable object's function ...
Wrapper for XMLRPC environment construction/destruction
std::timed_mutex mutex_
XMLRPC mutex.
register_monitor_(xmlrpc_commander &c)
register_monitor_ Constructor
static const uint64_t defaultTimeout
unregister_monitor_(xmlrpc_commander &c)
unregister_monitor_ Constructor
void execute(const xmlrpc_c::paramList ¶mList, xmlrpc_c::value *const retvalP) final
Execute trhe command with the given parameters.
shutdown_(xmlrpc_commander &c)
shutdown_ Constructor
virtual bool do_rollover_subrun(uint64_t eventNum)
Perform the rollover_subrun transition.
std::vector< std::string > legal_commands() const
Get the legal transition commands from the current state.
rollover_subrun_ Command class
bool start(art::RunID id, uint64_t timeout, uint64_t timestamp)
Processes the start transition.
report_(xmlrpc_commander &c)
report_ Constructor
start_(xmlrpc_commander &c)
start_ Command (cmd_ derived class) Constructor
virtual std::string do_trace_get(std::string const &name)
Get the TRACE mask for the given TRACE name If name is "ALL", then all TRACE masks will be printed...
trace_get_(xmlrpc_commander &c)
trace_msgfacility_set_ Constructor
unregister_monitor_ Command class
T getParam(const xmlrpc_c::paramList ¶mList, int index)
Get a parameter from the parameter list.
bool shutdown(uint64_t timeout)
Processes the shutdown transition.