inet::Stp Class Reference

Implements the Spanning Tree Protocol. More...

#include <Stp.h>

Inheritance diagram for inet::Stp:

Public Types
typedef Ieee8021dInterfaceData::PortInfo	PortInfo

Public Member Functions
	Stp ()
virtual	~Stp ()
void	handleBPDU (Packet *packet, const Ptr< const BpduCfg > &bpdu)
virtual void	initInterfacedata (unsigned int interfaceId)
void	handleTCN (Packet *packet, const Ptr< const BpduTcn > &tcn)
	Topology change handling. More...
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
void	generateBPDU (int interfaceId, const MacAddress &address=MacAddress::STP_MULTICAST_ADDRESS, bool tcFlag=false, bool tcaFlag=false)
void	generateHelloBPDUs ()
void	generateTCN ()
int	comparePorts (const Ieee8021dInterfaceData *portA, const Ieee8021dInterfaceData *portB)
int	compareBridgeIDs (unsigned int aPriority, MacAddress aAddress, unsigned int bPriority, MacAddress bAddress)
int	comparePortIDs (unsigned int aPriority, unsigned int aNum, unsigned int bPriority, unsigned int bNum)
bool	isSuperiorBPDU (int interfaceId, const Ptr< const BpduCfg > &bpdu)
void	setSuperiorBPDU (int interfaceId, const Ptr< const BpduCfg > &bpdu)
void	handleTick ()
void	checkTimers ()
void	checkParametersChange ()
void	initPortTable ()
void	selectRootPort ()
void	selectDesignatedPorts ()
void	setAllDesignated ()
void	lostRoot ()
void	lostAlternate ()
void	reset ()
bool	checkRootEligibility ()
void	tryRoot ()
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
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
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 (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
bool	isRoot = false
unsigned int	rootInterfaceId = 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
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

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)

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Detailed Description

Implements the Spanning Tree Protocol.

See the NED file for details.

Member Typedef Documentation

PortInfo

typedef Ieee8021dInterfaceData::PortInfo inet::Stp::PortInfo

Constructor & Destructor Documentation

Stp()

inet::Stp::Stp

(

)

{
}

~Stp()

inet::Stp::~Stp ( )

virtual

{
    cancelAndDelete(tick);
}

Member Function Documentation

checkParametersChange()

void inet::Stp::checkParametersChange

(

)

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

Referenced by handleTick().

checkRootEligibility()

bool inet::Stp::checkRootEligibility

(

)

{
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        const Ieee8021dInterfaceData *port = getPortInterfaceData(interfaceId);
 
        if (compareBridgeIDs(port->getRootPriority(), port->getRootAddress(), bridgePriority, bridgeAddress) > 0)
            return false;
    }
 
    return true;
}

Referenced by tryRoot().

checkTimers()

void inet::Stp::checkTimers

(

)

{
    Ieee8021dInterfaceData *port;
 
    // hello timer check
    if (helloTime >= currentHelloTime) {
        // only the root switch can generate Hello BPDUs
        if (isRoot)
            generateHelloBPDUs();
 
        helloTime = 0;
    }
 
    // information age check
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        port = getPortInterfaceDataForUpdate(interfaceId);
 
        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(interfaceId);
                lostRoot();
            }
            else {
                initInterfacedata(interfaceId);
                lostAlternate();
            }
        }
    }
 
    // fdWhile timer
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        port = getPortInterfaceDataForUpdate(interfaceId);
 
        // 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=" << interfaceId << " goes into learning state." << endl;
                        port->setState(Ieee8021dInterfaceData::LEARNING);
                        port->setFdWhile(0);
                        break;
 
                    case Ieee8021dInterfaceData::LEARNING:
                        EV_DETAIL << "Port=" << interfaceId << " goes into forwarding state." << endl;
                        port->setState(Ieee8021dInterfaceData::FORWARDING);
                        port->setFdWhile(0);
                        break;
 
                    default:
                        port->setFdWhile(0);
                        break;
                }
            }
        }
        else {
            EV_DETAIL << "Port=" << interfaceId << " goes into discarding state." << endl;
            port->setFdWhile(0);
            port->setState(Ieee8021dInterfaceData::DISCARDING);
        }
    }
}

Referenced by handleTick().

compareBridgeIDs()

int inet::Stp::compareBridgeIDs	(	unsigned int	aPriority,
		MacAddress	aAddress,
		unsigned int	bPriority,
		MacAddress	bAddress
	)

{
    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;
}

Referenced by checkRootEligibility(), and comparePorts().

comparePortIDs()

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

{
    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;
}

Referenced by comparePorts().

comparePorts()

int inet::Stp::comparePorts	(	const Ieee8021dInterfaceData *	portA,
		const Ieee8021dInterfaceData *	portB
	)

{
    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
}

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

generateBPDU()

void inet::Stp::generateBPDU	(	int	interfaceId,
		const MacAddress &	address = MacAddress::STP_MULTICAST_ADDRESS,
		bool	tcFlag = false,
		bool	tcaFlag = false
	)

{
    Packet *packet = new Packet("BPDU");
    const auto& bpdu = makeShared<BpduCfg>();
    auto macAddressReq = packet->addTag<MacAddressReq>();
    macAddressReq->setSrcAddress(bridgeAddress);
    macAddressReq->setDestAddress(address);
    packet->addTag<InterfaceReq>()->setInterfaceId(interfaceId);
    packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::stp);
    packet->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
 
    bpdu->setProtocolIdentifier(SPANNING_TREE_PROTOCOL);
    bpdu->setProtocolVersionIdentifier(SPANNING_TREE);
 
    bpdu->setBridgeAddress(bridgeAddress);
    bpdu->setBridgePriority(bridgePriority);
    bpdu->setRootPathCost(rootPathCost);
    bpdu->setRootAddress(rootAddress);
    bpdu->setRootPriority(rootPriority);
    bpdu->setPortNum(interfaceId);
    bpdu->setPortPriority(getPortInterfaceData(interfaceId)->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);
        }
    }
 
    packet->insertAtBack(bpdu);
    send(packet, "relayOut");
}

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

generateHelloBPDUs()

void inet::Stp::generateHelloBPDUs

(

)

{
    EV_INFO << "It is hello time. Root switch sending hello BPDUs on all its ports." << endl;
 
    // send hello BPDUs on all ports
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        generateBPDU(interfaceId);
    }
}

Referenced by checkTimers().

generateTCN()

void inet::Stp::generateTCN

(

)

{
    // there is something to notify
    if (topologyChangeNotification || !topologyChangeRecvd) {
        if (getPortInterfaceData(rootInterfaceId)->getRole() == Ieee8021dInterfaceData::ROOT) {
            // exist root port to notifying
            topologyChangeNotification = false;
            Packet *packet = new Packet("BPDU-TCN");
            const auto& tcn = makeShared<BpduTcn>();
            tcn->setProtocolIdentifier(SPANNING_TREE_PROTOCOL);
            tcn->setProtocolVersionIdentifier(SPANNING_TREE);
 
            auto macAddressReq = packet->addTag<MacAddressReq>();
            macAddressReq->setSrcAddress(bridgeAddress);
            macAddressReq->setDestAddress(MacAddress::STP_MULTICAST_ADDRESS);
            packet->addTag<InterfaceReq>()->setInterfaceId(rootInterfaceId);
            packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::stp);
            packet->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
 
            packet->insertAtBack(tcn);
            EV_INFO << "The topology has changed. Sending Topology Change Notification BPDU " << tcn << " to the Root Switch." << endl;
            send(packet, "relayOut");
        }
    }
}

Referenced by handleTick().

handleBPDU()

void inet::Stp::handleBPDU	(	Packet *	packet,
		const Ptr< const BpduCfg > &	bpdu
	)

{
    int arrivalGate = packet->getTag<InterfaceInd>()->getInterfaceId();
    const 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 << "MacForwardingTable 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->setAgingTime(-1);
 
            EV_INFO << "Sending BPDUs on all designated ports." << endl;
 
            // BPDUs are sent on all designated ports
            for (auto& elem : desPorts)
                generateBPDU(elem);
        }
    }
 
    tryRoot();
    delete packet;
}

Referenced by handleMessageWhenUp().

handleMessageWhenUp()

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

overridevirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (!msg->isSelfMessage()) {
        Packet *packet = check_and_cast<Packet *>(msg);
        const auto& bpdu = packet->peekAtFront<BpduBase>();
 
        switch (bpdu->getBpduType()) {
            case BPDU_CFG:
                handleBPDU(packet, CHK(dynamicPtrCast<const BpduCfg>(bpdu)));
                break;
            case BPDU_TCN:
                handleTCN(packet, CHK(dynamicPtrCast<const BpduTcn>(bpdu)));
                break;
            default:
                throw cRuntimeError("unknown BPDU TYPE: %d", bpdu->getBpduType());
        }
    }
    else {
        if (msg == tick) {
            handleTick();
            scheduleAfter(1, tick);
        }
        else
            throw cRuntimeError("Unknown self-message received");
    }
}

handleTCN()

void inet::Stp::handleTCN	(	Packet *	packet,
		const Ptr< const BpduTcn > &	tcn
	)

Topology change handling.

{
    EV_INFO << "Topology Change Notification BPDU " << tcn << " arrived." << endl;
    topologyChangeNotification = true;
 
    int arrivalGate = packet->getTag<InterfaceInd>()->getInterfaceId();
    const auto& addressInd = packet->getTag<MacAddressInd>();
    MacAddress srcAddress = addressInd->getSrcAddress();
    MacAddress destAddress = addressInd->getDestAddress();
 
    // send ACK to the sender
    EV_INFO << "Sending Topology Change Notification ACK." << endl;
    generateBPDU(arrivalGate, srcAddress, false, true);
 
    if (!isRoot) {
        Packet *outPacket = new Packet(packet->getName());
        outPacket->insertAtBack(tcn);
        outPacket->addTag<InterfaceReq>()->setInterfaceId(rootInterfaceId);
        auto macAddressReq = outPacket->addTag<MacAddressReq>();
        macAddressReq->setSrcAddress(bridgeAddress);
        macAddressReq->setDestAddress(destAddress);
        outPacket->addTag<PacketProtocolTag>()->setProtocol(&Protocol::stp);
        outPacket->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
        send(outPacket, "relayOut");
    }
    delete packet;
}

Referenced by handleMessageWhenUp().

handleTick()

void inet::Stp::handleTick

(

)

{
    // hello BPDU timer
    if (isRoot)
        helloTime = helloTime + 1;
    else
        helloTime = 0;
 
    for (unsigned int i = 0; i < numPorts; i++) {
        int interfaceId = ifTable->getInterface(i)->getInterfaceId();
        auto port = getPortInterfaceDataForUpdate(interfaceId);
 
        // 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=" << interfaceId << endl;
            port->setAge(port->getAge() + tickInterval);
        }
        if (port->getRole() == Ieee8021dInterfaceData::ROOT || port->getRole() == Ieee8021dInterfaceData::DESIGNATED) {
            EV_DEBUG << "Forward While timer incremented on port=" << interfaceId << endl;
            port->setFdWhile(port->getFdWhile() + tickInterval);
        }
    }
    checkTimers();
    checkParametersChange();
    generateTCN();
}

Referenced by handleMessageWhenUp().

initialize()

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);
    }
    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->isMulticast() /* && ie->getProtocol() == &Protocol::ethernetMac */) {   // TODO check protocol
                ie->addMulticastMacAddress(MacAddress::STP_MULTICAST_ADDRESS);
            }
        }
    }
}

initInterfacedata()

void inet::Stp::initInterfacedata ( unsigned int  interfaceId )

virtual

{
    auto ifd = getPortInterfaceDataForUpdate(interfaceId);
    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);
}

Referenced by checkTimers(), and initPortTable().

initPortTable()

void inet::Stp::initPortTable

(

)

{
    EV_DEBUG << "IEE8021D Interface Data initialization. Setting port infos to the protocol defaults." << endl;
    for (unsigned int i = 0; i < numPorts; i++) {
        auto ie = ifTable->getInterface(i);
        if (!ie->isLoopback() && ie->isWired() && ie->isMulticast() /* && ie->getProtocol() == &Protocol::ethernetMac */) {  // TODO check protocol
            initInterfacedata(ie->getInterfaceId());
        }
    }
}

Referenced by start().

isSuperiorBPDU()

bool inet::Stp::isSuperiorBPDU	(	int	interfaceId,
		const Ptr< const BpduCfg > &	bpdu
	)

{
    auto port = getPortInterfaceDataForUpdate(interfaceId);
    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(interfaceId, bpdu); // renew information
        delete xBpdu;
        return true;
    }
 
    setSuperiorBPDU(interfaceId, bpdu); // renew information
    delete xBpdu;
    return true;
}

Referenced by handleBPDU().

lostAlternate()

void inet::Stp::lostAlternate

(

)

{
    selectDesignatedPorts();
    topologyChangeNotification = true;
}

Referenced by checkTimers().

lostRoot()

void inet::Stp::lostRoot

(

)

{
    topologyChangeNotification = true;
    tryRoot();
}

Referenced by checkTimers().

numInitStages()

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

inlineoverridevirtual

Reimplemented from inet::StpBase.

{ return NUM_INIT_STAGES; }

reset()

void inet::Stp::reset

(

)

{
    // 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();
}

Referenced by checkParametersChange().

selectDesignatedPorts()

void inet::Stp::selectDesignatedPorts

(

)

{
    // select designated ports
    desPorts.clear();
    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++) {
        NetworkInterface *ie = ifTable->getInterface(i);
        auto portData = ie->getProtocolDataForUpdate<Ieee8021dInterfaceData>();
        ASSERT(portData != nullptr);
 
        if (portData->getRole() == Ieee8021dInterfaceData::ROOT || portData->getRole() == Ieee8021dInterfaceData::DISABLED)
            continue;
 
        bridgeGlobal->setPortPriority(portData->getPriority());
        int interfaceId = ie->getInterfaceId();
        bridgeGlobal->setPortNum(interfaceId);
 
        bridgeGlobal->setRootPathCost(rootPathCost + portData->getLinkCost());
 
        result = comparePorts(bridgeGlobal, portData);
 
        if (result > 0) {
            EV_DETAIL << "Port=" << ie->getFullName() << " is elected as designated portData." << endl;
            desPorts.push_back(interfaceId);
            portData->setRole(Ieee8021dInterfaceData::DESIGNATED);
            continue;
        }
        if (result < 0) {
            EV_DETAIL << "Port=" << ie->getFullName() << " goes into alternate role." << endl;
            portData->setRole(Ieee8021dInterfaceData::ALTERNATE);
            continue;
        }
    }
    delete bridgeGlobal;
}

Referenced by lostAlternate(), and tryRoot().

selectRootPort()

void inet::Stp::selectRootPort

(

)

{
    desPorts.clear();
    unsigned int xRootIdx = 0;
    int result;
    auto best = ifTable->getInterface(0)->getProtocolData<Ieee8021dInterfaceData>();
    Ieee8021dInterfaceData *currentPort = nullptr;
 
    for (unsigned int i = 0; i < numPorts; i++) {
        currentPort = ifTable->getInterface(i)->getProtocolDataForUpdate<Ieee8021dInterfaceData>();
        currentPort->setRole(Ieee8021dInterfaceData::NOTASSIGNED);
        result = comparePorts(currentPort, best);
        if (result > 0) {
            xRootIdx = i;
            best = currentPort;
            continue;
        }
        if (result < 0) {
            continue;
        }
        if (currentPort->getPriority() < best->getPriority()) {
            xRootIdx = i;
            best = currentPort;
            continue;
        }
    }
 
    unsigned int xRootInterfaceId = ifTable->getInterface(xRootIdx)->getInterfaceId();
    if (rootInterfaceId != xRootInterfaceId) {
        EV_DETAIL << "Port=" << xRootInterfaceId << " selected as root port." << endl;
        topologyChangeNotification = true;
    }
    rootInterfaceId = xRootInterfaceId;
    getPortInterfaceDataForUpdate(rootInterfaceId)->setRole(Ieee8021dInterfaceData::ROOT);
    rootPathCost = best->getRootPathCost();
    rootAddress = best->getRootAddress();
    rootPriority = best->getRootPriority();
 
    currentMaxAge = best->getMaxAge();
    currentFwdDelay = best->getFwdDelay();
    currentHelloTime = best->getHelloTime();
}

Referenced by tryRoot().

setAllDesignated()

void inet::Stp::setAllDesignated

(

)

{
    // all ports of the root switch are designated ports
    EV_DETAIL << "All ports become designated." << endl; // todo
 
    desPorts.clear();
    for (unsigned int i = 0; i < numPorts; i++) {
        NetworkInterface *ie = ifTable->getInterface(i);
        auto portData = ie->getProtocolDataForUpdate<Ieee8021dInterfaceData>();
        ASSERT(portData != nullptr);
        if (portData->getRole() == Ieee8021dInterfaceData::DISABLED)
            continue;
 
        int interfaceId = ie->getInterfaceId();
        portData->setRole(Ieee8021dInterfaceData::DESIGNATED);
        desPorts.push_back(interfaceId);
    }
}

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

setSuperiorBPDU()

void inet::Stp::setSuperiorBPDU	(	int	interfaceId,
		const Ptr< const BpduCfg > &	bpdu
	)

{
    // BPDU is out-of-date
    if (bpdu->getMessageAge() >= bpdu->getMaxAge())
        return;
 
    auto portData = getPortInterfaceDataForUpdate(interfaceId);
 
    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);
}

Referenced by isSuperiorBPDU().

start()

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;
    rootInterfaceId = ifTable->getInterface(0)->getInterfaceId();
    currentHelloTime = helloTime;
    currentMaxAge = maxAge;
    currentFwdDelay = forwardDelay;
    helloTime = 0;
    setAllDesignated();
 
    scheduleAfter(tickInterval, tick);
}

stop()

void inet::Stp::stop ( )

overrideprotectedvirtual

Reimplemented from inet::StpBase.

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

tryRoot()

void inet::Stp::tryRoot

(

)

{
    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();
    }
}

Referenced by handleBPDU(), and lostRoot().

Friends And Related Function Documentation

operator<< [1/4]

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;
}

operator<< [2/4]

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;
}

operator<< [3/4]

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;
}

operator<< [4/4]

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.rootInterfaceId << " \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

currentBridgePriority

unsigned int inet::Stp::currentBridgePriority = 0

protected

Referenced by checkParametersChange(), and start().

currentFwdDelay

simtime_t inet::Stp::currentFwdDelay

protected

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

currentHelloTime

simtime_t inet::Stp::currentHelloTime

protected

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

currentMaxAge

simtime_t inet::Stp::currentMaxAge

protected

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

defaultPort

PortInfo inet::Stp::defaultPort

protected

desPorts

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

protected

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

helloTime

simtime_t inet::Stp::helloTime

protected

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

isRoot

bool inet::Stp::isRoot = false

protected

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

rootAddress

MacAddress inet::Stp::rootAddress

protected

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

rootInterfaceId

unsigned int inet::Stp::rootInterfaceId = 0

protected

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

rootPathCost

unsigned int inet::Stp::rootPathCost = 0

protected

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

rootPriority

unsigned int inet::Stp::rootPriority = 0

protected

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

tick

cMessage* inet::Stp::tick = nullptr

protected

Referenced by handleMessageWhenUp(), initialize(), start(), stop(), and ~Stp().

tickInterval

const double inet::Stp::tickInterval = 1

staticprotected

Referenced by handleTick(), and start().

topologyChangeNotification

bool inet::Stp::topologyChangeNotification = false

protected

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

topologyChangeRecvd

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