Merge with head
[nepi.git] / src / nepi / testbeds / ns3 / execute.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from nepi.core import testbed_impl
5 from nepi.core.attributes import Attribute
6 from constants import TESTBED_ID, TESTBED_VERSION
7 from nepi.util.constants import TIME_NOW, TestbedStatus as TS
8 import os
9 import sys
10 import threading
11 import random
12 import socket
13 import weakref
14
15 def load_ns3_module():
16     import sys
17     if 'ns3' in sys.modules:
18         return
19
20     import ctypes
21     import imp
22     import re
23
24     bindings = os.environ["NEPI_NS3BINDINGS"] \
25                 if "NEPI_NS3BINDINGS" in os.environ else None
26     libdir = os.environ["NEPI_NS3LIBRARY"] \
27                 if "NEPI_NS3LIBRARY" in os.environ else None
28
29     if libdir:
30         files = os.listdir(libdir)
31         regex = re.compile("(.*\.so)$")
32         libs = [m.group(1) for filename in files for m in [regex.search(filename)] if m]
33
34         libscp = list(libs)
35         while len(libs) > 0:
36             for lib in libscp:
37                 libfile = os.path.join(libdir, lib)
38                 try:
39                     ctypes.CDLL(libfile, ctypes.RTLD_GLOBAL)
40                     libs.remove(lib)
41                 except:
42                     pass
43             # if did not load any libraries in the last iteration
44             if len(libscp) == len(libs):
45                 raise RuntimeError("Imposible to load shared libraries %s" % str(libs))
46             libscp = list(libs)
47
48     if bindings:
49         sys.path.append(bindings)
50
51     import ns3_bindings_import as mod
52     sys.modules["ns3"] = mod
53
54 class TestbedController(testbed_impl.TestbedController):
55     from nepi.util.tunchannel_impl import TunChannel
56     
57     LOCAL_FACTORIES = {
58         'ns3::Nepi::TunChannel' : TunChannel,
59     }
60     
61     LOCAL_TYPES = tuple(LOCAL_FACTORIES.values())
62
63     def __init__(self):
64         super(TestbedController, self).__init__(TESTBED_ID, TESTBED_VERSION)
65         self._ns3 = None
66         self._home_directory = None
67         self._traces = dict()
68         self._simulator_thread = None
69         self._condition = None
70
71     @property
72     def home_directory(self):
73         return self._home_directory
74
75     @property
76     def ns3(self):
77         return self._ns3
78
79     def do_setup(self):
80         self._home_directory = self._attributes.\
81             get_attribute_value("homeDirectory")
82         self._ns3 = self._configure_ns3_module()
83         
84         # create home...
85         home = os.path.normpath(self.home_directory)
86         if not os.path.exists(home):
87             os.makedirs(home, 0755)
88         
89         super(TestbedController, self).do_setup()
90
91     def start(self):
92         super(TestbedController, self).start()
93         self._condition = threading.Condition()
94         self._simulator_thread = threading.Thread(target = self._simulator_run,
95                 args = [self._condition])
96         self._simulator_thread.setDaemon(True)
97         self._simulator_thread.start()
98
99     def stop(self, time = TIME_NOW):
100         super(TestbedController, self).stop(time)
101         #self.ns3.Simulator.Stop()
102         self._stop_simulation(time)
103
104     def set(self, guid, name, value, time = TIME_NOW):
105         super(TestbedController, self).set(guid, name, value, time)
106         # TODO: take on account schedule time for the task
107         factory_id = self._create[guid]
108         factory = self._factories[factory_id]
109         element = self._elements[guid]
110         if factory_id in self.LOCAL_FACTORIES:
111             setattr(element, name, value)
112         elif not factory.box_attributes.is_attribute_metadata(name):
113             ns3_value = self._to_ns3_value(guid, name, value)
114             self._set_attribute(name, ns3_value, element)
115
116     def get(self, guid, name, time = TIME_NOW):
117         value = super(TestbedController, self).get(guid, name, time)
118         # TODO: take on account schedule time for the task
119         factory_id = self._create[guid]
120         factory = self._factories[factory_id]
121         element = self._elements[guid]
122         if factory_id in self.LOCAL_FACTORIES:
123             if hasattr(element, name):
124                 return getattr(element, name)
125             else:
126                 return value
127         if factory.box_attributes.is_attribute_metadata(name):
128             return value
129
130         TypeId = self.ns3.TypeId()
131         typeid = TypeId.LookupByName(factory_id)
132         info = TypeId.AttributeInfo()
133         if not typeid or not typeid.LookupAttributeByName(name, info):
134             raise AttributeError("Invalid attribute %s for element type %d" % \
135                 (name, guid))
136         checker = info.checker
137         ns3_value = checker.Create() 
138         self._get_attribute(name, ns3_value, element)
139         value = ns3_value.SerializeToString(checker)
140         attr_type = factory.box_attributes.get_attribute_type(name)
141         if attr_type == Attribute.INTEGER:
142             return int(value)
143         if attr_type == Attribute.DOUBLE:
144             return float(value)
145         if attr_type == Attribute.BOOL:
146             return value == "true"
147         return value
148
149     def action(self, time, guid, action):
150         raise NotImplementedError
151
152     def trace_filepath(self, guid, trace_id):
153         filename = self._traces[guid][trace_id]
154         return os.path.join(self.home_directory, filename)
155
156     def follow_trace(self, guid, trace_id, filename):
157         if not guid in self._traces:
158             self._traces[guid] = dict()
159         self._traces[guid][trace_id] = filename
160
161     def shutdown(self):
162         for element in self._elements.itervalues():
163             if isinstance(element, self.LOCAL_TYPES):
164                 # graceful shutdown of locally-implemented objects
165                 element.Cleanup()
166         if self.ns3:
167             self.ns3.Simulator.Stop()
168             
169             # Wait for it to stop, with a 30s timeout
170             for i in xrange(300):
171                 if self.ns3.Simulator.IsFinished():
172                     break
173                 time.sleep(0.1)
174             #self._stop_simulation("0s")
175         
176         self._elements.clear()
177         
178         if self.ns3:
179             # TODO!!!! SHOULD WAIT UNTIL THE THREAD FINISHES
180             #   if self._simulator_thread:
181             #       self._simulator_thread.join()
182             self.ns3.Simulator.Destroy()
183         
184         self._ns3 = None
185         sys.stdout.flush()
186         sys.stderr.flush()
187
188     def _simulator_run(self, condition):
189         # Run simulation
190         self.ns3.Simulator.Run()
191         # Signal condition on simulation end to notify waiting threads
192         condition.acquire()
193         condition.notifyAll()
194         condition.release()
195
196     def _schedule_event(self, condition, func, *args):
197         """Schedules event on running experiment"""
198         def execute_event(condition, has_event_occurred, func, *args):
199             # exec func
200             try:
201                 func(*args)
202             finally:
203                 # flag event occured
204                 has_event_occurred[0] = True
205                 # notify condition indicating attribute was set
206                 condition.acquire()
207                 condition.notifyAll()
208                 condition.release()
209
210         # contextId is defined as general context
211         contextId = long(0xffffffff)
212         # delay 0 means that the event is expected to execute inmediately
213         delay = self.ns3.Seconds(0)
214         # flag to indicate that the event occured
215         # because bool is an inmutable object in python, in order to create a
216         # bool flag, a list is used as wrapper
217         has_event_occurred = [False]
218         condition.acquire()
219         if not self.ns3.Simulator.IsFinished():
220             self.ns3.Simulator.ScheduleWithContext(contextId, delay, execute_event,
221                  condition, has_event_occurred, func, *args)
222             while not has_event_occurred[0] and not self.ns3.Simulator.IsFinished():
223                 condition.wait()
224                 condition.release()
225
226     def _set_attribute(self, name, ns3_value, element):
227         if self.status() == TS.STATUS_STARTED:
228             # schedule the event in the Simulator
229             self._schedule_event(self._condition, self._set_ns3_attribute, 
230                     name, ns3_value, element)
231         else:
232             self._set_ns3_attribute(name, ns3_value, element)
233
234     def _get_attribute(self, name, ns3_value, element):
235         if self.status() == TS.STATUS_STARTED:
236             # schedule the event in the Simulator
237             self._schedule_event(self._condition, self._get_ns3_attribute, 
238                     name, ns3_value, element)
239         else:
240             self._get_ns3_attribute(name, ns3_value, element)
241
242     def _set_ns3_attribute(self, name, ns3_value, element):
243         element.SetAttribute(name, ns3_value)
244
245     def _get_ns3_attribute(self, name, ns3_value, element):
246         element.GetAttribute(name, ns3_value)
247
248     def _stop_simulation(self, time):
249         if self.status() == TS.STATUS_STARTED:
250             # schedule the event in the Simulator
251             self._schedule_event(self._condition, self._stop_ns3_simulation, 
252                     time)
253         else:
254             self._stop_ns3_simulation(time)
255
256     def _stop_ns3_simulation(self, time = TIME_NOW):
257         if not self.ns3:
258             return
259         if time == TIME_NOW:
260             self.ns3.Simulator.Stop()
261         else:
262             self.ns3.Simulator.Stop(self.ns3.Time(time))
263
264     def _to_ns3_value(self, guid, name, value):
265         factory_id = self._create[guid]
266         TypeId = self.ns3.TypeId()
267         typeid = TypeId.LookupByName(factory_id)
268         info = TypeId.AttributeInfo()
269         if not typeid.LookupAttributeByName(name, info):
270             raise RuntimeError("Attribute %s doesn't belong to element %s" \
271                    % (name, factory_id))
272         str_value = str(value)
273         if isinstance(value, bool):
274             str_value = str_value.lower()
275         checker = info.checker
276         ns3_value = checker.Create()
277         ns3_value.DeserializeFromString(str_value, checker)
278         return ns3_value
279
280     def _configure_ns3_module(self):
281         simu_impl_type = self._attributes.get_attribute_value(
282                 "SimulatorImplementationType")
283         sched_impl_type = self._attributes.get_attribute_value(
284                 "SchedulerType")
285         checksum = self._attributes.get_attribute_value("ChecksumEnabled")
286         stop_time = self._attributes.get_attribute_value("StopTime")
287
288         load_ns3_module()
289
290         import ns3 as mod
291  
292         if simu_impl_type:
293             value = mod.StringValue(simu_impl_type)
294             mod.GlobalValue.Bind ("SimulatorImplementationType", value)
295         if sched_impl_type:
296             value = mod.StringValue(sched_impl_type)
297             mod.GlobalValue.Bind ("SchedulerType", value)
298         if checksum:
299             value = mod.BooleanValue(checksum)
300             mod.GlobalValue.Bind ("ChecksumEnabled", value)
301         if stop_time:
302             value = mod.Time(stop_time)
303             mod.Simulator.Stop (value)
304         return mod
305
306     def _get_construct_parameters(self, guid):
307         params = self._get_parameters(guid)
308         construct_params = dict()
309         factory_id = self._create[guid]
310         TypeId = self.ns3.TypeId()
311         typeid = TypeId.LookupByName(factory_id)
312         for name, value in params.iteritems():
313             info = self.ns3.TypeId.AttributeInfo()
314             found = typeid.LookupAttributeByName(name, info)
315             if found and \
316                 (info.flags & TypeId.ATTR_CONSTRUCT == TypeId.ATTR_CONSTRUCT):
317                 construct_params[name] = value
318         return construct_params
319
320
321