examples/ns3/local_csma_p2p_star_ping.py

   1 #!/usr/bin/env python
   2 #
   3 #    NEPI, a framework to manage network experiments
   4 #    Copyright (C) 2013 INRIA
   5 #
   6 #    This program is free software: you can redistribute it and/or modify
   7 #    it under the terms of the GNU General Public License version 2 as
   8 #    published by the Free Software Foundation;
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from __future__ import print_function
  21
  22 """
  23 network topology:
  24
  25
  26                         n6
  27                         |
  28                        p2p
  29                         |
  30                         n4
  31                         |
  32    n1 -- p2p -- n2 -- csma -- n5 -- p2p -- n8
  33                         |
  34                         n3
  35                         |
  36                         p2p
  37                         |
  38                         n7
  39
  40 """
  41
  42 from nepi.execution.ec import ExperimentController
  43
  44 def add_node(ec, simu):
  45     ## Add a ns-3 node with its protocol stack
  46     nsnode = ec.register_resource("ns3::Node")
  47     ec.register_connection(nsnode, simu)
  48
  49     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
  50     ec.register_connection(nsnode, ipv4)
  51     arp = ec.register_resource("ns3::ArpL3Protocol")
  52     ec.register_connection(nsnode, arp)
  53     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
  54     ec.register_connection(nsnode, icmp)
  55     return nsnode
  56
  57 def add_p2p_dev(ec, nsnode, ip, prefix):
  58     # Add a point to point net device to the node
  59     dev = ec.register_resource("ns3::PointToPointNetDevice")
  60     ec.set(dev, "ip", ip)
  61     ec.set(dev, "prefix", prefix)
  62     ec.register_connection(nsnode, dev)
  63     queue = ec.register_resource("ns3::DropTailQueue")
  64     ec.register_connection(dev, queue)
  65     return dev
  66
  67 def add_csma_dev(ec, nsnode, ip, prefix):
  68     dev = ec.register_resource("ns3::CsmaNetDevice")
  69     ec.set(dev, "ip", ip)
  70     ec.set(dev, "prefix", prefix)
  71     ec.register_connection(nsnode, dev)
  72     queue = ec.register_resource("ns3::DropTailQueue")
  73     ec.register_connection(dev, queue)
  74     return dev
  75
  76 def add_csma_chan(ec, devs):
  77     # Create channel
  78     chan = ec.register_resource("ns3::CsmaChannel")
  79     ec.set(chan, "Delay", "0s")
  80
  81     for dev in devs:
  82         ec.register_connection(chan, dev)
  83
  84     return chan
  85
  86 def add_p2p_chan(ec, dev1, dev2):
  87     # Add a point to point channel
  88     chan = ec.register_resource("ns3::PointToPointChannel")
  89     ec.set(chan, "Delay", "0s")
  90     ec.register_connection(chan, dev1)
  91     ec.register_connection(chan, dev2)
  92     return chan
  93
  94 ec = ExperimentController(exp_id = "ns3-csma-p2p-ping")
  95
  96 # Simulation will run in a remote machine
  97 node = ec.register_resource("linux::Node")
  98 ec.set(node, "hostname", "localhost")
  99
 100 # Add a simulation resource
 101 simu = ec.register_resource("linux::ns3::Simulation")
 102 ec.set(simu, "verbose", True)
 103 ec.set(simu, "enableDump", True)
 104 ec.register_connection(simu, node)
 105
 106 # Add simulated nodes
 107 nsnode1 = add_node(ec, simu)
 108 nsnode2 = add_node(ec, simu)
 109 nsnode3 = add_node(ec, simu)
 110 nsnode4 = add_node(ec, simu)
 111 nsnode5 = add_node(ec, simu)
 112 nsnode6 = add_node(ec, simu)
 113 nsnode7 = add_node(ec, simu)
 114 nsnode8 = add_node(ec, simu)
 115
 116 # Build the start topology
 117 dev12 = add_p2p_dev(ec, nsnode1, "10.0.1.1", "30")
 118 dev21 = add_p2p_dev(ec, nsnode2, "10.0.1.2", "30")
 119 p2p1 = add_p2p_chan(ec, dev12, dev21)
 120
 121 dev46 = add_p2p_dev(ec, nsnode4, "10.0.2.1", "30")
 122 dev64 = add_p2p_dev(ec, nsnode6, "10.0.2.2", "30")
 123 p2p2 = add_p2p_chan(ec, dev46, dev64)
 124
 125 dev37 = add_p2p_dev(ec, nsnode3, "10.0.3.1", "30")
 126 dev73 = add_p2p_dev(ec, nsnode7, "10.0.3.2", "30")
 127 p2p3 = add_p2p_chan(ec, dev37, dev73)
 128
 129 dev85 = add_p2p_dev(ec, nsnode5, "10.0.4.1", "30")
 130 dev58 = add_p2p_dev(ec, nsnode8, "10.0.4.2", "30")
 131 p2p4 = add_p2p_chan(ec, dev85, dev58)
 132
 133 dev2 = add_csma_dev(ec, nsnode2, "10.0.0.1", "24")
 134 dev3 = add_csma_dev(ec, nsnode3, "10.0.0.2", "24")
 135 dev4 = add_csma_dev(ec, nsnode4, "10.0.0.3", "24")
 136 dev5 = add_csma_dev(ec, nsnode5, "10.0.0.4", "24")
 137
 138 csma1 = add_csma_chan(ec, [dev2, dev3, dev4, dev5])
 139
 140 ## Add routes
 141 # Add n2 as default gw for n1
 142 r1 = ec.register_resource("ns3::Route")
 143 ec.set(r1, "network", "0.0.0.0")
 144 ec.set(r1, "prefix", "30")
 145 ec.set(r1, "nexthop", "10.0.1.2")
 146 ec.register_connection(r1, nsnode1)
 147
 148 # Add route to n8 from n2
 149 r28 = ec.register_resource("ns3::Route")
 150 ec.set(r28, "network", "10.0.4.0")
 151 ec.set(r28, "prefix", "30")
 152 ec.set(r28, "nexthop", "10.0.0.4")
 153 ec.register_connection(r28, nsnode2)
 154
 155 # Add n5 as default gw for n8
 156 r8 = ec.register_resource("ns3::Route")
 157 ec.set(r8, "network", "0.0.0.0")
 158 ec.set(r8, "prefix", "30")
 159 ec.set(r8, "nexthop", "10.0.4.1")
 160 ec.register_connection(r8, nsnode8)
 161
 162 # Add route to n1 from n5
 163 r51 = ec.register_resource("ns3::Route")
 164 ec.set(r51, "network", "10.0.1.0")
 165 ec.set(r51, "prefix", "30")
 166 ec.set(r51, "nexthop", "10.0.0.1")
 167 ec.register_connection(r51, nsnode5)
 168
 169 ### create pinger
 170 ping = ec.register_resource("ns3::V4Ping")
 171 ec.set (ping, "Remote", "10.0.4.2")
 172 ec.set (ping, "Interval", "1s")
 173 ec.set (ping, "Verbose", True)
 174 ec.set (ping, "StartTime", "0s")
 175 ec.set (ping, "StopTime", "20s")
 176 ec.register_connection(ping, nsnode1)
 177
 178 ec.deploy()
 179
 180 ec.wait_finished([ping])
 181
 182 stdout = ec.trace(simu, "stdout")
 183
 184 ec.shutdown()
 185
 186 print("PING OUTPUT", stdout)