src/nepi/resources/ns3/ns3node.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 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from nepi.execution.attribute import Attribute, Flags, Types
  21 from nepi.execution.resource import clsinit_copy
  22 from nepi.resources.ns3.ns3base import NS3Base
  23
  24 @clsinit_copy
  25 class NS3BaseNode(NS3Base):
  26     _rtype = "abstract::ns3::Node"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30         enable_dce = Attribute("enableDCE",
  31                 "This node will run in DCE emulation mode ",
  32                 default = False,
  33                 type = Types.Bool,
  34                 flags = Flags.Design)
  35
  36         cls._register_attribute(enable_dce)
  37
  38     @property
  39     def simulation(self):
  40         from nepi.resources.ns3.ns3simulation import NS3Simulation
  41         for guid in self.connections:
  42             rm = self.ec.get_resource(guid)
  43             if isinstance(rm, NS3Simulation):
  44                 return rm
  45
  46         msg = "Node not connected to simulation"
  47         self.error(msg)
  48         raise RuntimeError, msg
  49
  50     @property
  51     def ipv4(self):
  52         from nepi.resources.ns3.ns3ipv4l3protocol import NS3BaseIpv4L3Protocol
  53         ipv4s = self.get_connected(NS3BaseIpv4L3Protocol.get_rtype())
  54         if ipv4s: return ipv4s[0]
  55         return None
  56
  57     @property
  58     def mobility(self):
  59         from nepi.resources.ns3.ns3mobilitymodel import NS3BaseMobilityModel
  60         mobility = self.get_connected(NS3BaseMobilityModel.get_rtype())
  61         if mobility: return mobility[0]
  62         return None
  63
  64     @property
  65     def devices(self):
  66         from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
  67         devices = self.get_connected(NS3BaseNetDevice.get_rtype())
  68
  69         if not devices:
  70             msg = "Node not connected to devices"
  71             self.error(msg)
  72             raise RuntimeError, msg
  73
  74         return devices
  75
  76     @property
  77     def _rms_to_wait(self):
  78         rms = set()
  79         rms.add(self.simulation)
  80
  81         ipv4 = self.ipv4
  82         if ipv4:
  83             rms.add(ipv4)
  84
  85         mobility = self.mobility
  86         if mobility:
  87             rms.add(mobility)
  88
  89         return rms
  90
  91     def _configure_object(self):
  92         ### node.AggregateObject(PacketSocketFactory())
  93         uuid_packet_socket_factory = self.simulation.create("PacketSocketFactory")
  94         self.simulation.invoke(self.uuid, "AggregateObject", uuid_packet_socket_factory)
  95
  96         if self.get("enableDCE") == True:
  97             self._add_dce()
  98
  99     def _connect_object(self):
 100         ipv4 = self.ipv4
 101         if ipv4:
 102             self.simulation.invoke(self.uuid, "AggregateObject", ipv4.uuid)
 103
 104         mobility = self.mobility
 105         if mobility:
 106             self.simulation.invoke(self.uuid, "AggregateObject", mobility.uuid)
 107
 108     def _add_dce(self):
 109         container_uuid = self.simulation.create("NodeContainer")
 110         self.simulation.invoke(container_uuid, "Add", self.uuid)
 111         self.simulation.invoke(self.simulation.dce_helper_uuid, "Install",
 112                 container_uuid)
 113