ec_shutdown
[nepi.git] / src / nepi / resources / planetlab / tap.py
index 54d1863..991fa99 100644 (file)
@@ -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
@@ -28,12 +28,16 @@ import os
 import time
 
 # TODO: - routes!!!
+#       - CREATE GRE - PlanetlabGRE - it only needs to set the gre and remote
+#               properties when configuring the vif_up
 
 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):
@@ -54,13 +58,15 @@ class PlanetlabTap(LinuxApplication):
                 "Name of the network interface (e.g. eth0, wlan0, etc)",
                 flags = Flags.ReadOnly)
 
-        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.ExecReadOnly)
         
         pointopoint = Attribute("pointopoint", "Peer IP address", 
-                flags = Flags.ReadOnly)
+                flags = Flags.ExecReadOnly)
 
         tear_down = Attribute("tearDown", "Bash script to be executed before " + \
                 "releasing the resource",
@@ -92,7 +98,7 @@ class PlanetlabTap(LinuxApplication):
                 "pl-vif-create.py")
 
         self.node.upload(pl_vif_create,
-                os.path.join(self.app_home, "pl-vif-create.py"),
+                os.path.join(self.node.src_dir, "pl-vif-create.py"),
                 overwrite = False)
 
         # upload vif-stop python script
@@ -100,23 +106,23 @@ class PlanetlabTap(LinuxApplication):
                 "pl-vif-stop.py")
 
         self.node.upload(pl_vif_stop,
-                os.path.join(self.app_home, "pl-vif-stop.py"),
+                os.path.join(self.node.src_dir, "pl-vif-stop.py"),
                 overwrite = False)
 
         # upload vif-connect python script
         pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
-                "pl-vif-tunconnect.py")
+                "pl-vif-udp-connect.py")
 
         self.node.upload(pl_vif_connect,
-                os.path.join(self.app_home, "pl-vif-connect.py"),
+                os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
                 overwrite = False)
 
         # upload tun-connect python script
-        tunchannel = os.path.join(os.path.dirname(__file__), "..", "all", "scripts",
-                "tunchannel.py")
+        tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
+                "scripts", "tunchannel.py")
 
         self.node.upload(tunchannel,
-                os.path.join(self.app_home, "tunchannel.py"),
+                os.path.join(self.node.src_dir, "tunchannel.py"),
                 overwrite = False)
 
         # upload stop.sh script
@@ -159,38 +165,33 @@ class PlanetlabTap(LinuxApplication):
                 self.provision()
             except:
                 self.fail()
-                raise
+                return
+
             self.debug("----- READY ---- ")
-            self._ready_time = tnow()
-            self._state = ResourceState.READY
+            self.set_ready()
 
     def start(self):
-        if self._state == ResourceState.READY:
+        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
+            self.fail()
 
     def 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 = "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
+            self.set_stopped()
 
     @property
     def state(self):
@@ -204,15 +205,27 @@ 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.finish()
 
             self._last_state_check = tnow()
 
         return self._state
 
+    def 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.rtype())
+        for rm in rms:
+            if rm.state < ResourceState.STOPPED:
+                self.ec.schedule(reschedule_delay, self.release)
+                return 
+
+        super(PlanetlabTap, self).release()
+
     def wait_if_name(self):
         """ Waits until the if_name file for the command is generated, 
-            and returns the if_name for the devide """
+            and returns the if_name for the device """
         if_name = None
         delay = 1.0
 
@@ -228,14 +241,38 @@ class PlanetlabTap(LinuxApplication):
         else:
             msg = "Couldn't retrieve if_name"
             self.error(msg, out, err)
-            self.fail()
             raise RuntimeError, msg
 
         return if_name
 
+    def udp_connect_command(self, remote_ip, local_port_file, 
+            remote_port_file, ret_file, cipher, cipher_key,
+            bwlimit, txqueuelen):
+        command = ["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 = " ".join(command)
+        command = self.replace_paths(command)
+        return command
+
     @property
     def _start_command(self):
-        command = ["sudo -S python ${APP_HOME}/pl-vif-create.py"]
+        command = ["sudo -S python ${SRC}/pl-vif-create.py"]
         
         command.append("-t %s" % self.vif_type)
         command.append("-a %s" % self.get("ip4"))
@@ -251,7 +288,7 @@ class PlanetlabTap(LinuxApplication):
 
     @property
     def _stop_command(self):
-        command = ["sudo -S python ${APP_HOME}/pl-vif-stop.py"]
+        command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
         
         command.append("-S %s " % self.sock_name)
         return " ".join(command)
@@ -274,6 +311,7 @@ class PlanetlabTap(LinuxApplication):
 
     @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)' "
                     " ) "