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 def is_finished(self):
181 return self.ns3.Simulator.IsFinished()
184 return "uuid%s" % uuid.uuid4()
186 def get_object(self, uuid):
187 return self._objects.get(uuid)
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 """
193 if type_name not in self.allowed_types:
194 msg = "Type %s not supported" % (type_name)
195 self.logger.error(msg)
197 uuid = self.make_uuid()
200 self.logger.debug("FACTORY %s( %s )" % (type_name, str(kwargs)))
203 self.debuger.dump_factory(uuid, type_name, kwargs)
205 factory = self.ns3.ObjectFactory()
206 factory.SetTypeId(type_name)
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)
212 obj = factory.Create()
214 self._objects[uuid] = obj
217 self.logger.debug("RET FACTORY ( uuid %s ) %s = %s( %s )" % (
218 str(uuid), str(obj), type_name, str(kwargs)))
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) """
226 if not hasattr(self.ns3, clazzname):
227 msg = "Type %s not supported" % (clazzname)
228 self.logger.error(msg)
230 uuid = self.make_uuid()
233 self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
236 self.debuger.dump_create(uuid, clazzname, args)
238 clazz = getattr(self.ns3, clazzname)
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)
244 obj = clazz(*realargs)
246 self._objects[uuid] = obj
249 self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
250 str(obj), clazzname, str(args)))
254 def invoke(self, uuid, operation, *args, **kwargs):
256 self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
257 uuid, operation, str(args), str(kwargs)))
263 if operation == "isRunning":
264 result = self.is_running
266 elif operation == "isFinished":
267 result = self.is_finished
269 elif operation == "isAppRunning":
270 result = self._is_app_running(uuid)
272 elif operation == "recvFD":
273 ### passFD operation binds to a different random socket
274 ### en every execution, so the socket name that could be
275 ### dumped to the debug script using dump_invoke is
276 ### not be valid accross debug executions.
277 result = self._recv_fd(uuid, *args, **kwargs)
279 elif operation == "addStaticRoute":
280 result = self._add_static_route(uuid, *args)
282 ### DUMP - result is static, so will be dumped as plain text
283 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
285 elif operation == "retrieveObject":
286 result = self._retrieve_object(uuid, *args, **kwargs)
288 ### DUMP - result is static, so will be dumped as plain text
289 self.debuger.dump_invoke(result, uuid, operation, args, kwargs)
292 newuuid = self.make_uuid()
294 ### DUMP - result is a uuid that encoded an dynamically generated
296 self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
298 if uuid.startswith(SINGLETON):
299 obj = self._singleton(uuid)
301 obj = self.get_object(uuid)
303 method = getattr(obj, operation)
305 # arguments starting with 'uuid' identify ns-3 C++
306 # objects and must be replaced by the actual object
307 realargs = self.replace_args(args)
308 realkwargs = self.replace_kwargs(kwargs)
310 result = method(*realargs, **realkwargs)
312 # If the result is an object (not a base value),
313 # then keep track of the object a return the object
314 # reference (newuuid)
315 if not (result is None or type(result) in [
316 bool, float, long, str, int]):
317 self._objects[newuuid] = result
321 self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
322 "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
323 operation, str(args), str(kwargs)))
328 def _set_attr(self, obj, name, ns3_value):
329 obj.SetAttribute(name, ns3_value)
331 def set(self, uuid, name, value):
333 self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
336 self.debuger.dump_set(uuid, name, value)
338 obj = self.get_object(uuid)
339 type_name = obj.GetInstanceTypeId().GetName()
340 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
342 # If the Simulation thread is not running,
343 # then there will be no thread-safety problems
344 # in changing the value of an attribute directly.
345 # However, if the simulation is running we need
346 # to set the value by scheduling an event, else
347 # we risk to corrupt the state of the
350 event_executed = [False]
353 # schedule the event in the Simulator
354 self._schedule_event(self._condition, event_executed,
355 self._set_attr, obj, name, ns3_value)
357 if not event_executed[0]:
358 self._set_attr(obj, name, ns3_value)
361 self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
366 def _get_attr(self, obj, name, ns3_value):
367 obj.GetAttribute(name, ns3_value)
369 def get(self, uuid, name):
371 self.logger.debug("GET %s %s" % (uuid, name))
374 self.debuger.dump_get(uuid, name)
376 obj = self.get_object(uuid)
377 type_name = obj.GetInstanceTypeId().GetName()
378 ns3_value = self._create_attr_ns3_value(type_name, name)
380 event_executed = [False]
383 # schedule the event in the Simulator
384 self._schedule_event(self._condition, event_executed,
385 self._get_attr, obj, name, ns3_value)
387 if not event_executed[0]:
388 self._get_attr(obj, name, ns3_value)
390 result = self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
393 self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
399 self.debuger.dump_start()
401 # Launch the simulator thread and Start the
402 # simulator in that thread
403 self._condition = threading.Condition()
404 self._simulator_thread = threading.Thread(
405 target = self._simulator_run,
406 args = [self._condition])
407 self._simulator_thread.setDaemon(True)
408 self._simulator_thread.start()
412 self.logger.debug("START")
414 def stop(self, time = None):
416 self.debuger.dump_stop(time=time)
419 self.ns3.Simulator.Stop()
421 self.ns3.Simulator.Stop(self.ns3.Time(time))
424 self.logger.debug("STOP time=%s" % str(time))
428 self.debuger.dump_shutdown()
430 while not self.ns3.Simulator.IsFinished():
431 #self.logger.debug("Waiting for simulation to finish")
434 if self._simulator_thread:
435 self._simulator_thread.join()
437 self.ns3.Simulator.Destroy()
439 # Remove all references to ns-3 objects
440 self._objects.clear()
446 self.logger.debug("SHUTDOWN")
448 def _simulator_run(self, condition):
450 self.ns3.Simulator.Run()
451 # Signal condition to indicate simulation ended and
452 # notify waiting threads
454 condition.notifyAll()
457 def _schedule_event(self, condition, event_executed, func, *args):
458 """ Schedules event on running simulation, and wait until
461 def execute_event(contextId, condition, event_executed, func, *args):
464 event_executed[0] = True
466 # notify condition indicating event was executed
468 condition.notifyAll()
471 # contextId is defined as general context
472 contextId = long(0xffffffff)
474 # delay 0 means that the event is expected to execute inmediately
475 delay = self.ns3.Seconds(0)
477 # Mark event as not executed
478 event_executed[0] = False
482 self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
483 condition, event_executed, func, *args)
484 if not self.ns3.Simulator.IsFinished():
489 def _create_attr_ns3_value(self, type_name, name):
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 ns3_value = checker.Create()
501 def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
502 TypeId = self.ns3.TypeId()
503 tid = TypeId.LookupByName(type_name)
504 info = TypeId.AttributeInformation()
505 if not tid.LookupAttributeByName(name, info):
506 msg = "TypeId %s has no attribute %s" % (type_name, name)
507 self.logger.error(msg)
509 checker = info.checker
510 value = ns3_value.SerializeToString(checker)
512 type_name = checker.GetValueTypeName()
513 if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
515 if type_name == "ns3::DoubleValue":
517 if type_name == "ns3::BooleanValue":
518 return value == "true"
522 def _attr_from_string_to_ns3_value(self, type_name, name, value):
523 TypeId = self.ns3.TypeId()
524 tid = TypeId.LookupByName(type_name)
525 info = TypeId.AttributeInformation()
526 if not tid.LookupAttributeByName(name, info):
527 msg = "TypeId %s has no attribute %s" % (type_name, name)
528 self.logger.error(msg)
530 str_value = str(value)
531 if isinstance(value, bool):
532 str_value = str_value.lower()
534 checker = info.checker
535 ns3_value = checker.Create()
536 ns3_value.DeserializeFromString(str_value, checker)
539 # singletons are identified as "ns3::ClassName"
540 def _singleton(self, ident):
541 if not ident.startswith(SINGLETON):
544 clazzname = ident[ident.find("::")+2:]
545 if not hasattr(self.ns3, clazzname):
546 msg = "Type %s not supported" % (clazzname)
547 self.logger.error(msg)
549 return getattr(self.ns3, clazzname)
551 # replace uuids and singleton references for the real objects
552 def replace_args(self, args):
553 realargs = [self.get_object(arg) if \
554 str(arg).startswith("uuid") else arg for arg in args]
556 realargs = [self._singleton(arg) if \
557 str(arg).startswith(SINGLETON) else arg for arg in realargs]
561 # replace uuids and singleton references for the real objects
562 def replace_kwargs(self, kwargs):
563 realkwargs = dict([(k, self.get_object(v) \
564 if str(v).startswith("uuid") else v) \
565 for k,v in kwargs.iteritems()])
567 realkwargs = dict([(k, self._singleton(v) \
568 if str(v).startswith(SINGLETON) else v )\
569 for k, v in realkwargs.iteritems()])
573 def _is_app_running(self, uuid):
574 now = self.ns3.Simulator.Now()
578 app = self.get_object(uuid)
579 stop_time_value = self.ns3.TimeValue()
580 app.GetAttribute("StopTime", stop_time_value)
581 stop_time = stop_time_value.Get()
583 start_time_value = self.ns3.TimeValue()
584 app.GetAttribute("StartTime", start_time_value)
585 start_time = start_time_value.Get()
587 if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
592 def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
593 ipv4 = self.get_object(ipv4_uuid)
595 list_routing = ipv4.GetRoutingProtocol()
596 (static_routing, priority) = list_routing.GetRoutingProtocol(0)
598 ifindex = self._find_ifindex(ipv4, nexthop)
602 nexthop = self.ns3.Ipv4Address(nexthop)
604 if network in ["0.0.0.0", "0", None]:
605 # Default route: 0.0.0.0/0
606 static_routing.SetDefaultRoute(nexthop, ifindex)
608 mask = self.ns3.Ipv4Mask("/%s" % prefix)
609 network = self.ns3.Ipv4Address(network)
612 # Host route: x.y.z.w/32
613 static_routing.AddHostRouteTo(network, nexthop, ifindex)
615 # Network route: x.y.z.w/n
616 static_routing.AddNetworkRouteTo(network, mask, nexthop,
620 def _find_ifindex(self, ipv4, nexthop):
623 nexthop = self.ns3.Ipv4Address(nexthop)
625 # For all the interfaces registered with the ipv4 object, find
626 # the one that matches the network of the nexthop
627 nifaces = ipv4.GetNInterfaces()
628 for ifidx in xrange(nifaces):
629 iface = ipv4.GetInterface(ifidx)
630 naddress = iface.GetNAddresses()
631 for addridx in xrange(naddress):
632 ifaddr = iface.GetAddress(addridx)
633 ifmask = ifaddr.GetMask()
635 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)
641 def _retrieve_object(self, uuid, typeid, search = False):
642 obj = self.get_object(uuid)
644 type_id = self.ns3.TypeId()
645 tid = type_id.LookupByName(typeid)
646 nobj = obj.GetObject(tid)
651 for ouuid, oobj in self._objects.iteritems():
656 newuuid = self.make_uuid()
657 self._objects[newuuid] = nobj
661 def _recv_fd(self, uuid):
662 """ Waits on a local address to receive a file descriptor
663 from a local process. The file descriptor is associated
664 to a FdNetDevice to stablish communication between the
665 simulation and what ever process writes on that file descriptor
668 def recvfd(sock, fdnd):
669 (fd, msg) = passfd.recvfd(sock)
670 # Store a reference to the endpoint to keep the socket alive
671 fdnd.SetFileDescriptor(fd)
675 sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
677 address = sock.getsockname()
679 fdnd = self.get_object(uuid)
680 t = threading.Thread(target=recvfd, args=(sock,fdnd))