src/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 as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   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
  19 from nepi.execution.attribute import Attribute, Flags, Types
  20 from nepi.execution.trace import Trace, TraceAttr
  21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  22         ResourceState, reschedule_delay
  23 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
  24
  25 @clsinit_copy
  26 class NS3EmuNetDevice(NS3BaseNetDevice):
  27     _rtype = "ns3::EmuNetDevice"
  28
  29     @classmethod
  30     def _register_attributes(cls):
  31
  32         attr_mtu = Attribute("Mtu",
  33             "The MAC-level Maximum Transmission Unit",
  34             type = Types.Integer,
  35             default = "0",
  36             allowed = None,
  37             range = None,
  38             flags = Flags.Reserved | Flags.Construct)
  39
  40         cls._register_attribute(attr_mtu)
  41
  42         attr_address = Attribute("Address",
  43             "The ns-3 MAC address of this (virtual) device.",
  44             type = Types.String,
  45             default = "ff:ff:ff:ff:ff:ff",
  46             allowed = None,
  47             range = None,
  48             flags = Flags.Reserved | Flags.Construct)
  49
  50         cls._register_attribute(attr_address)
  51
  52         attr_devicename = Attribute("DeviceName",
  53             "The name of the underlying real device (e.g. eth1).",
  54             type = Types.String,
  55             default = "eth1",
  56             allowed = None,
  57             range = None,
  58             flags = Flags.Reserved | Flags.Construct)
  59
  60         cls._register_attribute(attr_devicename)
  61
  62         attr_start = Attribute("Start",
  63             "The simulation time at which to spin up the device thread.",
  64             type = Types.String,
  65             default = "+0.0ns",
  66             allowed = None,
  67             range = None,
  68             flags = Flags.Reserved | Flags.Construct)
  69
  70         cls._register_attribute(attr_start)
  71
  72         attr_stop = Attribute("Stop",
  73             "The simulation time at which to tear down the device thread.",
  74             type = Types.String,
  75             default = "+0.0ns",
  76             allowed = None,
  77             range = None,
  78             flags = Flags.Reserved | Flags.Construct)
  79
  80         cls._register_attribute(attr_stop)
  81
  82         attr_rxqueuesize = Attribute("RxQueueSize",
  83             "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.",
  84             type = Types.Integer,
  85             default = "1000",
  86             allowed = None,
  87             range = None,
  88             flags = Flags.Reserved | Flags.Construct)
  89
  90         cls._register_attribute(attr_rxqueuesize)
  91
  92
  93
  94     @classmethod
  95     def _register_traces(cls):
  96
  97         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
  98
  99         cls._register_trace(mactx)
 100
 101         mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
 102
 103         cls._register_trace(mactxdrop)
 104
 105         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,")
 106
 107         cls._register_trace(macpromiscrx)
 108
 109         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,")
 110
 111         cls._register_trace(macrx)
 112
 113         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
 114
 115         cls._register_trace(sniffer)
 116
 117         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
 118
 119         cls._register_trace(promiscsniffer)
 120
 121
 122
 123     def __init__(self, ec, guid):
 124         super(NS3EmuNetDevice, self).__init__(ec, guid)
 125         self._home = "ns3-emu-net-device-%s" % self.guid