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         ### DUMP
 203         self.debuger.dump_factory(uuid, type_name, kwargs)
 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         return uuid
 221
 222     def create(self, clazzname, *args):
 223         """ This method should be used to construct ns-3 objects that
 224         do not have a TypeId (e.g. Values) """
 225
 226         if not hasattr(self.ns3, clazzname):
 227             msg = "Type %s not supported" % (clazzname)
 228             self.logger.error(msg)
 229
 230         uuid = self.make_uuid()
 231
 232         ### DEBUG
 233         self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
 234
 235         ### DUMP
 236         self.debuger.dump_create(uuid, clazzname, args)
 237
 238         clazz = getattr(self.ns3, clazzname)
 239
 240         # arguments starting with 'uuid' identify ns-3 C++
 241         # objects and must be replaced by the actual object
 242         realargs = self.replace_args(args)
 243
 244         obj = clazz(*realargs)
 245
 246         self._objects[uuid] = obj
 247
 248         ### DEBUG
 249         self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
 250             str(obj), clazzname, str(args)))
 251
 252         return uuid
 253
 254     def invoke(self, uuid, operation, *args, **kwargs):
 255         ### DEBUG
 256         self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
 257             uuid, operation, str(args), str(kwargs)))
 258         ########
 259
 260         result = None
 261         newuuid = None
 262
 263         if operation == "isRunning":
 264             result = self.is_running
 265         elif operation == "isFinished":
 266             result = self.is_finished
 267         elif operation == "isAppRunning":
 268             result = self._is_app_running(uuid)
 269         else:
 270
 271             if operation == "addStaticRoute":
 272                 result = self._add_static_route(uuid, *args)
 273
 274                 ### DUMP
 275                 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
 276
 277             elif operation == "retrieveObject":
 278                 result = self._retrieve_object(uuid, *args, **kwargs)
 279
 280                 ### DUMP
 281                 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
 282
 283             else:
 284                 newuuid = self.make_uuid()
 285
 286                 ### DUMP
 287                 self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
 288
 289                 if uuid.startswith(SINGLETON):
 290                     obj = self._singleton(uuid)
 291                 else:
 292                     obj = self.get_object(uuid)
 293
 294                 method = getattr(obj, operation)
 295
 296                 # arguments starting with 'uuid' identify ns-3 C++
 297                 # objects and must be replaced by the actual object
 298                 realargs = self.replace_args(args)
 299                 realkwargs = self.replace_kwargs(kwargs)
 300
 301                 result = method(*realargs, **realkwargs)
 302
 303                 # If the result is an object (not a base value),
 304                 # then keep track of the object a return the object
 305                 # reference (newuuid)
 306                 if not (result is None or type(result) in [
 307                         bool, float, long, str, int]):
 308                     self._objects[newuuid] = result
 309                     result = newuuid
 310
 311         ### DEBUG
 312         self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
 313             "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
 314             operation, str(args), str(kwargs)))
 315         ########
 316
 317         return result
 318
 319     def _set_attr(self, obj, name, ns3_value):
 320         obj.SetAttribute(name, ns3_value)
 321
 322     def set(self, uuid, name, value):
 323         ### DEBUG
 324         self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
 325
 326         ### DUMP
 327         self.debuger.dump_set(uuid, name, value)
 328
 329         obj = self.get_object(uuid)
 330         type_name = obj.GetInstanceTypeId().GetName()
 331         ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 332
 333         # If the Simulation thread is not running,
 334         # then there will be no thread-safety problems
 335         # in changing the value of an attribute directly.
 336         # However, if the simulation is running we need
 337         # to set the value by scheduling an event, else
 338         # we risk to corrupt the state of the
 339         # simulation.
 340
 341         event_executed = [False]
 342
 343         if self.is_running:
 344             # schedule the event in the Simulator
 345             self._schedule_event(self._condition, event_executed,
 346                     self._set_attr, obj, name, ns3_value)
 347
 348         if not event_executed[0]:
 349             self._set_attr(obj, name, ns3_value)
 350
 351         ### DEBUG
 352         self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
 353             str(value)))
 354
 355         return value
 356
 357     def _get_attr(self, obj, name, ns3_value):
 358         obj.GetAttribute(name, ns3_value)
 359
 360     def get(self, uuid, name):
 361         ### DEBUG
 362         self.logger.debug("GET %s %s" % (uuid, name))
 363
 364         ### DUMP
 365         self.debuger.dump_get(uuid, name)
 366
 367         obj = self.get_object(uuid)
 368         type_name = obj.GetInstanceTypeId().GetName()
 369         ns3_value = self._create_attr_ns3_value(type_name, name)
 370
 371         event_executed = [False]
 372
 373         if self.is_running:
 374             # schedule the event in the Simulator
 375             self._schedule_event(self._condition, event_executed,
 376                     self._get_attr, obj, name, ns3_value)
 377
 378         if not event_executed[0]:
 379             self._get_attr(obj, name, ns3_value)
 380
 381         result = self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
 382
 383         ### DEBUG
 384         self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
 385
 386         return result
 387
 388     def start(self):
 389         ### DUMP
 390         self.debuger.dump_start()
 391
 392         # Launch the simulator thread and Start the
 393         # simulator in that thread
 394         self._condition = threading.Condition()
 395         self._simulator_thread = threading.Thread(
 396                 target = self._simulator_run,
 397                 args = [self._condition])
 398         self._simulator_thread.setDaemon(True)
 399         self._simulator_thread.start()
 400         self._started = True
 401
 402         ### DEBUG
 403         self.logger.debug("START")
 404
 405     def stop(self, time = None):
 406         ### DUMP
 407         self.debuger.dump_stop(time=time)
 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     def shutdown(self):
 418         ### DUMP
 419         self.debuger.dump_shutdown()
 420
 421         while not self.ns3.Simulator.IsFinished():
 422             #self.logger.debug("Waiting for simulation to finish")
 423             time.sleep(0.5)
 424
 425         if self._simulator_thread:
 426             self._simulator_thread.join()
 427
 428         self.ns3.Simulator.Destroy()
 429
 430         # Remove all references to ns-3 objects
 431         self._objects.clear()
 432
 433         sys.stdout.flush()
 434         sys.stderr.flush()
 435
 436         ### DEBUG
 437         self.logger.debug("SHUTDOWN")
 438
 439     def _simulator_run(self, condition):
 440         # Run simulation
 441         self.ns3.Simulator.Run()
 442         # Signal condition to indicate simulation ended and
 443         # notify waiting threads
 444         condition.acquire()
 445         condition.notifyAll()
 446         condition.release()
 447
 448     def _schedule_event(self, condition, event_executed, func, *args):
 449         """ Schedules event on running simulation, and wait until
 450             event is executed"""
 451
 452         def execute_event(contextId, condition, event_executed, func, *args):
 453             try:
 454                 func(*args)
 455                 event_executed[0] = True
 456             finally:
 457                 # notify condition indicating event was executed
 458                 condition.acquire()
 459                 condition.notifyAll()
 460                 condition.release()
 461
 462         # contextId is defined as general context
 463         contextId = long(0xffffffff)
 464
 465         # delay 0 means that the event is expected to execute inmediately
 466         delay = self.ns3.Seconds(0)
 467
 468         # Mark event as not executed
 469         event_executed[0] = False
 470
 471         condition.acquire()
 472         try:
 473             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
 474                     condition, event_executed, func, *args)
 475             if not self.ns3.Simulator.IsFinished():
 476                 condition.wait()
 477         finally:
 478             condition.release()
 479
 480     def _create_attr_ns3_value(self, type_name, name):
 481         TypeId = self.ns3.TypeId()
 482         tid = TypeId.LookupByName(type_name)
 483         info = TypeId.AttributeInformation()
 484         if not tid.LookupAttributeByName(name, info):
 485             msg = "TypeId %s has no attribute %s" % (type_name, name)
 486             self.logger.error(msg)
 487
 488         checker = info.checker
 489         ns3_value = checker.Create()
 490         return ns3_value
 491
 492     def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
 493         TypeId = self.ns3.TypeId()
 494         tid = TypeId.LookupByName(type_name)
 495         info = TypeId.AttributeInformation()
 496         if not tid.LookupAttributeByName(name, info):
 497             msg = "TypeId %s has no attribute %s" % (type_name, name)
 498             self.logger.error(msg)
 499
 500         checker = info.checker
 501         value = ns3_value.SerializeToString(checker)
 502
 503         type_name = checker.GetValueTypeName()
 504         if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
 505             return int(value)
 506         if type_name == "ns3::DoubleValue":
 507             return float(value)
 508         if type_name == "ns3::BooleanValue":
 509             return value == "true"
 510
 511         return value
 512
 513     def _attr_from_string_to_ns3_value(self, type_name, name, value):
 514         TypeId = self.ns3.TypeId()
 515         tid = TypeId.LookupByName(type_name)
 516         info = TypeId.AttributeInformation()
 517         if not tid.LookupAttributeByName(name, info):
 518             msg = "TypeId %s has no attribute %s" % (type_name, name)
 519             self.logger.error(msg)
 520
 521         str_value = str(value)
 522         if isinstance(value, bool):
 523             str_value = str_value.lower()
 524
 525         checker = info.checker
 526         ns3_value = checker.Create()
 527         ns3_value.DeserializeFromString(str_value, checker)
 528         return ns3_value
 529
 530     # singletons are identified as "ns3::ClassName"
 531     def _singleton(self, ident):
 532         if not ident.startswith(SINGLETON):
 533             return None
 534
 535         clazzname = ident[ident.find("::")+2:]
 536         if not hasattr(self.ns3, clazzname):
 537             msg = "Type %s not supported" % (clazzname)
 538             self.logger.error(msg)
 539
 540         return getattr(self.ns3, clazzname)
 541
 542     # replace uuids and singleton references for the real objects
 543     def replace_args(self, args):
 544         realargs = [self.get_object(arg) if \
 545                 str(arg).startswith("uuid") else arg for arg in args]
 546
 547         realargs = [self._singleton(arg) if \
 548                 str(arg).startswith(SINGLETON) else arg for arg in realargs]
 549
 550         return realargs
 551
 552     # replace uuids and singleton references for the real objects
 553     def replace_kwargs(self, kwargs):
 554         realkwargs = dict([(k, self.get_object(v) \
 555                 if str(v).startswith("uuid") else v) \
 556                 for k,v in kwargs.iteritems()])
 557
 558         realkwargs = dict([(k, self._singleton(v) \
 559                 if str(v).startswith(SINGLETON) else v )\
 560                 for k, v in realkwargs.iteritems()])
 561
 562         return realkwargs
 563
 564     def _is_app_running(self, uuid):
 565         now = self.ns3.Simulator.Now()
 566         if now.IsZero():
 567             return False
 568
 569         app = self.get_object(uuid)
 570         stop_time_value = self.ns3.TimeValue()
 571         app.GetAttribute("StopTime", stop_time_value)
 572         stop_time = stop_time_value.Get()
 573
 574         start_time_value = self.ns3.TimeValue()
 575         app.GetAttribute("StartTime", start_time_value)
 576         start_time = start_time_value.Get()
 577
 578         if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
 579             return True
 580
 581         return False
 582
 583     def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
 584         ipv4 = self.get_object(ipv4_uuid)
 585
 586         list_routing = ipv4.GetRoutingProtocol()
 587         (static_routing, priority) = list_routing.GetRoutingProtocol(0)
 588
 589         ifindex = self._find_ifindex(ipv4, nexthop)
 590         if ifindex == -1:
 591             return False
 592
 593         nexthop = self.ns3.Ipv4Address(nexthop)
 594
 595         if network in ["0.0.0.0", "0", None]:
 596             # Default route: 0.0.0.0/0
 597             static_routing.SetDefaultRoute(nexthop, ifindex)
 598         else:
 599             mask = self.ns3.Ipv4Mask("/%s" % prefix)
 600             network = self.ns3.Ipv4Address(network)
 601
 602             if prefix == 32:
 603                 # Host route: x.y.z.w/32
 604                 static_routing.AddHostRouteTo(network, nexthop, ifindex)
 605             else:
 606                 # Network route: x.y.z.w/n
 607                 static_routing.AddNetworkRouteTo(network, mask, nexthop,
 608                         ifindex)
 609         return True
 610
 611     def _find_ifindex(self, ipv4, nexthop):
 612         ifindex = -1
 613
 614         nexthop = self.ns3.Ipv4Address(nexthop)
 615
 616         # For all the interfaces registered with the ipv4 object, find
 617         # the one that matches the network of the nexthop
 618         nifaces = ipv4.GetNInterfaces()
 619         for ifidx in xrange(nifaces):
 620             iface = ipv4.GetInterface(ifidx)
 621             naddress = iface.GetNAddresses()
 622             for addridx in xrange(naddress):
 623                 ifaddr = iface.GetAddress(addridx)
 624                 ifmask = ifaddr.GetMask()
 625
 626                 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
 627
 628                 if ifindex == ifidx:
 629                     return ifindex
 630         return ifindex
 631
 632     def _retrieve_object(self, uuid, typeid, search = False):
 633         obj = self.get_object(uuid)
 634
 635         type_id = self.ns3.TypeId()
 636         tid = type_id.LookupByName(typeid)
 637         nobj = obj.GetObject(tid)
 638
 639         newuuid = None
 640         if search:
 641             # search object
 642             for ouuid, oobj in self._objects.iteritems():
 643                 if nobj == oobj:
 644                     newuuid = ouuid
 645                     break
 646         else:
 647             newuuid = self.make_uuid()
 648             self._objects[newuuid] = nobj
 649
 650         return newuuid
 651
 652
 653