2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2014 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>
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.trace import Trace, TraceAttr
22 from nepi.execution.resource import ResourceManager, clsinit_copy, \
23 ResourceState, reschedule_delay
24 from nepi.resources.linux.application import LinuxApplication
25 from nepi.util.timefuncs import tnow, tdiffsec
26 from nepi.resources.ns3.ns3simulation import NS3Simulation
27 from nepi.resources.ns3.ns3wrapper import SIMULATOR_UUID, GLOBAL_VALUE_UUID, \
28 IPV4_GLOBAL_ROUTING_HELPER_UUID
29 from nepi.resources.linux.ns3.ns3client import LinuxNS3Client
36 class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
37 _rtype = "LinuxNS3Simulation"
40 def _register_attributes(cls):
41 impl_type = Attribute("simulatorImplementationType",
42 "The object class to use as the simulator implementation",
43 allowed = ["ns3::DefaultSimulatorImpl", "ns3::RealtimeSimulatorImpl"],
44 default = "ns3::DefaultSimulatorImpl",
45 type = Types.Enumerate,
48 sched_type = Attribute("schedulerType",
49 "The object class to use as the scheduler implementation",
50 allowed = ["ns3::MapScheduler",
54 "ns3::CalendarScheduler"
56 default = "ns3::MapScheduler",
57 type = Types.Enumerate,
60 check_sum = Attribute("checksumEnabled",
61 "A global switch to enable all checksums for all protocols",
66 ns_log = Attribute("nsLog",
67 "NS_LOG environment variable. " \
68 " Will only generate output if ns-3 is compiled in DEBUG mode. ",
71 verbose = Attribute("verbose",
72 "True to output debugging info from the ns3 client-server communication",
76 build_mode = Attribute("buildMode",
77 "Mode used to build ns-3 with waf. One if: debug, release, oprimized ",
78 default = "optimized",
79 allowed = ["debug", "release", "optimized"],
80 type = Types.Enumerate,
83 ns3_version = Attribute("ns3Version",
84 "Version of ns-3 to install from nsam repo",
89 enable_dce = Attribute("enableDCE",
90 "Install DCE source code",
95 pybindgen_version = Attribute("pybindgenVersion",
96 "Version of pybindgen to install from bazar repo",
100 populate_routing_tables = Attribute("populateRoutingTables",
101 "Invokes Ipv4GlobalRoutingHelper.PopulateRoutingTables() ",
104 flags = Flags.Design)
106 cls._register_attribute(impl_type)
107 cls._register_attribute(sched_type)
108 cls._register_attribute(check_sum)
109 cls._register_attribute(ns_log)
110 cls._register_attribute(verbose)
111 cls._register_attribute(build_mode)
112 cls._register_attribute(ns3_version)
113 cls._register_attribute(pybindgen_version)
114 cls._register_attribute(populate_routing_tables)
115 cls._register_attribute(enable_dce)
117 def __init__(self, ec, guid):
118 LinuxApplication.__init__(self, ec, guid)
119 NS3Simulation.__init__(self)
122 self._home = "ns3-simu-%s" % self.guid
123 self._socket_name = "ns3-%s.sock" % os.urandom(4).encode('hex')
124 self._dce_manager_helper_uuid = None
125 self._dce_application_helper_uuid = None
127 # Lock used to synchronize usage of DceManagerHelper
128 self.dce_manager_lock = threading.Lock()
129 # Lock used to synchronize usage of DceApplicationHelper
130 self.dce_application_lock = threading.Lock()
133 def socket_name(self):
134 return self._socket_name
137 def remote_socket(self):
138 return os.path.join(self.run_home, self.socket_name)
141 def dce_manager_helper_uuid(self):
142 return self._dce_manager_helper_uuid
145 def dce_application_helper_uuid(self):
146 return self._dce_application_helper_uuid
149 def ns3_build_home(self):
150 return os.path.join(self.node.bin_dir, "ns-3", self.get("ns3Version"),
151 self.get("buildMode"), "build")
153 def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
155 return LinuxApplication.trace(self, name, attr, block, offset)
157 def upload_sources(self):
158 self.node.mkdir(os.path.join(self.node.src_dir, "ns3wrapper"))
160 # upload ns3 wrapper python script
161 ns3_wrapper = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
164 self.node.upload(ns3_wrapper,
165 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper.py"),
168 # upload ns3_server python script
169 ns3_server = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
172 self.node.upload(ns3_server,
173 os.path.join(self.node.src_dir, "ns3wrapper", "ns3server.py"),
176 if self.node.use_rpm:
177 # upload pygccxml sources
178 pygccxml_tar = os.path.join(os.path.dirname(__file__), "dependencies",
179 "%s.tar.gz" % self.pygccxml_version)
181 self.node.upload(pygccxml_tar,
182 os.path.join(self.node.src_dir, "%s.tar.gz" % self.pygccxml_version),
185 # Upload user defined ns-3 sources
186 self.node.mkdir(os.path.join(self.node.src_dir, "ns-3"))
187 src_dir = os.path.join(self.node.src_dir, "ns-3")
189 super(LinuxNS3Simulation, self).upload_sources(src_dir = src_dir)
191 def upload_extra_sources(self, sources = None, src_dir = None):
192 return super(LinuxNS3Simulation, self).upload_sources(
196 def upload_start_command(self):
197 command = self.get("command")
198 env = self.get("env")
200 # We want to make sure the ccnd is running
201 # before the experiment starts.
202 # Run the command as a bash script in background,
203 # in the host ( but wait until the command has
204 # finished to continue )
205 env = self.replace_paths(env)
206 command = self.replace_paths(command)
208 shfile = os.path.join(self.app_home, "start.sh")
209 self.node.upload_command(command,
215 self._run_in_background()
218 if self.has_changed("simulatorImplementationType"):
219 simu_type = self.get("simulatorImplementationType")
220 stype = self.create("StringValue", simu_type)
221 self.invoke(GLOBAL_VALUE_UUID, "Bind", "SimulatorImplementationType", stype)
223 if self.has_changed("checksumEnabled"):
224 check_sum = self.get("checksumEnabled")
225 btrue = self.create("BooleanValue", check_sum)
226 self.invoke(GLOBAL_VALUE_UUID, "Bind", "ChecksumEnabled", btrue)
228 if self.has_changed("schedulerType"):
229 sched_type = self.get("schedulerType")
230 stype = self.create("StringValue", sched_type)
231 self.invoke(GLOBAL_VALUE_UUID, "Bind", "SchedulerType", btrue)
233 if self.get("enableDCE"):
234 self._dce_manager_helper_uuid = self.create("DceManagerHelper")
235 self._dce_application_helper_uuid = self.create("DceApplicationHelper")
238 if not self.node or self.node.state < ResourceState.READY:
239 self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
241 # ccnd needs to wait until node is deployed and running
242 self.ec.schedule(reschedule_delay, self.deploy)
244 if not self.get("command"):
245 self.set("command", self._start_command)
247 if not self.get("depends"):
248 self.set("depends", self._dependencies)
250 if self.get("sources"):
251 sources = self.get("sources")
252 source = sources.split(" ")[0]
253 basename = os.path.basename(source)
254 version = ( basename.strip().replace(".tar.gz", "")
257 .replace(".zip","") )
259 self.set("ns3Version", version)
260 self.set("sources", source)
262 if not self.get("build"):
263 self.set("build", self._build)
265 if not self.get("install"):
266 self.set("install", self._install)
268 if not self.get("env"):
269 self.set("env", self._environment)
275 self._client = LinuxNS3Client(self)
282 """ Starts simulation execution
285 self.info("Starting")
287 if self.state == ResourceState.READY:
288 if self.get("populateRoutingTables") == True:
289 self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables")
295 msg = " Failed to execute command '%s'" % command
296 self.error(msg, out, err)
297 raise RuntimeError, msg
300 """ Stops simulation execution
303 if self.state == ResourceState.STARTED:
307 def do_release(self):
308 self.info("Releasing resource")
310 tear_down = self.get("tearDown")
312 self.node.execute(tear_down)
315 self._client.shutdown()
316 LinuxApplication.do_stop(self)
318 super(LinuxApplication, self).do_release()
321 def _start_command(self):
324 command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/")
326 command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % \
327 os.path.basename(self.remote_socket) )
329 ns_log = self.get("nsLog")
331 command.append("-L '%s'" % ns_log)
333 if self.get("verbose"):
336 command = " ".join(command)
340 def _dependencies(self):
341 if self.node.use_rpm:
342 return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml unzip")
343 elif self.node.use_deb:
344 return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml unzip")
349 return "http://code.nsnam.org"
352 def pygccxml_version(self):
353 return "pygccxml-1.0.0"
357 #return "http://code.nsnam.org/ns-3-dce"
358 return "http://code.nsnam.org/epmancini/ns-3-dce"
362 # If the user defined local sources for ns-3, we uncompress the sources
363 # on the remote sources directory. Else we clone ns-3 from the official repo.
364 source = self.get("sources")
366 clone_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/ns-3/%(ns3_version)s" \
368 'ns3_version': self.get("ns3Version"),
369 'ns3_repo': self.ns3_repo,
372 if source.find(".tar.gz") > -1:
374 "tar xzf ${SRC}/ns-3/%(basename)s "
375 " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
377 'basename': os.path.basename(source),
378 'ns3_version': self.get("ns3Version"),
380 elif source.find(".tar") > -1:
382 "tar xf ${SRC}/ns-3/%(basename)s "
383 " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
385 'basename': os.path.basename(source),
386 'ns3_version': self.get("ns3Version"),
388 elif source.find(".zip") > -1:
389 basename = os.path.basename(source)
390 bare_basename = basename.replace(".zip", "") \
391 .replace(".tar", "") \
392 .replace(".tar.gz", "")
395 "unzip ${SRC}/ns-3/%(basename)s && "
396 "mv ${SRC}/ns-3/%(bare_basename)s ${SRC}/ns-3/%(ns3_version)s "
398 'bare_basename': basename_name,
399 'basename': basename,
400 'ns3_version': self.get("ns3Version"),
403 clone_dce_cmd = " echo 'DCE will not be built' "
404 if self.get("enableDCE"):
407 # Test if dce is alredy installed
410 " ( test -d ${SRC}/dce/ns-3-dce ) "
411 " && echo 'dce binaries found, nothing to do'"
415 # Get dce source code
417 " mkdir -p ${SRC}/dce && "
418 " hg clone %(dce_repo)s ${SRC}/dce/ns-3-dce"
421 'dce_repo': self.dce_repo
429 # Test if ns-3 is alredy installed
430 " ((( test -d ${SRC}/ns-3/%(ns3_version)s ) || "
431 " ( test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'})) "
432 " && echo 'ns-3 binaries found, nothing to do' )"
435 # If not, install ns-3 and its dependencies
440 " python -c 'import pygccxml' && "
441 " echo 'pygccxml not found' "
445 " tar xf ${SRC}/%(pygccxml_version)s.tar.gz -C ${SRC} && "
446 " cd ${SRC}/%(pygccxml_version)s && "
447 " python setup.py build && "
448 " sudo -S python setup.py install "
455 " test -d ${SRC}/pybindgen/%(pybindgen_version)s && "
456 " echo 'binaries found, nothing to do' "
459 # If not, clone and build
461 " mkdir -p ${SRC}/pybindgen && "
462 " bzr checkout lp:pybindgen -r %(pybindgen_version)s ${SRC}/pybindgen/%(pybindgen_version)s && "
463 " cd ${SRC}/pybindgen/%(pybindgen_version)s && "
464 " ./waf configure && "
469 # Get ns-3 source code
471 " mkdir -p ${SRC}/ns-3/%(ns3_version)s && "
472 " %(clone_ns3_cmd)s "
478 " %(clone_dce_cmd)s "
481 'ns3_version': self.get("ns3Version"),
482 'pybindgen_version': self.get("pybindgenVersion"),
483 'pygccxml_version': self.pygccxml_version,
484 'clone_ns3_cmd': clone_ns3_cmd,
485 'clone_dce_cmd': clone_dce_cmd,
490 install_dce_cmd = " echo 'DCE will not be installed' "
491 if self.get("enableDCE"):
494 " ((test -d %(ns3_build_home)s/bin_dce ) && "
495 " echo 'dce binaries found, nothing to do' )"
499 # If not, copy ns-3 build to bin
500 " cd ${SRC}/dce/ns-3-dce && "
501 " ./waf configure %(enable_opt)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
502 " --prefix=%(ns3_build_home)s --with-ns3=%(ns3_build_home)s && "
505 " mv %(ns3_build_home)s/lib*/python*/site-packages/ns/dce.so %(ns3_build_home)s/lib/python/site-packages/ns/ "
508 'ns3_version': self.get("ns3Version"),
509 'pybindgen_version': self.get("pybindgenVersion"),
510 'ns3_build_home': self.ns3_build_home,
511 'build_mode': self.get("buildMode"),
512 'enable_opt': "--enable-opt" if self.get("buildMode") == "optimized" else ""
516 # Test if ns-3 is alredy installed
519 " ( ( (test -d %(ns3_build_home)s/lib ) || "
520 " (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && "
521 " echo 'binaries found, nothing to do' )"
525 # If not, copy ns-3 build to bin
526 " mkdir -p %(ns3_build_home)s && "
527 " cd ${SRC}/ns-3/%(ns3_version)s && "
528 " ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
529 " --prefix=%(ns3_build_home)s && "
532 " mv %(ns3_build_home)s/lib*/python* %(ns3_build_home)s/lib/python "
537 " %(install_dce_cmd)s "
540 'ns3_version': self.get("ns3Version"),
541 'pybindgen_version': self.get("pybindgenVersion"),
542 'build_mode': self.get("buildMode"),
543 'ns3_build_home': self.ns3_build_home,
544 'install_dce_cmd': install_dce_cmd
548 def _environment(self):
550 env.append("PYTHONPATH=$PYTHONPATH:${NS3BINDINGS:=%(ns3_build_home)s/lib/python/site-packages}" % {
551 'ns3_build_home': self.ns3_build_home
553 # If NS3LIBRARIES is defined and not empty, assign its value,
554 # if not assign ns3_build_home/lib/ to NS3LIBRARIES and LD_LIBARY_PATH
555 env.append("LD_LIBRARY_PATH=${NS3LIBRARIES:=%(ns3_build_home)s/lib}" % {
556 'ns3_build_home': self.ns3_build_home
558 env.append("DCE_PATH=$NS3LIBRARIES/../bin_dce")
559 env.append("DCE_ROOT=$NS3LIBRARIES/..")
563 def replace_paths(self, command):
565 Replace all special path tags with shell-escaped actual paths.
568 .replace("${USR}", self.node.usr_dir)
569 .replace("${LIB}", self.node.lib_dir)
570 .replace("${BIN}", self.node.bin_dir)
571 .replace("${SRC}", self.node.src_dir)
572 .replace("${SHARE}", self.node.share_dir)
573 .replace("${EXP}", self.node.exp_dir)
574 .replace("${EXP_HOME}", self.node.exp_home)
575 .replace("${APP_HOME}", self.app_home)
576 .replace("${RUN_HOME}", self.run_home)
577 .replace("${NODE_HOME}", self.node.node_home)
578 .replace("${HOME}", self.node.home_dir)
579 # If NS3LIBRARIES is defined and not empty, use that value,
580 # if not use ns3_build_home/lib/
581 .replace("${BIN_DCE}", "${NS3LIBRARIES-%s/lib/}../bin_dce" % \
585 def valid_connection(self, guid):