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 "artdaq-utilities/Plugins/MakeParameterSet.hh"
34 #include "canvas/Persistency/Provenance/RunID.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_DEBUG + 33) <<
"Getting parameter " << index <<
" from list as uint64_t.";
367 TLOG(TLVL_DEBUG + 33) <<
"Param value: " << paramList.getI8(index);
368 return static_cast<uint64_t
>(paramList.getI8(index));
372 TLOG(TLVL_DEBUG + 33) <<
"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_DEBUG + 33) <<
"Getting parameter " << index <<
" from list as uint32_t.";
389 TLOG(TLVL_DEBUG + 33) <<
"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_DEBUG + 33) <<
"Getting parameter " << index <<
" from list as string.";
405 TLOG(TLVL_DEBUG + 33) <<
"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_DEBUG + 33) <<
"Getting parameter " << index <<
" from list as Run Number.";
421 art::RunNumber_t run_number;
424 TLOG(TLVL_DEBUG + 33) <<
"Param value: " << paramList.getInt(index);
425 run_number = art::RunNumber_t(paramList.getInt(index));
429 TLOG(TLVL_DEBUG + 33) <<
"Parameter is not an int. Trying string...";
431 auto runNumber = paramList.getString(index);
432 TLOG(TLVL_DEBUG + 33) <<
"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_DEBUG + 33) <<
"Getting parameter " << index <<
" from list as ParameterSet.";
452 TLOG(TLVL_DEBUG + 33) <<
"Param value: " << paramList.getString(index);
453 std::string configString = std::string(paramList.getString(index));
454 TLOG(TLVL_DEBUG + 32) <<
"Loading Parameter Set from string: " << configString << std::endl;
455 fhicl::ParameterSet pset;
459 pset = artdaq::make_pset(configString);
461 catch (
const fhicl::exception& e)
463 if (getenv(
"FHICL_FILE_PATH") ==
nullptr)
465 TLOG(TLVL_ERROR) <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"";
466 std::cerr <<
"INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"" << std::endl;
467 setenv(
"FHICL_FILE_PATH",
".", 0);
469 cet::filepath_lookup_after1 lookup_policy(
"FHICL_FILE_PATH");
470 pset = artdaq::make_pset(configString, lookup_policy);
473 TLOG(TLVL_INFO) <<
"Parameter Set Loaded." << std::endl;
481 T val = default_value;
483 if (static_cast<unsigned>(index) < paramList.size())
485 val = getParam<T>(paramList, index);
490 void cmd_::execute(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const retvalP)
492 TLOG(TLVL_DEBUG + 33) <<
"Received Request to " << _help <<
", attempting to get lock";
493 std::unique_lock<std::timed_mutex> lk(
_c.
mutex_, std::defer_lock);
494 lk.try_lock_for(std::chrono::milliseconds(250));
512 if (!retvalP->isInstantiated())
514 *retvalP = xmlrpc_c::value_string(
"Success");
520 *retvalP = xmlrpc_c::value_string(problemReport);
523 catch (std::runtime_error& er)
526 *retvalP = xmlrpc_c::value_string(msg);
527 TLOG(TLVL_ERROR) << msg;
529 catch (art::Exception& er)
532 *retvalP = xmlrpc_c::value_string(msg);
533 TLOG(TLVL_ERROR) << msg;
535 catch (cet::exception& er)
538 *retvalP = xmlrpc_c::value_string(msg);
539 TLOG(TLVL_ERROR) << msg;
541 catch (boost::exception& er)
544 *retvalP = xmlrpc_c::value_string(msg);
545 TLOG(TLVL_ERROR) << msg;
547 catch (std::exception& er)
550 *retvalP = xmlrpc_c::value_string(msg);
551 TLOG(TLVL_ERROR) << msg;
555 std::string msg =
exception_msg(
"Unknown exception (not from std, boost, cet, or art)", _help);
556 *retvalP = xmlrpc_c::value_string(msg);
557 TLOG(TLVL_ERROR) << msg;
564 TLOG(TLVL_ERROR) <<
"Unable to get lock while trying to " << _help <<
", returning busy";
565 *retvalP = xmlrpc_c::value_string(
"busy");
577 #define GENERATE_INIT_TRANSITION(NAME, CALL, DESCRIPTION) \
579 class NAME##_ : public cmd_ \
585 explicit NAME##_(xmlrpc_commander& c) : cmd_(c, "s:sII", DESCRIPTION) {} \
588 static const uint64_t defaultTimeout = 45; \
590 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
593 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const retvalP) \
595 fhicl::ParameterSet ps; \
598 ps = getParam<fhicl::ParameterSet>(paramList, 0); \
602 *retvalP = xmlrpc_c::value_string("Error: The " #NAME " message requires a single argument that is a string containing the initialization ParameterSet"); \
606 return _c._commandable.CALL(ps, \
607 getParam<uint64_t>(paramList, 1, defaultTimeout), \
608 getParam<uint64_t>(paramList, 2, defaultTimestamp)); \
612 GENERATE_INIT_TRANSITION(init, initialize,
"initialize the program")
614 GENERATE_INIT_TRANSITION(soft_init, soft_initialize, "initialize software components in the program")
616 GENERATE_INIT_TRANSITION(reinit, reinitialize, "re-initialize the program")
618 #undef GENERATE_INIT_TRANSITION
633 :
cmd_(c,
"s:iII",
"start the run")
642 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
646 getParam<art::RunID>(paramList, 0);
650 *retvalP = xmlrpc_c::value_string(
"Error: The start message requires the run number as an argument.");
668 #define GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(NAME, CALL, DESCRIPTION, TIMEOUT) \
670 class NAME##_ : public cmd_ \
675 NAME##_(xmlrpc_commander& c) : cmd_(c, "s:II", DESCRIPTION) {} \
678 static const uint64_t defaultTimeout = TIMEOUT; \
680 static const uint64_t defaultTimestamp = std::numeric_limits<const uint64_t>::max(); \
683 bool execute_(const xmlrpc_c::paramList& paramList, xmlrpc_c::value* const) \
685 return _c._commandable.CALL(getParam<uint64_t>(paramList, 0, defaultTimeout), \
686 getParam<uint64_t>(paramList, 1, defaultTimestamp)); \
690 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(pause, pause,
"pause the program", 45)
692 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(resume, resume, "resume the program", 45)
694 GENERATE_TIMEOUT_TIMESTAMP_TRANSITION(stop, stop, "stop the program", 45)
696 #undef GENERATE_TIMEOUT_TIMESTAMP_TRANSITION
709 :
cmd_(c,
"s:i",
"shutdown the program")
716 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const )
override
742 :
cmd_(c,
"s:n",
"report the current state")
746 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const retvalP)
override
764 :
cmd_(c,
"s:s",
"report statistics")
768 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
772 getParam<std::string>(paramList, 0);
776 *retvalP = xmlrpc_c::value_string(
"Error: The report message requires a single argument that selects the type of statistics to be reported.");
796 :
cmd_(c,
"s:n",
"return the currently legal commands")
800 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const retvalP)
override
803 std::string resultString;
805 for (
auto& cmd : cmdList)
807 resultString.append(cmd +
" ");
808 if (cmd ==
"shutdown")
810 resultString.append(
" reset");
813 *retvalP = xmlrpc_c::value_string(resultString);
830 :
cmd_(c,
"s:s",
"Get notified of a new monitor")
834 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
838 getParam<fhicl::ParameterSet>(paramList, 0);
842 *retvalP = xmlrpc_c::value_string(
"Error: The register_monitor command expects a string representing the FHiCL definition of a Transfer plugin");
862 :
cmd_(c,
"s:s",
"Remove a monitor")
866 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
870 getParam<std::string>(paramList, 0);
874 *retvalP = xmlrpc_c::value_string(
"Error: The unregister_monitor command expects a string representing the label of the monitor to be removed");
894 :
cmd_(c,
"s:ssI",
"Set TRACE mask")
898 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
902 getParam<std::string>(paramList, 0);
903 getParam<std::string>(paramList, 1);
904 getParam<std::string>(paramList, 2);
908 *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");
912 return _c.
_commandable.
do_trace_set(getParam<std::string>(paramList, 0), getParam<std::string>(paramList, 1), getParam<std::string>(paramList, 2));
927 :
cmd_(c,
"s:s",
"Get TRACE mask")
931 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
935 getParam<std::string>(paramList, 0);
939 *retvalP = xmlrpc_c::value_string(
"Error: The trace_get command expects a name (ALL for all)");
959 :
cmd_(c,
"s:ss",
"Run custom command")
963 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
967 getParam<std::string>(paramList, 0);
968 getParam<std::string>(paramList, 1);
972 *retvalP = xmlrpc_c::value_string(
"Error: The meta_command command expects a string command and a string argument");
991 :
cmd_(c,
"s:Ii",
"create a new subrun")
998 bool execute_(
const xmlrpc_c::paramList& paramList, xmlrpc_c::value*
const )
override
1016 :
cmd_(c,
"s:ss",
"Add an entry to the configuration archive list")
1020 bool execute_(xmlrpc_c::paramList
const& paramList, xmlrpc_c::value*
const retvalP)
override
1024 getParam<std::string>(paramList, 0);
1025 getParam<std::string>(paramList, 1);
1029 *retvalP = xmlrpc_c::value_string(
"Error: The add_config_archive_entry command expects a string key and a string value");
1048 :
cmd_(c,
"s:n",
"Clear the configuration archive list")
1052 bool execute_(xmlrpc_c::paramList
const& , xmlrpc_c::value*
const )
override
1064 class shutdown_ :
public xmlrpc_c::registry::shutdown
1067 shutdown_(xmlrpc_c::serverAbyss *server) : _server(server) {}
1069 virtual void doit(
const std::string& paramString,
void*)
const
1071 TLOG(TLVL_INFO) <<
"A shutdown command was sent "
1072 <<
"with parameter "
1073 << paramString <<
"\"";
1074 _server->terminate();
1077 xmlrpc_c::serverAbyss *_server;
1083 , port_(ps.get<int>(
"id", 0))
1084 , serverUrl_(ps.get<std::string>(
"server_url",
""))
1087 if (serverUrl_.empty())
1089 char hostname[HOST_NAME_MAX];
1090 gethostname(hostname, HOST_NAME_MAX);
1091 serverUrl_ = std::string(hostname);
1093 if (serverUrl_.find(
"http") == std::string::npos)
1095 serverUrl_ =
"http://" + serverUrl_;
1097 if (serverUrl_.find(std::to_string(port_)) == std::string::npos && serverUrl_.find(
':', 7) == std::string::npos)
1099 serverUrl_ = serverUrl_ +
":" + std::to_string(port_);
1101 if (serverUrl_.find(
"RPC2") == std::string::npos)
1103 serverUrl_ = serverUrl_ +
"/RPC2";
1105 TLOG(TLVL_INFO) <<
"XMLRPC COMMANDER CONSTRUCTOR: Port: " << port_ <<
", Server Url: " << serverUrl_;
1111 xmlrpc_c::registry registry;
1112 struct xmlrpc_method_info3 methodInfo;
1113 memset(&methodInfo, 0,
sizeof(methodInfo));
1118 #define register_method(m) register_method2(m, 0x400000)
1121 xmlrpc_registry*** c_registryPPP;
1122 c_registryPPP =
reinterpret_cast<xmlrpc_registry***
>(
reinterpret_cast<char*
>(®istry) +
sizeof(girmem::autoObject));
1124 #define register_method2(m, ss) \
1125 xmlrpc_c::method* ptr_##m(dynamic_cast<xmlrpc_c::method*>(new m##_(*this))); \
1126 std::string m##signature = ptr_##m->signature(), m##help = ptr_##m->help(); \
1127 methodInfo.methodName = "daq." #m; \
1128 methodInfo.methodFunction = &c_executeMethod; \
1129 methodInfo.serverInfo = ptr_##m; \
1130 methodInfo.stackSize = ss; \
1131 methodInfo.signatureString = &m##signature[0]; \
1132 methodInfo.help = &m##help[0]; \
1133 xmlrpc_env_init(&env); \
1134 xmlrpc_registry_add_method3(&env, **c_registryPPP, &methodInfo); \
1135 if (env.fault_occurred) throw(girerr::error(env.fault_string)); \
1136 xmlrpc_env_clean(&env)
1138 #define unregister_method(m) delete ptr_##m;
1140 register_method2(init, 0x200000);
1141 register_method(soft_init);
1142 register_method(reinit);
1143 register_method(start);
1144 register_method(status);
1145 register_method(report);
1146 register_method(stop);
1147 register_method(pause);
1148 register_method(resume);
1149 register_method(register_monitor);
1150 register_method(unregister_monitor);
1151 register_method(legal_commands);
1152 register_method(trace_set);
1153 register_method(trace_get);
1154 register_method(meta_command);
1155 register_method(rollover_subrun);
1159 register_method(shutdown);
1162 xmlrpc_c::methodPtr
const ptr_reset(
new shutdown_(*
this));
1163 registry.addMethod(
"daq.reset", ptr_reset);
1165 #undef register_method
1182 XMLRPC_SOCKET socket_file_descriptor = socket(PF_INET, SOCK_STREAM, 0);
1184 if (socket_file_descriptor < 0)
1186 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the socket() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1190 int retval = setsockopt(socket_file_descriptor,
1191 SOL_SOCKET, SO_REUSEADDR,
1192 &enable,
sizeof(
int));
1196 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the call to setsockopt(); C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1199 struct sockaddr_in sockAddr;
1201 sockAddr.sin_family = AF_INET;
1202 sockAddr.sin_port = htons(port_);
1203 sockAddr.sin_addr.s_addr = 0;
1205 retval = bind(socket_file_descriptor,
1206 reinterpret_cast<struct sockaddr*>(&sockAddr),
1211 close(socket_file_descriptor);
1212 throw cet::exception(
"xmlrpc_commander::run") <<
"Problem with the bind() call; C-style errno == " << errno <<
" (" << strerror(errno) <<
")";
1215 server = std::make_unique<xmlrpc_c::serverAbyss>(xmlrpc_c::serverAbyss::constrOpt().registryP(®istry).socketFd(socket_file_descriptor));
1218 xmlrpc_c::serverAbyss::shutdown shutdown_obj(&
server);
1219 registry.setShutdown(&shutdown_obj);
1222 TLOG(TLVL_DEBUG + 32) <<
"running server";
1238 TLOG(TLVL_WARNING) <<
"server threw an exception; closing the socket and rethrowing";
1240 close(socket_file_descriptor);
1244 close(socket_file_descriptor);
1246 unregister_method(init);
1247 unregister_method(soft_init);
1248 unregister_method(reinit);
1249 unregister_method(start);
1250 unregister_method(status);
1251 unregister_method(report);
1252 unregister_method(stop);
1253 unregister_method(pause);
1254 unregister_method(resume);
1255 unregister_method(register_monitor);
1256 unregister_method(unregister_monitor);
1257 unregister_method(legal_commands);
1258 unregister_method(trace_set);
1259 unregister_method(trace_get);
1260 unregister_method(meta_command);
1261 unregister_method(rollover_subrun);
1265 unregister_method(shutdown);
1267 TLOG(TLVL_DEBUG + 32) <<
"server terminated";
1274 std::string xmlrpc_commander::send_command_(
const std::string& command)
1276 if (serverUrl_.empty())
1278 std::stringstream errmsg;
1279 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1280 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1282 xmlrpc_c::clientSimple myClient;
1283 xmlrpc_c::value result;
1287 myClient.call(serverUrl_,
"daq." + command,
"", &result);
1291 std::stringstream errmsg;
1292 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1293 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1294 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1297 return xmlrpc_c::value_string(result);
1300 std::string xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg)
1302 if (serverUrl_.empty())
1304 std::stringstream errmsg;
1305 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1306 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1308 xmlrpc_c::clientSimple myClient;
1309 xmlrpc_c::value result;
1313 myClient.call(serverUrl_,
"daq." + command,
"s", &result, arg.c_str());
1317 std::stringstream errmsg;
1318 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1319 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1320 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1323 return xmlrpc_c::value_string(result);
1326 std::string xmlrpc_commander::send_command_(
const std::string& command,
const fhicl::ParameterSet& pset, uint64_t timestamp, uint64_t timeout)
1328 if (serverUrl_.empty())
1330 std::stringstream errmsg;
1331 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1332 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1334 xmlrpc_c::clientSimple myClient;
1335 xmlrpc_c::value result;
1339 myClient.call(serverUrl_,
"daq." + command,
"sII", &result, pset.to_string().c_str(), timestamp, timeout);
1343 std::stringstream errmsg;
1344 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1345 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1346 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1349 return xmlrpc_c::value_string(result);
1352 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t a, uint64_t b)
1354 if (serverUrl_.empty())
1356 std::stringstream errmsg;
1357 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1358 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1360 xmlrpc_c::clientSimple myClient;
1361 xmlrpc_c::value result;
1365 myClient.call(serverUrl_,
"daq." + command,
"II", &result, a, b);
1369 std::stringstream errmsg;
1370 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1371 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1372 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1375 return xmlrpc_c::value_string(result);
1378 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t a, uint32_t b)
1380 if (serverUrl_.empty())
1382 std::stringstream errmsg;
1383 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1384 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1386 xmlrpc_c::clientSimple myClient;
1387 xmlrpc_c::value result;
1391 myClient.call(serverUrl_,
"daq." + command,
"Ii", &result, a, b);
1395 std::stringstream errmsg;
1396 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1397 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1398 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1401 return xmlrpc_c::value_string(result);
1404 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, art::RunID r, uint64_t a, uint64_t b)
1406 if (serverUrl_.empty())
1408 std::stringstream errmsg;
1409 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1410 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1412 xmlrpc_c::clientSimple myClient;
1413 xmlrpc_c::value result;
1417 myClient.call(serverUrl_,
"daq." + command,
"iII", &result, r.run(), a, b);
1421 std::stringstream errmsg;
1422 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1423 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1424 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1427 return xmlrpc_c::value_string(result);
1430 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command, uint64_t arg1)
1432 if (serverUrl_.empty())
1434 std::stringstream errmsg;
1435 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1436 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1438 xmlrpc_c::clientSimple myClient;
1439 xmlrpc_c::value result;
1443 myClient.call(serverUrl_,
"daq." + command,
"I", &result, arg1);
1447 std::stringstream errmsg;
1448 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1449 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1450 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1453 return xmlrpc_c::value_string(result);
1456 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg1,
const std::string& arg2)
1458 if (serverUrl_.empty())
1460 std::stringstream errmsg;
1461 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1462 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1464 xmlrpc_c::clientSimple myClient;
1465 xmlrpc_c::value result;
1469 myClient.call(serverUrl_,
"daq." + command,
"ss", &result, arg1.c_str(), arg2.c_str());
1473 std::stringstream errmsg;
1474 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1475 <<
"; possible causes are malformed FHiCL or nonexistent process at requested port";
1476 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1479 return xmlrpc_c::value_string(result);
1482 std::string artdaq::xmlrpc_commander::send_command_(
const std::string& command,
const std::string& arg1,
const std::string& arg2,
const std::string& arg3)
1484 if (serverUrl_.empty())
1486 std::stringstream errmsg;
1487 errmsg <<
"Problem attempting " << command <<
" XML-RPC call: No server URL set!";
1488 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1490 xmlrpc_c::clientSimple myClient;
1491 xmlrpc_c::value result;
1495 myClient.call(serverUrl_,
"daq." + command,
"sss", &result, arg1.c_str(), arg2.c_str(), arg3.c_str());
1499 std::stringstream errmsg;
1500 errmsg <<
"Problem attempting " << command <<
" XML-RPC call on host " << serverUrl_
1501 <<
"; possible causes are bad arguments or nonexistent process at requested port";
1502 ExceptionHandler(ExceptionHandlerRethrow::yes, errmsg.str());
1505 return xmlrpc_c::value_string(result);
1510 return send_command_(
"register_monitor", monitor_fhicl);
1514 return send_command_(
"unregister_monitor", monitor_label);
1518 return send_command_(
"init", ps, timeout, timestamp);
1522 return send_command_(
"soft_init", ps, timeout, timestamp);
1526 return send_command_(
"reinit", ps, timeout, timestamp);
1530 return send_command_(
"start", run, timeout, timestamp);
1534 return send_command_(
"pause", timeout, timestamp);
1538 return send_command_(
"resume", timeout, timestamp);
1542 return send_command_(
"stop", timeout, timestamp);
1546 return send_command_(
"shutdown", timeout);
1550 return send_command_(
"status");
1554 return send_command_(
"report", what);
1558 return send_command_(
"legal_commands");
1562 return send_command_(
"trace_get", name);
1566 return send_command_(
"trace_set", name, type, mask);
1570 return send_command_(
"meta_command", command, arg);
1574 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.