Implements the OSPFv2 routing protocol. More...

#include <OSPFRouting.h>

Inheritance diagram for inet::ospf::OSPFRouting:

Public Member Functions
	OSPFRouting ()

virtual	~OSPFRouting ()

void	insertExternalRoute (int ifIndex, const IPv4AddressRange &netAddr)
	Insert a route learn by BGP in OSPF routingTable as an external route. More...

bool	checkExternalRoute (const IPv4Address &route)
	Return true if the route is in OSPF external LSA Table, false else. 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	handleMessage (cMessage *msg) override

virtual void	handleMessageWhenDown (cMessage *msg)

virtual bool	handleOperationStage (LifecycleOperation operation, int stage, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

virtual void	createOspfRouter ()

virtual bool	isNodeUp ()

Private Attributes
IIPv4RoutingTable *	rt = nullptr

IInterfaceTable *	ift = nullptr

bool	isUp = false

Router *	ospfRouter = nullptr

Detailed Description

Implements the OSPFv2 routing protocol.

See the NED file for more information.

Constructor & Destructor Documentation

inet::ospf::OSPFRouting::OSPFRouting ( )

40 {

41 }

inet::ospf::OSPFRouting::~OSPFRouting ( )

virtual

 {
     delete ospfRouter;
 }

Member Function Documentation

bool inet::ospf::OSPFRouting::checkExternalRoute ( const IPv4Address & route )

Return true if the route is in OSPF external LSA Table, false else.

Used by the BGPRouting module.

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

 {
     Enter_Method_Silent();
     for (unsigned long i = 1; i < ospfRouter->getASExternalLSACount(); i++) {
         ASExternalLSA *externalLSA = ospfRouter->getASExternalLSA(i);
         IPv4Address externalAddr = externalLSA->getHeader().getLinkStateID();
         if (externalAddr == route) //FIXME was this meant???
             return true;
     }
     return false;
 }

void inet::ospf::OSPFRouting::createOspfRouter ( )

protectedvirtual

Referenced by handleOperationStage(), initialize(), and numInitStages().

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

void inet::ospf::OSPFRouting::handleMessage ( cMessage * msg )

overrideprotectedvirtual

Referenced by numInitStages().

 {
     if (!isUp)
         handleMessageWhenDown(msg);
     else
         ospfRouter->getMessageHandler()->messageReceived(msg);
 }

void inet::ospf::OSPFRouting::handleMessageWhenDown ( cMessage * msg )

protectedvirtual

Referenced by handleMessage(), and numInitStages().

 {
     if (msg->isSelfMessage())
         throw cRuntimeError("Model error: self msg '%s' received when protocol is down", msg->getName());
     EV_ERROR << "Protocol is turned off, dropping '" << msg->getName() << "' message\n";
     delete msg;
 }

bool inet::ospf::OSPFRouting::handleOperationStage	(	LifecycleOperation *	operation,
		int	stage,
		IDoneCallback *	doneCallback
	)

overrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

Referenced by numInitStages().

 {
     Enter_Method_Silent();
 
     if (dynamic_cast<NodeStartOperation *>(operation)) {
         if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_ROUTING_PROTOCOLS) {
             ASSERT(ospfRouter == nullptr);
             isUp = true;
             createOspfRouter();
         }
     }
     else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
         if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_ROUTING_PROTOCOLS) {
             ASSERT(ospfRouter);
             isUp = false;
             delete ospfRouter;
             ospfRouter = nullptr;
         }
     }
     else if (dynamic_cast<NodeCrashOperation *>(operation)) {
         if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH) {
             ASSERT(ospfRouter);
             isUp = false;
             delete ospfRouter;
             ospfRouter = nullptr;
         }
     }
     else {
         throw cRuntimeError("Unsupported operation '%s'", operation->getClassName());
     }
     return true;
 }

void inet::ospf::OSPFRouting::initialize ( int stage )

overrideprotectedvirtual

Referenced by numInitStages().

 {
     cSimpleModule::initialize(stage);
 
     if (stage == INITSTAGE_ROUTING_PROTOCOLS) {
         ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
         rt = getModuleFromPar<IIPv4RoutingTable>(par("routingTableModule"), this);
         IPSocket ipSocket(gate("ipOut"));
         ipSocket.registerProtocol(IP_PROT_OSPF);
 
         isUp = isNodeUp();
         if (isUp)
             createOspfRouter();
     }
 }

void inet::ospf::OSPFRouting::insertExternalRoute	(	int	ifIndex,
		const IPv4AddressRange &	netAddr
	)

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

Used by the BGPRouting module. : interface ID

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

 {
     Enter_Method_Silent();
     OSPFASExternalLSAContents newExternalContents;
     newExternalContents.setRouteCost(OSPF_BGP_DEFAULT_COST);
     newExternalContents.setExternalRouteTag(OSPF_EXTERNAL_ROUTES_LEARNED_BY_BGP);
     const IPv4Address netmask = netAddr.mask;
     newExternalContents.setNetworkMask(netmask);
     ospfRouter->updateExternalRoute(netAddr.address, newExternalContents, ifIndex);
 }

bool inet::ospf::OSPFRouting::isNodeUp ( )

protectedvirtual

Referenced by initialize(), and numInitStages().

 {
     NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
     return !nodeStatus || nodeStatus->getState() == NodeStatus::UP;
 }