2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2014 INRIA
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.
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.
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/>.
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, \
23 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
26 class NS3EmuNetDevice(NS3BaseNetDevice):
27 _rtype = "ns3::EmuNetDevice"
30 def _register_attributes(cls):
32 attr_mtu = Attribute("Mtu",
33 "The MAC-level Maximum Transmission Unit",
38 flags = Flags.Reserved | Flags.Construct)
40 cls._register_attribute(attr_mtu)
42 attr_address = Attribute("Address",
43 "The ns-3 MAC address of this (virtual) device.",
45 default = "ff:ff:ff:ff:ff:ff",
48 flags = Flags.Reserved | Flags.Construct)
50 cls._register_attribute(attr_address)
52 attr_devicename = Attribute("DeviceName",
53 "The name of the underlying real device (e.g. eth1).",
58 flags = Flags.Reserved | Flags.Construct)
60 cls._register_attribute(attr_devicename)
62 attr_start = Attribute("Start",
63 "The simulation time at which to spin up the device thread.",
68 flags = Flags.Reserved | Flags.Construct)
70 cls._register_attribute(attr_start)
72 attr_stop = Attribute("Stop",
73 "The simulation time at which to tear down the device thread.",
78 flags = Flags.Reserved | Flags.Construct)
80 cls._register_attribute(attr_stop)
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.",
88 flags = Flags.Reserved | Flags.Construct)
90 cls._register_attribute(attr_rxqueuesize)
95 def _register_traces(cls):
97 mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
99 cls._register_trace(mactx)
101 mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
103 cls._register_trace(mactxdrop)
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,")
107 cls._register_trace(macpromiscrx)
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,")
111 cls._register_trace(macrx)
113 sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
115 cls._register_trace(sniffer)
117 promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
119 cls._register_trace(promiscsniffer)
123 def __init__(self, ec, guid):
124 super(NS3EmuNetDevice, self).__init__(ec, guid)
125 self._home = "ns3-emu-net-device-%s" % self.guid