# Copyright (C) 2013 INRIA
#
# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation;
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
from nepi.execution.attribute import Attribute, Flags, Types
-from nepi.execution.resource import clsinit_copy, ResourceState, \
- reschedule_delay, failtrap
-from nepi.resources.linux.application import LinuxApplication
+from nepi.execution.resource import clsinit_copy, ResourceState
+from nepi.resources.linux.tap import LinuxTap
from nepi.resources.planetlab.node import PlanetlabNode
from nepi.util.timefuncs import tnow, tdiffsec
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"
+class PlanetlabTap(LinuxTap):
+ _rtype = "planetlab::Tap"
_help = "Creates a TAP device on a PlanetLab host"
- _backend = "planetlab"
+ _platform = "planetlab"
@classmethod
def _register_attributes(cls):
- ip4 = Attribute("ip4", "IPv4 Address",
- flags = Flags.ExecReadOnly)
-
- mac = Attribute("mac", "MAC Address",
- flags = Flags.ExecReadOnly)
-
- prefix4 = Attribute("prefix4", "IPv4 network prefix",
- type = Types.Integer,
- flags = Flags.ExecReadOnly)
-
- 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)
-
- 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)
-
- tear_down = Attribute("tearDown", "Bash script to be executed before " + \
- "releasing the resource",
- flags = Flags.ExecReadOnly)
-
- cls._register_attribute(ip4)
- cls._register_attribute(mac)
- cls._register_attribute(prefix4)
- cls._register_attribute(mtu)
- cls._register_attribute(devname)
- cls._register_attribute(up)
cls._register_attribute(snat)
- cls._register_attribute(pointopoint)
- 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):
- # 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)
+
+ # udp-connect python script
+ udp_connect = os.path.join(os.path.dirname(__file__),
+ "..",
+ "linux",
+ "scripts",
+ "linux-udp-connect.py")
+
+ scripts.append(udp_connect)
- # upload vif-connect python script
- pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
- "pl-vif-udp-connect.py")
+ # tunnel creation python script
+ tunchannel = os.path.join(os.path.dirname(__file__),
+ "..",
+ "linux",
+ "scripts",
+ "tunchannel.py")
- self.node.upload(pl_vif_connect,
- os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
- overwrite = False)
+ scripts.append(tunchannel)
- # upload tun-connect python script
- tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
- "scripts", "tunchannel.py")
+ # Upload scripts
+ scripts = ";".join(scripts)
- self.node.upload(tunchannel,
- os.path.join(self.node.src_dir, "tunchannel.py"),
+ 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,
- overwrite = False)
+
+ 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):
super(PlanetlabTap, self).upload_start_command()
- # 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 )
- self._run_in_background()
-
- # Retrive if_name
- if_name = self.wait_if_name()
- self.set("deviceName", if_name)
-
- @failtrap
- def deploy(self):
- if not self.node or self.node.state < ResourceState.PROVISIONED:
- self.ec.schedule(reschedule_delay, self.deploy)
+ # Planetlab TAPs always add a PI header
+ self.set("pi", True)
+
+ if not self.gre_enabled:
+ # 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 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:
+ vif_name = out.strip()
+ break
+ else:
+ time.sleep(delay)
+ delay = delay * 1.5
else:
- if not self.get("command"):
- self.set("command", self._start_command)
+ msg = "Couldn't retrieve vif_name"
+ self.error(msg, out, err)
+ raise RuntimeError, msg
- if not self.get("depends"):
- self.set("depends", self._dependencies)
+ return vif_name
- if not self.get("install"):
- self.set("install", self._install)
+ def gre_connect(self, remote_endpoint, connection_app_home,
+ connection_run_home):
+ super(PlanetlabTap, self).gre_connect(remote_endpoint,
+ connection_app_home, connection_run_home)
+ # 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)
- self.discover()
- self.provision()
+ return True
- self.debug("----- READY ---- ")
- self.set_ready()
+ def _gre_connect_command(self, remote_endpoint, connection_app_home,
+ connection_run_home):
+ # Set the remote endpoint, (private) IP of the device
+ self.set("pointopoint", remote_endpoint.get("ip"))
+ # Public IP of the node
+ self.set("greRemote", remote_endpoint.node.get("ip"))
- @failtrap
- def start(self):
- if self.state == ResourceState.READY:
- command = self.get("command")
- self.info("Starting command '%s'" % command)
+ # Generate GRE connect command
- self.set_started()
- else:
- msg = " Failed to execute command '%s'" % command
- self.error(msg, out, err)
- raise RuntimeError, msg
+ # Use vif_down command to first kill existing TAP in GRE mode
+ vif_down_command = self._vif_down_command
- @failtrap
- def stop(self):
- command = self.get('command') or ''
+ # Use pl-vif-up.py script to configure TAP with peer info
+ vif_up_command = self._vif_up_command
- if self.state == ResourceState.STARTED:
- self.info("Stopping command '%s'" % command)
+ command = ["("]
+ command.append(vif_down_command)
+ command.append(") ; (")
+ command.append(vif_up_command)
+ command.append(")")
- command = "bash %s" % os.path.join(self.app_home, "stop.sh")
- (out, err), proc = self.execute_command(command,
- blocking = True)
+ command = " ".join(command)
+ command = self.replace_paths(command)
- self.set_stopped()
+ return command
@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:
-
- if self.get("deviceName"):
- (out, err), proc = self.node.execute("ifconfig")
-
- if out.strip().find(self.get("deviceName")) == -1:
- # tap is not running is not running (socket not found)
- 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
- try:
- 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
- except:
- import traceback
- err = traceback.format_exc()
- self.error(err)
-
- 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 device """
- if_name = None
- delay = 1.0
-
- for i in xrange(4):
- (out, err), proc = self.node.check_output(self.run_home, "if_name")
-
- if out:
- if_name = out.strip()
- break
- else:
- time.sleep(delay)
- delay = delay * 1.5
+ def _start_command(self):
+ if self.gre_enabled:
+ command = []
else:
- msg = "Couldn't retrieve if_name"
- self.error(msg, out, err)
- raise RuntimeError, msg
+ command = ["sudo -S python ${SRC}/pl-vif-create.py"]
+
+ command.append("-t %s" % self.vif_type)
+ command.append("-a %s" % self.get("ip"))
+ command.append("-n %s" % self.get("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 if_name
+ return " ".join(command)
- 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)
+ @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)
- command = " ".join(command)
- command = self.replace_paths(command)
return command
@property
- def _start_command(self):
- command = ["sudo -S python ${SRC}/pl-vif-create.py"]
-
+ 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("ip4"))
- command.append("-n %d" % self.get("prefix4"))
- command.append("-f %s " % self.if_name_file)
- command.append("-S %s " % self.sock_name)
+ command.append("-a %s" % self.get("ip"))
+ command.append("-n %s" % self.get("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"))
- return " ".join(command)
-
- @property
- def _stop_command(self):
- command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
+ if self.gre_enabled:
+ command.append("-g %s" % self.get("greKey"))
+ command.append("-G %s" % self.get("greRemote"))
- command.append("-S %s " % self.sock_name)
+ command.append("-f %s " % self.vif_name_file)
+
return " ".join(command)
@property
- def vif_type(self):
- return "IFF_TAP"
+ def _vif_down_command(self):
+ if self.gre_enabled:
+ device_name = "%s" % self.guid
+ else:
+ device_name = self.get("deviceName")
- @property
- def if_name_file(self):
- return os.path.join(self.run_home, "if_name")
+ 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")
- @property
- def sock_name(self):
- return os.path.join(self.run_home, "tap.sock")
+ return " ".join(command)
@property
- def _dependencies(self):
- return "mercurial make gcc"
+ def vif_name_file(self):
+ return os.path.join(self.run_home, "vif_name")
@property
def _install(self):
git://git.onelab.eu / nepi.git / blobdiff