Omitting explicit setting of pointopoint attribute for PlanetLab TAP/TUN devices
[nepi.git] / src / nepi / resources / planetlab / tap.py
index b6b1744..bbfa85a 100644 (file)
@@ -25,9 +25,10 @@ from nepi.resources.planetlab.node import PlanetlabNode
 from nepi.util.timefuncs import tnow, tdiffsec
 
 import os
+import socket
 import time
 
-# TODO: - routes!!!
+# TODO:
 #       - CREATE GRE - PlanetlabGRE - it only needs to set the gre and remote
 #               properties when configuring the vif_up
 
@@ -42,35 +43,35 @@ class PlanetlabTap(LinuxApplication):
     @classmethod
     def _register_attributes(cls):
         ip4 = Attribute("ip4", "IPv4 Address",
-              flags = Flags.ExecReadOnly)
+              flags = Flags.Design)
 
         mac = Attribute("mac", "MAC Address",
-                flags = Flags.ExecReadOnly)
+                flags = Flags.Design)
 
         prefix4 = Attribute("prefix4", "IPv4 network prefix",
                 type = Types.Integer,
-                flags = Flags.ExecReadOnly)
+                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)
         
         snat = Attribute("snat", "Set SNAT=1", 
                 type = Types.Bool,
-                flags = Flags.ExecReadOnly)
+                flags = Flags.Design)
         
         pointopoint = Attribute("pointopoint", "Peer IP address", 
-                flags = Flags.ExecReadOnly)
+                flags = Flags.Design)
 
         tear_down = Attribute("tearDown", "Bash script to be executed before " + \
                 "releasing the resource",
-                flags = Flags.ExecReadOnly)
+                flags = Flags.Design)
 
         cls._register_attribute(ip4)
         cls._register_attribute(mac)
@@ -93,40 +94,48 @@ class PlanetlabTap(LinuxApplication):
         return None
 
     def upload_sources(self):
-        # upload vif-creation python script
+        scripts = []
+
+        # vif-creation python script
         pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
                 "pl-vif-create.py")
 
-        self.node.upload(pl_vif_create,
-                os.path.join(self.node.src_dir, "pl-vif-create.py"),
-                overwrite = False)
-
-        # upload vif-stop python script
-        pl_vif_stop = os.path.join(os.path.dirname(__file__), "scripts",
-                "pl-vif-stop.py")
+        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.node.upload(pl_vif_stop,
-                os.path.join(self.node.src_dir, "pl-vif-stop.py"),
-                overwrite = False)
+        # vif-down python script
+        pl_vif_down = os.path.join(os.path.dirname(__file__), "scripts",
+                "pl-vif-down.py")
+        
+        scripts.append(pl_vif_down)
 
-        # upload vif-connect python script
+        # udp-connect python script
         pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
                 "pl-vif-udp-connect.py")
+        
+        scripts.append(pl_vif_connect)
 
-        self.node.upload(pl_vif_connect,
-                os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
-                overwrite = False)
-
-        # upload tun-connect python script
+        # tunnel creation python script
         tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
                 "scripts", "tunchannel.py")
 
-        self.node.upload(tunchannel,
-                os.path.join(self.node.src_dir, "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)
+
         self.node.upload(stop_command,
                 os.path.join(self.app_home, "stop.sh"),
                 text = True,
@@ -137,21 +146,23 @@ class PlanetlabTap(LinuxApplication):
 
     def upload_start_command(self):
         # Overwrite file every time. 
-        # The stop.sh has the path to the socket, wich should change
+        # 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 things will be ready
-        # before other stuff starts running).
-        # Run the command as a bash script in background,
-        # in the host ( but wait until the command has
-        # finished to continue )
+        # 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()
         
-        # Retrive if_name
-        if_name = self.wait_if_name()
-        self.set("deviceName", if_name) 
+        # 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:
@@ -169,7 +180,6 @@ class PlanetlabTap(LinuxApplication):
             self.do_discover()
             self.do_provision()
 
-            self.debug("----- READY ---- ")
             self.set_ready()
 
     def do_start(self):
@@ -193,6 +203,10 @@ class PlanetlabTap(LinuxApplication):
             (out, err), proc = self.execute_command(command,
                     blocking = True)
 
+            if err:
+                msg = " Failed to stop command '%s' " % command
+                self.error(msg, out, err)
+
             self.set_stopped()
 
     @property
@@ -216,8 +230,9 @@ class PlanetlabTap(LinuxApplication):
     def do_release(self):
         # Node needs to wait until all associated RMs are released
         # to be released
-        from nepi.resources.linux.udptunnel import UdpTunnel
-        rms = self.get_connected(UdpTunnel.get_rtype())
+        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)
@@ -225,32 +240,65 @@ class PlanetlabTap(LinuxApplication):
 
         super(PlanetlabTap, self).do_release()
 
-    def wait_if_name(self):
-        """ Waits until the if_name file for the command is generated, 
-            and returns the if_name for the device """
-        if_name = None
-        delay = 1.0
+    def wait_vif_name(self):
+        """ 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
+
+        for i in xrange(20):
+            (out, err), proc = self.node.check_output(self.run_home, "vif_name")
 
-        for i in xrange(10):
-            (out, err), proc = self.node.check_output(self.run_home, "if_name")
+            if proc.poll() > 0:
+                (out, err), proc = self.node.check_errors(self.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)
             raise RuntimeError, msg
 
-        return if_name
+        return vif_name
 
-    def udp_connect_command(self, remote_ip, local_port_file, 
-            remote_port_file, ret_file, cipher, cipher_key,
-            bwlimit, txqueuelen):
-        command = ["sudo -S "]
+    def udp_connect_command(self, remote_endpoint, connection_run_home, 
+            cipher, cipher_key, bwlimit, txqueuelen):
+
+        # Generate UDP connect command
+        remote_ip = socket.gethostbyname(
+                remote_endpoint.node.get("hostname"))
+
+        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")
+
+        # Use pl-vif-up.py script to configure TAP with peer info
+        command = ["( sudo -S "]
+        command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
+        command.append("python ${SRC}/pl-vif-up.py")
+        command.append("-N %s" % self.get("deviceName"))
+        command.append("-t %s" % self.vif_type)
+        command.append("-a %s" % self.get("ip4"))
+        command.append("-n %d" % self.get("prefix4"))
+        if self.get("snat") == True:
+            command.append("-s")
+        command.append("-p %s" % remote_endpoint.get("ip4"))
+
+        # 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)
@@ -268,8 +316,11 @@ class PlanetlabTap(LinuxApplication):
         if bwlimit:
             command.append("-b %s " % bwlimit)
 
+        command.append(")")
+
         command = " ".join(command)
         command = self.replace_paths(command)
+
         return command
 
     @property
@@ -279,10 +330,12 @@ class PlanetlabTap(LinuxApplication):
         command.append("-t %s" % self.vif_type)
         command.append("-a %s" % self.get("ip4"))
         command.append("-n %d" % self.get("prefix4"))
-        command.append("-f %s " % self.if_name_file)
+        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"))
 
@@ -290,7 +343,7 @@ class PlanetlabTap(LinuxApplication):
 
     @property
     def _stop_command(self):
-        command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
+        command = ["sudo -S python ${SRC}/pl-vif-down.py"]
         
         command.append("-S %s " % self.sock_name)
         return " ".join(command)
@@ -300,8 +353,8 @@ class PlanetlabTap(LinuxApplication):
         return "IFF_TAP"
 
     @property
-    def if_name_file(self):
-        return os.path.join(self.run_home, "if_name")
+    def vif_name_file(self):
+        return os.path.join(self.run_home, "vif_name")
 
     @property
     def sock_name(self):