src/nepi/resources/ns3/classes/fd_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.ns3fdnetdevice import NS3BaseFdNetDevice
  23
  24 @clsinit_copy
  25 class NS3FdNetDevice(NS3BaseFdNetDevice):
  26     _rtype = "ns3::FdNetDevice"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_address = Attribute("Address",
  32             "The MAC address of this device.",
  33             type = Types.String,
  34             default = "ff:ff:ff:ff:ff:ff",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_address)
  40
  41         attr_start = Attribute("Start",
  42             "The simulation time at which to spin up the device thread.",
  43             type = Types.String,
  44             default = "+0.0ns",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_start)
  50
  51         attr_stop = Attribute("Stop",
  52             "The simulation time at which to tear down the device thread.",
  53             type = Types.String,
  54             default = "+0.0ns",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_stop)
  60
  61         attr_encapsulationmode = Attribute("EncapsulationMode",
  62             "The link-layer encapsulation type to use.",
  63             type = Types.Enumerate,
  64             default = "Dix",
  65             allowed = ["Dix","Llc","DixPi"],
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_encapsulationmode)
  70
  71         attr_rxqueuesize = Attribute("RxQueueSize",
  72             "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.",
  73             type = Types.Integer,
  74             default = "1000",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_rxqueuesize)
  80
  81
  82
  83     @classmethod
  84     def _register_traces(cls):
  85
  86         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
  87
  88         cls._register_trace(mactx)
  89
  90         mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
  91
  92         cls._register_trace(mactxdrop)
  93
  94         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,")
  95
  96         cls._register_trace(macpromiscrx)
  97
  98         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,")
  99
 100         cls._register_trace(macrx)
 101
 102         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
 103
 104         cls._register_trace(sniffer)
 105
 106         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
 107
 108         cls._register_trace(promiscsniffer)
 109
 110
 111
 112     def __init__(self, ec, guid):
 113         super(NS3FdNetDevice, self).__init__(ec, guid)
 114         self._home = "ns3-fd-net-device-%s" % self.guid