X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=example%2Fdiameter%2Flauncher%2FLauncher.cpp;h=94d8f66f52e5c12e52c4c4f9d0694b0f3e8102ee;hb=5406b19bdbfe101b264f8c4d878392e2916b8f9d;hp=afb8a96016877ab0eabf5ab41d2ca15271d9c286;hpb=84c30c372cf2926a138a6d51a52d56f3b2a63804;p=anna.git diff --git a/example/diameter/launcher/Launcher.cpp b/example/diameter/launcher/Launcher.cpp index afb8a96..94d8f66 100644 --- a/example/diameter/launcher/Launcher.cpp +++ b/example/diameter/launcher/Launcher.cpp @@ -6,268 +6,583 @@ // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE // +// Standard +#include // std::istringstream +#include // std::cout +#include // ceil +#include +#include // chdir +//#include TODO: use this from gcc4.9.0: http://stackoverflow.com/questions/8060025/is-this-c11-regex-error-me-or-the-compiler +#include + // Project +#include #include +#include #include +#include #include #include #include -#include #include #include +#include +#include +#include +#include +#include // Process -#include "Launcher.hpp" - +#include +#include +#include +#include + + +#define SIGUSR2_TASKS_INPUT_FILENAME "sigusr2.in" +#define SIGUSR2_TASKS_OUTPUT_FILENAME "sigusr2.out" + + +const char *ServicesDTD = "\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +"; -#define SIGUSR2_TASKS_INPUT_FILENAME "./sigusr2.tasks.input" -#define SIGUSR2_TASKS_OUTPUT_FILENAME "./sigusr2.tasks.output" -#define DIAMETER_CODEC_ENGINE_NAME_PREFIX "MyCodecEngine" Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) { - a_myDiameterEngine = new MyDiameterEngine(); - a_myDiameterEngine->setRealm("ADL.ericsson.com"); - a_myDiameterEngine->setAutoBind(false); // allow to create client-sessions without binding them, in order to set timeouts. - a_logFile = "launcher.log"; - a_burstLogFile = "launcher.burst"; - a_splitLog = false; - a_detailedLog = false; - a_dumpLog = false; a_timeEngine = NULL; a_counterRecorder = NULL; + a_admlMinResolution = 2 * anna::timex::Engine::minResolution; // 2*10 = 20 ms; 1000/20 = 50 ticks per second; + //a_admlMinResolution = (anna::Millisecond)100; a_counterRecorderClock = NULL; - a_entity = NULL; - a_diameterLocalServer = NULL; - a_cerPathfile = "cer.xml"; - a_dwrPathfile = "dwr.xml"; - // Burst - a_burstCycle = 1; - a_burstRepeat = false; - a_burstActive = false; - a_burstLoadIndx = 0; - a_burstDeliveryIt = a_burstMessages.begin(); - a_otaRequest = 0; - a_burstPopCounter = 0; + + a_workingNode = NULL; + + a_httpServerSocket = NULL; } -anna::diameter::comm::Message *Launcher::createCommMessage() throw(anna::RuntimeException) { - return a_commMessages.create(); + +std::string Launcher::getSignalUSR2InputFile() const throw() { + return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_INPUT_FILENAME); } -void Launcher::releaseCommMessage(anna::diameter::comm::Message *msg) throw() { - a_commMessages.release(msg); +std::string Launcher::getSignalUSR2OutputFile() const throw() { + return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_OUTPUT_FILENAME); } -void Launcher::baseProtocolSetupAsClient() throw(anna::RuntimeException) { - - anna::diameter::codec::Engine *codecEngine; - - codecEngine = getCodecEngine(); - // XXXXXXXXXXXXXXXXXXXX codecEngine = a_myDiameterEngine->getBaseProtocolCodecEngine(); - - - // Build CER - // ::= < Diameter Header: 257, REQ > - // { Origin-Host } 264 diameterIdentity - // { Origin-Realm } 296 idem - // 1* { Host-IP-Address } 257, address - // { Vendor-Id } 266 Unsigned32 - // { Product-Name } 269 UTF8String - // [Origin-State-Id] 278 Unsigned32 - // * [ Supported-Vendor-Id ] 265 Unsigned32 - // * [ Auth-Application-Id ] 258 Unsigned32 - // * [Acct-Application-Id] 259 Unsigned32 - anna::diameter::codec::Message diameterCER(codecEngine); - int applicationId = 0 /*anna::diameter::helpers::APPID__3GPP_Rx*/; // Unsigned32 - std::string OH = a_myDiameterEngine->getHost(); - std::string OR = a_myDiameterEngine->getRealm(); - std::string hostIP = anna::functions::getHostnameIP(); // Address - int vendorId = anna::diameter::helpers::VENDORID__tgpp; // Unsigned32 - std::string productName = "ANNA Diameter Launcher"; // UTF8String - bool loadingError = false; - try { - diameterCER.loadXML(a_cerPathfile); - } catch(anna::RuntimeException &ex) { - //ex.trace(); - loadingError = true; - } +void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOperation) throw(anna::RuntimeException) { - if(loadingError) { - LOGWARNING(anna::Logger::warning("CER file not found. Get harcoded.", ANNA_FILE_LOCATION)); - diameterCER.setId(anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request); - diameterCER.setApplicationId(applicationId); - diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH); - diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR); - 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|" - diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Vendor_Id)->getUnsigned32()->setValue(vendorId); - diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Product_Name)->getUTF8String()->setValue(productName); - diameterCER.addAvp(anna::diameter::helpers::base::AVPID__Auth_Application_Id)->getUnsigned32()->setValue(applicationId); - } + CommandLine& cl(anna::CommandLine::instantiate()); + bool allLogsDisabled = cl.exists("disableLogs"); - // Build DWR - // ::= < Diameter Header: 280, REQ > - // { Origin-Host } - // { Origin-Realm } - anna::diameter::codec::Message diameterDWR(codecEngine); - loadingError = false; + // + const anna::xml::Attribute *id, *dictionary; - try { - diameterDWR.loadXML(a_dwrPathfile); - } catch(anna::RuntimeException &ex) { - //ex.trace(); - loadingError = true; - } + // + const anna::xml::Attribute *originHost, *appId, *originRealm, *cer, *dwr, *cea, *allowedInactivityTime, *tcpConnectDelay, + *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions, + *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection, + *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog; + // Never clear services content from here (append new data from xml). At the moment no node removing is implemented in this process - if(loadingError) { - LOGWARNING(anna::Logger::warning("DWR file not found. Get harcoded.", ANNA_FILE_LOCATION)); - diameterDWR.setId(anna::diameter::helpers::base::COMMANDID__Device_Watchdog_Request); - diameterDWR.setApplicationId(applicationId); - diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(OH); - diameterDWR.addAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(OR); - } + // Stacks + anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate(); + anna::diameter::stack::Dictionary *d; + const anna::diameter::stack::Dictionary *bpd = NULL; // base protocol dictionary - // Assignment for CER/DWR and CEA/DWA: - a_myDiameterEngine->setCERandDWR(diameterCER.code(), diameterDWR.code()); - //a_myDiameterEngine->setCEAandDWA(diameterCEA.code(), diameterDWA.code()); -} + // Codec engine manager: + anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate(); + anna::diameter::codec::Engine *ce; + + /////////////////////////////////////////// + // APPLICATION MESSAGE OAM MODULE SCOPES // + /////////////////////////////////////////// + // We will register a scope per stack id registered. The counters will be dynamically registered at count method. + anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate(); + appMsgOamModule.enableCounters(); // this special module is disabled by default (the only) + static int scope_id = 3; + unsigned int id_value; + std::string codecEngineName; + + for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) { + std::string nodeName = (*it)->getName(); + + if(nodeName == "stack") { + // Input data: + id = (*it)->getAttribute("id"); + dictionary = (*it)->getAttribute("dictionary"); + id_value = id->getIntegerValue(); + + if (stackEngine.getDictionary(id_value)) { // Ignore (but don't fail) dictionary load with same stack id already registered + LOGWARNING(anna::Logger::warning(anna::functions::asString("Ignore dictionary load for stack id already registered: %llu", id_value), ANNA_FILE_LOCATION)); + continue; + } -void Launcher::writeLogFile(const anna::DataBlock & db, const std::string &logExtension, const std::string &detail, anna::diameter::codec::Engine *codecEngine) const throw() { -// if (!logEnabled()) return; - anna::diameter::codec::Message codecMsg(codecEngine); - try { codecMsg.decode(db); } catch(anna::RuntimeException &ex) { ex.trace(); } - writeLogFile(codecMsg, logExtension, detail); + try { + d = stackEngine.createDictionary(id_value, dictionary->getValue()); + LOGDEBUG(anna::Logger::debug(anna::functions::asString("Created dictionary (%p) for stack id %llu", d, id_value), ANNA_FILE_LOCATION)); -} + // OAM module for counters: + appMsgOamModule.createStackCounterScope(scope_id, id_value /* application-id */); + scope_id++; -// Si ya lo tengo decodificado: -void Launcher::writeLogFile(const anna::diameter::codec::Message & decodedMessage, const std::string &logExtension, const std::string &detail) const throw() { -// if (!logEnabled()) return; - // Open target file: - std::string targetFile = a_logFile; + } catch(anna::RuntimeException &ex) { + //_exit(ex.asString()); + throw ex; + } - if(a_splitLog) { - targetFile += "."; - targetFile += logExtension; + bpd = d; // base protocol dictionary in case of monostack. If multistack, will be calculated later + + // Create codec engine and register it in the codec engine manager: + codecEngineName = anna::functions::asString("CodecEngineForStackId_%llu", id_value); + ce = new anna::diameter::codec::Engine(codecEngineName.c_str(), d); + em.registerCodecEngine(id_value, ce); + + // Codec engine configuration: + const anna::xml::Attribute *vm_attr = (*it)->getAttribute("validationMode", false /* no exception */); + const anna::xml::Attribute *vd_attr = (*it)->getAttribute("validationDepth", false /* no exception */); + const anna::xml::Attribute *fm_attr = (*it)->getAttribute("fixMode", false /* no exception */); + const anna::xml::Attribute *if_attr = (*it)->getAttribute("ignoreFlagsOnValidation", false /* no exception */); + + std::string vm_value = vm_attr ? vm_attr->getValue() : "AfterDecoding"; + std::string vd_value = vd_attr ? vd_attr->getValue() : "FirstError"; + std::string fm_value = fm_attr ? fm_attr->getValue() : "BeforeEncoding"; + + anna::diameter::codec::Engine::ValidationMode::_v vm; + if (vm_value == "BeforeEncoding") vm = anna::diameter::codec::Engine::ValidationMode::BeforeEncoding; + else if (vm_value == "AfterDecoding") vm = anna::diameter::codec::Engine::ValidationMode::AfterDecoding; + else if (vm_value == "Always") vm = anna::diameter::codec::Engine::ValidationMode::Always; + else if (vm_value == "Never") vm = anna::diameter::codec::Engine::ValidationMode::Never; + ce->setValidationMode(vm); + + anna::diameter::codec::Engine::ValidationDepth::_v vd; + if (vd_value == "Complete") vd = anna::diameter::codec::Engine::ValidationDepth::Complete; + else if (vd_value == "FirstError") vd = anna::diameter::codec::Engine::ValidationDepth::FirstError; + ce->setValidationDepth(vd); + + anna::diameter::codec::Engine::FixMode::_v fm; + if (fm_value == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding; + else if (fm_value == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding; + else if (fm_value == "Always") fm = anna::diameter::codec::Engine::FixMode::Always; + else if (fm_value == "Never") fm = anna::diameter::codec::Engine::FixMode::Never; + ce->setFixMode(fm); + + bool if_value = (if_attr ? (if_attr->getValue() == "yes") : false); + ce->ignoreFlagsOnValidation(if_value); + } } - std::ofstream out(targetFile.c_str(), std::ifstream::out | std::ifstream::app); - // Set text to dump: - std::string title = "["; - title += logExtension; - title += "]"; - // Build complete log: - std::string log = "\n"; - std::string xml = decodedMessage.asXMLString(); - - - if(a_detailedLog) { - anna::time::Date now; - now.setNow(); - title += " "; - title += now.asString(); - log += anna::functions::highlight(title, anna::functions::TextHighlightMode::OverAndUnderline); - log += xml; - log += "\n"; - log += anna::functions::highlight("Used resource"); - log += detail; - log += "\n"; - } else { - log += title; - log += "\n"; - log += xml; - log += "\n"; + // Show loaded stacks: + std::cout << "Stacks currently loaded:" << std::endl; + std::cout << anna::functions::tab(stackEngine.asString(false /* light */)) << std::endl; + + // Basic checking for multistack: + bool multistack = (stackEngine.stack_size() > 1); + if (multistack) { + bpd = stackEngine.getDictionary(0); + if(!bpd) + throw anna::RuntimeException("In multistack applications is mandatory register a stack id = 0 using a dictionary which contains the needed elements to build base protocol messages (CER/A, DWR/A, DPR/A, STR/A, etc.)", ANNA_FILE_LOCATION); } - if(a_dumpLog) { - std::string name = anna::functions::asString(decodedMessage.getHopByHop()); - name += "."; - name += anna::functions::asString(decodedMessage.getEndToEnd()); - name += "."; - name += anna::functions::asString(decodedMessage.getId().first); - name += "."; - name += ((decodedMessage.getId().second) ? "request.":"answer."); - name += logExtension; - name += ".xml"; - std::ofstream outMsg(name.c_str(), std::ifstream::out | std::ifstream::app); - outMsg.write(xml.c_str(), xml.size()); - outMsg.close(); + // REALMS: + for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) { + std::string nodeName = (*it)->getName(); + + if(nodeName == "node") { + // Input data: + originHost = (*it)->getAttribute("originHost"); + appId = (*it)->getAttribute("applicationId"); + originRealm = (*it)->getAttribute("originRealm", false /* no exception */); + cer = (*it)->getAttribute("cer", false /* no exception */); + dwr = (*it)->getAttribute("dwr", false /* no exception */); + cea = (*it)->getAttribute("cea", false /* no exception */); + allowedInactivityTime = (*it)->getAttribute("allowedInactivityTime", false /* no exception */); + tcpConnectDelay = (*it)->getAttribute("tcpConnectDelay", false /* no exception */); + answersTimeout = (*it)->getAttribute("answersTimeout", false /* no exception */); + ceaTimeout = (*it)->getAttribute("ceaTimeout", false /* no exception */); + watchdogPeriod = (*it)->getAttribute("watchdogPeriod", false /* no exception */); + entity = (*it)->getAttribute("entity", false /* no exception */); + entityServerSessions = (*it)->getAttribute("entityServerSessions", false /* no exception */); + diameterServer = (*it)->getAttribute("diameterServer", false /* no exception */); + diameterServerSessions = (*it)->getAttribute("diameterServerSessions", false /* no exception */); + balance = (*it)->getAttribute("balance", false /* no exception */); // (yes | no) + sessionBasedModelsClientSocketSelection = (*it)->getAttribute("sessionBasedModelsClientSocketSelection", false /* no exception */); // (SessionIdHighPart | SessionIdOptionalPart | RoundRobin) + retries = (*it)->getAttribute("retries", false /* no exception */); + log = (*it)->getAttribute("log", false /* no exception */); + splitLog = (*it)->getAttribute("splitLog", false /* no exception */); // (yes | no) + detailedLog = (*it)->getAttribute("detailedLog", false /* no exception */); // (yes | no) + dumpLog = (*it)->getAttribute("dumpLog", false /* no exception */); // (yes | no) + burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no) + + // Basic checkings: + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *oh = ohm.getOriginHost(originHost->getValue()); + if (oh) { + std::string msg = "Already registered such Origin-Host: "; msg += originHost->getValue(); + throw anna::RuntimeException(msg, ANNA_FILE_LOCATION); + } + + unsigned int applicationId = appId->getIntegerValue(); + if (!stackEngine.getDictionary(applicationId)) { + std::string msg = "Cannot found a registered stack id with the value of applicationId provided: "; msg += appId->getValue(); + throw anna::RuntimeException(msg, ANNA_FILE_LOCATION); + } + + // Engine time measures checking & assignment: + anna::Millisecond allowedInactivityTimeMs(90000); + anna::Millisecond tcpConnectDelayMs(200); + anna::Millisecond answersTimeoutMs(10000); + anna::Millisecond ceaTimeoutMs(10000); + anna::Millisecond watchdogPeriodMs(30000); + + if (allowedInactivityTime) allowedInactivityTimeMs = checkTimeMeasure("allowedInactivityTime", allowedInactivityTime->getValue()); + if (tcpConnectDelay) tcpConnectDelayMs = checkTimeMeasure("tcpConnectDelay", tcpConnectDelay->getValue()); + if (answersTimeout) answersTimeoutMs = checkTimeMeasure("answersTimeout", answersTimeout->getValue()); + if (ceaTimeout) ceaTimeoutMs = checkTimeMeasure("ceaTimeout", ceaTimeout->getValue()); + if (watchdogPeriod) watchdogPeriodMs = checkTimeMeasure("watchdogPeriod", watchdogPeriod->getValue()); + + // Checking command line parameters + std::string sessionBasedModelsType; + anna::diameter::comm::Entity::SessionBasedModelsType::_v sessionBasedModelsTypeEnum; + if(sessionBasedModelsClientSocketSelection) { + sessionBasedModelsType = sessionBasedModelsClientSocketSelection->getValue(); + if (sessionBasedModelsType == "RoundRobin") { + sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::RoundRobin; + } + else if (sessionBasedModelsType == "SessionIdOptionalPart") { + sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdOptionalPart; + } + else if (sessionBasedModelsType == "SessionIdHighPart") { + sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdHighPart; + } + else if (sessionBasedModelsType == "SessionIdLowPart") { + sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdLowPart; + } + else { + throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdLowPart'/'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION); + } + } + + int retransmissions = retries ? retries->getIntegerValue() : 0; + if(retransmissions < 0) { + throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION); + } + + ///////////////////////////////////////////////////////////////////////////////////////////// + // Diameter communication engine: + std::string commEngineName = originHost->getValue() + "_DiameterCommEngine"; + MyDiameterEngine *commEngine = new MyDiameterEngine(commEngineName.c_str(), bpd); + commEngine->setAutoBind(false); // allow to create client-sessions without binding them, in order to set timeouts. + commEngine->setMaxConnectionDelay(tcpConnectDelayMs); + commEngine->setWatchdogPeriod(watchdogPeriodMs); + commEngine->setOriginHostName(originHost->getValue()); + if (originRealm) commEngine->setOriginRealmName(originRealm->getValue()); + + // Origin host node: + a_workingNode = new anna::diameter::comm::OriginHost((anna::diameter::comm::Engine*)commEngine, applicationId); + a_workingNode->setRequestRetransmissions(retransmissions); + ///////////////////////////////////////////////////////////////////////////////////////////// + + + // Diameter entity: + if(entity) { + int sessions = entityServerSessions ? entityServerSessions->getIntegerValue() : 1; + + if(sessions > 0) { + // Number of sessions: + commEngine->setNumberOfClientSessionsPerServer(sessions); + + // Client CER and DWR + std::string cerPathfile = cer ? cer->getValue() : ""; + std::string dwrPathfile = dwr ? dwr->getValue() : ""; + commEngine->setClientCERandDWR(cerPathfile, dwrPathfile); + + // Register one entity for this engine: + a_workingNode->createEntity(entity->getValue(), ceaTimeoutMs, answersTimeoutMs); + a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsTypeEnum); + a_workingNode->getEntity()->setBalance(balance ? (balance->getValue() == "yes") : false); // for sendings + if (eventOperation) a_workingNode->getEntity()->bind(); + } + } + + // Diameter Server: + if(diameterServer) { + // Server CEA + std::string ceaPathfile = cea ? cea->getValue() : ""; + + int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1; + a_workingNode->createDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile); + } + + // Logs: + if (!allLogsDisabled) { + std::string host = commEngine->getOriginHostName(); + std::string s_log = host + ".launcher.log"; if (log) s_log = log->getValue(); + bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false); + bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false); + bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false); + std::string s_burstLog = host + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue(); + a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog); + } + + + // Lazy initialization for comm engine: + if (eventOperation) commEngine->lazyInitialize(); + + // Node and Codec Engine registration /////////////////////////////////////////////////////// + ohm.registerOriginHost(originHost->getValue(), a_workingNode); + ///////////////////////////////////////////////////////////////////////////////////////////// + } } - // Write and close - out.write(log.c_str(), log.size()); - out.close(); -} + if (!uniqueOriginHost()) + a_workingNode = NULL; // by default, mode auto -void Launcher::writeBurstLogFile(const std::string &buffer) throw() { - std::ofstream out(a_burstLogFile.c_str(), std::ifstream::out | std::ifstream::app); - out.write(buffer.c_str(), buffer.size()); - out.close(); // close() will be called when the object is destructed (i.e., when it goes out of scope). - // you'd call close() only if you indeed for some reason wanted to close the filestream - // earlier than it goes out of scope. + // Diameter comm engines which are loaded after application start (via management operation 'services') are not really started, + // but this don't care because application startComponents() -> initialize() -> do_initialize() -> do nothing. + // And when stopped, running state is not checked and it will be stopped anyway. } -void Launcher::checkTimeMeasure(const char * commandLineParameter, bool optional) throw(anna::RuntimeException) { - CommandLine& cl(anna::CommandLine::instantiate()); - if(!cl.exists(commandLineParameter) && optional) return; // start error if mandatory +void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation) throw(anna::RuntimeException) { - std::string parameter = cl.getValue(commandLineParameter); + if (xmlPathFile == "null" || xmlPathFile == "") { + LOGWARNING(anna::Logger::warning("Ignoring services configuration on start: empty or 'null' string provided as xml file. Use management interface (operation 'services') in order to add services", ANNA_FILE_LOCATION)); + return; + } + + LOGDEBUG( + std::string trace = "Loading ADML services file '"; + trace += xmlPathFile; + trace += "'"; + anna::Logger::debug(trace, ANNA_FILE_LOCATION); + ); + anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy) + anna::xml::DTDMemory xmlDTD; + const anna::xml::Node *rootNode; + xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error + xmlDTD.initialize(ServicesDTD); + try { + rootNode = xmlDocument.parse(xmlDTD); // Parsing: fail here if xml violates dtd + } + catch (anna::RuntimeException &ex) { + LOGWARNING( + std::string msg = "Services DTD schema:\n\n"; + msg += ServicesDTD; + anna::Logger::warning(msg, ANNA_FILE_LOCATION); + ); + throw ex; + } - if(anna::functions::isLike("^[0-9]+$", parameter)) { // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$ - int msecs = cl.getIntegerValue(commandLineParameter); + LOGDEBUG( + std::string trace = "Loaded XML file ("; + trace += xmlPathFile; + trace += "):\n"; + trace += anna::xml::Compiler().apply(rootNode); + anna::Logger::debug(trace, ANNA_FILE_LOCATION); + ); + servicesFromXML(rootNode, eventOperation); +} + + +anna::Millisecond Launcher::checkTimeMeasure(const std::string ¶meter, const std::string &value) throw(anna::RuntimeException) { + + if(anna::functions::isLike("^[0-9]+$", value)) { // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$ + int msecs; + std::istringstream ( value ) >> msecs; if(msecs > a_timeEngine->getMaxTimeout()) { // 600000 ms - std::string msg = "Commandline parameter '"; - msg += commandLineParameter; - msg += "' is greater than allowed max timeout for timming engine: "; + std::string msg = "Configuration value for '"; + msg += parameter; + msg += "' ("; msg += value; msg += " msecs) is greater than allowed max timeout for timming engine: "; msg += anna::functions::asString(a_timeEngine->getMaxTimeout()); throw RuntimeException(msg, ANNA_FILE_LOCATION); } if(msecs > 300000) { - std::string msg = "Commandline parameter '"; - msg += commandLineParameter; - msg += "' is perhaps very big (over 5 minutes). Take into account memory consumption issues."; + std::string msg = "Configuration value for '"; + msg += parameter; + msg += "' ("; msg += value; msg += " msecs) is perhaps very big (over 5 minutes)."; LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); } if(msecs <= a_timeEngine->getResolution()) { - std::string msg = "Commandline parameter '"; - msg += commandLineParameter; - msg += "' (and in general, all time measures) must be greater than timming engine resolution: "; + std::string msg = "Configuration value for '"; + msg += parameter; + msg += "' ("; msg += value; msg += " msecs) as any other time measure, must be greater than timming engine resolution: "; msg += anna::functions::asString(a_timeEngine->getResolution()); throw RuntimeException(msg, ANNA_FILE_LOCATION); } - return; // ok + return (anna::Millisecond)msecs; // ok } - // Excepcion (por no ser entero): - std::string msg = "Error at commandline parameter '"; - msg += commandLineParameter; - msg += "' = '"; + // Non-integer exception: + std::string msg = "Configuration error for '"; msg += parameter; + msg += "' = '"; + msg += value; msg += "': must be a non-negative integer number"; throw RuntimeException(msg, ANNA_FILE_LOCATION); } -void Launcher::startDiameterServer(int diameterServerSessions) throw(anna::RuntimeException) { - if(diameterServerSessions <= 0) return; +bool Launcher::setWorkingNode(const std::string &name) throw() { + bool result = false; - std::string address; - int port; - CommandLine& cl(anna::CommandLine::instantiate()); - anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("diameterServer"), address, port); - //ServerSocket *createServerSocket(const std::string & addr, int port = Session::DefaultPort, int maxConnections = -1, int category = 1, const std::string & description = "") - a_diameterLocalServer = (MyLocalServer*)(a_myDiameterEngine->createLocalServer(address, port, diameterServerSessions)); - a_diameterLocalServer->setDescription("Launcher diameter local server"); - a_diameterLocalServer->setCodecEngine(getCodecEngine()); // this is for automatic answers (failed-avp) XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX el del nodo correspondiente - int allowedInactivityTime = 90000; // ms + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *oh = ohm.getOriginHost(name); - if(cl.exists("allowedInactivityTime")) allowedInactivityTime = cl.getIntegerValue("allowedInactivityTime"); + if (oh) { + a_workingNode = const_cast(oh); + result = true; + } + + return result; +} + +anna::diameter::comm::OriginHost *Launcher::getOriginHost(const std::string &name) const throw(anna::RuntimeException) { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *result = ohm.getOriginHost(name); + + if (!result) + throw anna::RuntimeException(anna::functions::asString("There is no origin host registered as '%s' (set Origin-Host avp correctly or force a specific host with 'node' operation)", name.c_str()), ANNA_FILE_LOCATION); + + return result; +} + +anna::diameter::comm::OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) { + std::string originHost = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->getValue(); + return (getOriginHost(originHost)); +} + +bool Launcher::uniqueOriginHost() const throw() { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + return (ohm.size() == 1); +} + + +void Launcher::updateOperatedOriginHostWithMessage(const anna::diameter::codec::Message &message) throw(anna::RuntimeException) { + if (!a_operatedHost) // priority for working node by mean 'node' operation + a_operatedHost = getOriginHost(message); +} - a_diameterLocalServer->setAllowedInactivityTime((anna::Millisecond)allowedInactivityTime); +anna::diameter::comm::OriginHost *Launcher::getWorkingNode() const throw(anna::RuntimeException) { + if(!a_workingNode) + throw anna::RuntimeException("Working node not identified (try to load services)", ANNA_FILE_LOCATION); + + return a_workingNode; +} + +anna::diameter::comm::OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) { + if(!a_operatedHost) + throw anna::RuntimeException("Node not identified (try to force a specific Origin-Host with 'node' operation)", ANNA_FILE_LOCATION); + + return a_operatedHost; +} + +MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) { + MyDiameterEntity *result = (MyDiameterEntity *)(getOperatedHost()->getEntity()); + if (!result) + throw anna::RuntimeException("No entity configured for the operated node", ANNA_FILE_LOCATION); + return result; +} + +MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) { + MyLocalServer *result = (MyLocalServer *)(getOperatedHost()->getDiameterServer()); + if (!result) + throw anna::RuntimeException("No local server configured for the operated node", ANNA_FILE_LOCATION); + return result; +} + +MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) { + return (MyDiameterEngine *)getOperatedHost()->getCommEngine(); // never will be NULL } void Launcher::initialize() @@ -275,55 +590,65 @@ throw(anna::RuntimeException) { anna::comm::Application::initialize(); CommandLine& cl(anna::CommandLine::instantiate()); anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single); -// if (cl.exists ("clone")) -// workMode = anna::comm::Communicator::WorkMode::Clone; a_communicator = new MyCommunicator(workMode); - a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, (anna::Millisecond)150); - // Counters record procedure: - anna::Millisecond cntRecordPeriod = (anna::Millisecond)300000; // ms + a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, a_admlMinResolution); + anna::testing::TestManager::instantiate().setTimerController(a_timeEngine); - if(cl.exists("cntRecordPeriod")) cntRecordPeriod = cl.getIntegerValue("cntRecordPeriod"); + // Counters record procedure: + const char *varname = "cntRecordPeriod"; + anna::Millisecond cntRecordPeriod; + try { + cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000; + } + catch(anna::RuntimeException &ex) { + if (cntRecordPeriod != 0) throw ex; + } if(cntRecordPeriod != 0) { - checkTimeMeasure("cntRecordPeriod"); a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock std::string cntDir = "."; - if(cl.exists("cntDir")) cntDir = cl.getValue("cntDir"); - a_counterRecorder = new MyCounterRecorder(cntDir + anna::functions::asString("/Counters.Pid%d", (int)getPid())); } + + // Testing framework: + std::string tmDir = "."; + if(cl.exists("tmDir")) tmDir = cl.getValue("tmDir"); + anna::testing::TestManager::instantiate().setReportsDirectory(tmDir); + + // Tracing: + if(cl.exists("trace")) + anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace"))); + + // Load launcher services: + loadServices(cl.getValue("services")); // before run (have components to be created) } void Launcher::run() throw(anna::RuntimeException) { LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION)); CommandLine& cl(anna::CommandLine::instantiate()); + anna::diameter::stack::Engine::instantiate(); + // Start time: a_start_time.setNow(); - // Statistics: - anna::statistics::Engine::instantiate().enable(); - // Checking command line parameters - if(cl.exists("sessionBasedModelsClientSocketSelection")) { - std::string type = cl.getValue("sessionBasedModelsClientSocketSelection"); + // Initial working directory: + char cwd[1024]; + if (getcwd(cwd, sizeof(cwd)) == NULL) + throw anna::RuntimeException("Cannot retrieve initial working directory !!", ANNA_FILE_LOCATION); + a_initialWorkingDirectory = cwd; - if((type != "SessionIdHighPart") && (type != "SessionIdOptionalPart") && (type != "RoundRobin")) { - throw anna::RuntimeException("Commandline option '-sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION); - } - } - - // Tracing: - if(cl.exists("trace")) - anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace"))); + // Statistics: + anna::statistics::Engine::instantiate().enable(); LOGINFORMATION( - // Help on startup traces: - anna::Logger::information(help(), ANNA_FILE_LOCATION); - // Test messages dtd: - std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n"; - msg += anna::diameter::codec::MessageDTD; - anna::Logger::information(msg, ANNA_FILE_LOCATION); + // Help on startup traces: + anna::Logger::information(help(), ANNA_FILE_LOCATION); + // Test messages dtd: + std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n"; + msg += anna::diameter::codec::MessageDTD; + anna::Logger::information(msg, ANNA_FILE_LOCATION); ); // HTTP Server: @@ -337,40 +662,6 @@ throw(anna::RuntimeException) { a_httpServerSocket = new anna::comm::ServerSocket(anna::comm::INetAddress(device, port), cl.exists("httpServerShared") /* shared bind */, &anna::http::Transport::getFactory()); } - // Stack: - a_codecEngine = new anna::diameter::codec::Engine(DIAMETER_CODEC_ENGINE_NAME_PREFIX); - anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate(); - anna::diameter::stack::Dictionary * d = stackEngine.createDictionary(0 /* stack id; its value don't mind, is not used (ADL is monostack) */); - // Analyze comma-separated list: - anna::Tokenizer lst; - std::string dictionaryParameter = cl.getValue("dictionary"); - lst.apply(dictionaryParameter, ","); - - if(lst.size() >= 1) { // always true (at least one, because --dictionary is mandatory) - anna::Tokenizer::const_iterator tok_min(lst.begin()); - anna::Tokenizer::const_iterator tok_max(lst.end()); - anna::Tokenizer::const_iterator tok_iter; - std::string pathFile; - d->allowUpdates(); - - for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) { - pathFile = anna::Tokenizer::data(tok_iter); - d->load(pathFile); - } - } - - getCodecEngine()->setDictionary(d); // XXXX esto cambiara... - LOGDEBUG(anna::Logger::debug(getCodecEngine()->asString(), ANNA_FILE_LOCATION)); - - if(lst.size() > 1) { - std::string all_in_one = "./dictionary-all-in-one.xml"; - std::ofstream out(all_in_one.c_str(), std::ifstream::out); - std::string buffer = d->asXMLString(); - out.write(buffer.c_str(), buffer.size()); - out.close(); - std::cout << "Written accumulated '" << all_in_one << "' (provide it next time to be more comfortable)." << std::endl; - } - /////////////////////////////// // Diameter library COUNTERS // /////////////////////////////// @@ -451,9 +742,12 @@ throw(anna::RuntimeException) { oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentExpired, "", 55); oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionExpired, "", 56); oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionExpired, "", 57); - oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown, "", 58); - oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown, "", 59); - oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown, "", 60); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmitted, "", 58); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnClientSession, "", 59); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnServerSession, "", 60); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown, "", 61); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown, "", 62); + oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown, "", 63); ////////////////// // CODEC MODULE // ////////////////// @@ -479,17 +773,6 @@ throw(anna::RuntimeException) { oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded, "", 17 /*2017*/); oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem, "", 18 /*2018*/); oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified, "", 19 /*2019*/); - /////////////////////////////////////////// - // APPLICATION MESSAGE OAM MODULE SCOPES // - /////////////////////////////////////////// - // We will register a scope per stack id registered. The counters will be dynamically registered at count method. - anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate(); - int scope_id = 3; - for (anna::diameter::stack::Engine::const_stack_iterator it = stackEngine.stack_begin(); it != stackEngine.stack_end(); it++) { - appMsgOamModule.createStackCounterScope(scope_id, it->first); - scope_id++; - } - appMsgOamModule.enableCounters(); // this special module is disabled by default (the only) ///////////////////////////////// @@ -498,143 +781,35 @@ throw(anna::RuntimeException) { if(a_counterRecorderClock) { oamDiameterComm.setCounterRecorder(a_counterRecorder); oamDiameterCodec.setCounterRecorder(a_counterRecorder); - appMsgOamModule.setCounterRecorder(a_counterRecorder); + anna::diameter::comm::ApplicationMessageOamModule::instantiate().setCounterRecorder(a_counterRecorder); a_timeEngine->activate(a_counterRecorderClock); // start clock } - - // Integration (validation 'Complete' for receiving messages) and debugging (validation also before encoding: 'Always'). - // If missing 'integrationAndDebugging', default behaviour at engine is: mode 'AfterDecoding', depth 'FirstError': - if(cl.exists("integrationAndDebugging")) { - getCodecEngine()->setValidationMode(anna::diameter::codec::Engine::ValidationMode::Always); // XXXXXXXXXXXXXXXXXXXXXXXXX - getCodecEngine()->setValidationDepth(anna::diameter::codec::Engine::ValidationDepth::Complete); - } - - // Fix mode - if(cl.exists("fixMode")) { // BeforeEncoding(default), AfterDecoding, Always, Never - std::string fixMode = cl.getValue("fixMode"); - anna::diameter::codec::Engine::FixMode::_v fm; - if (fixMode == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding; - else if (fixMode == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding; - else if (fixMode == "Always") fm = anna::diameter::codec::Engine::FixMode::Always; - else if (fixMode == "Never") fm = anna::diameter::codec::Engine::FixMode::Never; - else LOGINFORMATION(anna::Logger::information("Unreconized command-line fix mode. Assumed default 'BeforeEncoding'", ANNA_FILE_LOCATION)); - getCodecEngine()->setFixMode(fm); // XXXXXXXXXXXXXXXXXXXXXXX - } - - getCodecEngine()->ignoreFlagsOnValidation(cl.exists("ignoreFlags")); // XXXXXXXXXXXXXXXXXXXXXXX - - // Base protocol for internal use (CEA, DWA, DPA and tracing: - a_myDiameterEngine->setBaseProtocolCodecEngine(getCodecEngine()); - - - // Diameter Server: - if(cl.exists("diameterServer")) - startDiameterServer(cl.exists("diameterServerSessions") ? cl.getIntegerValue("diameterServerSessions") : 1); - - // Optional command line parameters //////////////////////////////////////////////////////// - checkTimeMeasure("allowedInactivityTime"); - checkTimeMeasure("tcpConnectDelay"); - checkTimeMeasure("answersTimeout"); - checkTimeMeasure("ceaTimeout"); - checkTimeMeasure("watchdogPeriod"); - checkTimeMeasure("reconnectionPeriod"); - int tcpConnectDelay = 200; // ms - anna::Millisecond answersTimeout = (anna::Millisecond)10000; // ms - anna::Millisecond ceaTimeout; - anna::Millisecond watchdogPeriod = (anna::Millisecond)30000; // ms - int reconnectionPeriod = 10000; // ms - - if(cl.exists("tcpConnectDelay")) tcpConnectDelay = cl.getIntegerValue("tcpConnectDelay"); - - if(cl.exists("answersTimeout")) answersTimeout = cl.getIntegerValue("answersTimeout"); - - if(cl.exists("ceaTimeout")) ceaTimeout = cl.getIntegerValue("ceaTimeout"); - else ceaTimeout = answersTimeout; - - if(cl.exists("watchdogPeriod")) watchdogPeriod = cl.getIntegerValue("watchdogPeriod"); - - if(cl.exists("reconnectionPeriod")) reconnectionPeriod = cl.getIntegerValue("reconnectionPeriod"); - - a_myDiameterEngine->setMaxConnectionDelay((anna::Millisecond)tcpConnectDelay); - a_myDiameterEngine->setWatchdogPeriod(watchdogPeriod); - std::string originHost = ""; - std::string originRealm = ""; - - if(cl.exists("cer")) a_cerPathfile = cl.getValue("cer"); - - if(cl.exists("dwr")) a_dwrPathfile = cl.getValue("dwr"); - - if(cl.exists("originHost")) originHost = cl.getValue("originHost"); - - if(cl.exists("originRealm")) originRealm = cl.getValue("originRealm"); - - a_myDiameterEngine->setHost(originHost); - a_myDiameterEngine->setRealm(originRealm); - - // Diameter entity: - if(cl.exists("entity")) { - int entityServerSessions = cl.exists("entityServerSessions") ? cl.getIntegerValue("entityServerSessions") : 1; - - if(entityServerSessions > 0) { - baseProtocolSetupAsClient(); - anna::socket_v servers = anna::functions::getSocketVectorFromString(cl.getValue("entity")); - a_myDiameterEngine->setNumberOfClientSessionsPerServer(entityServerSessions); - a_entity = (MyDiameterEntity*)(a_myDiameterEngine->createEntity(servers, "Launcher diameter entity")); - a_entity->setClassCodeTimeout(anna::diameter::comm::ClassCode::Bind, ceaTimeout); - a_entity->setClassCodeTimeout(anna::diameter::comm::ClassCode::ApplicationMessage, answersTimeout); - a_entity->setCodecEngine(getCodecEngine()); // XXXXXXXXXXXXXXXXXXXXXXX - a_entity->bind(); - } - } - - // Logs - if(cl.exists("log")) a_logFile = cl.getValue("log"); - - if(cl.exists("splitLog")) a_splitLog = true; - - if(cl.exists("detailedLog")) a_detailedLog = true; - - if(cl.exists("dumpLog")) a_dumpLog = true; - - if(cl.exists("burstLog")) a_burstLogFile = cl.getValue("burstLog"); - - // Log statistics concepts - if(cl.exists("logStatisticSamples")) { - std::string list = cl.getValue("logStatisticSamples"); - anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate(); - - if(list == "all") { - if(statEngine.enableSampleLog(/* -1: all concepts */)) - LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION)); - } else { - anna::Tokenizer lst; - lst.apply(cl.getValue("logStatisticSamples"), ","); - - if(lst.size() >= 1) { - anna::Tokenizer::const_iterator tok_min(lst.begin()); - anna::Tokenizer::const_iterator tok_max(lst.end()); - anna::Tokenizer::const_iterator tok_iter; - int conceptId; - - for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) { - conceptId = atoi(anna::Tokenizer::data(tok_iter)); - - if(statEngine.enableSampleLog(conceptId)) - LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION)); - } - } - } + ///////////////////////////// + // Log statistics concepts // + ///////////////////////////// + if(cl.exists("logStatisticSamples")) + logStatisticsSamples(cl.getValue("logStatisticSamples")); + + // Start client connections ////////////////////////////////////////////////////////////////////////////////// + MyDiameterEntity *entity; + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + for (diameter::comm::origin_hosts_it it = ohm.begin(); it != ohm.end(); it++) { + entity = (MyDiameterEntity *)(it->second->getEntity()); + if (entity) entity->bind(); } - a_communicator->setRecoveryTime((const anna::Millisecond)reconnectionPeriod); + // Go into communicator poll + // Reconnection period (tcp reconnect retry time): + const char *varname = "reconnectionPeriod"; + anna::Millisecond reconnectionPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)10000; + a_communicator->setRecoveryTime(reconnectionPeriod); if(cl.exists("httpServer")) a_communicator->attach(a_httpServerSocket); // HTTP - a_communicator->accept(); } -bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() { +bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw(anna::RuntimeException) { // Get hex string static char buffer[8192]; std::ifstream infile(pathfile.c_str(), std::ifstream::in); @@ -645,11 +820,12 @@ bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBl // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString': hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end()); LOGDEBUG( - std::string msg = "Hex string (remove colons if exists): "; - msg += hexString; - anna::Logger::debug(msg, ANNA_FILE_LOCATION); + std::string msg = "Hex string (remove colons if exists): "; + msg += hexString; + anna::Logger::debug(msg, ANNA_FILE_LOCATION); ); - anna::functions::fromHexString(hexString, db); + + anna::functions::fromHexString(hexString, db); // could launch exception // Close file infile.close(); return true; @@ -658,222 +834,31 @@ bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBl return false; } -int Launcher::clearBurst() throw() { - int size = a_burstMessages.size(); - - if(size) { - std::map::const_iterator it; - std::map::const_iterator it_min(a_burstMessages.begin()); - std::map::const_iterator it_max(a_burstMessages.end()); - - for(it = it_min; it != it_max; it++) releaseCommMessage((*it).second); - - a_burstMessages.clear(); - } else { - std::string msg = "Burst list already empty. Nothing done"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - } - - a_burstActive = false; - a_burstLoadIndx = 0; - a_burstDeliveryIt = a_burstMessages.begin(); - return size; -} - -int Launcher::loadBurstMessage(const anna::DataBlock & db) throw(anna::RuntimeException) { - anna::diameter::comm::Message *msg = createCommMessage(); - msg->setBody(db); - a_burstMessages[a_burstLoadIndx++] = msg; - return (a_burstLoadIndx - 1); -} - -int Launcher::stopBurst() throw() { - if(!a_burstActive) { - std::string msg = "Burst launch is already stopped. Nothing done"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -1; - } - - a_burstActive = false; - // Remaining on cycle: - return (a_burstMessages.size() - (*a_burstDeliveryIt).first); -} - -int Launcher::popBurst(int releaseAmount) throw() { - if(!a_burstActive) { - std::string msg = "Burst launch is stopped. Nothing done"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -1; - } - - if(releaseAmount < 1) { - std::string msg = "No valid release amount is specified. Ignoring burst pop"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -2; - } - - int currentOTArequests = a_entity->getOTARequests(); - a_burstPopCounter = (releaseAmount > currentOTArequests) ? currentOTArequests : releaseAmount; - return a_burstPopCounter; -} - -int Launcher::pushBurst(int loadAmount) throw() { - if(a_burstMessages.size() == 0) { - std::string msg = "Burst data not found (empty list). Ignoring burst launch"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -1; - } - - if(loadAmount < 1) { - std::string msg = "No valid load amount is specified. Ignoring burst push"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -2; - } - - a_burstActive = true; - int count; - - for(count = 0; count < loadAmount; count++) - if(!sendBurstMessage()) break; - - return count; -} - -int Launcher::sendBurst(int loadAmount) throw() { - if(a_burstMessages.size() == 0) { - std::string msg = "Burst data not found (empty list). Ignoring burst launch"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -1; - } +bool Launcher::getContentFromFile(const std::string &pathfile, std::string &content) const throw(anna::RuntimeException) { - if(loadAmount < 1) { - std::string msg = "No valid load amount is specified. Ignoring burst send"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -2; + std::ifstream inFile(pathfile.c_str(), std::ifstream::in); + if(!inFile.good()) { + throw RuntimeException(anna::functions::asString("Unable to open file '%s'", pathfile.c_str()), ANNA_FILE_LOCATION); } - int count; - - for(count = 0; count < loadAmount; count++) - if(!sendBurstMessage(true /* anyway */)) break; + std::stringstream strStream; + strStream << inFile.rdbuf(); //read the file + content = strStream.str(); // holds the content of the file + inFile.close(); - return count; + return true; } -int Launcher::startBurst(int initialLoad) throw() { - if(initialLoad < 1) { - std::string msg = "No initial load is specified. Ignoring burst start"; - std::cout << msg << std::endl; - LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION)); - return -2; - } - - a_burstActive = true; - a_burstCycle = 1; - a_burstDeliveryIt = a_burstMessages.begin(); - return (pushBurst(initialLoad)); -} - -bool Launcher::sendBurstMessage(bool anyway) throw() { - if(!anyway && !burstActive()) return false; - - if(a_burstPopCounter > 0) { - if(burstLogEnabled()) writeBurstLogFile("x"); - - a_burstPopCounter--; - return false; - } - - if(a_burstDeliveryIt == a_burstMessages.end()) { - a_burstDeliveryIt = a_burstMessages.begin(); - - if(!anyway) { - if(a_burstRepeat) { - a_burstCycle++; - - if(burstLogEnabled()) writeBurstLogFile(anna::functions::asString("\nCompleted burst cycle. Starting again (repeat mode) on cycle %d.\n", a_burstCycle)); - } else { - if(burstLogEnabled()) writeBurstLogFile("\nCompleted burst cycle. Burst finished (repeat mode disabled).\n"); - - stopBurst(); - return false; - } - } +void Launcher::resetStatistics() throw() { + if (a_workingNode) { + a_workingNode->getCommEngine()->resetStatistics(); } - - anna::diameter::comm::Message *msg = (*a_burstDeliveryIt).second; - int order = (*a_burstDeliveryIt).first + 1; - a_burstDeliveryIt++; - bool dot = true; - // sending - bool result = a_entity->send(msg, anna::CommandLine::instantiate().exists("balance")); - - if(burstLogEnabled()) { - if(a_burstMessages.size() >= 100) - dot = (order % (a_burstMessages.size() / 100)); - - if(dot) { - writeBurstLogFile("."); - } else { - writeBurstLogFile(anna::functions::asString(" %d", order)); - int otaReqs = a_entity->getOTARequests(); - - if(result && (otaReqs != a_otaRequest)) { - // false if was a sending after an answer received (no OTA change in this case) - // true after push and pop operations - a_otaRequest = otaReqs; - writeBurstLogFile(anna::functions::asString("[OTA %d]", a_otaRequest)); - } + else { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + for (diameter::comm::origin_hosts_it it = ohm.begin(); it != ohm.end(); it++) { + it->second->getCommEngine()->resetStatistics(); } } - - // Detailed log: - if(logEnabled()) { - anna::diameter::comm::Server *usedServer = a_entity->getLastUsedResource(); - anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL; - std::string detail = usedClientSession ? usedClientSession->asString() : ""; // esto no deberia ocurrir - writeLogFile(msg->getBody(), (result ? "sent2e" : "send2eError"), detail, getCodecEngine()); // el del nodo de trabajo - } - - return result; -} - -std::string Launcher::lookBurst(int order) const throw() { - std::string result = "No message found for order provided ("; - result += anna::functions::asString(order); - result += ")"; - std::map::const_iterator it = a_burstMessages.find(order - 1); - - if(it != a_burstMessages.end()) { - // Decode - anna::diameter::codec::Message codecMsg(getCodecEngine()); // XXXXXXXXXXXXXXXX el del nodo de trabajo - try { codecMsg.decode((*it).second->getBody()); } catch(anna::RuntimeException &ex) { ex.trace(); } - result = codecMsg.asXMLString(); - } - - return result; -} - -std::string Launcher::gotoBurst(int order) throw() { - std::string result = "Position not found for order provided ("; - std::map::iterator it = a_burstMessages.find(order - 1); - - if(it != a_burstMessages.end()) { - a_burstDeliveryIt = it; - result = "Position updated for order provided ("; - } - - result += anna::functions::asString(order); - result += ")"; - return result; } void Launcher::resetCounters() throw() { @@ -883,29 +868,38 @@ void Launcher::resetCounters() throw() { } void Launcher::signalUSR2() throw(anna::RuntimeException) { + + std::string inputFile = getSignalUSR2InputFile(); + std::string outputFile = getSignalUSR2OutputFile(); + LOGNOTICE( - std::string msg = "Captured signal SIGUSR2. Reading tasks at '"; - msg += SIGUSR2_TASKS_INPUT_FILENAME; - msg += "' (results will be written at '"; - msg += SIGUSR2_TASKS_OUTPUT_FILENAME; - msg += "')"; - anna::Logger::notice(msg, ANNA_FILE_LOCATION); + std::string msg = "Captured signal SIGUSR2. Reading tasks at '"; + msg += inputFile; + msg += "' (results will be written at '"; + msg += outputFile; + msg += "')"; + anna::Logger::notice(msg, ANNA_FILE_LOCATION); ); + // Operation: std::string line; std::string response_content; - std::ifstream in_file(SIGUSR2_TASKS_INPUT_FILENAME); - std::ofstream out_file(SIGUSR2_TASKS_OUTPUT_FILENAME); + std::ifstream in_file(inputFile); + std::ofstream out_file(outputFile); if(!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION); - if(!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION); while(getline(in_file, line)) { + + // Ignore comments and blank lines: + if (line[0] == '#') continue; + if (std::string::npos == line.find_first_not_of(" \t")) continue; + LOGDEBUG( - std::string msg = "Processing line: "; - msg += line; - anna::Logger::debug(msg, ANNA_FILE_LOCATION); + std::string msg = "Processing line: "; + msg += line; + anna::Logger::debug(msg, ANNA_FILE_LOCATION); ); try { @@ -914,10 +908,11 @@ void Launcher::signalUSR2() throw(anna::RuntimeException) { ex.trace(); } - out_file << response_content; + out_file << response_content << "\n"; } in_file.close(); + out_file << "EOF\n"; out_file.close(); } @@ -928,18 +923,21 @@ std::string Launcher::help() const throw() { result += "\nOVERVIEW"; result += "\n--------"; result += "\n"; - result += "\nThe ADL (ANNA Diameter Launcher) process is a complete diameter agent with client and server"; - result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server"; - result += "\n (i.e. to simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.),"; - result += "\n and balancer systems to provide failover to external round-robin launchers. Also, auxiliary"; - result += "\n encoder/decoder/loader function could be deployed to reinterpret certain external flow and"; - result += "\n send it to another process."; - result += "\n"; + result += "\nThe ADML (ANNA Diameter MultiHost Launcher) process is a multi-host node with client and server"; + result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server (i.e. to"; + result += "\n simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.), and balancer"; + result += "\n systems to provide failover to external round-robin launchers. Also, auxiliary encoder/decoder/loader"; + result += "\n function could be deployed to reinterpret certain external flow and send it to another process."; + result += "\n "; result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections"; result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard"; result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA"; result += "\n generation, expiration control and many more features."; result += "\n"; + result += "\nThe ADML process can easily configure a many origin-host nodes as needed, which will have own endpoints."; + result += "\nYou should avoid loop configurations (client and server for that client) because automatic forwarding,"; + result += "\n is implemented and this would get in a never ending cycle when a request is sent."; + result += "\n"; result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually"; result += "\n 'debug' or 'warning'. See ANNA documentation for more details."; result += "\n"; @@ -951,7 +949,7 @@ std::string Launcher::help() const throw() { result += "\n vi /var/tmp/anna.context."; result += "\n"; result += "\nA complete xml report will show all the context information (counters, alarms, statistics,"; - result += "\n handlers, diameter dictionary, etc.), and a powerful log module could dump all the events"; + result += "\n handlers, diameter stacks, etc.), and a powerful log module could dump all the events"; result += "\n processed and flow information. Statistics could be analized at context dump and optionally"; result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the"; result += "\n measurements."; @@ -964,38 +962,83 @@ std::string Launcher::help() const throw() { result += "\n"; result += "\nStart the launcher process without arguments in order to see all the startup configuration"; result += "\n posibilities, many of which could be modified on the air through the management interface"; - result += "\n (we will talk later about this great feature). Some of the more common parameters are:"; + result += "\n (we will talk later about this great feature). There is only one mandatory parameter which"; + result += "\n is the services definition: --services . You must follow the dtd schema"; + result += "\n to build a valid services xml file. Some basic examples are:"; result += "\n"; - result += "\nAs mandatory, the stack definition given through the xml dictionary:"; - result += "\n --dictionary "; + result += "\nClient configuration:"; result += "\n"; - result += "\nActing as a diameter server (accepting i.e. 10 connections), you would have:"; - result += "\n --diameterServer localhost:3868 --diameterServerSessions 10 --entityServerSessions 0"; + result += "\n"; + result += "\n "; + result += "\n "; result += "\n"; - result += "\nActing as a diameter client (launching i.e. 10 connections to each entity server), you would have:"; - result += "\n --entity 192.168.12.11:3868,192.168.12.21:3868 --entityServerSessions 10 --diameterServerSessions 0"; + result += "\n "; + result += "\n "; + result += "\n"; + result += "\n"; + result += "\nServer configuration:"; + result += "\n"; + result += "\n"; + result += "\n "; + result += "\n "; + result += "\n"; + result += "\n "; + result += "\n "; + result += "\n"; result += "\n"; result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably"; result += "\n will need to program the answers to be replied through the operations interface. To balance the"; result += "\n traffic at your client side you shall use '--balance' and '--sessionBasedModelsClientSocketSelection'"; - result += "\n arguments in order to define the balancing behaviour."; + result += "\n arguments in order to define the balancing behaviour. To make hybrid setups you only must mix the nodes:"; result += "\n"; - result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own"; - result += "\n customized ones using '--cer ' and '--dwr '."; - result += "\nThe process builds automatically CEA and DWA messages as a server, but you could program your own"; - result += "\n customized ones using operations interface."; + result += "\nClient and server configuration:"; result += "\n"; + result += "\n"; + result += "\n "; + result += "\n "; + result += "\n "; + result += "\n "; + result += "\n"; + result += "\n "; + result += "\n "; + result += "\n "; + result += "\n"; + result += "\n"; + result += "\n"; + result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own"; + result += "\n as shown in the hybrid former example. Note that the base protocol stack must be registered because"; + result += "\n the configuration corresponds to a multistack process which change the stack using the application-id"; + result += "\n processed (0 in the case of base protocol messages: CER, CEA, DWR, DWA, DPR, DPA)."; result += "\n"; result += "\nDYNAMIC OPERATIONS"; result += "\n------------------"; result += "\n"; - result += "\nADL supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh."; + result += "\nADML supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh."; result += "\nAn operation is specified by mean a string containing the operation name and needed arguments"; result += "\n separated by pipes. These are the available commands:"; result += "\n"; result += "\n--------------------------------------------------------------------------------------- General purpose"; result += "\n"; - result += "\nhelp This help. Startup information-level traces also dump this help."; + result += "\nhelp This help."; + result += "\n"; + result += "\n--------------------------------------------------------------------------------------- Node management"; + result += "\n"; + result += "\nnode[|] Selects a context working node by mean a registered name (origin-host)."; + result += "\n All the subsequent operations will be forced to work with"; + result += "\n this node, which makes possible some rare scenarios like"; + result += "\n sending unexpected messages on remote peers. This is also"; + result += "\n useful for some operations in order to restrict the scope"; + result += "\n of action (statistics, communication visibility, etc.)."; + result += "\n Empty parameter will show the current configuration."; + result += "\n"; + result += "\nnode_auto Returns to the default behaviour (smart node selection)."; + result += "\n Depending on the operation, this could imply a global"; + result += "\n action scope, affecting to all the registered hosts."; + result += "\n This should be the normal configuration. Take into"; + result += "\n account that if you fix the working node, this could"; + result += "\n affect to things like test programming: communication"; + result += "\n resources will override those which would be inferred"; + result += "\n from programmed messages Origin-Host avps."; result += "\n"; result += "\n------------------------------------------------------------------------------------ Parsing operations"; result += "\n"; @@ -1005,18 +1048,44 @@ std::string Launcher::help() const throw() { result += "\n"; result += "\n------------------------------------------------------------------------------------------- Hot changes"; result += "\n"; + result += "\nservices[|source file] Adds and starts the services specified in the xml file provided."; + result += "\n (if missing, the file 'services.xml' will be used). This is used"; + result += "\n to load new nodes once the ADML is started, regardless if command"; + result += "\n line '--services' parameter was used or not. Those services which"; + result += "\n are not correctly loaded will be ignored to keep the process alive."; + result += "\n If you need to load services as deltas, you must firstly load the"; + result += "\n diameter base dictionary with stack id 0, because all the nodes"; + result += "\n will use this dictionary to encode/decode base protocol messages"; + result += "\n managed by the communication engine."; + result += "\n"; result += "\ndiameterServerSessions| Updates the maximum number of accepted connections to diameter"; result += "\n server socket."; - result += "\ncontext|[target file] Application context could also be written by mean this operation,"; + result += "\ncontext[|target file] Application context could also be written by mean this operation,"; result += "\n and not only through SIGUSR1. If optional path file is missing,"; result += "\n default '/var/tmp/anna.context.' will be used."; result += "\ncollect Reset statistics and counters to start a new test stage of"; result += "\n performance measurement. Context data can be written at"; - result += "\n '/var/tmp/anna.context.' by mean 'kill -10 '"; + result += "\n '/var/tmp/anna.context.' by mean 'kill -10 '."; result += "\n or sending operation 'context|[target file]'."; + result += "\n This operation applies over all the registered host nodes"; + result += "\n except if one specific working node has been set."; result += "\nforceCountersRecord Forces dump to file the current counters of the process."; + result += "\nlog-statistics-samples| Log statistics samples for the provided comma-separated concept id"; + result += "\n list, over './sample..csv' files. For example: \"1,2\""; + result += "\n will log concepts 1 and 2. Reserved words \"all\"/\"none\" activates/"; + result += "\n deactivates all registered statistics concept identifiers. That ids"; + result += "\n are shown at context dump."; + result += "\nchange-dir[|directory] Changes the execution point which could be fine to ease some"; + result += "\n file system interaction tasks. Be care about some requirements"; + result += "\n (for example if you have a user defined counters directory as"; + result += "\n relative path this must exists from the new execution directory)."; + result += "\n If nothing provided, initial working directory will be restored."; + result += "\nshow-oam Dumps current counters of the process. This is also done at"; + result += "\n process context dump."; + result += "\nshow-stats Dumps statistics of the process. This is also done at process"; + result += "\n context dump."; result += "\n"; - result += "\n|[
:]|[socket id]"; + result += "\n[|
:][|socket id]"; result += "\n"; result += "\n Actions: hide, show (update state) and hidden, shown (query state)."; result += "\n Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A)."; @@ -1032,20 +1101,18 @@ std::string Launcher::help() const throw() { result += "\n"; result += "\nsendxml2e| Sends xml source file (pathfile) through configured entity."; result += "\nsendxml2c| Sends xml source file (pathfile) to client."; - result += "\nsendxml| Same as 'sendxml2e'."; - result += "\nanswerxml2e|[source_file] Answer xml source file (pathfile) for incoming request with same code from entity."; + result += "\nanswerxml2e[|source_file] Answer xml source file (pathfile) for incoming request with same code from entity."; result += "\n The answer is stored in a FIFO queue for a specific message code, then there are"; result += "\n as many queues as different message codes have been programmed."; - result += "\nanswerxml2c|[source_file] Answer xml source file (pathfile) for incoming request with same code from client."; + result += "\nanswerxml2c[|source_file] Answer xml source file (pathfile) for incoming request with same code from client."; result += "\n The answer is stored in a FIFO queue for a specific message code, then there are"; result += "\n as many queues as different message codes have been programmed."; - result += "\nanswerxml|[source_file] Same as 'answerxml2c'."; - result += "\nanswerxml(2e/2c) List programmed answers (to entity/client) if no parameter provided."; - result += "\nanswerxml(2e/2c)|dump Write programmed answers (to entity/client) to file 'programmed_answer..',"; + result += "\nanswerxml<2e/2c> List programmed answers (to entity/client) if no parameter provided."; + result += "\nanswerxml<2e/2c>|dump Write programmed answers (to entity/client) to file 'programmed_answer..',"; result += "\n where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers."; - result += "\nanswerxml(2e/2c)|clear Clear programmed answers (to entity/client)."; - result += "\nanswerxml(2e/2c)|exhaust Disable the corresponding queue rotation, which is the default behaviour."; - result += "\nanswerxml(2e/2c)|rotate Enable the corresponding queue rotation, useful in performance tests."; + result += "\nanswerxml<2e/2c>|clear Clear programmed answers (to entity/client)."; + result += "\nanswerxml<2e/2c>|exhaust Disable the corresponding queue rotation, which is the default behaviour."; + result += "\nanswerxml<2e/2c>|rotate Enable the corresponding queue rotation, useful in performance tests."; result += "\n Rotation consists in add again to the queue, each element retrieved for answering."; result += "\n"; result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test"; @@ -1053,13 +1120,12 @@ std::string Launcher::help() const throw() { result += "\n"; result += "\nsendhex2e| Sends hex source file (pathfile) through configured entity."; result += "\nsendhex2c| Sends hex source file (pathfile) to client."; - result += "\nsendhex| Same as 'sendhex2e'."; result += "\n"; result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also"; result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,"; result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created."; result += "\n"; - result += "\nIf a request is received, answer map (built with 'answerxml<[2c] or 2e>' operations) will be"; + result += "\nIf a request is received, answer map (built with 'answerxml<2e/2c>' operations) will be"; result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,"; result += "\n or answer message was received, the message is forwarded to the other side (entity or client),"; result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when"; @@ -1072,16 +1138,16 @@ std::string Launcher::help() const throw() { result += "\n"; result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored"; result += "\n to the peer which sent the request. If user wants to test a specific answer without changing it,"; - result += "\n use sendxml/sendhex operations better than programming."; + result += "\n use sendxml<2e/2c>/sendhex<2e/2c> operations better than programming."; result += "\n"; - result += "\nBalance ('-balance' command line parameter) could be used to forward server socket receptions through"; + result += "\nBalance ('--balance' command line parameter) could be used to forward server socket receptions through"; result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should"; result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an"; result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc."; result += "\n"; result += "\n--------------------------------------------------------------------------- Processing types (log tags)"; result += "\n"; - result += "\nUsed as log file extensions (when '-splitLog' is provided on command line) and context preffixes on log"; + result += "\nUsed as log file extensions (when '--splitLog' is provided on command line) and context preffixes on log"; result += "\n details when unique log file is dumped:"; result += "\n"; result += "\n [sent2e/send2eError] Send to entity (success/error)"; @@ -1098,9 +1164,15 @@ std::string Launcher::help() const throw() { result += "\n has been logged)"; result += "\n [retry] Request retransmission"; result += "\n"; - result += "\n-------------------------------------------------------------------------------------------- Load tests"; + result += "\n------------------------------------------------------------------------------------------- Burst tests"; result += "\n"; - result += "\nburst||[parameter] Used for performance testing, we first program diameter requests"; + result += "\nIn order to simplify user experience, burst category operations are only allowed in single host node"; + result += "\n configuration. Indeed, you could send messages with unmatched Origin-Host, and no warning is shown."; + result += "\nAll the operations are performed through the unique host: if you need to use more interfaces, you may"; + result += "\n launch different ADML instances. Is nonsense to allow burst in a multi-host configured ADML, because"; + result += "\n this feature is not able to coordinate the messages."; + result += "\n"; + result += "\nburst|[|parameter] Used for performance testing, we first program diameter requests"; result += "\n messages in order to launch them from client side to the configured"; result += "\n diameter entity. We could start the burst with an initial load"; result += "\n (non-asynchronous sending), after this, a new request will be sent"; @@ -1114,18 +1186,332 @@ std::string Launcher::help() const throw() { result += "\n burst|push| Sends specific non-aynchronous load."; result += "\n burst|pop| Skip send burst messages in order to reduce over-the-air requests."; result += "\n Popping all OTA requests implies burst stop because no more answer"; - result += "\n will arrive to the process. Burst output file (-burstLog command"; + result += "\n will arrive to the process. Burst output file (--burstLog command"; result += "\n line parameter) shows popped messages with crosses (x). Each cross"; result += "\n represents one received answer for which no new request is sent."; result += "\n burst|stop Stops the burst cycle. You can resume pushing 1 load amount."; - result += "\n burst|repeat|[[yes]|no] Restarts the burst launch when finish. If initial load or push load"; + result += "\n burst|repeat[|[yes]|no] Restarts the burst launch when finish. If initial load or push load"; result += "\n amount is greater than burst list size, they will be limited when"; result += "\n the list is processed except when repeat mode is enabled."; result += "\n burst|send| Sends messages from burst list. The main difference with start/push"; result += "\n operations is that burst won't be awaken. Externally we could control"; result += "\n sending time (no request will be sent for answers)."; result += "\n burst|goto| Updates current burst pointer position."; - result += "\n burst|look| Show programmed burst message for order provided."; + result += "\n burst|look[|order] Show programmed burst message for order provided, current when missing."; + result += "\n"; + result += "\n-------------------------------------------------------------------------------------- Advanced testing"; + result += "\n"; + result += "\n Burst mode only allows single interface interaction. For multiple interface"; + result += "\n (origin-host) coordination, you could use the advanced test cases programming:"; + result += "\n"; + result += "\n"; + result += "\n test||[|parameters]"; + result += "\n"; + result += "\n Adds a new step to the test case with provided identifier. If provided identifier"; + result += "\n is not registered yet, a new test case will be created with that value and the"; + result += "\n step will be added as the first. For a specific 'id', the steps are stored in"; + result += "\n order as they are programmed. Check possible runtime exceptions when adding a"; + result += "\n new step because those which fail, will be ignored/skipped during test case"; + result += "\n programming giving an incomplete sequence invalid for the testing purpose."; + result += "\n"; + result += "\n : integer number, normally monotonically increased for each test case. Some external"; + result += "\n script/procedure shall clone a test case template in order to build a collection"; + result += "\n of independent and coherent test cases (normally same type) with different context"; + result += "\n values (Session-Id, Subscriber-Id, etc.)."; + result += "\n"; + result += "\n : commands to be executed for the test id provided. Each command programmed"; + result += "\n constitutes a test case 'step', numbered from 1 to N."; + result += "\n"; + result += "\n timeout| Sets an asynchronous timer to restrict the maximum timeout"; + result += "\n until last test step. Normally, this command is invoked"; + result += "\n in the first step, anyway it measures the time from the"; + result += "\n execution point whatever it is. The expiration will abort"; + result += "\n the test if still running. One or more timeouts could be"; + result += "\n programmed (not usual), but the more restrict will apply."; + result += "\n It is highly recommended to program a initial timeout step,"; + result += "\n or the test case could be eternally in-progress."; + result += "\n"; + result += "\n sendxml2e|[|]"; + result += "\n Sends xml source file (pathfile) to entity (it would be a"; + result += "\n 'forward' event if it came through local server endpoint)."; + result += "\n Take into account that the xml message is encoded just on"; + result += "\n call. The xml file is not longer needed neither interpreted"; + result += "\n in case of modification, after calling this command."; + result += "\n The step number should be provided for answers to indicate"; + result += "\n the 'wait for request' corresponding step. If you miss this"; + result += "\n reference, the sequence information (hop-by-hop, end-to-end)"; + result += "\n will be sent as they are in the answer xml message (realize"; + result += "\n the difficulty of predicting these information). Be sure to"; + result += "\n refer to a 'wait for request' step. Conditions like 'regexp'"; + result += "\n (as we will see later) are not verified."; + result += "\n In the case of requests, the step number is used to force the"; + result += "\n copy of Session-Id value from the referred step."; + result += "\n"; + result += "\n sendxml2c|[|]"; + result += "\n Sends xml source file (pathfile) to client (it would be a"; + result += "\n 'forward' event if it came through remote server endpoint)."; + result += "\n Same commented for 'sendxml2e' regarding the step number."; + result += "\n"; + result += "\n delay| Blocking step until the time lapse expires. Useful to give "; + result += "\n some cadence control and time schedule for a specific case."; + result += "\n A value of 0 could be used as a dummy step."; + result += "\n"; + result += "\n sh-command|