Bugfixing for ns3::MatrixPropagationLossModel ...
[nepi.git] / src / nepi / testbeds / ns3 / execute.py
index d031090..7de7bde 100644 (file)
@@ -1,11 +1,10 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from util import  _get_ipv4_protocol_guid, _get_node_guid, _get_dev_number
 from nepi.core import testbed_impl
 from nepi.core.attributes import Attribute
-from constants import TESTBED_ID
-from nepi.util.constants import TIME_NOW, \
-    TESTBED_STATUS_STARTED
+from constants import TESTBED_ID, TESTBED_VERSION
+from nepi.util.constants import TIME_NOW, TestbedStatus as TS
 import os
 import sys
 import threading
@@ -13,17 +12,58 @@ import random
 import socket
 import weakref
 
+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,
     }
-    
+   
+    DUMMY_FACTORIES = ['ns3::Nepi::MobilityPair']
+
     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()
@@ -41,7 +81,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)
@@ -60,29 +100,46 @@ class TestbedController(testbed_impl.TestbedController):
 
     def stop(self, time = TIME_NOW):
         super(TestbedController, self).stop(time)
-        #self.ns3.Simulator.Stop()
         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]
+        if factory_id in self.DUMMY_FACTORIES:
+            return 
+
         factory = self._factories[factory_id]
-        if factory.box_attributes.is_attribute_design_only(name):
-            return
         element = self._elements[guid]
         if factory_id in self.LOCAL_FACTORIES:
             setattr(element, name, value)
-        elif factory.box_attributes.is_attribute_invisible(name):
-            return
-        else:
-            ns3_value = self._to_ns3_value(guid, name, value)
-            self._set_attribute(name, ns3_value, element)
+        elif not factory.box_attributes.is_attribute_metadata(name):
+            if name == "Up":
+                ipv4_guid =  _get_ipv4_protocol_guid(self, guid)
+                if not ipv4_guid in self._elements:
+                    return
+                ipv4 = self._elements[ipv4_guid]
+                if value == False:
+                    nint = ipv4.GetNInterfaces()
+                    for i in xrange(0, nint):
+                        ipv4.SetDown(i)
+                else:
+                    nint = ipv4.GetNInterfaces()
+                    for i in xrange(0, nint):
+                        ipv4.SetUp(i)
+            else:
+                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]
+        if factory_id in self.DUMMY_FACTORIES:
+            return 
+
         factory = self._factories[factory_id]
         element = self._elements[guid]
         if factory_id in self.LOCAL_FACTORIES:
@@ -90,12 +147,25 @@ class TestbedController(testbed_impl.TestbedController):
                 return getattr(element, name)
             else:
                 return value
-        if factory.box_attributes.is_attribute_design_only(name) or \
-                factory.box_attributes.is_attribute_invisible(name):
+        else: 
+            if name == "Up":
+                ipv4_guid =  _get_ipv4_protocol_guid(self, guid)
+                if not ipv4_guid in self._elements:
+                    return True
+                ipv4 = self._elements[ipv4_guid]
+                nint = ipv4.GetNInterfaces()
+                value = True
+                for i in xrange(0, nint):
+                    value = ipv4.IsUp(i)
+                    if not value: break
+                return value
+
+        if factory.box_attributes.is_attribute_metadata(name):
             return value
+
         TypeId = self.ns3.TypeId()
         typeid = TypeId.LookupByName(factory_id)
-        info = TypeId.AttributeInfo()
+        info = TypeId.AttributeInformation()
         if not typeid or not typeid.LookupAttributeByName(name, info):
             raise AttributeError("Invalid attribute %s for element type %d" % \
                 (name, guid))
@@ -104,6 +174,7 @@ class TestbedController(testbed_impl.TestbedController):
         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:
             return int(value)
         if attr_type == Attribute.DOUBLE:
@@ -119,6 +190,9 @@ class TestbedController(testbed_impl.TestbedController):
         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 not guid in self._traces:
             self._traces[guid] = dict()
@@ -128,25 +202,19 @@ class TestbedController(testbed_impl.TestbedController):
         for element in self._elements.itervalues():
             if isinstance(element, self.LOCAL_TYPES):
                 # graceful shutdown of locally-implemented objects
-                element.Cleanup()
+                element.cleanup()
         if self.ns3:
-            self.ns3.Simulator.Stop()
+            if not self.ns3.Simulator.IsFinished():
+                self.stop()
             
-            # Wait for it to stop, with a 30s timeout
-            for i in xrange(300):
-                if self.ns3.Simulator.IsFinished():
-                    break
-                time.sleep(0.1)
-            #self._stop_simulation("0s")
-        
-        self._elements.clear()
-        
-        if self.ns3:
             # TODO!!!! SHOULD WAIT UNTIL THE THREAD FINISHES
-            #   if self._simulator_thread:
-            #       self._simulator_thread.join()
+            if self._simulator_thread:
+                self._simulator_thread.join()
+            
             self.ns3.Simulator.Destroy()
         
+        self._elements.clear()
+        
         self._ns3 = None
         sys.stdout.flush()
         sys.stderr.flush()
@@ -161,7 +229,7 @@ class TestbedController(testbed_impl.TestbedController):
 
     def _schedule_event(self, condition, func, *args):
         """Schedules event on running experiment"""
-        def execute_event(condition, has_event_occurred, func, *args):
+        def execute_event(contextId, condition, has_event_occurred, func, *args):
             # exec func
             try:
                 func(*args)
@@ -182,15 +250,17 @@ 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()
+        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() == TESTBED_STATUS_STARTED:
+        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)
@@ -198,7 +268,7 @@ class TestbedController(testbed_impl.TestbedController):
             self._set_ns3_attribute(name, ns3_value, element)
 
     def _get_attribute(self, name, ns3_value, element):
-        if self.status() == TESTBED_STATUS_STARTED:
+        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)
@@ -212,14 +282,14 @@ class TestbedController(testbed_impl.TestbedController):
         element.GetAttribute(name, ns3_value)
 
     def _stop_simulation(self, time):
-        if self.status() == TESTBED_STATUS_STARTED:
+        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_simulation(self, time = TIME_NOW):
+    def _stop_ns3_simulation(self, time = TIME_NOW):
         if not self.ns3:
             return
         if time == TIME_NOW:
@@ -231,7 +301,7 @@ class TestbedController(testbed_impl.TestbedController):
         factory_id = self._create[guid]
         TypeId = self.ns3.TypeId()
         typeid = TypeId.LookupByName(factory_id)
-        info = TypeId.AttributeInfo()
+        info = TypeId.AttributeInformation()
         if not typeid.LookupAttributeByName(name, info):
             raise RuntimeError("Attribute %s doesn't belong to element %s" \
                    % (name, factory_id))
@@ -243,45 +313,24 @@ 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)
+        load_ns3_module()
 
-        path = [ os.path.dirname(__file__) ] + sys.path
-        if bindings:
-            path = [ bindings ] + path
-
-        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)
@@ -297,7 +346,7 @@ class TestbedController(testbed_impl.TestbedController):
         TypeId = self.ns3.TypeId()
         typeid = TypeId.LookupByName(factory_id)
         for name, value in params.iteritems():
-            info = self.ns3.TypeId.AttributeInfo()
+            info = self.ns3.TypeId.AttributeInformation()
             found = typeid.LookupAttributeByName(name, info)
             if found and \
                 (info.flags & TypeId.ATTR_CONSTRUCT == TypeId.ATTR_CONSTRUCT):