examples/virtual-net-device.cc
author Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
Fri, 03 Jul 2009 11:17:38 +0100
changeset 4651 0f97d2edf425
parent 4616 a84f60b6cd12
permissions -rw-r--r--
Fix the virtual-net-device.cc example; thanks Antti M?kel?.
     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  * ns-2 simple.tcl script (ported from ns-2)
    18  * Originally authored by Steve McCanne, 12/19/1996
    19  */
    20 
    21 // Network topology
    22 //
    23 //  n0
    24 //     \ 5 Mb/s, 2ms
    25 //      \          1.5Mb/s, 10ms
    26 //       n2 -------------------------n3
    27 //      /
    28 //     / 5 Mb/s, 2ms
    29 //   n1
    30 //
    31 // - all links are point-to-point links with indicated one-way BW/delay
    32 // - CBR/UDP flows from n0 to n3, and from n3 to n1
    33 // - FTP/TCP flow from n0 to n3, starting at time 1.2 to time 1.35 sec.
    34 // - UDP packet size of 210 bytes, with per-packet interval 0.00375 sec.
    35 //   (i.e., DataRate of 448,000 bps)
    36 // - DropTail queues 
    37 // - Tracing of queues and packet receptions to file "virtual-net-device.tr"
    38 
    39 // Tunneling changes (relative to the simple-global-routing example):
    40 // n0 will receive an extra virtual interface with address 11.0.0.1
    41 // n1 will also receive an extra virtual interface with the same address 11.0.0.1
    42 // n3 will receive an extra virtual interface with address 11.0.0.254
    43 // The flows will be between 11.0.0.x (tunnel) addresses instead of 10.1.x.y ones
    44 // n3 will decide, on a per-packet basis, via random number, whether to
    45 // send the packet to n0 or to n1.
    46 //
    47 // Note: here we create a tunnel where IP packets are tunneled over
    48 // UDP/IP, but tunneling directly IP-over-IP would also be possible;
    49 // see src/node/ipv4-raw-socket-factory.h.
    50 
    51 #include <iostream>
    52 #include <fstream>
    53 #include <string>
    54 #include <cassert>
    55 
    56 #include "ns3/core-module.h"
    57 #include "ns3/simulator-module.h"
    58 #include "ns3/node-module.h"
    59 #include "ns3/helper-module.h"
    60 #include "ns3/virtual-net-device.h"
    61 
    62 using namespace ns3;
    63 
    64 NS_LOG_COMPONENT_DEFINE ("VirtualNetDeviceExample");
    65 
    66 class Tunnel
    67 {
    68   Ptr<Socket> m_n3Socket;
    69   Ptr<Socket> m_n0Socket;
    70   Ptr<Socket> m_n1Socket;
    71   Ipv4Address m_n3Address;
    72   Ipv4Address m_n0Address;
    73   Ipv4Address m_n1Address;
    74   UniformVariable m_rng;
    75   Ptr<VirtualNetDevice> m_n0Tap;
    76   Ptr<VirtualNetDevice> m_n1Tap;
    77   Ptr<VirtualNetDevice> m_n3Tap;
    78   
    79   
    80   bool
    81   N0VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
    82   {
    83     m_n0Socket->SendTo (packet, 0, InetSocketAddress (m_n3Address, 667));
    84     return true;
    85   }
    86 
    87   bool
    88   N1VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
    89   {
    90     m_n1Socket->SendTo (packet, 0, InetSocketAddress (m_n3Address, 667));
    91     return true;
    92   }
    93 
    94   bool
    95   N3VirtualSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
    96   {
    97     if (m_rng.GetValue () < 0.25)
    98       {
    99         m_n3Socket->SendTo (packet, 0, InetSocketAddress (m_n0Address, 667));
   100       }
   101     else 
   102       {
   103         m_n3Socket->SendTo (packet, 0, InetSocketAddress (m_n1Address, 667));
   104       }
   105     return true;
   106   }
   107 
   108   void N3SocketRecv (Ptr<Socket> socket)
   109   {
   110     Ptr<Packet> packet = socket->Recv (65535, 0);
   111     SocketAddressTag socketAddressTag;
   112     packet->RemovePacketTag (socketAddressTag);
   113     m_n3Tap->Receive (packet, 0x0800, m_n3Tap->GetAddress (), m_n3Tap->GetAddress (), NetDevice::PACKET_HOST);
   114   }
   115 
   116   void N0SocketRecv (Ptr<Socket> socket)
   117   {
   118     Ptr<Packet> packet = socket->Recv (65535, 0);
   119     SocketAddressTag socketAddressTag;
   120     packet->RemovePacketTag (socketAddressTag);
   121     m_n0Tap->Receive (packet, 0x0800, m_n0Tap->GetAddress (), m_n0Tap->GetAddress (), NetDevice::PACKET_HOST);
   122   }
   123 
   124   void N1SocketRecv (Ptr<Socket> socket)
   125   {
   126     Ptr<Packet> packet = socket->Recv (65535, 0);
   127     SocketAddressTag socketAddressTag;
   128     packet->RemovePacketTag (socketAddressTag);
   129     m_n1Tap->Receive (packet, 0x0800, m_n1Tap->GetAddress (), m_n1Tap->GetAddress (), NetDevice::PACKET_HOST);
   130   }
   131 
   132 public:
   133   
   134   Tunnel (Ptr<Node> n3, Ptr<Node> n0, Ptr<Node> n1,
   135           Ipv4Address n3Addr, Ipv4Address n0Addr, Ipv4Address n1Addr)
   136     : m_n3Address (n3Addr), m_n0Address (n0Addr), m_n1Address (n1Addr)
   137   {
   138     m_n3Socket = Socket::CreateSocket (n3, TypeId::LookupByName ("ns3::UdpSocketFactory"));
   139     m_n3Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
   140     m_n3Socket->SetRecvCallback (MakeCallback (&Tunnel::N3SocketRecv, this));    
   141     
   142     m_n0Socket = Socket::CreateSocket (n0, TypeId::LookupByName ("ns3::UdpSocketFactory"));
   143     m_n0Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
   144     m_n0Socket->SetRecvCallback (MakeCallback (&Tunnel::N0SocketRecv, this));    
   145     
   146     m_n1Socket = Socket::CreateSocket (n1, TypeId::LookupByName ("ns3::UdpSocketFactory"));
   147     m_n1Socket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 667));
   148     m_n1Socket->SetRecvCallback (MakeCallback (&Tunnel::N1SocketRecv, this));
   149     
   150     // n0 tap device
   151     m_n0Tap = CreateObject<VirtualNetDevice> ();
   152     m_n0Tap->SetAddress (Mac48Address ("11:00:01:02:03:01"));
   153     m_n0Tap->SetSendCallback (MakeCallback (&Tunnel::N0VirtualSend, this));
   154     n0->AddDevice (m_n0Tap);
   155     Ptr<Ipv4> ipv4 = n0->GetObject<Ipv4> ();
   156     uint32_t i = ipv4->AddInterface (m_n0Tap);
   157     ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.1"), Ipv4Mask ("255.255.255.0")));
   158     ipv4->SetUp (i);
   159     
   160     // n1 tap device
   161     m_n1Tap = CreateObject<VirtualNetDevice> ();
   162     m_n1Tap->SetAddress (Mac48Address ("11:00:01:02:03:02"));
   163     m_n1Tap->SetSendCallback (MakeCallback (&Tunnel::N1VirtualSend, this));
   164     n1->AddDevice (m_n1Tap);
   165     ipv4 = n1->GetObject<Ipv4> ();
   166     i = ipv4->AddInterface (m_n1Tap);
   167     ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.1"), Ipv4Mask ("255.255.255.0")));
   168     ipv4->SetUp (i);
   169 
   170     // n3 tap device
   171     m_n3Tap = CreateObject<VirtualNetDevice> ();
   172     m_n3Tap->SetAddress (Mac48Address ("11:00:01:02:03:04"));
   173     m_n3Tap->SetSendCallback (MakeCallback (&Tunnel::N3VirtualSend, this));
   174     n3->AddDevice (m_n3Tap);
   175     ipv4 = n3->GetObject<Ipv4> ();
   176     i = ipv4->AddInterface (m_n3Tap);
   177     ipv4->AddAddress (i, Ipv4InterfaceAddress (Ipv4Address ("11.0.0.254"), Ipv4Mask ("255.255.255.0")));
   178     ipv4->SetUp (i);
   179     
   180   }
   181   
   182   
   183 };
   184 
   185   
   186 
   187 int 
   188 main (int argc, char *argv[])
   189 {
   190   // Users may find it convenient to turn on explicit debugging
   191   // for selected modules; the below lines suggest how to do this
   192 #if 0 
   193   LogComponentEnable ("VirtualNetDeviceExample", LOG_LEVEL_INFO);
   194 #endif
   195 
   196   // Set up some default values for the simulation.  Use the 
   197   Config::SetDefault ("ns3::OnOffApplication::PacketSize", UintegerValue (210));
   198   Config::SetDefault ("ns3::OnOffApplication::DataRate", StringValue ("448kb/s"));
   199 
   200   //DefaultValue::Bind ("DropTailQueue::m_maxPackets", 30);   
   201 
   202   // Allow the user to override any of the defaults and the above
   203   // DefaultValue::Bind ()s at run-time, via command-line arguments
   204   CommandLine cmd;
   205   cmd.Parse (argc, argv);
   206 
   207   // Here, we will explicitly create four nodes.  In more sophisticated
   208   // topologies, we could configure a node factory.
   209   NS_LOG_INFO ("Create nodes.");
   210   NodeContainer c;
   211   c.Create (4);
   212   NodeContainer n0n2 = NodeContainer (c.Get(0), c.Get (2));
   213   NodeContainer n1n2 = NodeContainer (c.Get(1), c.Get (2));
   214   NodeContainer n3n2 = NodeContainer (c.Get(3), c.Get (2));
   215 
   216   InternetStackHelper internet;
   217   internet.Install (c);
   218 
   219   // We create the channels first without any IP addressing information
   220   NS_LOG_INFO ("Create channels.");
   221   PointToPointHelper p2p;
   222   p2p.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
   223   p2p.SetChannelAttribute ("Delay", StringValue ("2ms"));
   224   NetDeviceContainer d0d2 = p2p.Install (n0n2);
   225 
   226   NetDeviceContainer d1d2 = p2p.Install (n1n2);
   227   
   228   p2p.SetDeviceAttribute ("DataRate", StringValue ("1500kbps"));
   229   p2p.SetChannelAttribute ("Delay", StringValue ("10ms"));
   230   NetDeviceContainer d3d2 = p2p.Install (n3n2);
   231   
   232   // Later, we add IP addresses.  
   233   NS_LOG_INFO ("Assign IP Addresses.");
   234   Ipv4AddressHelper ipv4;
   235   ipv4.SetBase ("10.1.1.0", "255.255.255.0");
   236   Ipv4InterfaceContainer i0i2 = ipv4.Assign (d0d2);
   237 
   238   ipv4.SetBase ("10.1.2.0", "255.255.255.0");
   239   Ipv4InterfaceContainer i1i2 = ipv4.Assign (d1d2);
   240   
   241   ipv4.SetBase ("10.1.3.0", "255.255.255.0");
   242   Ipv4InterfaceContainer i3i2 = ipv4.Assign (d3d2);
   243 
   244   // Create router nodes, initialize routing database and set up the routing
   245   // tables in the nodes.
   246   Ipv4GlobalRoutingHelper::PopulateRoutingTables ();
   247 
   248   // Add the tunnels
   249   Tunnel tunnel (c.Get (3), c.Get (0), c.Get (1),
   250                  i3i2.GetAddress (0), i0i2.GetAddress (0), i1i2.GetAddress (0));
   251 
   252   // Create the OnOff application to send UDP datagrams of size
   253   // 210 bytes at a rate of 448 Kb/s
   254   NS_LOG_INFO ("Create Applications.");
   255   uint16_t port = 9;   // Discard port (RFC 863)
   256   OnOffHelper onoff ("ns3::UdpSocketFactory", 
   257                      Address (InetSocketAddress (Ipv4Address ("11.0.0.254"), port)));
   258   onoff.SetAttribute ("OnTime", RandomVariableValue (ConstantVariable (1)));
   259   onoff.SetAttribute ("OffTime", RandomVariableValue (ConstantVariable (0)));
   260   ApplicationContainer apps = onoff.Install (c.Get (0));
   261   apps.Start (Seconds (1.0));
   262   apps.Stop (Seconds (10.0));
   263 
   264   // Create a packet sink to receive these packets
   265   PacketSinkHelper sink ("ns3::UdpSocketFactory",
   266     Address (InetSocketAddress (Ipv4Address::GetAny (), port)));
   267   apps = sink.Install (c.Get (3));
   268   apps.Start (Seconds (1.0));
   269   apps.Stop (Seconds (10.0));
   270 
   271   // Create a similar flow from n3 to n1, starting at time 1.1 seconds
   272   onoff.SetAttribute ("Remote", 
   273                       AddressValue (InetSocketAddress (Ipv4Address ("11.0.0.2"), port)));
   274   apps = onoff.Install (c.Get (3));
   275   apps.Start (Seconds (1.1));
   276   apps.Stop (Seconds (10.0));
   277 
   278   // Create a packet sink to receive these packets
   279   apps = sink.Install (c.Get (1));
   280   apps.Start (Seconds (1.1));
   281   apps.Stop (Seconds (10.0));
   282 
   283   std::ofstream ascii;
   284   ascii.open ("virtual-net-device.tr");
   285   PointToPointHelper::EnablePcapAll ("virtual-net-device");
   286   PointToPointHelper::EnableAsciiAll (ascii);
   287 
   288   NS_LOG_INFO ("Run Simulation.");
   289   Simulator::Run ();
   290   Simulator::Destroy ();
   291   NS_LOG_INFO ("Done.");
   292 
   293   return 0;
   294 }