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, ResourceFactory, 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
35 ## TODO: Clean up DCE part. All that is DCE specific should go
36 ## in the linux ns3dceapplication.py
39 class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
40 _rtype = "LinuxNS3Simulation"
43 def _register_attributes(cls):
44 impl_type = Attribute("simulatorImplementationType",
45 "The object class to use as the simulator implementation",
46 allowed = ["ns3::DefaultSimulatorImpl", "ns3::RealtimeSimulatorImpl"],
47 default = "ns3::DefaultSimulatorImpl",
48 type = Types.Enumerate,
51 sched_type = Attribute("schedulerType",
52 "The object class to use as the scheduler implementation",
53 allowed = ["ns3::MapScheduler",
57 "ns3::CalendarScheduler"
59 default = "ns3::MapScheduler",
60 type = Types.Enumerate,
63 check_sum = Attribute("checksumEnabled",
64 "A global switch to enable all checksums for all protocols",
69 ns_log = Attribute("nsLog",
70 "NS_LOG environment variable. " \
71 " Will only generate output if ns-3 is compiled in DEBUG mode. ",
74 verbose = Attribute("verbose",
75 "True to output debugging info from the ns3 client-server communication",
79 enable_dump = Attribute("enableDump",
80 "Enable dumping the remote executed ns-3 commands to a script "
81 "in order to later reproduce and debug the experiment",
86 build_mode = Attribute("buildMode",
87 "Mode used to build ns-3 with waf. One if: debug, release, oprimized ",
88 default = "optimized",
89 allowed = ["debug", "release", "optimized"],
90 type = Types.Enumerate,
93 ns3_version = Attribute("ns3Version",
94 "Version of ns-3 to install from nsam repo",
97 #default = "ns-3-dev",
100 pybindgen_version = Attribute("pybindgenVersion",
101 "Version of pybindgen to install from bazar repo",
105 flags = Flags.Design)
107 dce_version = Attribute("dceVersion",
108 "Version of dce to install from nsam repo (tag branch for repo)",
110 #default = "dce-dev",
111 flags = Flags.Design)
113 populate_routing_tables = Attribute("populateRoutingTables",
114 "Invokes Ipv4GlobalRoutingHelper.PopulateRoutingTables() ",
117 flags = Flags.Design)
119 stoptime = Attribute("stopTime",
120 "Time at which the simulation will stop",
121 flags = Flags.Design)
123 cls._register_attribute(impl_type)
124 cls._register_attribute(sched_type)
125 cls._register_attribute(check_sum)
126 cls._register_attribute(ns_log)
127 cls._register_attribute(enable_dump)
128 cls._register_attribute(verbose)
129 cls._register_attribute(build_mode)
130 cls._register_attribute(ns3_version)
131 cls._register_attribute(pybindgen_version)
132 cls._register_attribute(dce_version)
133 cls._register_attribute(populate_routing_tables)
134 cls._register_attribute(stoptime)
136 def __init__(self, ec, guid):
137 LinuxApplication.__init__(self, ec, guid)
138 NS3Simulation.__init__(self)
141 self._home = "ns3-simu-%s" % self.guid
142 self._socket_name = "ns3-%s.sock" % os.urandom(4).encode('hex')
143 self._dce_manager_helper_uuid = None
144 self._dce_application_helper_uuid = None
145 self._enable_dce = None
148 def socket_name(self):
149 return self._socket_name
152 def remote_socket(self):
153 return os.path.join(self.run_home, self.socket_name)
156 def ns3_build_home(self):
157 return os.path.join(self.node.bin_dir, "ns-3", self.get("ns3Version"),
158 self.get("buildMode"), "build")
160 def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
161 # stout needs to get flushed on the ns-3 server side, else we will
162 # get an empty stream. We try twice to retrieve the stream
163 # if we get empty stdout since the stream might not be
164 # flushed immediately.
165 if name.endswith("stdout"):
167 result = LinuxApplication.trace(self, name, attr, block, offset)
170 # Let the stream be flushed
173 return LinuxApplication.trace(self, name, attr, block, offset)
175 def upload_sources(self):
176 self.node.mkdir(os.path.join(self.node.src_dir, "ns3wrapper"))
178 # upload ns3 wrapper python script
179 ns3_wrapper = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
182 self.node.upload(ns3_wrapper,
183 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper.py"),
186 # upload ns3 wrapper debug python script
187 ns3_wrapper_debug = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
188 "ns3wrapper_debug.py")
190 self.node.upload(ns3_wrapper_debug,
191 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper_debug.py"),
194 # upload ns3_server python script
195 ns3_server = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
198 self.node.upload(ns3_server,
199 os.path.join(self.node.src_dir, "ns3wrapper", "ns3server.py"),
202 if self.node.use_rpm:
203 # upload pygccxml sources
204 pygccxml_tar = os.path.join(os.path.dirname(__file__), "dependencies",
205 "%s.tar.gz" % self.pygccxml_version)
207 self.node.upload(pygccxml_tar,
208 os.path.join(self.node.src_dir, "%s.tar.gz" % self.pygccxml_version),
211 # Upload user defined ns-3 sources
212 self.node.mkdir(os.path.join(self.node.src_dir, "ns-3"))
213 src_dir = os.path.join(self.node.src_dir, "ns-3")
215 super(LinuxNS3Simulation, self).upload_sources(src_dir = src_dir)
217 def upload_extra_sources(self, sources = None, src_dir = None):
218 return super(LinuxNS3Simulation, self).upload_sources(
222 def upload_start_command(self):
223 command = self.get("command")
224 env = self.get("env")
226 # We want to make sure the ccnd is running
227 # before the experiment starts.
228 # Run the command as a bash script in background,
229 # in the host ( but wait until the command has
230 # finished to continue )
231 env = self.replace_paths(env)
232 command = self.replace_paths(command)
234 shfile = os.path.join(self.app_home, "start.sh")
235 self.node.upload_command(command,
241 self._run_in_background()
243 # Wait until the remote socket is created
244 self.wait_remote_socket()
247 if self.has_changed("simulatorImplementationType"):
248 simu_type = self.get("simulatorImplementationType")
249 stype = self.create("StringValue", simu_type)
250 self.invoke(GLOBAL_VALUE_UUID, "Bind", "SimulatorImplementationType", stype)
252 if self.has_changed("checksumEnabled"):
253 check_sum = self.get("checksumEnabled")
254 btrue = self.create("BooleanValue", check_sum)
255 self.invoke(GLOBAL_VALUE_UUID, "Bind", "ChecksumEnabled", btrue)
257 if self.has_changed("schedulerType"):
258 sched_type = self.get("schedulerType")
259 stype = self.create("StringValue", sched_type)
260 self.invoke(GLOBAL_VALUE_UUID, "Bind", "SchedulerType", btrue)
263 if not self.node or self.node.state < ResourceState.READY:
264 self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
266 # ccnd needs to wait until node is deployed and running
267 self.ec.schedule(reschedule_delay, self.deploy)
269 if not self.get("command"):
270 self.set("command", self._start_command)
272 if not self.get("depends"):
273 self.set("depends", self._dependencies)
275 if self.get("sources"):
276 sources = self.get("sources")
277 source = sources.split(" ")[0]
278 basename = os.path.basename(source)
279 version = ( basename.strip().replace(".tar.gz", "")
282 .replace(".zip","") )
284 self.set("ns3Version", version)
285 self.set("sources", source)
287 if not self.get("build"):
288 self.set("build", self._build)
290 if not self.get("install"):
291 self.set("install", self._install)
293 if not self.get("env"):
294 self.set("env", self._environment)
300 self._client = LinuxNS3Client(self)
307 """ Starts simulation execution
310 self.info("Starting")
312 if self.state == ResourceState.READY:
313 if self.get("populateRoutingTables") == True:
314 self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables")
319 # XXX: IS THIS REALLY NEEDED??!!!
320 # Wait until the Simulation is actually started...
322 for i in xrange(1000):
323 is_running = self.invoke(SIMULATOR_UUID, "isRunning")
324 is_finished = self.invoke(SIMULATOR_UUID, "isFinished")
326 if is_running or is_finished:
332 msg = " Simulation did not start"
338 msg = " Failed to execute command '%s'" % command
339 self.error(msg, out, err)
340 raise RuntimeError, msg
343 """ Stops simulation execution
346 if self.state == ResourceState.STARTED:
348 if self.get("stopTime"):
349 time = self.get("stopTime")
351 self._client.stop(time=time)
354 def do_release(self):
355 self.info("Releasing resource")
357 tear_down = self.get("tearDown")
359 self.node.execute(tear_down)
362 self._client.shutdown()
363 LinuxApplication.do_stop(self)
365 super(LinuxApplication, self).do_release()
368 def enable_dce(self):
369 if self._enable_dce is None:
370 from nepi.resources.ns3.ns3dceapplication import NS3BaseDceApplication
371 rclass = ResourceFactory.get_resource_type(
372 NS3BaseDceApplication.get_rtype())
374 self._enable_dce = False
375 for guid in self.ec.resources:
376 rm = self.ec.get_resource(guid)
377 if isinstance(rm, rclass):
378 self._enable_dce = True
381 return self._enable_dce
384 def _start_command(self):
387 command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/")
389 command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % \
390 os.path.basename(self.remote_socket) )
392 ns_log = self.get("nsLog")
394 command.append("-L '%s'" % ns_log)
396 if self.get("enableDump"):
399 if self.get("verbose"):
402 command = " ".join(command)
406 def _dependencies(self):
407 if self.node.use_rpm:
408 return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml unzip")
409 elif self.node.use_deb:
410 return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml unzip")
415 return "http://code.nsnam.org"
418 def pygccxml_version(self):
419 return "pygccxml-1.0.0"
423 return "http://code.nsnam.org/ns-3-dce"
424 #eturn "http://code.nsnam.org/epmancini/ns-3-dce"
427 def dce_version(self):
428 dce_version = self.get("dceVersion")
429 return dce_version or "dce-dev"
433 # If the user defined local sources for ns-3, we uncompress the sources
434 # on the remote sources directory. Else we clone ns-3 from the official repo.
435 source = self.get("sources")
437 clone_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/ns-3/%(ns3_version)s" \
439 'ns3_version': self.get("ns3Version"),
440 'ns3_repo': self.ns3_repo,
443 if source.find(".tar.gz") > -1:
445 "tar xzf ${SRC}/ns-3/%(basename)s "
446 " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
448 'basename': os.path.basename(source),
449 'ns3_version': self.get("ns3Version"),
451 elif source.find(".tar") > -1:
453 "tar xf ${SRC}/ns-3/%(basename)s "
454 " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
456 'basename': os.path.basename(source),
457 'ns3_version': self.get("ns3Version"),
459 elif source.find(".zip") > -1:
460 basename = os.path.basename(source)
461 bare_basename = basename.replace(".zip", "") \
462 .replace(".tar", "") \
463 .replace(".tar.gz", "")
466 "unzip ${SRC}/ns-3/%(basename)s && "
467 "mv ${SRC}/ns-3/%(bare_basename)s ${SRC}/ns-3/%(ns3_version)s "
469 'bare_basename': basename_name,
470 'basename': basename,
471 'ns3_version': self.get("ns3Version"),
474 clone_dce_cmd = " echo 'DCE will not be built' "
476 dce_version = self.dce_version
478 if dce_version != "dce-dev":
479 dce_tag = "-r %s" % dce_version
483 # Test if dce is alredy installed
486 " ( test -d ${SRC}/dce/ns-3-dce/%(dce_version)s ) "
487 " && echo 'dce binaries found, nothing to do'"
491 # Get dce source code
493 " mkdir -p ${SRC}/dce/%(dce_version)s && "
494 " hg clone %(dce_repo)s %(dce_tag)s ${SRC}/dce/ns-3-dce/%(dce_version)s"
497 "dce_repo": self.dce_repo,
499 "dce_version": dce_version,
506 # Test if ns-3 is alredy installed
507 " ((( test -d ${SRC}/ns-3/%(ns3_version)s ) || "
508 " ( test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'})) "
509 " && echo 'ns-3 binaries found, nothing to do' )"
512 # If not, install ns-3 and its dependencies
517 " python -c 'import pygccxml' && "
518 " echo 'pygccxml not found' "
522 " tar xf ${SRC}/%(pygccxml_version)s.tar.gz -C ${SRC} && "
523 " cd ${SRC}/%(pygccxml_version)s && "
524 " python setup.py build && "
525 " sudo -S python setup.py install "
532 " test -d ${SRC}/pybindgen/%(pybindgen_version)s && "
533 " echo 'binaries found, nothing to do' "
536 # If not, clone and build
538 " mkdir -p ${SRC}/pybindgen && "
539 " bzr checkout lp:pybindgen -r %(pybindgen_version)s ${SRC}/pybindgen/%(pybindgen_version)s && "
540 " cd ${SRC}/pybindgen/%(pybindgen_version)s && "
541 " ./waf configure && "
546 # Get ns-3 source code
548 " mkdir -p ${SRC}/ns-3/%(ns3_version)s && "
549 " %(clone_ns3_cmd)s "
555 " %(clone_dce_cmd)s "
558 'ns3_version': self.get("ns3Version"),
559 'pybindgen_version': self.get("pybindgenVersion"),
560 'pygccxml_version': self.pygccxml_version,
561 'clone_ns3_cmd': clone_ns3_cmd,
562 'clone_dce_cmd': clone_dce_cmd,
567 install_dce_cmd = " echo 'DCE will not be installed' "
571 " ((test -d %(ns3_build_home)s/bin_dce/%(dce_version)s ) && "
572 " echo 'dce binaries found, nothing to do' )"
576 # If not, copy ns-3 build to bin
577 " cd ${SRC}/dce/ns-3-dce/%(dce_version)s && "
578 " rm -rf ${SRC}/dce/ns-3-dce/%(dce_version)s/build && "
579 " ./waf configure %(enable_opt)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
580 " --prefix=%(ns3_build_home)s --with-ns3=%(ns3_build_home)s && "
583 " mv %(ns3_build_home)s/lib*/python*/site-packages/ns/dce.so %(ns3_build_home)s/lib/python/site-packages/ns/ "
586 "ns3_version": self.get("ns3Version"),
587 "pybindgen_version": self.get("pybindgenVersion"),
588 "ns3_build_home": self.ns3_build_home,
589 "build_mode": self.get("buildMode"),
590 "enable_opt": "--enable-opt" if self.get("buildMode") == "optimized" else "",
591 "dce_version": self.dce_version,
595 # Test if ns-3 is alredy installed
598 " ( ( (test -d %(ns3_build_home)s/lib ) || "
599 " (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && "
600 " echo 'binaries found, nothing to do' )"
604 # If not, copy ns-3 build to bin
605 " mkdir -p %(ns3_build_home)s && "
606 " cd ${SRC}/ns-3/%(ns3_version)s && "
607 " rm -rf ${SRC}/ns-3/%(ns3_version)s/build && "
608 " ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
609 " --prefix=%(ns3_build_home)s && "
612 " mv %(ns3_build_home)s/lib*/python* %(ns3_build_home)s/lib/python "
617 " %(install_dce_cmd)s "
620 'ns3_version': self.get("ns3Version"),
621 'pybindgen_version': self.get("pybindgenVersion"),
622 'build_mode': self.get("buildMode"),
623 'ns3_build_home': self.ns3_build_home,
624 'install_dce_cmd': install_dce_cmd
628 def _environment(self):
630 env.append("PYTHONPATH=$PYTHONPATH:${NS3BINDINGS:=%(ns3_build_home)s/lib/python/site-packages}" % {
631 'ns3_build_home': self.ns3_build_home
633 # If NS3LIBRARIES is defined and not empty, assign its value,
634 # if not assign ns3_build_home/lib/ to NS3LIBRARIES and LD_LIBARY_PATH
635 env.append("LD_LIBRARY_PATH=${NS3LIBRARIES:=%(ns3_build_home)s/lib}" % {
636 'ns3_build_home': self.ns3_build_home
638 env.append("DCE_PATH=$NS3LIBRARIES/../bin_dce")
639 env.append("DCE_ROOT=$NS3LIBRARIES/..")
643 def replace_paths(self, command):
645 Replace all special path tags with shell-escaped actual paths.
648 .replace("${USR}", self.node.usr_dir)
649 .replace("${LIB}", self.node.lib_dir)
650 .replace("${BIN}", self.node.bin_dir)
651 .replace("${SRC}", self.node.src_dir)
652 .replace("${SHARE}", self.node.share_dir)
653 .replace("${EXP}", self.node.exp_dir)
654 .replace("${EXP_HOME}", self.node.exp_home)
655 .replace("${APP_HOME}", self.app_home)
656 .replace("${RUN_HOME}", self.run_home)
657 .replace("${NODE_HOME}", self.node.node_home)
658 .replace("${HOME}", self.node.home_dir)
659 # If NS3LIBRARIES is defined and not empty, use that value,
660 # if not use ns3_build_home/lib/
661 .replace("${BIN_DCE}", "${NS3LIBRARIES-%s/lib}/../bin_dce" % \
665 def valid_connection(self, guid):
669 def wait_remote_socket(self):
670 """ Waits until the remote socket is created
672 command = " [ -e %s ] && echo 'DONE' " % self.remote_socket
674 for i in xrange(200):
675 (out, err), proc = self.node.execute(command, retry = 1,
678 if out.find("DONE") > -1:
681 raise RuntimeError("Remote socket not found at %s" % \