ns-3 simulator synchronizing start
[nepi.git] / src / nepi / resources / ns3 / ns3wrapper.py
index 9f84db7..f6075b0 100644 (file)
@@ -25,12 +25,15 @@ import time
 import uuid
 
 SINGLETON = "singleton::"
+SIMULATOR_UUID = "singleton::Simulator"
+CONFIG_UUID = "singleton::Config"
+GLOBAL_VALUE_UUID = "singleton::GlobalValue"
+IPV4_GLOBAL_ROUTING_HELPER_UUID = "singleton::Ipv4GlobalRoutingHelper"
 
-def load_ns3_module():
+def load_ns3_libraries():
     import ctypes
     import re
 
-    bindings = os.environ.get("NS3BINDINGS")
     libdir = os.environ.get("NS3LIBRARIES")
 
     # Load the ns-3 modules shared libraries
@@ -58,9 +61,13 @@ def load_ns3_module():
             # to prevent infinit loop
             if initial_size == len(libs):
                 raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
-            initial_size = list(libs)
+            initial_size = len(libs)
+
+def load_ns3_module():
+    load_ns3_libraries()
 
     # import the python bindings for the ns-3 modules
+    bindings = os.environ.get("NS3BINDINGS")
     if bindings:
         sys.path.append(bindings)
 
@@ -94,26 +101,18 @@ def load_ns3_module():
     return ns3mod
 
 class NS3Wrapper(object):
-    def __init__(self, homedir = None, loglevel = logging.INFO):
+    def __init__(self, loglevel = logging.INFO):
         super(NS3Wrapper, self).__init__()
         # Thread used to run the simulation
         self._simulation_thread = None
         self._condition = None
 
-        # XXX: Started should be global. There is no support for more than
-        # one simulator per process
+        # True if Simulator::Run was invoked
         self._started = False
 
         # holds reference to all C++ objects and variables in the simulation
         self._objects = dict()
 
-        # create home dir (where all simulation related files will end up)
-        self._homedir = homedir or os.path.join("/", "tmp", "ns3_wrapper" )
-        
-        home = os.path.normpath(self.homedir)
-        if not os.path.exists(home):
-            os.makedirs(home, 0755)
-
         # Logging
         self._logger = logging.getLogger("ns3wrapper")
         self._logger.setLevel(loglevel)
@@ -161,10 +160,6 @@ class NS3Wrapper(object):
         
         return self._allowed_types
 
-    @property
-    def homedir(self):
-        return self._homedir
-
     @property
     def logger(self):
         return self._logger
@@ -216,23 +211,33 @@ class NS3Wrapper(object):
 
         return uuid
 
-    def invoke(self, uuid, operation, *args):
+    def invoke(self, uuid, operation, *args, **kwargs):
+        if operation == "isRunning":
+            return self._is_running()
+        if operation == "isAppRunning":
+            return self._is_app_running(uuid)
+        if operation == "addStaticRoute":
+            return self._add_static_route(uuid, *args)
+
         if uuid.startswith(SINGLETON):
             obj = self._singleton(uuid)
         else:
             obj = self.get_object(uuid)
-    
+        
         method = getattr(obj, operation)
 
         # arguments starting with 'uuid' identify ns-3 C++
         # objects and must be replaced by the actual object
         realargs = self.replace_args(args)
+        realkwargs = self.replace_kwargs(kwargs)
 
-        result = method(*realargs)
+        result = method(*realargs, **realkwargs)
 
-        if not result:
-            return None
-        
+        # If the result is not an object, no need to 
+        # keep a reference. Directly return value.
+        if result is None or type(result) in [bool, float, long, str, int]:
+            return result
+      
         newuuid = self.make_uuid()
         self._objects[newuuid] = result
 
@@ -253,11 +258,15 @@ class NS3Wrapper(object):
         # to set the value by scheduling an event, else
         # we risk to corrupt the state of the
         # simulation.
+        
+        event_executed = [False]
+
         if self.is_running:
             # schedule the event in the Simulator
-            self._schedule_event(self._condition, self._set_attr, 
-                    obj, name, ns3_value)
-        else:
+            self._schedule_event(self._condition, event_executed, 
+                    self._set_attr, obj, name, ns3_value)
+
+        if not event_executed[0]:
             self._set_attr(obj, name, ns3_value)
 
         return value
@@ -270,12 +279,15 @@ class NS3Wrapper(object):
         type_name = obj.GetInstanceTypeId().GetName()
         ns3_value = self._create_attr_ns3_value(type_name, name)
 
+        event_executed = [False]
+
         if self.is_running:
             # schedule the event in the Simulator
-            self._schedule_event(self._condition, self._get_attr, obj,
-                    name, ns3_value)
-        else:
-            get_attr(obj, name, ns3_value)
+            self._schedule_event(self._condition, event_executed,
+                    self._get_attr, obj, name, ns3_value)
+
+        if not event_executed[0]:
+            self._get_attr(obj, name, ns3_value)
 
         return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
 
@@ -301,10 +313,9 @@ class NS3Wrapper(object):
             #self.logger.debug("Waiting for simulation to finish")
             time.sleep(0.5)
         
-        # TODO!!!! SHOULD WAIT UNTIL THE THREAD FINISHES
         if self._simulator_thread:
             self._simulator_thread.join()
-        
+       
         self.ns3.Simulator.Destroy()
         
         # Remove all references to ns-3 objects
@@ -322,17 +333,16 @@ class NS3Wrapper(object):
         condition.notifyAll()
         condition.release()
 
-    def _schedule_event(self, condition, func, *args):
+    def _schedule_event(self, condition, event_executed, func, *args):
         """ Schedules event on running simulation, and wait until
             event is executed"""
 
-        def execute_event(contextId, condition, has_event_occurred, func, *args):
+        def execute_event(contextId, condition, event_executed, func, *args):
             try:
                 func(*args)
+                event_executed[0] = True
             finally:
-                # flag event occured
-                has_event_occurred[0] = True
-                # notify condition indicating attribute was set
+                # notify condition indicating event was executed
                 condition.acquire()
                 condition.notifyAll()
                 condition.release()
@@ -342,21 +352,16 @@ class NS3Wrapper(object):
 
         # delay 0 means that the event is expected to execute inmediately
         delay = self.ns3.Seconds(0)
+    
+        # Mark event as not executed
+        event_executed[0] = False
 
-        # flag to indicate that the event occured
-        # because bool is an inmutable object in python, in order to create a
-        # bool flag, a list is used as wrapper
-        has_event_occurred = [False]
         condition.acquire()
-
-        simu = self.ns3.Simulator
-
         try:
-            if not simu.IsFinished():
-                simu.ScheduleWithContext(contextId, delay, execute_event,
-                     condition, has_event_occurred, func, *args)
-                while not has_event_occurred[0] and not simu.IsFinished():
-                    condition.wait()
+            self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event, 
+                    condition, event_executed, func, *args)
+            if not self.ns3.Simulator.IsFinished():
+                condition.wait()
         finally:
             condition.release()
 
@@ -432,3 +437,93 @@ class NS3Wrapper(object):
 
         return realargs
 
+    # replace uuids and singleton references for the real objects
+    def replace_kwargs(self, kwargs):
+        realkwargs = dict([(k, self.get_object(v) \
+                if str(v).startswith("uuid") else v) \
+                for k,v in kwargs.iteritems()])
+        realkwargs = dict([(k, self._singleton(v) \
+                if str(v).startswith(SINGLETON) else v )\
+                for k, v in realkwargs.iteritems()])
+
+        return realkwargs
+
+    def _is_running(self): 
+        if self.ns3.Simulator.IsFinished():
+            return False
+
+        now = self.ns3.Simulator.Now()
+        if now.IsZero():
+            return False
+        
+        return True
+
+    def _is_app_running(self, uuid): 
+        now = self.ns3.Simulator.Now()
+        if now.IsZero():
+            return False
+
+        app = self.get_object(uuid)
+        stop_time_value = self.ns3.TimeValue()
+        app.GetAttribute("StopTime", stop_time_value)
+        stop_time = stop_time_value.Get()
+
+        start_time_value = self.ns3.TimeValue()
+        app.GetAttribute("StartTime", start_time_value)
+        start_time = start_time_value.Get()
+        
+        if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
+            return True
+
+        return False
+
+    def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
+        ipv4 = self.get_object(ipv4_uuid)
+
+        list_routing = ipv4.GetRoutingProtocol()
+        (static_routing, priority) = list_routing.GetRoutingProtocol(0)
+
+        ifindex = self._find_ifindex(ipv4, nexthop)
+        if ifindex == -1:
+            return False
+        
+        nexthop = self.ns3.Ipv4Address(nexthop)
+
+        if network in ["0.0.0.0", "0", None]:
+            # Default route: 0.0.0.0/0
+            static_routing.SetDefaultRoute(nexthop, ifindex)
+        else:
+            mask = self.ns3.Ipv4Mask("/%s" % prefix) 
+            network = self.ns3.Ipv4Address(network)
+
+            if prefix == 32:
+                # Host route: x.y.z.w/32
+                static_routing.AddHostRouteTo(network, nexthop, ifindex)
+            else:
+                # Network route: x.y.z.w/n
+                static_routing.AddNetworkRouteTo(network, mask, nexthop, 
+                        ifindex) 
+        return True
+
+    def _find_ifindex(self, ipv4, nexthop):
+        ifindex = -1
+
+        nexthop = self.ns3.Ipv4Address(nexthop)
+
+        # For all the interfaces registered with the ipv4 object, find
+        # the one that matches the network of the nexthop
+        nifaces = ipv4.GetNInterfaces()
+        for ifidx in xrange(nifaces):
+            iface = ipv4.GetInterface(ifidx)
+            naddress = iface.GetNAddresses()
+            for addridx in xrange(naddress):
+                ifaddr = iface.GetAddress(addridx)
+                ifmask = ifaddr.GetMask()
+                
+                ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
+
+                if ifindex == ifidx:
+                    return ifindex
+        return ifindex
+