inet::STP Class Reference

Implements the Spanning Tree Protocol. More...

#include <STP.h>

Inheritance diagram for inet::STP:

Public Types
enum	BDPUType { CONFIG_BDPU = 0, TCN_BPDU = 1 }
typedef Ieee8021dInterfaceData::PortInfo	PortInfo

Public Member Functions
	STP ()
virtual	~STP ()
void	handleBPDU (BPDU *bpdu)
virtual void	initInterfacedata (unsigned int portNum)
void	handleTCN (BPDU *tcn)
	Topology change handling. More...
virtual void	handleMessage (cMessage *msg) override
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
void	generateBPDU (int portNum, const MACAddress &address=MACAddress::STP_MULTICAST_ADDRESS, bool tcFlag=false, bool tcaFlag=false)
void	generateHelloBDPUs ()
void	generateTCN ()
int	comparePorts (Ieee8021dInterfaceData *portA, Ieee8021dInterfaceData *portB)
int	compareBridgeIDs (unsigned int, MACAddress, unsigned int, MACAddress)
int	comparePortIDs (unsigned int, unsigned int, unsigned int, unsigned int)
bool	isSuperiorBPDU (int portNum, BPDU *bpdu)
void	setSuperiorBPDU (int portNum, BPDU *bpdu)
void	handleTick ()
void	checkTimers ()
void	checkParametersChange ()
void	initPortTable ()
void	selectRootPort ()
void	selectDesignatedPorts ()
void	setAllDesignated ()
void	lostRoot ()
void	lostAlternate (int port)
void	reset ()
bool	checkRootEligibility ()
void	tryRoot ()
Public Member Functions inherited from inet::STPBase
	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 void	start () override
virtual void	stop () override
Protected Member Functions inherited from inet::STPBase
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	isRoot = false
unsigned int	rootPort = 0
std::vector< unsigned int >	desPorts
unsigned int	rootPathCost = 0
unsigned int	rootPriority = 0
MACAddress	rootAddress
simtime_t	currentMaxAge
simtime_t	currentFwdDelay
simtime_t	currentHelloTime
simtime_t	helloTime
unsigned int	currentBridgePriority = 0
bool	topologyChangeNotification = false
bool	topologyChangeRecvd = false
PortInfo	defaultPort
cMessage *	tick = nullptr
Protected Attributes inherited from inet::STPBase
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

Static Protected Attributes
static const double	tickInterval = 1

Friends
std::ostream &	operator<< (std::ostream &os, const Ieee8021dInterfaceData::PortRole r)
std::ostream &	operator<< (std::ostream &os, const Ieee8021dInterfaceData::PortState s)
std::ostream &	operator<< (std::ostream &os, Ieee8021dInterfaceData *p)
std::ostream &	operator<< (std::ostream &os, STP i)

Detailed Description

Implements the Spanning Tree Protocol.

See the NED file for details.

Member Typedef Documentation

typedef Ieee8021dInterfaceData::PortInfo inet::STP::PortInfo

Member Enumeration Documentation

enum inet::STP::BDPUType

Enumerator
CONFIG_BDPU
TCN_BPDU

{ CONFIG_BDPU = 0, TCN_BPDU = 1 };

Constructor & Destructor Documentation

inet::STP::STP

(

)

{
}

inet::STP::~STP ( )

virtual

{
    cancelAndDelete(tick);
}

Member Function Documentation

void inet::STP::checkParametersChange

(

)

Referenced by handleTick().

{
    if (isRoot) {
        currentHelloTime = helloTime;
        currentMaxAge = maxAge;
        currentFwdDelay = forwardDelay;
    }
    if (currentBridgePriority != bridgePriority) {
        currentBridgePriority = bridgePriority;
        reset();
    }
}

bool inet::STP::checkRootEligibility

(

)

Referenced by tryRoot().

{
    Ieee8021dInterfaceData *port;

    for (unsigned int i = 0; i < numPorts; i++) {
        port = getPortInterfaceData(i);

        if (compareBridgeIDs(port->getRootPriority(), port->getRootAddress(), bridgePriority, bridgeAddress) > 0)
            return false;
    }

    return true;
}

void inet::STP::checkTimers

(

)

Referenced by handleTick().

{
    Ieee8021dInterfaceData *port;

    // hello timer check
    if (helloTime >= currentHelloTime) {
        // only the root switch can generate Hello BPDUs
        if (isRoot)
            generateHelloBDPUs();

        helloTime = 0;
    }

    // information age check
    for (unsigned int i = 0; i < numPorts; i++) {
        port = getPortInterfaceData(i);

        if (port->getAge() >= currentMaxAge) {
            EV_DETAIL << "Port=" << i << " reached its maximum age. Setting it to the default port info." << endl;
            if (port->getRole() == Ieee8021dInterfaceData::ROOT) {
                initInterfacedata(i);
                lostRoot();
            }
            else {
                initInterfacedata(i);
                lostAlternate(i);
            }
        }
    }

    // fdWhile timer
    for (unsigned int i = 0; i < numPorts; i++) {
        port = getPortInterfaceData(i);

        // ROOT / DESIGNATED, can transition
        if (port->getRole() == Ieee8021dInterfaceData::ROOT || port->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
            if (port->getFdWhile() >= currentFwdDelay) {
                switch (port->getState()) {
                    case Ieee8021dInterfaceData::DISCARDING:
                        EV_DETAIL << "Port=" << i << " goes into learning state." << endl;
                        port->setState(Ieee8021dInterfaceData::LEARNING);
                        port->setFdWhile(0);
                        break;

                    case Ieee8021dInterfaceData::LEARNING:
                        EV_DETAIL << "Port=" << i << " goes into forwarding state." << endl;
                        port->setState(Ieee8021dInterfaceData::FORWARDING);
                        port->setFdWhile(0);
                        break;

                    default:
                        port->setFdWhile(0);
                        break;
                }
            }
        }
        else {
            EV_DETAIL << "Port=" << i << " goes into discarding state." << endl;
            port->setFdWhile(0);
            port->setState(Ieee8021dInterfaceData::DISCARDING);
        }
    }
}

int inet::STP::compareBridgeIDs	(	unsigned int	aPriority,
		MACAddress	aAddress,
		unsigned int	bPriority,
		MACAddress	bAddress
	)

Referenced by checkRootEligibility(), and comparePorts().

{
    if (aPriority < bPriority)
        return 1; // A is superior
    else if (aPriority > bPriority)
        return -1;

    // APR == BPR
    if (aAddress.compareTo(bAddress) == -1)
        return 1; // A is superior
    else if (aAddress.compareTo(bAddress) == 1)
        return -1;

    // A==B
    // (can happen if bridge have two port connected to one not bridged lan,
    // "cable loopback"
    return 0;
}

int inet::STP::comparePortIDs	(	unsigned int	aPriority,
		unsigned int	aNum,
		unsigned int	bPriority,
		unsigned int	bNum
	)

Referenced by comparePorts().

{
    if (aPriority < bPriority)
        return 1; // A is superior

    else if (aPriority > bPriority)
        return -1;

    // APR == BPR
    if (aNum < bNum)
        return 1; // A is superior

    else if (aNum > bNum)
        return -1;

    // A==B
    return 0;
}

int inet::STP::comparePorts	(	Ieee8021dInterfaceData *	portA,
		Ieee8021dInterfaceData *	portB
	)

Referenced by isSuperiorBPDU(), selectDesignatedPorts(), and selectRootPort().

{
    int result;

    result = compareBridgeIDs(portA->getRootPriority(), portA->getRootAddress(), portB->getRootPriority(),
                portB->getRootAddress());

    // not same, so pass result
    if (result != 0)
        return result;

    if (portA->getRootPathCost() < portB->getRootPathCost())
        return 1;

    if (portA->getRootPathCost() > portB->getRootPathCost())
        return -1;

    // designated bridge
    result = compareBridgeIDs(portA->getBridgePriority(), portA->getBridgeAddress(), portB->getBridgePriority(),
                portB->getBridgeAddress());

    // not same, so pass result
    if (result != 0)
        return result;

    // designated port of designated Bridge
    result = comparePortIDs(portA->getPortPriority(), portA->getPortNum(), portB->getPortPriority(), portB->getPortNum());

    // not same, so pass result
    if (result != 0)
        return result;

    return 0;    // same
}

void inet::STP::generateBPDU	(	int	portNum,
		const MACAddress &	address = MACAddress::STP_MULTICAST_ADDRESS,
		bool	tcFlag = false,
		bool	tcaFlag = false
	)

Referenced by generateHelloBDPUs(), handleBPDU(), and handleTCN().

{
    BPDU *bpdu = new BPDU();
    Ieee802Ctrl *controlInfo = new Ieee802Ctrl();
    controlInfo->setDest(address);
    controlInfo->setSwitchPort(port);

    bpdu->setName("BPDU");
    bpdu->setProtocolIdentifier(0);
    bpdu->setProtocolVersionIdentifier(0);
    bpdu->setBpduType(0);    // 0 if configuration BPDU

    bpdu->setBridgeAddress(bridgeAddress);
    bpdu->setBridgePriority(bridgePriority);
    bpdu->setRootPathCost(rootPathCost);
    bpdu->setRootAddress(rootAddress);
    bpdu->setRootPriority(rootPriority);
    bpdu->setPortNum(port);
    bpdu->setPortPriority(getPortInterfaceData(port)->getPriority());
    bpdu->setMessageAge(0);
    bpdu->setMaxAge(currentMaxAge);
    bpdu->setHelloTime(currentHelloTime);
    bpdu->setForwardDelay(currentFwdDelay);

    if (topologyChangeNotification) {
        if (isRoot || tcFlag) {
            bpdu->setTcFlag(true);
            bpdu->setTcaFlag(false);
        }
        else if (tcaFlag) {
            bpdu->setTcFlag(false);
            bpdu->setTcaFlag(true);
        }
    }

    bpdu->setControlInfo(controlInfo);

    send(bpdu, "relayOut");
}

void inet::STP::generateHelloBDPUs

(

)

Referenced by checkTimers().

{
    EV_INFO << "It is hello time. Root switch sending hello BDPUs on all its ports." << endl;

    // send hello BDPUs on all ports
    for (unsigned int i = 0; i < numPorts; i++)
        generateBPDU(i);
}

void inet::STP::generateTCN

(

)

Referenced by handleTick().

{
    // there is something to notify
    if (topologyChangeNotification || !topologyChangeRecvd) {
        if (getPortInterfaceData(rootPort)->getRole() == Ieee8021dInterfaceData::ROOT) {
            // exist root port to notifying
            topologyChangeNotification = false;
            BPDU *tcn = new BPDU();
            tcn->setProtocolIdentifier(0);
            tcn->setProtocolVersionIdentifier(0);
            tcn->setName("BPDU");

            // 1 if Topology Change Notification BPDU
            tcn->setBpduType(1);

            Ieee802Ctrl *controlInfo = new Ieee802Ctrl();
            controlInfo->setDest(MACAddress::STP_MULTICAST_ADDRESS);
            controlInfo->setSwitchPort(rootPort);
            tcn->setControlInfo(controlInfo);

            EV_INFO << "The topology has changed. Sending Topology Change Notification BPDU " << tcn << " to the Root Switch." << endl;
            send(tcn, "relayOut");
        }
    }
}

void inet::STP::handleBPDU

(

BPDU *

bpdu

)

Referenced by handleMessage().

{
    Ieee802Ctrl *controlInfo = check_and_cast<Ieee802Ctrl *>(bpdu->getControlInfo());
    int arrivalGate = controlInfo->getSwitchPort();
    Ieee8021dInterfaceData *port = getPortInterfaceData(arrivalGate);

    if (bpdu->getTcaFlag()) {
        topologyChangeRecvd = true;
        topologyChangeNotification = false;
    }

    // get inferior BPDU, reply with superior
    if (!isSuperiorBPDU(arrivalGate, bpdu)) {
        if (port->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
            EV_DETAIL << "Inferior Configuration BPDU " << bpdu << " arrived on port=" << arrivalGate << " responding to it with a superior BPDU." << endl;
            generateBPDU(arrivalGate);
        }
    }
    // BPDU from root
    else if (port->getRole() == Ieee8021dInterfaceData::ROOT) {
        EV_INFO << "Configuration BPDU " << bpdu << " arrived from Root Switch." << endl;

        if (bpdu->getTcFlag()) {
            EV_DEBUG << "MACAddressTable aging time set to " << currentFwdDelay << "." << endl;
            macTable->setAgingTime(currentFwdDelay);

            // config BPDU with TC flag
            for (auto & elem : desPorts)
                generateBPDU(elem, MACAddress::STP_MULTICAST_ADDRESS, true, false);
        }
        else {
            macTable->resetDefaultAging();

            EV_INFO << "Sending BPDUs on all designated ports." << endl;

            // BPDUs are sent on all designated ports
            for (auto & elem : desPorts)
                generateBPDU(elem);
        }
    }

    tryRoot();
    delete bpdu;
}

void inet::STP::handleMessage ( cMessage *  msg )

overridevirtual

{
    if (!isOperational) {
        EV << "Message '" << msg << "' arrived when module status is down, dropped it\n";
        delete msg;
        return;
    }

    cMessage *tmp = msg;

    if (!msg->isSelfMessage()) {
        if (dynamic_cast<BPDU *>(tmp)) {
            BPDU *bpdu = (BPDU *)tmp;

            if (bpdu->getBpduType() == CONFIG_BDPU)
                handleBPDU(bpdu);
            else if (bpdu->getBpduType() == TCN_BPDU)
                handleTCN(bpdu);
        }
        else
            throw cRuntimeError("Non-BPDU packet received");
    }
    else {
        if (msg == tick) {
            handleTick();
            scheduleAt(simTime() + 1, tick);
        }
        else
            throw cRuntimeError("Unknown self-message received");
    }
}

void inet::STP::handleTCN

(

BPDU *

tcn

)

Topology change handling.

Referenced by handleMessage().

{
    EV_INFO << "Topology Change Notification BDPU " << tcn << " arrived." << endl;
    topologyChangeNotification = true;

    Ieee802Ctrl *controlInfo = check_and_cast<Ieee802Ctrl *>(tcn->getControlInfo());
    int arrivalGate = controlInfo->getSwitchPort();
    MACAddress address = controlInfo->getSrc();

    // send ACK to the sender
    EV_INFO << "Sending Topology Change Notification ACK." << endl;
    generateBPDU(arrivalGate, address, false, true);

    controlInfo->setSwitchPort(rootPort);    // send TCN to the Root Switch

    if (!isRoot)
        send(tcn, "relayOut");
    else
        delete tcn;
}

void inet::STP::handleTick

(

)

Referenced by handleMessage().

{
    // hello BDPU timer
    if (isRoot)
        helloTime = helloTime + 1;
    else
        helloTime = 0;

    for (unsigned int i = 0; i < numPorts; i++) {
        Ieee8021dInterfaceData *port = getPortInterfaceData(i);

        // disabled ports don't count
        if (port->getRole() == Ieee8021dInterfaceData::DISABLED)
            continue;

        // increment the MessageAge and FdWhile timers
        if (port->getRole() != Ieee8021dInterfaceData::DESIGNATED) {
            EV_DEBUG << "Message Age timer incremented on port=" << i << endl;
            port->setAge(port->getAge() + tickInterval);
        }
        if (port->getRole() == Ieee8021dInterfaceData::ROOT || port->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
            EV_DEBUG << "Forward While timer incremented on port=" << i << endl;
            port->setFdWhile(port->getFdWhile() + tickInterval);
        }
    }
    checkTimers();
    checkParametersChange();
    generateTCN();
}

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

overridevirtual

Reimplemented from inet::STPBase.

{
    STPBase::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        tick = new cMessage("STP_TICK", 0);
        WATCH(bridgeAddress);
    }
}

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

virtual

Referenced by checkTimers(), and initPortTable().

{
    Ieee8021dInterfaceData *ifd = getPortInterfaceData(portNum);
    ifd->setRole(Ieee8021dInterfaceData::NOTASSIGNED);
    ifd->setState(Ieee8021dInterfaceData::DISCARDING);
    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);
}

void inet::STP::initPortTable

(

)

Referenced by start().

{
    EV_DEBUG << "IEE8021D Interface Data initialization. Setting port infos to the protocol defaults." << endl;
    for (unsigned int i = 0; i < numPorts; i++) {
        initInterfacedata(i);
    }
}

bool inet::STP::isSuperiorBPDU	(	int	portNum,
		BPDU *	bpdu
	)

Referenced by handleBPDU().

{
    Ieee8021dInterfaceData *port = getPortInterfaceData(portNum);
    Ieee8021dInterfaceData *xBpdu = new Ieee8021dInterfaceData();

    int result;

    xBpdu->setRootPriority(bpdu->getRootPriority());
    xBpdu->setRootAddress(bpdu->getRootAddress());
    xBpdu->setRootPathCost(bpdu->getRootPathCost() + port->getLinkCost());
    xBpdu->setBridgePriority(bpdu->getBridgePriority());
    xBpdu->setBridgeAddress(bpdu->getBridgeAddress());
    xBpdu->setPortPriority(bpdu->getPortPriority());
    xBpdu->setPortNum(bpdu->getPortNum());

    result = comparePorts(port, xBpdu);

    // port is superior
    if (result > 0) {
        delete xBpdu;
        return false;
    }

    if (result < 0) {
        // BPDU is superior
        port->setFdWhile(0);    // renew info
        port->setState(Ieee8021dInterfaceData::DISCARDING);
        setSuperiorBPDU(portNum, bpdu);    // renew information
        delete xBpdu;
        return true;
    }

    setSuperiorBPDU(portNum, bpdu);    // renew information
    delete xBpdu;
    return true;
}

void inet::STP::lostAlternate

(

int

port

)

Referenced by checkTimers().

{
    selectDesignatedPorts();
    topologyChangeNotification = true;
}

void inet::STP::lostRoot

(

)

Referenced by checkTimers().

{
    topologyChangeNotification = true;
    tryRoot();
}

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

inlineoverridevirtual

Reimplemented from inet::STPBase.

{ return NUM_INIT_STAGES; }

void inet::STP::reset

(

)

Referenced by checkParametersChange().

{
    // upon booting all switches believe themselves to be the root
    isRoot = true;
    rootPriority = bridgePriority;
    rootAddress = bridgeAddress;
    rootPathCost = 0;
    currentHelloTime = helloTime;
    currentMaxAge = maxAge;
    currentFwdDelay = forwardDelay;
    setAllDesignated();
}

void inet::STP::selectDesignatedPorts

(

)

Referenced by lostAlternate(), and tryRoot().

{
    // select designated ports
    desPorts.clear();
    Ieee8021dInterfaceData *port;
    Ieee8021dInterfaceData *bridgeGlobal = new Ieee8021dInterfaceData();
    int result;

    bridgeGlobal->setBridgePriority(bridgePriority);
    bridgeGlobal->setBridgeAddress(bridgeAddress);
    bridgeGlobal->setRootAddress(rootAddress);
    bridgeGlobal->setRootPriority(rootPriority);

    for (unsigned int i = 0; i < numPorts; i++) {
        port = getPortInterfaceData(i);

        if (port->getRole() == Ieee8021dInterfaceData::ROOT || port->getRole() == Ieee8021dInterfaceData::DISABLED)
            continue;

        bridgeGlobal->setPortPriority(port->getPriority());
        bridgeGlobal->setPortNum(i);

        bridgeGlobal->setRootPathCost(rootPathCost + port->getLinkCost());

        result = comparePorts(bridgeGlobal, port);

        if (result > 0) {
            EV_DETAIL << "Port=" << i << " is elected as designated port." << endl;
            desPorts.push_back(i);
            port->setRole(Ieee8021dInterfaceData::DESIGNATED);
            continue;
        }
        if (result < 0) {
            EV_DETAIL << "Port=" << i << " goes into alternate role." << endl;
            port->setRole(Ieee8021dInterfaceData::ALTERNATE);
            continue;
        }
    }
    delete bridgeGlobal;
}

void inet::STP::selectRootPort

(

)

Referenced by tryRoot().

{
    desPorts.clear();
    unsigned int xRootPort = 0;
    int result;
    Ieee8021dInterfaceData *best = getPortInterfaceData(0);
    Ieee8021dInterfaceData *currentPort;

    for (unsigned int i = 0; i < numPorts; i++) {
        currentPort = getPortInterfaceData(i);
        currentPort->setRole(Ieee8021dInterfaceData::NOTASSIGNED);
        result = comparePorts(currentPort, best);
        if (result > 0) {
            xRootPort = i;
            best = currentPort;
            continue;
        }
        if (result < 0) {
            continue;
        }
        if (currentPort->getPriority() < best->getPriority()) {
            xRootPort = i;
            best = currentPort;
            continue;
        }
        if (currentPort->getPriority() > best->getPriority())
            continue;
    }

    if (rootPort != xRootPort) {
        EV_DETAIL << "Port=" << xRootPort << " selected as root port." << endl;
        topologyChangeNotification = true;
    }
    rootPort = xRootPort;
    getPortInterfaceData(rootPort)->setRole(Ieee8021dInterfaceData::ROOT);
    rootPathCost = best->getRootPathCost();
    rootAddress = best->getRootAddress();
    rootPriority = best->getRootPriority();

    currentMaxAge = best->getMaxAge();
    currentFwdDelay = best->getFwdDelay();
    currentHelloTime = best->getHelloTime();
}

void inet::STP::setAllDesignated

(

)

Referenced by reset(), start(), and tryRoot().

{
    // all ports of the root switch are designated ports
    EV_DETAIL << "All ports become designated." << endl;    // todo

    Ieee8021dInterfaceData *port;
    desPorts.clear();
    for (unsigned int i = 0; i < numPorts; i++) {
        port = getPortInterfaceData(i);
        if (port->getRole() == Ieee8021dInterfaceData::DISABLED)
            continue;

        port->setRole(Ieee8021dInterfaceData::DESIGNATED);
        desPorts.push_back(i);
    }
}

void inet::STP::setSuperiorBPDU	(	int	portNum,
		BPDU *	bpdu
	)

Referenced by isSuperiorBPDU().

{
    // BDPU is out-of-date
    if (bpdu->getMessageAge() >= bpdu->getMaxAge())
        return;

    Ieee8021dInterfaceData *portData = getPortInterfaceData(portNum);

    portData->setRootPriority(bpdu->getRootPriority());
    portData->setRootAddress(bpdu->getRootAddress());
    portData->setRootPathCost(bpdu->getRootPathCost() + portData->getLinkCost());
    portData->setBridgePriority(bpdu->getBridgePriority());
    portData->setBridgeAddress(bpdu->getBridgeAddress());
    portData->setPortPriority(bpdu->getPortPriority());
    portData->setPortNum(bpdu->getPortNum());
    portData->setMaxAge(bpdu->getMaxAge());
    portData->setFwdDelay(bpdu->getForwardDelay());
    portData->setHelloTime(bpdu->getHelloTime());

    // we just set new port info so reset the age timer
    portData->setAge(0);
}

void inet::STP::start ( )

overrideprotectedvirtual

Reimplemented from inet::STPBase.

{
    STPBase::start();

    initPortTable();
    currentBridgePriority = bridgePriority;
    isRoot = true;
    topologyChangeNotification = true;
    topologyChangeRecvd = true;
    rootPriority = bridgePriority;
    rootAddress = bridgeAddress;
    rootPathCost = 0;
    rootPort = 0;
    currentHelloTime = helloTime;
    currentMaxAge = maxAge;
    currentFwdDelay = forwardDelay;
    helloTime = 0;
    setAllDesignated();

    scheduleAt(simTime() + tickInterval, tick);
}

void inet::STP::stop ( )

overrideprotectedvirtual

Reimplemented from inet::STPBase.

{
    STPBase::stop();
    isRoot = false;
    topologyChangeNotification = true;
    cancelEvent(tick);
}

void inet::STP::tryRoot

(

)

Referenced by handleBPDU(), and lostRoot().

{
    if (checkRootEligibility()) {
        EV_DETAIL << "Switch is elected as root switch." << endl;
        isRoot = true;
        setAllDesignated();
        rootPriority = bridgePriority;
        rootAddress = bridgeAddress;
        rootPathCost = 0;
        currentHelloTime = helloTime;
        currentMaxAge = maxAge;
        currentFwdDelay = forwardDelay;
    }
    else {
        isRoot = false;
        selectRootPort();
        selectDesignatedPorts();
    }
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const Ieee8021dInterfaceData::PortRole  r  )

friend

{
    switch (r) {
        case Ieee8021dInterfaceData::NOTASSIGNED:
            os << "Unkn";
            break;

        case Ieee8021dInterfaceData::ALTERNATE:
            os << "Altr";
            break;

        case Ieee8021dInterfaceData::DESIGNATED:
            os << "Desg";
            break;

        case Ieee8021dInterfaceData::ROOT:
            os << "Root";
            break;

        default:
            os << "<?>";
            break;
    }

    return os;
}

std::ostream& operator<< ( std::ostream &  os, const Ieee8021dInterfaceData::PortState  s  )

friend

{
    switch (s) {
        case Ieee8021dInterfaceData::DISCARDING:
            os << "DIS";
            break;

        case Ieee8021dInterfaceData::LEARNING:
            os << "LRN";
            break;

        case Ieee8021dInterfaceData::FORWARDING:
            os << "FWD";
            break;

        default:
            os << "<?>";
            break;
    }

    return os;
}

std::ostream& operator<< ( std::ostream &  os, Ieee8021dInterfaceData *  p  )

friend

{
    os << "[";
    if (p->isLearning())
        os << "L";
    else
        os << "_";
    if (p->isForwarding())
        os << "F";
    else
        os << "_";
    os << "]";

    os << " " << p->getRole() << " " << p->getState() << " ";
    os << p->getLinkCost() << " ";
    os << p->getPriority() << " ";

    return os;
}

std::ostream& operator<< ( std::ostream &  os, STP  i  )

friend

{
    os << "RootID Priority: " << i.rootPriority << " \n";
    os << "  Address: " << i.rootAddress << " \n";
    if (i.isRoot)
        os << "  This bridge is the Root. \n";
    else {
        os << "  Cost: " << i.rootPathCost << " \n";
        os << "  Port: " << i.rootPort << " \n";
    }
    os << "  Hello Time: " << i.currentHelloTime << " \n";
    os << "  Max Age: " << i.currentMaxAge << " \n";
    os << "  Forward Delay: " << i.currentFwdDelay << " \n";
    os << "BridgeID Priority: " << i.bridgePriority << "\n";
    os << "  Address: " << i.bridgeAddress << " \n";
    os << "  Hello Time: " << i.helloTime << " \n";
    os << "  Max Age: " << i.maxAge << " \n";
    os << "  Forward Delay: " << i.forwardDelay << " \n";
    os << "Port Flag Role State Cost Priority \n";
    os << "-----------------------------------------\n";

    for (unsigned int x = 0; x < i.numPorts; x++)
        os << x << "  " << i.getPortInterfaceData(x) << " \n";

    return os;
}

Member Data Documentation

unsigned int inet::STP::currentBridgePriority = 0

protected

Referenced by checkParametersChange(), and start().

simtime_t inet::STP::currentFwdDelay

protected

Referenced by checkParametersChange(), checkTimers(), generateBPDU(), handleBPDU(), inet::operator<<(), reset(), selectRootPort(), start(), and tryRoot().

simtime_t inet::STP::currentHelloTime

protected

Referenced by checkParametersChange(), checkTimers(), generateBPDU(), inet::operator<<(), reset(), selectRootPort(), start(), and tryRoot().

simtime_t inet::STP::currentMaxAge

protected

Referenced by checkParametersChange(), checkTimers(), generateBPDU(), inet::operator<<(), reset(), selectRootPort(), start(), and tryRoot().

PortInfo inet::STP::defaultPort

protected

std::vector<unsigned int> inet::STP::desPorts

protected

Referenced by handleBPDU(), selectDesignatedPorts(), selectRootPort(), and setAllDesignated().

simtime_t inet::STP::helloTime

protected

Referenced by checkParametersChange(), checkTimers(), handleTick(), inet::operator<<(), reset(), start(), and tryRoot().

bool inet::STP::isRoot = false

protected

Referenced by checkParametersChange(), checkTimers(), generateBPDU(), handleTCN(), handleTick(), inet::operator<<(), reset(), start(), stop(), and tryRoot().

MACAddress inet::STP::rootAddress

protected

Referenced by generateBPDU(), inet::operator<<(), reset(), selectDesignatedPorts(), selectRootPort(), start(), and tryRoot().

unsigned int inet::STP::rootPathCost = 0

protected

Referenced by generateBPDU(), inet::operator<<(), reset(), selectDesignatedPorts(), selectRootPort(), start(), and tryRoot().

unsigned int inet::STP::rootPort = 0

protected

Referenced by generateTCN(), handleTCN(), inet::operator<<(), selectRootPort(), and start().

unsigned int inet::STP::rootPriority = 0

protected

Referenced by generateBPDU(), inet::operator<<(), reset(), selectDesignatedPorts(), selectRootPort(), start(), and tryRoot().

cMessage* inet::STP::tick = nullptr

protected

Referenced by handleMessage(), initialize(), start(), stop(), and ~STP().

const double inet::STP::tickInterval = 1

staticprotected

Referenced by handleTick(), and start().

bool inet::STP::topologyChangeNotification = false

protected

Referenced by generateBPDU(), generateTCN(), handleBPDU(), handleTCN(), lostAlternate(), lostRoot(), selectRootPort(), start(), and stop().

bool inet::STP::topologyChangeRecvd = false

protected

Referenced by generateTCN(), handleBPDU(), and start().

---

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

• STP.h
• STP.cc