src/nepi/testbeds/ns3/execute.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 from constants import TESTBED_ID
   5 from nepi.core import testbed_impl
   6 from nepi.core.attributes import Attribute
   7 from nepi.util.constants import TESTBED_STATUS_CREATED
   8 import os
   9 import sys
  10 import threading
  11
  12 class TestbedController(testbed_impl.TestbedController):
  13     def __init__(self, testbed_version):
  14         super(TestbedController, self).__init__(TESTBED_ID, testbed_version)
  15         self._ns3 = None
  16         self._home_directory = None
  17         self._traces = dict()
  18         self._simulator_thread = None
  19         self._condition = None
  20
  21     @property
  22     def home_directory(self):
  23         return self._home_directory
  24
  25     @property
  26     def ns3(self):
  27         return self._ns3
  28
  29     def do_setup(self):
  30         self._home_directory = self._attributes.\
  31             get_attribute_value("homeDirectory")
  32         self._ns3 = self._load_ns3_module()
  33         super(TestbedController, self).do_setup()
  34
  35     def start(self):
  36         super(TestbedController, self).start()
  37         self._condition = threading.Condition()
  38         self._simulator_thread = threading.Thread(target = self._simulator_run,
  39                 args = [self._condition])
  40         self._simulator_thread.start()
  41
  42     def set(self, time, guid, name, value):
  43         super(TestbedController, self).set(time, guid, name, value)
  44         # TODO: take on account schedule time for the task
  45         factory_id = self._create[guid]
  46         factory = self._factories[factory_id]
  47         if factory.box_attributes.is_attribute_design_only(name):
  48             return
  49         element = self._elements[guid]
  50         ns3_value = self._to_ns3_value(guid, name, value)
  51         element.SetAttribute(name, ns3_value)
  52
  53     def get(self, time, guid, name):
  54         value = super(TestbedController, self).get(time, guid, name)
  55         # TODO: take on account schedule time for the task
  56         factory_id = self._create[guid]
  57         factory = self._factories[factory_id]
  58         if factory.box_attributes.is_attribute_design_only(name):
  59             return value
  60         TypeId = self.ns3.TypeId()
  61         typeid = TypeId.LookupByName(factory_id)
  62         info = TypeId.AttributeInfo()
  63         if not typeid or not typeid.LookupAttributeByName(name, info):
  64             raise AttributeError("Invalid attribute %s for element type %d" % \
  65                 (name, guid))
  66         checker = info.checker
  67         ns3_value = checker.Create()
  68         element = self._elements[guid]
  69         element.GetAttribute(name, ns3_value)
  70         value = ns3_value.SerializeToString(checker)
  71         attr_type = factory.box_attributes.get_attribute_type(name)
  72         if attr_type == Attribute.INTEGER:
  73             return int(value)
  74         if attr_type == Attribute.DOUBLE:
  75             return float(value)
  76         if attr_type == Attribute.BOOL:
  77             return value == "true"
  78         return value
  79
  80     def action(self, time, guid, action):
  81         raise NotImplementedError
  82
  83     def trace_filename(self, guid, trace_id):
  84         # TODO: Need to be defined inside a home!!!! with and experiment id_code
  85         filename = self._traces[guid][trace_id]
  86         return os.path.join(self.home_directory, filename)
  87
  88     def follow_trace(self, guid, trace_id, filename):
  89         if guid not in self._traces:
  90             self._traces[guid] = dict()
  91         self._traces[guid][trace_id] = filename
  92
  93     def shutdown(self):
  94         for element in self._elements.values():
  95             element = None
  96
  97     def _simulator_run(self, condition):
  98         # Run simulation
  99         self.ns3.Simulator.Run()
 100         # Signal condition on simulation end to notify waiting threads
 101         condition.acquire()
 102         condition.notifyAll()
 103         condition.release()
 104
 105     def _schedule_event(self, condition, func, *args):
 106         """Schedules event on running experiment"""
 107         def execute_event(condition, has_event_occurred, func, *args):
 108             # exec func
 109             func(*args)
 110             # flag event occured
 111             has_event_occurred[0] = True
 112             # notify condition indicating attribute was set
 113             condition.acquire()
 114             condition.notifyAll()
 115             condition.release()
 116
 117         # contextId is defined as general context
 118         contextId = long(0xffffffff)
 119         # delay 0 means that the event is expected to execute inmediately
 120         delay = self.ns3.Seconds(0)
 121         # flag to indicate that the event occured
 122         # because bool is an inmutable object in python, in order to create a
 123         # bool flag, a list is used as wrapper
 124         has_event_occurred = [False]
 125         condition.acquire()
 126         if not self.ns3.Simulator.IsFinished():
 127             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
 128                  condition, has_event_occurred, func, *args)
 129             while not has_event_occurred[0] and not self.ns3.Simulator.IsFinished():
 130                 condition.wait()
 131                 condition.release()
 132                 if not has_event_occurred[0]:
 133                     raise RuntimeError('Event could not be scheduled : %s %s ' \
 134                     % (repr(func), repr(args)))
 135
 136     def _to_ns3_value(self, guid, name, value):
 137         factory_id = self._create[guid]
 138         TypeId = self.ns3.TypeId()
 139         typeid = TypeId.LookupByName(factory_id)
 140         info = TypeId.AttributeInfo()
 141         if not typeid.LookupAttributeByName(name, info):
 142             raise RuntimeError("Attribute %s doesn't belong to element %s" \
 143                    % (name, factory_id))
 144         str_value = str(value)
 145         if isinstance(value, bool):
 146             str_value = str_value.lower()
 147         checker = info.checker
 148         ns3_value = checker.Create()
 149         ns3_value.DeserializeFromString(str_value, checker)
 150         return ns3_value
 151
 152     def _load_ns3_module(self):
 153         import ctypes
 154         import imp
 155
 156         simu_impl_type = self._attributes.get_attribute_value(
 157                 "SimulatorImplementationType")
 158         checksum = self._attributes.get_attribute_value("ChecksumEnabled")
 159
 160         bindings = os.environ["NEPI_NS3BINDINGS"] \
 161                 if "NEPI_NS3BINDINGS" in os.environ else None
 162         libfile = os.environ["NEPI_NS3LIBRARY"] \
 163                 if "NEPI_NS3LIBRARY" in os.environ else None
 164
 165         if libfile:
 166             ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
 167
 168         path = [ os.path.dirname(__file__) ] + sys.path
 169         if bindings:
 170             path = [ bindings ] + path
 171
 172         module = imp.find_module ('ns3', path)
 173         mod = imp.load_module ('ns3', *module)
 174
 175         if simu_impl_type:
 176             value = mod.StringValue(simu_impl_type)
 177             mod.GlobalValue.Bind ("SimulatorImplementationType", value)
 178         if checksum:
 179             value = mod.BooleanValue(checksum)
 180             mod.GlobalValue.Bind ("ChecksumEnabled", value)
 181         return mod
 182
 183     def _get_construct_parameters(self, guid):
 184         params = self._get_parameters(guid)
 185         construct_params = dict()
 186         factory_id = self._create[guid]
 187         TypeId = self.ns3.TypeId()
 188         typeid = TypeId.LookupByName(factory_id)
 189         for name, value in params.iteritems():
 190             info = self.ns3.TypeId.AttributeInfo()
 191             found = typeid.LookupAttributeByName(name, info)
 192             if found and \
 193                 (info.flags & TypeId.ATTR_CONSTRUCT == TypeId.ATTR_CONSTRUCT):
 194                 construct_params[name] = value
 195         return construct_params
 196