src/nepi/resources/ns3/ns3wrapper.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 import logging
  21 import os
  22 import sys
  23 import threading
  24 import time
  25 import uuid
  26
  27 SINGLETON = "singleton::"
  28 SIMULATOR_UUID = "singleton::Simulator"
  29 CONFIG_UUID = "singleton::Config"
  30 GLOBAL_VALUE_UUID = "singleton::GlobalValue"
  31
  32 def load_ns3_module():
  33     import ctypes
  34     import re
  35
  36     bindings = os.environ.get("NS3BINDINGS")
  37     libdir = os.environ.get("NS3LIBRARIES")
  38
  39     # Load the ns-3 modules shared libraries
  40     if libdir:
  41         files = os.listdir(libdir)
  42         regex = re.compile("(.*\.so)$")
  43         libs = [m.group(1) for filename in files for m in [regex.search(filename)] if m]
  44
  45         initial_size = len(libs)
  46         # Try to load the libraries in the right order by trial and error.
  47         # Loop until all libraries are loaded.
  48         while len(libs) > 0:
  49             for lib in libs:
  50                 libfile = os.path.join(libdir, lib)
  51                 try:
  52                     ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
  53                     libs.remove(lib)
  54                 except:
  55                     #import traceback
  56                     #err = traceback.format_exc()
  57                     #print err
  58                     pass
  59
  60             # if did not load any libraries in the last iteration break
  61             # to prevent infinit loop
  62             if initial_size == len(libs):
  63                 raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
  64             initial_size = list(libs)
  65
  66     # import the python bindings for the ns-3 modules
  67     if bindings:
  68         sys.path.append(bindings)
  69
  70     import pkgutil
  71     import imp
  72     import ns
  73
  74     # create a Python module to add all ns3 classes
  75     ns3mod = imp.new_module("ns3")
  76     sys.modules["ns3"] = ns3mod
  77
  78     for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
  79         if modname in [ "visualizer" ]:
  80             continue
  81
  82         fullmodname = "ns.%s" % modname
  83         module = __import__(fullmodname, globals(), locals(), ['*'])
  84
  85         for sattr in dir(module):
  86             if sattr.startswith("_"):
  87                 continue
  88
  89             attr = getattr(module, sattr)
  90
  91             # netanim.Config and lte.Config singleton overrides ns3::Config
  92             if sattr == "Config" and modname in ['netanim', 'lte']:
  93                 sattr = "%s.%s" % (modname, sattr)
  94
  95             setattr(ns3mod, sattr, attr)
  96
  97     return ns3mod
  98
  99 class NS3Wrapper(object):
 100     def __init__(self, loglevel = logging.INFO):
 101         super(NS3Wrapper, self).__init__()
 102         # Thread used to run the simulation
 103         self._simulation_thread = None
 104         self._condition = None
 105
 106         # True if Simulator::Run was invoked
 107         self._started = False
 108
 109         # holds reference to all C++ objects and variables in the simulation
 110         self._objects = dict()
 111
 112         # Logging
 113         self._logger = logging.getLogger("ns3wrapper")
 114         self._logger.setLevel(loglevel)
 115
 116         ## NOTE that the reason to create a handler to the ns3 module,
 117         # that is re-loaded each time a ns-3 wrapper is instantiated,
 118         # is that else each unit test for the ns3wrapper class would need
 119         # a separate file. Several ns3wrappers would be created in the
 120         # same unit test (single process), leading to inchorences in the
 121         # state of ns-3 global objects
 122         #
 123         # Handler to ns3 classes
 124         self._ns3 = None
 125
 126         # Collection of allowed ns3 classes
 127         self._allowed_types = None
 128
 129     @property
 130     def ns3(self):
 131         if not self._ns3:
 132             # load ns-3 libraries and bindings
 133             self._ns3 = load_ns3_module()
 134
 135         return self._ns3
 136
 137     @property
 138     def allowed_types(self):
 139         if not self._allowed_types:
 140             self._allowed_types = set()
 141             type_id = self.ns3.TypeId()
 142
 143             tid_count = type_id.GetRegisteredN()
 144             base = type_id.LookupByName("ns3::Object")
 145
 146             for i in xrange(tid_count):
 147                 tid = type_id.GetRegistered(i)
 148
 149                 if tid.MustHideFromDocumentation() or \
 150                         not tid.HasConstructor() or \
 151                         not tid.IsChildOf(base):
 152                     continue
 153
 154                 type_name = tid.GetName()
 155                 self._allowed_types.add(type_name)
 156
 157         return self._allowed_types
 158
 159     @property
 160     def logger(self):
 161         return self._logger
 162
 163     @property
 164     def is_running(self):
 165         return self._started and self.ns3.Simulator.IsFinished()
 166
 167     def make_uuid(self):
 168         return "uuid%s" % uuid.uuid4()
 169
 170     def get_object(self, uuid):
 171         return self._objects.get(uuid)
 172
 173     def factory(self, type_name, **kwargs):
 174         if type_name not in self.allowed_types:
 175             msg = "Type %s not supported" % (type_name)
 176             self.logger.error(msg)
 177
 178         factory = self.ns3.ObjectFactory()
 179         factory.SetTypeId(type_name)
 180
 181         for name, value in kwargs.iteritems():
 182             ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 183             factory.Set(name, ns3_value)
 184
 185         obj = factory.Create()
 186
 187         uuid = self.make_uuid()
 188         self._objects[uuid] = obj
 189
 190         return uuid
 191
 192     def create(self, clazzname, *args):
 193         if not hasattr(self.ns3, clazzname):
 194             msg = "Type %s not supported" % (clazzname)
 195             self.logger.error(msg)
 196
 197         clazz = getattr(self.ns3, clazzname)
 198
 199         # arguments starting with 'uuid' identify ns-3 C++
 200         # objects and must be replaced by the actual object
 201         realargs = self.replace_args(args)
 202
 203         obj = clazz(*realargs)
 204
 205         uuid = self.make_uuid()
 206         self._objects[uuid] = obj
 207
 208         return uuid
 209
 210     def invoke(self, uuid, operation, *args):
 211         if operation == "isAppRunning":
 212             return self._is_app_running(uuid)
 213
 214         if uuid.startswith(SINGLETON):
 215             obj = self._singleton(uuid)
 216         else:
 217             obj = self.get_object(uuid)
 218
 219         method = getattr(obj, operation)
 220
 221         # arguments starting with 'uuid' identify ns-3 C++
 222         # objects and must be replaced by the actual object
 223         realargs = self.replace_args(args)
 224
 225         result = method(*realargs)
 226
 227         if not result:
 228             return result
 229
 230         newuuid = self.make_uuid()
 231         self._objects[newuuid] = result
 232
 233         return newuuid
 234
 235     def _set_attr(self, obj, name, ns3_value):
 236         obj.SetAttribute(name, ns3_value)
 237
 238     def set(self, uuid, name, value):
 239         obj = self.get_object(uuid)
 240         type_name = obj.GetInstanceTypeId().GetName()
 241         ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 242
 243         # If the Simulation thread is not running,
 244         # then there will be no thread-safety problems
 245         # in changing the value of an attribute directly.
 246         # However, if the simulation is running we need
 247         # to set the value by scheduling an event, else
 248         # we risk to corrupt the state of the
 249         # simulation.
 250
 251         event_executed = [False]
 252
 253         if self.is_running:
 254             # schedule the event in the Simulator
 255             self._schedule_event(self._condition, event_executed,
 256                     self._set_attr, obj, name, ns3_value)
 257
 258         if not event_executed[0]:
 259             self._set_attr(obj, name, ns3_value)
 260
 261         return value
 262
 263     def _get_attr(self, obj, name, ns3_value):
 264         obj.GetAttribute(name, ns3_value)
 265
 266     def get(self, uuid, name):
 267         obj = self.get_object(uuid)
 268         type_name = obj.GetInstanceTypeId().GetName()
 269         ns3_value = self._create_attr_ns3_value(type_name, name)
 270
 271         event_executed = [False]
 272
 273         if self.is_running:
 274             # schedule the event in the Simulator
 275             self._schedule_event(self._condition, event_executed,
 276                     self._get_attr, obj, name, ns3_value)
 277
 278         if not event_executed[0]:
 279             self._get_attr(obj, name, ns3_value)
 280
 281         return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
 282
 283     def start(self):
 284         # Launch the simulator thread and Start the
 285         # simulator in that thread
 286         self._condition = threading.Condition()
 287         self._simulator_thread = threading.Thread(
 288                 target = self._simulator_run,
 289                 args = [self._condition])
 290         self._simulator_thread.setDaemon(True)
 291         self._simulator_thread.start()
 292         self._started = True
 293
 294     def stop(self, time = None):
 295         if time is None:
 296             self.ns3.Simulator.Stop()
 297         else:
 298             self.ns3.Simulator.Stop(self.ns3.Time(time))
 299
 300     def shutdown(self):
 301         while not self.ns3.Simulator.IsFinished():
 302             #self.logger.debug("Waiting for simulation to finish")
 303             time.sleep(0.5)
 304
 305         if self._simulator_thread:
 306             self._simulator_thread.join()
 307
 308         self.ns3.Simulator.Destroy()
 309
 310         # Remove all references to ns-3 objects
 311         self._objects.clear()
 312
 313         sys.stdout.flush()
 314         sys.stderr.flush()
 315
 316     def _simulator_run(self, condition):
 317         # Run simulation
 318         self.ns3.Simulator.Run()
 319         # Signal condition to indicate simulation ended and
 320         # notify waiting threads
 321         condition.acquire()
 322         condition.notifyAll()
 323         condition.release()
 324
 325     def _schedule_event(self, condition, event_executed, func, *args):
 326         """ Schedules event on running simulation, and wait until
 327             event is executed"""
 328
 329         def execute_event(contextId, condition, event_executed, func, *args):
 330             try:
 331                 func(*args)
 332                 event_executed[0] = True
 333             finally:
 334                 # notify condition indicating event was executed
 335                 condition.acquire()
 336                 condition.notifyAll()
 337                 condition.release()
 338
 339         # contextId is defined as general context
 340         contextId = long(0xffffffff)
 341
 342         # delay 0 means that the event is expected to execute inmediately
 343         delay = self.ns3.Seconds(0)
 344
 345         # Mark event as not executed
 346         event_executed[0] = False
 347
 348         condition.acquire()
 349         try:
 350             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
 351                     condition, event_executed, func, *args)
 352             if not self.ns3.Simulator.IsFinished():
 353                 condition.wait()
 354         finally:
 355             condition.release()
 356
 357     def _create_attr_ns3_value(self, type_name, name):
 358         TypeId = self.ns3.TypeId()
 359         tid = TypeId.LookupByName(type_name)
 360         info = TypeId.AttributeInformation()
 361         if not tid.LookupAttributeByName(name, info):
 362             msg = "TypeId %s has no attribute %s" % (type_name, name)
 363             self.logger.error(msg)
 364
 365         checker = info.checker
 366         ns3_value = checker.Create()
 367         return ns3_value
 368
 369     def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
 370         TypeId = self.ns3.TypeId()
 371         tid = TypeId.LookupByName(type_name)
 372         info = TypeId.AttributeInformation()
 373         if not tid.LookupAttributeByName(name, info):
 374             msg = "TypeId %s has no attribute %s" % (type_name, name)
 375             self.logger.error(msg)
 376
 377         checker = info.checker
 378         value = ns3_value.SerializeToString(checker)
 379
 380         type_name = checker.GetValueTypeName()
 381         if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
 382             return int(value)
 383         if type_name == "ns3::DoubleValue":
 384             return float(value)
 385         if type_name == "ns3::BooleanValue":
 386             return value == "true"
 387
 388         return value
 389
 390     def _attr_from_string_to_ns3_value(self, type_name, name, value):
 391         TypeId = self.ns3.TypeId()
 392         tid = TypeId.LookupByName(type_name)
 393         info = TypeId.AttributeInformation()
 394         if not tid.LookupAttributeByName(name, info):
 395             msg = "TypeId %s has no attribute %s" % (type_name, name)
 396             self.logger.error(msg)
 397
 398         str_value = str(value)
 399         if isinstance(value, bool):
 400             str_value = str_value.lower()
 401
 402         checker = info.checker
 403         ns3_value = checker.Create()
 404         ns3_value.DeserializeFromString(str_value, checker)
 405         return ns3_value
 406
 407     # singletons are identified as "ns3::ClassName"
 408     def _singleton(self, ident):
 409         if not ident.startswith(SINGLETON):
 410             return None
 411
 412         clazzname = ident[ident.find("::")+2:]
 413         if not hasattr(self.ns3, clazzname):
 414             msg = "Type %s not supported" % (clazzname)
 415             self.logger.error(msg)
 416
 417         return getattr(self.ns3, clazzname)
 418
 419     # replace uuids and singleton references for the real objects
 420     def replace_args(self, args):
 421         realargs = [self.get_object(arg) if \
 422                 str(arg).startswith("uuid") else arg for arg in args]
 423
 424         realargs = [self._singleton(arg) if \
 425                 str(arg).startswith(SINGLETON) else arg for arg in realargs]
 426
 427         return realargs
 428
 429     def _is_app_running(self, uuid):
 430         now = self.ns3.Simulator.Now()
 431         if now.IsZero():
 432             return False
 433
 434         stop_value = self.get(uuid, "StopTime")
 435         stop_time = self.ns3.Time(stop_value)
 436
 437         start_value = self.get(uuid, "StartTime")
 438         start_time = self.ns3.Time(start_value)
 439
 440         self.logger.debug("NOW %s" % now.GetSeconds())
 441         self.logger.debug("START TIME %s" % start_value)
 442         self.logger.debug("STOP TIME %s" % stop_value)
 443
 444         if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
 445             return True
 446
 447         return False
 448