inet::Ieee8021dRelay Class Reference

#include <Ieee8021dRelay.h>

Inheritance diagram for inet::Ieee8021dRelay:

Public Member Functions
	Ieee8021dRelay ()
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
void	handleAndDispatchFrame (EtherFrame *frame)
	Updates address table (if the port is in learning state) with source address, determines output port and sends out (or broadcasts) frame on ports (if the ports are in forwarding state). More...
void	dispatch (EtherFrame *frame, unsigned int portNum)
void	learn (EtherFrame *frame)
void	broadcast (EtherFrame *frame)
void	dispatchBPDU (BPDU *bpdu)
	Receives BPDU from the STP/RSTP module and dispatch it to network. More...
void	deliverBPDU (EtherFrame *frame)
	Deliver BPDU to the STP/RSTP module. More...
virtual void	start ()
virtual void	stop ()
bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
Ieee8021dInterfaceData *	getPortInterfaceData (unsigned int portNum)
virtual InterfaceEntry *	chooseInterface ()
virtual void	finish () override

Protected Attributes
MACAddress	bridgeAddress
IInterfaceTable *	ifTable = nullptr
IMACAddressTable *	macTable = nullptr
InterfaceEntry *	ie = nullptr
bool	isOperational = false
bool	isStpAware = false
unsigned int	portCount = 0
int	numReceivedNetworkFrames = 0
int	numDroppedFrames = 0
int	numReceivedBPDUsFromSTP = 0
int	numDeliveredBDPUsToSTP = 0
int	numDispatchedNonBPDUFrames = 0
int	numDispatchedBDPUFrames = 0

Constructor & Destructor Documentation

inet::Ieee8021dRelay::Ieee8021dRelay

(

)

{
}

Member Function Documentation

void inet::Ieee8021dRelay::broadcast ( EtherFrame *  frame )

protected

Referenced by handleAndDispatchFrame().

{
    EV_DETAIL << "Broadcast frame " << frame << endl;

    unsigned int arrivalGate = frame->getArrivalGate()->getIndex();

    for (unsigned int i = 0; i < portCount; i++)
        if (i != arrivalGate && (!isStpAware || getPortInterfaceData(i)->isForwarding()))
            dispatch(frame->dup(), i);


    delete frame;
}

InterfaceEntry * inet::Ieee8021dRelay::chooseInterface ( )

protectedvirtual

Referenced by initialize(), and start().

{
    // TODO: Currently, we assume that the first non-loopback interface is an Ethernet interface
    //       since relays work on EtherSwitches.
    //       NOTE that, we don't check if the returning interface is an Ethernet interface!
    IInterfaceTable *ift = check_and_cast<IInterfaceTable *>(getModuleByPath(par("interfaceTablePath")));

    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *current = ift->getInterface(i);
        if (!current->isLoopback())
            return current;
    }

    return nullptr;
}

void inet::Ieee8021dRelay::deliverBPDU ( EtherFrame *  frame )

protected

Deliver BPDU to the STP/RSTP module.

Sets the BPDU's Ieee802Ctrl info according to the arriving EtherFrame.

Referenced by handleAndDispatchFrame().

{
    BPDU *bpdu = check_and_cast<BPDU *>(frame->decapsulate());

    Ieee802Ctrl *controlInfo = new Ieee802Ctrl();
    controlInfo->setSrc(frame->getSrc());
    controlInfo->setSwitchPort(frame->getArrivalGate()->getIndex());
    controlInfo->setDest(frame->getDest());

    bpdu->setControlInfo(controlInfo);

    delete frame;    // we have the BPDU packet, so delete the frame

    EV_INFO << "Sending BPDU frame " << bpdu << " to the STP/RSTP module" << endl;
    numDeliveredBDPUsToSTP++;
    send(bpdu, "stpOut");
}

void inet::Ieee8021dRelay::dispatch ( EtherFrame *  frame, unsigned int  portNum  )

protected

Referenced by broadcast(), and handleAndDispatchFrame().

{
    EV_INFO << "Sending frame " << frame << " on output port " << portNum << "." << endl;

    if (portNum >= portCount)
        throw cRuntimeError("Output port %d doesn't exist!", portNum);

    EV_INFO << "Sending " << frame << " with destination = " << frame->getDest() << ", port = " << portNum << endl;

    numDispatchedNonBPDUFrames++;
    emit(LayeredProtocolBase::packetSentToLowerSignal, frame);
    send(frame, "ifOut", portNum);
}

void inet::Ieee8021dRelay::dispatchBPDU ( BPDU *  bpdu )

protected

Receives BPDU from the STP/RSTP module and dispatch it to network.

Sets EherFrame destination, source, etc. according to the BPDU's Ieee802Ctrl info.

Referenced by handleMessage().

{
    Ieee802Ctrl *controlInfo = check_and_cast<Ieee802Ctrl *>(bpdu->removeControlInfo());
    unsigned int portNum = controlInfo->getSwitchPort();
    MACAddress address = controlInfo->getDest();
    delete controlInfo;

    if (portNum >= portCount)
        throw cRuntimeError("Output port %d doesn't exist!", portNum);

    // TODO: use LLCFrame
    EthernetIIFrame *frame = new EthernetIIFrame(bpdu->getName());

    frame->setKind(bpdu->getKind());
    frame->setSrc(bridgeAddress);
    frame->setDest(address);
    frame->setByteLength(ETHER_MAC_FRAME_BYTES);
    frame->setEtherType(-1);
    frame->encapsulate(bpdu);

    if (frame->getByteLength() < MIN_ETHERNET_FRAME_BYTES)
        frame->setByteLength(MIN_ETHERNET_FRAME_BYTES);

    EV_INFO << "Sending BPDU frame " << frame << " with destination = " << frame->getDest() << ", port = " << portNum << endl;
    numDispatchedBDPUFrames++;
    emit(LayeredProtocolBase::packetSentToLowerSignal, frame);
    send(frame, "ifOut", portNum);
}

void inet::Ieee8021dRelay::finish ( )

overrideprotectedvirtual

{
    recordScalar("number of received BPDUs from STP module", numReceivedBPDUsFromSTP);
    recordScalar("number of received frames from network (including BPDUs)", numReceivedNetworkFrames);
    recordScalar("number of dropped frames (including BPDUs)", numDroppedFrames);
    recordScalar("number of delivered BPDUs to the STP module", numDeliveredBDPUsToSTP);
    recordScalar("number of dispatched BPDU frames to the network", numDispatchedBDPUFrames);
    recordScalar("number of dispatched non-BDPU frames to the network", numDispatchedNonBPDUFrames);
}

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

protected

Referenced by broadcast(), handleAndDispatchFrame(), and learn().

{
    if (isStpAware) {
        cGate *gate = getContainingNode(this)->gate("ethg$o", portNum);
        InterfaceEntry *gateIfEntry = ifTable->getInterfaceByNodeOutputGateId(gate->getId());
        Ieee8021dInterfaceData *portData = gateIfEntry ? gateIfEntry->ieee8021dData() : nullptr;

        if (!portData)
            throw cRuntimeError("Ieee8021dInterfaceData not found for port = %d", portNum);

        return portData;
    }
    return nullptr;
}

void inet::Ieee8021dRelay::handleAndDispatchFrame ( EtherFrame *  frame )

protected

Updates address table (if the port is in learning state) with source address, determines output port and sends out (or broadcasts) frame on ports (if the ports are in forwarding state).

Includes calls to updateTableWithAddress() and getPortForAddress().

Referenced by handleMessage().

{
    int arrivalGate = frame->getArrivalGate()->getIndex();
    Ieee8021dInterfaceData *arrivalPortData = getPortInterfaceData(arrivalGate);
    learn(frame);

    // BPDU Handling
    if (isStpAware && (frame->getDest() == MACAddress::STP_MULTICAST_ADDRESS || frame->getDest() == bridgeAddress) && arrivalPortData->getRole() != Ieee8021dInterfaceData::DISABLED) {
        EV_DETAIL << "Deliver BPDU to the STP/RSTP module" << endl;
        deliverBPDU(frame);    // deliver to the STP/RSTP module
    }
    else if (isStpAware && !arrivalPortData->isForwarding()) {
        EV_INFO << "The arrival port is not forwarding! Discarding it!" << endl;
        numDroppedFrames++;
        delete frame;
    }
    else if (frame->getDest().isBroadcast()) {    // broadcast address
        broadcast(frame);
    }
    else {
        int outGate = macTable->getPortForAddress(frame->getDest());
        // Not known -> broadcast
        if (outGate == -1) {
            EV_DETAIL << "Destination address = " << frame->getDest() << " unknown, broadcasting frame " << frame << endl;
            broadcast(frame);
        }
        else {
            if (outGate != arrivalGate) {
                Ieee8021dInterfaceData *outPortData = getPortInterfaceData(outGate);

                if (!isStpAware || outPortData->isForwarding())
                    dispatch(frame, outGate);
                else {
                    EV_INFO << "Output port " << outGate << " is not forwarding. Discarding!" << endl;
                    numDroppedFrames++;
                    delete frame;
                }
            }
            else {
                EV_DETAIL << "Output port is same as input port, " << frame->getFullName() << " destination = " << frame->getDest() << ", discarding frame " << frame << endl;
                numDroppedFrames++;
                delete frame;
            }
        }
    }
}

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

overrideprotectedvirtual

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

    if (!msg->isSelfMessage()) {
        // messages from STP process
        if (strcmp(msg->getArrivalGate()->getName(), "stpIn") == 0) {
            numReceivedBPDUsFromSTP++;
            EV_INFO << "Received " << msg << " from STP/RSTP module." << endl;
            BPDU *bpdu = check_and_cast<BPDU *>(msg);
            dispatchBPDU(bpdu);
        }
        // messages from network
        else if (strcmp(msg->getArrivalGate()->getName(), "ifIn") == 0) {
            numReceivedNetworkFrames++;
            EV_INFO << "Received " << msg << " from network." << endl;
            EtherFrame *frame = check_and_cast<EtherFrame *>(msg);
            emit(LayeredProtocolBase::packetReceivedFromLowerSignal, frame);
            handleAndDispatchFrame(frame);
        }
    }
    else
        throw cRuntimeError("This module doesn't handle self-messages!");
}

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

overrideprotectedvirtual

Perform one stage of a lifecycle operation.

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

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

Implements inet::ILifecycle.

{
    Enter_Method_Silent();

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

    return true;
}

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

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LOCAL) {
        // statistics
        numDispatchedBDPUFrames = numDispatchedNonBPDUFrames = numDeliveredBDPUsToSTP = 0;
        numReceivedBPDUsFromSTP = numReceivedNetworkFrames = numDroppedFrames = 0;

        // number of ports
        portCount = gate("ifOut", 0)->size();
        if (gate("ifIn", 0)->size() != (int)portCount)
            throw cRuntimeError("the sizes of the ifIn[] and ifOut[] gate vectors must be the same");
    }
    else if (stage == INITSTAGE_LINK_LAYER_2) {
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;

        macTable = check_and_cast<IMACAddressTable *>(getModuleByPath(par("macTablePath")));
        ifTable = check_and_cast<IInterfaceTable *>(getModuleByPath(par("interfaceTablePath")));

        if (isOperational) {
            ie = chooseInterface();

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

        isStpAware = gate("stpIn")->isConnected();    // if the stpIn is not connected then the switch is STP/RSTP unaware

        WATCH(bridgeAddress);
        WATCH(numReceivedNetworkFrames);
        WATCH(numDroppedFrames);
        WATCH(numReceivedBPDUsFromSTP);
        WATCH(numDeliveredBDPUsToSTP);
        WATCH(numDispatchedNonBPDUFrames);
    }
}

void inet::Ieee8021dRelay::learn ( EtherFrame *  frame )

protected

Referenced by handleAndDispatchFrame().

{
    int arrivalGate = frame->getArrivalGate()->getIndex();
    Ieee8021dInterfaceData *port = getPortInterfaceData(arrivalGate);

    if (!isStpAware || port->isLearning())
        macTable->updateTableWithAddress(arrivalGate, frame->getSrc());
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::Ieee8021dRelay::start ( )

protectedvirtual

Referenced by handleOperationStage().

{
    isOperational = true;

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

    macTable->clearTable();
}

void inet::Ieee8021dRelay::stop ( )

protectedvirtual

Referenced by handleOperationStage().

{
    isOperational = false;

    macTable->clearTable();
    ie = nullptr;
}

Member Data Documentation

MACAddress inet::Ieee8021dRelay::bridgeAddress

protected

Referenced by dispatchBPDU(), handleAndDispatchFrame(), initialize(), and start().

InterfaceEntry* inet::Ieee8021dRelay::ie = nullptr

protected

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

IInterfaceTable* inet::Ieee8021dRelay::ifTable = nullptr

protected

Referenced by getPortInterfaceData(), and initialize().

bool inet::Ieee8021dRelay::isOperational = false

protected

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

bool inet::Ieee8021dRelay::isStpAware = false

protected

Referenced by broadcast(), getPortInterfaceData(), handleAndDispatchFrame(), initialize(), and learn().

IMACAddressTable* inet::Ieee8021dRelay::macTable = nullptr

protected

Referenced by handleAndDispatchFrame(), initialize(), learn(), start(), and stop().

int inet::Ieee8021dRelay::numDeliveredBDPUsToSTP = 0

protected

Referenced by deliverBPDU(), finish(), and initialize().

int inet::Ieee8021dRelay::numDispatchedBDPUFrames = 0

protected

Referenced by dispatchBPDU(), finish(), and initialize().

int inet::Ieee8021dRelay::numDispatchedNonBPDUFrames = 0

protected

Referenced by dispatch(), finish(), and initialize().

int inet::Ieee8021dRelay::numDroppedFrames = 0

protected

Referenced by finish(), handleAndDispatchFrame(), and initialize().

int inet::Ieee8021dRelay::numReceivedBPDUsFromSTP = 0

protected

Referenced by finish(), handleMessage(), and initialize().

int inet::Ieee8021dRelay::numReceivedNetworkFrames = 0

protected

Referenced by finish(), handleMessage(), and initialize().

unsigned int inet::Ieee8021dRelay::portCount = 0

protected

Referenced by broadcast(), dispatch(), dispatchBPDU(), and initialize().

---

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

• Ieee8021dRelay.h
• Ieee8021dRelay.cc