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 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.ns3netdevice import NS3BaseNetDevice
  23
  24 @clsinit_copy
  25 class NS3TapBridge(NS3BaseNetDevice):
  26     _rtype = "ns3::TapBridge"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_mtu = Attribute("Mtu",
  32             "The MAC-level Maximum Transmission Unit",
  33             type = Types.Integer,
  34             default = "0",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_mtu)
  40
  41         attr_devicename = Attribute("DeviceName",
  42             "The name of the tap device to create.",
  43             type = Types.String,
  44             default = "",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_devicename)
  50
  51         attr_gateway = Attribute("Gateway",
  52             "The IP address of the default gateway to assign to the host machine, when in ConfigureLocal mode.",
  53             type = Types.String,
  54             default = "255.255.255.255",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_gateway)
  60
  61         attr_ipaddress = Attribute("IpAddress",
  62             "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.",
  63             type = Types.String,
  64             default = "255.255.255.255",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_ipaddress)
  70
  71         attr_macaddress = Attribute("MacAddress",
  72             "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.",
  73             type = Types.String,
  74             default = "ff:ff:ff:ff:ff:ff",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_macaddress)
  80
  81         attr_netmask = Attribute("Netmask",
  82             "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.",
  83             type = Types.String,
  84             default = "255.255.255.255",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_netmask)
  90
  91         attr_start = Attribute("Start",
  92             "The simulation time at which to spin up the tap device read thread.",
  93             type = Types.String,
  94             default = "+0.0ns",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved | Flags.Construct)
  98
  99         cls._register_attribute(attr_start)
 100
 101         attr_stop = Attribute("Stop",
 102             "The simulation time at which to tear down the tap device read thread.",
 103             type = Types.String,
 104             default = "+0.0ns",
 105             allowed = None,
 106             range = None,
 107             flags = Flags.Reserved | Flags.Construct)
 108
 109         cls._register_attribute(attr_stop)
 110
 111
 112
 113     @classmethod
 114     def _register_traces(cls):
 115         pass
 116
 117     def __init__(self, ec, guid):
 118         super(NS3TapBridge, self).__init__(ec, guid)
 119         self._home = "ns3-tap-bridge-%s" % self.guid