inet::ospfv2::Ospfv2 Class Reference

Implements the OSPFv2 routing protocol. More...

#include <Ospfv2.h>

Inheritance diagram for inet::ospfv2::Ospfv2:

Public Member Functions
	Ospfv2 ()
virtual	~Ospfv2 ()
void	insertExternalRoute (int ifIndex, const Ipv4AddressRange &netAddr)
	Insert a route learn by BGP in OSPF routingTable as an external route. More...
int	checkExternalRoute (const Ipv4Address &route)
	Checks if the route is in OSPF external LSA Table. More...
Public Member Functions inherited from inet::RoutingProtocolBase
	RoutingProtocolBase ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
	Listen on interface changes and update private data structures. More...
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual void	createOspfRouter ()
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
void	handleInterfaceDown (const NetworkInterface *ie)
Protected Member Functions inherited from inet::RoutingProtocolBase
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...
virtual void	handleActiveOperationTimeout (cMessage *message)
virtual bool	isUp () const
	utility functions More...
virtual bool	isDown () const
virtual void	setOperationalState (State newState)
virtual void	scheduleOperationTimeout (simtime_t timeout)
virtual void	setupActiveOperation (LifecycleOperation *operation, IDoneCallback *doneCallback, State)
virtual void	delayActiveOperationFinish (simtime_t timeout)
virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)
virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)
virtual void	finishActiveOperation ()

Private Attributes
cModule *	host = nullptr
ModuleRefByPar< IIpv4RoutingTable >	rt
ModuleRefByPar< IInterfaceTable >	ift
Router *	ospfRouter = nullptr
cMessage *	startupTimer = nullptr

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Detailed Description

Implements the OSPFv2 routing protocol.

See the NED file for more information.

Constructor & Destructor Documentation

Ospfv2()

inet::ospfv2::Ospfv2::Ospfv2

(

)

{
}

~Ospfv2()

inet::ospfv2::Ospfv2::~Ospfv2 ( )

virtual

{
    cancelAndDelete(startupTimer);
    delete ospfRouter;
}

Member Function Documentation

checkExternalRoute()

int inet::ospfv2::Ospfv2::checkExternalRoute

(

const Ipv4Address &

route

)

Checks if the route is in OSPF external LSA Table.

0: not external, 1: type 1 external, 2: type 2 external Used by the Bgp module.

{
    Enter_Method("checkExternalRoute");
    for (uint32_t i = 0; i < ospfRouter->getASExternalLSACount(); i++) {
        AsExternalLsa *externalLSA = ospfRouter->getASExternalLSA(i);
        Ipv4Address externalAddr = externalLSA->getHeader().getLinkStateID();
        if (externalAddr == route) { // FIXME was this meant???
            if (externalLSA->getContents().getExternalTOSInfo(0).E_ExternalMetricType)
                return 2;
            else
                return 1;
        }
    }
    return 0;
}

Referenced by inet::bgp::BgpRouter::checkExternalRoute().

createOspfRouter()

void inet::ospfv2::Ospfv2::createOspfRouter ( )

protectedvirtual

{
    ospfRouter = new Router(this, ift, rt);
 
    // read the OSPF AS configuration
    cXMLElement *ospfConfig = par("ospfConfig");
    Ospfv2ConfigReader configReader(this, ift);
    if (!configReader.loadConfigFromXML(ospfConfig, ospfRouter))
        throw cRuntimeError("Error reading AS configuration from %s", ospfConfig->getSourceLocation());
 
    ospfRouter->addWatches();
}

Referenced by handleMessageWhenUp(), and handleStartOperation().

handleCrashOperation()

void inet::ospfv2::Ospfv2::handleCrashOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    ASSERT(ospfRouter);
    delete ospfRouter;
    cancelEvent(startupTimer);
    ospfRouter = nullptr;
    unsubscribe();
}

handleInterfaceDown()

void inet::ospfv2::Ospfv2::handleInterfaceDown ( const NetworkInterface *  ie )

protected

{
    EV_DEBUG << "interface " << ie->getInterfaceId() << " went down. \n";
 
    // Step 1: delete all direct-routes connected to this interface
 
    // ... from OSPF table
    for (uint32_t i = 0; i < ospfRouter->getRoutingTableEntryCount(); i++) {
        Ospfv2RoutingTableEntry *ospfRoute = ospfRouter->getRoutingTableEntry(i);
        if (ospfRoute && ospfRoute->getInterface() == ie && ospfRoute->getNextHopAsGeneric().isUnspecified()) {
            EV_DEBUG << "removing route from OSPF routing table: " << ospfRoute << "\n";
            ospfRouter->deleteRoute(ospfRoute);
            i--;
        }
    }
    // ... from Ipv4 table
    for (int32_t i = 0; i < rt->getNumRoutes(); i++) {
        Ipv4Route *route = rt->getRoute(i);
        if (route && route->getInterface() == ie && route->getNextHopAsGeneric().isUnspecified()) {
            EV_DEBUG << "removing route from Ipv4 routing table: " << route << "\n";
            rt->deleteRoute(route);
            i--;
        }
    }
 
    // Step 2: find the Ospfv2Interface associated with the ie and take it down
    Ospfv2Interface *foundIntf = nullptr;
    for (auto& areaId : ospfRouter->getAreaIds()) {
        Ospfv2Area *area = ospfRouter->getAreaByID(areaId);
        if (area) {
            for (auto& ifIndex : area->getInterfaceIndices()) {
                Ospfv2Interface *intf = area->getInterface(ifIndex);
                if (intf && intf->getIfIndex() == ie->getInterfaceId()) {
                    foundIntf = intf;
                    break;
                }
            }
            if (foundIntf) {
                foundIntf->processEvent(Ospfv2Interface::INTERFACE_DOWN);
                break;
            }
        }
    }
}

Referenced by receiveSignal().

handleMessageWhenUp()

void inet::ospfv2::Ospfv2::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg == startupTimer) {
        createOspfRouter();
        subscribe();
    }
    else
        ospfRouter->getMessageHandler()->messageReceived(msg);
 
}

handleStartOperation()

void inet::ospfv2::Ospfv2::handleStartOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    ASSERT(ospfRouter == nullptr);
    simtime_t startupTime = par("startupTime");
    if (startupTime <= simTime()) {
        createOspfRouter();
        subscribe();
    }
    else
        scheduleAfter(startupTime, startupTimer);
}

handleStopOperation()

void inet::ospfv2::Ospfv2::handleStopOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    ASSERT(ospfRouter);
    delete ospfRouter;
    cancelEvent(startupTimer);
    ospfRouter = nullptr;
    unsubscribe();
}

initialize()

void inet::ospfv2::Ospfv2::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    RoutingProtocolBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        host = getContainingNode(this);
        ift.reference(this, "interfaceTableModule", true);
        rt.reference(this, "routingTableModule", true);
        startupTimer = new cMessage("OSPF-startup");
    }
    else if (stage == INITSTAGE_ROUTING_PROTOCOLS) { // interfaces and static routes are already initialized
        registerProtocol(Protocol::ospf, gate("ipOut"), gate("ipIn"));
    }
}

insertExternalRoute()

void inet::ospfv2::Ospfv2::insertExternalRoute	(	int	ifIndex,
		const Ipv4AddressRange &	netAddr
	)

Insert a route learn by BGP in OSPF routingTable as an external route.

Used by the Bgp module. @ifIndex: interface ID

{
    Enter_Method("insertExternalRoute");
    Ospfv2AsExternalLsaContents newExternalContents;
    newExternalContents.setExternalTOSInfoArraySize(1);
    const Ipv4Address netmask = netAddr.mask;
    newExternalContents.setNetworkMask(netmask);
    auto& tosInfo = newExternalContents.getExternalTOSInfoForUpdate(0);
    tosInfo.E_ExternalMetricType = false;
    tosInfo.tos = 0;
    tosInfo.externalRouteTag = OSPFv2_EXTERNAL_ROUTES_LEARNED_BY_BGP;
//    tosInfo.forwardingAddress = ;
    tosInfo.routeCost = OSPFv2_BGP_DEFAULT_COST;
 
    ospfRouter->updateExternalRoute(netAddr.address, newExternalContents, ifIndex);
}

Referenced by inet::bgp::BgpRouter::decisionProcess().

numInitStages()

virtual int inet::ospfv2::Ospfv2::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

receiveSignal()

void inet::ospfv2::Ospfv2::receiveSignal ( cComponent *  source, simsignal_t  signalID, cObject *  obj, cObject *  details  )

overrideprotectedvirtual

Listen on interface changes and update private data structures.

{
    Enter_Method("%s", cComponent::getSignalName(signalID));
 
    const NetworkInterface *ie;
    const NetworkInterfaceChangeDetails *change;
 
    if (signalID == interfaceCreatedSignal) {
        // configure interface for RIP
        ie = check_and_cast<const NetworkInterface *>(obj);
        if (ie->isMulticast() && !ie->isLoopback()) {
            // TODO
        }
    }
    else if (signalID == interfaceDeletedSignal) {
        ie = check_and_cast<const NetworkInterface *>(obj);
        // TODO
    }
    else if (signalID == interfaceStateChangedSignal) {
        change = check_and_cast<const NetworkInterfaceChangeDetails *>(obj);
        auto fieldId = change->getFieldId();
        if (fieldId == NetworkInterface::F_STATE || fieldId == NetworkInterface::F_CARRIER) {
            ie = change->getNetworkInterface();
            if (!ie->isUp())
                handleInterfaceDown(ie);
            else {
                // interface went back online. Do nothing!
                // Wait for Hello messages to establish adjacency.
            }
        }
    }
    else
        throw cRuntimeError("Unexpected signal: %s", getSignalName(signalID));
}

subscribe()

void inet::ospfv2::Ospfv2::subscribe ( )

protectedvirtual

{
    host->subscribe(interfaceCreatedSignal, this);
    host->subscribe(interfaceDeletedSignal, this);
    host->subscribe(interfaceStateChangedSignal, this);
}

Referenced by handleMessageWhenUp(), and handleStartOperation().

unsubscribe()

void inet::ospfv2::Ospfv2::unsubscribe ( )

protectedvirtual

{
    host->unsubscribe(interfaceCreatedSignal, this);
    host->unsubscribe(interfaceDeletedSignal, this);
    host->unsubscribe(interfaceStateChangedSignal, this);
}

Referenced by handleCrashOperation(), and handleStopOperation().

Member Data Documentation

host

cModule* inet::ospfv2::Ospfv2::host = nullptr

private

Referenced by initialize(), subscribe(), and unsubscribe().

ift

ModuleRefByPar<IInterfaceTable> inet::ospfv2::Ospfv2::ift

private

Referenced by createOspfRouter(), and initialize().

ospfRouter

Router* inet::ospfv2::Ospfv2::ospfRouter = nullptr

private

Referenced by checkExternalRoute(), createOspfRouter(), handleCrashOperation(), handleInterfaceDown(), handleMessageWhenUp(), handleStartOperation(), handleStopOperation(), insertExternalRoute(), and ~Ospfv2().

rt

ModuleRefByPar<IIpv4RoutingTable> inet::ospfv2::Ospfv2::rt

private

Referenced by createOspfRouter(), handleInterfaceDown(), and initialize().

startupTimer

cMessage* inet::ospfv2::Ospfv2::startupTimer = nullptr

private

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStartOperation(), handleStopOperation(), initialize(), and ~Ospfv2().

---

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

• Ospfv2.h
• Ospfv2.cc