Added TCP-handshake for TunChannel and tun_connect.py
[nepi.git] / src / nepi / testbeds / ns3 / execute.py
index 2b10a74..0635f26 100644 (file)
@@ -1,10 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-from constants import TESTBED_ID
 from nepi.core import testbed_impl
 from nepi.core.attributes import Attribute
-from nepi.util.constants import TIME_NOW
+from constants import TESTBED_ID, TESTBED_VERSION
+from nepi.util.constants import TIME_NOW, TestbedStatus as TS
 import os
 import sys
 import threading
@@ -12,23 +12,61 @@ import random
 import socket
 import weakref
 
-from nepi.util.tunchannel import TunChannel
+def load_ns3_module():
+    import sys
+    if 'ns3' in sys.modules:
+        return
+
+    import ctypes
+    import imp
+    import re
+
+    bindings = os.environ["NEPI_NS3BINDINGS"] \
+               if "NEPI_NS3BINDINGS" in os.environ else None
+    libdir = os.environ["NEPI_NS3LIBRARY"] \
+               if "NEPI_NS3LIBRARY" in os.environ else None
+
+    if libdir:
+        files = os.listdir(libdir)
+        regex = re.compile("(.*\.so)$")
+        libs = [m.group(1) for filename in files for m in [regex.search(filename)] if m]
+
+        libscp = list(libs)
+        while len(libs) > 0:
+            for lib in libscp:
+                libfile = os.path.join(libdir, lib)
+                try:
+                    ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
+                    libs.remove(lib)
+                except:
+                    pass
+            # if did not load any libraries in the last iteration
+            if len(libscp) == len(libs):
+                raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
+            libscp = list(libs)
+
+    if bindings:
+        sys.path.append(bindings)
+
+    import ns3_bindings_import as mod
+    sys.modules["ns3"] = mod
 
 class TestbedController(testbed_impl.TestbedController):
+    from nepi.util.tunchannel_impl import TunChannel
+    
     LOCAL_FACTORIES = {
         'ns3::Nepi::TunChannel' : TunChannel,
     }
+    
+    LOCAL_TYPES = tuple(LOCAL_FACTORIES.values())
 
-    def __init__(self, testbed_version):
-        super(TestbedController, self).__init__(TESTBED_ID, testbed_version)
+    def __init__(self):
+        super(TestbedController, self).__init__(TESTBED_ID, TESTBED_VERSION)
         self._ns3 = None
         self._home_directory = None
         self._traces = dict()
         self._simulator_thread = None
         self._condition = None
-        
-        # local factories
-        self.TunChannel = TunChannel
 
     @property
     def home_directory(self):
@@ -41,7 +79,7 @@ class TestbedController(testbed_impl.TestbedController):
     def do_setup(self):
         self._home_directory = self._attributes.\
             get_attribute_value("homeDirectory")
-        self._ns3 = self._load_ns3_module()
+        self._ns3 = self._configure_ns3_module()
         
         # create home...
         home = os.path.normpath(self.home_directory)
@@ -55,33 +93,39 @@ class TestbedController(testbed_impl.TestbedController):
         self._condition = threading.Condition()
         self._simulator_thread = threading.Thread(target = self._simulator_run,
                 args = [self._condition])
+        self._simulator_thread.setDaemon(True)
         self._simulator_thread.start()
 
+    def stop(self, time = TIME_NOW):
+        super(TestbedController, self).stop(time)
+        self._stop_simulation(time)
+
     def set(self, guid, name, value, time = TIME_NOW):
         super(TestbedController, self).set(guid, name, value, time)
         # TODO: take on account schedule time for the task
         factory_id = self._create[guid]
         factory = self._factories[factory_id]
-        if factory.box_attributes.is_attribute_design_only(name) or \
-                factory.box_attributes.is_attribute_invisible(name):
-            return
         element = self._elements[guid]
         if factory_id in self.LOCAL_FACTORIES:
             setattr(element, name, value)
-        else:
-            ns3_value = self._to_ns3_value(guid, name, value) 
-            element.SetAttribute(name, ns3_value)
+        elif not factory.box_attributes.is_attribute_metadata(name):
+            ns3_value = self._to_ns3_value(guid, name, value)
+            self._set_attribute(name, ns3_value, element)
 
     def get(self, guid, name, time = TIME_NOW):
         value = super(TestbedController, self).get(guid, name, time)
         # TODO: take on account schedule time for the task
         factory_id = self._create[guid]
         factory = self._factories[factory_id]
-        if factory.box_attributes.is_attribute_design_only(name) or \
-                factory.box_attributes.is_attribute_invisible(name):
-            return value
+        element = self._elements[guid]
         if factory_id in self.LOCAL_FACTORIES:
-            return getattr(element, name)
+            if hasattr(element, name):
+                return getattr(element, name)
+            else:
+                return value
+        if factory.box_attributes.is_attribute_metadata(name):
+            return value
+
         TypeId = self.ns3.TypeId()
         typeid = TypeId.LookupByName(factory_id)
         info = TypeId.AttributeInfo()
@@ -90,8 +134,7 @@ class TestbedController(testbed_impl.TestbedController):
                 (name, guid))
         checker = info.checker
         ns3_value = checker.Create() 
-        element = self._elements[guid]
-        element.GetAttribute(name, ns3_value)
+        self._get_attribute(name, ns3_value, element)
         value = ns3_value.SerializeToString(checker)
         attr_type = factory.box_attributes.get_attribute_type(name)
         if attr_type == Attribute.INTEGER:
@@ -105,19 +148,38 @@ class TestbedController(testbed_impl.TestbedController):
     def action(self, time, guid, action):
         raise NotImplementedError
 
-    def trace_filename(self, guid, trace_id):
-        # TODO: Need to be defined inside a home!!!! with and experiment id_code
+    def trace_filepath(self, guid, trace_id):
         filename = self._traces[guid][trace_id]
         return os.path.join(self.home_directory, filename)
 
+    def trace_filename(self, guid, trace_id):
+        return self._traces[guid][trace_id]
+
     def follow_trace(self, guid, trace_id, filename):
-        if guid not in self._traces:
+        if not guid in self._traces:
             self._traces[guid] = dict()
         self._traces[guid][trace_id] = filename
 
     def shutdown(self):
-        for element in self._elements.values():
-            element = None
+        for element in self._elements.itervalues():
+            if isinstance(element, self.LOCAL_TYPES):
+                # graceful shutdown of locally-implemented objects
+                element.cleanup()
+        if self.ns3:
+            if not self.ns3.Simulator.IsFinished():
+                self.stop()
+            
+            # TODO!!!! SHOULD WAIT UNTIL THE THREAD FINISHES
+            if self._simulator_thread:
+                self._simulator_thread.join()
+            
+            self.ns3.Simulator.Destroy()
+        
+        self._elements.clear()
+        
+        self._ns3 = None
+        sys.stdout.flush()
+        sys.stderr.flush()
 
     def _simulator_run(self, condition):
         # Run simulation
@@ -131,13 +193,15 @@ class TestbedController(testbed_impl.TestbedController):
         """Schedules event on running experiment"""
         def execute_event(condition, has_event_occurred, func, *args):
             # exec func
-            func(*args)
-            # flag event occured
-            has_event_occurred[0] = True
-            # notify condition indicating attribute was set
-            condition.acquire()
-            condition.notifyAll()
-            condition.release()
+            try:
+                func(*args)
+            finally:
+                # flag event occured
+                has_event_occurred[0] = True
+                # notify condition indicating attribute was set
+                condition.acquire()
+                condition.notifyAll()
+                condition.release()
 
         # contextId is defined as general context
         contextId = long(0xffffffff)
@@ -148,15 +212,52 @@ class TestbedController(testbed_impl.TestbedController):
         # bool flag, a list is used as wrapper
         has_event_occurred = [False]
         condition.acquire()
-        if not self.ns3.Simulator.IsFinished():
-            self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
-                 condition, has_event_occurred, func, *args)
-            while not has_event_occurred[0] and not self.ns3.Simulator.IsFinished():
-                condition.wait()
-                condition.release()
-                if not has_event_occurred[0]:
-                    raise RuntimeError('Event could not be scheduled : %s %s ' \
-                    % (repr(func), repr(args)))
+        try:
+            if not self.ns3.Simulator.IsFinished():
+                self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
+                     condition, has_event_occurred, func, *args)
+                while not has_event_occurred[0] and not self.ns3.Simulator.IsFinished():
+                    condition.wait()
+        finally:
+            condition.release()
+
+    def _set_attribute(self, name, ns3_value, element):
+        if self.status() == TS.STATUS_STARTED:
+            # schedule the event in the Simulator
+            self._schedule_event(self._condition, self._set_ns3_attribute, 
+                    name, ns3_value, element)
+        else:
+            self._set_ns3_attribute(name, ns3_value, element)
+
+    def _get_attribute(self, name, ns3_value, element):
+        if self.status() == TS.STATUS_STARTED:
+            # schedule the event in the Simulator
+            self._schedule_event(self._condition, self._get_ns3_attribute, 
+                    name, ns3_value, element)
+        else:
+            self._get_ns3_attribute(name, ns3_value, element)
+
+    def _set_ns3_attribute(self, name, ns3_value, element):
+        element.SetAttribute(name, ns3_value)
+
+    def _get_ns3_attribute(self, name, ns3_value, element):
+        element.GetAttribute(name, ns3_value)
+
+    def _stop_simulation(self, time):
+        if self.status() == TS.STATUS_STARTED:
+            # schedule the event in the Simulator
+            self._schedule_event(self._condition, self._stop_ns3_simulation, 
+                    time)
+        else:
+            self._stop_ns3_simulation(time)
+
+    def _stop_ns3_simulation(self, time = TIME_NOW):
+        if not self.ns3:
+            return
+        if time == TIME_NOW:
+            self.ns3.Simulator.Stop()
+        else:
+            self.ns3.Simulator.Stop(self.ns3.Time(time))
 
     def _to_ns3_value(self, guid, name, value):
         factory_id = self._create[guid]
@@ -174,47 +275,30 @@ class TestbedController(testbed_impl.TestbedController):
         ns3_value.DeserializeFromString(str_value, checker)
         return ns3_value
 
-    def _load_ns3_module(self):
-        import ctypes
-        import imp
-
+    def _configure_ns3_module(self):
         simu_impl_type = self._attributes.get_attribute_value(
                 "SimulatorImplementationType")
+        sched_impl_type = self._attributes.get_attribute_value(
+                "SchedulerType")
         checksum = self._attributes.get_attribute_value("ChecksumEnabled")
+        stop_time = self._attributes.get_attribute_value("StopTime")
 
-        bindings = os.environ["NEPI_NS3BINDINGS"] \
-                if "NEPI_NS3BINDINGS" in os.environ else None
-        libfile = os.environ["NEPI_NS3LIBRARY"] \
-                if "NEPI_NS3LIBRARY" in os.environ else None
-
-        if libfile:
-            ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
-
-        path = [ os.path.dirname(__file__) ] + sys.path
-        if bindings:
-            path = [ bindings ] + path
+        load_ns3_module()
 
-        try:
-            module = imp.find_module ('ns3', path)
-            mod = imp.load_module ('ns3', *module)
-        except ImportError:
-            # In some environments, ns3 per-se does not exist,
-            # only the low-level _ns3
-            module = imp.find_module ('_ns3', path)
-            mod = imp.load_module ('_ns3', *module)
-            sys.modules["ns3"] = mod # install it as ns3 too
-            
-            # When using _ns3, we have to make sure we destroy
-            # the simulator when the process finishes
-            import atexit
-            atexit.register(mod.Simulator.Destroy)
-    
+        import ns3 as mod
         if simu_impl_type:
             value = mod.StringValue(simu_impl_type)
             mod.GlobalValue.Bind ("SimulatorImplementationType", value)
+        if sched_impl_type:
+            value = mod.StringValue(sched_impl_type)
+            mod.GlobalValue.Bind ("SchedulerType", value)
         if checksum:
             value = mod.BooleanValue(checksum)
             mod.GlobalValue.Bind ("ChecksumEnabled", value)
+        if stop_time:
+            value = mod.Time(stop_time)
+            mod.Simulator.Stop (value)
         return mod
 
     def _get_construct_parameters(self, guid):