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 """
  21 network topology:
  22
  23
  24                         n6
  25                         |
  26                        p2p
  27                         |
  28                         n4
  29                         |
  30    n1 -- p2p -- n2 -- csma -- n5 -- p2p -- n8
  31                         |
  32                         n3
  33                         |
  34                         p2p
  35                         |
  36                         n7
  37
  38 """
  39
  40 from nepi.execution.ec import ExperimentController
  41
  42 def add_node(ec, simu):
  43     ## Add a ns-3 node with its protocol stack
  44     nsnode = ec.register_resource("ns3::Node")
  45     ec.register_connection(nsnode, simu)
  46
  47     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
  48     ec.register_connection(nsnode, ipv4)
  49     arp = ec.register_resource("ns3::ArpL3Protocol")
  50     ec.register_connection(nsnode, arp)
  51     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
  52     ec.register_connection(nsnode, icmp)
  53     return nsnode
  54
  55 def add_p2p_dev(ec, nsnode, ip, prefix):
  56     # Add a point to point net device to the node
  57     dev = ec.register_resource("ns3::PointToPointNetDevice")
  58     ec.set(dev, "ip", ip)
  59     ec.set(dev, "prefix", prefix)
  60     ec.register_connection(nsnode, dev)
  61     queue = ec.register_resource("ns3::DropTailQueue")
  62     ec.register_connection(dev, queue)
  63     return dev
  64
  65 def add_csma_dev(ec, nsnode, ip, prefix):
  66     dev = ec.register_resource("ns3::CsmaNetDevice")
  67     ec.set(dev, "ip", ip)
  68     ec.set(dev, "prefix", prefix)
  69     ec.register_connection(nsnode, dev)
  70     queue = ec.register_resource("ns3::DropTailQueue")
  71     ec.register_connection(dev, queue)
  72     return dev
  73
  74 def add_csma_chan(ec, devs):
  75     # Create channel
  76     chan = ec.register_resource("ns3::CsmaChannel")
  77     ec.set(chan, "Delay", "0s")
  78
  79     for dev in devs:
  80         ec.register_connection(chan, dev)
  81
  82     return chan
  83
  84 def add_p2p_chan(ec, dev1, dev2):
  85     # Add a point to point channel
  86     chan = ec.register_resource("ns3::PointToPointChannel")
  87     ec.set(chan, "Delay", "0s")
  88     ec.register_connection(chan, dev1)
  89     ec.register_connection(chan, dev2)
  90     return chan
  91
  92 ec = ExperimentController(exp_id = "ns3-csma-p2p-ping")
  93
  94 # Simulation will run in a remote machine
  95 node = ec.register_resource("linux::Node")
  96 ec.set(node, "hostname", "localhost")
  97
  98 # Add a simulation resource
  99 simu = ec.register_resource("linux::ns3::Simulation")
 100 ec.set(simu, "verbose", True)
 101 ec.set(simu, "enableDump", True)
 102 ec.register_connection(simu, node)
 103
 104 # Add simulated nodes
 105 nsnode1 = add_node(ec, simu)
 106 nsnode2 = add_node(ec, simu)
 107 nsnode3 = add_node(ec, simu)
 108 nsnode4 = add_node(ec, simu)
 109 nsnode5 = add_node(ec, simu)
 110 nsnode6 = add_node(ec, simu)
 111 nsnode7 = add_node(ec, simu)
 112 nsnode8 = add_node(ec, simu)
 113
 114 # Build the start topology
 115 dev12 = add_p2p_dev(ec, nsnode1, "10.0.1.1", "30")
 116 dev21 = add_p2p_dev(ec, nsnode2, "10.0.1.2", "30")
 117 p2p1 = add_p2p_chan(ec, dev12, dev21)
 118
 119 dev46 = add_p2p_dev(ec, nsnode4, "10.0.2.1", "30")
 120 dev64 = add_p2p_dev(ec, nsnode6, "10.0.2.2", "30")
 121 p2p2 = add_p2p_chan(ec, dev46, dev64)
 122
 123 dev37 = add_p2p_dev(ec, nsnode3, "10.0.3.1", "30")
 124 dev73 = add_p2p_dev(ec, nsnode7, "10.0.3.2", "30")
 125 p2p3 = add_p2p_chan(ec, dev37, dev73)
 126
 127 dev85 = add_p2p_dev(ec, nsnode5, "10.0.4.1", "30")
 128 dev58 = add_p2p_dev(ec, nsnode8, "10.0.4.2", "30")
 129 p2p4 = add_p2p_chan(ec, dev85, dev58)
 130
 131 dev2 = add_csma_dev(ec, nsnode2, "10.0.0.1", "24")
 132 dev3 = add_csma_dev(ec, nsnode3, "10.0.0.2", "24")
 133 dev4 = add_csma_dev(ec, nsnode4, "10.0.0.3", "24")
 134 dev5 = add_csma_dev(ec, nsnode5, "10.0.0.4", "24")
 135
 136 csma1 = add_csma_chan(ec, [dev2, dev3, dev4, dev5])
 137
 138 ## Add routes
 139 # Add n2 as default gw for n1
 140 r1 = ec.register_resource("ns3::Route")
 141 ec.set(r1, "network", "0.0.0.0")
 142 ec.set(r1, "prefix", "30")
 143 ec.set(r1, "nexthop", "10.0.1.2")
 144 ec.register_connection(r1, nsnode1)
 145
 146 # Add route to n8 from n2
 147 r28 = ec.register_resource("ns3::Route")
 148 ec.set(r28, "network", "10.0.4.0")
 149 ec.set(r28, "prefix", "30")
 150 ec.set(r28, "nexthop", "10.0.0.4")
 151 ec.register_connection(r28, nsnode2)
 152
 153 # Add n5 as default gw for n8
 154 r8 = ec.register_resource("ns3::Route")
 155 ec.set(r8, "network", "0.0.0.0")
 156 ec.set(r8, "prefix", "30")
 157 ec.set(r8, "nexthop", "10.0.4.1")
 158 ec.register_connection(r8, nsnode8)
 159
 160 # Add route to n1 from n5
 161 r51 = ec.register_resource("ns3::Route")
 162 ec.set(r51, "network", "10.0.1.0")
 163 ec.set(r51, "prefix", "30")
 164 ec.set(r51, "nexthop", "10.0.0.1")
 165 ec.register_connection(r51, nsnode5)
 166
 167 ### create pinger
 168 ping = ec.register_resource("ns3::V4Ping")
 169 ec.set (ping, "Remote", "10.0.4.2")
 170 ec.set (ping, "Interval", "1s")
 171 ec.set (ping, "Verbose", True)
 172 ec.set (ping, "StartTime", "0s")
 173 ec.set (ping, "StopTime", "20s")
 174 ec.register_connection(ping, nsnode1)
 175
 176 ec.deploy()
 177
 178 ec.wait_finished([ping])
 179
 180 stdout = ec.trace(simu, "stdout")
 181
 182 ec.shutdown()
 183
 184 print "PING OUTPUT", stdout