RoutingTable6.h

Go to the documentation of this file.

//
// Copyright (C) 2005 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 __INET_ROUTINGTABLE6_H
#define __INET_ROUTINGTABLE6_H

#include <vector>
#include <omnetpp.h>
#include "INETDefs.h"
#include "IPv6Address.h"
#include "IInterfaceTable.h"
#include "NotificationBoard.h"


class INET_API IPv6Route : public cPolymorphic
{
  public:
    enum RouteSrc
    {
        FROM_RA,        
        OWN_ADV_PREFIX, 
        STATIC,         
        ROUTING_PROT,   
    };

  protected:
    IPv6Address _destPrefix;
    short _length;
    RouteSrc _src;
    int _interfaceID;      //XXX IPv4 IRoutingTable uses interface pointer
    IPv6Address _nextHop;  // unspecified means "direct"
    simtime_t _expiryTime; // if route is an advertised prefix: prefix lifetime
    int _metric;

  public:
    IPv6Route(IPv6Address destPrefix, int length, RouteSrc src) {
        _destPrefix = destPrefix;
        _length = length;
        _src = src;
        _interfaceID = -1;
        _expiryTime = 0;
        _metric = 0;
    }

    virtual std::string info() const;
    virtual std::string detailedInfo() const;
    static const char *routeSrcName(RouteSrc src);

    void setInterfaceId(int interfaceId)  {_interfaceID = interfaceId;}
    void setNextHop(const IPv6Address& nextHop)  {_nextHop = nextHop;}
    void setExpiryTime(simtime_t expiryTime)  {_expiryTime = expiryTime;}
    void setMetric(int metric)  {_metric = metric;}

    const IPv6Address& getDestPrefix() const {return _destPrefix;}
    int getPrefixLength() const  {return _length;}
    RouteSrc getSrc() const  {return _src;}
    int getInterfaceId() const  {return _interfaceID;}
    const IPv6Address& getNextHop() const  {return _nextHop;}
    simtime_t getExpiryTime() const  {return _expiryTime;}
    int getMetric() const  {return _metric;}
};


class INET_API RoutingTable6 : public cSimpleModule, protected INotifiable
{
  protected:
    IInterfaceTable *ift; // cached pointer
    NotificationBoard *nb; // cached pointer

    bool isrouter;

    // Destination Cache maps dest address to next hop and interfaceId.
    // NOTE: nextHop might be a link-local address from which interfaceId cannot be deduced
    struct DestCacheEntry
    {
        int interfaceId;
        IPv6Address nextHopAddr;
        // more destination specific data may be added here, e.g. path MTU
    };
    friend std::ostream& operator<<(std::ostream& os, const DestCacheEntry& e);
    typedef std::map<IPv6Address,DestCacheEntry> DestCache;
    DestCache destCache;

    // RouteList contains local prefixes, and (for routers)
    // static, OSPF, RIP etc routes as well
    typedef std::vector<IPv6Route*> RouteList;
    RouteList routeList;

  protected:
    // internal: routes of different type can only be added via well-defined functions
    virtual void addRoute(IPv6Route *route);
    // helper for addRoute()
    static bool routeLessThan(const IPv6Route *a, const IPv6Route *b);
    // internal
    virtual void configureInterfaceForIPv6(InterfaceEntry *ie);
    virtual void assignRequiredNodeAddresses(InterfaceEntry *ie);
    // internal
    virtual void configureInterfaceFromXML(InterfaceEntry *ie, cXMLElement *cfg);

  protected:
    // displays summary above the icon
    virtual void updateDisplayString();

  public:
    RoutingTable6();
    virtual ~RoutingTable6();

  protected:
    virtual int numInitStages() const  {return 5;}
    virtual void initialize(int stage);
    virtual void parseXMLConfigFile();

    virtual void handleMessage(cMessage *);

    virtual void receiveChangeNotification(int category, const cPolymorphic *details);

  public:
    virtual InterfaceEntry *getInterfaceByAddress(const IPv6Address& address);

    virtual bool isRouter() const {return isrouter;}

    virtual bool isLocalAddress(const IPv6Address& dest) const;

    const IPv6Address& lookupDestCache(const IPv6Address& dest, int& outInterfaceId) const;

    const IPv6Route *doLongestPrefixMatch(const IPv6Address& dest);

    virtual bool isPrefixPresent(const IPv6Address& prefix) const;

    //TBD multicast delivery

    virtual void updateDestCache(const IPv6Address& dest, const IPv6Address& nextHopAddr, int interfaceId);

    virtual void purgeDestCache();

    virtual void purgeDestCacheEntriesToNeighbour(const IPv6Address& nextHopAddr, int interfaceId);

    virtual void addOrUpdateOnLinkPrefix(const IPv6Address& destPrefix, int prefixLength,
                                 int interfaceId, simtime_t expiryTime);

    virtual void removeOnLinkPrefix(const IPv6Address& destPrefix, int prefixLength);

    virtual void addOrUpdateOwnAdvPrefix(const IPv6Address& destPrefix, int prefixLength,
                                 int interfaceId, simtime_t expiryTime);

    virtual void addStaticRoute(const IPv6Address& destPrefix, int prefixLength,
                        unsigned int interfaceId, const IPv6Address& nextHop,
                        int metric=0);

    virtual void addDefaultRoute(const IPv6Address& raSrcAddr, unsigned int ifID,
        simtime_t routerLifetime);

    virtual void addRoutingProtocolRoute(IPv6Route *route);

    virtual void removeRoute(IPv6Route *route);

    virtual int getNumRoutes() const;

    virtual IPv6Route *getRoute(int i);

};

#endif