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"
32 def load_ns3_module():
36 bindings = os.environ.get("NS3BINDINGS")
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 = list(libs)
66 # import the python bindings for the ns-3 modules
68 sys.path.append(bindings)
74 # create a Python module to add all ns3 classes
75 ns3mod = imp.new_module("ns3")
76 sys.modules["ns3"] = ns3mod
78 for importer, modname, ispkg in pkgutil.iter_modules(ns.__path__):
79 if modname in [ "visualizer" ]:
82 fullmodname = "ns.%s" % modname
83 module = __import__(fullmodname, globals(), locals(), ['*'])
85 for sattr in dir(module):
86 if sattr.startswith("_"):
89 attr = getattr(module, sattr)
91 # netanim.Config and lte.Config singleton overrides ns3::Config
92 if sattr == "Config" and modname in ['netanim', 'lte']:
93 sattr = "%s.%s" % (modname, sattr)
95 setattr(ns3mod, sattr, attr)
99 class NS3Wrapper(object):
100 def __init__(self, loglevel = logging.INFO):
101 super(NS3Wrapper, self).__init__()
102 # Thread used to run the simulation
103 self._simulation_thread = None
104 self._condition = None
106 # True if Simulator::Run was invoked
107 self._started = False
109 # holds reference to all C++ objects and variables in the simulation
110 self._objects = dict()
113 self._logger = logging.getLogger("ns3wrapper")
114 self._logger.setLevel(loglevel)
116 ## NOTE that the reason to create a handler to the ns3 module,
117 # that is re-loaded each time a ns-3 wrapper is instantiated,
118 # is that else each unit test for the ns3wrapper class would need
119 # a separate file. Several ns3wrappers would be created in the
120 # same unit test (single process), leading to inchorences in the
121 # state of ns-3 global objects
123 # Handler to ns3 classes
126 # Collection of allowed ns3 classes
127 self._allowed_types = None
132 # load ns-3 libraries and bindings
133 self._ns3 = load_ns3_module()
138 def allowed_types(self):
139 if not self._allowed_types:
140 self._allowed_types = set()
141 type_id = self.ns3.TypeId()
143 tid_count = type_id.GetRegisteredN()
144 base = type_id.LookupByName("ns3::Object")
146 for i in xrange(tid_count):
147 tid = type_id.GetRegistered(i)
149 if tid.MustHideFromDocumentation() or \
150 not tid.HasConstructor() or \
151 not tid.IsChildOf(base):
154 type_name = tid.GetName()
155 self._allowed_types.add(type_name)
157 return self._allowed_types
164 def is_running(self):
165 return self._started and self.ns3.Simulator.IsFinished()
168 return "uuid%s" % uuid.uuid4()
170 def get_object(self, uuid):
171 return self._objects.get(uuid)
173 def factory(self, type_name, **kwargs):
174 if type_name not in self.allowed_types:
175 msg = "Type %s not supported" % (type_name)
176 self.logger.error(msg)
178 factory = self.ns3.ObjectFactory()
179 factory.SetTypeId(type_name)
181 for name, value in kwargs.iteritems():
182 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
183 factory.Set(name, ns3_value)
185 obj = factory.Create()
187 uuid = self.make_uuid()
188 self._objects[uuid] = obj
192 def create(self, clazzname, *args):
193 if not hasattr(self.ns3, clazzname):
194 msg = "Type %s not supported" % (clazzname)
195 self.logger.error(msg)
197 clazz = getattr(self.ns3, clazzname)
199 # arguments starting with 'uuid' identify ns-3 C++
200 # objects and must be replaced by the actual object
201 realargs = self.replace_args(args)
203 obj = clazz(*realargs)
205 uuid = self.make_uuid()
206 self._objects[uuid] = obj
210 def invoke(self, uuid, operation, *args):
211 if operation == "isAppRunning":
212 return self._is_app_running(uuid)
214 if uuid.startswith(SINGLETON):
215 obj = self._singleton(uuid)
217 obj = self.get_object(uuid)
219 method = getattr(obj, operation)
221 # arguments starting with 'uuid' identify ns-3 C++
222 # objects and must be replaced by the actual object
223 realargs = self.replace_args(args)
225 result = method(*realargs)
227 if result is None or \
228 isinstance(result, bool):
231 newuuid = self.make_uuid()
232 self._objects[newuuid] = result
236 def _set_attr(self, obj, name, ns3_value):
237 obj.SetAttribute(name, ns3_value)
239 def set(self, uuid, name, value):
240 obj = self.get_object(uuid)
241 type_name = obj.GetInstanceTypeId().GetName()
242 ns3_value = self._attr_from_string_to_ns3_value(type_name, name, value)
244 # If the Simulation thread is not running,
245 # then there will be no thread-safety problems
246 # in changing the value of an attribute directly.
247 # However, if the simulation is running we need
248 # to set the value by scheduling an event, else
249 # we risk to corrupt the state of the
252 event_executed = [False]
255 # schedule the event in the Simulator
256 self._schedule_event(self._condition, event_executed,
257 self._set_attr, obj, name, ns3_value)
259 if not event_executed[0]:
260 self._set_attr(obj, name, ns3_value)
264 def _get_attr(self, obj, name, ns3_value):
265 obj.GetAttribute(name, ns3_value)
267 def get(self, uuid, name):
268 obj = self.get_object(uuid)
269 type_name = obj.GetInstanceTypeId().GetName()
270 ns3_value = self._create_attr_ns3_value(type_name, name)
272 event_executed = [False]
275 # schedule the event in the Simulator
276 self._schedule_event(self._condition, event_executed,
277 self._get_attr, obj, name, ns3_value)
279 if not event_executed[0]:
280 self._get_attr(obj, name, ns3_value)
282 return self._attr_from_ns3_value_to_string(type_name, name, ns3_value)
285 # Launch the simulator thread and Start the
286 # simulator in that thread
287 self._condition = threading.Condition()
288 self._simulator_thread = threading.Thread(
289 target = self._simulator_run,
290 args = [self._condition])
291 self._simulator_thread.setDaemon(True)
292 self._simulator_thread.start()
295 def stop(self, time = None):
297 self.ns3.Simulator.Stop()
299 self.ns3.Simulator.Stop(self.ns3.Time(time))
302 while not self.ns3.Simulator.IsFinished():
303 #self.logger.debug("Waiting for simulation to finish")
306 if self._simulator_thread:
307 self._simulator_thread.join()
309 self.ns3.Simulator.Destroy()
311 # Remove all references to ns-3 objects
312 self._objects.clear()
317 def _simulator_run(self, condition):
319 self.ns3.Simulator.Run()
320 # Signal condition to indicate simulation ended and
321 # notify waiting threads
323 condition.notifyAll()
326 def _schedule_event(self, condition, event_executed, func, *args):
327 """ Schedules event on running simulation, and wait until
330 def execute_event(contextId, condition, event_executed, func, *args):
333 event_executed[0] = True
335 # notify condition indicating event was executed
337 condition.notifyAll()
340 # contextId is defined as general context
341 contextId = long(0xffffffff)
343 # delay 0 means that the event is expected to execute inmediately
344 delay = self.ns3.Seconds(0)
346 # Mark event as not executed
347 event_executed[0] = False
351 self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
352 condition, event_executed, func, *args)
353 if not self.ns3.Simulator.IsFinished():
358 def _create_attr_ns3_value(self, type_name, name):
359 TypeId = self.ns3.TypeId()
360 tid = TypeId.LookupByName(type_name)
361 info = TypeId.AttributeInformation()
362 if not tid.LookupAttributeByName(name, info):
363 msg = "TypeId %s has no attribute %s" % (type_name, name)
364 self.logger.error(msg)
366 checker = info.checker
367 ns3_value = checker.Create()
370 def _attr_from_ns3_value_to_string(self, type_name, name, ns3_value):
371 TypeId = self.ns3.TypeId()
372 tid = TypeId.LookupByName(type_name)
373 info = TypeId.AttributeInformation()
374 if not tid.LookupAttributeByName(name, info):
375 msg = "TypeId %s has no attribute %s" % (type_name, name)
376 self.logger.error(msg)
378 checker = info.checker
379 value = ns3_value.SerializeToString(checker)
381 type_name = checker.GetValueTypeName()
382 if type_name in ["ns3::UintegerValue", "ns3::IntegerValue"]:
384 if type_name == "ns3::DoubleValue":
386 if type_name == "ns3::BooleanValue":
387 return value == "true"
391 def _attr_from_string_to_ns3_value(self, type_name, name, value):
392 TypeId = self.ns3.TypeId()
393 tid = TypeId.LookupByName(type_name)
394 info = TypeId.AttributeInformation()
395 if not tid.LookupAttributeByName(name, info):
396 msg = "TypeId %s has no attribute %s" % (type_name, name)
397 self.logger.error(msg)
399 str_value = str(value)
400 if isinstance(value, bool):
401 str_value = str_value.lower()
403 checker = info.checker
404 ns3_value = checker.Create()
405 ns3_value.DeserializeFromString(str_value, checker)
408 # singletons are identified as "ns3::ClassName"
409 def _singleton(self, ident):
410 if not ident.startswith(SINGLETON):
413 clazzname = ident[ident.find("::")+2:]
414 if not hasattr(self.ns3, clazzname):
415 msg = "Type %s not supported" % (clazzname)
416 self.logger.error(msg)
418 return getattr(self.ns3, clazzname)
420 # replace uuids and singleton references for the real objects
421 def replace_args(self, args):
422 realargs = [self.get_object(arg) if \
423 str(arg).startswith("uuid") else arg for arg in args]
425 realargs = [self._singleton(arg) if \
426 str(arg).startswith(SINGLETON) else arg for arg in realargs]
430 def _is_app_running(self, uuid):
431 now = self.ns3.Simulator.Now()
435 stop_value = self.get(uuid, "StopTime")
436 stop_time = self.ns3.Time(stop_value)
438 start_value = self.get(uuid, "StartTime")
439 start_time = self.ns3.Time(start_value)
441 self.logger.debug("NOW %s" % now.GetSeconds())
442 self.logger.debug("START TIME %s" % start_value)
443 self.logger.debug("STOP TIME %s" % stop_value)
445 if now.Compare(start_time) >= 0 and now.Compare(stop_time) < 0: