Interface MAC plugin for HWMP – 802.11s routing protocol. More...

#include "hwmp-protocol-mac.h"

Inheritance diagram for ns3::dot11s::HwmpProtocolMac:

Collaboration diagram for ns3::dot11s::HwmpProtocolMac:

Classes
struct	MyPerr
	MyPerr structure. More...

struct	Statistics
	Statistics structure. More...

Public Member Functions
	HwmpProtocolMac (uint32_t ifIndex, Ptr< HwmpProtocol > protocol)
	Constructor. More...

	~HwmpProtocolMac () override

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. More...

bool	Receive (Ptr< Packet > packet, const WifiMacHeader &header) override
	Process received frame. More...

void	SetParent (Ptr< MeshWifiInterfaceMac > parent) override
	Each plugin must be installed on an interface to work. More...

void	UpdateBeacon (MeshWifiBeacon &beacon) const override
	Update beacon before it will be formed and sent. More...

bool	UpdateOutcomingFrame (Ptr< Packet > packet, WifiMacHeader &header, Mac48Address from, Mac48Address to) override
	Update frame before it will be forwarded down. More...

Public Member Functions inherited from ns3::MeshWifiInterfaceMacPlugin
virtual	~MeshWifiInterfaceMacPlugin ()
	This is for subclasses. More...

Public Member Functions inherited from ns3::SimpleRefCount< MeshWifiInterfaceMacPlugin >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Private Member Functions
uint16_t	GetChannelId () const
	Get the channel ID. More...

uint32_t	GetLinkMetric (Mac48Address peerAddress) const

bool	ReceiveAction (Ptr< Packet > packet, const WifiMacHeader &header)
	Receive action management frame. More...

bool	ReceiveData (Ptr< Packet > packet, const WifiMacHeader &header)
	Receive data frame. More...

void	Report (std::ostream &os) const
	Report statistics. More...

void	ResetStats ()
	Reset statistics. More...

void	SendMyPerr ()
	Send PERR function. More...

void	SendMyPreq ()
	Sends one PREQ when PreqMinInterval after last PREQ expires (if any PREQ exists in rhe queue) More...

Interaction with HWMP:
void	SendPreq (IePreq preq)
	Send PREQ function. More...

void	SendPreqVector (std::vector< IePreq > preq)
	Send PREQ function for vector of PREQ. More...

void	SendPrep (IePrep prep, Mac48Address receiver)
	Send PREP function. More...

void	ForwardPerr (std::vector< HwmpProtocol::FailedDestination > destinations, std::vector< Mac48Address > receivers)
	Forward a path error. More...

void	InitiatePerr (std::vector< HwmpProtocol::FailedDestination > destinations, std::vector< Mac48Address > receivers)
	initiate my own path error More...

void	RequestDestination (Mac48Address dest, uint32_t originator_seqno, uint32_t dst_seqno)
	Request a destination. More...

Static Private Member Functions
static WifiActionHeader	GetWifiActionHeader ()

Private Attributes
uint32_t	m_ifIndex
	IF index. More...

Ptr< MeshWifiInterfaceMac >	m_parent
	parent More...

Ptr< HwmpProtocol >	m_protocol
	protocol More...

my PREQ and PREQ timer:
EventId	m_preqTimer
	Timer for PREQs. More...

std::vector< IePreq >	m_myPreq
	container of PREQs More...

PERR timer and stored path error
EventId	m_perrTimer
	PERR. More...

MyPerr	m_myPerr
	PERR. More...

Statistics
Statistics	m_stats
	statistics More...

Friends
class	HwmpProtocol
	allow HwmpProtocol class friend access More...

Detailed Description

Interface MAC plugin for HWMP – 802.11s routing protocol.

Definition at line 45 of file hwmp-protocol-mac.h.

Constructor & Destructor Documentation

◆ HwmpProtocolMac()

ns3::dot11s::HwmpProtocolMac::HwmpProtocolMac	(	uint32_t	ifIndex,
		Ptr< HwmpProtocol >	protocol
	)

Constructor.

Parameters

ifIndex	interface index
protocol	pointer to HWMP protocol instance

Definition at line 45 of file hwmp-protocol-mac.cc.

References NS_LOG_FUNCTION.

◆ ~HwmpProtocolMac()

ns3::dot11s::HwmpProtocolMac::~HwmpProtocolMac ( )

override

Definition at line 52 of file hwmp-protocol-mac.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::dot11s::HwmpProtocolMac::AssignStreams ( int64_t stream )

overridevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 548 of file hwmp-protocol-mac.cc.

References m_protocol.

◆ ForwardPerr()

void ns3::dot11s::HwmpProtocolMac::ForwardPerr	(	std::vector< HwmpProtocol::FailedDestination >	destinations,
		std::vector< Mac48Address >	receivers
	)

private

Forward a path error.

Parameters

destinations	vector of failed destinations
receivers	vector of receivers

Definition at line 366 of file hwmp-protocol-mac.cc.

References ns3::Packet::AddHeader(), ns3::MeshInformationElementVector::AddInformationElement(), first::address, ns3::Mac48Address::GetBroadcast(), ns3::Packet::GetSize(), GetWifiActionHeader(), m_parent, m_protocol, m_stats, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetType(), ns3::dot11s::HwmpProtocolMac::Statistics::txMgt, ns3::dot11s::HwmpProtocolMac::Statistics::txMgtBytes, ns3::dot11s::HwmpProtocolMac::Statistics::txPerr, and ns3::WIFI_MAC_MGT_ACTION.

Referenced by ns3::dot11s::HwmpProtocol::ForwardPathError(), and SendMyPerr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannelId()

uint16_t ns3::dot11s::HwmpProtocolMac::GetChannelId ( ) const

private

Get the channel ID.

Returns: the channel ID

Definition at line 487 of file hwmp-protocol-mac.cc.

References m_parent.

◆ GetLinkMetric()

uint32_t ns3::dot11s::HwmpProtocolMac::GetLinkMetric ( Mac48Address peerAddress ) const

private

Parameters

peerAddress peer address

Returns: metric to HWMP protocol, needed only by metrics to add peer as routing entry

Definition at line 481 of file hwmp-protocol-mac.cc.

References m_parent.

◆ GetWifiActionHeader()

WifiActionHeader ns3::dot11s::HwmpProtocolMac::GetWifiActionHeader ( )

staticprivate

Returns: a path selection action header

Definition at line 240 of file hwmp-protocol-mac.cc.

References check-style-clang-format::action, ns3::WifiActionHeader::MESH, ns3::WifiActionHeader::PATH_SELECTION, and ns3::WifiActionHeader::SetAction().

Referenced by ForwardPerr(), SendPrep(), and SendPreqVector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitiatePerr()

void ns3::dot11s::HwmpProtocolMac::InitiatePerr	(	std::vector< HwmpProtocol::FailedDestination >	destinations,
		std::vector< Mac48Address >	receivers
	)

private

initiate my own path error

Parameters

destinations	vector of failed destinations
receivers	vector of receivers

Definition at line 420 of file hwmp-protocol-mac.cc.

References ns3::dot11s::HwmpProtocolMac::MyPerr::destinations, m_myPerr, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::dot11s::HwmpProtocolMac::MyPerr::receivers, and SendMyPerr().

Here is the call graph for this function:

◆ Receive()

bool ns3::dot11s::HwmpProtocolMac::Receive	(	Ptr< Packet >	packet,
		const WifiMacHeader &	header
	)

overridevirtual

Process received frame.

Parameters

packet
header

Returns: false if (and only if) frame should be dropped

Todo:: define when MAC call this

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 191 of file hwmp-protocol-mac.cc.

References ns3::WifiMacHeader::IsAction(), ns3::WifiMacHeader::IsData(), NS_LOG_FUNCTION, ReceiveAction(), and ReceiveData().

Here is the call graph for this function:

◆ ReceiveAction()

bool ns3::dot11s::HwmpProtocolMac::ReceiveAction	(	Ptr< Packet >	packet,
		const WifiMacHeader &	header
	)

private

Receive action management frame.

Parameters

packet
header

Returns: true if a packet was received

Definition at line 108 of file hwmp-protocol-mac.cc.

References ns3::MeshInformationElementVector::Begin(), ns3::MeshInformationElementVector::End(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetAddr3(), ns3::WifiActionHeader::GetCategory(), ns3::Packet::GetSize(), IE_PERR, IE_PREP, IE_PREQ, IE_RANN, m_ifIndex, m_parent, m_protocol, m_stats, ns3::WifiActionHeader::MESH, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_WARN, ns3::Packet::RemoveHeader(), ns3::dot11s::HwmpProtocolMac::Statistics::rxMgt, ns3::dot11s::HwmpProtocolMac::Statistics::rxMgtBytes, ns3::dot11s::HwmpProtocolMac::Statistics::rxPerr, ns3::dot11s::HwmpProtocolMac::Statistics::rxPrep, and ns3::dot11s::HwmpProtocolMac::Statistics::rxPreq.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReceiveData()

bool ns3::dot11s::HwmpProtocolMac::ReceiveData	(	Ptr< Packet >	packet,
		const WifiMacHeader &	header
	)

private

Receive data frame.

Parameters

packet
header

Returns: true if a packet was received

Todo:: address extension

Definition at line 64 of file hwmp-protocol-mac.cc.

References ns3::Packet::AddPacketTag(), ns3::WifiMacHeader::GetAddr3(), ns3::WifiMacHeader::GetAddr4(), ns3::dot11s::MeshHeader::GetAddressExt(), ns3::Mac48Address::GetBroadcast(), ns3::dot11s::MeshHeader::GetMeshSeqno(), ns3::dot11s::MeshHeader::GetMeshTtl(), ns3::Packet::GetSize(), ns3::WifiMacHeader::IsData(), m_protocol, m_stats, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Packet::PeekPacketTag(), ns3::Packet::RemoveHeader(), ns3::dot11s::HwmpProtocolMac::Statistics::rxData, ns3::dot11s::HwmpProtocolMac::Statistics::rxDataBytes, ns3::dot11s::HwmpTag::SetSeqno(), and ns3::dot11s::HwmpTag::SetTtl().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Report()

void ns3::dot11s::HwmpProtocolMac::Report ( std::ostream & os ) const

private

Report statistics.

Parameters

os	The output stream on which to report

Definition at line 532 of file hwmp-protocol-mac.cc.

References m_parent, m_stats, and ns3::dot11s::HwmpProtocolMac::Statistics::Print().

Here is the call graph for this function:

◆ RequestDestination()

void ns3::dot11s::HwmpProtocolMac::RequestDestination	(	Mac48Address	dest,
		uint32_t	originator_seqno,
		uint32_t	dst_seqno
	)

private

Request a destination.

If cannot send PREQ immediately, add a destination to existing PREQ generated by me and stored in PREQ queue

Parameters

dest	is the destination to be resolved
originator_seqno	is a sequence number that shall be preq originator sequenece number
dst_seqno	is a sequence number taken from routing table

Definition at line 290 of file hwmp-protocol-mac.cc.

References ns3::dot11s::IePreq::AddDestinationAddressElement(), m_myPreq, m_protocol, NS_ASSERT, NS_LOG_FUNCTION, SendMyPreq(), ns3::dot11s::IePreq::SetHopcount(), ns3::dot11s::IePreq::SetLifetime(), ns3::dot11s::IePreq::SetOriginatorAddress(), ns3::dot11s::IePreq::SetOriginatorSeqNumber(), ns3::dot11s::IePreq::SetPreqID(), and ns3::dot11s::IePreq::SetTTL().