#include <RoutingTable6.h>

Inheritance diagram for RoutingTable6:

Classes
struct	DestCacheEntry
Public Member Functions
	RoutingTable6 ()
virtual	~RoutingTable6 ()
virtual bool	isRouter () const
Interfaces

virtual InterfaceEntry *	getInterfaceByAddress (const IPv6Address &address)
Routing functions

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
Managing the destination cache

virtual void	updateDestCache (const IPv6Address &dest, const IPv6Address &nextHopAddr, int interfaceId)
virtual void	purgeDestCache ()
virtual void	purgeDestCacheEntriesToNeighbour (const IPv6Address &nextHopAddr, int interfaceId)
Managing prefixes and the route table

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)
Protected Types
typedef std::map< IPv6Address, DestCacheEntry >	DestCache
typedef std::vector< IPv6Route * >	RouteList
Protected Member Functions
virtual void	addRoute (IPv6Route *route)
virtual void	configureInterfaceForIPv6 (InterfaceEntry *ie)
virtual void	assignRequiredNodeAddresses (InterfaceEntry *ie)
virtual void	configureInterfaceFromXML (InterfaceEntry ie, cXMLElement cfg)
virtual void	updateDisplayString ()
virtual int	numInitStages () const
virtual void	initialize (int stage)
virtual void	parseXMLConfigFile ()
virtual void	handleMessage (cMessage *)
virtual void	receiveChangeNotification (int category, const cPolymorphic *details)
Static Protected Member Functions
static bool	routeLessThan (const IPv6Route a, const IPv6Route b)
Protected Attributes
IInterfaceTable *	ift
NotificationBoard *	nb
bool	isrouter
DestCache	destCache
RouteList	routeList
Friends
std::ostream &	operator<< (std::ostream &os, const DestCacheEntry &e)

Detailed Description

Represents the IPv6 routing table and neighbour discovery data structures. This object has one instance per host or router.

See the NED documentation for general overview.

This is a simple module without gates, it requires function calls to it (message handling does nothing). Methods are provided for reading and updating the interface table and the route table, as well as for unicast and multicast routing.

The route table is read from a file. The route table can also be read and modified during simulation, typically by routing protocol implementations.

Definition at line 102 of file RoutingTable6.h.

Member Typedef Documentation

typedef std::map<IPv6Address,DestCacheEntry> RoutingTable6::DestCache [protected]

Definition at line 119 of file RoutingTable6.h.

typedef std::vector<IPv6Route*> RoutingTable6::RouteList [protected]

Definition at line 124 of file RoutingTable6.h.

Constructor & Destructor Documentation

RoutingTable6::RoutingTable6 ( )

Definition at line 73 of file RoutingTable6.cc.

{
}

RoutingTable6::~RoutingTable6 ( ) [virtual]

Definition at line 77 of file RoutingTable6.cc.

{
    for (unsigned int i=0; i<routeList.size(); i++)
        delete routeList[i];
}

Member Function Documentation

void RoutingTable6::addDefaultRoute	(	const IPv6Address &	raSrcAddr,
		unsigned int	ifID,
		simtime_t	routerLifetime
	)			`[virtual]`

Adds a default route for a host. This method requires the RA's source address and the router expiry time plus the simTime().

Definition at line 591 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::processRAForRouterUpdates().

{
    // create route object
    IPv6Route *route = new IPv6Route(IPv6Address(), 0, IPv6Route::FROM_RA);
    route->setInterfaceId(ifID);
    route->setNextHop(nextHop);
    route->setMetric(10);//FIXME:should be filled from interface metric

    // then add it
    addRoute(route);
}

void RoutingTable6::addOrUpdateOnLinkPrefix	(	const IPv6Address &	destPrefix,
		int	prefixLength,
		int	interfaceId,
		simtime_t	expiryTime
	)			`[virtual]`

Add on-link prefix (route of type FROM_RA), or update existing one. To be called from code processing on-link prefixes in Router Advertisements. Expiry time can be derived from the Valid Lifetime field in the Router Advertisements.

NOTE: This method does NOT update the lifetime of matching addresses in the IInterfaceTable (see IPv6InterfaceData); that has to be done separately.

Definition at line 484 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::processRAPrefixInfo().

{
    // see if prefix exists in table
    IPv6Route *route = NULL;
    for (RouteList::iterator it=routeList.begin(); it!=routeList.end(); it++)
    {
        if ((*it)->getSrc()==IPv6Route::FROM_RA && (*it)->getDestPrefix()==destPrefix && (*it)->getPrefixLength()==prefixLength)
        {
            route = *it;
            break;
        }
    }

    if (route==NULL)
    {
        // create new route object
        IPv6Route *route = new IPv6Route(destPrefix, prefixLength, IPv6Route::FROM_RA);
        route->setInterfaceId(interfaceId);
        route->setExpiryTime(expiryTime);
        route->setMetric(0);

        // then add it
        addRoute(route);
    }
    else
    {
        // update existing one; notification-wise, we pretend the route got removed then re-added
        nb->fireChangeNotification(NF_IPv6_ROUTE_DELETED, route);
        route->setInterfaceId(interfaceId);
        route->setExpiryTime(expiryTime);
        nb->fireChangeNotification(NF_IPv6_ROUTE_ADDED, route);
    }

    updateDisplayString();
}

void RoutingTable6::addOrUpdateOwnAdvPrefix	(	const IPv6Address &	destPrefix,
		int	prefixLength,
		int	interfaceId,
		simtime_t	expiryTime
	)			`[virtual]`

Add route of type OWN_ADV_PREFIX. This is a prefix that *this* router advertises on this interface.

Definition at line 521 of file RoutingTable6.cc.

Referenced by FlatNetworkConfigurator6::addOwnAdvPrefixRoutes(), and initialize().

{
    // FIXME this is very similar to the one above -- refactor!!

    // see if prefix exists in table
    IPv6Route *route = NULL;
    for (RouteList::iterator it=routeList.begin(); it!=routeList.end(); it++)
    {
        if ((*it)->getSrc()==IPv6Route::OWN_ADV_PREFIX && (*it)->getDestPrefix()==destPrefix && (*it)->getPrefixLength()==prefixLength)
        {
            route = *it;
            break;
        }
    }

    if (route==NULL)
    {
        // create new route object
        IPv6Route *route = new IPv6Route(destPrefix, prefixLength, IPv6Route::OWN_ADV_PREFIX);
        route->setInterfaceId(interfaceId);
        route->setExpiryTime(expiryTime);
        route->setMetric(0);

        // then add it
        addRoute(route);
    }
    else
    {
        // update existing one; notification-wise, we pretend the route got removed then re-added
        nb->fireChangeNotification(NF_IPv6_ROUTE_DELETED, route);
        route->setInterfaceId(interfaceId);
        route->setExpiryTime(expiryTime);
        nb->fireChangeNotification(NF_IPv6_ROUTE_ADDED, route);
    }

    updateDisplayString();
}

void RoutingTable6::addRoute ( IPv6Route * route ) [protected, virtual]

Definition at line 620 of file RoutingTable6.cc.

Referenced by addDefaultRoute(), addOrUpdateOnLinkPrefix(), addOrUpdateOwnAdvPrefix(), addRoutingProtocolRoute(), and addStaticRoute().

{
    routeList.push_back(route);

    // we keep entries sorted by prefix length in routeList, so that we can
    // stop at the first match when doing the longest prefix matching
    std::sort(routeList.begin(), routeList.end(), routeLessThan);

    updateDisplayString();

    nb->fireChangeNotification(NF_IPv6_ROUTE_ADDED, route);
}

void RoutingTable6::addRoutingProtocolRoute ( IPv6Route * route ) [virtual]

Adds the given getRoute(which can be OSPF, BGP, RIP or any other route) with src==ROUTING_PROT. To store additional information with the route, one can subclass from IPv6Route and add more fields.

Definition at line 604 of file RoutingTable6.cc.

{
    ASSERT(route->getSrc()==IPv6Route::ROUTING_PROT);
    addRoute(route);
}

void RoutingTable6::addStaticRoute	(	const IPv6Address &	destPrefix,
		int	prefixLength,
		unsigned int	interfaceId,
		const IPv6Address &	nextHop,
		int	metric = `0`
	)			`[virtual]`

Creates a static route. If metric is omitted, it gets initialized to the interface's metric value.

Definition at line 575 of file RoutingTable6.cc.

Referenced by FlatNetworkConfigurator6::addStaticRoutes().

{
    // create route object
    IPv6Route *route = new IPv6Route(destPrefix, prefixLength, IPv6Route::STATIC);
    route->setInterfaceId(interfaceId);
    route->setNextHop(nextHop);
    if (metric==0)
        metric = 10; // TBD should be filled from interface metric
    route->setMetric(metric);

    // then add it
    addRoute(route);
}

void RoutingTable6::assignRequiredNodeAddresses ( InterfaceEntry * ie ) [protected, virtual]

RFC 3513: Section 2.8 A Node's Required Address Assign the various addresses to the node's respective interface. This should be done when the IPv6 Protocol stack is created.

Definition at line 235 of file RoutingTable6.cc.

Referenced by configureInterfaceForIPv6().

{
    //RFC 3513 Section 2.8:A Node's Required Addresses
    /*A host is required to recognize the following addresses as
    identifying itself:*/

    //o  The loopback address.
    if (ie->isLoopback())
    {
        ie->ipv6Data()->assignAddress(IPv6Address("::1"), false, 0, 0);
        return;
    }
    //o  Its required Link-Local Address for each interface.
    //IPv6Address linkLocalAddr = IPv6Address().formLinkLocalAddress(ie->getInterfaceToken());
    //ie->ipv6Data()->assignAddress(linkLocalAddr, true, 0, 0);

    /*o  Any additional Unicast and Anycast Addresses that have been configured
    for the node's interfaces (manually or automatically).*/

    // FIXME FIXME Andras: commented out the following lines, because these addresses
    // are implicitly checked for in isLocalAddress()  (we don't want redundancy,
    // and manually adding solicited-node mcast address for each and every address
    // is very error-prone!)
    //
    //o  The All-Nodes Multicast Addresses defined in section 2.7.1.

    /*o  The Solicited-Node Multicast Address for each of its unicast and anycast
    addresses.*/

    //o  Multicast Addresses of all other groups to which the node belongs.

    /*A router is required to recognize all addresses that a host is
    required to recognize, plus the following addresses as identifying
    itself:*/
    /*o  The Subnet-Router Anycast Addresses for all interfaces for
    which it is configured to act as a router.*/

    //o  All other Anycast Addresses with which the router has been configured.
    //o  The All-Routers Multicast Addresses defined in section 2.7.1.
}

void RoutingTable6::configureInterfaceForIPv6 ( InterfaceEntry * ie ) [protected, virtual]

Definition at line 217 of file RoutingTable6.cc.

Referenced by initialize().

{
    IPv6InterfaceData *ipv6IfData = new IPv6InterfaceData();
    ie->setIPv6Data(ipv6IfData);

    // for routers, turn on advertisements by default
    //FIXME: we will use this isRouter flag for now. what if future implementations
    //have 2 interfaces where one interface is configured as a router and the other
    //as a host?
    ipv6IfData->setAdvSendAdvertisements(isrouter);//Added by WEI

    // metric: some hints: OSPF cost (2e9/bps value), MS KB article Q299540, ...
    //d->setMetric((int)ceil(2e9/ie->getDatarate())); // use OSPF cost as default
    //FIXME TBD fill in the rest

    assignRequiredNodeAddresses(ie);
}

void RoutingTable6::configureInterfaceFromXML	(	InterfaceEntry *	ie,
		cXMLElement *	cfg
	)			`[protected, virtual]`

Definition at line 291 of file RoutingTable6.cc.

Referenced by parseXMLConfigFile().

{
    /*XML parsing capabilities tweaked by WEI. For now, we can configure a specific
    node's interface. We can set advertising prefixes and other variables to be used
    in RAs. The IPv6 interface data gets overwritten if lines 249 to 262 is uncommented.
    The fix is to create an XML file with all the default values. Customised XML files
    can be used for future protocols that requires different values. (MIPv6)*/
    IPv6InterfaceData *d = ie->ipv6Data();

    // parse basic config (attributes)
    d->setAdvSendAdvertisements(toBool(getRequiredAttr(cfg, "AdvSendAdvertisements")));
    //TODO: leave this off first!! They overwrite stuff!
/* TODO: Wei commented out the stuff below. To be checked why (Andras).
    d->setMaxRtrAdvInterval(OPP_Global::atod(getRequiredAttr(cfg, "MaxRtrAdvInterval")));
    d->setMinRtrAdvInterval(OPP_Global::atod(getRequiredAttr(cfg, "MinRtrAdvInterval")));
    d->setAdvManagedFlag(toBool(getRequiredAttr(cfg, "AdvManagedFlag")));
    d->setAdvOtherConfigFlag(toBool(getRequiredAttr(cfg, "AdvOtherConfigFlag")));
    d->setAdvLinkMTU(OPP_Global::atoul(getRequiredAttr(cfg, "AdvLinkMTU")));
    d->setAdvReachableTime(OPP_Global::atoul(getRequiredAttr(cfg, "AdvReachableTime")));
    d->setAdvRetransTimer(OPP_Global::atoul(getRequiredAttr(cfg, "AdvRetransTimer")));
    d->setAdvCurHopLimit(OPP_Global::atoul(getRequiredAttr(cfg, "AdvCurHopLimit")));
    d->setAdvDefaultLifetime(OPP_Global::atoul(getRequiredAttr(cfg, "AdvDefaultLifetime")));
    ie->setMtu(OPP_Global::atoul(getRequiredAttr(cfg, "HostLinkMTU")));
    d->setCurHopLimit(OPP_Global::atoul(getRequiredAttr(cfg, "HostCurHopLimit")));
    d->setBaseReachableTime(OPP_Global::atoul(getRequiredAttr(cfg, "HostBaseReachableTime")));
    d->setRetransTimer(OPP_Global::atoul(getRequiredAttr(cfg, "HostRetransTimer")));
    d->setDupAddrDetectTransmits(OPP_Global::atoul(getRequiredAttr(cfg, "HostDupAddrDetectTransmits")));
*/

    // parse prefixes (AdvPrefix elements; they should be inside an AdvPrefixList
    // element, but we don't check that)
    cXMLElementList prefixList = cfg->getElementsByTagName("AdvPrefix");
    for (unsigned int i=0; i<prefixList.size(); i++)
    {
        cXMLElement *node = prefixList[i];
        IPv6InterfaceData::AdvPrefix prefix;

        // FIXME todo implement: advValidLifetime, advPreferredLifetime can
        // store (absolute) expiry time (if >0) or lifetime (delta) (if <0);
        // 0 should be treated as infinity
        int pfxLen;
        if (!prefix.prefix.tryParseAddrWithPrefix(node->getNodeValue(),pfxLen))
            opp_error("element <%s> at %s: wrong IPv6Address/prefix syntax %s",
                      node->getTagName(), node->getSourceLocation(), node->getNodeValue());
        prefix.prefixLength = pfxLen;
        prefix.advValidLifetime = OPP_Global::atoul(getRequiredAttr(node, "AdvValidLifetime"));
        prefix.advOnLinkFlag = toBool(getRequiredAttr(node, "AdvOnLinkFlag"));
        prefix.advPreferredLifetime = OPP_Global::atoul(getRequiredAttr(node, "AdvPreferredLifetime"));
        prefix.advAutonomousFlag = toBool(getRequiredAttr(node, "AdvAutonomousFlag"));
        d->addAdvPrefix(prefix);
    }

    // parse addresses
    cXMLElementList addrList = cfg->getChildrenByTagName("inetAddr");
    for (unsigned int k=0; k<addrList.size(); k++)
    {
        cXMLElement *node = addrList[k];
        IPv6Address address = node->getNodeValue();
        //We can now decide if the address is tentative or not.
        d->assignAddress(address, toBool(getRequiredAttr(node, "tentative")), 0, 0);  // set up with infinite lifetimes
    }
}

const IPv6Route * RoutingTable6::doLongestPrefixMatch ( const IPv6Address & dest )

Performs longest prefix match in the routing table and returns the resulting route, or NULL if there was no match.

Definition at line 417 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::determineNextHop(), and IPv6::routePacket().

{
    Enter_Method("doLongestPrefixMatch(%s)", dest.str().c_str());

    // we'll just stop at the first match, because the table is sorted
    // by prefix lengths and metric (see addRoute())
    for (RouteList::const_iterator it=routeList.begin(); it!=routeList.end(); it++)
    {
        if (dest.matches((*it)->getDestPrefix(),(*it)->getPrefixLength()))
        {
            // FIXME proofread this code, iterator invalidation-wise, etc
            bool entryExpired = false;
            if (simTime() > (*it)->getExpiryTime() && (*it)->getExpiryTime() != 0)//since 0 represents infinity.
            {
                EV << "Expired prefix detected!!" << endl;
                removeOnLinkPrefix((*it)->getDestPrefix(), (*it)->getPrefixLength());
                entryExpired = true;
            }
            if (entryExpired == false) return *it;
        }
    }
    // FIXME todo: if we selected an expired route, throw it out and select again!
    return NULL;
}

InterfaceEntry * RoutingTable6::getInterfaceByAddress ( const IPv6Address & address ) [virtual]

Returns an interface given by its address. Returns NULL if not found.

Definition at line 354 of file RoutingTable6.cc.

Referenced by IPv6::encapsulate().

{
    Enter_Method("getInterfaceByAddress(%s)=?", addr.str().c_str());

    if (addr.isUnspecified())
        return NULL;
    for (int i=0; i<ift->getNumInterfaces(); ++i)
    {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->ipv6Data()->hasAddress(addr))
            return ie;
    }
    return NULL;
}

int RoutingTable6::getNumRoutes ( ) const [virtual]

Return the number of routes.

Definition at line 646 of file RoutingTable6.cc.

Referenced by updateDisplayString().

{
    return routeList.size();
}

IPv6Route * RoutingTable6::getRoute ( int i ) [virtual]

Return the ith route.

Definition at line 651 of file RoutingTable6.cc.

{
    ASSERT(i>=0 && i<(int)routeList.size());
    return routeList[i];
}

void RoutingTable6::handleMessage ( cMessage * msg ) [protected, virtual]

Raises an error.

Definition at line 180 of file RoutingTable6.cc.

{
    opp_error("This module doesn't process messages");
}

void RoutingTable6::initialize ( int stage ) [protected, virtual]

Definition at line 83 of file RoutingTable6.cc.

{
    if (stage==1)
    {
        ift = InterfaceTableAccess().get();
        nb = NotificationBoardAccess().get();

        nb->subscribe(this, NF_INTERFACE_CREATED);
        nb->subscribe(this, NF_INTERFACE_DELETED);
        nb->subscribe(this, NF_INTERFACE_STATE_CHANGED);
        nb->subscribe(this, NF_INTERFACE_CONFIG_CHANGED);
        nb->subscribe(this, NF_INTERFACE_IPv6CONFIG_CHANGED);

        WATCH_PTRVECTOR(routeList);
        WATCH_MAP(destCache); // FIXME commented out for now
        isrouter = par("isRouter");
        WATCH(isrouter);

        // add IPv6InterfaceData to interfaces
        for (int i=0; i<ift->getNumInterfaces(); i++)
        {
            InterfaceEntry *ie = ift->getInterface(i);
            configureInterfaceForIPv6(ie);
        }

        parseXMLConfigFile();

        // skip hosts
        if (isrouter)
        {
            // add globally routable prefixes to routing table
            for (int x = 0; x < ift->getNumInterfaces(); x++)
            {
                InterfaceEntry *ie = ift->getInterface(x);

                if (ie->isLoopback())
                    continue;

                for (int y = 0; y < ie->ipv6Data()->getNumAdvPrefixes(); y++)
                    if (ie->ipv6Data()->getAdvPrefix(y).prefix.isGlobal())
                        addOrUpdateOwnAdvPrefix(ie->ipv6Data()->getAdvPrefix(y).prefix,
                                                ie->ipv6Data()->getAdvPrefix(y).prefixLength,
                                                ie->getInterfaceId(), 0);
            }
        }
    }
    else if (stage==4)
    {
        // configurator adds routes only in stage==3
        updateDisplayString();
    }
}

bool RoutingTable6::isLocalAddress ( const IPv6Address & dest ) const [virtual]

Checks if the address is one of the host's addresses, i.e. assigned to one of its interfaces (tentatively or not).

Definition at line 369 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::processNSForTentativeAddress(), IPv6::routeMulticastPacket(), and IPv6::routePacket().

{
    Enter_Method("isLocalAddress(%s) y/n", dest.str().c_str());

    // first, check if we have an interface with this address
    for (int i=0; i<ift->getNumInterfaces(); i++)
    {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->ipv6Data()->hasAddress(dest))
            return true;
    }

    // then check for special, preassigned multicast addresses
    // (these addresses occur more rarely than specific interface addresses,
    // that's why we check for them last)

    if (dest==IPv6Address::ALL_NODES_1 || dest==IPv6Address::ALL_NODES_2)
        return true;
    if (isRouter() && (dest==IPv6Address::ALL_ROUTERS_1 || dest==IPv6Address::ALL_ROUTERS_2 || dest==IPv6Address::ALL_ROUTERS_5))
        return true;

    // check for solicited-node multicast address
    if (dest.matches(IPv6Address::SOLICITED_NODE_PREFIX, 104))
    {
        for (int i=0; i<ift->getNumInterfaces(); i++)
        {
            InterfaceEntry *ie = ift->getInterface(i);
            if (ie->ipv6Data()->matchesSolicitedNodeMulticastAddress(dest))
                return true;
        }
    }
    return false;
}

bool RoutingTable6::isPrefixPresent ( const IPv6Address & prefix ) const [virtual]

Checks if the given prefix already exists in the routing table (prefix list)

Definition at line 442 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::processRAPrefixInfo().

{
    for (RouteList::const_iterator it=routeList.begin(); it!=routeList.end(); it++)
        if (prefix.matches((*it)->getDestPrefix(),128))
            return true;
    return false;
}

virtual bool RoutingTable6::isRouter ( ) const [inline, virtual]

IP forwarding on/off

Definition at line 179 of file RoutingTable6.h.

Referenced by IPv6NeighbourDiscovery::initialize(), isLocalAddress(), IPv6::routeMulticastPacket(), IPv6::routePacket(), and IPv6NeighbourDiscovery::sendSolicitedNA().

{return isrouter;}

const IPv6Address & RoutingTable6::lookupDestCache	(	const IPv6Address &	dest,
		int &	outInterfaceId
	)			const

Looks up the given destination address in the Destination Cache, then returns the next-hop address and the interface in the outInterfaceId variable. If the destination is not in the cache, outInterfaceId is set to -1 and the unspecified address is returned. The caller should check for interfaceId==-1, because unspecified address is also returned if the link layer doesn't use addresses at all (e.g. PPP).

NOTE: outInterfaceId is an OUTPUT parameter -- its initial value is ignored, and the lookupDestCache() sets it to the correct value instead.

Definition at line 403 of file RoutingTable6.cc.

Referenced by IPv6::routePacket().

{
    Enter_Method("lookupDestCache(%s)", dest.str().c_str());

    DestCache::const_iterator it = destCache.find(dest);
    if (it == destCache.end())
    {
        outInterfaceId = -1;
        return IPv6Address::UNSPECIFIED_ADDRESS;
    }
    outInterfaceId = it->second.interfaceId;
    return it->second.nextHopAddr;
}

virtual int RoutingTable6::numInitStages ( ) const [inline, protected, virtual]

Definition at line 152 of file RoutingTable6.h.

{return 5;}

void RoutingTable6::parseXMLConfigFile ( ) [protected, virtual]

Definition at line 136 of file RoutingTable6.cc.

Referenced by initialize().

{
    // TODO to be revised by Andras
    // configure interfaces from XML config file
    cXMLElement *config = par("routingTableFile");
    for (cXMLElement *child=config->getFirstChild(); child; child = child->getNextSibling())
    {
        //std::cout << "configuring interfaces from XML file." << endl;
        //std::cout << "selected element is: " << child->getTagName() << endl;
        // we ensure that the selected element is local.
        if (opp_strcmp(child->getTagName(),"local")!=0) continue;
        //ensure that this is the right parent module we are configuring.
        if (opp_strcmp(child->getAttribute("node"),getParentModule()->getFullName())!=0)
            continue;
        //Go one level deeper.
        //child = child->getFirstChild();
        for (cXMLElement *ifTag=child->getFirstChild(); ifTag; ifTag = ifTag->getNextSibling())
        {
            //The next tag should be "interface".
            if (opp_strcmp(ifTag->getTagName(),"interface")!=0)
                continue;
            //std::cout << "Getting attribute: name" << endl;
            const char *ifname = ifTag->getAttribute("name");
            if (!ifname)
                error("<interface> without name attribute at %s", child->getSourceLocation());
            InterfaceEntry *ie = ift->getInterfaceByName(ifname);
            if (!ie)
                error("no interface named %s was registered, %s", ifname, child->getSourceLocation());
            configureInterfaceFromXML(ie, ifTag);
        }
    }
}

void RoutingTable6::purgeDestCache ( ) [virtual]

Discard all entries in destination cache

Definition at line 459 of file RoutingTable6.cc.

{
    destCache.clear();
    updateDisplayString();
}

void RoutingTable6::purgeDestCacheEntriesToNeighbour	(	const IPv6Address &	nextHopAddr,
		int	interfaceId
	)			`[virtual]`

Discard all entries in destination cache where next hop is the given address on the given interface. This is typically called when a router becomes unreachable, and all destinations going via that router have to go though router selection again.

Definition at line 465 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::timeoutDefaultRouter().

{
    for (DestCache::iterator it=destCache.begin(); it!=destCache.end(); )
    {
        if (it->second.interfaceId==interfaceId && it->second.nextHopAddr==nextHopAddr)
        {
            // move the iterator past this element before removing it
            DestCache::iterator oldIt = it++;
            destCache.erase(oldIt);
        }
        else
        {
            it++;
        }
    }

    updateDisplayString();
}

void RoutingTable6::receiveChangeNotification	(	int	category,
		const cPolymorphic *	details
	)			`[protected, virtual]`

Called by the NotificationBoard whenever a change of a category occurs to which this client has subscribed.

Implements INotifiable.

Definition at line 185 of file RoutingTable6.cc.

{
    if (simulation.getContextType()==CTX_INITIALIZE)
        return;  // ignore notifications during initialize

    Enter_Method_Silent();
    printNotificationBanner(category, details);

    if (category==NF_INTERFACE_CREATED)
    {
        //TODO something like this:
        //InterfaceEntry *ie = check_and_cast<InterfaceEntry*>(details);
        //configureInterfaceForIPv6(ie);
    }
    else if (category==NF_INTERFACE_DELETED)
    {
        //TODO remove all routes that point to that interface (?)
    }
    else if (category==NF_INTERFACE_STATE_CHANGED)
    {
        //TODO invalidate routing cache (?)
    }
    else if (category==NF_INTERFACE_CONFIG_CHANGED)
    {
        //TODO invalidate routing cache (?)
    }
    else if (category==NF_INTERFACE_IPv6CONFIG_CHANGED)
    {
        //TODO
    }
}

void RoutingTable6::removeOnLinkPrefix	(	const IPv6Address &	destPrefix,
		int	prefixLength
	)			`[virtual]`

Remove an on-link prefix. To be called when the prefix gets advertised with zero lifetime, or to purge an expired prefix.

NOTE: This method does NOT remove the matching addresses from the IInterfaceTable (see IPv6InterfaceData); that has to be done separately.

Definition at line 560 of file RoutingTable6.cc.

Referenced by doLongestPrefixMatch(), IPv6NeighbourDiscovery::processRAPrefixInfo(), and IPv6NeighbourDiscovery::timeoutPrefixEntry().

{
    // scan the routing table for this prefix and remove it
    for (RouteList::iterator it=routeList.begin(); it!=routeList.end(); it++)
    {
        if ((*it)->getSrc()==IPv6Route::FROM_RA && (*it)->getDestPrefix()==destPrefix && (*it)->getPrefixLength()==prefixLength)
        {
            routeList.erase(it);
            return; // there can be only one such route, addOrUpdateOnLinkPrefix() guarantees that
        }
    }

    updateDisplayString();
}

void RoutingTable6::removeRoute ( IPv6Route * route ) [virtual]

Deletes the given route from the route table.

Definition at line 633 of file RoutingTable6.cc.

{
    RouteList::iterator it = std::find(routeList.begin(), routeList.end(), route);
    ASSERT(it!=routeList.end());

    nb->fireChangeNotification(NF_IPv6_ROUTE_DELETED, route); // rather: going to be deleted

    routeList.erase(it);
    delete route;

    updateDisplayString();
}

bool RoutingTable6::routeLessThan	(	const IPv6Route *	a,
		const IPv6Route *	b
	)			`[static, protected]`

Definition at line 610 of file RoutingTable6.cc.

{
    // helper for sort() in addRoute(). We want routes with longer
    // prefixes to be at front, so we compare them as "less".
    // For metric, a smaller value is better (we report that as "less").
    if (a->getPrefixLength()!=b->getPrefixLength())
        return a->getPrefixLength() > b->getPrefixLength();
    return a->getMetric() < b->getMetric();
}

void RoutingTable6::updateDestCache	(	const IPv6Address &	dest,
		const IPv6Address &	nextHopAddr,
		int	interfaceId
	)			`[virtual]`

Add or update a destination cache entry.

Definition at line 450 of file RoutingTable6.cc.

Referenced by IPv6NeighbourDiscovery::determineNextHop(), and IPv6::routePacket().

{
    // FIXME this performs 2 lookups -- optimize to do only one
    destCache[dest].nextHopAddr = nextHopAddr;
    destCache[dest].interfaceId = interfaceId;

    updateDisplayString();
}

void RoutingTable6::updateDisplayString ( ) [protected, virtual]

Definition at line 169 of file RoutingTable6.cc.

Referenced by addOrUpdateOnLinkPrefix(), addOrUpdateOwnAdvPrefix(), addRoute(), initialize(), purgeDestCache(), purgeDestCacheEntriesToNeighbour(), removeOnLinkPrefix(), removeRoute(), and updateDestCache().

{
    if (!ev.isGUI())
        return;

    std::stringstream os;

    os << getNumRoutes() << " routes\n" << destCache.size() << " destcache entries";
    getDisplayString().setTagArg("t", 0, os.str().c_str());
}

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const DestCacheEntry &	e
	)			`[friend]`

Definition at line 67 of file RoutingTable6.cc.

{
    os << "if=" << e.interfaceId << " " << e.nextHopAddr;  //FIXME try printing interface name
    return os;
};

Member Data Documentation

DestCache RoutingTable6::destCache [protected]

Definition at line 120 of file RoutingTable6.h.

Referenced by initialize(), lookupDestCache(), purgeDestCache(), purgeDestCacheEntriesToNeighbour(), updateDestCache(), and updateDisplayString().

IInterfaceTable* RoutingTable6::ift [protected]

Definition at line 105 of file RoutingTable6.h.

Referenced by getInterfaceByAddress(), initialize(), isLocalAddress(), and parseXMLConfigFile().

bool RoutingTable6::isrouter [protected]

Definition at line 108 of file RoutingTable6.h.

Referenced by configureInterfaceForIPv6(), and initialize().

NotificationBoard* RoutingTable6::nb [protected]

Definition at line 106 of file RoutingTable6.h.

Referenced by addOrUpdateOnLinkPrefix(), addOrUpdateOwnAdvPrefix(), addRoute(), initialize(), and removeRoute().

RouteList RoutingTable6::routeList [protected]

Definition at line 125 of file RoutingTable6.h.

Referenced by addOrUpdateOnLinkPrefix(), addOrUpdateOwnAdvPrefix(), addRoute(), doLongestPrefixMatch(), getNumRoutes(), getRoute(), initialize(), isPrefixPresent(), removeOnLinkPrefix(), removeRoute(), and ~RoutingTable6().

The documentation for this class was generated from the following files:

RoutingTable6 Class Reference

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions