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 // ./ns3 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 // ./ns3 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 // ./ns3 run "olsr-hna --assocMethod2=1"
51 //
52 
53 #include <iostream>
54 #include <fstream>
55 #include <vector>
56 #include <string>
57 #include "ns3/core-module.h"
58 #include "ns3/network-module.h"
59 #include "ns3/mobility-module.h"
60 #include "ns3/config-store-module.h"
61 #include "ns3/csma-module.h"
62 #include "ns3/internet-module.h"
63 #include "ns3/olsr-routing-protocol.h"
64 #include "ns3/olsr-helper.h"
65 #include "ns3/yans-wifi-helper.h"
66 
67 using namespace ns3;
68 
69 NS_LOG_COMPONENT_DEFINE ("OlsrHna");
70 
72 {
73  NS_LOG_UNCOND ("Received one packet!");
74 }
75 
76 static void GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize,
77  uint32_t pktCount, Time pktInterval )
78 {
79  if (pktCount > 0)
80  {
81  socket->Send (Create<Packet> (pktSize));
82  Simulator::Schedule (pktInterval, &GenerateTraffic,
83  socket, pktSize,pktCount - 1, pktInterval);
84  }
85  else
86  {
87  socket->Close ();
88  }
89 }
90 
91 
92 int main (int argc, char *argv[])
93 {
94  std::string phyMode ("DsssRate1Mbps");
95  double rss = -80; // -dBm
96  uint32_t packetSize = 1000; // bytes
97  uint32_t numPackets = 1;
98  double interval = 1.0; // seconds
99  bool verbose = false;
100  bool assocMethod1 = false;
101  bool assocMethod2 = false;
102 
103  CommandLine cmd (__FILE__);
104 
105  cmd.AddValue ("phyMode", "Wifi Phy mode", phyMode);
106  cmd.AddValue ("rss", "received signal strength", rss);
107  cmd.AddValue ("packetSize", "size of application packet sent", packetSize);
108  cmd.AddValue ("numPackets", "number of packets generated", numPackets);
109  cmd.AddValue ("interval", "interval (seconds) between packets", interval);
110  cmd.AddValue ("verbose", "turn on all WifiNetDevice log components", verbose);
111  cmd.AddValue ("assocMethod1", "Use SetRoutingTableAssociation () method", assocMethod1);
112  cmd.AddValue ("assocMethod2", "Use AddHostNetworkAssociation () method", assocMethod2);
113 
114  cmd.Parse (argc, argv);
115  // Convert to time object
116  Time interPacketInterval = Seconds (interval);
117 
118  // disable fragmentation for frames below 2200 bytes
119  Config::SetDefault ("ns3::WifiRemoteStationManager::FragmentationThreshold", StringValue ("2200"));
120  // turn off RTS/CTS for frames below 2200 bytes
121  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("2200"));
122  // Fix non-unicast data rate to be the same as that of unicast
123  Config::SetDefault ("ns3::WifiRemoteStationManager::NonUnicastMode",
124  StringValue (phyMode));
125 
126  NodeContainer olsrNodes;
127  olsrNodes.Create (2);
128 
130  csmaNodes.Create (1);
131 
132  // The below set of helpers will help us to put together the wifi NICs we want
134  if (verbose)
135  {
136  wifi.EnableLogComponents (); // Turn on all Wifi logging
137  }
138  wifi.SetStandard (WIFI_STANDARD_80211b);
139 
140  YansWifiPhyHelper wifiPhy;
141  // This is one parameter that matters when using FixedRssLossModel
142  // set it to zero; otherwise, gain will be added
143  wifiPhy.Set ("RxGain", DoubleValue (0) );
144  // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
146 
147  YansWifiChannelHelper wifiChannel;
148  wifiChannel.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
149  // The below FixedRssLossModel will cause the rss to be fixed regardless
150  // of the distance between the two stations, and the transmit power
151  wifiChannel.AddPropagationLoss ("ns3::FixedRssLossModel","Rss",DoubleValue (rss));
152  wifiPhy.SetChannel (wifiChannel.Create ());
153 
154  // Add a mac and disable rate control
155  WifiMacHelper wifiMac;
156  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
157  "DataMode",StringValue (phyMode),
158  "ControlMode",StringValue (phyMode));
159  // Set it to adhoc mode
160  wifiMac.SetType ("ns3::AdhocWifiMac");
161  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, olsrNodes);
162 
164  csma.SetChannelAttribute ("DataRate", DataRateValue (DataRate (5000000)));
165  csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (2)));
166  NetDeviceContainer csmaDevices = csma.Install (NodeContainer (csmaNodes.Get (0), olsrNodes.Get (1)));
167 
168  // Note that with FixedRssLossModel, the positions below are not
169  // used for received signal strength.
171  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
172  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
173  positionAlloc->Add (Vector (5.0, 0.0, 0.0));
174  mobility.SetPositionAllocator (positionAlloc);
175  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
176  mobility.Install (olsrNodes);
177 
179 
180  // Specify Node B's csma device as a non-OLSR device.
181  olsr.ExcludeInterface (olsrNodes.Get (1), 2);
182 
183  Ipv4StaticRoutingHelper staticRouting;
184 
186  list.Add (staticRouting, 0);
187  list.Add (olsr, 10);
188 
189  InternetStackHelper internet_olsr;
190  internet_olsr.SetRoutingHelper (list); // has effect on the next Install ()
191  internet_olsr.Install (olsrNodes);
192 
193  InternetStackHelper internet_csma;
194  internet_csma.Install (csmaNodes);
195 
196  Ipv4AddressHelper ipv4;
197  NS_LOG_INFO ("Assign IP Addresses.");
198  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
199  ipv4.Assign (devices);
200 
201  ipv4.SetBase ("172.16.1.0", "255.255.255.0");
202  ipv4.Assign (csmaDevices);
203 
204  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
205  Ptr<Socket> recvSink = Socket::CreateSocket (csmaNodes.Get (0), tid);
207  recvSink->Bind (local);
209 
210  Ptr<Socket> source = Socket::CreateSocket (olsrNodes.Get (0), tid);
211  InetSocketAddress remote = InetSocketAddress (Ipv4Address ("172.16.1.1"), 80);
212  source->Connect (remote);
213 
214  // Obtain olsr::RoutingProtocol instance of gateway node
215  // (namely, node B) and add the required association
216  Ptr<Ipv4> stack = olsrNodes.Get (1)->GetObject<Ipv4> ();
217  Ptr<Ipv4RoutingProtocol> rp_Gw = (stack->GetRoutingProtocol ());
218  Ptr<Ipv4ListRouting> lrp_Gw = DynamicCast<Ipv4ListRouting> (rp_Gw);
219 
220  Ptr<olsr::RoutingProtocol> olsrrp_Gw;
221 
222  for (uint32_t i = 0; i < lrp_Gw->GetNRoutingProtocols (); i++)
223  {
224  int16_t priority;
225  Ptr<Ipv4RoutingProtocol> temp = lrp_Gw->GetRoutingProtocol (i, priority);
226  if (DynamicCast<olsr::RoutingProtocol> (temp))
227  {
228  olsrrp_Gw = DynamicCast<olsr::RoutingProtocol> (temp);
229  }
230  }
231 
232  if (assocMethod1)
233  {
234  // Create a special Ipv4StaticRouting instance for RoutingTableAssociation
235  // Even the Ipv4StaticRouting instance added to list may be used
236  Ptr<Ipv4StaticRouting> hnaEntries = Create<Ipv4StaticRouting> ();
237 
238  // Add the required routes into the Ipv4StaticRouting Protocol instance
239  // and have the node generate HNA messages for all these routes
240  // which are associated with non-OLSR interfaces specified above.
241  hnaEntries->AddNetworkRouteTo (Ipv4Address ("172.16.1.0"), Ipv4Mask ("255.255.255.0"), uint32_t (2), uint32_t (1));
242  olsrrp_Gw->SetRoutingTableAssociation (hnaEntries);
243  }
244 
245  if (assocMethod2)
246  {
247  // Specify the required associations directly.
248  olsrrp_Gw->AddHostNetworkAssociation (Ipv4Address ("172.16.1.0"), Ipv4Mask ("255.255.255.0"));
249  }
250 
251  // Tracing
252  wifiPhy.EnablePcap ("olsr-hna", devices);
253  csma.EnablePcap ("olsr-hna", csmaDevices, false);
254  AsciiTraceHelper ascii;
255  wifiPhy.EnableAsciiAll (ascii.CreateFileStream ("olsr-hna-wifi.tr"));
256  csma.EnableAsciiAll (ascii.CreateFileStream ("olsr-hna-csma.tr"));
257 
259  Seconds (15.0), &GenerateTraffic,
260  source, packetSize, numPackets, interPacketInterval);
261 
262  Simulator::Stop (Seconds (20.0));
263  Simulator::Run ();
265 
266  return 0;
267 }
void EnableAsciiAll(std::string prefix)
Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes c...
Manage ASCII trace files for device models.
Definition: trace-helper.h:163
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Parse command-line arguments.
Definition: command-line.h:229
build a set of CsmaNetDevice objects
Definition: csma-helper.h:47
Class for representing data rates.
Definition: data-rate.h:89
AttributeValue implementation for DataRate.
Definition: data-rate.h:298
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
static Ipv4Address GetAny(void)
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:77
Helper class that adds ns3::Ipv4ListRouting objects.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:256
Helper class that adds ns3::Ipv4StaticRouting objects.
Helper class used to assign positions and mobility models to nodes.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
uint32_t GetId(void) const
Definition: node.cc:109
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
Helper class that adds OLSR routing to nodes.
Definition: olsr-helper.h:41
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:180
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:136
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:556
static void ScheduleWithContext(uint32_t context, Time const &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition: simulator.h:571
static void Run(void)
Run the simulation.
Definition: simulator.cc:172
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
virtual int Close(void)=0
Close a socket.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
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
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Hold variables of type string.
Definition: string.h:41
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
AttributeValue implementation for Time.
Definition: nstime.h:1308
a unique identifier for an interface.
Definition: type-id.h:59
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:829
helps to create WifiNetDevice objects
Definition: wifi-helper.h:274
create MAC layers for a ns3::WifiNetDevice.
void SetType(std::string type, Args &&... args)
void SetPcapDataLinkType(SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:518
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:154
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
Definition: wifi-helper.h:126
manage and create wifi channel objects for the YANS model.
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())
Ptr< YansWifiChannel > Create(void) const
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())
Make it easy to create and manage PHY objects for the YANS model.
void SetChannel(Ptr< YansWifiChannel > channel)
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1252
@ WIFI_STANDARD_80211b
devices
Definition: first.py:39
stack
Definition: first.py:41
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648
Definition: olsr.py:1
csmaNodes
Definition: second.py:53
csma
Definition: second.py:63
cmd
Definition: second.py:35
csmaDevices
Definition: second.py:67
wifi
Definition: third.py:96
mobility
Definition: third.py:108
void ReceivePacket(Ptr< Socket > socket)
Definition: olsr-hna.cc:71
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
Definition: olsr-hna.cc:76
#define list
bool verbose
uint32_t pktSize
packet size used for the simulation (in bytes)
Definition: wifi-bianchi.cc:89
static const uint32_t packetSize