A Discrete-Event Network Simulator
API
wifi-simple-adhoc.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 The Boeing Company
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  */
18 
19 // This script configures two nodes on an 802.11b physical layer, with
20 // 802.11b NICs in adhoc mode, and by default, sends one packet of 1000
21 // (application) bytes to the other node. The physical layer is configured
22 // to receive at a fixed RSS (regardless of the distance and transmit
23 // power); therefore, changing position of the nodes has no effect.
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 --help"
29 //
30 // For instance, for this configuration, the physical layer will
31 // stop successfully receiving packets when rss drops below -97 dBm.
32 // To see this effect, try running:
33 //
34 // ./ns3 run "wifi-simple-adhoc --rss=-97 --numPackets=20"
35 // ./ns3 run "wifi-simple-adhoc --rss=-98 --numPackets=20"
36 // ./ns3 run "wifi-simple-adhoc --rss=-99 --numPackets=20"
37 //
38 // Note that all ns-3 attributes (not just the ones exposed in the below
39 // script) can be changed at command line; see the documentation.
40 //
41 // This script can also be helpful to put the Wifi layer into verbose
42 // logging mode; this command will turn on all wifi logging:
43 //
44 // ./ns3 run "wifi-simple-adhoc --verbose=1"
45 //
46 // When you are done, you will notice two pcap trace files in your directory.
47 // If you have tcpdump installed, you can try this:
48 //
49 // tcpdump -r wifi-simple-adhoc-0-0.pcap -nn -tt
50 //
51 
52 #include "ns3/command-line.h"
53 #include "ns3/config.h"
54 #include "ns3/double.h"
55 #include "ns3/internet-stack-helper.h"
56 #include "ns3/ipv4-address-helper.h"
57 #include "ns3/log.h"
58 #include "ns3/mobility-helper.h"
59 #include "ns3/mobility-model.h"
60 #include "ns3/string.h"
61 #include "ns3/yans-wifi-channel.h"
62 #include "ns3/yans-wifi-helper.h"
63 
64 using namespace ns3;
65 
66 NS_LOG_COMPONENT_DEFINE("WifiSimpleAdhoc");
67 
73 void
75 {
76  while (socket->Recv())
77  {
78  NS_LOG_UNCOND("Received one packet!");
79  }
80 }
81 
90 static void
91 GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
92 {
93  if (pktCount > 0)
94  {
95  socket->Send(Create<Packet>(pktSize));
96  Simulator::Schedule(pktInterval,
98  socket,
99  pktSize,
100  pktCount - 1,
101  pktInterval);
102  }
103  else
104  {
105  socket->Close();
106  }
107 }
108 
109 int
110 main(int argc, char* argv[])
111 {
112  std::string phyMode("DsssRate1Mbps");
113  double rss = -80; // -dBm
114  uint32_t packetSize = 1000; // bytes
115  uint32_t numPackets = 1;
116  double interval = 1.0; // seconds
117  bool verbose = false;
118 
119  CommandLine cmd(__FILE__);
120  cmd.AddValue("phyMode", "Wifi Phy mode", phyMode);
121  cmd.AddValue("rss", "received signal strength", rss);
122  cmd.AddValue("packetSize", "size of application packet sent", packetSize);
123  cmd.AddValue("numPackets", "number of packets generated", numPackets);
124  cmd.AddValue("interval", "interval (seconds) between packets", interval);
125  cmd.AddValue("verbose", "turn on all WifiNetDevice log components", verbose);
126  cmd.Parse(argc, argv);
127  // Convert to time object
128  Time interPacketInterval = Seconds(interval);
129 
130  // Fix non-unicast data rate to be the same as that of unicast
131  Config::SetDefault("ns3::WifiRemoteStationManager::NonUnicastMode", StringValue(phyMode));
132 
133  NodeContainer c;
134  c.Create(2);
135 
136  // The below set of helpers will help us to put together the wifi NICs we want
138  if (verbose)
139  {
140  WifiHelper::EnableLogComponents(); // Turn on all Wifi logging
141  }
142  wifi.SetStandard(WIFI_STANDARD_80211b);
143 
144  YansWifiPhyHelper wifiPhy;
145  // This is one parameter that matters when using FixedRssLossModel
146  // set it to zero; otherwise, gain will be added
147  wifiPhy.Set("RxGain", DoubleValue(0));
148  // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
150 
151  YansWifiChannelHelper wifiChannel;
152  wifiChannel.SetPropagationDelay("ns3::ConstantSpeedPropagationDelayModel");
153  // The below FixedRssLossModel will cause the rss to be fixed regardless
154  // of the distance between the two stations, and the transmit power
155  wifiChannel.AddPropagationLoss("ns3::FixedRssLossModel", "Rss", DoubleValue(rss));
156  wifiPhy.SetChannel(wifiChannel.Create());
157 
158  // Add a mac and disable rate control
159  WifiMacHelper wifiMac;
160  wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
161  "DataMode",
162  StringValue(phyMode),
163  "ControlMode",
164  StringValue(phyMode));
165  // Set it to adhoc mode
166  wifiMac.SetType("ns3::AdhocWifiMac");
167  NetDeviceContainer devices = wifi.Install(wifiPhy, wifiMac, c);
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(c);
178 
179  InternetStackHelper internet;
180  internet.Install(c);
181 
182  Ipv4AddressHelper ipv4;
183  NS_LOG_INFO("Assign IP Addresses.");
184  ipv4.SetBase("10.1.1.0", "255.255.255.0");
186 
187  TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
188  Ptr<Socket> recvSink = Socket::CreateSocket(c.Get(0), tid);
190  recvSink->Bind(local);
192 
193  Ptr<Socket> source = Socket::CreateSocket(c.Get(1), tid);
194  InetSocketAddress remote = InetSocketAddress(Ipv4Address("255.255.255.255"), 80);
195  source->SetAllowBroadcast(true);
196  source->Connect(remote);
197 
198  // Tracing
199  wifiPhy.EnablePcap("wifi-simple-adhoc", devices);
200 
201  // Output what we are doing
202  NS_LOG_UNCOND("Testing " << numPackets << " packets sent with receiver rss " << rss);
203 
205  Seconds(1.0),
207  source,
208  packetSize,
209  numPackets,
210  interPacketInterval);
211 
212  Simulator::Run();
214 
215  return 0;
216 }
Parse command-line arguments.
Definition: command-line.h:232
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...
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()
holds a vector of std::pair of Ptr<Ipv4> and interface index.
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
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
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
void SetRecvCallback(Callback< void, Ptr< Socket >> receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:126
virtual Ptr< Packet > Recv(uint32_t maxSize, uint32_t flags)=0
Read data from the socket.
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
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
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1336
@ WIFI_STANDARD_80211b
devices
Definition: first.py:35
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
cmd
Definition: second.py:33
wifi
Definition: third.py:88
mobility
Definition: third.py:96
bool verbose
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.