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/client_simple.hpp>
11 #include <xmlrpc-c/girerr.hpp>
12 #include <xmlrpc-c/registry.hpp>
13 #include <xmlrpc-c/server_abyss.hpp>
14 #undef _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES
15 #pragma GCC diagnostic pop
21 #include "artdaq/DAQdata/Globals.hh"
22 #define TRACE_NAME (app_name + "_xmlrpc_commander").c_str()
26 #include <netinet/in.h>
27 #include <sys/socket.h>
30 #include "artdaq-core/Utilities/ExceptionHandler.hh"
32 #include "canvas/Persistency/Provenance/RunID.h"
33 #include "fhiclcpp/make_ParameterSet.h"
35 #include "artdaq/ExternalComms/xmlrpc_commander.hh"
45 env_wrap() { xmlrpc_env_init(&this->env_c); };
46 ~
env_wrap() { xmlrpc_env_clean(&this->env_c); };
50 static xmlrpc_c::paramList
51 pListFromXmlrpcArray(xmlrpc_value*
const arrayP)
54 XMLRPC_ASSERT_ARRAY_OK(arrayP);
55 unsigned int const arraySize = xmlrpc_array_size(&env.env_c, arrayP);
56 assert(!env.env_c.fault_occurred);
57 xmlrpc_c::paramList paramList(arraySize);
58 for (
unsigned int i = 0; i < arraySize; ++i)
60 xmlrpc_value* arrayItemP;
61 xmlrpc_array_read_item(&env.env_c, arrayP, i, &arrayItemP);
62 assert(!env.env_c.fault_occurred);
63 paramList.add(xmlrpc_c::value(arrayItemP));
64 xmlrpc_DECREF(arrayItemP);
69 c_executeMethod(xmlrpc_env*
const envP,
70 xmlrpc_value*
const paramArrayP,
71 void*
const methodPtr,
72 void*
const callInfoPtr)
74 xmlrpc_c::method*
const methodP(static_cast<xmlrpc_c::method*>(methodPtr));
75 xmlrpc_c::paramList
const paramList(pListFromXmlrpcArray(paramArrayP));
76 xmlrpc_c::callInfo*
const callInfoP(static_cast<xmlrpc_c::callInfo*>(callInfoPtr));
81 xmlrpc_c::value result;
84 xmlrpc_c::method2*
const method2P(dynamic_cast<xmlrpc_c::method2*>(methodP));
86 method2P->execute(paramList, callInfoP, &result);
88 methodP->execute(paramList, &result);
90 catch (xmlrpc_c::fault
const& fault)
92 xmlrpc_env_set_fault(envP, fault.getCode(),
93 fault.getDescription().c_str());
95 if (!envP->fault_occurred)
97 if (result.isInstantiated())
98 retval = result.cValue();
101 "Xmlrpc-c user's xmlrpc_c::method object's "
102 "'execute method' failed to set the RPC result "
106 catch (std::exception
const& e)
109 "Unexpected error executing code for "
110 "particular method, detected by Xmlrpc-c "
111 "method registry code. Method did not "
112 "fail; rather, it did not complete at all. %s",
117 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
118 "Unexpected error executing code for "
119 "particular method, detected by Xmlrpc-c "
120 "method registry code. Method did not "
121 "fail; rather, it did not complete at all.");
134 const std::string& helpText =
"execute request")
136 std::string msg(
"Exception when trying to ");
137 msg.append(helpText);
139 msg.append(er.what());
140 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
151 const std::string& helpText)
153 std::string msg(
"Exception when trying to ");
154 msg.append(helpText);
156 msg.append(er.what());
157 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
168 const std::string& helpText)
170 std::string msg(
"Exception when trying to ");
171 msg.append(helpText);
173 msg.append(er.what());
174 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
185 const std::string& helpText)
187 std::string msg(
"Exception when trying to ");
188 msg.append(helpText);
191 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
212 class cmd_ :
public xmlrpc_c::method
225 _signature = signature;
234 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
final;
244 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value*
const retvalP) = 0;
256 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
282 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
291 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
303 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
305 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as uint64_t.";
306 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
307 return boost::lexical_cast<uint64_t>(paramList.getString(index));
319 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
321 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as string.";
322 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
323 return static_cast<std::string
>(paramList.getString(index));
335 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
337 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as Run Number.";
338 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
339 std::string run_number_string = paramList.getString(index);
340 art::RunNumber_t run_number =
341 boost::lexical_cast<art::RunNumber_t>(run_number_string);
342 art::RunID run_id(run_number);
356 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
358 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
359 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
360 std::string configString = std::string(paramList.getString(index).c_str());
361 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
362 fhicl::ParameterSet pset;
366 fhicl::make_ParameterSet(configString, pset);
368 catch (
const fhicl::exception& e)
370 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
372 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
373 setenv(
"FHICL_FILE_PATH",
".", 0);
375 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
376 fhicl::make_ParameterSet(configString, lookup_policy, pset);
379 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
387 T val = default_value;
391 val = getParam<T>(paramList, index);
393 catch (
const cet::exception& exception)
403 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
405 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::chrono::milliseconds(250));
422 if (!retvalP->isInstantiated())
424 *retvalP = xmlrpc_c::value_string(
"Success");
430 *retvalP = xmlrpc_c::value_string(problemReport);
433 catch (std::runtime_error& er)
436 *retvalP = xmlrpc_c::value_string(msg);
437 TLOG(TLVL_ERROR) << msg;
439 catch (art::Exception& er)
442 *retvalP = xmlrpc_c::value_string(msg);
443 TLOG(TLVL_ERROR) << msg;
445 catch (cet::exception& er)
448 *retvalP = xmlrpc_c::value_string(msg);
449 TLOG(TLVL_ERROR) << msg;
454 *retvalP = xmlrpc_c::value_string(msg);
455 TLOG(TLVL_ERROR) << msg;
460 *retvalP = xmlrpc_c::value_string(
"busy");
472 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
474 class NAME##_ : public cmd_ \
480 explicit NAME##_(xmlrpc_commander& c) : cmd_(c, "s:sii", DESCRIPTION) {} \
483 static const uint64_t defaultTimeout = 45; \
485 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
488 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP) \
490 fhicl::ParameterSet ps; \
493 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
497 *retvalP = xmlrpc_c::value_string("The " #NAME " message requires a single argument that is a string containing the initialization ParameterSet"); \
501 return _c._commandable.CALL(ps, \
502 getParam<uint64_t>(paramList, 1, defaultTimeout), \
503 getParam<uint64_t>(paramList, 2, defaultTimestamp)); \
507 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
509 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
511 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
513 #undef GENERATE_INIT_TRANSITION
528 :
cmd_(c,
"s:iii",
"start the run")
537 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
541 getParam<art::RunID>(paramList, 0);
545 *retvalP = xmlrpc_c::value_string(
"The start message requires the run number as an argument.");
563 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
565 class NAME##_ : public cmd_ \
570 NAME##_(xmlrpc_commander& c) : cmd_(c, "s:ii", DESCRIPTION) {} \
573 static const uint64_t defaultTimeout = TIMEOUT; \
575 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
578 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const) \
580 return _c._commandable.CALL(getParam<uint64_t>(paramList, 0, defaultTimeout), \
581 getParam<uint64_t>(paramList, 1, defaultTimestamp)); \
585 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
587 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
589 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
591 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
604 :
cmd_(c,
"s:i",
"shutdown the program")
611 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
634 :
cmd_(c,
"s:n",
"report the current state")
638 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
656 :
cmd_(c,
"s:s",
"report statistics")
660 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
664 getParam<std::string>(paramList, 0);
668 *retvalP = xmlrpc_c::value_string(
"The report message requires a single argument that selects the type of statistics to be reported.");
688 :
cmd_(c,
"s:n",
"return the currently legal commands")
692 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
695 std::string resultString;
697 for (
auto& cmd : cmdList)
699 resultString.append(cmd +
" ");
700 if (cmd ==
"shutdown")
702 resultString.append(
" reset");
705 *retvalP = xmlrpc_c::value_string(resultString);
722 :
cmd_(c,
"s:s",
"Get notified of a new monitor")
726 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
730 getParam<fhicl::ParameterSet>(paramList, 0);
734 *retvalP = xmlrpc_c::value_string(
"The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
754 :
cmd_(c,
"s:s",
"Remove a monitor")
758 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
762 getParam<std::string>(paramList, 0);
766 *retvalP = xmlrpc_c::value_string(
"The unregister_monitor command expects a string representing the label of the monitor to be removed");
786 :
cmd_(c,
"s:ssi",
"Set TRACE mask")
790 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
794 getParam<std::string>(paramList, 0);
795 getParam<std::string>(paramList, 1);
796 getParam<uint64_t>(paramList, 2);
800 *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");
804 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<uint64_t>(paramList, 2));
819 :
cmd_(c,
"s:s",
"Get TRACE mask")
823 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
827 getParam<std::string>(paramList, 0);
831 *retvalP = xmlrpc_c::value_string(
"The trace_msgfacility_set command expects a name (ALL for all)");
851 :
cmd_(c,
"s:ss",
"Run custom command")
855 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
859 getParam<std::string>(paramList, 0);
860 getParam<std::string>(paramList, 1);
864 *retvalP = xmlrpc_c::value_string(
"The meta_command command expects a string command and a string argument");
883 :
cmd_(c,
"s:ii",
"create a new subrun")
890 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
908 :
cmd_(c,
"s:ss",
"Add an entry to the configuration archive list")
912 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
916 getParam<std::string>(paramList, 0);
917 getParam<std::string>(paramList, 1);
921 *retvalP = xmlrpc_c::value_string(
"The add_config_archive_entry command expects a string key and a string value");
940 :
cmd_(c,
"s:n",
"Clear the configuration archive list")
944 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const)
956 class shutdown_ :
public xmlrpc_c::registry::shutdown
959 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
961 virtual void doit(
const std::string& paramString,
void*)
const
963 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
965 << paramString <<
"\"";
966 _server->terminate();
969 xmlrpc_c::serverAbyss *_server;
975 , port_(ps.get<int>(
"id", 0))
976 , serverUrl_(ps.get<std::string>(
"server_url",
""))
979 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
980 if (serverUrl_.find(
"http") == std::string::npos)
982 serverUrl_ =
"http://" + serverUrl_;
984 if (serverUrl_.find(std::to_string(port_)) == std::string::npos && serverUrl_.find(
':', 7) == std::string::npos)
986 serverUrl_ = serverUrl_ +
":" + std::to_string(port_);
988 if (serverUrl_.find(
"RPC2") == std::string::npos)
990 serverUrl_ = serverUrl_ +
"/RPC2";
992 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
998 xmlrpc_c::registry registry;
999 struct xmlrpc_method_info3 methodInfo;
1000 memset(&methodInfo, 0,
sizeof(methodInfo));
1005 #define register_method(m) register_method2(m, 0x400000)
1008 xmlrpc_registry*** c_registryPPP;
1009 c_registryPPP = (xmlrpc_registry***)(((
char*)®istry) +
sizeof(girmem::autoObject));
1011 #define register_method2(m, ss) \
1012 xmlrpc_c::method* ptr_##m(dynamic_cast<xmlrpc_c::method*>(new m##_(*this))); \
1013 std::string m##signature = ptr_##m->signature(), m##help = ptr_##m->help(); \
1014 methodInfo.methodName = "daq." #m; \
1015 methodInfo.methodFunction = &c_executeMethod; \
1016 methodInfo.serverInfo = ptr_##m; \
1017 methodInfo.stackSize = ss; \
1018 methodInfo.signatureString = &m##signature[0]; \
1019 methodInfo.help = &m##help[0]; \
1020 xmlrpc_env_init(&env); \
1021 xmlrpc_registry_add_method3(&env, **c_registryPPP, &methodInfo); \
1022 if (env.fault_occurred) throw(girerr::error(env.fault_string)); \
1023 xmlrpc_env_clean(&env)
1025 register_method2(init, 0x200000);
1026 register_method(soft_init);
1027 register_method(reinit);
1028 register_method(start);
1029 register_method(status);
1030 register_method(report);
1031 register_method(stop);
1032 register_method(pause);
1033 register_method(resume);
1034 register_method(register_monitor);
1035 register_method(unregister_monitor);
1036 register_method(legal_commands);
1037 register_method(trace_set);
1038 register_method(trace_get);
1039 register_method(meta_command);
1040 register_method(rollover_subrun);
1044 register_method(shutdown);
1047 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
1048 registry.addMethod(
"daq.reset", ptr_reset);
1050 #undef register_method
1067 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1069 if (socket_file_descriptor < 0)
1071 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the socket() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1075 int retval = setsockopt(socket_file_descriptor,
1076 SOL_SOCKET, SO_REUSEADDR,
1077 &enable,
sizeof(
int));
1081 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the call to setsockopt(); C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1084 struct sockaddr_in sockAddr;
1086 sockAddr.sin_family = AF_INET;
1087 sockAddr.sin_port = htons(port_);
1088 sockAddr.sin_addr.s_addr = 0;
1090 retval = bind(socket_file_descriptor,
1091 reinterpret_cast<struct sockaddr*>(&sockAddr),
1096 close(socket_file_descriptor);
1097 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the bind() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1100 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1103 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1104 registry.setShutdown(&shutdown_obj);
1107 TLOG(TLVL_DEBUG) <<
"running server";
1123 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing";
1125 close(socket_file_descriptor);
1129 close(socket_file_descriptor);
1130 TLOG(TLVL_DEBUG) <<
"server terminated";
1137 std::string xmlrpc_commander::send_command_(std::string command)
1139 if (serverUrl_ ==
"")
1141 std::stringstream errmsg;
1142 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1143 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1145 xmlrpc_c::clientSimple myClient;
1146 xmlrpc_c::value result;
1150 myClient.call(serverUrl_,
"daq." + command,
"", &result);
1154 std::stringstream errmsg;
1155 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1156 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1157 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1160 return xmlrpc_c::value_string(result);
1163 std::string xmlrpc_commander::send_command_(std::string command, std::string arg)
1165 if (serverUrl_ ==
"")
1167 std::stringstream errmsg;
1168 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1169 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1171 xmlrpc_c::clientSimple myClient;
1172 xmlrpc_c::value result;
1176 myClient.call(serverUrl_,
"daq." + command,
"s", &result, arg.c_str());
1180 std::stringstream errmsg;
1181 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1182 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1183 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1186 return xmlrpc_c::value_string(result);
1189 std::string xmlrpc_commander::send_command_(std::string command, fhicl::ParameterSet pset, uint64_t timestamp, uint64_t timeout)
1191 if (serverUrl_ ==
"")
1193 std::stringstream errmsg;
1194 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1195 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1197 xmlrpc_c::clientSimple myClient;
1198 xmlrpc_c::value result;
1202 myClient.call(serverUrl_,
"daq." + command,
"sii", &result, pset.to_string().c_str(), timestamp, timeout);
1206 std::stringstream errmsg;
1207 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1208 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1209 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1212 return xmlrpc_c::value_string(result);
1215 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t a, uint64_t b)
1217 if (serverUrl_ ==
"")
1219 std::stringstream errmsg;
1220 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1221 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1223 xmlrpc_c::clientSimple myClient;
1224 xmlrpc_c::value result;
1228 myClient.call(serverUrl_,
"daq." + command,
"ii", &result, a, b);
1232 std::stringstream errmsg;
1233 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1234 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1235 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1238 return xmlrpc_c::value_string(result);
1241 std::string artdaq::xmlrpc_commander::send_command_(std::string command, art::RunID r, uint64_t a, uint64_t b)
1243 if (serverUrl_ ==
"")
1245 std::stringstream errmsg;
1246 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1247 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1249 xmlrpc_c::clientSimple myClient;
1250 xmlrpc_c::value result;
1254 myClient.call(serverUrl_,
"daq." + command,
"iii", &result, r, a, b);
1258 std::stringstream errmsg;
1259 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1260 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1261 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1264 return xmlrpc_c::value_string(result);
1267 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t arg1)
1269 if (serverUrl_ ==
"")
1271 std::stringstream errmsg;
1272 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1273 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1275 xmlrpc_c::clientSimple myClient;
1276 xmlrpc_c::value result;
1280 myClient.call(serverUrl_,
"daq." + command,
"i", &result, arg1);
1284 std::stringstream errmsg;
1285 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1286 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1287 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1290 return xmlrpc_c::value_string(result);
1293 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2)
1295 if (serverUrl_ ==
"")
1297 std::stringstream errmsg;
1298 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1299 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1301 xmlrpc_c::clientSimple myClient;
1302 xmlrpc_c::value result;
1306 myClient.call(serverUrl_,
"daq." + command,
"ss", &result, arg1.c_str(), arg2.c_str());
1310 std::stringstream errmsg;
1311 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1312 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1313 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1316 return xmlrpc_c::value_string(result);
1319 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2, uint64_t arg3)
1321 if (serverUrl_ ==
"")
1323 std::stringstream errmsg;
1324 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1325 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1327 xmlrpc_c::clientSimple myClient;
1328 xmlrpc_c::value result;
1332 myClient.call(serverUrl_,
"daq." + command,
"ssi", &result, arg1.c_str(), arg2.c_str(), arg3);
1336 std::stringstream errmsg;
1337 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1338 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1339 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1342 return xmlrpc_c::value_string(result);
1347 return send_command_(
"register_monitor", monitor_fhicl);
1351 return send_command_(
"unregister_monitor", monitor_label);
1355 return send_command_(
"init", ps, a, b);
1359 return send_command_(
"soft_init", ps, a, b);
1363 return send_command_(
"reinit", ps, a, b);
1367 return send_command_(
"start", r, a, b);
1371 return send_command_(
"pause", a, b);
1375 return send_command_(
"resume", a, b);
1379 return send_command_(
"stop", a, b);
1383 return send_command_(
"shutdown", a);
1387 return send_command_(
"status");
1391 return send_command_(
"report", what);
1395 return send_command_(
"legal_commands");
1399 return send_command_(
"trace_get", name);
1403 return send_command_(
"trace_set", name, which, mask);
1407 return send_command_(
"meta_command", command, arg);
1411 return send_command_(
"rollover_subrun", when, sr);
virtual bool do_add_config_archive_entry(std::string const &, std::string const &)
Add the specified key-value pair to the configuration archive list.
std::string send_stop(uint64_t, uint64_t) override
Send a stop command over XMLRPC
std::string send_shutdown(uint64_t) override
Send a shutdown command over XMLRPC
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
virtual bool do_clear_config_archive()
Clears the configuration archive list.
xmlrpc_commander(fhicl::ParameterSet ps, artdaq::Commandable &commandable)
xmlrpc_commander Constructor
Command class representing a start transition.
rollover_subrun_(xmlrpc_commander &c)
shutdown_ Constructor
std::string send_soft_init(fhicl::ParameterSet, uint64_t, uint64_t) override
Send a soft_init command over XMLRPC
std::string send_pause(uint64_t, uint64_t) override
Send a pause command over XMLRPC
virtual std::string clear_config_archive()
Using the transport mechanism, send a clear_config_archive command
virtual std::string unregister_monitor(std::string const &)
Perform the unregister_monitor action.
std::string send_status() override
Send a status command over XMLRPC
std::string send_legal_commands() override
Send a legal_commands command over XMLRPC
The xmlrpc_commander class serves as the XMLRPC server run in each artdaq application.
static const uint64_t defaultTimestamp
static const uint32_t defaultSubrunNumber
Default subrun number for command.
The "cmd_" class serves as the base class for all artdaq's XML-RPC commands.
trace_set_(xmlrpc_commander &c)
unregister_monitor_ Constructor
std::string send_report(std::string) override
Send a report command over XMLRPC
void run_server() override
Run the XMLRPC server.
std::string send_meta_command(std::string, std::string) override
Send an send_meta_command command over XMLRPC
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
Default Sequence ID for command.
add_config_archive_entry_(xmlrpc_commander &c)
add_config_archive_entry_ Constructor
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
add_config_archive_entry_ Command class
legal_commands_ Command class
artdaq::Commandable & _commandable
Reference to the Commandable that this Commander Commands.
std::string send_trace_get(std::string) override
Send an send_trace_get command over XMLRPC
std::string send_reinit(fhicl::ParameterSet, uint64_t, uint64_t) override
Send a reinit command over XMLRPC
xmlrpc_commander & _c
The xmlrpc_commander instance that the command will be sent to.
clear_config_archive_ Command class
std::string send_resume(uint64_t, uint64_t) override
Send a resume command over XMLRPC
status_(xmlrpc_commander &c)
status_ Constructor
clear_config_archive_(xmlrpc_commander &c)
clear_config_archive_ 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
std::string send_rollover_subrun(uint64_t, uint32_t) override
Send a send_rollover_subrun command over XMLRPC
std::vector< std::string > legal_commands() const
Get the legal transition commands from the current state.
std::string send_start(art::RunID, uint64_t, uint64_t) override
Send a start command over XMLRPC
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 add_config_archive_entry(std::string, std::string)
Using the transport mechanism, send an add_config_archive_entry command
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...
std::string send_init(fhicl::ParameterSet, uint64_t, uint64_t) override
Send an init command over XMLRPC
trace_get_(xmlrpc_commander &c)
trace_msgfacility_set_ Constructor
std::string send_trace_set(std::string, std::string, uint64_t) override
Send an send_trace_msgfacility_set command over XMLRPC
std::atomic< bool > running_
Whether the server is running and able to respond to requests.
virtual bool do_rollover_subrun(uint64_t eventNum, uint32_t subrunNum)
Perform the rollover_subrun transition.
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.