A Discrete-Event Network Simulator
API
wifi-simple-infra.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 The Boeing Company
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 // This script configures two nodes on an 802.11b physical layer, with
21 // 802.11b NICs in infrastructure mode, and by default, the station sends
22 // one packet of 1000 (application) bytes to the access point. The
23 // physical layer is configured
24 // to receive at a fixed RSS (regardless of the distance and transmit
25 // power); therefore, changing position of the nodes has no effect.
26 //
27 // There are a number of command-line options available to control
28 // the default behavior. The list of available command-line options
29 // can be listed with the following command:
30 // ./waf --run "wifi-simple-infra --help"
31 //
32 // For instance, for this configuration, the physical layer will
33 // stop successfully receiving packets when rss drops below -97 dBm.
34 // To see this effect, try running:
35 //
36 // ./waf --run "wifi-simple-infra --rss=-97 --numPackets=20"
37 // ./waf --run "wifi-simple-infra --rss=-98 --numPackets=20"
38 // ./waf --run "wifi-simple-infra --rss=-99 --numPackets=20"
39 //
40 // Note that all ns-3 attributes (not just the ones exposed in the below
41 // script) can be changed at command line; see the documentation.
42 //
43 // This script can also be helpful to put the Wifi layer into verbose
44 // logging mode; this command will turn on all wifi logging:
45 //
46 // ./waf --run "wifi-simple-infra --verbose=1"
47 //
48 // When you are done, you will notice two pcap trace files in your directory.
49 // If you have tcpdump installed, you can try this:
50 //
51 // tcpdump -r wifi-simple-infra-0-0.pcap -nn -tt
52 //
53 
54 #include "ns3/command-line.h"
55 #include "ns3/config.h"
56 #include "ns3/double.h"
57 #include "ns3/string.h"
58 #include "ns3/log.h"
59 #include "ns3/yans-wifi-helper.h"
60 #include "ns3/ssid.h"
61 #include "ns3/mobility-helper.h"
62 #include "ns3/ipv4-address-helper.h"
63 #include "ns3/yans-wifi-channel.h"
64 #include "ns3/mobility-model.h"
65 #include "ns3/internet-stack-helper.h"
66 
67 using namespace ns3;
68 
69 NS_LOG_COMPONENT_DEFINE ("WifiSimpleInfra");
70 
72 {
73  while (socket->Recv ())
74  {
75  NS_LOG_UNCOND ("Received one packet!");
76  }
77 }
78 
79 static void GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize,
80  uint32_t pktCount, Time pktInterval )
81 {
82  if (pktCount > 0)
83  {
84  socket->Send (Create<Packet> (pktSize));
85  Simulator::Schedule (pktInterval, &GenerateTraffic,
86  socket, pktSize,pktCount - 1, pktInterval);
87  }
88  else
89  {
90  socket->Close ();
91  }
92 }
93 
94 int main (int argc, char *argv[])
95 {
96  std::string phyMode ("DsssRate1Mbps");
97  double rss = -80; // -dBm
98  uint32_t packetSize = 1000; // bytes
99  uint32_t numPackets = 1;
100  double interval = 1.0; // seconds
101  bool verbose = false;
102 
104  cmd.AddValue ("phyMode", "Wifi Phy mode", phyMode);
105  cmd.AddValue ("rss", "received signal strength", rss);
106  cmd.AddValue ("packetSize", "size of application packet sent", packetSize);
107  cmd.AddValue ("numPackets", "number of packets generated", numPackets);
108  cmd.AddValue ("interval", "interval (seconds) between packets", interval);
109  cmd.AddValue ("verbose", "turn on all WifiNetDevice log components", verbose);
110  cmd.Parse (argc, argv);
111  // Convert to time object
112  Time interPacketInterval = Seconds (interval);
113 
114  // Fix non-unicast data rate to be the same as that of unicast
115  Config::SetDefault ("ns3::WifiRemoteStationManager::NonUnicastMode",
116  StringValue (phyMode));
117 
118  NodeContainer c;
119  c.Create (2);
120 
121  // The below set of helpers will help us to put together the wifi NICs we want
123  if (verbose)
124  {
125  wifi.EnableLogComponents (); // Turn on all Wifi logging
126  }
127  wifi.SetStandard (WIFI_PHY_STANDARD_80211b);
128 
130  // This is one parameter that matters when using FixedRssLossModel
131  // set it to zero; otherwise, gain will be added
132  wifiPhy.Set ("RxGain", DoubleValue (0) );
133  // ns-3 supports RadioTap and Prism tracing extensions for 802.11b
135 
136  YansWifiChannelHelper wifiChannel;
137  wifiChannel.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
138  // The below FixedRssLossModel will cause the rss to be fixed regardless
139  // of the distance between the two stations, and the transmit power
140  wifiChannel.AddPropagationLoss ("ns3::FixedRssLossModel","Rss",DoubleValue (rss));
141  wifiPhy.SetChannel (wifiChannel.Create ());
142 
143  // Add a mac and disable rate control
144  WifiMacHelper wifiMac;
145  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
146  "DataMode",StringValue (phyMode),
147  "ControlMode",StringValue (phyMode));
148 
149  // Setup the rest of the mac
150  Ssid ssid = Ssid ("wifi-default");
151  // setup sta.
152  wifiMac.SetType ("ns3::StaWifiMac",
153  "Ssid", SsidValue (ssid));
154  NetDeviceContainer staDevice = wifi.Install (wifiPhy, wifiMac, c.Get (0));
155  NetDeviceContainer devices = staDevice;
156  // setup ap.
157  wifiMac.SetType ("ns3::ApWifiMac",
158  "Ssid", SsidValue (ssid));
159  NetDeviceContainer apDevice = wifi.Install (wifiPhy, wifiMac, c.Get (1));
160  devices.Add (apDevice);
161 
162  // Note that with FixedRssLossModel, the positions below are not
163  // used for received signal strength.
165  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
166  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
167  positionAlloc->Add (Vector (5.0, 0.0, 0.0));
168  mobility.SetPositionAllocator (positionAlloc);
169  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
170  mobility.Install (c);
171 
172  InternetStackHelper internet;
173  internet.Install (c);
174 
175  Ipv4AddressHelper ipv4;
176  NS_LOG_INFO ("Assign IP Addresses.");
177  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
179 
180  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
181  Ptr<Socket> recvSink = Socket::CreateSocket (c.Get (0), tid);
183  recvSink->Bind (local);
185 
186  Ptr<Socket> source = Socket::CreateSocket (c.Get (1), tid);
187  InetSocketAddress remote = InetSocketAddress (Ipv4Address ("255.255.255.255"), 80);
188  source->SetAllowBroadcast (true);
189  source->Connect (remote);
190 
191  // Tracing
192  wifiPhy.EnablePcap ("wifi-simple-infra", devices);
193 
194  // Output what we are doing
195  NS_LOG_UNCOND ("Testing " << numPackets << " packets sent with receiver rss " << rss );
196 
198  Seconds (1.0), &GenerateTraffic,
199  source, packetSize, numPackets, interPacketInterval);
200 
201  Simulator::Stop (Seconds (30.0));
202  Simulator::Run ();
204 
205  return 0;
206 }
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())
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:134
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
static Ipv4Address GetAny(void)
uint32_t GetId(void) const
Definition: node.cc:107
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Hold variables of type string.
Definition: string.h:41
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
Make it easy to create and manage PHY objects for the yans model.
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
aggregate IP/TCP/UDP functionality to existing Nodes.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
cmd
Definition: second.py:35
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:230
Ptr< YansWifiChannel > Create(void) const
mobility
Definition: third.py:101
void SetChannel(Ptr< YansWifiChannel > channel)
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1381
ssid
Definition: third.py:93
holds a vector of ns3::NetDevice pointers
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void SetRecvCallback(Callback< void, Ptr< Socket > >)
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
Parse command-line arguments.
Definition: command-line.h:213
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
virtual Ptr< Packet > Recv(uint32_t maxSize, uint32_t flags)=0
Read data from the socket.
DSSS PHY (Clause 15) and HR/DSSS PHY (Clause 18)
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
void SetPcapDataLinkType(SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:453
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
virtual void SetType(std::string type, 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(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
wifi
Definition: third.py:89
Helper class used to assign positions and mobility models to nodes.
static void ScheduleWithContext(uint32_t context, Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event with the given context.
Definition: simulator.h:1475
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1014
AttributeValue implementation for Ssid.
Definition: ssid.h:110
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
void Add(Vector v)
Add a position to the list of positions.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
static const uint32_t packetSize
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())
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
devices
Definition: first.py:32
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual int Close(void)=0
Close a socket.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:58
Include Radiotap link layer information.
Definition: wifi-helper.h:111
void ReceivePacket(Ptr< Socket > socket)
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
bool verbose
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:824