Base class for STP and RSTP. More...

#include <STPBase.h>

Inheritance diagram for inet::STPBase:

Public Member Functions
	STPBase ()

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

virtual void	receiveSignal (cComponent source, simsignal_t signalID, cObject obj, cObject *details) override

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	start ()

virtual void	stop ()

virtual void	colorLink (unsigned int i, bool forwarding) const
	Adds effects to be represented by Tkenv. More...

virtual void	refreshDisplay () const override
	Adds effects to be represented by Tkenv. More...

virtual int	getRootIndex () const
	Obtains the root gate index. More...

Ieee8021dInterfaceData *	getPortInterfaceData (unsigned int portNum)
	Gets Ieee8021dInterfaceData for port number. More...

const Ieee8021dInterfaceData *	getPortInterfaceData (unsigned int portNum) const

InterfaceEntry *	getPortInterfaceEntry (unsigned int portNum)
	Gets InterfaceEntry for port number. More...

virtual InterfaceEntry *	chooseInterface ()

Protected Attributes
bool	visualize = false

bool	isOperational = false

unsigned int	numPorts = 0

unsigned int	bridgePriority = 0

MACAddress	bridgeAddress

simtime_t	maxAge

simtime_t	helloTime

simtime_t	forwardDelay

cModule *	switchModule = nullptr

IMACAddressTable *	macTable = nullptr

IInterfaceTable *	ifTable = nullptr

InterfaceEntry *	ie = nullptr

Detailed Description

Base class for STP and RSTP.

Constructor & Destructor Documentation

inet::STPBase::STPBase ( )

31 {

32 }

Member Function Documentation

InterfaceEntry * inet::STPBase::chooseInterface ( )

protectedvirtual

Referenced by start().

 {
     // TODO: Currently, we assume that the first non-loopback interface is an Ethernet interface
     //       since STP and RSTP work on EtherSwitches.
     //       NOTE that, we doesn't check if the returning interface is an Ethernet interface!
     IInterfaceTable *ift = check_and_cast<IInterfaceTable *>(getModuleByPath(par("interfaceTablePath")));
 
     for (int i = 0; i < ift->getNumInterfaces(); i++) {
         InterfaceEntry *current = ift->getInterface(i);
         if (!current->isLoopback())
             return current;
     }
 
     return nullptr;
 }

void inet::STPBase::colorLink	(	unsigned int	i,
		bool	forwarding
	)		const

protectedvirtual

Adds effects to be represented by Tkenv.

Colors the link black if forwarding parameter is true and the port to which the link is connected to is also forwarding, otherwise colors the link gray.

Referenced by refreshDisplay().

 {
     if (visualize) {
         cGate *inGate = switchModule->gate("ethg$i", i);
         cGate *outGate = switchModule->gate("ethg$o", i);
         cGate *outGateNext = outGate ? outGate->getNextGate() : nullptr;
         cGate *outGatePrev = outGate ? outGate->getPreviousGate() : nullptr;
         cGate *inGatePrev = inGate ? inGate->getPreviousGate() : nullptr;
         cGate *inGatePrev2 = inGatePrev ? inGatePrev->getPreviousGate() : nullptr;
 
         if (outGate && inGate && inGatePrev && outGateNext && outGatePrev && inGatePrev2) {
             if (forwarding) {
                 outGatePrev->getDisplayString().setTagArg("ls", 0, ENABLED_LINK_COLOR);
                 inGate->getDisplayString().setTagArg("ls", 0, ENABLED_LINK_COLOR);
             }
             else {
                 outGatePrev->getDisplayString().setTagArg("ls", 0, DISABLED_LINK_COLOR);
                 inGate->getDisplayString().setTagArg("ls", 0, DISABLED_LINK_COLOR);
             }
 
             if ((!inGatePrev2->getDisplayString().containsTag("ls") || strcmp(inGatePrev2->getDisplayString().getTagArg("ls", 0), ENABLED_LINK_COLOR) == 0) && forwarding) {
                 outGate->getDisplayString().setTagArg("ls", 0, ENABLED_LINK_COLOR);
                 inGatePrev->getDisplayString().setTagArg("ls", 0, ENABLED_LINK_COLOR);
             }
             else {
                 outGate->getDisplayString().setTagArg("ls", 0, DISABLED_LINK_COLOR);
                 inGatePrev->getDisplayString().setTagArg("ls", 0, DISABLED_LINK_COLOR);
             }
         }
     }
 }

Ieee8021dInterfaceData * inet::STPBase::getPortInterfaceData ( unsigned int portNum )

protected

Gets Ieee8021dInterfaceData for port number.

Returns: The port's Ieee8021dInterfaceData, or nullptr if it doesn't exist.

Referenced by inet::STP::checkRootEligibility(), inet::RSTP::checkTC(), inet::STP::checkTimers(), inet::RSTP::compareInterfacedata(), inet::RSTP::contestInterfacedata(), inet::RSTP::flushOtherPorts(), inet::STP::generateBPDU(), inet::STP::generateTCN(), inet::RSTP::getBestAlternate(), getRootIndex(), inet::RSTP::handleBackup(), inet::STP::handleBPDU(), inet::RSTP::handleHelloTime(), inet::STP::handleTick(), inet::RSTP::handleUpgrade(), inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::RSTP::initPorts(), inet::STP::isSuperiorBPDU(), inet::operator<<(), inet::RSTP::printState(), inet::RSTP::processBetterSource(), inet::RSTP::processBPDU(), inet::RSTP::processSameSource(), inet::RSTP::receiveSignal(), refreshDisplay(), inet::RSTP::scheduleNextUpgrade(), inet::STP::selectDesignatedPorts(), inet::STP::selectRootPort(), inet::RSTP::sendBPDU(), inet::RSTP::sendBPDUs(), inet::RSTP::sendTCNtoRoot(), inet::STP::setAllDesignated(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

 {
     Ieee8021dInterfaceData *portData = getPortInterfaceEntry(portNum)->ieee8021dData();
     if (!portData)
         throw cRuntimeError("Ieee8021dInterfaceData not found!");
 
     return portData;
 }

const Ieee8021dInterfaceData* inet::STPBase::getPortInterfaceData ( unsigned int portNum ) const

inlineprotected

Referenced by getPortInterfaceData().

86 { return const_cast<STPBase *>(this)->getPortInterfaceData(portNum); }

inet::STPBase::getPortInterfaceData

Ieee8021dInterfaceData * getPortInterfaceData(unsigned int portNum)

Gets Ieee8021dInterfaceData for port number.

Definition: STPBase.cc:140

inet::STPBase::STPBase

STPBase()

Definition: STPBase.cc:30

InterfaceEntry * inet::STPBase::getPortInterfaceEntry ( unsigned int portNum )

protected

Gets InterfaceEntry for port number.

Returns: The port's InterfaceEntry, or nullptr if it doesn't exist.

Referenced by getPortInterfaceData(), inet::RSTP::handleUpgrade(), inet::RSTP::receiveSignal(), and inet::RSTP::scheduleNextUpgrade().

 {
     cGate *gate = switchModule->gate("ethg$o", portNum);
     if (!gate)
         throw cRuntimeError("gate is nullptr");
     InterfaceEntry *gateIfEntry = ifTable->getInterfaceByNodeOutputGateId(gate->getId());
     if (!gateIfEntry)
         throw cRuntimeError("gate's Interface is nullptr");
 
     return gateIfEntry;
 }

int inet::STPBase::getRootIndex ( ) const

protectedvirtual

Obtains the root gate index.

Returns: The root gate index or -1 if there is no root gate.

Referenced by inet::RSTP::contestInterfacedata(), inet::RSTP::printState(), inet::RSTP::processBetterSource(), refreshDisplay(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

 {
     for (unsigned int i = 0; i < numPorts; i++)
         if (getPortInterfaceData(i)->getRole() == Ieee8021dInterfaceData::ROOT)
             return i;
 
     return -1;
 }

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

overridevirtual

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.

 {
     Enter_Method_Silent();
 
     if (dynamic_cast<NodeStartOperation *>(operation)) {
         if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_LINK_LAYER)
             start();
     }
     else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
         if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_LINK_LAYER)
             stop();
     }
     else if (dynamic_cast<NodeCrashOperation *>(operation)) {
         if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH)
             stop();
     }
     else
         throw cRuntimeError("Unsupported operation '%s'", operation->getClassName());
 
     return true;
 }

void inet::STPBase::initialize ( int stage )

overrideprotectedvirtual

Reimplemented in inet::STP, and inet::RSTP.

Referenced by inet::RSTP::initialize(), and inet::STP::initialize().

 {
     if (stage == INITSTAGE_LOCAL) {
         visualize = par("visualize");
         bridgePriority = par("bridgePriority");
 
         maxAge = par("maxAge");
         helloTime = par("helloTime");
         forwardDelay = par("forwardDelay");
 
         macTable = check_and_cast<IMACAddressTable *>(getModuleByPath(par("macTablePath")));
         ifTable = check_and_cast<IInterfaceTable *>(getModuleByPath(par("interfaceTablePath")));
         switchModule = findContainingNode(this);
         if (!switchModule)
             throw cRuntimeError("Containing @networkNode module not found");
         numPorts = switchModule->gate("ethg$o", 0)->getVectorSize();
     }
 
     if (stage == INITSTAGE_LINK_LAYER_2) {    // "auto" MAC addresses assignment takes place in stage 0
         cModule *m = findContainingNode(this);
         if (m)
             m->subscribe(NF_INTERFACE_STATE_CHANGED, this);
 
         NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(switchModule->getSubmodule("status"));
         isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
 
         if (isOperational)
             start();
     }
 }

virtual int inet::STPBase::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented in inet::STP, and inet::RSTP.

57 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

virtual void inet::STPBase::receiveSignal	(	cComponent *	source,
		simsignal_t	signalID,
		cObject *	obj,
		cObject *	details
	)

inlineoverridevirtual

Reimplemented in inet::RSTP.

54 {}

void inet::STPBase::refreshDisplay ( ) const

overrideprotectedvirtual

Adds effects to be represented by Tkenv.

Inactive links are colored grey. Shows port role, state. Marks root switch.

 {
     if (visualize) {
         for (unsigned int i = 0; i < numPorts; i++) {
             const Ieee8021dInterfaceData *port = getPortInterfaceData(i);
 
             // color link
             colorLink(i, isOperational && (port->getState() == Ieee8021dInterfaceData::FORWARDING));
 
             // label ethernet interface with port status and role
             cModule *nicModule = switchModule->getSubmodule("eth", i);
             if (nicModule != nullptr) {
                 char buf[32];
                 sprintf(buf, "%s\n%s", port->getRoleName(), port->getStateName());
                 nicModule->getDisplayString().setTagArg("t", 0, buf);
             }
         }
 
         // mark root switch
         if (isOperational && (const_cast<STPBase*>(this)->getRootIndex() == -1))
             switchModule->getDisplayString().setTagArg("i", 1, ROOT_SWITCH_COLOR);
         else
             switchModule->getDisplayString().setTagArg("i", 1, "");
     }
 }

void inet::STPBase::start ( )

protectedvirtual

Reimplemented in inet::STP, and inet::RSTP.

Referenced by handleOperationStage(), initialize(), inet::RSTP::start(), and inet::STP::start().

 {
     isOperational = true;
     ie = chooseInterface();
 
     if (ie)
         bridgeAddress = ie->getMacAddress(); // get the bridge's MAC address
     else
         throw cRuntimeError("No non-loopback interface found!");
 }

void inet::STPBase::stop ( )

protectedvirtual

Reimplemented in inet::STP, and inet::RSTP.

Referenced by handleOperationStage(), inet::RSTP::stop(), and inet::STP::stop().

 {
     isOperational = false;
     ie = nullptr;
 }

Member Data Documentation

MACAddress inet::STPBase::bridgeAddress

protected

Referenced by inet::STP::checkRootEligibility(), inet::RSTP::contestInterfacedata(), inet::STP::generateBPDU(), inet::RSTP::handleIncomingFrame(), inet::STP::initialize(), inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::operator<<(), inet::RSTP::printState(), inet::RSTP::processBPDU(), inet::STP::reset(), inet::STP::selectDesignatedPorts(), inet::RSTP::sendBPDU(), inet::RSTP::sendTCNtoRoot(), start(), inet::STP::start(), and inet::STP::tryRoot().

unsigned int inet::STPBase::bridgePriority = 0

protected

Referenced by inet::STP::checkParametersChange(), inet::STP::checkRootEligibility(), inet::RSTP::contestInterfacedata(), inet::STP::generateBPDU(), initialize(), inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::operator<<(), inet::RSTP::printState(), inet::STP::reset(), inet::STP::selectDesignatedPorts(), inet::RSTP::sendBPDU(), inet::RSTP::sendTCNtoRoot(), inet::STP::start(), and inet::STP::tryRoot().

simtime_t inet::STPBase::forwardDelay

protected

Referenced by inet::STP::checkParametersChange(), inet::RSTP::handleHelloTime(), inet::RSTP::handleUpgrade(), initialize(), inet::operator<<(), inet::RSTP::processBetterSource(), inet::RSTP::processSameSource(), inet::RSTP::receiveSignal(), inet::STP::reset(), inet::RSTP::sendBPDU(), inet::RSTP::sendTCNtoRoot(), inet::STP::start(), and inet::STP::tryRoot().

simtime_t inet::STPBase::helloTime

protected

Referenced by inet::RSTP::handleHelloTime(), initialize(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

InterfaceEntry* inet::STPBase::ie = nullptr

protected

Referenced by start(), and stop().

IInterfaceTable* inet::STPBase::ifTable = nullptr

protected

Referenced by getPortInterfaceEntry(), and initialize().

bool inet::STPBase::isOperational = false

protected

Referenced by inet::STP::handleMessage(), inet::RSTP::handleMessage(), initialize(), refreshDisplay(), start(), and stop().

IMACAddressTable* inet::STPBase::macTable = nullptr

protected

Referenced by inet::RSTP::checkTC(), inet::RSTP::flushOtherPorts(), inet::RSTP::handleBackup(), inet::STP::handleBPDU(), inet::RSTP::handleHelloTime(), initialize(), inet::RSTP::initPorts(), inet::RSTP::processBetterSource(), and inet::RSTP::processSameSource().

simtime_t inet::STPBase::maxAge

protected

Referenced by inet::STP::checkParametersChange(), inet::RSTP::handleIncomingFrame(), initialize(), inet::operator<<(), inet::STP::reset(), inet::RSTP::sendBPDU(), inet::RSTP::sendTCNtoRoot(), inet::STP::start(), and inet::STP::tryRoot().

cModule* inet::STPBase::switchModule = nullptr

protected

Referenced by colorLink(), getPortInterfaceEntry(), initialize(), and refreshDisplay().

bool inet::STPBase::visualize = false

protected

Referenced by colorLink(), initialize(), and refreshDisplay().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation