X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2Fnepi%2Fresources%2Fplanetlab%2Ftap.py;h=5a47663cf2b7c13b109dce252af82ffa339ec71f;hb=38575a0f27f26511965771dde8320060b10252dd;hp=bbfa85a62f0bb7d10e61ed6e6bb5268b612e7fa9;hpb=0fb87d99cce02d9806a4557459e279d96a975b08;p=nepi.git diff --git a/src/nepi/resources/planetlab/tap.py b/src/nepi/resources/planetlab/tap.py index bbfa85a6..5a47663c 100644 --- a/src/nepi/resources/planetlab/tap.py +++ b/src/nepi/resources/planetlab/tap.py @@ -25,13 +25,8 @@ from nepi.resources.planetlab.node import PlanetlabNode from nepi.util.timefuncs import tnow, tdiffsec import os -import socket import time -# TODO: -# - 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 @@ -42,13 +37,15 @@ class PlanetlabTap(LinuxApplication): @classmethod def _register_attributes(cls): - ip4 = Attribute("ip4", "IPv4 Address", + 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.Design) - prefix4 = Attribute("prefix4", "IPv4 network prefix", + endpoint_prefix = Attribute("endpoint_prefix", "IPv4 network prefix of the endpoint", type = Types.Integer, flags = Flags.Design) @@ -69,29 +66,57 @@ class PlanetlabTap(LinuxApplication): pointopoint = Attribute("pointopoint", "Peer IP address", flags = Flags.Design) - tear_down = Attribute("tearDown", "Bash script to be executed before " + \ - "releasing the resource", + 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) + + gre_remote = Attribute("greRemote", + "Public IP of remote endpoint for GRE tunnel", + flags = Flags.Design) + + tear_down = Attribute("tearDown", + "Bash script to be executed before releasing the resource", flags = Flags.Design) - cls._register_attribute(ip4) + 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.get_rtype()) if node: return node[0] - return None + raise RuntimeError, "TAP/TUN devices must be connected to Node" + + @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 + + return self._gre_enabled def upload_sources(self): scripts = [] @@ -136,33 +161,35 @@ class PlanetlabTap(LinuxApplication): # 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, + 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, wich should change + # The stop.sh has the path to the socket, which should change # on every experiment run. overwrite = True) def upload_start_command(self): - # 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) + # 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: @@ -211,7 +238,6 @@ class PlanetlabTap(LinuxApplication): @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: @@ -240,17 +266,23 @@ class PlanetlabTap(LinuxApplication): super(PlanetlabTap, self).do_release() - def wait_vif_name(self): + 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(self.run_home) + (out, err), proc = self.node.check_errors(exec_run_home) if err.strip(): raise RuntimeError, err @@ -268,12 +300,94 @@ class PlanetlabTap(LinuxApplication): return vif_name - def udp_connect_command(self, remote_endpoint, connection_run_home, + 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): - # Generate UDP connect command - remote_ip = socket.gethostbyname( - remote_endpoint.node.get("hostname")) + # 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") @@ -284,17 +398,12 @@ class PlanetlabTap(LinuxApplication): 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 - 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")) + 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(") & (") @@ -323,29 +432,118 @@ class PlanetlabTap(LinuxApplication): 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): - command = ["sudo -S python ${SRC}/pl-vif-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("ip4")) - command.append("-n %d" % self.get("prefix4")) - command.append("-f %s " % self.vif_name_file) - command.append("-S %s " % self.sock_name) + 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 _stop_command(self): - command = ["sudo -S python ${SRC}/pl-vif-down.py"] + 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) - command.append("-S %s " % self.sock_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