2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
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.
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.
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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
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"
33 def load_ns3_libraries():
37 libdir = os.environ.get("NS3LIBRARIES")
39 # Load the ns-3 modules shared libraries
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]
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.
50 libfile = os.path.join(libdir, lib)
52 ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
56 #err = traceback.format_exc()
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)
66 def load_ns3_module():
69 # import the python bindings for the ns-3 modules
70 bindings = os.environ.get("NS3BINDINGS")
72 sys.path.append(bindings)
78 # create a Python module to add all ns3 classes
79 ns3mod = imp.new_module("ns3")
80 sys.modules["ns3"] = ns3mod
82 for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
83 if modname in [ "visualizer" ]:
86 fullmodname = "ns.%s" % modname
87 module = __import__(fullmodname, globals(), locals(), ['*'])
89 for sattr in dir(module):
90 if sattr.startswith("_"):
93 attr = getattr(module, sattr)
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)
99 setattr(ns3mod, sattr, attr)
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
110 # True if Simulator::Run was invoked
111 self._started = False
113 # holds reference to all C++ objects and variables in the simulation
114 self._objects = dict()
117 self._logger = logging.getLogger("ns3wrapper")
118 self._logger.setLevel(loglevel)
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
127 # Handler to ns3 classes
130 # Collection of allowed ns3 classes
131 self._allowed_types = None
133 # Object to dump instructions to reproduce and debug experiment
134 from ns3wrapper_debug import NS3WrapperDebuger
135 self._debuger = NS3WrapperDebuger(enabled = enable_dump)
144 # load ns-3 libraries and bindings
145 self._ns3 = load_ns3_module()
150 def allowed_types(self):
151 if not self._allowed_types:
152 self._allowed_types = set()
153 type_id = self.ns3.TypeId()
155 tid_count = type_id.GetRegisteredN()
156 base = type_id.LookupByName("ns3::Object")
158 for i in xrange(tid_count):
159 tid = type_id.GetRegistered(i)
161 if tid.MustHideFromDocumentation() or \
162 not tid.HasConstructor() or \
163 not tid.IsChildOf(base):
166 type_name = tid.GetName()
167 self._allowed_types.add(type_name)
169 return self._allowed_types
176 def is_running(self):
177 return self._started and not self.ns3.Simulator.IsFinished()
180 return "uuid%s" % uuid.uuid4()
182 def get_object(self, uuid):
183 return self._objects.get(uuid)
185 def factory(self, type_name, **kwargs):
186 """ This method should be used to construct ns-3 objects
187 that have a TypeId and related introspection information """
189 if type_name not in self.allowed_types:
190 msg = "Type %s not supported" % (type_name)
191 self.logger.error(msg)
193 uuid = self.make_uuid()
196 self.logger.debug("FACTORY %s( %s )" % (type_name, str(kwargs)))
198 self.debuger.dump_factory(uuid, type_name, kwargs)
201 factory = self.ns3.ObjectFactory()
202 factory.SetTypeId(type_name)
204 for name, value in kwargs.iteritems():
205 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
206 factory.Set(name, ns3_value)
208 obj = factory.Create()
210 self._objects[uuid] = obj
213 self.logger.debug("RET FACTORY ( uuid %s ) %s = %s( %s )" % (
214 str(uuid), str(obj), type_name, str(kwargs)))
219 def create(self, clazzname, *args):
220 """ This method should be used to construct ns-3 objects that
221 do not have a TypeId (e.g. Values) """
223 if not hasattr(self.ns3, clazzname):
224 msg = "Type %s not supported" % (clazzname)
225 self.logger.error(msg)
227 uuid = self.make_uuid()
230 self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
232 self.debuger.dump_create(uuid, clazzname, args)
235 clazz = getattr(self.ns3, clazzname)
237 # arguments starting with 'uuid' identify ns-3 C++
238 # objects and must be replaced by the actual object
239 realargs = self.replace_args(args)
241 obj = clazz(*realargs)
243 self._objects[uuid] = obj
246 self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
247 str(obj), clazzname, str(args)))
252 def invoke(self, uuid, operation, *args, **kwargs):
254 self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
255 uuid, operation, str(args), str(kwargs)))
261 if operation == "isRunning":
262 result = self.is_running
263 elif operation == "isAppRunning":
264 result = self._is_app_running(uuid)
265 elif operation == "addStaticRoute":
267 self.debuger.dump_add_static_route(uuid, args)
270 result = self._add_static_route(uuid, *args)
272 newuuid = self.make_uuid()
275 self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
278 if uuid.startswith(SINGLETON):
279 obj = self._singleton(uuid)
281 obj = self.get_object(uuid)
283 method = getattr(obj, operation)
285 # arguments starting with 'uuid' identify ns-3 C++
286 # objects and must be replaced by the actual object
287 realargs = self.replace_args(args)
288 realkwargs = self.replace_kwargs(kwargs)
290 result = method(*realargs, **realkwargs)
292 # If the result is an object (not a base value),
293 # then keep track of the object a return the object
294 # reference (newuuid)
295 if not (result is None or type(result) in [
296 bool, float, long, str, int]):
297 self._objects[newuuid] = result
301 self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
302 "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
303 operation, str(args), str(kwargs)))
308 def _set_attr(self, obj, name, ns3_value):
309 obj.SetAttribute(name, ns3_value)
311 def set(self, uuid, name, value):
313 self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
315 self.debuger.dump_set(uuid, name, value)
318 obj = self.get_object(uuid)
319 type_name = obj.GetInstanceTypeId().GetName()
320 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
322 # If the Simulation thread is not running,
323 # then there will be no thread-safety problems
324 # in changing the value of an attribute directly.
325 # However, if the simulation is running we need
326 # to set the value by scheduling an event, else
327 # we risk to corrupt the state of the
330 event_executed = [False]
333 # schedule the event in the Simulator
334 self._schedule_event(self._condition, event_executed,
335 self._set_attr, obj, name, ns3_value)
337 if not event_executed[0]:
338 self._set_attr(obj, name, ns3_value)
341 self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
347 def _get_attr(self, obj, name, ns3_value):
348 obj.GetAttribute(name, ns3_value)
350 def get(self, uuid, name):
352 self.logger.debug("GET %s %s" % (uuid, name))
354 self.debuger.dump_get(uuid, name)
357 obj = self.get_object(uuid)
358 type_name = obj.GetInstanceTypeId().GetName()
359 ns3_value = self._create_attr_ns3_value(type_name, name)
361 event_executed = [False]
364 # schedule the event in the Simulator
365 self._schedule_event(self._condition, event_executed,
366 self._get_attr, obj, name, ns3_value)
368 if not event_executed[0]:
369 self._get_attr(obj, name, ns3_value)
371 result = self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
374 self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
381 self.debuger.dump_start()
384 # Launch the simulator thread and Start the
385 # simulator in that thread
386 self._condition = threading.Condition()
387 self._simulator_thread = threading.Thread(
388 target = self._simulator_run,
389 args = [self._condition])
390 self._simulator_thread.setDaemon(True)
391 self._simulator_thread.start()
395 self.logger.debug("START")
398 def stop(self, time = None):
400 self.debuger.dump_stop(time=time)
404 self.ns3.Simulator.Stop()
406 self.ns3.Simulator.Stop(self.ns3.Time(time))
409 self.logger.debug("STOP time=%s" % str(time))
414 self.debuger.dump_shutdown()
417 while not self.ns3.Simulator.IsFinished():
418 #self.logger.debug("Waiting for simulation to finish")
421 if self._simulator_thread:
422 self._simulator_thread.join()
424 self.ns3.Simulator.Destroy()
426 # Remove all references to ns-3 objects
427 self._objects.clear()
433 self.logger.debug("SHUTDOWN")
436 def _simulator_run(self, condition):
438 self.ns3.Simulator.Run()
439 # Signal condition to indicate simulation ended and
440 # notify waiting threads
442 condition.notifyAll()
445 def _schedule_event(self, condition, event_executed, func, *args):
446 """ Schedules event on running simulation, and wait until
449 def execute_event(contextId, condition, event_executed, func, *args):
452 event_executed[0] = True
454 # notify condition indicating event was executed
456 condition.notifyAll()
459 # contextId is defined as general context
460 contextId = long(0xffffffff)
462 # delay 0 means that the event is expected to execute inmediately
463 delay = self.ns3.Seconds(0)
465 # Mark event as not executed
466 event_executed[0] = False
470 self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
471 condition, event_executed, func, *args)
472 if not self.ns3.Simulator.IsFinished():
477 def _create_attr_ns3_value(self, type_name, name):
478 TypeId = self.ns3.TypeId()
479 tid = TypeId.LookupByName(type_name)
480 info = TypeId.AttributeInformation()
481 if not tid.LookupAttributeByName(name, info):
482 msg = "TypeId %s has no attribute %s" % (type_name, name)
483 self.logger.error(msg)
485 checker = info.checker
486 ns3_value = checker.Create()
489 def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
490 TypeId = self.ns3.TypeId()
491 tid = TypeId.LookupByName(type_name)
492 info = TypeId.AttributeInformation()
493 if not tid.LookupAttributeByName(name, info):
494 msg = "TypeId %s has no attribute %s" % (type_name, name)
495 self.logger.error(msg)
497 checker = info.checker
498 value = ns3_value.SerializeToString(checker)
500 type_name = checker.GetValueTypeName()
501 if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
503 if type_name == "ns3::DoubleValue":
505 if type_name == "ns3::BooleanValue":
506 return value == "true"
510 def _attr_from_string_to_ns3_value(self, type_name, name, value):
511 TypeId = self.ns3.TypeId()
512 tid = TypeId.LookupByName(type_name)
513 info = TypeId.AttributeInformation()
514 if not tid.LookupAttributeByName(name, info):
515 msg = "TypeId %s has no attribute %s" % (type_name, name)
516 self.logger.error(msg)
518 str_value = str(value)
519 if isinstance(value, bool):
520 str_value = str_value.lower()
522 checker = info.checker
523 ns3_value = checker.Create()
524 ns3_value.DeserializeFromString(str_value, checker)
527 # singletons are identified as "ns3::ClassName"
528 def _singleton(self, ident):
529 if not ident.startswith(SINGLETON):
532 clazzname = ident[ident.find("::")+2:]
533 if not hasattr(self.ns3, clazzname):
534 msg = "Type %s not supported" % (clazzname)
535 self.logger.error(msg)
537 return getattr(self.ns3, clazzname)
539 # replace uuids and singleton references for the real objects
540 def replace_args(self, args):
541 realargs = [self.get_object(arg) if \
542 str(arg).startswith("uuid") else arg for arg in args]
544 realargs = [self._singleton(arg) if \
545 str(arg).startswith(SINGLETON) else arg for arg in realargs]
549 # replace uuids and singleton references for the real objects
550 def replace_kwargs(self, kwargs):
551 realkwargs = dict([(k, self.get_object(v) \
552 if str(v).startswith("uuid") else v) \
553 for k,v in kwargs.iteritems()])
555 realkwargs = dict([(k, self._singleton(v) \
556 if str(v).startswith(SINGLETON) else v )\
557 for k, v in realkwargs.iteritems()])
561 def _is_app_running(self, uuid):
562 now = self.ns3.Simulator.Now()
566 app = self.get_object(uuid)
567 stop_time_value = self.ns3.TimeValue()
568 app.GetAttribute("StopTime", stop_time_value)
569 stop_time = stop_time_value.Get()
571 start_time_value = self.ns3.TimeValue()
572 app.GetAttribute("StartTime", start_time_value)
573 start_time = start_time_value.Get()
575 if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
580 def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
581 ipv4 = self.get_object(ipv4_uuid)
583 list_routing = ipv4.GetRoutingProtocol()
584 (static_routing, priority) = list_routing.GetRoutingProtocol(0)
586 ifindex = self._find_ifindex(ipv4, nexthop)
590 nexthop = self.ns3.Ipv4Address(nexthop)
592 if network in ["0.0.0.0", "0", None]:
593 # Default route: 0.0.0.0/0
594 static_routing.SetDefaultRoute(nexthop, ifindex)
596 mask = self.ns3.Ipv4Mask("/%s" % prefix)
597 network = self.ns3.Ipv4Address(network)
600 # Host route: x.y.z.w/32
601 static_routing.AddHostRouteTo(network, nexthop, ifindex)
603 # Network route: x.y.z.w/n
604 static_routing.AddNetworkRouteTo(network, mask, nexthop,
608 def _find_ifindex(self, ipv4, nexthop):
611 nexthop = self.ns3.Ipv4Address(nexthop)
613 # For all the interfaces registered with the ipv4 object, find
614 # the one that matches the network of the nexthop
615 nifaces = ipv4.GetNInterfaces()
616 for ifidx in xrange(nifaces):
617 iface = ipv4.GetInterface(ifidx)
618 naddress = iface.GetNAddresses()
619 for addridx in xrange(naddress):
620 ifaddr = iface.GetAddress(addridx)
621 ifmask = ifaddr.GetMask()
623 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)