X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2Fnepi%2Fresources%2Fplanetlab%2Ftap.py;h=5a47663cf2b7c13b109dce252af82ffa339ec71f;hb=38575a0f27f26511965771dde8320060b10252dd;hp=ed6c2aae5c3bcb0573723d6530817d50a7bee0c7;hpb=a0eefc4e266c584dfa3363e30154b3fdaa5b4f60;p=nepi.git

diff --git a/src/nepi/resources/planetlab/tap.py b/src/nepi/resources/planetlab/tap.py
index ed6c2aae..5a47663c 100644
--- a/src/nepi/resources/planetlab/tap.py
+++ b/src/nepi/resources/planetlab/tap.py
@@ -18,7 +18,7 @@
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
 from nepi.execution.attribute import Attribute, Flags, Types
-from nepi.execution.resource import ResourceManager, clsinit_copy, ResourceState, \
+from nepi.execution.resource import clsinit_copy, ResourceState, \
         reschedule_delay
 from nepi.resources.linux.application import LinuxApplication
 from nepi.resources.planetlab.node import PlanetlabNode
@@ -27,162 +27,217 @@ from nepi.util.timefuncs import tnow, tdiffsec
 import os
 import time
 
-# TODO: - routes!!!
-#       - Make base clase 'virtual device' and redefine vif_type
-#       - Instead of doing an infinite loop, open a port for communication allowing
-#           to pass the fd to another process
-
 PYTHON_VSYS_VERSION = "1.0"
 
 @clsinit_copy
 class PlanetlabTap(LinuxApplication):
     _rtype = "PlanetlabTap"
+    _help = "Creates a TAP device on a PlanetLab host"
+    _backend = "planetlab"
 
     @classmethod
     def _register_attributes(cls):
-        ip4 = Attribute("ip4", "IPv4 Address",
-              flags = Flags.ExecReadOnly)
+        endpoint_ip = Attribute("endpoint_ip", "IP of the endpoint. This is the attribute " 
+                                "you should use to establish a tunnel or a remote "
+                                "connection between endpoint",
+              flags = Flags.Design)
 
         mac = Attribute("mac", "MAC Address",
-                flags = Flags.ExecReadOnly)
+                flags = Flags.Design)
 
-        prefix4 = Attribute("prefix4", "IPv4 network prefix",
-                flags = Flags.ExecReadOnly)
+        endpoint_prefix = Attribute("endpoint_prefix", "IPv4 network prefix of the endpoint",
+                type = Types.Integer,
+                flags = Flags.Design)
 
         mtu = Attribute("mtu", "Maximum transmition unit for device",
                 type = Types.Integer)
 
         devname = Attribute("deviceName", 
                 "Name of the network interface (e.g. eth0, wlan0, etc)",
-                flags = Flags.ReadOnly)
+                flags = Flags.NoWrite)
 
-        up = Attribute("up", "Link up", type = Types.Bool)
+        up = Attribute("up", "Link up", 
+                type = Types.Bool)
         
-        snat = Attribute("snat", "Set SNAT=1", type = Types.Bool,
-                flags = Flags.ReadOnly)
+        snat = Attribute("snat", "Set SNAT=1", 
+                type = Types.Bool,
+                flags = Flags.Design)
         
         pointopoint = Attribute("pointopoint", "Peer IP address", 
-                flags = Flags.ReadOnly)
+                flags = Flags.Design)
+
+        txqueuelen = Attribute("txqueuelen", "Length of transmission queue", 
+                flags = Flags.Design)
+
+        txqueuelen = Attribute("txqueuelen", "Length of transmission queue", 
+                flags = Flags.Design)
+
+        gre_key = Attribute("greKey", 
+                "GRE key to be used to configure GRE tunnel", 
+                default = "1",
+                flags = Flags.Design)
 
-        tear_down = Attribute("tearDown", "Bash script to be executed before " + \
-                "releasing the resource",
-                flags = Flags.ExecReadOnly)
+        gre_remote = Attribute("greRemote", 
+                "Public IP of remote endpoint for GRE tunnel", 
+                flags = Flags.Design)
 
-        cls._register_attribute(ip4)
+        tear_down = Attribute("tearDown", 
+                "Bash script to be executed before releasing the resource",
+                flags = Flags.Design)
+
+        cls._register_attribute(endpoint_ip)
         cls._register_attribute(mac)
-        cls._register_attribute(prefix4)
+        cls._register_attribute(endpoint_prefix)
         cls._register_attribute(mtu)
         cls._register_attribute(devname)
         cls._register_attribute(up)
         cls._register_attribute(snat)
         cls._register_attribute(pointopoint)
+        cls._register_attribute(txqueuelen)
+        cls._register_attribute(gre_key)
+        cls._register_attribute(gre_remote)
         cls._register_attribute(tear_down)
 
     def __init__(self, ec, guid):
         super(PlanetlabTap, self).__init__(ec, guid)
         self._home = "tap-%s" % self.guid
+        self._gre_enabled = False
 
     @property
     def node(self):
-        node = self.get_connected(PlanetlabNode.rtype())
+        node = self.get_connected(PlanetlabNode.get_rtype())
         if node: return node[0]
-        return None
+        raise RuntimeError, "TAP/TUN devices must be connected to Node"
 
-    def upload_sources(self):
-        depends = "mercurial make gcc"
-        self.set("depends", depends)
+    @property
+    def gre_enabled(self):
+        if not self._gre_enabled:
+            from nepi.resources.linux.gretunnel import LinuxGRETunnel
+            gre = self.get_connected(LinuxGRETunnel.get_rtype())
+            if gre: self._gre_enabled = True
 
-        install = ( " ( "
-                    "   python -c 'import vsys, os;  vsys.__version__ == \"%(version)s\" or os._exit(1)' "
-                    " ) "
-                    " ||"
-                    " ( "
-                    "   cd ${SRC} ; "
-                    "   hg clone http://nepi.inria.fr/code/python-vsys ; "
-                    "   cd python-vsys ; "
-                    "   make all ; "
-                    "   sudo -S make install "
-                    " )" ) % ({
-                        "version": PYTHON_VSYS_VERSION
-                        })
+        return self._gre_enabled
 
-        self.set("install", install)
+    def upload_sources(self):
+        scripts = []
 
-    def upload_start_command(self):
-        # upload tap-creation python script
-        start_script = self.replace_paths(self._start_script)
-        self.node.upload(start_script,
-                os.path.join(self.app_home, "tap_create.py"),
-                text = True, 
-                overwrite = False)
+        # vif-creation python script
+        pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
+                "pl-vif-create.py")
 
-        # upload start.sh
-        start_command = self.replace_paths(self._start_command)
+        scripts.append(pl_vif_create)
+        
+        # vif-up python script
+        pl_vif_up = os.path.join(os.path.dirname(__file__), "scripts",
+                "pl-vif-up.py")
+        
+        scripts.append(pl_vif_up)
 
-        self.info("Uploading command '%s'" % start_command)
+        # vif-down python script
+        pl_vif_down = os.path.join(os.path.dirname(__file__), "scripts",
+                "pl-vif-down.py")
         
-        self.set("command", start_command)
-        self.node.upload(start_command,
-                os.path.join(self.app_home, "start.sh"),
-                text = True, 
-                overwrite = False)
+        scripts.append(pl_vif_down)
 
-        # We want to make sure the device is up and running
-        # before the experiment starts.
-        # Run the command as a bash script in background,
-        # in the host ( but wait until the command has
-        # finished to continue )
-        self._run_in_background()
+        # udp-connect python script
+        pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
+                "pl-vif-udp-connect.py")
         
-        # Retrive if_name
-        if_name = self.wait_if_name()
-        self.set("deviceName", if_name) 
+        scripts.append(pl_vif_connect)
+
+        # tunnel creation python script
+        tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
+                "scripts", "tunchannel.py")
+
+        scripts.append(tunchannel)
+
+        # Upload scripts
+        scripts = ";".join(scripts)
+
+        self.node.upload(scripts,
+                os.path.join(self.node.src_dir),
+                overwrite = False)
+
+        # upload stop.sh script
+        stop_command = self.replace_paths(self._stop_command)
 
-    def deploy(self):
+        self.node.upload_command(stop_command,
+                shfile = os.path.join(self.app_home, "stop.sh"),
+                # Overwrite file every time. 
+                # The stop.sh has the path to the socket, which should change
+                # on every experiment run.
+                overwrite = True)
+
+    def upload_start_command(self):
+        # If GRE mode is enabled, TAP creation is delayed until the
+        # tunnel is established
+        if not self.gre_enabled:
+            # Overwrite file every time. 
+            # The start.sh has the path to the socket, wich should change
+            # on every experiment run.
+            super(PlanetlabTap, self).upload_start_command(overwrite = True)
+
+            # We want to make sure the device is up and running
+            # before the deploy finishes, so we execute now the 
+            # start script. We run it in background, because the 
+            # TAP will live for as long as the process that 
+            # created it is running, and wait until the TAP  
+            # is created. 
+            self._run_in_background()
+            
+            # After creating the TAP, the pl-vif-create.py script
+            # will write the name of the TAP to a file. We wait until
+            # we can read the interface name from the file.
+            vif_name = self.wait_vif_name()
+            self.set("deviceName", vif_name) 
+
+    def do_deploy(self):
         if not self.node or self.node.state < ResourceState.PROVISIONED:
             self.ec.schedule(reschedule_delay, self.deploy)
         else:
+            if not self.get("command"):
+                self.set("command", self._start_command)
+
+            if not self.get("depends"):
+                self.set("depends", self._dependencies)
+
+            if not self.get("install"):
+                self.set("install", self._install)
 
-            try:
-                self.discover()
-                self.provision()
-            except:
-                self.fail()
-                raise
- 
-            self.debug("----- READY ---- ")
-            self._ready_time = tnow()
-            self._state = ResourceState.READY
-
-    def start(self):
-        if self._state == ResourceState.READY:
+            self.do_discover()
+            self.do_provision()
+
+            self.set_ready()
+
+    def do_start(self):
+        if self.state == ResourceState.READY:
             command = self.get("command")
             self.info("Starting command '%s'" % command)
 
-            self._start_time = tnow()
-            self._state = ResourceState.STARTED
+            self.set_started()
         else:
             msg = " Failed to execute command '%s'" % command
             self.error(msg, out, err)
-            self._state = ResourceState.FAILED
             raise RuntimeError, msg
 
-    def stop(self):
+    def do_stop(self):
         command = self.get('command') or ''
-        state = self.state
         
-        if state == ResourceState.STARTED:
+        if self.state == ResourceState.STARTED:
             self.info("Stopping command '%s'" % command)
 
-            command = "rm %s" % os.path.join(self.run_home, "if_stop")
-            (out, err), proc = self.execute_command(command)
+            command = "bash %s" % os.path.join(self.app_home, "stop.sh")
+            (out, err), proc = self.execute_command(command,
+                    blocking = True)
 
-            self._stop_time = tnow()
-            self._state = ResourceState.STOPPED
+            if err:
+                msg = " Failed to stop command '%s' " % command
+                self.error(msg, out, err)
+
+            self.set_stopped()
 
     @property
     def state(self):
-        # First check if the ccnd has failed
         state_check_delay = 0.5
         if self._state == ResourceState.STARTED and \
                 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
@@ -192,66 +247,350 @@ class PlanetlabTap(LinuxApplication):
 
                 if out.strip().find(self.get("deviceName")) == -1: 
                     # tap is not running is not running (socket not found)
-                    self._state = ResourceState.FINISHED
+                    self.set_stopped()
 
             self._last_state_check = tnow()
 
         return self._state
 
-    def wait_if_name(self):
-        """ Waits until the if_name file for the command is generated, 
-            and returns the if_name for the devide """
-        if_name = None
-        delay = 1.0
+    def do_release(self):
+        # Node needs to wait until all associated RMs are released
+        # to be released
+        from nepi.resources.linux.tunnel import LinuxTunnel
+        rms = self.get_connected(LinuxTunnel.get_rtype())
+
+        for rm in rms:
+            if rm.state < ResourceState.STOPPED:
+                self.ec.schedule(reschedule_delay, self.release)
+                return 
 
-        for i in xrange(4):
-            (out, err), proc = self.node.check_output(self.run_home, "if_name")
+        super(PlanetlabTap, self).do_release()
+
+    def wait_vif_name(self, exec_run_home = None):
+        """ Waits until the vif_name file for the command is generated, 
+            and returns the vif_name for the device """
+        vif_name = None
+        delay = 0.5
+
+        # The vif_name file will be created in the tap-home, while the
+        # current execution home might be elsewhere to check for errors
+        # (e.g. could be a tunnel-home)
+        if not exec_run_home:
+            exec_run_home = self.run_home
+
+        for i in xrange(20):
+            (out, err), proc = self.node.check_output(self.run_home, "vif_name")
+
+            if proc.poll() > 0:
+                (out, err), proc = self.node.check_errors(exec_run_home)
+                
+                if err.strip():
+                    raise RuntimeError, err
 
             if out:
-                if_name = out.strip()
+                vif_name = out.strip()
                 break
             else:
                 time.sleep(delay)
                 delay = delay * 1.5
         else:
-            msg = "Couldn't retrieve if_name"
+            msg = "Couldn't retrieve vif_name"
             self.error(msg, out, err)
-            self.fail()
             raise RuntimeError, msg
 
-        return if_name
+        return vif_name
+
+    def gre_connect(self, remote_endpoint, connection_app_home,
+            connection_run_home):
+        gre_connect_command = self._gre_connect_command(
+                remote_endpoint, connection_run_home)
+
+        # upload command to connect.sh script
+        shfile = os.path.join(connection_app_home, "gre-connect.sh")
+        self.node.upload_command(gre_connect_command,
+                shfile = shfile,
+                overwrite = False)
+
+        # invoke connect script
+        cmd = "bash %s" % shfile
+        (out, err), proc = self.node.run(cmd, connection_run_home) 
+             
+        # check if execution errors occurred
+        msg = " Failed to connect endpoints "
+        
+        if proc.poll() or err:
+            self.error(msg, out, err)
+            raise RuntimeError, msg
+    
+        # Wait for pid file to be generated
+        pid, ppid = self.node.wait_pid(connection_run_home)
+        
+        # If the process is not running, check for error information
+        # on the remote machine
+        if not pid or not ppid:
+            (out, err), proc = self.node.check_errors(connection_run_home)
+            # Out is what was written in the stderr file
+            if err:
+                msg = " Failed to start command '%s' " % command
+                self.error(msg, out, err)
+                raise RuntimeError, msg
+        
+        # After creating the TAP, the pl-vif-create.py script
+        # will write the name of the TAP to a file. We wait until
+        # we can read the interface name from the file.
+        vif_name = self.wait_vif_name(exec_run_home = connection_run_home)
+        self.set("deviceName", vif_name) 
+
+        return True
+
+    def udp_connect(self, remote_endpoint, connection_app_home, 
+            connection_run_home, cipher, cipher_key, bwlimit, txqueuelen):
+        udp_connect_command = self._udp_connect_command(
+                remote_endpoint, connection_run_home,
+                cipher, cipher_key, bwlimit, txqueuelen)
+
+        # upload command to connect.sh script
+        shfile = os.path.join(connection_app_home, "udp-connect.sh")
+        self.node.upload_command(udp_connect_command,
+                shfile = shfile,
+                overwrite = False)
+
+        # invoke connect script
+        cmd = "bash %s" % shfile
+        (out, err), proc = self.node.run(cmd, connection_run_home) 
+             
+        # check if execution errors occurred
+        msg = "Failed to connect endpoints "
+        
+        if proc.poll():
+            self.error(msg, out, err)
+            raise RuntimeError, msg
+    
+        # Wait for pid file to be generated
+        pid, ppid = self.node.wait_pid(connection_run_home)
+        
+        # If the process is not running, check for error information
+        # on the remote machine
+        if not pid or not ppid:
+            (out, err), proc = self.node.check_errors(connection_run_home)
+            # Out is what was written in the stderr file
+            if err:
+                msg = " Failed to start command '%s' " % command
+                self.error(msg, out, err)
+                raise RuntimeError, msg
+
+        return pid, ppid
+
+    def _udp_connect_command(self, remote_endpoint, connection_run_home, 
+            cipher, cipher_key, bwlimit, txqueuelen):
+
+        # Set the remote endpoint
+        self.set("pointopoint", remote_endpoint.get("endpoint_ip"))
+
+        remote_ip = remote_endpoint.node.get("ip")
+
+        local_port_file = os.path.join(connection_run_home, 
+                "local_port")
+
+        remote_port_file = os.path.join(connection_run_home, 
+                "remote_port")
+
+        ret_file = os.path.join(connection_run_home, 
+                "ret_file")
+
+        # Generate UDP connect command
+        # Use pl-vif-up.py script to configure TAP with peer info
+        vif_up_command = self._vif_up_command
+        
+        command = ["( "]
+        command.append(vif_up_command)
+
+        # Use pl-vid-udp-connect.py to stablish the tunnel between endpoints
+        command.append(") & (")
+        command.append("sudo -S")
+        command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
+        command.append("python ${SRC}/pl-vif-udp-connect.py")
+        command.append("-t %s" % self.vif_type)
+        command.append("-S %s " % self.sock_name)
+        command.append("-l %s " % local_port_file)
+        command.append("-r %s " % remote_port_file)
+        command.append("-H %s " % remote_ip)
+        command.append("-R %s " % ret_file)
+        if cipher:
+            command.append("-c %s " % cipher)
+        if cipher_key:
+            command.append("-k %s " % cipher_key)
+        if txqueuelen:
+            command.append("-q %s " % txqueuelen)
+        if bwlimit:
+            command.append("-b %s " % bwlimit)
+
+        command.append(")")
+
+        command = " ".join(command)
+        command = self.replace_paths(command)
+
+        return command
+
+    def _gre_connect_command(self, remote_endpoint, connection_run_home): 
+        # Set the remote endpoint
+        self.set("pointopoint", remote_endpoint.get("endpoint_ip"))
+        self.set("greRemote", remote_endpoint.node.get("ip"))
+
+        # Generate GRE connect command
+
+        # Use vif_down command to first kill existing TAP in GRE mode
+        vif_down_command = self._vif_down_command
+
+        # Use pl-vif-up.py script to configure TAP with peer info
+        vif_up_command = self._vif_up_command
+        
+        command = ["("]
+        command.append(vif_down_command)
+        command.append(") ; (")
+        command.append(vif_up_command)
+        command.append(")")
+
+        command = " ".join(command)
+        command = self.replace_paths(command)
+
+        return command
 
     @property
     def _start_command(self):
-        return "sudo -S python ${APP_HOME}/tap_create.py" 
+        if self.gre_enabled:
+            command = []
+        else:
+            command = ["sudo -S python ${SRC}/pl-vif-create.py"]
+            
+            command.append("-t %s" % self.vif_type)
+            command.append("-a %s" % self.get("endpoint_ip"))
+            command.append("-n %d" % self.get("endpoint_prefix"))
+            command.append("-f %s " % self.vif_name_file)
+            command.append("-S %s " % self.sock_name)
+
+            if self.get("snat") == True:
+                command.append("-s")
+
+            if self.get("pointopoint"):
+                command.append("-p %s" % self.get("pointopoint"))
+            
+            if self.get("txqueuelen"):
+                command.append("-q %s" % self.get("txqueuelen"))
+
+        return " ".join(command)
+
+    @property
+    def _stop_command(self):
+        if self.gre_enabled:
+            command = self._vif_down_command
+        else:
+            command = ["sudo -S "]
+            command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
+            command.append("python ${SRC}/pl-vif-down.py")
+            command.append("-S %s " % self.sock_name)
+            command = " ".join(command)
+
+        return command
+
+    @property
+    def _vif_up_command(self):
+        if self.gre_enabled:
+            device_name = "%s" % self.guid
+        else:
+            device_name = self.get("deviceName")
+
+        # Use pl-vif-up.py script to configure TAP
+        command = ["sudo -S "]
+        command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
+        command.append("python ${SRC}/pl-vif-up.py")
+        command.append("-u %s" % self.node.get("username"))
+        command.append("-N %s" % device_name)
+        command.append("-t %s" % self.vif_type)
+        command.append("-a %s" % self.get("endpoint_ip"))
+        command.append("-n %d" % self.get("endpoint_prefix"))
+
+        if self.get("snat") == True:
+            command.append("-s")
+
+        if self.get("pointopoint"):
+            command.append("-p %s" % self.get("pointopoint"))
+        
+        if self.get("txqueuelen"):
+            command.append("-q %s" % self.get("txqueuelen"))
+
+        if self.gre_enabled:
+            command.append("-g %s" % self.get("greKey"))
+            command.append("-G %s" % self.get("greRemote"))
+        
+        command.append("-f %s " % self.vif_name_file)
+
+        return " ".join(command)
 
     @property
-    def _start_script(self):
-        return ( "import vsys, time, os \n"
-                 "(fd, if_name) = vsys.fd_tuntap(vsys.%(devtype)s)\n"
-                 "vsys.vif_up(if_name, '%(ip)s', %(prefix)s%(snat)s%(pointopoint)s)\n"
-                 "f = open('%(if_name_file)s', 'w')\n"
-                 "f.write(if_name)\n"
-                 "f.close()\n\n"
-                 "f = open('%(if_stop_file)s', 'w')\n"
-                 "f.close()\n\n"
-                 "while os.path.exists('%(if_stop_file)s'):\n"
-                 "    time.sleep(2)\n"
-               ) % ({
-                   "devtype": self._vif_type,
-                   "ip": self.get("ip4"),
-                   "prefix": self.get("prefix4"),
-                   "snat": ", snat=True" if self.get("snat") else "",
-                   "pointopoint": ", pointopoint=%s" % self.get("pointopoint") \
-                           if self.get("pointopoint") else "",
-                    "if_name_file": os.path.join(self.run_home, "if_name"),
-                    "if_stop_file": os.path.join(self.run_home, "if_stop"),
-                   })
+    def _vif_down_command(self):
+        if self.gre_enabled:
+            device_name = "%s" % self.guid
+        else:
+            device_name = self.get("deviceName")
+
+        command = ["sudo -S "]
+        command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
+        command.append("python ${SRC}/pl-vif-down.py")
+        command.append("-N %s " % device_name)
+        
+        if self.gre_enabled:
+            command.append("-u %s" % self.node.get("username"))
+            command.append("-t %s" % self.vif_type)
+            command.append("-D")
+
+        return " ".join(command)
 
     @property
-    def _vif_type(self):
+    def vif_type(self):
         return "IFF_TAP"
 
+    @property
+    def vif_name_file(self):
+        return os.path.join(self.run_home, "vif_name")
+
+    @property
+    def sock_name(self):
+        return os.path.join(self.run_home, "tap.sock")
+
+    @property
+    def _dependencies(self):
+        return "mercurial make gcc"
+
+    @property
+    def _install(self):
+        # Install python-vsys and python-passfd
+        install_vsys = ( " ( "
+                    "   python -c 'import vsys, os;  vsys.__version__ == \"%(version)s\" or os._exit(1)' "
+                    " ) "
+                    " || "
+                    " ( "
+                    "   cd ${SRC} ; "
+                    "   hg clone http://nepi.inria.fr/code/python-vsys ; "
+                    "   cd python-vsys ; "
+                    "   make all ; "
+                    "   sudo -S make install "
+                    " )" ) % ({
+                        "version": PYTHON_VSYS_VERSION
+                        })
+
+        install_passfd = ( " ( python -c 'import passfd' ) "
+                    " || "
+                    " ( "
+                    "   cd ${SRC} ; "
+                    "   hg clone http://nepi.inria.fr/code/python-passfd ; "
+                    "   cd python-passfd ; "
+                    "   make all ; "
+                    "   sudo -S make install "
+                    " )" )
+
+        return "%s ; %s" % ( install_vsys, install_passfd )
+
     def valid_connection(self, guid):
         # TODO: Validate!
         return True