A Discrete-Event Network Simulator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2004 Francisco J. Ros
4  * Copyright (c) 2007 INESC Porto
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors: Francisco J. Ros <fjrm@dif.um.es>
20  * Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
21  */
23 #ifndef OLSR_AGENT_IMPL_H
24 #define OLSR_AGENT_IMPL_H
26 #include "olsr-header.h"
27 #include "ns3/test.h"
28 #include "olsr-state.h"
29 #include "olsr-repositories.h"
31 #include "ns3/object.h"
32 #include "ns3/packet.h"
33 #include "ns3/node.h"
34 #include "ns3/socket.h"
35 #include "ns3/event-garbage-collector.h"
36 #include "ns3/random-variable-stream.h"
37 #include "ns3/timer.h"
38 #include "ns3/traced-callback.h"
39 #include "ns3/ipv4.h"
40 #include "ns3/ipv4-routing-protocol.h"
41 #include "ns3/ipv4-static-routing.h"
43 #include <vector>
44 #include <map>
47 class OlsrMprTestCase;
49 namespace ns3 {
50 namespace olsr {
59 {
62  uint32_t interface;
63  uint32_t distance;
65  RoutingTableEntry () : // default values
66  destAddr (), nextAddr (),
67  interface (0), distance (0) {};
68 };
70 class RoutingProtocol;
78 {
79 public:
80  friend class ::OlsrMprTestCase;
81  static TypeId GetTypeId (void);
83  RoutingProtocol ();
84  virtual ~RoutingProtocol ();
91  void SetMainInterface (uint32_t interface);
98  void Dump (void);
103  std::vector<RoutingTableEntry> GetRoutingTableEntries () const;
113  int64_t AssignStreams (int64_t stream);
115 private:
116  std::set<uint32_t> m_interfaceExclusions;
119 public:
120  std::set<uint32_t> GetInterfaceExclusions () const
121  {
122  return m_interfaceExclusions;
123  }
124  void SetInterfaceExclusions (std::set<uint32_t> exceptions);
127  void AddHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask);
129  void RemoveHostNetworkAssociation (Ipv4Address networkAddr, Ipv4Mask netmask);
140 protected:
141  virtual void DoInitialize (void);
142 private:
143  std::map<Ipv4Address, RoutingTableEntry> m_table;
154  uint16_t m_ansn;
165  uint8_t m_willingness;
172  void Clear ();
173  uint32_t GetSize () const { return m_table.size (); }
174  void RemoveEntry (const Ipv4Address &dest);
175  void AddEntry (const Ipv4Address &dest,
176  const Ipv4Address &next,
177  uint32_t interface,
178  uint32_t distance);
179  void AddEntry (const Ipv4Address &dest,
180  const Ipv4Address &next,
181  const Ipv4Address &interfaceAddress,
182  uint32_t distance);
183  bool Lookup (const Ipv4Address &dest,
184  RoutingTableEntry &outEntry) const;
185  bool FindSendEntry (const RoutingTableEntry &entry,
186  RoutingTableEntry &outEntry) const;
188  // From Ipv4RoutingProtocol
190  const Ipv4Header &header,
191  Ptr<NetDevice> oif,
192  Socket::SocketErrno &sockerr);
193  virtual bool RouteInput (Ptr<const Packet> p,
194  const Ipv4Header &header,
199  ErrorCallback ecb);
200  virtual void NotifyInterfaceUp (uint32_t interface);
201  virtual void NotifyInterfaceDown (uint32_t interface);
202  virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address);
203  virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address);
204  virtual void SetIpv4 (Ptr<Ipv4> ipv4);
205  virtual void PrintRoutingTable (Ptr<OutputStreamWrapper> stream) const;
207  void DoDispose ();
209  void SendPacket (Ptr<Packet> packet, const MessageList &containedMessages);
212  inline uint16_t GetPacketSequenceNumber ();
214  inline uint16_t GetMessageSequenceNumber ();
216  void RecvOlsr (Ptr<Socket> socket);
218  void MprComputation ();
219  void RoutingTableComputation ();
220  Ipv4Address GetMainAddress (Ipv4Address iface_addr) const;
223  // Timer handlers
225  void HelloTimerExpire ();
228  void TcTimerExpire ();
231  void MidTimerExpire ();
234  void HnaTimerExpire ();
236  void DupTupleTimerExpire (Ipv4Address address, uint16_t sequenceNumber);
238  void LinkTupleTimerExpire (Ipv4Address neighborIfaceAddr);
239  void Nb2hopTupleTimerExpire (Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr);
240  void MprSelTupleTimerExpire (Ipv4Address mainAddr);
241  void TopologyTupleTimerExpire (Ipv4Address destAddr, Ipv4Address lastAddr);
242  void IfaceAssocTupleTimerExpire (Ipv4Address ifaceAddr);
243  void AssociationTupleTimerExpire (Ipv4Address gatewayAddr, Ipv4Address networkAddr, Ipv4Mask netmask);
245  void IncrementAnsn ();
249  Timer m_queuedMessagesTimer; // timer for throttling outgoing messages
251  void ForwardDefault (olsr::MessageHeader olsrMessage,
252  DuplicateTuple *duplicated,
253  const Ipv4Address &localIface,
254  const Ipv4Address &senderAddress);
255  void QueueMessage (const olsr::MessageHeader &message, Time delay);
256  void SendQueuedMessages ();
257  void SendHello ();
258  void SendTc ();
259  void SendMid ();
260  void SendHna ();
262  void NeighborLoss (const LinkTuple &tuple);
263  void AddDuplicateTuple (const DuplicateTuple &tuple);
264  void RemoveDuplicateTuple (const DuplicateTuple &tuple);
265  void LinkTupleAdded (const LinkTuple &tuple, uint8_t willingness);
266  void RemoveLinkTuple (const LinkTuple &tuple);
267  void LinkTupleUpdated (const LinkTuple &tuple, uint8_t willingness);
268  void AddNeighborTuple (const NeighborTuple &tuple);
269  void RemoveNeighborTuple (const NeighborTuple &tuple);
270  void AddTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);
272  void AddMprSelectorTuple (const MprSelectorTuple &tuple);
273  void RemoveMprSelectorTuple (const MprSelectorTuple &tuple);
274  void AddTopologyTuple (const TopologyTuple &tuple);
275  void RemoveTopologyTuple (const TopologyTuple &tuple);
276  void AddIfaceAssocTuple (const IfaceAssocTuple &tuple);
277  void RemoveIfaceAssocTuple (const IfaceAssocTuple &tuple);
278  void AddAssociationTuple (const AssociationTuple &tuple);
279  void RemoveAssociationTuple (const AssociationTuple &tuple);
281  void ProcessHello (const olsr::MessageHeader &msg,
282  const Ipv4Address &receiverIface,
283  const Ipv4Address &senderIface);
284  void ProcessTc (const olsr::MessageHeader &msg,
285  const Ipv4Address &senderIface);
286  void ProcessMid (const olsr::MessageHeader &msg,
287  const Ipv4Address &senderIface);
288  void ProcessHna (const olsr::MessageHeader &msg,
289  const Ipv4Address &senderIface);
291  void LinkSensing (const olsr::MessageHeader &msg,
292  const olsr::MessageHeader::Hello &hello,
293  const Ipv4Address &receiverIface,
294  const Ipv4Address &sender_iface);
295  void PopulateNeighborSet (const olsr::MessageHeader &msg,
296  const olsr::MessageHeader::Hello &hello);
298  const olsr::MessageHeader::Hello &hello);
300  const olsr::MessageHeader::Hello &hello);
302  int Degree (NeighborTuple const &tuple);
304  bool IsMyOwnAddress (const Ipv4Address & a) const;
308  // One socket per interface, each bound to that interface's address
309  // (reason: for OLSR Link Sensing we need to know on which interface
310  // HELLO messages arrive)
311  std::map< Ptr<Socket>, Ipv4InterfaceAddress > m_socketAddresses;
313  TracedCallback <const PacketHeader &,
315  TracedCallback <const PacketHeader &,
322 };
324 }
325 } // namespace ns3
327 #endif /* OLSR_AGENT_IMPL_H */
An MPR-Selector Tuple.
std::set< uint32_t > m_interfaceExclusions
An OLSR's routing table entry.
uint32_t distance
Distance in hops to the destination.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
void HelloTimerExpire()
Sends a HELLO message and reschedules the HELLO timer.
std::set< uint32_t > GetInterfaceExclusions() const
void AddTopologyTuple(const TopologyTuple &tuple)
Adds a topology tuple to the Topology Set.
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:60
void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
void IfaceAssocTupleTimerExpire(Ipv4Address ifaceAddr)
Removes tuple_ if expired.
void RemoveMprSelectorTuple(const MprSelectorTuple &tuple)
Removes an MPR selector tuple from the MPR Selector Set.
uint16_t GetPacketSequenceNumber()
Increments packet sequence number and returns the new value.
Time m_midInterval
MID messages' emission interval.
a simple Timer class
Definition: timer.h:45
Doxygen introspection did not find any typical Config paths.
Definition: olsr-header.h:116
void Clear()
Clears the routing table and frees the memory assigned to each one of its entries.
uint16_t m_messageSequenceNumber
Messages sequence number counter.
Ipv4Address destAddr
Address of the destination node.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:222
void HnaTimerExpire()
Sends an HNA message (if the node has associated hosts/networks) and reschedules the HNA timer...
void LinkTupleUpdated(const LinkTuple &tuple, uint8_t willingness)
This function is invoked when a link tuple is updated.
void LinkSensing(const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello, const Ipv4Address &receiverIface, const Ipv4Address &sender_iface)
Updates Link Set according to a new received HELLO message (following RFC 3626 specification).
forward calls to a chain of CallbackAn ns3::TracedCallback has almost exactly the same API as a norma...
uint16_t m_ansn
Advertised Neighbor Set sequence number.
void AddEntry(const Ipv4Address &dest, const Ipv4Address &next, uint32_t interface, uint32_t distance)
Adds a new entry into the routing table.
virtual void NotifyInterfaceUp(uint32_t interface)
void SendTc()
Creates a new OLSR TC message which is buffered for being sent later on.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
void DupTupleTimerExpire(Ipv4Address address, uint16_t sequenceNumber)
Removes tuple if expired.
void AddHostNetworkAssociation(Ipv4Address networkAddr, Ipv4Mask netmask)
Inject Association to be sent in HNA message.
void LinkTupleTimerExpire(Ipv4Address neighborIfaceAddr)
Removes tuple_ if expired.
void SetMainInterface(uint32_t interface)
Set the OLSR main address to the first address on the indicated interface.
Enumeration of the possible errors returned by a socket.
Definition: socket.h:82
void Nb2hopTupleTimerExpire(Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr)
Removes tuple_ if expired.
void RemoveAssociationTuple(const AssociationTuple &tuple)
Removes a host network association tuple from the Association Set.
void ProcessTc(const olsr::MessageHeader &msg, const Ipv4Address &senderIface)
Processes a TC message following RFC 3626 specification.
void MprSelTupleTimerExpire(Ipv4Address mainAddr)
Removes tuple_ if expired.
Callback< void, Ptr< const Packet >, const Ipv4Header &, Socket::SocketErrno > ErrorCallback
Callback for routing errors (e.g., no route found)
std::map< Ipv4Address, RoutingTableEntry > m_table
Data structure for the routing table.
TracedCallback< const PacketHeader &, const MessageList & > m_rxPacketTrace
void RemoveIfaceAssocTuple(const IfaceAssocTuple &tuple)
Removes an interface association tuple from the Interface Association Set.
Packet header for IPv4.
Definition: ipv4-header.h:31
EventGarbageCollector m_events
An object that tracks scheduled events and automatically cancels them when it is destroyed.
A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting.
uint8_t m_willingness
Willingness for forwarding packets on behalf of other nodes.
void PopulateNeighborSet(const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello)
Updates the Neighbor Set according to the information contained in a new received HELLO message (foll...
void RemoveHostNetworkAssociation(Ipv4Address networkAddr, Ipv4Mask netmask)
Removes Association sent in HNA message.
void AddIfaceAssocTuple(const IfaceAssocTuple &tuple)
Adds an interface association tuple to the Interface Association Set.
void QueueMessage(const olsr::MessageHeader &message, Time delay)
Enques an OLSR message which will be sent with a delay of (0, delay].
void SendPacket(Ptr< Packet > packet, const MessageList &containedMessages)
OLSR routing protocol for IPv4.
An Association Tuple.
void ProcessHello(const olsr::MessageHeader &msg, const Ipv4Address &receiverIface, const Ipv4Address &senderIface)
Processes a HELLO message following RFC 3626 specification.
void AddAssociationTuple(const AssociationTuple &tuple)
Adds a host network association tuple to the Association Set.
Ptr< Ipv4StaticRouting > m_hnaRoutingTable
virtual bool RouteInput(Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
Route an input packet (to be forwarded or locally delivered)
void MprComputation()
Computates MPR set of a node following RFC 3626 hints.
void RemoveDuplicateTuple(const DuplicateTuple &tuple)
Removes a duplicate tuple from the Duplicate Set.
virtual void NotifyAddAddress(uint32_t interface, Ipv4InterfaceAddress address)
Time m_helloInterval
HELLO messages' emission interval.
void SetRoutingTableAssociation(Ptr< Ipv4StaticRouting > routingTable)
Inject Associations from an Ipv4StaticRouting instance.
std::map< Ptr< Socket >, Ipv4InterfaceAddress > m_socketAddresses
void TopologyTupleTimerExpire(Ipv4Address destAddr, Ipv4Address lastAddr)
Removes tuple_ if expired.
Time m_tcInterval
TC messages' emission interval.
void AddTwoHopNeighborTuple(const TwoHopNeighborTuple &tuple)
Adds a 2-hop neighbor tuple to the 2-hop Neighbor Set.
void AssociationTupleTimerExpire(Ipv4Address gatewayAddr, Ipv4Address networkAddr, Ipv4Mask netmask)
Removes tuple_ if expired.
virtual void PrintRoutingTable(Ptr< OutputStreamWrapper > stream) const
Print the Routing Table entries.
void NeighborLoss(const LinkTuple &tuple)
Performs all actions needed when a neighbor loss occurs.
void RemoveTopologyTuple(const TopologyTuple &tuple)
Removes a topology tuple from the Topology Set.
void SendMid()
Creates a new OLSR MID message which is buffered for being sent later on.
void RecvOlsr(Ptr< Socket > socket)
This class encapsulates all data structures needed for maintaining internal state of an OLSR node...
Definition: olsr-state.h:34
void MidTimerExpire()
Sends a MID message (if the node has more than one interface) and resets the MID timer.
Ptr< Ipv4StaticRouting > m_routingTableAssociation
Ptr< const Ipv4StaticRouting > GetRoutingTableAssociation() const
Returns the internal HNA table.
void AddNeighborTuple(const NeighborTuple &tuple)
Adds a neighbor tuple to the Neighbor Set.
void SendHello()
Creates a new OLSR HELLO message which is buffered for being sent later on.
void RemoveLinkTuple(const LinkTuple &tuple)
Removes a link tuple from the Link Set.
bool UsesNonOlsrOutgoingInterface(const Ipv4RoutingTableEntry &route)
Tests whether or not the specified route uses a non-OLSR outgoing interface.
bool Lookup(const Ipv4Address &dest, RoutingTableEntry &outEntry) const
Looks up an entry for the specified destination address.
std::vector< MessageHeader > MessageList
Definition: olsr-header.h:450
virtual void NotifyInterfaceDown(uint32_t interface)
Doxygen introspection did not find any typical Config paths.
Definition: olsr-header.h:69
uint16_t m_packetSequenceNumber
Packets sequence number counter.
void PopulateTwoHopNeighborSet(const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello)
Updates the 2-hop Neighbor Set according to the information contained in a new received HELLO message...
Ipv4Address GetMainAddress(Ipv4Address iface_addr) const
Gets the main address associated with a given interface address.
void RoutingTableComputation()
Creates the routing table of the node following RFC 3626 hints.
void RemoveTwoHopNeighborTuple(const TwoHopNeighborTuple &tuple)
Removes a 2-hop neighbor tuple from the 2-hop Neighbor Set.
void RemoveEntry(const Ipv4Address &dest)
Deletes the entry whose destination address is given.
void ForwardDefault(olsr::MessageHeader olsrMessage, DuplicateTuple *duplicated, const Ipv4Address &localIface, const Ipv4Address &senderAddress)
OLSR's default forwarding algorithm.
Callback< void, Ptr< const Packet >, const Ipv4Header &, uint32_t > LocalDeliverCallback
Callback for packets to be locally delivered.
void ProcessHna(const olsr::MessageHeader &msg, const Ipv4Address &senderIface)
Processes a HNA message following RFC 3626 specification.
virtual Ptr< Ipv4Route > RouteOutput(Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
Query routing cache for an existing route, for an outbound packet.
int Degree(NeighborTuple const &tuple)
This auxiliary function (defined in RFC 3626) is used for calculating the MPR Set.
uint32_t interface
Interface index.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
bool IsMyOwnAddress(const Ipv4Address &a) const
Check that address is one of my interfaces.
a class to store IPv4 address information on an interface
virtual void SetIpv4(Ptr< Ipv4 > ipv4)
void PopulateMprSelectorSet(const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello)
Updates the MPR Selector Set according to the information contained in a new received HELLO message (...
void SendQueuedMessages()
Creates as many OLSR packets as needed in order to send all buffered OLSR messages.
Ipv4Address nextAddr
Address of the next hop.
TracedCallback< const PacketHeader &, const MessageList & > m_txPacketTrace
void SendHna()
Creates a new OLSR HNA message which is buffered for being sent later on.
Abstract base class for IPv4 routing protocols.
void LinkTupleAdded(const LinkTuple &tuple, uint8_t willingness)
void SetInterfaceExclusions(std::set< uint32_t > exceptions)
Time m_hnaInterval
HNA messages' emission interval.
void Dump(void)
Dump the neighbor table, two-hop neighbor table, and routing table to logging output (NS_LOG_DEBUG lo...
virtual void DoInitialize(void)
This method is called only once by Object::Initialize.
std::vector< RoutingTableEntry > GetRoutingTableEntries() const
Return the list of routing table entries discovered by OLSR.
tuple address
Definition: first.py:37
void AddDuplicateTuple(const DuplicateTuple &tuple)
Adds a duplicate tuple to the Duplicate Set.
void TcTimerExpire()
Sends a TC message (if there exists any MPR selector) and reschedules the TC timer.
void RemoveNeighborTuple(const NeighborTuple &tuple)
Removes a neighbor tuple from the Neighbor Set.
uint16_t GetMessageSequenceNumber()
Increments message sequence number and returns the new value.
OlsrState m_state
Internal state with all needed data structs.
Callback< void, Ptr< Ipv4MulticastRoute >, Ptr< const Packet >, const Ipv4Header & > MulticastForwardCallback
Callback for multicast packets to be forwarded.
void AddMprSelectorTuple(const MprSelectorTuple &tuple)
Adds an MPR selector tuple to the MPR Selector Set.
TracedCallback< uint32_t > m_routingTableChanged
a unique identifier for an interface.
Definition: type-id.h:49
An Interface Association Tuple.
The type "list of interface addresses".
virtual void NotifyRemoveAddress(uint32_t interface, Ipv4InterfaceAddress address)
olsr::MessageList m_queuedMessages
A list of pending messages which are buffered awaiting for being sent.
Ptr< UniformRandomVariable > m_uniformRandomVariable
Provides uniform random variables.
bool FindSendEntry(const RoutingTableEntry &entry, RoutingTableEntry &outEntry) const
Finds the appropiate entry which must be used in order to forward a data packet to a next hop (given ...
Callback< void, Ptr< Ipv4Route >, Ptr< const Packet >, const Ipv4Header & > UnicastForwardCallback
Callback for unicast packets to be forwarded.
Testcase for MPR computation mechanism.
void ProcessMid(const olsr::MessageHeader &msg, const Ipv4Address &senderIface)
Processes a MID message following RFC 3626 specification.