inet::MACAddressTable Class Reference

This module handles the mapping between ports and MAC addresses. More...

#include <MACAddressTable.h>

Inheritance diagram for inet::MACAddressTable:

Classes
struct	AddressEntry
struct	MAC_compare

Public Member Functions
	MACAddressTable ()
	~MACAddressTable ()
virtual int	getPortForAddress (MACAddress &address, unsigned int vid=0) override
	For a known arriving port, V-TAG and destination MAC. More...
virtual bool	updateTableWithAddress (int portno, MACAddress &address, unsigned int vid=0) override
	Register a new MAC address at AddressTable. More...
virtual void	flush (int portno) override
	Clears portno cache. More...
virtual void	printState () override
	Prints cached data. More...
virtual void	copyTable (int portA, int portB) override
	Copy cache from portA to portB port. More...
virtual void	removeAgedEntriesFromVlan (unsigned int vid=0) override
	Remove aged entries from a specified VLAN. More...
virtual void	removeAgedEntriesFromAllVlans () override
	Remove aged entries from all VLANs. More...
virtual void	removeAgedEntriesIfNeeded () override
virtual void	readAddressTable (const char *fileName) override
	Pre-reads in entries for Address Table during initialization. More...
virtual void	clearTable () override
	For lifecycle: clears all entries from the vlanAddressTable. More...
virtual void	setAgingTime (simtime_t agingTime) override
virtual void	resetDefaultAging () override

Protected Types
typedef std::map< MACAddress, AddressEntry, MAC_compare >	AddressTable
typedef std::map< unsigned int, AddressTable * >	VlanAddressTable

Protected Member Functions
virtual void	initialize () override
virtual void	handleMessage (cMessage *msg) override
AddressTable *	getTableForVid (unsigned int vid)
	Returns a MAC Address Table for a specified VLAN ID. More...

Protected Attributes
simtime_t	agingTime
simtime_t	lastPurge
AddressTable *	addressTable = nullptr
VlanAddressTable	vlanAddressTable

Friends
std::ostream &	operator<< (std::ostream &os, const AddressEntry &entry)

Detailed Description

This module handles the mapping between ports and MAC addresses.

See the NED definition for details.

Member Typedef Documentation

typedef std::map<MACAddress, AddressEntry, MAC_compare> inet::MACAddressTable::AddressTable

protected

typedef std::map<unsigned int, AddressTable *> inet::MACAddressTable::VlanAddressTable

protected

Constructor & Destructor Documentation

inet::MACAddressTable::MACAddressTable

(

)

{
    addressTable = new AddressTable();
    // Set addressTable for VLAN ID 0
    vlanAddressTable[0] = addressTable;
}

inet::MACAddressTable::~MACAddressTable

(

)

{
    for (auto & elem : vlanAddressTable)
        delete elem.second;
}

Member Function Documentation

void inet::MACAddressTable::clearTable ( )

overridevirtual

For lifecycle: clears all entries from the vlanAddressTable.

Implements inet::IMACAddressTable.

{
    for (auto & elem : vlanAddressTable)
        delete elem.second;

    vlanAddressTable.clear();
    addressTable = nullptr;
}

void inet::MACAddressTable::copyTable ( int  portA, int  portB  )

overridevirtual

Copy cache from portA to portB port.

Implements inet::IMACAddressTable.

{
    for (auto & elem : vlanAddressTable) {
        AddressTable *table = elem.second;
        for (auto & table_j : *table)
            if (table_j.second.portno == portA)
                table_j.second.portno = portB;

    }
}

void inet::MACAddressTable::flush ( int  portno )

overridevirtual

Clears portno cache.

Implements inet::IMACAddressTable.

{
    Enter_Method("MACAddressTable::flush():  Clearing gate %d cache", portno);
    for (auto & elem : vlanAddressTable) {
        AddressTable *table = elem.second;
        for (auto j = table->begin(); j != table->end(); ) {
            auto cur = j++;
            if (cur->second.portno == portno)
                table->erase(cur);
        }
    }
}

int inet::MACAddressTable::getPortForAddress ( MACAddress &  address, unsigned int  vid = 0  )

overridevirtual

For a known arriving port, V-TAG and destination MAC.

It finds out the port where relay component should deliver the message

Parameters

address	MAC destination
vid	VLAN ID

Returns

Output port for address, or -1 if unknown.

Implements inet::IMACAddressTable.

{
    Enter_Method("MACAddressTable::getPortForAddress()");

    AddressTable *table = getTableForVid(vid);
    // VLAN ID vid does not exist
    if (table == nullptr)
        return -1;

    auto iter = table->find(address);

    if (iter == table->end()) {
        // not found
        return -1;
    }
    if (iter->second.insertionTime + agingTime <= simTime()) {
        // don't use (and throw out) aged entries
        EV << "Ignoring and deleting aged entry: " << iter->first << " --> port" << iter->second.portno << "\n";
        table->erase(iter);
        return -1;
    }
    return iter->second.portno;
}

MACAddressTable::AddressTable * inet::MACAddressTable::getTableForVid ( unsigned int  vid )

protected

Returns a MAC Address Table for a specified VLAN ID.

Referenced by getPortForAddress(), readAddressTable(), removeAgedEntriesFromVlan(), and updateTableWithAddress().

{
    if (vid == 0)
        return addressTable;

    auto iter = vlanAddressTable.find(vid);
    if (iter != vlanAddressTable.end())
        return iter->second;
    return nullptr;
}

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

overrideprotectedvirtual

{
    throw cRuntimeError("This module doesn't process messages");
}

void inet::MACAddressTable::initialize ( )

overrideprotectedvirtual

{
    agingTime = par("agingTime");
    lastPurge = SIMTIME_ZERO;

    // Option to pre-read in Address Table. To turn it off, set addressTableFile to empty string
    const char *addressTableFile = par("addressTableFile");
    if (addressTableFile && *addressTableFile)
        readAddressTable(addressTableFile);

    AddressTable& addressTable = *this->addressTable;    // magic to hide the '*' from the name of the watch below
    WATCH_MAP(addressTable);
}

void inet::MACAddressTable::printState ( )

overridevirtual

Prints cached data.

Implements inet::IMACAddressTable.

{
    EV << endl << "MAC Address Table" << endl;
    EV << "VLAN ID    MAC    Port    Inserted" << endl;
    for (auto & elem : vlanAddressTable) {
        AddressTable *table = elem.second;
        for (auto & table_j : *table)
            EV << table_j.second.vid << "   " << table_j.first << "   " << table_j.second.portno << "   " << table_j.second.insertionTime << endl;
    }
}

void inet::MACAddressTable::readAddressTable ( const char *  fileName )

overridevirtual

Pre-reads in entries for Address Table during initialization.

Implements inet::IMACAddressTable.

Referenced by initialize().

{
    FILE *fp = fopen(fileName, "r");
    if (fp == nullptr)
        throw cRuntimeError("cannot open address table file `%s'", fileName);

    //  Syntax of the file goes as:
    //  VLAN ID, address in hexadecimal representation, portno
    //  1    ffffffff    1
    //  1    ffffeed1    2
    //  2    aabcdeff    3
    //
    //  etc...
    //
    //  Each iteration of the loop reads in an entire line i.e. up to '\n' or EOF characters
    //  and uses strtok to extract tokens from the resulting string
    char *line;
    for (int lineno = 0; (line = fgetline(fp)) != nullptr; delete [] line) {
        lineno++;

        // lines beginning with '#' are treated as comments
        if (line[0] == '#')
            continue;

        // scan in VLAN ID
        char *vlanID = strtok(line, " \t");
        // scan in hexaddress
        char *hexaddress = strtok(nullptr, " \t");
        // scan in port number
        char *portno = strtok(nullptr, " \t");

        // empty line?
        if (!vlanID)
            continue;

        // broken line?
        if (!portno || !hexaddress)
            throw cRuntimeError("line %d invalid in address table file `%s'", lineno, fileName);

        // Create an entry with address and portno and insert into table
        AddressEntry entry(atoi(vlanID), atoi(portno), 0);
        AddressTable *table = getTableForVid(entry.vid);

        if (table == nullptr) {
            table = new AddressTable();
            vlanAddressTable[entry.vid] = table;
        }

        (*table)[MACAddress(hexaddress)] = entry;
    }
    fclose(fp);
}

void inet::MACAddressTable::removeAgedEntriesFromAllVlans ( )

overridevirtual

Remove aged entries from all VLANs.

Implements inet::IMACAddressTable.

Referenced by removeAgedEntriesIfNeeded().

{
    for (auto & elem : vlanAddressTable) {
        AddressTable *table = elem.second;
        // TODO: this part could be factored out
        for (auto j = table->begin(); j != table->end(); ) {
            auto cur = j++;    // iter will get invalidated after erase()
            AddressEntry& entry = cur->second;
            if (entry.insertionTime + agingTime <= simTime()) {
                EV << "Removing aged entry from Address Table: "
                   << cur->first << " --> port" << cur->second.portno << "\n";
                table->erase(cur);
            }
        }
    }
}

void inet::MACAddressTable::removeAgedEntriesFromVlan ( unsigned int  vid = 0 )

overridevirtual

Remove aged entries from a specified VLAN.

Implements inet::IMACAddressTable.

{
    AddressTable *table = getTableForVid(vid);
    if (table == nullptr)
        return;
    // TODO: this part could be factored out
    for (auto iter = table->begin(); iter != table->end(); ) {
        auto cur = iter++;    // iter will get invalidated after erase()
        AddressEntry& entry = cur->second;
        if (entry.insertionTime + agingTime <= simTime()) {
            EV << "Removing aged entry from Address Table: "
               << cur->first << " --> port" << cur->second.portno << "\n";
            table->erase(cur);
        }
    }
}

void inet::MACAddressTable::removeAgedEntriesIfNeeded ( )

overridevirtual

Implements inet::IMACAddressTable.

Referenced by updateTableWithAddress().

{
    simtime_t now = simTime();

    if (now >= lastPurge + 1)
        removeAgedEntriesFromAllVlans();

    lastPurge = simTime();
}

void inet::MACAddressTable::resetDefaultAging ( )

overridevirtual

Implements inet::IMACAddressTable.

{
    agingTime = par("agingTime");
}

void inet::MACAddressTable::setAgingTime ( simtime_t  agingTime )

overridevirtual

Implements inet::IMACAddressTable.

{
    this->agingTime = agingTime;
}

bool inet::MACAddressTable::updateTableWithAddress ( int  portno, MACAddress &  address, unsigned int  vid = 0  )

overridevirtual

Register a new MAC address at AddressTable.

Returns

True if refreshed. False if it is new.

Implements inet::IMACAddressTable.

{
    Enter_Method("MACAddressTable::updateTableWithAddress()");
    if (address.isBroadcast())
        return false;

    AddressTable::iterator iter;
    AddressTable *table = getTableForVid(vid);

    if (table == nullptr) {
        // MAC Address Table does not exist for VLAN ID vid, so we create it
        table = new AddressTable();

        // set 'the addressTable' to VLAN ID 0
        if (vid == 0)
            addressTable = table;

        vlanAddressTable[vid] = table;
        iter = table->end();
    }
    else
        iter = table->find(address);

    if (iter == table->end()) {
        removeAgedEntriesIfNeeded();

        // Add entry to table
        EV << "Adding entry to Address Table: " << address << " --> port" << portno << "\n";
        (*table)[address] = AddressEntry(vid, portno, simTime());
        return false;
    }
    else {
        // Update existing entry
        EV << "Updating entry in Address Table: " << address << " --> port" << portno << "\n";
        AddressEntry& entry = iter->second;
        entry.insertionTime = simTime();
        entry.portno = portno;
    }
    return true;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const AddressEntry &  entry  )

friend

{
    os << "{VID=" << entry.vid << ", port=" << entry.portno << ", insertionTime=" << entry.insertionTime << "}";
    return os;
}

Member Data Documentation

AddressTable* inet::MACAddressTable::addressTable = nullptr

protected

Referenced by clearTable(), getTableForVid(), initialize(), MACAddressTable(), and updateTableWithAddress().

simtime_t inet::MACAddressTable::agingTime

protected

Referenced by getPortForAddress(), initialize(), removeAgedEntriesFromAllVlans(), removeAgedEntriesFromVlan(), resetDefaultAging(), and setAgingTime().

simtime_t inet::MACAddressTable::lastPurge

protected

Referenced by initialize(), and removeAgedEntriesIfNeeded().

VlanAddressTable inet::MACAddressTable::vlanAddressTable

protected

Referenced by clearTable(), copyTable(), flush(), getTableForVid(), MACAddressTable(), printState(), readAddressTable(), removeAgedEntriesFromAllVlans(), updateTableWithAddress(), and ~MACAddressTable().

---

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

• MACAddressTable.h
• MACAddressTable.cc