inet::MACAddress Class Reference

Stores an IEEE 802 MAC address (6 octets = 48 bits). More...

#include <MACAddress.h>

Classes
class	SimulationLifecycleListener

Public Member Functions
	MACAddress ()
	Default constructor initializes address bytes to zero. More...
	MACAddress (uint64 bits)
	Initializes the address from the lower 48 bits of the 64-bit argument. More...
	MACAddress (const char *hexstr)
	Constructor which accepts a hex string (12 hex digits, may also contain spaces, hyphens and colons) More...
	MACAddress (const MACAddress &other)
	Copy constructor. More...
MACAddress &	operator= (const MACAddress &other)
	Assignment. More...
unsigned int	getAddressSize () const
	Returns the address size in bytes, that is, 6. More...
unsigned char	getAddressByte (unsigned int k) const
	Returns the kth byte of the address. More...
void	setAddressByte (unsigned int k, unsigned char addrbyte)
	Sets the kth byte of the address. More...
bool	tryParse (const char *hexstr)
	Sets the address and returns true if the syntax of the string is correct. More...
void	setAddress (const char *hexstr)
	Converts address value from hex string (12 hex digits, may also contain spaces, hyphens and colons) More...
void	getAddressBytes (unsigned char *addrbytes) const
	Copies the address to the given pointer (array of 6 unsigned chars). More...
void	getAddressBytes (char *addrbytes) const
void	setAddressBytes (unsigned char *addrbytes)
	Sets address bytes. More...
void	setAddressBytes (char *addrbytes)
void	setBroadcast ()
	Sets the address to the broadcast address (hex ff:ff:ff:ff:ff:ff). More...
bool	isBroadcast () const
	Returns true if this is the broadcast address (hex ff:ff:ff:ff:ff:ff). More...
bool	isMulticast () const
	Returns true if this is a multicast logical address (first byte's lsb is 1). More...
bool	isUnspecified () const
	Returns true if all address bytes are zero. More...
std::string	str () const
	Converts address to a hex string. More...
uint64	getInt () const
	Converts address to 48 bits integer. More...
bool	equals (const MACAddress &other) const
	Returns true if the two addresses are equal. More...
bool	operator== (const MACAddress &other) const
	Returns true if the two addresses are equal. More...
bool	operator!= (const MACAddress &other) const
	Returns true if the two addresses are not equal. More...
int	compareTo (const MACAddress &other) const
	Returns -1, 0 or 1 as result of comparison of 2 addresses. More...
InterfaceToken	formInterfaceIdentifier () const
	Create interface identifier (IEEE EUI-64) which can be used by IPv6 stateless address autoconfiguration. More...
bool	operator< (const MACAddress &other) const
bool	operator> (const MACAddress &other) const

Static Public Member Functions
static MACAddress	generateAutoAddress ()
	Generates a unique address which begins with 0a:aa and ends in a unique suffix. More...
static MACAddress	makeMulticastAddress (IPv4Address addr)
	Form a MAC address for a multicast IPv4 address, see RFC 1112, section 6.4. More...

Static Public Attributes
static const MACAddress	UNSPECIFIED_ADDRESS
	The unspecified MAC address, 00:00:00:00:00:00. More...
static const MACAddress	BROADCAST_ADDRESS
	The broadcast MAC address, ff:ff:ff:ff:ff:ff. More...
static const MACAddress	MULTICAST_PAUSE_ADDRESS
	The special multicast PAUSE MAC address, 01:80:C2:00:00:01. More...
static const MACAddress	STP_MULTICAST_ADDRESS
	The spanning tree protocol bridge's multicast address, 01:80:C2:00:00:00. More...

Private Attributes
uint64	address

Static Private Attributes
static unsigned int	autoAddressCtr
static bool	simulationLifecycleListenerAdded

Detailed Description

Stores an IEEE 802 MAC address (6 octets = 48 bits).

Constructor & Destructor Documentation

inet::MACAddress::MACAddress ( )

inline

Default constructor initializes address bytes to zero.

{ address = 0; }

inet::MACAddress::MACAddress ( uint64  bits )

inlineexplicit

Initializes the address from the lower 48 bits of the 64-bit argument.

{ address = bits & MAC_ADDRESS_MASK; }

inet::MACAddress::MACAddress ( const char *  hexstr )

inlineexplicit

Constructor which accepts a hex string (12 hex digits, may also contain spaces, hyphens and colons)

{ setAddress(hexstr); }

inet::MACAddress::MACAddress ( const MACAddress &  other )

inline

Copy constructor.

{ address = other.address; }

Member Function Documentation

int inet::MACAddress::compareTo

(

const MACAddress &

other

)

const

Returns -1, 0 or 1 as result of comparison of 2 addresses.

Referenced by inet::STP::compareBridgeIDs(), inet::RSTP::compareRSTPData(), inet::RSTP::handleIncomingFrame(), inet::MACAddressTable::MAC_compare::operator()(), inet::ieee80211::Ieee80211MgmtAP::MAC_compare::operator()(), and inet::RSTP::processBPDU().

{
    return (address < other.address) ? -1 : (address == other.address) ? 0 : 1;    // note: "return address-other.address" is not OK because 64-bit result does not fit into the return type
}

bool inet::MACAddress::equals ( const MACAddress &  other ) const

inline

Returns true if the two addresses are equal.

Referenced by inet::IdealMac::dropFrameNotForUs(), inet::EtherMACBase::dropFrameNotForUs(), inet::EtherMACFullDuplex::processFrameFromUpperLayer(), inet::EtherMAC::processFrameFromUpperLayer(), inet::IPv6NeighbourDiscovery::processNAForOtherNCEStates(), inet::IPv6NeighbourDiscovery::processNSWithSpecifiedSrcAddr(), and inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ return address == other.address; }

InterfaceToken inet::MACAddress::formInterfaceIdentifier

(

)

const

Create interface identifier (IEEE EUI-64) which can be used by IPv6 stateless address autoconfiguration.

Referenced by inet::IdealMac::createInterfaceEntry(), inet::ieee80211::Ieee80211Mac::createInterfaceEntry(), inet::LMacLayer::createInterfaceEntry(), inet::CsmaCaMac::createInterfaceEntry(), inet::BMacLayer::createInterfaceEntry(), inet::EtherMACBase::createInterfaceEntry(), and inet::CSMA::createInterfaceEntry().

{
    uint32 high = ((address >> 16) | 0xff) ^ 0x02000000;
    uint32 low = (0xfe << 24) | (address & 0xffffff);
    return InterfaceToken(low, high, 64);
}

MACAddress inet::MACAddress::generateAutoAddress ( )

static

Generates a unique address which begins with 0a:aa and ends in a unique suffix.

Referenced by inet::ieee80211::Ieee80211Mac::initialize(), inet::CsmaCaMac::initialize(), inet::IdealMac::initializeMACAddress(), inet::LMacLayer::initializeMACAddress(), inet::EtherMACBase::initializeMACAddress(), inet::BMacLayer::initializeMACAddress(), and inet::CSMA::initializeMACAddress().

{
    if (!simulationLifecycleListenerAdded) {
        // NOTE: EXECUTE_ON_STARTUP is too early and would add the listener to StaticEnv
        getEnvir()->addLifecycleListener(new MACAddress::SimulationLifecycleListener());
        simulationLifecycleListenerAdded = true;
    }
    ++autoAddressCtr;

    uint64 intAddr = 0x0AAA00000000ULL + (autoAddressCtr & 0xffffffffUL);
    MACAddress addr(intAddr);
    return addr;
}

unsigned char inet::MACAddress::getAddressByte

(

unsigned int

k

)

const

Returns the kth byte of the address.

Referenced by getAddressBytes(), and str().

{
    if (k >= MAC_ADDRESS_SIZE)
        throw cRuntimeError("Array of size 6 indexed with %d", k);
    int offset = (MAC_ADDRESS_SIZE - k - 1) * 8;
    return 0xff & (address >> offset);
}

void inet::MACAddress::getAddressBytes

(

unsigned char *

addrbytes

)

const

Copies the address to the given pointer (array of 6 unsigned chars).

Referenced by inet::serializer::Buffer::writeMACAddress().

{
    for (int i = 0; i < MAC_ADDRESS_SIZE; i++)
        addrbytes[i] = getAddressByte(i);
}

void inet::MACAddress::getAddressBytes ( char *  addrbytes ) const

inline

Referenced by getAddressBytes().

{ getAddressBytes((unsigned char *)addrbytes); }

unsigned int inet::MACAddress::getAddressSize ( ) const

inline

Returns the address size in bytes, that is, 6.

{ return MAC_ADDRESS_SIZE; }

uint64 inet::MACAddress::getInt ( ) const

inline

Converts address to 48 bits integer.

{ return address; }

bool inet::MACAddress::isBroadcast ( ) const

inline

Returns true if this is the broadcast address (hex ff:ff:ff:ff:ff:ff).

Referenced by inet::IdealMac::dropFrameNotForUs(), inet::EtherMACBase::dropFrameNotForUs(), inet::MACRelayUnit::handleAndDispatchFrame(), inet::Ieee8021dRelay::handleAndDispatchFrame(), inet::CSMA::handleLowerPacket(), inet::BMacLayer::handleSelfMessage(), inet::LMacLayer::handleSelfMessage(), inet::L3Address::isBroadcast(), inet::CsmaCaMac::isBroadcast(), inet::L3Address::isUnicast(), inet::CSMA::updateStatusTransmitFrame(), and inet::MACAddressTable::updateTableWithAddress().

{ return address == MAC_ADDRESS_MASK; }

bool inet::MACAddress::isMulticast ( ) const

inline

Returns true if this is a multicast logical address (first byte's lsb is 1).

Referenced by inet::ieee80211::PendingQueue::cmpMgmtOverMulticastOverUnicast(), inet::ieee80211::OriginatorProtectionMechanism::computeDataFrameDurationField(), inet::ieee80211::SingleProtectionMechanism::computeDataOrMgmtFrameDurationField(), inet::ieee80211::RateSelection::computeDataOrMgmtFrameMode(), inet::ieee80211::QoSRateSelection::computeDataOrMgmtFrameMode(), inet::ieee80211::OriginatorProtectionMechanism::computeMgmtFrameDurationField(), inet::IdealMac::dropFrameNotForUs(), inet::EtherMACBase::dropFrameNotForUs(), inet::ieee80211::QoSSequenceNumberAssignment::getCacheType(), inet::ieee80211::Ieee80211MgmtAP::handleDataFrame(), inet::ieee80211::Ieee80211MgmtAP::handleUpperMessage(), inet::ieee80211::HcfFs::hasMoreTxOpsAndMulticast(), inet::ieee80211::RecipientAckPolicy::isAckNeeded(), inet::ieee80211::RecipientQoSAckPolicy::isAckNeeded(), inet::ieee80211::OriginatorQoSAckPolicy::isAckNeeded(), inet::ieee80211::DcfFs::isBroadcastManagementOrGroupDataSequenceNeeded(), inet::ieee80211::FrameSequenceContext::isForUs(), inet::ieee80211::Dcf::isForUs(), inet::ieee80211::Hcf::isForUs(), inet::L3Address::isMulticast(), inet::ieee80211::RtsPolicy::isRtsNeeded(), inet::ieee80211::QoSRtsPolicy::isRtsNeeded(), inet::L3Address::isUnicast(), inet::ieee80211::Hcf::originatorProcessTransmittedFrame(), and inet::ieee80211::HcfFs::selectHcfSequence().

{ return getAddressByte(0) & 0x01; };

bool inet::MACAddress::isUnspecified ( ) const

inline

Returns true if all address bytes are zero.

Referenced by inet::ieee80211::Ieee80211MgmtAPBase::distributeReceivedDataFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::encapsulate(), inet::L3AddressResolver::getInterfaceMACAddress(), inet::GlobalARP::getL3AddressFor(), inet::ARP::getL3AddressFor(), inet::WiseRoute::handleLowerPacket(), inet::EtherTrafGen::handleMessage(), inet::EtherAppCli::handleMessage(), inet::EtherEncap::handleSendPause(), inet::EtherLLC::handleSendPause(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleUpperMessage(), inet::CsmaCaMac::handleUpperPacket(), inet::WiseRoute::handleUpperPacket(), inet::EthernetApplication::initialize(), inet::L3Address::isUnspecified(), inet::ARP::processARPPacket(), inet::ieee80211::Ieee80211AgentSTA::processAssociateConfirm(), inet::EtherMACFullDuplex::processFrameFromUpperLayer(), inet::EtherMAC::processFrameFromUpperLayer(), inet::IPv6NeighbourDiscovery::processNAForIncompleteNCEState(), inet::IPv6NeighbourDiscovery::processNAForOtherNCEStates(), inet::IPv6NeighbourDiscovery::processNSWithSpecifiedSrcAddr(), inet::IPv6NeighbourDiscovery::processRAForRouterUpdates(), inet::ieee80211::Ieee80211MgmtSTA::processScanCommand(), inet::ieee80211::Ieee80211Mac::processUpperFrame(), inet::IPv6::resolveMACAddressAndSendPacket(), inet::ARP::sendARPRequest(), inet::IPv6::sendDatagramToOutput(), inet::IPv4::sendDatagramToOutput(), inet::IPv6NeighbourDiscovery::sendSolicitedNA(), inet::EtherMACFullDuplex::startFrameTransmission(), inet::EtherMAC::startFrameTransmission(), inet::IPv6NeighbourDiscovery::validateNSPacket(), and inet::IPv6NeighbourDiscovery::validateRSPacket().

{ return address == 0; }

MACAddress inet::MACAddress::makeMulticastAddress ( IPv4Address  addr )

static

Form a MAC address for a multicast IPv4 address, see RFC 1112, section 6.4.

Referenced by inet::IPv4::resolveNextHopMacAddress().

{
    ASSERT(addr.isMulticast());

    MACAddress macAddr;
    macAddr.setAddressByte(0, 0x01);
    macAddr.setAddressByte(1, 0x00);
    macAddr.setAddressByte(2, 0x5e);
    macAddr.setAddressByte(3, addr.getDByte(1) & 0x7f);
    macAddr.setAddressByte(4, addr.getDByte(2));
    macAddr.setAddressByte(5, addr.getDByte(3));
    return macAddr;
}

bool inet::MACAddress::operator!= ( const MACAddress &  other ) const

inline

Returns true if the two addresses are not equal.

{ return address != other.address; }

bool inet::MACAddress::operator< ( const MACAddress &  other ) const

inline

{ return address < other.address; }

MACAddress& inet::MACAddress::operator= ( const MACAddress &  other )

inline

Assignment.

{ address = other.address; return *this; }

bool inet::MACAddress::operator== ( const MACAddress &  other ) const

inline

Returns true if the two addresses are equal.

{ return address == other.address; }

bool inet::MACAddress::operator> ( const MACAddress &  other ) const

inline

{ return address > other.address; }

void inet::MACAddress::setAddress

(

const char *

hexstr

)

Converts address value from hex string (12 hex digits, may also contain spaces, hyphens and colons)

Referenced by inet::ieee80211::Ieee80211MgmtSTASimplified::initialize(), inet::ieee80211::Ieee80211MgmtBase::initialize(), inet::ieee80211::Ieee80211Mac::initialize(), inet::CsmaCaMac::initialize(), inet::IdealMac::initializeMACAddress(), inet::LMacLayer::initializeMACAddress(), inet::EtherMACBase::initializeMACAddress(), inet::BMacLayer::initializeMACAddress(), inet::CSMA::initializeMACAddress(), inet::EthernetApplication::resolveDestMACAddress(), inet::EtherTrafGen::resolveDestMACAddress(), and inet::EtherAppCli::resolveDestMACAddress().

{
    if (!tryParse(hexstr))
        throw cRuntimeError("MACAddress: wrong address syntax '%s': 12 hex digits expected, with optional embedded spaces, hyphens or colons", hexstr);
}

void inet::MACAddress::setAddressByte	(	unsigned int	k,
		unsigned char	addrbyte
	)

Sets the kth byte of the address.

Referenced by makeMulticastAddress(), inet::GenericARP::mapMulticastAddress(), inet::serializer::Buffer::readMACAddress(), setAddressBytes(), and tryParse().

{
    if (k >= MAC_ADDRESS_SIZE)
        throw cRuntimeError("Array of size 6 indexed with %d", k);
    int offset = (MAC_ADDRESS_SIZE - k - 1) * 8;
    address = (address & (~(((uint64)0xff) << offset))) | (((uint64)addrbyte) << offset);
}

void inet::MACAddress::setAddressBytes

(

unsigned char *

addrbytes

)

Sets address bytes.

The argument should point to an array of 6 unsigned chars.

{
    address = 0;    // clear top 16 bits too that setAddressByte() calls skip
    for (int i = 0; i < MAC_ADDRESS_SIZE; i++)
        setAddressByte(i, addrbytes[i]);
}

void inet::MACAddress::setAddressBytes ( char *  addrbytes )

inline

Referenced by setAddressBytes().

{ setAddressBytes((unsigned char *)addrbytes); }

void inet::MACAddress::setBroadcast ( )

inline

Sets the address to the broadcast address (hex ff:ff:ff:ff:ff:ff).

{ address = MAC_ADDRESS_MASK; }

std::string inet::MACAddress::str

(

)

const

Converts address to a hex string.

Referenced by inet::InetPacketPrinter2::formatARPPacket(), inet::ieee80211::Ieee80211MgmtSTA::handleAssociationResponseFrame(), inet::CsmaCaMac::initialize(), inet::IdealMac::initializeMACAddress(), inet::LMacLayer::initializeMACAddress(), inet::EtherMACBase::initializeMACAddress(), inet::BMacLayer::initializeMACAddress(), inet::CSMA::initializeMACAddress(), inet::operator<<(), inet::RSTP::printState(), inet::ieee80211::Ieee80211MgmtSTA::processAssociateCommand(), inet::ieee80211::Ieee80211MgmtSTA::processAuthenticateCommand(), inet::ieee80211::Ieee80211MgmtSTA::processDeauthenticateCommand(), inet::EtherMACFullDuplex::processFrameFromUpperLayer(), inet::EtherMAC::processFrameFromUpperLayer(), inet::IPv6NeighbourDiscovery::processNUDTimeout(), inet::ieee80211::Ieee80211MgmtSTA::startAssociation(), inet::ieee80211::Ieee80211MgmtSTA::startAuthentication(), and inet::L3Address::str().

{
    char buf[20];
    char *s = buf;
    for (int i = 0; i < MAC_ADDRESS_SIZE; i++, s += 3)
        sprintf(s, "%2.2X-", getAddressByte(i));
    *(s - 1) = '\0';
    return std::string(buf);
}

bool inet::MACAddress::tryParse

(

const char *

hexstr

)

Sets the address and returns true if the syntax of the string is correct.

(See setAddress() for the syntax.)

Referenced by inet::EthernetApplication::resolveDestMACAddress(), inet::EtherTrafGen::resolveDestMACAddress(), inet::EtherAppCli::resolveDestMACAddress(), setAddress(), and inet::L3Address::tryParse().

{
    if (!hexstr)
        return false;

    // check syntax
    int numHexDigits = 0;
    for (const char *s = hexstr; *s; s++) {
        if (isxdigit(*s))
            numHexDigits++;
        else if (*s != ' ' && *s != ':' && *s != '-')
            return false; // wrong syntax
    }
    if (numHexDigits != 2 * MAC_ADDRESS_SIZE)
        return false;

    // Converts hex string into the address
    // if hext string is shorter, address is filled with zeros;
    // Non-hex characters are discarded before conversion.
    address = 0;    // clear top 16 bits too that setAddressByte() calls skip
    int k = 0;
    const char *s = hexstr;
    for (int pos = 0; pos < MAC_ADDRESS_SIZE; pos++) {
        if (!s || !*s) {
            setAddressByte(pos, 0);
        }
        else {
            while (*s && !isxdigit(*s))
                s++;
            if (!*s) {
                setAddressByte(pos, 0);
                continue;
            }
            unsigned char d = isdigit(*s) ? (*s - '0') : islower(*s) ? (*s - 'a' + 10) : (*s - 'A' + 10);
            d = d << 4;
            s++;

            while (*s && !isxdigit(*s))
                s++;
            if (!*s) {
                setAddressByte(pos, 0);
                continue;
            }
            d += isdigit(*s) ? (*s - '0') : islower(*s) ? (*s - 'a' + 10) : (*s - 'A' + 10);
            s++;

            setAddressByte(pos, d);
            k++;
        }
    }
    return true;
}

Member Data Documentation

uint64 inet::MACAddress::address

private

Referenced by compareTo(), equals(), formInterfaceIdentifier(), getAddressByte(), inet::ieee80211::Ieee80211MgmtSTA::handleBeaconFrame(), inet::ieee80211::Ieee80211MgmtSTA::handleDisassociationFrame(), MACAddress(), operator!=(), operator<(), operator=(), operator==(), operator>(), inet::ieee80211::Ieee80211MgmtSTA::processDisassociateCommand(), setAddressByte(), setAddressBytes(), and tryParse().

unsigned int inet::MACAddress::autoAddressCtr

staticprivate

Referenced by generateAutoAddress().

const MACAddress inet::MACAddress::BROADCAST_ADDRESS

static

The broadcast MAC address, ff:ff:ff:ff:ff:ff.

Referenced by inet::IPv6::datagramLocalOut(), inet::ProbabilisticBroadcast::encapsMsg(), inet::Flood::encapsMsg(), inet::MACAddressType::getBroadcastAddress(), inet::ProbabilisticBroadcast::handleLowerPacket(), inet::Flood::handleLowerPacket(), inet::WiseRoute::handleLowerPacket(), inet::BMacLayer::handleSelfMessage(), inet::ProbabilisticBroadcast::handleSelfMessage(), inet::WiseRoute::handleSelfMessage(), inet::WiseRoute::handleUpperPacket(), inet::BMacLayer::initialize(), inet::ieee80211::Ieee80211MgmtSTA::processScanCommand(), inet::GenericARP::resolveL3Address(), inet::IPv4::resolveNextHopMacAddress(), inet::IPv6::routeMulticastPacket(), inet::ARP::sendARPRequest(), inet::ieee80211::Ieee80211MgmtAP::sendBeacon(), and inet::BMacLayer::sendPreamble().

const MACAddress inet::MACAddress::MULTICAST_PAUSE_ADDRESS

static

The special multicast PAUSE MAC address, 01:80:C2:00:00:01.

Referenced by inet::EtherMACBase::dropFrameNotForUs(), inet::EtherEncap::handleSendPause(), and inet::EtherLLC::handleSendPause().

bool inet::MACAddress::simulationLifecycleListenerAdded

staticprivate

Referenced by generateAutoAddress().

const MACAddress inet::MACAddress::STP_MULTICAST_ADDRESS

static

The spanning tree protocol bridge's multicast address, 01:80:C2:00:00:00.

Referenced by inet::STP::generateTCN(), inet::Ieee8021dRelay::handleAndDispatchFrame(), inet::STP::handleBPDU(), inet::STP::numInitStages(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

const MACAddress inet::MACAddress::UNSPECIFIED_ADDRESS

static

The unspecified MAC address, 00:00:00:00:00:00.

Referenced by inet::ieee80211::OriginatorQoSAckPolicy::computeBlockAckReqParameters(), inet::MACAddressType::getLinkLocalAddress(), inet::MACAddressType::getUnspecifiedAddress(), inet::ARP::initiateARPResolution(), inet::ieee80211::Ieee80211Mac::isInterfaceRegistered(), inet::IPv6NeighbourDiscovery::processIPv6Datagram(), inet::ARP::requestTimedOut(), inet::GlobalARP::resolveL3Address(), inet::ARP::resolveL3Address(), inet::IPv6NeighbourDiscovery::resolveNeighbour(), and inet::GenericNetworkProtocol::sendDatagramToOutput().

---

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

• MACAddress.h
• MACAddress.cc