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