A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
wifi-simple-adhoc-grid.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 University of Washington
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8//
9// This program configures a grid (default 5x5) of nodes on an
10// 802.11b physical layer, with
11// 802.11b NICs in adhoc mode, and by default, sends one packet of 1000
12// (application) bytes to node 1.
13//
14// The default layout is like this, on a 2-D grid.
15//
16// n20 n21 n22 n23 n24
17// n15 n16 n17 n18 n19
18// n10 n11 n12 n13 n14
19// n5 n6 n7 n8 n9
20// n0 n1 n2 n3 n4
21//
22// the layout is affected by the parameters given to GridPositionAllocator;
23// by default, GridWidth is 5 (nodes per row) and numNodes is 25..
24//
25// There are a number of command-line options available to control
26// the default behavior. The list of available command-line options
27// can be listed with the following command:
28// ./ns3 run "wifi-simple-adhoc-grid --help"
29//
30// Note that all ns-3 attributes (not just the ones exposed in the below
31// script) can be changed at command line; see the ns-3 documentation.
32//
33// For instance, for this configuration, the physical layer will
34// stop successfully receiving packets when distance increases beyond
35// the default of 100m. The cutoff is around 116m; below that value, the
36// received signal strength falls below the (default) RSSI limit of -82 dBm
37// used by Wi-Fi's threshold preamble detection running.
38//
39// To see this effect, try running at a larger distance, and no packet
40// reception will be reported:
41//
42// ./ns3 run "wifi-simple-adhoc-grid --distance=200"
43//
44// The default path through the topology will follow the following node
45// numbers: 24->23->18->13->12->11->10->5->0
46//
47// To see this, the following Bash commands will list the UDP packet
48// transmissions hop-by-hop, if tracing is enabled:
49//
50// ./ns3 run "wifi-simple-adhoc-grid --tracing=1"
51// grep ^t wifi-simple-adhoc-grid.tr | grep Udp | grep -v olsr | less
52//
53// By changing the distance to a smaller value, more nodes can be reached
54// by each transmission, and the number of forwarding hops will decrease.
55//
56// The source node and sink node can be changed like this:
57//
58// ./ns3 run "wifi-simple-adhoc-grid --sourceNode=20 --sinkNode=10"
59//
60// This script can also be helpful to put the Wifi layer into verbose
61// logging mode; this command will turn on all wifi logging:
62//
63// ./ns3 run "wifi-simple-adhoc-grid --verbose=1"
64//
65// By default, trace file writing is off-- to enable it, try:
66// ./ns3 run "wifi-simple-adhoc-grid --tracing=1"
67//
68// When you are done tracing, you will notice many pcap trace files
69// in your directory. If you have tcpdump installed, you can try this:
70//
71// tcpdump -r wifi-simple-adhoc-grid-0-0.pcap -nn -tt
72//
73// or you can examine the text-based trace wifi-simple-adhoc-grid.tr with
74// an editor.
75//
76
77#include "ns3/command-line.h"
78#include "ns3/config.h"
79#include "ns3/double.h"
80#include "ns3/internet-stack-helper.h"
81#include "ns3/ipv4-address-helper.h"
82#include "ns3/ipv4-list-routing-helper.h"
83#include "ns3/ipv4-static-routing-helper.h"
84#include "ns3/log.h"
85#include "ns3/mobility-helper.h"
86#include "ns3/mobility-model.h"
87#include "ns3/olsr-helper.h"
88#include "ns3/string.h"
89#include "ns3/uinteger.h"
90#include "ns3/yans-wifi-channel.h"
91#include "ns3/yans-wifi-helper.h"
92
93using namespace ns3;
94
95NS_LOG_COMPONENT_DEFINE("WifiSimpleAdhocGrid");
96
97/**
98 * Function called when a packet is received.
99 *
100 * \param socket The receiving socket.
101 */
102void
104{
105 while (socket->Recv())
106 {
107 NS_LOG_UNCOND("Received one packet!");
108 }
109}
110
111/**
112 * Generate traffic.
113 *
114 * \param socket The sending socket.
115 * \param pktSize The packet size.
116 * \param pktCount The packet count.
117 * \param pktInterval The interval between two packets.
118 */
119static void
121{
122 if (pktCount > 0)
123 {
124 socket->Send(Create<Packet>(pktSize));
125 Simulator::Schedule(pktInterval,
127 socket,
128 pktSize,
129 pktCount - 1,
130 pktInterval);
131 }
132 else
133 {
134 socket->Close();
135 }
136}
137
138int
139main(int argc, char* argv[])
140{
141 std::string phyMode{"DsssRate1Mbps"};
142 meter_u distance{100};
143 uint32_t packetSize{1000}; // bytes
144 uint32_t numPackets{1};
145 uint32_t numNodes{25}; // by default, 5x5
146 uint32_t sinkNode{0};
147 uint32_t sourceNode{24};
148 Time interPacketInterval{"1s"};
149 bool verbose{false};
150 bool tracing{false};
151
152 CommandLine cmd(__FILE__);
153 cmd.AddValue("phyMode", "Wifi Phy mode", phyMode);
154 cmd.AddValue("distance", "distance (m)", distance);
155 cmd.AddValue("packetSize", "size of application packet sent", packetSize);
156 cmd.AddValue("numPackets", "number of packets generated", numPackets);
157 cmd.AddValue("interval", "interval (seconds) between packets", interPacketInterval);
158 cmd.AddValue("verbose", "turn on all WifiNetDevice log components", verbose);
159 cmd.AddValue("tracing", "turn on ascii and pcap tracing", tracing);
160 cmd.AddValue("numNodes", "number of nodes", numNodes);
161 cmd.AddValue("sinkNode", "Receiver node number", sinkNode);
162 cmd.AddValue("sourceNode", "Sender node number", sourceNode);
163 cmd.Parse(argc, argv);
164
165 // Fix non-unicast data rate to be the same as that of unicast
166 Config::SetDefault("ns3::WifiRemoteStationManager::NonUnicastMode", StringValue(phyMode));
167
169 c.Create(numNodes);
170
171 // The below set of helpers will help us to put together the wifi NICs we want
173 if (verbose)
174 {
175 WifiHelper::EnableLogComponents(); // Turn on all Wifi logging
176 }
177
178 YansWifiPhyHelper wifiPhy;
179 // set it to zero; otherwise, gain will be added
180 wifiPhy.Set("RxGain", DoubleValue(-10));
181 // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
183
184 YansWifiChannelHelper wifiChannel;
185 wifiChannel.SetPropagationDelay("ns3::ConstantSpeedPropagationDelayModel");
186 wifiChannel.AddPropagationLoss("ns3::FriisPropagationLossModel");
187 wifiPhy.SetChannel(wifiChannel.Create());
188
189 // Add an upper mac and disable rate control
190 WifiMacHelper wifiMac;
191 wifi.SetStandard(WIFI_STANDARD_80211b);
192 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
193 "DataMode",
194 StringValue(phyMode),
195 "ControlMode",
196 StringValue(phyMode));
197 // Set it to adhoc mode
198 wifiMac.SetType("ns3::AdhocWifiMac");
199 NetDeviceContainer devices = wifi.Install(wifiPhy, wifiMac, c);
200
202 mobility.SetPositionAllocator("ns3::GridPositionAllocator",
203 "MinX",
204 DoubleValue(0.0),
205 "MinY",
206 DoubleValue(0.0),
207 "DeltaX",
208 DoubleValue(distance),
209 "DeltaY",
210 DoubleValue(distance),
211 "GridWidth",
212 UintegerValue(5),
213 "LayoutType",
214 StringValue("RowFirst"));
215 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
216 mobility.Install(c);
217
218 // Enable OLSR
220 Ipv4StaticRoutingHelper staticRouting;
221
223 list.Add(staticRouting, 0);
224 list.Add(olsr, 10);
225
227 internet.SetRoutingHelper(list); // has effect on the next Install ()
228 internet.Install(c);
229
231 NS_LOG_INFO("Assign IP Addresses.");
232 ipv4.SetBase("10.1.1.0", "255.255.255.0");
233 Ipv4InterfaceContainer i = ipv4.Assign(devices);
234
235 TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
236 Ptr<Socket> recvSink = Socket::CreateSocket(c.Get(sinkNode), tid);
238 recvSink->Bind(local);
239 recvSink->SetRecvCallback(MakeCallback(&ReceivePacket));
240
241 Ptr<Socket> source = Socket::CreateSocket(c.Get(sourceNode), tid);
242 InetSocketAddress remote = InetSocketAddress(i.GetAddress(sinkNode, 0), 80);
243 source->Connect(remote);
244
245 if (tracing)
246 {
247 AsciiTraceHelper ascii;
248 wifiPhy.EnableAsciiAll(ascii.CreateFileStream("wifi-simple-adhoc-grid.tr"));
249 wifiPhy.EnablePcap("wifi-simple-adhoc-grid", devices);
250 // Trace routing tables
251 Ptr<OutputStreamWrapper> routingStream =
252 Create<OutputStreamWrapper>("wifi-simple-adhoc-grid.routes", std::ios::out);
254 Ptr<OutputStreamWrapper> neighborStream =
255 Create<OutputStreamWrapper>("wifi-simple-adhoc-grid.neighbors", std::ios::out);
257
258 // To do-- enable an IP-level trace that shows forwarding events only
259 }
260
261 // Give OLSR time to converge-- 30 seconds perhaps
264 source,
266 numPackets,
267 interPacketInterval);
268
269 // Output what we are doing
270 NS_LOG_UNCOND("Testing from node " << sourceNode << " to " << sinkNode << " with grid distance "
271 << distance);
272
276
277 return 0;
278}
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.
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.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
static Ipv4Address GetAny()
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Helper class that adds ns3::Ipv4ListRouting objects.
void Add(const Ipv4RoutingHelper &routing, int16_t priority)
static void PrintNeighborCacheAllEvery(Time printInterval, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the neighbor cache of all nodes at regular intervals specified by user.
static void PrintRoutingTableAllEvery(Time printInterval, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of all nodes at regular intervals specified by user.
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.
Helper class that adds OLSR routing to nodes.
Definition olsr-helper.h:31
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
Smart pointer class similar to boost::intrusive_ptr.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition simulator.h:560
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition simulator.cc:131
static void Run()
Run the simulation.
Definition simulator.cc:167
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition simulator.cc:175
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:61
Hold variables of type string.
Definition string.h:45
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
a unique identifier for an interface.
Definition type-id.h:48
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition type-id.cc:872
Hold an unsigned integer type.
Definition uinteger.h:34
helps to create WifiNetDevice objects
static void EnableLogComponents(LogLevel logLevel=LOG_LEVEL_ALL)
Helper to enable all WifiNetDevice log components with one statement.
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.
void Set(std::string name, const AttributeValue &v)
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
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:883
#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:191
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition log.h:264
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Definition ptr.h:436
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition nstime.h:1308
@ WIFI_STANDARD_80211b
devices
Definition first.py:31
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:684
Definition olsr.py:1
wifi
Definition third.py:84
mobility
Definition third.py:92
#define list
bool verbose
bool tracing
Flag to enable/disable generation of tracing files.
uint32_t pktSize
packet size used for the simulation (in bytes)
static const uint32_t packetSize
Packet size generated at the AP.
void ReceivePacket(Ptr< Socket > socket)
Function called when a packet is received.
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
Generate traffic.