A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008,2009 IITP RAS
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Kirill Andreev <andreev@iitp.ru>
19  */
21 #ifndef HWMP_PROTOCOL_H
22 #define HWMP_PROTOCOL_H
24 #include "ns3/mesh-l2-routing-protocol.h"
25 #include "ns3/nstime.h"
26 #include "ns3/event-id.h"
27 #include "ns3/traced-value.h"
28 #include <vector>
29 #include <map>
31 namespace ns3 {
32 class MeshPointDevice;
33 class Packet;
34 class Mac48Address;
35 class UniformRandomVariable;
36 namespace dot11s {
37 class HwmpProtocolMac;
38 class HwmpRtable;
39 class IePerr;
40 class IePreq;
41 class IePrep;
47 {
48  std::string type;
51  uint32_t interface;
52  uint32_t metric;
54  uint32_t seqnum;
55 };
63 {
64 public:
69  static TypeId GetTypeId ();
70  HwmpProtocol ();
71  ~HwmpProtocol ();
72  void DoDispose ();
78  {
80  uint32_t seqnum;
81  };
94  bool RequestRoute (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination,
95  Ptr<const Packet> packet, uint16_t protocolType, RouteReplyCallback routeReply);
106  bool RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source,
107  const Mac48Address destination, Ptr<Packet> packet, uint16_t& protocolType);
118  bool Install (Ptr<MeshPointDevice> mp);
126  void PeerLinkStatus (Mac48Address meshPontAddress, Mac48Address peerAddress, uint32_t interface,bool status);
131  void SetNeighboursCallback (Callback<std::vector<Mac48Address>, uint32_t> cb);
135  void SetRoot ();
137  void UnsetRoot ();
146  void Report (std::ostream & os) const;
148  void ResetStats ();
159  int64_t AssignStreams (int64_t stream);
165  Ptr<HwmpRtable> GetRoutingTable (void) const;
167 private:
169  friend class HwmpProtocolMac;
171  virtual void DoInitialize ();
178  HwmpProtocol& operator= (const HwmpProtocol & hwmp);
183  HwmpProtocol (const HwmpProtocol & hwmp);
189  struct PathError
190  {
191  std::vector<FailedDestination> destinations;
192  std::vector<std::pair<uint32_t, Mac48Address> > receivers;
193  };
196  {
200  uint16_t protocol;
201  uint32_t inInterface;
204  QueuedPacket ();
205  };
206  typedef std::map<uint32_t, Ptr<HwmpProtocolMac> > HwmpProtocolMacMap;
219  bool ForwardUnicast (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination,
220  Ptr<Packet> packet, uint16_t protocolType, RouteReplyCallback routeReply, uint32_t ttl);
233  void ReceivePreq (IePreq preq, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric);
243  void ReceivePrep (IePrep prep, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric);
252  void ReceivePerr (std::vector<FailedDestination> destinations, Mac48Address from, uint32_t interface, Mac48Address fromMp);
264  void SendPrep (
265  Mac48Address src,
266  Mac48Address dst,
267  Mac48Address retransmitter,
268  uint32_t initMetric,
269  uint32_t originatorDsn,
270  uint32_t destinationSN,
271  uint32_t lifetime,
272  uint32_t interface);
280  PathError MakePathError (std::vector<FailedDestination> destinations);
285  void ForwardPathError (PathError perr);
290  void InitiatePathError (PathError perr);
297  std::vector<std::pair<uint32_t, Mac48Address> > GetPerrReceivers (std::vector<FailedDestination> failedDest);
305  std::vector<Mac48Address> GetPreqReceivers (uint32_t interface);
312  std::vector<Mac48Address> GetBroadcastReceivers (uint32_t interface);
320  bool DropDataFrame (uint32_t seqno, Mac48Address source);
330  // /\name Methods related to Queue/Dequeue procedures
337  bool QueuePacket (QueuedPacket packet);
357  void ProactivePathResolved ();
369  bool ShouldSendPreq (Mac48Address dst);
378  void RetryPathDiscovery (Mac48Address dst, uint8_t numOfRetry);
380  void SendProactivePreq ();
391  bool GetDoFlag ();
396  bool GetRfFlag ();
411  uint8_t GetMaxTtl ();
416  uint32_t GetNextPreqId ();
421  uint32_t GetNextHwmpSeqno ();
426  uint32_t GetActivePathLifetime ();
431  uint8_t GetUnicastPerrThreshold ();
434 private:
436  struct Statistics
437  {
438  uint16_t txUnicast;
439  uint16_t txBroadcast;
440  uint32_t txBytes;
441  uint16_t droppedTtl;
442  uint16_t totalQueued;
443  uint16_t totalDropped;
444  uint16_t initiatedPreq;
445  uint16_t initiatedPrep;
446  uint16_t initiatedPerr;
452  void Print (std::ostream & os) const;
454  Statistics ();
455  };
460  uint32_t m_dataSeqno;
461  uint32_t m_hwmpSeqno;
462  uint32_t m_preqId;
463  std::map<Mac48Address, uint32_t> m_lastDataSeqno;
468  std::map<Mac48Address, std::pair<uint32_t, uint32_t> > m_hwmpSeqnoMetricDatabase;
475  struct PreqEvent {
478  };
480  std::map<Mac48Address, PreqEvent> m_preqTimeouts;
485  std::vector<QueuedPacket> m_rqueue;
490  uint16_t m_maxQueueSize;
499  bool m_isRoot;
500  uint8_t m_maxTtl;
504  bool m_doFlag;
505  bool m_rfFlag;
511 };
512 } // namespace dot11s
513 } // namespace ns3
514 #endif
Time m_dot11MeshHWMPrannInterval
Lifetime of proactive routing information.
Structure of path error: IePerr and list of receivers: interfaces and MAC address.
uint16_t txBroadcast
transmit broadcast
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.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
Mac48Address retransmitter
route source
Definition: hwmp-protocol.h:50
std::string type
type of change
Definition: hwmp-protocol.h:48
Callback template class.
Definition: callback.h:1278
bool m_doFlag
Destination only HWMP flag.
std::map< uint32_t, Ptr< HwmpProtocolMac > > HwmpProtocolMacMap
HwmpProtocolMacMap typedef.
Time m_dot11MeshHWMPpreqMinInterval
Minimal interval between to successive PREQs.
uint16_t initiatedPreq
initiated PREQ
Time m_dot11MeshHWMPperrMinInterval
Minimal interval between to successive PREQs.
void SetRoot()
Unset the current node as root.
void SendPrep(Mac48Address src, Mac48Address dst, Mac48Address retransmitter, uint32_t initMetric, uint32_t originatorDsn, uint32_t destinationSN, uint32_t lifetime, uint32_t interface)
Send Path Reply.
structure of unreachable destination - address and sequence number
Definition: hwmp-protocol.h:77
Forward calls to a chain of Callback.
Callback< void, bool, Ptr< Packet >, Mac48Address, Mac48Address, uint16_t, uint32_t > RouteReplyCallback
Callback to be invoked when route discovery procedure is completed.
TracedCallback< struct RouteChange > RouteChangeTracedCallback
RouteChangeTracedCallback typedef.
Time m_dot11MeshHWMPactiveRootTimeout
Lifetime of proactive routing information.
void ForwardPathError(PathError perr)
Forwards a received path error.
See of 802.11s draft 2.07.
void UnsetRoot()
Unset the current node as root.
bool GetRfFlag()
Get rf flag function.
void InitiatePathError(PathError perr)
Passes a self-generated PERR to interface-plugin.
Time lifetime
lifetime of route
Definition: hwmp-protocol.h:53
Statistics m_stats
void Report(std::ostream &os) const
bool Install(Ptr< MeshPointDevice > mp)
Install HWMP on given mesh point.
Ptr< HwmpRtable > GetRoutingTable(void) const
Get pointer to HWMP routing table.
uint8_t GetMaxTtl()
Get maximum TTL function.
void ReactivePathResolved(Mac48Address dst)
Signal the protocol that the reactive path toward a destination is now available. ...
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 ...
uint8_t m_unicastDataThreshold
Maximum number of broadcast receivers, when we send a broadcast as a chain of unicasts.
TracedCallback< Time > m_routeDiscoveryTimeCallback
Route discovery time:
void ReceivePrep(IePrep prep, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric)
Handler for receiving Path Reply.
void SendProactivePreq()
Proactive Preq routines:
bool DropDataFrame(uint32_t seqno, Mac48Address source)
MAC-plugin asks whether the frame can be dropped.
QueuedPacket DequeueFirstPacket()
Dequeue the first packet in the queue.
std::vector< Mac48Address > GetPreqReceivers(uint32_t interface)
Get PREQ receivers.
bool RemoveRoutingStuff(uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)
Clean HWMP packet tag from packet; only the packet parameter is used.
Time GetPerrMinInterval()
Get PERR minimum interval function.
uint8_t m_unicastPerrThreshold
Maximum number of PERR receivers, when we send a PERR as a chain of unicasts.
std::vector< QueuedPacket > m_rqueue
Packet Queue.
std::vector< std::pair< uint32_t, Mac48Address > > GetPerrReceivers(std::vector< FailedDestination > failedDest)
Get PERR receivers.
void RetryPathDiscovery(Mac48Address dst, uint8_t numOfRetry)
Generates PREQ retry when retry timeout has expired and route is still unresolved.
void DoDispose()
Destructor implementation.
Mac48Address destination
route destination
Definition: hwmp-protocol.h:49
Hybrid wireless mesh protocol – a mesh routing protocol defined in IEEE 802.11-2012 standard...
Definition: hwmp-protocol.h:62
See of 802.11s draft 2.07.
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.
uint32_t seqnum
sequence number of route
Definition: hwmp-protocol.h:54
Packet waiting its routing information.
void ProactivePathResolved()
Signal the protocol that the proactive path is now available.
HwmpProtocolMacMap m_interfaces
uint32_t GetActivePathLifetime()
Get active path lifetime function.
uint16_t totalDropped
total dropped
Ptr< HwmpRtable > m_rtable
Routing table.
static TypeId GetTypeId()
Get the type ID.
uint16_t initiatedPerr
initiated PERR
uint16_t m_maxQueueSize
Maximum number of packets we can store when resolving route.
uint8_t m_unicastPreqThreshold
Maximum number of PREQ receivers, when we send a PREQ as a chain of unicasts.
void ReceivePreq(IePreq preq, Mac48Address from, uint32_t interface, Mac48Address fromMp, uint32_t metric)
Handler for receiving Path Request.
uint8_t m_maxTtl
Initial value of Time To Live field.
uint32_t m_dataSeqno
data sequence no
Time m_randomStart
Random start in Proactive PREQ propagation.
Interface MAC plugin for HWMP – 802.11s routing protocol.
uint32_t m_hwmpSeqno
HWMP sequence no.
Mac48Address m_address
uint8_t m_dot11MeshHWMPmaxPREQretries
Maximum number of retries before we suppose the destination to be unreachable.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint16_t initiatedPrep
initiated PREP
uint32_t GetNextPreqId()
Get next period function.
PathError MakePathError(std::vector< FailedDestination > destinations)
forms a path error information element when list of destination fails on a given interface ...
std::vector< std::pair< uint32_t, Mac48Address > > receivers
list of PathError receivers (in case of unicast PERR)
an EUI-48 address
Definition: mac48-address.h:43
uint32_t GetNextHwmpSeqno()
Get next HWMP sequence no function.
RouteReplyCallback reply
how to reply
uint32_t m_preqId
Interface for L2 mesh routing protocol and mesh point communication.
bool m_isRoot
True if the node is a root.
Mac48Address destination
destination address
Definition: hwmp-protocol.h:79
void ReceivePerr(std::vector< FailedDestination > destinations, Mac48Address from, uint32_t interface, Mac48Address fromMp)
Handler for receiving Path Error.
uint32_t metric
metric of route
Definition: hwmp-protocol.h:52
Ptr< UniformRandomVariable > m_coefficient
Random variable for random start time.
uint8_t GetUnicastPerrThreshold()
Get unicast PERR threshold function.
EventId m_proactivePreqTimer
proactive PREQ timer
Time m_dot11MeshHWMPactivePathTimeout
Lifetime of reactive routing information.
An identifier for simulation events.
Definition: event-id.h:53
std::vector< Mac48Address > GetBroadcastReceivers(uint32_t interface)
Get broadcast receivers.
std::vector< FailedDestination > destinations
destination list: Mac48Address and sequence number
void Print(std::ostream &os) const
Print function.
Time m_dot11MeshHWMPpathToRootInterval
Interval between two successive proactive PREQs.
uint16_t txUnicast
transmit unicast
Callback< std::vector< Mac48Address >, uint32_t > m_neighboursCallback
neighbors callback
std::map< Mac48Address, uint32_t > m_lastDataSeqno
keeps HWMP seqno (first in pair) and HWMP metric (second in pair) for each address ...
QueuedPacket DequeueFirstPacketByDst(Mac48Address dst)
Dequeue the first packet for a given destination.
Time GetPreqMinInterval()
Get PREQ minimum interval function.
TracedCallback< struct RouteChange > m_routeChangeTraceSource
Route change trace source.
uint32_t inInterface
incoming device interface ID. (if packet has come from upper layers, this is Mesh point ID) ...
bool QueuePacket(QueuedPacket packet)
Queue a packet.
bool ShouldSendPreq(Mac48Address dst)
checks when the last path discovery procedure was started for a given destination.
HwmpProtocol & operator=(const HwmpProtocol &hwmp)
assignment operator
void PeerLinkStatus(Mac48Address meshPontAddress, Mac48Address peerAddress, uint32_t interface, bool status)
Peer link status function.
void ResetStats()
Reset Statistics:
a unique identifier for an interface.
Definition: type-id.h:58
uint32_t interface
interface index
Definition: hwmp-protocol.h:51
bool m_rfFlag
Reply and forward flag.
std::map< Mac48Address, PreqEvent > m_preqTimeouts
PREQ timeouts.
bool GetDoFlag()
Get do flag function.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Time m_dot11MeshHWMPnetDiameterTraversalTime
Time we suppose the packet to go from one edge of the network to another.
Structure to encapsulate route change information.
Definition: hwmp-protocol.h:46
void SetNeighboursCallback(Callback< std::vector< Mac48Address >, uint32_t > cb)
This callback is used to obtain active neighbours on a given interface.
virtual void DoInitialize()
Initialize() implementation.