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     _help = "Creates a TAP device on a PlanetLab host"
  40     _backend = "planetlab"
  41
  42     @classmethod
  43     def _register_attributes(cls):
  44         ip4 = Attribute("ip4", "IPv4 Address",
  45               flags = Flags.ExecReadOnly)
  46
  47         mac = Attribute("mac", "MAC Address",
  48                 flags = Flags.ExecReadOnly)
  49
  50         prefix4 = Attribute("prefix4", "IPv4 network prefix",
  51                 type = Types.Integer,
  52                 flags = Flags.ExecReadOnly)
  53
  54         mtu = Attribute("mtu", "Maximum transmition unit for device",
  55                 type = Types.Integer)
  56
  57         devname = Attribute("deviceName",
  58                 "Name of the network interface (e.g. eth0, wlan0, etc)",
  59                 flags = Flags.ReadOnly)
  60
  61         up = Attribute("up", "Link up",
  62                 type = Types.Bool)
  63
  64         snat = Attribute("snat", "Set SNAT=1",
  65                 type = Types.Bool,
  66                 flags = Flags.ExecReadOnly)
  67
  68         pointopoint = Attribute("pointopoint", "Peer IP address",
  69                 flags = Flags.ExecReadOnly)
  70
  71         tear_down = Attribute("tearDown", "Bash script to be executed before " + \
  72                 "releasing the resource",
  73                 flags = Flags.ExecReadOnly)
  74
  75         cls._register_attribute(ip4)
  76         cls._register_attribute(mac)
  77         cls._register_attribute(prefix4)
  78         cls._register_attribute(mtu)
  79         cls._register_attribute(devname)
  80         cls._register_attribute(up)
  81         cls._register_attribute(snat)
  82         cls._register_attribute(pointopoint)
  83         cls._register_attribute(tear_down)
  84
  85     def __init__(self, ec, guid):
  86         super(PlanetlabTap, self).__init__(ec, guid)
  87         self._home = "tap-%s" % self.guid
  88
  89     @property
  90     def node(self):
  91         node = self.get_connected(PlanetlabNode.rtype())
  92         if node: return node[0]
  93         return None
  94
  95     def upload_sources(self):
  96         # upload vif-creation python script
  97         pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
  98                 "pl-vif-create.py")
  99
 100         self.node.upload(pl_vif_create,
 101                 os.path.join(self.node.src_dir, "pl-vif-create.py"),
 102                 overwrite = False)
 103
 104         # upload vif-stop python script
 105         pl_vif_stop = os.path.join(os.path.dirname(__file__), "scripts",
 106                 "pl-vif-stop.py")
 107
 108         self.node.upload(pl_vif_stop,
 109                 os.path.join(self.node.src_dir, "pl-vif-stop.py"),
 110                 overwrite = False)
 111
 112         # upload vif-connect python script
 113         pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
 114                 "pl-vif-udp-connect.py")
 115
 116         self.node.upload(pl_vif_connect,
 117                 os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
 118                 overwrite = False)
 119
 120         # upload tun-connect python script
 121         tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
 122                 "scripts", "tunchannel.py")
 123
 124         self.node.upload(tunchannel,
 125                 os.path.join(self.node.src_dir, "tunchannel.py"),
 126                 overwrite = False)
 127
 128         # upload stop.sh script
 129         stop_command = self.replace_paths(self._stop_command)
 130         self.node.upload(stop_command,
 131                 os.path.join(self.app_home, "stop.sh"),
 132                 text = True,
 133                 overwrite = False)
 134
 135     def upload_start_command(self):
 136         super(PlanetlabTap, self).upload_start_command()
 137
 138         # We want to make sure the device is up and running
 139         # before the deploy finishes (so things will be ready
 140         # before other stuff starts running).
 141         # Run the command as a bash script in background,
 142         # in the host ( but wait until the command has
 143         # finished to continue )
 144         self._run_in_background()
 145
 146         # Retrive if_name
 147         if_name = self.wait_if_name()
 148         self.set("deviceName", if_name)
 149
 150     def deploy(self):
 151         if not self.node or self.node.state < ResourceState.PROVISIONED:
 152             self.ec.schedule(reschedule_delay, self.deploy)
 153         else:
 154             if not self.get("command"):
 155                 self.set("command", self._start_command)
 156
 157             if not self.get("depends"):
 158                 self.set("depends", self._dependencies)
 159
 160             if not self.get("install"):
 161                 self.set("install", self._install)
 162
 163             try:
 164                 self.discover()
 165                 self.provision()
 166             except:
 167                 self.fail()
 168                 return
 169
 170             self.debug("----- READY ---- ")
 171             self.set_ready()
 172
 173     def start(self):
 174         if self.state == ResourceState.READY:
 175             command = self.get("command")
 176             self.info("Starting command '%s'" % command)
 177
 178             self.set_started()
 179         else:
 180             msg = " Failed to execute command '%s'" % command
 181             self.error(msg, out, err)
 182             self.fail()
 183
 184     def stop(self):
 185         command = self.get('command') or ''
 186
 187         if self.state == ResourceState.STARTED:
 188             self.info("Stopping command '%s'" % command)
 189
 190             command = "bash %s" % os.path.join(self.app_home, "stop.sh")
 191             (out, err), proc = self.execute_command(command,
 192                     blocking = True)
 193
 194             self.set_stopped()
 195
 196     @property
 197     def state(self):
 198         # First check if the ccnd has failed
 199         state_check_delay = 0.5
 200         if self._state == ResourceState.STARTED and \
 201                 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 202
 203             if self.get("deviceName"):
 204                 (out, err), proc = self.node.execute("ifconfig")
 205
 206                 if out.strip().find(self.get("deviceName")) == -1:
 207                     # tap is not running is not running (socket not found)
 208                     self.finish()
 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             raise RuntimeError, msg
 245
 246         return if_name
 247
 248     def udp_connect_command(self, remote_ip, local_port_file,
 249             remote_port_file, ret_file, cipher, cipher_key,
 250             bwlimit, txqueuelen):
 251         command = ["sudo -S "]
 252         command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 253         command.append("python ${SRC}/pl-vif-udp-connect.py")
 254         command.append("-t %s" % self.vif_type)
 255         command.append("-S %s " % self.sock_name)
 256         command.append("-l %s " % local_port_file)
 257         command.append("-r %s " % remote_port_file)
 258         command.append("-H %s " % remote_ip)
 259         command.append("-R %s " % ret_file)
 260         if cipher:
 261             command.append("-c %s " % cipher)
 262         if cipher_key:
 263             command.append("-k %s " % cipher_key)
 264         if txqueuelen:
 265             command.append("-q %s " % txqueuelen)
 266         if bwlimit:
 267             command.append("-b %s " % bwlimit)
 268
 269         command = " ".join(command)
 270         command = self.replace_paths(command)
 271         return command
 272
 273     @property
 274     def _start_command(self):
 275         command = ["sudo -S python ${SRC}/pl-vif-create.py"]
 276
 277         command.append("-t %s" % self.vif_type)
 278         command.append("-a %s" % self.get("ip4"))
 279         command.append("-n %d" % self.get("prefix4"))
 280         command.append("-f %s " % self.if_name_file)
 281         command.append("-S %s " % self.sock_name)
 282         if self.get("snat") == True:
 283             command.append("-s")
 284         if self.get("pointopoint"):
 285             command.append("-p %s" % self.get("pointopoint"))
 286
 287         return " ".join(command)
 288
 289     @property
 290     def _stop_command(self):
 291         command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
 292
 293         command.append("-S %s " % self.sock_name)
 294         return " ".join(command)
 295
 296     @property
 297     def vif_type(self):
 298         return "IFF_TAP"
 299
 300     @property
 301     def if_name_file(self):
 302         return os.path.join(self.run_home, "if_name")
 303
 304     @property
 305     def sock_name(self):
 306         return os.path.join(self.run_home, "tap.sock")
 307
 308     @property
 309     def _dependencies(self):
 310         return "mercurial make gcc"
 311
 312     @property
 313     def _install(self):
 314         # Install python-vsys and python-passfd
 315         install_vsys = ( " ( "
 316                     "   python -c 'import vsys, os;  vsys.__version__ == \"%(version)s\" or os._exit(1)' "
 317                     " ) "
 318                     " || "
 319                     " ( "
 320                     "   cd ${SRC} ; "
 321                     "   hg clone http://nepi.inria.fr/code/python-vsys ; "
 322                     "   cd python-vsys ; "
 323                     "   make all ; "
 324                     "   sudo -S make install "
 325                     " )" ) % ({
 326                         "version": PYTHON_VSYS_VERSION
 327                         })
 328
 329         install_passfd = ( " ( python -c 'import passfd' ) "
 330                     " || "
 331                     " ( "
 332                     "   cd ${SRC} ; "
 333                     "   hg clone http://nepi.inria.fr/code/python-passfd ; "
 334                     "   cd python-passfd ; "
 335                     "   make all ; "
 336                     "   sudo -S make install "
 337                     " )" )
 338
 339         return "%s ; %s" % ( install_vsys, install_passfd )
 340
 341     def valid_connection(self, guid):
 342         # TODO: Validate!
 343         return True
 344