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 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getInt(index);
355 art::RunNumber_t run_number(paramList.getInt(index));
356 art::RunID run_id(run_number);
370 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
372 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
373 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
374 std::string configString = std::string(paramList.getString(index).c_str());
375 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
376 fhicl::ParameterSet pset;
380 fhicl::make_ParameterSet(configString, pset);
382 catch (
const fhicl::exception& e)
384 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
386 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
387 setenv(
"FHICL_FILE_PATH",
".", 0);
389 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
390 fhicl::make_ParameterSet(configString, lookup_policy, pset);
393 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
401 T val = default_value;
405 val = getParam<T>(paramList, index);
407 catch (
const cet::exception& exception)
417 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
419 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::chrono::milliseconds(250));
436 if (!retvalP->isInstantiated())
438 *retvalP = xmlrpc_c::value_string(
"Success");
444 *retvalP = xmlrpc_c::value_string(problemReport);
447 catch (std::runtime_error& er)
450 *retvalP = xmlrpc_c::value_string(msg);
451 TLOG(TLVL_ERROR) << msg;
453 catch (art::Exception& er)
456 *retvalP = xmlrpc_c::value_string(msg);
457 TLOG(TLVL_ERROR) << msg;
459 catch (cet::exception& er)
462 *retvalP = xmlrpc_c::value_string(msg);
463 TLOG(TLVL_ERROR) << msg;
468 *retvalP = xmlrpc_c::value_string(msg);
469 TLOG(TLVL_ERROR) << msg;
474 *retvalP = xmlrpc_c::value_string(
"busy");
486 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
488 class NAME##_ : public cmd_ \
494 explicit NAME##_(xmlrpc_commander& c) : cmd_(c, "s:sII", DESCRIPTION) {} \
497 static const uint64_t defaultTimeout = 45; \
499 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
502 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP) \
504 fhicl::ParameterSet ps; \
507 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
511 *retvalP = xmlrpc_c::value_string("Error: The " #NAME " message requires a single argument that is a string containing the initialization ParameterSet"); \
515 return _c._commandable.CALL(ps, \
516 getParam<uint64_t>(paramList, 1, defaultTimeout), \
517 getParam<uint64_t>(paramList, 2, defaultTimestamp)); \
521 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
523 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
525 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
527 #undef GENERATE_INIT_TRANSITION
542 :
cmd_(c,
"s:iII",
"start the run")
551 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
555 getParam<art::RunID>(paramList, 0);
559 *retvalP = xmlrpc_c::value_string(
"Error: The start message requires the run number as an argument.");
577 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
579 class NAME##_ : public cmd_ \
584 NAME##_(xmlrpc_commander& c) : cmd_(c, "s:II", DESCRIPTION) {} \
587 static const uint64_t defaultTimeout = TIMEOUT; \
589 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
592 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const) \
594 return _c._commandable.CALL(getParam<uint64_t>(paramList, 0, defaultTimeout), \
595 getParam<uint64_t>(paramList, 1, defaultTimestamp)); \
599 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
601 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
603 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
605 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
618 :
cmd_(c,
"s:i",
"shutdown the program")
625 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
648 :
cmd_(c,
"s:n",
"report the current state")
652 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
670 :
cmd_(c,
"s:s",
"report statistics")
674 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
678 getParam<std::string>(paramList, 0);
682 *retvalP = xmlrpc_c::value_string(
"Error: The report message requires a single argument that selects the type of statistics to be reported.");
702 :
cmd_(c,
"s:n",
"return the currently legal commands")
706 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const retvalP)
709 std::string resultString;
711 for (
auto& cmd : cmdList)
713 resultString.append(cmd +
" ");
714 if (cmd ==
"shutdown")
716 resultString.append(
" reset");
719 *retvalP = xmlrpc_c::value_string(resultString);
736 :
cmd_(c,
"s:s",
"Get notified of a new monitor")
740 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
744 getParam<fhicl::ParameterSet>(paramList, 0);
748 *retvalP = xmlrpc_c::value_string(
"Error: The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
768 :
cmd_(c,
"s:s",
"Remove a monitor")
772 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
776 getParam<std::string>(paramList, 0);
780 *retvalP = xmlrpc_c::value_string(
"Error: The unregister_monitor command expects a string representing the label of the monitor to be removed");
800 :
cmd_(c,
"s:ssI",
"Set TRACE mask")
804 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
808 getParam<std::string>(paramList, 0);
809 getParam<std::string>(paramList, 1);
810 getParam<std::string>(paramList, 2);
814 *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");
818 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<std::string>(paramList, 2));
833 :
cmd_(c,
"s:s",
"Get TRACE mask")
837 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
841 getParam<std::string>(paramList, 0);
845 *retvalP = xmlrpc_c::value_string(
"Error: The trace_get command expects a name (ALL for all)");
865 :
cmd_(c,
"s:ss",
"Run custom command")
869 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
873 getParam<std::string>(paramList, 0);
874 getParam<std::string>(paramList, 1);
878 *retvalP = xmlrpc_c::value_string(
"Error: The meta_command command expects a string command and a string argument");
897 :
cmd_(c,
"s:Ii",
"create a new subrun")
904 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const)
922 :
cmd_(c,
"s:ss",
"Add an entry to the configuration archive list")
926 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
930 getParam<std::string>(paramList, 0);
931 getParam<std::string>(paramList, 1);
935 *retvalP = xmlrpc_c::value_string(
"Error: The add_config_archive_entry command expects a string key and a string value");
954 :
cmd_(c,
"s:n",
"Clear the configuration archive list")
958 bool execute_(xmlrpc_c::paramList
const&, xmlrpc_c::value*
const)
970 class shutdown_ :
public xmlrpc_c::registry::shutdown
973 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
975 virtual void doit(
const std::string& paramString,
void*)
const
977 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
979 << paramString <<
"\"";
980 _server->terminate();
983 xmlrpc_c::serverAbyss *_server;
989 , port_(ps.get<int>(
"id", 0))
990 , serverUrl_(ps.get<std::string>(
"server_url",
""))
993 if (serverUrl_ ==
"")
995 char hostname[HOST_NAME_MAX];
996 gethostname(hostname, HOST_NAME_MAX);
997 serverUrl_ = std::string(hostname);
999 if (serverUrl_.find(
"http") == std::string::npos)
1001 serverUrl_ =
"http://" + serverUrl_;
1003 if (serverUrl_.find(std::to_string(port_)) == std::string::npos && serverUrl_.find(
':', 7) == std::string::npos)
1005 serverUrl_ = serverUrl_ +
":" + std::to_string(port_);
1007 if (serverUrl_.find(
"RPC2") == std::string::npos)
1009 serverUrl_ = serverUrl_ +
"/RPC2";
1011 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
1017 xmlrpc_c::registry registry;
1018 struct xmlrpc_method_info3 methodInfo;
1019 memset(&methodInfo, 0,
sizeof(methodInfo));
1024 #define register_method(m) register_method2(m, 0x400000)
1027 xmlrpc_registry*** c_registryPPP;
1028 c_registryPPP = (xmlrpc_registry***)(((
char*)®istry) +
sizeof(girmem::autoObject));
1030 #define register_method2(m, ss) \
1031 xmlrpc_c::method* ptr_##m(dynamic_cast<xmlrpc_c::method*>(new m##_(*this))); \
1032 std::string m##signature = ptr_##m->signature(), m##help = ptr_##m->help(); \
1033 methodInfo.methodName = "daq." #m; \
1034 methodInfo.methodFunction = &c_executeMethod; \
1035 methodInfo.serverInfo = ptr_##m; \
1036 methodInfo.stackSize = ss; \
1037 methodInfo.signatureString = &m##signature[0]; \
1038 methodInfo.help = &m##help[0]; \
1039 xmlrpc_env_init(&env); \
1040 xmlrpc_registry_add_method3(&env, **c_registryPPP, &methodInfo); \
1041 if (env.fault_occurred) throw(girerr::error(env.fault_string)); \
1042 xmlrpc_env_clean(&env)
1044 register_method2(init, 0x200000);
1045 register_method(soft_init);
1046 register_method(reinit);
1047 register_method(start);
1048 register_method(status);
1049 register_method(report);
1050 register_method(stop);
1051 register_method(pause);
1052 register_method(resume);
1053 register_method(register_monitor);
1054 register_method(unregister_monitor);
1055 register_method(legal_commands);
1056 register_method(trace_set);
1057 register_method(trace_get);
1058 register_method(meta_command);
1059 register_method(rollover_subrun);
1063 register_method(shutdown);
1066 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
1067 registry.addMethod(
"daq.reset", ptr_reset);
1069 #undef register_method
1086 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1088 if (socket_file_descriptor < 0)
1090 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the socket() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1094 int retval = setsockopt(socket_file_descriptor,
1095 SOL_SOCKET, SO_REUSEADDR,
1096 &enable,
sizeof(
int));
1100 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the call to setsockopt(); C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1103 struct sockaddr_in sockAddr;
1105 sockAddr.sin_family = AF_INET;
1106 sockAddr.sin_port = htons(port_);
1107 sockAddr.sin_addr.s_addr = 0;
1109 retval = bind(socket_file_descriptor,
1110 reinterpret_cast<struct sockaddr*>(&sockAddr),
1115 close(socket_file_descriptor);
1116 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the bind() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1119 server.reset(
new xmlrpc_c::serverAbyss(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor)));
1122 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1123 registry.setShutdown(&shutdown_obj);
1126 TLOG(TLVL_DEBUG) <<
"running server";
1142 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing";
1144 close(socket_file_descriptor);
1148 close(socket_file_descriptor);
1149 TLOG(TLVL_DEBUG) <<
"server terminated";
1156 std::string xmlrpc_commander::send_command_(std::string command)
1158 if (serverUrl_ ==
"")
1160 std::stringstream errmsg;
1161 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1162 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1164 xmlrpc_c::clientSimple myClient;
1165 xmlrpc_c::value result;
1169 myClient.call(serverUrl_,
"daq." + command,
"", &result);
1173 std::stringstream errmsg;
1174 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1175 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1176 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1179 return xmlrpc_c::value_string(result);
1182 std::string xmlrpc_commander::send_command_(std::string command, std::string arg)
1184 if (serverUrl_ ==
"")
1186 std::stringstream errmsg;
1187 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1188 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1190 xmlrpc_c::clientSimple myClient;
1191 xmlrpc_c::value result;
1195 myClient.call(serverUrl_,
"daq." + command,
"s", &result, arg.c_str());
1199 std::stringstream errmsg;
1200 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1201 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1202 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1205 return xmlrpc_c::value_string(result);
1208 std::string xmlrpc_commander::send_command_(std::string command, fhicl::ParameterSet pset, uint64_t timestamp, uint64_t timeout)
1210 if (serverUrl_ ==
"")
1212 std::stringstream errmsg;
1213 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1214 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1216 xmlrpc_c::clientSimple myClient;
1217 xmlrpc_c::value result;
1221 myClient.call(serverUrl_,
"daq." + command,
"sII", &result, pset.to_string().c_str(), timestamp, timeout);
1225 std::stringstream errmsg;
1226 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1227 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1228 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1231 return xmlrpc_c::value_string(result);
1234 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t a, uint64_t b)
1236 if (serverUrl_ ==
"")
1238 std::stringstream errmsg;
1239 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1240 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1242 xmlrpc_c::clientSimple myClient;
1243 xmlrpc_c::value result;
1247 myClient.call(serverUrl_,
"daq." + command,
"II", &result, a, b);
1251 std::stringstream errmsg;
1252 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1253 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1254 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1257 return xmlrpc_c::value_string(result);
1260 std::string artdaq::xmlrpc_commander::send_command_(std::string command, art::RunID r, uint64_t a, uint64_t b)
1262 if (serverUrl_ ==
"")
1264 std::stringstream errmsg;
1265 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1266 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1268 xmlrpc_c::clientSimple myClient;
1269 xmlrpc_c::value result;
1273 myClient.call(serverUrl_,
"daq." + command,
"iII", &result, r.run(), a, b);
1277 std::stringstream errmsg;
1278 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1279 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1280 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1283 return xmlrpc_c::value_string(result);
1286 std::string artdaq::xmlrpc_commander::send_command_(std::string command, uint64_t arg1)
1288 if (serverUrl_ ==
"")
1290 std::stringstream errmsg;
1291 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1292 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1294 xmlrpc_c::clientSimple myClient;
1295 xmlrpc_c::value result;
1299 myClient.call(serverUrl_,
"daq." + command,
"I", &result, arg1);
1303 std::stringstream errmsg;
1304 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1305 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1306 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1309 return xmlrpc_c::value_string(result);
1312 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2)
1314 if (serverUrl_ ==
"")
1316 std::stringstream errmsg;
1317 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1318 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1320 xmlrpc_c::clientSimple myClient;
1321 xmlrpc_c::value result;
1325 myClient.call(serverUrl_,
"daq." + command,
"ss", &result, arg1.c_str(), arg2.c_str());
1329 std::stringstream errmsg;
1330 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1331 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1332 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1335 return xmlrpc_c::value_string(result);
1338 std::string artdaq::xmlrpc_commander::send_command_(std::string command, std::string arg1, std::string arg2, std::string arg3)
1340 if (serverUrl_ ==
"")
1342 std::stringstream errmsg;
1343 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1344 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1346 xmlrpc_c::clientSimple myClient;
1347 xmlrpc_c::value result;
1351 myClient.call(serverUrl_,
"daq." + command,
"sss", &result, arg1.c_str(), arg2.c_str(), arg3.c_str());
1355 std::stringstream errmsg;
1356 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1357 <<
"; possible causes are bad arguments or nonexistent process at requested port";
1358 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1361 return xmlrpc_c::value_string(result);
1366 return send_command_(
"register_monitor", monitor_fhicl);
1370 return send_command_(
"unregister_monitor", monitor_label);
1374 return send_command_(
"init", ps, timeout, timestamp);
1378 return send_command_(
"soft_init", ps, timeout, timestamp);
1382 return send_command_(
"reinit", ps, timeout, timestamp);
1386 return send_command_(
"start", run, timeout, timestamp);
1390 return send_command_(
"pause", timeout, timestamp);
1394 return send_command_(
"resume", timeout, timestamp);
1398 return send_command_(
"stop", timeout, timestamp);
1402 return send_command_(
"shutdown", timeout);
1406 return send_command_(
"status");
1410 return send_command_(
"report", what);
1414 return send_command_(
"legal_commands");
1418 return send_command_(
"trace_get", name);
1422 return send_command_(
"trace_set", name, type, mask);
1426 return send_command_(
"meta_command", command, arg);
1430 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.