6 #pragma GCC diagnostic push
7 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
8 #include <xmlrpc-c/base.hpp>
9 #include <xmlrpc-c/registry.hpp>
10 #include <xmlrpc-c/server_abyss.hpp>
11 #include <xmlrpc-c/girerr.hpp>
12 #include <xmlrpc-c/client_simple.hpp>
13 #pragma GCC diagnostic pop
19 #define TRACE_NAME "xmlrpc_commander"
22 #include "artdaq-core/Utilities/ExceptionHandler.hh"
23 #include <sys/socket.h>
24 #include <netinet/in.h>
29 #include "canvas/Persistency/Provenance/RunID.h"
30 #include "fhiclcpp/make_ParameterSet.h"
32 #include "artdaq/ExternalComms/xmlrpc_commander.hh"
33 #include "artdaq/DAQdata/Globals.hh"
39 env_wrap() { xmlrpc_env_init(&this->env_c); };
40 ~
env_wrap() { xmlrpc_env_clean(&this->env_c); };
44 static xmlrpc_c::paramList
45 pListFromXmlrpcArray(xmlrpc_value *
const arrayP)
48 XMLRPC_ASSERT_ARRAY_OK(arrayP);
49 unsigned int const arraySize = xmlrpc_array_size(&env.env_c, arrayP);
50 assert(!env.env_c.fault_occurred);
51 xmlrpc_c::paramList paramList(arraySize);
52 for (
unsigned int i = 0; i < arraySize; ++i) {
53 xmlrpc_value * arrayItemP;
54 xmlrpc_array_read_item(&env.env_c, arrayP, i, &arrayItemP);
55 assert(!env.env_c.fault_occurred);
56 paramList.add(xmlrpc_c::value(arrayItemP));
57 xmlrpc_DECREF(arrayItemP);
62 c_executeMethod(xmlrpc_env *
const envP,
63 xmlrpc_value *
const paramArrayP,
64 void *
const methodPtr,
65 void *
const callInfoPtr)
67 xmlrpc_c::method *
const methodP(static_cast<xmlrpc_c::method *>(methodPtr));
68 xmlrpc_c::paramList
const paramList(pListFromXmlrpcArray(paramArrayP));
69 xmlrpc_c::callInfo *
const callInfoP(static_cast<xmlrpc_c::callInfo *>(callInfoPtr));
70 xmlrpc_value * retval;
73 xmlrpc_c::value result;
75 xmlrpc_c::method2 *
const method2P(dynamic_cast<xmlrpc_c::method2 *>(methodP));
77 method2P->execute(paramList, callInfoP, &result);
79 methodP->execute(paramList, &result);
81 catch (xmlrpc_c::fault
const& fault) {
82 xmlrpc_env_set_fault(envP, fault.getCode(),
83 fault.getDescription().c_str());
85 if (!envP->fault_occurred) {
86 if (result.isInstantiated())
87 retval = result.cValue();
89 girerr::throwf(
"Xmlrpc-c user's xmlrpc_c::method object's "
90 "'execute method' failed to set the RPC result "
94 catch (std::exception
const& e) {
95 xmlrpc_faultf(envP,
"Unexpected error executing code for "
96 "particular method, detected by Xmlrpc-c "
97 "method registry code. Method did not "
98 "fail; rather, it did not complete at all. %s",
102 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
103 "Unexpected error executing code for "
104 "particular method, detected by Xmlrpc-c "
105 "method registry code. Method did not "
106 "fail; rather, it did not complete at all.");
122 const std::string& helpText =
"execute request")
124 std::string msg(
"Exception when trying to ");
125 msg.append(helpText);
127 msg.append(er.what());
128 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
139 const std::string& helpText)
141 std::string msg(
"Exception when trying to ");
142 msg.append(helpText);
144 msg.append(er.what());
145 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
156 const std::string& helpText)
158 std::string msg(
"Exception when trying to ");
159 msg.append(helpText);
161 msg.append(er.what());
162 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
173 const std::string& helpText)
175 std::string msg(
"Exception when trying to ");
176 msg.append(helpText);
179 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
201 class cmd_ :
public xmlrpc_c::method
214 _signature = signature;
223 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
final;
234 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value*
const retvalP) = 0;
245 template <
typename T>
246 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
271 template <
typename T>
272 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
278 template <
typename T>
281 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
293 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
295 return boost::lexical_cast<uint64_t>(paramList.getInt(index));
307 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
309 return static_cast<std::string
>(paramList.getString(index));
321 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
323 std::string run_number_string = paramList.getString(index);
324 art::RunNumber_t run_number =
325 boost::lexical_cast<art::RunNumber_t>(run_number_string);
326 art::RunID run_id(run_number);
340 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
342 std::string configString = std::string(paramList.getString(index).c_str());
343 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
344 fhicl::ParameterSet pset;
348 fhicl::make_ParameterSet(configString, pset);
350 catch (fhicl::exception e)
352 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
354 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
355 setenv(
"FHICL_FILE_PATH",
".", 0);
357 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
358 fhicl::make_ParameterSet(configString, lookup_policy, pset);
361 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
365 template <
typename T>
369 T val = default_value;
373 val = getParam<T>(paramList, index);
375 catch (
const cet::exception& exception)
384 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
386 std::unique_lock<std::mutex> lk(
_c.
mutex_, std::try_to_lock);
403 if (!retvalP->isInstantiated())
405 *retvalP = xmlrpc_c::value_string(
"Success");
411 *retvalP = xmlrpc_c::value_string(problemReport);
414 catch (std::runtime_error& er)
417 *retvalP = xmlrpc_c::value_string(msg);
418 TLOG(TLVL_ERROR) << msg << TLOG_ENDL;
420 catch (art::Exception& er)
423 *retvalP = xmlrpc_c::value_string(msg);
424 TLOG(TLVL_ERROR) << msg << TLOG_ENDL;
426 catch (cet::exception& er)
429 *retvalP = xmlrpc_c::value_string(msg);
430 TLOG(TLVL_ERROR) << msg << TLOG_ENDL;
435 *retvalP = xmlrpc_c::value_string(msg);
436 TLOG(TLVL_ERROR) << msg << TLOG_ENDL;
441 *retvalP = xmlrpc_c::value_string(
"busy");
454 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
456 class NAME ## _: public cmd_ { \
462 explicit NAME ## _(xmlrpc_commander& c): \
463 cmd_(c, "s:sii", DESCRIPTION) {} \
466 static const uint64_t defaultTimeout = 45; \
468 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
471 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP ) { \
472 fhicl::ParameterSet ps; \
474 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
476 *retvalP = xmlrpc_c::value_string ("The "#NAME" message requires a single argument that is a string containing the initialization ParameterSet"); \
480 return _c._commandable.CALL(ps, \
481 getParam<uint64_t>(paramList, 1, defaultTimeout), \
482 getParam<uint64_t>(paramList, 2, defaultTimestamp) \
487 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
489 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
491 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
493 #undef GENERATE_INIT_TRANSITION
508 cmd_(c,
"s:iii",
"start the run")
518 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
522 getParam<art::RunID>(paramList, 0);
526 *retvalP = xmlrpc_c::value_string(
"The start message requires the run number as an argument.");
546 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
548 class NAME ## _: public cmd_ { \
553 NAME ## _(xmlrpc_commander& c): \
554 cmd_(c, "s:ii", DESCRIPTION) {} \
557 static const uint64_t defaultTimeout = TIMEOUT ; \
559 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
563 bool execute_ (const xmlrpc_c::paramList& paramList , xmlrpc_c::value* const ) { \
565 return _c._commandable.CALL( getParam<uint64_t>(paramList, 0, defaultTimeout), \
566 getParam<uint64_t>(paramList, 1, defaultTimestamp) \
571 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
573 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
575 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
577 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
591 cmd_(c,
"s:i",
"shutdown the program")
599 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
623 cmd_(c,
"s:n",
"report the current state")
628 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
647 cmd_(c,
"s:s",
"report statistics")
651 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
655 getParam<std::string>(paramList, 0);
659 *retvalP = xmlrpc_c::value_string(
"The report message requires a single argument that selects the type of statistics to be reported.");
679 cmd_(c,
"s:n",
"return the currently legal commands")
683 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
686 std::string resultString;
688 for (
auto& cmd : cmdList)
690 resultString.append(cmd +
" ");
691 if (cmd ==
"shutdown")
693 resultString.append(
" reset");
696 *retvalP = xmlrpc_c::value_string(resultString);
713 cmd_(c,
"s:s",
"Get notified of a new monitor")
717 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
721 getParam<fhicl::ParameterSet>(paramList, 0);
725 *retvalP = xmlrpc_c::value_string(
"The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
745 cmd_(c,
"s:s",
"Remove a monitor")
749 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
753 getParam<std::string>(paramList, 0);
757 *retvalP = xmlrpc_c::value_string(
"The unregister_monitor command expects a string representing the label of the monitor to be removed");
778 cmd_(c,
"s:ssi",
"Set TRACE mask")
782 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
786 getParam<std::string>(paramList, 0);
787 getParam<std::string>(paramList, 1);
788 getParam<uint64_t>(paramList, 2);
792 *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");
796 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<uint64_t>(paramList, 2));
811 cmd_(c,
"s:s",
"Get TRACE mask")
815 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
819 getParam<std::string>(paramList, 0);
823 *retvalP = xmlrpc_c::value_string(
"The trace_msgfacility_set command expects a name (ALL for all)");
843 cmd_(c,
"s:ss",
"Run custom command")
847 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
851 getParam<std::string>(paramList, 0);
852 getParam<std::string>(paramList, 1);
856 *retvalP = xmlrpc_c::value_string(
"The meta_command command expects a string command and a string argument");
870 class shutdown_ :
public xmlrpc_c::registry::shutdown
873 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
875 virtual void doit(
const std::string& paramString,
void*)
const
877 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
879 << paramString <<
"\"" << TLOG_ENDL;
880 _server->terminate();
883 xmlrpc_c::serverAbyss *_server;
891 , port_(ps.get<int>(
"id", 0))
892 , serverUrl_(ps.get<std::string>(
"server_url",
""))
901 xmlrpc_c::registry registry;
902 struct xmlrpc_method_info3 methodInfo;
903 memset(&methodInfo, 0,
sizeof(methodInfo));
908 #define register_method(m) register_method2(m,0x200000)
911 xmlrpc_registry ***c_registryPPP;
912 c_registryPPP = (xmlrpc_registry ***)(((
char*)®istry) +
sizeof(girmem::autoObject));
914 #define register_method2(m,ss) \
915 xmlrpc_c::method * ptr_ ## m(dynamic_cast<xmlrpc_c::method *>(new m ## _(*this))); \
916 methodInfo.methodName = "daq." #m; \
917 methodInfo.methodFunction = &c_executeMethod; \
918 methodInfo.serverInfo = ptr_ ## m; \
919 methodInfo.stackSize = ss; \
920 methodInfo.signatureString = ptr_ ## m ->signature().c_str(); \
921 methodInfo.help = ptr_ ## m ->help().c_str(); \
922 xmlrpc_env_init(&env); \
923 xmlrpc_registry_add_method3(&env,**c_registryPPP,&methodInfo); \
924 if(env.fault_occurred)throw(girerr::error(env.fault_string)); \
925 xmlrpc_env_clean(&env)
927 register_method2(init, 0x200000);
928 register_method(soft_init);
929 register_method(reinit);
930 register_method(start);
931 register_method(status);
932 register_method(report);
933 register_method(stop);
934 register_method(pause);
935 register_method(resume);
936 register_method(register_monitor);
937 register_method(unregister_monitor);
938 register_method(legal_commands);
939 register_method(trace_set);
940 register_method(trace_get);
941 register_method(meta_command);
943 register_method(shutdown);
946 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
947 registry.addMethod(
"daq.reset", ptr_reset);
949 #undef register_method
966 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
968 if (socket_file_descriptor < 0)
970 throw cet::exception(
"xmlrpc_commander::run") <<
971 "Problem with the socket() call; C-style errno == " <<
972 errno <<
" (" << strerror(errno) <<
")";
976 int retval = setsockopt(socket_file_descriptor,
977 SOL_SOCKET, SO_REUSEADDR,
978 &enable,
sizeof(
int));
982 throw cet::exception(
"xmlrpc_commander::run") <<
983 "Problem with the call to setsockopt(); C-style errno == " <<
984 errno <<
" (" << strerror(errno) <<
")";
987 struct sockaddr_in sockAddr;
989 sockAddr.sin_family = AF_INET;
990 sockAddr.sin_port = htons(port_);
991 sockAddr.sin_addr.s_addr = 0;
993 retval = bind(socket_file_descriptor,
994 reinterpret_cast<struct sockaddr*>(&sockAddr),
999 close(socket_file_descriptor);
1000 throw cet::exception(
"xmlrpc_commander::run") <<
1001 "Problem with the bind() call; C-style errno == " <<
1002 errno <<
" (" << strerror(errno) <<
")";
1005 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1008 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1009 registry.setShutdown(&shutdown_obj);
1012 TLOG(TLVL_DEBUG) <<
"running server" << TLOG_ENDL;
1026 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing" << TLOG_ENDL;
1027 close(socket_file_descriptor);
1031 close(socket_file_descriptor);
1032 TLOG(TLVL_DEBUG) <<
"server terminated" << TLOG_ENDL;
1042 if (serverUrl_ ==
"")
1044 std::stringstream errmsg;
1045 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1046 ExceptionHandler(ExceptionHandlerRethrow::yes,
1050 xmlrpc_c::clientSimple myClient;
1051 xmlrpc_c::value result;
1055 myClient.call(serverUrl_,
"daq.register_monitor",
"s", &result, monitor_fhicl.c_str());
1059 std::stringstream errmsg;
1060 errmsg <<
"Problem attempting XML-RPC call on host " << serverUrl_
1061 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1062 ExceptionHandler(ExceptionHandlerRethrow::yes,
1066 return xmlrpc_c::value_string(result);
1071 if (serverUrl_ ==
"")
1073 std::stringstream errmsg;
1074 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
1075 ExceptionHandler(ExceptionHandlerRethrow::yes,
1080 xmlrpc_c::clientSimple myClient;
1081 xmlrpc_c::value result;
1085 myClient.call(serverUrl_,
"daq.unregister_monitor",
"s", &result, monitor_label.c_str());
1089 std::stringstream errmsg;
1090 errmsg <<
"Problem attempting to unregister monitor via XML-RPC call on host " << serverUrl_
1091 <<
"; possible causes are that the monitor label \""
1093 <<
"\" is unrecognized by contacted process or process at requested port doesn't exist";
1094 ExceptionHandler(ExceptionHandlerRethrow::no, errmsg.str());
1097 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 ...
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
std::mutex mutex_
XMLRPC mutex.
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.