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 version 2 as
7 # published by the Free Software Foundation;
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
26 SINGLETON = "singleton::"
27 SIMULATOR_UUID = "singleton::Simulator"
28 CONFIG_UUID = "singleton::Config"
29 GLOBAL_VALUE_UUID = "singleton::GlobalValue"
30 IPV4_GLOBAL_ROUTING_HELPER_UUID = "singleton::Ipv4GlobalRoutingHelper"
32 def load_ns3_libraries():
36 libdir = os.environ.get("NS3LIBRARIES")
38 # Load the ns-3 modules shared libraries
40 files = os.listdir(libdir)
41 regex = re.compile("(.*\.so)$")
42 libs = [m.group(1) for filename in files for m in [regex.search(filename)] if m]
44 initial_size = len(libs)
45 # Try to load the libraries in the right order by trial and error.
46 # Loop until all libraries are loaded.
49 libfile = os.path.join(libdir, lib)
51 ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
55 #err = traceback.format_exc()
59 # if did not load any libraries in the last iteration break
60 # to prevent infinit loop
61 if initial_size == len(libs):
62 raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
63 initial_size = len(libs)
65 def load_ns3_module():
68 # import the python bindings for the ns-3 modules
69 bindings = os.environ.get("NS3BINDINGS")
71 sys.path.append(bindings)
77 # create a Python module to add all ns3 classes
78 ns3mod = imp.new_module("ns3")
79 sys.modules["ns3"] = ns3mod
81 for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
82 if modname in [ "visualizer" ]:
85 fullmodname = "ns.%s" % modname
86 module = __import__(fullmodname, globals(), locals(), ['*'])
88 for sattr in dir(module):
89 if sattr.startswith("_"):
92 attr = getattr(module, sattr)
94 # netanim.Config and lte.Config singleton overrides ns3::Config
95 if sattr == "Config" and modname in ['netanim', 'lte']:
96 sattr = "%s.%s" % (modname, sattr)
98 setattr(ns3mod, sattr, attr)
102 class NS3Wrapper(object):
103 def __init__(self, loglevel = logging.INFO, enable_dump = False):
104 super(NS3Wrapper, self).__init__()
105 # Thread used to run the simulation
106 self._simulation_thread = None
107 self._condition = None
109 # True if Simulator::Run was invoked
110 self._started = False
112 # holds reference to all C++ objects and variables in the simulation
113 self._objects = dict()
116 self._logger = logging.getLogger("ns3wrapper")
117 self._logger.setLevel(loglevel)
119 ## NOTE that the reason to create a handler to the ns3 module,
120 # that is re-loaded each time a ns-3 wrapper is instantiated,
121 # is that else each unit test for the ns3wrapper class would need
122 # a separate file. Several ns3wrappers would be created in the
123 # same unit test (single process), leading to inchorences in the
124 # state of ns-3 global objects
126 # Handler to ns3 classes
129 # Collection of allowed ns3 classes
130 self._allowed_types = None
132 # Object to dump instructions to reproduce and debug experiment
133 from ns3wrapper_debug import NS3WrapperDebuger
134 self._debuger = NS3WrapperDebuger(enabled = enable_dump)
143 # load ns-3 libraries and bindings
144 self._ns3 = load_ns3_module()
149 def allowed_types(self):
150 if not self._allowed_types:
151 self._allowed_types = set()
152 type_id = self.ns3.TypeId()
154 tid_count = type_id.GetRegisteredN()
155 base = type_id.LookupByName("ns3::Object")
157 for i in range(tid_count):
158 tid = type_id.GetRegistered(i)
160 if tid.MustHideFromDocumentation() or \
161 not tid.HasConstructor() or \
162 not tid.IsChildOf(base):
165 type_name = tid.GetName()
166 self._allowed_types.add(type_name)
168 return self._allowed_types
175 def is_running(self):
176 return self.is_started and not self.ns3.Simulator.IsFinished()
179 def is_started(self):
180 if not self._started:
181 now = self.ns3.Simulator.Now()
188 def is_finished(self):
189 return self.ns3.Simulator.IsFinished()
192 return "uuid%s" % uuid.uuid4()
194 def get_object(self, uuid):
195 return self._objects.get(uuid)
197 def factory(self, type_name, **kwargs):
198 """ This method should be used to construct ns-3 objects
199 that have a TypeId and related introspection information """
201 if type_name not in self.allowed_types:
202 msg = "Type %s not supported" % (type_name)
203 self.logger.error(msg)
205 uuid = self.make_uuid()
208 self.logger.debug("FACTORY %s( %s )" % (type_name, str(kwargs)))
211 self.debuger.dump_factory(uuid, type_name, kwargs)
213 factory = self.ns3.ObjectFactory()
214 factory.SetTypeId(type_name)
216 for name, value in kwargs.items():
217 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
218 factory.Set(name, ns3_value)
220 obj = factory.Create()
222 self._objects[uuid] = obj
225 self.logger.debug("RET FACTORY ( uuid %s ) %s = %s( %s )" % (
226 str(uuid), str(obj), type_name, str(kwargs)))
230 def create(self, clazzname, *args):
231 """ This method should be used to construct ns-3 objects that
232 do not have a TypeId (e.g. Values) """
234 if not hasattr(self.ns3, clazzname):
235 msg = "Type %s not supported" % (clazzname)
236 self.logger.error(msg)
238 uuid = self.make_uuid()
241 self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
244 self.debuger.dump_create(uuid, clazzname, args)
246 clazz = getattr(self.ns3, clazzname)
248 # arguments starting with 'uuid' identify ns-3 C++
249 # objects and must be replaced by the actual object
250 realargs = self.replace_args(args)
252 obj = clazz(*realargs)
254 self._objects[uuid] = obj
257 self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
258 str(obj), clazzname, str(args)))
262 def invoke(self, uuid, operation, *args, **kwargs):
264 self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
265 uuid, operation, str(args), str(kwargs)))
271 if operation == "isRunning":
272 result = self.is_running
274 elif operation == "isStarted":
275 result = self.is_started
277 elif operation == "isFinished":
278 result = self.is_finished
280 elif operation == "isAppRunning":
281 result = self._is_app_running(uuid)
283 elif operation == "isAppStarted":
284 result = self._is_app_started(uuid)
286 elif operation == "recvFD":
287 ### passFD operation binds to a different random socket
288 ### en every execution, so the socket name that could be
289 ### dumped to the debug script using dump_invoke is
290 ### not be valid accross debug executions.
291 result = self._recv_fd(uuid, *args, **kwargs)
293 elif operation == "addStaticRoute":
294 result = self._add_static_route(uuid, *args)
296 ### DUMP - result is static, so will be dumped as plain text
297 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
299 elif operation == "retrieveObject":
300 result = self._retrieve_object(uuid, *args, **kwargs)
302 ### DUMP - result is static, so will be dumped as plain text
303 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
306 newuuid = self.make_uuid()
308 ### DUMP - result is a uuid that encoded an dynamically generated
310 self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
312 if uuid.startswith(SINGLETON):
313 obj = self._singleton(uuid)
315 obj = self.get_object(uuid)
317 method = getattr(obj, operation)
319 # arguments starting with 'uuid' identify ns-3 C++
320 # objects and must be replaced by the actual object
321 realargs = self.replace_args(args)
322 realkwargs = self.replace_kwargs(kwargs)
324 result = method(*realargs, **realkwargs)
326 # If the result is an object (not a base value),
327 # then keep track of the object a return the object
328 # reference (newuuid)
329 if not (result is None or type(result) in [
330 bool, float, long, str, int]):
331 self._objects[newuuid] = result
335 self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
336 "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
337 operation, str(args), str(kwargs)))
342 def _set_attr(self, obj, name, ns3_value):
343 obj.SetAttribute(name, ns3_value)
345 def set(self, uuid, name, value):
347 self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
350 self.debuger.dump_set(uuid, name, value)
352 obj = self.get_object(uuid)
353 type_name = obj.GetInstanceTypeId().GetName()
354 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
356 # If the Simulation thread is not running,
357 # then there will be no thread-safety problems
358 # in changing the value of an attribute directly.
359 # However, if the simulation is running we need
360 # to set the value by scheduling an event, else
361 # we risk to corrupt the state of the
364 event_executed = [False]
367 # schedule the event in the Simulator
368 self._schedule_event(self._condition, event_executed,
369 self._set_attr, obj, name, ns3_value)
371 if not event_executed[0]:
372 self._set_attr(obj, name, ns3_value)
375 self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
380 def _get_attr(self, obj, name, ns3_value):
381 obj.GetAttribute(name, ns3_value)
383 def get(self, uuid, name):
385 self.logger.debug("GET %s %s" % (uuid, name))
388 self.debuger.dump_get(uuid, name)
390 obj = self.get_object(uuid)
391 type_name = obj.GetInstanceTypeId().GetName()
392 ns3_value = self._create_attr_ns3_value(type_name, name)
394 event_executed = [False]
397 # schedule the event in the Simulator
398 self._schedule_event(self._condition, event_executed,
399 self._get_attr, obj, name, ns3_value)
401 if not event_executed[0]:
402 self._get_attr(obj, name, ns3_value)
404 result = self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
407 self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
413 self.debuger.dump_start()
415 # Launch the simulator thread and Start the
416 # simulator in that thread
417 self._condition = threading.Condition()
418 self._simulator_thread = threading.Thread(
419 target = self._simulator_run,
420 args = [self._condition])
421 self._simulator_thread.setDaemon(True)
422 self._simulator_thread.start()
425 self.logger.debug("START")
427 def stop(self, time = None):
429 self.debuger.dump_stop(time=time)
432 self.ns3.Simulator.Stop()
434 self.ns3.Simulator.Stop(self.ns3.Time(time))
437 self.logger.debug("STOP time=%s" % str(time))
441 self.debuger.dump_shutdown()
443 while not self.ns3.Simulator.IsFinished():
444 #self.logger.debug("Waiting for simulation to finish")
447 if self._simulator_thread:
448 self._simulator_thread.join()
450 self.ns3.Simulator.Destroy()
452 # Remove all references to ns-3 objects
453 self._objects.clear()
459 self.logger.debug("SHUTDOWN")
461 def _simulator_run(self, condition):
463 self.ns3.Simulator.Run()
464 # Signal condition to indicate simulation ended and
465 # notify waiting threads
467 condition.notifyAll()
470 def _schedule_event(self, condition, event_executed, func, *args):
471 """ Schedules event on running simulation, and wait until
474 def execute_event(contextId, condition, event_executed, func, *args):
477 event_executed[0] = True
479 # notify condition indicating event was executed
481 condition.notifyAll()
484 # contextId is defined as general context
485 contextId = long(0xffffffff)
487 # delay 0 means that the event is expected to execute inmediately
488 delay = self.ns3.Seconds(0)
490 # Mark event as not executed
491 event_executed[0] = False
495 self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
496 condition, event_executed, func, *args)
497 if not self.ns3.Simulator.IsFinished():
502 def _create_attr_ns3_value(self, type_name, name):
503 TypeId = self.ns3.TypeId()
504 tid = TypeId.LookupByName(type_name)
505 info = TypeId.AttributeInformation()
506 if not tid.LookupAttributeByName(name, info):
507 msg = "TypeId %s has no attribute %s" % (type_name, name)
508 self.logger.error(msg)
510 checker = info.checker
511 ns3_value = checker.Create()
514 def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
515 TypeId = self.ns3.TypeId()
516 tid = TypeId.LookupByName(type_name)
517 info = TypeId.AttributeInformation()
518 if not tid.LookupAttributeByName(name, info):
519 msg = "TypeId %s has no attribute %s" % (type_name, name)
520 self.logger.error(msg)
522 checker = info.checker
523 value = ns3_value.SerializeToString(checker)
525 type_name = checker.GetValueTypeName()
526 if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
528 if type_name == "ns3::DoubleValue":
530 if type_name == "ns3::BooleanValue":
531 return value == "true"
535 def _attr_from_string_to_ns3_value(self, type_name, name, value):
536 TypeId = self.ns3.TypeId()
537 tid = TypeId.LookupByName(type_name)
538 info = TypeId.AttributeInformation()
539 if not tid.LookupAttributeByName(name, info):
540 msg = "TypeId %s has no attribute %s" % (type_name, name)
541 self.logger.error(msg)
543 str_value = str(value)
544 if isinstance(value, bool):
545 str_value = str_value.lower()
547 checker = info.checker
548 ns3_value = checker.Create()
549 ns3_value.DeserializeFromString(str_value, checker)
552 # singletons are identified as "ns3::ClassName"
553 def _singleton(self, ident):
554 if not ident.startswith(SINGLETON):
557 clazzname = ident[ident.find("::")+2:]
558 if not hasattr(self.ns3, clazzname):
559 msg = "Type %s not supported" % (clazzname)
560 self.logger.error(msg)
562 return getattr(self.ns3, clazzname)
564 # replace uuids and singleton references for the real objects
565 def replace_args(self, args):
566 realargs = [self.get_object(arg) if \
567 str(arg).startswith("uuid") else arg for arg in args]
569 realargs = [self._singleton(arg) if \
570 str(arg).startswith(SINGLETON) else arg for arg in realargs]
574 # replace uuids and singleton references for the real objects
575 def replace_kwargs(self, kwargs):
576 realkwargs = dict([(k, self.get_object(v) \
577 if str(v).startswith("uuid") else v) \
578 for k,v in kwargs.items()])
580 realkwargs = dict([(k, self._singleton(v) \
581 if str(v).startswith(SINGLETON) else v )\
582 for k, v in realkwargs.items()])
586 def _is_app_running(self, uuid):
587 now = self.ns3.Simulator.Now()
591 if self.ns3.Simulator.IsFinished():
594 app = self.get_object(uuid)
595 stop_time_value = self.ns3.TimeValue()
596 app.GetAttribute("StopTime", stop_time_value)
597 stop_time = stop_time_value.Get()
599 start_time_value = self.ns3.TimeValue()
600 app.GetAttribute("StartTime", start_time_value)
601 start_time = start_time_value.Get()
603 if now.Compare(start_time) >= 0:
604 if stop_time.IsZero() or now.Compare(stop_time) < 0:
609 def _is_app_started(self, uuid):
610 return self._is_app_running(uuid) or self.is_finished
612 def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
613 ipv4 = self.get_object(ipv4_uuid)
615 list_routing = ipv4.GetRoutingProtocol()
616 (static_routing, priority) = list_routing.GetRoutingProtocol(0)
618 ifindex = self._find_ifindex(ipv4, nexthop)
622 nexthop = self.ns3.Ipv4Address(nexthop)
624 if network in ["0.0.0.0", "0", None]:
625 # Default route: 0.0.0.0/0
626 static_routing.SetDefaultRoute(nexthop, ifindex)
628 mask = self.ns3.Ipv4Mask("/%s" % prefix)
629 network = self.ns3.Ipv4Address(network)
632 # Host route: x.y.z.w/32
633 static_routing.AddHostRouteTo(network, nexthop, ifindex)
635 # Network route: x.y.z.w/n
636 static_routing.AddNetworkRouteTo(network, mask, nexthop,
640 def _find_ifindex(self, ipv4, nexthop):
643 nexthop = self.ns3.Ipv4Address(nexthop)
645 # For all the interfaces registered with the ipv4 object, find
646 # the one that matches the network of the nexthop
647 nifaces = ipv4.GetNInterfaces()
648 for ifidx in range(nifaces):
649 iface = ipv4.GetInterface(ifidx)
650 naddress = iface.GetNAddresses()
651 for addridx in range(naddress):
652 ifaddr = iface.GetAddress(addridx)
653 ifmask = ifaddr.GetMask()
655 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
661 def _retrieve_object(self, uuid, typeid, search = False):
662 obj = self.get_object(uuid)
664 type_id = self.ns3.TypeId()
665 tid = type_id.LookupByName(typeid)
666 nobj = obj.GetObject(tid)
671 for ouuid, oobj in self._objects.items():
676 newuuid = self.make_uuid()
677 self._objects[newuuid] = nobj
681 def _recv_fd(self, uuid):
682 """ Waits on a local address to receive a file descriptor
683 from a local process. The file descriptor is associated
684 to a FdNetDevice to stablish communication between the
685 simulation and what ever process writes on that file descriptor
688 def recvfd(sock, fdnd):
689 (fd, msg) = passfd.recvfd(sock)
690 # Store a reference to the endpoint to keep the socket alive
691 fdnd.SetFileDescriptor(fd)
695 sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
697 address = sock.getsockname()
699 fdnd = self.get_object(uuid)
700 t = threading.Thread(target=recvfd, args=(sock,fdnd))