X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;ds=sidebyside;f=src%2Fnepi%2Fresources%2Flinux%2Fns3%2Fns3simulation.py;h=0f94c4cb93a7f5d273e85f5b4849ee2a737977bf;hb=64fdda7bf665776fb043b355e989502e6c367a0c;hp=d73e7382506e41ef5b3f49bcec8b92d64eb5f360;hpb=04094716c3ff011e697e1e8871328a4a06aab83d;p=nepi.git diff --git a/src/nepi/resources/linux/ns3/ns3simulation.py b/src/nepi/resources/linux/ns3/ns3simulation.py index d73e7382..0f94c4cb 100644 --- a/src/nepi/resources/linux/ns3/ns3simulation.py +++ b/src/nepi/resources/linux/ns3/ns3simulation.py @@ -20,15 +20,20 @@ from nepi.execution.attribute import Attribute, Flags, Types from nepi.execution.trace import Trace, TraceAttr from nepi.execution.resource import ResourceManager, clsinit_copy, \ - ResourceState, reschedule_delay + ResourceState, ResourceFactory, reschedule_delay from nepi.resources.linux.application import LinuxApplication from nepi.util.timefuncs import tnow, tdiffsec from nepi.resources.ns3.ns3simulation import NS3Simulation -from nepi.resources.ns3.ns3wrapper import SIMULATOR_UUID, GLOBAL_VALUE_UUID +from nepi.resources.ns3.ns3wrapper import SIMULATOR_UUID, GLOBAL_VALUE_UUID, \ + IPV4_GLOBAL_ROUTING_HELPER_UUID from nepi.resources.linux.ns3.ns3client import LinuxNS3Client import os import time +import threading + +## TODO: Clean up DCE part. All that is DCE specific should go +## in the linux ns3dceapplication.py @clsinit_copy class LinuxNS3Simulation(LinuxApplication, NS3Simulation): @@ -71,11 +76,48 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): type = Types.Bool, flags = Flags.Design) + enable_dump = Attribute("enableDump", + "Enable dumping the remote executed ns-3 commands to a script " + "in order to later reproduce and debug the experiment", + type = Types.Bool, + default = False, + flags = Flags.Design) + + build_mode = Attribute("buildMode", + "Mode used to build ns-3 with waf. One if: debug, release, oprimized ", + default = "optimized", + allowed = ["debug", "release", "optimized"], + type = Types.Enumerate, + flags = Flags.Design) + + ns3_version = Attribute("ns3Version", + "Version of ns-3 to install from nsam repo", + #default = "ns-3.19", + default = "ns-3-dev", + flags = Flags.Design) + + pybindgen_version = Attribute("pybindgenVersion", + "Version of pybindgen to install from bazar repo", + #default = "864", + default = "868", + flags = Flags.Design) + + populate_routing_tables = Attribute("populateRoutingTables", + "Invokes Ipv4GlobalRoutingHelper.PopulateRoutingTables() ", + default = False, + type = Types.Bool, + flags = Flags.Design) + cls._register_attribute(impl_type) cls._register_attribute(sched_type) cls._register_attribute(check_sum) cls._register_attribute(ns_log) + cls._register_attribute(enable_dump) cls._register_attribute(verbose) + cls._register_attribute(build_mode) + cls._register_attribute(ns3_version) + cls._register_attribute(pybindgen_version) + cls._register_attribute(populate_routing_tables) def __init__(self, ec, guid): LinuxApplication.__init__(self, ec, guid) @@ -83,7 +125,10 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): self._client = None self._home = "ns3-simu-%s" % self.guid - self._socket_name = "ns3simu-%s" % os.urandom(8).encode('hex') + self._socket_name = "ns3-%s.sock" % os.urandom(4).encode('hex') + self._dce_manager_helper_uuid = None + self._dce_application_helper_uuid = None + self._enable_dce = None @property def socket_name(self): @@ -94,11 +139,9 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): return os.path.join(self.run_home, self.socket_name) @property - def local_socket(self): - if self.node.get('hostname') in ['localhost', '127.0.0.01']: - return self.remote_socket - - return os.path.join("/", "tmp", self.socket_name) + def ns3_build_home(self): + return os.path.join(self.node.bin_dir, "ns-3", self.get("ns3Version"), + self.get("buildMode"), "build") def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0): self._client.flush() @@ -115,6 +158,14 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper.py"), overwrite = False) + # upload ns3 wrapper debug python script + ns3_wrapper_debug = os.path.join(os.path.dirname(__file__), "..", "..", "ns3", + "ns3wrapper_debug.py") + + self.node.upload(ns3_wrapper_debug, + os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper_debug.py"), + overwrite = False) + # upload ns3_server python script ns3_server = os.path.join(os.path.dirname(__file__), "..", "..", "ns3", "ns3server.py") @@ -132,6 +183,17 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): os.path.join(self.node.src_dir, "%s.tar.gz" % self.pygccxml_version), overwrite = False) + # Upload user defined ns-3 sources + self.node.mkdir(os.path.join(self.node.src_dir, "ns-3")) + src_dir = os.path.join(self.node.src_dir, "ns-3") + + super(LinuxNS3Simulation, self).upload_sources(src_dir = src_dir) + + def upload_extra_sources(self, sources = None, src_dir = None): + return super(LinuxNS3Simulation, self).upload_sources( + sources = sources, + src_dir = src_dir) + def upload_start_command(self): command = self.get("command") env = self.get("env") @@ -168,7 +230,7 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): sched_type = self.get("schedulerType") stype = self.create("StringValue", sched_type) self.invoke(GLOBAL_VALUE_UUID, "Bind", "SchedulerType", btrue) - + def do_deploy(self): if not self.node or self.node.state < ResourceState.READY: self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state ) @@ -182,6 +244,18 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): if not self.get("depends"): self.set("depends", self._dependencies) + if self.get("sources"): + sources = self.get("sources") + source = sources.split(" ")[0] + basename = os.path.basename(source) + version = ( basename.strip().replace(".tar.gz", "") + .replace(".tar","") + .replace(".gz","") + .replace(".zip","") ) + + self.set("ns3Version", version) + self.set("sources", source) + if not self.get("build"): self.set("build", self._build) @@ -196,15 +270,6 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): # Create client self._client = LinuxNS3Client(self) - - # Wait until local socket is created - for i in [1, 5, 15, 30, 60]: - if os.path.exists(self.local_socket): - break - time.sleep(i) - - if not os.path.exists(self.local_socket): - raise RuntimeError("Problem starting socat") self.configure() @@ -217,7 +282,29 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): self.info("Starting") if self.state == ResourceState.READY: - self._client.start() + if self.get("populateRoutingTables") == True: + self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables") + + self._client.start() + + """ + # XXX: IS THIS REALLY NEEDED?? + # Wait until the Simulation is actually started... + + is_running = False + for i in xrange(1000): + is_running = self.invoke(SIMULATOR_UUID, "isRunning") + + if is_running: + break + else: + time.sleep(1) + else: + if not is_running: + msg = " Simulation did not start" + self.error(msg) + raise RuntimeError + """ self.set_started() else: @@ -246,16 +333,37 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): super(LinuxApplication, self).do_release() + @property + def enable_dce(self): + if self._enable_dce is None: + from nepi.resources.ns3.ns3dceapplication import NS3BaseDceApplication + rclass = ResourceFactory.get_resource_type( + NS3BaseDceApplication.get_rtype()) + + self._enable_dce = False + for guid in self.ec.resources: + rm = self.ec.get_resource(guid) + if isinstance(rm, rclass): + self._enable_dce = True + break + + return self._enable_dce + @property def _start_command(self): command = [] - command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/") - command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % self.remote_socket ) + command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/") + + command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % \ + os.path.basename(self.remote_socket) ) ns_log = self.get("nsLog") if ns_log: - command.append("-L %s" % ns_log) + command.append("-L '%s'" % ns_log) + + if self.get("enableDump"): + command.append("-D") if self.get("verbose"): command.append("-v") @@ -266,35 +374,96 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): @property def _dependencies(self): if self.node.use_rpm: - return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml") + return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml unzip") elif self.node.use_deb: - return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml") + return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml unzip") return "" @property def ns3_repo(self): - return "http://code.nsnam.org" - - @property - def ns3_version(self): - return "ns-3.19" + return "http://code.nsnam.org" @property - def pybindgen_version(self): - return "834" + def pygccxml_version(self): + return "pygccxml-1.0.0" @property - def pygccxml_version(self): - return "pygccxml-1.0.0" + def dce_repo(self): + return "http://code.nsnam.org/ns-3-dce" + #eturn "http://code.nsnam.org/epmancini/ns-3-dce" @property def _build(self): + # If the user defined local sources for ns-3, we uncompress the sources + # on the remote sources directory. Else we clone ns-3 from the official repo. + source = self.get("sources") + if not source: + clone_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/ns-3/%(ns3_version)s" \ + % { + 'ns3_version': self.get("ns3Version"), + 'ns3_repo': self.ns3_repo, + } + else: + if source.find(".tar.gz") > -1: + clone_ns3_cmd = ( + "tar xzf ${SRC}/ns-3/%(basename)s " + " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s " + ) % { + 'basename': os.path.basename(source), + 'ns3_version': self.get("ns3Version"), + } + elif source.find(".tar") > -1: + clone_ns3_cmd = ( + "tar xf ${SRC}/ns-3/%(basename)s " + " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s " + ) % { + 'basename': os.path.basename(source), + 'ns3_version': self.get("ns3Version"), + } + elif source.find(".zip") > -1: + basename = os.path.basename(source) + bare_basename = basename.replace(".zip", "") \ + .replace(".tar", "") \ + .replace(".tar.gz", "") + + clone_ns3_cmd = ( + "unzip ${SRC}/ns-3/%(basename)s && " + "mv ${SRC}/ns-3/%(bare_basename)s ${SRC}/ns-3/%(ns3_version)s " + ) % { + 'bare_basename': basename_name, + 'basename': basename, + 'ns3_version': self.get("ns3Version"), + } + + clone_dce_cmd = " echo 'DCE will not be built' " + if self.enable_dce: + clone_dce_cmd = ( + # DCE installation + # Test if dce is alredy installed + " ( " + " ( " + " ( test -d ${SRC}/dce/ns-3-dce ) " + " && echo 'dce binaries found, nothing to do'" + " ) " + " ) " + " || " + # Get dce source code + " ( " + " mkdir -p ${SRC}/dce && " + " hg clone %(dce_repo)s ${SRC}/dce/ns-3-dce" + " ) " + ) % { + 'dce_repo': self.dce_repo + } + return ( - # Test if ns-3 is alredy installed + # NS3 installation + "( " " ( " - " (( " - " ( test -d ${SRC}/%(ns3_version)s ) || (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && " - " echo 'binaries found, nothing to do' )" + # Test if ns-3 is alredy installed + " ((( test -d ${SRC}/ns-3/%(ns3_version)s ) || " + " ( test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'})) " + " && echo 'ns-3 binaries found, nothing to do' )" " ) " " || " # If not, install ns-3 and its dependencies @@ -309,6 +478,7 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): " ( " " tar xf ${SRC}/%(pygccxml_version)s.tar.gz -C ${SRC} && " " cd ${SRC}/%(pygccxml_version)s && " + " python setup.py build && " " sudo -S python setup.py install " " ) " " ) " @@ -316,65 +486,138 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation): " && " " ( " " ( " - " test -d ${BIN}/pybindgen && " + " test -d ${SRC}/pybindgen/%(pybindgen_version)s && " " echo 'binaries found, nothing to do' " " ) " " || " # If not, clone and build " ( cd ${SRC} && " - " bzr checkout lp:pybindgen -r %(pybindgen_version)s && " - " cd ${SRC}/pybindgen && " + " mkdir -p ${SRC}/pybindgen && " + " bzr checkout lp:pybindgen -r %(pybindgen_version)s ${SRC}/pybindgen/%(pybindgen_version)s && " + " cd ${SRC}/pybindgen/%(pybindgen_version)s && " " ./waf configure && " " ./waf " " ) " " ) " - " && " - # Clone and build ns-3 + " && " + # Get ns-3 source code " ( " - " hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/%(ns3_version)s && " - " cd ${SRC}/%(ns3_version)s && " - " ./waf configure -d optimized && " - " ./waf " - " ) " + " mkdir -p ${SRC}/ns-3/%(ns3_version)s && " + " %(clone_ns3_cmd)s " + " ) " " ) " - ) % ({ - 'ns3_repo': self.ns3_repo, - 'ns3_version': self.ns3_version, - 'pybindgen_version': self.pybindgen_version, - 'pygccxml_version': self.pygccxml_version - }) + ") " + " && " + "( " + " %(clone_dce_cmd)s " + ") " + ) % { + 'ns3_version': self.get("ns3Version"), + 'pybindgen_version': self.get("pybindgenVersion"), + 'pygccxml_version': self.pygccxml_version, + 'clone_ns3_cmd': clone_ns3_cmd, + 'clone_dce_cmd': clone_dce_cmd, + } @property def _install(self): + install_dce_cmd = " echo 'DCE will not be installed' " + if self.enable_dce: + install_dce_cmd = ( + " ( " + " ((test -d %(ns3_build_home)s/bin_dce ) && " + " echo 'dce binaries found, nothing to do' )" + " ) " + " ||" + " ( " + # If not, copy ns-3 build to bin + " cd ${SRC}/dce/ns-3-dce && " + " rm -rf ${SRC}/dce/ns-3-dce/build && " + " ./waf configure %(enable_opt)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s " + " --prefix=%(ns3_build_home)s --with-ns3=%(ns3_build_home)s && " + " ./waf build && " + " ./waf install && " + " mv %(ns3_build_home)s/lib*/python*/site-packages/ns/dce.so %(ns3_build_home)s/lib/python/site-packages/ns/ " + " )" + ) % { + 'ns3_version': self.get("ns3Version"), + 'pybindgen_version': self.get("pybindgenVersion"), + 'ns3_build_home': self.ns3_build_home, + 'build_mode': self.get("buildMode"), + 'enable_opt': "--enable-opt" if self.get("buildMode") == "optimized" else "" + } + return ( - # Test if ns-3 is alredy cloned + # Test if ns-3 is alredy installed + "(" " ( " - " ( ( (test -d ${BIN}/%(ns3_version)s/build ) || " + " ( ( (test -d %(ns3_build_home)s/lib ) || " " (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && " " echo 'binaries found, nothing to do' )" " ) " " ||" " ( " # If not, copy ns-3 build to bin - " mkdir -p ${BIN}/%(ns3_version)s && " - " mv ${SRC}/%(ns3_version)s/build ${BIN}/%(ns3_version)s/build " + " mkdir -p %(ns3_build_home)s && " + " cd ${SRC}/ns-3/%(ns3_version)s && " + " rm -rf ${SRC}/ns-3/%(ns3_version)s/build && " + " ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s " + " --prefix=%(ns3_build_home)s && " + " ./waf build && " + " ./waf install && " + " mv %(ns3_build_home)s/lib*/python* %(ns3_build_home)s/lib/python " " )" - ) % ({ - 'ns3_version': self.ns3_version - }) + ") " + " && " + "( " + " %(install_dce_cmd)s " + ") " + ) % { + 'ns3_version': self.get("ns3Version"), + 'pybindgen_version': self.get("pybindgenVersion"), + 'build_mode': self.get("buildMode"), + 'ns3_build_home': self.ns3_build_home, + 'install_dce_cmd': install_dce_cmd + } @property def _environment(self): env = [] - env.append("NS3BINDINGS=${NS3BINDINGS:=${BIN}/%(ns3_version)s/build/bindings/python/}" % ({ - 'ns3_version': self.ns3_version, - })) - env.append("NS3LIBRARIES=${NS3LIBRARIES:=${BIN}/%(ns3_version)s/build/}" % ({ - 'ns3_version': self.ns3_version, - })) + env.append("PYTHONPATH=$PYTHONPATH:${NS3BINDINGS:=%(ns3_build_home)s/lib/python/site-packages}" % { + 'ns3_build_home': self.ns3_build_home + }) + # If NS3LIBRARIES is defined and not empty, assign its value, + # if not assign ns3_build_home/lib/ to NS3LIBRARIES and LD_LIBARY_PATH + env.append("LD_LIBRARY_PATH=${NS3LIBRARIES:=%(ns3_build_home)s/lib}" % { + 'ns3_build_home': self.ns3_build_home + }) + env.append("DCE_PATH=$NS3LIBRARIES/../bin_dce") + env.append("DCE_ROOT=$NS3LIBRARIES/..") return " ".join(env) + def replace_paths(self, command): + """ + Replace all special path tags with shell-escaped actual paths. + """ + return ( command + .replace("${USR}", self.node.usr_dir) + .replace("${LIB}", self.node.lib_dir) + .replace("${BIN}", self.node.bin_dir) + .replace("${SRC}", self.node.src_dir) + .replace("${SHARE}", self.node.share_dir) + .replace("${EXP}", self.node.exp_dir) + .replace("${EXP_HOME}", self.node.exp_home) + .replace("${APP_HOME}", self.app_home) + .replace("${RUN_HOME}", self.run_home) + .replace("${NODE_HOME}", self.node.node_home) + .replace("${HOME}", self.node.home_dir) + # If NS3LIBRARIES is defined and not empty, use that value, + # if not use ns3_build_home/lib/ + .replace("${BIN_DCE}", "${NS3LIBRARIES-%s/lib}/../bin_dce" % \ + self.ns3_build_home) + ) + def valid_connection(self, guid): # TODO: Validate! return True