Add unix timestamp milliseconds to dumpLog messages
[anna.git] / example / diameter / launcher / Launcher.cpp
1 // ANNA - Anna is Not Nothingness Anymore                                                         //
2 //                                                                                                //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
4 //                                                                                                //
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 //
7
8
9 // Standard
10 #include <sstream>      // std::istringstream
11 #include <iostream>     // std::cout
12 #include <math.h> // ceil
13 #include <climits>
14 #include <unistd.h> // chdir
15
16 // Project
17 #include <anna/timex/Engine.hpp>
18 #include <anna/statistics/Engine.hpp>
19 #include <anna/diameter/codec/functions.hpp>
20 #include <anna/diameter/codec/Engine.hpp>
21 #include <anna/diameter/codec/EngineManager.hpp>
22 #include <anna/http/Transport.hpp>
23 #include <anna/diameter/stack/Engine.hpp>
24 #include <anna/diameter/helpers/base/functions.hpp>
25 #include <anna/time/functions.hpp>
26 #include <anna/diameter.comm/ApplicationMessageOamModule.hpp>
27 #include <anna/xml/xml.hpp>
28
29 // Process
30 #include <Launcher.hpp>
31 #include <OriginHost.hpp>
32 #include <MyDiameterEngine.hpp>
33 #include <TestManager.hpp>
34 #include <TestCase.hpp>
35
36
37 #define SIGUSR2_TASKS_INPUT_FILENAME "sigusr2.in"
38 #define SIGUSR2_TASKS_OUTPUT_FILENAME "sigusr2.out"
39
40
41 const char *ServicesDTD = "\
42 <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
43 <!-- Diameter services DTD -->\n\
44 \n\
45 <!ELEMENT services (stack*, node*)>\n\
46 \n\
47 <!ELEMENT stack EMPTY>\n\
48 <!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\
49 <!--\n\
50    Stack record\n\
51 \n\
52     id:                      Normally the id corresponds to the Application-Id for which the dictionary provided is designed\n\
53                              (in multistack applications, it shall be mandatory respect such association to know the stack used\n\
54                              for processed messages).\n\
55     dictionary:              Path to the dictionary file.\n\
56     validationMode:          Sets the validation mode. Default is 'AfterDecoding'.\n\
57     validationDepth:         Sets the validation depth. Default is 'FirstError'.\n\
58     fixMode:                 Sets the fix mode. Default is 'BeforeEncoding'.\n\
59     ignoreFlagsOnValidation: Ignore flags during message validation. Default is 'no'.\n\
60 -->\n\
61 \n\
62 <!ELEMENT node EMPTY>\n\
63 <!ATTLIST node originHost CDATA #REQUIRED applicationId CDATA #REQUIRED originRealm 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\
64 <!--\n\
65    Node record\n\
66 \n\
67    originHost:                              Node identifier as diameter application host name.\n\
68    applicationId:                           The Application-Id provided must exists as a registered 'stack id'.\n\
69    originRealm:                             Origin-Realm (domain-name internally used by default).\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\
77                                             be assigned\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\
81                                             will be assigned.\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                                             Negative value implies no limit accepting incoming connections.\n\
91    balance:                                 Balance over entity servers instead of doing standard behaviour (first primary, secondary\n\
92                                             if fails, etc.). Default value 'no'.\n\
93    sessionBasedModelsClientSocketSelection: By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part\n\
94                                             will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR\n\
95                                             analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied;\n\
96                                             usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart').\n\
97    retries:                                 Expired responses will cause a number of request retransmissions. Disabled by default (0 retries).\n\
98    log:                                     Process log file (operations result, traffic log, etc.). By default '<originHost>.launcher.log'.\n\
99                                             Empty string or \"null\" name, to disable. Warning: there is no rotation for log files\n\
100                                             (use logrotate or whatever you consider).\n\
101    splitLog:                                Splits log file (appends to log filename, extensions with the type of event: see help on\n\
102                                             startup information-level traces). No log files for code/decode and load operations are created.\n\
103                                             Default value 'no'.\n\
104    detailedLog:                             Insert detailed information at log files (timestamps, communication resources, etc.). Useful\n\
105                                             to analyze the messages flow along the sockets (specially on 'balance' mode). Default 'no'.\n\
106    dumpLog:                                 Write to disk every incoming/outcoming message named as:\n\
107                                                '<unix ms timestamp>.<originHost>.<hop by hop>.<end to end>.<message code>.<request|answer>.<type of event>.xml'\n\
108                                             Default value 'no'.\n\
109    burstLog:                                Burst operations log file. By default '<originHost>.launcher.burst'. Empty string or \"null\" name, to disable.\n\
110                                             Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each\n\
111                                             burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst\n\
112                                             list size, plus OTA requests when changed.\n\
113 \n\
114 -->\n\
115 \n\
116 ";
117
118
119 Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) {
120   a_timeEngine = NULL;
121   a_counterRecorder = NULL;
122   a_admlMinResolution = 2 * anna::timex::Engine::minResolution; // 2*10 = 20 ms; 1000/20 = 50 ticks per second;
123   //a_admlMinResolution = (anna::Millisecond)100;
124   a_counterRecorderClock = NULL;
125
126   // a_originHosts.clear();
127   a_workingNode = NULL;
128
129   a_httpServerSocket = NULL;
130 }
131
132
133 std::string Launcher::getSignalUSR2InputFile() const throw() {
134   return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_INPUT_FILENAME);
135 }
136
137 std::string Launcher::getSignalUSR2OutputFile() const throw() {
138   return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_OUTPUT_FILENAME);
139 }
140
141
142 void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOperation) throw(anna::RuntimeException) {
143
144   CommandLine& cl(anna::CommandLine::instantiate());
145   bool allLogsDisabled = cl.exists("disableLogs");
146
147     //<!ATTLIST stack id CDATA #REQUIRED dictionary CDATA #REQUIRED>
148   const anna::xml::Attribute *id, *dictionary;
149
150   // <!ATTLIST node originHost CDATA #REQUIRED applicationId CDATA #REQUIRED 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>
151   const anna::xml::Attribute *originHost, *appId, *originRealm, *cer, *dwr, *allowedInactivityTime, *tcpConnectDelay,
152   *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions,
153   *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection,
154   *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog;
155   // Never clear services content from here (append new data from xml). At the moment no node removing is implemented in this process
156
157   // Stacks
158   anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
159   anna::diameter::stack::Dictionary *d;
160   const anna::diameter::stack::Dictionary *bpd = NULL; // base protocol dictionary
161
162   // Codec engine manager:
163   anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate();
164   anna::diameter::codec::Engine *ce;
165
166   ///////////////////////////////////////////
167   // APPLICATION MESSAGE OAM MODULE SCOPES //
168   ///////////////////////////////////////////
169   // We will register a scope per stack id registered. The counters will be dynamically registered at count method.
170   anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate();
171   appMsgOamModule.enableCounters(); // this special module is disabled by default (the only)
172   static int scope_id = 3;
173   unsigned int id_value;
174   std::string codecEngineName;
175
176   for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
177     std::string nodeName = (*it)->getName();
178
179     if(nodeName == "stack") {
180       // Input data:
181       id = (*it)->getAttribute("id");
182       dictionary = (*it)->getAttribute("dictionary");
183       id_value = id->getIntegerValue();
184
185       if (stackEngine.getDictionary(id_value)) { // Ignore (but don't fail) dictionary load with same stack id already registered
186         LOGWARNING(anna::Logger::warning(anna::functions::asString("Ignore dictionary load for stack id already registered: %llu", id_value), ANNA_FILE_LOCATION));
187         continue;
188       }
189
190       try {
191         d = stackEngine.createDictionary(id_value, dictionary->getValue());
192         LOGDEBUG(anna::Logger::debug(anna::functions::asString("Created dictionary (%p) for stack id %llu", d, id_value), ANNA_FILE_LOCATION));
193
194         // OAM module for counters:
195         appMsgOamModule.createStackCounterScope(scope_id, id_value /* application-id */);
196         scope_id++;
197
198       } catch(anna::RuntimeException &ex) {
199         //_exit(ex.asString());
200         throw ex;
201       }
202
203       bpd = d; // base protocol dictionary in case of monostack. If multistack, will be calculated later
204
205       // Create codec engine and register it in the codec engine manager:
206       codecEngineName = anna::functions::asString("CodecEngineForStackId_%llu", id_value);
207       ce = new anna::diameter::codec::Engine(codecEngineName.c_str(), d);
208       em.registerCodecEngine(id_value, ce);
209
210       // Codec engine configuration:
211       const anna::xml::Attribute *vm_attr = (*it)->getAttribute("validationMode", false /* no exception */);
212       const anna::xml::Attribute *vd_attr = (*it)->getAttribute("validationDepth", false /* no exception */);
213       const anna::xml::Attribute *fm_attr = (*it)->getAttribute("fixMode", false /* no exception */);
214       const anna::xml::Attribute *if_attr = (*it)->getAttribute("ignoreFlagsOnValidation", false /* no exception */);
215
216       std::string vm_value = vm_attr ? vm_attr->getValue() : "AfterDecoding";
217       std::string vd_value = vd_attr ? vd_attr->getValue() : "FirstError";
218       std::string fm_value = fm_attr ? fm_attr->getValue() : "BeforeEncoding";
219
220       anna::diameter::codec::Engine::ValidationMode::_v vm;
221       if (vm_value == "BeforeEncoding") vm = anna::diameter::codec::Engine::ValidationMode::BeforeEncoding;
222       else if (vm_value == "AfterDecoding") vm = anna::diameter::codec::Engine::ValidationMode::AfterDecoding;
223       else if (vm_value == "Always") vm = anna::diameter::codec::Engine::ValidationMode::Always;
224       else if (vm_value == "Never") vm = anna::diameter::codec::Engine::ValidationMode::Never;
225       ce->setValidationMode(vm);
226
227       anna::diameter::codec::Engine::ValidationDepth::_v vd;
228       if (vd_value == "Complete") vd = anna::diameter::codec::Engine::ValidationDepth::Complete;
229       else if (vd_value == "FirstError") vd = anna::diameter::codec::Engine::ValidationDepth::FirstError;
230       ce->setValidationDepth(vd);
231
232       anna::diameter::codec::Engine::FixMode::_v fm;
233       if (fm_value == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding;
234       else if (fm_value == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding;
235       else if (fm_value == "Always") fm = anna::diameter::codec::Engine::FixMode::Always;
236       else if (fm_value == "Never") fm = anna::diameter::codec::Engine::FixMode::Never;
237       ce->setFixMode(fm);
238
239       bool if_value = (if_attr ? (if_attr->getValue() == "yes") : false);
240       ce->ignoreFlagsOnValidation(if_value);
241     }
242   }
243
244   // Show loaded stacks:
245   std::cout << "Stacks currently loaded:" << std::endl;
246   std::cout << anna::functions::tab(stackEngine.asString(false /* light */)) << std::endl;
247
248   // Basic checking for multistack:
249   bool multistack = (stackEngine.stack_size() > 1);
250   if (multistack) {
251     bpd = stackEngine.getDictionary(0);
252     if(!bpd)
253       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);
254   }
255
256   // REALMS:
257   for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
258     std::string nodeName = (*it)->getName();
259
260     if(nodeName == "node") {
261       // Input data:
262       originHost = (*it)->getAttribute("originHost");
263       appId = (*it)->getAttribute("applicationId");
264       originRealm = (*it)->getAttribute("originRealm", false /* no exception */);
265       cer = (*it)->getAttribute("cer", false /* no exception */);
266       dwr = (*it)->getAttribute("dwr", false /* no exception */);
267       allowedInactivityTime = (*it)->getAttribute("allowedInactivityTime", false /* no exception */);
268       tcpConnectDelay = (*it)->getAttribute("tcpConnectDelay", false /* no exception */);
269       answersTimeout = (*it)->getAttribute("answersTimeout", false /* no exception */);
270       ceaTimeout = (*it)->getAttribute("ceaTimeout", false /* no exception */);
271       watchdogPeriod = (*it)->getAttribute("watchdogPeriod", false /* no exception */);
272       entity = (*it)->getAttribute("entity", false /* no exception */);
273       entityServerSessions = (*it)->getAttribute("entityServerSessions", false /* no exception */);
274       diameterServer = (*it)->getAttribute("diameterServer", false /* no exception */);
275       diameterServerSessions = (*it)->getAttribute("diameterServerSessions", false /* no exception */);
276       balance = (*it)->getAttribute("balance", false /* no exception */); // (yes | no)
277       sessionBasedModelsClientSocketSelection = (*it)->getAttribute("sessionBasedModelsClientSocketSelection", false /* no exception */); // (SessionIdHighPart | SessionIdOptionalPart | RoundRobin)
278       retries = (*it)->getAttribute("retries", false /* no exception */);
279       log = (*it)->getAttribute("log", false /* no exception */);
280       splitLog = (*it)->getAttribute("splitLog", false /* no exception */); // (yes | no)
281       detailedLog = (*it)->getAttribute("detailedLog", false /* no exception */); // (yes | no)
282       dumpLog = (*it)->getAttribute("dumpLog", false /* no exception */); // (yes | no)
283       burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no)
284
285       // Basic checkings:
286       origin_hosts_it nodeIt = a_originHosts.find(originHost->getValue());
287       if (nodeIt != a_originHosts.end()) {
288         std::string msg = "Already registered such Origin-Host: "; msg += originHost->getValue();
289         throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
290       }
291
292       unsigned int applicationId = appId->getIntegerValue();
293       if (!stackEngine.getDictionary(applicationId)) {
294         std::string msg = "Cannot found a registered stack id with the value of applicationId provided: "; msg += appId->getValue();
295         throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
296       }
297
298       // Engine time measures checking & assignment:
299       anna::Millisecond allowedInactivityTimeMs(90000);
300       anna::Millisecond tcpConnectDelayMs(200);
301       anna::Millisecond answersTimeoutMs(10000);
302       anna::Millisecond ceaTimeoutMs(10000);
303       anna::Millisecond watchdogPeriodMs(30000);
304
305       if (allowedInactivityTime) allowedInactivityTimeMs = checkTimeMeasure("allowedInactivityTime", allowedInactivityTime->getValue());
306       if (tcpConnectDelay)       tcpConnectDelayMs =       checkTimeMeasure("tcpConnectDelay",       tcpConnectDelay->getValue());
307       if (answersTimeout)        answersTimeoutMs =        checkTimeMeasure("answersTimeout",        answersTimeout->getValue());
308       if (ceaTimeout)            ceaTimeoutMs =            checkTimeMeasure("ceaTimeout",            ceaTimeout->getValue());
309       if (watchdogPeriod)        watchdogPeriodMs =        checkTimeMeasure("watchdogPeriod",        watchdogPeriod->getValue());
310
311       // Checking command line parameters
312       std::string sessionBasedModelsType;
313       if(sessionBasedModelsClientSocketSelection) {
314         sessionBasedModelsType = sessionBasedModelsClientSocketSelection->getValue();
315         if((sessionBasedModelsType != "SessionIdHighPart") && (sessionBasedModelsType != "SessionIdOptionalPart") && (sessionBasedModelsType != "RoundRobin")) {
316           throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
317         }
318       }
319
320       int retransmissions = retries ? retries->getIntegerValue() : 0;
321       if(retransmissions < 0) {
322         throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION);
323       }
324
325       // Create new Node instance /////////////////////////////////////////////////////////////////
326       a_workingNode = new OriginHost(originHost->getValue(), applicationId, bpd);
327       MyDiameterEngine *commEngine = a_workingNode->getMyDiameterEngine();
328       /////////////////////////////////////////////////////////////////////////////////////////////
329
330       // Assignments:
331       commEngine->setMaxConnectionDelay(tcpConnectDelayMs);
332       commEngine->setWatchdogPeriod(watchdogPeriodMs);
333
334       // Realm information:
335       commEngine->setOriginHost(originHost->getValue());
336       if (originRealm) commEngine->setOriginRealm(originRealm->getValue());
337
338       // Diameter entity:
339       if(entity) {
340         int sessions = entityServerSessions ? entityServerSessions->getIntegerValue() : 1;
341
342         if(sessions > 0) {
343           // Number of sessions:
344           commEngine->setNumberOfClientSessionsPerServer(sessions);
345
346           // Client CER and DWR
347           std::string cerPathfile = cer ? cer->getValue() : "";
348           std::string dwrPathfile = dwr ? dwr->getValue() : "";
349           commEngine->setClientCERandDWR(cerPathfile, dwrPathfile);
350
351           // Register one entity for this engine:
352           a_workingNode->createEntity(entity->getValue(), ceaTimeoutMs, answersTimeoutMs);
353           a_workingNode->setRequestRetransmissions(retransmissions);
354           a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsType);
355           a_workingNode->getEntity()->setBalance(balance ? (balance->getValue() == "yes") : false); // for sendings
356           if (eventOperation) a_workingNode->getEntity()->bind();
357         }
358       }
359
360       // Diameter Server:
361       if(diameterServer) {
362         int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1;
363         a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs);
364       }
365
366       // Logs:
367       if (!allLogsDisabled) {
368         std::string host = commEngine->getOriginHost();
369         std::string s_log = host + ".launcher.log"; if (log) s_log = log->getValue();
370         bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false);
371         bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false);
372         bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false);
373         std::string s_burstLog = host + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue();
374         a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog);
375       }
376
377
378       // Lazy initialization for comm engine:
379       if (eventOperation) commEngine->lazyInitialize();
380
381       // Node and Codec Engine registration ///////////////////////////////////////////////////////
382       a_originHosts[originHost->getValue()] = a_workingNode;
383       /////////////////////////////////////////////////////////////////////////////////////////////
384     }
385   }
386
387   if (!uniqueOriginHost())
388     a_workingNode = NULL; // by default, mode auto
389
390   // Diameter comm engines which are loaded after application start (via management operation 'services') are not really started,
391   //  but this don't care because application startComponents() -> initialize() -> do_initialize() -> do nothing.
392   // And when stopped, running state is not checked and it will be stopped anyway.
393 }
394
395
396 void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation) throw(anna::RuntimeException) {
397
398   if (xmlPathFile == "null" || xmlPathFile == "") {
399     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));
400     return;
401   }
402
403   LOGDEBUG(
404       std::string trace = "Loading ADML services file '";
405   trace += xmlPathFile;
406   trace += "'";
407   anna::Logger::debug(trace, ANNA_FILE_LOCATION);
408   );
409   anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
410   anna::xml::DTDMemory xmlDTD;
411   const anna::xml::Node *rootNode;
412   xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error
413   xmlDTD.initialize(ServicesDTD);
414   try {
415     rootNode = xmlDocument.parse(xmlDTD); // Parsing: fail here if xml violates dtd
416   }
417   catch (anna::RuntimeException &ex) {
418     LOGWARNING(
419         std::string msg = "Services DTD schema:\n\n";
420     msg += ServicesDTD;
421     anna::Logger::warning(msg, ANNA_FILE_LOCATION);
422     );
423     throw ex;
424   }
425
426   LOGDEBUG(
427       std::string trace = "Loaded XML file (";
428   trace += xmlPathFile;
429   trace += "):\n";
430   trace += anna::xml::Compiler().apply(rootNode);
431   anna::Logger::debug(trace, ANNA_FILE_LOCATION);
432   );
433   servicesFromXML(rootNode, eventOperation);
434 }
435
436
437 anna::Millisecond Launcher::checkTimeMeasure(const std::string &parameter, const std::string &value) throw(anna::RuntimeException) {
438
439   if(anna::functions::isLike("^[0-9]+$", value)) {  // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$
440     int msecs;
441     std::istringstream ( value ) >> msecs;
442
443     if(msecs > a_timeEngine->getMaxTimeout()) { // 600000 ms
444       std::string msg = "Configuration value for '";
445       msg += parameter;
446       msg += "' ("; msg += value; msg += " msecs) is greater than allowed max timeout for timming engine: ";
447       msg += anna::functions::asString(a_timeEngine->getMaxTimeout());
448       throw RuntimeException(msg, ANNA_FILE_LOCATION);
449     }
450
451     if(msecs > 300000) {
452       std::string msg = "Configuration value for '";
453       msg += parameter;
454       msg += "' ("; msg += value; msg += " msecs) is perhaps very big (over 5 minutes).";
455       LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
456     }
457
458     if(msecs <= a_timeEngine->getResolution()) {
459       std::string msg = "Configuration value for '";
460       msg += parameter;
461       msg += "' ("; msg += value; msg += " msecs) as any other time measure, must be greater than timming engine resolution: ";
462       msg += anna::functions::asString(a_timeEngine->getResolution());
463       throw RuntimeException(msg, ANNA_FILE_LOCATION);
464     }
465
466     return (anna::Millisecond)msecs; // ok
467   }
468
469   // Non-integer exception:
470   std::string msg = "Configuration error for '";
471   msg += parameter;
472   msg += "' = '";
473   msg += value;
474   msg += "': must be a non-negative integer number";
475   throw RuntimeException(msg, ANNA_FILE_LOCATION);
476 }
477
478 bool Launcher::setWorkingNode(const std::string &name) throw() {
479   bool result = false;
480
481   origin_hosts_it nodeIt = a_originHosts.find(name);
482   if (nodeIt == a_originHosts.end()) {
483     LOGWARNING(
484         std::string msg = "Unknown node with name '"; msg += name; msg += "'. Ignoring ...";
485     anna::Logger::warning(msg, ANNA_FILE_LOCATION);
486     );
487   }
488   else {
489     a_workingNode = const_cast<OriginHost*>(nodeIt->second);
490     result = true;
491   }
492
493   return result;
494 }
495
496 OriginHost *Launcher::getOriginHost(const std::string &oh) const throw(anna::RuntimeException) {
497   origin_hosts_it it = a_originHosts.find(oh);
498   if (it != a_originHosts.end()) return it->second;
499   throw anna::RuntimeException(anna::functions::asString("There is no origin host registered as '%s' (set Origin-Host avp correctly or force a specific host with 'node' operation)", oh.c_str()), ANNA_FILE_LOCATION);
500 }
501
502 OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
503   std::string originHost = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->getValue();
504   return (getOriginHost(originHost));
505 }
506
507 void Launcher::updateOperatedOriginHostWithMessage(const anna::diameter::codec::Message &message) throw(anna::RuntimeException) {
508   if (!a_operatedHost) // priority for working node by mean 'node' operation
509     a_operatedHost = getOriginHost(message);
510 }
511
512 OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
513   if(!a_operatedHost)
514     throw anna::RuntimeException("Node not identified (try to force a specific Origin-Host with 'node' operation)", ANNA_FILE_LOCATION);
515
516   return a_operatedHost;
517 }
518
519 MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) {
520   MyDiameterEntity *result = getOperatedHost()->getEntity();
521   if (!result)
522     throw anna::RuntimeException("No entity configured for the operated node", ANNA_FILE_LOCATION);
523   return result;
524 }
525
526 MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) {
527   MyLocalServer *result = getOperatedHost()->getDiameterServer();
528   if (!result)
529     throw anna::RuntimeException("No local server configured for the operated node", ANNA_FILE_LOCATION);
530   return result;
531 }
532
533 MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) {
534   return getOperatedHost()->getMyDiameterEngine(); // never will be NULL
535 }
536
537 void Launcher::initialize()
538 throw(anna::RuntimeException) {
539   anna::comm::Application::initialize();
540   CommandLine& cl(anna::CommandLine::instantiate());
541   anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single);
542   a_communicator = new MyCommunicator(workMode);
543   a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, a_admlMinResolution);
544   TestManager::instantiate().setTimerController(a_timeEngine);
545
546   // Counters record procedure:
547   const char *varname = "cntRecordPeriod";
548   anna::Millisecond cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000;
549   if(cntRecordPeriod != 0) {
550     a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock
551     std::string cntDir = ".";
552     if(cl.exists("cntDir")) cntDir = cl.getValue("cntDir");
553     a_counterRecorder = new MyCounterRecorder(cntDir + anna::functions::asString("/Counters.Pid%d", (int)getPid()));
554   }
555
556   // Testing framework:
557   std::string tmDir = ".";
558   if(cl.exists("tmDir")) tmDir = cl.getValue("tmDir");
559   TestManager::instantiate().setReportsDirectory(tmDir);
560
561   // Tracing:
562   if(cl.exists("trace"))
563     anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace")));
564
565   // Load launcher services:
566   loadServices(cl.getValue("services")); // before run (have components to be created)
567 }
568
569 void Launcher::run()
570 throw(anna::RuntimeException) {
571   LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION));
572   CommandLine& cl(anna::CommandLine::instantiate());
573   anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
574
575   // Start time:
576   a_start_time.setNow();
577
578   // Initial working directory:
579   char cwd[1024];
580   if (getcwd(cwd, sizeof(cwd)) == NULL)
581     throw anna::RuntimeException("Cannot retrieve initial working directory !!", ANNA_FILE_LOCATION);
582   a_initialWorkingDirectory = cwd;
583
584   // Statistics:
585   anna::statistics::Engine::instantiate().enable();
586
587   LOGINFORMATION(
588       // Help on startup traces:
589       anna::Logger::information(help(), ANNA_FILE_LOCATION);
590   // Test messages dtd:
591   std::string msg = "\n                     ------------- TESTMESSAGES DTD -------------\n";
592   msg += anna::diameter::codec::MessageDTD;
593   anna::Logger::information(msg, ANNA_FILE_LOCATION);
594   );
595
596   // HTTP Server:
597   if(cl.exists("httpServer")) {
598     anna::comm::Network& network = anna::comm::Network::instantiate();
599     std::string address;
600     int port;
601     anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("httpServer"), address, port);
602     //const anna::comm::Device* device = network.find(Device::asAddress(address)); // here provide IP
603     const anna::comm::Device* device = *((network.resolve(address)->device_begin())); // trick to solve
604     a_httpServerSocket = new anna::comm::ServerSocket(anna::comm::INetAddress(device, port), cl.exists("httpServerShared") /* shared bind */, &anna::http::Transport::getFactory());
605   }
606
607   ///////////////////////////////
608   // Diameter library COUNTERS //
609   ///////////////////////////////
610   anna::diameter::comm::OamModule & oamDiameterComm = anna::diameter::comm::OamModule::instantiate();
611   oamDiameterComm.initializeCounterScope(1);  // 1000 - 1999
612   oamDiameterComm.enableCounters();
613   oamDiameterComm.enableAlarms();
614   anna::diameter::codec::OamModule & oamDiameterCodec = anna::diameter::codec::OamModule::instantiate();
615   oamDiameterCodec.initializeCounterScope(2);  // 2000 - 2999
616   oamDiameterCodec.enableCounters();
617   oamDiameterCodec.enableAlarms();
618   /////////////////
619   // COMM MODULE //
620   /////////////////
621   /* Main events */
622   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceived, "" /* get defaults for enum type*/, 0 /*1000*/);
623   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceived,                 "", 1 /*1001*/);
624   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnClientSession, "", 2 /*1002*/);
625   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSession,  "", 3 /*1003*/);
626   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnServerSession, "", 4 /* etc. */);
627   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSession,  "", 5);
628   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOK,                  "", 6);
629   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentNOK,                 "", 7);
630   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOK,                   "", 8);
631   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentNOK,                  "", 9);
632   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionOK,   "", 10);
633   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionNOK,  "", 11);
634   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionOK,    "", 12);
635   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionNOK,   "", 13);
636   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionOK,   "", 14);
637   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionNOK,  "", 15);
638   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionOK,    "", 16);
639   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionNOK,   "", 17);
640   /* Diameter Base (capabilities exchange & keep alive) */
641   // as client
642   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentOK,   "", 18);
643   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentNOK,  "", 19);
644   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEAReceived, "", 20);
645   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentOK,   "", 21);
646   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentNOK,  "", 22);
647   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWAReceived, "", 23);
648   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentOK,   "", 24);
649   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentNOK,  "", 25);
650   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPAReceived, "", 26);
651   // as server
652   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERReceived, "", 27);
653   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentOK,   "", 28);
654   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentNOK,  "", 29);
655   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRReceived, "", 30);
656   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentOK,   "", 31);
657   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentNOK,  "", 32);
658   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRReceived, "", 33);
659   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentOK,   "", 34);
660   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentNOK,  "", 35);
661   /* server socket operations (enable/disable listening port for any local server) */
662   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsOpened, "", 36);
663   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsClosed, "", 37);
664   /* Connectivity */
665   // clients
666   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverOverEntity,                  "", 38);
667   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverClientSession,          "", 39);
668   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverClientSession,     "", 40);
669   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverServer,                 "", 41);
670   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverServer,            "", 42);
671   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEntity,                 "", 43);
672   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEntity,            "", 44);
673   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForEntities,      "", 45);
674   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForEntities, "", 46);
675   // servers
676   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverToClient,                                    "", 47);
677   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostConnectionForServerSession,                             "", 48);
678   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnbindConnectionForServerSessionDueToInactivityTimeAnomaly, "", 49);
679   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CreatedConnectionForServerSession,                          "", 50);
680   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverLocalServer,                            "", 51);
681   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverLocalServer,                       "", 52);
682   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForLocalServers,                  "", 53);
683   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForLocalServers,             "", 54);
684   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentExpired,  "", 55);
685   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionExpired,  "", 56);
686   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionExpired,  "", 57);
687   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmitted,  "", 58);
688   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnClientSession,  "", 59);
689   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnServerSession,  "", 60);
690   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown,  "", 61);
691   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown,  "", 62);
692   oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown,  "", 63);
693   //////////////////
694   // CODEC MODULE //
695   //////////////////
696   /* Avp decoding */
697   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength,                          "", 0 /*2000*/);
698   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived, "", 1 /*2001*/);
699   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncorrectLength,                                               "", 2 /*2002*/);
700   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__DataPartInconsistence,                                         "", 3 /*2003*/);
701   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit,                                    "", 4 /*2004*/);
702   /* Message decoding */
703   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength, "", 5 /*2005*/);
704   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength,       "", 6 /*2006*/);
705   /* Avp validation */
706   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction, "", 10 /*2010*/);
707   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules,      "", 11 /*2011*/);
708   /* Message validation */
709   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate, "", 12 /*2012*/);
710   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags,     "", 13 /*2013*/);
711   /* Level validation */
712   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__MissingFixedRule,                                       "", 14 /*2014*/);
713   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinality,                               "", 15 /*2015*/);
714   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded,                 "", 16 /*2016*/);
715   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded,                 "", 17 /*2017*/);
716   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem, "", 18 /*2018*/);
717   oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified,      "", 19 /*2019*/);
718
719
720   /////////////////////////////////
721   // Counter recorder associated //
722   /////////////////////////////////
723   if(a_counterRecorderClock) {
724     oamDiameterComm.setCounterRecorder(a_counterRecorder);
725     oamDiameterCodec.setCounterRecorder(a_counterRecorder);
726     anna::diameter::comm::ApplicationMessageOamModule::instantiate().setCounterRecorder(a_counterRecorder);
727     a_timeEngine->activate(a_counterRecorderClock); // start clock
728   }
729
730   // Log statistics concepts
731   if(cl.exists("logStatisticSamples")) {
732     std::string list = cl.getValue("logStatisticSamples");
733     anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
734
735     if(list == "all") {
736       if(statEngine.enableSampleLog(/* -1: all concepts */))
737         LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
738     } else {
739       anna::Tokenizer lst;
740       lst.apply(cl.getValue("logStatisticSamples"), ",");
741
742       if(lst.size() >= 1) {
743         anna::Tokenizer::const_iterator tok_min(lst.begin());
744         anna::Tokenizer::const_iterator tok_max(lst.end());
745         anna::Tokenizer::const_iterator tok_iter;
746         int conceptId;
747
748         for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
749           conceptId = atoi(anna::Tokenizer::data(tok_iter));
750
751           if(statEngine.enableSampleLog(conceptId))
752             LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
753         }
754       }
755     }
756   }
757
758
759   // Start client connections //////////////////////////////////////////////////////////////////////////////////
760   MyDiameterEntity *entity;
761   for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
762     entity = it->second->getEntity();
763     if (entity) entity->bind();
764   }
765
766   // Go into communicator poll
767   // Reconnection period (tcp reconnect retry time):
768   const char *varname = "reconnectionPeriod";
769   anna::Millisecond reconnectionPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)10000;
770
771   a_communicator->setRecoveryTime(reconnectionPeriod);
772   if(cl.exists("httpServer")) a_communicator->attach(a_httpServerSocket);  // HTTP
773   a_communicator->accept();
774 }
775
776
777 bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() {
778   // Get hex string
779   static char buffer[8192];
780   std::ifstream infile(pathfile.c_str(), std::ifstream::in);
781
782   if(infile.is_open()) {
783     infile >> buffer;
784     std::string hexString(buffer, strlen(buffer));
785     // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString':
786     hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end());
787     LOGDEBUG(
788         std::string msg = "Hex string (remove colons if exists): ";
789     msg += hexString;
790     anna::Logger::debug(msg, ANNA_FILE_LOCATION);
791     );
792     anna::functions::fromHexString(hexString, db);
793     // Close file
794     infile.close();
795     return true;
796   }
797
798   return false;
799 }
800
801 void Launcher::resetStatistics() throw() {
802   if (a_workingNode) {
803     a_workingNode->getMyDiameterEngine()->resetStatistics();
804   }
805   else {
806     for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
807       it->second->getMyDiameterEngine()->resetStatistics();
808     }
809   }
810 }
811
812 void Launcher::resetCounters() throw() {
813   anna::diameter::comm::OamModule::instantiate().resetCounters();
814   anna::diameter::comm::ApplicationMessageOamModule::instantiate().resetCounters();
815   anna::diameter::codec::OamModule::instantiate().resetCounters();
816 }
817
818 void Launcher::signalUSR2() throw(anna::RuntimeException) {
819
820   std::string inputFile = getSignalUSR2InputFile();
821   std::string outputFile = getSignalUSR2OutputFile();
822
823   LOGNOTICE(
824   std::string msg = "Captured signal SIGUSR2. Reading tasks at '";
825   msg += inputFile;
826   msg += "' (results will be written at '";
827   msg += outputFile;
828   msg += "')";
829   anna::Logger::notice(msg, ANNA_FILE_LOCATION);
830   );
831
832   // Operation:
833   std::string line;
834   std::string response_content;
835   std::ifstream in_file(inputFile);
836   std::ofstream out_file(outputFile);
837
838   if(!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION);
839   if(!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION);
840
841   while(getline(in_file, line)) {
842
843     // Ignore comments and blank lines:
844     if (line[0] == '#')  continue;
845     if (std::string::npos == line.find_first_not_of(" \t")) continue;
846
847     LOGDEBUG(
848         std::string msg = "Processing line: ";
849     msg += line;
850     anna::Logger::debug(msg, ANNA_FILE_LOCATION);
851     );
852
853     try {
854       eventOperation(line, response_content);
855     } catch(RuntimeException &ex) {
856       ex.trace();
857     }
858
859     out_file << response_content << "\n";
860   }
861
862   in_file.close();
863   out_file << "EOF\n";
864   out_file.close();
865 }
866
867 std::string Launcher::help() const throw() {
868   std::string result = "\n";
869   result += "\n                     ------------- HELP -------------\n";
870   result += "\n";
871   result += "\nOVERVIEW";
872   result += "\n--------";
873   result += "\n";
874   result += "\nThe ADML (ANNA Diameter MultiHost Launcher) process is a multi-host node with client and server";
875   result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server (i.e. to";
876   result += "\n simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.), and balancer";
877   result += "\n systems to provide failover to external round-robin launchers. Also, auxiliary encoder/decoder/loader";
878   result += "\n function could be deployed to reinterpret certain external flow and send it to another process.";
879   result += "\n ";
880   result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections";
881   result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard";
882   result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA";
883   result += "\n generation, expiration control and many more features.";
884   result += "\n";
885   result += "\nThe ADML process can easily configure a many origin-host nodes as needed, which will have own endpoints.";
886   result += "\nYou should avoid loop configurations (client and server for that client) because automatic forwarding,";
887   result += "\n is implemented and this would get in a never ending cycle when a request is sent.";
888   result += "\n";
889   result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually";
890   result += "\n 'debug' or 'warning'. See ANNA documentation for more details.";
891   result += "\n";
892   result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:";
893   result += "\n   kill -10 <pid>";
894   result += "\n    or";
895   result += "\n   kill -s SIGUSR1 <pid>";
896   result += "\n    and then";
897   result += "\n   vi /var/tmp/anna.context.<pid>";
898   result += "\n";
899   result += "\nA complete xml report will show all the context information (counters, alarms, statistics,";
900   result += "\n handlers, diameter stacks, etc.), and a powerful log module could dump all the events";
901   result += "\n processed and flow information. Statistics could be analized at context dump and optionally";
902   result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the";
903   result += "\n measurements.";
904   result += "\n";
905   result += "\nAlso SIGUSR2 is handled for management purposes. We will talk later about this.";
906   result += "\n";
907   result += "\n";
908   result += "\nCOMMAND LINE";
909   result += "\n------------";
910   result += "\n";
911   result += "\nStart the launcher process without arguments in order to see all the startup configuration";
912   result += "\n posibilities, many of which could be modified on the air through the management interface";
913   result += "\n (we will talk later about this great feature). There is only one mandatory parameter which";
914   result += "\n is the services definition: --services <services xml file>. You must follow the dtd schema";
915   result += "\n to build a valid services xml file. Some basic examples are:";
916   result += "\n";
917   result += "\nClient configuration:";
918   result += "\n";
919   result += "\n<services>";
920   result += "\n  <!-- Stacks -->";
921   result += "\n  <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
922   result += "\n";
923   result += "\n  <!-- Nodes -->";
924   result += "\n  <node originHost=\"ADML-client\" applicationId=\"0\" entity=\"localhost:3868\"/>";
925   result += "\n</services>";
926   result += "\n";
927   result += "\nServer configuration:";
928   result += "\n";
929   result += "\n<services>";
930   result += "\n  <!-- Stacks -->";
931   result += "\n  <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
932   result += "\n";
933   result += "\n  <!-- Nodes -->";
934   result += "\n  <node originHost=\"ADML-server\" applicationId=\"0\" diameterServer=\"localhost:3868\"/>";
935   result += "\n</services>";
936   result += "\n";
937   result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably";
938   result += "\n will need to program the answers to be replied through the operations interface. To balance the";
939   result += "\n traffic at your client side you shall use '--balance' and '--sessionBasedModelsClientSocketSelection'";
940   result += "\n arguments in order to define the balancing behaviour. To make hybrid setups you only must mix the nodes:";
941   result += "\n";
942   result += "\nClient and server configuration:";
943   result += "\n";
944   result += "\n<services>";
945   result += "\n  <!-- Stacks -->";
946   result += "\n  <stack id=\"16777236\" dictionary=\"dictionary_Rx.xml\"/>";
947   result += "\n  <stack id=\"16777238\" dictionary=\"dictionary_Gx.xml\"/>";
948   result += "\n  <stack id=\"0\" dictionary=\"dictionary_base.xml\"/>";
949   result += "\n";
950   result += "\n  <!-- Nodes -->";
951   result += "\n  <node originHost=\"ADML-Rx-client\" applicationId=\"16777236\" entity=\"localhost:3868\" cer=\"cer_Rx.xml\"/>";
952   result += "\n  <node originHost=\"ADML-Gx-client\" applicationId=\"16777238\" entity=\"localhost:3868\" cer=\"cer_Gx.xml\"/>";
953   result += "\n</services>";
954   result += "\n";
955   result += "\n";
956   result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own";
957   result += "\n as shown in the hybrid former example. Note that the base protocol stack must be registered because";
958   result += "\n the configuration corresponds to a multistack process which change the stack using the application-id";
959   result += "\n processed (0 in the case of base protocol messages: CER, CEA, DWR, DWA, DPR, DPA).";
960   result += "\n";
961   result += "\nDYNAMIC OPERATIONS";
962   result += "\n------------------";
963   result += "\n";
964   result += "\nADML supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh.";
965   result += "\nAn operation is specified by mean a string containing the operation name and needed arguments";
966   result += "\n separated by pipes. These are the available commands:";
967   result += "\n";
968   result += "\n--------------------------------------------------------------------------------------- General purpose";
969   result += "\n";
970   result += "\nhelp                                 This help.";
971   result += "\n";
972   result += "\n--------------------------------------------------------------------------------------- Node management";
973   result += "\n";
974   result += "\nnode[|<name>]                         Selects a context working node by mean a registered name (origin-host).";
975   result += "\n                                      All the subsequent operations will be forced to work with";
976   result += "\n                                      this node, which makes possible some rare scenarios like";
977   result += "\n                                      sending unexpected messages on remote peers. This is also";
978   result += "\n                                      useful for some operations in order to restrict the scope";
979   result += "\n                                      of action (statistics, communication visibility, etc.).";
980   result += "\n                                      Empty parameter will show the current configuration.";
981   result += "\n";
982   result += "\nnode_auto                             Returns to the default behaviour (smart node selection).";
983   result += "\n                                      Depending on the operation, this could imply a global";
984   result += "\n                                      action scope, affecting to all the registered hosts.";
985   result += "\n                                      This should be the normal configuration. Take into";
986   result += "\n                                      account that if you fix the working node, this could";
987   result += "\n                                      affect to things like test programming: communication";
988   result += "\n                                      resources will override those which would be inferred";
989   result += "\n                                      from programmed messages Origin-Host avps.";
990   result += "\n";
991   result += "\n------------------------------------------------------------------------------------ Parsing operations";
992   result += "\n";
993   result += "\ncode|<source_file>|<target_file>     Encodes source file (pathfile) into target file (pathfile).";
994   result += "\ndecode|<source_file>|<target_file>   Decodes source file (pathfile) into target file (pathfile).";
995   result += "\nloadxml|<source_file>                Reinterpret xml source file (pathfile).";
996   result += "\n";
997   result += "\n------------------------------------------------------------------------------------------- Hot changes";
998   result += "\n";
999   result += "\nservices[|source file]               Adds and starts the services specified in the xml file provided.";
1000   result += "\n                                      (if missing, the file 'services.xml' will be used). This is used";
1001   result += "\n                                      to load new nodes once the ADML is started, regardless if command";
1002   result += "\n                                      line '--services' parameter was used or not. Those services which";
1003   result += "\n                                      are not correctly loaded will be ignored to keep the process alive.";
1004   result += "\n                                     If you need to load services as deltas, you must firstly load the";
1005   result += "\n                                      diameter base dictionary with stack id 0, because all the nodes";
1006   result += "\n                                      will use this dictionary to encode/decode base protocol messages";
1007   result += "\n                                      managed by the communication engine.";
1008   result += "\n";
1009   result += "\ndiameterServerSessions|<integer>     Updates the maximum number of accepted connections to diameter";
1010   result += "\n                                      server socket.";
1011   result += "\ncontext[|target file]                Application context could also be written by mean this operation,";
1012   result += "\n                                      and not only through SIGUSR1. If optional path file is missing,";
1013   result += "\n                                      default '/var/tmp/anna.context.<pid>' will be used.";
1014   result += "\ncollect                              Reset statistics and counters to start a new test stage of";
1015   result += "\n                                      performance measurement. Context data can be written at";
1016   result += "\n                                      '/var/tmp/anna.context.<pid>' by mean 'kill -10 <pid>'.";
1017   result += "\n                                      or sending operation 'context|[target file]'.";
1018   result += "\n                                     This operation applies over all the registered host nodes";
1019   result += "\n                                      except if one specific working node has been set.";
1020   result += "\nforceCountersRecord                  Forces dump to file the current counters of the process.";
1021   result += "\nchange-dir[|directory]               Changes the execution point which could be fine to ease some";
1022   result += "\n                                     file system interaction tasks. Be care about some requirements";
1023   result += "\n                                     (for example if you have a user defined counters directory as";
1024   result += "\n                                     relative path this must exists from the new execution directory).";
1025   result += "\n                                     If nothing provided, initial working directory will be restored.";
1026   result += "\nshow-oam                             Dumps current counters of the process. This is also done at";
1027   result += "\n                                      process context dump.";
1028   result += "\nshow-stats                           Dumps statistics of the process. This is also done at process";
1029   result += "\n                                      context dump.";
1030   result += "\n";
1031   result += "\n<visibility action>[|<address>:<port>][|socket id]";
1032   result += "\n";
1033   result += "\n       Actions: hide, show (update state) and hidden, shown (query state).";
1034   result += "\n       Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A).";
1035   result += "\n       If missing server (first parameter) all applications sockets will be affected.";
1036   result += "\n       If missing socket (second parameter) for specific server, all its sockets will be affected.";
1037   result += "\n";
1038   result += "\n       All application client sessions are shown on startup, but standard delivery only use primary";
1039   result += "\n        server ones except if fails. Balance configuration use all the allowed sockets. You could also";
1040   result += "\n        use command line 'sessionBasedModelsClientSocketSelection' to force traffic flow over certain";
1041   result += "\n        client sessions, but for this, hide/show feature seems easier.";
1042   result += "\n";
1043   result += "\n--------------------------------------------------------------------------------------- Flow operations";
1044   result += "\n";
1045   result += "\nsendxml2e|<source_file>    Sends xml source file (pathfile) through configured entity.";
1046   result += "\nsendxml2c|<source_file>    Sends xml source file (pathfile) to client.";
1047   result += "\nanswerxml2e[|source_file]  Answer xml source file (pathfile) for incoming request with same code from entity.";
1048   result += "\n                           The answer is stored in a FIFO queue for a specific message code, then there are";
1049   result += "\n                           as many queues as different message codes have been programmed.";
1050   result += "\nanswerxml2c[|source_file]  Answer xml source file (pathfile) for incoming request with same code from client.";
1051   result += "\n                           The answer is stored in a FIFO queue for a specific message code, then there are";
1052   result += "\n                           as many queues as different message codes have been programmed.";
1053   result += "\nanswerxml<2e/2c>           List programmed answers (to entity/client) if no parameter provided.";
1054   result += "\nanswerxml<2e/2c>|dump      Write programmed answers (to entity/client) to file 'programmed_answer.<message code>.<sequence>',";
1055   result += "\n                           where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers.";
1056   result += "\nanswerxml<2e/2c>|clear     Clear programmed answers (to entity/client).";
1057   result += "\nanswerxml<2e/2c>|exhaust   Disable the corresponding queue rotation, which is the default behaviour.";
1058   result += "\nanswerxml<2e/2c>|rotate    Enable the corresponding queue rotation, useful in performance tests.";
1059   result += "\n                           Rotation consists in add again to the queue, each element retrieved for answering.";
1060   result += "\n";
1061   result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test";
1062   result += "\nspecial scenarios (protocol errors):";
1063   result += "\n";
1064   result += "\nsendhex2e|<source_file>    Sends hex source file (pathfile) through configured entity.";
1065   result += "\nsendhex2c|<source_file>    Sends hex source file (pathfile) to client.";
1066   result += "\n";
1067   result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also";
1068   result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
1069   result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created.";
1070   result += "\n";
1071   result += "\nIf a request is received, answer map (built with 'answerxml<2e/2c>' operations) will be";
1072   result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,";
1073   result += "\n or answer message was received, the message is forwarded to the other side (entity or client),";
1074   result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when";
1075   result += "\n diameter server socket is configured, answer to entity have sense when entity does.";
1076   result += "\n";
1077   result += "\nIn the most complete situation (process with both client and server side) there are internally";
1078   result += "\n two maps with N FIFO queues, one for each different message code within programmed answers.";
1079   result += "\nOne map is for answers towards the client, and the other is to react entity requests. Then in";
1080   result += "\n each one we could program different answers corresponding to different request codes received.";
1081   result += "\n";
1082   result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored";
1083   result += "\n    to the peer which sent the request. If user wants to test a specific answer without changing it,";
1084   result += "\n    use sendxml<2e/2c>/sendhex<2e/2c> operations better than programming.";
1085   result += "\n";
1086   result += "\nBalance ('--balance' command line parameter) could be used to forward server socket receptions through";
1087   result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should";
1088   result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an";
1089   result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc.";
1090   result += "\n";
1091   result += "\n--------------------------------------------------------------------------- Processing types (log tags)";
1092   result += "\n";
1093   result += "\nUsed as log file extensions (when '--splitLog' is provided on command line) and context preffixes on log";
1094   result += "\n details when unique log file is dumped:";
1095   result += "\n";
1096   result += "\n   [sent2e/send2eError]   Send to entity (success/error)";
1097   result += "\n   [sent2c/send2cError]   Send to client (success/error)";
1098   result += "\n   [fwd2e/fwd2eError]     Forward to entity a reception from client (success/error)";
1099   result += "\n   [fwd2c/fwd2cError]     Forward to client a reception from entity (success/error)";
1100   result += "\n   [recvfc]               Reception from client";
1101   result += "\n   [recvfe]               Reception from entity";
1102   result += "\n   [req2c-expired]        A request sent to client has been expired";
1103   result += "\n   [req2e-expired]        A request sent to entity has been expired";
1104   result += "\n   [recvfc-ans-unknown]   Reception from client of an unknown answer (probably former [req2c-expired]";
1105   result += "\n                           has been logged)";
1106   result += "\n   [recvfe-ans-unknown]   Reception from entity of an unknown answer (probably former [req2e-expired]";
1107   result += "\n                           has been logged)";
1108   result += "\n   [retry]                Request retransmission";
1109   result += "\n";
1110   result += "\n------------------------------------------------------------------------------------------- Burst tests";
1111   result += "\n";
1112   result += "\nIn order to simplify user experience, burst category operations are only allowed in single host node";
1113   result += "\n configuration. Indeed, you could send messages with unmatched Origin-Host, and no warning is shown.";
1114   result += "\nAll the operations are performed through the unique host: if you need to use more interfaces, you may";
1115   result += "\n launch different ADML instances. Is nonsense to allow burst in a multi-host configured ADML, because";
1116   result += "\n this feature is not able to coordinate the messages.";
1117   result += "\n";
1118   result += "\nburst|<action>[|parameter]     Used for performance testing, we first program diameter requests";
1119   result += "\n                                messages in order to launch them from client side to the configured";
1120   result += "\n                                diameter entity. We could start the burst with an initial load";
1121   result += "\n                                (non-asynchronous sending), after this, a new request will be sent";
1122   result += "\n                                per answer received or expired context. There are 10 actions: clear,";
1123   result += "\n                                load, start, push, pop, stop, repeat, send, goto and look.";
1124   result += "\n";
1125   result += "\n   burst|clear                 Clears all loaded burst messages.";
1126   result += "\n   burst|load|<source_file>    Loads the next diameter message into launcher burst.";
1127   result += "\n   burst|start|<initial load>  Starts (or restarts if already in progress) the message sending with";
1128   result += "\n                                a certain initial load.";
1129   result += "\n   burst|push|<load amount>    Sends specific non-aynchronous load.";
1130   result += "\n   burst|pop|<release amount>  Skip send burst messages in order to reduce over-the-air requests.";
1131   result += "\n                               Popping all OTA requests implies burst stop because no more answer";
1132   result += "\n                                will arrive to the process. Burst output file (--burstLog command";
1133   result += "\n                                line parameter) shows popped messages with crosses (x). Each cross";
1134   result += "\n                                represents one received answer for which no new request is sent.";
1135   result += "\n   burst|stop                  Stops the burst cycle. You can resume pushing 1 load amount.";
1136   result += "\n   burst|repeat[|[yes]|no]     Restarts the burst launch when finish. If initial load or push load";
1137   result += "\n                                amount is greater than burst list size, they will be limited when";
1138   result += "\n                                the list is processed except when repeat mode is enabled.";
1139   result += "\n   burst|send|<amount>         Sends messages from burst list. The main difference with start/push";
1140   result += "\n                                operations is that burst won't be awaken. Externally we could control";
1141   result += "\n                                sending time (no request will be sent for answers).";
1142   result += "\n   burst|goto|<order>          Updates current burst pointer position.";
1143   result += "\n   burst|look[|order]          Show programmed burst message for order provided, current when missing.";
1144   result += "\n";
1145   result += "\n-------------------------------------------------------------------------------------- Advanced testing";
1146   result += "\n";
1147   result += "\n                           Burst mode only allows single interface interaction. For multiple interface";
1148   result += "\n                            (origin-host) coordination, you could use the advanced test cases programming:";
1149   result += "\n";
1150   result += "\n";
1151   result += "\n   test|<id>|<command>[|parameters]";
1152   result += "\n";
1153   result += "\n                           Adds a new step to the test case with provided identifier. If provided identifier";
1154   result += "\n                            is not registered yet, a new test case will be created with that value and the";
1155   result += "\n                            step will be added as the first. For a specific 'id', the steps are stored in";
1156   result += "\n                            order as they are programmed. Check possible runtime exceptions when adding a";
1157   result += "\n                            new step because those which fail, will be ignored/skipped during test case";
1158   result += "\n                            programming giving an incomplete sequence invalid for the testing purpose.";
1159   result += "\n";
1160   result += "\n                           <id>: integer number, normally monotonically increased for each test case. Some external";
1161   result += "\n                                 script/procedure shall clone a test case template in order to build a collection";
1162   result += "\n                                 of independent and coherent test cases (normally same type) with different context";
1163   result += "\n                                 values (Session-Id, Subscriber-Id, etc.).";
1164   result += "\n";
1165   result += "\n                           <command>: commands to be executed for the test id provided. Each command programmed";
1166   result += "\n                                      constitutes a test case 'step', numbered from 1 to N.";
1167   result += "\n";
1168   result += "\n                              timeout|<msecs>            Sets an asynchronous timer to restrict the maximum timeout";
1169   result += "\n                                                          until last test step. Normally, this command is invoked";
1170   result += "\n                                                          in the first step, anyway it measures the time from the";
1171   result += "\n                                                          execution point whatever it is. The expiration will abort";
1172   result += "\n                                                          the test if still running. One or more timeouts could be";
1173   result += "\n                                                          programmed (not usual), but the more restrict will apply.";
1174   result += "\n                                                         It is highly recommended to program a initial timeout step,";
1175   result += "\n                                                          or the test case could be eternally in-progress.";
1176   result += "\n";
1177   result += "\n                              sendxml2e|<source_file>[|<step number>]";
1178   result += "\n                                                         Sends xml source file (pathfile) to entity (it would be a";
1179   result += "\n                                                          'forward' event if it came through local server endpoint).";
1180   result += "\n                                                         The step number should be provided for answers to indicate";
1181   result += "\n                                                          the 'wait for request' corresponding step. If you miss this";
1182   result += "\n                                                          reference, the sequence information (hop-by-hop, end-to-end)";
1183   result += "\n                                                          will be sent as they are in the answer xml message (realize";
1184   result += "\n                                                          the difficulty of predicting these information). Be sure to";
1185   result += "\n                                                          refer to a 'wait for request' step. Conditions like 'regexp'";
1186   result += "\n                                                          (as we will see later) are not verified.";
1187   result += "\n";
1188   result += "\n                              sendxml2c|<source_file>[|<step number>]";
1189   result += "\n                                                         Sends xml source file (pathfile) to client (it would be a";
1190   result += "\n                                                          'forward' event if it came through remote server endpoint).";
1191   result += "\n                                                         Same commented for 'sendxml2e' regarding the step number.";
1192   result += "\n";
1193   result += "\n                              delay|<msecs>              Blocking step until the time lapse expires. Useful to give ";
1194   result += "\n                                                          some cadence control and time schedule for a specific case.";
1195   result += "\n                                                         A value of 0 could be used as a dummy step.";
1196   result += "\n                              wait<fe/fc>|<condition>    Blocking step until condition is fulfilled. The message could";
1197   result += "\n                                                          received from entity (waitfe) or from client (waitfc).";
1198   result += "\n";
1199   result += "\n                              wait<fe/fc>-regexp|<regexp>";
1200   result += "\n                                                         Wait condition, from entity (waitfe-regexp) or client (waitfc-regexp)";
1201   result += "\n                                                          to match the serialized xml content for received messages. CPU cost";
1202   result += "\n                                                          is bigger than the former ones because the whole message must be";
1203   result += "\n                                                          decoded and converted to xml instead of doing a direct hexadecimal";
1204   result += "\n                                                          buffer search. The main advantage is the great flexibility to identify";
1205   result += "\n                                                          any content with a regular expression.";
1206   result += "\n";
1207   result += "\n                              sh-command|<script>        External execution for script/executable via shell through a dedicated";
1208   result += "\n                                                          thread, providing the command and parameters. You could use dynamic";
1209   result += "\n                                                          variables ##<tag> to have more flexibility:";
1210   result += "\n                                                             Test pool cycle id: "; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1211   result += "\n                                                             Test case id:       "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1212   result += "\n                                                             Test step id:       "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1213   result += "\n";
1214   result += "\n                                                         For example, your command could be something like this:";
1215   result += "\n                                                          insert_sql_"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID; result += ".sh -db dbname --verbose";
1216   result += "\n                                                             > /tmp/cycle-"; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1217   result += ".testcase-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1218   result += ".teststep-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1219   result += ".out";
1220   result += "\n                                                         Try to redirect stdout and stderr to avoid ADML output contamination";
1221   result += "\n                                                          with the possible outputs from the scripts. You could also put your";
1222   result += "\n                                                          job in background although sh-command will return 0-value immediately.";
1223   result += "\n";
1224   result += "\n                           <condition>: Optional parameters which must be fulfilled to continue through the next step.";
1225   result += "\n                                        Any received message over diameter interfaces will be evaluated against the";
1226   result += "\n                                         corresponding test case starting from the current step until the first one";
1227   result += "\n                                         whose condition is fulfilled. If no condition is fulfilled the event will be";
1228   result += "\n                                         classified as 'uncovered' (normally a test case bad configuration, or perhaps";
1229   result += "\n                                         a real unexpected message).";
1230
1231   // TODO(***)
1232   //  result += "\n                                        The way to identify the test case, is through registered Session-Id values for";
1233   //  result += "\n                                         programmed requests. But this depends on the type of node. Acting as clients,";
1234   //  result += "\n                                         requests received have Session-Id values which are already registered with";
1235   //  result += "\n                                         one test case, causing an error if not found. Acting as servers, requests are";
1236   //  result += "\n                                         received over a diameter local server from a client which are generating that";
1237   //  result += "\n                                         Session-Id values. Then we know nothing about such values. The procedure in";
1238   //  result += "\n                                         this case is find out a test case not-started containing a condition which";
1239   //  result += "\n                                         comply with the incoming message, and reactivates it.";
1240   // The other solution: register Session-Id values for answers send to client from a local diameter server.
1241
1242   result += "\n                                        How to answer: a wait condition for a request will store the incoming message";
1243   result += "\n                                         which fulfills that condition. This message is useful together with the peer";
1244   result += "\n                                         connection source in a further send step configured with the corresponding";
1245   result += "\n                                         response. You could also insert a delay between wait and send steps to be";
1246   result += "\n                                         more realistic (processing time simulation in a specific ADML host node).";
1247   result += "\n                                         Always, a response send step will get the needed information from the most";
1248   result += "\n                                         recent wait step finding in reverse order (note that some race conditions";
1249   result += "\n                                         could happen if your condition is not specific enough).";
1250
1251   result += "\n";
1252   result += "\n                                        Condition format:";
1253   result += "\n";
1254   result += "\n                                           [code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]";
1255   result += "\n";
1256   result += "\n                                             code: integer number";
1257   result += "\n                                             bitR: 1 (request), 0 (answer)";
1258   result += "\n                                             hopByHop: integer number or request send step reference: #<step number>";
1259   result += "\n";
1260   result += "\n                                                       Using the hash reference, you would indicate a specific wait condition";
1261   result += "\n                                                        for answers. The step number provided must correspond to any of the";
1262   result += "\n                                                        previous send commands (sendxml2e/sendxml2c) configured for a request.";
1263   result += "\n                                                       This 'hop-by-hop' variant eases the wait condition for answers in the";
1264   result += "\n                                                        safest way.";
1265   result += "\n";
1266   result += "\n                                             applicationId: integer number";
1267   result += "\n                                             sessionId: string";
1268   result += "\n                                             resultCode: integer number";
1269   result += "\n                                             msisdn: string";
1270   result += "\n                                             imsi: string";
1271   result += "\n                                             serviceContextId: string";
1272   result += "\n";
1273   result += "\n                                        Take into account these rules, useful in general:";
1274   result += "\n";
1275   result += "\n                                           - Be as much specific as possible defining conditions to avoid ambiguity sending";
1276   result += "\n                                             messages out of context due to race conditions. Although you could program several";
1277   result += "\n                                             times similar conditions, some risky practices will throw a warning trace (if you";
1278   result += "\n                                             repeat the same condition within the same test case).";
1279   result += "\n                                           - Adding a ResultCode and/or HopByHop to the condition are only valid waiting answers.";
1280   result += "\n                                           - Requests hop-by-hop values must be different for all the test case requests.";
1281   result += "\n                                             RFC says that a hop by hop must be unique for a specific connection, something that";
1282   result += "\n                                             could be difficult to manage if we have multiple available connections from client";
1283   result += "\n                                             side endpoint (entity or local server), even if we would have only one connection but";
1284   result += "\n                                             several host interfaces. It is enough to configure different hop-by-hop values within";
1285   result += "\n                                             each test case, because on reception, the Session-Id is used to identify that test case.";
1286   result += "\n";
1287   result += "\n";
1288   result += "\n";
1289   result += "\n";
1290   result += "\n                           Programming example:";
1291   result += "\n";
1292   result += "\n                              Basic Rx/Gx scenary: PCEF (Gx) - PCRF - AF (Rx)";
1293   result += "\n";
1294   result += "\n                              test|1|timeout|5000                  (step 1: whole time requirement is 5 seconds)";
1295   result += "\n                              test|1|sendxml2e|CCR-I.xml           (step 2: imagine this xml uses the Session-Id 'SGx')";
1296   result += "\n                              test|1|waitfe|272|0|||SGx|2001       (step 3: waits the CCA for the CCR-I with Result-Code = DIAMETER_SUCCESS)";
1297   result += "\n                              test|1|sendxml2e|AAR-flows.xml       (step 4: imagine this xml uses the Session-Id 'SRx')";
1298   result += "\n                              test|1|waitfe|265|0|||SRx|2001       (step 5: waits the AAA for the AAR-flows with Result-Code = DIAMETER_SUCCESS)";
1299   result += "\n                              test|1|waitfe|258|1|||SGx            (step 6: waits the RAR (install policies) from the PCRF server)";
1300   result += "\n                              test|1|sendxml2e|RAA-install.xml|6   (step 7: sends the response for the RAR)";
1301   result += "\n                              test|1|sendxml2e|CCR-T.xml           (step 8: termination of the Gx session, imagine this xml puts hop-by-hop 'H1')";
1302   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')";
1303   result += "\n                              test|1|waitfe|258|1|||SGx            (step 10: waits the RAR (remove policies) from the PCRF server)";
1304   result += "\n                              test|1|sendxml2e|RAA-remove.xml|10   (step 11: sends the response for the RAR)";
1305   result += "\n";
1306   result += "\n                              Notes: We added an additional condition in step 9: the hop-by-hop. When we program the corresponding";
1307   result += "\n                                      source request (CCR-T), we configured the value 'H1' for the hop-by-hop. This is an 'application";
1308   result += "\n                                      value' because the real hop-by-hop transported through the client connection is managed by the";
1309   result += "\n                                      diameter stack. But when returned, the transaction pool resolve the original value. This feature";
1310   result += "\n                                      is necessary to ease the implementation of certain diameter agents (proxies for example). In our";
1311   result += "\n                                      case, we could format the hop-by-hop values within the request templates with total freedom to";
1312   result += "\n                                      improve the programmed conditions.";
1313   result += "\n";
1314   result += "\n                                     In the case of 'waiting for requests' is not such easy. Indeed, steps 6 and 10 will write a warning";
1315   result += "\n                                      because they are the same condition. We know that we are not going to have any problem because";
1316   result += "\n                                      such events are blocking-protected regarding logic-dependent messages (CCR-T), and race condition";
1317   result += "\n                                      is absolutely strange in this case.";
1318   result += "\n";
1319   result += "\n                                     You could speed up the test case moving forward steps like 3 & 5, understood as non-strict requirements";
1320   result += "\n                                      to continue testing. Anyway, remember that test cases should be as real as possible, and that there";
1321   result += "\n                                      are many ways to increase the load rate as we will see in next section (test cases execution).";
1322   result += "\n";
1323   result += "\n                                     Other simplifications: the steps 3, 5 and 9 can be replaced by";
1324   result += "\n";
1325   result += "\n                                        test|1|waitfe||0|#2";
1326   result += "\n                                        test|1|waitfe||0|#4";
1327   result += "\n                                        test|1|waitfe||0|#8";
1328   result += "\n";
1329   result += "\n                                        which means that hop-by-hop must be retrieved from steps 2, 4 and 8 respectively,";
1330   result += "\n                                        and the expected message shall be an answer. Normally you will add other conditions,";
1331   result += "\n                                        for example a DIAMETER_SUCCESS result (adding 2001 as Result-Code).";
1332   result += "\n";
1333   result += "\nTest cases execution:";
1334   result += "\n";
1335   result += "\n";
1336   result += "\n   test|ttps|<amount>            Starts/resume the provided number of test ticks per second (ttps). The ADML starts";
1337   result += "\n                                 with the event trigger system suspended, and this operation is neccessary to begin";
1338   result += "\n                                 those cases which need this time event (internal triggering). Some other test cases";
1339   result += "\n                                 could be started through external events (first test case event could be programmed";
1340   result += "\n                                 to wait specific message), but is not usual this external mode and neither usual to";
1341   result += "\n                                 mix triggering types. Normally, you will pause/stop new test launchs providing 0 as";
1342   result += "\n                                 ttps value, and also you could dynamically modify the load rate updating that value.";
1343   result += "\n                                 If a test case has N messages then 'ttps * N' will be the virtual number of messages";
1344   result += "\n                                 managed per second when no bottleneck exists.";
1345   result += "\n";
1346   result += "\n                                 Provide 0 in order to stop the timer triggering.";
1347   result += "\n";
1348   result += "\n                                 The timer manager resolution currently harcoded allows a maximum  of ";
1349   result += anna::functions::asString(1000/a_admlMinResolution); result += " events";
1350   result += "\n                                 per second. To reach greater rates ADML will join synchronously the needed number of";
1351   result += "\n                                 new time-triggered test cases per a single event, writting a warning-level trace to";
1352   result += "\n                                 advice about the risk of burst sendings and recommend launching multiple instances";
1353   result += "\n                                 to achieve such load with a lower rate per instance.";
1354   result += "\n";
1355   result += "\n   test|next[|<sync-amount>]     Forces the execution of the next test case(s) without waiting for test manager tick.";
1356   result += "\n                                 Provide an integer value for 'sync-amount' to send a burst synchronous amount of the";
1357   result += "\n                                 next programmed test cases (1 by default). This event works regardless the timer tick";
1358   result += "\n                                 function, but it is normally used with the test manager tick stopped.";
1359   result += "\n";
1360   result += "\n   test|ip-limit[|amount]        In-progress limit of test cases. No new test cases will be launched over this value";
1361   result += "\n                                 (test Manager tick work will be ignored). Zero-value is equivalent to stop the clock.";
1362   result += "\n                                 tick, -1 is used to specify 'no limit' which is the default. If missing amount, the";
1363   result += "\n                                 limit and current amount of in-progress test cases will be shown.";
1364   result += "\n";
1365   result += "\n   test|goto|<id>                Updates current test pointer position.";
1366   result += "\n";
1367   result += "\n   test|look[|id]                Show programmed test case for id provided, current 'in-process' test case when missing.";
1368   result += "\n                                 Test cases reports are not dumped on process context (too many information in general).";
1369   result += "\n                                 The report contains context information in every moment: this operation acts as a snapshot.";
1370   result += "\n";
1371   result += "\n   test|interact|amount|id       Makes interactive a specific test case id. The amount is the margin of execution steps";
1372   result += "\n                                 to be done. Normally, we will execute 'test|interact|0|<test case id>', which means that";
1373   result += "\n                                 the test case is selected to be interactive, but no step is executed. Then you have to";
1374   result += "\n                                 interact with positive amounts (usually 1), executing the provided number of steps if";
1375   result += "\n                                 they are ready and fulfill the needed conditions. The value of 0, implies no execution";
1376   result += "\n                                 steps margin, which could be useful to 'freeze' a test in the middle of its execution.";
1377   result += "\n                                 You could also provide -1 to make it non-interactive resuming it from the current step.";
1378   result += "\n";
1379   result += "\n   test|reset|<[soft]/hard>[|id] Reset the test case for id provided, all the tests when missing. It could be hard/soft:";
1380   result += "\n                                 - hard: you probably may need to stop the load rate before. This operation initializes";
1381   result += "\n                                         all test cases regardless their states.";
1382   result += "\n                                 - soft: only for finished cases (those with 'Success' or 'Failed' states). It does not";
1383   result += "\n                                         affect to test cases with 'InProgress' state.";
1384   result += "\n";
1385   result += "\n   test|repeats|<amount>         Restarts the whole programmed test list when finished the amount number of times (repeats";
1386   result += "\n                                 forever if value -1 is provided). This is disabled by default (amount = 0): testing trigger";
1387   result += "\n                                 system will enter suspended state until new ttps operation is received and a soft reset has";
1388   result += "\n                                 been done before. Test cases state & data will be reset (when achieved again), but general";
1389   result += "\n                                 statistics and counters will continue measuring until reset with 'collect' operation.";
1390   result += "\n";
1391   result += "\n   test|clear                    Clears all the programmed test cases and stop testing (if in progress).";
1392   result += "\n";
1393   result += "\n   test|summary                  Test manager general report (number of test cases, counts by state, global configuration,";
1394   result += "\n                                 forced in-progress limitation, reports visibility, etc.). Be careful when you have reports";
1395   result += "\n                                 enabled because the programmed test cases dumps could be heavy (anyway you could enable the";
1396   result += "\n                                 dumps separately, for any of the possible states: Initialized, InProgress, Failed, Success).";
1397   result += "\n";
1398   result += "\n   test|report|<initialized/in-progress/failed/success/[all]/none>[|[yes]|no]";
1399   result += "\n";
1400   result += "\n                                 Enables/disables report generation for a certain test case state: initialized, in-progress,";
1401   result += "\n                                 failed or success (also 'all' and 'none' reserved words could be used). This applies to report";
1402   result += "\n                                 summary (former described operation) and automatic dumps during testing where only failed or";
1403   result += "\n                                 successful states will appear: every time a test case is finished its xml representation will";
1404   result += "\n                                 be dump on a file under the execution directory (or the one configured in process command-line";
1405   result += "\n                                 'tmDir') with the name:";
1406   result += "\n";
1407   result += "\n                                    'cycle-<cycle id>.testcase-<test case id>.xml'.";
1408   result += "\n";
1409   result += "\n                                 By default, all the states are disabled to avoid IO overload. In most of cases not all the";
1410   result += "\n                                 tests are going to fail then you could enable only such failed dumps. Anyway you could set";
1411   result += "\n                                 the reports visibility to fit your needs in a given situation.";
1412   result += "\n";
1413   result += "\n   test|report-hex[|[yes]|no]    Reports could include the diameter messages in hexadecimal format. Disabled by default.";
1414   result += "\n";
1415   result += "\n";
1416   result += "\nUSING OPERATIONS INTERFACE";
1417   result += "\n--------------------------";
1418   result += "\n";
1419   result += "\n------------------------------------------------------------------------- Operations via HTTP interface";
1420   result += "\n";
1421   result += "\nAll the operations described above can be used through the optional HTTP interface. You only have";
1422   result += "\n to define the http server at the command line with something like: '--httpServer localhost:9000'.";
1423   result += "\nTo send the task, we shall build the http request body with the operation string. Some examples";
1424   result += "\n using curl client could be:";
1425   result += "\n";
1426   result += "\n   curl -m 1 --data \"diameterServerSessions|4\" localhost:9000";
1427   result += "\n   curl -m 1 --data \"code|ccr.xml\" localhost:9000";
1428   result += "\n   curl -m 1 --data \"decode|ccr.hex\" localhost:9000";
1429   result += "\n   curl -m 1 --data \"sendxml2e|ccr.xml\" localhost:9000";
1430   result += "\n   etc.";
1431   result += "\n";
1432   result += "\n------------------------------------------------------------------------- Operations via SIGUSR2 signal";
1433   result += "\n";
1434   result += "\nThe alternative using SIGUSR2 signal requires the creation of the task(s) file which will be read at";
1435   result += "\n signal event:";
1436   result += "\n   echo \"<<operation>\" > "; result += getSignalUSR2InputFile();
1437   result += "\n    then";
1438   result += "\n   kill -12 <pid>";
1439   result += "\n    or";
1440   result += "\n   kill -s SIGUSR2 <pid>";
1441   result += "\n    and then see the results:";
1442   result += "\n   cat "; result += getSignalUSR2OutputFile();
1443   result += "\n";
1444   result += "\n   (this file is ended with EOF final line, useful managing huge batch files to ensure the job completion)";
1445   result += "\n";
1446   result += "\nYou could place more than one line (task) in the input file. Output reports will be appended in that";
1447   result += "\n case over the output file. Take into account that all the content of the task file will be executed";
1448   result += "\n sinchronously by the process. If you are planning traffic load, better use the asynchronous http";
1449   result += "\n interface.";
1450   result += "\n";
1451   result += "\n";
1452
1453   return result;
1454 }
1455
1456 void Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
1457   LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
1458   if (operation == "") return; // ignore
1459   LOGDEBUG(anna::Logger::debug(operation, ANNA_FILE_LOCATION));
1460
1461   // Default response:
1462   response_content = "Operation processed with exception: ";
1463   response_content += operation;
1464   std::string opt_response_content = ""; // aditional response content
1465   anna::DataBlock db_aux(true);
1466   anna::diameter::codec::Message codecMsg; // auxiliary codec message
1467
1468   // Singletons:
1469   CommandLine& cl(anna::CommandLine::instantiate());
1470   TestManager &testManager = TestManager::instantiate();
1471
1472
1473   ///////////////////////////////////////////////////////////////////
1474   // Simple operations without arguments:
1475
1476   // Help:
1477   if(operation == "help") {
1478     response_content = help();
1479     return;
1480   }
1481
1482   // Reset performance data:
1483   if(operation == "collect") {
1484     resetCounters();
1485     resetStatistics();
1486     response_content = "All process counters & statistic information have been reset";
1487     return;
1488   }
1489
1490   // Counters dump on demand:
1491   if(operation == "forceCountersRecord") {
1492     forceCountersRecord();
1493     response_content = "Current counters have been dump to disk";
1494     return;
1495   }
1496
1497   // OAM & statistics:
1498   if(operation == "show-oam") {
1499     anna::xml::Node root("root");
1500     response_content = anna::xml::Compiler().apply(oamAsXML(&root));
1501     return;
1502   }
1503   if(operation == "show-stats") {
1504     anna::xml::Node root("root");
1505     response_content = anna::xml::Compiler().apply(statsAsXML(&root));
1506     return;
1507   }
1508
1509   ///////////////////////////////////////////////////////////////////
1510   // Tokenize operation
1511   Tokenizer params;
1512   params.apply(operation, "|", "<null>" /* allow contiguous separators */);
1513   int numParams = params.size() - 1;
1514
1515   // Get the operation type and parameters:
1516   Tokenizer::const_iterator tok_iter = params.begin();
1517   std::string opType = Tokenizer::data(tok_iter);
1518   std::string param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11;
1519   if(numParams >= 1) { tok_iter++; param1 = Tokenizer::data(tok_iter); }
1520   if(numParams >= 2) { tok_iter++; param2 = Tokenizer::data(tok_iter); }
1521   if(numParams >= 3) { tok_iter++; param3 = Tokenizer::data(tok_iter); }
1522   // Tests conditions
1523   if(numParams >= 4) { tok_iter++; param4 = Tokenizer::data(tok_iter); }
1524   if(numParams >= 5) { tok_iter++; param5 = Tokenizer::data(tok_iter); }
1525   if(numParams >= 6) { tok_iter++; param6 = Tokenizer::data(tok_iter); }
1526   if(numParams >= 7) { tok_iter++; param7 = Tokenizer::data(tok_iter); }
1527   if(numParams >= 8) { tok_iter++; param8 = Tokenizer::data(tok_iter); }
1528   if(numParams >= 9) { tok_iter++; param9 = Tokenizer::data(tok_iter); }
1529   if(numParams >= 10) { tok_iter++; param10 = Tokenizer::data(tok_iter); }
1530   if(numParams >= 11) { tok_iter++; param11 = Tokenizer::data(tok_iter); }
1531   // Remove '<null>' artificial token to ease further checkings:
1532   if (param1 == "<null>") param1 = "";
1533   if (param2 == "<null>") param2 = "";
1534   if (param3 == "<null>") param3 = "";
1535   if (param4 == "<null>") param4 = "";
1536   if (param5 == "<null>") param5 = "";
1537   if (param6 == "<null>") param6 = "";
1538   if (param7 == "<null>") param7 = "";
1539   if (param8 == "<null>") param8 = "";
1540   if (param9 == "<null>") param9 = "";
1541   if (param10 == "<null>") param10 = "";
1542   if (param11 == "<null>") param11 = "";
1543
1544   // No operation has more than 2 arguments except 'test' ...
1545   if(opType != "test" && numParams > 2)
1546     throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1547
1548
1549   // Check the number of parameters:
1550   bool wrongBody = false;
1551
1552   if((opType == "change-dir") && (numParams > 1)) wrongBody = true;
1553   if((opType == "node") && (numParams > 1)) wrongBody = true;
1554
1555   if((opType == "node_auto") && (numParams > 0)) wrongBody = true;
1556
1557   if(((opType == "code") || (opType == "decode")) && (numParams != 2)) wrongBody = true;
1558
1559   if(((opType == "sendxml2e") || (opType == "sendhex2e")) && (numParams != 1)) wrongBody = true;
1560
1561   if((opType == "burst") && (numParams < 1)) wrongBody = true;
1562
1563   if((opType == "test") && (numParams < 1)) wrongBody = true;
1564
1565   if(((opType == "sendxml2c") || (opType == "sendhex2c") || (opType == "loadxml") || (opType == "diameterServerSessions")) && (numParams != 1)) wrongBody = true;
1566
1567   if(wrongBody) {
1568     // Launch exception
1569     std::string msg = "Wrong body content format on HTTP Request for '";
1570     msg += opType;
1571     msg += "' operation (missing parameter/s). Use 'help' management command to see more information.";
1572     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1573   }
1574
1575   // Operations:
1576   if(opType == "context") {
1577     std::string contextFile = ((numParams == 1) ? param1 : anna::functions::asString("/var/tmp/anna.context.%05d", getPid()));
1578     writeContext(contextFile);
1579     response_content = anna::functions::asString("Context dumped on file '%s'", contextFile.c_str());
1580     return;
1581   }
1582
1583   // Change execution directory:
1584   if(opType == "change-dir") {
1585     if (param1 == "") param1 = a_initialWorkingDirectory;
1586     if (chdir(param1.c_str()) == 0)
1587       response_content = "New execution directory configured: ";
1588     else
1589       response_content = "Cannot assign provided execution directory: ";
1590
1591     response_content += param1;
1592     return;
1593   }
1594
1595   if(opType == "services") {
1596     std::string servicesFile = ((numParams == 1) ? param1 : "services.xml");
1597     try {
1598       loadServices(servicesFile, true /* bind entities */);
1599     }
1600     catch(anna::RuntimeException &ex) {
1601       ex.trace();
1602       response_content = anna::functions::asString("Loaded services from file '%s' with errors", servicesFile.c_str());
1603       return;
1604     }
1605     response_content = anna::functions::asString("Loaded services from file '%s'", servicesFile.c_str());
1606     return;
1607   }
1608
1609   // Host switch:
1610   if(opType == "node") {
1611     if (param1 != "") {
1612       if (setWorkingNode(param1)) response_content = anna::functions::asString("Forced node is now '%s'", param1.c_str());
1613     }
1614     else {
1615       if (a_workingNode) {
1616         response_content = "Working node is forced to be: \n\n";
1617         response_content += a_workingNode->asXMLString();
1618       }
1619       else {
1620         response_content = "Working node is automatic";
1621       }
1622     }
1623     return;
1624   }
1625   if(opType == "node_auto") {
1626     a_workingNode = NULL;
1627     response_content = "Working node has been set to automatic";
1628     return;
1629   }
1630
1631   // Operated host from possible forced-working node:
1632   a_operatedHost = a_workingNode ? a_workingNode /* priority */: NULL /* auto */;
1633   // Use later:
1634   //    If any message is managed: updateOperatedOriginHostWithMessage(codecMessage)
1635   //    To operate, use the exception-protected methods which never will return NULL:
1636   //         getOperatedHost(), getOperatedEntity(), getOperatedServer(), getOperatedEngine()
1637
1638
1639   if(opType == "code") {
1640     codecMsg.loadXML(param1);
1641     std::string hexString = anna::functions::asHexString(codecMsg.code());
1642     // write to outfile
1643     std::ofstream outfile(param2.c_str(), std::ifstream::out);
1644     outfile.write(hexString.c_str(), hexString.size());
1645     outfile.close();
1646   } else if(opType == "decode") {
1647     // Get DataBlock from file with hex content:
1648     if(!getDataBlockFromHexFile(param1, db_aux))
1649       throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1650
1651     // Decode
1652     try { codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1653
1654     std::string xmlString = codecMsg.asXMLString();
1655     // write to outfile
1656     std::ofstream outfile(param2.c_str(), std::ifstream::out);
1657     outfile.write(xmlString.c_str(), xmlString.size());
1658     outfile.close();
1659   } else if((opType == "hide") || (opType == "show") || (opType == "hidden") || (opType == "shown")) {
1660
1661     if(param1 != "") {
1662       if(param2 != "") {
1663         std::string key = param1;
1664         key += "|";
1665         key += param2;
1666
1667         if(opType == "hide") getOperatedEngine()->findClientSession(key)->hide();
1668
1669         if(opType == "show") getOperatedEngine()->findClientSession(key)->show();
1670
1671         if(opType == "hidden") opt_response_content = getOperatedEngine()->findClientSession(key)->hidden() ? "true" : "false";
1672
1673         if(opType == "shown") opt_response_content = getOperatedEngine()->findClientSession(key)->shown() ? "true" : "false";
1674       } else {
1675         std::string address;
1676         int port;
1677         anna::functions::getAddressAndPortFromSocketLiteral(param1, address, port);
1678
1679         if(opType == "hide") getOperatedEngine()->findServer(address, port)->hide();
1680
1681         if(opType == "show") getOperatedEngine()->findServer(address, port)->show();
1682
1683         if(opType == "hidden") opt_response_content = getOperatedEngine()->findServer(address, port)->hidden() ? "true" : "false";
1684
1685         if(opType == "shown") opt_response_content = getOperatedEngine()->findServer(address, port)->shown() ? "true" : "false";
1686       }
1687     } else {
1688       if(opType == "hide") getOperatedEntity()->hide();
1689
1690       if(opType == "show") getOperatedEntity()->show();
1691
1692       if(opType == "hidden") opt_response_content = getOperatedEntity()->hidden() ? "true" : "false";
1693
1694       if(opType == "shown") opt_response_content = getOperatedEntity()->shown() ? "true" : "false";
1695     }
1696   } else if((opType == "sendxml2e") || (opType == "sendhex2e")) {
1697     anna::diameter::comm::Message *msg;
1698
1699     if(opType == "sendxml2e") {
1700       codecMsg.loadXML(param1);
1701       updateOperatedOriginHostWithMessage(codecMsg);
1702       msg = getOperatedHost()->createCommMessage();
1703       msg->clearBody();
1704       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)
1705       msg->setBody(codecMsg.code());
1706     } else {
1707       // Get DataBlock from file with hex content:
1708       if(!getDataBlockFromHexFile(param1, db_aux))
1709         throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1710       msg = getOperatedHost()->createCommMessage();
1711       msg->setBody(db_aux);
1712       try { if(getOperatedHost()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1713     }
1714
1715     bool success = getOperatedEntity()->send(msg, cl.exists("balance"));
1716     getOperatedHost()->releaseCommMessage(msg);
1717
1718     // Detailed log:
1719     if(getOperatedHost()->logEnabled()) {
1720       anna::diameter::comm::Server *usedServer = getOperatedEntity()->getLastUsedResource();
1721       anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
1722       std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
1723       getOperatedHost()->writeLogFile(codecMsg, (success ? "sent2e" : "send2eError"), detail);
1724     }
1725   } else if((opType == "burst")) {
1726
1727     if (!uniqueOriginHost())
1728       throw anna::RuntimeException("Burst category operations are only allowed in single host node configuration. This is only to simplify user experience.", ANNA_FILE_LOCATION);
1729
1730     // burst|clear                     clears all loaded burst messages.
1731     // burst|load|<source_file>        loads the next diameter message into launcher burst.
1732     // burst|start|<initial load>      starts the message sending with a certain initial load.
1733     // burst|push|<load amount>        sends specific non-aynchronous load.
1734     // burst|stop                      stops the burst cycle.
1735     // burst|repeat|[[yes]|no]         restarts the burst launch when finish.
1736     // burst|send|<amount>             send messages from burst list. The main difference with
1737     //                                 start/push operations is that burst won't be awaken.
1738     //                                 Externally we could control sending time (no request
1739     //                                 will be sent for answers).
1740     // burst|goto|<order>              Updates current burst pointer position.
1741     // burst|look|<order>              Show programmed burst message for order provided, current when missing.
1742
1743     if(param1 == "clear") {
1744       opt_response_content = "removed ";
1745       opt_response_content += anna::functions::asString(getOperatedHost()->clearBurst());
1746       opt_response_content += " elements";
1747     } else if(param1 == "load") {
1748       if(param2 == "") throw anna::RuntimeException("Missing xml path file for burst load operation", ANNA_FILE_LOCATION);
1749
1750       codecMsg.loadXML(param2);
1751       if(codecMsg.isAnswer()) throw anna::RuntimeException("Cannot load diameter answers for burst feature", ANNA_FILE_LOCATION);
1752       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)
1753
1754       int position = getOperatedHost()->loadBurstMessage(codecMsg.code());
1755       opt_response_content = "loaded '";
1756       opt_response_content += param2;
1757       opt_response_content += "' file into burst list position ";
1758       opt_response_content += anna::functions::asString(position);
1759     } else if(param1 == "start") {
1760       if(param2 == "") throw anna::RuntimeException("Missing initial load for burst start operation", ANNA_FILE_LOCATION);
1761
1762       int initialLoad = atoi(param2.c_str());
1763       int processed = getOperatedHost()->startBurst(initialLoad);
1764
1765       if(processed > 0) {
1766         opt_response_content = "initial load completed for ";
1767         opt_response_content += anna::functions::entriesAsString(processed, "message");
1768       }
1769     } else if(param1 == "push") {
1770       if(param2 == "") throw anna::RuntimeException("Missing load amount for burst push operation", ANNA_FILE_LOCATION);
1771
1772       int pushed = getOperatedHost()->pushBurst(atoi(param2.c_str()));
1773
1774       if(pushed > 0) {
1775         opt_response_content = "pushed ";
1776         opt_response_content += anna::functions::entriesAsString(pushed, "message");
1777       }
1778     } else if(param1 == "pop") {
1779       if(param2 == "") throw anna::RuntimeException("Missing amount for burst pop operation", ANNA_FILE_LOCATION);
1780
1781       int releaseLoad = atoi(param2.c_str());
1782       int popped = getOperatedHost()->popBurst(releaseLoad);
1783
1784       if(popped > 0) {
1785         opt_response_content = "burst popped for ";
1786         opt_response_content += anna::functions::entriesAsString(popped, "message");
1787       }
1788     } else if(param1 == "stop") {
1789       int left = getOperatedHost()->stopBurst();
1790
1791       if(left != -1) {
1792         opt_response_content += anna::functions::entriesAsString(left, "message");
1793         opt_response_content += " left to the end of the cycle";
1794       }
1795     } else if(param1 == "repeat") {
1796       if(param2 == "") param2 = "yes";
1797
1798       bool repeat = (param2 == "yes");
1799       getOperatedHost()->repeatBurst(repeat);
1800       opt_response_content += (repeat ? "repeat enabled" : "repeat disabled");
1801     } else if(param1 == "send") {
1802       if(param2 == "") throw anna::RuntimeException("Missing amount for burst send operation", ANNA_FILE_LOCATION);
1803
1804       int sent = getOperatedHost()->sendBurst(atoi(param2.c_str()));
1805
1806       if(sent > 0) {
1807         opt_response_content = "sent ";
1808         opt_response_content += anna::functions::entriesAsString(sent, "message");
1809       }
1810     } else if(param1 == "goto") {
1811       if(param2 == "") throw anna::RuntimeException("Missing order position for burst goto operation", ANNA_FILE_LOCATION);
1812
1813       opt_response_content = getOperatedHost()->gotoBurst(atoi(param2.c_str()));
1814     } else if(param1 == "look") {
1815       int order = ((param2 != "") ? atoi(param2.c_str()) : -1);
1816       opt_response_content = "\n\n";
1817       opt_response_content += getOperatedHost()->lookBurst(order);
1818     } else {
1819       throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). See help", ANNA_FILE_LOCATION);
1820     }
1821
1822   } else if((opType == "test")) {
1823     // test|<id>|<command>[|parameters]         Add a new step to the test case ...
1824     // test|ttps|<amount>                       Starts/resume the provided number of time ticks per second (ttps). The ADML starts ...
1825     // test|next[|<sync-amount>]                Forces the execution of the next test case(s) without waiting for test manager tick ...
1826     // test|ip-limit[|amount]                   In-progress limit of test cases. No new test cases will be launched over this value ...
1827     // test|repeats|<amount>                    Restarts the whole programmed test list when finished the amount number of times ...
1828     // test|report|<initialized/in-progress/failed/success/[all]/none>[|[yes]|no]
1829     //                                          Enables/disables report generation for a certain test case state: initialized, in-progress ...
1830     // test|report-hex[|[yes]|no]               Reports could include the diameter messages in hexadecimal format. Disabled by default.
1831     // test|goto|<id>                           Updates current test pointer position.
1832     // test|look[|id]                           Show programmed test case for id provided, current when missing ...
1833     // test|interact|amount|id                  Makes interactive a specific test case id. The amount is the margin of execution steps ...
1834     // test|reset|<[soft]/hard>[|id]            Reset the test case for id provided, all the tests when missing ...
1835     // test|clear                               Clears all the programmed test cases.
1836     // test|summary                             Test manager general report (number of test cases, counts by state ...
1837
1838
1839     if(param1 == "ttps") {
1840       if (numParams > 2)
1841         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1842
1843       bool success = ((param2 != "") ? testManager.configureTTPS(atoi(param2.c_str())) : false);
1844       if (success) {
1845         opt_response_content = "assigned new test launch rate to ";
1846         opt_response_content += anna::functions::asString(atoi(param2.c_str()));
1847         opt_response_content += " events per second";
1848       }
1849       else {
1850         opt_response_content += "unable to configure the test rate provided";
1851       }
1852     }
1853     else if (param1 == "next") {
1854       if (numParams > 2)
1855         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1856
1857       int sync_amount = ((param2 != "") ? atoi(param2.c_str()) : 1);
1858
1859       if (sync_amount < 1)
1860         throw anna::RuntimeException("The parameter 'sync-amount' must be a positive integer value", ANNA_FILE_LOCATION);
1861
1862       bool success = testManager.execTestCases(sync_amount);
1863
1864       opt_response_content = (success ? "" : "not completely " /* completed cycle and no repeats, rare case */);
1865       opt_response_content += "processed ";
1866       opt_response_content += anna::functions::asString(sync_amount);
1867       opt_response_content += ((sync_amount > 1) ? " test cases synchronously" : " test case");
1868     }
1869     else if(param1 == "ip-limit") {
1870       if (numParams > 2)
1871         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1872
1873       unsigned int limit;
1874       if (param2 != "") {
1875         limit = atoi(param2.c_str());
1876         testManager.setInProgressLimit(limit);
1877         opt_response_content = "new in-progress limit: ";
1878         opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1879       }
1880       else {
1881         opt_response_content = "in-progress limit amount: ";
1882         limit = testManager.getInProgressLimit();
1883         opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1884         opt_response_content += "; currently there are ";
1885         opt_response_content += anna::functions::asString(testManager.getInProgressCount());
1886         opt_response_content += " test cases running";
1887       }
1888     }
1889     else if(param1 == "repeats") {
1890       if (numParams != 2)
1891         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1892       int repeats = atoi(param2.c_str());
1893       if (repeats < 0) repeats = -1;
1894       testManager.setPoolRepeats(repeats);
1895       std::string nolimit = (repeats != -1) ? "":" [no limit]";
1896       opt_response_content += anna::functions::asString("Pool repeats: %d%s (current cycle: %d)", repeats, nolimit.c_str(), testManager.getPoolCycle());
1897     }
1898     else if(param1 == "report") {
1899       if (numParams > 3)
1900         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1901
1902       if(param2 == "") param2 = "all";
1903       if(param3 == "") param3 = "yes";
1904       bool enable = (param3 == "yes");
1905
1906       if(param2 == "initialized")
1907         testManager.setDumpInitializedReports(enable);
1908       else if(param2 == "in-progress")
1909         testManager.setDumpInProgressReports(enable);
1910       else if(param2 == "failed")
1911         testManager.setDumpFailedReports(enable);
1912       else if(param2 == "success")
1913         testManager.setDumpSuccessReports(enable);
1914       else if(param2 == "all") {
1915         param2 = "any";
1916         testManager.setDumpAllReports(enable);
1917       }
1918       else if(param2 == "none") {
1919         enable = !enable;
1920         param2 = "any";
1921         testManager.setDumpAllReports(enable);
1922       }
1923       else
1924         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1925
1926       opt_response_content += (enable ? "report enabled " : "report disabled ");
1927       opt_response_content += "for tests in '";
1928       opt_response_content += param2;
1929       opt_response_content += "' state";
1930     }
1931     else if(param1 == "report-hex") {
1932       if (numParams > 2)
1933         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1934
1935       if(param2 == "") param2 = "yes";
1936       testManager.setDumpHex((param2 == "yes"));
1937       opt_response_content += (testManager.getDumpHex() ? "report includes hexadecimal messages" : "report excludes hexadecimal messages");
1938     }
1939     else if(param1 == "goto") {
1940       if (numParams > 2)
1941         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1942
1943       if(param2 == "") throw anna::RuntimeException("Missing id for test goto operation", ANNA_FILE_LOCATION);
1944       int id = atoi(param2.c_str());
1945       if (testManager.gotoTestCase(id)) {
1946         opt_response_content = "position updated for id provided (";
1947       }
1948       else {
1949         opt_response_content = "cannot found test id (";
1950       }
1951       opt_response_content += anna::functions::asString(id);
1952       opt_response_content += ")";
1953     }
1954     else if(param1 == "look") {
1955       if (numParams > 2)
1956         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1957
1958       int id = ((param2 != "") ? atoi(param2.c_str()) : -1);
1959       TestCase *testCase = testManager.findTestCase(id);
1960
1961       if (testCase) {
1962         response_content = testCase->asXMLString();
1963         return;
1964       }
1965       else {
1966         if (id == -1) {
1967           opt_response_content = "no current test case detected (testing started ?)";
1968         }
1969         else {
1970           opt_response_content = "cannot found test id (";
1971           opt_response_content += anna::functions::asString(id);
1972           opt_response_content += ")";
1973         }
1974       }
1975     }
1976     else if (param1 == "interact") {
1977       if (numParams != 3)
1978         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1979
1980       int amount = atoi(param2.c_str());
1981       if (amount < -1)
1982         throw anna::RuntimeException("Interactive amount must be -1 (to disable interactive mode) or a positive number.", ANNA_FILE_LOCATION);
1983
1984       int id = atoi(param3.c_str());
1985       TestCase *testCase = testManager.findTestCase(id);
1986       if (testCase) {
1987         if (amount == -1) {
1988           testCase->makeInteractive(false);
1989           opt_response_content = "interactive mode disabled";
1990         }
1991         else {
1992           testCase->addInteractiveAmount(amount);
1993           opt_response_content = "added interactive amount of ";
1994           opt_response_content += anna::functions::asString(amount);
1995           opt_response_content += " units";
1996           if (amount == 0) opt_response_content += " (0: freezing a non-interactive testcase, no effect on already interactive)";
1997         }
1998         opt_response_content += " for test case id ";
1999         opt_response_content += anna::functions::asString(id);
2000       }
2001       else {
2002         opt_response_content = "cannot found test id (";
2003         opt_response_content += anna::functions::asString(id);
2004         opt_response_content += ")";
2005       }
2006     }
2007     else if(param1 == "reset") {
2008       if (numParams > 3)
2009         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2010
2011       if(param2 == "") param2 = "soft";
2012      if (param2 != "soft" && param2 != "hard")
2013         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2014
2015       int id = ((param3 != "") ? atoi(param3.c_str()) : -1);
2016       TestCase *testCase = ((id != -1) ? testManager.findTestCase(id) : NULL);
2017
2018       if (testCase) {
2019         bool done = testCase->reset((param2 == "hard") ? true:false);
2020         opt_response_content = "test ";
2021         opt_response_content += param2;
2022         opt_response_content += " reset for id ";
2023         opt_response_content += anna::functions::asString(id);
2024         opt_response_content += done ? ": done": ": not done";
2025       }
2026       else {
2027         if (id == -1) {
2028           bool anyReset = testManager.resetPool((param2 == "hard") ? true:false);
2029           opt_response_content = param2; opt_response_content += " reset have been sent to all programmed tests: "; opt_response_content += anyReset ? "some/all have been reset" : "nothing was reset";
2030         }
2031         else {
2032           opt_response_content = "cannot found test id (";
2033           opt_response_content += anna::functions::asString(id);
2034           opt_response_content += ")";
2035         }
2036       }
2037     }
2038     else if(param1 == "clear") {
2039       if (numParams > 1)
2040         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2041
2042       if (testManager.clearPool()) {
2043         opt_response_content = "all the programmed test cases have been dropped";
2044       }
2045       else {
2046         opt_response_content = "there are not programmed test cases to be removed";
2047       }
2048     }
2049     else if(param1 == "summary") {
2050       response_content = testManager.asXMLString();
2051       return;
2052     }
2053     else {
2054       int id = atoi(param1.c_str());
2055       if(id < 0)
2056         throw anna::RuntimeException("Invalid test case identifier: must be a non-negative number", ANNA_FILE_LOCATION);
2057
2058       // PARAM: 1     2            3      4          5           6             7           8          9       10         11
2059       // test|<id>|<command>
2060       //             timeout|    <msecs>
2061       //             sendxml2e|  <file>[|<step number>]
2062       //             sendxml2c|  <file>[|<step number>]
2063       //             delay|      [msecs]
2064       //             wait<fe/fc>|[code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]
2065       //      wait<fe/fc>-answer|<step number>
2066       //      wait<fe/fc>-regexp|<regexp>
2067       if(param2 == "") throw anna::RuntimeException("Missing command for test id operation", ANNA_FILE_LOCATION);
2068
2069       // Commands:
2070       if (param2 == "timeout") {
2071         if (numParams > 3)
2072           throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2073         if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'timeout' command in test id operation", ANNA_FILE_LOCATION);
2074         anna::Millisecond timeout = checkTimeMeasure("Test case timeout", param3);
2075         testManager.getTestCase(id)->addTimeout(timeout); // creates / reuses
2076       }
2077       else if ((param2 == "sendxml2e")||(param2 == "sendxml2c")) {
2078         if (numParams > 4)
2079           throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2080         if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing xml file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2081         codecMsg.loadXML(param3);
2082         if (codecMsg.isRequest()) {
2083           if (param4 != "")
2084             throw anna::RuntimeException("Step number is provided with answers (to resolve the corresponding 'wait for request' step), but NOT with requests", ANNA_FILE_LOCATION);
2085         }
2086         else {
2087           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));
2088         }
2089         updateOperatedOriginHostWithMessage(codecMsg);
2090         int stepNumber = ((param4 != "") ? atoi(param4.c_str()):-1);
2091
2092         if (param2 == "sendxml2e")
2093           testManager.getTestCase(id)->addSendxml2e(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses
2094         else
2095           testManager.getTestCase(id)->addSendxml2c(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses
2096       }
2097       else if (param2 == "delay") {
2098         if (numParams > 3)
2099           throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2100         if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'delay' command in test id operation", ANNA_FILE_LOCATION);
2101         anna::Millisecond delay = ((param3 == "0" /* special case */) ? (anna::Millisecond)0 : checkTimeMeasure("Test case delay step", param3));
2102         testManager.getTestCase(id)->addDelay(delay); // creates / reuses
2103       }
2104       else if ((param2 == "waitfe")||(param2 == "waitfc")) {
2105         if (numParams > 11)
2106           throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2107         if (param3 != "" || param4 != "" || param5 != "" || param6 != "" || param7 != "" || param8 != "" || param9 != "" || param10 != "" || param11 != "") {
2108           bool fromEntity = (param2.substr(4,2) == "fe");
2109           testManager.getTestCase(id)->addWait(fromEntity, param3, param4, param5, param6, param7, param8, param9, param10, param11);
2110         }
2111         else {
2112           throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2113         }
2114       }
2115       else if ((param2 == "waitfe-regexp")||(param2 == "waitfc-regexp")) {
2116         if (numParams > 3)
2117           throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2118         if (param3 != "") {
2119           bool fromEntity = (param2.substr(4,2) == "fe");
2120           testManager.getTestCase(id)->addWaitRegexp(fromEntity, param3);
2121         }
2122         else {
2123           throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2124         }
2125       }
2126       else if (param2 == "sh-command") {
2127         // Allow pipes in command:
2128         //if (numParams > 4)
2129         //  throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2130         if(param3 == "") throw anna::RuntimeException("Missing script/executable command-line for 'sh-command' in test id operation", ANNA_FILE_LOCATION);
2131         std::string token = "|sh-command|";
2132         std::string command = operation.substr(operation.find(token) + token.size());
2133         testManager.getTestCase(id)->addCommand(command); // creates / reuses
2134       }
2135       else {
2136         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2137       }
2138     }
2139
2140   } else if((opType == "sendxml2c") || (opType == "sendhex2c")) {
2141     anna::diameter::comm::Message *msg;
2142
2143     if(opType == "sendxml2c") {
2144       codecMsg.loadXML(param1);
2145       updateOperatedOriginHostWithMessage(codecMsg);
2146       msg = getOperatedHost()->createCommMessage();
2147       msg->clearBody();
2148       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)
2149
2150       msg->setBody(codecMsg.code());
2151     } else {
2152       // Get DataBlock from file with hex content:
2153       if(!getDataBlockFromHexFile(param1, db_aux))
2154         throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
2155       msg = getOperatedHost()->createCommMessage();
2156       msg->setBody(db_aux);
2157     }
2158
2159     bool success = getOperatedServer()->send(msg);
2160     getOperatedHost()->releaseCommMessage(msg);
2161
2162     // Detailed log:
2163     if(getOperatedHost()->logEnabled()) {
2164       anna::diameter::comm::ServerSession *usedServerSession = getOperatedServer()->getLastUsedResource();
2165       std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
2166       getOperatedHost()->writeLogFile(codecMsg, (success ? "sent2c" : "send2cError"), detail);
2167     }
2168   } else if(opType == "loadxml") {
2169     codecMsg.loadXML(param1);
2170     response_content = codecMsg.asXMLString();
2171     return;
2172   } else if(opType == "diameterServerSessions") {
2173     int diameterServerSessions = atoi(param1.c_str());
2174     getOperatedServer()->setMaxConnections(diameterServerSessions);
2175
2176   } else if(opType == "answerxml2c") {
2177     if(param1 == "") { // programmed answers FIFO's to stdout
2178       response_content = getOperatedServer()->getReactingAnswers()->asString("ANSWERS TO CLIENT");
2179       return;
2180     } else if (param1 == "rotate") {
2181       getOperatedServer()->getReactingAnswers()->rotate(true);
2182     } else if (param1 == "exhaust") {
2183       getOperatedServer()->getReactingAnswers()->rotate(false);
2184     } else if (param1 == "clear") {
2185       getOperatedServer()->getReactingAnswers()->clear();
2186     } else if (param1 == "dump") {
2187       getOperatedServer()->getReactingAnswers()->dump();
2188     } else {
2189       codecMsg.loadXML(param1);
2190       updateOperatedOriginHostWithMessage(codecMsg);
2191       anna::diameter::codec::Message *message = getOperatedHost()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2192       LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2193
2194       if(message->isRequest())
2195         throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2196
2197       int code = message->getId().first;
2198       LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to client' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2199       getOperatedServer()->getReactingAnswers()->addMessage(code, message);
2200     }
2201   } else if(opType == "answerxml2e") {
2202
2203     if(param1 == "") { // programmed answers FIFO's to stdout
2204       response_content = getOperatedEntity()->getReactingAnswers()->asString("ANSWERS TO ENTITY");
2205       return;
2206     } else if (param1 == "rotate") {
2207       getOperatedEntity()->getReactingAnswers()->rotate(true);
2208     } else if (param1 == "exhaust") {
2209       getOperatedEntity()->getReactingAnswers()->rotate(false);
2210     } else if (param1 == "clear") {
2211       getOperatedEntity()->getReactingAnswers()->clear();
2212     } else if (param1 == "dump") {
2213       getOperatedEntity()->getReactingAnswers()->dump();
2214     } else {
2215       codecMsg.loadXML(param1);
2216       updateOperatedOriginHostWithMessage(codecMsg);
2217       anna::diameter::codec::Message *message = getOperatedHost()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2218       LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2219
2220       if(message->isRequest())
2221         throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2222
2223       int code = message->getId().first;
2224       LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to entity' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2225       getOperatedEntity()->getReactingAnswers()->addMessage(code, message);
2226     }
2227   } else {
2228     throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2229   }
2230
2231   // HTTP response
2232   response_content = "Operation correctly processed: "; response_content += operation;
2233   if (opt_response_content != "") {
2234     response_content += " => ";
2235     response_content += opt_response_content;
2236   }
2237 }
2238
2239 anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const
2240 throw() {
2241   anna::xml::Node* result = parent->createChild("launcher");
2242   anna::comm::Application::asXML(result);
2243   // Timming:
2244   result->createAttribute("StartTime", a_start_time.asString());
2245   result->createAttribute("InitialWorkingDirectory", a_initialWorkingDirectory);
2246   result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000);
2247   // Diameter:
2248   for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
2249     it->second->asXML(result);
2250   }
2251
2252   // Registered codec engines:
2253   anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate();
2254   em.asXML(result);
2255
2256   // OAM & statistics:
2257   oamAsXML(result);
2258   statsAsXML(result);
2259
2260   // Testing: could be heavy if test case reports are enabled
2261   TestManager::instantiate().asXML(result);
2262
2263   return result;
2264 }
2265
2266 anna::xml::Node* Launcher::oamAsXML(anna::xml::Node* parent) const
2267 throw() {
2268   anna::xml::Node* result = parent->createChild("Oam");
2269
2270   // OAM:
2271   anna::diameter::comm::OamModule::instantiate().asXML(result);
2272   anna::diameter::comm::ApplicationMessageOamModule::instantiate().asXML(result);
2273   anna::diameter::codec::OamModule::instantiate().asXML(result);
2274
2275   return result;
2276 }
2277
2278 anna::xml::Node* Launcher::statsAsXML(anna::xml::Node* parent) const
2279 throw() {
2280   anna::xml::Node* result = parent->createChild("Statistics");
2281
2282   // Statistics:
2283   anna::statistics::Engine::instantiate().asXML(result);
2284
2285   return result;
2286 }