A Discrete-Event Network Simulator
API
wifi-simple-adhoc-grid.cc
Go to the documentation of this file.
1/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2009 University of Washington
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 */
19
20//
21// This program configures a grid (default 5x5) of nodes on an
22// 802.11b physical layer, with
23// 802.11b NICs in adhoc mode, and by default, sends one packet of 1000
24// (application) bytes to node 1.
25//
26// The default layout is like this, on a 2-D grid.
27//
28// n20 n21 n22 n23 n24
29// n15 n16 n17 n18 n19
30// n10 n11 n12 n13 n14
31// n5 n6 n7 n8 n9
32// n0 n1 n2 n3 n4
33//
34// the layout is affected by the parameters given to GridPositionAllocator;
35// by default, GridWidth is 5 and numNodes is 25..
36//
37// There are a number of command-line options available to control
38// the default behavior. The list of available command-line options
39// can be listed with the following command:
40// ./ns3 run "wifi-simple-adhoc-grid --help"
41//
42// Note that all ns-3 attributes (not just the ones exposed in the below
43// script) can be changed at command line; see the ns-3 documentation.
44//
45// For instance, for this configuration, the physical layer will
46// stop successfully receiving packets when distance increases beyond
47// the default of 500m.
48// To see this effect, try running:
49//
50// ./ns3 run "wifi-simple-adhoc-grid --distance=500"
51// ./ns3 run "wifi-simple-adhoc-grid --distance=1000"
52// ./ns3 run "wifi-simple-adhoc-grid --distance=1500"
53//
54// The source node and sink node can be changed like this:
55//
56// ./ns3 run "wifi-simple-adhoc-grid --sourceNode=20 --sinkNode=10"
57//
58// This script can also be helpful to put the Wifi layer into verbose
59// logging mode; this command will turn on all wifi logging:
60//
61// ./ns3 run "wifi-simple-adhoc-grid --verbose=1"
62//
63// By default, trace file writing is off-- to enable it, try:
64// ./ns3 run "wifi-simple-adhoc-grid --tracing=1"
65//
66// When you are done tracing, you will notice many pcap trace files
67// in your directory. If you have tcpdump installed, you can try this:
68//
69// tcpdump -r wifi-simple-adhoc-grid-0-0.pcap -nn -tt
70//
71
72#include "ns3/command-line.h"
73#include "ns3/config.h"
74#include "ns3/uinteger.h"
75#include "ns3/double.h"
76#include "ns3/string.h"
77#include "ns3/log.h"
78#include "ns3/yans-wifi-helper.h"
79#include "ns3/mobility-helper.h"
80#include "ns3/ipv4-address-helper.h"
81#include "ns3/yans-wifi-channel.h"
82#include "ns3/mobility-model.h"
83#include "ns3/olsr-helper.h"
84#include "ns3/ipv4-static-routing-helper.h"
85#include "ns3/ipv4-list-routing-helper.h"
86#include "ns3/internet-stack-helper.h"
87
88using namespace ns3;
89
90NS_LOG_COMPONENT_DEFINE ("WifiSimpleAdhocGrid");
91
93{
94 while (socket->Recv ())
95 {
96 NS_LOG_UNCOND ("Received one packet!");
97 }
98}
99
101 uint32_t pktCount, Time pktInterval )
102{
103 if (pktCount > 0)
104 {
105 socket->Send (Create<Packet> (pktSize));
106 Simulator::Schedule (pktInterval, &GenerateTraffic,
107 socket, pktSize,pktCount - 1, pktInterval);
108 }
109 else
110 {
111 socket->Close ();
112 }
113}
114
115
116int main (int argc, char *argv[])
117{
118 std::string phyMode ("DsssRate1Mbps");
119 double distance = 500; // m
120 uint32_t packetSize = 1000; // bytes
121 uint32_t numPackets = 1;
122 uint32_t numNodes = 25; // by default, 5x5
123 uint32_t sinkNode = 0;
124 uint32_t sourceNode = 24;
125 double interval = 1.0; // seconds
126 bool verbose = false;
127 bool tracing = false;
128
129 CommandLine cmd (__FILE__);
130 cmd.AddValue ("phyMode", "Wifi Phy mode", phyMode);
131 cmd.AddValue ("distance", "distance (m)", distance);
132 cmd.AddValue ("packetSize", "size of application packet sent", packetSize);
133 cmd.AddValue ("numPackets", "number of packets generated", numPackets);
134 cmd.AddValue ("interval", "interval (seconds) between packets", interval);
135 cmd.AddValue ("verbose", "turn on all WifiNetDevice log components", verbose);
136 cmd.AddValue ("tracing", "turn on ascii and pcap tracing", tracing);
137 cmd.AddValue ("numNodes", "number of nodes", numNodes);
138 cmd.AddValue ("sinkNode", "Receiver node number", sinkNode);
139 cmd.AddValue ("sourceNode", "Sender node number", sourceNode);
140 cmd.Parse (argc, argv);
141 // Convert to time object
142 Time interPacketInterval = Seconds (interval);
143
144 // Fix non-unicast data rate to be the same as that of unicast
145 Config::SetDefault ("ns3::WifiRemoteStationManager::NonUnicastMode",
146 StringValue (phyMode));
147
149 c.Create (numNodes);
150
151 // The below set of helpers will help us to put together the wifi NICs we want
153 if (verbose)
154 {
155 wifi.EnableLogComponents (); // Turn on all Wifi logging
156 }
157
158 YansWifiPhyHelper wifiPhy;
159 // set it to zero; otherwise, gain will be added
160 wifiPhy.Set ("RxGain", DoubleValue (-10) );
161 // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
162 wifiPhy.SetPcapDataLinkType (WifiPhyHelper::DLT_IEEE802_11_RADIO);
163
164 YansWifiChannelHelper wifiChannel;
165 wifiChannel.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
166 wifiChannel.AddPropagationLoss ("ns3::FriisPropagationLossModel");
167 wifiPhy.SetChannel (wifiChannel.Create ());
168
169 // Add an upper mac and disable rate control
170 WifiMacHelper wifiMac;
171 wifi.SetStandard (WIFI_STANDARD_80211b);
172 wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
173 "DataMode",StringValue (phyMode),
174 "ControlMode",StringValue (phyMode));
175 // Set it to adhoc mode
176 wifiMac.SetType ("ns3::AdhocWifiMac");
177 NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, c);
178
180 mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
181 "MinX", DoubleValue (0.0),
182 "MinY", DoubleValue (0.0),
183 "DeltaX", DoubleValue (distance),
184 "DeltaY", DoubleValue (distance),
185 "GridWidth", UintegerValue (5),
186 "LayoutType", StringValue ("RowFirst"));
187 mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
188 mobility.Install (c);
189
190 // Enable OLSR
192 Ipv4StaticRoutingHelper staticRouting;
193
195 list.Add (staticRouting, 0);
196 list.Add (olsr, 10);
197
198 InternetStackHelper internet;
199 internet.SetRoutingHelper (list); // has effect on the next Install ()
200 internet.Install (c);
201
203 NS_LOG_INFO ("Assign IP Addresses.");
204 ipv4.SetBase ("10.1.1.0", "255.255.255.0");
206
207 TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
208 Ptr<Socket> recvSink = Socket::CreateSocket (c.Get (sinkNode), tid);
209 InetSocketAddress local = InetSocketAddress (Ipv4Address::GetAny (), 80);
210 recvSink->Bind (local);
212
213 Ptr<Socket> source = Socket::CreateSocket (c.Get (sourceNode), tid);
214 InetSocketAddress remote = InetSocketAddress (i.GetAddress (sinkNode, 0), 80);
215 source->Connect (remote);
216
217 if (tracing == true)
218 {
219 AsciiTraceHelper ascii;
220 wifiPhy.EnableAsciiAll (ascii.CreateFileStream ("wifi-simple-adhoc-grid.tr"));
221 wifiPhy.EnablePcap ("wifi-simple-adhoc-grid", devices);
222 // Trace routing tables
223 Ptr<OutputStreamWrapper> routingStream = Create<OutputStreamWrapper> ("wifi-simple-adhoc-grid.routes", std::ios::out);
224 olsr.PrintRoutingTableAllEvery (Seconds (2), routingStream);
225 Ptr<OutputStreamWrapper> neighborStream = Create<OutputStreamWrapper> ("wifi-simple-adhoc-grid.neighbors", std::ios::out);
226 olsr.PrintNeighborCacheAllEvery (Seconds (2), neighborStream);
227
228 // To do-- enable an IP-level trace that shows forwarding events only
229 }
230
231 // Give OLSR time to converge-- 30 seconds perhaps
232 Simulator::Schedule (Seconds (30.0), &GenerateTraffic,
233 source, packetSize, numPackets, interPacketInterval);
234
235 // Output what we are doing
236 NS_LOG_UNCOND ("Testing from node " << sourceNode << " to " << sinkNode << " with grid distance " << distance);
237
238 Simulator::Stop (Seconds (33.0));
239 Simulator::Run ();
240 Simulator::Destroy ();
241
242 return 0;
243}
244
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
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...
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.
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:41
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
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 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
virtual Ptr< Packet > Recv(uint32_t maxSize, uint32_t flags)=0
Read data from the socket.
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
a unique identifier for an interface.
Definition: type-id.h:59
Hold an unsigned integer type.
Definition: uinteger.h:44
helps to create WifiNetDevice objects
Definition: wifi-helper.h:323
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:574
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:141
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
@ WIFI_STANDARD_80211b
devices
Definition: first.py:39
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
cmd
Definition: second.py:35
wifi
Definition: third.py:99
mobility
Definition: third.py:107
#define list
bool verbose
bool tracing
Flag to enable/disable generation of tracing files.
Definition: wifi-bianchi.cc:88
uint32_t pktSize
packet size used for the simulation (in bytes)
Definition: wifi-bianchi.cc:89
static const uint32_t packetSize
Pcket size generated at the AP.
void ReceivePacket(Ptr< Socket > socket)
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)