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