src/nepi/resources/ns3/ns3base.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.resource import ResourceManager, clsinit_copy, \
  21         ResourceState, reschedule_delay
  22
  23 from nepi.execution.attribute import Flags
  24 from nepi.resources.ns3.ns3simulator import NS3Simulator
  25
  26 @clsinit_copy
  27 class NS3Base(ResourceManager):
  28     _rtype = "abstract::ns3::Object"
  29     _backend_type = "ns3"
  30
  31     def __init__(self):
  32         super(NS3Base, self).__init__()
  33         self._uuid = None
  34         self._connected = set()
  35
  36     @property
  37     def connected(self):
  38         return self._connected
  39
  40     @property
  41     def uuid(self):
  42         return self._uuid
  43
  44     @property
  45     def simulator(self):
  46         simulators = self.get_connected(NS3Simulator.get_rtype())
  47         if simulators: return simulators[0]
  48         # if the object is not directly connected to the simulator,
  49         # it should be connected to a node
  50         node = self.node
  51         if node: return node.simulator
  52         return None
  53
  54     @property
  55     def node(self):
  56         from nepi.resources.ns3.ns3node import NS3BaseNode
  57         nodes = self.get_connected(NS3BaseNode.get_rtype())
  58         if nodes: return nodes[0]
  59         return None
  60
  61     @property
  62     def others_to_wait(self):
  63         others = set()
  64         node = self.node
  65         if node: others.add(node)
  66         return others
  67
  68     def _instantiate_object(self):
  69         if self.uuid:
  70             return
  71
  72         kwargs = dict()
  73         for attr in self._attrs:
  74             if not attr.value or attr.has_flag(Flags.ReadOnly):
  75                 continue
  76
  77             kwargs[attr.name] = attr.value
  78
  79         self.uuid = self.simulator.factory(self.get_rtype(), **kwargs)
  80
  81     def _configure_object(self):
  82         pass
  83
  84     def _connect_object(self):
  85         node = self.node
  86         if node and node.uuid not in self.connected:
  87             self.simulator.invoke(node.uuid, "AggregateObject", self.uuid)
  88             self._connected.add(node.uuid)
  89
  90     def _wait_others(self):
  91         """ Returns the collection of ns-3 RMs that this RM needs to
  92         wait for before start
  93
  94         This method should be overriden to wait for other ns-3
  95         objects to be deployed before proceeding with the deployment
  96
  97         """
  98         for other in self.others_to_wait:
  99             if other and other.state < ResourceState.READY:
 100                 return True
 101         return False
 102
 103     def do_provision(self):
 104         # create run dir for ns3 object
 105         # self.simulator.node.mkdir(self.run_home)
 106
 107         self._instantiate_object()
 108         self._connect_object()
 109         self._configure_object()
 110
 111         self.info("Provisioning finished")
 112
 113         super(NS3Base, self).do_provision()
 114
 115     def do_deploy(self):
 116         if not self.simulator or self.simulator.state < ResourceState.READY or \
 117                 self._wait_others():
 118             self.debug("---- RESCHEDULING DEPLOY ----" )
 119
 120             # ccnd needs to wait until node is deployed and running
 121             self.ec.schedule(reschedule_delay, self.deploy)
 122         else:
 123             # TODO: CREATE AND CONFIGURE NS-3 C++ OBJECT
 124             self.do_discover()
 125             self.do_provision()
 126
 127             self.debug("----- READY ---- ")
 128             self.set_ready()
 129
 130     def do_start(self):
 131         if self.state == ResourceState.READY:
 132             # No need to do anything, simulator.Run() will start every object
 133             self.info("Starting")
 134             self.set_started()
 135         else:
 136             msg = " Failed "
 137             self.error(msg, out, err)
 138             raise RuntimeError, msg
 139
 140     def do_stop(self):
 141         if self.state == ResourceState.STARTED:
 142             # No need to do anything, simulator.Destroy() will stop every object
 143             self.info("Stopping command '%s'" % command)
 144             self.set_stopped()
 145
 146     @property
 147     def state(self):
 148         return self._state
 149