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):
 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     @property
 134     def ns3(self):
 135         if not self._ns3:
 136             # load ns-3 libraries and bindings
 137             self._ns3 = load_ns3_module()
 138
 139         return self._ns3
 140
 141     @property
 142     def allowed_types(self):
 143         if not self._allowed_types:
 144             self._allowed_types = set()
 145             type_id = self.ns3.TypeId()
 146
 147             tid_count = type_id.GetRegisteredN()
 148             base = type_id.LookupByName("ns3::Object")
 149
 150             for i in xrange(tid_count):
 151                 tid = type_id.GetRegistered(i)
 152
 153                 if tid.MustHideFromDocumentation() or \
 154                         not tid.HasConstructor() or \
 155                         not tid.IsChildOf(base):
 156                     continue
 157
 158                 type_name = tid.GetName()
 159                 self._allowed_types.add(type_name)
 160
 161         return self._allowed_types
 162
 163     @property
 164     def logger(self):
 165         return self._logger
 166
 167     @property
 168     def is_running(self):
 169         return self._started and self.ns3.Simulator.IsFinished()
 170
 171     def make_uuid(self):
 172         return "uuid%s" % uuid.uuid4()
 173
 174     def get_object(self, uuid):
 175         return self._objects.get(uuid)
 176
 177     def factory(self, type_name, **kwargs):
 178         if type_name not in self.allowed_types:
 179             msg = "Type %s not supported" % (type_name)
 180             self.logger.error(msg)
 181
 182         factory = self.ns3.ObjectFactory()
 183         factory.SetTypeId(type_name)
 184
 185         for name, value in kwargs.iteritems():
 186             ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 187             factory.Set(name, ns3_value)
 188
 189         obj = factory.Create()
 190
 191         uuid = self.make_uuid()
 192         self._objects[uuid] = obj
 193
 194         return uuid
 195
 196     def create(self, clazzname, *args):
 197         if not hasattr(self.ns3, clazzname):
 198             msg = "Type %s not supported" % (clazzname)
 199             self.logger.error(msg)
 200
 201         clazz = getattr(self.ns3, clazzname)
 202
 203         # arguments starting with 'uuid' identify ns-3 C++
 204         # objects and must be replaced by the actual object
 205         realargs = self.replace_args(args)
 206
 207         obj = clazz(*realargs)
 208
 209         uuid = self.make_uuid()
 210         self._objects[uuid] = obj
 211
 212         return uuid
 213
 214     def invoke(self, uuid, operation, *args, **kwargs):
 215         if operation == "isAppRunning":
 216             return self._is_app_running(uuid)
 217         if operation == "addStaticRoute":
 218             return self._add_static_route(uuid, *args)
 219
 220         if uuid.startswith(SINGLETON):
 221             obj = self._singleton(uuid)
 222         else:
 223             obj = self.get_object(uuid)
 224
 225         method = getattr(obj, operation)
 226
 227         # arguments starting with 'uuid' identify ns-3 C++
 228         # objects and must be replaced by the actual object
 229         realargs = self.replace_args(args)
 230         realkwargs = self.replace_kwargs(kwargs)
 231
 232         result = method(*realargs, **realkwargs)
 233
 234         # If the result is not an object, no need to
 235         # keep a reference. Directly return value.
 236         if result is None or type(result) in [bool, float, long, str, int]:
 237             return result
 238
 239         newuuid = self.make_uuid()
 240         self._objects[newuuid] = result
 241
 242         return newuuid
 243
 244     def _set_attr(self, obj, name, ns3_value):
 245         obj.SetAttribute(name, ns3_value)
 246
 247     def set(self, uuid, name, value):
 248         obj = self.get_object(uuid)
 249         type_name = obj.GetInstanceTypeId().GetName()
 250         ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
 251
 252         # If the Simulation thread is not running,
 253         # then there will be no thread-safety problems
 254         # in changing the value of an attribute directly.
 255         # However, if the simulation is running we need
 256         # to set the value by scheduling an event, else
 257         # we risk to corrupt the state of the
 258         # simulation.
 259
 260         event_executed = [False]
 261
 262         if self.is_running:
 263             # schedule the event in the Simulator
 264             self._schedule_event(self._condition, event_executed,
 265                     self._set_attr, obj, name, ns3_value)
 266
 267         if not event_executed[0]:
 268             self._set_attr(obj, name, ns3_value)
 269
 270         return value
 271
 272     def _get_attr(self, obj, name, ns3_value):
 273         obj.GetAttribute(name, ns3_value)
 274
 275     def get(self, uuid, name):
 276         obj = self.get_object(uuid)
 277         type_name = obj.GetInstanceTypeId().GetName()
 278         ns3_value = self._create_attr_ns3_value(type_name, name)
 279
 280         event_executed = [False]
 281
 282         if self.is_running:
 283             # schedule the event in the Simulator
 284             self._schedule_event(self._condition, event_executed,
 285                     self._get_attr, obj, name, ns3_value)
 286
 287         if not event_executed[0]:
 288             self._get_attr(obj, name, ns3_value)
 289
 290         return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
 291
 292     def start(self):
 293         # Launch the simulator thread and Start the
 294         # simulator in that thread
 295         self._condition = threading.Condition()
 296         self._simulator_thread = threading.Thread(
 297                 target = self._simulator_run,
 298                 args = [self._condition])
 299         self._simulator_thread.setDaemon(True)
 300         self._simulator_thread.start()
 301         self._started = True
 302
 303     def stop(self, time = None):
 304         if time is None:
 305             self.ns3.Simulator.Stop()
 306         else:
 307             self.ns3.Simulator.Stop(self.ns3.Time(time))
 308
 309     def shutdown(self):
 310         while not self.ns3.Simulator.IsFinished():
 311             #self.logger.debug("Waiting for simulation to finish")
 312             time.sleep(0.5)
 313
 314         if self._simulator_thread:
 315             self._simulator_thread.join()
 316
 317         self.ns3.Simulator.Destroy()
 318
 319         # Remove all references to ns-3 objects
 320         self._objects.clear()
 321
 322         sys.stdout.flush()
 323         sys.stderr.flush()
 324
 325     def _simulator_run(self, condition):
 326         # Run simulation
 327         self.ns3.Simulator.Run()
 328         # Signal condition to indicate simulation ended and
 329         # notify waiting threads
 330         condition.acquire()
 331         condition.notifyAll()
 332         condition.release()
 333
 334     def _schedule_event(self, condition, event_executed, func, *args):
 335         """ Schedules event on running simulation, and wait until
 336             event is executed"""
 337
 338         def execute_event(contextId, condition, event_executed, func, *args):
 339             try:
 340                 func(*args)
 341                 event_executed[0] = True
 342             finally:
 343                 # notify condition indicating event was executed
 344                 condition.acquire()
 345                 condition.notifyAll()
 346                 condition.release()
 347
 348         # contextId is defined as general context
 349         contextId = long(0xffffffff)
 350
 351         # delay 0 means that the event is expected to execute inmediately
 352         delay = self.ns3.Seconds(0)
 353
 354         # Mark event as not executed
 355         event_executed[0] = False
 356
 357         condition.acquire()
 358         try:
 359             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
 360                     condition, event_executed, func, *args)
 361             if not self.ns3.Simulator.IsFinished():
 362                 condition.wait()
 363         finally:
 364             condition.release()
 365
 366     def _create_attr_ns3_value(self, type_name, name):
 367         TypeId = self.ns3.TypeId()
 368         tid = TypeId.LookupByName(type_name)
 369         info = TypeId.AttributeInformation()
 370         if not tid.LookupAttributeByName(name, info):
 371             msg = "TypeId %s has no attribute %s" % (type_name, name)
 372             self.logger.error(msg)
 373
 374         checker = info.checker
 375         ns3_value = checker.Create()
 376         return ns3_value
 377
 378     def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
 379         TypeId = self.ns3.TypeId()
 380         tid = TypeId.LookupByName(type_name)
 381         info = TypeId.AttributeInformation()
 382         if not tid.LookupAttributeByName(name, info):
 383             msg = "TypeId %s has no attribute %s" % (type_name, name)
 384             self.logger.error(msg)
 385
 386         checker = info.checker
 387         value = ns3_value.SerializeToString(checker)
 388
 389         type_name = checker.GetValueTypeName()
 390         if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
 391             return int(value)
 392         if type_name == "ns3::DoubleValue":
 393             return float(value)
 394         if type_name == "ns3::BooleanValue":
 395             return value == "true"
 396
 397         return value
 398
 399     def _attr_from_string_to_ns3_value(self, type_name, name, value):
 400         TypeId = self.ns3.TypeId()
 401         tid = TypeId.LookupByName(type_name)
 402         info = TypeId.AttributeInformation()
 403         if not tid.LookupAttributeByName(name, info):
 404             msg = "TypeId %s has no attribute %s" % (type_name, name)
 405             self.logger.error(msg)
 406
 407         str_value = str(value)
 408         if isinstance(value, bool):
 409             str_value = str_value.lower()
 410
 411         checker = info.checker
 412         ns3_value = checker.Create()
 413         ns3_value.DeserializeFromString(str_value, checker)
 414         return ns3_value
 415
 416     # singletons are identified as "ns3::ClassName"
 417     def _singleton(self, ident):
 418         if not ident.startswith(SINGLETON):
 419             return None
 420
 421         clazzname = ident[ident.find("::")+2:]
 422         if not hasattr(self.ns3, clazzname):
 423             msg = "Type %s not supported" % (clazzname)
 424             self.logger.error(msg)
 425
 426         return getattr(self.ns3, clazzname)
 427
 428     # replace uuids and singleton references for the real objects
 429     def replace_args(self, args):
 430         realargs = [self.get_object(arg) if \
 431                 str(arg).startswith("uuid") else arg for arg in args]
 432
 433         realargs = [self._singleton(arg) if \
 434                 str(arg).startswith(SINGLETON) else arg for arg in realargs]
 435
 436         return realargs
 437
 438     # replace uuids and singleton references for the real objects
 439     def replace_kwargs(self, kwargs):
 440         realkwargs = dict([(k, self.get_object(v) \
 441                 if str(v).startswith("uuid") else v) \
 442                 for k,v in kwargs.iteritems()])
 443
 444         realkwargs = dict([(k, self._singleton(v) \
 445                 if str(v).startswith(SINGLETON) else v )\
 446                 for k, v in realkwargs.iteritems()])
 447
 448         return realkwargs
 449
 450     def _is_app_running(self, uuid):
 451         now = self.ns3.Simulator.Now()
 452         if now.IsZero():
 453             return False
 454
 455         app = self.get_object(uuid)
 456         stop_time_value = self.ns3.TimeValue()
 457         app.GetAttribute("StopTime", stop_time_value)
 458         stop_time = stop_time_value.Get()
 459
 460         start_time_value = self.ns3.TimeValue()
 461         app.GetAttribute("StartTime", start_time_value)
 462         start_time = start_time_value.Get()
 463
 464         if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
 465             return True
 466
 467         return False
 468
 469     def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
 470         ipv4 = self.get_object(ipv4_uuid)
 471
 472         list_routing = ipv4.GetRoutingProtocol()
 473         (static_routing, priority) = list_routing.GetRoutingProtocol(0)
 474
 475         ifindex = self._find_ifindex(ipv4, nexthop)
 476         if ifindex == -1:
 477             return False
 478
 479         nexthop = self.ns3.Ipv4Address(nexthop)
 480
 481         if network in ["0.0.0.0", "0", None]:
 482             # Default route: 0.0.0.0/0
 483             static_routing.SetDefaultRoute(nexthop, ifindex)
 484         else:
 485             mask = self.ns3.Ipv4Mask("/%s" % prefix)
 486             network = self.ns3.Ipv4Address(network)
 487
 488             if prefix == 32:
 489                 # Host route: x.y.z.w/32
 490                 static_routing.AddHostRouteTo(network, nexthop, ifindex)
 491             else:
 492                 # Network route: x.y.z.w/n
 493                 static_routing.AddNetworkRouteTo(network, mask, nexthop,
 494                         ifindex)
 495         return True
 496
 497     def _find_ifindex(self, ipv4, nexthop):
 498         ifindex = -1
 499
 500         nexthop = self.ns3.Ipv4Address(nexthop)
 501
 502         # For all the interfaces registered with the ipv4 object, find
 503         # the one that matches the network of the nexthop
 504         nifaces = ipv4.GetNInterfaces()
 505         for ifidx in xrange(nifaces):
 506             iface = ipv4.GetInterface(ifidx)
 507             naddress = iface.GetNAddresses()
 508             for addridx in xrange(naddress):
 509                 ifaddr = iface.GetAddress(addridx)
 510                 ifmask = ifaddr.GetMask()
 511
 512                 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
 513
 514                 if ifindex == ifidx:
 515                     return ifindex
 516         return ifindex
 517