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);
80 }
catch (xmlrpc_c::fault
const& fault) {
81 xmlrpc_env_set_fault(envP, fault.getCode(),
82 fault.getDescription().c_str());
84 if (!envP->fault_occurred) {
85 if (result.isInstantiated())
86 retval = result.cValue();
88 girerr::throwf(
"Xmlrpc-c user's xmlrpc_c::method object's "
89 "'execute method' failed to set the RPC result "
92 }
catch (std::exception
const& e) {
93 xmlrpc_faultf(envP,
"Unexpected error executing code for "
94 "particular method, detected by Xmlrpc-c "
95 "method registry code. Method did not "
96 "fail; rather, it did not complete at all. %s",
99 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
100 "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.");
119 const std::string& helpText =
"execute request")
121 std::string msg(
"Exception when trying to ");
122 msg.append(helpText);
124 msg.append(er.what());
125 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
136 const std::string& helpText)
138 std::string msg(
"Exception when trying to ");
139 msg.append(helpText);
141 msg.append(er.what());
142 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
153 const std::string& helpText)
155 std::string msg(
"Exception when trying to ");
156 msg.append(helpText);
158 msg.append(er.what());
159 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
170 const std::string& helpText)
172 std::string msg(
"Exception when trying to ");
173 msg.append(helpText);
176 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
198 class cmd_ :
public xmlrpc_c::method
211 _signature = signature;
220 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
final;
231 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value*
const retvalP) = 0;
242 template <
typename T>
243 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
268 template <
typename T>
269 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
275 template <
typename T>
278 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
290 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
292 return boost::lexical_cast<uint64_t>(paramList.getInt(index));
304 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
306 return static_cast<std::string
>(paramList.getString(index));
318 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
320 std::string run_number_string = paramList.getString(index);
321 art::RunNumber_t run_number =
322 boost::lexical_cast<art::RunNumber_t>(run_number_string);
323 art::RunID run_id(run_number);
337 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
339 std::string configString = std::string(paramList.getString(index).c_str());
340 TLOG_DEBUG(
"xmlrpc_commander") <<
"Loading Parameter Set from string: " << configString << std::endl;
341 fhicl::ParameterSet pset;
345 fhicl::make_ParameterSet(configString, pset);
347 catch (fhicl::exception e)
349 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
351 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
352 setenv(
"FHICL_FILE_PATH",
".", 0);
354 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
355 fhicl::make_ParameterSet(configString, lookup_policy, pset);
358 TLOG_INFO(
"xmlrpc_commander") <<
"Parameter Set Loaded." << std::endl;
362 template <
typename T>
366 T val = default_value;
370 val = getParam<T>(paramList, index);
372 catch (
const cet::exception& exception)
381 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
383 std::unique_lock<std::mutex> lk(
_c.
mutex_, std::try_to_lock);
400 if (!retvalP->isInstantiated())
402 *retvalP = xmlrpc_c::value_string(
"Success");
408 *retvalP = xmlrpc_c::value_string(problemReport);
411 catch (std::runtime_error& er)
414 *retvalP = xmlrpc_c::value_string(msg);
415 TLOG_ERROR(
"XMLRPC_Commander") << msg << TLOG_ENDL;
417 catch (art::Exception& er)
420 *retvalP = xmlrpc_c::value_string(msg);
421 TLOG_ERROR(
"XMLRPC_Commander") << msg << TLOG_ENDL;
423 catch (cet::exception& er)
426 *retvalP = xmlrpc_c::value_string(msg);
427 TLOG_ERROR(
"XMLRPC_Commander") << msg << TLOG_ENDL;
432 *retvalP = xmlrpc_c::value_string(msg);
433 TLOG_ERROR(
"XMLRPC_Commander") << msg << TLOG_ENDL;
438 *retvalP = xmlrpc_c::value_string(
"busy");
451 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
453 class NAME ## _: public cmd_ { \
459 explicit NAME ## _(xmlrpc_commander& c): \
460 cmd_(c, "s:sii", DESCRIPTION) {} \
463 static const uint64_t defaultTimeout = 45; \
465 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
468 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP ) { \
469 fhicl::ParameterSet ps; \
471 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
473 *retvalP = xmlrpc_c::value_string ("The "#NAME" message requires a single argument that is a string containing the initialization ParameterSet"); \
477 return _c._commandable.CALL(ps, \
478 getParam<uint64_t>(paramList, 1, defaultTimeout), \
479 getParam<uint64_t>(paramList, 2, defaultTimestamp) \
484 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
486 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
488 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
490 #undef GENERATE_INIT_TRANSITION
505 cmd_(c,
"s:iii",
"start the run")
515 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
519 getParam<art::RunID>(paramList, 0);
523 *retvalP = xmlrpc_c::value_string(
"The start message requires the run number as an argument.");
543 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
545 class NAME ## _: public cmd_ { \
550 NAME ## _(xmlrpc_commander& c): \
551 cmd_(c, "s:ii", DESCRIPTION) {} \
554 static const uint64_t defaultTimeout = TIMEOUT ; \
556 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
560 bool execute_ (const xmlrpc_c::paramList& paramList , xmlrpc_c::value* const ) { \
562 return _c._commandable.CALL( getParam<uint64_t>(paramList, 0, defaultTimeout), \
563 getParam<uint64_t>(paramList, 1, defaultTimestamp) \
568 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
570 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
572 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
574 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
588 cmd_(c,
"s:i",
"shutdown the program")
596 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
614 cmd_(c,
"s:n",
"report the current state")
619 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
638 cmd_(c,
"s:s",
"report statistics")
642 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
646 getParam<std::string>(paramList, 0);
650 *retvalP = xmlrpc_c::value_string(
"The report message requires a single argument that selects the type of statistics to be reported.");
670 cmd_(c,
"s:n",
"return the currently legal commands")
674 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
677 std::string resultString;
679 for (
auto& cmd : cmdList)
681 resultString.append(cmd +
" ");
682 if (cmd ==
"shutdown")
684 resultString.append(
" reset");
687 *retvalP = xmlrpc_c::value_string(resultString);
704 cmd_(c,
"s:s",
"Get notified of a new monitor")
708 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
712 getParam<fhicl::ParameterSet>(paramList, 0);
716 *retvalP = xmlrpc_c::value_string(
"The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
736 cmd_(c,
"s:s",
"Remove a monitor")
740 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
744 getParam<std::string>(paramList, 0);
748 *retvalP = xmlrpc_c::value_string(
"The unregister_monitor command expects a string representing the label of the monitor to be removed");
764 class shutdown_ :
public xmlrpc_c::registry::shutdown
767 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
769 virtual void doit(
const std::string& paramString,
void*)
const
771 TLOG_INFO(
"XMLRPC_Commander") <<
"A shutdown command was sent "
773 << paramString <<
"\"" << TLOG_ENDL;
774 _server->terminate();
777 xmlrpc_c::serverAbyss *_server;
785 , port_(ps.get<int>(
"id", 0))
786 , serverUrl_(ps.get<std::string>(
"server_url",
""))
794 xmlrpc_c::registry registry;
795 struct xmlrpc_method_info3 methodInfo;
796 memset(&methodInfo, 0 ,
sizeof(methodInfo));
801 #define register_method(m) register_method2(m,0x200000)
804 xmlrpc_registry ***c_registryPPP;
805 c_registryPPP = (xmlrpc_registry ***)(((
char*)®istry)+
sizeof(girmem::autoObject));
807 #define register_method2(m,ss) \
808 xmlrpc_c::method * ptr_ ## m(dynamic_cast<xmlrpc_c::method *>(new m ## _(*this))); \
809 methodInfo.methodName = "daq." #m; \
810 methodInfo.methodFunction = &c_executeMethod; \
811 methodInfo.serverInfo = ptr_ ## m; \
812 methodInfo.stackSize = ss; \
813 methodInfo.signatureString = ptr_ ## m ->signature().c_str(); \
814 methodInfo.help = ptr_ ## m ->help().c_str(); \
815 xmlrpc_env_init(&env); \
816 xmlrpc_registry_add_method3(&env,**c_registryPPP,&methodInfo); \
817 if(env.fault_occurred)throw(girerr::error(env.fault_string)); \
818 xmlrpc_env_clean(&env)
820 register_method2(init,0x200000);
821 register_method(soft_init);
822 register_method(reinit);
823 register_method(start);
824 register_method(status);
825 register_method(report);
826 register_method(stop);
827 register_method(pause);
828 register_method(resume);
829 register_method(register_monitor);
830 register_method(unregister_monitor);
831 register_method(legal_commands);
833 register_method(shutdown);
836 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
837 registry.addMethod(
"daq.reset", ptr_reset);
839 #undef register_method
856 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
858 if (socket_file_descriptor < 0)
860 throw cet::exception(
"xmlrpc_commander::run") <<
861 "Problem with the socket() call; C-style errno == " <<
862 errno <<
" (" << strerror(errno) <<
")";
866 int retval = setsockopt(socket_file_descriptor,
867 SOL_SOCKET, SO_REUSEADDR,
868 &enable,
sizeof(
int));
872 throw cet::exception(
"xmlrpc_commander::run") <<
873 "Problem with the call to setsockopt(); C-style errno == " <<
874 errno <<
" (" << strerror(errno) <<
")";
877 struct sockaddr_in sockAddr;
879 sockAddr.sin_family = AF_INET;
880 sockAddr.sin_port = htons(port_);
881 sockAddr.sin_addr.s_addr = 0;
883 retval = bind(socket_file_descriptor,
884 reinterpret_cast<struct sockaddr*>(&sockAddr),
889 close(socket_file_descriptor);
890 throw cet::exception(
"xmlrpc_commander::run") <<
891 "Problem with the bind() call; C-style errno == " <<
892 errno <<
" (" << strerror(errno) <<
")";
895 xmlrpc_c::serverAbyss server(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor));
898 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&server);
899 registry.setShutdown(&shutdown_obj);
902 TLOG_DEBUG(
"XMLRPC_Commander") <<
"running server" << TLOG_ENDL;
916 TLOG_WARNING(
"XMLRPC_Commander") <<
"server threw an exception; closing the socket and rethrowing" << TLOG_ENDL;
917 close(socket_file_descriptor);
921 close(socket_file_descriptor);
922 TLOG_DEBUG(
"XMLRPC_Commander") <<
"server terminated" << TLOG_ENDL;
932 if (serverUrl_ ==
"")
934 std::stringstream errmsg;
935 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
936 ExceptionHandler(ExceptionHandlerRethrow::yes,
940 xmlrpc_c::clientSimple myClient;
941 xmlrpc_c::value result;
945 myClient.call(serverUrl_,
"daq.register_monitor",
"s", &result, monitor_fhicl.c_str());
949 std::stringstream errmsg;
950 errmsg <<
"Problem attempting XML-RPC call on host " << serverUrl_
951 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
952 ExceptionHandler(ExceptionHandlerRethrow::yes,
956 return xmlrpc_c::value_string(result);
961 if (serverUrl_ ==
"")
963 std::stringstream errmsg;
964 errmsg <<
"Problem attempting XML-RPC call: No server URL set!";
965 ExceptionHandler(ExceptionHandlerRethrow::yes,
970 xmlrpc_c::clientSimple myClient;
971 xmlrpc_c::value result;
975 myClient.call(serverUrl_,
"daq.unregister_monitor",
"s", &result, monitor_label.c_str());
979 std::stringstream errmsg;
980 errmsg <<
"Problem attempting to unregister monitor via XML-RPC call on host " << serverUrl_
981 <<
"; possible causes are that the monitor label \""
983 <<
"\" is unrecognized by contacted process or process at requested port doesn't exist";
984 ExceptionHandler(ExceptionHandlerRethrow::no,
988 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 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.
void run_server() override
Run the 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
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
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.