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):
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
136 # load ns-3 libraries and bindings
137 self._ns3 = load_ns3_module()
142 def allowed_types(self):
143 if not self._allowed_types:
144 self._allowed_types = set()
145 type_id = self.ns3.TypeId()
147 tid_count = type_id.GetRegisteredN()
148 base = type_id.LookupByName("ns3::Object")
150 for i in xrange(tid_count):
151 tid = type_id.GetRegistered(i)
153 if tid.MustHideFromDocumentation() or \
154 not tid.HasConstructor() or \
155 not tid.IsChildOf(base):
158 type_name = tid.GetName()
159 self._allowed_types.add(type_name)
161 return self._allowed_types
168 def is_running(self):
169 return self._started and self.ns3.Simulator.IsFinished()
172 return "uuid%s" % uuid.uuid4()
174 def get_object(self, uuid):
175 return self._objects.get(uuid)
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)
182 factory = self.ns3.ObjectFactory()
183 factory.SetTypeId(type_name)
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)
189 obj = factory.Create()
191 uuid = self.make_uuid()
192 self._objects[uuid] = obj
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)
201 clazz = getattr(self.ns3, clazzname)
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)
207 obj = clazz(*realargs)
209 uuid = self.make_uuid()
210 self._objects[uuid] = obj
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)
220 if uuid.startswith(SINGLETON):
221 obj = self._singleton(uuid)
223 obj = self.get_object(uuid)
225 method = getattr(obj, operation)
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)
232 result = method(*realargs, **realkwargs)
234 if result is None or \
235 isinstance(result, bool):
238 newuuid = self.make_uuid()
239 self._objects[newuuid] = result
243 def _set_attr(self, obj, name, ns3_value):
244 obj.SetAttribute(name, ns3_value)
246 def set(self, uuid, name, value):
247 obj = self.get_object(uuid)
248 type_name = obj.GetInstanceTypeId().GetName()
249 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
251 # If the Simulation thread is not running,
252 # then there will be no thread-safety problems
253 # in changing the value of an attribute directly.
254 # However, if the simulation is running we need
255 # to set the value by scheduling an event, else
256 # we risk to corrupt the state of the
259 event_executed = [False]
262 # schedule the event in the Simulator
263 self._schedule_event(self._condition, event_executed,
264 self._set_attr, obj, name, ns3_value)
266 if not event_executed[0]:
267 self._set_attr(obj, name, ns3_value)
271 def _get_attr(self, obj, name, ns3_value):
272 obj.GetAttribute(name, ns3_value)
274 def get(self, uuid, name):
275 obj = self.get_object(uuid)
276 type_name = obj.GetInstanceTypeId().GetName()
277 ns3_value = self._create_attr_ns3_value(type_name, name)
279 event_executed = [False]
282 # schedule the event in the Simulator
283 self._schedule_event(self._condition, event_executed,
284 self._get_attr, obj, name, ns3_value)
286 if not event_executed[0]:
287 self._get_attr(obj, name, ns3_value)
289 return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
292 # Launch the simulator thread and Start the
293 # simulator in that thread
294 self._condition = threading.Condition()
295 self._simulator_thread = threading.Thread(
296 target = self._simulator_run,
297 args = [self._condition])
298 self._simulator_thread.setDaemon(True)
299 self._simulator_thread.start()
302 def stop(self, time = None):
304 self.ns3.Simulator.Stop()
306 self.ns3.Simulator.Stop(self.ns3.Time(time))
309 while not self.ns3.Simulator.IsFinished():
310 #self.logger.debug("Waiting for simulation to finish")
313 if self._simulator_thread:
314 self._simulator_thread.join()
316 self.ns3.Simulator.Destroy()
318 # Remove all references to ns-3 objects
319 self._objects.clear()
324 def _simulator_run(self, condition):
326 self.ns3.Simulator.Run()
327 # Signal condition to indicate simulation ended and
328 # notify waiting threads
330 condition.notifyAll()
333 def _schedule_event(self, condition, event_executed, func, *args):
334 """ Schedules event on running simulation, and wait until
337 def execute_event(contextId, condition, event_executed, func, *args):
340 event_executed[0] = True
342 # notify condition indicating event was executed
344 condition.notifyAll()
347 # contextId is defined as general context
348 contextId = long(0xffffffff)
350 # delay 0 means that the event is expected to execute inmediately
351 delay = self.ns3.Seconds(0)
353 # Mark event as not executed
354 event_executed[0] = False
358 self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
359 condition, event_executed, func, *args)
360 if not self.ns3.Simulator.IsFinished():
365 def _create_attr_ns3_value(self, type_name, name):
366 TypeId = self.ns3.TypeId()
367 tid = TypeId.LookupByName(type_name)
368 info = TypeId.AttributeInformation()
369 if not tid.LookupAttributeByName(name, info):
370 msg = "TypeId %s has no attribute %s" % (type_name, name)
371 self.logger.error(msg)
373 checker = info.checker
374 ns3_value = checker.Create()
377 def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
378 TypeId = self.ns3.TypeId()
379 tid = TypeId.LookupByName(type_name)
380 info = TypeId.AttributeInformation()
381 if not tid.LookupAttributeByName(name, info):
382 msg = "TypeId %s has no attribute %s" % (type_name, name)
383 self.logger.error(msg)
385 checker = info.checker
386 value = ns3_value.SerializeToString(checker)
388 type_name = checker.GetValueTypeName()
389 if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
391 if type_name == "ns3::DoubleValue":
393 if type_name == "ns3::BooleanValue":
394 return value == "true"
398 def _attr_from_string_to_ns3_value(self, type_name, name, value):
399 TypeId = self.ns3.TypeId()
400 tid = TypeId.LookupByName(type_name)
401 info = TypeId.AttributeInformation()
402 if not tid.LookupAttributeByName(name, info):
403 msg = "TypeId %s has no attribute %s" % (type_name, name)
404 self.logger.error(msg)
406 str_value = str(value)
407 if isinstance(value, bool):
408 str_value = str_value.lower()
410 checker = info.checker
411 ns3_value = checker.Create()
412 ns3_value.DeserializeFromString(str_value, checker)
415 # singletons are identified as "ns3::ClassName"
416 def _singleton(self, ident):
417 if not ident.startswith(SINGLETON):
420 clazzname = ident[ident.find("::")+2:]
421 if not hasattr(self.ns3, clazzname):
422 msg = "Type %s not supported" % (clazzname)
423 self.logger.error(msg)
425 return getattr(self.ns3, clazzname)
427 # replace uuids and singleton references for the real objects
428 def replace_args(self, args):
429 realargs = [self.get_object(arg) if \
430 str(arg).startswith("uuid") else arg for arg in args]
432 realargs = [self._singleton(arg) if \
433 str(arg).startswith(SINGLETON) else arg for arg in realargs]
437 # replace uuids and singleton references for the real objects
438 def replace_kwargs(self, kwargs):
439 realkwargs = dict([(k, self.get_object(v) \
440 if str(v).startswith("uuid") else v) \
441 for k,v in kwargs.iteritems()])
443 realkwargs = dict([(k, self._singleton(v) \
444 if str(v).startswith(SINGLETON) else v )\
445 for k, v in realkwargs.iteritems()])
449 def _is_app_running(self, uuid):
450 now = self.ns3.Simulator.Now()
454 app = self.get_object(uuid)
455 stop_time_value = self.ns3.TimeValue()
456 app.GetAttribute("StopTime", stop_time_value)
457 stop_time = stop_time_value.Get()
459 start_time_value = self.ns3.TimeValue()
460 app.GetAttribute("StartTime", start_time_value)
461 start_time = start_time_value.Get()
463 if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0:
468 def _add_static_route(self, ipv4_uuid, network, prefix, nexthop):
469 ipv4 = self.get_object(ipv4_uuid)
471 list_routing = ipv4.GetRoutingProtocol()
472 (static_routing, priority) = list_routing.GetRoutingProtocol(0)
474 ifindex = self._find_ifindex(ipv4, nexthop)
478 nexthop = self.ns3.Ipv4Address(nexthop)
480 if network in ["0.0.0.0", "0", None]:
481 # Default route: 0.0.0.0/0
482 static_routing.SetDefaultRoute(nexthop, ifindex)
484 mask = self.ns3.Ipv4Mask("/%s" % prefix)
485 network = self.ns3.Ipv4Address(network)
488 # Host route: x.y.z.w/32
489 static_routing.AddHostRouteTo(network, nexthop, ifindex)
491 # Network route: x.y.z.w/n
492 static_routing.AddNetworkRouteTo(network, mask, nexthop,
496 def _find_ifindex(self, ipv4, nexthop):
499 nexthop = self.ns3.Ipv4Address(nexthop)
501 # For all the interfaces registered with the ipv4 object, find
502 # the one that matches the network of the nexthop
503 nifaces = ipv4.GetNInterfaces()
504 for ifidx in xrange(nifaces):
505 iface = ipv4.GetInterface(ifidx)
506 naddress = iface.GetNAddresses()
507 for addridx in xrange(naddress):
508 ifaddr = iface.GetAddress(addridx)
509 ifmask = ifaddr.GetMask()
511 ifindex = ipv4.GetInterfaceForPrefix(nexthop, ifmask)