LSA.h

Go to the documentation of this file.

//
// Copyright (C) 2006 Andras Babos and Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.
//

#ifndef __LSA_HPP__
#define __LSA_HPP__

#include "OSPFPacket_m.h"
#include "OSPFcommon.h"
#include <vector>
#include <math.h>

namespace OSPF {

struct NextHop {
    unsigned char ifIndex;
    IPv4Address   hopAddress;
    RouterID      advertisingRouter;
};

class RoutingInfo
{
private:
    std::vector<NextHop>  nextHops;
    unsigned long         distance;
    OSPFLSA*              parent;

public:
            RoutingInfo  (void) : distance(0), parent(NULL) {}

            RoutingInfo  (const RoutingInfo& routingInfo) : nextHops(routingInfo.nextHops), distance(routingInfo.distance), parent(routingInfo.parent) {}

    virtual ~RoutingInfo(void) {}

    void            AddNextHop          (NextHop nextHop)           { nextHops.push_back(nextHop); }
    void            ClearNextHops       (void)                      { nextHops.clear(); }
    unsigned int    GetNextHopCount     (void) const                { return nextHops.size(); }
    NextHop         GetNextHop          (unsigned int index) const  { return nextHops[index]; }
    void            SetDistance         (unsigned long d)           { distance = d; }
    unsigned long   GetDistance         (void) const                { return distance; }
    void            SetParent           (OSPFLSA* p)                { parent = p; }
    OSPFLSA*        GetParent           (void) const                { return parent; }
};

class LSATrackingInfo
{
public:
    enum InstallSource {
        Originated = 0,
        Flooded = 1
    };

private:
    InstallSource   source;
    unsigned long   installTime;

public:
        LSATrackingInfo(void) : source(Flooded), installTime(0) {}
        LSATrackingInfo(const LSATrackingInfo& info) : source(info.source), installTime(info.installTime) {}

    void            SetSource               (InstallSource installSource)   { source = installSource; }
    InstallSource   GetSource               (void) const                    { return source; }
    void            IncrementInstallTime    (void)                          { installTime++; }
    void            ResetInstallTime        (void)                          { installTime = 0; }
    unsigned long   GetInstallTime          (void) const                    { return installTime; }
};

class RouterLSA : public OSPFRouterLSA,
                  public RoutingInfo,
                  public LSATrackingInfo
{
public:
            RouterLSA  (void) : OSPFRouterLSA(), RoutingInfo(), LSATrackingInfo() {}
            RouterLSA  (const OSPFRouterLSA& lsa) : OSPFRouterLSA(lsa), RoutingInfo(), LSATrackingInfo() {}
            RouterLSA  (const RouterLSA& lsa) : OSPFRouterLSA(lsa), RoutingInfo(lsa), LSATrackingInfo(lsa) {}
    virtual ~RouterLSA(void) {}

    bool    ValidateLSChecksum() const   { return true; } // not implemented

    bool    Update      (const OSPFRouterLSA* lsa);
    bool    DiffersFrom(const OSPFRouterLSA* routerLSA) const;
};

class NetworkLSA : public OSPFNetworkLSA,
                   public RoutingInfo,
                   public LSATrackingInfo
{
public:
            NetworkLSA  (void) : OSPFNetworkLSA(), RoutingInfo(), LSATrackingInfo() {}
            NetworkLSA  (const OSPFNetworkLSA& lsa) : OSPFNetworkLSA(lsa), RoutingInfo(), LSATrackingInfo() {}
            NetworkLSA  (const NetworkLSA& lsa) : OSPFNetworkLSA(lsa), RoutingInfo(lsa), LSATrackingInfo(lsa) {}
    virtual ~NetworkLSA(void) {}

    bool    ValidateLSChecksum() const   { return true; } // not implemented

    bool    Update      (const OSPFNetworkLSA* lsa);
    bool    DiffersFrom(const OSPFNetworkLSA* networkLSA) const;
};

class SummaryLSA : public OSPFSummaryLSA,
                   public RoutingInfo,
                   public LSATrackingInfo
{
protected:
    bool    purgeable;
public:
            SummaryLSA  (void) : OSPFSummaryLSA(), RoutingInfo(), LSATrackingInfo(), purgeable(false) {}
            SummaryLSA  (const OSPFSummaryLSA& lsa) : OSPFSummaryLSA(lsa), RoutingInfo(), LSATrackingInfo(), purgeable(false) {}
            SummaryLSA  (const SummaryLSA& lsa) : OSPFSummaryLSA(lsa), RoutingInfo(lsa), LSATrackingInfo(lsa), purgeable(lsa.purgeable) {}
    virtual ~SummaryLSA(void) {}

    bool    GetPurgeable(void) const           { return purgeable; }
    void    SetPurgeable(bool purge = true)    { purgeable = purge; }

    bool    ValidateLSChecksum() const   { return true; } // not implemented

    bool    Update      (const OSPFSummaryLSA* lsa);
    bool    DiffersFrom(const OSPFSummaryLSA* summaryLSA) const;
};

class ASExternalLSA : public OSPFASExternalLSA,
                      public RoutingInfo,
                      public LSATrackingInfo
{
protected:
    bool    purgeable;
public:
            ASExternalLSA  (void) : OSPFASExternalLSA(), RoutingInfo(), LSATrackingInfo(), purgeable(false) {}
            ASExternalLSA  (const OSPFASExternalLSA& lsa) : OSPFASExternalLSA(lsa), RoutingInfo(), LSATrackingInfo(), purgeable(false) {}
            ASExternalLSA  (const ASExternalLSA& lsa) : OSPFASExternalLSA(lsa), RoutingInfo(lsa), LSATrackingInfo(lsa), purgeable(lsa.purgeable) {}
    virtual ~ASExternalLSA(void) {}

    bool    GetPurgeable(void) const           { return purgeable; }
    void    SetPurgeable(bool purge = true)    { purgeable = purge; }

    bool    ValidateLSChecksum() const   { return true; } // not implemented

    bool    Update      (const OSPFASExternalLSA* lsa);
    bool    DiffersFrom(const OSPFASExternalLSA* asExternalLSA) const;
};

} // namespace OSPF

inline bool operator< (const OSPFLSAHeader& leftLSA, const OSPFLSAHeader& rightLSA)
{
    long leftSequenceNumber  = leftLSA.getLsSequenceNumber();
    long rightSequenceNumber = rightLSA.getLsSequenceNumber();

    if (leftSequenceNumber < rightSequenceNumber) {
        return true;
    }
    if (leftSequenceNumber == rightSequenceNumber) {
        unsigned short leftChecksum  = leftLSA.getLsChecksum();
        unsigned short rightChecksum = rightLSA.getLsChecksum();

        if (leftChecksum < rightChecksum) {
            return true;
        }
        if (leftChecksum == rightChecksum) {
            unsigned short leftAge  = leftLSA.getLsAge();
            unsigned short rightAge = rightLSA.getLsAge();

            if ((leftAge != MAX_AGE) && (rightAge == MAX_AGE)) {
                return true;
            }
            if ((abs(leftAge - rightAge) > MAX_AGE_DIFF) && (leftAge > rightAge)) {
                return true;
            }
        }
    }
    return false;
}

inline bool operator== (const OSPFLSAHeader& leftLSA, const OSPFLSAHeader& rightLSA)
{
    long           leftSequenceNumber  = leftLSA.getLsSequenceNumber();
    long           rightSequenceNumber = rightLSA.getLsSequenceNumber();
    unsigned short leftChecksum        = leftLSA.getLsChecksum();
    unsigned short rightChecksum       = rightLSA.getLsChecksum();
    unsigned short leftAge             = leftLSA.getLsAge();
    unsigned short rightAge            = rightLSA.getLsAge();

    if ((leftSequenceNumber == rightSequenceNumber) &&
        (leftChecksum == rightChecksum) &&
        (((leftAge == MAX_AGE) && (rightAge == MAX_AGE)) ||
         (((leftAge != MAX_AGE) && (rightAge != MAX_AGE)) &&
          (abs(leftAge - rightAge) <= MAX_AGE_DIFF))))
    {
        return true;
    }
    else {
        return false;
    }
}

inline bool operator== (const OSPFOptions& leftOptions, const OSPFOptions& rightOptions)
{
    return ((leftOptions.E_ExternalRoutingCapability == rightOptions.E_ExternalRoutingCapability) &&
            (leftOptions.MC_MulticastForwarding      == rightOptions.MC_MulticastForwarding) &&
            (leftOptions.NP_Type7LSA                 == rightOptions.NP_Type7LSA) &&
            (leftOptions.EA_ForwardExternalLSAs      == rightOptions.EA_ForwardExternalLSAs) &&
            (leftOptions.DC_DemandCircuits           == rightOptions.DC_DemandCircuits));
}

inline bool operator!= (const OSPFOptions& leftOptions, const OSPFOptions& rightOptions)
{
    return (!(leftOptions == rightOptions));
}

inline bool operator== (const OSPF::NextHop& leftHop, const OSPF::NextHop& rightHop)
{
    return ((leftHop.ifIndex           == rightHop.ifIndex) &&
            (leftHop.hopAddress        == rightHop.hopAddress) &&
            (leftHop.advertisingRouter == rightHop.advertisingRouter));
}

inline bool operator!= (const OSPF::NextHop& leftHop, const OSPF::NextHop& rightHop)
{
    return (!(leftHop == rightHop));
}

inline unsigned int CalculateLSASize(const OSPFRouterLSA* routerLSA)
{
    unsigned int   lsaLength = OSPF_LSA_HEADER_LENGTH + OSPF_ROUTERLSA_HEADER_LENGTH;
    unsigned short linkCount = routerLSA->getLinksArraySize();

    for (unsigned short i = 0; i < linkCount; i++) {
        const Link& link = routerLSA->getLinks(i);
        lsaLength += OSPF_LINK_HEADER_LENGTH + (link.getTosDataArraySize() * OSPF_TOS_LENGTH);
    }

    return lsaLength;
}

inline unsigned int CalculateLSASize(const OSPFNetworkLSA* networkLSA)
{
    return (OSPF_LSA_HEADER_LENGTH + OSPF_NETWORKLSA_MASK_LENGTH +
            (networkLSA->getAttachedRoutersArraySize() * OSPF_NETWORKLSA_ADDRESS_LENGTH));
}

inline unsigned int CalculateLSASize(const OSPFSummaryLSA* summaryLSA)
{
    return (OSPF_LSA_HEADER_LENGTH + OSPF_SUMMARYLSA_HEADER_LENGTH +
            (summaryLSA->getTosDataArraySize() * OSPF_TOS_LENGTH));
}

inline unsigned int CalculateLSASize(const OSPFASExternalLSA* asExternalLSA)
{
    return (OSPF_LSA_HEADER_LENGTH + OSPF_ASEXTERNALLSA_HEADER_LENGTH +
            (asExternalLSA->getContents().getExternalTOSInfoArraySize() * OSPF_ASEXTERNALLSA_TOS_INFO_LENGTH));
}

inline void PrintLSAHeader(const OSPFLSAHeader& lsaHeader, std::ostream& output) {
    char addressString[16];
    output << "LSAHeader: age="
           << lsaHeader.getLsAge()
           << ", type=";
    switch (lsaHeader.getLsType()) {
        case RouterLSAType:                     output << "RouterLSA";                     break;
        case NetworkLSAType:                    output << "NetworkLSA";                    break;
        case SummaryLSA_NetworksType:           output << "SummaryLSA_Networks";           break;
        case SummaryLSA_ASBoundaryRoutersType:  output << "SummaryLSA_ASBoundaryRouters";  break;
        case ASExternalLSAType:                 output << "ASExternalLSA";                 break;
        default:                                output << "Unknown";                       break;
    }
    output << ", LSID="
           << AddressStringFromULong(addressString, sizeof(addressString), lsaHeader.getLinkStateID());
    output << ", advertisingRouter="
           << AddressStringFromULong(addressString, sizeof(addressString), lsaHeader.getAdvertisingRouter().getInt())
           << ", seqNumber="
           << lsaHeader.getLsSequenceNumber();
    output << endl;
}

inline std::ostream& operator<< (std::ostream& ostr, OSPFLSA& lsa)
{
    PrintLSAHeader(lsa.getHeader(), ostr);
    return ostr;
}

#endif // __LSA_HPP__