src/nepi/resources/ns3/classes/tap_bridge.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 NS3TapBridge(NS3BaseNetDevice):
  27     _rtype = "ns3::TapBridge"
  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_devicename = Attribute("DeviceName",
  43             "The name of the tap device to create.",
  44             type = Types.String,
  45             default = "",
  46             allowed = None,
  47             range = None,
  48             flags = Flags.Reserved | Flags.Construct)
  49
  50         cls._register_attribute(attr_devicename)
  51
  52         attr_gateway = Attribute("Gateway",
  53             "The IP address of the default gateway to assign to the host machine, when in ConfigureLocal mode.",
  54             type = Types.String,
  55             default = "255.255.255.255",
  56             allowed = None,
  57             range = None,
  58             flags = Flags.Reserved | Flags.Construct)
  59
  60         cls._register_attribute(attr_gateway)
  61
  62         attr_ipaddress = Attribute("IpAddress",
  63             "The IP address to assign to the tap device, when in ConfigureLocal mode.  This address will override the discovered IP address of the simulated device.",
  64             type = Types.String,
  65             default = "255.255.255.255",
  66             allowed = None,
  67             range = None,
  68             flags = Flags.Reserved | Flags.Construct)
  69
  70         cls._register_attribute(attr_ipaddress)
  71
  72         attr_macaddress = Attribute("MacAddress",
  73             "The MAC address to assign to the tap device, when in ConfigureLocal mode.  This address will override the discovered MAC address of the simulated device.",
  74             type = Types.String,
  75             default = "ff:ff:ff:ff:ff:ff",
  76             allowed = None,
  77             range = None,
  78             flags = Flags.Reserved | Flags.Construct)
  79
  80         cls._register_attribute(attr_macaddress)
  81
  82         attr_netmask = Attribute("Netmask",
  83             "The network mask to assign to the tap device, when in ConfigureLocal mode.  This address will override the discovered MAC address of the simulated device.",
  84             type = Types.String,
  85             default = "255.255.255.255",
  86             allowed = None,
  87             range = None,
  88             flags = Flags.Reserved | Flags.Construct)
  89
  90         cls._register_attribute(attr_netmask)
  91
  92         attr_start = Attribute("Start",
  93             "The simulation time at which to spin up the tap device read thread.",
  94             type = Types.String,
  95             default = "+0.0ns",
  96             allowed = None,
  97             range = None,
  98             flags = Flags.Reserved | Flags.Construct)
  99
 100         cls._register_attribute(attr_start)
 101
 102         attr_stop = Attribute("Stop",
 103             "The simulation time at which to tear down the tap device read thread.",
 104             type = Types.String,
 105             default = "+0.0ns",
 106             allowed = None,
 107             range = None,
 108             flags = Flags.Reserved | Flags.Construct)
 109
 110         cls._register_attribute(attr_stop)
 111
 112
 113
 114     @classmethod
 115     def _register_traces(cls):
 116         pass
 117
 118     def __init__(self, ec, guid):
 119         super(NS3TapBridge, self).__init__(ec, guid)
 120         self._home = "ns3-tap-bridge-%s" % self.guid