A Discrete-Event Network Simulator
API
virtual-net-device.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * Based on simple-global-routing.cc
17  */
18 
19 // Network topology
20 //
21 // n0
22 // \ 5 Mb/s, 2ms
23 // \ 1.5Mb/s, 10ms
24 // n2 -------------------------n3
25 // /
26 // / 5 Mb/s, 2ms
27 // n1
28 //
29 // - all links are point-to-point links with indicated one-way BW/delay
30 // - CBR/UDP flows from n0 to n3, and from n3 to n1
31 // - FTP/TCP flow from n0 to n3, starting at time 1.2 to time 1.35 sec.
32 // - UDP packet size of 210 bytes, with per-packet interval 0.00375 sec.
33 // (i.e., DataRate of 448,000 bps)
34 // - DropTail queues
35 // - Tracing of queues and packet receptions to file "virtual-net-device.tr"
36 
37 // Tunneling changes (relative to the simple-global-routing example):
38 // n0 will receive an extra virtual interface with address 11.0.0.1
39 // n1 will also receive an extra virtual interface with the same address 11.0.0.1
40 // n3 will receive an extra virtual interface with address 11.0.0.254
41 // The flows will be between 11.0.0.x (tunnel) addresses instead of 10.1.x.y ones
42 // n3 will decide, on a per-packet basis, via random number, whether to
43 // send the packet to n0 or to n1.
44 //
45 // Note: here we create a tunnel where IP packets are tunneled over
46 // UDP/IP, but tunneling directly IP-over-IP would also be possible;
47 // see src/node/ipv4-raw-socket-factory.h.
48 
49 #include <iostream>
50 #include <fstream>
51 #include <string>
52 #include <cassert>
53 
54 #include "ns3/core-module.h"
55 #include "ns3/network-module.h"
56 #include "ns3/internet-module.h"
57 #include "ns3/point-to-point-module.h"
58 #include "ns3/applications-module.h"
59 #include "ns3/virtual-net-device.h"
60 #include "ns3/ipv4-global-routing-helper.h"
61 
62 using namespace ns3;
63 
64 NS_LOG_COMPONENT_DEFINE ("VirtualNetDeviceExample");
65 
66 class Tunnel
67 {
78 
79 
80  bool
81  N0VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
82  {
83  NS_LOG_DEBUG ("Send to " << m_n3Address << ": " << *packet);
84  m_n0Socket->SendTo (packet, 0, InetSocketAddress (m_n3Address, 667));
85  return true;
86  }
87 
88  bool
89  N1VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
90  {
91  NS_LOG_DEBUG ("Send to " << m_n3Address << ": " << *packet);
92  m_n1Socket->SendTo (packet, 0, InetSocketAddress (m_n3Address, 667));
93  return true;
94  }
95 
96  bool
97  N3VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
98  {
99  if (m_rng->GetValue () < 0.25)
100  {
101  NS_LOG_DEBUG ("Send to " << m_n0Address << ": " << *packet);
102  m_n3Socket->SendTo (packet, 0, InetSocketAddress (m_n0Address, 667));
103  }
104  else
105  {
106  NS_LOG_DEBUG ("Send to " << m_n1Address << ": " << *packet);
107  m_n3Socket->SendTo (packet, 0, InetSocketAddress (m_n1Address, 667));
108  }
109  return true;
110  }
111 
112  void N3SocketRecv (Ptr<Socket> socket)
113  {
114  Ptr<Packet> packet = socket->Recv (65535, 0);
115  NS_LOG_DEBUG ("N3SocketRecv: " << *packet);
116  m_n3Tap->Receive (packet, 0x0800, m_n3Tap->GetAddress (), m_n3Tap->GetAddress (), NetDevice::PACKET_HOST);
117  }
118 
119  void N0SocketRecv (Ptr<Socket> socket)
120  {
121  Ptr<Packet> packet = socket->Recv (65535, 0);
122  NS_LOG_DEBUG ("N0SocketRecv: " << *packet);
123  m_n0Tap->Receive (packet, 0x0800, m_n0Tap->GetAddress (), m_n0Tap->GetAddress (), NetDevice::PACKET_HOST);
124  }
125 
126  void N1SocketRecv (Ptr<Socket> socket)
127  {
128  Ptr<Packet> packet = socket->Recv (65535, 0);
129  NS_LOG_DEBUG ("N1SocketRecv: " << *packet);
130  m_n1Tap->Receive (packet, 0x0800, m_n1Tap->GetAddress (), m_n1Tap->GetAddress (), NetDevice::PACKET_HOST);
131  }
132 
133 public:
134 
136  Ipv4Address n3Addr, Ipv4Address n0Addr, Ipv4Address n1Addr)
137  : m_n3Address (n3Addr), m_n0Address (n0Addr), m_n1Address (n1Addr)
138  {
139  m_rng = CreateObject<UniformRandomVariable> ();
140  m_n3Socket = Socket::CreateSocket (n3, TypeId::LookupByName ("ns3::UdpSocketFactory"));
141  m_n3Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
142  m_n3Socket->SetRecvCallback (MakeCallback (&Tunnel::N3SocketRecv, this));
143 
144  m_n0Socket = Socket::CreateSocket (n0, TypeId::LookupByName ("ns3::UdpSocketFactory"));
145  m_n0Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
146  m_n0Socket->SetRecvCallback (MakeCallback (&Tunnel::N0SocketRecv, this));
147 
148  m_n1Socket = Socket::CreateSocket (n1, TypeId::LookupByName ("ns3::UdpSocketFactory"));
149  m_n1Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
150  m_n1Socket->SetRecvCallback (MakeCallback (&Tunnel::N1SocketRecv, this));
151 
152  // n0 tap device
153  m_n0Tap = CreateObject<VirtualNetDevice> ();
154  m_n0Tap->SetAddress (Mac48Address ("11:00:01:02:03:01"));
156  n0->AddDevice (m_n0Tap);
157  Ptr<Ipv4> ipv4 = n0->GetObject<Ipv4> ();
158  uint32_t i = ipv4->AddInterface (m_n0Tap);
159  ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.1"), Ipv4Mask ("255.255.255.0")));
160  ipv4->SetUp (i);
161 
162  // n1 tap device
163  m_n1Tap = CreateObject<VirtualNetDevice> ();
164  m_n1Tap->SetAddress (Mac48Address ("11:00:01:02:03:02"));
166  n1->AddDevice (m_n1Tap);
167  ipv4 = n1->GetObject<Ipv4> ();
168  i = ipv4->AddInterface (m_n1Tap);
169  ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.1"), Ipv4Mask ("255.255.255.0")));
170  ipv4->SetUp (i);
171 
172  // n3 tap device
173  m_n3Tap = CreateObject<VirtualNetDevice> ();
174  m_n3Tap->SetAddress (Mac48Address ("11:00:01:02:03:04"));
176  n3->AddDevice (m_n3Tap);
177  ipv4 = n3->GetObject<Ipv4> ();
178  i = ipv4->AddInterface (m_n3Tap);
179  ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.254"), Ipv4Mask ("255.255.255.0")));
180  ipv4->SetUp (i);
181 
182  }
183 
184 
185 };
186 
187 
188 
189 int
190 main (int argc, char *argv[])
191 {
192  // Users may find it convenient to turn on explicit debugging
193  // for selected modules; the below lines suggest how to do this
194 #if 0
195  LogComponentEnable ("VirtualNetDeviceExample", LOG_LEVEL_INFO);
196 #endif
198 
199 
200  // Set up some default values for the simulation. Use the
201  Config::SetDefault ("ns3::OnOffApplication::PacketSize", UintegerValue (210));
202  Config::SetDefault ("ns3::OnOffApplication::DataRate", StringValue ("448kb/s"));
203 
204  //DefaultValue::Bind ("DropTailQueue::m_maxPackets", 30);
205 
206  // Allow the user to override any of the defaults and the above
207  // DefaultValue::Bind ()s at run-time, via command-line arguments
209  cmd.Parse (argc, argv);
210 
211  // Here, we will explicitly create four nodes. In more sophisticated
212  // topologies, we could configure a node factory.
213  NS_LOG_INFO ("Create nodes.");
214  NodeContainer c;
215  c.Create (4);
216  NodeContainer n0n2 = NodeContainer (c.Get (0), c.Get (2));
217  NodeContainer n1n2 = NodeContainer (c.Get (1), c.Get (2));
218  NodeContainer n3n2 = NodeContainer (c.Get (3), c.Get (2));
219 
220  InternetStackHelper internet;
221  internet.Install (c);
222 
223  // We create the channels first without any IP addressing information
224  NS_LOG_INFO ("Create channels.");
225  PointToPointHelper p2p;
226  p2p.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
227  p2p.SetChannelAttribute ("Delay", StringValue ("2ms"));
228  NetDeviceContainer d0d2 = p2p.Install (n0n2);
229 
230  NetDeviceContainer d1d2 = p2p.Install (n1n2);
231 
232  p2p.SetDeviceAttribute ("DataRate", StringValue ("1500kbps"));
233  p2p.SetChannelAttribute ("Delay", StringValue ("10ms"));
234  NetDeviceContainer d3d2 = p2p.Install (n3n2);
235 
236  // Later, we add IP addresses.
237  NS_LOG_INFO ("Assign IP Addresses.");
238  Ipv4AddressHelper ipv4;
239  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
240  Ipv4InterfaceContainer i0i2 = ipv4.Assign (d0d2);
241 
242  ipv4.SetBase ("10.1.2.0", "255.255.255.0");
243  Ipv4InterfaceContainer i1i2 = ipv4.Assign (d1d2);
244 
245  ipv4.SetBase ("10.1.3.0", "255.255.255.0");
246  Ipv4InterfaceContainer i3i2 = ipv4.Assign (d3d2);
247 
248  // Create router nodes, initialize routing database and set up the routing
249  // tables in the nodes.
251 
252  // Add the tunnels
253  Tunnel tunnel (c.Get (3), c.Get (0), c.Get (1),
254  i3i2.GetAddress (0), i0i2.GetAddress (0), i1i2.GetAddress (0));
255 
256  // Create the OnOff application to send UDP datagrams of size
257  // 210 bytes at a rate of 448 Kb/s
258  NS_LOG_INFO ("Create Applications.");
259  uint16_t port = 9; // Discard port (RFC 863)
260  OnOffHelper onoff ("ns3::UdpSocketFactory",
261  Address (InetSocketAddress (Ipv4Address ("11.0.0.254"), port)));
262  onoff.SetConstantRate (DataRate ("448kb/s"));
263  ApplicationContainer apps = onoff.Install (c.Get (0));
264  apps.Start (Seconds (1.0));
265  apps.Stop (Seconds (10.0));
266 
267  // Create a packet sink to receive these packets
268  PacketSinkHelper sink ("ns3::UdpSocketFactory",
270  apps = sink.Install (c.Get (3));
271  apps.Start (Seconds (1.0));
272  //apps.Stop (Seconds (10.0));
273 
274  // Create a similar flow from n3 to n1, starting at time 1.1 seconds
275  onoff.SetAttribute ("Remote",
276  AddressValue (InetSocketAddress (Ipv4Address ("11.0.0.1"), port)));
277  apps = onoff.Install (c.Get (3));
278  apps.Start (Seconds (1.1));
279  apps.Stop (Seconds (10.0));
280 
281  // Create a packet sink to receive these packets
282  apps = sink.Install (c.Get (1));
283  apps.Start (Seconds (1.1));
284  //apps.Stop (Seconds (10.0));
285 
286  AsciiTraceHelper ascii;
287  p2p.EnableAsciiAll (ascii.CreateFileStream ("virtual-net-device.tr"));
288  p2p.EnablePcapAll ("virtual-net-device");
289 
290  NS_LOG_INFO ("Run Simulation.");
291  Simulator::Run ();
293  NS_LOG_INFO ("Done.");
294 
295  return 0;
296 }
Ptr< PacketSink > sink
Definition: wifi-tcp.cc:56
holds a vector of ns3::Application pointers.
virtual uint32_t AddInterface(Ptr< NetDevice > device)=0
Manage ASCII trace files for device models.
Definition: trace-helper.h:161
an Inet address class
static Ipv4Address GetAny(void)
Ipv4Address m_n1Address
holds a vector of std::pair of Ptr<Ipv4> and interface index.
static void PopulateRoutingTables(void)
Build a routing database and initialize the routing tables of the nodes in the simulation.
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:459
Ptr< UniformRandomVariable > m_rng
Hold variables of type string.
Definition: string.h:41
NetDeviceContainer Install(NodeContainer c)
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:258
Ptr< VirtualNetDevice > m_n0Tap
Ipv4InterfaceContainer i1i2
void N3SocketRecv(Ptr< Socket > socket)
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
#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
Ipv4Address m_n3Address
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
cmd
Definition: second.py:35
bool Receive(Ptr< Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType)
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we&#39;ll use to write the traced bits. ...
Build a set of PointToPointNetDevice objects.
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
uint16_t port
Definition: dsdv-manet.cc:45
a polymophic address class
Definition: address.h:90
Ptr< Socket > m_n1Socket
Class for representing data rates.
Definition: data-rate.h:88
Ptr< Socket > m_n3Socket
void LogComponentEnable(char const *name, enum LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:369
virtual Address GetAddress(void) const
void EnablePcapAll(std::string prefix, bool promiscuous=false)
Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created ...
static void EnablePrinting(void)
Enable printing packets metadata.
Definition: packet.cc:572
virtual void SetUp(uint32_t interface)=0
Hold an unsigned integer type.
Definition: uinteger.h:44
virtual void SetAddress(Address address)
Set the address of this interface.
LOG_INFO and above.
Definition: log.h:104
holds a vector of ns3::NetDevice pointers
Ptr< VirtualNetDevice > m_n1Tap
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
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
Parse command-line arguments.
Definition: command-line.h:213
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
bool N0VirtualSend(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:76
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.
void SetConstantRate(DataRate dataRate, uint32_t packetSize=512)
Helper function to set a constant rate source.
keep track of a set of node pointers.
virtual Ptr< Packet > Recv(uint32_t maxSize, uint32_t flags)=0
Read data from the socket.
double GetValue(double min, double max)
Get the next random value, as a double in the specified range .
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
an EUI-48 address
Definition: mac48-address.h:43
bool N3VirtualSend(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
Ipv4InterfaceContainer i0i2
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
Ptr< VirtualNetDevice > m_n3Tap
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
AttributeValue implementation for Address.
Definition: address.h:278
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
uint32_t AddDevice(Ptr< NetDevice > device)
Associate a NetDevice to this node.
Definition: node.cc:128
a class to store IPv4 address information on an interface
Packet addressed oo us.
Definition: net-device.h:304
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
Ptr< Socket > m_n0Socket
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1007
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
virtual bool AddAddress(uint32_t interface, Ipv4InterfaceAddress address)=0
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
ApplicationContainer Install(NodeContainer c) const
Install an ns3::PacketSinkApplication on each node of the input container configured with all the att...
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
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...
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Tunnel(Ptr< Node > n3, Ptr< Node > n0, Ptr< Node > n1, Ipv4Address n3Addr, Ipv4Address n0Addr, Ipv4Address n1Addr)
Ipv4Address m_n0Address
void N0SocketRecv(Ptr< Socket > socket)
NodeContainer n0n2
void SetSendCallback(SendCallback transmitCb)
Set the user callback to be called when a L2 packet is to be transmitted.
ApplicationContainer Install(NodeContainer c) const
Install an ns3::OnOffApplication on each node of the input container configured with all the attribut...
void N1SocketRecv(Ptr< Socket > socket)
NodeContainer n1n2
void SetAttribute(std::string name, const AttributeValue &value)
Helper function used to set the underlying application attributes.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:824
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
bool N1VirtualSend(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)