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.getI8(index);
307 return static_cast<uint64_t
>(paramList.getI8(index));
319 uint32_t cmd_::getParam<uint32_t>(
const xmlrpc_c::paramList& paramList,
int index)
321 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as uint32_t.";
322 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getInt(index);
323 return static_cast<uint32_t
>(paramList.getInt(index));
335 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
337 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as string.";
338 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
339 return static_cast<std::string
>(paramList.getString(index));
351 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
353 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as Run Number.";
354 art::RunNumber_t run_number;
356 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getInt(index);
357 run_number = art::RunNumber_t(paramList.getInt(index));
360 TLOG(TLVL_TRACE) <<
"Parameter is not an int. Trying string...";
362 auto runNumber = paramList.getString(index);
363 TLOG(TLVL_TRACE) <<
"Got run number string " << runNumber;
364 run_number = art::RunNumber_t(std::stoi(runNumber));
367 art::RunID run_id(run_number);
380 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
382 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
383 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
384 std::string configString = std::string(paramList.getString(index).c_str());
385 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
386 fhicl::ParameterSet pset;
390 fhicl::make_ParameterSet(configString, pset);
392 catch (
const fhicl::exception& e)
394 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
396 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
397 setenv(
"FHICL_FILE_PATH",
".", 0);
399 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
400 fhicl::make_ParameterSet(configString, lookup_policy, pset);
403 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
411 T val = default_value;
415 val = getParam<T>(paramList, index);
417 catch (
const cet::exception& exception)
427 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
429 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::chrono::milliseconds(250));
446 if (!retvalP->isInstantiated())
448 *retvalP = xmlrpc_c::value_string(
"Success");
454 *retvalP = xmlrpc_c::value_string(problemReport);
457 catch (std::runtime_error& er)
460 *retvalP = xmlrpc_c::value_string(msg);
461 TLOG(TLVL_ERROR) << msg;
463 catch (art::Exception& er)
466 *retvalP = xmlrpc_c::value_string(msg);
467 TLOG(TLVL_ERROR) << msg;
469 catch (cet::exception& er)
472 *retvalP = xmlrpc_c::value_string(msg);
473 TLOG(TLVL_ERROR) << msg;
478 *retvalP = xmlrpc_c::value_string(msg);
479 TLOG(TLVL_ERROR) << msg;
484 *retvalP = xmlrpc_c::value_string(
"busy");
496 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
498 class NAME##_ : public cmd_ \
504 explicit NAME##_(xmlrpc_commander& c) : cmd_(c, "s:sII", DESCRIPTION) {} \
507 static const uint64_t defaultTimeout = 45; \
509 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
512 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP) \
514 fhicl::ParameterSet ps; \
517 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
521 *retvalP = xmlrpc_c::value_string("Error: The " #NAME " message requires a single argument that is a string containing the initialization ParameterSet"); \
525 return _c._commandable.CALL(ps, \
526 getParam<uint64_t>(paramList, 1, defaultTimeout), \
527 getParam<uint64_t>(paramList, 2, defaultTimestamp)); \
531 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
533 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
535 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
537 #undef GENERATE_INIT_TRANSITION
552 :
cmd_(c,
"s:iII",
"start the run")
561 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
565 getParam<art::RunID>(paramList, 0);
569 *retvalP = xmlrpc_c::value_string(
"Error: The start message requires the run number as an argument.");
587 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
589 class NAME##_ : public cmd_ \
594 NAME##_(xmlrpc_commander& c) : cmd_(c, "s:II", DESCRIPTION) {} \
597 static const uint64_t defaultTimeout = TIMEOUT; \
599 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
602 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const) \
604 return _c._commandable.CALL(getParam<uint64_t>(paramList, 0, defaultTimeout), \
605 getParam<uint64_t>(paramList, 1, defaultTimestamp)); \
609 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
611 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
613 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
615 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
628 :
cmd_(c,
"s:i",
"shutdown the program")
635 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
658 :
cmd_(c,
"s:n",
"report the current state")
662 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
680 :
cmd_(c,
"s:s",
"report statistics")
684 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
688 getParam<std::string>(paramList, 0);
692 *retvalP = xmlrpc_c::value_string(
"Error: The report message requires a single argument that selects the type of statistics to be reported.");
712 :
cmd_(c,
"s:n",
"return the currently legal commands")
716 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
719 std::string resultString;
721 for (
auto& cmd : cmdList)
723 resultString.append(cmd +
" ");
724 if (cmd ==
"shutdown")
726 resultString.append(
" reset");
729 *retvalP = xmlrpc_c::value_string(resultString);
746 :
cmd_(c,
"s:s",
"Get notified of a new monitor")
750 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
754 getParam<fhicl::ParameterSet>(paramList, 0);
758 *retvalP = xmlrpc_c::value_string(
"Error: The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
778 :
cmd_(c,
"s:s",
"Remove a monitor")
782 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
786 getParam<std::string>(paramList, 0);
790 *retvalP = xmlrpc_c::value_string(
"Error: The unregister_monitor command expects a string representing the label of the monitor to be removed");
810 :
cmd_(c,
"s:ssI",
"Set TRACE mask")
814 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
818 getParam<std::string>(paramList, 0);
819 getParam<std::string>(paramList, 1);
820 getParam<std::string>(paramList, 2);
824 *retvalP = xmlrpc_c::value_string(
"Error: The trace_set command expects a name (ALL for all), a mask type (M, S , or T), and a mask");
828 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<std::string>(paramList, 2));
843 :
cmd_(c,
"s:s",
"Get TRACE mask")
847 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
851 getParam<std::string>(paramList, 0);
855 *retvalP = xmlrpc_c::value_string(
"Error: The trace_get command expects a name (ALL for all)");
875 :
cmd_(c,
"s:ss",
"Run custom command")
879 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
883 getParam<std::string>(paramList, 0);
884 getParam<std::string>(paramList, 1);
888 *retvalP = xmlrpc_c::value_string(
"Error: The meta_command command expects a string command and a string argument");
907 :
cmd_(c,
"s:Ii",
"create a new subrun")
914 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
932 :
cmd_(c,
"s:ss",
"Add an entry to the configuration archive list")
936 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
940 getParam<std::string>(paramList, 0);
941 getParam<std::string>(paramList, 1);
945 *retvalP = xmlrpc_c::value_string(
"Error: The add_config_archive_entry command expects a string key and a string value");
964 :
cmd_(c,
"s:n",
"Clear the configuration archive list")
968 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const)
980 class shutdown_ :
public xmlrpc_c::registry::shutdown
983 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
985 virtual void doit(
const std::string& paramString,
void*)
const
987 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
989 << paramString <<
"\"";
990 _server->terminate();
993 xmlrpc_c::serverAbyss *_server;
999 , port_(ps.get<int>(
"id", 0))
1000 , serverUrl_(ps.get<std::string>(
"server_url",
""))
1003 if (serverUrl_ ==
"")
1005 char hostname[HOST_NAME_MAX];
1006 gethostname(hostname, HOST_NAME_MAX);
1007 serverUrl_ = std::string(hostname);
1009 if (serverUrl_.find(
"http") == std::string::npos)
1011 serverUrl_ =
"http://" + serverUrl_;
1013 if (serverUrl_.find(std::to_string(port_)) == std::string::npos && serverUrl_.find(
':', 7) == std::string::npos)
1015 serverUrl_ = serverUrl_ +
":" + std::to_string(port_);
1017 if (serverUrl_.find(
"RPC2") == std::string::npos)
1019 serverUrl_ = serverUrl_ +
"/RPC2";
1021 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
1027 xmlrpc_c::registry registry;
1028 struct xmlrpc_method_info3 methodInfo;
1029 memset(&methodInfo, 0,
sizeof(methodInfo));
1034 #define register_method(m) register_method2(m, 0x400000)
1037 xmlrpc_registry*** c_registryPPP;
1038 c_registryPPP = (xmlrpc_registry***)(((
char*)®istry) +
sizeof(girmem::autoObject));
1040 #define register_method2(m, ss) \
1041 xmlrpc_c::method* ptr_##m(dynamic_cast<xmlrpc_c::method*>(new m##_(*this))); \
1042 std::string m##signature = ptr_##m->signature(), m##help = ptr_##m->help(); \
1043 methodInfo.methodName = "daq." #m; \
1044 methodInfo.methodFunction = &c_executeMethod; \
1045 methodInfo.serverInfo = ptr_##m; \
1046 methodInfo.stackSize = ss; \
1047 methodInfo.signatureString = &m##signature[0]; \
1048 methodInfo.help = &m##help[0]; \
1049 xmlrpc_env_init(&env); \
1050 xmlrpc_registry_add_method3(&env, **c_registryPPP, &methodInfo); \
1051 if (env.fault_occurred) throw(girerr::error(env.fault_string)); \
1052 xmlrpc_env_clean(&env)
1054 register_method2(init, 0x200000);
1055 register_method(soft_init);
1056 register_method(reinit);
1057 register_method(start);
1058 register_method(status);
1059 register_method(report);
1060 register_method(stop);
1061 register_method(pause);
1062 register_method(resume);
1063 register_method(register_monitor);
1064 register_method(unregister_monitor);
1065 register_method(legal_commands);
1066 register_method(trace_set);
1067 register_method(trace_get);
1068 register_method(meta_command);
1069 register_method(rollover_subrun);
1073 register_method(shutdown);
1076 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
1077 registry.addMethod(
"daq.reset", ptr_reset);
1079 #undef register_method
1096 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1098 if (socket_file_descriptor < 0)
1100 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the socket() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1104 int retval = setsockopt(socket_file_descriptor,
1105 SOL_SOCKET, SO_REUSEADDR,
1106 &enable,
sizeof(
int));
1110 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the call to setsockopt(); C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1113 struct sockaddr_in sockAddr;
1115 sockAddr.sin_family = AF_INET;
1116 sockAddr.sin_port = htons(port_);
1117 sockAddr.sin_addr.s_addr = 0;
1119 retval = bind(socket_file_descriptor,
1120 reinterpret_cast<struct sockaddr*>(&sockAddr),
1125 close(socket_file_descriptor);
1126 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the bind() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1129 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1132 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1133 registry.setShutdown(&shutdown_obj);
1136 TLOG(TLVL_DEBUG) <<
"running server";
1152 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing";
1154 close(socket_file_descriptor);
1158 close(socket_file_descriptor);
1159 TLOG(TLVL_DEBUG) <<
"server terminated";
1166 std::string xmlrpc_commander::send_command_(std::string command)
1168 if (serverUrl_ ==
"")
1170 std::stringstream errmsg;
1171 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1172 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1174 xmlrpc_c::clientSimple myClient;
1175 xmlrpc_c::value result;
1179 myClient.call(serverUrl_,
"daq." + command,
"", &result);
1183 std::stringstream errmsg;
1184 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1185 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1186 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1189 return xmlrpc_c::value_string(result);
1192 std::string xmlrpc_commander::send_command_(std::string command, std::string arg)
1194 if (serverUrl_ ==
"")
1196 std::stringstream errmsg;
1197 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1198 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1200 xmlrpc_c::clientSimple myClient;
1201 xmlrpc_c::value result;
1205 myClient.call(serverUrl_,
"daq." + command,
"s", &result, arg.c_str());
1209 std::stringstream errmsg;
1210 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1211 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1212 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1215 return xmlrpc_c::value_string(result);
1218 std::string xmlrpc_commander::send_command_(std::string command, fhicl::ParameterSet pset, uint64_t timestamp, uint64_t timeout)
1220 if (serverUrl_ ==
"")
1222 std::stringstream errmsg;
1223 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1224 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1226 xmlrpc_c::clientSimple myClient;
1227 xmlrpc_c::value result;
1231 myClient.call(serverUrl_,
"daq." + command,
"sII", &result, pset.to_string().c_str(), timestamp, timeout);
1235 std::stringstream errmsg;
1236 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1237 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1238 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1241 return xmlrpc_c::value_string(result);
1244 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t a, uint64_t b)
1246 if (serverUrl_ ==
"")
1248 std::stringstream errmsg;
1249 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1250 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1252 xmlrpc_c::clientSimple myClient;
1253 xmlrpc_c::value result;
1257 myClient.call(serverUrl_,
"daq." + command,
"II", &result, a, b);
1261 std::stringstream errmsg;
1262 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1263 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1264 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1267 return xmlrpc_c::value_string(result);
1270 std::string artdaq::xmlrpc_commander::send_command_(std::string command, art::RunID r, uint64_t a, uint64_t b)
1272 if (serverUrl_ ==
"")
1274 std::stringstream errmsg;
1275 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1276 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1278 xmlrpc_c::clientSimple myClient;
1279 xmlrpc_c::value result;
1283 myClient.call(serverUrl_,
"daq." + command,
"iII", &result, r.run(), a, b);
1287 std::stringstream errmsg;
1288 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1289 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1290 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1293 return xmlrpc_c::value_string(result);
1296 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t arg1)
1298 if (serverUrl_ ==
"")
1300 std::stringstream errmsg;
1301 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1302 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1304 xmlrpc_c::clientSimple myClient;
1305 xmlrpc_c::value result;
1309 myClient.call(serverUrl_,
"daq." + command,
"I", &result, arg1);
1313 std::stringstream errmsg;
1314 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1315 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1316 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1319 return xmlrpc_c::value_string(result);
1322 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2)
1324 if (serverUrl_ ==
"")
1326 std::stringstream errmsg;
1327 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1328 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1330 xmlrpc_c::clientSimple myClient;
1331 xmlrpc_c::value result;
1335 myClient.call(serverUrl_,
"daq." + command,
"ss", &result, arg1.c_str(), arg2.c_str());
1339 std::stringstream errmsg;
1340 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1341 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1342 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1345 return xmlrpc_c::value_string(result);
1348 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2, std::string arg3)
1350 if (serverUrl_ ==
"")
1352 std::stringstream errmsg;
1353 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1354 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1356 xmlrpc_c::clientSimple myClient;
1357 xmlrpc_c::value result;
1361 myClient.call(serverUrl_,
"daq." + command,
"sss", &result, arg1.c_str(), arg2.c_str(), arg3.c_str());
1365 std::stringstream errmsg;
1366 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1367 <<
"; possible causes are bad arguments or nonexistent process at requested port";
1368 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1371 return xmlrpc_c::value_string(result);
1376 return send_command_(
"register_monitor", monitor_fhicl);
1380 return send_command_(
"unregister_monitor", monitor_label);
1384 return send_command_(
"init", ps, timeout, timestamp);
1388 return send_command_(
"soft_init", ps, timeout, timestamp);
1392 return send_command_(
"reinit", ps, timeout, timestamp);
1396 return send_command_(
"start", run, timeout, timestamp);
1400 return send_command_(
"pause", timeout, timestamp);
1404 return send_command_(
"resume", timeout, timestamp);
1408 return send_command_(
"stop", timeout, timestamp);
1412 return send_command_(
"shutdown", timeout);
1416 return send_command_(
"status");
1420 return send_command_(
"report", what);
1424 return send_command_(
"legal_commands");
1428 return send_command_(
"trace_get", name);
1432 return send_command_(
"trace_set", name, type, mask);
1436 return send_command_(
"meta_command", command, arg);
1440 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_rollover_subrun(uint64_t seq, uint32_t subrunNumber) override
Send a send_rollover_subrun 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_trace_get(std::string name) override
Send an send_trace_get command over XMLRPC
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_stop(uint64_t timeout, uint64_t timestamp) override
Send a stop 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.
std::string send_meta_command(std::string command, std::string argument) override
Send an send_meta_command command over XMLRPC
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 send_shutdown(uint64_t timeout) override
Send a shutdown command over XMLRPC
std::string send_init(fhicl::ParameterSet ps, uint64_t timeout, uint64_t timestamp) override
Send an init command over XMLRPC
std::string exception_msg(const std::runtime_error &er, const std::string &helpText="execute request")
Write an exception message.
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.
virtual bool do_trace_set(std::string const &name, std::string const &type, std::string const &mask_in_string_form)
Set the given TRACE mask for the given TRACE name.
register_monitor_ Command class
add_config_archive_entry_ Command class
legal_commands_ Command class
std::string send_pause(uint64_t timeout, uint64_t timestamp) override
Send a pause command over XMLRPC
artdaq::Commandable & _commandable
Reference to the Commandable that this Commander Commands.
std::string send_trace_set(std::string name, std::string type, std::string mask) override
Send an send_trace_msgfacility_set command over XMLRPC
xmlrpc_commander & _c
The xmlrpc_commander instance that the command will be sent to.
std::string send_start(art::RunID runNumber, uint64_t timeout, uint64_t timestamp) override
Send a start command over XMLRPC
clear_config_archive_ Command class
std::string send_soft_init(fhicl::ParameterSet ps, uint64_t timeout, uint64_t timestamp) override
Send a soft_init command over XMLRPC
status_(xmlrpc_commander &c)
status_ Constructor
clear_config_archive_(xmlrpc_commander &c)
clear_config_archive_ Constructor
virtual std::string add_config_archive_entry(std::string key, std::string value)
Using the transport mechanism, send an add_config_archive_entry command
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::vector< std::string > legal_commands() const
Get the legal transition commands from the current state.
rollover_subrun_ Command class
std::string send_resume(uint64_t timeout, uint64_t timestamp) override
Send a resume command over XMLRPC
bool start(art::RunID id, uint64_t timeout, uint64_t timestamp)
Processes the start transition.
report_(xmlrpc_commander &c)
report_ Constructor
std::string send_report(std::string which) override
Send a report command over XMLRPC
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
std::string send_reinit(fhicl::ParameterSet ps, uint64_t timeout, uint64_t timestamp) override
Send a reinit 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.