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