# 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
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
-# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
-# Alexandros Kouvakas <alexandros.kouvakas@gmail.com>
+# Authors: Alina Quereilhac <alina.quereilhac@inria.fr>
+# Alexandros Kouvakas <alexandros.kouvakas@inria.fr>
+# Julien Tribino <julien.tribino@inria.fr>
from nepi.execution.attribute import Attribute, Flags, Types
-from nepi.execution.resource import ResourceManager, clsinit_copy, ResourceState
-from nepi.resources.planetlab.openvswitch.ovs import OVSWitch
+from nepi.execution.resource import ResourceManager, clsinit_copy, \
+ ResourceState
+from nepi.resources.planetlab.openvswitch.ovs import PlanetlabOVSSwitch
from nepi.resources.planetlab.node import PlanetlabNode
from nepi.resources.linux.application import LinuxApplication
-reschedule_delay = "0.5s"
+import os
@clsinit_copy
-class OVSPort(LinuxApplication):
+class PlanetlabOVSPort(LinuxApplication):
"""
.. class:: Class Args :
"""
- _rtype = "OVSPort"
+ _rtype = "planetlab::OVSPort"
_help = "Runs an OpenVSwitch on a PlanetLab host"
- _backend = "planetlab"
+ _platform = "planetlab"
- _authorized_connections = ["OVSWitch", "Tunnel"]
+ _authorized_connections = ["planetlab::OVSSwitch", "linux::UdpTunnel", "linux::Tunnel"]
@classmethod
def _register_attributes(cls):
"""
port_name = Attribute("port_name", "Name of the port",
- flags = Flags.ExecReadOnly)
+ flags = Flags.Design)
+ ip = Attribute("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)
+ network = Attribute("network", "Network used by the port",
+ flags = Flags.Design)
cls._register_attribute(port_name)
+ cls._register_attribute(ip)
+ cls._register_attribute(network)
def __init__(self, ec, guid):
"""
:type guid: int
"""
- super(OVSPort, self).__init__(ec, guid)
+ super(PlanetlabOVSPort, self).__init__(ec, guid)
+ self._home = "ovsport-%s" % self.guid
self._port_number = None
- self.port_info = []
@property
def node(self):
- rm_list = self.get_connected(OVSWitch.rtype())
- if rm_list:
- for elt in rm_list:
- node = elt.get_connected(PlanetlabNode.rtype())
- if node: return node[0]
- return node[0]
+ """ Node that run the switch and the ports
+ """
+ return self.ovsswitch.node
@property
- def ovswitch(self):
- ovswitch = self.get_connected(OVSWitch.rtype())
- if ovswitch: return ovswitch[0]
+ def ovsswitch(self):
+ """ Switch where the port is created
+ """
+ ovsswitch = self.get_connected(PlanetlabOVSSwitch.get_rtype())
+ if ovsswitch: return ovsswitch[0]
return None
@property
return self._port_number
def valid_connection(self, guid):
- # TODO: Validate!
- return True
+ """ Check if the connection is available.
+
+ :param guid: Guid of the current RM
+ :type guid: int
+ :rtype: Boolean
-# def valid_connection(self, guid):
-# """ Check if the connection is available.
-
-# :param guid: Guid of the current RM
-# :type guid: int
-# :rtype: Boolean
-
-# """
-# rm = self.ec.get_resource(guid)
-# if rm.rtype() in self._authorized_connections:
-# msg = "Connection between %s %s and %s %s accepted" % (self.rtype(), self._guid, rm.rtype(), guid)
-# self.debug(msg)
-# return True
-# msg = "Connection between %s %s and %s %s refused" % (self.rtype(), self._guid, rm.rtype(), guid)
-# self.debug(msg)
-
- def get_host_ip(self):
- """ Get the hostname of the node that
- the port belongs to. We use it for tunnel.
"""
- get_host_ip = self.node
- if not get_host_ip:
- msg = "info_list is empty"
- self.debug(msg)
- raise RuntimeError, msg
- import socket
- self.port_info.append(get_host_ip.get('hostname'))
- self.port_info.append(socket.gethostbyname(self.port_info[0]))
-
+ rm = self.ec.get_resource(guid)
+ if rm.get_rtype() not in self._authorized_connections:
+ return False
+
+ return True
+
def create_port(self):
""" Create the desired port
"""
- port_name = self.get('port_name')
- if not (port_name or self.ovswitch):
- msg = "The rm_list is empty or the port name is not assigned\n Failed to create port"
+ msg = "Creating the port %s" % self.get('port_name')
+ self.debug(msg)
+
+ if not self.get('port_name'):
+ msg = "The port name is not assigned"
+ self.error(msg)
+ raise AttributeError(msg)
+
+ if not self.ovsswitch:
+ msg = "The OVSwitch RM is not running"
self.error(msg)
- self.debug("ovswitch_list = %s and port_name = %s" % (self.ovswitch, port_name) )
- raise AttributeError, msg
-
- self.info("Create the port %s on switch %s" % (port_name, self.ovswitch.get('bridge_name')))
- self.port_info.append(port_name)
- self.port_info.append(self.ovswitch.get('virtual_ip_pref'))
- cmd = "sliver-ovs create-port %s %s" % (self.ovswitch.get('bridge_name'), port_name)
- self.node.run(cmd, self.ovswitch.ovs_checks,
- stderr = "stdout-%s" % port_name,
- stdout = "stderr-%s" % port_name,
- sudo = True)
+ raise AttributeError(msg)
+
+ command = "sliver-ovs create-port %s %s" % (
+ self.ovsswitch.get('bridge_name'),
+ self.get('port_name'))
+
+ shfile = os.path.join(self.app_home, "create_port.sh")
+ try:
+ self.node.run_and_wait(command, self.run_home,
+ shfile=shfile,
+ sudo = True,
+ stderr="port_stdout",
+ stdout="port_stderr",
+ pidfile="port_pidfile",
+ ecodefile="port_exitcode")
+ except RuntimeError:
+ msg = "Could not create ovs-port"
+ self.debug(msg)
+ raise RuntimeError(msg)
+
+ self.info("Created port %s on switch %s" % (
+ self.get('port_name'),
+ self.ovsswitch.get('bridge_name')))
- def get_local_end(self):
+ def initiate_udp_connection(self, remote_endpoint, connection_app_home,
+ connection_run_home, cipher, cipher_key, bwlimit, txqueuelen):
""" Get the local_endpoint of the port
"""
- msg = "Discovering the number of the port %s"\
- % self.get('port_name')
+ msg = "Discovering the port number for %s" % self.get('port_name')
self.info(msg)
- command = "sliver-ovs get-local-endpoint %s"\
- % self.get('port_name')
- out = err = ""
- (out, err), proc = self.node.run_and_wait(command, self.ovswitch.ovs_checks,
- shfile = "port_number-%s.sh" % self.get('port_name'),
- pidfile = "port_number_pidfile-%s" % self.get('port_name'),
- ecodefile = "port_number_exitcode-%s" % self.get('port_name'),
- sudo = True,
- stdout = "stdout-%s" % self.get('port_name'),
- stderr = "stderr-%s" % self.get('port_name'))
+ command = "sliver-ovs get-local-endpoint %s" % self.get('port_name')
+
+ shfile = os.path.join(connection_app_home, "get_port.sh")
+ (out, err), proc = self.node.run_and_wait(command, connection_run_home,
+ shfile=shfile,
+ sudo=True,
+ overwrite = True,
+ pidfile="get_port_pidfile",
+ ecodefile="get_port_exitcode",
+ stdout="get_port_stdout",
+ stderr="get_port_stderr")
if err != "":
- msg = "No assignment in attribute port_name"
+ msg = "Error retrieving the local endpoint of the port"
self.error(msg)
- self.debug("You are in the method get_local_end and the port_name = %s" % self.get('port_name'))
- raise AttributeError, msg
- self._port_number = None
- self._port_number = int(out)
- self.port_info.append(self._port_number)
- self.info("The number of the %s is %s" % (self.get('port_name'), self._port_number))
-
- def switch_connect_command(self, local_port_name,
- remote_ip, remote_port_num):
- """ Script for switch links
+ raise RuntimeError(msg)
+
+ if out:
+ self._port_number = out.strip()
+
+ self.info("The number of the %s is %s" % (self.get('port_name'),
+ self.port_number))
+
+ # Must set a routing rule in the ovs client nodes so they know
+ # that the LAN can be found through the switch
+ if remote_endpoint.is_rm_instance("planetlab::Tap"):
+ self._vroute = self.ec.register_resource("planetlab::Vroute")
+ self.ec.set(self._vroute, "action", "add")
+ self.ec.set(self._vroute, "prefix", remote_endpoint.get("prefix"))
+ self.ec.set(self._vroute, "nexthop", remote_endpoint.get("pointopoint"))
+ self.ec.set(self._vroute, "network", self.get("network"))
+
+ self.ec.register_connection(self._vroute, remote_endpoint.guid)
+ self.ec.deploy(guids=[self._vroute], group = self.deployment_group)
+
+ # For debugging
+ msg = "Route for the tap configured"
+ self.debug(msg)
+
+ return self.port_number
+
+ def establish_udp_connection(self, remote_endpoint,
+ connection_app_home,
+ connection_run_home,
+ port):
+ remote_ip = remote_endpoint.node.get("ip")
+ command = self._establish_connection_command(port, remote_ip)
+
+ shfile = os.path.join(connection_app_home, "connect_port.sh")
+ (out, err), proc = self.node.run_and_wait(command, connection_run_home,
+ shfile=shfile,
+ sudo=True,
+ overwrite = True,
+ pidfile="connect_port_pidfile",
+ ecodefile="connect_port_exitcode",
+ stdout="connect_port_stdout",
+ stderr="connect_port_stderr")
+
+ # For debugging
+ msg = "Connection on port configured"
+ self.debug(msg)
+
+ def _establish_connection_command(self, port, remote_ip):
+ """ Script to create the connection from a switch to a
+ remote endpoint
"""
+ local_port_name = self.get('port_name')
+
command = ["sliver-ovs"]
- command.append("set-remote-endpoint ")
- command.append("%s " % local_port_name)
- command.append("%s " % remote_ip)
- command.append("%s " % remote_port_num)
+ command.append("set-remote-endpoint")
+ command.append(local_port_name)
+ command.append(remote_ip)
+ command.append(port)
command = " ".join(command)
command = self.replace_paths(command)
return command
-
- def provision(self):
- """ Provision the ports.No meaning.
- """
- pass
+
+ def verify_connection(self, remote_endpoint, connection_app_home,
+ connection_run_home):
+ self.ovsswitch.ovs_status()
+
+ def terminate_connection(self, endpoint, connection_app_home,
+ connection_run_home):
+ return True
+
+ def check_status(self):
+ return self.node.status(self._pid, self._ppid)
- def discover(self):
- """ Discover the ports.No meaning
- """
- pass
+ def do_provision(self):
+ self.node.mkdir(self.run_home)
- def deploy(self):
- """ Wait until ovswitch is started
+ self.create_port()
+ end_ip = self.ovsswitch.get('virtual_ip_pref').split('/')
+ self.set("ip", end_ip[0])
+
+ #Check the status of the OVS Switch
+ self.ovsswitch.ovs_status()
+
+ self.set_provisioned()
+
+ def do_deploy(self):
+ """ Deploy the OVS port after the OVS Switch
"""
- ovswitch = self.ovswitch
- if not ovswitch or ovswitch.state < ResourceState.READY:
- self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.ovswitch.state )
- self.ec.schedule(reschedule_delay, self.deploy)
-
+ if not self.ovsswitch or self.ovsswitch.state < ResourceState.READY:
+ self.debug("---- RESCHEDULING DEPLOY ---- OVSwitch state %s " % self.ovsswitch.state )
+ self.ec.schedule(self.reschedule_delay, self.deploy)
else:
- try:
- self.discover()
- self.provision()
- self.get_host_ip()
- self.create_port()
- self.get_local_end()
- self.ovswitch.ovs_status()
- self._state = ResourceState.READY
- except:
- self._state = ResourceState.FAILED
- raise
-
- def start(self):
- """ Start the RM. It means nothing special for
- ovsport for now.
- """
- pass
-
- def stop(self):
- """ Stop the RM. It means nothing special for
- ovsport for now.
- """
- pass
-
- def release(self):
- """ Release the port RM means delete the ports
+ self.do_discover()
+ self.do_provision()
+
+ self.set_ready()
+
+ def do_release(self):
+ """ Delete the port on the OVSwitch. It needs to wait for the tunnel
+ to be released.
"""
- # OVS needs to wait until all associated RMs are released
- # to be released
- from nepi.resources.planetlab.openvswitch.tunnel import Tunnel
- rm = self.get_connected(Tunnel.rtype())
- if rm and rm[0].state < ResourceState.FINISHED:
- self.ec.schedule(reschedule_delay, self.release)
+ from nepi.resources.linux.udptunnel import LinuxUdpTunnel
+ rm = self.get_connected(LinuxUdpTunnel.get_rtype())
+
+ if rm and rm[0].state < ResourceState.STOPPED:
+ self.ec.schedule(self.reschedule_delay, self.release)
return
msg = "Deleting the port %s" % self.get('port_name')
self.info(msg)
- cmd = "sliver-ovs del_port %s" % self.get('port_name')
- (out, err), proc = self.node.run(cmd, self.ovswitch.ovs_checks,
- sudo = True)
- if proc.poll():
- self.fail()
- self.error(msg, out, err)
- raise RuntimeError, msg
+ command = "sliver-ovs del_port %s" % self.get('port_name')
+
+ shfile = os.path.join(self.app_home, "stop.sh")
+ self.node.run_and_wait(command, self.run_home,
+ shfile=shfile,
+ sudo=True,
+ pidfile="stop_pidfile",
+ ecodefile="stop_exitcode",
+ stdout="stop_stdout",
+ stderr="stop_stderr")
+
+ super(PlanetlabOVSPort, self).do_release()
- self._state = ResourceState.RELEASED