src/nepi/resources/ns3/classes/csma_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
  23 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
  24
  25 @clsinit_copy
  26 class NS3CsmaNetDevice(NS3BaseNetDevice):
  27     _rtype = "ns3::CsmaNetDevice"
  28
  29     @classmethod
  30     def _register_attributes(cls):
  31
  32         attr_address = Attribute("Address",
  33             "The MAC address of this device.",
  34             type = Types.String,
  35             default = "ff:ff:ff:ff:ff:ff",
  36             allowed = None,
  37             range = None,
  38             flags = Flags.Reserved | Flags.Construct)
  39
  40         cls._register_attribute(attr_address)
  41
  42         attr_mtu = Attribute("Mtu",
  43             "The MAC-level Maximum Transmission Unit",
  44             type = Types.Integer,
  45             default = "1500",
  46             allowed = None,
  47             range = None,
  48             flags = Flags.Reserved | Flags.Construct)
  49
  50         cls._register_attribute(attr_mtu)
  51
  52         attr_sendenable = Attribute("SendEnable",
  53             "Enable or disable the transmitter section of the device.",
  54             type = Types.Bool,
  55             default = "True",
  56             allowed = None,
  57             range = None,
  58             flags = Flags.Reserved | Flags.Construct)
  59
  60         cls._register_attribute(attr_sendenable)
  61
  62         attr_receiveenable = Attribute("ReceiveEnable",
  63             "Enable or disable the receiver section of the device.",
  64             type = Types.Bool,
  65             default = "True",
  66             allowed = None,
  67             range = None,
  68             flags = Flags.Reserved | Flags.Construct)
  69
  70         cls._register_attribute(attr_receiveenable)
  71
  72
  73
  74     @classmethod
  75     def _register_traces(cls):
  76
  77         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
  78
  79         cls._register_trace(mactx)
  80
  81         mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
  82
  83         cls._register_trace(mactxdrop)
  84
  85         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,")
  86
  87         cls._register_trace(macpromiscrx)
  88
  89         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,")
  90
  91         cls._register_trace(macrx)
  92
  93         mactxbackoff = Trace("MacTxBackoff", "Trace source indicating a packet has been delayed by the CSMA backoff process")
  94
  95         cls._register_trace(mactxbackoff)
  96
  97         phytxbegin = Trace("PhyTxBegin", "Trace source indicating a packet has begun transmitting over the channel")
  98
  99         cls._register_trace(phytxbegin)
 100
 101         phytxend = Trace("PhyTxEnd", "Trace source indicating a packet has been completely transmitted over the channel")
 102
 103         cls._register_trace(phytxend)
 104
 105         phytxdrop = Trace("PhyTxDrop", "Trace source indicating a packet has been dropped by the device during transmission")
 106
 107         cls._register_trace(phytxdrop)
 108
 109         phyrxend = Trace("PhyRxEnd", "Trace source indicating a packet has been completely received by the device")
 110
 111         cls._register_trace(phyrxend)
 112
 113         phyrxdrop = Trace("PhyRxDrop", "Trace source indicating a packet has been dropped by the device during reception")
 114
 115         cls._register_trace(phyrxdrop)
 116
 117         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
 118
 119         cls._register_trace(sniffer)
 120
 121         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
 122
 123         cls._register_trace(promiscsniffer)
 124
 125
 126
 127     def __init__(self, ec, guid):
 128         super(NS3CsmaNetDevice, self).__init__(ec, guid)
 129         self._home = "ns3-csma-net-device-%s" % self.guid