nepi/resources/ns3/classes/emu_net_device.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2014 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License version 2 as
   7 #    published by the Free Software Foundation;
   8 #
   9 #    This program is distributed in the hope that it will be useful,
  10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #    GNU General Public License for more details.
  13 #
  14 #    You should have received a copy of the GNU General Public License
  15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 from nepi.execution.attribute import Attribute, Flags, Types
  19 from nepi.execution.trace import Trace, TraceAttr
  20 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  21         ResourceState
  22 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
  23
  24 @clsinit_copy
  25 class NS3EmuNetDevice(NS3BaseNetDevice):
  26     _rtype = "ns3::EmuNetDevice"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_mtu = Attribute("Mtu",
  32             "The MAC-level Maximum Transmission Unit",
  33             type = Types.Integer,
  34             default = "0",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_mtu)
  40
  41         attr_address = Attribute("Address",
  42             "The ns-3 MAC address of this (virtual) device.",
  43             type = Types.String,
  44             default = "ff:ff:ff:ff:ff:ff",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_address)
  50
  51         attr_devicename = Attribute("DeviceName",
  52             "The name of the underlying real device (e.g. eth1).",
  53             type = Types.String,
  54             default = "eth1",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_devicename)
  60
  61         attr_start = Attribute("Start",
  62             "The simulation time at which to spin up the device thread.",
  63             type = Types.String,
  64             default = "+0.0ns",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_start)
  70
  71         attr_stop = Attribute("Stop",
  72             "The simulation time at which to tear down the device thread.",
  73             type = Types.String,
  74             default = "+0.0ns",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_stop)
  80
  81         attr_rxqueuesize = Attribute("RxQueueSize",
  82             "Maximum size of the read queue.  This value limits number of packets that have been read from the network into a memory buffer but have not yet been processed by the simulator.",
  83             type = Types.Integer,
  84             default = "1000",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_rxqueuesize)
  90
  91
  92
  93     @classmethod
  94     def _register_traces(cls):
  95
  96         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
  97
  98         cls._register_trace(mactx)
  99
 100         mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
 101
 102         cls._register_trace(mactxdrop)
 103
 104         macpromiscrx = Trace("MacPromiscRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a promiscuous trace,")
 105
 106         cls._register_trace(macpromiscrx)
 107
 108         macrx = Trace("MacRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a non-promiscuous trace,")
 109
 110         cls._register_trace(macrx)
 111
 112         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
 113
 114         cls._register_trace(sniffer)
 115
 116         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
 117
 118         cls._register_trace(promiscsniffer)
 119
 120
 121
 122     def __init__(self, ec, guid):
 123         super(NS3EmuNetDevice, self).__init__(ec, guid)
 124         self._home = "ns3-emu-net-device-%s" % self.guid