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"
41 env_wrap() { xmlrpc_env_init(&this->env_c); };
42 ~
env_wrap() { xmlrpc_env_clean(&this->env_c); };
46 static xmlrpc_c::paramList
47 pListFromXmlrpcArray(xmlrpc_value *
const arrayP)
50 XMLRPC_ASSERT_ARRAY_OK(arrayP);
51 unsigned int const arraySize = xmlrpc_array_size(&env.env_c, arrayP);
52 assert(!env.env_c.fault_occurred);
53 xmlrpc_c::paramList paramList(arraySize);
54 for (
unsigned int i = 0; i < arraySize; ++i) {
55 xmlrpc_value * arrayItemP;
56 xmlrpc_array_read_item(&env.env_c, arrayP, i, &arrayItemP);
57 assert(!env.env_c.fault_occurred);
58 paramList.add(xmlrpc_c::value(arrayItemP));
59 xmlrpc_DECREF(arrayItemP);
64 c_executeMethod(xmlrpc_env *
const envP,
65 xmlrpc_value *
const paramArrayP,
66 void *
const methodPtr,
67 void *
const callInfoPtr)
69 xmlrpc_c::method *
const methodP(static_cast<xmlrpc_c::method *>(methodPtr));
70 xmlrpc_c::paramList
const paramList(pListFromXmlrpcArray(paramArrayP));
71 xmlrpc_c::callInfo *
const callInfoP(static_cast<xmlrpc_c::callInfo *>(callInfoPtr));
72 xmlrpc_value * retval;
75 xmlrpc_c::value result;
77 xmlrpc_c::method2 *
const method2P(dynamic_cast<xmlrpc_c::method2 *>(methodP));
79 method2P->execute(paramList, callInfoP, &result);
81 methodP->execute(paramList, &result);
83 catch (xmlrpc_c::fault
const& fault) {
84 xmlrpc_env_set_fault(envP, fault.getCode(),
85 fault.getDescription().c_str());
87 if (!envP->fault_occurred) {
88 if (result.isInstantiated())
89 retval = result.cValue();
91 girerr::throwf(
"Xmlrpc-c user's xmlrpc_c::method object's "
92 "'execute method' failed to set the RPC result "
96 catch (std::exception
const& e) {
97 xmlrpc_faultf(envP,
"Unexpected error executing code for "
98 "particular method, detected by Xmlrpc-c "
99 "method registry code. Method did not "
100 "fail; rather, it did not complete at all. %s",
104 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
105 "Unexpected error executing code for "
106 "particular method, detected by Xmlrpc-c "
107 "method registry code. Method did not "
108 "fail; rather, it did not complete at all.");
124 const std::string& helpText =
"execute request")
126 std::string msg(
"Exception when trying to ");
127 msg.append(helpText);
129 msg.append(er.what());
130 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
141 const std::string& helpText)
143 std::string msg(
"Exception when trying to ");
144 msg.append(helpText);
146 msg.append(er.what());
147 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
158 const std::string& helpText)
160 std::string msg(
"Exception when trying to ");
161 msg.append(helpText);
163 msg.append(er.what());
164 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
175 const std::string& helpText)
177 std::string msg(
"Exception when trying to ");
178 msg.append(helpText);
181 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
203 class cmd_ :
public xmlrpc_c::method
216 _signature = signature;
225 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
final;
236 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value*
const retvalP) = 0;
247 template <
typename T>
248 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
273 template <
typename T>
274 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
280 template <
typename T>
283 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
295 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
297 return boost::lexical_cast<uint64_t>(paramList.getInt(index));
309 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
311 return static_cast<std::string
>(paramList.getString(index));
323 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
325 std::string run_number_string = paramList.getString(index);
326 art::RunNumber_t run_number =
327 boost::lexical_cast<art::RunNumber_t>(run_number_string);
328 art::RunID run_id(run_number);
342 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
344 std::string configString = std::string(paramList.getString(index).c_str());
345 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
346 fhicl::ParameterSet pset;
350 fhicl::make_ParameterSet(configString, pset);
352 catch (fhicl::exception e)
354 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
356 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
357 setenv(
"FHICL_FILE_PATH",
".", 0);
359 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
360 fhicl::make_ParameterSet(configString, lookup_policy, pset);
363 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
367 template <
typename T>
371 T val = default_value;
375 val = getParam<T>(paramList, index);
377 catch (
const cet::exception& exception)
386 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
388 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::chrono::milliseconds(250));
405 if (!retvalP->isInstantiated())
407 *retvalP = xmlrpc_c::value_string(
"Success");
413 *retvalP = xmlrpc_c::value_string(problemReport);
416 catch (std::runtime_error& er)
419 *retvalP = xmlrpc_c::value_string(msg);
420 TLOG(TLVL_ERROR) << msg ;
422 catch (art::Exception& er)
425 *retvalP = xmlrpc_c::value_string(msg);
426 TLOG(TLVL_ERROR) << msg ;
428 catch (cet::exception& er)
431 *retvalP = xmlrpc_c::value_string(msg);
432 TLOG(TLVL_ERROR) << msg ;
437 *retvalP = xmlrpc_c::value_string(msg);
438 TLOG(TLVL_ERROR) << msg ;
443 *retvalP = xmlrpc_c::value_string(
"busy");
456 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
458 class NAME ## _: public cmd_ { \
464 explicit NAME ## _(xmlrpc_commander& c): \
465 cmd_(c, "s:sii", DESCRIPTION) {} \
468 static const uint64_t defaultTimeout = 45; \
470 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
473 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP ) { \
474 fhicl::ParameterSet ps; \
476 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
478 *retvalP = xmlrpc_c::value_string ("The "#NAME" message requires a single argument that is a string containing the initialization ParameterSet"); \
482 return _c._commandable.CALL(ps, \
483 getParam<uint64_t>(paramList, 1, defaultTimeout), \
484 getParam<uint64_t>(paramList, 2, defaultTimestamp) \
489 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
491 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
493 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
495 #undef GENERATE_INIT_TRANSITION
510 cmd_(c,
"s:iii",
"start the run")
520 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
524 getParam<art::RunID>(paramList, 0);
528 *retvalP = xmlrpc_c::value_string(
"The start message requires the run number as an argument.");
548 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
550 class NAME ## _: public cmd_ { \
555 NAME ## _(xmlrpc_commander& c): \
556 cmd_(c, "s:ii", DESCRIPTION) {} \
559 static const uint64_t defaultTimeout = TIMEOUT ; \
561 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
565 bool execute_ (const xmlrpc_c::paramList& paramList , xmlrpc_c::value* const ) { \
567 return _c._commandable.CALL( getParam<uint64_t>(paramList, 0, defaultTimeout), \
568 getParam<uint64_t>(paramList, 1, defaultTimestamp) \
573 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
575 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
577 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
579 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
593 cmd_(c,
"s:i",
"shutdown the program")
601 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
625 cmd_(c,
"s:n",
"report the current state")
630 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
649 cmd_(c,
"s:s",
"report statistics")
653 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
657 getParam<std::string>(paramList, 0);
661 *retvalP = xmlrpc_c::value_string(
"The report message requires a single argument that selects the type of statistics to be reported.");
681 cmd_(c,
"s:n",
"return the currently legal commands")
685 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
688 std::string resultString;
690 for (
auto& cmd : cmdList)
692 resultString.append(cmd +
" ");
693 if (cmd ==
"shutdown")
695 resultString.append(
" reset");
698 *retvalP = xmlrpc_c::value_string(resultString);
715 cmd_(c,
"s:s",
"Get notified of a new monitor")
719 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
723 getParam<fhicl::ParameterSet>(paramList, 0);
727 *retvalP = xmlrpc_c::value_string(
"The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
747 cmd_(c,
"s:s",
"Remove a monitor")
751 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
755 getParam<std::string>(paramList, 0);
759 *retvalP = xmlrpc_c::value_string(
"The unregister_monitor command expects a string representing the label of the monitor to be removed");
780 cmd_(c,
"s:ssi",
"Set TRACE mask")
784 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
788 getParam<std::string>(paramList, 0);
789 getParam<std::string>(paramList, 1);
790 getParam<uint64_t>(paramList, 2);
794 *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");
798 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<uint64_t>(paramList, 2));
813 cmd_(c,
"s:s",
"Get TRACE mask")
817 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
821 getParam<std::string>(paramList, 0);
825 *retvalP = xmlrpc_c::value_string(
"The trace_msgfacility_set command expects a name (ALL for all)");
845 cmd_(c,
"s:ss",
"Run custom command")
849 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
853 getParam<std::string>(paramList, 0);
854 getParam<std::string>(paramList, 1);
858 *retvalP = xmlrpc_c::value_string(
"The meta_command command expects a string command and a string argument");
872 class shutdown_ :
public xmlrpc_c::registry::shutdown
875 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
877 virtual void doit(
const std::string& paramString,
void*)
const
879 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
881 << paramString <<
"\"" ;
882 _server->terminate();
885 xmlrpc_c::serverAbyss *_server;
893 , port_(ps.get<int>(
"id", 0))
894 , serverUrl_(ps.get<std::string>(
"server_url",
""))
903 xmlrpc_c::registry registry;
904 struct xmlrpc_method_info3 methodInfo;
905 memset(&methodInfo, 0,
sizeof(methodInfo));
910 #define register_method(m) register_method2(m,0x400000)
913 xmlrpc_registry ***c_registryPPP;
914 c_registryPPP = (xmlrpc_registry ***)(((
char*)®istry) +
sizeof(girmem::autoObject));
916 #define register_method2(m,ss) \
917 xmlrpc_c::method * ptr_ ## m(dynamic_cast<xmlrpc_c::method *>(new m ## _(*this))); \
918 methodInfo.methodName = "daq." #m; \
919 methodInfo.methodFunction = &c_executeMethod; \
920 methodInfo.serverInfo = ptr_ ## m; \
921 methodInfo.stackSize = ss; \
922 methodInfo.signatureString = ptr_ ## m ->signature().c_str(); \
923 methodInfo.help = ptr_ ## m ->help().c_str(); \
924 xmlrpc_env_init(&env); \
925 xmlrpc_registry_add_method3(&env,**c_registryPPP,&methodInfo); \
926 if(env.fault_occurred)throw(girerr::error(env.fault_string)); \
927 xmlrpc_env_clean(&env)
929 register_method2(init, 0x200000);
930 register_method(soft_init);
931 register_method(reinit);
932 register_method(start);
933 register_method(status);
934 register_method(report);
935 register_method(stop);
936 register_method(pause);
937 register_method(resume);
938 register_method(register_monitor);
939 register_method(unregister_monitor);
940 register_method(legal_commands);
941 register_method(trace_set);
942 register_method(trace_get);
943 register_method(meta_command);
945 register_method(shutdown);
948 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
949 registry.addMethod(
"daq.reset", ptr_reset);
951 #undef register_method
968 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
970 if (socket_file_descriptor < 0)
972 throw cet::exception(
"xmlrpc_commander::run") <<
973 "Problem with the socket() call; C-style errno == " <<
974 errno <<
" (" << strerror(errno) <<
")";
978 int retval = setsockopt(socket_file_descriptor,
979 SOL_SOCKET, SO_REUSEADDR,
980 &enable,
sizeof(
int));
984 throw cet::exception(
"xmlrpc_commander::run") <<
985 "Problem with the call to setsockopt(); C-style errno == " <<
986 errno <<
" (" << strerror(errno) <<
")";
989 struct sockaddr_in sockAddr;
991 sockAddr.sin_family = AF_INET;
992 sockAddr.sin_port = htons(port_);
993 sockAddr.sin_addr.s_addr = 0;
995 retval = bind(socket_file_descriptor,
996 reinterpret_cast<struct sockaddr*>(&sockAddr),
1001 close(socket_file_descriptor);
1002 throw cet::exception(
"xmlrpc_commander::run") <<
1003 "Problem with the bind() call; C-style errno == " <<
1004 errno <<
" (" << strerror(errno) <<
")";
1007 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1010 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1011 registry.setShutdown(&shutdown_obj);
1014 TLOG(TLVL_DEBUG) <<
"running server" ;
1028 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing" ;
1029 close(socket_file_descriptor);
1033 close(socket_file_descriptor);
1034 TLOG(TLVL_DEBUG) <<
"server terminated" ;
1044 if (serverUrl_ ==
"")
1046 std::stringstream errmsg;
1047 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1048 ExceptionHandler(ExceptionHandlerRethrow::yes,
1052 xmlrpc_c::clientSimple myClient;
1053 xmlrpc_c::value result;
1057 myClient.call(serverUrl_,
"daq.register_monitor",
"s", &result, monitor_fhicl.c_str());
1061 std::stringstream errmsg;
1062 errmsg <<
"Problem attempting XML-RPC call on host " << serverUrl_
1063 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1064 ExceptionHandler(ExceptionHandlerRethrow::yes,
1068 return xmlrpc_c::value_string(result);
1073 if (serverUrl_ ==
"")
1075 std::stringstream errmsg;
1076 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1077 ExceptionHandler(ExceptionHandlerRethrow::yes,
1082 xmlrpc_c::clientSimple myClient;
1083 xmlrpc_c::value result;
1087 myClient.call(serverUrl_,
"daq.unregister_monitor",
"s", &result, monitor_label.c_str());
1091 std::stringstream errmsg;
1092 errmsg <<
"Problem attempting to unregister monitor via XML-RPC call on host " << serverUrl_
1093 <<
"; possible causes are that the monitor label \""
1095 <<
"\" is unrecognized by contacted process or process at requested port doesn't exist";
1096 ExceptionHandler(ExceptionHandlerRethrow::no, errmsg.str());
1099 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.
virtual bool do_trace_set(std::string const &, std::string const &, uint64_t)
Set the given TRACE mask for the given trace name.
virtual std::string do_trace_get(std::string const &)
Get the TRACE mask for the given trace name.
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 std::string register_monitor(fhicl::ParameterSet const &)
Perform the register_monitor action.
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 ...
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_meta_command(std::string const &, std::string const &)
Run a module-defined command with the given parameter string.
std::vector< std::string > legal_commands() const
Get the legal transition commands from the current state.
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
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.