+#
+# NEPI, a framework to manage network experiments
+# Copyright (C) 2013 INRIA
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+
import logging
import os
import sys
import threading
+import time
import uuid
+SINGLETON = "singleton::"
+
+def load_ns3_module():
+ import ctypes
+ import re
+
+ bindings = os.environ.get("NS3BINDINGS")
+ libdir = os.environ.get("NS3LIBRARIES")
+
+ # Load the ns-3 modules shared libraries
+ 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 libs:
+ 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 break
+ # to prevent infinit loop
+ if len(libscp) == len(libs):
+ raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
+ libscp = list(libs)
+
+ # import the python bindings for the ns-3 modules
+ if bindings:
+ sys.path.append(bindings)
+
+ import pkgutil
+ import imp
+ import ns
+
+ # create a module to add all ns3 classes
+ ns3mod = imp.new_module("ns3")
+ sys.modules["ns3"] = ns3mod
+
+ for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
+ fullmodname = "ns.%s" % modname
+ module = __import__(fullmodname, globals(), locals(), ['*'])
+
+ for sattr in dir(module):
+ if sattr.startswith("_"):
+ continue
+
+ attr = getattr(module, sattr)
+
+ # netanim.Config and lte.Config singleton overrides ns3::Config
+ if sattr == "Config" and modname in ['netanim', 'lte']:
+ sattr = "%s.%s" % (modname, sattr)
+
+ setattr(ns3mod, sattr, attr)
+
+ return ns3mod
+
class NS3Wrapper(object):
def __init__(self, homedir = None):
super(NS3Wrapper, self).__init__()
- self._ns3 = None
- self._uuid = self.make_uuid()
- self._homedir = homedir or os.path.join("/tmp", self._uuid)
+ # 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
self._started = False
- self._stopped = False
- # holds reference to all ns-3 objects in the simulation
- self._resources = dict()
+ # 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
loglevel = os.environ.get("NS3LOGLEVEL", "debug")
- self._logger = logging.getLogger("ns3wrapper.%s" % self.uuid)
+ self._logger = logging.getLogger("ns3wrapper")
self._logger.setLevel(getattr(logging, loglevel.upper()))
+
hdlr = logging.FileHandler(os.path.join(self.homedir, "ns3wrapper.log"))
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
hdlr.setFormatter(formatter)
- self._logger.addHandler(hdlr)
-
- # Load ns-3 shared libraries and import modules
- self._load_ns3_module()
+ self._logger.addHandler(hdlr)
+
+ ## NOTE that the reason to create a handler to the ns3 module,
+ # that is re-loaded each time a ns-3 wrapper is instantiated,
+ # is that else each unit test for the ns3wrapper class would need
+ # a separate file. Several ns3wrappers would be created in the
+ # same unit test (single process), leading to inchorences in the
+ # state of ns-3 global objects
+ #
+ # Handler to ns3 classes
+ self._ns3 = None
+
+ # Collection of allowed ns3 classes
+ self._allowed_types = None
+
@property
def ns3(self):
+ if not self._ns3:
+ # load ns-3 libraries and bindings
+ self._ns3 = load_ns3_module()
+
return self._ns3
@property
- def homedir(self):
- return self._homedir
+ def allowed_types(self):
+ if not self._allowed_types:
+ self._allowed_types = set()
+ type_id = self.ns3.TypeId()
+
+ tid_count = type_id.GetRegisteredN()
+ base = type_id.LookupByName("ns3::Object")
+
+ # Create a .py file using the ns-3 RM template for each ns-3 TypeId
+ for i in xrange(tid_count):
+ tid = type_id.GetRegistered(i)
+
+ if tid.MustHideFromDocumentation() or \
+ not tid.HasConstructor() or \
+ not tid.IsChildOf(base):
+ continue
+
+ type_name = tid.GetName()
+ self._allowed_types.add(type_name)
+
+ return self._allowed_types
@property
- def uuid(self):
- return self._uuid
+ def homedir(self):
+ return self._homedir
@property
def logger(self):
return self._logger
+ @property
+ def is_running(self):
+ return self._started and self.ns3.Simulator.IsFinished()
+
def make_uuid(self):
return "uuid%s" % uuid.uuid4()
- def singleton(self, clazzname):
- uuid = "uuid%s"%clazzname
+ def get_object(self, uuid):
+ return self._objects.get(uuid)
- if not uuid in self._resources:
- if not hasattr(self.ns3, clazzname):
- msg = "Type %s not supported" % (typeid)
- self.logger.error(msg)
-
- clazz = getattr(self.ns3, clazzname)
- typeid = "ns3::%s" % clazzname
- self._resources[uuid] = (clazz, typeid)
+ def factory(self, type_name, *kwargs):
+ if type_name not in allowed_types:
+ msg = "Type %s not supported" % (type_name)
+ self.logger.error(msg)
+
+ factory = self.ns3.ObjectFactory()
+ factory.SetTypeId(type_name)
- return uuid
+ for name, value in kwargs.iteritems():
+ ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
+ factory.Set(name, ns3_value)
- def get_trace(self, trace, offset = None, nbytes = None ):
- pass
+ obj = factory.Create()
- def is_running(self):
- return self._started and not self._stopped
+ uuid = self.make_uuid()
+ self._objects[uuid] = obj
- def get_resource(self, uuid):
- (resource, typeid) = self._resources.get(uuid)
- return resource
-
- def get_typeid(self, uuid):
- (resource, typeid) = self._resources.get(uuid)
- return typeid
+ return uuid
def create(self, clazzname, *args):
if not hasattr(self.ns3, clazzname):
msg = "Type %s not supported" % (clazzname)
self.logger.error(msg)
-
+
clazz = getattr(self.ns3, clazzname)
- #typeid = clazz.GetInstanceTypeId().GetName()
- typeid = "ns3::%s" % clazzname
-
- realargs = [self.get_resource(arg) if \
- str(arg).startswith("uuid") else arg for arg in args]
-
- resource = clazz(*realargs)
+
+ # arguments starting with 'uuid' identify ns-3 C++
+ # objects and must be replaced by the actual object
+ realargs = self.replace_args(args)
+
+ obj = clazz(*realargs)
uuid = self.make_uuid()
- self._resources[uuid] = (resource, typeid)
- return uuid
+ self._objects[uuid] = obj
- def set(self, uuid, name, value):
- resource = self.get_resource(uuid)
+ return uuid
- if hasattr(resource, name):
- setattr(resource, name, value)
+ def invoke(self, uuid, operation, *args):
+ if uuid.startswith(SINGLETON):
+ obj = self._singleton(uuid)
else:
- self._set_ns3_attr(uuid, name, value)
+ 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)
+
+ result = method(*realargs)
- def get(self, name, uuid = None):
- resource = self.get_resource(uuid)
+ if not result:
+ return None
+
+ newuuid = self.make_uuid()
+ self._objects[newuuid] = result
- value = None
- if hasattr(resource, name):
- value = getattr(resource, name)
+ return newuuid
+
+ def _set_attr(self, obj, name, ns3_value):
+ obj.SetAttribute(name, ns3_value)
+
+ def set(self, uuid, name, value):
+ obj = self.get_object(uuid)
+ type_name = obj.GetInstanceTypeId().GetName()
+ ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
+
+ # If the Simulation thread is not running,
+ # then there will be no thread-safety problems
+ # in changing the value of an attribute directly.
+ # However, if the simulation is running we need
+ # to set the value by scheduling an event, else
+ # we risk to corrupt the state of the
+ # simulation.
+ if self.is_running:
+ # schedule the event in the Simulator
+ self._schedule_event(self._condition, self._set_attr,
+ obj, name, ns3_value)
else:
- value = self._get_ns3_attr(uuid, name)
+ self._set_attr(obj, name, ns3_value)
return value
- def invoke(self, uuid, operation, *args):
- resource = self.get_resource(uuid)
- typeid = self.get_typeid(uuid)
- method = getattr(resource, operation)
-
- realargs = [self.get_resource(arg) if \
- str(arg).startswith("uuid") else arg for arg in args]
+ def _get_attr(self, obj, name, ns3_value):
+ obj.GetAttribute(name, ns3_value)
- result = method(*realargs)
+ def get(self, uuid, name):
+ obj = self.get_object(uuid)
+ type_name = obj.GetInstanceTypeId().GetName()
+ ns3_value = self._create_attr_ns3_value(type_name, name)
- if not result:
- return None
-
- uuid = self.make_uuid()
- self._resources[uuid] = (result, typeid)
+ 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)
- return uuid
+ return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
def start(self):
+ # Launch the simulator thread and Start the
+ # simulator in that thread
self._condition = threading.Condition()
self._simulator_thread = threading.Thread(
target = self._simulator_run,
self._started = True
def stop(self, time = None):
- if not self.ns3:
- return
-
if time is None:
self.ns3.Simulator.Stop()
else:
self.ns3.Simulator.Stop(self.ns3.Time(time))
- self._stopped = True
def shutdown(self):
- 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()
+ while not self.ns3.Simulator.IsFinished():
+ #self.logger.debug("Waiting for simulation to finish")
+ time.sleep(0.5)
- self._resources.clear()
+ # 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
+ self._objects.clear()
- self._ns3 = None
sys.stdout.flush()
sys.stderr.flush()
def _simulator_run(self, condition):
# Run simulation
self.ns3.Simulator.Run()
- # Signal condition on simulation end to notify waiting threads
+ # Signal condition to indicate simulation ended and
+ # notify waiting threads
condition.acquire()
condition.notifyAll()
condition.release()
# bool flag, a list is used as wrapper
has_event_occurred = [False]
condition.acquire()
+
+ simu = self.ns3.Simulator
+
try:
- if not self.ns3.Simulator.IsFinished():
- self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
+ if not simu.IsFinished():
+ simu.ScheduleWithContext(contextId, delay, execute_event,
condition, has_event_occurred, func, *args)
- while not has_event_occurred[0] and not self.ns3.Simulator.IsFinished():
+ while not has_event_occurred[0] and not simu.IsFinished():
condition.wait()
finally:
condition.release()
- def _set_ns3_attr(self, uuid, name, value):
- resource = self.get_resource(uuid)
- ns3_value = self._to_ns3_value(uuid, name, value)
-
- def set_attr(resource, name, ns3_value):
- resource.SetAttribute(name, ns3_value)
-
- if self._is_running:
- # schedule the event in the Simulator
- self._schedule_event(self._condition, set_attr, resource,
- name, ns3_value)
- else:
- set_attr(resource, name, ns3_value)
-
- def _get_ns3_attr(self, uuid, name):
- resource = self.get_resource(uuid)
- ns3_value = self._create_ns3_value(uuid, name)
-
- def get_attr(resource, name, ns3_value):
- resource.GetAttribute(name, ns3_value)
-
- if self._is_running:
- # schedule the event in the Simulator
- self._schedule_event(self._condition, get_attr, resource,
- name, ns3_value)
- else:
- get_attr(resource, name, ns3_value)
-
- return self._from_ns3_value(uuid, name, ns3_value)
-
- def _create_ns3_value(self, uuid, name):
- typeid = get_typeid(uuid)
+ def _create_attr_ns3_value(self, type_name, name):
TypeId = self.ns3.TypeId()
- tid = TypeId.LookupByName(typeid)
+ tid = TypeId.LookupByName(type_name)
info = TypeId.AttributeInformation()
if not tid.LookupAttributeByName(name, info):
- msg = "TypeId %s has no attribute %s" % (typeid, name)
+ msg = "TypeId %s has no attribute %s" % (type_name, name)
self.logger.error(msg)
checker = info.checker
ns3_value = checker.Create()
return ns3_value
- def _from_ns3_value(self, uuid, name, ns3_value):
- typeid = get_typeid(uuid)
+ def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
TypeId = self.ns3.TypeId()
- tid = TypeId.LookupByName(typeid)
+ tid = TypeId.LookupByName(type_name)
info = TypeId.AttributeInformation()
if not tid.LookupAttributeByName(name, info):
- msg = "TypeId %s has no attribute %s" % (typeid, name)
+ msg = "TypeId %s has no attribute %s" % (type_name, name)
self.logger.error(msg)
checker = info.checker
return value
- def _to_ns3_value(self, uuid, name, value):
- typeid = get_typeid(uuid)
+ def _attr_from_string_to_ns3_value(self, type_name, name, value):
TypeId = self.ns3.TypeId()
- typeid = TypeId.LookupByName(typeid)
+ tid = TypeId.LookupByName(type_name)
info = TypeId.AttributeInformation()
if not tid.LookupAttributeByName(name, info):
- msg = "TypeId %s has no attribute %s" % (typeid, name)
+ msg = "TypeId %s has no attribute %s" % (type_name, name)
self.logger.error(msg)
str_value = str(value)
ns3_value.DeserializeFromString(str_value, checker)
return ns3_value
- def _load_ns3_module(self):
- if self.ns3:
- return
-
- import ctypes
- import imp
- import re
- import pkgutil
-
- bindings = os.environ.get("NS3BINDINGS")
- libdir = os.environ.get("NS3LIBRARIES")
+ # singletons are identified as "ns3::ClassName"
+ def _singleton(self, ident):
+ if not ident.startswith(SINGLETON):
+ return None
- # Load the ns-3 modules shared libraries
- 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]
+ clazzname = ident[ident.find("::")+2:]
+ if not hasattr(self.ns3, clazzname):
+ msg = "Type %s not supported" % (clazzname)
+ self.logger.error(msg)
- libscp = list(libs)
- while len(libs) > 0:
- for lib in libs:
- 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 break
- # to prevent infinit loop
- if len(libscp) == len(libs):
- raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
- libscp = list(libs)
-
- # import the python bindings for the ns-3 modules
- if bindings:
- sys.path.append(bindings)
-
- # create a module to add all ns3 classes
- ns3mod = imp.new_module("ns3")
- sys.modules["ns3"] = ns3mod
-
- # retrieve all ns3 classes and add them to the ns3 module
- import ns
- for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
- fullmodname = "ns.%s" % modname
- module = __import__(fullmodname, globals(), locals(), ['*'])
-
- # netanim.Config singleton overrides ns3::Config
- if modname in ['netanim']:
- continue
+ return getattr(self.ns3, clazzname)
- for sattr in dir(module):
- if not sattr.startswith("_"):
- attr = getattr(module, sattr)
- setattr(ns3mod, sattr, attr)
+ # replace uuids and singleton references for the real objects
+ def replace_args(self, args):
+ realargs = [self.get_object(arg) if \
+ str(arg).startswith("uuid") else arg for arg in args]
+
+ realargs = [self._singleton(arg) if \
+ str(arg).startswith(SINGLETON) else arg for arg in realargs]
- self._ns3 = ns3mod
+ return realargs
git://git.onelab.eu / nepi.git / blobdiff