1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
9 #include <anna/diameter.comm/OamModule.hpp>
10 #include <anna/diameter.comm/Engine.hpp>
11 #include <anna/diameter.comm/LocalServer.hpp>
12 #include <anna/diameter.comm/ServerSession.hpp>
13 #include <anna/diameter.comm/ServerSocket.hpp>
14 #include <anna/core/functions.hpp>
15 #include <anna/statistics/Engine.hpp>
16 #include <anna/diameter.comm/TimerManager.hpp>
18 #include <anna/core/tracing/Logger.hpp>
19 #include <anna/core/tracing/TraceMethod.hpp>
20 #include <anna/core/functions.hpp>
21 #include <anna/app/functions.hpp>
22 #include <anna/xml/Node.hpp>
23 #include <anna/comm/Communicator.hpp>
24 #include <anna/comm/Network.hpp>
25 #include <anna/comm/Host.hpp>
26 #include <anna/comm/ClientSocket.hpp>
33 using namespace anna::diameter::comm;
35 LocalServer::LocalServer() :
39 a_currentConnections(0),
40 a_allowedInactivityTime(ServerSession::DefaultAllowedInactivityTime),
46 a_lastUsedResource(NULL) {
47 a_statisticsAccumulator.reset();
51 void LocalServer::initializeStatisticConcepts() throw() {
53 anna::statistics::Engine& statsEngine = anna::statistics::Engine::instantiate();
54 // Concepts descriptions:
55 std::string serverAsString = anna::functions::socketLiteralAsString(a_key.first, a_key.second);
56 std::string c1desc = "Diameter processing time (for requests) at clients connected to "; c1desc += serverAsString;
57 std::string c2desc = "Diameter message sizes received from clients connected to "; c2desc += serverAsString;
59 a_processing_time__StatisticConceptId = statsEngine.addConcept(c1desc.c_str(), "ms", true/* integer values */);
60 a_received_message_size__StatisticConceptId = statsEngine.addConcept(c2desc.c_str(), "bytes", true/* integer values */);
63 void LocalServer::resetStatistics() throw() {
64 a_statisticsAccumulator.reset();
67 void LocalServer::updateProcessingTimeStatisticConcept(const double &value) throw() {
68 a_statisticsAccumulator.process(a_processing_time__StatisticConceptId, value);
69 LOGDEBUG(anna::Logger::debug(a_statisticsAccumulator.asString(), ANNA_FILE_LOCATION));
72 void LocalServer::updateReceivedMessageSizeStatisticConcept(const double &value) throw() {
73 a_statisticsAccumulator.process(a_received_message_size__StatisticConceptId, value);
74 //LOGDEBUG(anna::Logger::debug(a_statisticsAccumulator.asString(), ANNA_FILE_LOCATION));
78 ServerSession* LocalServer::allocateServerSession() throw() { return a_serverSessionsRecycler.create(); }
79 void LocalServer::releaseServerSession(ServerSession *serverSession) throw() { a_serverSessionsRecycler.release(serverSession); }
82 LocalServer::serverSession_iterator LocalServer::serverSession_find(const serverSession_key &key) throw() {
83 return a_serverSessions.find(key);
87 LocalServer::serverSession_key LocalServer::getServerSessionKey(const anna::comm::ClientSocket &clientSocket) const throw() {
88 return (anna::functions::exclusiveHash(clientSocket.getRemoteAccessPoint().getINetAddress().serialize()));
92 void LocalServer::availabilityLost() throw() {
94 std::string socket = anna::functions::socketLiteralAsString(a_key.first, a_key.second);
96 std::string msg = "diameter::comm::LocalServer { Socket: ";
98 msg += " } has lost its availability";
99 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
102 OamModule &oamModule = OamModule::instantiate();
103 oamModule.activateAlarm(OamModule::Alarm::c_LostAvailabilityOverLocalServerDefinedAs__s__, socket.c_str());
104 oamModule.count(OamModule::Counter::LostAvailabilityOverLocalServer);
105 a_engine->availabilityLost(this);
106 a_engine->refreshAvailabilityForLocalServers();
110 void LocalServer::availabilityRecovered() throw() {
112 std::string socket = anna::functions::socketLiteralAsString(a_key.first, a_key.second);
114 std::string msg = "diameter::comm::LocalServer { Socket: ";
116 msg += " } has recovered its availability";
117 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
120 OamModule &oamModule = OamModule::instantiate();
121 oamModule.cancelAlarm(OamModule::Alarm::c_LostAvailabilityOverLocalServerDefinedAs__s__, socket.c_str());
122 oamModule.count(OamModule::Counter::RecoveredAvailabilityOverLocalServer);
123 a_engine->availabilityRecovered(this);
124 a_engine->refreshAvailabilityForLocalServers();
129 bool LocalServer::refreshAvailability() throw() {
131 if(a_available) { // check not-bound state for all server-sessions:
132 // bool isolate = true;
134 // for (const_serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++)
135 // if (serverSession(it)->getState() != ServerSession::State::Closed) { isolate = false; break; }
138 // El problema de lo anterior, es que cuando se acepta una conexion, aun no ha llegado el CER (receive). Un server session
139 // esta en estado "Bound" cuando llega dicho CER y consecuentemente envio un CEA. Nos basaremos en 'a_currentConnections':
140 if(a_currentConnections == 0) {
148 // Here not available
149 // for (const_serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++)
150 // if (serverSession(it)->getState() == ServerSession::State::Bound) {
151 if(a_currentConnections > 0) { // really == 0
152 availabilityRecovered();
160 void LocalServer::enable(bool unlock) throw(anna::RuntimeException) {
162 if(unlock) a_lock = false;
166 if(a_serverSocket && a_serverSocket->isOpened()) return; // communicator attach twice gets poll bad file descriptor and application stops !
168 // Resolve local address:
169 anna::comm::Network& network = anna::comm::Network::instantiate();
171 anna::comm::Host *host = network.resolve(a_key.first /* addr */);
172 const anna::comm::Device *device = *(host->device_begin());
173 anna::comm::INetAddress localAddress(device, a_key.second /* port */);
174 // Create server socket and assign receiver factory
175 a_serverSocket = new ServerSocket(localAddress, this);
176 a_serverSocket->setCategory(a_category);
180 void LocalServer::attach() throw() {
182 // Attach to communicator
183 anna::comm::Communicator * communicator = anna::app::functions::component <anna::comm::Communicator> (ANNA_FILE_LOCATION);
184 communicator->attach((anna::comm::ServerSocket*)a_serverSocket); // invokes handler insert and then initialize -> server socket bind (*)
186 OamModule &oamModule = OamModule::instantiate();
187 oamModule.count(OamModule::Counter::ServerSocketsOpened);
188 } catch(anna::RuntimeException& ex) {
189 ex.trace(); // fails on (*) (i.e. Address already in use), within communicator attach
191 a_serverSocket->close();
195 void LocalServer::attachPlanning() throw() {
196 LOGMETHOD(anna::TraceMethod tttm("diameter::comm::LocalServer", "attachPlanning", ANNA_FILE_LOCATION));
199 TimerManager::instantiate().createTimer(this);
200 } catch(anna::RuntimeException& ex) {
202 anna::Logger::error("CAPTURED EXCEPTION activating attachPlanning timer", ANNA_FILE_LOCATION);
207 void LocalServer::disable(bool lock) throw(anna::RuntimeException) {
210 anna::comm::Communicator * communicator = anna::app::functions::component <anna::comm::Communicator> (ANNA_FILE_LOCATION);
211 communicator->detach((anna::comm::ServerSocket*)a_serverSocket);
212 //delete(a_serverSocket);
214 OamModule &oamModule = OamModule::instantiate();
215 oamModule.count(OamModule::Counter::ServerSocketsClosed);
219 void LocalServer::lostConnection() throw() {
220 a_currentConnections--;
225 void LocalServer::newConnection() throw(anna::RuntimeException) {
226 a_currentConnections++;
229 if(a_currentConnections == a_maxConnections) {
230 LOGWARNING(anna::Logger::warning("The maximum number of connections allowed over diameter server socket have already been served", ANNA_FILE_LOCATION));
234 // Inform local server (availability changes):
235 bool changes = refreshAvailability();
237 OamModule &oamModule = OamModule::instantiate();
238 oamModule.count(OamModule::Counter::CreatedConnectionForServerSession);
243 ServerSession *LocalServer::createServerSession(const anna::comm::ClientSocket &clientSocket) throw(anna::RuntimeException) {
244 LOGMETHOD(anna::TraceMethod tttm("diameter::comm::LocalServer", "createServerSession", ANNA_FILE_LOCATION));
245 ServerSession* result(NULL);
246 // First erase deprecated ones:
247 std::vector<const ServerSession*> deprecated_server_sessions;
248 const ServerSession* ss;
250 for(const_serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++) {
251 ss = serverSession(it);
254 deprecated_server_sessions.push_back(ss);
257 std::vector<const ServerSession*>::iterator dc_ncit;
258 std::vector<const ServerSession*>::iterator dc_min(deprecated_server_sessions.begin());
259 std::vector<const ServerSession*>::iterator dc_max(deprecated_server_sessions.end());
260 serverSession_iterator ii;
262 for(dc_ncit = dc_min; dc_ncit != dc_max; dc_ncit++) {
263 ii = serverSession_find((*dc_ncit)->getSocketId());
264 a_serverSessions.erase(ii);
267 // End erase deprecated server sessions
269 if((result = allocateServerSession()) == NULL)
270 throw anna::RuntimeException("diameter::comm::LocalServer::allocateServerSession returns NULL", ANNA_FILE_LOCATION);
273 result->initialize(); // warning: recycler does not initialize its objects and at least...
274 // Assignments (it could be done at allocate):
275 serverSession_key key = getServerSessionKey(clientSocket);
276 result->setAllowedInactivityTime(getAllowedInactivityTime());
277 result->setClientSocket((anna::comm::ClientSocket*)(&clientSocket));
278 result->a_parent = this;
279 result->a_socketId = key; // de momento...
280 result->initializeSequences(); // después de asignar el LocalServer y el socketId (*)
281 // (*) Las secuencias se basan en la semilla: srand(::time(NULL) + anna::functions::exclusiveHash(anna::functions::asString("%s:%d|%d", getAddress().c_str(), getPort(), a_socketId)));
282 result->a_engine = a_engine;
283 a_serverSessions.insert(serverSession_value_type(key, result));
285 a_deliveryIterator = serverSession_begin();
291 void LocalServer::closeServerSession(ServerSession* serverSession)
292 throw(anna::RuntimeException) {
293 if(serverSession == NULL)
297 std::string msg("diameter::comm::LocalServer::closeServerSession | ");
298 msg += serverSession->asString();
299 // msg += " | Destroy: ";
300 // msg += (destroy ? "yes" : "no");
301 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
303 serverSession_iterator ii = serverSession_find(serverSession->getSocketId());
305 if(ii == serverSession_end())
309 //serverSession->setState(ServerSession::State::Closing); NOT MANAGED WITH SERVER SESSIONS
310 serverSession->unbind(true /* always forceDisconnect on server sessions ... */);
311 releaseServerSession(serverSession);
312 } catch(anna::RuntimeException& ex) {
316 //a_serverSessions.erase(ii); // IMPORTANTE: posible fuente de cores de este tipo, en relacion con ServerSession::finalize() => delete(this)
317 // #0 0x0000003ca1c2e26d in raise () from /lib64/tls/libc.so.6
319 // #0 0x0000003ca1c2e26d in raise () from /lib64/tls/libc.so.6
320 // #1 0x0000003ca1c2fa6e in abort () from /lib64/tls/libc.so.6
321 // #2 0x0000003ca8cb1148 in __gnu_cxx::__verbose_terminate_handler () from /usr/lib64/libstdc++.so.6
322 // #3 0x0000003ca8caf176 in __cxa_call_unexpected () from /usr/lib64/libstdc++.so.6
323 // #4 0x0000003ca8caf1a3 in std::terminate () from /usr/lib64/libstdc++.so.6
324 // #5 0x0000003ca8caf1b6 in std::terminate () from /usr/lib64/libstdc++.so.6
325 // #6 0x0000003ca8caf0c8 in __cxa_call_unexpected () from /usr/lib64/libstdc++.so.6
326 // #7 0x000000000047a4a7 in anna::diameter::comm::LocalServer::lostConnection (this=0x8aeb10) at comm.db/diameter.comm.LocalServer.cc:200
327 // #8 0x000000000047a9e6 in anna::diameter::comm::LocalServer::closeServerSession (this=0x8aeb10, serverSession=0xc37a00)
328 // at comm.db/diameter.comm.LocalServer.cc:275
329 // #9 0x000000000048d288 in anna::diameter::comm::ServerSession::finalize (this=0xc37a00) at comm.db/diameter.comm.ServerSession.cc:510
330 // #10 0x0000000000494e4f in anna::diameter::comm::ServerSessionReceiver::eventBreakLocalConnection (this=0xc119c0, clientSocket=@0xb0ea00)
331 // SOLUCION: no borrar aqui, marcar como "deprecated". Este estado no se necesita realmente puesto que nadie volvera a usar este recurso.
332 // Pero simplemente se podria usar para purgar mediante temporizacion (entonces sà se harÃa el erase)
333 serverSession->a_deprecated = true;
334 // WE WILL ERASE AT createServerSession
335 a_deliveryIterator = serverSession_begin();
340 ServerSession* LocalServer::findServerSession(int socketId, anna::Exception::Mode::_v emode)
341 throw(anna::RuntimeException) {
342 serverSession_iterator ii = serverSession_find(socketId);
344 if(ii != serverSession_end())
345 return serverSession(ii);
347 if(emode != anna::Exception::Mode::Ignore) {
348 std::string msg("diameter::comm::LocalServer::findServerSession | SocketId: ");
349 msg += anna::functions::asString(socketId);
350 msg += " | ServerSession not found";
351 anna::RuntimeException ex(msg, ANNA_FILE_LOCATION);
353 if(emode == anna::Exception::Mode::Throw)
362 ServerSession* LocalServer::findServerSession(const anna::comm::ClientSocket &clientSocket, anna::Exception::Mode::_v emode)
363 throw(anna::RuntimeException) {
364 return findServerSession(getServerSessionKey(clientSocket), emode);
368 int LocalServer::getOTARequests() const throw() {
371 for(const_serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++)
372 result += serverSession(it)->getOTARequests();
377 void LocalServer::close() throw(anna::RuntimeException) {
378 LOGMETHOD(anna::TraceMethod tttm("diameter::comm::LocalServer", "close", ANNA_FILE_LOCATION));
379 // Close listener (permanently to avoid reopening when local connections are being deleted):
380 disable(true /* lock */);
382 for(serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++)
383 closeServerSession(serverSession(it));
387 void LocalServer::setMaxConnections(int maxConnections) throw(anna::RuntimeException) {
388 LOGMETHOD(anna::TraceMethod tttm("anna::diameter::comm::LocalServer", "setMaxConnections", ANNA_FILE_LOCATION));
390 // Negative & initial
391 if(maxConnections < 0) {
392 LOGDEBUG(anna::Logger::debug("Provided negative value means no limit accepting connections over server socket. Opening listen port (if closed)...", ANNA_FILE_LOCATION));
393 a_maxConnections = -1;
399 if(maxConnections == a_maxConnections) {
400 LOGDEBUG(anna::Logger::debug("Provided equal to current. Ignore operation", ANNA_FILE_LOCATION));
405 if(maxConnections < a_currentConnections) {
406 std::string msg = "There are more current connections (";
407 msg += anna::functions::entriesAsString(a_currentConnections);
408 msg += ") than provided maximum (";
409 msg += anna::functions::entriesAsString(maxConnections);
410 msg += "). Command rejected (you should release connections before logical limitation)";
411 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
415 if(maxConnections > a_currentConnections) {
416 LOGDEBUG(anna::Logger::debug("Increasing connection margin (new limit is greater than current connections). Opening listen port (if closed)...", ANNA_FILE_LOCATION));
418 } else { // maxConnections == a_currentConnections: listen port must be closed if it is opened
421 if(maxConnections == 0)
422 anna::Logger::debug("Provided zero value means disabling diameter server", ANNA_FILE_LOCATION);
423 anna::Logger::debug("Zeroing connections margin (new limit is equal to current connections). Closing listen port (if opened)...", ANNA_FILE_LOCATION);
431 std::string msg("Updating max connections from ");
432 msg += (a_maxConnections == -1) ? "'no limit'" : anna::functions::asString(a_maxConnections);
434 msg += (maxConnections == -1) ? "'no limit'" : anna::functions::asString(maxConnections);
435 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
438 a_maxConnections = maxConnections;
442 bool LocalServer::send(const Message* message, int socketId) throw(anna::RuntimeException) {
443 LOGMETHOD(anna::TraceMethod tttm("diameter::comm::LocalServer", "send", ANNA_FILE_LOCATION));
447 std::string msg = "The local server ";
449 if(a_description != "") {
451 msg += a_description;
454 msg += "is currently unavailable (no server sessions to send the message)";
455 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
460 if(socketId != -1) { // socket id provided
461 // Send (it was a request because of key (socketId) != -1, we forward the answer):
463 ServerSession * fixedServerSession = a_engine->findServerSession(socketId); // exception if not found
464 fixedServerSession->send(message);
466 } catch(anna::RuntimeException &ex) {
467 std::string msg = "Cannot deliver answer through a fixed server session (socket id ";
468 msg += anna::functions::asString(socketId);
469 msg += "). Perhaps it existed but not now. Ignore";
470 anna::Logger::error(msg, ANNA_FILE_LOCATION);
476 // Socket is not provided: use readSocketId
477 socketId = (a_currentConnections > 1) ? readSocketId(message) : -1; // optimization
479 if(a_deliveryIterator == serverSession_end()) a_deliveryIterator = serverSession_begin();
481 a_lastUsedResource = (*a_deliveryIterator).second;
484 a_lastUsedResource = findServerSession(socketId); // exception if not found
485 } else { // Round Robin delivery between client-sessions
486 if(getCurrentConnections() != 1) { // optimize
487 // Next server-session:
488 a_deliveryIterator++;
494 const Response* response = a_lastUsedResource->send(message);
495 return true; // no matter if response is NULL (answers, i.e.) or not.
496 } catch(anna::RuntimeException &ex) {
500 // Here, sent has failed:
502 OamModule &oamModule = OamModule::instantiate();
503 std::string socket = anna::functions::socketLiteralAsString(getKey().first, getKey().second);
504 oamModule.activateAlarm(OamModule::Alarm::UnableToDeliverDiameterMessageToClientFromLocalServer__s__, socket.c_str());
505 oamModule.count(OamModule::Counter::UnableToDeliverToClient);
510 bool LocalServer::broadcast(const Message* message) throw(anna::RuntimeException) {
511 LOGMETHOD(anna::TraceMethod tttm("diameter::comm::LocalServer", "broadcast", ANNA_FILE_LOCATION));
512 const Response* response;
515 for(serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++) {
517 response = serverSession(it)->send(message);
518 } catch(anna::RuntimeException &ex) {
527 void LocalServer::eventPeerShutdown(const ServerSession* serverSession) throw() {
529 std::string msg(serverSession->asString());
530 msg += " | eventPeerShutdown";
531 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
535 std::string LocalServer::asString() const throw() {
536 std::string result("diameter::comm::LocalServer { ");
537 result += "Description: ";
538 result += (a_description != "") ? a_description : "undefined";
539 result += " | Available (any server session bound): ";
540 result += a_available ? "yes" : "no";
541 result += " | Max Connections: ";
542 result += anna::functions::asString(a_maxConnections);
543 result += " | Current Connections: ";
544 result += anna::functions::asString(a_currentConnections);
545 // Current connections ??
546 result += " | Allowed inactivity time for server sessions: ";
547 result += a_allowedInactivityTime.asString();
548 result += " | Server socket: ";
549 result += a_serverSocket ? a_serverSocket->asString() : "closed";
550 result += anna::functions::asString(" | OTA requests: %d%s", getOTARequests(), idle() ? " (idle)" : "");
551 result += " | Last Incoming Activity Time: ";
552 result += a_lastIncomingActivityTime.asString();
553 result += " | Last Outgoing Activity Time: ";
554 result += a_lastOutgoingActivityTime.asString();
556 // result += a_statisticsAccumulator.asString();
557 // ServerSessions only in xml
558 return result += " }";
562 anna::xml::Node* LocalServer::asXML(anna::xml::Node* parent) const throw() {
563 anna::xml::Node* result = parent->createChild("diameter.LocalServer");
564 result->createAttribute("Description", (a_description != "") ? a_description : "undefined");
565 result->createAttribute("Available", a_available ? "yes" : "no");
566 result->createAttribute("MaxConnections", a_maxConnections);
567 result->createAttribute("CurrentConnections", a_currentConnections);
568 // Current connections ??
569 result->createAttribute("AllowedInactivityTimeForServerSessions", a_allowedInactivityTime.asString());
572 a_serverSocket->asXML(result);
574 result->createAttribute("ServerSocket", "closed");
576 result->createAttribute("OTArequests", anna::functions::asString("%d%s", getOTARequests(), idle() ? " (idle)" : ""));
577 result->createAttribute("LastIncomingActivityTime", a_lastIncomingActivityTime.asString());
578 result->createAttribute("LastOutgoingActivityTime", a_lastOutgoingActivityTime.asString());
580 anna::xml::Node* stats = result->createChild("Statistics");
581 a_statisticsAccumulator.asXML(stats);
582 anna::xml::Node* serverSessions = result->createChild("ServerSessions"); // LocalServer.ServerSessions
584 for(const_serverSession_iterator it = serverSession_begin(); it != serverSession_end(); it++)
585 serverSession(it)->asXML(serverSessions);
590 //------------------------------------------------------------------------------
591 //------------------------------------ LocalServer::updateIncomingActivityTime()
592 //------------------------------------------------------------------------------
593 void LocalServer::updateIncomingActivityTime() throw() {
594 a_lastIncomingActivityTime = anna::functions::millisecond();
597 std::string msg = "Updated INCOMING activity on local server (milliseconds unix): ";
598 msg += anna::functions::asString(a_lastIncomingActivityTime.getValue());
599 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
604 //------------------------------------------------------------------------------
605 //------------------------------------ LocalServer::updateOutgoingActivityTime()
606 //------------------------------------------------------------------------------
607 void LocalServer::updateOutgoingActivityTime(void) throw() {
608 a_lastOutgoingActivityTime = anna::functions::millisecond();
611 std::string msg = "Updated OUTGOING activity on local server (milliseconds unix): ";
612 msg += anna::functions::asString(a_lastOutgoingActivityTime.getValue());
613 anna::Logger::debug(msg, ANNA_FILE_LOCATION);