ns-3 wifi example examples/linux/ns3/wifi_ping.py
[nepi.git] / src / nepi / resources / linux / ns3 / ns3simulation.py
index 9ce8291..0f94c4c 100644 (file)
@@ -20,7 +20,7 @@
 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
@@ -30,6 +30,10 @@ 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):
@@ -72,21 +76,30 @@ 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 = "release", 
+            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.19", 
+            default = "ns-3-dev", 
             flags = Flags.Design)
 
         pybindgen_version = Attribute("pybindgenVersion",
             "Version of pybindgen to install from bazar repo",
-            default = "834", 
+            #default = "864", 
+            default = "868", 
             flags = Flags.Design)
 
         populate_routing_tables = Attribute("populateRoutingTables",
@@ -99,6 +112,7 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
         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)
@@ -111,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):
@@ -121,6 +138,11 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
     def remote_socket(self):
         return os.path.join(self.run_home, self.socket_name)
 
+    @property
+    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() 
         return LinuxApplication.trace(self, name, attr, block, offset)
@@ -136,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")
@@ -158,6 +188,11 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
         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")
@@ -195,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 )
@@ -250,7 +285,26 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
             if self.get("populateRoutingTables") == True:
                 self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables")
 
-            self._client.start() 
+            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:
@@ -279,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")
@@ -312,56 +387,83 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
     def pygccxml_version(self):
         return "pygccxml-1.0.0"
 
+    @property
+    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:
-            copy_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/ns-3/%(ns3_version)s" \
-                    % ({
+            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:
-                copy_ns3_cmd = ( 
+                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:
-                copy_ns3_cmd = ( 
+                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", "")
 
-                copy_ns3_cmd = ( 
+                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}/ns-3/%(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
@@ -401,54 +503,121 @@ class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
                 # Get ns-3 source code
                 "  ( "
                 "     mkdir -p ${SRC}/ns-3/%(ns3_version)s && "
-                "     %(copy_ns3_cmd)s "
+                "     %(clone_ns3_cmd)s "
                 "  ) "
                 " ) "
-             ) % ({ 
+                ") "
+                " && "
+                "( "
+                "   %(clone_dce_cmd)s "
+                ") "
+             ) % { 
                     'ns3_version': self.get("ns3Version"),
                     'pybindgen_version': self.get("pybindgenVersion"),
                     'pygccxml_version': self.pygccxml_version,
-                    'copy_ns3_cmd': copy_ns3_cmd,
-                 })
+                    '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}/ns-3/%(ns3_version)s/%(build_mode)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 %(ns3_build_home)s && "
                 "  cd ${SRC}/ns-3/%(ns3_version)s && "
-                "  ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s && "
-                "  ./waf && "
-                "  mkdir -p ${BIN}/ns-3/%(ns3_version)s/%(build_mode)s && "
-                "  mv ${SRC}/ns-3/%(ns3_version)s/build ${BIN}/ns-3/%(ns3_version)s/%(build_mode)s/build "
+                "  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 "
                 " )"
-             ) % ({ 
+                ") "
+                " && "
+                "( "
+                "   %(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}/ns-3/%(ns3_version)s/%(build_mode)s/build/bindings/python/}" % ({ 
-                    'ns3_version': self.get("ns3Version"),
-                    'build_mode': self.get("buildMode")
-                 }))
-        env.append("NS3LIBRARIES=${NS3LIBRARIES:=${BIN}/ns-3/%(ns3_version)s/%(build_mode)s/build/}" % ({ 
-                    'ns3_version': self.get("ns3Version"),
-                    'build_mode': self.get("buildMode")
-                 }))
+        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