6 #pragma GCC diagnostic push
7 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
8 #define _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES 1
10 #include <xmlrpc-c/base.hpp>
11 #include <xmlrpc-c/client_simple.hpp>
12 #include <xmlrpc-c/girerr.hpp>
13 #include <xmlrpc-c/registry.hpp>
14 #include <xmlrpc-c/server_abyss.hpp>
15 #undef _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES
16 #pragma GCC diagnostic pop
22 #include "artdaq/DAQdata/Globals.hh"
23 #define TRACE_NAME (app_name + "_xmlrpc_commander").c_str()
26 #include <netinet/in.h>
27 #include <sys/socket.h>
31 #include "artdaq-core/Utilities/ExceptionHandler.hh"
33 #include "canvas/Persistency/Provenance/RunID.h"
34 #include "fhiclcpp/make_ParameterSet.h"
36 #include "artdaq/ExternalComms/xmlrpc_commander.hh"
46 env_wrap() { xmlrpc_env_init(&this->env_c); };
47 ~
env_wrap() { xmlrpc_env_clean(&this->env_c); };
56 static xmlrpc_c::paramList
57 pListFromXmlrpcArray(xmlrpc_value*
const arrayP)
60 XMLRPC_ASSERT_ARRAY_OK(arrayP);
61 unsigned int const arraySize = xmlrpc_array_size(&env.env_c, arrayP);
62 assert(!env.env_c.fault_occurred);
63 xmlrpc_c::paramList paramList(arraySize);
64 for (
unsigned int i = 0; i < arraySize; ++i)
66 xmlrpc_value* arrayItemP;
67 xmlrpc_array_read_item(&env.env_c, arrayP, i, &arrayItemP);
68 assert(!env.env_c.fault_occurred);
69 paramList.add(xmlrpc_c::value(arrayItemP));
70 xmlrpc_DECREF(arrayItemP);
75 c_executeMethod(xmlrpc_env*
const envP,
76 xmlrpc_value*
const paramArrayP,
77 void*
const methodPtr,
78 void*
const callInfoPtr)
80 auto*
const methodP(static_cast<xmlrpc_c::method*>(methodPtr));
81 xmlrpc_c::paramList
const paramList(pListFromXmlrpcArray(paramArrayP));
82 auto*
const callInfoP(static_cast<xmlrpc_c::callInfo*>(callInfoPtr));
87 xmlrpc_c::value result;
90 auto*
const method2P(dynamic_cast<xmlrpc_c::method2*>(methodP));
91 if (method2P !=
nullptr)
93 method2P->execute(paramList, callInfoP, &result);
97 methodP->execute(paramList, &result);
100 catch (xmlrpc_c::fault
const& fault)
102 xmlrpc_env_set_fault(envP, fault.getCode(),
103 fault.getDescription().c_str());
105 if (envP->fault_occurred == 0)
107 if (result.isInstantiated())
109 retval = result.cValue();
114 "Xmlrpc-c user's xmlrpc_c::method object's "
115 "'execute method' failed to set the RPC result "
120 catch (std::exception
const& e)
123 "Unexpected error executing code for "
124 "particular method, detected by Xmlrpc-c "
125 "method registry code. Method did not "
126 "fail; rather, it did not complete at all. %s",
131 xmlrpc_env_set_fault(envP, XMLRPC_INTERNAL_ERROR,
132 "Unexpected error executing code for "
133 "particular method, detected by Xmlrpc-c "
134 "method registry code. Method did not "
135 "fail; rather, it did not complete at all.");
148 const std::string& helpText =
"execute request")
150 std::string msg(
"Exception when trying to ");
151 msg.append(helpText);
153 msg.append(er.what());
154 if (msg[msg.size() - 1] ==
'\n')
156 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')
176 msg.erase(msg.size() - 1);
188 const std::string& helpText)
190 std::string msg(
"Exception when trying to ");
191 msg.append(helpText);
193 msg.append(er.what());
194 if (msg[msg.size() - 1] ==
'\n')
196 msg.erase(msg.size() - 1);
208 const std::string& helpText)
210 std::string msg(
"Exception when trying to ");
211 msg.append(helpText);
213 msg.append(boost::diagnostic_information(er));
214 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
224 const std::string& helpText)
226 std::string msg(
"Exception when trying to ");
227 msg.append(helpText);
229 msg.append(er.what());
230 if (msg[msg.size() - 1] ==
'\n') msg.erase(msg.size() - 1);
241 const std::string& helpText)
243 std::string msg(
"Exception when trying to ");
244 msg.append(helpText);
247 if (msg[msg.size() - 1] ==
'\n')
249 msg.erase(msg.size() - 1);
271 class cmd_ :
public xmlrpc_c::method
284 _signature = signature;
293 void execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value* retvalP)
final;
303 virtual bool execute_(
const xmlrpc_c::paramList&, xmlrpc_c::value* retvalP) = 0;
315 T
getParam(
const xmlrpc_c::paramList& paramList,
int index);
341 T
getParam(
const xmlrpc_c::paramList& paramList,
int index, T default_value);
350 throw cet::exception(
"cmd_") <<
"Error in cmd_::getParam(): value type not supported" << std::endl;
362 uint64_t cmd_::getParam<uint64_t>(
const xmlrpc_c::paramList& paramList,
int index)
364 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as uint64_t.";
367 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getI8(index);
368 return static_cast<uint64_t
>(paramList.getI8(index));
372 TLOG(TLVL_TRACE) <<
"Param value (int): " << paramList.getInt(index);
373 return static_cast<uint64_t
>(paramList.getInt(index));
386 uint32_t cmd_::getParam<uint32_t>(
const xmlrpc_c::paramList& paramList,
int index)
388 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as uint32_t.";
389 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getInt(index);
390 return static_cast<uint32_t
>(paramList.getInt(index));
402 std::string cmd_::getParam<std::string>(
const xmlrpc_c::paramList& paramList,
int index)
404 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as string.";
405 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
406 return static_cast<std::string
>(paramList.getString(index));
418 art::RunID cmd_::getParam<art::RunID>(
const xmlrpc_c::paramList& paramList,
int index)
420 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as Run Number.";
421 art::RunNumber_t run_number;
424 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getInt(index);
425 run_number = art::RunNumber_t(paramList.getInt(index));
429 TLOG(TLVL_TRACE) <<
"Parameter is not an int. Trying string...";
431 auto runNumber = paramList.getString(index);
432 TLOG(TLVL_TRACE) <<
"Got run number string " << runNumber;
433 run_number = art::RunNumber_t(std::stoi(runNumber));
436 art::RunID run_id(run_number);
449 fhicl::ParameterSet cmd_::getParam<fhicl::ParameterSet>(
const xmlrpc_c::paramList& paramList,
int index)
451 TLOG(TLVL_TRACE) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
452 TLOG(TLVL_TRACE) <<
"Param value: " << paramList.getString(index);
453 std::string configString = std::string(paramList.getString(index));
454 TLOG(TLVL_DEBUG) <<
"Loading Parameter Set from string: " << configString << std::endl;
455 fhicl::ParameterSet pset;
459 fhicl::make_ParameterSet(configString, pset);
461 catch (
const fhicl::exception& e)
463 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
465 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
466 setenv(
"FHICL_FILE_PATH",
".", 0);
468 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
469 fhicl::make_ParameterSet(configString, lookup_policy, pset);
472 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
480 T val = default_value;
482 if (static_cast<unsigned>(index) < paramList.size())
484 val = getParam<T>(paramList, index);
489 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
491 TLOG(TLVL_TRACE) <<
"Received Request to " << _help <<
", attempting to get lock";
492 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::defer_lock);
493 lk.try_lock_for(std::chrono::milliseconds(250));
511 if (!retvalP->isInstantiated())
513 *retvalP = xmlrpc_c::value_string(
"Success");
519 *retvalP = xmlrpc_c::value_string(problemReport);
522 catch (std::runtime_error& er)
525 *retvalP = xmlrpc_c::value_string(msg);
526 TLOG(TLVL_ERROR) << msg;
528 catch (art::Exception& er)
531 *retvalP = xmlrpc_c::value_string(msg);
532 TLOG(TLVL_ERROR) << msg;
534 catch (cet::exception& er)
537 *retvalP = xmlrpc_c::value_string(msg);
538 TLOG(TLVL_ERROR) << msg;
540 catch (boost::exception& er)
543 *retvalP = xmlrpc_c::value_string(msg);
544 TLOG(TLVL_ERROR) << msg;
546 catch (std::exception& er)
549 *retvalP = xmlrpc_c::value_string(msg);
550 TLOG(TLVL_ERROR) << msg;
554 std::string msg =
exception_msg(
"Unknown exception (not from std, boost, cet, or art)", _help);
555 *retvalP = xmlrpc_c::value_string(msg);
556 TLOG(TLVL_ERROR) << msg;
563 TLOG(TLVL_ERROR) <<
"Unable to get lock while trying to " << _help <<
", returning busy";
564 *retvalP = xmlrpc_c::value_string(
"busy");
576 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
578 class NAME##_ : public cmd_ \
584 explicit NAME##_(xmlrpc_commander& c) : cmd_(c, "s:sII", DESCRIPTION) {} \
587 static const uint64_t defaultTimeout = 45; \
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 retvalP) \
594 fhicl::ParameterSet ps; \
597 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
601 *retvalP = xmlrpc_c::value_string("Error: The " #NAME " message requires a single argument that is a string containing the initialization ParameterSet"); \
605 return _c._commandable.CALL(ps, \
606 getParam<uint64_t>(paramList, 1, defaultTimeout), \
607 getParam<uint64_t>(paramList, 2, defaultTimestamp)); \
611 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
613 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
615 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
617 #undef GENERATE_INIT_TRANSITION
632 :
cmd_(c,
"s:iII",
"start the run")
641 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
645 getParam<art::RunID>(paramList, 0);
649 *retvalP = xmlrpc_c::value_string(
"Error: The start message requires the run number as an argument.");
667 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
669 class NAME##_ : public cmd_ \
674 NAME##_(xmlrpc_commander& c) : cmd_(c, "s:II", DESCRIPTION) {} \
677 static const uint64_t defaultTimeout = TIMEOUT; \
679 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
682 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const) \
684 return _c._commandable.CALL(getParam<uint64_t>(paramList, 0, defaultTimeout), \
685 getParam<uint64_t>(paramList, 1, defaultTimestamp)); \
689 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
691 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
693 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
695 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
708 :
cmd_(c,
"s:i",
"shutdown the program")
715 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const )
override
741 :
cmd_(c,
"s:n",
"report the current state")
745 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const retvalP)
override
763 :
cmd_(c,
"s:s",
"report statistics")
767 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
771 getParam<std::string>(paramList, 0);
775 *retvalP = xmlrpc_c::value_string(
"Error: The report message requires a single argument that selects the type of statistics to be reported.");
795 :
cmd_(c,
"s:n",
"return the currently legal commands")
799 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const retvalP)
override
802 std::string resultString;
804 for (
auto& cmd : cmdList)
806 resultString.append(cmd +
" ");
807 if (cmd ==
"shutdown")
809 resultString.append(
" reset");
812 *retvalP = xmlrpc_c::value_string(resultString);
829 :
cmd_(c,
"s:s",
"Get notified of a new monitor")
833 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
837 getParam<fhicl::ParameterSet>(paramList, 0);
841 *retvalP = xmlrpc_c::value_string(
"Error: The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
861 :
cmd_(c,
"s:s",
"Remove a monitor")
865 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
869 getParam<std::string>(paramList, 0);
873 *retvalP = xmlrpc_c::value_string(
"Error: The unregister_monitor command expects a string representing the label of the monitor to be removed");
893 :
cmd_(c,
"s:ssI",
"Set TRACE mask")
897 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
901 getParam<std::string>(paramList, 0);
902 getParam<std::string>(paramList, 1);
903 getParam<std::string>(paramList, 2);
907 *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");
911 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<std::string>(paramList, 2));
926 :
cmd_(c,
"s:s",
"Get TRACE mask")
930 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
934 getParam<std::string>(paramList, 0);
938 *retvalP = xmlrpc_c::value_string(
"Error: The trace_get command expects a name (ALL for all)");
958 :
cmd_(c,
"s:ss",
"Run custom command")
962 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
966 getParam<std::string>(paramList, 0);
967 getParam<std::string>(paramList, 1);
971 *retvalP = xmlrpc_c::value_string(
"Error: The meta_command command expects a string command and a string argument");
990 :
cmd_(c,
"s:Ii",
"create a new subrun")
997 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const )
override
1015 :
cmd_(c,
"s:ss",
"Add an entry to the configuration archive list")
1019 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
1023 getParam<std::string>(paramList, 0);
1024 getParam<std::string>(paramList, 1);
1028 *retvalP = xmlrpc_c::value_string(
"Error: The add_config_archive_entry command expects a string key and a string value");
1047 :
cmd_(c,
"s:n",
"Clear the configuration archive list")
1051 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const )
override
1063 class shutdown_ :
public xmlrpc_c::registry::shutdown
1066 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
1068 virtual void doit(
const std::string& paramString,
void*)
const
1070 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
1071 <<
"with parameter "
1072 << paramString <<
"\"";
1073 _server->terminate();
1076 xmlrpc_c::serverAbyss *_server;
1082 , port_(ps.get<int>(
"id", 0))
1083 , serverUrl_(ps.get<std::string>(
"server_url",
""))
1086 if (serverUrl_.empty())
1088 char hostname[HOST_NAME_MAX];
1089 gethostname(hostname, HOST_NAME_MAX);
1090 serverUrl_ = std::string(hostname);
1092 if (serverUrl_.find(
"http") == std::string::npos)
1094 serverUrl_ =
"http://" + serverUrl_;
1096 if (serverUrl_.find(std::to_string(port_)) == std::string::npos && serverUrl_.find(
':', 7) == std::string::npos)
1098 serverUrl_ = serverUrl_ +
":" + std::to_string(port_);
1100 if (serverUrl_.find(
"RPC2") == std::string::npos)
1102 serverUrl_ = serverUrl_ +
"/RPC2";
1104 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
1110 xmlrpc_c::registry registry;
1111 struct xmlrpc_method_info3 methodInfo;
1112 memset(&methodInfo, 0,
sizeof(methodInfo));
1117 #define register_method(m) register_method2(m, 0x400000)
1120 xmlrpc_registry*** c_registryPPP;
1121 c_registryPPP =
reinterpret_cast<xmlrpc_registry***
>(
reinterpret_cast<char*
>(®istry) +
sizeof(girmem::autoObject));
1123 #define register_method2(m, ss) \
1124 xmlrpc_c::method* ptr_##m(dynamic_cast<xmlrpc_c::method*>(new m##_(*this))); \
1125 std::string m##signature = ptr_##m->signature(), m##help = ptr_##m->help(); \
1126 methodInfo.methodName = "daq." #m; \
1127 methodInfo.methodFunction = &c_executeMethod; \
1128 methodInfo.serverInfo = ptr_##m; \
1129 methodInfo.stackSize = ss; \
1130 methodInfo.signatureString = &m##signature[0]; \
1131 methodInfo.help = &m##help[0]; \
1132 xmlrpc_env_init(&env); \
1133 xmlrpc_registry_add_method3(&env, **c_registryPPP, &methodInfo); \
1134 if (env.fault_occurred) throw(girerr::error(env.fault_string)); \
1135 xmlrpc_env_clean(&env)
1137 register_method2(init, 0x200000);
1138 register_method(soft_init);
1139 register_method(reinit);
1140 register_method(start);
1141 register_method(status);
1142 register_method(report);
1143 register_method(stop);
1144 register_method(pause);
1145 register_method(resume);
1146 register_method(register_monitor);
1147 register_method(unregister_monitor);
1148 register_method(legal_commands);
1149 register_method(trace_set);
1150 register_method(trace_get);
1151 register_method(meta_command);
1152 register_method(rollover_subrun);
1156 register_method(shutdown);
1159 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
1160 registry.addMethod(
"daq.reset", ptr_reset);
1162 #undef register_method
1179 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1181 if (socket_file_descriptor < 0)
1183 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the socket() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1187 int retval = setsockopt(socket_file_descriptor,
1188 SOL_SOCKET, SO_REUSEADDR,
1189 &enable,
sizeof(
int));
1193 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the call to setsockopt(); C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1196 struct sockaddr_in sockAddr;
1198 sockAddr.sin_family = AF_INET;
1199 sockAddr.sin_port = htons(port_);
1200 sockAddr.sin_addr.s_addr = 0;
1202 retval = bind(socket_file_descriptor,
1203 reinterpret_cast<struct sockaddr*>(&sockAddr),
1208 close(socket_file_descriptor);
1209 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the bind() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1212 server = std::make_unique<xmlrpc_c::serverAbyss>(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor));
1215 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1216 registry.setShutdown(&shutdown_obj);
1219 TLOG(TLVL_DEBUG) <<
"running server";
1235 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing";
1237 close(socket_file_descriptor);
1241 close(socket_file_descriptor);
1242 TLOG(TLVL_DEBUG) <<
"server terminated";
1249 std::string xmlrpc_commander::send_command_(
const std::string& command)
1251 if (serverUrl_.empty())
1253 std::stringstream errmsg;
1254 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1255 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1257 xmlrpc_c::clientSimple myClient;
1258 xmlrpc_c::value result;
1262 myClient.call(serverUrl_,
"daq." + command,
"", &result);
1266 std::stringstream errmsg;
1267 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1268 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1269 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1272 return xmlrpc_c::value_string(result);
1275 std::string xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg)
1277 if (serverUrl_.empty())
1279 std::stringstream errmsg;
1280 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1281 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1283 xmlrpc_c::clientSimple myClient;
1284 xmlrpc_c::value result;
1288 myClient.call(serverUrl_,
"daq." + command,
"s", &result, arg.c_str());
1292 std::stringstream errmsg;
1293 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1294 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1295 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1298 return xmlrpc_c::value_string(result);
1301 std::string xmlrpc_commander::send_command_(
const std::string& command,
const fhicl::ParameterSet& pset, uint64_t timestamp, uint64_t timeout)
1303 if (serverUrl_.empty())
1305 std::stringstream errmsg;
1306 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1307 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1309 xmlrpc_c::clientSimple myClient;
1310 xmlrpc_c::value result;
1314 myClient.call(serverUrl_,
"daq." + command,
"sII", &result, pset.to_string().c_str(), timestamp, timeout);
1318 std::stringstream errmsg;
1319 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1320 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1321 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1324 return xmlrpc_c::value_string(result);
1327 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t a, uint64_t b)
1329 if (serverUrl_.empty())
1331 std::stringstream errmsg;
1332 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1333 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1335 xmlrpc_c::clientSimple myClient;
1336 xmlrpc_c::value result;
1340 myClient.call(serverUrl_,
"daq." + command,
"II", &result, a, b);
1344 std::stringstream errmsg;
1345 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1346 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1347 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1350 return xmlrpc_c::value_string(result);
1353 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t a, uint32_t b)
1355 if (serverUrl_.empty())
1357 std::stringstream errmsg;
1358 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1359 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1361 xmlrpc_c::clientSimple myClient;
1362 xmlrpc_c::value result;
1366 myClient.call(serverUrl_,
"daq." + command,
"Ii", &result, a, b);
1370 std::stringstream errmsg;
1371 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1372 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1373 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1376 return xmlrpc_c::value_string(result);
1379 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, art::RunID r, uint64_t a, uint64_t b)
1381 if (serverUrl_.empty())
1383 std::stringstream errmsg;
1384 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1385 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1387 xmlrpc_c::clientSimple myClient;
1388 xmlrpc_c::value result;
1392 myClient.call(serverUrl_,
"daq." + command,
"iII", &result, r.run(), a, b);
1396 std::stringstream errmsg;
1397 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1398 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1399 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1402 return xmlrpc_c::value_string(result);
1405 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t arg1)
1407 if (serverUrl_.empty())
1409 std::stringstream errmsg;
1410 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1411 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1413 xmlrpc_c::clientSimple myClient;
1414 xmlrpc_c::value result;
1418 myClient.call(serverUrl_,
"daq." + command,
"I", &result, arg1);
1422 std::stringstream errmsg;
1423 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1424 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1425 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1428 return xmlrpc_c::value_string(result);
1431 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg1,
const std::string& arg2)
1433 if (serverUrl_.empty())
1435 std::stringstream errmsg;
1436 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1437 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1439 xmlrpc_c::clientSimple myClient;
1440 xmlrpc_c::value result;
1444 myClient.call(serverUrl_,
"daq." + command,
"ss", &result, arg1.c_str(), arg2.c_str());
1448 std::stringstream errmsg;
1449 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1450 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1451 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1454 return xmlrpc_c::value_string(result);
1457 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg1,
const std::string& arg2,
const std::string& arg3)
1459 if (serverUrl_.empty())
1461 std::stringstream errmsg;
1462 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1463 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1465 xmlrpc_c::clientSimple myClient;
1466 xmlrpc_c::value result;
1470 myClient.call(serverUrl_,
"daq." + command,
"sss", &result, arg1.c_str(), arg2.c_str(), arg3.c_str());
1474 std::stringstream errmsg;
1475 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1476 <<
"; possible causes are bad arguments or nonexistent process at requested port";
1477 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1480 return xmlrpc_c::value_string(result);
1485 return send_command_(
"register_monitor", monitor_fhicl);
1489 return send_command_(
"unregister_monitor", monitor_label);
1493 return send_command_(
"init", ps, timeout, timestamp);
1497 return send_command_(
"soft_init", ps, timeout, timestamp);
1501 return send_command_(
"reinit", ps, timeout, timestamp);
1505 return send_command_(
"start", run, timeout, timestamp);
1509 return send_command_(
"pause", timeout, timestamp);
1513 return send_command_(
"resume", timeout, timestamp);
1517 return send_command_(
"stop", timeout, timestamp);
1521 return send_command_(
"shutdown", timeout);
1525 return send_command_(
"status");
1529 return send_command_(
"report", what);
1533 return send_command_(
"legal_commands");
1537 return send_command_(
"trace_get", name);
1541 return send_command_(
"trace_set", name, type, mask);
1545 return send_command_(
"meta_command", command, arg);
1549 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.
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
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.
Command class representing a start transition.
rollover_subrun_(xmlrpc_commander &c)
shutdown_ Constructor
xmlrpc_commander(const fhicl::ParameterSet &ps, artdaq::Commandable &commandable)
xmlrpc_commander Constructor
std::string send_trace_set(std::string const &name, std::string const &type, std::string const &mask) override
Send an send_trace_msgfacility_set command over XMLRPC
std::string send_register_monitor(std::string const &monitor_fhicl) override
Send a register_monitor command over XMLRPC
std::string send_init(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp) override
Send an init command over XMLRPC
std::string send_meta_command(std::string const &command, std::string const &argument) override
Send an send_meta_command command over XMLRPC
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.
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_reinit(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp) override
Send a reinit 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
std::string send_trace_get(std::string const &name) override
Send an send_trace_get command over XMLRPC
virtual std::string register_monitor(fhicl::ParameterSet const &)
Perform the register_monitor action.
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.
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
virtual std::string add_config_archive_entry(std::string const &key, std::string const &value)
Using the transport mechanism, send an add_config_archive_entry command
void execute(const xmlrpc_c::paramList ¶mList, xmlrpc_c::value *retvalP) final
Execute trhe command with the given parameters.
status_(xmlrpc_commander &c)
status_ Constructor
clear_config_archive_(xmlrpc_commander &c)
clear_config_archive_ Constructor
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
std::string send_rollover_subrun(uint64_t when, uint32_t sr) override
Send a send_rollover_subrun command over XMLRPC
unregister_monitor_(xmlrpc_commander &c)
unregister_monitor_ Constructor
virtual bool execute_(const xmlrpc_c::paramList &, xmlrpc_c::value *retvalP)=0
"execute_" is a wrapper function around the call to the commandable object's function ...
shutdown_(xmlrpc_commander &c)
shutdown_ Constructor
std::vector< std::string > legal_commands() const
Get the legal transition commands from the current state.
std::string send_soft_init(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp) override
Send a soft_init command over XMLRPC
rollover_subrun_ Command class
std::string send_resume(uint64_t timeout, uint64_t timestamp) override
Send a resume command over XMLRPC
std::string send_unregister_monitor(std::string const &monitor_label) override
Send an unregister_monitor command over XMLRPC
std::string send_report(std::string const &what) override
Send a report command over XMLRPC
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 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...
virtual bool do_meta_command(std::string const &cmd, std::string const &args)
Run a module-defined command with the given parameter string.
trace_get_(xmlrpc_commander &c)
trace_msgfacility_set_ Constructor
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.