inet::Rstp Class Reference

Implements the Rapid Spanning Tree Protocol. More...

#include <Rstp.h>

Inheritance diagram for inet::Rstp:

Public Member Functions
	Rstp ()
virtual	~Rstp ()
virtual int	numInitStages () const override
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
Public Member Functions inherited from inet::StpBase
	StpBase ()
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Types
enum	SelfKinds { SELF_HELLOTIME = 1, SELF_UPGRADE }
enum	CompareResult {   WORSE_PORT = -4, WORSE_SRC = -3, WORSE_RPC = -2, WORSE_ROOT = -1,   SIMILAR = 0, BETTER_ROOT = 1, BETTER_RPC = 2, BETTER_SRC = 3,   BETTER_PORT = 4 }
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	finish () override
virtual void	initInterfacedata (unsigned int portNum)
virtual void	start () override
virtual void	stop () override
virtual void	initPorts ()
	initialize RSTP dynamic information More...
virtual int	getBestAlternate ()
	Gets the best alternate port. More...
virtual void	sendBPDUs ()
	Sends BPDUs through all ports, if they are required. More...
virtual void	sendBPDU (int interfaceId)
	Sends BPDU through a port. More...
virtual void	handleMessageWhenUp (cMessage *msg) override
	General processing. More...
virtual void	handleIncomingFrame (Packet *packet)
	BPDU processing. More...
virtual void	processBPDU (const Ptr< const BpduCfg > &frame, unsigned int arrivalInterfaceId)
virtual bool	processBetterSource (const Ptr< const BpduCfg > &frame, unsigned int arrivalInterfaceId)
virtual bool	processSameSource (const Ptr< const BpduCfg > &frame, unsigned int arrivalInterfaceId)
virtual void	printState ()
	Prints current data base info. More...
virtual void	updateInterfacedata (const Ptr< const BpduCfg > &frame, unsigned int interfaceId)
	Update Interfacedata with the content of the BPDU frame. More...
virtual CompareResult	contestInterfacedata (const Ptr< const BpduCfg > &msg, unsigned int interfaceId)
	Compares the BPDU frame with the BPDU this module would send through that port. More...
virtual CompareResult	contestInterfacedata (unsigned int interfaceId)
	Compares the port's best BPDU with the BPDU this module would send through that port. More...
virtual CompareResult	compareInterfacedata (unsigned int interfaceId, const Ptr< const BpduCfg > &msg, int linkCost)
	Compares a port's best BPDU with a BPDU frame. More...
virtual CompareResult	compareRSTPData (int rootPriority1, int rootPriority2, MacAddress rootAddress1, MacAddress rootAddress2, int rootPathCost1, int rootPathCost2, int bridgePriority1, int bridgePriority2, MacAddress bridgeAddress1, MacAddress bridgeAddress2, int portPriority1, int portPriority2, int portNum1, int portNum2)
	Compares two RSTP data. More...
virtual void	sendTCNtoRoot ()
	If root TCWhile has not expired, sends a BPDU to the Root with TCFlag=true. More...
virtual void	handleHelloTime (cMessage *)
	HelloTime event handling. More...
virtual void	handleUpgrade (cMessage *)
	Upgrade event handling. More...
virtual void	checkTC (const Ptr< const BpduCfg > &frame, int arrivalInterfaceId)
	Checks the frame TC flag. More...
virtual void	handleBackup (const Ptr< const BpduCfg > &frame, unsigned int arrivalInterfaceId)
	Handles the switch to backup in one of the ports. More...
virtual void	scheduleNextUpgrade ()
	schedule next upgrade self-message More...
virtual void	flushOtherPorts (unsigned int interfaceId)
	flush all port expect one More...
Protected Member Functions inherited from inet::StpBase
virtual void	colorLink (NetworkInterface *ie, 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	getRootInterfaceId () const
	Obtains the root interface ID. More...
const Ieee8021dInterfaceData *	getPortInterfaceData (unsigned int interfaceId) const
	Gets Ieee8021dInterfaceData for interface ID. More...
Ieee8021dInterfaceData *	getPortInterfaceDataForUpdate (unsigned int interfaceId)
NetworkInterface *	getPortNetworkInterface (unsigned int interfaceId) const
	Gets NetworkInterface for interface ID. More...
virtual NetworkInterface *	chooseInterface ()
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 ()

Protected Attributes
simtime_t	migrateTime
simtime_t	tcWhileTime
bool	autoEdge = false
cMessage *	helloTimer = nullptr
cMessage *	upgradeTimer = nullptr
Protected Attributes inherited from inet::StpBase
bool	visualize = false
unsigned int	numPorts = 0
unsigned int	bridgePriority = 0
MacAddress	bridgeAddress
simtime_t	maxAge
simtime_t	helloTime
simtime_t	forwardDelay
opp_component_ptr< cModule >	switchModule
ModuleRefByPar< IMacForwardingTable >	macTable
ModuleRefByPar< IInterfaceTable >	ifTable
opp_component_ptr< NetworkInterface >	ie
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Detailed Description

Implements the Rapid Spanning Tree Protocol.

See the NED file for details.

Member Enumeration Documentation

CompareResult

enum inet::Rstp::CompareResult

protected

Enumerator
WORSE_PORT
WORSE_SRC
WORSE_RPC
WORSE_ROOT
SIMILAR
BETTER_ROOT
BETTER_RPC
BETTER_SRC
BETTER_PORT

                       {
        WORSE_PORT = -4, WORSE_SRC = -3, WORSE_RPC = -2, WORSE_ROOT = -1, SIMILAR = 0,
        BETTER_ROOT = 1, BETTER_RPC = 2, BETTER_SRC = 3, BETTER_PORT = 4
    };

SelfKinds

enum inet::Rstp::SelfKinds

protected

Enumerator
SELF_HELLOTIME
SELF_UPGRADE

{ SELF_HELLOTIME = 1, SELF_UPGRADE };

Constructor & Destructor Documentation

Rstp()

inet::Rstp::Rstp

(

)

{
}

~Rstp()

inet::Rstp::~Rstp ( )

virtual

{
    cancelAndDelete(helloTimer);
    cancelAndDelete(upgradeTimer);
}

Member Function Documentation

checkTC()

void inet::Rstp::checkTC ( const Ptr< const BpduCfg > &  frame, int  arrivalInterfaceId  )

protectedvirtual

Checks the frame TC flag.

Sets TCWhile if the port was forwarding and the flag is true.

{
    const Ieee8021dInterfaceData *port = getPortInterfaceData(arrivalInterfaceId);
    if ((frame->getTcFlag() == true) && (port->getState() == Ieee8021dInterfaceData::FORWARDING)) {
        EV_DETAIL << "TCN received" << endl;
        findContainingNode(this)->bubble("TCN received");
        for (unsigned int i = 0; i < numPorts; i++) {
            int interfaceId = ifTable->getInterface(i)->getInterfaceId();
            if (interfaceId != arrivalInterfaceId) {
                auto port2 = getPortInterfaceDataForUpdate(interfaceId);
                // flushing other ports
                // TCN over other ports
                macTable->removeForwardingInterface(interfaceId);
                port2->setTCWhile(simTime() + tcWhileTime);
            }
        }
    }
}

Referenced by handleIncomingFrame().

compareInterfacedata()

Rstp::CompareResult inet::Rstp::compareInterfacedata ( unsigned int  interfaceId, const Ptr< const BpduCfg > &  msg, int  linkCost  )

protectedvirtual

Compares a port's best BPDU with a BPDU frame.

Returns

(<0 if vector better than frame)

{
    const Ieee8021dInterfaceData *ifd = getPortInterfaceData(interfaceId);
 
    return compareRSTPData(ifd->getRootPriority(), msg->getRootPriority(),
            ifd->getRootAddress(), msg->getRootAddress(),
            ifd->getRootPathCost(), msg->getRootPathCost() + linkCost,
            ifd->getBridgePriority(), msg->getBridgePriority(),
            ifd->getBridgeAddress(), msg->getBridgeAddress(),
            ifd->getPortPriority(), msg->getPortPriority(),
            ifd->getPortNum(), msg->getPortNum());
}

Referenced by processBetterSource(), processBPDU(), and processSameSource().

compareRSTPData()

Rstp::CompareResult inet::Rstp::compareRSTPData ( int  rootPriority1, int  rootPriority2, MacAddress  rootAddress1, MacAddress  rootAddress2, int  rootPathCost1, int  rootPathCost2, int  bridgePriority1, int  bridgePriority2, MacAddress  bridgeAddress1, MacAddress  bridgeAddress2, int  portPriority1, int  portPriority2, int  portNum1, int  portNum2  )

protectedvirtual

Compares two RSTP data.

Returns

(<0 if vector better than frame)

{
    if (rootPriority1 != rootPriority2)
        return (rootPriority1 < rootPriority2) ? WORSE_ROOT : BETTER_ROOT;
 
    int c = rootAddress1.compareTo(rootAddress2);
    if (c != 0)
        return (c < 0) ? WORSE_ROOT : BETTER_ROOT;
 
    if (rootPathCost1 != rootPathCost2)
        return (rootPathCost1 < rootPathCost2) ? WORSE_RPC : BETTER_RPC;
 
    if (bridgePriority1 != bridgePriority2)
        return (bridgePriority1 < bridgePriority2) ? WORSE_SRC : BETTER_SRC;
 
    c = bridgeAddress1.compareTo(bridgeAddress2);
    if (c != 0)
        return (c < 0) ? WORSE_SRC : BETTER_SRC;
 
    if (portPriority1 != portPriority2)
        return (portPriority1 < portPriority2) ? WORSE_PORT : BETTER_PORT;
 
    if (portNum1 != portNum2)
        return (portNum1 < portNum2) ? WORSE_PORT : BETTER_PORT;
 
    return SIMILAR;
}

Referenced by compareInterfacedata(), contestInterfacedata(), and getBestAlternate().

contestInterfacedata() [1/2]

Rstp::CompareResult inet::Rstp::contestInterfacedata ( const Ptr< const BpduCfg > &  msg, unsigned int  interfaceId  )

protectedvirtual

Compares the BPDU frame with the BPDU this module would send through that port.

Returns

(<0 if the root BPDU is better than BPDU)

{
    int r = getRootInterfaceId();
    const Ieee8021dInterfaceData *rootPort = getPortInterfaceData(r);
    const Ieee8021dInterfaceData *ifd = getPortInterfaceData(interfaceId);
 
    return compareRSTPData(rootPort->getRootPriority(), msg->getRootPriority(),
            rootPort->getRootAddress(), msg->getRootAddress(),
            rootPort->getRootPathCost(), msg->getRootPathCost(),
            bridgePriority, msg->getBridgePriority(),
            bridgeAddress, msg->getBridgeAddress(),
            ifd->getPortPriority(), msg->getPortPriority(),
            interfaceId, msg->getPortNum());
}

Referenced by processBetterSource(), and processSameSource().

contestInterfacedata() [2/2]

Rstp::CompareResult inet::Rstp::contestInterfacedata ( unsigned int  interfaceId )

protectedvirtual

Compares the port's best BPDU with the BPDU this module would send through that port.

Returns

(<0 if the root BPDU is better than port's best BPDU)

{
    int r = getRootInterfaceId();
    const Ieee8021dInterfaceData *rootPort = getPortInterfaceData(r);
    const Ieee8021dInterfaceData *ifd = getPortInterfaceData(portNum);
 
    return compareRSTPData(rootPort->getRootPriority(), ifd->getRootPriority(),
            rootPort->getRootAddress(), ifd->getRootAddress(),
            rootPort->getRootPathCost() + ifd->getLinkCost(), ifd->getRootPathCost(),
            bridgePriority, ifd->getBridgePriority(),
            bridgeAddress, ifd->getBridgeAddress(),
            ifd->getPortPriority(), ifd->getPortPriority(),
            portNum, ifd->getPortNum());
}

finish()

virtual void inet::Rstp::finish ( )

inlineoverrideprotectedvirtual

{}

flushOtherPorts()

void inet::Rstp::flushOtherPorts ( unsigned int  interfaceId )

protectedvirtual

flush all port expect one

{
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        auto iPort = getPortInterfaceDataForUpdate(interfaceId);
        iPort->setTCWhile(simTime() + tcWhileTime);
        if ((unsigned int)interfaceId != portId)
            macTable->removeForwardingInterface(interfaceId);
    }
}

Referenced by handleHelloTime(), handleUpgrade(), processBetterSource(), and processSameSource().

getBestAlternate()

int inet::Rstp::getBestAlternate ( )

protectedvirtual

Gets the best alternate port.

Returns

Best alternate gate index

{
    int candidate = -1; // index of the best alternate found
    for (unsigned int j = 0; j < numPorts; j++) {
        int interfaceId = ifTable->getInterface(j)->getInterfaceId();
        const Ieee8021dInterfaceData *jPort = getPortInterfaceData(interfaceId);
        if (jPort->getRole() == Ieee8021dInterfaceData::ALTERNATE) { // just from alternates, others are not updated
            if (candidate < 0)
                candidate = interfaceId;
            else {
                const Ieee8021dInterfaceData *candidatePort = getPortInterfaceData(candidate);
                if (compareRSTPData(jPort->getRootPriority(), candidatePort->getRootPriority(),
                        jPort->getRootAddress(), candidatePort->getRootAddress(),
                        jPort->getRootPathCost(), candidatePort->getRootPathCost(),
                        jPort->getBridgePriority(), candidatePort->getBridgePriority(),
                        jPort->getBridgeAddress(), candidatePort->getBridgeAddress(),
                        jPort->getPortPriority(), candidatePort->getPortPriority(),
                        jPort->getPortNum(), candidatePort->getPortNum()) < 0)
                {
                    // alternate better than the found one
                    candidate = interfaceId; // new candidate
                }
            }
        }
    }
    return candidate;
}

Referenced by handleHelloTime(), and processSameSource().

handleBackup()

void inet::Rstp::handleBackup ( const Ptr< const BpduCfg > &  frame, unsigned int  arrivalInterfaceId  )

protectedvirtual

Handles the switch to backup in one of the ports.

{
    EV_DETAIL << "More than one port in the same LAN" << endl;
    auto port = getPortInterfaceDataForUpdate(arrivalInterfaceId);
    if ((frame->getPortPriority() < port->getPortPriority())
        || ((frame->getPortPriority() == port->getPortPriority()) && (frame->getPortNum() < arrivalInterfaceId)))
    {
        // flushing arrival port
        macTable->removeForwardingInterface(arrivalInterfaceId);
        port->setRole(Ieee8021dInterfaceData::BACKUP);
        port->setState(Ieee8021dInterfaceData::DISCARDING);
        port->setLostBPDU(0);
        EV_DETAIL << "Setting port " << arrivalInterfaceId << "to backup" << endl;
    }
    else if (frame->getPortPriority() > port->getPortPriority()
             || (frame->getPortPriority() == port->getPortPriority() && frame->getPortNum() > arrivalInterfaceId))
    {
        auto port2 = getPortInterfaceDataForUpdate(frame->getPortNum());
        // flushing sender port
        macTable->removeForwardingInterface(frame->getPortNum()); // portNum is sender port number, it is not arrival port
        port2->setRole(Ieee8021dInterfaceData::BACKUP);
        port2->setState(Ieee8021dInterfaceData::DISCARDING);
        port2->setLostBPDU(0);
        EV_DETAIL << "Setting port " << frame->getPortNum() << "to backup" << endl;
    }
    else {
        auto port2 = getPortInterfaceDataForUpdate(frame->getPortNum());
        // unavoidable loop, received its own message at the same port
        // switch to disabled
        EV_DETAIL << "Unavoidable loop. Received its own message at the same port. Setting port " << frame->getPortNum() << " to disabled." << endl;
        // flushing that port
        macTable->removeForwardingInterface(frame->getPortNum()); // portNum is sender port number, it is not arrival port
        port2->setRole(Ieee8021dInterfaceData::DISABLED);
        port2->setState(Ieee8021dInterfaceData::DISCARDING);
    }
}

Referenced by handleIncomingFrame().

handleHelloTime()

void inet::Rstp::handleHelloTime ( cMessage *  msg )

protectedvirtual

HelloTime event handling.

{
    EV_DETAIL << "Hello time." << endl;
    for (unsigned int i = 0; i < numPorts; i++) {
        // sends hello through all active (learning, forwarding or not assigned) ports
        // increments LostBPDU just from ROOT, ALTERNATE and BACKUP
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        auto iPort = getPortInterfaceDataForUpdate(interfaceId);
        if (!iPort->isEdge()
            && (iPort->getRole() == Ieee8021dInterfaceData::ROOT
                || iPort->getRole() == Ieee8021dInterfaceData::ALTERNATE
                || iPort->getRole() == Ieee8021dInterfaceData::BACKUP))
        {
            iPort->setLostBPDU(iPort->getLostBPDU() + 1);
            if (iPort->getLostBPDU() > 3) { // 3 HelloTime without the best BPDU.
                EV_DETAIL << "3 HelloTime without the best BPDU" << endl;
                // starts contest
                if (iPort->getRole() == Ieee8021dInterfaceData::ROOT) {
                    // looking for the best ALTERNATE port
                    int candidate = getBestAlternate();
                    if (candidate != -1) {
                        // if an alternate gate has been found, switch to alternate
                        EV_DETAIL << "It was the root port. Alternate gate has been found. Setting port " << candidate << " to root. Setting current root port (port" << interfaceId << ") to designated." << endl;
                        // ALTERNATE->ROOT. DISCARDING->FORWARDING (immediately)
                        // old root gate goes to DESIGNATED and DISCARDING
                        // a new contest should be done to determine the new root path from this LAN
                        // updating root vector.
                        auto candidatePort = getPortInterfaceDataForUpdate(candidate);
                        iPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                        iPort->setState(Ieee8021dInterfaceData::DISCARDING); // if there is not a better BPDU, that will become FORWARDING
                        iPort->setNextUpgrade(simTime() + forwardDelay);
                        scheduleNextUpgrade();
                        initInterfacedata(interfaceId); // reset, then a new BPDU will be allowed to upgrade the best received info for this port
                        candidatePort->setRole(Ieee8021dInterfaceData::ROOT);
                        candidatePort->setState(Ieee8021dInterfaceData::FORWARDING);
                        candidatePort->setLostBPDU(0);
                        flushOtherPorts(candidate);
                        macTable->replaceForwardingInterface(interfaceId, candidate); // copy cache from old to new root
                    }
                    else {
                        // alternate not found, selects a new root
                        EV_DETAIL << "It was the root port. Alternate not found. Starts from beginning." << endl;
                        // initializing ports, start from the beginning
                        initPorts();
                    }
                }
                else if (iPort->getRole() == Ieee8021dInterfaceData::ALTERNATE
                         || iPort->getRole() == Ieee8021dInterfaceData::BACKUP)
                {
                    EV_DETAIL << "Setting port " << interfaceId << " to designated." << endl;
                    // it should take care of this LAN, switching to designated
                    iPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                    iPort->setState(Ieee8021dInterfaceData::DISCARDING); // a new content will start in case of another switch were in alternate
                    iPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                    // if there is no problem, this will become forwarding in a few seconds
                    initInterfacedata(interfaceId);
                }
                iPort->setLostBPDU(0); // reseting lost bpdu counter after a change.
            }
        }
    }
    sendBPDUs(); // generating and sending new BPDUs
    sendTCNtoRoot();
    scheduleAfter(helloTime, msg); // programming next hello time
}

Referenced by handleMessageWhenUp().

handleIncomingFrame()

void inet::Rstp::handleIncomingFrame ( Packet *  packet )

protectedvirtual

BPDU processing.

Updates port information. Handles port role changes.

{
    const auto& frame = packet->peekAtFront<BpduCfg>();
    // incoming BPDU handling
    // checking message age
    int arrivalInterfaceId = packet->getTag<InterfaceInd>()->getInterfaceId();
    MacAddress src = packet->getTag<MacAddressInd>()->getSrcAddress();
    EV_INFO << "BPDU received at port " << arrivalInterfaceId << "." << endl;
    if (frame->getMessageAge() < maxAge) {
        // checking TC
        checkTC(frame, arrivalInterfaceId); // sets TCWhile if arrival port was FORWARDING
        // checking possible backup
        if (src.compareTo(bridgeAddress) == 0) // more than one port in the same LAN
            handleBackup(frame, arrivalInterfaceId);
        else
            processBPDU(frame, arrivalInterfaceId);
    }
    else
        EV_DETAIL << "Expired BPDU" << endl;
    delete packet;
}

Referenced by handleMessageWhenUp().

handleMessageWhenUp()

void inet::Rstp::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

General processing.

Implements inet::OperationalMixin< cSimpleModule >.

{
    // it can receive BPDU or self messages
    if (msg->isSelfMessage()) {
        switch (msg->getKind()) {
            case SELF_HELLOTIME:
                handleHelloTime(msg);
                break;
 
            case SELF_UPGRADE:
                // designated ports state upgrading (discarding-->learning, learning-->forwarding)
                handleUpgrade(msg);
                break;
 
            default:
                throw cRuntimeError("Unknown self message");
                break;
        }
    }
    else {
        handleIncomingFrame(check_and_cast<Packet *>(msg)); // handling BPDU
    }
}

handleUpgrade()

void inet::Rstp::handleUpgrade ( cMessage *  msg )

protectedvirtual

Upgrade event handling.

{
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        auto iPort = getPortInterfaceDataForUpdate(interfaceId);
        if (getPortNetworkInterface(interfaceId)->hasCarrier() && iPort->getNextUpgrade() == simTime()) {
            if (iPort->getRole() == Ieee8021dInterfaceData::NOTASSIGNED) {
                EV_DETAIL << "MigrateTime. Setting port " << interfaceId << "to designated." << endl;
                iPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                iPort->setState(Ieee8021dInterfaceData::DISCARDING); // contest to become forwarding.
                iPort->setNextUpgrade(simTime() + forwardDelay);
            }
            else if (iPort->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
                if (iPort->getState() == Ieee8021dInterfaceData::DISCARDING) {
                    EV_INFO << "UpgradeTime. Setting port " << interfaceId << " state to learning." << endl;
                    iPort->setState(Ieee8021dInterfaceData::LEARNING);
                    iPort->setNextUpgrade(simTime() + forwardDelay);
                }
                else if (iPort->getState() == Ieee8021dInterfaceData::LEARNING) {
                    EV_INFO << "UpgradeTime. Setting port " << interfaceId << " state to forwarding." << endl;
                    iPort->setState(Ieee8021dInterfaceData::FORWARDING);
                    flushOtherPorts(interfaceId);
                }
            }
        }
    }
    scheduleNextUpgrade();
}

Referenced by handleMessageWhenUp().

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::StpBase.

{
    StpBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        autoEdge = par("autoEdge");
        tcWhileTime = par("tcWhileTime");
        migrateTime = par("migrateTime");
        helloTimer = new cMessage("itshellotime", SELF_HELLOTIME);
        upgradeTimer = new cMessage("upgrade", SELF_UPGRADE);
    }
    else if (stage == INITSTAGE_LINK_LAYER) {
        registerProtocol(Protocol::stp, gate("relayOut"), gate("relayIn"));
 
        for (int i = 0; i < ifTable->getNumInterfaces(); i++) {
            auto ie = ifTable->getInterface(i);
            if (!ie->isLoopback() && ie->isWired() /* && ie->getProtocol() == &Protocol::ethernetMac */) {   // TODO check protocol
                ie->addMulticastMacAddress(MacAddress::STP_MULTICAST_ADDRESS);
            }
        }
    }
}

initInterfacedata()

void inet::Rstp::initInterfacedata ( unsigned int  portNum )

protectedvirtual

{
    auto ifd = getPortInterfaceDataForUpdate(interfaceId);
    ifd->setRootPriority(bridgePriority);
    ifd->setRootAddress(bridgeAddress);
    ifd->setRootPathCost(0);
    ifd->setAge(0);
    ifd->setBridgePriority(bridgePriority);
    ifd->setBridgeAddress(bridgeAddress);
    ifd->setPortPriority(-1);
    ifd->setPortNum(-1);
    ifd->setLostBPDU(0);
}

Referenced by handleHelloTime(), initPorts(), and processBetterSource().

initPorts()

void inet::Rstp::initPorts ( )

protectedvirtual

initialize RSTP dynamic information

{
    for (unsigned int j = 0; j < numPorts; j++) {
        int interfaceId = ifTable->getInterface(j)->getInterfaceId();
        auto jPort = getPortInterfaceDataForUpdate(interfaceId);
        if (!jPort->isEdge()) {
            jPort->setRole(Ieee8021dInterfaceData::NOTASSIGNED);
            jPort->setState(Ieee8021dInterfaceData::DISCARDING);
            jPort->setNextUpgrade(simTime() + migrateTime);
        }
        else {
            jPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
            jPort->setState(Ieee8021dInterfaceData::FORWARDING);
        }
        initInterfacedata(interfaceId);
        macTable->removeForwardingInterface(interfaceId);
    }
    scheduleNextUpgrade();
}

Referenced by handleHelloTime(), processSameSource(), and start().

numInitStages()

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

inlineoverridevirtual

Reimplemented from inet::StpBase.

{ return NUM_INIT_STAGES; }

printState()

void inet::Rstp::printState ( )

protectedvirtual

Prints current data base info.

{
    // prints current database info
    EV_DETAIL << "Switch " << findContainingNode(this)->getFullName() << " state:" << endl;
    int rootIndex = getRootInterfaceId();
    EV_DETAIL << "  Priority: " << bridgePriority << endl;
    EV_DETAIL << "  Local MAC: " << bridgeAddress << endl;
    if (rootIndex >= 0) {
        const Ieee8021dInterfaceData *rootPort = getPortInterfaceData(rootIndex);
        EV_DETAIL << "  Root Priority: " << rootPort->getRootPriority() << endl;
        EV_DETAIL << "  Root Address: " << rootPort->getRootAddress().str() << endl;
        EV_DETAIL << "  Cost: " << rootPort->getRootPathCost() << endl;
        EV_DETAIL << "  Age:  " << rootPort->getAge() << endl;
        EV_DETAIL << "  Bridge Priority: " << rootPort->getBridgePriority() << endl;
        EV_DETAIL << "  Bridge Address: " << rootPort->getBridgeAddress().str() << endl;
        EV_DETAIL << "  Src TxGate Priority: " << rootPort->getPortPriority() << endl;
        EV_DETAIL << "  Src TxGate: " << rootPort->getPortNum() << endl;
    }
    EV_DETAIL << "Port State/Role:" << endl;
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        const Ieee8021dInterfaceData *iPort = getPortInterfaceData(interfaceId);
        EV_DETAIL << "  " << i << ": " << iPort->getStateName() << "/" << iPort->getRoleName() << (iPort->isEdge() ? " (Client)" : "") << endl;
    }
    EV_DETAIL << "Per-port best sources, Root/Src:" << endl;
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        const Ieee8021dInterfaceData *iPort = getPortInterfaceData(interfaceId);
        EV_DETAIL << "  " << interfaceId << ": " << iPort->getRootAddress().str() << "/" << iPort->getBridgeAddress().str() << endl;
    }
    EV_DETAIL << endl;
}

processBetterSource()

bool inet::Rstp::processBetterSource ( const Ptr< const BpduCfg > &  frame, unsigned int  arrivalInterfaceId  )

protectedvirtual

{
    EV_DETAIL << "Better BPDU received than the current best for this port." << endl;
    // update that port rstp info
    updateInterfacedata(frame, arrivalInterfaceId);
    auto arrivalPort = getPortInterfaceDataForUpdate(arrivalInterfaceId);
    int r = getRootInterfaceId();
    if (r == -1) {
        EV_DETAIL << "There was no root. Setting the arrival port to root." << endl;
        // there was no root
        arrivalPort->setRole(Ieee8021dInterfaceData::ROOT);
        arrivalPort->setState(Ieee8021dInterfaceData::FORWARDING);
        arrivalPort->setLostBPDU(0);
        flushOtherPorts(arrivalInterfaceId);
        return true;
    }
    else {
        auto rootPort = getPortInterfaceDataForUpdate(r);
        // there was a Root -> challenge 2 (compare with the root)
        int case2 = compareInterfacedata(r, frame, arrivalPort->getLinkCost()); // comparing with root port's BPDU
        int case3 = 0;
 
        switch (case2) {
            case SIMILAR: // double link to the same port of the root source -> Tie breaking (better local port first)
                EV_DETAIL << "Double link to the same port of the root source." << endl;
                if (rootPort->getPortPriority() < arrivalPort->getPortPriority()
                    || (rootPort->getPortPriority() == arrivalPort->getPortPriority() && (unsigned int)r < arrivalInterfaceId))
                {
                    // flushing that port
                    EV_DETAIL << "The current root has better local port. Setting the arrival port to alternate." << endl;
                    macTable->removeForwardingInterface(arrivalInterfaceId);
                    arrivalPort->setRole(Ieee8021dInterfaceData::ALTERNATE);
                    arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    arrivalPort->setLostBPDU(0);
                }
                else {
                    if (arrivalPort->getState() != Ieee8021dInterfaceData::FORWARDING)
                        flushOtherPorts(arrivalInterfaceId);
                    else
                        macTable->removeForwardingInterface(r); // flushing r, needed in case arrival were previously FORWARDING
                    EV_DETAIL << "This has better local port. Setting the arrival port to root. Setting current root port (port " << r << ") to alternate." << endl;
                    rootPort->setRole(Ieee8021dInterfaceData::ALTERNATE);
                    rootPort->setState(Ieee8021dInterfaceData::DISCARDING); // comes from root, preserve lostBPDU
                    arrivalPort->setRole(Ieee8021dInterfaceData::ROOT);
                    arrivalPort->setState(Ieee8021dInterfaceData::FORWARDING);
                    arrivalPort->setLostBPDU(0);
                    macTable->replaceForwardingInterface(r, arrivalInterfaceId); // copy cache from old to new root
                    // the change does not deserve flooding
                }
                break;
 
            case BETTER_ROOT: // new port rstp info is better than the root in another gate -> root change
                EV_DETAIL << "Better root received than the current root. Setting the arrival port to root." << endl;
                for (unsigned int i = 0; i < numPorts; i++) {
                    int interfaceId = ifTable->getInterface(i)->getInterfaceId();
                    auto iPort = getPortInterfaceDataForUpdate(interfaceId);
                    if (!iPort->isEdge()) { // avoiding clients reseting
                        if (arrivalPort->getState() != Ieee8021dInterfaceData::FORWARDING)
                            iPort->setTCWhile(simTime() + tcWhileTime);
                        macTable->removeForwardingInterface(interfaceId);
                        if ((unsigned int)interfaceId != arrivalInterfaceId) {
                            iPort->setRole(Ieee8021dInterfaceData::NOTASSIGNED);
                            iPort->setState(Ieee8021dInterfaceData::DISCARDING);
                            iPort->setNextUpgrade(simTime() + migrateTime);
                            scheduleNextUpgrade();
                            initInterfacedata(interfaceId);
                        }
                    }
                }
                arrivalPort->setRole(Ieee8021dInterfaceData::ROOT);
                arrivalPort->setState(Ieee8021dInterfaceData::FORWARDING);
                arrivalPort->setLostBPDU(0);
 
                return true;
 
            case BETTER_RPC: // same that Root but better RPC
            case BETTER_SRC: // same that Root RPC but better source
            case BETTER_PORT: // same that root RPC and source but better port
                if (arrivalPort->getState() != Ieee8021dInterfaceData::FORWARDING) {
                    EV_DETAIL << "Better route to the current root. Setting the arrival port to root." << endl;
                    flushOtherPorts(arrivalInterfaceId);
                }
                arrivalPort->setRole(Ieee8021dInterfaceData::ROOT);
                arrivalPort->setState(Ieee8021dInterfaceData::FORWARDING);
                arrivalPort->setLostBPDU(0);
                rootPort->setRole(Ieee8021dInterfaceData::ALTERNATE); // temporary, just one port can be root at contest time
                macTable->replaceForwardingInterface(r, arrivalInterfaceId); // copy cache from old to new root
                case3 = contestInterfacedata(r);
                if (case3 >= 0) {
                    EV_DETAIL << "Setting current root port (port " << r << ") to alternate." << endl;
                    rootPort->setRole(Ieee8021dInterfaceData::ALTERNATE);
                    rootPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    // not lostBPDU reset
                    // flushing r
                    macTable->removeForwardingInterface(r);
                }
                else {
                    EV_DETAIL << "Setting current root port (port " << r << ") to designated." << endl;
                    rootPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                    rootPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    rootPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                }
                return true;
 
            case WORSE_ROOT:
                EV_DETAIL << "Worse BPDU received than the current root. Sending BPDU to show him a better root as soon as possible." << endl;
                sendBPDU(arrivalInterfaceId); // BPDU to show him a better root as soon as possible
                break;
 
            case WORSE_RPC: // same Root but worse RPC
            case WORSE_SRC: // same Root RPC but worse source
            case WORSE_PORT: // same Root RPC and source but worse port
                case3 = contestInterfacedata(frame, arrivalInterfaceId); // case 0 not possible
                if (case3 < 0) {
                    EV_DETAIL << "Worse route to the current root. Setting the arrival port to designated." << endl;
                    arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                    arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    arrivalPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                    sendBPDU(arrivalInterfaceId); // BPDU to show him a better root as soon as possible
                }
                else {
                    EV_DETAIL << "Worse route to the current root. Setting the arrival port to alternate." << endl;
                    // flush arrival
                    macTable->removeForwardingInterface(arrivalInterfaceId);
                    arrivalPort->setRole(Ieee8021dInterfaceData::ALTERNATE);
                    arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    arrivalPort->setLostBPDU(0);
                }
                break;
        }
    }
    return false;
}

Referenced by processBPDU().

processBPDU()

void inet::Rstp::processBPDU ( const Ptr< const BpduCfg > &  frame, unsigned int  arrivalInterfaceId  )

protectedvirtual

{
    // three challenges.
    //
    // first:  vs best received BPDU for that port --------->case
    // second: vs root BPDU--------------------------------->case1
    // third:  vs BPDU that would be sent from this Bridge.->case2
    const Ieee8021dInterfaceData *arrivalPort = getPortInterfaceData(arrivalInterfaceId);
    bool flood = false;
    if (compareInterfacedata(arrivalInterfaceId, frame, arrivalPort->getLinkCost()) > 0 // better root
        && frame->getRootAddress().compareTo(bridgeAddress) != 0) // root will not participate in a loop with its own address
        flood = processBetterSource(frame, arrivalInterfaceId);
    else if (frame->getBridgeAddress().compareTo(arrivalPort->getBridgeAddress()) == 0 // worse or similar, but the same source
             && frame->getRootAddress().compareTo(bridgeAddress) != 0) // root will not participate
        flood = processSameSource(frame, arrivalInterfaceId);
    if (flood) {
        sendBPDUs(); // expedited BPDU
        sendTCNtoRoot();
    }
}

Referenced by handleIncomingFrame().

processSameSource()

bool inet::Rstp::processSameSource ( const Ptr< const BpduCfg > &  frame, unsigned int  arrivalInterfaceId  )

protectedvirtual

{
    EV_DETAIL << "BPDU received from the same source than the current best for this port" << endl;
    auto arrivalPort = getPortInterfaceDataForUpdate(arrivalInterfaceId);
    int case0 = compareInterfacedata(arrivalInterfaceId, frame, arrivalPort->getLinkCost());
    // source has updated BPDU information
    switch (case0) {
        case SIMILAR:
            arrivalPort->setLostBPDU(0); // same BPDU, not updated
            break;
 
        case WORSE_ROOT:
            EV_DETAIL << "Worse root received than the current best for this port." << endl;
            if (arrivalPort->getRole() == Ieee8021dInterfaceData::ROOT) {
                int alternative = getBestAlternate(); // searching for alternate
                if (alternative >= 0) {
                    EV_DETAIL << "This port was the root, but there is a better alternative. Setting the arrival port to designated and port " << alternative << "to root." << endl;
                    auto alternativePort = getPortInterfaceDataForUpdate(alternative);
                    arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                    arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    arrivalPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                    macTable->replaceForwardingInterface(arrivalInterfaceId, alternative); // copy cache from old to new root
                    flushOtherPorts(alternative);
                    alternativePort->setRole(Ieee8021dInterfaceData::ROOT);
                    alternativePort->setState(Ieee8021dInterfaceData::FORWARDING); // comes from alternate, preserves lostBPDU
                    updateInterfacedata(frame, arrivalInterfaceId);
                    sendBPDU(arrivalInterfaceId); // show him a better Root as soon as possible
                }
                else {
                    EV_DETAIL << "This port was the root and there no alternative. Initialize all ports" << endl;
                    int case2 = 0;
                    initPorts(); // allowing other ports to contest again
                    // flushing all ports
                    for (unsigned int j = 0; j < numPorts; j++) {
                        int interfaceId = ifTable->getInterface(j)->getInterfaceId();
                        macTable->removeForwardingInterface(interfaceId);
                    }
                    case2 = compareInterfacedata(arrivalInterfaceId, frame, arrivalPort->getLinkCost());
                    if (case2 > 0) {
                        EV_DETAIL << "This switch is not better, keep arrival port as a ROOT" << endl;
                        updateInterfacedata(frame, arrivalInterfaceId); // if this module is not better, keep it as a ROOT
                        arrivalPort->setRole(Ieee8021dInterfaceData::ROOT);
                        arrivalPort->setState(Ieee8021dInterfaceData::FORWARDING);
                    }
                    // propagating new information
                    return true;
                }
            }
            else if (arrivalPort->getRole() == Ieee8021dInterfaceData::ALTERNATE) {
                EV_DETAIL << "This port was an alternate, setting to designated" << endl;
                arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                arrivalPort->setNextUpgrade(simTime() + forwardDelay);
                scheduleNextUpgrade();
                updateInterfacedata(frame, arrivalInterfaceId);
                sendBPDU(arrivalInterfaceId); // Show him a better Root as soon as possible
            }
            break;
 
        case WORSE_RPC:
        case WORSE_SRC:
        case WORSE_PORT:
            EV_DETAIL << "Worse route to the current root than the current best for this port." << endl;
            if (arrivalPort->getRole() == Ieee8021dInterfaceData::ROOT) {
                arrivalPort->setLostBPDU(0);
                int alternative = getBestAlternate(); // searching for alternate
                if (alternative >= 0) {
                    auto alternativePort = getPortInterfaceDataForUpdate(alternative);
                    int case2 = 0;
                    case2 = compareInterfacedata(alternative, frame, arrivalPort->getLinkCost());
                    if (case2 < 0) { // if alternate is better, change
                        alternativePort->setRole(Ieee8021dInterfaceData::ROOT);
                        alternativePort->setState(Ieee8021dInterfaceData::FORWARDING);
                        arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED); // temporary, just one port can be root at contest time
                        int case3 = 0;
                        case3 = contestInterfacedata(frame, arrivalInterfaceId);
                        if (case3 < 0) {
                            EV_DETAIL << "This port was the root, but there is a better alternative. Setting the arrival port to designated and port " << alternative << "to root." << endl;
                            arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED);
                            arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                            arrivalPort->setNextUpgrade(simTime() + forwardDelay);
                            scheduleNextUpgrade();
                        }
                        else {
                            EV_DETAIL << "This port was the root, but there is a better alternative. Setting the arrival port to alternate and port " << alternative << "to root." << endl;
                            arrivalPort->setRole(Ieee8021dInterfaceData::ALTERNATE);
                            arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                        }
                        flushOtherPorts(alternative);
                        macTable->replaceForwardingInterface(arrivalInterfaceId, alternative); // copy cache from old to new root
                    }
                }
                updateInterfacedata(frame, arrivalInterfaceId);
                // propagating new information
                return true;
                // if alternate is worse than root, or there is not alternate, keep old root as root
            }
            else if (arrivalPort->getRole() == Ieee8021dInterfaceData::ALTERNATE) {
                int case2 = 0;
                case2 = contestInterfacedata(frame, arrivalInterfaceId);
                if (case2 < 0) {
                    EV_DETAIL << "This port was an alternate, setting to designated" << endl;
                    arrivalPort->setRole(Ieee8021dInterfaceData::DESIGNATED); // if the frame is worse than this module generated frame, switch to Designated/Discarding
                    arrivalPort->setState(Ieee8021dInterfaceData::DISCARDING);
                    arrivalPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                    sendBPDU(arrivalInterfaceId); // show him a better BPDU as soon as possible
                }
                else {
                    arrivalPort->setLostBPDU(0); // if it is better than this module generated frame, keep it as alternate
                    // this does not deserve expedited BPDU
                }
            }
            updateInterfacedata(frame, arrivalInterfaceId);
            break;
    }
    return false;
}

Referenced by processBPDU().

receiveSignal()

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

overridevirtual

Reimplemented from inet::StpBase.

{
    Enter_Method("%s", cComponent::getSignalName(signalID));
 
    if (signalID == interfaceStateChangedSignal) {
        NetworkInterface *changedIE = check_and_cast<const NetworkInterfaceChangeDetails *>(obj)->getNetworkInterface();
        for (unsigned int i = 0; i < numPorts; i++) {
            int interfaceId = ifTable->getInterface(i)->getInterfaceId();
            NetworkInterface *gateIfEntry = getPortNetworkInterface(interfaceId);
            if (gateIfEntry == changedIE) {
                if (gateIfEntry->hasCarrier()) {
                    auto iPort = getPortInterfaceDataForUpdate(interfaceId);
                    if (iPort->getRole() == Ieee8021dInterfaceData::NOTASSIGNED)
                        iPort->setNextUpgrade(simTime() + migrateTime);
                    else if (iPort->getRole() == Ieee8021dInterfaceData::DESIGNATED
                             && (iPort->getState() == Ieee8021dInterfaceData::DISCARDING || iPort->getState() == Ieee8021dInterfaceData::LEARNING))
                        iPort->setNextUpgrade(simTime() + forwardDelay);
                    scheduleNextUpgrade();
                }
            }
        }
    }
}

scheduleNextUpgrade()

void inet::Rstp::scheduleNextUpgrade ( )

protectedvirtual

schedule next upgrade self-message

{
    cancelEvent(upgradeTimer);
    const Ieee8021dInterfaceData *nextInterfaceData = nullptr;
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        if (getPortNetworkInterface(interfaceId)->hasCarrier()) {
            const Ieee8021dInterfaceData *iPort = getPortInterfaceData(interfaceId);
            if (iPort->getRole() == Ieee8021dInterfaceData::NOTASSIGNED) {
                if (nextInterfaceData == nullptr)
                    nextInterfaceData = iPort;
                else if (iPort->getNextUpgrade() < nextInterfaceData->getNextUpgrade())
                    nextInterfaceData = iPort;
            }
            else if (iPort->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
                if (iPort->getState() == Ieee8021dInterfaceData::DISCARDING) {
                    if (nextInterfaceData == nullptr)
                        nextInterfaceData = iPort;
                    else if (iPort->getNextUpgrade() < nextInterfaceData->getNextUpgrade())
                        nextInterfaceData = iPort;
                }
                else if (iPort->getState() == Ieee8021dInterfaceData::LEARNING) {
                    if (nextInterfaceData == nullptr)
                        nextInterfaceData = iPort;
                    else if (iPort->getNextUpgrade() < nextInterfaceData->getNextUpgrade())
                        nextInterfaceData = iPort;
                }
            }
        }
    }
    if (nextInterfaceData != nullptr)
        scheduleAt(nextInterfaceData->getNextUpgrade(), upgradeTimer);
}

Referenced by handleHelloTime(), handleUpgrade(), initPorts(), processBetterSource(), processSameSource(), and receiveSignal().

sendBPDU()

void inet::Rstp::sendBPDU ( int  interfaceId )

protectedvirtual

Sends BPDU through a port.

{
    // send a BPDU throuth port
    const Ieee8021dInterfaceData *iport = getPortInterfaceData(interfaceId);
    int r = getRootInterfaceId();
    const Ieee8021dInterfaceData *rootPort;
    if (r != -1)
        rootPort = getPortInterfaceData(r);
    if (iport->getRole() != Ieee8021dInterfaceData::DISABLED) {
        Packet *packet = new Packet("BPDU");
        const auto& frame = makeShared<BpduCfg>();
        if (r != -1) {
            frame->setRootPriority(rootPort->getRootPriority());
            frame->setRootAddress(rootPort->getRootAddress());
            frame->setMessageAge(rootPort->getAge());
            frame->setRootPathCost(rootPort->getRootPathCost());
        }
        else {
            frame->setRootPriority(bridgePriority);
            frame->setRootAddress(bridgeAddress);
            frame->setMessageAge(0);
            frame->setRootPathCost(0);
        }
        frame->setBridgePriority(bridgePriority);
        frame->setTcaFlag(false);
        frame->setPortNum(interfaceId);
        frame->setBridgeAddress(bridgeAddress);
        if (simTime() < iport->getTCWhile())
            frame->setTcFlag(true);
        else
            frame->setTcFlag(false);
        frame->setMaxAge(maxAge);
        frame->setHelloTime(helloTime);
        frame->setForwardDelay(forwardDelay);
 
        packet->insertAtBack(frame);
 
        auto macAddressReq = packet->addTag<MacAddressReq>();
        macAddressReq->setSrcAddress(bridgeAddress);
        macAddressReq->setDestAddress(MacAddress::STP_MULTICAST_ADDRESS);
        packet->addTag<InterfaceReq>()->setInterfaceId(interfaceId);
        packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::stp);
        packet->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
        send(packet, "relayOut");
    }
}

Referenced by processBetterSource(), processSameSource(), and sendBPDUs().

sendBPDUs()

void inet::Rstp::sendBPDUs ( )

protectedvirtual

Sends BPDUs through all ports, if they are required.

{
    // send BPDUs through all ports, if they are required
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        const Ieee8021dInterfaceData *iPort = getPortInterfaceData(interfaceId);
        if ((iPort->getRole() != Ieee8021dInterfaceData::ROOT)
            && (iPort->getRole() != Ieee8021dInterfaceData::ALTERNATE)
            && (iPort->getRole() != Ieee8021dInterfaceData::DISABLED) && (!iPort->isEdge()))
        {
            sendBPDU(interfaceId);
        }
    }
}

Referenced by handleHelloTime(), and processBPDU().

sendTCNtoRoot()

void inet::Rstp::sendTCNtoRoot ( )

protectedvirtual

If root TCWhile has not expired, sends a BPDU to the Root with TCFlag=true.

{
    // if TCWhile is not expired, sends BPDU with TC flag to the root
    this->bubble("SendTCNtoRoot");
    EV_DETAIL << "SendTCNtoRoot" << endl;
    int r = getRootInterfaceId();
    if (r >= 0) {
        const Ieee8021dInterfaceData *rootPort = getPortInterfaceData(r);
        if (rootPort->getRole() != Ieee8021dInterfaceData::DISABLED) {
            if (simTime() < rootPort->getTCWhile()) {
                Packet *packet = new Packet("BPDU");
                const auto& frame = makeShared<BpduCfg>();
                frame->setRootPriority(rootPort->getRootPriority());
                frame->setRootAddress(rootPort->getRootAddress());
                frame->setMessageAge(rootPort->getAge());
                frame->setRootPathCost(rootPort->getRootPathCost());
                frame->setBridgePriority(bridgePriority);
                frame->setTcaFlag(false);
                frame->setPortNum(r);
                frame->setBridgeAddress(bridgeAddress);
                frame->setTcFlag(true);
                frame->setMaxAge(maxAge);
                frame->setHelloTime(helloTime);
                frame->setForwardDelay(forwardDelay);
 
                packet->insertAtBack(frame);
 
                auto macAddressReq = packet->addTag<MacAddressReq>();
                macAddressReq->setSrcAddress(bridgeAddress);
                macAddressReq->setDestAddress(MacAddress::STP_MULTICAST_ADDRESS);
                packet->addTag<InterfaceReq>()->setInterfaceId(r);
 
                packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::stp);
                packet->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
                send(packet, "relayOut");
            }
        }
    }
}

Referenced by handleHelloTime(), and processBPDU().

start()

void inet::Rstp::start ( )

overrideprotectedvirtual

Reimplemented from inet::StpBase.

{
    StpBase::start();
    initPorts();
    scheduleAfter(SIMTIME_ZERO, helloTimer);
}

stop()

void inet::Rstp::stop ( )

overrideprotectedvirtual

Reimplemented from inet::StpBase.

{
    StpBase::stop();
    cancelEvent(helloTimer);
    cancelEvent(upgradeTimer);
}

updateInterfacedata()

void inet::Rstp::updateInterfacedata ( const Ptr< const BpduCfg > &  frame, unsigned int  interfaceId  )

protectedvirtual

Update Interfacedata with the content of the BPDU frame.

{
    auto ifd = getPortInterfaceDataForUpdate(portNum);
    ifd->setRootPriority(frame->getRootPriority());
    ifd->setRootAddress(frame->getRootAddress());
    ifd->setRootPathCost(frame->getRootPathCost() + ifd->getLinkCost());
    ifd->setAge(frame->getMessageAge() + 1);
    ifd->setBridgePriority(frame->getBridgePriority());
    ifd->setBridgeAddress(frame->getBridgeAddress());
    ifd->setPortPriority(frame->getPortPriority());
    ifd->setPortNum(frame->getPortNum());
    ifd->setLostBPDU(0);
}

Referenced by processBetterSource(), and processSameSource().

Member Data Documentation

autoEdge

bool inet::Rstp::autoEdge = false

protected

Referenced by initialize().

helloTimer

cMessage* inet::Rstp::helloTimer = nullptr

protected

Referenced by initialize(), start(), stop(), and ~Rstp().

migrateTime

simtime_t inet::Rstp::migrateTime

protected

Referenced by initialize(), initPorts(), processBetterSource(), and receiveSignal().

tcWhileTime

simtime_t inet::Rstp::tcWhileTime

protected

Referenced by checkTC(), flushOtherPorts(), initialize(), and processBetterSource().

upgradeTimer

cMessage* inet::Rstp::upgradeTimer = nullptr

protected

Referenced by initialize(), scheduleNextUpgrade(), stop(), and ~Rstp().

---

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

• Rstp.h
• Rstp.cc