source/diameter/codec/Avp.cpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 // Local
  38 #include <anna/diameter/codec/Avp.hpp>
  39 #include <anna/diameter/codec/Format.hpp>
  40
  41 #include <anna/config/defines.hpp> // general types, decoding helpers (DECODE[2/3/4]BYTES_INDX_VALUETYPE), etc.
  42 #include <anna/diameter/functions.hpp>
  43 #include <anna/diameter/helpers/defines.hpp>
  44 #include <anna/diameter/codec/basetypes/basetypes.hpp>
  45 #include <anna/diameter/codec/functions.hpp> // REQUIRED_WORDS
  46 #include <anna/diameter/codec/OamModule.hpp>
  47 #include <anna/diameter/stack/Avp.hpp>
  48 #include <anna/diameter/stack/Format.hpp>
  49 #include <anna/diameter/stack/Dictionary.hpp>
  50 #include <anna/diameter/stack/Engine.hpp>
  51 #include <anna/diameter/codec/Engine.hpp>
  52 #include <anna/core/functions.hpp>
  53
  54 #include <anna/core/tracing/Logger.hpp>
  55 #include <anna/core/functions.hpp>
  56 #include <anna/core/tracing/TraceMethod.hpp>
  57 #include <anna/xml/xml.hpp>
  58
  59 // STL
  60 #include <map>
  61
  62
  63 using namespace anna;
  64 using namespace anna::diameter::codec;
  65
  66
  67 //static
  68 namespace anna {
  69
  70 namespace diameter {
  71
  72 namespace codec {
  73 const int Avp::HeaderLengthVactive(12);
  74 const int Avp::HeaderLengthVinactive(8);
  75 const U8 Avp::VBitMask(0x80);
  76 const U8 Avp::MBitMask(0x40);
  77 const U8 Avp::PBitMask(0x20);
  78 }
  79 }
  80 }
  81
  82 //------------------------------------------------------------------------------
  83 //------------------------------------------------------------------- Avp::Avp()
  84 //------------------------------------------------------------------------------
  85 Avp::Avp() {
  86   initialize();
  87 }
  88
  89
  90 //------------------------------------------------------------------------------
  91 //------------------------------------------------------------------- Avp::Avp()
  92 //------------------------------------------------------------------------------
  93 Avp::Avp(AvpId id) {
  94   initialize();
  95   setId(id);
  96 }
  97
  98
  99 //------------------------------------------------------------------------------
 100 //------------------------------------------------------------------ Avp::~Avp()
 101 //------------------------------------------------------------------------------
 102 Avp::~Avp() {
 103   clear();
 104 }
 105
 106
 107 //------------------------------------------------------------------------------
 108 //------------------------------------------------------------- Avp::getEngine()
 109 //------------------------------------------------------------------------------
 110 Engine * Avp::getEngine() const throw(anna::RuntimeException) {
 111   return a_engine ? a_engine : (a_engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION));
 112 }
 113
 114
 115 //------------------------------------------------------------------------------
 116 //------------------------------------------------------------ Avp::initialize()
 117 //------------------------------------------------------------------------------
 118 void Avp::initialize() throw() {
 119   a_engine = NULL;
 120   a_id = helpers::AVPID__AVP; // (0,0)
 121   a_flags = 0x00;
 122   a_insertionPositionForChilds = 0;
 123   a_OctetString = NULL;
 124   a_Integer32 = NULL;
 125   a_Integer64 = NULL;
 126   a_Unsigned32 = NULL;
 127   a_Unsigned64 = NULL;
 128   a_Float32 = NULL;
 129   a_Float64 = NULL;
 130   //a_avps.clear();
 131   a_Address = NULL;
 132   a_Time = NULL;
 133   a_UTF8String = NULL;
 134   a_DiameterIdentity = NULL;
 135   a_DiameterURI = NULL;
 136   a_Enumerated = NULL;
 137   a_IPFilterRule = NULL;
 138   a_QoSFilterRule = NULL;
 139   a_Unknown = NULL;
 140   //a_finds.clear();
 141   /////////////////////
 142   // Format specific //
 143   /////////////////////
 144   initializeByFormat();
 145 }
 146
 147
 148 //------------------------------------------------------------------------------
 149 //----------------------------------------------------------------- Avp::clear()
 150 //------------------------------------------------------------------------------
 151 void Avp::clear() throw(anna::RuntimeException) {
 152   delete a_OctetString;
 153   delete a_Integer32;
 154   delete a_Integer64;
 155   delete a_Unsigned32;
 156   delete a_Unsigned64;
 157   delete a_Float32;
 158   delete a_Float64;
 159
 160   for(avp_iterator it = avp_begin(); it != avp_end(); it++) { /*avp(it)->clear(); */getEngine()->releaseAvp(avp(it)); }
 161
 162   a_avps.clear();
 163   delete a_Address;
 164   delete a_Time;
 165   delete a_UTF8String;
 166   delete a_DiameterIdentity;
 167   delete a_DiameterURI;
 168   delete a_Enumerated;
 169   delete a_IPFilterRule;
 170   delete a_QoSFilterRule;
 171   delete a_Unknown;
 172   // Cache system:
 173   a_finds.clear();
 174   /////////////////////
 175   // Format specific //
 176   /////////////////////
 177   clearByFormat();
 178   // Initialize:
 179   initialize();
 180 }
 181
 182
 183 //------------------------------------------------------------------------------
 184 //-------------------------------------------------------------- Avp::avp_find()
 185 //------------------------------------------------------------------------------
 186 avp_iterator Avp::avp_find(avp_container &avps, AvpId id, unsigned int position) throw() {
 187   int match = 0;
 188   Avp *aux;
 189
 190   for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
 191     aux = (*it).second;
 192
 193     if(aux && (aux->getId() == id)) {
 194       match++;
 195
 196       if(match == position) return it;
 197     }
 198   }
 199
 200   return avps.end();
 201 }
 202
 203
 204 //------------------------------------------------------------------------------
 205 //---------------------------------------------------------------- Avp::addAvp()
 206 //------------------------------------------------------------------------------
 207 Avp * Avp::addAvp(avp_container &avps, int &insertionPositionForChilds, AvpId id, Engine *engine) throw() {
 208   Avp * result = engine->allocateAvp();
 209   result->setId(id);
 210   addChild(avps, insertionPositionForChilds, result);
 211   return result;
 212 }
 213
 214
 215 //------------------------------------------------------------------------------
 216 //------------------------------------------------------------- Avp::removeAvp()
 217 //------------------------------------------------------------------------------
 218 bool Avp::removeAvp(avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine) throw() {
 219   bool removed = false;
 220   bool do_remove = true;
 221   int position = ocurrence;
 222
 223   if(position < 0) {  /* reversed access */
 224     position = countAvp(avps, id) + 1 + position;
 225
 226     // Special cases -> 0 and negative results:
 227     // (1) User wants to remove the last, but no avp is found: position = 0 + 1 - 1 = 0 (would removes all but, no avp will be found: return now)
 228     // (2) User wants to remove some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (would removes all !!!: return to avoid unexpected behaviour)
 229     // (2) User wants to remove some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
 230     if(position <= 0) do_remove = false;
 231   }
 232
 233   if(do_remove) {
 234     int n = position ? position : 1 /* will search always the first and remove, the first and remove, the first and remove ... */;
 235     avp_iterator it;
 236
 237     while((it = avp_find(avps, id, n)) != avps.end()) {
 238       engine->releaseAvp((*it).second);
 239       avps.erase(it);
 240       removed = true;
 241
 242       if(position) break;
 243     }
 244   }
 245
 246   if(removed) {
 247     // Cache system reset (remove will invalidate cached findings):
 248     finds.clear();
 249     LOGDEBUG(
 250       const stack::Avp *stackAvp = getStackAvp(id, engine);
 251       std::string msg = "Removed Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 252       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 253       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 254     );
 255   } else {
 256     LOGDEBUG(
 257       const stack::Avp *stackAvp = getStackAvp(id, engine);
 258       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 259       msg += anna::functions::asString(" with provided ocurrence (%d), in order to be removed", ocurrence);
 260       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 261     );
 262   }
 263
 264   return removed;
 265 }
 266
 267
 268 //------------------------------------------------------------------------------
 269 //-------------------------------------------------------------- Avp::countAvp()
 270 //------------------------------------------------------------------------------
 271 int Avp::countAvp(const avp_container &avps, AvpId id) throw() {
 272   int result = 0;
 273   const_avp_iterator it;
 274
 275   while((it = avp_find(avps, id, result + 1)) != avps.end()) result++;
 276
 277   return result;
 278 }
 279
 280
 281 //------------------------------------------------------------------------------
 282 //-------------------------------------------------------------- Avp::firstAvp()
 283 //------------------------------------------------------------------------------
 284 const Avp* Avp::firstAvp(const avp_container &avps, AvpId id) throw() {
 285   const_avp_iterator it = avp_find(avps, id, 1);
 286
 287   if(it != avps.end())
 288     return (*it).second;
 289
 290   return NULL;
 291 }
 292
 293
 294 //------------------------------------------------------------------------------
 295 //----------------------------------------------------------- Avp::countChilds()
 296 //------------------------------------------------------------------------------
 297 int Avp::countChilds(const avp_container &avps) throw() {
 298   return avps.size();
 299 }
 300
 301
 302 //------------------------------------------------------------------------------
 303 //---------------------------------------------------------------- Avp::getAvp()
 304 //------------------------------------------------------------------------------
 305 const Avp *Avp::getAvp(const avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine, anna::Exception::Mode::_v emode) throw(anna::RuntimeException) {
 306   if(ocurrence == 0) {
 307     LOGDEBUG(anna::Logger::debug("Ocurrence number zero has no sense. NULL returned.", ANNA_FILE_LOCATION));
 308     return NULL;
 309   }
 310
 311   bool do_search = true;
 312   bool cached;
 313   int position = ocurrence;
 314
 315   if(position < 0) {  /* reversed access */
 316     position = countAvp(avps, id) + 1 + position;
 317
 318     // Special cases -> 0 and negative results:
 319     // (1) User wants to get the last, but no avp is found: position = 0 + 1 - 1 = 0 (can't find 0-position ...)
 320     // (2) User wants to get some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (can't find 0-position ...)
 321     // (2) User wants to get some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
 322     if(position <= 0) do_search = false;
 323   }
 324
 325   const Avp * result = NULL;
 326
 327   if(do_search) {
 328     // Search at cache finds:
 329     find_key key(id, position);
 330     find_iterator fit = finds.find(key);
 331     cached = (fit != finds.end());
 332
 333     if(cached) {
 334       result = (*fit).second;
 335     } else {
 336       const_avp_iterator it = avp_find(avps, id, position);
 337
 338       if(it != avps.end()) {
 339         result = (*it).second;
 340         finds[key] = const_cast<Avp*>(result); // store in cache
 341       }
 342     }
 343   }
 344
 345   // Avp found:
 346   if(result) {
 347     LOGDEBUG(
 348       const stack::Avp *stackAvp = getStackAvp(id, engine);
 349       std::string msg = "Found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 350       msg += anna::functions::asString(" with provided ocurrence (%d) which was ", ocurrence);
 351       msg += cached ? "already cached:\n" : "the first search, now cached:\n";
 352       msg += result->asXMLString();
 353       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 354     );
 355     return result;
 356   }
 357
 358   // Avp not found:
 359   switch(emode) {
 360   case anna::Exception::Mode::Throw: {
 361     const stack::Avp *stackAvp = getStackAvp(id, engine);
 362     std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 363     msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 364     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 365     break;
 366   }
 367   case anna::Exception::Mode::Trace: {
 368     LOGWARNING(
 369       const stack::Avp *stackAvp = getStackAvp(id, engine);
 370       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 371       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 372       anna::Logger::warning(msg, ANNA_FILE_LOCATION);
 373     );
 374     break;
 375   }
 376   case anna::Exception::Mode::Ignore: {
 377     LOGDEBUG(
 378       const stack::Avp *stackAvp = getStackAvp(id, engine);
 379       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 380       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 381       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 382     );
 383     break;
 384   }
 385   }
 386
 387   return NULL;
 388 }
 389
 390
 391 //------------------------------------------------------------------------------
 392 //--------------------------------------------------------------- Avp::_getAvp()
 393 //------------------------------------------------------------------------------
 394 const Avp *Avp::_getAvp(AvpId id, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
 395   // Dictionary stack avp and format (this):
 396   const stack::Avp *stackAvp = getStackAvp();
 397   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 398
 399   if(!stackFormat || !stackFormat->isGrouped())
 400     throw anna::RuntimeException("This method only applies over grouped avps.", ANNA_FILE_LOCATION);
 401
 402   return getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
 403 }
 404
 405
 406 //------------------------------------------------------------------------------
 407 //---------------------------------------------------------- Avp::assertFormat()
 408 //------------------------------------------------------------------------------
 409 void Avp::assertFormat(const std::string &name) const throw(anna::RuntimeException) {
 410   // Dictionary stack avp and format:
 411   const stack::Avp *stackAvp = getStackAvp();
 412   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 413   std::string format = stackFormat ? stackFormat->getName() : "Unknown";
 414
 415   if(format != name) {
 416     std::string msg = "The Avp ";
 417     msg += anna::diameter::functions::avpIdAsPairString(a_id);
 418     msg += " with format '";
 419     msg += format;
 420     msg += "' is not compatible with the API method used (";
 421     msg += name;
 422     msg += ")";
 423     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 424   }
 425 }
 426
 427
 428 //------------------------------------------------------------------------------
 429 //--------------------------------------------------------------- Avp::flagsOK()
 430 //------------------------------------------------------------------------------
 431 bool Avp::flagsOK() const throw() {
 432   // Dictionary stack avp:
 433   const stack::Avp *stackAvp = getStackAvp();
 434
 435   if(!stackAvp) {
 436     anna::Logger::error("Impossible to decide if flags are correct because stack avp is not identified. Assume flags ok", ANNA_FILE_LOCATION);
 437     return true;
 438   };
 439
 440   // Assignments
 441   bool Vnone = (stackAvp->getVbit() == stack::Avp::FlagRule::None);
 442
 443   bool Vmust = (stackAvp->getVbit() == stack::Avp::FlagRule::must);
 444
 445   bool Vmustnot = (stackAvp->getVbit() == stack::Avp::FlagRule::mustnot);
 446
 447   bool Mnone = (stackAvp->getMbit() == stack::Avp::FlagRule::None);
 448
 449   bool Mmust = (stackAvp->getMbit() == stack::Avp::FlagRule::must);
 450
 451   bool Mmustnot = (stackAvp->getMbit() == stack::Avp::FlagRule::mustnot);
 452
 453   bool Pnone = (stackAvp->getPbit() == stack::Avp::FlagRule::None);
 454
 455   bool Pmust = (stackAvp->getPbit() == stack::Avp::FlagRule::must);
 456
 457   bool Pmustnot = (stackAvp->getPbit() == stack::Avp::FlagRule::mustnot);
 458
 459   // V-bit
 460   if((Vnone && Mnone && Pnone && vendorBit()) || (Vmust && !vendorBit()) || (Vmustnot && vendorBit())) {
 461     anna::Logger::error("Vendor Bit (V) incoherence found", ANNA_FILE_LOCATION);
 462     return false;
 463   }
 464
 465   // Exit on permissive mode:
 466   if(getEngine()->ignoreFlagsOnValidation()) return true;  // Ignore checking for AVP 'M' & 'P' bits
 467
 468   // M-bit
 469   if((Mmust && !mandatoryBit()) || (Mmustnot && mandatoryBit())) {
 470     anna::Logger::error("Mandatory Bit (M) incoherence found", ANNA_FILE_LOCATION);
 471     return false;
 472   }
 473
 474   // P-bit
 475   if((Pmust && !encryptionBit()) || (Pmustnot && encryptionBit())) {
 476     anna::Logger::error("Encryption Bit (P) incoherence found", ANNA_FILE_LOCATION);
 477     return false;
 478   }
 479
 480   // Reserved bits
 481   if((a_flags & 0x1f) != 0x00) {
 482     anna::Logger::error("Any (or more than one) of the reserved avp flags bit has been activated. Reserved bits must be null", ANNA_FILE_LOCATION);
 483     return false;
 484   }
 485
 486   return true;
 487 }
 488
 489
 490 //------------------------------------------------------------------------------
 491 //----------------------------------------------------------------- Avp::setId()
 492 //------------------------------------------------------------------------------
 493 void Avp::setId(AvpId id) throw(anna::RuntimeException) {
 494   // Generic AVP assignment has no sense
 495   if(id == helpers::AVPID__AVP) return;
 496
 497   // Clear class content:
 498   clear();
 499   // Id assignment:
 500   a_id = id;
 501   // Dictionary stack avp and format:
 502   const stack::Avp *stackAvp = getStackAvp(); // based on dictionary and a_id
 503   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 504
 505   // Dictionary flags for known types:
 506   if(stackAvp) {
 507     if(stackAvp->getVbit() == stack::Avp::FlagRule::must) a_flags |= VBitMask;
 508
 509     if(stackAvp->getMbit() == stack::Avp::FlagRule::must) a_flags |= MBitMask;
 510
 511     if(stackAvp->getPbit() == stack::Avp::FlagRule::must) a_flags |= PBitMask;
 512   } else {
 513     if(a_id.second != 0) a_flags |= VBitMask; else a_flags &= (~VBitMask);
 514   }
 515
 516   if(!stackFormat) {  // Unknown Avp
 517     LOGDEBUG(
 518       std::string msg = "Unknown format for AVP identifier ";
 519       msg += anna::diameter::functions::avpIdAsPairString(id);
 520       msg += ". Raw data without specific format will be managed";
 521       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 522     );
 523     a_Unknown = new Unknown();
 524     return;
 525   }
 526
 527   // Avp class formats (Avp child classes should implement this source code block for application-specific formats):
 528   if(stackFormat->isOctetString()) a_OctetString = new OctetString();
 529   else if(stackFormat->isInteger32()) a_Integer32 = new Integer32();
 530   else if(stackFormat->isInteger64()) a_Integer64 = new Integer64();
 531   else if(stackFormat->isUnsigned32()) a_Unsigned32 = new Unsigned32();
 532   else if(stackFormat->isUnsigned64()) a_Unsigned64 = new Unsigned64();
 533   else if(stackFormat->isFloat32()) a_Float32 = new Float32();
 534   else if(stackFormat->isFloat64()) a_Float64 = new Float64();
 535   //else if (stackFormat->isGrouped())
 536   else if(stackFormat->isAddress()) a_Address = new Address();
 537   else if(stackFormat->isTime()) a_Time = new Time();
 538   else if(stackFormat->isUTF8String()) a_UTF8String = new UTF8String();
 539   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity = new DiameterIdentity();
 540   else if(stackFormat->isDiameterURI()) a_DiameterURI = new DiameterURI();
 541   else if(stackFormat->isEnumerated()) a_Enumerated = new Enumerated();
 542   else if(stackFormat->isIPFilterRule()) a_IPFilterRule = new IPFilterRule();
 543   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule = new QoSFilterRule();
 544
 545   /////////////////////
 546   // Format specific //
 547   /////////////////////
 548   allocationByFormat(stackFormat);
 549 }
 550
 551
 552 //------------------------------------------------------------------------------
 553 //----------------------------------------------------------------- Avp::setId()
 554 //------------------------------------------------------------------------------
 555 void Avp::setId(const char *name) throw(anna::RuntimeException) {
 556   setId(getEngine()->avpIdForName(name));
 557 }
 558
 559
 560 //------------------------------------------------------------------------------
 561 //---------------------------------------------------------------- Avp::addAvp()
 562 //------------------------------------------------------------------------------
 563 Avp * Avp::addAvp(const char *name) throw(anna::RuntimeException) {
 564   return addAvp(getEngine()->avpIdForName(name));
 565 }
 566
 567
 568 //------------------------------------------------------------------------------
 569 //------------------------------------------------------------- Avp::removeAvp()
 570 //------------------------------------------------------------------------------
 571 bool Avp::removeAvp(const char *name, int ocurrence) throw(anna::RuntimeException) {
 572   return removeAvp(getEngine()->avpIdForName(name), ocurrence);
 573 }
 574
 575
 576 //------------------------------------------------------------------------------
 577 //--------------------------------------------------------------- Avp::_getAvp()
 578 //------------------------------------------------------------------------------
 579 const Avp *Avp::_getAvp(const char *name, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
 580   return getAvp(getEngine()->avpIdForName(name), ocurrence, emode);
 581 }
 582
 583
 584 //------------------------------------------------------------------------------
 585 //-------------------------------------------------------------- Avp::countAvp()
 586 //------------------------------------------------------------------------------
 587 int Avp::countAvp(const char *name) const throw(anna::RuntimeException) {
 588   return countAvp(getEngine()->avpIdForName(name));
 589 }
 590
 591 //------------------------------------------------------------------------------
 592 //------------------------------------------------------------- Avp::getLength()
 593 //------------------------------------------------------------------------------
 594 U24 Avp::getLength() const throw() {
 595   U24 result;
 596   // Avp format:
 597   const stack::Avp *stackAvp = getStackAvp();
 598   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 599   // Header length:
 600   result = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
 601
 602   if(!stackFormat) {
 603     result += a_Unknown->getSize();
 604     return result;
 605   }
 606
 607   if(stackFormat->isOctetString()) result += a_OctetString->getSize();
 608   else if(stackFormat->isInteger32()) result += a_Integer32->getSize();
 609   else if(stackFormat->isInteger64()) result += a_Integer64->getSize();
 610   else if(stackFormat->isUnsigned32()) result += a_Unsigned32->getSize();
 611   else if(stackFormat->isUnsigned64()) result += a_Unsigned64->getSize();
 612   else if(stackFormat->isFloat32()) result += a_Float32->getSize();
 613   else if(stackFormat->isFloat64()) result += a_Float64->getSize();
 614   else if(stackFormat->isGrouped()) for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) result += 4 * REQUIRED_WORDS(avp(it)->getLength());
 615   else if(stackFormat->isAddress()) result += a_Address->getSize();
 616   else if(stackFormat->isTime()) result += a_Time->getSize();
 617   else if(stackFormat->isUTF8String()) result += a_UTF8String->getSize();
 618   else if(stackFormat->isDiameterIdentity()) result += a_DiameterIdentity->getSize();
 619   else if(stackFormat->isDiameterURI()) result += a_DiameterURI->getSize();
 620   else if(stackFormat->isEnumerated()) result += a_Enumerated->getSize();
 621   else if(stackFormat->isIPFilterRule()) result += a_IPFilterRule->getSize();
 622   else if(stackFormat->isQoSFilterRule()) result += a_QoSFilterRule->getSize();
 623
 624   /////////////////////
 625   // Format specific //
 626   /////////////////////
 627   result += getLengthByFormat(stackFormat);
 628   return result;
 629 }
 630
 631
 632 //------------------------------------------------------------------------------
 633 //-------------------------------------------- Avp::unknownAvpWithMandatoryBit()
 634 //------------------------------------------------------------------------------
 635 void Avp::unknownAvpWithMandatoryBit(Message *answer) const throw(anna::RuntimeException) {
 636   OamModule &oamModule = OamModule::instantiate();
 637   const char *c_aid = STRING_WITH_QUOTATION_MARKS__C_STR(anna::diameter::functions::avpIdAsPairString(a_id));
 638   oamModule.activateAlarm(OamModule::Alarm::AvpDecode__UnknownAvp__s__WithMandatoryBit, c_aid);
 639   oamModule.count(OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit);
 640   LOGWARNING(
 641     std::string msg = anna::functions::asString("Detected unknown Avp %s with mandatory bit activated", c_aid);
 642     anna::Logger::warning(msg, ANNA_FILE_LOCATION);
 643   );
 644
 645   if(answer) {
 646     answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_UNSUPPORTED);
 647     answer->setNewFailedAvp((Avp*)this);
 648   }
 649 }
 650
 651 //------------------------------------------------------------------------------
 652 //-------------------------------------------------------- Avp::decodeDataPart()
 653 //------------------------------------------------------------------------------
 654 void Avp::decodeDataPart(const char * buffer, int size, Message *answer) throw(anna::RuntimeException) {
 655   // OAM
 656   OamModule &oamModule = OamModule::instantiate();
 657   // Dictionary stack avp and format:
 658   const stack::Avp *stackAvp = getStackAvp();
 659   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 660
 661   if(!stackFormat) {
 662     a_Unknown->decode(buffer, size);
 663     return;
 664   }
 665
 666   if(stackFormat->isOctetString()) a_OctetString->decode(buffer, size);
 667   else if(stackFormat->isInteger32()) a_Integer32->decode(buffer, size);
 668   else if(stackFormat->isInteger64()) a_Integer64->decode(buffer, size);
 669   else if(stackFormat->isUnsigned32()) a_Unsigned32->decode(buffer, size);
 670   else if(stackFormat->isUnsigned64()) a_Unsigned64->decode(buffer, size);
 671   else if(stackFormat->isFloat32()) a_Float32->decode(buffer, size);
 672   else if(stackFormat->isFloat64()) a_Float64->decode(buffer, size);
 673   else if(stackFormat->isGrouped()) {
 674     if(size == 0) {
 675       LOGDEBUG(anna::Logger::debug("Grouped Avp has empty data part", ANNA_FILE_LOCATION));
 676       return;
 677     }
 678
 679     if((size % 4) != 0) {
 680       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
 681       oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
 682       throw anna::RuntimeException("Avp format error, the avp length is incorrect (must be multiple of 4 on grouped type)", ANNA_FILE_LOCATION);
 683     }
 684
 685     int avpPos = 0;
 686     Avp* avp;
 687     anna::DataBlock db;
 688
 689     while(avpPos < size) {
 690       try {
 691         avp = getEngine()->allocateAvp();
 692         db.assign(buffer + avpPos, size - avpPos /* is valid to pass total size (indeed i don't know the real avp size) because it will be limited and this has deep copy disabled (no memory is reserved) */);
 693         avp -> decode(db, answer);
 694       } catch(anna::RuntimeException &ex) {
 695         getEngine()->releaseAvp(avp);
 696         throw;
 697       }
 698
 699       addChild(avp);
 700       avpPos += 4 * REQUIRED_WORDS(avp->getLength());
 701     }
 702   } else if(stackFormat->isAddress()) a_Address->decode(buffer, size);
 703   else if(stackFormat->isTime()) a_Time->decode(buffer, size);
 704   else if(stackFormat->isUTF8String()) a_UTF8String->decode(buffer, size);
 705   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->decode(buffer, size);
 706   else if(stackFormat->isDiameterURI()) a_DiameterURI->decode(buffer, size);
 707   else if(stackFormat->isEnumerated()) a_Enumerated->decode(buffer, size);
 708   else if(stackFormat->isIPFilterRule()) a_IPFilterRule->decode(buffer, size);
 709   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->decode(buffer, size);
 710
 711   /////////////////////
 712   // Format specific //
 713   /////////////////////
 714   decodeDataPartByFormat(buffer, size, stackFormat);
 715 }
 716
 717 //------------------------------------------------------------------------------
 718 //---------------------------------------------------------------- Avp::decode()
 719 //------------------------------------------------------------------------------
 720 void Avp::decode(const anna::DataBlock &db, Message *answer) throw(anna::RuntimeException) {
 721   // OAM
 722   OamModule &oamModule = OamModule::instantiate();
 723
 724   if(db.getSize() < HeaderLengthVinactive) {
 725     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 726     oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 727     // DIAMETER_INVALID_AVP_LENGTH; // no podré construir un avp fiable, así que no registro el result-code
 728     throw anna::RuntimeException("Not enough bytes to cover avp header length", ANNA_FILE_LOCATION);
 729   }
 730
 731   const char * buffer = db.getData();
 732
 733   //       0                   1                   2                   3
 734   //       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 735   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 736   //      |                           AVP Code                            |
 737   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 738   //      |   AVP Flags   |                  AVP Length                   |
 739   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 740   //      |                        Vendor-ID (opt)                        |
 741   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 742   //      |    Data ...
 743   //      +-+-+-+-+-+-+-+-+
 744   // Code flags and vendor-id
 745   U32 code = DECODE4BYTES_INDX_VALUETYPE(buffer, 0, U32);
 746
 747   a_flags = (S8)buffer[4];
 748
 749   U32 vendorID = helpers::VENDORID__base;
 750
 751   if(vendorBit()) {
 752     if(db.getSize() < HeaderLengthVactive) {
 753       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 754       oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 755       // DIAMETER_INVALID_AVP_LENGTH; // no podré construir un avp fiable, así que no registro el result-code
 756       throw anna::RuntimeException(anna::functions::asString("Not enough bytes to cover avp header length (avp code = %u)", code), ANNA_FILE_LOCATION);
 757     }
 758
 759     vendorID = DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32);
 760
 761     if(vendorID == helpers::VENDORID__base) {
 762       //      A vendor ID value of zero (0) corresponds to the IETF adopted AVP
 763       //      values, as managed by the IANA. Since the absence of the vendor
 764       //      ID field implies that the AVP in question is not vendor specific,
 765       //      ...
 766       //      implementations MUST NOT use the zero (0) vendor ID.
 767       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
 768       oamModule.count(OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
 769       throw anna::RuntimeException(anna::functions::asString("Incoherence between activated V bit and zeroed vendor-id value received (avp code = %u)", code), ANNA_FILE_LOCATION);
 770     }
 771   }
 772
 773   // Avp identifier
 774   setId(AvpId(code, vendorID));
 775   // Flags could have been updated regarding dictionary, but during decoding we must respect buffer received:
 776   a_flags = (S8)buffer[4];
 777
 778   // Here i know id and flags:
 779   //   The 'M' Bit, known as the Mandatory bit, indicates whether support of the AVP is required. If an AVP with the 'M' bit set is received by
 780   //   a Diameter client, server, proxy, or translation agent and either the AVP or its value is unrecognized, the message MUST be rejected.
 781   //   Diameter Relay and redirect agents MUST NOT reject messages with unrecognized AVPs.
 782   if(!getStackAvp() && mandatoryBit()) unknownAvpWithMandatoryBit(answer);
 783
 784   // Avp Length
 785   U24 length = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
 786   // Data start position:
 787   int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
 788   // Data part:
 789   int dataBytes = length - startDataPos;
 790
 791   if(dataBytes < 0) {
 792     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
 793     oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
 794
 795     if(answer) {
 796       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_LENGTH);
 797       answer->setNewFailedAvp(a_id);
 798     }
 799
 800     throw anna::RuntimeException(anna::functions::asString("Avp format error, the avp length is incorrect (avp code = %u)", code), ANNA_FILE_LOCATION);
 801   }
 802
 803   try {
 804     decodeDataPart(buffer + startDataPos, dataBytes, answer);
 805   } catch(anna::RuntimeException &ex) {
 806     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__DataPartInconsistence);
 807     oamModule.count(OamModule::Counter::AvpDecode__DataPartInconsistence);
 808
 809     if(answer) {
 810       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE); // unspecified error ...
 811       answer->setNewFailedAvp((Avp*)this);
 812     }
 813
 814     throw anna::RuntimeException(anna::functions::asString("Internal Avp decoding error (avp code = %u): %s", code, ex.getText().c_str()), ANNA_FILE_LOCATION);
 815   }
 816 }
 817
 818
 819 //------------------------------------------------------------------------------
 820 //----------------------------------------------------------- Avp::getStackAvp()
 821 //------------------------------------------------------------------------------
 822 const anna::diameter::stack::Avp *Avp::getStackAvp(AvpId id, Engine *engine) throw() {
 823   const stack::Dictionary * dictionary = engine->getDictionary();
 824   return (dictionary ? (dictionary->getAvp(id)) : NULL);
 825 }
 826
 827
 828 //------------------------------------------------------------------------------
 829 //------------------------------------------------------------------- Avp::fix()
 830 //------------------------------------------------------------------------------
 831 void Avp::fix(avp_container &avps, find_container &finds, int &insertionPositionForChilds, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd) throw() {
 832   // Exit cases
 833   if(avps.size() == 0) return;  // empty content, nothing to fix
 834
 835   if(ruleBegin == ruleEnd) return;  // no reference. Cannot fix
 836
 837   // Copy reference container and clear internal map in order to build a fixed version:
 838   avp_container unfixedAvps;
 839
 840   for(const_avp_iterator it = avps.begin(); it != avps.end(); it++)
 841     unfixedAvps[(*it).first] = (*it).second;
 842
 843   avps.clear();
 844   // Cache system reset (fix probably will invalidate cached findings):
 845   finds.clear();
 846   insertionPositionForChilds = 0;
 847   avp_iterator avp_it;
 848   Avp * avp;
 849
 850   for(anna::diameter::stack::const_avprule_iterator rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 851     while((avp_it = Avp::avp_find(unfixedAvps, (*rule_it).second.getId(), 1)) != unfixedAvps.end()) {
 852       avp = (*avp_it).second;
 853       addChild(avps, insertionPositionForChilds, avp);
 854       unfixedAvps.erase(avp_it); // processed
 855     }
 856   }
 857
 858   // Add remaining avps:
 859   for(avp_it = unfixedAvps.begin(); avp_it != unfixedAvps.end(); avp_it++) {
 860     avp = (*avp_it).second;
 861
 862     if(avp) addChild(avps, insertionPositionForChilds, avp);
 863   }
 864
 865   // Fix grouped Avps:
 866   for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
 867     avp = (*it).second;
 868
 869     if(avp->hasChildren()) avp->fix();
 870   }
 871 }
 872
 873
 874 //------------------------------------------------------------------------------
 875 //------------------------------------------------------------------- Avp::fix()
 876 //------------------------------------------------------------------------------
 877 void Avp::fix() throw() {
 878   // Dictionary stack avp:
 879   const stack::Avp *stackAvp = getStackAvp();
 880   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 881
 882   if(!stackAvp) {
 883     //LOGDEBUG(anna::Logger::debug("No dictionary avp reference found. Cannot fix.", ANNA_FILE_LOCATION));
 884     return;
 885   }
 886
 887   if(!stackFormat || !stackFormat->isGrouped()) {
 888     //LOGDEBUG(anna::Logger::debug("Avp is not grouped. Nothing fix.", ANNA_FILE_LOCATION));
 889     return;
 890   }
 891
 892   fix(a_avps, (find_container&)a_finds, a_insertionPositionForChilds, stackAvp->avprule_begin(), stackAvp->avprule_end());
 893 }
 894
 895
 896 //------------------------------------------------------------------------------
 897 //------------------------------------------------------------ Avp::validLevel()
 898 //------------------------------------------------------------------------------
 899 bool Avp::validLevel(const avp_container &avps, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd, Engine * engine, const std::string & parentDescription, Message *answer) throw(anna::RuntimeException) {
 900   bool result = true;
 901   // OAM
 902   OamModule &oamModule = OamModule::instantiate();
 903   ///////////
 904   // Fixed //
 905   ///////////
 906   // auxiliary
 907   AvpId id;
 908   const_avp_iterator avp_it = avps.begin();
 909   anna::diameter::stack::const_avprule_iterator rule_it;
 910   bool okFixed;
 911
 912   for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 913     okFixed = true;
 914
 915     if((*rule_it).second.isFixed()) {
 916       if(avps.size() == 0) break;  // cardinality checking will show this anomaly
 917
 918       if(avp_it != avps.end()) {
 919         id = Avp::avp(avp_it)->getId();
 920
 921         if(id != (*rule_it).second.getId()) {
 922           okFixed = false;
 923           // Missing fixed rule: %s
 924         } else if(Avp::avp_find(avps, id, 2) != avps.end()) {
 925           okFixed = false;
 926           // More than one fixed ocurrency for rule %s (*)
 927         }
 928
 929         avp_it++;
 930         // (*) for (register int k = 0; k < (*rule_it).second.getQualMax(); k++) avp_it++
 931       } else
 932         okFixed = false;
 933
 934       if(!okFixed) {
 935         result = false;
 936         // OAM & Depth management
 937         oamModule.activateAlarm(OamModule::Alarm::LevelValidation__MissingFixedRule__s__Inside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)));
 938         oamModule.count(OamModule::Counter::LevelValidation__MissingFixedRule);
 939
 940         if(answer) {
 941           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
 942           answer->setNewFailedAvp((*rule_it).second.getId());
 943         }
 944
 945         engine->validationAnomaly(anna::functions::asString("Missing fixed rule %s inside %s", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
 946       }
 947     } else break; // finish fixed
 948   }
 949
 950   /////////////////
 951   // Cardinality // Mandatory control is implicit here
 952   /////////////////
 953   anna::diameter::stack::const_avprule_iterator generic_rule_it = ruleEnd;
 954   int min, max, amount;
 955
 956   for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 957     if((*rule_it).second.isAny()) { generic_rule_it = rule_it; continue; }  // generic Avp will be managed after
 958
 959     id = (*rule_it).second.getId();
 960     min = (*rule_it).second.getQualMin();
 961     max = (*rule_it).second.getQualMax(); // -1 means infinite
 962     amount = Avp::countAvp(avps, id);
 963
 964     if((amount < min) || ((max != -1) && (amount > max))) {
 965       // Failed rule %s for cardinality (found %d items)
 966       result = false;
 967       // OAM & Depth management
 968       oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedRule__s__ForCardinality_Found__d__ItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription));
 969       oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinality);
 970
 971       if(amount < min) {
 972         oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded);
 973
 974         if(answer) {
 975           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
 976           answer->setNewFailedAvp(id);
 977         }
 978       } else {
 979         oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded);
 980
 981         if(answer) {
 982           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_OCCURS_TOO_MANY_TIMES);
 983           answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */);
 984         }
 985       }
 986
 987       engine->validationAnomaly(anna::functions::asString("Failed rule %s for cardinality (found %d items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
 988     }
 989   }
 990
 991   bool haveGeneric = (generic_rule_it != ruleEnd);
 992   /////////////////
 993   // Generic AVP //
 994   /////////////////
 995   bool foundInRules;
 996   std::map < AvpId, int /* dummy */ > disregarded; // 'Disregardeds' are Avps not in rules list
 997   std::map < AvpId, int /* dummy */ >::const_iterator disregarded_it;
 998
 999   for(avp_it = avps.begin(); avp_it != avps.end(); avp_it++) {
1000     id = Avp::avp(avp_it)->getId();
1001     // Find rule for the child:
1002     foundInRules = false;
1003
1004     for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
1005       if((*rule_it).second.getId() == id) {
1006         foundInRules = true;
1007         break;
1008       }
1009     }
1010
1011     if(!foundInRules) {
1012       disregarded[id] = 0;
1013     }
1014   }
1015
1016   // Generic AVP cardinality checkings
1017   int disregardeds = disregarded.size();
1018
1019   if(haveGeneric) {
1020     min = (*generic_rule_it).second.getQualMin();
1021     max = (*generic_rule_it).second.getQualMax(); // -1 means infinite
1022     amount = disregardeds;
1023
1024     if((amount < min) || ((max != -1) && (amount > max))) {
1025       // Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)
1026       result = false;
1027       // OAM & Depth management
1028       oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedGenericAvpRule__s__ForCardinality_Found__d__DisregardedItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription));
1029       oamModule.count(OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem);
1030
1031       if(answer) {
1032         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1033         //answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */); // NO SENSE... what to put ?
1034       }
1035
1036       engine->validationAnomaly(anna::functions::asString("Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
1037     }
1038   } else if(disregardeds) {  // When Generic AVP missing, no disregarded Avps are allowed
1039     // Found %d disregarded items inside %s and Generic AVP was not specified
1040     result = false;
1041     // Build disregarded list as string (unknown as avp id pair):
1042     std::string s_disregardeds = "";
1043     const stack::Avp *stackAvp;
1044
1045     for(disregarded_it = disregarded.begin(); disregarded_it != disregarded.end(); disregarded_it++) {
1046       id = (*disregarded_it).first;
1047       stackAvp = getStackAvp(id, engine);
1048       s_disregardeds += (stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id)));
1049       s_disregardeds += ", ";
1050
1051       // We wouldn't know where are these disregarded, but...
1052       if(answer) {
1053         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1054         answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */);
1055       }
1056     }
1057
1058     s_disregardeds.erase(s_disregardeds.size() - 2, 2); // remove last ', '
1059     // OAM & Depth management
1060     oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FoundDisregardedItemsInside__s__AndGenericAVPWasNotSpecified__s__, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds));
1061     oamModule.count(OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified);
1062     engine->validationAnomaly(anna::functions::asString("Found disregarded items inside %s and Generic AVP was not specified: %s", STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds)));
1063   }
1064
1065   return result;
1066 }
1067
1068
1069 //------------------------------------------------------------------------------
1070 //----------------------------------------------------------------- Avp::valid()
1071 //------------------------------------------------------------------------------
1072 bool Avp::valid(const std::string & parentDescription, Message *answer) const throw(anna::RuntimeException) {
1073   // OAM
1074   OamModule &oamModule = OamModule::instantiate();
1075   // Dictionary stack avp:
1076   const stack::Avp *stackAvp = getStackAvp();
1077   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1078   std::string me;
1079
1080   if(!stackAvp) {
1081     // No dictionary avp reference found. Cannot validate
1082     return true; // perhaps a unknown Avp
1083   }
1084
1085   me = parentDescription + "->" + stackAvp->getName();
1086
1087   if(!stackFormat) {
1088     // No format avp reference found. Cannot validate
1089     return true; // perhaps a unknown Avp
1090   }
1091
1092   //////////////////////////////
1093   // Flags coherence checking //
1094   //////////////////////////////
1095   bool result = flagsOK();
1096
1097   if(!result) {
1098     // OAM & Depth management
1099     oamModule.activateAlarm(OamModule::Alarm::AvpValidation__Avp__s__Flags__d__DoesNotFulfillTheDefinedFlagRules__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription()));
1100     oamModule.count(OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules);
1101
1102     if(answer) {
1103       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_BITS);
1104       //answer->setNewFailedAvp((Avp*)this); RFC 6733 says nothing about Failed-AVP in this case...
1105     }
1106
1107     getEngine()->validationAnomaly(anna::functions::asString("The AVP %s flags (%d) does not fulfill the defined flag rules: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription())));
1108   }
1109
1110   //////////////////////
1111   // Enumerated range //
1112   //////////////////////
1113   if(stackFormat->isEnumerated()) {
1114     if(!stackAvp->allowEnum(a_Enumerated->getValue())) {
1115       result = false;
1116       // OAM & Depth management
1117       oamModule.activateAlarm(OamModule::Alarm::AvpValidation__EnumeratedAvp__s__WithValue__d__DoesNotComplyRestriction__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me), a_Enumerated->getValue(), stackAvp->getEnums());
1118       oamModule.count(OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction);
1119
1120       if(answer) {
1121         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE);
1122         answer->setNewFailedAvp((Avp*)this);
1123       }
1124
1125       getEngine()->validationAnomaly(anna::functions::asString("Enumerated AVP %s with value %d does not comply to restriction: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me), a_Enumerated->getValue(), stackAvp->getEnums()));
1126     }
1127   }
1128
1129   ////////////////////
1130   // Level checking //
1131   ////////////////////
1132   result = Avp::validLevel(a_avps, stackAvp->avprule_begin(), stackAvp->avprule_end(), getEngine(), me, answer) && result;
1133
1134   ////////////////////////
1135   // Childrens checking //
1136   ////////////////////////
1137   if(a_id == helpers::base::AVPID__Failed_AVP) return result;  // DON'T VALIDATE CONTENT FOR Failed-AVP, because it won't be valid...
1138
1139   for(const_avp_iterator it = avp_begin(); it != avp_end(); it++)
1140     result = ((*it).second->valid(me, answer)) && result;
1141
1142   return result;
1143 }
1144
1145
1146 //------------------------------------------------------------------------------
1147 //------------------------------------------------------------------ Avp::code()
1148 //------------------------------------------------------------------------------
1149 void Avp::code(char* buffer, int &size) const throw(anna::RuntimeException) {
1150   // Code
1151   buffer[0] = (S8)(a_id.first >> 24);
1152   buffer[1] = (S8)(a_id.first >> 16);
1153   buffer[2] = (S8)(a_id.first >> 8);
1154   buffer[3] = (S8) a_id.first;
1155   // Flags and length
1156   size = getLength();
1157   buffer[4] = (S8) a_flags;
1158   buffer[5] = (S8)(size >> 16);
1159   buffer[6] = (S8)(size >> 8);
1160   buffer[7] = (S8) size;
1161
1162   // Vendor-id
1163   if(vendorBit()) {
1164     buffer[8] = (S8)(a_id.second >> 24);
1165     buffer[9] = (S8)(a_id.second >> 16);
1166     buffer[10] = (S8)(a_id.second >> 8);
1167     buffer[11] = (S8) a_id.second;
1168   }
1169
1170   // Data start position:
1171   int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
1172   // Data part:
1173   S8 * dataPart = buffer + startDataPos;
1174   int dataBytes; // not used but could be useful for checking (size - startDataPos)
1175
1176   if(startDataPos == size) {
1177     LOGDEBUG(anna::Logger::debug("There is no data part to encode", ANNA_FILE_LOCATION));
1178     return;
1179   }
1180
1181   // Avp format:
1182   const stack::Avp *stackAvp = getStackAvp();
1183   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1184
1185   if(!stackFormat) {
1186     a_Unknown->code(dataPart, dataBytes);
1187     return;
1188   }
1189
1190   if(stackFormat->isOctetString()) a_OctetString->code(dataPart, dataBytes);
1191   else if(stackFormat->isInteger32()) a_Integer32->code(dataPart, dataBytes);
1192   else if(stackFormat->isInteger64()) a_Integer64->code(dataPart, dataBytes);
1193   else if(stackFormat->isUnsigned32()) a_Unsigned32->code(dataPart, dataBytes);
1194   else if(stackFormat->isUnsigned64()) a_Unsigned64->code(dataPart, dataBytes);
1195   else if(stackFormat->isFloat32()) a_Float32->code(dataPart, dataBytes);
1196   else if(stackFormat->isFloat64()) a_Float64->code(dataPart, dataBytes);
1197   else if(stackFormat->isGrouped()) {
1198 //      // Each avp encoding will remain padding octets depending on format. In order to
1199 //      //  code grouped content (each avp will be multiple of 4) we clean the entire buffer
1200 //      //  to ensure padding (easier than custom-made for each format):
1201 //      memset(dataPart, 0, size - startDataPos);
1202     char *dataPartGrouped = dataPart;
1203     int dataBytesGrouped;
1204
1205     for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
1206       avp(it)->code(dataPartGrouped, dataBytesGrouped);
1207       dataPartGrouped = dataPartGrouped + 4 * REQUIRED_WORDS(dataBytesGrouped);
1208     }
1209   } else if(stackFormat->isAddress()) a_Address->code(dataPart, dataBytes);
1210   else if(stackFormat->isTime()) a_Time->code(dataPart, dataBytes);
1211   else if(stackFormat->isUTF8String()) a_UTF8String->code(dataPart, dataBytes);
1212   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->code(dataPart, dataBytes);
1213   else if(stackFormat->isDiameterURI()) a_DiameterURI->code(dataPart, dataBytes);
1214   else if(stackFormat->isEnumerated()) a_Enumerated->code(dataPart, dataBytes);
1215   else if(stackFormat->isIPFilterRule()) a_IPFilterRule->code(dataPart, dataBytes);
1216   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->code(dataPart, dataBytes);
1217
1218   /////////////////////
1219   // Format specific //
1220   /////////////////////
1221   codeByFormat(dataPart, stackFormat);
1222 }
1223
1224
1225 //------------------------------------------------------------------------------
1226 //------------------------------------------------------------ Avp::getXMLdata()
1227 //------------------------------------------------------------------------------
1228 std::string Avp::getXMLdata(bool & isHex, const stack::Format *stackFormat) const throw() {
1229   std::string result = "";
1230   isHex = false;
1231   // Unknown
1232 //   try {
1233 //      if (!stackFormat) {
1234 //         isHex = true;
1235 //         return a_Unknown->asHexString();
1236 //      }
1237 //   } catch (anna::RuntimeException &ex) {
1238 //      ex.trace();
1239 //   }
1240
1241   if(!stackFormat) {
1242     isHex = true;
1243     return a_Unknown->asHexString(); // el asHexString del OctetString no puede lanzar una excepcion en realidad
1244   }
1245
1246   // Special case for Address: could launch exception if not printable
1247   try {
1248     if(stackFormat->isAddress()) return a_Address->asPrintableString();
1249   } catch(anna::RuntimeException&) {
1250     //ex.trace();
1251     isHex = true;
1252     return a_Address->asHexString();
1253   }
1254
1255   try {
1256     if(stackFormat->isOctetString()) {
1257       isHex = true;
1258       return a_OctetString->asHexString();
1259     }
1260
1261     // Non-hexadecimal
1262     if(stackFormat->isInteger32()) return a_Integer32->asPrintableString();
1263
1264     if(stackFormat->isInteger64()) return a_Integer64->asPrintableString();
1265
1266     if(stackFormat->isUnsigned32()) return a_Unsigned32->asPrintableString();
1267
1268     if(stackFormat->isUnsigned64()) return a_Unsigned64->asPrintableString();
1269
1270     if(stackFormat->isFloat32()) return a_Float32->asPrintableString();
1271
1272     if(stackFormat->isFloat64()) return a_Float64->asPrintableString();
1273
1274     //if (stackFormat->isAddress()) return a_Address->asPrintableString();
1275
1276     if(stackFormat->isTime()) return a_Time->asPrintableString();
1277
1278     if(stackFormat->isUTF8String()) return a_UTF8String->asPrintableString();
1279
1280     if(stackFormat->isDiameterIdentity()) return a_DiameterIdentity->asPrintableString();
1281
1282     if(stackFormat->isDiameterURI()) return a_DiameterURI->asPrintableString();
1283
1284     if(stackFormat->isEnumerated()) return a_Enumerated->asPrintableString();
1285
1286     if(stackFormat->isIPFilterRule()) return a_IPFilterRule->asPrintableString();
1287
1288     if(stackFormat->isQoSFilterRule()) return a_QoSFilterRule->asPrintableString();
1289
1290     /////////////////////
1291     // Format specific //
1292     /////////////////////
1293     return getXMLdataByFormat(isHex, stackFormat);
1294   } catch(anna::RuntimeException &ex) {
1295     ex.trace();
1296   }
1297
1298   return result;
1299 }
1300
1301
1302 //------------------------------------------------------------------------------
1303 //--------------------------------------------------------------- Avp::fromXML()
1304 //------------------------------------------------------------------------------
1305 void Avp::fromXML(const anna::xml::Node* avpNode) throw(anna::RuntimeException) {
1306   // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1307   const anna::xml::Attribute *name, *code, *vendorCode, *flags, *data, *hexData;
1308   name = avpNode->getAttribute("name", false /* no exception */);
1309   code = avpNode->getAttribute("code", false /* no exception */);
1310   vendorCode = avpNode->getAttribute("vendor-code", false /* no exception */);
1311   flags = avpNode->getAttribute("flags", false /* no exception */);
1312   data = avpNode->getAttribute("data", false /* no exception */);
1313   hexData = avpNode->getAttribute("hex-data", false /* no exception */);
1314   // Dictionary
1315   const stack::Dictionary * dictionary = getEngine()->getDictionary();
1316   const stack::Avp *stackAvp = NULL;
1317   const stack::Format *stackFormat = NULL;
1318
1319   // Compact mode
1320   if(name) {
1321     if(!dictionary) {
1322       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1323       msg += "'>: no dictionary available. Load one or use <'code' + 'flags' + 'vendorCode'> instead of <'name'>";
1324       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1325     }
1326
1327     stackAvp = dictionary->getAvp(name->getValue());
1328
1329     if(!stackAvp) {
1330       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1331       msg += "'>: no avp found for this identifier at available dictionary";
1332       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1333     }
1334
1335     stackFormat = stackAvp->getFormat();
1336   }
1337
1338   // Check attributes exclusiveness
1339   if(name) {  // compact mode
1340     if(code || flags || vendorCode) {
1341       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1342       msg += "'>: avp attributes <'code' + 'flags' + 'vendorCode'> are not allowed if <'name'> is provided";
1343       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1344     }
1345
1346     setId(stackAvp->getId());
1347   } else {
1348     if(!code || !flags || !vendorCode) {
1349       std::string s_code = code ? code->getValue() : "?";
1350       std::string s_flags = flags ? flags->getValue() : "?";
1351       std::string s_vendorCode = vendorCode ? vendorCode->getValue() : "?";
1352       std::string msg = "Error processing avp <code '"; msg += s_code;
1353       msg += "' + flags '"; msg += s_flags;
1354       msg += "' + vendorCode '"; msg += s_vendorCode;
1355       msg += "'>: all must be provided if <'name'> don't";
1356       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1357     }
1358
1359     // Code check
1360     int i_aux = code->getIntegerValue();
1361
1362     if(i_aux < 0) {
1363       std::string msg = "Error processing avp <code '"; msg += code->getValue();
1364       msg += "': negative values are not allowed";
1365       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1366     }
1367
1368     U24 u_code = i_aux;
1369     // Flags check
1370     i_aux = flags->getIntegerValue();
1371
1372     if(i_aux < 0 || i_aux > 256) {
1373       std::string msg = "Error processing avp <flags '"; msg += flags->getValue();
1374       msg += "': out of range [0,256]";
1375       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1376     }
1377
1378     a_flags = i_aux;
1379     int flagsBCK = a_flags;
1380     // VendorCode checks
1381     i_aux = vendorCode->getIntegerValue();
1382
1383     if(i_aux < 0) {
1384       std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1385       msg += "': negative values are not allowed";
1386       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1387     }
1388
1389     U32 u_vendorCode = i_aux;
1390     bool vendorSpecific1 = (u_vendorCode != 0);
1391     bool vendorSpecific2 = (((a_flags) & VBitMask) != 0x00);
1392
1393     if(vendorSpecific1 != vendorSpecific2) {
1394       std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1395       msg += "' and avp <flags '"; msg += flags->getValue();
1396       msg += "': incompatible vendor-specific properties";
1397       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1398     }
1399
1400     // Final assignments
1401     setId(AvpId(u_code, u_vendorCode));
1402     // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
1403     a_flags = flagsBCK;
1404     stackAvp = getStackAvp();
1405     stackFormat = stackAvp ? stackAvp->getFormat() : NULL;
1406   }
1407
1408   // Childrens
1409   // Check if grouped not confirmed
1410   anna::xml::Node::const_child_iterator it;
1411   anna::xml::Node::const_child_iterator minii = avpNode->child_begin();
1412   anna::xml::Node::const_child_iterator maxii = avpNode->child_end();
1413   const bool hasChildren(minii != maxii);
1414
1415   if(hasChildren) {
1416     // We need to confirm is grouped
1417     if(!stackFormat)
1418       throw anna::RuntimeException("An xml avp node with children nodes could not confirmed as Grouped", ANNA_FILE_LOCATION);
1419
1420     if(!stackFormat->isGrouped())
1421       throw anna::RuntimeException("An xml avp node with children nodes is not grouped type", ANNA_FILE_LOCATION);
1422
1423     if(data || hexData)
1424       throw anna::RuntimeException("An xml avp node with children nodes has 'data' or 'hex-data' field", ANNA_FILE_LOCATION);
1425   }
1426
1427   // Presentation
1428   std::string s_avp = name ? (name->getValue()) : (anna::diameter::functions::avpIdAsPairString(a_id));
1429
1430   if(data && hexData) {
1431     std::string msg = "Not allowed both 'data' and 'hex-data' definitions. Avp ";
1432     msg += s_avp;
1433     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1434   }
1435
1436   LOGWARNING(
1437     bool unknown = !stackFormat;
1438     bool octetString = stackFormat && (stackFormat->isOctetString());
1439
1440   if(data && (unknown || octetString)) {
1441   std::string msg = "Not recommended 'data' field at ";
1442   msg += unknown ? "Unknown" : "OctetString";
1443   msg += "-format Avp "; msg += s_avp;
1444   msg += ". Use better 'hex-data' or omit content fields if empty";
1445   anna::Logger::warning(msg, ANNA_FILE_LOCATION);
1446   }
1447   );
1448
1449   if(!stackFormat) {
1450     if(data) a_Unknown->fromPrintableString(data->getValue().c_str());
1451     else if(hexData) a_Unknown->fromHexString(hexData->getValue());
1452
1453     return;
1454   }
1455
1456   if(stackFormat->isOctetString()) {
1457     if(data) a_OctetString->fromPrintableString(data->getValue().c_str());
1458     else if(hexData) a_OctetString->fromHexString(hexData->getValue());
1459   } else if(stackFormat->isInteger32()) {
1460     if(data) a_Integer32->fromPrintableString(data->getValue().c_str());
1461     else if(hexData) a_Integer32->fromHexString(hexData->getValue());
1462   } else if(stackFormat->isInteger64()) {
1463     if(data) a_Integer64->fromPrintableString(data->getValue().c_str());
1464     else if(hexData) a_Integer64->fromHexString(hexData->getValue());
1465   } else if(stackFormat->isUnsigned32()) {
1466     if(data) a_Unsigned32->fromPrintableString(data->getValue().c_str());
1467     else if(hexData) a_Unsigned32->fromHexString(hexData->getValue());
1468   } else if(stackFormat->isUnsigned64()) {
1469     if(data) a_Unsigned64->fromPrintableString(data->getValue().c_str());
1470     else if(hexData) a_Unsigned64->fromHexString(hexData->getValue());
1471   } else if(stackFormat->isFloat32()) {
1472     if(data) a_Float32->fromPrintableString(data->getValue().c_str());
1473     else if(hexData) a_Float32->fromHexString(hexData->getValue());
1474   } else if(stackFormat->isFloat64()) {
1475     if(data) a_Float64->fromPrintableString(data->getValue().c_str());
1476     else if(hexData) a_Float64->fromHexString(hexData->getValue());
1477   } else if(stackFormat->isGrouped()) {
1478     // Childrens
1479     Avp *avp;
1480
1481     for(it = minii; it != maxii; it++) {
1482       std::string nodeName = (*it)->getName();
1483
1484       if(nodeName != "avp") {
1485         std::string msg = "Unsupported grouped avp child node name '"; msg += nodeName;
1486         msg += "': use 'avp'";
1487         throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1488       }
1489
1490       try {
1491         avp =  getEngine()->allocateAvp();
1492         avp -> fromXML(*it);
1493       } catch(anna::RuntimeException &ex) {
1494         getEngine()->releaseAvp(avp);
1495         throw;
1496       }
1497
1498       addAvp(avp);
1499     }
1500   } else if(stackFormat->isAddress()) {
1501     if(data) a_Address->fromPrintableString(data->getValue().c_str());
1502     else if(hexData) a_Address->fromHexString(hexData->getValue());
1503   } else if(stackFormat->isTime()) {
1504     if(data) a_Time->fromPrintableString(data->getValue().c_str());
1505     else if(hexData) a_Time->fromHexString(hexData->getValue());
1506   } else if(stackFormat->isUTF8String()) {
1507     if(data) a_UTF8String->fromPrintableString(data->getValue().c_str());
1508     else if(hexData) a_UTF8String->fromHexString(hexData->getValue());
1509   } else if(stackFormat->isDiameterIdentity()) {
1510     if(data) a_DiameterIdentity->fromPrintableString(data->getValue().c_str());
1511     else if(hexData) a_DiameterIdentity->fromHexString(hexData->getValue());
1512   } else if(stackFormat->isDiameterURI()) {
1513     if(data) a_DiameterURI->fromPrintableString(data->getValue().c_str());
1514     else if(hexData) a_DiameterURI->fromHexString(hexData->getValue());
1515   } else if(stackFormat->isEnumerated()) {
1516     if(data) a_Enumerated->fromPrintableString(data->getValue().c_str());
1517     else if(hexData) a_Enumerated->fromHexString(hexData->getValue());
1518   } else if(stackFormat->isIPFilterRule()) {
1519     if(data) a_IPFilterRule->fromPrintableString(data->getValue().c_str());
1520     else if(hexData) a_IPFilterRule->fromHexString(hexData->getValue());
1521   } else if(stackFormat->isQoSFilterRule()) {
1522     if(data) a_QoSFilterRule->fromPrintableString(data->getValue().c_str());
1523     else if(hexData) a_QoSFilterRule->fromHexString(hexData->getValue());
1524   }
1525
1526   /////////////////////
1527   // Format specific //
1528   /////////////////////
1529   fromXMLByFormat(data, hexData, stackFormat);
1530 }
1531
1532 //------------------------------------------------------------------------------
1533 //----------------------------------------------------------------- Avp::asXML()
1534 //------------------------------------------------------------------------------
1535 anna::xml::Node* Avp::asXML(anna::xml::Node* parent) const throw() {
1536   // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1537   anna::xml::Node* result = parent->createChild("avp");
1538   // Dictionary stack avp and format:
1539   const stack::Avp *stackAvp = getStackAvp();
1540   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1541   bool compactMode = (stackAvp && flagsOK());
1542
1543   if(compactMode) {
1544     result->createAttribute("name", stackAvp->getName());
1545   } else {
1546     result->createAttribute("code", a_id.first);
1547     result->createAttribute("vendor-code", a_id.second);
1548     result->createAttribute("flags", (int)a_flags);
1549   }
1550
1551   // Grouped special case:
1552   if(stackFormat && stackFormat->isGrouped()) {
1553     for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) avp(it)->asXML(result);
1554
1555     return result;
1556   }
1557
1558   // Data part literals:
1559   bool isHex;
1560   std::string value = getXMLdata(isHex, stackFormat);
1561
1562   if(isHex) {
1563     result->createAttribute("hex-data", value);
1564   } else {
1565     result->createAttribute("data", value);
1566     const char *alias = stackAvp->getAlias(value);
1567
1568     if(alias) result->createAttribute("alias", alias);  // additional information
1569   }
1570
1571   return result;
1572 }
1573
1574 //------------------------------------------------------------------------------
1575 //----------------------------------------------------------- Avp::asXMLString()
1576 //------------------------------------------------------------------------------
1577 std::string Avp::asXMLString() const throw() {
1578   anna::xml::Node root("root");
1579   return anna::xml::Compiler().apply(asXML(&root));
1580 }
1581