A Discrete-Event Network Simulator
API
olsr-hna.cc
Go to the documentation of this file.
1 /*
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * Authors: Lalith Suresh <suresh.lalith@gmail.com>
17  *
18  */
19 
20 //
21 // This script, adapted from examples/wireless/wifi-simple-adhoc illustrates
22 // the use of OLSR HNA.
23 //
24 // Network Topology:
25 //
26 // |------ OLSR ------| |---- non-OLSR ----|
27 // A )))) (((( B ------------------- C
28 // 10.1.1.1 10.1.1.2 172.16.1.2 172.16.1.1
29 //
30 // Node A needs to send a UDP packet to node C. This can be done only after
31 // A receives an HNA message from B, in which B announces 172.16.1.0/24
32 // as an associated network.
33 //
34 // If no HNA message is generated by B, a will not be able to form a route to C.
35 // This can be verified as follows:
36 //
37 // ./ns3 run olsr-hna
38 //
39 // There are two ways to make a node to generate HNA messages.
40 //
41 // One way is to use olsr::RoutingProtocol::SetRoutingTableAssociation ()
42 // to use which you may run:
43 //
44 // ./ns3 run "olsr-hna --assocMethod1=1"
45 //
46 // The other way is to use olsr::RoutingProtocol::AddHostNetworkAssociation ()
47 // to use which you may run:
48 //
49 // ./ns3 run "olsr-hna --assocMethod2=1"
50 //
51 
52 #include "ns3/config-store-module.h"
53 #include "ns3/core-module.h"
54 #include "ns3/csma-module.h"
55 #include "ns3/internet-module.h"
56 #include "ns3/mobility-module.h"
57 #include "ns3/network-module.h"
58 #include "ns3/olsr-helper.h"
59 #include "ns3/olsr-routing-protocol.h"
60 #include "ns3/yans-wifi-helper.h"
61 
62 #include <fstream>
63 #include <iostream>
64 #include <string>
65 #include <vector>
66 
67 using namespace ns3;
68 
69 NS_LOG_COMPONENT_DEFINE("OlsrHna");
70 
71 void
73 {
74  NS_LOG_UNCOND("Received one packet!");
75 }
76 
77 static void
78 GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
79 {
80  if (pktCount > 0)
81  {
82  socket->Send(Create<Packet>(pktSize));
83  Simulator::Schedule(pktInterval,
85  socket,
86  pktSize,
87  pktCount - 1,
88  pktInterval);
89  }
90  else
91  {
92  socket->Close();
93  }
94 }
95 
96 int
97 main(int argc, char* argv[])
98 {
99  std::string phyMode("DsssRate1Mbps");
100  double rss = -80; // -dBm
101  uint32_t packetSize = 1000; // bytes
102  uint32_t numPackets = 1;
103  double interval = 1.0; // seconds
104  bool verbose = false;
105  bool assocMethod1 = false;
106  bool assocMethod2 = false;
107 
108  CommandLine cmd(__FILE__);
109 
110  cmd.AddValue("phyMode", "Wifi Phy mode", phyMode);
111  cmd.AddValue("rss", "received signal strength", rss);
112  cmd.AddValue("packetSize", "size of application packet sent", packetSize);
113  cmd.AddValue("numPackets", "number of packets generated", numPackets);
114  cmd.AddValue("interval", "interval (seconds) between packets", interval);
115  cmd.AddValue("verbose", "turn on all WifiNetDevice log components", verbose);
116  cmd.AddValue("assocMethod1", "Use SetRoutingTableAssociation () method", assocMethod1);
117  cmd.AddValue("assocMethod2", "Use AddHostNetworkAssociation () method", assocMethod2);
118 
119  cmd.Parse(argc, argv);
120  // Convert to time object
121  Time interPacketInterval = Seconds(interval);
122 
123  // disable fragmentation for frames below 2200 bytes
124  Config::SetDefault("ns3::WifiRemoteStationManager::FragmentationThreshold",
125  StringValue("2200"));
126  // turn off RTS/CTS for frames below 2200 bytes
127  Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("2200"));
128  // Fix non-unicast data rate to be the same as that of unicast
129  Config::SetDefault("ns3::WifiRemoteStationManager::NonUnicastMode", StringValue(phyMode));
130 
131  NodeContainer olsrNodes;
132  olsrNodes.Create(2);
133 
135  csmaNodes.Create(1);
136 
137  // The below set of helpers will help us to put together the wifi NICs we want
139  if (verbose)
140  {
141  WifiHelper::EnableLogComponents(); // Turn on all Wifi logging
142  }
143  wifi.SetStandard(WIFI_STANDARD_80211b);
144 
145  YansWifiPhyHelper wifiPhy;
146  // This is one parameter that matters when using FixedRssLossModel
147  // set it to zero; otherwise, gain will be added
148  wifiPhy.Set("RxGain", DoubleValue(0));
149  // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
151 
152  YansWifiChannelHelper wifiChannel;
153  wifiChannel.SetPropagationDelay("ns3::ConstantSpeedPropagationDelayModel");
154  // The below FixedRssLossModel will cause the rss to be fixed regardless
155  // of the distance between the two stations, and the transmit power
156  wifiChannel.AddPropagationLoss("ns3::FixedRssLossModel", "Rss", DoubleValue(rss));
157  wifiPhy.SetChannel(wifiChannel.Create());
158 
159  // Add a mac and disable rate control
160  WifiMacHelper wifiMac;
161  wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
162  "DataMode",
163  StringValue(phyMode),
164  "ControlMode",
165  StringValue(phyMode));
166  // Set it to adhoc mode
167  wifiMac.SetType("ns3::AdhocWifiMac");
168  NetDeviceContainer devices = wifi.Install(wifiPhy, wifiMac, olsrNodes);
169 
171  csma.SetChannelAttribute("DataRate", DataRateValue(DataRate(5000000)));
172  csma.SetChannelAttribute("Delay", TimeValue(MilliSeconds(2)));
174  csma.Install(NodeContainer(csmaNodes.Get(0), olsrNodes.Get(1)));
175 
176  // Note that with FixedRssLossModel, the positions below are not
177  // used for received signal strength.
179  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
180  positionAlloc->Add(Vector(0.0, 0.0, 0.0));
181  positionAlloc->Add(Vector(5.0, 0.0, 0.0));
182  mobility.SetPositionAllocator(positionAlloc);
183  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
184  mobility.Install(olsrNodes);
185 
187 
188  // Specify Node B's csma device as a non-OLSR device.
189  olsr.ExcludeInterface(olsrNodes.Get(1), 2);
190 
191  Ipv4StaticRoutingHelper staticRouting;
192 
194  list.Add(staticRouting, 0);
195  list.Add(olsr, 10);
196 
197  InternetStackHelper internet_olsr;
198  internet_olsr.SetRoutingHelper(list); // has effect on the next Install ()
199  internet_olsr.Install(olsrNodes);
200 
201  InternetStackHelper internet_csma;
202  internet_csma.Install(csmaNodes);
203 
204  Ipv4AddressHelper ipv4;
205  NS_LOG_INFO("Assign IP Addresses.");
206  ipv4.SetBase("10.1.1.0", "255.255.255.0");
207  ipv4.Assign(devices);
208 
209  ipv4.SetBase("172.16.1.0", "255.255.255.0");
210  ipv4.Assign(csmaDevices);
211 
212  TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
213  Ptr<Socket> recvSink = Socket::CreateSocket(csmaNodes.Get(0), tid);
215  recvSink->Bind(local);
217 
218  Ptr<Socket> source = Socket::CreateSocket(olsrNodes.Get(0), tid);
219  InetSocketAddress remote = InetSocketAddress(Ipv4Address("172.16.1.1"), 80);
220  source->Connect(remote);
221 
222  // Obtain olsr::RoutingProtocol instance of gateway node
223  // (namely, node B) and add the required association
224  Ptr<Ipv4> stack = olsrNodes.Get(1)->GetObject<Ipv4>();
225  Ptr<Ipv4RoutingProtocol> rp_Gw = (stack->GetRoutingProtocol());
226  Ptr<Ipv4ListRouting> lrp_Gw = DynamicCast<Ipv4ListRouting>(rp_Gw);
227 
228  Ptr<olsr::RoutingProtocol> olsrrp_Gw;
229 
230  for (uint32_t i = 0; i < lrp_Gw->GetNRoutingProtocols(); i++)
231  {
232  int16_t priority;
233  Ptr<Ipv4RoutingProtocol> temp = lrp_Gw->GetRoutingProtocol(i, priority);
234  if (DynamicCast<olsr::RoutingProtocol>(temp))
235  {
236  olsrrp_Gw = DynamicCast<olsr::RoutingProtocol>(temp);
237  }
238  }
239 
240  if (assocMethod1)
241  {
242  // Create a special Ipv4StaticRouting instance for RoutingTableAssociation
243  // Even the Ipv4StaticRouting instance added to list may be used
244  Ptr<Ipv4StaticRouting> hnaEntries = Create<Ipv4StaticRouting>();
245 
246  // Add the required routes into the Ipv4StaticRouting Protocol instance
247  // and have the node generate HNA messages for all these routes
248  // which are associated with non-OLSR interfaces specified above.
249  hnaEntries->AddNetworkRouteTo(Ipv4Address("172.16.1.0"),
250  Ipv4Mask("255.255.255.0"),
251  uint32_t(2),
252  uint32_t(1));
253  olsrrp_Gw->SetRoutingTableAssociation(hnaEntries);
254  }
255 
256  if (assocMethod2)
257  {
258  // Specify the required associations directly.
259  olsrrp_Gw->AddHostNetworkAssociation(Ipv4Address("172.16.1.0"), Ipv4Mask("255.255.255.0"));
260  }
261 
262  // Tracing
263  wifiPhy.EnablePcap("olsr-hna", devices);
264  csma.EnablePcap("olsr-hna", csmaDevices, false);
265  AsciiTraceHelper ascii;
266  wifiPhy.EnableAsciiAll(ascii.CreateFileStream("olsr-hna-wifi.tr"));
267  csma.EnableAsciiAll(ascii.CreateFileStream("olsr-hna-csma.tr"));
268 
270  Seconds(15.0),
272  source,
273  packetSize,
274  numPackets,
275  interPacketInterval);
276 
277  Simulator::Stop(Seconds(20.0));
278  Simulator::Run();
280 
281  return 0;
282 }
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:173
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:232
build a set of CsmaNetDevice objects
Definition: csma-helper.h:48
AttributeValue implementation for DataRate.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
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:43
static Ipv4Address GetAny()
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:79
Helper class that adds ns3::Ipv4ListRouting objects.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:258
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() const
Definition: node.cc:117
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
Helper class that adds OLSR routing to nodes.
Definition: olsr-helper.h:42
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:568
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:140
static void ScheduleWithContext(uint32_t context, const Time &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition: simulator.h:587
static void Run()
Run the simulation.
Definition: simulator.cc:176
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:184
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetRecvCallback(Callback< void, Ptr< Socket >> receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:126
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual Ptr< Node > GetNode() const =0
Return the node this socket is associated with.
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:72
virtual int Close()=0
Close a socket.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Hold variables of type string.
Definition: string.h:56
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
AttributeValue implementation for Time.
Definition: nstime.h:1423
a unique identifier for an interface.
Definition: type-id.h:60
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:839
helps to create WifiNetDevice objects
Definition: wifi-helper.h:325
static void EnableLogComponents()
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:880
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:543
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:163
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
Definition: wifi-helper.h:179
manage and create wifi channel objects for the YANS model.
void SetPropagationDelay(std::string name, Ts &&... args)
void AddPropagationLoss(std::string name, Ts &&... args)
Ptr< YansWifiChannel > Create() const
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:891
#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:202
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
void(* DataRate)(DataRate oldValue, DataRate newValue)
TracedValue callback signature for DataRate.
Definition: data-rate.h:328
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1336
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1348
@ WIFI_STANDARD_80211b
devices
Definition: first.py:35
stack
Definition: first.py:37
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:707
Definition: olsr.py:1
csmaNodes
Definition: second.py:46
csma
Definition: second.py:56
cmd
Definition: second.py:33
csmaDevices
Definition: second.py:60
wifi
Definition: third.py:88
mobility
Definition: third.py:96
void ReceivePacket(Ptr< Socket > socket)
Definition: olsr-hna.cc:72
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
Definition: olsr-hna.cc:78
#define list
bool verbose
uint32_t pktSize
packet size used for the simulation (in bytes)
static const uint32_t packetSize
Packet size generated at the AP.