1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
11 // * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
17 // * Neither the name of the copyright holder nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
40 #include <sys/stat.h> // chmod
41 #include <fcntl.h> // open / write
47 #include <anna/config/defines.hpp>
48 #include <anna/comm/comm.hpp>
49 #include <anna/core/core.hpp>
50 #include <anna/xml/xml.hpp>
51 #include <anna/app/functions.hpp>
52 #include <anna/http/Request.hpp>
53 #include <anna/http/Response.hpp>
54 #include <anna/http/Handler.hpp>
55 #include <anna/http/Transport.hpp>
56 #include <anna/http/functions.hpp>
57 #include <anna/comm/functions.hpp>
58 #include <anna/timex/Engine.hpp>
59 #include <anna/timex/Clock.hpp>
60 #include <anna/diameter/stack/Engine.hpp>
61 #include <anna/diameter/codec/Engine.hpp>
62 #include <anna/diameter.comm/OamModule.hpp>
63 #include <anna/diameter.comm/ClientSession.hpp>
64 #include <anna/diameter.comm/LocalServer.hpp>
65 #include <anna/diameter.comm/Engine.hpp>
66 #include <anna/diameter.comm/Entity.hpp>
67 #include <anna/diameter.comm/Response.hpp>
68 #include <anna/diameter/functions.hpp>
69 #include <anna/diameter/codec/OamModule.hpp>
70 #include <anna/diameter/codec/functions.hpp>
71 #include <anna/time/functions.hpp>
72 #include <anna/time/Date.hpp>
73 #include <anna/diameter/helpers/base/defines.hpp>
74 #include <anna/diameter/helpers/base/functions.hpp>
75 #include <anna/diameter/helpers/dcca/defines.hpp>
76 #include <anna/diameter/helpers/dcca/functions.hpp>
77 #include <anna/statistics/Engine.hpp>
78 #include <anna/core/functions.hpp>
94 #define SIGUSR2_TASKS_INPUT_FILENAME "./sigusr2.tasks.input"
95 #define SIGUSR2_TASKS_OUTPUT_FILENAME "./sigusr2.tasks.output"
98 // Auxiliary message for sendings
99 anna::diameter::comm::Message G_commMsgSent2c, G_commMsgSent2e, G_commMsgFwd2c, G_commMsgFwd2e;
100 anna::diameter::comm::Message G_commMsg;
101 anna::diameter::codec::Message G_codecMsg, G_codecAnsMsg;
102 anna::Recycler<anna::diameter::comm::Message> G_commMessages; // create on requests forwards without programmed answer / release in answers forward
105 // Auxiliary resources for answers programming
106 typedef std::map < int /* message code */, anna::diameter::codec::Message* > reacting_answers_container;
107 typedef std::map < int /* message code */, anna::diameter::codec::Message* >::iterator reacting_answers_iterator;
108 typedef std::map < int /* message code */, anna::diameter::codec::Message* >::const_iterator reacting_answers_const_iterator;
109 reacting_answers_container G_reactingAnswers2C, G_reactingAnswers2E;
113 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
114 // COUNTERS RECORD PROCEDURE //////////////////////////////////////////////////////////////////////////////////////////////////////////////////
115 class MyCounterRecorderClock : public anna::timex::Clock {
117 MyCounterRecorderClock(const char *clockName, const anna::Millisecond & timeout) :
118 anna::timex::Clock(clockName, timeout) {;}
119 //virtual ~MyCounterRecorderClock();
121 virtual bool tick() throw (RuntimeException) {
122 anna::diameter::comm::OamModule::instantiate().recordCounters();
123 anna::diameter::codec::OamModule::instantiate().recordCounters();
128 class MyCounterRecorder : public anna::oam::CounterRecorder {
132 std::string a_fileNamePrefix;
133 std::string a_fileName;
134 time_t a_previousTime;
135 std::string a_fixedLine;
137 // pure virtual definitions:
138 void open() throw(anna::RuntimeException) {
139 static char str [256];
141 const time_t now = ::time (NULL);
143 struct tm tmPrevious;
145 anna_memcpy (&tmNow, localtime (&now), sizeof (tmNow));
146 anna_memcpy (&tmPrevious, localtime (&a_previousTime), sizeof (tmPrevious));
149 str,".Date%04d%02d%02d.Time%02d%02d%02d",
150 1900 + (tmNow.tm_year), (tmNow.tm_mon) + 1,
151 tmNow.tm_mday, tmNow.tm_hour, tmNow.tm_min, tmNow.tm_sec);
153 a_fileName = a_fileNamePrefix;
157 std::string msg ("Flush counters | ");
159 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
162 if ((a_stream = ::open (a_fileName.c_str (), O_WRONLY | O_CREAT, S_IWUSR)) == -1)
163 throw RuntimeException (anna::functions::asString("Error opening file '%s'; errno = %d", a_fileName.c_str(), errno), ANNA_FILE_LOCATION);
165 sprintf (str, "%04d-%02d-%02d %02d:%02d|%04d-%02d-%02d %02d:%02d",
166 1900 + (tmPrevious.tm_year), (tmPrevious.tm_mon) + 1,
167 tmPrevious.tm_mday, tmPrevious.tm_hour, tmPrevious.tm_min,
168 1900 + (tmNow.tm_year), (tmNow.tm_mon) + 1,
169 tmNow.tm_mday, tmNow.tm_hour, tmNow.tm_min
176 void apply(const anna::oam::Counter& counter) throw(anna::RuntimeException) {
177 static char line [356];
178 anna::oam::Counter::type_t value = counter;
179 sprintf (line, "%s|%06d|%07u|%s\n", a_fixedLine.c_str (), counter.getReference(), value, counter.getName ().c_str ());
180 if (write (a_stream, line, anna_strlen (line)) == -1)
181 throw RuntimeException (anna::functions::asString("Error writting to file '%s'; errno = %d", a_fileName.c_str(), errno), ANNA_FILE_LOCATION);
184 void close() throw() {
185 if (a_stream != -1) {
189 chmod (a_fileName.c_str (), S_IWUSR | S_IRUSR);
190 a_previousTime = ::time (NULL);
193 std::string asString() const throw() {
194 std::string result = "Physical counters dump at file '";
195 result += a_fileName;
196 result += "'. Another way to see counters: context dump (kill -10 <pid>";
201 MyCounterRecorder(const std::string &fnp) : a_stream(-1), a_fileNamePrefix(fnp) {
202 a_previousTime = ::time (NULL);
206 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
209 class MyDiameterEntity : public anna::diameter::comm::Entity {
211 void eventResponse(const anna::diameter::comm::Response&) throw(anna::RuntimeException);
212 void eventRequest(anna::diameter::comm::ClientSession *, const anna::DataBlock&) throw(anna::RuntimeException);
213 void eventUnknownResponse(anna::diameter::comm::ClientSession *, const anna::DataBlock&) throw(anna::RuntimeException);
216 int readSocketId(const anna::diameter::comm::Message* message, int maxClientSessions) const throw();
219 class MyLocalServer : public anna::diameter::comm::LocalServer {
221 void eventResponse(const anna::diameter::comm::Response&) throw(anna::RuntimeException);
222 void eventRequest(anna::diameter::comm::ServerSession *, const anna::DataBlock&) throw(anna::RuntimeException);
223 void eventUnknownResponse(anna::diameter::comm::ServerSession *, const anna::DataBlock&) throw(anna::RuntimeException);
226 class MyDiameterEngine : public anna::diameter::comm::Engine {
229 static const char* getClassName() throw() { return "launcher::MyDiameterEngine"; }
230 MyDiameterEngine() {;}
232 // Default implementation is enough
233 // void readDPA(anna::DataBlock &dpa, const anna::DataBlock & dpr) throw() {;} // DPA is not replied
234 // void readCEA(anna::DataBlock &cea, const anna::DataBlock & cer) throw() {;} // CEA is not replied
235 // void readDWA(anna::DataBlock &dwa, const anna::DataBlock & dwr) throw() {;} // DWA is not replied
238 anna::Recycler<MyDiameterEntity> a_entitiesRecycler;
240 anna::diameter::comm::Entity* allocateEntity() throw() { return a_entitiesRecycler.create(); }
242 void releaseEntity(anna::diameter::comm::Entity* entity) throw() {
243 MyDiameterEntity* aux = static_cast <MyDiameterEntity*>(entity);
244 a_entitiesRecycler.release(aux);
247 anna::Recycler<MyLocalServer> a_localServersRecycler;
249 anna::diameter::comm::LocalServer* allocateLocalServer() throw() { return a_localServersRecycler.create(); }
251 void releaseLocalServer(anna::diameter::comm::LocalServer* localServer) throw() {
252 MyLocalServer* aux = static_cast <MyLocalServer*>(localServer);
253 a_localServersRecycler.release(aux);
258 class MyHandler : public anna::http::Handler {
260 MyHandler() : anna::http::Handler("http_converter::MyHandler") {
261 allocateResponse()->createHeader(anna::http::Header::Type::Date);
266 void evRequest(anna::comm::ClientSocket&, const anna::http::Request& request) throw(anna::RuntimeException);
267 void evResponse(anna::comm::ClientSocket&, const anna::http::Response&) throw(anna::RuntimeException) {;}
270 class MyCommunicator : public anna::comm::Communicator {
272 MyCommunicator(const anna::comm::Communicator::WorkMode::_v acceptMode = anna::comm::Communicator::WorkMode::Single) : anna::comm::Communicator(acceptMode),
273 a_contexts("Contexts")
276 void prepareAnswer(anna::diameter::codec::Message *answer, const anna::DataBlock &request) const throw();
277 void terminate() throw();
280 anna::ThreadData <MyHandler> a_contexts;
281 void eventReceiveMessage(anna::comm::ClientSocket&, const anna::comm::Message&) throw(anna::RuntimeException);
282 void eventBreakConnection(Server* server) throw();
285 class Launcher : public anna::comm::Application {
287 MyCommunicator *a_communicator;
288 MyDiameterEngine *a_myDiameterEngine;
289 anna::diameter::comm::Entity *a_entity;
290 std::string a_logFile, a_burstLogFile;
291 std::ofstream a_burstLogStream;
292 bool a_splitLog, a_detailedLog;
293 anna::time::Date a_start_time;
294 anna::timex::Engine* a_timeEngine;
295 MyCounterRecorder *a_counterRecorder;
296 MyCounterRecorderClock *a_counterRecorderClock;
297 std::string a_cerPathfile;
298 std::string a_dwrPathfile;
304 std::map < int /* dummy, p.e. used for order number */, anna::diameter::comm::Message* > a_burstMessages;
306 std::map<int, anna::diameter::comm::Message*>::const_iterator a_burstDeliveryIt;
308 int a_burstPopCounter;
310 anna::comm::ServerSocket* a_httpServerSocket; // HTTP
311 anna::diameter::comm::LocalServer* a_diameterLocalServer; // DIAMETER
312 void checkTimeMeasure(const char * commandLineParameter, bool optional = true) throw(anna::RuntimeException);
313 void initialize() throw(anna::RuntimeException); // HTTP
314 void run() throw(anna::RuntimeException);
319 MyCommunicator *getCommunicator() throw() { return a_communicator; }
320 MyDiameterEngine* getMyDiameterEngine() const throw() { return (a_myDiameterEngine); }
321 void baseProtocolSetupAsClient(void) throw(anna::RuntimeException);
322 anna::diameter::comm::Entity *getEntity() throw() { return a_entity; }
323 anna::diameter::comm::LocalServer* getDiameterLocalServer() throw() { return a_diameterLocalServer; }
324 void eventOperation(const std::string &, std::string &) throw(anna::RuntimeException);
325 bool logEnabled() const throw() { return (((a_logFile == "") || (a_logFile == "null")) ? false : true); }
326 void writeLogFile(const anna::DataBlock & db, const std::string &logExtension, const std::string &detail) const throw();
327 void writeLogFile(const anna::diameter::codec::Message & decodedMessage, const std::string &logExtension, const std::string &detail) const throw();
328 void writeBurstLogFile(const std::string &buffer) throw();
329 bool burstLogEnabled() const throw() { return (((a_burstLogFile == "") || (a_burstLogFile == "null")) ? false : true); }
330 void startDiameterServer(int) throw(anna::RuntimeException);
332 anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
333 void resetStatistics() throw() { a_myDiameterEngine->resetStatistics(); }
334 void resetCounters() throw();
335 void signalUSR2() throw(anna::RuntimeException);
336 std::string help() const throw();
337 std::string programmedAnswers2e() const throw();
338 std::string programmedAnswers2c() const throw();
341 bool getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw();
344 int clearBurst() throw(); // returns removed
345 int loadBurstMessage(const anna::DataBlock & db) throw(anna::RuntimeException);
346 void repeatBurst(bool repeat) throw() { a_burstRepeat = repeat; }
347 int startBurst(int initialLoad) throw(); // return processed on start, or -1 if burst list is empty, -2 if invalid initial load (0 or negative)
348 int pushBurst(int loadAmount) throw(); // returns pushed (perhaps is less than provided because of no repeat mode and burst list exhausted), or -1 if burst list is empty, -2 if invalid load (0 or negative)
349 int sendBurst(int loadAmount) throw(); // returns sent (burst always cycled using send), returns -1 if burst list is empty, -2 if invalid load (0 or negative)
350 int popBurst(int releaseAmount) throw(); // returns popped (perhaps is less than provided because of OTA request), or -1 if burst stopped
351 int stopBurst() throw(); // returns remaining on cycle, or -1 if burst already stopped
352 bool burstActive() const throw() { return a_burstActive; }
353 bool sendBurstMessage(bool anyway = false) throw();
354 std::string lookBurst(int order) const throw();
355 std::string gotoBurst(int order) throw();
358 bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() {
361 static char buffer[2048];
362 std::ifstream infile(pathfile.c_str(), std::ifstream::in);
363 if(infile.is_open()) {
365 std::string hexString(buffer, strlen(buffer));
366 // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString':
367 hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end());
369 std::string msg = "Hex string (remove colons if exists): ";
371 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
374 anna::functions::fromHexString(hexString, db);
383 int Launcher::clearBurst() throw() {
384 int size = a_burstMessages.size();
387 std::map<int, anna::diameter::comm::Message*>::const_iterator it;
388 std::map<int, anna::diameter::comm::Message*>::const_iterator it_min(a_burstMessages.begin());
389 std::map<int, anna::diameter::comm::Message*>::const_iterator it_max(a_burstMessages.end());
391 for (it = it_min; it != it_max; it++) G_commMessages.release((*it).second);
393 a_burstMessages.clear();
395 std::string msg = "Burst list already empty. Nothing done";
396 std::cout << msg << std::endl;
397 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
400 a_burstActive = false;
402 a_burstDeliveryIt = a_burstMessages.begin();
407 int Launcher::loadBurstMessage(const anna::DataBlock & db) throw(anna::RuntimeException) {
408 anna::diameter::comm::Message *msg = G_commMessages.create();
410 a_burstMessages[a_burstLoadIndx++] = msg;
411 return (a_burstLoadIndx - 1);
414 int Launcher::stopBurst() throw() {
415 if (!a_burstActive) {
416 std::string msg = "Burst launch is already stopped. Nothing done";
417 std::cout << msg << std::endl;
418 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
422 a_burstActive = false;
423 // Remaining on cycle:
424 return (a_burstMessages.size() - (*a_burstDeliveryIt).first);
427 int Launcher::popBurst(int releaseAmount) throw() {
428 if (!a_burstActive) {
429 std::string msg = "Burst launch is stopped. Nothing done";
430 std::cout << msg << std::endl;
431 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
435 if (releaseAmount < 1) {
436 std::string msg = "No valid release amount is specified. Ignoring burst pop";
437 std::cout << msg << std::endl;
438 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
442 int currentOTArequests = a_entity->getOTARequests();
443 a_burstPopCounter = (releaseAmount > currentOTArequests) ? currentOTArequests : releaseAmount;
444 return a_burstPopCounter;
447 int Launcher::pushBurst(int loadAmount) throw() {
448 if (a_burstMessages.size() == 0) {
449 std::string msg = "Burst data not found (empty list). Ignoring burst launch";
450 std::cout << msg << std::endl;
451 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
455 if (loadAmount < 1) {
456 std::string msg = "No valid load amount is specified. Ignoring burst push";
457 std::cout << msg << std::endl;
458 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
462 a_burstActive = true;
465 for (count = 0; count < loadAmount; count++)
466 if (!sendBurstMessage()) break;
472 int Launcher::sendBurst(int loadAmount) throw() {
473 if (a_burstMessages.size() == 0) {
474 std::string msg = "Burst data not found (empty list). Ignoring burst launch";
475 std::cout << msg << std::endl;
476 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
480 if (loadAmount < 1) {
481 std::string msg = "No valid load amount is specified. Ignoring burst send";
482 std::cout << msg << std::endl;
483 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
489 for (count = 0; count < loadAmount; count++)
490 if (!sendBurstMessage(true /* anyway */)) break;
497 int Launcher::startBurst(int initialLoad) throw() {
498 if (initialLoad < 1) {
499 std::string msg = "No initial load is specified. Ignoring burst start";
500 std::cout << msg << std::endl;
501 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
505 a_burstActive = true;
507 a_burstDeliveryIt = a_burstMessages.begin();
508 return (pushBurst(initialLoad));
511 bool Launcher::sendBurstMessage(bool anyway) throw() {
512 if (!anyway && !burstActive()) return false;
514 if (a_burstPopCounter > 0) {
515 if (burstLogEnabled()) writeBurstLogFile("x");
521 if (a_burstDeliveryIt == a_burstMessages.end()) {
522 a_burstDeliveryIt = a_burstMessages.begin();
528 if (burstLogEnabled()) writeBurstLogFile(anna::functions::asString("\nCompleted burst cycle. Starting again (repeat mode) on cycle %d.\n", a_burstCycle));
530 if (burstLogEnabled()) writeBurstLogFile("\nCompleted burst cycle. Burst finished (repeat mode disabled).\n");
538 anna::diameter::comm::Message *msg = (*a_burstDeliveryIt).second;
539 int order = (*a_burstDeliveryIt).first + 1;
543 bool result = a_entity->send(msg, anna::CommandLine::instantiate().exists("balance"));
545 if (burstLogEnabled()) {
546 if (a_burstMessages.size() >= 100)
547 dot = (order % (a_burstMessages.size() / 100));
550 writeBurstLogFile(".");
552 writeBurstLogFile(anna::functions::asString(" %d", order));
553 int otaReqs = a_entity->getOTARequests();
555 if (result && (otaReqs != a_otaRequest)) {
556 // false if was a sending after an answer received (no OTA change in this case)
557 // true after push and pop operations
558 a_otaRequest = otaReqs;
559 writeBurstLogFile(anna::functions::asString("[OTA %d]", a_otaRequest));
566 anna::diameter::comm::Server *usedServer = a_entity->getLastUsedResource();
567 anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
568 std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // esto no deberia ocurrir
569 writeLogFile(msg->getBody(), (result ? "sent2e" : "send2eError"), detail);
576 std::string Launcher::lookBurst(int order) const throw() {
577 std::string result = "No message found for order provided (";
578 result += anna::functions::asString(order);
580 std::map<int, anna::diameter::comm::Message*>::const_iterator it = a_burstMessages.find(order - 1);
582 if (it != a_burstMessages.end()) {
584 try { G_codecMsg.decode((*it).second->getBody()); } catch (anna::RuntimeException &ex) { ex.trace(); }
586 result = G_codecMsg.asXMLString();
592 std::string Launcher::gotoBurst(int order) throw() {
593 std::string result = "Position not found for order provided (";
594 std::map<int, anna::diameter::comm::Message*>::iterator it = a_burstMessages.find(order - 1);
596 if (it != a_burstMessages.end()) {
597 a_burstDeliveryIt = it;
598 result = "Position updated for order provided (";
601 result += anna::functions::asString(order);
606 ////////////////////////////////////////////////////
609 void Launcher::resetCounters() throw() {
610 // Diameter::comm module:
611 anna::diameter::comm::OamModule & oamDiameterComm = anna::diameter::comm::OamModule::instantiate();
612 oamDiameterComm.resetCounters();
615 void Launcher::signalUSR2() throw(anna::RuntimeException) {
618 std::string msg = "Captured signal SIGUSR2. Reading tasks at '";
619 msg += SIGUSR2_TASKS_INPUT_FILENAME;
620 msg += "' (results will be written at '";
621 msg += SIGUSR2_TASKS_OUTPUT_FILENAME;
623 anna::Logger::notice(msg, ANNA_FILE_LOCATION);
628 std::string response_content;
630 std::ifstream in_file (SIGUSR2_TASKS_INPUT_FILENAME);
631 std::ofstream out_file (SIGUSR2_TASKS_OUTPUT_FILENAME);
633 if (!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION);
634 if (!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION);
636 while (getline (in_file, line))
639 std::string msg = "Processing line: ";
641 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
645 eventOperation(line, response_content);
646 } catch (RuntimeException &ex) {
649 out_file << response_content;
656 std::string Launcher::help() const throw() {
657 std::string result = "\n";
658 result += "\n ------------- HELP -------------\n";
660 result += "\nOVERVIEW";
661 result += "\n--------";
663 result += "\nThe ADL (ANNA Diameter Launcher) process is a complete diameter agent with client and server";
664 result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server";
665 result += "\n (i.e. to simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.),";
666 result += "\n and balancer systems to provide failover to external round-robin launchers. Also, auxiliary";
667 result += "\n encoder/decoder/loader function could be deployed to reinterpret certain external flow and";
668 result += "\n send it to another process.";
670 result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections";
671 result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard";
672 result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA";
673 result += "\n generation, expiration control and many more features.";
675 result += "\nProcess traces are dump on \"launcher.traces\" and could have any trace level (POSIX levels), usually";
676 result += "\n 'debug' or 'warning'. See ANNA documentation for more details.";
678 result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:";
679 result += "\n kill -10 <pid>";
681 result += "\n kill -s SIGUSR1 <pid>";
682 result += "\n and then";
683 result += "\n vi /var/tmp/anna.context.<pid>";
685 result += "\nA complete xml report will show all the context information (counters, alarms, statistics,";
686 result += "\n handlers, diameter dictionary, etc.), and a powerful log module could dump all the events";
687 result += "\n processed and flow information. Statistics could be analized at context dump and optionally";
688 result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the";
689 result += "\n measurements.";
691 result += "\nAlso SIGUSR2 is handled for management purposes. We will talk later about this.";
694 result += "\nCOMMAND LINE";
695 result += "\n------------";
697 result += "\nStart the launcher process without arguments in order to see all the startup configuration";
698 result += "\n posibilities, many of which could be modified on the air through the management interface";
699 result += "\n (we will talk later about this great feature). Some of the more common parameters are:";
701 result += "\nAs mandatory, the stack definition given through the xml dictionary:";
702 result += "\n -dictionary <path to dictionary file>";
704 result += "\nActing as a diameter server (accepting i.e. 10 connections), you would have:";
705 result += "\n -diameterServer localhost:3868 -diameterServerSessions 10 -entityServerSessions 0";
707 result += "\nActing as a diameter client (launching i.e. 10 connections to each entity server), you would have:";
708 result += "\n -entity 192.168.12.11:3868,192.168.12.21:3868 -entityServerSessions 10 -diameterServerSessions 0";
710 result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably";
711 result += "\n will need to program the answers to be replied through the operations interface. To balance the";
712 result += "\n traffic at your client side you shall use '-balance' and '-sessionBasedModelsClientSocketSelection'";
713 result += "\n arguments in order to define the balancing behaviour.";
715 result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own";
716 result += "\n customized ones using '-cer <xml message file>' and '-dwr <xml message file>'.";
717 result += "\nThe process builds automatically CEA and DWA messages as a server, but you could program your own";
718 result += "\n customized ones using operations interface.";
721 result += "\nDYNAMIC OPERATIONS";
722 result += "\n------------------";
724 result += "\nADL supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh.";
725 result += "\nAn operation is specified by mean a string containing the operation name and needed arguments";
726 result += "\n separated by pipes. These are the available commands:";
728 result += "\n--------------------------------------------------------------------------------------- General purpose";
730 result += "\nhelp This help. Startup information-level traces also dump this help.";
732 result += "\n------------------------------------------------------------------------------------ Parsing operations";
734 result += "\ncode|<source_file>|<target_file> Encodes source file (pathfile) into target file (pathfile).";
735 result += "\ndecode|<source_file>|<target_file> Decodes source file (pathfile) into target file (pathfile).";
736 result += "\nloadxml|<source_file> Reinterpret xml source file (pathfile).";
738 result += "\n------------------------------------------------------------------------------------------- Hot changes";
740 result += "\ndiameterServerSessions|<integer> Updates the maximum number of accepted connections to diameter";
741 result += "\n server socket.";
742 result += "\ncollect Reset statistics and counters to start a new test stage of";
743 result += "\n performance measurement. Context data is written at";
744 result += "\n '/var/tmp/anna.context.<pid>' by mean 'kill -10 <pid>'.";
746 result += "\n<visibility action>|[<address>:<port>]|[socket id]";
748 result += "\n Actions: hide, show (update state) and hidden, shown (query state).";
749 result += "\n Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A).";
750 result += "\n If missing server (first parameter) all applications sockets will be affected.";
751 result += "\n If missing socket (second parameter) for specific server, all its sockets will be affected.";
753 result += "\n All application client sessions are shown on startup, but standard delivery only use primary";
754 result += "\n server ones except if fails. Balance configuration use all the allowed sockets. You could also";
755 result += "\n use command line 'sessionBasedModelsClientSocketSelection' to force traffic flow over certain";
756 result += "\n client sessions, but for this, hide/show feature seems easier.";
758 result += "\n--------------------------------------------------------------------------------------- Flow operations";
760 result += "\nsendxml2e|<source_file> Sends xml source file (pathfile) through configured entity.";
761 result += "\nsendxml2c|<source_file> Sends xml source file (pathfile) to client.";
762 result += "\nsendxml|<source_file> Same as 'sendxml2e'.";
763 result += "\nanswerxml2e|[source_file] Answer xml source file (pathfile) for corresponding request from entity.";
764 result += "\nanswerxml2c|[source_file] Answer xml source file (pathfile) for corresponding request from client.";
765 result += "\nanswerxml|[source_file] Same as 'answerxml2c'.";
766 result += "\n List programmed answers if no parameter provided.";
768 result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test";
769 result += "\nspecial scenarios (protocol errors):";
771 result += "\nsendhex2e|<source_file> Sends hex source file (pathfile) through configured entity.";
772 result += "\nsendhex2c|<source_file> Sends hex source file (pathfile) to client.";
773 result += "\nsendhex|<source_file> Same as 'sendhex2e'.";
775 result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also";
776 result += "\nis intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
777 result += "\nsubscriber id, session id, etc.";
779 result += "\nIf a request is received, answer map (built with 'answerxml<[2c] or 2e>' operations) will be";
780 result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,";
781 result += "\n or answer message was received, the message is forwarded to the other side (entity or client),";
782 result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when";
783 result += "\n diameter server socket is configured, answer to entity have sense when entity does.";
785 result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored";
786 result += "\n to the peer which sent the request. If user wants to test a specific answer without changing it,";
787 result += "\n use sendxml/sendhex operations better than programming.";
789 result += "\nBalance ('-balance' command line parameter) could be used to forward server socket receptions through";
790 result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should";
791 result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an";
792 result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc.";
794 result += "\n--------------------------------------------------------------------------- Processing types (log tags)";
796 result += "\nUsed as log file extensions (when '-splitLog' is provided on command line) and context preffixes on log";
797 result += "\n details when unique log file is dumped:";
799 result += "\n [sent2e/send2eError] Send to entity (success/error)";
800 result += "\n [sent2c/send2cError] Send to client (success/error)";
801 result += "\n [fwd2e/fwd2eError] Forward to entity a reception from client (success/error)";
802 result += "\n [fwd2c/fwd2cError] Forward to client a reception from entity (success/error)";
803 result += "\n [recvfc] Reception from client";
804 result += "\n [recvfe] Reception from entity";
805 result += "\n [req2c-expired] A request sent to client has been expired";
806 result += "\n [req2e-expired] A request sent to entity has been expired";
807 result += "\n [recvfc-ans-unknown] Reception from client of an unknown answer (probably former [req2c-expired]";
808 result += "\n has been logged)";
809 result += "\n [recvfe-ans-unknown] Reception from entity of an unknown answer (probably former [req2e-expired]";
810 result += "\n has been logged)";
812 result += "\n-------------------------------------------------------------------------------------------- Load tests";
814 result += "\nburst|<action>|[parameter] Used for performance testing, we first program diameter requests";
815 result += "\n messages in order to launch them from client side to the configured";
816 result += "\n diameter entity. We could start the burst with an initial load";
817 result += "\n (non-asynchronous sending), after this, a new request will be sent";
818 result += "\n per answer received or expired context. There are 10 actions: clear,";
819 result += "\n load, start, push, pop, stop, repeat, send, goto and look.";
821 result += "\n burst|clear Clears all loaded burst messages.";
822 result += "\n burst|load|<source_file> Loads the next diameter message into launcher burst.";
823 result += "\n burst|start|<initial load> Starts (or restarts if already in progress) the message sending with";
824 result += "\n a certain initial load.";
825 result += "\n burst|push|<load amount> Sends specific non-aynchronous load.";
826 result += "\n burst|pop|<release amount> Skip send burst messages in order to reduce over-the-air requests.";
827 result += "\n Popping all OTA requests implies burst stop because no more answer";
828 result += "\n will arrive to the process. Burst output file (-burstLog command";
829 result += "\n line parameter) shows popped messages with crosses (x). Each cross";
830 result += "\n represents one received answer for which no new request is sent.";
831 result += "\n burst|stop Stops the burst cycle. You can resume pushing 1 load amount.";
832 result += "\n burst|repeat|[[yes]|no] Restarts the burst launch when finish. If initial load or push load";
833 result += "\n amount is greater than burst list size, they will be limited when";
834 result += "\n the list is processed except when repeat mode is enabled.";
835 result += "\n burst|send|<amount> Sends messages from burst list. The main difference with start/push";
836 result += "\n operations is that burst won't be awaken. Externally we could control";
837 result += "\n sending time (no request will be sent for answers).";
838 result += "\n burst|goto|<order> Updates current burst pointer position.";
839 result += "\n burst|look|<order> Show programmed burst message for order provided.";
842 result += "\nUSING OPERATIONS INTERFACE";
843 result += "\n--------------------------";
845 result += "\n------------------------------------------------------------------------- Operations via HTTP interface";
847 result += "\nAll the operations described above can be used through the optional HTTP interface. You only have";
848 result += "\n to define the http server at the command line with something like: '-httpServer localhost:9000'.";
849 result += "\nTo send the task, we shall build the http request body with the operation string. Some examples";
850 result += "\n using curl client could be:";
852 result += "\n curl -m 1 --data \"diameterServerSessions|4\" localhost:9000";
853 result += "\n curl -m 1 --data \"code|ccr.xml\" localhost:9000";
854 result += "\n curl -m 1 --data \"decode|ccr.hex\" localhost:9000";
855 result += "\n curl -m 1 --data \"sendxml2e|ccr.xml\" localhost:9000";
858 result += "\n------------------------------------------------------------------------- Operations via SIGUSR2 signal";
860 result += "\nThe alternative using SIGUSR2 signal requires the creation of the task(s) file which will be read at";
861 result += "\n signal event:";
862 result += "\n echo \"<<operation>\" > "; result += SIGUSR2_TASKS_INPUT_FILENAME;
864 result += "\n kill -12 <pid>";
866 result += "\n kill -s SIGUSR2 <pid>";
867 result += "\n and then see the results:";
868 result += "\n cat "; result += SIGUSR2_TASKS_OUTPUT_FILENAME;
870 result += "\nYou could place more than one line (task) in the input file. Output reports will be appended in that";
871 result += "\n case over the output file. Take into account that all the content of the task file will be executed";
872 result += "\n sinchronously by the process. If you are planning traffic load, better use the asynchronous http";
873 result += "\n interface.";
881 std::string Launcher::programmedAnswers2c() const throw() {
882 std::string result = "\n";
883 result += "\n ------------- CURRENT PROGRAMMED ANSWERS TO CLIENT -------------\n\n";
885 if (G_reactingAnswers2C.size() == 0) {
886 result += "No ocurrences found\n\n";
888 for (reacting_answers_const_iterator it = G_reactingAnswers2C.begin(); it != G_reactingAnswers2C.end(); it++) {
889 result += (*it).second->asXMLString();
898 std::string Launcher::programmedAnswers2e() const throw() {
899 std::string result = "\n";
900 result += "\n\n ------------- CURRENT PROGRAMMED ANSWERS TO ENTITY -------------\n\n";
902 if (G_reactingAnswers2E.size() == 0) {
903 result += "No ocurrences found\n\n";
905 for (reacting_answers_const_iterator it = G_reactingAnswers2E.begin(); it != G_reactingAnswers2E.end(); it++) {
906 result += (*it).second->asXMLString();
914 void MyCommunicator::prepareAnswer(anna::diameter::codec::Message *answer, const anna::DataBlock &request) const throw() {
915 // Sequence values (hop-by-hop and end-to-end), session-id and subscription-id avps, are mirrored to the peer which sent the request.
916 // If user wants to test a specific answer without changing it, use send operations better than programming.
917 // Sequence substitution:
918 answer->setHopByHop(anna::diameter::codec::functions::getHopByHop(request));
919 answer->setEndToEnd(anna::diameter::codec::functions::getEndToEnd(request));
921 // Session-Id substitution:
923 std::string sessionId = anna::diameter::helpers::base::functions::getSessionId(request);
925 std::string msg = "Extracted Session-Id: ";
927 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
929 answer->getAvp("Session-Id")->getUTF8String()->setValue(sessionId);
930 } catch (anna::RuntimeException &ex) {
934 // Subscription-Id substitution: is not usual to carry Subscription-Id on answer messages, but if programmed answer have this information,
935 // then it will be adapted with the received data at request.
936 if (answer->countAvp("Subscription-Id") > 0) {
937 std::string msisdn = anna::diameter::helpers::dcca::functions::getSubscriptionIdData(request, anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_E164);
938 std::string imsi = anna::diameter::helpers::dcca::functions::getSubscriptionIdData(request, anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_IMSI);
940 if ((msisdn != "") || (imsi != "")) { // Both request & answer have SID: replace answer one with the request information:
941 answer->removeAvp("Subscription-Id", 0 /* remove all */);
946 anna::diameter::codec::Avp *sid = answer->addAvp("Subscription-Id");
947 sid->addAvp("Subscription-Id-Type")->getEnumerated()->setValue(anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_E164);
948 sid->addAvp("Subscription-Id-Data")->getUTF8String()->setValue(msisdn);
952 anna::diameter::codec::Avp *sid = answer->addAvp("Subscription-Id"); // another
953 sid->addAvp("Subscription-Id-Type")->getEnumerated()->setValue(anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_IMSI);
954 sid->addAvp("Subscription-Id-Data")->getUTF8String()->setValue(imsi);
960 void MyCommunicator::eventReceiveMessage(anna::comm::ClientSocket& clientSocket, const anna::comm::Message& message)
961 throw(anna::RuntimeException) {
962 LOGMETHOD(anna::TraceMethod tm("MyCommunicator", "eventReceiveMessage", ANNA_FILE_LOCATION));
964 if (clientSocket.support(anna::http::Transport::className()) == false)
967 MyHandler& httpHandler = a_contexts.get();
968 httpHandler.apply(clientSocket, message);
972 using namespace anna::diameter;
974 int main(int argc, const char** argv) {
975 anna::Logger::setLevel(anna::Logger::Warning);
976 anna::Logger::initialize("launcher", new TraceWriter("launcher.traces", 2048000));
977 anna::time::functions::initialize(); // before application instantiation (it have a anna::time object)
978 anna::time::functions::setControlPoint(); // start control point (application lifetime)
980 anna::http::functions::initialize();
983 CommandLine& commandLine(anna::CommandLine::instantiate());
985 commandLine.add("trace", anna::CommandLine::Argument::Optional, "Trace level (emergency, alert, critical, error, warning, notice, information, debug, local0..local7)");
986 commandLine.add("log", anna::CommandLine::Argument::Optional, "Process log file (operations result, traffic log, etc.). By default 'launcher.log'. Empty string or \"null\" name, to disable. Warning: there is no rotation for log files (use logrotate or whatever)");
987 commandLine.add("splitLog", anna::CommandLine::Argument::Optional, "Splits log file (appends to log filename, extensions with the type of event: see help on startup information-level traces). No log files for code/decode and load operations are created", false);
988 commandLine.add("detailedLog", anna::CommandLine::Argument::Optional, "Insert detailed information at log files. Should be disabled on automatic tests. Useful on '-balance' mode to know messages flow along the sockets", false);
989 commandLine.add("logStatisticSamples", anna::CommandLine::Argument::Optional, "Log statistics samples for the provided concept id list, over './sample.<concept id>.csv' files. For example: \"1,2\" will log concepts 1 and 2. Reserved word \"all\" activates all registered statistics concept identifiers. That ids are shown at context dump (see help to get it).");
990 commandLine.add("burstLog", anna::CommandLine::Argument::Optional, "Burst operations log file. By default 'launcher.burst'. Empty string or \"null\" name, to disable. Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst list size, plus OTA requests when changed.");
991 commandLine.add("cntDir", anna::CommandLine::Argument::Optional, "Counters directory. By default is the current execution directory. Warning: a counter file will be dump per record period; take care about the possible accumulation of files");
992 commandLine.add("cntRecordPeriod", anna::CommandLine::Argument::Optional, "Counters record procedure period in milliseconds. If missing, default value of 300000 (5 minutes) will be assigned. Value of 0 disables the record procedure.");
994 commandLine.add("httpServer", anna::CommandLine::Argument::Optional, "HTTP Management interface address (using i.e. curl tool) in '<address>:<port>' format. For example: 10.20.30.40:8080");
995 commandLine.add("httpServerShared", anna::CommandLine::Argument::Optional, "Enables shared bind for HTTP Management interface address. It would be useful i.e. to allow a great amount of curl operations per second", false);
996 commandLine.add("diameterServer", anna::CommandLine::Argument::Optional, "Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868");
997 commandLine.add("diameterServerSessions", anna::CommandLine::Argument::Optional, "Diameter own server available connections (0: diameter server disabled). Default value of 1");
998 commandLine.add("entity", anna::CommandLine::Argument::Optional, "Target diameter entity (comma-separated '<address>:<port>' format). For example: 10.20.30.40:3868,10.20.30.41:3868");
999 commandLine.add("entityServerSessions", anna::CommandLine::Argument::Optional, "Diameter entity server sessions (0: diameter entity disabled). Default value of 1");
1000 commandLine.add("balance", anna::CommandLine::Argument::Optional, "Balance over entity servers instead of doing standard behaviour (first primary, secondary if fails, etc.)", false);
1001 commandLine.add("sessionBasedModelsClientSocketSelection", anna::CommandLine::Argument::Optional, "By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied; usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin'.");
1002 commandLine.add("dictionary", anna::CommandLine::Argument::Mandatory, "Diameter dictionary pathfiles (could be one or more ocurrences in a comma separated list, in order to accumulate loads). For example: avps_etsi.xml,avps_ietf.xml,avps_tgpp.xml,commands_qosControl.xml");
1003 commandLine.add("ignoreFlags", anna::CommandLine::Argument::Optional, "Ignore flags on validation (at the moment only bits M & P from AVPs, because V bit is too important; no operation flags could be checked). Also force compact xml presentation ignoring flags during dictionary elements identification", false);
1004 commandLine.add("ignoreErrors", anna::CommandLine::Argument::Optional, "Local server skips requests errors analysis which would prepare automatic answers for them when a problem is found. If no answer is programmed and entity is configured, a failed request would be forwarded (delegates at the end point) even if this parameter is missing", false);
1005 commandLine.add("allowedInactivityTime", anna::CommandLine::Argument::Optional, "Milliseconds for the maximum allowed inactivity time on server sessions born over the local server before being reset. If missing, default value of 90000 will be assigned");
1006 commandLine.add("tcpConnectDelay", anna::CommandLine::Argument::Optional, "Milliseconds to wait TCP connect to any server. If missing, default value of 200 will be assigned");
1007 commandLine.add("answersTimeout", anna::CommandLine::Argument::Optional, "Milliseconds to wait pending application answers from diameter peers. If missing, default value of 10000 will be assigned");
1008 commandLine.add("ceaTimeout", anna::CommandLine::Argument::Optional, "Milliseconds to wait CEA from diameter server. If missing, default value of 'answersTimeout' will be assigned");
1009 commandLine.add("watchdogPeriod", anna::CommandLine::Argument::Optional, "Milliseconds for watchdog timer (Tw) for diameter keep-alive procedure. If missing, default value of 30000 will be assigned");
1010 commandLine.add("reconnectionPeriod", anna::CommandLine::Argument::Optional, "Milliseconds to recover diameter client-session when server connection has been broken. If missing, default value of 10000 will be assigned");
1011 commandLine.add("cer", anna::CommandLine::Argument::Optional, "Pathfile for the Capabilities Exchange Request xml message. If missing, \"cer.xml\" is searched. If missing again, process creates own CER");
1012 commandLine.add("dwr", anna::CommandLine::Argument::Optional, "Pathfile for the Device Watchdog Request xml message. If missing, \"dwr.xml\" is searched. If missing again, process creates own DWR");
1013 commandLine.add("originHost", anna::CommandLine::Argument::Optional, "Diameter application host name (system name). If missing, process sets o.s. hostname");
1014 commandLine.add("originRealm", anna::CommandLine::Argument::Optional, "Diameter application node realm name. If missing, process sets domain name");
1015 commandLine.add("integrationAndDebugging", anna::CommandLine::Argument::Optional, "Sets validation mode to 'Always' (default validates only after decoding), and validation depth to 'Complete' (default validates until 'FirstError')", false);
1016 // commandLine.add("clone", anna::CommandLine::Argument::Optional, "Enables fork mode for request processing", false);
1017 commandLine.initialize(argv, argc);
1018 commandLine.verify();
1019 std::cout << commandLine.asString() << std::endl;
1021 } catch (Exception& ex) {
1022 cout << ex.asString() << endl;
1028 Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) {
1029 a_myDiameterEngine = new MyDiameterEngine();
1030 a_myDiameterEngine->setRealm("ADL.ericsson.com");
1031 a_myDiameterEngine->setAutoBind(false); // allow to create client-sessions without binding them, in order to set timeouts.
1032 //a_myDiameterEngine->setFreezeEndToEndOnSending();
1033 a_logFile = "launcher.log";
1034 a_burstLogFile = "launcher.burst";
1036 a_detailedLog = false;
1037 a_timeEngine = NULL;
1038 a_counterRecorder = NULL;
1039 a_counterRecorderClock = NULL;
1041 a_diameterLocalServer = NULL;
1042 a_cerPathfile = "cer.xml";
1043 a_dwrPathfile = "dwr.xml";
1046 a_burstRepeat = false;
1047 a_burstActive = false;
1048 //a_burstMessages.clear();
1049 a_burstLoadIndx = 0;
1050 a_burstDeliveryIt = a_burstMessages.begin();
1052 a_burstPopCounter = 0;
1055 void Launcher::baseProtocolSetupAsClient(void) throw(anna::RuntimeException) {
1057 // <CER> ::= < Diameter Header: 257, REQ >
1058 // { Origin-Host } 264 diameterIdentity
1059 // { Origin-Realm } 296 idem
1060 // 1* { Host-IP-Address } 257, address
1061 // { Vendor-Id } 266 Unsigned32
1062 // { Product-Name } 269 UTF8String
1063 // [Origin-State-Id] 278 Unsigned32
1064 // * [ Supported-Vendor-Id ] 265 Unsigned32
1065 // * [ Auth-Application-Id ] 258 Unsigned32
1066 // * [Acct-Application-Id] 259 Unsigned32
1067 anna::diameter::codec::Message diameterCER;
1068 int applicationId = 0 /*anna::diameter::helpers::APPID__3GPP_Rx*/; // Unsigned32
1069 std::string OH = a_myDiameterEngine->getHost();
1070 std::string OR = a_myDiameterEngine->getRealm();
1071 std::string hostIP = anna::functions::getHostnameIP(); // Address
1072 int vendorId = anna::diameter::helpers::VENDORID__tgpp; // Unsigned32
1073 std::string productName = "ANNA Diameter Launcher"; // UTF8String
1074 bool loadingError = false;
1077 diameterCER.loadXML(a_cerPathfile);
1078 } catch (anna::RuntimeException &ex) {
1080 loadingError = true;
1084 LOGWARNING(anna::Logger::warning("CER file not found. Get harcoded.", ANNA_FILE_LOCATION));
1085 diameterCER.setId(anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request);
1086 diameterCER.setApplicationId(applicationId);
1087 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH);
1088 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR);
1089 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Host_IP_Address)->getAddress()->fromPrintableString(hostIP.c_str()); // supported by Address class, anyway is better to provide "1|<ip address>"
1090 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Vendor_Id)->getUnsigned32()->setValue(vendorId);
1091 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Product_Name)->getUTF8String()->setValue(productName);
1092 diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Auth_Application_Id)->getUnsigned32()->setValue(applicationId);
1096 // <DWR> ::= < Diameter Header: 280, REQ >
1099 anna::diameter::codec::Message diameterDWR;
1100 loadingError = false;
1103 diameterDWR.loadXML(a_dwrPathfile);
1104 } catch (anna::RuntimeException &ex) {
1106 loadingError = true;
1110 LOGWARNING(anna::Logger::warning("DWR file not found. Get harcoded.", ANNA_FILE_LOCATION));
1111 diameterDWR.setId(anna::diameter::helpers::base::COMMANDID__Device_Watchdog_Request);
1112 diameterDWR.setApplicationId(applicationId);
1113 diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH);
1114 diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR);
1117 //////////////////////////
1118 // IDEM FOR CEA AND DWA //
1119 //////////////////////////
1121 // // <CER> ::= < Diameter Header: 257, REQ >
1122 // // { Origin-Host } 264 diameterIdentity
1123 // // { Origin-Realm } 296 idem
1124 // // 1* { Host-IP-Address } 257, address
1125 // // { Vendor-Id } 266 Unsigned32
1126 // // { Product-Name } 269 UTF8String
1127 // // [Origin-State-Id] 278 Unsigned32
1128 // // * [ Supported-Vendor-Id ] 265 Unsigned32
1129 // // * [ Auth-Application-Id ] 258 Unsigned32
1130 // // * [Acct-Application-Id] 259 Unsigned32
1131 // anna::diameter::codec::Message diameterCER;
1132 // int applicationId = 0 /*anna::diameter::helpers::APPID__3GPP_Rx*/; // Unsigned32
1133 // std::string OH = a_myDiameterEngine->getHost();
1134 // std::string OR = a_myDiameterEngine->getRealm();
1135 // std::string hostIP = anna::functions::getHostnameIP(); // Address
1136 // int vendorId = anna::diameter::helpers::VENDORID__tgpp; // Unsigned32
1137 // std::string productName = "ANNA Diameter Launcher"; // UTF8String
1138 // bool loadingError = false;
1141 // diameterCER.loadXML("cer.xml");
1142 // } catch (anna::RuntimeException &ex) {
1144 // loadingError = true;
1147 // if (loadingError) {
1148 // LOGWARNING(anna::Logger::warning("CER file not found. Get harcoded.", ANNA_FILE_LOCATION));
1149 // diameterCER.setId(anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request);
1150 // diameterCER.setApplicationId(applicationId);
1151 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH);
1152 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR);
1153 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Host_IP_Address)->getAddress()->fromPrintableString(hostIP.c_str()); // supported by Address class, anyway is better to provide "1|<ip address>"
1154 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Vendor_Id)->getUnsigned32()->setValue(vendorId);
1155 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Product_Name)->getUTF8String()->setValue(productName);
1156 // diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Auth_Application_Id)->getUnsigned32()->setValue(applicationId);
1160 // // <DWR> ::= < Diameter Header: 280, REQ >
1161 // // { Origin-Host }
1162 // // { Origin-Realm }
1163 // anna::diameter::codec::Message diameterDWR;
1164 // loadingError = false;
1167 // diameterDWR.loadXML("dwr.xml");
1168 // } catch (anna::RuntimeException &ex) {
1170 // loadingError = true;
1173 // if (loadingError) {
1174 // LOGWARNING(anna::Logger::warning("DWR file not found. Get harcoded.", ANNA_FILE_LOCATION));
1175 // diameterDWR.setId(anna::diameter::helpers::base::COMMANDID__Device_Watchdog_Request);
1176 // diameterDWR.setApplicationId(applicationId);
1177 // diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH);
1178 // diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR);
1180 // Assignment for CER/DWR and CEA/DWA:
1181 a_myDiameterEngine->setCERandDWR(diameterCER.code(), diameterDWR.code());
1182 //a_myDiameterEngine->setCEAandDWA(diameterCEA.code(), diameterDWA.code());
1185 void Launcher::writeLogFile(const anna::DataBlock & db, const std::string &logExtension, const std::string &detail) const throw() {
1186 // if (!logEnabled()) return;
1189 try { G_codecMsg.decode(db); } catch (anna::RuntimeException &ex) { ex.trace(); }
1191 writeLogFile(G_codecMsg, logExtension, detail);
1195 // Si ya lo tengo decodificado:
1196 void Launcher::writeLogFile(const anna::diameter::codec::Message & decodedMessage, const std::string &logExtension, const std::string &detail) const throw() {
1197 // if (!logEnabled()) return;
1198 // Open target file:
1199 std::string targetFile = a_logFile;
1203 targetFile += logExtension;
1206 ofstream out(targetFile.c_str(), ifstream::out | ifstream::app);
1207 // Set text to dump:
1208 std::string title = "[";
1209 title += logExtension;
1211 // Build complete log:
1212 std::string log = "\n";
1214 if (a_detailedLog) {
1215 anna::time::Date now;
1218 title += now.asString();
1219 log += anna::functions::highlight(title, anna::functions::TextHighlightMode::OverAndUnderline);
1220 log += decodedMessage.asXMLString();
1222 log += anna::functions::highlight("Used resource");
1228 log += decodedMessage.asXMLString();
1233 out.write(log.c_str(), log.size());
1238 void Launcher::writeBurstLogFile(const std::string &buffer) throw() {
1239 ofstream out(a_burstLogFile.c_str(), ifstream::out | ifstream::app);
1240 out.write(buffer.c_str(), buffer.size());
1241 out.close(); // close() will be called when the object is destructed (i.e., when it goes out of scope).
1242 // you'd call close() only if you indeed for some reason wanted to close the filestream
1243 // earlier than it goes out of scope.
1247 void Launcher::checkTimeMeasure(const char * commandLineParameter, bool optional) throw(anna::RuntimeException) {
1248 CommandLine& cl(anna::CommandLine::instantiate());
1250 if (!cl.exists(commandLineParameter) && optional) return; // start error if mandatory
1252 std::string parameter = cl.getValue(commandLineParameter);
1254 if (anna::functions::isLike("^[0-9]+$", parameter)) { // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$
1255 int msecs = cl.getIntegerValue(commandLineParameter);
1257 if (msecs > a_timeEngine->getMaxTimeout()) {
1258 std::string msg = "Commandline parameter '";
1259 msg += commandLineParameter;
1260 msg += "' is greater than allowed max timeout for timming engine: ";
1261 msg += anna::functions::asString(a_timeEngine->getMaxTimeout());
1262 throw RuntimeException(msg, ANNA_FILE_LOCATION);
1265 if (msecs <= a_timeEngine->getResolution()) {
1266 std::string msg = "Commandline parameter '";
1267 msg += commandLineParameter;
1268 msg += "' (and in general, all time measures) must be greater than timming engine resolution: ";
1269 msg += anna::functions::asString(a_timeEngine->getResolution());
1270 throw RuntimeException(msg, ANNA_FILE_LOCATION);
1276 // Excepcion (por no ser entero):
1277 std::string msg = "Error at commandline parameter '";
1278 msg += commandLineParameter;
1281 msg += "': must be a non-negative integer number";
1282 throw RuntimeException(msg, ANNA_FILE_LOCATION);
1286 void Launcher::startDiameterServer(int diameterServerSessions) throw(anna::RuntimeException) {
1287 if (diameterServerSessions <= 0) return;
1289 std::string address;
1291 CommandLine& cl(anna::CommandLine::instantiate());
1292 anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("diameterServer"), address, port);
1293 //ServerSocket *createServerSocket(const std::string & addr, int port = Session::DefaultPort, int maxConnections = -1, int category = 1, const std::string & description = "")
1294 a_diameterLocalServer = a_myDiameterEngine->createLocalServer(address, port, diameterServerSessions);
1295 a_diameterLocalServer->setDescription("Launcher diameter local server");
1296 int allowedInactivityTime = 90000; // ms
1298 if (cl.exists("allowedInactivityTime")) allowedInactivityTime = cl.getIntegerValue("allowedInactivityTime");
1300 a_diameterLocalServer->setAllowedInactivityTime((anna::Millisecond)allowedInactivityTime);
1304 void Launcher::initialize()
1305 throw(anna::RuntimeException) {
1306 anna::comm::Application::initialize();
1307 CommandLine& cl(anna::CommandLine::instantiate());
1308 anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single);
1309 // if (cl.exists ("clone"))
1310 // workMode = anna::comm::Communicator::WorkMode::Clone;
1311 a_communicator = new MyCommunicator(workMode);
1312 a_timeEngine = new anna::timex::Engine((anna::Millisecond)300000, (anna::Millisecond)150);
1314 // Counters record procedure:
1315 anna::Millisecond cntRecordPeriod = (anna::Millisecond)300000; // ms
1316 if (cl.exists("cntRecordPeriod")) cntRecordPeriod = cl.getIntegerValue("cntRecordPeriod");
1317 if (cntRecordPeriod != 0) {
1318 checkTimeMeasure("cntRecordPeriod");
1319 a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock
1321 std::string cntDir = ".";
1322 if (cl.exists("cntDir")) cntDir = cl.getValue("cntDir");
1323 a_counterRecorder = new MyCounterRecorder(cntDir + anna::functions::asString("/Counters.Pid%d", (int)getPid()));
1327 void Launcher::run()
1328 throw(anna::RuntimeException) {
1329 LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION));
1330 CommandLine& cl(anna::CommandLine::instantiate());
1332 a_start_time.setNow();
1334 anna::statistics::Engine::instantiate().enable();
1335 ///////////////////////////////
1336 // Diameter library COUNTERS //
1337 ///////////////////////////////
1338 anna::diameter::comm::OamModule & oamDiameterComm = anna::diameter::comm::OamModule::instantiate();
1339 oamDiameterComm.initializeCounterScope(1); // 1000 - 1999
1340 anna::diameter::codec::OamModule & oamDiameterCodec = anna::diameter::codec::OamModule::instantiate();
1341 oamDiameterCodec.initializeCounterScope(2); // 2000 - 2999
1347 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceived, "" /* get defaults for enum type*/, 0 /*1000*/);
1348 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceived, "", 1 /*1001*/);
1349 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnClientSession, "", 2 /*1002*/);
1350 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSession, "", 3 /*1003*/);
1351 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnServerSession, "", 4 /* etc. */);
1352 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSession, "", 5);
1353 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOK, "", 6);
1354 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentNOK, "", 7);
1355 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOK, "", 8);
1356 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentNOK, "", 9);
1357 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionOK, "", 10);
1358 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionNOK, "", 11);
1359 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionOK, "", 12);
1360 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionNOK, "", 13);
1361 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionOK, "", 14);
1362 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionNOK, "", 15);
1363 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionOK, "", 16);
1364 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionNOK, "", 17);
1365 /* Diameter Base (capabilities exchange & keep alive) */
1367 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentOK, "", 18);
1368 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentNOK, "", 19);
1369 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEAReceived, "", 20);
1370 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentOK, "", 21);
1371 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentNOK, "", 22);
1372 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWAReceived, "", 23);
1373 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentOK, "", 24);
1374 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentNOK, "", 25);
1375 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPAReceived, "", 26);
1377 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERReceived, "", 27);
1378 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentOK, "", 28);
1379 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentNOK, "", 29);
1380 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRReceived, "", 30);
1381 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentOK, "", 31);
1382 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentNOK, "", 32);
1383 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRReceived, "", 33);
1384 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentOK, "", 34);
1385 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentNOK, "", 35);
1386 /* server socket operations (enable/disable listening port for any local server) */
1387 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsOpened, "", 36);
1388 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsClosed, "", 37);
1391 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverOverEntity, "", 38);
1392 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverClientSession, "", 39);
1393 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverClientSession, "", 40);
1394 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverServer, "", 41);
1395 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverServer, "", 42);
1396 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEntity, "", 43);
1397 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEntity, "", 44);
1398 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForEntities, "", 45);
1399 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForEntities, "", 46);
1401 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverToClient, "", 47);
1402 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostConnectionForServerSession, "", 48);
1403 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnbindConnectionForServerSessionDueToInactivityTimeAnomaly, "", 49);
1404 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CreatedConnectionForServerSession, "", 50);
1405 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverLocalServer, "", 51);
1406 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverLocalServer, "", 52);
1407 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForLocalServers, "", 53);
1408 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForLocalServers, "", 54);
1409 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentExpired, "", 55);
1410 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionExpired, "", 56);
1411 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionExpired, "", 57);
1412 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown, "", 58);
1413 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown, "", 59);
1414 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown, "", 60);
1419 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength, "", 0 /*2000*/);
1420 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived, "", 1 /*2001*/);
1421 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncorrectLength, "", 2 /*2002*/);
1422 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__DataPartInconsistence, "", 3 /*2003*/);
1423 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit, "", 4 /*2004*/);
1424 /* Message decoding */
1425 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength, "", 5 /*2005*/);
1426 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength, "", 6 /*2006*/);
1427 /* Avp validation */
1428 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction, "", 10 /*2010*/);
1429 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules, "", 11 /*2011*/);
1430 /* Message validation */
1431 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate, "", 12 /*2012*/);
1432 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags, "", 13 /*2013*/);
1433 /* Level validation */
1434 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__MissingFixedRule, "", 14 /*2014*/);
1435 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinality, "", 15 /*2015*/);
1436 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded, "", 16 /*2016*/);
1437 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded, "", 17 /*2017*/);
1438 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem, "", 18 /*2018*/);
1439 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified, "", 19 /*2019*/);
1441 /////////////////////////////////
1442 // Counter recorder associated //
1443 /////////////////////////////////
1444 if (a_counterRecorderClock) {
1445 oamDiameterComm.setCounterRecorder(a_counterRecorder);
1446 oamDiameterCodec.setCounterRecorder(a_counterRecorder);
1447 a_timeEngine->activate(a_counterRecorderClock); // start clock
1450 // Checking command line parameters
1451 if (cl.exists("sessionBasedModelsClientSocketSelection")) {
1452 std::string type = cl.getValue("sessionBasedModelsClientSocketSelection");
1454 if ((type != "SessionIdHighPart") && (type != "SessionIdOptionalPart") && (type != "RoundRobin")) {
1455 throw anna::RuntimeException("Commandline option '-sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
1460 if (cl.exists("trace"))
1461 anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace")));
1464 // Help on startup traces:
1465 anna::Logger::information(help(), ANNA_FILE_LOCATION);
1466 // Test messages dtd:
1467 std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n";
1468 msg += anna::diameter::codec::MessageDTD;
1469 anna::Logger::information(msg, ANNA_FILE_LOCATION);
1472 if (cl.exists("httpServer")) {
1473 anna::comm::Network& network = anna::comm::Network::instantiate();
1474 std::string address;
1476 anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("httpServer"), address, port);
1477 //const anna::comm::Device* device = network.find(Device::asAddress(address)); // here provide IP
1478 const anna::comm::Device* device = *((network.resolve(address)->device_begin())); // trick to solve
1479 a_httpServerSocket = new anna::comm::ServerSocket(anna::comm::INetAddress(device, port), cl.exists("httpServerShared") /* shared bind */, &anna::http::Transport::getFactory());
1483 anna::diameter::codec::Engine *codecEngine = new anna::diameter::codec::Engine();
1484 anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
1487 anna::diameter::stack::Dictionary * d = stackEngine.createDictionary(0 /* stack id */);
1488 // Analyze comma-separated list:
1489 anna::Tokenizer lst;
1490 std::string dictionaryParameter = cl.getValue("dictionary");
1491 lst.apply(dictionaryParameter, ",");
1493 if (lst.size() >= 1) { // always true (at least one, because -dictionary is mandatory)
1494 anna::Tokenizer::const_iterator tok_min(lst.begin());
1495 anna::Tokenizer::const_iterator tok_max(lst.end());
1496 anna::Tokenizer::const_iterator tok_iter;
1497 std::string pathFile;
1500 for (tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
1501 pathFile = anna::Tokenizer::data(tok_iter);
1506 codecEngine->setDictionary(d);
1507 LOGDEBUG(anna::Logger::debug(codecEngine->asString(), ANNA_FILE_LOCATION));
1508 } catch (anna::RuntimeException &ex) {
1512 // Integration (validation 'Complete' for receiving messages) and debugging (validation also before encoding: 'Always').
1513 // If missing 'integrationAndDebugging', default behaviour at engine is: mode 'AfterDecoding', depth 'FirstError':
1514 if (cl.exists("integrationAndDebugging")) {
1515 codecEngine->setValidationMode(anna::diameter::codec::Engine::ValidationMode::Always);
1516 codecEngine->setValidationDepth(anna::diameter::codec::Engine::ValidationDepth::Complete);
1519 codecEngine->ignoreFlagsOnValidation(cl.exists("ignoreFlags"));
1522 if (cl.exists("diameterServer"))
1523 startDiameterServer(cl.exists("diameterServerSessions") ? cl.getIntegerValue("diameterServerSessions") : 1);
1525 // Optional command line parameters ////////////////////////////////////////////////////////
1526 checkTimeMeasure("allowedInactivityTime");
1527 checkTimeMeasure("tcpConnectDelay");
1528 checkTimeMeasure("answersTimeout");
1529 checkTimeMeasure("ceaTimeout");
1530 checkTimeMeasure("watchdogPeriod");
1531 checkTimeMeasure("reconnectionPeriod");
1532 int tcpConnectDelay = 200; // ms
1533 anna::Millisecond answersTimeout = (anna::Millisecond)10000; // ms
1534 anna::Millisecond ceaTimeout;
1535 anna::Millisecond watchdogPeriod = (anna::Millisecond)30000; // ms
1536 int reconnectionPeriod = 10000; // ms
1538 if (cl.exists("tcpConnectDelay")) tcpConnectDelay = cl.getIntegerValue("tcpConnectDelay");
1540 if (cl.exists("answersTimeout")) answersTimeout = cl.getIntegerValue("answersTimeout");
1542 if (cl.exists("ceaTimeout")) ceaTimeout = cl.getIntegerValue("ceaTimeout");
1543 else ceaTimeout = answersTimeout;
1545 if (cl.exists("watchdogPeriod")) watchdogPeriod = cl.getIntegerValue("watchdogPeriod");
1547 if (cl.exists("reconnectionPeriod")) reconnectionPeriod = cl.getIntegerValue("reconnectionPeriod");
1549 a_myDiameterEngine->setMaxConnectionDelay((anna::Millisecond)tcpConnectDelay);
1550 a_myDiameterEngine->setWatchdogPeriod(watchdogPeriod);
1551 std::string originHost = "";
1552 std::string originRealm = "";
1554 if (cl.exists("cer")) a_cerPathfile = cl.getValue("cer");
1556 if (cl.exists("dwr")) a_dwrPathfile = cl.getValue("dwr");
1558 if (cl.exists("originHost")) originHost = cl.getValue("originHost");
1560 if (cl.exists("originRealm")) originRealm = cl.getValue("originRealm");
1562 a_myDiameterEngine->setHost(originHost);
1563 a_myDiameterEngine->setRealm(originRealm);
1566 if (cl.exists("entity")) {
1567 int entityServerSessions = cl.exists("entityServerSessions") ? cl.getIntegerValue("entityServerSessions") : 1;
1569 if (entityServerSessions > 0) {
1570 baseProtocolSetupAsClient(); // Same CER/CEA, DWR/DWA for all diameter servers
1571 anna::socket_v servers = anna::functions::getSocketVectorFromString(cl.getValue("entity"));
1572 a_myDiameterEngine->setNumberOfClientSessionsPerServer(entityServerSessions);
1573 a_entity = a_myDiameterEngine->createEntity(servers, "Launcher diameter entity");
1574 a_entity->setClassCodeTimeout(anna::diameter::comm::ClassCode::Bind, ceaTimeout);
1575 a_entity->setClassCodeTimeout(anna::diameter::comm::ClassCode::ApplicationMessage, answersTimeout);
1581 if (cl.exists("log")) a_logFile = cl.getValue("log");
1583 if (cl.exists("splitLog")) a_splitLog = true;
1585 if (cl.exists("detailedLog")) a_detailedLog = true;
1587 if (cl.exists("burstLog")) a_burstLogFile = cl.getValue("burstLog");
1589 // Log statistics concepts
1590 if (cl.exists("logStatisticSamples")) {
1591 std::string list = cl.getValue("logStatisticSamples");
1592 anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
1594 if (list == "all") {
1595 if (statEngine.enableSampleLog(/* -1: all concepts */))
1596 LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
1598 anna::Tokenizer lst;
1599 lst.apply(cl.getValue("logStatisticSamples"), ",");
1601 if (lst.size() >= 1) {
1602 anna::Tokenizer::const_iterator tok_min(lst.begin());
1603 anna::Tokenizer::const_iterator tok_max(lst.end());
1604 anna::Tokenizer::const_iterator tok_iter;
1607 for (tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
1608 conceptId = atoi(anna::Tokenizer::data(tok_iter));
1610 if (statEngine.enableSampleLog(conceptId))
1611 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
1617 a_communicator->setRecoveryTime((const anna::Millisecond)reconnectionPeriod);
1618 if (cl.exists("httpServer")) a_communicator->attach(a_httpServerSocket); // HTTP
1619 a_communicator->accept();
1622 void MyCommunicator::eventBreakConnection(Server* server)
1624 LOGMETHOD(anna::TraceMethod tm("MyCommunicator", "eventBreakConnection", ANNA_FILE_LOCATION));
1626 anna::comm::Communicator::eventBreakConnection(server);
1629 void MyCommunicator::terminate()
1631 if (hasRequestedStop() == true)
1637 void MyHandler::evRequest(anna::comm::ClientSocket& clientSocket, const anna::http::Request& request)
1638 throw(anna::RuntimeException) {
1639 const anna::DataBlock& body = request.getBody();
1641 if (body.getSize() == 0)
1642 throw anna::RuntimeException("Missing operation parameters on HTTP request", ANNA_FILE_LOCATION);
1645 string msg("Received body: ");
1646 msg += anna::functions::asString(body);
1647 anna::Logger::information(msg, ANNA_FILE_LOCATION);
1649 std::string body_content;
1650 body_content.assign(body.getData(), body.getSize());
1652 std::string response_content;
1655 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
1656 my_app.eventOperation(body_content, response_content);
1657 } catch (RuntimeException &ex) {
1661 anna::http::Response* response = allocateResponse();
1662 response->setStatusCode(200); // http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
1663 anna::DataBlock db_content(true);
1664 db_content = response_content;
1665 response->setBody(db_content);
1666 // response->find(anna::http::Header::Type::Date)->setValue("Mon, 30 Jan 2006 14:36:18 GMT");
1667 // anna::http::Header* keepAlive = response->find("Keep-Alive");
1669 // if (keepAlive == NULL)
1670 // keepAlive = response->createHeader("Keep-Alive");
1672 // keepAlive->setValue("Verificacion del cambio 1.0.7");
1675 clientSocket.send(*response);
1676 } catch (Exception& ex) {
1681 void Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
1682 LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
1683 CommandLine& cl(anna::CommandLine::instantiate());
1684 LOGDEBUG(anna::Logger::debug(operation, ANNA_FILE_LOCATION));
1685 response_content = "Operation processed with exception. See traces\n"; // supposed
1686 std::string result = "";
1687 anna::DataBlock db_aux(true);
1689 ///////////////////////////////////////////////////////////////////
1690 // Simple operations without arguments:
1693 if (operation == "help") {
1694 std::string s_help = help();
1695 std::cout << s_help << std::endl;
1696 LOGINFORMATION(anna::Logger::information(s_help, ANNA_FILE_LOCATION));
1697 response_content = "Help dumped on stdout and information-level traces (launcher.traces file)\n";
1701 // Reset performance data:
1702 if (operation == "collect") {
1705 response_content = "All process counters & statistic information have been reset\n";
1708 ///////////////////////////////////////////////////////////////////
1710 // Tokenize operation
1712 params.apply(operation, "|");
1713 int numParams = params.size() - 1;
1715 // No operation has more than 2 arguments ...
1716 if (numParams > 2) {
1717 LOGWARNING(anna::Logger::warning(help(), ANNA_FILE_LOCATION));
1718 throw anna::RuntimeException("Wrong body content format on HTTP Request", ANNA_FILE_LOCATION);
1721 // Get the operation type:
1722 Tokenizer::const_iterator tok_iter = params.begin();
1723 std::string opType = Tokenizer::data(tok_iter);
1725 // Check the number of parameters:
1726 bool wrongBody = false;
1727 if ( ((opType == "code")||(opType == "decode")) && (numParams != 2) ) wrongBody = true;
1728 if ( ((opType == "sendxml") || (opType == "sendxml2e") || (opType == "sendhex") || (opType == "sendhex2e")) && (numParams != 1) ) wrongBody = true;
1729 if ( (opType == "burst") && (numParams < 1) ) wrongBody = true;
1730 if ( ((opType == "sendxml2c")||(opType == "sendhex2c")||(opType == "loadxml")||(opType == "diameterServerSessions")) && (numParams != 1) ) wrongBody = true;
1733 std::string msg = "Wrong body content format on HTTP Request for '";
1735 msg += "' operation (missing parameter/s)";
1736 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1740 std::string param1, param2;
1741 if (numParams >= 1) { tok_iter++; param1 = Tokenizer::data(tok_iter); }
1742 if (numParams == 2) { tok_iter++; param2 = Tokenizer::data(tok_iter); }
1746 if (opType == "code") {
1747 G_codecMsg.loadXML(param1);
1748 std::string hexString = anna::functions::asHexString(G_codecMsg.code());
1750 ofstream outfile(param2.c_str(), ifstream::out);
1751 outfile.write(hexString.c_str(), hexString.size());
1754 } else if (opType == "decode") {
1755 // Get DataBlock from file with hex content:
1756 if (!getDataBlockFromHexFile(param1, db_aux))
1757 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1760 try { G_codecMsg.decode(db_aux); } catch (anna::RuntimeException &ex) { ex.trace(); }
1762 std::string xmlString = G_codecMsg.asXMLString();
1764 ofstream outfile(param2.c_str(), ifstream::out);
1765 outfile.write(xmlString.c_str(), xmlString.size());
1768 } else if ((opType == "hide") || (opType == "show") || (opType == "hidden") || (opType == "shown")) {
1769 anna::diameter::comm::Entity *entity = getEntity();
1770 if (!entity) throw anna::RuntimeException("No entity configured to send messages", ANNA_FILE_LOCATION);
1773 std::string key = param1;
1777 if (opType == "hide") getMyDiameterEngine()->findClientSession(key)->hide();
1778 if (opType == "show") getMyDiameterEngine()->findClientSession(key)->show();
1779 if (opType == "hidden") result = getMyDiameterEngine()->findClientSession(key)->hidden() ? "true" : "false";
1780 if (opType == "shown") result = getMyDiameterEngine()->findClientSession(key)->shown() ? "true" : "false";
1782 std::string address;
1784 anna::functions::getAddressAndPortFromSocketLiteral(param1, address, port);
1786 if (opType == "hide") getMyDiameterEngine()->findServer(address, port)->hide();
1787 if (opType == "show") getMyDiameterEngine()->findServer(address, port)->show();
1788 if (opType == "hidden") result = getMyDiameterEngine()->findServer(address, port)->hidden() ? "true" : "false";
1789 if (opType == "shown") result = getMyDiameterEngine()->findServer(address, port)->shown() ? "true" : "false";
1792 if (opType == "hide") entity->hide();
1793 if (opType == "show") entity->show();
1794 if (opType == "hidden") result = entity->hidden() ? "true" : "false";
1795 if (opType == "shown") result = entity->shown() ? "true" : "false";
1797 } else if ((opType == "sendxml") || (opType == "sendxml2e") || (opType == "sendhex") || (opType == "sendhex2e")) {
1799 anna::diameter::comm::Entity *entity = getEntity();
1800 if (!entity) throw anna::RuntimeException("No entity configured to send the message", ANNA_FILE_LOCATION);
1802 if ((opType == "sendxml") || (opType == "sendxml2e")) {
1803 G_codecMsg.loadXML(param1);
1804 G_commMsgSent2e.clearBody();
1805 try { G_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)
1806 G_commMsgSent2e.setBody(G_codecMsg.code());
1809 // Get DataBlock from file with hex content:
1810 if (!getDataBlockFromHexFile(param1, db_aux))
1811 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1812 G_commMsgSent2e.setBody(db_aux);
1815 bool success = entity->send(G_commMsgSent2e, cl.exists("balance"));
1819 anna::diameter::comm::Server *usedServer = entity->getLastUsedResource();
1820 anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
1821 std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // esto no deberia ocurrir
1822 writeLogFile(G_codecMsg, (success ? "sent2e" : "send2eError"), detail);
1824 } else if ((opType == "burst")) {
1825 anna::diameter::comm::Entity *entity = getEntity();
1826 if (!entity) throw anna::RuntimeException("No entity configured to use burst feature", ANNA_FILE_LOCATION);
1828 // burst|clear clears all loaded burst messages.
1829 // burst|load|<source_file> loads the next diameter message into launcher burst.
1830 // burst|start|<initial load> starts the message sending with a certain initial load.
1831 // burst|push|<load amount> sends specific non-aynchronous load.
1832 // burst|stop stops the burst cycle.
1833 // burst|repeat|[[yes]|no] restarts the burst launch when finish.
1834 // burst|send|<amount> send messages from burst list. The main difference with
1835 // start/push operations is that burst won't be awaken.
1836 // Externally we could control sending time (no request
1837 // will be sent for answers).
1838 // burst|goto|<order> Updates current burst pointer position.
1839 // burst|look|<order> Show programmed burst message for order provided.
1841 if (param1 == "clear") {
1842 result = "Removed ";
1843 result += anna::functions::asString(clearBurst());
1844 result += " elements.";
1845 } else if (param1 == "load") {
1846 if (param2 == "") throw anna::RuntimeException("Missing xml path file for burst load operation", ANNA_FILE_LOCATION);
1848 G_codecMsg.loadXML(param2);
1850 if (G_codecMsg.isAnswer()) throw anna::RuntimeException("Cannot load diameter answers for burst feature", ANNA_FILE_LOCATION);
1851 try { G_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)
1853 int position = loadBurstMessage(G_codecMsg.code());
1854 result = "Loaded '";
1856 result += "' file into burst list position ";
1857 result += anna::functions::asString(position);
1858 } else if (param1 == "start") {
1859 if (param2 == "") throw anna::RuntimeException("Missing initial load for burst start operation", ANNA_FILE_LOCATION);
1861 int initialLoad = atoi(param2.c_str());
1862 int processed = startBurst(initialLoad);
1864 if (processed > 0) {
1865 result = "Initial load completed for ";
1866 result += anna::functions::entriesAsString(processed, "message");
1869 } else if (param1 == "push") {
1870 if (param2 == "") throw anna::RuntimeException("Missing load amount for burst push operation", ANNA_FILE_LOCATION);
1872 int pushed = pushBurst(atoi(param2.c_str()));
1876 result += anna::functions::entriesAsString(pushed, "message");
1879 } else if (param1 == "pop") {
1880 if (param2 == "") throw anna::RuntimeException("Missing amount for burst pop operation", ANNA_FILE_LOCATION);
1882 int releaseLoad = atoi(param2.c_str());
1883 int popped = popBurst(releaseLoad);
1886 result = "Burst popped for ";
1887 result += anna::functions::entriesAsString(popped, "message");
1890 } else if (param1 == "stop") {
1891 int left = stopBurst();
1894 result += anna::functions::entriesAsString(left, "message");
1895 result += " left to the end of the cycle.";
1897 } else if (param1 == "repeat") {
1898 if (param2 == "") param2 = "yes";
1900 bool repeat = (param2 == "yes");
1901 repeatBurst(repeat);
1902 result += (repeat ? "Mode on." : "Mode off.");
1903 } else if (param1 == "send") {
1904 if (param2 == "") throw anna::RuntimeException("Missing amount for burst send operation", ANNA_FILE_LOCATION);
1906 int sent = sendBurst(atoi(param2.c_str()));
1910 result += anna::functions::entriesAsString(sent, "message");
1913 } else if (param1 == "goto") {
1914 if (param2 == "") throw anna::RuntimeException("Missing order position for burst goto operation", ANNA_FILE_LOCATION);
1916 result = gotoBurst(atoi(param2.c_str()));
1918 } else if (param1 == "look") {
1919 if (param2 == "") throw anna::RuntimeException("Missing order position for burst look operation", ANNA_FILE_LOCATION);
1922 result += lookBurst(atoi(param2.c_str()));
1925 throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). See help", ANNA_FILE_LOCATION);
1928 } else if ((opType == "sendxml2c") || (opType == "sendhex2c")) {
1929 anna::diameter::comm::LocalServer *localServer = getDiameterLocalServer();
1930 if (!localServer) throw anna::RuntimeException("No local server configured to send the message", ANNA_FILE_LOCATION);
1932 if (opType == "sendxml2c") {
1933 G_codecMsg.loadXML(param1);
1934 G_commMsgSent2c.clearBody();
1935 try { G_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)
1936 G_commMsgSent2c.setBody(G_codecMsg.code());
1939 // Get DataBlock from file with hex content:
1940 if (!getDataBlockFromHexFile(param1, db_aux))
1941 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1942 G_commMsgSent2c.setBody(db_aux);
1945 bool success = localServer->send(G_commMsgSent2c);
1949 anna::diameter::comm::ServerSession *usedServerSession = localServer->getLastUsedResource();
1950 std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // esto no deberia ocurrir
1951 writeLogFile(G_codecMsg, (success ? "sent2c" : "send2cError"), detail);
1954 } else if (opType == "loadxml") {
1955 G_codecMsg.loadXML(param1);
1956 std::string xmlString = G_codecMsg.asXMLString();
1957 std::cout << xmlString << std::endl;
1959 } else if (opType == "diameterServerSessions") {
1961 int diameterServerSessions = atoi(param1.c_str());
1963 if (!getDiameterLocalServer())
1964 startDiameterServer(diameterServerSessions);
1966 getDiameterLocalServer()->setMaxConnections(diameterServerSessions);
1967 } else if ((opType == "answerxml") || (opType == "answerxml2c")) {
1968 anna::diameter::comm::LocalServer *localServer = getDiameterLocalServer();
1971 throw anna::RuntimeException("Operation not applicable (no own diameter server has been configured)", ANNA_FILE_LOCATION);
1974 anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
1975 anna::diameter::codec::Message *message = engine->createMessage(param1);
1978 anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION);
1981 if (message->isRequest())
1982 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
1984 int code = message->getId().first;
1985 reacting_answers_const_iterator it = G_reactingAnswers2C.find(code);
1987 if (it != G_reactingAnswers2C.end()) { // found: replace
1988 LOGDEBUG(anna::Logger::debug("Replacing formerly programed answer...", ANNA_FILE_LOCATION));
1989 engine->releaseMessage((*it).second);
1992 G_reactingAnswers2C[code] = message;
1993 } else { // answers query on stdout
1994 std::cout << programmedAnswers2c() << std::endl;
1995 response_content = "Programmed answers dumped on stdout\n";
1998 } else if (opType == "answerxml2e") {
1999 anna::diameter::comm::Entity *entity = getEntity();
2002 throw anna::RuntimeException("Operation not applicable (no diameter entity has been configured)", ANNA_FILE_LOCATION);
2005 anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
2006 anna::diameter::codec::Message *message = engine->createMessage(param1);
2009 anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION);
2012 if (message->isRequest())
2013 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2015 int code = message->getId().first;
2016 reacting_answers_const_iterator it = G_reactingAnswers2E.find(code);
2018 if (it != G_reactingAnswers2E.end()) { // found: replace
2019 LOGDEBUG(anna::Logger::debug("Replacing formerly programed answer...", ANNA_FILE_LOCATION));
2020 engine->releaseMessage((*it).second);
2023 G_reactingAnswers2E[code] = message;
2024 } else { // answers query on stdout
2025 std::cout << programmedAnswers2e() << std::endl;
2026 response_content = "Programmed answers dumped on stdout\n";
2030 LOGWARNING(anna::Logger::warning(help(), ANNA_FILE_LOCATION));
2031 throw anna::RuntimeException("Wrong body content format on HTTP Request. Unsupported/unrecognized operation type", ANNA_FILE_LOCATION);
2035 response_content = "Operation processed; ";
2037 if ((opType == "decode") || (opType == "code")) {
2038 response_content += "File '";
2039 response_content += param2;
2040 response_content += "' created.";
2041 response_content += "\n";
2042 } else if ((opType == "hide") || (opType == "show")) {
2043 response_content += "Resource '";
2044 response_content += ((param1 != "") ? param1 : "Entity");
2047 response_content += "|";
2048 response_content += param2;
2051 response_content += "' ";
2053 if (opType == "hide") response_content += "has been hidden.";
2055 if (opType == "show") response_content += "has been shown.";
2057 response_content += "\n";
2058 } else if ((opType == "hidden") || (opType == "shown")) {
2059 response_content += "Result: ";
2060 response_content += result;
2061 response_content += "\n";
2062 } else if ((opType == "sendxml") || (opType == "sendxml2e") || (opType == "sendhex") || (opType == "sendhex2e")) {
2063 response_content += "Message '";
2064 response_content += param1;
2065 response_content += "' sent to entity.";
2066 response_content += "\n";
2067 } else if (opType == "burst") {
2068 response_content += "Burst '";
2069 response_content += param1;
2070 response_content += "' executed. ";
2071 response_content += result;
2072 response_content += "\n";
2073 } else if ((opType == "sendxml2c")||(opType == "sendhex2c")) {
2074 response_content += "Message '";
2075 response_content += param1;
2076 response_content += "' sent to client.";
2077 response_content += "\n";
2078 } else if (opType == "loadxml") {
2079 response_content += "Message '";
2080 response_content += param1;
2081 response_content += "' loaded.";
2082 response_content += "\n";
2083 } else if ((opType == "answerxml") || (opType == "answerxml2c")) {
2084 response_content += "Answer to client '";
2085 response_content += param1;
2086 response_content += "' programmed.";
2087 response_content += "\n";
2088 } else if (opType == "answerxml2e") {
2089 response_content += "Answer to entity '";
2090 response_content += param1;
2091 response_content += "' programmed.";
2092 response_content += "\n";
2093 } else if (opType == "diameterServerSessions") {
2094 response_content += "Maximum server socket connections updated to '";
2095 response_content += param1;
2096 response_content += "'.";
2097 response_content += "\n";
2102 int MyDiameterEntity::readSocketId(const anna::diameter::comm::Message* message, int maxClientSessions) const throw() {
2103 CommandLine& cl(anna::CommandLine::instantiate());
2104 std::string sessionBasedModelsType = (cl.exists("sessionBasedModelsClientSocketSelection") ? cl.getValue("sessionBasedModelsClientSocketSelection") : "SessionIdLowPart");
2106 if (sessionBasedModelsType == "RoundRobin") return -1; // IEC also would return -1
2109 // Service-Context-Id:
2110 anna::diameter::helpers::dcca::ChargingContext::_v chargingContext;
2111 std::string scid = anna::diameter::helpers::dcca::functions::getServiceContextId(message->getBody(), chargingContext);
2113 switch (chargingContext) {
2114 case anna::diameter::helpers::dcca::ChargingContext::Data:
2115 case anna::diameter::helpers::dcca::ChargingContext::Voice:
2116 case anna::diameter::helpers::dcca::ChargingContext::Content: {
2117 // Session-Id: '<DiameterIdentity>;<high 32 bits>;<low 32 bits>[;<optional value>="">]'
2118 std::string sid = anna::diameter::helpers::base::functions::getSessionId(message->getBody());
2119 std::string diameterIdentity, optional;
2120 anna::U32 high, low;
2121 anna::diameter::helpers::base::functions::decodeSessionId(sid, diameterIdentity, high, low /* context-teid */, optional);
2123 if (sessionBasedModelsType == "SessionIdLowPart") return (low % maxClientSessions);
2125 if (sessionBasedModelsType == "SessionIdHighPart") return (high % maxClientSessions);
2127 if (sessionBasedModelsType == "SessionIdOptionalPart") return (atoi(optional.c_str()) % maxClientSessions);
2129 //case anna::diameter::helpers::dcca::ChargingContext::SMS:
2130 //case anna::diameter::helpers::dcca::ChargingContext::MMS:
2132 // return -1; // IEC model and Unknown traffic types
2134 } catch (anna::RuntimeException &ex) {
2136 std::string msg = ex.getText();
2137 msg += " | Round-robin between sessions will be used to send";
2138 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2146 void MyDiameterEntity::eventRequest(anna::diameter::comm::ClientSession *clientSession, const anna::DataBlock &message)
2147 throw(anna::RuntimeException) {
2148 LOGMETHOD(anna::TraceMethod tm("launcher::MyDiameterEntity", "eventRequest", ANNA_FILE_LOCATION));
2149 // Performance stats:
2150 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2151 CommandLine& cl(anna::CommandLine::instantiate());
2153 anna::diameter::CommandId cid = anna::diameter::codec::functions::getCommandId(message);
2156 std::string msg = "Request received: ";
2157 msg += anna::diameter::functions::commandIdAsPairString(cid);
2158 msg += " | DiameterServer: ";
2159 msg += anna::functions::socketLiteralAsString(clientSession->getAddress(), clientSession->getPort());
2160 msg += " | EventTime: ";
2161 msg += anna::time::functions::currentTimeAsString();
2162 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2166 if (my_app.logEnabled()) my_app.writeLogFile(message, "recvfe", clientSession->asString());
2168 // Lookup reacting answers list:
2169 int code = cid.first;
2170 reacting_answers_const_iterator it = G_reactingAnswers2E.find(code);
2172 if (it != G_reactingAnswers2E.end()) {
2173 anna::diameter::codec::Message *answer_message = (*it).second;
2175 my_app.getCommunicator()->prepareAnswer(answer_message, message);
2178 G_commMsgSent2e.setBody(answer_message->code());
2179 /* response = NULL =*/clientSession->send(&G_commMsgSent2e);
2181 if (my_app.logEnabled()) my_app.writeLogFile(*answer_message, "sent2e", clientSession->asString());
2182 } catch (anna::RuntimeException &ex) {
2185 if (my_app.logEnabled()) my_app.writeLogFile(*answer_message, "send2eError", clientSession->asString());
2187 } else { // not found: forward to client (if exists)
2188 // Forward to client:
2189 anna::diameter::comm::LocalServer *localServer = my_app.getDiameterLocalServer();
2191 if (localServer && (cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) /* don't forward CER */) {
2193 anna::diameter::comm::Message *msg = G_commMessages.create();
2194 msg->setBody(message);
2195 msg->setRequestClientSessionKey(clientSession->getKey());
2196 bool success = localServer->send(msg);
2199 if (my_app.logEnabled()) {
2200 anna::diameter::comm::ServerSession *usedServerSession = localServer->getLastUsedResource();
2201 std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // esto no deberia ocurrir
2202 my_app.writeLogFile(message, (success ? "fwd2c" : "fwd2cError"), detail);
2204 } catch (anna::RuntimeException &ex) {
2212 void MyDiameterEntity::eventResponse(const anna::diameter::comm::Response &response)
2213 throw(anna::RuntimeException) {
2214 LOGMETHOD(anna::TraceMethod tm("launcher::MyDiameterEntity", "eventResponse", ANNA_FILE_LOCATION));
2215 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2216 CommandLine& cl(anna::CommandLine::instantiate());
2217 anna::diameter::comm::ClassCode::_v code = response.getClassCode();
2218 anna::diameter::comm::Response::ResultCode::_v result = response.getResultCode();
2219 anna::diameter::comm::Message* request = const_cast<anna::diameter::comm::Message*>(response.getRequest());
2220 const anna::DataBlock* message = response.getMessage();
2221 const anna::diameter::comm::ClientSession *clientSession = static_cast<const anna::diameter::comm::ClientSession *>(response.getSession());
2222 bool isBindResponse = (code == anna::diameter::comm::ClassCode::Bind);
2223 bool isApplicationMessage = (code == anna::diameter::comm::ClassCode::ApplicationMessage);
2224 bool contextExpired = (result == anna::diameter::comm::Response::ResultCode::Timeout);
2225 bool isUnavailable = (result == anna::diameter::comm::Response::ResultCode::DiameterUnavailable);
2226 bool isOK = (result == anna::diameter::comm::Response::ResultCode::Success);
2228 anna::diameter::CommandId request_cid = request->getCommandId();
2231 std::string msg = "Response received for original diameter request: ";
2232 msg += anna::diameter::functions::commandIdAsPairString(request_cid);
2233 msg += " | Response: ";
2234 msg += response.asString();
2235 msg += " | DiameterServer: ";
2236 msg += anna::functions::socketLiteralAsString(clientSession->getAddress(), clientSession->getPort());
2237 msg += " | EventTime: ";
2238 msg += anna::time::functions::currentTimeAsString();
2239 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2242 if (isUnavailable) {
2243 //if (isApplicationMessage)
2244 LOGWARNING(anna::Logger::warning("Diameter entity unavailable for Diameter Request", ANNA_FILE_LOCATION));
2247 if (contextExpired) {
2248 //if (isApplicationMessage)
2249 LOGWARNING(anna::Logger::warning("Context Expired for Diameter Request which was sent to the entity", ANNA_FILE_LOCATION));
2251 if (request_cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) { // don't trace CEA
2252 if (my_app.logEnabled()) my_app.writeLogFile(*request, "req2e-expired", clientSession->asString());
2258 std::string msg = "Received response for diameter message: ";
2259 msg += anna::diameter::functions::commandIdAsPairString(request_cid);
2260 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2263 bool alreadyDecodedOnG_codecMsg = false;
2265 if (request_cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) { // don't trace CEA
2266 if (my_app.logEnabled()) {
2267 my_app.writeLogFile(*message, "recvfe", clientSession->asString());
2268 alreadyDecodedOnG_codecMsg = true;
2272 // Forward to client:
2273 anna::diameter::comm::LocalServer *localServer = my_app.getDiameterLocalServer();
2275 if (localServer && (request_cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) /* don't forward CEA */) {
2277 G_commMsgFwd2c.setBody(*message);
2278 bool success = localServer->send(&G_commMsgFwd2c, request->getRequestServerSessionKey());
2279 G_commMessages.release(request);
2281 anna::diameter::comm::ServerSession *usedServerSession = my_app.getMyDiameterEngine()->findServerSession(request->getRequestServerSessionKey());
2282 std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // esto no deberia ocurrir
2284 if (my_app.logEnabled()) {
2285 if (alreadyDecodedOnG_codecMsg)
2286 my_app.writeLogFile(G_codecMsg, (success ? "fwd2c" : "fwd2cError"), detail);
2288 my_app.writeLogFile(*message, (success ? "fwd2c" : "fwd2cError"), detail);
2290 } catch (anna::RuntimeException &ex) {
2296 // Triggering burst:
2297 if (isOK || contextExpired) my_app.sendBurstMessage();
2301 void MyDiameterEntity::eventUnknownResponse(anna::diameter::comm::ClientSession *clientSession, const anna::DataBlock &message)
2302 throw(anna::RuntimeException) {
2303 LOGMETHOD(anna::TraceMethod tm("launcher::MyDiameterEntity", "eventUnknownResponse", ANNA_FILE_LOCATION));
2304 // Performance stats:
2305 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2307 anna::diameter::CommandId cid = anna::diameter::codec::functions::getCommandId(message);
2310 std::string msg = "Out-of-context response received from entity: ";
2311 msg += anna::diameter::functions::commandIdAsPairString(cid);
2312 msg += " | DiameterServer: ";
2313 msg += anna::functions::socketLiteralAsString(clientSession->getAddress(), clientSession->getPort());
2314 msg += " | EventTime: ";
2315 msg += anna::time::functions::currentTimeAsString();
2316 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2320 if (my_app.logEnabled()) my_app.writeLogFile(message, "recvfe-ans-unknown", clientSession->asString());
2326 void MyLocalServer::eventRequest(anna::diameter::comm::ServerSession *serverSession, const anna::DataBlock &message)
2327 throw(anna::RuntimeException) {
2328 LOGMETHOD(anna::TraceMethod tm("launcher::MyLocalServer", "eventRequest", ANNA_FILE_LOCATION));
2329 // Performance stats:
2330 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2331 CommandLine& cl(anna::CommandLine::instantiate());
2333 anna::diameter::CommandId cid = anna::diameter::codec::functions::getCommandId(message);
2336 std::string msg = "Request received: ";
2337 msg += anna::diameter::functions::commandIdAsPairString(cid);
2338 msg += " | DiameterServer: ";
2339 msg += anna::functions::socketLiteralAsString(serverSession->getAddress(), serverSession->getPort());
2340 msg += " | EventTime: ";
2341 msg += anna::time::functions::currentTimeAsString();
2342 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2346 if (my_app.logEnabled()) my_app.writeLogFile(message, "recvfc", serverSession->asString());
2348 // If no answer is programmed and entity is configured, the failed request would be forwarded even being wrong (delegates at the end point)
2349 int code = cid.first;
2350 reacting_answers_const_iterator it = G_reactingAnswers2C.find(code);
2351 bool programmed = (it != G_reactingAnswers2C.end());
2352 anna::diameter::comm::Entity *entity = my_app.getEntity();
2354 if (!programmed && entity) { // forward condition (no programmed answer + entity available)
2355 anna::diameter::comm::Message *msg = G_commMessages.create();
2356 msg->setBody(message);
2357 msg->setRequestServerSessionKey(serverSession->getKey());
2358 bool success = entity->send(msg, cl.exists("balance"));
2361 if (my_app.logEnabled()) {
2362 anna::diameter::comm::Server *usedServer = entity->getLastUsedResource();
2363 anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
2364 std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // esto no deberia ocurrir
2365 my_app.writeLogFile(message, (success ? "fwd2e" : "fwd2eError"), detail); // forwarded
2372 bool analysisOK = true; // by default
2373 anna::diameter::codec::Message *answer_message = NULL;
2375 if (!cl.exists("ignoreErrors")) { // Error analysis
2376 answer_message = (anna::diameter::codec::Message*) & G_codecAnsMsg;
2377 answer_message->clear();
2380 try { G_codecMsg.decode(message, answer_message); } catch (anna::RuntimeException &ex) { ex.trace(); }
2382 answer_message->setStandardToAnswer(G_codecMsg, my_app.getMyDiameterEngine()->getHost(), my_app.getMyDiameterEngine()->getRealm());
2383 analysisOK = (answer_message->getResultCode() == anna::diameter::helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS);
2386 // Programmed answer only when all is ok
2389 answer_message = (*it).second;
2391 my_app.getCommunicator()->prepareAnswer(answer_message, message);
2392 } else return; // nothing done
2395 anna::diameter::codec::Engine *codecEngine = (anna::functions::component <anna::diameter::codec::Engine> (ANNA_FILE_LOCATION));
2396 anna::diameter::codec::Engine::ValidationMode::_v backupVM = codecEngine->getValidationMode();
2399 codecEngine->setValidationMode(anna::diameter::codec::Engine::ValidationMode::Never);
2402 G_commMsgSent2c.setBody(answer_message->code());
2403 /* response = NULL =*/serverSession->send(&G_commMsgSent2c);
2405 if (my_app.logEnabled()) my_app.writeLogFile(*answer_message, "sent2c", serverSession->asString());
2406 } catch (anna::RuntimeException &ex) {
2409 if (my_app.logEnabled()) my_app.writeLogFile(*answer_message, "send2cError", serverSession->asString());
2412 // Restore validation mode
2413 codecEngine->setValidationMode(backupVM);
2416 void MyLocalServer::eventResponse(const anna::diameter::comm::Response &response)
2417 throw(anna::RuntimeException) {
2418 LOGMETHOD(anna::TraceMethod tm("launcher::MyLocalServer", "eventResponse", ANNA_FILE_LOCATION));
2419 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2420 CommandLine& cl(anna::CommandLine::instantiate());
2421 anna::diameter::comm::ClassCode::_v code = response.getClassCode();
2422 anna::diameter::comm::Response::ResultCode::_v result = response.getResultCode();
2423 anna::diameter::comm::Message* request = const_cast<anna::diameter::comm::Message*>(response.getRequest());
2424 const anna::DataBlock* message = response.getMessage();
2425 const anna::diameter::comm::ServerSession *serverSession = static_cast<const anna::diameter::comm::ServerSession *>(response.getSession());
2426 bool isBindResponse = (code == anna::diameter::comm::ClassCode::Bind);
2427 bool isApplicationMessage = (code == anna::diameter::comm::ClassCode::ApplicationMessage);
2428 bool contextExpired = (result == anna::diameter::comm::Response::ResultCode::Timeout);
2429 bool isUnavailable = (result == anna::diameter::comm::Response::ResultCode::DiameterUnavailable);
2430 bool isOK = (result == anna::diameter::comm::Response::ResultCode::Success);
2432 anna::diameter::CommandId request_cid = request->getCommandId();
2435 std::string msg = "Response received for original diameter request: ";
2436 msg += anna::diameter::functions::commandIdAsPairString(request_cid);
2437 msg += " | Response: ";
2438 msg += response.asString();
2439 msg += " | LocalServer: ";
2440 msg += anna::functions::socketLiteralAsString(serverSession->getAddress(), serverSession->getPort());
2441 msg += " | EventTime: ";
2442 msg += anna::time::functions::currentTimeAsString();
2443 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2446 if (isUnavailable) {
2447 //if (isApplicationMessage)
2448 LOGWARNING(anna::Logger::warning("Diameter client unavailable for Diameter Request", ANNA_FILE_LOCATION));
2451 if (contextExpired) {
2452 //if (isApplicationMessage)
2453 LOGWARNING(anna::Logger::warning("Context Expired for Diameter Request which was sent to the client", ANNA_FILE_LOCATION));
2455 if (request_cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) { // don't trace CEA
2456 if (my_app.logEnabled()) my_app.writeLogFile(*request, "req2c-expired", serverSession->asString());
2462 std::string msg = "Received response for diameter message: ";
2463 msg += anna::diameter::functions::commandIdAsPairString(request_cid);
2464 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2468 if (my_app.logEnabled()) my_app.writeLogFile(*message, "recvfc", serverSession->asString());
2470 // This is not very usual, but answers could arrive from clients:
2471 anna::diameter::comm::Entity *entity = my_app.getEntity();
2474 anna::diameter::comm::ClientSession *usedClientSession = my_app.getMyDiameterEngine()->findClientSession(request->getRequestClientSessionKey());
2477 if (my_app.logEnabled()) detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // esto no deberia ocurrir
2480 G_commMsgFwd2e.setBody(*message);
2483 if (usedClientSession) /* response = NULL =*/usedClientSession->send(&G_commMsgFwd2e);
2486 //G_commMsgFwd2e.setRequestClientSessionKey(request->getRequestClientSessionKey());
2487 //bool success = entity->send(G_commMsgFwd2e);
2488 G_commMessages.release(request);
2490 if (my_app.logEnabled()) my_app.writeLogFile(*message, "fwd2e", detail); // forwarded
2491 } catch (anna::RuntimeException &ex) {
2494 if (my_app.logEnabled()) my_app.writeLogFile(*message, "fwd2eError", detail); // forwarded
2500 void MyLocalServer::eventUnknownResponse(anna::diameter::comm::ServerSession *serverSession, const anna::DataBlock &message)
2501 throw(anna::RuntimeException) {
2502 LOGMETHOD(anna::TraceMethod tm("launcher::MyLocalServer", "eventUnknownResponse", ANNA_FILE_LOCATION));
2503 // Performance stats:
2504 Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
2506 anna::diameter::CommandId cid = anna::diameter::codec::functions::getCommandId(message);
2509 std::string msg = "Out-of-context response received from client: ";
2510 msg += anna::diameter::functions::commandIdAsPairString(cid);
2511 msg += " | DiameterServer: ";
2512 msg += anna::functions::socketLiteralAsString(serverSession->getAddress(), serverSession->getPort());
2513 msg += " | EventTime: ";
2514 msg += anna::time::functions::currentTimeAsString();
2515 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
2518 if (my_app.logEnabled()) my_app.writeLogFile(message, "recvfc-ans-unknown", serverSession->asString());
2522 anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const
2524 anna::xml::Node* result = parent->createChild("launcher");
2525 anna::comm::Application::asXML(result);
2527 result->createAttribute("StartTime", a_start_time.asString());
2528 result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000);
2530 (anna::functions::component <anna::diameter::codec::Engine> (ANNA_FILE_LOCATION))->asXML(result);
2532 anna::diameter::comm::OamModule::instantiate().asXML(result);
2533 anna::diameter::codec::OamModule::instantiate().asXML(result);
2535 anna::statistics::Engine::instantiate().asXML(result);