1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
10 #include <sstream> // std::istringstream
11 #include <iostream> // std::cout
12 #include <math.h> // ceil
16 #include <anna/timex/Engine.hpp>
17 #include <anna/statistics/Engine.hpp>
18 #include <anna/diameter/codec/functions.hpp>
19 #include <anna/diameter/codec/Engine.hpp>
20 #include <anna/diameter/codec/EngineManager.hpp>
21 #include <anna/http/Transport.hpp>
22 #include <anna/diameter/stack/Engine.hpp>
23 #include <anna/diameter/helpers/base/functions.hpp>
24 #include <anna/time/functions.hpp>
25 #include <anna/diameter.comm/ApplicationMessageOamModule.hpp>
26 #include <anna/xml/xml.hpp>
29 #include <Launcher.hpp>
30 #include <RealmNode.hpp>
31 #include <MyDiameterEngine.hpp>
32 #include <TestManager.hpp>
33 #include <TestCase.hpp>
36 #define SIGUSR2_TASKS_INPUT_FILENAME "./sigusr2.in"
37 #define SIGUSR2_TASKS_OUTPUT_FILENAME "./sigusr2.out"
40 const char *ServicesDTD = "\
41 <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
42 <!-- Diameter services DTD -->\n\
44 <!ELEMENT services (stack*, node*)>\n\
46 <!ELEMENT stack EMPTY>\n\
47 <!ATTLIST stack id CDATA #REQUIRED dictionary CDATA #REQUIRED validationMode (BeforeEncoding | AfterDecoding | Always | Never) #IMPLIED validationDepth (Complete | FirstError) #IMPLIED fixMode (BeforeEncoding | AfterDecoding | Always | Never) #IMPLIED ignoreFlagsOnValidation (yes | no) #IMPLIED>\n\
51 id: Normally the id corresponds to the Application-Id for which the dictionary provided is designed\n\
52 (in multistack applications, it shall be mandatory respect such association to know the stack used\n\
53 for processed messages).\n\
54 dictionary: Path to the dictionary file.\n\
55 validationMode: Sets the validation mode. Default is 'AfterDecoding'.\n\
56 validationDepth: Sets the validation depth. Default is 'FirstError'.\n\
57 fixMode: Sets the fix mode. Default is 'BeforeEncoding'.\n\
58 ignoreFlagsOnValidation: Ignore flags during message validation. Default is 'no'.\n\
61 <!ELEMENT node EMPTY>\n\
62 <!ATTLIST node originRealm CDATA #REQUIRED applicationId CDATA #REQUIRED originHost CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>\n\
66 originRealm: Node identifier (Origin-Realm name).\n\
67 applicationId: The Application-Id provided must exists as a registered 'stack id'.\n\
68 originHost: Diameter application host name (system name). If missing, process sets o.s. hostname\n\
69 Note that if you have two or more realms, the names must be different.\n\
70 cer: User defined CER path file to be encoded to establish diameter connections.\n\
71 If missing, will be harcoded\n\
72 dwr: User defined DWR path file to be encoded for diameter protocol keep alive.\n\
73 If missing, will be harcoded\n\
74 allowedInactivityTime: Milliseconds for the maximum allowed inactivity time on server sessions born over the\n\
75 local server before being reset. If missing, default value of 90000 will be assigned\n\
76 tcpConnectDelay: Milliseconds to wait TCP connect to any server. If missing, default value of 200 will\n\
78 answersTimeout: Milliseconds to wait pending application answers from diameter peers. If missing,\n\
79 default value of 10000 will be assigned\n\
80 ceaTimeout: Milliseconds to wait CEA from diameter server. If missing, default value of 'answersTimeout'\n\
82 watchdogPeriod: Milliseconds for watchdog timer (Tw) for diameter keep-alive procedure. If missing, default\n\
83 value of 30000 will be assigned\n\
84 entity: Target diameter entity (comma-separated '<address>:<port>' format).\n\
85 For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled\n\
86 entityServerSessions: Diameter entity server sessions (0: diameter entity disabled). Default value of 1\n\
87 diameterServer: Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868.\n\
88 If missing, no local server will be enabled\n\
89 diameterServerSessions: Diameter own server available connections (0: diameter server disabled). Default value of 1\n\
90 balance: Balance over entity servers instead of doing standard behaviour (first primary, secondary\n\
91 if fails, etc.). Default value 'no'\n\
92 sessionBasedModelsClientSocketSelection: By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part\n\
93 will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR\n\
94 analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied;\n\
95 usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart')\n\
96 retries: Expired responses will cause a number of request retransmissions. Disabled by default (0 retries)\n\
97 log: Process log file (operations result, traffic log, etc.). By default '<originRealm>.launcher.log'.\n\
98 Empty string or \"null\" name, to disable. Warning: there is no rotation for log files\n\
99 (use logrotate or whatever you consider)\n\
100 splitLog: Splits log file (appends to log filename, extensions with the type of event: see help on\n\
101 startup information-level traces). No log files for code/decode and load operations are created.\n\
102 Default value 'no'\n\
103 detailedLog: Insert detailed information at log files. Should be disabled on automatic tests. Useful on\n\
104 'balance' mode to know messages flow along the sockets. Default value 'no'\n\
105 dumpLog: Write to disk every incoming/outcoming message named as:\n\
106 '<originRealm>.<hop by hop>.<end to end>.<message code>.<request|answer>.<type of event>.xml'\n\
107 Default value 'no'\n\
108 burstLog: Burst operations log file. By default '<originRealm>.launcher.burst'. Empty string or \"null\" name, to disable.\n\
109 Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each\n\
110 burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst\n\
111 list size, plus OTA requests when changed\n\
118 Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) {
120 a_counterRecorder = NULL;
121 a_admlMinResolution = 2 * anna::timex::Engine::minResolution; // 2*10 = 20 ms; 1000/20 = 50 ticks per second;
122 //a_admlMinResolution = (anna::Millisecond)100;
123 a_counterRecorderClock = NULL;
126 a_workingNode = NULL;
128 a_httpServerSocket = NULL;
134 void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOperation) throw(anna::RuntimeException) {
135 //<!ATTLIST stack id CDATA #REQUIRED dictionary CDATA #REQUIRED>
136 const anna::xml::Attribute *id, *dictionary;
138 // <!ATTLIST node originRealm CDATA #REQUIRED applicationId CDATA #REQUIRED originHost CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>
139 const anna::xml::Attribute *originRealm, *appId, *originHost, *cer, *dwr, *allowedInactivityTime, *tcpConnectDelay,
140 *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions,
141 *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection,
142 *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog;
144 // Never clear services content from here (append new data from xml). At the moment no node removing is implemented in this process
147 anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
148 anna::diameter::stack::Dictionary *d;
149 const anna::diameter::stack::Dictionary *bpd = NULL; // base protocol dictionary
151 // Codec engine manager:
152 anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate();
153 anna::diameter::codec::Engine *ce;
155 ///////////////////////////////////////////
156 // APPLICATION MESSAGE OAM MODULE SCOPES //
157 ///////////////////////////////////////////
158 // We will register a scope per stack id registered. The counters will be dynamically registered at count method.
159 anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate();
160 appMsgOamModule.enableCounters(); // this special module is disabled by default (the only)
161 static int scope_id = 3;
162 unsigned int id_value;
163 std::string codecEngineName;
165 for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
166 std::string nodeName = (*it)->getName();
168 if(nodeName == "stack") {
170 id = (*it)->getAttribute("id");
171 dictionary = (*it)->getAttribute("dictionary");
172 id_value = id->getIntegerValue();
175 d = stackEngine.createDictionary(id_value, dictionary->getValue());
176 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Created dictionary (%p) for stack id %llu", d, id_value), ANNA_FILE_LOCATION));
178 // OAM module for counters:
179 appMsgOamModule.createStackCounterScope(scope_id, id_value /* application-id */);
182 } catch(anna::RuntimeException &ex) {
183 //_exit(ex.asString());
187 bpd = d; // base protocol dictionary in case of monostack. If multistack, will be calculated later
189 // Create codec engine and register it in the codec engine manager:
190 codecEngineName = anna::functions::asString("CodecEngineForStackId_%llu", id_value);
191 ce = new anna::diameter::codec::Engine(codecEngineName.c_str(), d);
192 em.registerCodecEngine(id_value, ce);
194 // Codec engine configuration:
195 const anna::xml::Attribute *vm_attr = (*it)->getAttribute("validationMode", false /* no exception */);
196 const anna::xml::Attribute *vd_attr = (*it)->getAttribute("validationDepth", false /* no exception */);
197 const anna::xml::Attribute *fm_attr = (*it)->getAttribute("fixMode", false /* no exception */);
198 const anna::xml::Attribute *if_attr = (*it)->getAttribute("ignoreFlags", false /* no exception */);
200 std::string vm_value = vm_attr ? vm_attr->getValue() : "AfterDecoding";
201 std::string vd_value = vd_attr ? vd_attr->getValue() : "FirstError";
202 std::string fm_value = fm_attr ? fm_attr->getValue() : "BeforeEncoding";
204 anna::diameter::codec::Engine::ValidationMode::_v vm;
205 if (vm_value == "BeforeEncoding") vm = anna::diameter::codec::Engine::ValidationMode::BeforeEncoding;
206 else if (vm_value == "AfterDecoding") vm = anna::diameter::codec::Engine::ValidationMode::AfterDecoding;
207 else if (vm_value == "Always") vm = anna::diameter::codec::Engine::ValidationMode::Always;
208 else if (vm_value == "Never") vm = anna::diameter::codec::Engine::ValidationMode::Never;
209 ce->setValidationMode(vm);
211 anna::diameter::codec::Engine::ValidationDepth::_v vd;
212 if (vd_value == "Complete") vd = anna::diameter::codec::Engine::ValidationDepth::Complete;
213 else if (vd_value == "FirstError") vd = anna::diameter::codec::Engine::ValidationDepth::FirstError;
214 ce->setValidationDepth(vd);
216 anna::diameter::codec::Engine::FixMode::_v fm;
217 if (fm_value == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding;
218 else if (fm_value == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding;
219 else if (fm_value == "Always") fm = anna::diameter::codec::Engine::FixMode::Always;
220 else if (fm_value == "Never") fm = anna::diameter::codec::Engine::FixMode::Never;
223 bool if_value = (if_attr ? (if_attr->getValue() == "yes") : false);
224 ce->ignoreFlagsOnValidation(if_value);
228 // Show loaded stacks:
229 std::cout << "Stacks currently loaded:" << std::endl;
230 std::cout << anna::functions::tab(stackEngine.asString(false /* light */)) << std::endl;
232 // Basic checking for multistack:
233 bool multistack = (stackEngine.stack_size() > 1);
235 bpd = stackEngine.getDictionary(0);
237 throw anna::RuntimeException("In multistack applications is mandatory register a stack id = 0 using a dictionary which contains the needed elements to build base protocol messages (CER/A, DWR/A, DPR/A, STR/A, etc.)", ANNA_FILE_LOCATION);
241 for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
242 std::string nodeName = (*it)->getName();
244 if(nodeName == "node") {
246 originRealm = (*it)->getAttribute("originRealm");
247 appId = (*it)->getAttribute("applicationId");
248 originHost = (*it)->getAttribute("originHost", false /* no exception */);
249 cer = (*it)->getAttribute("cer", false /* no exception */);
250 dwr = (*it)->getAttribute("dwr", false /* no exception */);
251 allowedInactivityTime = (*it)->getAttribute("allowedInactivityTime", false /* no exception */);
252 tcpConnectDelay = (*it)->getAttribute("tcpConnectDelay", false /* no exception */);
253 answersTimeout = (*it)->getAttribute("answersTimeout", false /* no exception */);
254 ceaTimeout = (*it)->getAttribute("ceaTimeout", false /* no exception */);
255 watchdogPeriod = (*it)->getAttribute("watchdogPeriod", false /* no exception */);
256 entity = (*it)->getAttribute("entity", false /* no exception */);
257 entityServerSessions = (*it)->getAttribute("entityServerSessions", false /* no exception */);
258 diameterServer = (*it)->getAttribute("diameterServer", false /* no exception */);
259 diameterServerSessions = (*it)->getAttribute("diameterServerSessions", false /* no exception */);
260 balance = (*it)->getAttribute("balance", false /* no exception */); // (yes | no)
261 sessionBasedModelsClientSocketSelection = (*it)->getAttribute("sessionBasedModelsClientSocketSelection", false /* no exception */); // (SessionIdHighPart | SessionIdOptionalPart | RoundRobin)
262 retries = (*it)->getAttribute("retries", false /* no exception */);
263 log = (*it)->getAttribute("log", false /* no exception */);
264 splitLog = (*it)->getAttribute("splitLog", false /* no exception */); // (yes | no)
265 detailedLog = (*it)->getAttribute("detailedLog", false /* no exception */); // (yes | no)
266 dumpLog = (*it)->getAttribute("dumpLog", false /* no exception */); // (yes | no)
267 burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no)
270 realm_nodes_it nodeIt = a_nodes.find(originRealm->getValue());
271 if (nodeIt != a_nodes.end()) {
272 std::string msg = "Already registered node name (Origin-Realm): "; msg += originRealm->getValue();
273 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
276 unsigned int applicationId = appId->getIntegerValue();
277 if (!stackEngine.getDictionary(applicationId)) {
278 std::string msg = "Cannot found a registered stack id with the value of applicationId provided: "; msg += appId->getValue();
279 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
282 // Engine time measures checking & assignment:
283 anna::Millisecond allowedInactivityTimeMs(90000);
284 anna::Millisecond tcpConnectDelayMs(200);
285 anna::Millisecond answersTimeoutMs(10000);
286 anna::Millisecond ceaTimeoutMs(10000);
287 anna::Millisecond watchdogPeriodMs(30000);
289 if (allowedInactivityTime) allowedInactivityTimeMs = checkTimeMeasure("allowedInactivityTime", allowedInactivityTime->getValue());
290 if (tcpConnectDelay) tcpConnectDelayMs = checkTimeMeasure("tcpConnectDelay", tcpConnectDelay->getValue());
291 if (answersTimeout) answersTimeoutMs = checkTimeMeasure("answersTimeout", answersTimeout->getValue());
292 if (ceaTimeout) ceaTimeoutMs = checkTimeMeasure("ceaTimeout", ceaTimeout->getValue());
293 if (watchdogPeriod) watchdogPeriodMs = checkTimeMeasure("watchdogPeriod", watchdogPeriod->getValue());
295 // Checking command line parameters
296 std::string sessionBasedModelsType;
297 if(sessionBasedModelsClientSocketSelection) {
298 sessionBasedModelsType = sessionBasedModelsClientSocketSelection->getValue();
299 if((sessionBasedModelsType != "SessionIdHighPart") && (sessionBasedModelsType != "SessionIdOptionalPart") && (sessionBasedModelsType != "RoundRobin")) {
300 throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
304 int retransmissions = retries ? retries->getIntegerValue() : 0;
305 if(retransmissions < 0) {
306 throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION);
309 // Create new Node instance /////////////////////////////////////////////////////////////////
310 a_workingNode = new RealmNode(originRealm->getValue(), applicationId, bpd);
311 MyDiameterEngine *commEngine = a_workingNode->getMyDiameterEngine();
312 /////////////////////////////////////////////////////////////////////////////////////////////
315 commEngine->setMaxConnectionDelay(tcpConnectDelayMs);
316 commEngine->setWatchdogPeriod(watchdogPeriodMs);
318 // Realm information:
319 if (originHost) commEngine->setHost(originHost->getValue());
320 commEngine->setRealm(originRealm->getValue());
324 int sessions = entityServerSessions ? entityServerSessions->getIntegerValue() : 1;
327 // Number of sessions:
328 commEngine->setNumberOfClientSessionsPerServer(sessions);
330 // Client CER and DWR
331 std::string cerPathfile = cer ? cer->getValue() : "";
332 std::string dwrPathfile = dwr ? dwr->getValue() : "";
333 commEngine->setClientCERandDWR(cerPathfile, dwrPathfile);
335 // Register one entity for this engine:
336 a_workingNode->createEntity(entity->getValue(), ceaTimeoutMs, answersTimeoutMs);
337 a_workingNode->setRequestRetransmissions(retransmissions);
338 a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsType);
339 a_workingNode->getEntity()->setBalance(balance ? (balance->getValue() == "yes") : false); // for sendings
340 if (eventOperation) a_workingNode->getEntity()->bind();
346 int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1;
347 a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs);
351 std::string realm = commEngine->getRealm();
352 std::string s_log = realm + ".launcher.log"; if (log) s_log = log->getValue();
353 bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false);
354 bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false);
355 bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false);
356 std::string s_burstLog = realm + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue();
357 a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog);
360 // Lazy initialization for comm engine:
361 if (eventOperation) commEngine->lazyInitialize();
363 // Node and Codec Engine registration ///////////////////////////////////////////////////////
364 a_nodes[originRealm->getValue()] = a_workingNode;
365 /////////////////////////////////////////////////////////////////////////////////////////////
370 a_workingNode = NULL; // by default, mode auto
372 // Diameter comm engines which are loaded after application start (via management operation 'services') are not really started,
373 // but this don't care because application startComponents() -> initialize() -> do_initialize() -> do nothing.
374 // And when stopped, running state is not checked and it will be stopped anyway.
378 void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation) throw(anna::RuntimeException) {
380 if (xmlPathFile == "null" || xmlPathFile == "") {
381 LOGWARNING(anna::Logger::warning("Ignoring services configuration on start: empty or 'null' string provided as xml file. Use management interface (operation 'services') in order to add services", ANNA_FILE_LOCATION));
386 std::string trace = "Loading ADML services file '";
387 trace += xmlPathFile;
389 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
391 anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
392 anna::xml::DTDMemory xmlDTD;
393 const anna::xml::Node *rootNode;
394 xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error
395 xmlDTD.initialize(ServicesDTD);
397 rootNode = xmlDocument.parse(xmlDTD); // Parsing: fail here if xml violates dtd
399 catch (anna::RuntimeException &ex) {
401 std::string msg = "Services DTD schema:\n\n";
403 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
409 std::string trace = "Loaded XML file (";
410 trace += xmlPathFile;
412 trace += anna::xml::Compiler().apply(rootNode);
413 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
415 servicesFromXML(rootNode, eventOperation);
419 anna::Millisecond Launcher::checkTimeMeasure(const std::string ¶meter, const std::string &value) throw(anna::RuntimeException) {
421 if(anna::functions::isLike("^[0-9]+$", value)) { // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$
423 std::istringstream ( value ) >> msecs;
425 if(msecs > a_timeEngine->getMaxTimeout()) { // 600000 ms
426 std::string msg = "Configuration value for '";
428 msg += "' ("; msg += value; msg += " msecs) is greater than allowed max timeout for timming engine: ";
429 msg += anna::functions::asString(a_timeEngine->getMaxTimeout());
430 throw RuntimeException(msg, ANNA_FILE_LOCATION);
434 std::string msg = "Configuration value for '";
436 msg += "' ("; msg += value; msg += " msecs) is perhaps very big (over 5 minutes).";
437 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
440 if(msecs <= a_timeEngine->getResolution()) {
441 std::string msg = "Configuration value for '";
443 msg += "' ("; msg += value; msg += " msecs) as any other time measure, must be greater than timming engine resolution: ";
444 msg += anna::functions::asString(a_timeEngine->getResolution());
445 throw RuntimeException(msg, ANNA_FILE_LOCATION);
448 return (anna::Millisecond)msecs; // ok
451 // Non-integer exception:
452 std::string msg = "Configuration error for '";
456 msg += "': must be a non-negative integer number";
457 throw RuntimeException(msg, ANNA_FILE_LOCATION);
460 bool Launcher::setWorkingNode(const std::string &name) throw() {
463 realm_nodes_it nodeIt = a_nodes.find(name);
464 if (nodeIt == a_nodes.end()) {
466 std::string msg = "Unknown node with name '"; msg += name; msg += "'. Ignoring ...";
467 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
471 a_workingNode = const_cast<RealmNode*>(nodeIt->second);
478 RealmNode *Launcher::getRealmNode(const std::string &realmName) const throw(anna::RuntimeException) {
479 realm_nodes_it it = a_nodes.find(realmName);
480 if (it != a_nodes.end()) return it->second;
481 throw anna::RuntimeException(anna::functions::asString("There is no realm node registered as '%s' (set Origin-Realm avp correctly or force a specific realm with 'node' operation)", realmName.c_str()), ANNA_FILE_LOCATION);
484 RealmNode *Launcher::getRealmNode(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
485 std::string originRealm = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->getValue();
486 return (getRealmNode(originRealm));
489 void Launcher::updateOperatedRealmNodeWithMessage(const anna::diameter::codec::Message &message) throw(anna::RuntimeException) {
490 if (!a_operatedRealm) // priority for working node by mean 'node' operation
491 a_operatedRealm = getRealmNode(message);
494 RealmNode *Launcher::getOperatedRealm() const throw(anna::RuntimeException) {
496 throw anna::RuntimeException("Realm Node not identified (try to force a specific realm with 'node' operation)", ANNA_FILE_LOCATION);
498 return a_operatedRealm;
501 MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) {
502 MyDiameterEntity *result = getOperatedRealm()->getEntity();
504 throw anna::RuntimeException("No entity configured for the operated Realm Node", ANNA_FILE_LOCATION);
508 MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) {
509 MyLocalServer *result = getOperatedRealm()->getDiameterServer();
511 throw anna::RuntimeException("No local server configured for the operated Realm Node", ANNA_FILE_LOCATION);
515 MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) {
516 return getOperatedRealm()->getMyDiameterEngine(); // never will be NULL
519 void Launcher::initialize()
520 throw(anna::RuntimeException) {
521 anna::comm::Application::initialize();
522 CommandLine& cl(anna::CommandLine::instantiate());
523 anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single);
524 a_communicator = new MyCommunicator(workMode);
525 a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, a_admlMinResolution);
526 TestManager::instantiate().setTimerController(a_timeEngine);
528 // Counters record procedure:
529 const char *varname = "cntRecordPeriod";
530 anna::Millisecond cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000;
531 if(cntRecordPeriod != 0) {
532 a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock
533 std::string cntDir = ".";
534 if(cl.exists("cntDir")) cntDir = cl.getValue("cntDir");
535 a_counterRecorder = new MyCounterRecorder(cntDir + anna::functions::asString("/Counters.Pid%d", (int)getPid()));
538 // Testing framework:
539 std::string tmDir = ".";
540 if(cl.exists("tmDir")) tmDir = cl.getValue("tmDir");
541 TestManager::instantiate().setReportsDirectory(tmDir);
544 if(cl.exists("trace"))
545 anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace")));
547 // Load launcher services:
548 loadServices(cl.getValue("services")); // before run (have components to be created)
552 throw(anna::RuntimeException) {
553 LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION));
554 CommandLine& cl(anna::CommandLine::instantiate());
555 anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
558 a_start_time.setNow();
560 anna::statistics::Engine::instantiate().enable();
563 // Help on startup traces:
564 anna::Logger::information(help(), ANNA_FILE_LOCATION);
565 // Test messages dtd:
566 std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n";
567 msg += anna::diameter::codec::MessageDTD;
568 anna::Logger::information(msg, ANNA_FILE_LOCATION);
572 if(cl.exists("httpServer")) {
573 anna::comm::Network& network = anna::comm::Network::instantiate();
576 anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("httpServer"), address, port);
577 //const anna::comm::Device* device = network.find(Device::asAddress(address)); // here provide IP
578 const anna::comm::Device* device = *((network.resolve(address)->device_begin())); // trick to solve
579 a_httpServerSocket = new anna::comm::ServerSocket(anna::comm::INetAddress(device, port), cl.exists("httpServerShared") /* shared bind */, &anna::http::Transport::getFactory());
582 ///////////////////////////////
583 // Diameter library COUNTERS //
584 ///////////////////////////////
585 anna::diameter::comm::OamModule & oamDiameterComm = anna::diameter::comm::OamModule::instantiate();
586 oamDiameterComm.initializeCounterScope(1); // 1000 - 1999
587 oamDiameterComm.enableCounters();
588 oamDiameterComm.enableAlarms();
589 anna::diameter::codec::OamModule & oamDiameterCodec = anna::diameter::codec::OamModule::instantiate();
590 oamDiameterCodec.initializeCounterScope(2); // 2000 - 2999
591 oamDiameterCodec.enableCounters();
592 oamDiameterCodec.enableAlarms();
597 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceived, "" /* get defaults for enum type*/, 0 /*1000*/);
598 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceived, "", 1 /*1001*/);
599 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnClientSession, "", 2 /*1002*/);
600 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSession, "", 3 /*1003*/);
601 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnServerSession, "", 4 /* etc. */);
602 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSession, "", 5);
603 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOK, "", 6);
604 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentNOK, "", 7);
605 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOK, "", 8);
606 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentNOK, "", 9);
607 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionOK, "", 10);
608 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionNOK, "", 11);
609 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionOK, "", 12);
610 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionNOK, "", 13);
611 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionOK, "", 14);
612 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionNOK, "", 15);
613 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionOK, "", 16);
614 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionNOK, "", 17);
615 /* Diameter Base (capabilities exchange & keep alive) */
617 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentOK, "", 18);
618 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentNOK, "", 19);
619 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEAReceived, "", 20);
620 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentOK, "", 21);
621 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentNOK, "", 22);
622 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWAReceived, "", 23);
623 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentOK, "", 24);
624 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentNOK, "", 25);
625 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPAReceived, "", 26);
627 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERReceived, "", 27);
628 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentOK, "", 28);
629 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentNOK, "", 29);
630 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRReceived, "", 30);
631 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentOK, "", 31);
632 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentNOK, "", 32);
633 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRReceived, "", 33);
634 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentOK, "", 34);
635 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentNOK, "", 35);
636 /* server socket operations (enable/disable listening port for any local server) */
637 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsOpened, "", 36);
638 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsClosed, "", 37);
641 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverOverEntity, "", 38);
642 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverClientSession, "", 39);
643 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverClientSession, "", 40);
644 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverServer, "", 41);
645 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverServer, "", 42);
646 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEntity, "", 43);
647 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEntity, "", 44);
648 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForEntities, "", 45);
649 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForEntities, "", 46);
651 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverToClient, "", 47);
652 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostConnectionForServerSession, "", 48);
653 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnbindConnectionForServerSessionDueToInactivityTimeAnomaly, "", 49);
654 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CreatedConnectionForServerSession, "", 50);
655 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverLocalServer, "", 51);
656 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverLocalServer, "", 52);
657 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForLocalServers, "", 53);
658 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForLocalServers, "", 54);
659 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentExpired, "", 55);
660 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionExpired, "", 56);
661 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionExpired, "", 57);
662 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmitted, "", 58);
663 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnClientSession, "", 59);
664 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnServerSession, "", 60);
665 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown, "", 61);
666 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown, "", 62);
667 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown, "", 63);
672 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength, "", 0 /*2000*/);
673 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived, "", 1 /*2001*/);
674 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncorrectLength, "", 2 /*2002*/);
675 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__DataPartInconsistence, "", 3 /*2003*/);
676 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit, "", 4 /*2004*/);
677 /* Message decoding */
678 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength, "", 5 /*2005*/);
679 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength, "", 6 /*2006*/);
681 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction, "", 10 /*2010*/);
682 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules, "", 11 /*2011*/);
683 /* Message validation */
684 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate, "", 12 /*2012*/);
685 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags, "", 13 /*2013*/);
686 /* Level validation */
687 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__MissingFixedRule, "", 14 /*2014*/);
688 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinality, "", 15 /*2015*/);
689 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded, "", 16 /*2016*/);
690 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded, "", 17 /*2017*/);
691 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem, "", 18 /*2018*/);
692 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified, "", 19 /*2019*/);
695 /////////////////////////////////
696 // Counter recorder associated //
697 /////////////////////////////////
698 if(a_counterRecorderClock) {
699 oamDiameterComm.setCounterRecorder(a_counterRecorder);
700 oamDiameterCodec.setCounterRecorder(a_counterRecorder);
701 anna::diameter::comm::ApplicationMessageOamModule::instantiate().setCounterRecorder(a_counterRecorder);
702 a_timeEngine->activate(a_counterRecorderClock); // start clock
705 // Log statistics concepts
706 if(cl.exists("logStatisticSamples")) {
707 std::string list = cl.getValue("logStatisticSamples");
708 anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
711 if(statEngine.enableSampleLog(/* -1: all concepts */))
712 LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
715 lst.apply(cl.getValue("logStatisticSamples"), ",");
717 if(lst.size() >= 1) {
718 anna::Tokenizer::const_iterator tok_min(lst.begin());
719 anna::Tokenizer::const_iterator tok_max(lst.end());
720 anna::Tokenizer::const_iterator tok_iter;
723 for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
724 conceptId = atoi(anna::Tokenizer::data(tok_iter));
726 if(statEngine.enableSampleLog(conceptId))
727 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
734 // Start client connections //////////////////////////////////////////////////////////////////////////////////
735 MyDiameterEntity *entity;
736 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
737 entity = it->second->getEntity();
738 if (entity) entity->bind();
741 // Go into communicator poll
742 // Reconnection period (tcp reconnect retry time):
743 const char *varname = "reconnectionPeriod";
744 anna::Millisecond reconnectionPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)10000;
746 a_communicator->setRecoveryTime(reconnectionPeriod);
747 if(cl.exists("httpServer")) a_communicator->attach(a_httpServerSocket); // HTTP
748 a_communicator->accept();
752 bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() {
754 static char buffer[8192];
755 std::ifstream infile(pathfile.c_str(), std::ifstream::in);
757 if(infile.is_open()) {
759 std::string hexString(buffer, strlen(buffer));
760 // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString':
761 hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end());
763 std::string msg = "Hex string (remove colons if exists): ";
765 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
767 anna::functions::fromHexString(hexString, db);
776 void Launcher::resetStatistics() throw() {
778 a_workingNode->getMyDiameterEngine()->resetStatistics();
781 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
782 it->second->getMyDiameterEngine()->resetStatistics();
787 void Launcher::resetCounters() throw() {
788 anna::diameter::comm::OamModule::instantiate().resetCounters();
789 anna::diameter::comm::ApplicationMessageOamModule::instantiate().resetCounters();
790 anna::diameter::codec::OamModule::instantiate().resetCounters();
793 void Launcher::signalUSR2() throw(anna::RuntimeException) {
795 std::string msg = "Captured signal SIGUSR2. Reading tasks at '";
796 msg += SIGUSR2_TASKS_INPUT_FILENAME;
797 msg += "' (results will be written at '";
798 msg += SIGUSR2_TASKS_OUTPUT_FILENAME;
800 anna::Logger::notice(msg, ANNA_FILE_LOCATION);
805 std::string response_content;
806 std::ifstream in_file(SIGUSR2_TASKS_INPUT_FILENAME);
807 std::ofstream out_file(SIGUSR2_TASKS_OUTPUT_FILENAME);
809 if(!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION);
811 if(!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION);
813 while(getline(in_file, line)) {
815 std::string msg = "Processing line: ";
817 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
821 eventOperation(line, response_content);
822 } catch(RuntimeException &ex) {
826 out_file << response_content << "\n";
833 std::string Launcher::help() const throw() {
834 std::string result = "\n";
835 result += "\n ------------- HELP -------------\n";
837 result += "\nOVERVIEW";
838 result += "\n--------";
840 result += "\nThe ADML (ANNA Diameter Multirealm Launcher) process is a multi-realm node with client and server";
841 result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server (i.e. to";
842 result += "\n simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.), and balancer";
843 result += "\n systems to provide failover to external round-robin launchers. Also, auxiliary encoder/decoder/loader";
844 result += "\n function could be deployed to reinterpret certain external flow and send it to another process.";
846 result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections";
847 result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard";
848 result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA";
849 result += "\n generation, expiration control and many more features.";
851 result += "\nThe ADML process can easily configure a many realm nodes as needed, which will have own endpoints.";
852 result += "\nYou should avoid loop configurations (client and server for that client) because automatic forwarding,";
853 result += "\n is implemented and this would get in a never ending cycle when a request is sent.";
855 result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually";
856 result += "\n 'debug' or 'warning'. See ANNA documentation for more details.";
858 result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:";
859 result += "\n kill -10 <pid>";
861 result += "\n kill -s SIGUSR1 <pid>";
862 result += "\n and then";
863 result += "\n vi /var/tmp/anna.context.<pid>";
865 result += "\nA complete xml report will show all the context information (counters, alarms, statistics,";
866 result += "\n handlers, diameter stacks, etc.), and a powerful log module could dump all the events";
867 result += "\n processed and flow information. Statistics could be analized at context dump and optionally";
868 result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the";
869 result += "\n measurements.";
871 result += "\nAlso SIGUSR2 is handled for management purposes. We will talk later about this.";
874 result += "\nCOMMAND LINE";
875 result += "\n------------";
877 result += "\nStart the launcher process without arguments in order to see all the startup configuration";
878 result += "\n posibilities, many of which could be modified on the air through the management interface";
879 result += "\n (we will talk later about this great feature). There is only one mandatory parameter which";
880 result += "\n is the services definition: --services <services xml file>. You must follow the dtd schema";
881 result += "\n to build a valid services xml file. Some basic examples are:";
883 result += "\nClient configuration:";
885 result += "\n<services>";
886 result += "\n <!-- Stacks -->";
887 result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
889 result += "\n <!-- Nodes -->";
890 result += "\n <node originRealm=\"ADML-client\" applicationId=\"0\" entity=\"localhost:3868\"/>";
891 result += "\n</services>";
893 result += "\nServer configuration:";
895 result += "\n<services>";
896 result += "\n <!-- Stacks -->";
897 result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
899 result += "\n <!-- Nodes -->";
900 result += "\n <node originRealm=\"ADML-server\" applicationId=\"0\" diameterServer=\"localhost:3868\"/>";
901 result += "\n</services>";
903 result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably";
904 result += "\n will need to program the answers to be replied through the operations interface. To balance the";
905 result += "\n traffic at your client side you shall use '--balance' and '--sessionBasedModelsClientSocketSelection'";
906 result += "\n arguments in order to define the balancing behaviour. To make hybrid setups you only must mix the realms:";
908 result += "\nClient and server configuration:";
910 result += "\n<services>";
911 result += "\n <!-- Stacks -->";
912 result += "\n <stack id=\"16777236\" dictionary=\"dictionary_Rx.xml\"/>";
913 result += "\n <stack id=\"16777238\" dictionary=\"dictionary_Gx.xml\"/>";
914 result += "\n <stack id=\"0\" dictionary=\"dictionary_base.xml\"/>";
916 result += "\n <!-- Nodes -->";
917 result += "\n <node originRealm=\"ADML-Rx-client\" applicationId=\"16777236\" entity=\"localhost:3868\" cer=\"cer_Rx.xml\"/>";
918 result += "\n <node originRealm=\"ADML-Gx-client\" applicationId=\"16777238\" entity=\"localhost:3868\" cer=\"cer_Gx.xml\"/>";
919 result += "\n</services>";
922 result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own";
923 result += "\n as shown in the hybrid former example. Note that the base protocol stack must be registered because";
924 result += "\n the configuration corresponds to a multistack process which change the stack using the application-id";
925 result += "\n processed (0 in the case of base protocol messages: CER, CEA, DWR, DWA, DPR, DPA).";
927 result += "\nDYNAMIC OPERATIONS";
928 result += "\n------------------";
930 result += "\nADML supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh.";
931 result += "\nAn operation is specified by mean a string containing the operation name and needed arguments";
932 result += "\n separated by pipes. These are the available commands:";
934 result += "\n--------------------------------------------------------------------------------------- General purpose";
936 result += "\nhelp This help.";
938 result += "\n--------------------------------------------------------------------------------------- Node management";
940 result += "\nnode[|<name>] Selects a context working node by mean a registered name.";
941 result += "\n All the subsequent operations will be forced to work with";
942 result += "\n this node, which makes possible some rare scenarios like";
943 result += "\n sending unexpected messages on remote peers. This is also";
944 result += "\n useful for some operations in order to restrict the scope";
945 result += "\n of action (statistics, communication visibility, etc.).";
946 result += "\n Empty parameter will show the current configuration.";
948 result += "\nnode_auto Returns to the default behaviour (smart node selection).";
949 result += "\n Depending on the operation, this could imply a global";
950 result += "\n action scope, affecting to all the registered realms.";
951 result += "\n This should be the normal configuration. Take into";
952 result += "\n account that if you fix the working node, this could";
953 result += "\n affect to things like test programming: communication";
954 result += "\n resources will override those which would be inferred";
955 result += "\n from programmed messages Origin-Realm avps.";
957 result += "\n------------------------------------------------------------------------------------ Parsing operations";
959 result += "\ncode|<source_file>|<target_file> Encodes source file (pathfile) into target file (pathfile).";
960 result += "\ndecode|<source_file>|<target_file> Decodes source file (pathfile) into target file (pathfile).";
961 result += "\nloadxml|<source_file> Reinterpret xml source file (pathfile).";
963 result += "\n------------------------------------------------------------------------------------------- Hot changes";
965 result += "\nservices[|source file] Adds and starts the services specified in the xml file provided.";
966 result += "\n (if missing, the file 'services.xml' will be used). This is used";
967 result += "\n to load new nodes once the ADML is started, regardless if command";
968 result += "\n line '--services' parameter was used or not. Those services which";
969 result += "\n are not correctly loaded will be ignored to keep the process alive.";
971 result += "\ndiameterServerSessions|<integer> Updates the maximum number of accepted connections to diameter";
972 result += "\n server socket.";
973 result += "\ncontext[|target file] Application context could also be written by mean this operation,";
974 result += "\n and not only through SIGUSR1. If optional path file is missing,";
975 result += "\n default '/var/tmp/anna.context.<pid>' will be used.";
976 result += "\ncollect Reset statistics and counters to start a new test stage of";
977 result += "\n performance measurement. Context data can be written at";
978 result += "\n '/var/tmp/anna.context.<pid>' by mean 'kill -10 <pid>'.";
979 result += "\n or sending operation 'context|[target file]'.";
980 result += "\n This operation applies over all the registered realm nodes";
981 result += "\n except if one specific working node has been set.";
982 result += "\nforceCountersRecord Forces dump to file the current counters of the process.";
983 result += "\noam-and-stats Dumps current counters and statistics of the process. This is";
984 result += "\n also done at process context dump.";
986 result += "\n<visibility action>[|<address>:<port>][|socket id]";
988 result += "\n Actions: hide, show (update state) and hidden, shown (query state).";
989 result += "\n Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A).";
990 result += "\n If missing server (first parameter) all applications sockets will be affected.";
991 result += "\n If missing socket (second parameter) for specific server, all its sockets will be affected.";
993 result += "\n All application client sessions are shown on startup, but standard delivery only use primary";
994 result += "\n server ones except if fails. Balance configuration use all the allowed sockets. You could also";
995 result += "\n use command line 'sessionBasedModelsClientSocketSelection' to force traffic flow over certain";
996 result += "\n client sessions, but for this, hide/show feature seems easier.";
998 result += "\n--------------------------------------------------------------------------------------- Flow operations";
1000 result += "\nsendxml2e|<source_file> Sends xml source file (pathfile) through configured entity.";
1001 result += "\nsendxml2c|<source_file> Sends xml source file (pathfile) to client.";
1002 result += "\nanswerxml2e[|source_file] Answer xml source file (pathfile) for incoming request with same code from entity.";
1003 result += "\n The answer is stored in a FIFO queue for a specific message code, then there are";
1004 result += "\n as many queues as different message codes have been programmed.";
1005 result += "\nanswerxml2c[|source_file] Answer xml source file (pathfile) for incoming request with same code from client.";
1006 result += "\n The answer is stored in a FIFO queue for a specific message code, then there are";
1007 result += "\n as many queues as different message codes have been programmed.";
1008 result += "\nanswerxml<2e/2c> List programmed answers (to entity/client) if no parameter provided.";
1009 result += "\nanswerxml<2e/2c>|dump Write programmed answers (to entity/client) to file 'programmed_answer.<message code>.<sequence>',";
1010 result += "\n where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers.";
1011 result += "\nanswerxml<2e/2c>|clear Clear programmed answers (to entity/client).";
1012 result += "\nanswerxml<2e/2c>|exhaust Disable the corresponding queue rotation, which is the default behaviour.";
1013 result += "\nanswerxml<2e/2c>|rotate Enable the corresponding queue rotation, useful in performance tests.";
1014 result += "\n Rotation consists in add again to the queue, each element retrieved for answering.";
1016 result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test";
1017 result += "\nspecial scenarios (protocol errors):";
1019 result += "\nsendhex2e|<source_file> Sends hex source file (pathfile) through configured entity.";
1020 result += "\nsendhex2c|<source_file> Sends hex source file (pathfile) to client.";
1022 result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also";
1023 result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
1024 result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created.";
1026 result += "\nIf a request is received, answer map (built with 'answerxml<2e/2c>' operations) will be";
1027 result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,";
1028 result += "\n or answer message was received, the message is forwarded to the other side (entity or client),";
1029 result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when";
1030 result += "\n diameter server socket is configured, answer to entity have sense when entity does.";
1032 result += "\nIn the most complete situation (process with both client and server side) there are internally";
1033 result += "\n two maps with N FIFO queues, one for each different message code within programmed answers.";
1034 result += "\nOne map is for answers towards the client, and the other is to react entity requests. Then in";
1035 result += "\n each one we could program different answers corresponding to different request codes received.";
1037 result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored";
1038 result += "\n to the peer which sent the request. If user wants to test a specific answer without changing it,";
1039 result += "\n use sendxml<2e/2c>/sendhex<2e/2c> operations better than programming.";
1041 result += "\nBalance ('--balance' command line parameter) could be used to forward server socket receptions through";
1042 result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should";
1043 result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an";
1044 result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc.";
1046 result += "\n--------------------------------------------------------------------------- Processing types (log tags)";
1048 result += "\nUsed as log file extensions (when '--splitLog' is provided on command line) and context preffixes on log";
1049 result += "\n details when unique log file is dumped:";
1051 result += "\n [sent2e/send2eError] Send to entity (success/error)";
1052 result += "\n [sent2c/send2cError] Send to client (success/error)";
1053 result += "\n [fwd2e/fwd2eError] Forward to entity a reception from client (success/error)";
1054 result += "\n [fwd2c/fwd2cError] Forward to client a reception from entity (success/error)";
1055 result += "\n [recvfc] Reception from client";
1056 result += "\n [recvfe] Reception from entity";
1057 result += "\n [req2c-expired] A request sent to client has been expired";
1058 result += "\n [req2e-expired] A request sent to entity has been expired";
1059 result += "\n [recvfc-ans-unknown] Reception from client of an unknown answer (probably former [req2c-expired]";
1060 result += "\n has been logged)";
1061 result += "\n [recvfe-ans-unknown] Reception from entity of an unknown answer (probably former [req2e-expired]";
1062 result += "\n has been logged)";
1063 result += "\n [retry] Request retransmission";
1065 result += "\n------------------------------------------------------------------------------------------- Burst tests";
1067 result += "\nIn order to simplify user experience, burst category operations are only allowed in single realm node";
1068 result += "\n configuration. Indeed, you could send messages with incorrect Origin-Realm, and no warning is shown.";
1069 result += "\nAll the operations are performed through the unique realm: if you need to use more interfaces, you may";
1070 result += "\n launch different ADML instances. Is nonsense to allow burst in a multi-realm configured ADML, because";
1071 result += "\n this feature is not able to coordinate the messages.";
1073 result += "\nburst|<action>[|parameter] Used for performance testing, we first program diameter requests";
1074 result += "\n messages in order to launch them from client side to the configured";
1075 result += "\n diameter entity. We could start the burst with an initial load";
1076 result += "\n (non-asynchronous sending), after this, a new request will be sent";
1077 result += "\n per answer received or expired context. There are 10 actions: clear,";
1078 result += "\n load, start, push, pop, stop, repeat, send, goto and look.";
1080 result += "\n burst|clear Clears all loaded burst messages.";
1081 result += "\n burst|load|<source_file> Loads the next diameter message into launcher burst.";
1082 result += "\n burst|start|<initial load> Starts (or restarts if already in progress) the message sending with";
1083 result += "\n a certain initial load.";
1084 result += "\n burst|push|<load amount> Sends specific non-aynchronous load.";
1085 result += "\n burst|pop|<release amount> Skip send burst messages in order to reduce over-the-air requests.";
1086 result += "\n Popping all OTA requests implies burst stop because no more answer";
1087 result += "\n will arrive to the process. Burst output file (--burstLog command";
1088 result += "\n line parameter) shows popped messages with crosses (x). Each cross";
1089 result += "\n represents one received answer for which no new request is sent.";
1090 result += "\n burst|stop Stops the burst cycle. You can resume pushing 1 load amount.";
1091 result += "\n burst|repeat[|[yes]|no] Restarts the burst launch when finish. If initial load or push load";
1092 result += "\n amount is greater than burst list size, they will be limited when";
1093 result += "\n the list is processed except when repeat mode is enabled.";
1094 result += "\n burst|send|<amount> Sends messages from burst list. The main difference with start/push";
1095 result += "\n operations is that burst won't be awaken. Externally we could control";
1096 result += "\n sending time (no request will be sent for answers).";
1097 result += "\n burst|goto|<order> Updates current burst pointer position.";
1098 result += "\n burst|look[|order] Show programmed burst message for order provided, current when missing.";
1100 result += "\n-------------------------------------------------------------------------------------- Advanced testing";
1102 result += "\n Burst mode only allows single interface interaction. For multiple interface";
1103 result += "\n (realm) coordination, you could use the advanced test cases programming:";
1106 result += "\n test|<id>|<command>[|parameters]";
1108 result += "\n Adds a new step to the test case with provided identifier. If provided identifier";
1109 result += "\n is not registered yet, a new test case will be created with that value and the";
1110 result += "\n step will be added as the first. For a specific 'id', the steps are stored in";
1111 result += "\n order as they are programmed. Check possible runtime exceptions when adding a";
1112 result += "\n new step because those which fail, will be ignored/skipped during test case";
1113 result += "\n programming giving an incomplete sequence invalid for the testing purpose.";
1115 result += "\n <id>: integer number, normally monotonically increased for each test case. Some external";
1116 result += "\n script/procedure shall clone a test case template in order to build a collection";
1117 result += "\n of independent and coherent test cases (normally same type) with different context";
1118 result += "\n values (Session-Id, Subscriber-Id, etc.).";
1120 result += "\n <command>: commands to be executed for the test id provided. Each command programmed";
1121 result += "\n constitutes a test case 'step', numbered from 1 to N.";
1123 result += "\n timeout|<msecs> Sets an asynchronous timer to restrict the maximum timeout";
1124 result += "\n until last test step. Normally, this command is invoked";
1125 result += "\n in the first step, anyway it measures the time from the";
1126 result += "\n execution point whatever it is. The expiration will abort";
1127 result += "\n the test if still running. One or more timeouts could be";
1128 result += "\n programmed (not usual), but the more restrict will apply.";
1129 result += "\n It is highly recommended to program a initial timeout step,";
1130 result += "\n or the test case could be eternally in-progress.";
1132 result += "\n sendxml2e|<source_file>[|<step number>]";
1133 result += "\n Sends xml source file (pathfile) to entity (it would be a";
1134 result += "\n 'forward' event if it came through local server endpoint).";
1135 result += "\n The step number should be provided for answers to indicate";
1136 result += "\n the 'wait for request' corresponding step. If you miss this";
1137 result += "\n reference, the sequence information (hop-by-hop, end-to-end)";
1138 result += "\n will be sent as they are in the answer xml message (realize";
1139 result += "\n the difficulty of predicting these information). Be sure to";
1140 result += "\n refer to a 'wait for request' step. Conditions like 'regexp'";
1141 result += "\n (as we will see later) are not verified.";
1143 result += "\n sendxml2c|<source_file>[|<step number>]";
1144 result += "\n Sends xml source file (pathfile) to client (it would be a";
1145 result += "\n 'forward' event if it came through remote server endpoint).";
1146 result += "\n Same commented for 'sendxml2e' regarding the step number.";
1148 result += "\n delay|<msecs> Blocking step until the time lapse expires. Useful to give ";
1149 result += "\n some cadence control and time schedule for a specific case.";
1150 result += "\n wait<fe/fc>|<condition> Blocking step until condition is fulfilled. The message could";
1151 result += "\n received from entity (waitfe) or from client (waitfc).";
1153 result += "\n wait<fe/fc>-regexp|<regexp>";
1154 result += "\n Wait condition, from entity (waitfe-regexp) or client (waitfc-regexp)";
1155 result += "\n to match the serialized xml content for received messages. CPU cost";
1156 result += "\n is bigger than the former ones because the whole message must be";
1157 result += "\n decoded and converted to xml instead of doing a direct hexadecimal";
1158 result += "\n buffer search. The main advantage is the great flexibility to identify";
1159 result += "\n any content with a regular expression.";
1161 result += "\n sh-command|<script> External execution for script/executable via shell through a dedicated";
1162 result += "\n thread, providing the command and parameters. You could use dynamic";
1163 result += "\n variables ##<tag> to have more flexibility:";
1164 result += "\n Test pool cycle id: "; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1165 result += "\n Test case id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1166 result += "\n Test step id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1168 result += "\n For example, your command could be something like this:";
1169 result += "\n insert_sql_"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID; result += ".sh -db dbname --verbose";
1170 result += "\n > /tmp/cycle-"; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1171 result += ".testcase-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1172 result += ".teststep-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1174 result += "\n Try to redirect stdout and stderr to avoid ADML output contamination";
1175 result += "\n with the possible outputs from the scripts. You could also put your";
1176 result += "\n job in background although sh-command will return 0-value immediately.";
1178 result += "\n <condition>: Optional parameters which must be fulfilled to continue through the next step.";
1179 result += "\n Any received message over diameter interfaces will be evaluated against the";
1180 result += "\n corresponding test case starting from the current step until the first one";
1181 result += "\n whose condition is fulfilled. If no condition is fulfilled the event will be";
1182 result += "\n classified as 'uncovered' (normally a test case bad configuration, or perhaps";
1183 result += "\n a real unexpected message).";
1186 // result += "\n The way to identify the test case, is through registered Session-Id values for";
1187 // result += "\n programmed requests. But this depends on the type of node. Acting as clients,";
1188 // result += "\n requests received have Session-Id values which are already registered with";
1189 // result += "\n one test case, causing an error if not found. Acting as servers, requests are";
1190 // result += "\n received over a diameter local server from a client which are generating that";
1191 // result += "\n Session-Id values. Then we know nothing about such values. The procedure in";
1192 // result += "\n this case is find out a test case not-started containing a condition which";
1193 // result += "\n comply with the incoming message, and reactivates it.";
1194 // The other solution: register Session-Id values for answers send to client from a local diameter server.
1196 result += "\n How to answer: a wait condition for a request will store the incoming message";
1197 result += "\n which fulfills that condition. This message is useful together with the peer";
1198 result += "\n connection source in a further send step configured with the corresponding";
1199 result += "\n response. You could also insert a delay between wait and send steps to be";
1200 result += "\n more realistic (processing time simulation in a specific ADML realm node).";
1201 result += "\n Always, a response send step will get the needed information from the most";
1202 result += "\n recent wait step finding in reverse order (note that some race conditions";
1203 result += "\n could happen if your condition is not specific enough).";
1206 result += "\n Condition format:";
1208 result += "\n [code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]";
1210 result += "\n code: integer number";
1211 result += "\n bitR: 1 (request), 0 (answer)";
1212 result += "\n hopByHop: integer number or request send step reference: #<step number>";
1214 result += "\n Using the hash reference, you would indicate a specific wait condition";
1215 result += "\n for answers. The step number provided must correspond to any of the";
1216 result += "\n previous send commands (sendxml2e/sendxml2c) configured for a request.";
1217 result += "\n This 'hop-by-hop' variant eases the wait condition for answers in the";
1218 result += "\n safest way.";
1220 result += "\n applicationId: integer number";
1221 result += "\n sessionId: string";
1222 result += "\n resultCode: integer number";
1223 result += "\n msisdn: string";
1224 result += "\n imsi: string";
1225 result += "\n serviceContextId: string";
1227 result += "\n Take into account these rules, useful in general:";
1229 result += "\n - Be as much specific as possible defining conditions to avoid ambiguity sending";
1230 result += "\n messages out of context due to race conditions. Although you could program several";
1231 result += "\n times similar conditions, some risky practices will throw a warning trace (if you";
1232 result += "\n repeat the same condition within the same test case).";
1233 result += "\n - Adding a ResultCode and/or HopByHop to the condition are only valid waiting answers.";
1234 result += "\n - Requests hop-by-hop values must be different for all the test case requests.";
1235 result += "\n RFC says that a hop by hop must be unique for a specific connection, something that";
1236 result += "\n could be difficult to manage if we have multiple available connections from client";
1237 result += "\n side endpoint (entity or local server), even if we would have only one connection but";
1238 result += "\n several realm interfaces. It is enough to configure different hop-by-hop values within";
1239 result += "\n each test case, because on reception, the Session-Id is used to identify that test case.";
1244 result += "\n Programming example:";
1246 result += "\n Basic Rx/Gx scenary: PCEF (Gx) - PCRF - AF (Rx)";
1248 result += "\n test|1|timeout|5000 (step 1: whole time requirement is 5 seconds)";
1249 result += "\n test|1|sendxml2e|CCR-I.xml (step 2: imagine this xml uses the Session-Id 'SGx')";
1250 result += "\n test|1|waitfe|272|0|||SGx|2001 (step 3: waits the CCA for the CCR-I with Result-Code = DIAMETER_SUCCESS)";
1251 result += "\n test|1|sendxml2e|AAR-flows.xml (step 4: imagine this xml uses the Session-Id 'SRx')";
1252 result += "\n test|1|waitfe|265|0|||SRx|2001 (step 5: waits the AAA for the AAR-flows with Result-Code = DIAMETER_SUCCESS)";
1253 result += "\n test|1|waitfe|258|1|||SGx (step 6: waits the RAR (install policies) from the PCRF server)";
1254 result += "\n test|1|sendxml2e|RAA-install.xml|6 (step 7: sends the response for the RAR)";
1255 result += "\n test|1|sendxml2e|CCR-T.xml (step 8: termination of the Gx session, imagine this xml puts hop-by-hop 'H1')";
1256 result += "\n test|1|waitfe|272|0|H1||SGx|2001 (step 9: waits the CCA for the CCR-T with Result-Code = DIAMETER_SUCCESS and hop-by-hop 'H1')";
1257 result += "\n test|1|waitfe|258|1|||SGx (step 10: waits the RAR (remove policies) from the PCRF server)";
1258 result += "\n test|1|sendxml2e|RAA-remove.xml|10 (step 11: sends the response for the RAR)";
1260 result += "\n Notes: We added an additional condition in step 9: the hop-by-hop. When we program the corresponding";
1261 result += "\n source request (CCR-T), we configured the value 'H1' for the hop-by-hop. This is an 'application";
1262 result += "\n value' because the real hop-by-hop transported through the client connection is managed by the";
1263 result += "\n diameter stack. But when returned, the transaction pool resolve the original value. This feature";
1264 result += "\n is necessary to ease the implementation of certain diameter agents (proxies for example). In our";
1265 result += "\n case, we could format the hop-by-hop values within the request templates with total freedom to";
1266 result += "\n improve the programmed conditions.";
1268 result += "\n In the case of 'waiting for requests' is not such easy. Indeed, steps 6 and 10 will write a warning";
1269 result += "\n because they are the same condition. We know that we are not going to have any problem because";
1270 result += "\n such events are blocking-protected regarding logic-dependent messages (CCR-T), and race condition";
1271 result += "\n is absolutely strange in this case.";
1273 result += "\n You could speed up the test case moving forward steps like 3 & 5, understood as non-strict requirements";
1274 result += "\n to continue testing. Anyway, remember that test cases should be as real as possible, and that there";
1275 result += "\n are many ways to increase the load rate as we will see in next section (test cases execution).";
1277 result += "\n Other simplifications: the steps 3, 5 and 9 can be replaced by";
1279 result += "\n test|1|waitfe||0|#2";
1280 result += "\n test|1|waitfe||0|#4";
1281 result += "\n test|1|waitfe||0|#8";
1283 result += "\n which means that hop-by-hop must be retrieved from steps 2, 4 and 8 respectively,";
1284 result += "\n and the expected message shall be an answer. Normally you will add other conditions,";
1285 result += "\n for example a DIAMETER_SUCCESS result (adding 2001 as Result-Code).";
1287 result += "\nTest cases execution:";
1290 result += "\n test|ttps|<amount> Starts/resume the provided number of test ticks per second (ttps). The ADML starts";
1291 result += "\n with the event trigger system suspended, and this operation is neccessary to begin";
1292 result += "\n those cases which need this time event (internal triggering). Some other test cases";
1293 result += "\n could be started through external events (first test case event could be programmed";
1294 result += "\n to wait specific message), but is not usual this external mode and neither usual to";
1295 result += "\n mix triggering types. Normally, you will pause/stop new test launchs providing 0 as";
1296 result += "\n ttps value, and also you could dynamically modify the load rate updating that value.";
1297 result += "\n If a test case has N messages then 'ttps * N' will be the virtual number of messages";
1298 result += "\n managed per second when no bottleneck exists.";
1300 result += "\n Provide 0 in order to stop the timer triggering.";
1302 result += "\n There timer manager resolution currently harcoded allows a maximum of ";
1303 result += anna::functions::asString(1000/a_admlMinResolution); result += " events";
1304 result += "\n per second. To reach greater rates ADML will join synchronously the needed number of";
1305 result += "\n new time-triggered test cases per a single event, writting a warning-level trace to";
1306 result += "\n advice about the risk of burst sendings and recommend launching multiple instances";
1307 result += "\n to achieve such load with a lower rate per instance.";
1309 result += "\n test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value";
1310 result += "\n (test Manager tick work will be ignored). Zero-value is equivalent to stop the clock.";
1311 result += "\n tick, -1 is used to specify 'no limit' which is the default. If missing amount, the";
1312 result += "\n limit and current amount of in-progress test cases will be shown.";
1314 result += "\n test|goto|<id> Updates current test pointer position.";
1316 result += "\n test|look[|id] Show programmed test case for id provided, current 'in-process' test case when missing.";
1317 result += "\n Test cases reports are not dumped on process context (too many information in general).";
1318 result += "\n The report contains context information in every moment: this operation acts as a snapshot.";
1320 result += "\n test|report[|[yes]|no] Every time a test case is finished, its xml representation will be dump on a file under";
1321 result += "\n the execution directory (or the one configured in process command-line 'tmDir') with";
1322 result += "\n the name 'cycle-<cycle id>.testcase-<test case id>.xml'. This option is disabled by";
1323 result += "\n default reducing IO. ADML process context won't show test manager whole information";
1324 result += "\n because it could be a huge amount of data to write. Anyway, you could use the 'look'";
1325 result += "\n operation to see the desired report(s).";
1327 result += "\n test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.";
1329 result += "\n test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps";
1330 result += "\n to be done. Normally, we will execute 'test|interact|0|<test case id>', which means that";
1331 result += "\n the test case is selected to be interactive, but no step is executed. Then you have to";
1332 result += "\n interact with positive amounts (usually 1), executing the provided number of steps if";
1333 result += "\n they are ready and fulfill the needed conditions. The value of 0, implies no execution";
1334 result += "\n steps margin, which could be useful to 'freeze' a test in the middle of its execution.";
1335 result += "\n You could also provide -1 to make it non-interactive resuming it from the current step.";
1337 result += "\n test|reset|<soft/hard>[|id] Reset the test case for id provided, all the tests when missing. It could be hard/soft:";
1338 result += "\n - hard: you probably may need to stop the load rate before. This operation initializes";
1339 result += "\n all test cases regardless their states.";
1340 result += "\n - soft: only for finished cases (those with 'Success' or 'Failed' states). It does not";
1341 result += "\n affect to test cases with 'InProgress' state.";
1343 result += "\n test|repeats|<amount> Restarts the whole programmed test list when finished the amount number of times (repeats";
1344 result += "\n forever if value -1 is provided). This is disabled by default (amount = 0): testing trigger";
1345 result += "\n system will enter suspended state until new ttps operation is received and a soft reset has";
1346 result += "\n been done before. Test cases state & data will be reset (when achieved again), but general";
1347 result += "\n statistics and counters will continue measuring until reset with 'collect' operation.";
1349 result += "\n test|clear Clears all the programmed test cases and stop testing (if in progress).";
1351 result += "\n test|summary Test manager general report (number of test cases, counts by state, global configuration,";
1352 result += "\n forced in-progress limitation, reports visibility, etc.). Be careful when you have reports";
1353 result += "\n dumps enabled because all the programmed test cases will be dump and that could be heavy.";
1356 result += "\nUSING OPERATIONS INTERFACE";
1357 result += "\n--------------------------";
1359 result += "\n------------------------------------------------------------------------- Operations via HTTP interface";
1361 result += "\nAll the operations described above can be used through the optional HTTP interface. You only have";
1362 result += "\n to define the http server at the command line with something like: '--httpServer localhost:9000'.";
1363 result += "\nTo send the task, we shall build the http request body with the operation string. Some examples";
1364 result += "\n using curl client could be:";
1366 result += "\n curl -m 1 --data \"diameterServerSessions|4\" localhost:9000";
1367 result += "\n curl -m 1 --data \"code|ccr.xml\" localhost:9000";
1368 result += "\n curl -m 1 --data \"decode|ccr.hex\" localhost:9000";
1369 result += "\n curl -m 1 --data \"sendxml2e|ccr.xml\" localhost:9000";
1370 result += "\n etc.";
1372 result += "\n------------------------------------------------------------------------- Operations via SIGUSR2 signal";
1374 result += "\nThe alternative using SIGUSR2 signal requires the creation of the task(s) file which will be read at";
1375 result += "\n signal event:";
1376 result += "\n echo \"<<operation>\" > "; result += SIGUSR2_TASKS_INPUT_FILENAME;
1377 result += "\n then";
1378 result += "\n kill -12 <pid>";
1380 result += "\n kill -s SIGUSR2 <pid>";
1381 result += "\n and then see the results:";
1382 result += "\n cat "; result += SIGUSR2_TASKS_OUTPUT_FILENAME;
1384 result += "\nYou could place more than one line (task) in the input file. Output reports will be appended in that";
1385 result += "\n case over the output file. Take into account that all the content of the task file will be executed";
1386 result += "\n sinchronously by the process. If you are planning traffic load, better use the asynchronous http";
1387 result += "\n interface.";
1394 void Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
1395 LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
1396 if (operation == "") return; // ignore
1397 LOGDEBUG(anna::Logger::debug(operation, ANNA_FILE_LOCATION));
1399 // Default response:
1400 response_content = "Operation processed with exception (see traces): ";
1401 response_content += operation;
1402 std::string opt_response_content = ""; // aditional response content
1403 anna::DataBlock db_aux(true);
1404 anna::diameter::codec::Message codecMsg; // auxiliary codec message
1407 CommandLine& cl(anna::CommandLine::instantiate());
1408 TestManager &testManager = TestManager::instantiate();
1411 ///////////////////////////////////////////////////////////////////
1412 // Simple operations without arguments:
1415 if(operation == "help") {
1416 response_content = help();
1420 // Reset performance data:
1421 if(operation == "collect") {
1424 response_content = "All process counters & statistic information have been reset";
1428 // Counters dump on demand:
1429 if(operation == "forceCountersRecord") {
1430 forceCountersRecord();
1431 response_content = "Current counters have been dump to disk";
1435 // OAM & statistics:
1436 if(operation == "oam-and-stats") {
1437 anna::xml::Node root("root");
1438 response_content = anna::xml::Compiler().apply(oamAndStatsAsXML(&root));
1442 ///////////////////////////////////////////////////////////////////
1443 // Tokenize operation
1445 params.apply(operation, "|", "<null>" /* allow contiguous separators */);
1446 int numParams = params.size() - 1;
1448 // Get the operation type and parameters:
1449 Tokenizer::const_iterator tok_iter = params.begin();
1450 std::string opType = Tokenizer::data(tok_iter);
1451 std::string param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11;
1452 if(numParams >= 1) { tok_iter++; param1 = Tokenizer::data(tok_iter); }
1453 if(numParams >= 2) { tok_iter++; param2 = Tokenizer::data(tok_iter); }
1454 if(numParams >= 3) { tok_iter++; param3 = Tokenizer::data(tok_iter); }
1456 if(numParams >= 4) { tok_iter++; param4 = Tokenizer::data(tok_iter); }
1457 if(numParams >= 5) { tok_iter++; param5 = Tokenizer::data(tok_iter); }
1458 if(numParams >= 6) { tok_iter++; param6 = Tokenizer::data(tok_iter); }
1459 if(numParams >= 7) { tok_iter++; param7 = Tokenizer::data(tok_iter); }
1460 if(numParams >= 8) { tok_iter++; param8 = Tokenizer::data(tok_iter); }
1461 if(numParams >= 9) { tok_iter++; param9 = Tokenizer::data(tok_iter); }
1462 if(numParams >= 10) { tok_iter++; param10 = Tokenizer::data(tok_iter); }
1463 if(numParams >= 11) { tok_iter++; param11 = Tokenizer::data(tok_iter); }
1464 // Remove '<null>' artificial token to ease further checkings:
1465 if (param1 == "<null>") param1 = "";
1466 if (param2 == "<null>") param2 = "";
1467 if (param3 == "<null>") param3 = "";
1468 if (param4 == "<null>") param4 = "";
1469 if (param5 == "<null>") param5 = "";
1470 if (param6 == "<null>") param6 = "";
1471 if (param7 == "<null>") param7 = "";
1472 if (param8 == "<null>") param8 = "";
1473 if (param9 == "<null>") param9 = "";
1474 if (param10 == "<null>") param10 = "";
1475 if (param11 == "<null>") param11 = "";
1477 // No operation has more than 2 arguments except 'test' ...
1478 if(opType != "test" && numParams > 2)
1479 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1482 // Check the number of parameters:
1483 bool wrongBody = false;
1485 if((opType == "node") && (numParams > 1)) wrongBody = true;
1486 if((opType == "node_auto") && (numParams > 0)) wrongBody = true;
1488 if(((opType == "code") || (opType == "decode")) && (numParams != 2)) wrongBody = true;
1490 if(((opType == "sendxml2e") || (opType == "sendhex2e")) && (numParams != 1)) wrongBody = true;
1492 if((opType == "burst") && (numParams < 1)) wrongBody = true;
1494 if((opType == "test") && (numParams < 1)) wrongBody = true;
1496 if(((opType == "sendxml2c") || (opType == "sendhex2c") || (opType == "loadxml") || (opType == "diameterServerSessions")) && (numParams != 1)) wrongBody = true;
1500 std::string msg = "Wrong body content format on HTTP Request for '";
1502 msg += "' operation (missing parameter/s). Use 'help' management command to see more information.";
1503 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1507 if(opType == "context") {
1508 std::string contextFile = ((numParams == 1) ? param1 : anna::functions::asString("/var/tmp/anna.context.%05d", getPid()));
1509 writeContext(contextFile);
1510 response_content = anna::functions::asString("Context dumped on file '%s'", contextFile.c_str());
1514 if(opType == "services") {
1515 std::string servicesFile = ((numParams == 1) ? param1 : "services.xml");
1517 loadServices(servicesFile, true /* bind entities */);
1519 catch(anna::RuntimeException &ex) {
1521 response_content = anna::functions::asString("Loaded services from file '%s' with errors", servicesFile.c_str());
1524 response_content = anna::functions::asString("Loaded services from file '%s'", servicesFile.c_str());
1529 if(opType == "node") {
1531 if (setWorkingNode(param1)) response_content = anna::functions::asString("Forced node is now '%s'", param1.c_str());
1534 if (a_workingNode) {
1535 response_content = "Working node is forced to be: \n\n";
1536 response_content += a_workingNode->asXMLString();
1539 response_content = "Working node is automatic";
1544 if(opType == "node_auto") {
1545 a_workingNode = NULL;
1546 response_content = "Working node has been set to automatic";
1550 // Operated realm from possible forced-working node:
1551 a_operatedRealm = a_workingNode ? a_workingNode /* priority */: NULL /* auto */;
1553 // If any message is managed: updateOperatedRealmNodeWithMessage(codecMessage)
1554 // To operate, use the exception-protected methods which never will return NULL:
1555 // getOperatedRealm(), getOperatedEntity(), getOperatedServer(), getOperatedEngine()
1558 if(opType == "code") {
1559 codecMsg.loadXML(param1);
1560 std::string hexString = anna::functions::asHexString(codecMsg.code());
1562 std::ofstream outfile(param2.c_str(), std::ifstream::out);
1563 outfile.write(hexString.c_str(), hexString.size());
1565 } else if(opType == "decode") {
1566 // Get DataBlock from file with hex content:
1567 if(!getDataBlockFromHexFile(param1, db_aux))
1568 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1571 try { codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1573 std::string xmlString = codecMsg.asXMLString();
1575 std::ofstream outfile(param2.c_str(), std::ifstream::out);
1576 outfile.write(xmlString.c_str(), xmlString.size());
1578 } else if((opType == "hide") || (opType == "show") || (opType == "hidden") || (opType == "shown")) {
1582 std::string key = param1;
1586 if(opType == "hide") getOperatedEngine()->findClientSession(key)->hide();
1588 if(opType == "show") getOperatedEngine()->findClientSession(key)->show();
1590 if(opType == "hidden") opt_response_content = getOperatedEngine()->findClientSession(key)->hidden() ? "true" : "false";
1592 if(opType == "shown") opt_response_content = getOperatedEngine()->findClientSession(key)->shown() ? "true" : "false";
1594 std::string address;
1596 anna::functions::getAddressAndPortFromSocketLiteral(param1, address, port);
1598 if(opType == "hide") getOperatedEngine()->findServer(address, port)->hide();
1600 if(opType == "show") getOperatedEngine()->findServer(address, port)->show();
1602 if(opType == "hidden") opt_response_content = getOperatedEngine()->findServer(address, port)->hidden() ? "true" : "false";
1604 if(opType == "shown") opt_response_content = getOperatedEngine()->findServer(address, port)->shown() ? "true" : "false";
1607 if(opType == "hide") getOperatedEntity()->hide();
1609 if(opType == "show") getOperatedEntity()->show();
1611 if(opType == "hidden") opt_response_content = getOperatedEntity()->hidden() ? "true" : "false";
1613 if(opType == "shown") opt_response_content = getOperatedEntity()->shown() ? "true" : "false";
1615 } else if((opType == "sendxml2e") || (opType == "sendhex2e")) {
1616 anna::diameter::comm::Message *msg;
1618 if(opType == "sendxml2e") {
1619 codecMsg.loadXML(param1);
1620 updateOperatedRealmNodeWithMessage(codecMsg);
1621 msg = getOperatedRealm()->createCommMessage();
1623 try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher)
1624 msg->setBody(codecMsg.code());
1626 // Get DataBlock from file with hex content:
1627 if(!getDataBlockFromHexFile(param1, db_aux))
1628 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1629 msg = getOperatedRealm()->createCommMessage();
1630 msg->setBody(db_aux);
1631 try { if(getOperatedRealm()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1634 bool success = getOperatedEntity()->send(msg, cl.exists("balance"));
1635 getOperatedRealm()->releaseCommMessage(msg);
1638 if(getOperatedRealm()->logEnabled()) {
1639 anna::diameter::comm::Server *usedServer = getOperatedEntity()->getLastUsedResource();
1640 anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
1641 std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
1642 getOperatedRealm()->writeLogFile(codecMsg, (success ? "sent2e" : "send2eError"), detail);
1644 } else if((opType == "burst")) {
1647 throw anna::RuntimeException("Burst category operations are only allowed in single realm node configuration. This is only to simplify user experience.", ANNA_FILE_LOCATION);
1649 // burst|clear clears all loaded burst messages.
1650 // burst|load|<source_file> loads the next diameter message into launcher burst.
1651 // burst|start|<initial load> starts the message sending with a certain initial load.
1652 // burst|push|<load amount> sends specific non-aynchronous load.
1653 // burst|stop stops the burst cycle.
1654 // burst|repeat|[[yes]|no] restarts the burst launch when finish.
1655 // burst|send|<amount> send messages from burst list. The main difference with
1656 // start/push operations is that burst won't be awaken.
1657 // Externally we could control sending time (no request
1658 // will be sent for answers).
1659 // burst|goto|<order> Updates current burst pointer position.
1660 // burst|look|<order> Show programmed burst message for order provided, current when missing.
1662 if(param1 == "clear") {
1663 opt_response_content = "removed ";
1664 opt_response_content += anna::functions::asString(getOperatedRealm()->clearBurst());
1665 opt_response_content += " elements";
1666 } else if(param1 == "load") {
1667 if(param2 == "") throw anna::RuntimeException("Missing xml path file for burst load operation", ANNA_FILE_LOCATION);
1669 codecMsg.loadXML(param2);
1670 if(codecMsg.isAnswer()) throw anna::RuntimeException("Cannot load diameter answers for burst feature", ANNA_FILE_LOCATION);
1671 try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue loading (see validation mode configured in launcher)
1673 int position = getOperatedRealm()->loadBurstMessage(codecMsg.code());
1674 opt_response_content = "loaded '";
1675 opt_response_content += param2;
1676 opt_response_content += "' file into burst list position ";
1677 opt_response_content += anna::functions::asString(position);
1678 } else if(param1 == "start") {
1679 if(param2 == "") throw anna::RuntimeException("Missing initial load for burst start operation", ANNA_FILE_LOCATION);
1681 int initialLoad = atoi(param2.c_str());
1682 int processed = getOperatedRealm()->startBurst(initialLoad);
1685 opt_response_content = "initial load completed for ";
1686 opt_response_content += anna::functions::entriesAsString(processed, "message");
1688 } else if(param1 == "push") {
1689 if(param2 == "") throw anna::RuntimeException("Missing load amount for burst push operation", ANNA_FILE_LOCATION);
1691 int pushed = getOperatedRealm()->pushBurst(atoi(param2.c_str()));
1694 opt_response_content = "pushed ";
1695 opt_response_content += anna::functions::entriesAsString(pushed, "message");
1697 } else if(param1 == "pop") {
1698 if(param2 == "") throw anna::RuntimeException("Missing amount for burst pop operation", ANNA_FILE_LOCATION);
1700 int releaseLoad = atoi(param2.c_str());
1701 int popped = getOperatedRealm()->popBurst(releaseLoad);
1704 opt_response_content = "burst popped for ";
1705 opt_response_content += anna::functions::entriesAsString(popped, "message");
1707 } else if(param1 == "stop") {
1708 int left = getOperatedRealm()->stopBurst();
1711 opt_response_content += anna::functions::entriesAsString(left, "message");
1712 opt_response_content += " left to the end of the cycle";
1714 } else if(param1 == "repeat") {
1715 if(param2 == "") param2 = "yes";
1717 bool repeat = (param2 == "yes");
1718 getOperatedRealm()->repeatBurst(repeat);
1719 opt_response_content += (repeat ? "repeat enabled" : "repeat disabled");
1720 } else if(param1 == "send") {
1721 if(param2 == "") throw anna::RuntimeException("Missing amount for burst send operation", ANNA_FILE_LOCATION);
1723 int sent = getOperatedRealm()->sendBurst(atoi(param2.c_str()));
1726 opt_response_content = "sent ";
1727 opt_response_content += anna::functions::entriesAsString(sent, "message");
1729 } else if(param1 == "goto") {
1730 if(param2 == "") throw anna::RuntimeException("Missing order position for burst goto operation", ANNA_FILE_LOCATION);
1732 opt_response_content = getOperatedRealm()->gotoBurst(atoi(param2.c_str()));
1733 } else if(param1 == "look") {
1734 int order = ((param2 != "") ? atoi(param2.c_str()) : -1);
1735 opt_response_content = "\n\n";
1736 opt_response_content += getOperatedRealm()->lookBurst(order);
1738 throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). See help", ANNA_FILE_LOCATION);
1741 } else if((opType == "test")) {
1742 // test|<id>|<command>[|parameters] Add a new step to the test case ...
1743 // test|ttps|<amount> Starts/resume the provided number of time ticks per second (ttps). The ADML starts ...
1744 // test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value ...
1745 // test|repeats|<amount> Restarts the whole programmed test list when finished the amount number of times ...
1746 // test|report[|[yes]|no] Every time a test case is finished a report file in xml format will be created under ...
1747 // test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.
1748 // test|goto|<id> Updates current test pointer position.
1749 // test|look[|id] Show programmed test case for id provided, current when missing ...
1750 // test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps ...
1751 // test|reset|<soft/hard>[|id] Reset the test case for id provided, all the tests when missing ...
1752 // test|clear Clears all the programmed test cases.
1753 // test|summary Test manager general report (number of test cases, counts by state ...
1756 if(param1 == "ttps") {
1758 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1760 bool success = ((param2 != "") ? testManager.configureTTPS(atoi(param2.c_str())) : false);
1762 opt_response_content = "assigned new test launch rate to ";
1763 opt_response_content += anna::functions::asString(atoi(param2.c_str()));
1764 opt_response_content += " events per second";
1767 opt_response_content += "unable to configure the test rate provided";
1770 else if(param1 == "ip-limit") {
1772 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1776 limit = atoi(param2.c_str());
1777 testManager.setInProgressLimit(limit);
1778 opt_response_content = "new in-progress limit: ";
1779 opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1782 opt_response_content = "in-progress limit amount: ";
1783 limit = testManager.getInProgressLimit();
1784 opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1785 opt_response_content += "; currently there are ";
1786 opt_response_content += anna::functions::asString(testManager.getInProgressCount());
1787 opt_response_content += " test cases running";
1790 else if(param1 == "repeats") {
1792 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1793 int repeats = atoi(param2.c_str());
1794 if (repeats < 0) repeats = -1;
1795 testManager.setPoolRepeats(repeats);
1796 std::string nolimit = (repeats != -1) ? "":" [no limit]";
1797 opt_response_content += anna::functions::asString("Pool repeats: %d%s (current cycle: %d)", repeats, nolimit.c_str(), testManager.getPoolCycle());
1799 else if(param1 == "report") {
1801 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1803 if(param2 == "") param2 = "yes";
1804 testManager.setDumpReports((param2 == "yes"));
1805 opt_response_content += (testManager.getDumpReports() ? "report enabled" : "report disabled");
1807 else if(param1 == "report-hex") {
1809 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1811 if(param2 == "") param2 = "yes";
1812 testManager.setDumpHex((param2 == "yes"));
1813 opt_response_content += (testManager.getDumpHex() ? "report includes hexadecimal messages" : "report excludes hexadecimal messages");
1815 else if(param1 == "goto") {
1817 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1819 if(param2 == "") throw anna::RuntimeException("Missing id for test goto operation", ANNA_FILE_LOCATION);
1820 int id = atoi(param2.c_str());
1821 if (testManager.gotoTestCase(id)) {
1822 opt_response_content = "position updated for id provided (";
1825 opt_response_content = "cannot found test id (";
1827 opt_response_content += anna::functions::asString(id);
1828 opt_response_content += ")";
1830 else if(param1 == "look") {
1832 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1834 int id = ((param2 != "") ? atoi(param2.c_str()) : -1);
1835 TestCase *testCase = testManager.findTestCase(id);
1838 response_content = testCase->asXMLString();
1843 opt_response_content = "no current test case detected (testing started ?)";
1846 opt_response_content = "cannot found test id (";
1847 opt_response_content += anna::functions::asString(id);
1848 opt_response_content += ")";
1852 else if (param1 == "interact") {
1854 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1856 int amount = atoi(param2.c_str());
1858 throw anna::RuntimeException("Interactive amount must be -1 (to disable interactive mode) or a positive number.", ANNA_FILE_LOCATION);
1860 int id = atoi(param3.c_str());
1861 TestCase *testCase = testManager.findTestCase(id);
1864 testCase->makeInteractive(false);
1865 opt_response_content = "interactive mode disabled";
1868 testCase->addInteractiveAmount(amount);
1869 opt_response_content = "added interactive amount of ";
1870 opt_response_content += anna::functions::asString(amount);
1871 opt_response_content += " units";
1872 if (amount == 0) opt_response_content += " (0: freezing a non-interactive testcase, no effect on already interactive)";
1874 opt_response_content += " for test case id ";
1875 opt_response_content += anna::functions::asString(id);
1878 opt_response_content = "cannot found test id (";
1879 opt_response_content += anna::functions::asString(id);
1880 opt_response_content += ")";
1883 else if(param1 == "reset") {
1885 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1887 if (param2 != "soft" && param2 != "hard")
1888 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1890 int id = ((param3 != "") ? atoi(param3.c_str()) : -1);
1891 TestCase *testCase = ((id != -1) ? testManager.findTestCase(id) : NULL);
1894 bool done = testCase->reset((param2 == "hard") ? true:false);
1895 opt_response_content = "test ";
1896 opt_response_content += param2;
1897 opt_response_content += " reset for id ";
1898 opt_response_content += anna::functions::asString(id);
1899 opt_response_content += done ? ": done": ": not done";
1903 bool anyReset = testManager.resetPool((param2 == "hard") ? true:false);
1904 opt_response_content = "reset have been sent to all programmed tests: "; opt_response_content += anyReset ? "some/all have been reset" : "nothing was reset";
1907 opt_response_content = "cannot found test id (";
1908 opt_response_content += anna::functions::asString(id);
1909 opt_response_content += ")";
1913 else if(param1 == "clear") {
1915 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1917 if (testManager.clearPool()) {
1918 opt_response_content = "all the programmed test cases have been dropped";
1921 opt_response_content = "there are not programmed test cases to be removed";
1924 else if(param1 == "summary") {
1925 response_content = testManager.asXMLString();
1929 int id = atoi(param1.c_str());
1931 throw anna::RuntimeException("Invalid test case identifier: must be a non-negative number", ANNA_FILE_LOCATION);
1933 // PARAM: 1 2 3 4 5 6 7 8 9 10 11
1934 // test|<id>|<command>
1936 // sendxml2e| <file>[|<step number>]
1937 // sendxml2c| <file>[|<step number>]
1939 // wait<fe/fc>|[code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]
1940 // wait<fe/fc>-answer|<step number>
1941 // wait<fe/fc>-regexp|<regexp>
1942 if(param2 == "") throw anna::RuntimeException("Missing command for test id operation", ANNA_FILE_LOCATION);
1945 if (param2 == "timeout") {
1947 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1948 if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'timeout' command in test id operation", ANNA_FILE_LOCATION);
1949 anna::Millisecond timeout = checkTimeMeasure("Test case timeout", param3);
1950 testManager.getTestCase(id)->addTimeout(timeout); // creates / reuses
1952 else if ((param2 == "sendxml2e")||(param2 == "sendxml2c")) {
1954 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1955 if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing xml file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
1956 codecMsg.loadXML(param3);
1957 if (codecMsg.isRequest()) {
1959 throw anna::RuntimeException("Step number is provided with answers (to resolve the corresponding 'wait for request' step), but NOT with requests", ANNA_FILE_LOCATION);
1962 if (param4 == "") LOGWARNING(anna::Logger::warning("Step number has not been provided. Take into account that this answer message will be sent 'as is' and sequence information could be wrong at the remote peer", ANNA_FILE_LOCATION));
1964 updateOperatedRealmNodeWithMessage(codecMsg);
1965 int stepNumber = ((param4 != "") ? atoi(param4.c_str()):-1);
1967 if (param2 == "sendxml2e")
1968 testManager.getTestCase(id)->addSendxml2e(codecMsg.code(), getOperatedRealm(), stepNumber); // creates / reuses
1970 testManager.getTestCase(id)->addSendxml2c(codecMsg.code(), getOperatedRealm(), stepNumber); // creates / reuses
1972 else if (param2 == "delay") {
1974 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1975 if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'delay' command in test id operation", ANNA_FILE_LOCATION);
1976 anna::Millisecond delay = checkTimeMeasure("Test case delay step", param3);
1977 testManager.getTestCase(id)->addDelay(delay); // creates / reuses
1979 else if ((param2 == "waitfe")||(param2 == "waitfc")) {
1981 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1982 if (param3 != "" || param4 != "" || param5 != "" || param6 != "" || param7 != "" || param8 != "" || param9 != "" || param10 != "" || param11 != "") {
1983 bool fromEntity = (param2.substr(4,2) == "fe");
1984 testManager.getTestCase(id)->addWait(fromEntity, param3, param4, param5, param6, param7, param8, param9, param10, param11);
1987 throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
1990 else if ((param2 == "waitfe-regexp")||(param2 == "waitfc-regexp")) {
1992 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1994 bool fromEntity = (param2.substr(4,2) == "fe");
1995 testManager.getTestCase(id)->addWaitRegexp(fromEntity, param3);
1998 throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2001 else if (param2 == "sh-command") {
2003 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2004 if(param3 == "") throw anna::RuntimeException("Missing script/executable command-line for 'sh-command' in test id operation", ANNA_FILE_LOCATION);
2005 testManager.getTestCase(id)->addCommand(param3); // creates / reuses
2008 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2012 } else if((opType == "sendxml2c") || (opType == "sendhex2c")) {
2013 anna::diameter::comm::Message *msg;
2015 if(opType == "sendxml2c") {
2016 codecMsg.loadXML(param1);
2017 updateOperatedRealmNodeWithMessage(codecMsg);
2018 msg = getOperatedRealm()->createCommMessage();
2020 try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher)
2022 msg->setBody(codecMsg.code());
2024 // Get DataBlock from file with hex content:
2025 if(!getDataBlockFromHexFile(param1, db_aux))
2026 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
2027 msg = getOperatedRealm()->createCommMessage();
2028 msg->setBody(db_aux);
2031 bool success = getOperatedServer()->send(msg);
2032 getOperatedRealm()->releaseCommMessage(msg);
2035 if(getOperatedRealm()->logEnabled()) {
2036 anna::diameter::comm::ServerSession *usedServerSession = getOperatedServer()->getLastUsedResource();
2037 std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
2038 getOperatedRealm()->writeLogFile(codecMsg, (success ? "sent2c" : "send2cError"), detail);
2040 } else if(opType == "loadxml") {
2041 codecMsg.loadXML(param1);
2042 response_content = codecMsg.asXMLString();
2044 } else if(opType == "diameterServerSessions") {
2045 int diameterServerSessions = atoi(param1.c_str());
2046 getOperatedServer()->setMaxConnections(diameterServerSessions);
2048 } else if(opType == "answerxml2c") {
2049 if(param1 == "") { // programmed answers FIFO's to stdout
2050 response_content = getOperatedServer()->getReactingAnswers()->asString("ANSWERS TO CLIENT");
2052 } else if (param1 == "rotate") {
2053 getOperatedServer()->getReactingAnswers()->rotate(true);
2054 } else if (param1 == "exhaust") {
2055 getOperatedServer()->getReactingAnswers()->rotate(false);
2056 } else if (param1 == "clear") {
2057 getOperatedServer()->getReactingAnswers()->clear();
2058 } else if (param1 == "dump") {
2059 getOperatedServer()->getReactingAnswers()->dump();
2061 codecMsg.loadXML(param1);
2062 updateOperatedRealmNodeWithMessage(codecMsg);
2063 anna::diameter::codec::Message *message = getOperatedRealm()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2064 LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2066 if(message->isRequest())
2067 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2069 int code = message->getId().first;
2070 LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to client' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2071 getOperatedServer()->getReactingAnswers()->addMessage(code, message);
2073 } else if(opType == "answerxml2e") {
2075 if(param1 == "") { // programmed answers FIFO's to stdout
2076 response_content = getOperatedEntity()->getReactingAnswers()->asString("ANSWERS TO ENTITY");
2078 } else if (param1 == "rotate") {
2079 getOperatedEntity()->getReactingAnswers()->rotate(true);
2080 } else if (param1 == "exhaust") {
2081 getOperatedEntity()->getReactingAnswers()->rotate(false);
2082 } else if (param1 == "clear") {
2083 getOperatedEntity()->getReactingAnswers()->clear();
2084 } else if (param1 == "dump") {
2085 getOperatedEntity()->getReactingAnswers()->dump();
2087 codecMsg.loadXML(param1);
2088 updateOperatedRealmNodeWithMessage(codecMsg);
2089 anna::diameter::codec::Message *message = getOperatedRealm()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2090 LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2092 if(message->isRequest())
2093 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2095 int code = message->getId().first;
2096 LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to entity' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2097 getOperatedEntity()->getReactingAnswers()->addMessage(code, message);
2100 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2104 response_content = "Operation correctly processed: "; response_content += operation;
2105 if (opt_response_content != "") {
2106 response_content += " => ";
2107 response_content += opt_response_content;
2111 anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const
2113 anna::xml::Node* result = parent->createChild("launcher");
2114 anna::comm::Application::asXML(result);
2116 result->createAttribute("StartTime", a_start_time.asString());
2117 result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000);
2119 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
2120 it->second->asXML(result);
2123 // OAM & statistics:
2124 oamAndStatsAsXML(result);
2126 // Testing: could be heavy if test case reports are enabled
2127 TestManager::instantiate().asXML(result);
2132 anna::xml::Node* Launcher::oamAndStatsAsXML(anna::xml::Node* parent) const
2134 anna::xml::Node* result = parent->createChild("OamAndStatistics");
2137 anna::diameter::comm::OamModule::instantiate().asXML(result);
2138 anna::diameter::comm::ApplicationMessageOamModule::instantiate().asXML(result);
2139 anna::diameter::codec::OamModule::instantiate().asXML(result);
2141 anna::statistics::Engine::instantiate().asXML(result);