FwTable Class Reference

#include <FwTable.h>

Inheritance diagram for FwTable:

List of all members.

Public Member Functions
virtual	~FwTable ()
virtual std::string	getRouterId ()
virtual void	setRouterId (std::string a)
virtual list< int >	findMatchingRoute (string FID)
virtual int	getNumRoutes ()
virtual const char *	getLID (int index)
virtual const char *	getInterfaceName (int index)
virtual FwRoute *	getFwRoute (string LID)
Protected Types
typedef std::vector< FwRoute * >	RouteVector
Protected Member Functions
virtual void	initialize (int stage)
virtual int	numInitStages () const
virtual void	updateDisplayString ()
virtual void	handleMessage (cMessage *)
virtual void	configureRouterId ()
void	addInterfaceRoute (InterfaceEntry *entry)
virtual void	receiveChangeNotification (int category, const cPolymorphic *details)
Protected Attributes
IInterfaceTable *	ift
	cached pointer
NotificationBoard *	nb
	cached pointer
std::string	routerId
	The ID of the Router Using this Forwarding Table.
RouteVector	routes
	Unicast route array.

---

Detailed Description

Represents the forwarding table. This object has one instance per host or router. It has methods to manage the interface table and the interface table, so one can achieve functionality similar to the "route" and "ifconfig" commands.

See the NED documentation for general overview.

---

Member Typedef Documentation

typedef std::vector<FwRoute *> FwTable::RouteVector [protected]

---

Constructor & Destructor Documentation

FwTable::~FwTable

(

)

[virtual]

Destructor of the class.

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

---

Member Function Documentation

void FwTable::addInterfaceRoute

(

InterfaceEntry *

entry

)

[protected]

Adds the FID for an interface.

{
        //Go to the end of the list
    RouteVector::iterator it = routes.end();

    //Set up entry
    FwRoute *fwEntry = new FwRoute();
    string tempLID;

    //Create a random LID, with few 1s
        tempLID = "0000000000000000000000000000000000000000000000000000000000000000";

        //Set at least 5 1s
        for(int i=0;i<5;i++)
                tempLID[intrand(FID_LEN*8)]='1';

        //And some extra...
        //int extra=intrand(6);
        //for(int i=0;i<5;i++)
        //      tempLID[intrand(64)]='1';

    fwEntry->setLID(tempLID);
    fwEntry->setInterface(entry);
    fwEntry->setMetric(intrand(100));


    //Push it to the route vector
    routes.push_back(fwEntry);

    //Update Display String
    updateDisplayString();
}

void FwTable::configureRouterId

(

)

[protected, virtual]

Set the Router ID

{
        const char *routerIdStr = par("routerId").stringValue();
        if (!strcmp(routerIdStr, "auto"))  // non-"auto" cases already handled in stage 1
        {
                //Put the simulation name of the parent module as the routerID
                routerId = this->getParentModule()->getFullName();
        }
        else {
                //Put the name specified in the configuration file as the routerID
                routerId=routerIdStr;
        }
}

list< int > FwTable::findMatchingRoute

(

string

FID

)

[virtual]

The routing function.

{
    Enter_Method("findMatchingRoute(%s)", FID.c_str()); // note: str().c_str() too slow here

    list<int> matchingInterfaces;

    if(!routes.empty()) {
                for (RouteVector::const_iterator i=routes.begin(); i!=routes.end(); ++i)
                {
                        FwRoute *e = *i;
                        //Make the LID and FID comparison
                        if (e->getLID().compare(lidAND(e->getLID(),FID))==0)
                        {
                                matchingInterfaces.push_back(e->getInterface()->getNetworkLayerGateIndex());
                        }
                }
    }
    else {
        ev << "No routes found in router " << this->getParentModule()->getFullName() << endl;
    }

    return matchingInterfaces;
}

FwRoute * FwTable::getFwRoute

(

string

LID

)

[virtual]

Return a pointer to the forwarding entry for the specified interface

                                       {
        for (int i=0; i<getNumRoutes(); i++) {
                if(LID.compare(routes.at(i)->getLID())==0) {
                        return routes.at(i);
                }
        }

        return NULL;
}

const char * FwTable::getInterfaceName

(

int

index

)

[virtual]

Get the name of a specific interface

                                               {
        return routes.at(index)->getInterfaceName();
}

const char * FwTable::getLID

(

int

index

)

[virtual]

Return the LID of a specified link.

                                     {
        return routes.at(index)->getLID().c_str();
}

int FwTable::getNumRoutes

(

)

[virtual]

Returns the total number of routes (unicast only, unlike IP)

{
    return routes.size();
}

virtual std::string FwTable::getRouterId

(

)

[inline, virtual]

Forwarding on/off Returns routerId.

{return routerId;}

void FwTable::handleMessage

(

cMessage *

msg

)

[protected, virtual]

Raises an error.

Reimplemented from cSimpleModule.

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

void FwTable::initialize

(

int

stage

)

[protected, virtual]

Initialization of the Forwarding Table module

Reimplemented from cComponent.

{
    if (stage==0)
    {
        // used for the random generator
        srand ( time(NULL) );

        // get a pointer to the NotificationBoard module and IInterfaceTable
        nb = NotificationBoardAccess().get();
        ift = InterfaceTableAccess().get();

        configureRouterId();

        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_IPv4CONFIG_CHANGED);

        WATCH_PTRVECTOR(routes);
        WATCH(routerId);
    }
   if (stage==1)
    {
           // L2 modules register themselves in stage 0, so we can only configure
       // the interfaces in stage 1.
           IInterfaceTable *interfaceTable = InterfaceTableAccess().get();
           for (int i=1; i<interfaceTable->getNumInterfaces(); i++) {
                   //Create a new entry for each interface
                   addInterfaceRoute(interfaceTable->getInterface(i));

                   ev << "Adding forwarding route for interface ";
                   ev << (interfaceTable->getInterface(i)->getName()[0] ? interfaceTable->getInterface(i)->getName() : "*") << endl;
           }
    }
}

virtual int FwTable::numInitStages

(

)

const [inline, protected, virtual]

Returns the number of initialization stages.

Reimplemented from cComponent.

{return 4;}

void FwTable::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.

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

    Enter_Method_Silent();
    printNotificationBanner(category, details);

    if (category==NF_INTERFACE_CREATED)
    {
        // add netmask route for the new interface
        //updateNetmaskRoutes();
    }
    else if (category==NF_INTERFACE_DELETED)
    {
        // remove all routes that point to that interface
        //InterfaceEntry *entry = check_and_cast<InterfaceEntry*>(details);
        //deleteInterfaceRoutes(entry);
    }
    else if (category==NF_INTERFACE_STATE_CHANGED)
    {
        //invalidateCache();
    }
    else if (category==NF_INTERFACE_CONFIG_CHANGED)
    {
        //invalidateCache();
    }
    else if (category==NF_INTERFACE_IPv4CONFIG_CHANGED)
    {
        // if anything IPv4-related changes in the interfaces, interface netmask
        // based routes have to be re-built.
        //updateNetmaskRoutes();
    }
}

virtual void FwTable::setRouterId

(

std::string

a

)

[inline, virtual]

Sets routerId.

{routerId = a;}

void FwTable::updateDisplayString

(

)

[protected, virtual]

Displays summary above the icon.

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

    char buf[80];
    if (routerId.empty())
        sprintf(buf, "%d routes", (int)routes.size());
    else
        sprintf(buf, "routerId: %s\n%d routes", routerId.c_str(), (int)routes.size());
    getDisplayString().setTagArg("t",0,buf);
}

---

Member Data Documentation

IInterfaceTable* FwTable::ift [protected]

cached pointer

NotificationBoard* FwTable::nb [protected]

cached pointer

std::string FwTable::routerId [protected]

The ID of the Router Using this Forwarding Table.

RouteVector FwTable::routes [protected]

Unicast route array.

---

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

• FwTable.h
• FwTable.cc