src/nepi/resources/planetlab/tap.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from nepi.execution.attribute import Attribute, Flags, Types
  21 from nepi.execution.resource import clsinit_copy, ResourceState, \
  22         reschedule_delay
  23 from nepi.resources.linux.application import LinuxApplication
  24 from nepi.resources.planetlab.node import PlanetlabNode
  25 from nepi.util.timefuncs import tnow, tdiffsec
  26
  27 import os
  28 import time
  29
  30 # TODO: - routes!!!
  31 #       - CREATE GRE - PlanetlabGRE - it only needs to set the gre and remote
  32 #               properties when configuring the vif_up
  33
  34 PYTHON_VSYS_VERSION = "1.0"
  35
  36 @clsinit_copy
  37 class PlanetlabTap(LinuxApplication):
  38     _rtype = "PlanetlabTap"
  39
  40     @classmethod
  41     def _register_attributes(cls):
  42         ip4 = Attribute("ip4", "IPv4 Address",
  43               flags = Flags.ExecReadOnly)
  44
  45         mac = Attribute("mac", "MAC Address",
  46                 flags = Flags.ExecReadOnly)
  47
  48         prefix4 = Attribute("prefix4", "IPv4 network prefix",
  49                 type = Types.Integer,
  50                 flags = Flags.ExecReadOnly)
  51
  52         mtu = Attribute("mtu", "Maximum transmition unit for device",
  53                 type = Types.Integer)
  54
  55         devname = Attribute("deviceName",
  56                 "Name of the network interface (e.g. eth0, wlan0, etc)",
  57                 flags = Flags.ReadOnly)
  58
  59         up = Attribute("up", "Link up",
  60                 type = Types.Bool)
  61
  62         snat = Attribute("snat", "Set SNAT=1",
  63                 type = Types.Bool,
  64                 flags = Flags.ExecReadOnly)
  65
  66         pointopoint = Attribute("pointopoint", "Peer IP address",
  67                 flags = Flags.ExecReadOnly)
  68
  69         tear_down = Attribute("tearDown", "Bash script to be executed before " + \
  70                 "releasing the resource",
  71                 flags = Flags.ExecReadOnly)
  72
  73         cls._register_attribute(ip4)
  74         cls._register_attribute(mac)
  75         cls._register_attribute(prefix4)
  76         cls._register_attribute(mtu)
  77         cls._register_attribute(devname)
  78         cls._register_attribute(up)
  79         cls._register_attribute(snat)
  80         cls._register_attribute(pointopoint)
  81         cls._register_attribute(tear_down)
  82
  83     def __init__(self, ec, guid):
  84         super(PlanetlabTap, self).__init__(ec, guid)
  85         self._home = "tap-%s" % self.guid
  86
  87     @property
  88     def node(self):
  89         node = self.get_connected(PlanetlabNode.rtype())
  90         if node: return node[0]
  91         return None
  92
  93     def upload_sources(self):
  94         # upload vif-creation python script
  95         pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
  96                 "pl-vif-create.py")
  97
  98         self.node.upload(pl_vif_create,
  99                 os.path.join(self.node.src_dir, "pl-vif-create.py"),
 100                 overwrite = False)
 101
 102         # upload vif-stop python script
 103         pl_vif_stop = os.path.join(os.path.dirname(__file__), "scripts",
 104                 "pl-vif-stop.py")
 105
 106         self.node.upload(pl_vif_stop,
 107                 os.path.join(self.node.src_dir, "pl-vif-stop.py"),
 108                 overwrite = False)
 109
 110         # upload vif-connect python script
 111         pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
 112                 "pl-vif-udp-connect.py")
 113
 114         self.node.upload(pl_vif_connect,
 115                 os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
 116                 overwrite = False)
 117
 118         # upload tun-connect python script
 119         tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
 120                 "scripts", "tunchannel.py")
 121
 122         self.node.upload(tunchannel,
 123                 os.path.join(self.node.src_dir, "tunchannel.py"),
 124                 overwrite = False)
 125
 126         # upload stop.sh script
 127         stop_command = self.replace_paths(self._stop_command)
 128         self.node.upload(stop_command,
 129                 os.path.join(self.app_home, "stop.sh"),
 130                 text = True,
 131                 overwrite = False)
 132
 133     def upload_start_command(self):
 134         super(PlanetlabTap, self).upload_start_command()
 135
 136         # We want to make sure the device is up and running
 137         # before the deploy finishes (so things will be ready
 138         # before other stuff starts running).
 139         # Run the command as a bash script in background,
 140         # in the host ( but wait until the command has
 141         # finished to continue )
 142         self._run_in_background()
 143
 144         # Retrive if_name
 145         if_name = self.wait_if_name()
 146         self.set("deviceName", if_name)
 147
 148     def deploy(self):
 149         if not self.node or self.node.state < ResourceState.PROVISIONED:
 150             self.ec.schedule(reschedule_delay, self.deploy)
 151         else:
 152             if not self.get("command"):
 153                 self.set("command", self._start_command)
 154
 155             if not self.get("depends"):
 156                 self.set("depends", self._dependencies)
 157
 158             if not self.get("install"):
 159                 self.set("install", self._install)
 160
 161             try:
 162                 self.discover()
 163                 self.provision()
 164             except:
 165                 self.fail()
 166                 raise
 167
 168             self.debug("----- READY ---- ")
 169             self.set_ready()
 170
 171     def start(self):
 172         if self.state == ResourceState.READY:
 173             command = self.get("command")
 174             self.info("Starting command '%s'" % command)
 175
 176             self.set_started()
 177         else:
 178             msg = " Failed to execute command '%s'" % command
 179             self.error(msg, out, err)
 180             self.fail()
 181             raise RuntimeError, msg
 182
 183     def stop(self):
 184         command = self.get('command') or ''
 185
 186         if self.state == ResourceState.STARTED:
 187             self.info("Stopping command '%s'" % command)
 188
 189             command = "bash %s" % os.path.join(self.app_home, "stop.sh")
 190             (out, err), proc = self.execute_command(command,
 191                     blocking = True)
 192
 193             self.set_stopped()
 194
 195     @property
 196     def state(self):
 197         # First check if the ccnd has failed
 198         state_check_delay = 0.5
 199         if self._state == ResourceState.STARTED and \
 200                 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 201
 202             if self.get("deviceName"):
 203                 (out, err), proc = self.node.execute("ifconfig")
 204
 205                 if out.strip().find(self.get("deviceName")) == -1:
 206                     # tap is not running is not running (socket not found)
 207                     self._finish_time = tnow()
 208                     self._state = ResourceState.FINISHED
 209
 210             self._last_state_check = tnow()
 211
 212         return self._state
 213
 214     def release(self):
 215         # Node needs to wait until all associated RMs are released
 216         # to be released
 217         from nepi.resources.linux.udptunnel import UdpTunnel
 218         rms = self.get_connected(UdpTunnel.rtype())
 219         for rm in rms:
 220             if rm.state < ResourceState.STOPPED:
 221                 self.ec.schedule(reschedule_delay, self.release)
 222                 return
 223
 224         super(PlanetlabTap, self).release()
 225
 226     def wait_if_name(self):
 227         """ Waits until the if_name file for the command is generated,
 228             and returns the if_name for the device """
 229         if_name = None
 230         delay = 1.0
 231
 232         for i in xrange(4):
 233             (out, err), proc = self.node.check_output(self.run_home, "if_name")
 234
 235             if out:
 236                 if_name = out.strip()
 237                 break
 238             else:
 239                 time.sleep(delay)
 240                 delay = delay * 1.5
 241         else:
 242             msg = "Couldn't retrieve if_name"
 243             self.error(msg, out, err)
 244             self.fail()
 245             raise RuntimeError, msg
 246
 247         return if_name
 248
 249     def udp_connect_command(self, remote_ip, local_port_file,
 250             remote_port_file, ret_file, cipher, cipher_key,
 251             bwlimit, txqueuelen):
 252         command = ["sudo -S "]
 253         command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 254         command.append("python ${SRC}/pl-vif-udp-connect.py")
 255         command.append("-t %s" % self.vif_type)
 256         command.append("-S %s " % self.sock_name)
 257         command.append("-l %s " % local_port_file)
 258         command.append("-r %s " % remote_port_file)
 259         command.append("-H %s " % remote_ip)
 260         command.append("-R %s " % ret_file)
 261         if cipher:
 262             command.append("-c %s " % cipher)
 263         if cipher_key:
 264             command.append("-k %s " % cipher_key)
 265         if txqueuelen:
 266             command.append("-q %s " % txqueuelen)
 267         if bwlimit:
 268             command.append("-b %s " % bwlimit)
 269
 270         command = " ".join(command)
 271         command = self.replace_paths(command)
 272         return command
 273
 274     @property
 275     def _start_command(self):
 276         command = ["sudo -S python ${SRC}/pl-vif-create.py"]
 277
 278         command.append("-t %s" % self.vif_type)
 279         command.append("-a %s" % self.get("ip4"))
 280         command.append("-n %d" % self.get("prefix4"))
 281         command.append("-f %s " % self.if_name_file)
 282         command.append("-S %s " % self.sock_name)
 283         if self.get("snat") == True:
 284             command.append("-s")
 285         if self.get("pointopoint"):
 286             command.append("-p %s" % self.get("pointopoint"))
 287
 288         return " ".join(command)
 289
 290     @property
 291     def _stop_command(self):
 292         command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
 293
 294         command.append("-S %s " % self.sock_name)
 295         return " ".join(command)
 296
 297     @property
 298     def vif_type(self):
 299         return "IFF_TAP"
 300
 301     @property
 302     def if_name_file(self):
 303         return os.path.join(self.run_home, "if_name")
 304
 305     @property
 306     def sock_name(self):
 307         return os.path.join(self.run_home, "tap.sock")
 308
 309     @property
 310     def _dependencies(self):
 311         return "mercurial make gcc"
 312
 313     @property
 314     def _install(self):
 315         # Install python-vsys and python-passfd
 316         install_vsys = ( " ( "
 317                     "   python -c 'import vsys, os;  vsys.__version__ == \"%(version)s\" or os._exit(1)' "
 318                     " ) "
 319                     " || "
 320                     " ( "
 321                     "   cd ${SRC} ; "
 322                     "   hg clone http://nepi.inria.fr/code/python-vsys ; "
 323                     "   cd python-vsys ; "
 324                     "   make all ; "
 325                     "   sudo -S make install "
 326                     " )" ) % ({
 327                         "version": PYTHON_VSYS_VERSION
 328                         })
 329
 330         install_passfd = ( " ( python -c 'import passfd' ) "
 331                     " || "
 332                     " ( "
 333                     "   cd ${SRC} ; "
 334                     "   hg clone http://nepi.inria.fr/code/python-passfd ; "
 335                     "   cd python-passfd ; "
 336                     "   make all ; "
 337                     "   sudo -S make install "
 338                     " )" )
 339
 340         return "%s ; %s" % ( install_vsys, install_passfd )
 341
 342     def valid_connection(self, guid):
 343         # TODO: Validate!
 344         return True
 345