Files
unison/examples/wireless/mixed-wireless.cc
Dean Armstrong 0946a77009 Bug 978: Consolidate Wi-Fi MAC high functionality
This change reorganises the Wi-Fi MAC high classes in attempt to
reduce duplication of functionality that is required for more than one
of the MAC high models. A new class called RegularWifiMac has been
created. This derives from the abstract WifiMac, and is parent of
AdhocWifiMac, StaWifiMac, ApWifiMac, and MeshWifiInterfaceMac. The QoS
and non-QoS class variants are no longer, with a RegularWifiMac
attribute "QosSupported" allowing selection between these two modes of
operation. QosWifiMacHelper and NqosWifiMacHelper continue to work as
previously.

Updates to some regression traces are necessary because the
reorganisation has led to random number streams being initialised in
slightly different orders and thus over-the-air timing changing.
2010-12-02 07:51:34 +00:00

426 lines
18 KiB
C++

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
//
// This ns-3 example demonstrates the use of helper functions to ease
// the construction of simulation scenarios.
//
// The simulation topology consists of a mixed wired and wireless
// scenario in which a hierarchical mobility model is used.
//
// The simulation layout consists of N backbone routers interconnected
// by an ad hoc wifi network.
// Each backbone router also has a local 802.11 network and is connected
// to a local LAN. An additional set of (K-1) nodes are connected to
// this backbone. Finally, a local LAN is connected to each router
// on the backbone, with L-1 additional hosts.
//
// The nodes are populated with TCP/IP stacks, and OLSR unicast routing
// on the backbone. An example UDP transfer is shown. The simulator
// be configured to output tcpdumps or traces from different nodes.
//
//
// +--------------------------------------------------------+
// | |
// | 802.11 ad hoc, ns-2 mobility |
// | |
// +--------------------------------------------------------+
// | o o o (N backbone routers) |
// +--------+ +--------+
// wired LAN | mobile | wired LAN | mobile |
// -----------| router | -----------| router |
// --------- ---------
// | |
// +----------------+ +----------------+
// | 802.11 | | 802.11 |
// | infra net | | infra net |
// | K-1 hosts | | K-1 hosts |
// +----------------+ +----------------+
//
// We'll send data from the first wired LAN node on the first wired LAN
// to the last wireless STA on the last infrastructure net, thereby
// causing packets to traverse CSMA to adhoc to infrastructure links
//
// Note that certain mobility patterns may cause packet forwarding
// to fail (if nodes become disconnected)
#include <fstream>
#include <string>
#include "ns3/core-module.h"
#include "ns3/common-module.h"
#include "ns3/node-module.h"
#include "ns3/helper-module.h"
#include "ns3/mobility-module.h"
#include "ns3/contrib-module.h"
#include "ns3/wifi-module.h"
#include "ns3/olsr-helper.h"
#include "ns3/ipv4-global-routing-helper.h"
using namespace ns3;
//
// Define logging keyword for this file
//
NS_LOG_COMPONENT_DEFINE ("MixedWireless");
//
// This function will be used below as a trace sink, if the command-line
// argument or default value "useCourseChangeCallback" is set to true
//
static void
CourseChangeCallback (std::string path, Ptr<const MobilityModel> model)
{
Vector position = model->GetPosition ();
std::cout << "CourseChange " << path << " x=" << position.x << ", y=" << position.y << ", z=" << position.z << std::endl;
}
int
main (int argc, char *argv[])
{
//
// First, we declare and initialize a few local variables that control some
// simulation parameters.
//
uint32_t backboneNodes = 10;
uint32_t infraNodes = 5;
uint32_t lanNodes = 5;
uint32_t stopTime = 10;
bool useCourseChangeCallback = false;
bool enableTracing = false;
//
// Simulation defaults are typically set next, before command line
// arguments are parsed.
//
Config::SetDefault ("ns3::OnOffApplication::PacketSize", StringValue ("210"));
Config::SetDefault ("ns3::OnOffApplication::DataRate", StringValue ("10kb/s"));
//
// For convenience, we add the local variables to the command line argument
// system so that they can be overridden with flags such as
// "--backboneNodes=20"
//
CommandLine cmd;
cmd.AddValue("backboneNodes", "number of backbone nodes", backboneNodes);
cmd.AddValue ("infraNodes", "number of leaf nodes", infraNodes);
cmd.AddValue("lanNodes", "number of LAN nodes", lanNodes);
cmd.AddValue("stopTime", "simulation stop time (seconds)", stopTime);
cmd.AddValue("useCourseChangeCallback", "whether to enable course change tracing", useCourseChangeCallback);
cmd.AddValue("enableTracing", "enable tracing", enableTracing);
//
// The system global variables and the local values added to the argument
// system can be overridden by command line arguments by using this call.
//
cmd.Parse (argc, argv);
///////////////////////////////////////////////////////////////////////////
// //
// Construct the backbone //
// //
///////////////////////////////////////////////////////////////////////////
//
// Create a container to manage the nodes of the adhoc (backbone) network.
// Later we'll create the rest of the nodes we'll need.
//
NodeContainer backbone;
backbone.Create (backboneNodes);
//
// Create the backbone wifi net devices and install them into the nodes in
// our container
//
WifiHelper wifi;
NqosWifiMacHelper mac = NqosWifiMacHelper::Default ();
mac.SetType ("ns3::AdhocWifiMac");
wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
"DataMode", StringValue ("OfdmRate54Mbps"));
YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
wifiPhy.SetChannel (wifiChannel.Create ());
NetDeviceContainer backboneDevices = wifi.Install (wifiPhy, mac, backbone);
// We enable OLSR (which will be consulted at a higher priority than
// the global routing) on the backbone ad hoc nodes
NS_LOG_INFO ("Enabling OLSR routing on all backbone nodes");
OlsrHelper olsr;
//
// Add the IPv4 protocol stack to the nodes in our container
//
InternetStackHelper internet;
internet.SetRoutingHelper (olsr);
internet.Install (backbone);
// re-initialize for non-olsr routing.
internet.Reset ();
//
// Assign IPv4 addresses to the device drivers (actually to the associated
// IPv4 interfaces) we just created.
//
Ipv4AddressHelper ipAddrs;
ipAddrs.SetBase ("192.168.0.0", "255.255.255.0");
ipAddrs.Assign (backboneDevices);
//
// The ad-hoc network nodes need a mobility model so we aggregate one to
// each of the nodes we just finished building.
//
MobilityHelper mobility;
Ptr<ListPositionAllocator> positionAlloc =
CreateObject<ListPositionAllocator> ();
double x = 0.0;
for (uint32_t i = 0; i < backboneNodes; ++i)
{
positionAlloc->Add (Vector (x, 0.0, 0.0));
x += 5.0;
}
mobility.SetPositionAllocator (positionAlloc);
mobility.SetMobilityModel ("ns3::RandomDirection2dMobilityModel",
"Bounds", RectangleValue (Rectangle (0, 20, 0, 20)),
"Speed", RandomVariableValue (ConstantVariable (2)),
"Pause", RandomVariableValue (ConstantVariable (0.2)));
mobility.Install (backbone);
///////////////////////////////////////////////////////////////////////////
// //
// Construct the LANs //
// //
///////////////////////////////////////////////////////////////////////////
// Reset the address base-- all of the CSMA networks will be in
// the "172.16 address space
ipAddrs.SetBase ("172.16.0.0", "255.255.255.0");
for (uint32_t i = 0; i < backboneNodes; ++i)
{
NS_LOG_INFO ("Configuring local area network for backbone node " << i);
//
// Create a container to manage the nodes of the LAN. We need
// two containers here; one with all of the new nodes, and one
// with all of the nodes including new and existing nodes
//
NodeContainer newLanNodes;
newLanNodes.Create (lanNodes - 1);
// Now, create the container with all nodes on this link
NodeContainer lan (backbone.Get (i), newLanNodes);
//
// Create the CSMA net devices and install them into the nodes in our
// collection.
//
CsmaHelper csma;
csma.SetChannelAttribute ("DataRate",
DataRateValue (DataRate (5000000)));
csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (2)));
NetDeviceContainer lanDevices = csma.Install (lan);
//
// Add the IPv4 protocol stack to the new LAN nodes
//
internet.Install (newLanNodes);
//
// Assign IPv4 addresses to the device drivers (actually to the
// associated IPv4 interfaces) we just created.
//
ipAddrs.Assign (lanDevices);
//
// Assign a new network prefix for the next LAN, according to the
// network mask initialized above
//
ipAddrs.NewNetwork ();
}
///////////////////////////////////////////////////////////////////////////
// //
// Construct the mobile networks //
// //
///////////////////////////////////////////////////////////////////////////
// Reset the address base-- all of the 802.11 networks will be in
// the "10.0" address space
ipAddrs.SetBase ("10.0.0.0", "255.255.255.0");
for (uint32_t i = 0; i < backboneNodes; ++i)
{
NS_LOG_INFO ("Configuring wireless network for backbone node " << i);
//
// Create a container to manage the nodes of the LAN. We need
// two containers here; one with all of the new nodes, and one
// with all of the nodes including new and existing nodes
//
NodeContainer stas;
stas.Create (infraNodes - 1);
// Now, create the container with all nodes on this link
NodeContainer infra (backbone.Get (i), stas);
//
// Create an infrastructure network
//
WifiHelper wifiInfra = WifiHelper::Default ();
NqosWifiMacHelper macInfra = NqosWifiMacHelper::Default ();
wifiPhy.SetChannel (wifiChannel.Create ());
// Create unique ssids for these networks
std::string ssidString("wifi-infra");
std::stringstream ss;
ss << i;
ssidString += ss.str();
Ssid ssid = Ssid (ssidString);
wifiInfra.SetRemoteStationManager ("ns3::ArfWifiManager");
// setup stas
macInfra.SetType ("ns3::StaWifiMac",
"Ssid", SsidValue (ssid),
"ActiveProbing", BooleanValue (false));
NetDeviceContainer staDevices = wifiInfra.Install (wifiPhy, macInfra, stas);
// setup ap.
macInfra.SetType ("ns3::ApWifiMac",
"Ssid", SsidValue (ssid));
NetDeviceContainer apDevices = wifiInfra.Install (wifiPhy, macInfra, backbone.Get (i));
// Collect all of these new devices
NetDeviceContainer infraDevices (apDevices, staDevices);
// Add the IPv4 protocol stack to the nodes in our container
//
internet.Install (stas);
//
// Assign IPv4 addresses to the device drivers (actually to the associated
// IPv4 interfaces) we just created.
//
ipAddrs.Assign (infraDevices);
//
// Assign a new network prefix for each mobile network, according to
// the network mask initialized above
//
ipAddrs.NewNetwork ();
//
// The new wireless nodes need a mobility model so we aggregate one
// to each of the nodes we just finished building.
//
Ptr<ListPositionAllocator> subnetAlloc =
CreateObject<ListPositionAllocator> ();
for (uint32_t j = 0; j < infra.GetN (); ++j)
{
subnetAlloc->Add (Vector (0.0, j, 0.0));
}
mobility.PushReferenceMobilityModel (backbone.Get (i));
mobility.SetPositionAllocator (subnetAlloc);
mobility.SetMobilityModel ("ns3::RandomDirection2dMobilityModel",
"Bounds", RectangleValue (Rectangle (-10, 10, -10, 10)),
"Speed", RandomVariableValue (ConstantVariable (3)),
"Pause", RandomVariableValue (ConstantVariable (0.4)));
mobility.Install (infra);
}
///////////////////////////////////////////////////////////////////////////
// //
// Routing configuration //
// //
///////////////////////////////////////////////////////////////////////////
// The below global routing does not take into account wireless effects.
// However, it is useful for setting default routes for all of the nodes
// such as the LAN nodes.
NS_LOG_INFO ("Enabling global routing on all nodes");
Ipv4GlobalRoutingHelper::PopulateRoutingTables ();
///////////////////////////////////////////////////////////////////////////
// //
// Application configuration //
// //
///////////////////////////////////////////////////////////////////////////
// Create the OnOff application to send UDP datagrams of size
// 210 bytes at a rate of 10 Kb/s, between two nodes
// We'll send data from the first wired LAN node on the first wired LAN
// to the last wireless STA on the last infrastructure net, thereby
// causing packets to traverse CSMA to adhoc to infrastructure links
NS_LOG_INFO ("Create Applications.");
uint16_t port = 9; // Discard port (RFC 863)
// Let's make sure that the user does not define too few nodes
// to make this example work. We need lanNodes > 1 and infraNodes > 1
NS_ASSERT (lanNodes > 1 && infraNodes > 1);
// We want the source to be the first node created outside of the backbone
// Conveniently, the variable "backboneNodes" holds this node index value
Ptr<Node> appSource = NodeList::GetNode (backboneNodes);
// We want the sink to be the last node created in the topology.
uint32_t lastNodeIndex = backboneNodes + backboneNodes*(lanNodes - 1) + backboneNodes*(infraNodes - 1) - 1;
Ptr<Node> appSink = NodeList::GetNode (lastNodeIndex);
// Let's fetch the IP address of the last node, which is on Ipv4Interface 1
Ipv4Address remoteAddr = appSink->GetObject<Ipv4> ()->GetAddress(1, 0).GetLocal ();
OnOffHelper onoff ("ns3::UdpSocketFactory",
Address (InetSocketAddress (remoteAddr, port)));
onoff.SetAttribute ("OnTime", RandomVariableValue (ConstantVariable (1)));
onoff.SetAttribute ("OffTime", RandomVariableValue (ConstantVariable (0)));
ApplicationContainer apps = onoff.Install (appSource);
apps.Start (Seconds (3.0));
apps.Stop (Seconds (20.0));
// Create a packet sink to receive these packets
PacketSinkHelper sink ("ns3::UdpSocketFactory",
InetSocketAddress (Ipv4Address::GetAny (), port));
apps = sink.Install (appSink);
apps.Start (Seconds (3.0));
///////////////////////////////////////////////////////////////////////////
// //
// Tracing configuration //
// //
///////////////////////////////////////////////////////////////////////////
NS_LOG_INFO ("Configure Tracing.");
if (enableTracing == true)
{
CsmaHelper csma;
//
// Let's set up some ns-2-like ascii traces, using another helper class
//
AsciiTraceHelper ascii;
Ptr<OutputStreamWrapper> stream = ascii.CreateFileStream ("mixed-wireless.tr");
wifiPhy.EnableAsciiAll (stream);
csma.EnableAsciiAll (stream);
internet.EnableAsciiIpv4All (stream);
// Let's do a pcap trace on the application source and sink, ifIndex 0
// Csma captures in non-promiscuous mode
#if 0
csma.EnablePcap ("mixed-wireless", appSource->GetId (), 0, false);
#else
csma.EnablePcapAll ("mixed-wireless", false);
#endif
wifiPhy.EnablePcap ("mixed-wireless", appSink->GetId (), 0);
wifiPhy.EnablePcap ("mixed-wireless", 9, 2);
wifiPhy.EnablePcap ("mixed-wireless", 9, 0);
}
if (useCourseChangeCallback == true)
{
Config::Connect ("/NodeList/*/$ns3::MobilityModel/CourseChange", MakeCallback (&CourseChangeCallback));
}
///////////////////////////////////////////////////////////////////////////
// //
// Run simulation //
// //
///////////////////////////////////////////////////////////////////////////
NS_LOG_INFO ("Run Simulation.");
Simulator::Stop (Seconds (stopTime));
Simulator::Run ();
Simulator::Destroy ();
}