A Discrete-Event Network Simulator
API
olsr-hna.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Authors: Lalith Suresh <suresh.lalith@gmail.com>
18  *
19  */
20 
21 //
22 // This script, adapted from examples/wireless/wifi-simple-adhoc illustrates
23 // the use of OLSR HNA.
24 //
25 // Network Topology:
26 //
27 // |------ OLSR ------| |---- non-OLSR ----|
28 // A )))) (((( B ------------------- C
29 // 10.1.1.1 10.1.1.2 172.16.1.2 172.16.1.1
30 //
31 // Node A needs to send a UDP packet to node C. This can be done only after
32 // A receives an HNA message from B, in which B announces 172.16.1.0/24
33 // as an associated network.
34 //
35 // If no HNA message is generated by B, a will not be able to form a route to C.
36 // This can be verified as follows:
37 //
38 // ./waf --run olsr-hna
39 //
40 // There are two ways to make a node to generate HNA messages.
41 //
42 // One way is to use olsr::RoutingProtocol::SetRoutingTableAssociation ()
43 // to use which you may run:
44 //
45 // ./waf --run "olsr-hna --assocMethod1=1"
46 //
47 // The other way is to use olsr::RoutingProtocol::AddHostNetworkAssociation ()
48 // to use which you may run:
49 //
50 // ./waf --run "olsr-hna --assocMethod2=1"
51 //
52 
53 #include "ns3/core-module.h"
54 #include "ns3/network-module.h"
55 #include "ns3/mobility-module.h"
56 #include "ns3/config-store-module.h"
57 #include "ns3/wifi-module.h"
58 #include "ns3/csma-module.h"
59 #include "ns3/internet-module.h"
60 #include "ns3/olsr-routing-protocol.h"
61 #include "ns3/olsr-helper.h"
62 
63 #include <iostream>
64 #include <fstream>
65 #include <vector>
66 #include <string>
67 
68 using namespace ns3;
69 
70 NS_LOG_COMPONENT_DEFINE ("OlsrHna");
71 
73 {
74  NS_LOG_UNCOND ("Received one packet!");
75 }
76 
77 static void GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize,
78  uint32_t pktCount, Time pktInterval )
79 {
80  if (pktCount > 0)
81  {
82  socket->Send (Create<Packet> (pktSize));
83  Simulator::Schedule (pktInterval, &GenerateTraffic,
84  socket, pktSize,pktCount - 1, pktInterval);
85  }
86  else
87  {
88  socket->Close ();
89  }
90 }
91 
92 
93 int main (int argc, char *argv[])
94 {
95  std::string phyMode ("DsssRate1Mbps");
96  double rss = -80; // -dBm
97  uint32_t packetSize = 1000; // bytes
98  uint32_t numPackets = 1;
99  double interval = 1.0; // seconds
100  bool verbose = false;
101  bool assocMethod1 = false;
102  bool assocMethod2 = false;
103 
105 
106  cmd.AddValue ("phyMode", "Wifi Phy mode", phyMode);
107  cmd.AddValue ("rss", "received signal strength", rss);
108  cmd.AddValue ("packetSize", "size of application packet sent", packetSize);
109  cmd.AddValue ("numPackets", "number of packets generated", numPackets);
110  cmd.AddValue ("interval", "interval (seconds) between packets", interval);
111  cmd.AddValue ("verbose", "turn on all WifiNetDevice log components", verbose);
112  cmd.AddValue ("assocMethod1", "Use SetRoutingTableAssociation () method", assocMethod1);
113  cmd.AddValue ("assocMethod2", "Use AddHostNetworkAssociation () method", assocMethod2);
114 
115  cmd.Parse (argc, argv);
116  // Convert to time object
117  Time interPacketInterval = Seconds (interval);
118 
119  // disable fragmentation for frames below 2200 bytes
120  Config::SetDefault ("ns3::WifiRemoteStationManager::FragmentationThreshold", StringValue ("2200"));
121  // turn off RTS/CTS for frames below 2200 bytes
122  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("2200"));
123  // Fix non-unicast data rate to be the same as that of unicast
124  Config::SetDefault ("ns3::WifiRemoteStationManager::NonUnicastMode",
125  StringValue (phyMode));
126 
127  NodeContainer olsrNodes;
128  olsrNodes.Create (2);
129 
131  csmaNodes.Create (1);
132 
133  // The below set of helpers will help us to put together the wifi NICs we want
135  if (verbose)
136  {
137  wifi.EnableLogComponents (); // Turn on all Wifi logging
138  }
140 
142  // This is one parameter that matters when using FixedRssLossModel
143  // set it to zero; otherwise, gain will be added
144  wifiPhy.Set ("RxGain", DoubleValue (0) );
145  // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
147 
148  YansWifiChannelHelper wifiChannel;
149  wifiChannel.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
150  // The below FixedRssLossModel will cause the rss to be fixed regardless
151  // of the distance between the two stations, and the transmit power
152  wifiChannel.AddPropagationLoss ("ns3::FixedRssLossModel","Rss",DoubleValue (rss));
153  wifiPhy.SetChannel (wifiChannel.Create ());
154 
155  // Add a mac and disable rate control
156  WifiMacHelper wifiMac;
157  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
158  "DataMode",StringValue (phyMode),
159  "ControlMode",StringValue (phyMode));
160  // Set it to adhoc mode
161  wifiMac.SetType ("ns3::AdhocWifiMac");
162  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, olsrNodes);
163 
165  csma.SetChannelAttribute ("DataRate", DataRateValue (DataRate (5000000)));
166  csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (2)));
167  NetDeviceContainer csmaDevices = csma.Install (NodeContainer (csmaNodes.Get (0), olsrNodes.Get (1)));
168 
169  // Note that with FixedRssLossModel, the positions below are not
170  // used for received signal strength.
172  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
173  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
174  positionAlloc->Add (Vector (5.0, 0.0, 0.0));
175  mobility.SetPositionAllocator (positionAlloc);
176  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
177  mobility.Install (olsrNodes);
178 
180 
181  // Specify Node B's csma device as a non-OLSR device.
182  olsr.ExcludeInterface (olsrNodes.Get (1), 2);
183 
184  Ipv4StaticRoutingHelper staticRouting;
185 
187  list.Add (staticRouting, 0);
188  list.Add (olsr, 10);
189 
190  InternetStackHelper internet_olsr;
191  internet_olsr.SetRoutingHelper (list); // has effect on the next Install ()
192  internet_olsr.Install (olsrNodes);
193 
194  InternetStackHelper internet_csma;
195  internet_csma.Install (csmaNodes);
196 
197  Ipv4AddressHelper ipv4;
198  NS_LOG_INFO ("Assign IP Addresses.");
199  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
200  ipv4.Assign (devices);
201 
202  ipv4.SetBase ("172.16.1.0", "255.255.255.0");
203  ipv4.Assign (csmaDevices);
204 
205  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
206  Ptr<Socket> recvSink = Socket::CreateSocket (csmaNodes.Get (0), tid);
208  recvSink->Bind (local);
210 
211  Ptr<Socket> source = Socket::CreateSocket (olsrNodes.Get (0), tid);
212  InetSocketAddress remote = InetSocketAddress (Ipv4Address ("172.16.1.1"), 80);
213  source->Connect (remote);
214 
215  // Obtain olsr::RoutingProtocol instance of gateway node
216  // (namely, node B) and add the required association
217  Ptr<Ipv4> stack = olsrNodes.Get (1)->GetObject<Ipv4> ();
218  Ptr<Ipv4RoutingProtocol> rp_Gw = (stack->GetRoutingProtocol ());
219  Ptr<Ipv4ListRouting> lrp_Gw = DynamicCast<Ipv4ListRouting> (rp_Gw);
220 
221  Ptr<olsr::RoutingProtocol> olsrrp_Gw;
222 
223  for (uint32_t i = 0; i < lrp_Gw->GetNRoutingProtocols (); i++)
224  {
225  int16_t priority;
226  Ptr<Ipv4RoutingProtocol> temp = lrp_Gw->GetRoutingProtocol (i, priority);
227  if (DynamicCast<olsr::RoutingProtocol> (temp))
228  {
229  olsrrp_Gw = DynamicCast<olsr::RoutingProtocol> (temp);
230  }
231  }
232 
233  if (assocMethod1)
234  {
235  // Create a special Ipv4StaticRouting instance for RoutingTableAssociation
236  // Even the Ipv4StaticRouting instance added to list may be used
237  Ptr<Ipv4StaticRouting> hnaEntries = Create<Ipv4StaticRouting> ();
238 
239  // Add the required routes into the Ipv4StaticRouting Protocol instance
240  // and have the node generate HNA messages for all these routes
241  // which are associated with non-OLSR interfaces specified above.
242  hnaEntries->AddNetworkRouteTo (Ipv4Address ("172.16.1.0"), Ipv4Mask ("255.255.255.0"), uint32_t (2), uint32_t (1));
243  olsrrp_Gw->SetRoutingTableAssociation (hnaEntries);
244  }
245 
246  if (assocMethod2)
247  {
248  // Specify the required associations directly.
249  olsrrp_Gw->AddHostNetworkAssociation (Ipv4Address ("172.16.1.0"), Ipv4Mask ("255.255.255.0"));
250  }
251 
252  // Tracing
253  wifiPhy.EnablePcap ("olsr-hna", devices);
254  csma.EnablePcap ("olsr-hna", csmaDevices, false);
255 
257  Seconds (15.0), &GenerateTraffic,
258  source, packetSize, numPackets, interPacketInterval);
259 
260  Simulator::Stop (Seconds (20.0));
261  Simulator::Run ();
263 
264  return 0;
265 }
void AddPropagationLoss(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:132
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
static Ipv4Address GetAny(void)
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
Definition: olsr-hna.cc:77
void SetChannelAttribute(std::string n1, const AttributeValue &v1)
Definition: csma-helper.cc:71
tuple devices
Definition: first.py:32
virtual Ptr< Ipv4RoutingProtocol > GetRoutingProtocol(uint32_t index, int16_t &priority) const
Return pointer to routing protocol stored at index, with the first protocol (index 0) the highest pri...
Ptr< YansWifiChannel > Create(void) const
void SetRemoteStationManager(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:719
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:459
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the yans model.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:258
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1001
aggregate IP/TCP/UDP functionality to existing Nodes.
Helper class that adds OLSR routing to nodes.
Definition: olsr-helper.h:40
NetDeviceContainer Install(Ptr< Node > node) const
This method creates an ns3::CsmaChannel with the attributes configured by CsmaHelper::SetChannelAttri...
Definition: csma-helper.cc:217
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:277
tuple csmaNodes
Definition: second.py:53
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:213
virtual Ptr< Ipv4RoutingProtocol > GetRoutingProtocol(void) const =0
Get the routing protocol to be used by this Ipv4 stack.
tuple cmd
Definition: second.py:35
void SetPcapDataLinkType(enum SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:566
Class for representing data rates.
Definition: data-rate.h:88
tuple csmaDevices
Definition: second.py:67
void SetChannel(Ptr< YansWifiChannel > channel)
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
tuple mobility
Definition: third.py:101
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1375
AttributeValue implementation for Time.
Definition: nstime.h:1055
holds a vector of ns3::NetDevice pointers
virtual void SetStandard(enum WifiPhyStandard standard)
Definition: wifi-helper.cc:742
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
Definition: wifi-helper.cc:748
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:71
Parse command-line arguments.
Definition: command-line.h:205
#define list
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:76
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
virtual uint32_t GetNRoutingProtocols(void) const
DSSS PHY (Clause 15) and HR/DSSS PHY (Clause 18)
void SetMobilityModel(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionaly.
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
Definition: olsr.py:1
void Add(const Ipv4RoutingHelper &routing, int16_t priority)
tuple stack
Definition: first.py:34
void ReceivePacket(Ptr< Socket > socket)
Definition: olsr-hna.cc:72
build a set of CsmaNetDevice objects
Definition: csma-helper.h:46
virtual void SetType(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue())
Helper class used to assign positions and mobility models to nodes.
void AddNetworkRouteTo(Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
Add a network route to the static routing table.
static void ScheduleWithContext(uint32_t context, Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event with the given context.
Definition: simulator.h:1469
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
static void EnableLogComponents(void)
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:797
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
uint32_t GetId(void) const
Definition: node.cc:107
Helper class that adds ns3::Ipv4StaticRouting objects.
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:498
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:993
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
void Add(Vector v)
Add a position to the list of positions.
Helper class that adds ns3::Ipv4ListRouting objects.
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
tuple wifi
Definition: third.py:89
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
static const uint32_t packetSize
void SetPropagationDelay(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Definition: olsr-helper.cc:47
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
virtual int Close(void)=0
Close a socket.
This class can be used to hold variables of floating point type such as 'double' or 'float'...
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:58
Include Radiotap link layer information.
Definition: wifi-helper.h:111
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
bool verbose
tuple csma
Definition: second.py:63
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:823