A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::dot11s::HwmpProtocol Class Reference

Hybrid wireless mesh protocol – a routing protocol of IEEE 802.11s draft. More...

#include <hwmp-protocol.h>

+ Inheritance diagram for ns3::dot11s::HwmpProtocol:

Classes

struct  FailedDestination
 structure of unreachable destination - address and sequence number More...
 
struct  PathError
 Structure of path error: IePerr and list of receivers: interfaces and MAC address. More...
 
struct  PreqEvent
 
struct  QueuedPacket
 Packet waiting its routing information. More...
 
struct  Statistics
 

Public Member Functions

int64_t AssignStreams (int64_t stream)
 
void DoDispose ()
 
bool Install (Ptr< MeshPointDevice >)
 Install HWMP on given mesh point. More...
 
void PeerLinkStatus (Mac48Address meshPontAddress, Mac48Address peerAddress, uint32_t interface, bool status)
 
bool RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)
 Cleanup packet from all tags.
 
void Report (std::ostream &) const
 Statistics:
 
bool RequestRoute (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination, Ptr< const Packet > packet, uint16_t protocolType, RouteReplyCallback routeReply)
 Route request, inherited from MeshL2RoutingProtocol.
 
void ResetStats ()
 
void SetNeighboursCallback (Callback< std::vector< Mac48Address >, uint32_t > cb)
 This callback is used to obtain active neighbours on a given interface. More...
 
Proactive PREQ mechanism:
void SetRoot ()
 
void UnsetRoot ()
 
- Public Member Functions inherited from ns3::MeshL2RoutingProtocol
virtual ~MeshL2RoutingProtocol ()
 virtual D-tor for subclasses
 
Ptr< MeshPointDeviceGetMeshPoint () const
 Each mesh protocol must be installed on the mesh point to work.
 
void SetMeshPoint (Ptr< MeshPointDevice > mp)
 Set host mesh point, analog of SetNode (...) methods for upper layer protocols.
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::MeshL2RoutingProtocol
static TypeId GetTypeId ()
 Never forget to support NS3 object model.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Types

typedef std::map< uint32_t,
Ptr< HwmpProtocolMac > > 
HwmpProtocolMacMap
 

Private Member Functions

 HwmpProtocol (const HwmpProtocol &)
 
virtual void DoInitialize ()
 
bool ForwardUnicast (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t protocolType, RouteReplyCallback routeReply, uint32_t ttl)
 Like RequestRoute, but for unicast packets.
 
Mac48Address GetAddress ()
 
HwmpProtocoloperator= (const HwmpProtocol &)
 
Interaction with HWMP MAC plugin
void ReceivePreq (IePreq preq, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric)
 
void ReceivePrep (IePrep prep, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric)
 
void ReceivePerr (std::vector< FailedDestination >, Mac48Address from, uint32_t interface, Mac48Address fromMp)
 
void SendPrep (Mac48Address src, Mac48Address dst, Mac48Address retransmitter, uint32_t initMetric, uint32_t originatorDsn, uint32_t destinationSN, uint32_t lifetime, uint32_t interface)
 
PathError MakePathError (std::vector< FailedDestination > destinations)
 forms a path error information element when list of destination fails on a given interface More...
 
void ForwardPathError (PathError perr)
 Forwards a received path error.
 
void InitiatePathError (PathError perr)
 Passes a self-generated PERR to interface-plugin.
 
std::vector< std::pair
< uint32_t, Mac48Address > > 
GetPerrReceivers (std::vector< FailedDestination > failedDest)
 
std::vector< Mac48AddressGetPreqReceivers (uint32_t interface)
 
std::vector< Mac48AddressGetBroadcastReceivers (uint32_t interface)
 
bool DropDataFrame (uint32_t seqno, Mac48Address source)
 MAC-plugin asks whether the frame can be dropped. Protocol automatically updates seqno. More...
 
Methods related to Queue/Dequeue procedures
bool QueuePacket (QueuedPacket packet)
 
QueuedPacket DequeueFirstPacketByDst (Mac48Address dst)
 
QueuedPacket DequeueFirstPacket ()
 
void ReactivePathResolved (Mac48Address dst)
 
void ProactivePathResolved ()
 
Methods responsible for path discovery retry procedure:
bool ShouldSendPreq (Mac48Address dst)
 checks when the last path discovery procedure was started for a given destination. More...
 
void RetryPathDiscovery (Mac48Address dst, uint8_t numOfRetry)
 Generates PREQ retry when retry timeout has expired and route is still unresolved. More...
 
void SendProactivePreq ()
 Proactive Preq routines:
 
Methods needed by HwmpMacLugin to access protocol parameters:
bool GetDoFlag ()
 
bool GetRfFlag ()
 
Time GetPreqMinInterval ()
 
Time GetPerrMinInterval ()
 
uint8_t GetMaxTtl ()
 
uint32_t GetNextPreqId ()
 
uint32_t GetNextHwmpSeqno ()
 
uint32_t GetActivePathLifetime ()
 
uint8_t GetUnicastPerrThreshold ()
 

Private Attributes

Mac48Address m_address
 
Ptr< UniformRandomVariablem_coefficient
 
uint32_t m_dataSeqno
 
uint32_t m_hwmpSeqno
 
HwmpProtocolMacMap m_interfaces
 
Callback< std::vector
< Mac48Address >, uint32_t > 
m_neighboursCallback
 
uint32_t m_preqId
 
TracedCallback< Timem_routeDiscoveryTimeCallback
 Route discovery time:
 
std::vector< QueuedPacketm_rqueue
 
Ptr< HwmpRtablem_rtable
 Routing table.
 
Statistics:
Statistics m_stats
 
Sequence number filters

Data sequence number database

std::map< Mac48Address, uint32_t > m_lastDataSeqno
 
std::map< Mac48Address,
std::pair< uint32_t, uint32_t > > 
m_hwmpSeqnoMetricDatabase
 keeps HWMP seqno (first in pair) and HWMP metric (second in pair) for each address
 
Timers:
std::map< Mac48Address, PreqEventm_preqTimeouts
 
EventId m_proactivePreqTimer
 
Time m_randomStart
 Random start in Proactive PREQ propagation.
 
HWMP-protocol parameters (attributes of GetTypeId)
uint16_t m_maxQueueSize
 
uint8_t m_dot11MeshHWMPmaxPREQretries
 
Time m_dot11MeshHWMPnetDiameterTraversalTime
 
Time m_dot11MeshHWMPpreqMinInterval
 
Time m_dot11MeshHWMPperrMinInterval
 
Time m_dot11MeshHWMPactiveRootTimeout
 
Time m_dot11MeshHWMPactivePathTimeout
 
Time m_dot11MeshHWMPpathToRootInterval
 
Time m_dot11MeshHWMPrannInterval
 
bool m_isRoot
 
uint8_t m_maxTtl
 
uint8_t m_unicastPerrThreshold
 
uint8_t m_unicastPreqThreshold
 
uint8_t m_unicastDataThreshold
 
bool m_doFlag
 
bool m_rfFlag
 

Friends

class HwmpProtocolMac
 

Additional Inherited Members

- Public Types inherited from ns3::MeshL2RoutingProtocol
typedef Callback< void, bool,
Ptr< Packet >, Mac48Address,
Mac48Address, uint16_t,
uint32_t > 
RouteReplyCallback
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 
- Protected Attributes inherited from ns3::MeshL2RoutingProtocol
Ptr< MeshPointDevicem_mp
 Host mesh point.
 

Detailed Description

Hybrid wireless mesh protocol – a routing protocol of IEEE 802.11s draft.

Config Paths

ns3::dot11s::HwmpProtocol is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol

Attributes

  • RandomStart: Random delay at first proactive PREQ
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +100000000.0ns
    • Flags: construct write read
  • MaxQueueSize: Maximum number of packets we can store when resolving route
  • Dot11MeshHWMPmaxPREQretries: Maximum number of retries before we suppose the destination to be unreachable
  • Dot11MeshHWMPnetDiameterTraversalTime: Time we suppose the packet to go from one edge of the network to another
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPpreqMinInterval: Minimal interval between to successive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPperrMinInterval: Minimal interval between to successive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPactiveRootTimeout: Lifetime of poractive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPactivePathTimeout: Lifetime of reactive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPpathToRootInterval: Interval between two successive proactive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +2048000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPrannInterval: Lifetime of poractive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • MaxTtl: Initial value of Time To Live field
  • UnicastPerrThreshold: Maximum number of PERR receivers, when we send a PERR as a chain of unicasts
  • UnicastPreqThreshold: Maximum number of PREQ receivers, when we send a PREQ as a chain of unicasts
  • UnicastDataThreshold: Maximum number ofbroadcast receivers, when we send a broadcast as a chain of unicasts
  • DoFlag: Destination only HWMP flag
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • RfFlag: Reply and forward flag
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources

  • RouteDiscoveryTime: The time of route discovery procedure

Definition at line 47 of file hwmp-protocol.h.

Member Function Documentation

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

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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 1173 of file hwmp-protocol.cc.

References m_coefficient, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

void ns3::dot11s::HwmpProtocol::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 214 of file hwmp-protocol.cc.

References NS_LOG_FUNCTION_NOARGS.

void ns3::dot11s::HwmpProtocol::DoInitialize ( void  )
privatevirtual

This method is called only once by Object::Initialize. If the user calls Object::Initialize multiple times, DoInitialize is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::Object.

Definition at line 204 of file hwmp-protocol.cc.

bool ns3::dot11s::HwmpProtocol::DropDataFrame ( uint32_t  seqno,
Mac48Address  source 
)
private

MAC-plugin asks whether the frame can be dropped. Protocol automatically updates seqno.

Returns
true if frame can be dropped
Parameters
seqnois the sequence number of source
sourceis the source address

Definition at line 743 of file hwmp-protocol.cc.

Mac48Address ns3::dot11s::HwmpProtocol::GetAddress ( void  )
private
Returns
address of MeshPointDevice

Definition at line 1104 of file hwmp-protocol.cc.

std::vector< Mac48Address > ns3::dot11s::HwmpProtocol::GetBroadcastReceivers ( uint32_t  interface)
private
Returns
list of addresses where a broadcast should be

Definition at line 858 of file hwmp-protocol.cc.

References ns3::Mac48Address::GetBroadcast().

std::vector< std::pair< uint32_t, Mac48Address > > ns3::dot11s::HwmpProtocol::GetPerrReceivers ( std::vector< FailedDestination failedDest)
private
Returns
list of addresses where a PERR should be sent to

Definition at line 816 of file hwmp-protocol.cc.

std::vector< Mac48Address > ns3::dot11s::HwmpProtocol::GetPreqReceivers ( uint32_t  interface)
private
Returns
list of addresses where a PERR should be sent to

Definition at line 843 of file hwmp-protocol.cc.

References ns3::Mac48Address::GetBroadcast().

bool ns3::dot11s::HwmpProtocol::Install ( Ptr< MeshPointDevice mp)

Install HWMP on given mesh point.

Installing protocol cause installing its interface MAC plugins.

Also MP aggregates all installed protocols, HWMP protocol can be accessed via MeshPointDevice::GetObject<dot11s::HwmpProtocol>();

Definition at line 696 of file hwmp-protocol.cc.

References ns3::Mac48Address::ConvertFrom(), and ns3::MakeCallback().

HwmpProtocol::PathError ns3::dot11s::HwmpProtocol::MakePathError ( std::vector< FailedDestination destinations)
private

forms a path error information element when list of destination fails on a given interface

Attention
removes all entries from routing table!

Definition at line 765 of file hwmp-protocol.cc.

References ns3::dot11s::HwmpProtocol::PathError::destinations, and ns3::dot11s::HwmpProtocol::PathError::receivers.

void ns3::dot11s::HwmpProtocol::RetryPathDiscovery ( Mac48Address  dst,
uint8_t  numOfRetry 
)
private
void ns3::dot11s::HwmpProtocol::SetNeighboursCallback ( Callback< std::vector< Mac48Address >, uint32_t >  cb)

This callback is used to obtain active neighbours on a given interface.

Parameters
cbis a callback, which returns a list of addresses on given interface (uint32_t)

Definition at line 738 of file hwmp-protocol.cc.

bool ns3::dot11s::HwmpProtocol::ShouldSendPreq ( Mac48Address  dst)
private

checks when the last path discovery procedure was started for a given destination.

If the retry counter has not achieved the maximum level - preq should not be sent

Definition at line 967 of file hwmp-protocol.cc.

References ns3::Simulator::Now(), RetryPathDiscovery(), and ns3::Simulator::Schedule().

Member Data Documentation

Ptr<UniformRandomVariable> ns3::dot11s::HwmpProtocol::m_coefficient
private

Random variable for random start time

Definition at line 284 of file hwmp-protocol.h.

Referenced by AssignStreams().

std::vector<QueuedPacket> ns3::dot11s::HwmpProtocol::m_rqueue
private

Packet Queue

Definition at line 263 of file hwmp-protocol.h.


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