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 IPV4_GLOBAL_ROUTING_HELPER_UUID = "singleton::Ipv4GlobalRoutingHelper"
  32
  33 def load_ns3_libraries():
  34     import ctypes
  35     import re
  36
  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 = len(libs)
  65
  66 def load_ns3_module():
  67     load_ns3_libraries()
  68
  69     # import the python bindings for the ns-3 modules
  70     bindings = os.environ.get("NS3BINDINGS")
  71     if bindings:
  72         sys.path.append(bindings)
  73
  74     import pkgutil
  75     import imp
  76     import ns
  77
  78     # create a Python module to add all ns3 classes
  79     ns3mod = imp.new_module("ns3")
  80     sys.modules["ns3"] = ns3mod
  81
  82     for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
  83         if modname in [ "visualizer" ]:
  84             continue
  85
  86         fullmodname = "ns.%s" % modname
  87         module = __import__(fullmodname, globals(), locals(), ['*'])
  88
  89         for sattr in dir(module):
  90             if sattr.startswith("_"):
  91                 continue
  92
  93             attr = getattr(module, sattr)
  94
  95             # netanim.Config and lte.Config singleton overrides ns3::Config
  96             if sattr == "Config" and modname in ['netanim', 'lte']:
  97                 sattr = "%s.%s" % (modname, sattr)
  98
  99             setattr(ns3mod, sattr, attr)
 100
 101     return ns3mod
 102
 103 class NS3Wrapper(object):
 104     def __init__(self, loglevel = logging.INFO, enable_dump = False):
 105         super(NS3Wrapper, self).__init__()
 106         # Thread used to run the simulation
 107         self._simulation_thread = None
 108         self._condition = None
 109
 110         # True if Simulator::Run was invoked
 111         self._started = False
 112
 113         # holds reference to all C++ objects and variables in the simulation
 114         self._objects = dict()
 115
 116         # Logging
 117         self._logger = logging.getLogger("ns3wrapper")
 118         self._logger.setLevel(loglevel)
 119
 120         ## NOTE that the reason to create a handler to the ns3 module,
 121         # that is re-loaded each time a ns-3 wrapper is instantiated,
 122         # is that else each unit test for the ns3wrapper class would need
 123         # a separate file. Several ns3wrappers would be created in the
 124         # same unit test (single process), leading to inchorences in the
 125         # state of ns-3 global objects
 126         #
 127         # Handler to ns3 classes
 128         self._ns3 = None
 129
 130         # Collection of allowed ns3 classes
 131         self._allowed_types = None
 132
 133         # Object to dump instructions to reproduce and debug experiment
 134         from ns3wrapper_debug import NS3WrapperDebuger
 135         self._debuger = NS3WrapperDebuger(enabled = enable_dump)
 136
 137     @property
 138     def debuger(self):
 139         return self._debuger
 140
 141     @property
 142     def ns3(self):
 143         if not self._ns3:
 144             # load ns-3 libraries and bindings
 145             self._ns3 = load_ns3_module()
 146
 147         return self._ns3
 148
 149     @property
 150     def allowed_types(self):
 151         if not self._allowed_types:
 152             self._allowed_types = set()
 153             type_id = self.ns3.TypeId()
 154
 155             tid_count = type_id.GetRegisteredN()
 156             base = type_id.LookupByName("ns3::Object")
 157
 158             for i in xrange(tid_count):
 159                 tid = type_id.GetRegistered(i)
 160
 161                 if tid.MustHideFromDocumentation() or \
 162                         not tid.HasConstructor() or \
 163                         not tid.IsChildOf(base):
 164                     continue
 165
 166                 type_name = tid.GetName()
 167                 self._allowed_types.add(type_name)
 168
 169         return self._allowed_types
 170
 171     @property
 172     def logger(self):
 173         return self._logger
 174
 175     @property
 176     def is_running(self):
 177         return self._started and not self.ns3.Simulator.IsFinished()
 178
 179     @property
 180     def is_finished(self):
 181         return self.ns3.Simulator.IsFinished()
 182
 183     def make_uuid(self):
 184         return "uuid%s" % uuid.uuid4()
 185
 186     def get_object(self, uuid):
 187         return self._objects.get(uuid)
 188
 189     def factory(self, type_name, **kwargs):
 190         """ This method should be used to construct ns-3 objects
 191         that have a TypeId and related introspection information """
 192
 193         if type_name not in self.allowed_types:
 194             msg = "Type %s not supported" % (type_name)
 195             self.logger.error(msg)
 196
 197         uuid = self.make_uuid()
 198
 199         ### DEBUG
 200         self.logger.debug("FACTORY %s( %s )" % (type_name, str(kwargs)))
 201
 202         self.debuger.dump_factory(uuid, type_name, kwargs)
 203         ########
 204
 205         factory = self.ns3.ObjectFactory()
 206         factory.SetTypeId(type_name)
 207
 208         for name, value in kwargs.iteritems():
 209             ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 210             factory.Set(name, ns3_value)
 211
 212         obj = factory.Create()
 213
 214         self._objects[uuid] = obj
 215
 216         ### DEBUG
 217         self.logger.debug("RET FACTORY ( uuid %s ) %s = %s( %s )" % (
 218             str(uuid), str(obj), type_name, str(kwargs)))
 219         ########
 220
 221         return uuid
 222
 223     def create(self, clazzname, *args):
 224         """ This method should be used to construct ns-3 objects that
 225         do not have a TypeId (e.g. Values) """
 226
 227         if not hasattr(self.ns3, clazzname):
 228             msg = "Type %s not supported" % (clazzname)
 229             self.logger.error(msg)
 230
 231         uuid = self.make_uuid()
 232
 233         ### DEBUG
 234         self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
 235
 236         self.debuger.dump_create(uuid, clazzname, args)
 237         ########
 238
 239         clazz = getattr(self.ns3, clazzname)
 240
 241         # arguments starting with 'uuid' identify ns-3 C++
 242         # objects and must be replaced by the actual object
 243         realargs = self.replace_args(args)
 244
 245         obj = clazz(*realargs)
 246
 247         self._objects[uuid] = obj
 248
 249         ### DEBUG
 250         self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
 251             str(obj), clazzname, str(args)))
 252         ########
 253
 254         return uuid
 255
 256     def invoke(self, uuid, operation, *args, **kwargs):
 257         ### DEBUG
 258         self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
 259             uuid, operation, str(args), str(kwargs)))
 260         ########
 261
 262         result = None
 263         newuuid = None
 264
 265         if operation == "isRunning":
 266             result = self.is_running
 267         elif operation == "isFinished":
 268             result = self.is_finished
 269         elif operation == "isAppRunning":
 270             result = self._is_app_running(uuid)
 271         elif operation == "addStaticRoute":
 272             ### DEBUG
 273             self.debuger.dump_add_static_route(uuid, args)
 274             ########
 275
 276             result = self._add_static_route(uuid, *args)
 277         else:
 278             newuuid = self.make_uuid()
 279
 280             ### DEBUG
 281             self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
 282             ########
 283
 284             if uuid.startswith(SINGLETON):
 285                 obj = self._singleton(uuid)
 286             else:
 287                 obj = self.get_object(uuid)
 288
 289             method = getattr(obj, operation)
 290
 291             # arguments starting with 'uuid' identify ns-3 C++
 292             # objects and must be replaced by the actual object
 293             realargs = self.replace_args(args)
 294             realkwargs = self.replace_kwargs(kwargs)
 295
 296             result = method(*realargs, **realkwargs)
 297
 298             # If the result is an object (not a base value),
 299             # then keep track of the object a return the object
 300             # reference (newuuid)
 301             if not (result is None or type(result) in [
 302                     bool, float, long, str, int]):
 303                 self._objects[newuuid] = result
 304                 result = newuuid
 305
 306         ### DEBUG
 307         self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
 308             "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
 309             operation, str(args), str(kwargs)))
 310         ########
 311
 312         return result
 313
 314     def _set_attr(self, obj, name, ns3_value):
 315         obj.SetAttribute(name, ns3_value)
 316
 317     def set(self, uuid, name, value):
 318         ### DEBUG
 319         self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
 320
 321         self.debuger.dump_set(uuid, name, value)
 322         ########
 323
 324         obj = self.get_object(uuid)
 325         type_name = obj.GetInstanceTypeId().GetName()
 326         ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 327
 328         # If the Simulation thread is not running,
 329         # then there will be no thread-safety problems
 330         # in changing the value of an attribute directly.
 331         # However, if the simulation is running we need
 332         # to set the value by scheduling an event, else
 333         # we risk to corrupt the state of the
 334         # simulation.
 335
 336         event_executed = [False]
 337
 338         if self.is_running:
 339             # schedule the event in the Simulator
 340             self._schedule_event(self._condition, event_executed,
 341                     self._set_attr, obj, name, ns3_value)
 342
 343         if not event_executed[0]:
 344             self._set_attr(obj, name, ns3_value)
 345
 346         ### DEBUG
 347         self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
 348             str(value)))
 349         ########
 350
 351         return value
 352
 353     def _get_attr(self, obj, name, ns3_value):
 354         obj.GetAttribute(name, ns3_value)
 355
 356     def get(self, uuid, name):
 357         ### DEBUG
 358         self.logger.debug("GET %s %s" % (uuid, name))
 359
 360         self.debuger.dump_get(uuid, name)
 361         ########
 362
 363         obj = self.get_object(uuid)
 364         type_name = obj.GetInstanceTypeId().GetName()
 365         ns3_value = self._create_attr_ns3_value(type_name, name)
 366
 367         event_executed = [False]
 368
 369         if self.is_running:
 370             # schedule the event in the Simulator
 371             self._schedule_event(self._condition, event_executed,
 372                     self._get_attr, obj, name, ns3_value)
 373
 374         if not event_executed[0]:
 375             self._get_attr(obj, name, ns3_value)
 376
 377         result = self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
 378
 379         ### DEBUG
 380         self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
 381         ########
 382
 383         return result
 384
 385     def start(self):
 386         ### DEBUG
 387         self.debuger.dump_start()
 388         ########
 389
 390         # Launch the simulator thread and Start the
 391         # simulator in that thread
 392         self._condition = threading.Condition()
 393         self._simulator_thread = threading.Thread(
 394                 target = self._simulator_run,
 395                 args = [self._condition])
 396         self._simulator_thread.setDaemon(True)
 397         self._simulator_thread.start()
 398         self._started = True
 399
 400         ### DEBUG
 401         self.logger.debug("START")
 402         ########
 403
 404     def stop(self, time = None):
 405         ### DEBUG
 406         self.debuger.dump_stop(time=time)
 407         ########
 408
 409         if time is None:
 410             self.ns3.Simulator.Stop()
 411         else:
 412             self.ns3.Simulator.Stop(self.ns3.Time(time))
 413
 414         ### DEBUG
 415         self.logger.debug("STOP time=%s" % str(time))
 416         ########
 417
 418     def shutdown(self):
 419         ### DEBUG
 420         self.debuger.dump_shutdown()
 421         ########
 422
 423         while not self.ns3.Simulator.IsFinished():
 424             #self.logger.debug("Waiting for simulation to finish")
 425             time.sleep(0.5)
 426
 427         if self._simulator_thread:
 428             self._simulator_thread.join()
 429
 430         self.ns3.Simulator.Destroy()
 431
 432         # Remove all references to ns-3 objects
 433         self._objects.clear()
 434
 435         sys.stdout.flush()
 436         sys.stderr.flush()
 437
 438         ### DEBUG
 439         self.logger.debug("SHUTDOWN")
 440         ########
 441
 442     def _simulator_run(self, condition):
 443         # Run simulation
 444         self.ns3.Simulator.Run()
 445         # Signal condition to indicate simulation ended and
 446         # notify waiting threads
 447         condition.acquire()
 448         condition.notifyAll()
 449         condition.release()
 450
 451     def _schedule_event(self, condition, event_executed, func, *args):
 452         """ Schedules event on running simulation, and wait until
 453             event is executed"""
 454
 455         def execute_event(contextId, condition, event_executed, func, *args):
 456             try:
 457                 func(*args)
 458                 event_executed[0] = True
 459             finally:
 460                 # notify condition indicating event was executed
 461                 condition.acquire()
 462                 condition.notifyAll()
 463                 condition.release()
 464
 465         # contextId is defined as general context
 466         contextId = long(0xffffffff)
 467
 468         # delay 0 means that the event is expected to execute inmediately
 469         delay = self.ns3.Seconds(0)
 470
 471         # Mark event as not executed
 472         event_executed[0] = False
 473
 474         condition.acquire()
 475         try:
 476             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
 477                     condition, event_executed, func, *args)
 478             if not self.ns3.Simulator.IsFinished():
 479                 condition.wait()
 480         finally:
 481             condition.release()
 482
 483     def _create_attr_ns3_value(self, type_name, name):
 484         TypeId = self.ns3.TypeId()
 485         tid = TypeId.LookupByName(type_name)
 486         info = TypeId.AttributeInformation()
 487         if not tid.LookupAttributeByName(name, info):
 488             msg = "TypeId %s has no attribute %s" % (type_name, name)
 489             self.logger.error(msg)
 490
 491         checker = info.checker
 492         ns3_value = checker.Create()
 493         return ns3_value
 494
 495     def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
 496         TypeId = self.ns3.TypeId()
 497         tid = TypeId.LookupByName(type_name)
 498         info = TypeId.AttributeInformation()
 499         if not tid.LookupAttributeByName(name, info):
 500             msg = "TypeId %s has no attribute %s" % (type_name, name)
 501             self.logger.error(msg)
 502
 503         checker = info.checker
 504         value = ns3_value.SerializeToString(checker)
 505
 506         type_name = checker.GetValueTypeName()
 507         if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
 508             return int(value)
 509         if type_name == "ns3::DoubleValue":
 510             return float(value)
 511         if type_name == "ns3::BooleanValue":
 512             return value == "true"
 513
 514         return value
 515
 516     def _attr_from_string_to_ns3_value(self, type_name, name, value):
 517         TypeId = self.ns3.TypeId()
 518         tid = TypeId.LookupByName(type_name)
 519         info = TypeId.AttributeInformation()
 520         if not tid.LookupAttributeByName(name, info):
 521             msg = "TypeId %s has no attribute %s" % (type_name, name)
 522             self.logger.error(msg)
 523
 524         str_value = str(value)
 525         if isinstance(value, bool):
 526             str_value = str_value.lower()
 527
 528         checker = info.checker
 529         ns3_value = checker.Create()
 530         ns3_value.DeserializeFromString(str_value, checker)
 531         return ns3_value
 532
 533     # singletons are identified as "ns3::ClassName"
 534     def _singleton(self, ident):
 535         if not ident.startswith(SINGLETON):
 536             return None
 537
 538         clazzname = ident[ident.find("::")+2:]
 539         if not hasattr(self.ns3, clazzname):
 540             msg = "Type %s not supported" % (clazzname)
 541             self.logger.error(msg)
 542
 543         return getattr(self.ns3, clazzname)
 544
 545     # replace uuids and singleton references for the real objects
 546     def replace_args(self, args):
 547         realargs = [self.get_object(arg) if \
 548                 str(arg).startswith("uuid") else arg for arg in args]
 549
 550         realargs = [self._singleton(arg) if \
 551                 str(arg).startswith(SINGLETON) else arg for arg in realargs]
 552
 553         return realargs
 554
 555     # replace uuids and singleton references for the real objects
 556     def replace_kwargs(self, kwargs):
 557         realkwargs = dict([(k, self.get_object(v) \
 558                 if str(v).startswith("uuid") else v) \
 559                 for k,v in kwargs.iteritems()])
 560
 561         realkwargs = dict([(k, self._singleton(v) \
 562                 if str(v).startswith(SINGLETON) else v )\
 563                 for k, v in realkwargs.iteritems()])
 564
 565         return realkwargs
 566
 567     def _is_app_running(self, uuid):
 568         now = self.ns3.Simulator.Now()
 569         if now.IsZero():
 570             return False
 571
 572         app = self.get_object(uuid)
 573         stop_time_value = self.ns3.TimeValue()
 574         app.GetAttribute("StopTime", stop_time_value)
 575         stop_time = stop_time_value.Get()
 576
 577         start_time_value = self.ns3.TimeValue()
 578         app.GetAttribute("StartTime", start_time_value)
 579         start_time = start_time_value.Get()
 580
 581         if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
 582             return True
 583
 584         return False
 585
 586     def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
 587         ipv4 = self.get_object(ipv4_uuid)
 588
 589         list_routing = ipv4.GetRoutingProtocol()
 590         (static_routing, priority) = list_routing.GetRoutingProtocol(0)
 591
 592         ifindex = self._find_ifindex(ipv4, nexthop)
 593         if ifindex == -1:
 594             return False
 595
 596         nexthop = self.ns3.Ipv4Address(nexthop)
 597
 598         if network in ["0.0.0.0", "0", None]:
 599             # Default route: 0.0.0.0/0
 600             static_routing.SetDefaultRoute(nexthop, ifindex)
 601         else:
 602             mask = self.ns3.Ipv4Mask("/%s" % prefix)
 603             network = self.ns3.Ipv4Address(network)
 604
 605             if prefix == 32:
 606                 # Host route: x.y.z.w/32
 607                 static_routing.AddHostRouteTo(network, nexthop, ifindex)
 608             else:
 609                 # Network route: x.y.z.w/n
 610                 static_routing.AddNetworkRouteTo(network, mask, nexthop,
 611                         ifindex)
 612         return True
 613
 614     def _find_ifindex(self, ipv4, nexthop):
 615         ifindex = -1
 616
 617         nexthop = self.ns3.Ipv4Address(nexthop)
 618
 619         # For all the interfaces registered with the ipv4 object, find
 620         # the one that matches the network of the nexthop
 621         nifaces = ipv4.GetNInterfaces()
 622         for ifidx in xrange(nifaces):
 623             iface = ipv4.GetInterface(ifidx)
 624             naddress = iface.GetNAddresses()
 625             for addridx in xrange(naddress):
 626                 ifaddr = iface.GetAddress(addridx)
 627                 ifmask = ifaddr.GetMask()
 628
 629                 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
 630
 631                 if ifindex == ifidx:
 632                     return ifindex
 633         return ifindex
 634