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 socket
  29 import time
  30
  31 PYTHON_VSYS_VERSION = "1.0"
  32
  33 @clsinit_copy
  34 class PlanetlabTap(LinuxApplication):
  35     _rtype = "PlanetlabTap"
  36     _help = "Creates a TAP device on a PlanetLab host"
  37     _backend = "planetlab"
  38
  39     @classmethod
  40     def _register_attributes(cls):
  41         ip4 = Attribute("ip4", "IPv4 Address",
  42               flags = Flags.Design)
  43
  44         mac = Attribute("mac", "MAC Address",
  45                 flags = Flags.Design)
  46
  47         prefix4 = Attribute("prefix4", "IPv4 network prefix",
  48                 type = Types.Integer,
  49                 flags = Flags.Design)
  50
  51         mtu = Attribute("mtu", "Maximum transmition unit for device",
  52                 type = Types.Integer)
  53
  54         devname = Attribute("deviceName",
  55                 "Name of the network interface (e.g. eth0, wlan0, etc)",
  56                 flags = Flags.NoWrite)
  57
  58         up = Attribute("up", "Link up",
  59                 type = Types.Bool)
  60
  61         snat = Attribute("snat", "Set SNAT=1",
  62                 type = Types.Bool,
  63                 flags = Flags.Design)
  64
  65         pointopoint = Attribute("pointopoint", "Peer IP address",
  66                 flags = Flags.Design)
  67
  68         txqueuelen = Attribute("txqueuelen", "Length of transmission queue",
  69                 flags = Flags.Design)
  70
  71         txqueuelen = Attribute("txqueuelen", "Length of transmission queue",
  72                 flags = Flags.Design)
  73
  74         gre_key = Attribute("greKey",
  75                 "GRE key to be used to configure GRE tunnel",
  76                 default = "1",
  77                 flags = Flags.Design)
  78
  79         gre_remote = Attribute("greRemote",
  80                 "Public IP of remote endpoint for GRE tunnel",
  81                 flags = Flags.Design)
  82
  83         tear_down = Attribute("tearDown",
  84                 "Bash script to be executed before releasing the resource",
  85                 flags = Flags.Design)
  86
  87         cls._register_attribute(ip4)
  88         cls._register_attribute(mac)
  89         cls._register_attribute(prefix4)
  90         cls._register_attribute(mtu)
  91         cls._register_attribute(devname)
  92         cls._register_attribute(up)
  93         cls._register_attribute(snat)
  94         cls._register_attribute(pointopoint)
  95         cls._register_attribute(txqueuelen)
  96         cls._register_attribute(gre_key)
  97         cls._register_attribute(gre_remote)
  98         cls._register_attribute(tear_down)
  99
 100     def __init__(self, ec, guid):
 101         super(PlanetlabTap, self).__init__(ec, guid)
 102         self._home = "tap-%s" % self.guid
 103         self._gre_enabled = False
 104
 105     @property
 106     def node(self):
 107         node = self.get_connected(PlanetlabNode.get_rtype())
 108         if node: return node[0]
 109         return None
 110
 111     @property
 112     def gre_enabled(self):
 113         if not self._gre_enabled:
 114             from nepi.resources.linux.gretunnel import LinuxGRETunnel
 115             gre = self.get_connected(LinuxGRETunnel.get_rtype())
 116             if gre: self._gre_enabled = True
 117
 118         return self._gre_enabled
 119
 120     def upload_sources(self):
 121         scripts = []
 122
 123         # vif-creation python script
 124         pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
 125                 "pl-vif-create.py")
 126
 127         scripts.append(pl_vif_create)
 128
 129         # vif-up python script
 130         pl_vif_up = os.path.join(os.path.dirname(__file__), "scripts",
 131                 "pl-vif-up.py")
 132
 133         scripts.append(pl_vif_up)
 134
 135         # vif-down python script
 136         pl_vif_down = os.path.join(os.path.dirname(__file__), "scripts",
 137                 "pl-vif-down.py")
 138
 139         scripts.append(pl_vif_down)
 140
 141         # udp-connect python script
 142         pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
 143                 "pl-vif-udp-connect.py")
 144
 145         scripts.append(pl_vif_connect)
 146
 147         # tunnel creation python script
 148         tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
 149                 "scripts", "tunchannel.py")
 150
 151         scripts.append(tunchannel)
 152
 153         # Upload scripts
 154         scripts = ";".join(scripts)
 155
 156         self.node.upload(scripts,
 157                 os.path.join(self.node.src_dir),
 158                 overwrite = False)
 159
 160         # upload stop.sh script
 161         stop_command = self.replace_paths(self._stop_command)
 162
 163         self.node.upload(stop_command,
 164                 os.path.join(self.app_home, "stop.sh"),
 165                 text = True,
 166                 # Overwrite file every time.
 167                 # The stop.sh has the path to the socket, which should change
 168                 # on every experiment run.
 169                 overwrite = True)
 170
 171     def upload_start_command(self):
 172         # If GRE mode is enabled, TAP creation is delayed until the
 173         # tunnel is established
 174         if not self.gre_enabled:
 175             # Overwrite file every time.
 176             # The start.sh has the path to the socket, wich should change
 177             # on every experiment run.
 178             super(PlanetlabTap, self).upload_start_command(overwrite = True)
 179
 180             # We want to make sure the device is up and running
 181             # before the deploy finishes, so we execute now the
 182             # start script. We run it in background, because the
 183             # TAP will live for as long as the process that
 184             # created it is running, and wait until the TAP
 185             # is created.
 186             self._run_in_background()
 187
 188             # After creating the TAP, the pl-vif-create.py script
 189             # will write the name of the TAP to a file. We wait until
 190             # we can read the interface name from the file.
 191             vif_name = self.wait_vif_name()
 192             self.set("deviceName", vif_name)
 193
 194     def do_deploy(self):
 195         if not self.node or self.node.state < ResourceState.PROVISIONED:
 196             self.ec.schedule(reschedule_delay, self.deploy)
 197         else:
 198             if not self.get("command"):
 199                 self.set("command", self._start_command)
 200
 201             if not self.get("depends"):
 202                 self.set("depends", self._dependencies)
 203
 204             if not self.get("install"):
 205                 self.set("install", self._install)
 206
 207             self.do_discover()
 208             self.do_provision()
 209
 210             self.set_ready()
 211
 212     def do_start(self):
 213         if self.state == ResourceState.READY:
 214             command = self.get("command")
 215             self.info("Starting command '%s'" % command)
 216
 217             self.set_started()
 218         else:
 219             msg = " Failed to execute command '%s'" % command
 220             self.error(msg, out, err)
 221             raise RuntimeError, msg
 222
 223     def do_stop(self):
 224         command = self.get('command') or ''
 225
 226         if self.state == ResourceState.STARTED:
 227             self.info("Stopping command '%s'" % command)
 228
 229             command = "bash %s" % os.path.join(self.app_home, "stop.sh")
 230             (out, err), proc = self.execute_command(command,
 231                     blocking = True)
 232
 233             if err:
 234                 msg = " Failed to stop command '%s' " % command
 235                 self.error(msg, out, err)
 236
 237             self.set_stopped()
 238
 239     @property
 240     def state(self):
 241         state_check_delay = 0.5
 242         if self._state == ResourceState.STARTED and \
 243                 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 244
 245             if self.get("deviceName"):
 246                 (out, err), proc = self.node.execute("ifconfig")
 247
 248                 if out.strip().find(self.get("deviceName")) == -1:
 249                     # tap is not running is not running (socket not found)
 250                     self.set_stopped()
 251
 252             self._last_state_check = tnow()
 253
 254         return self._state
 255
 256     def do_release(self):
 257         # Node needs to wait until all associated RMs are released
 258         # to be released
 259         from nepi.resources.linux.tunnel import LinuxTunnel
 260         rms = self.get_connected(LinuxTunnel.get_rtype())
 261
 262         for rm in rms:
 263             if rm.state < ResourceState.STOPPED:
 264                 self.ec.schedule(reschedule_delay, self.release)
 265                 return
 266
 267         super(PlanetlabTap, self).do_release()
 268
 269     def wait_vif_name(self):
 270         """ Waits until the vif_name file for the command is generated,
 271             and returns the vif_name for the device """
 272         vif_name = None
 273         delay = 0.5
 274
 275         for i in xrange(20):
 276             (out, err), proc = self.node.check_output(self.run_home, "vif_name")
 277
 278             if proc.poll() > 0:
 279                 (out, err), proc = self.node.check_errors(self.run_home)
 280
 281                 if err.strip():
 282                     raise RuntimeError, err
 283
 284             if out:
 285                 vif_name = out.strip()
 286                 break
 287             else:
 288                 time.sleep(delay)
 289                 delay = delay * 1.5
 290         else:
 291             msg = "Couldn't retrieve vif_name"
 292             self.error(msg, out, err)
 293             raise RuntimeError, msg
 294
 295         return vif_name
 296
 297     def udp_connect_command(self, remote_endpoint, connection_run_home,
 298             cipher, cipher_key, bwlimit, txqueuelen):
 299
 300         # Set the remote endpoint
 301         self.set("pointopoint", remote_endpoint.get("ip4"))
 302
 303         remote_ip = socket.gethostbyname(
 304                 remote_endpoint.node.get("hostname"))
 305
 306         local_port_file = os.path.join(connection_run_home,
 307                 "local_port")
 308
 309         remote_port_file = os.path.join(connection_run_home,
 310                 "remote_port")
 311
 312         ret_file = os.path.join(connection_run_home,
 313                 "ret_file")
 314
 315         # Generate UDP connect command
 316         # Use pl-vif-up.py script to configure TAP with peer info
 317         vif_up_command = self._vif_up_command
 318
 319         command = ["( "]
 320         command.append(vif_up_command)
 321
 322         # Use pl-vid-udp-connect.py to stablish the tunnel between endpoints
 323         command.append(") & (")
 324         command.append("sudo -S")
 325         command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 326         command.append("python ${SRC}/pl-vif-udp-connect.py")
 327         command.append("-t %s" % self.vif_type)
 328         command.append("-S %s " % self.sock_name)
 329         command.append("-l %s " % local_port_file)
 330         command.append("-r %s " % remote_port_file)
 331         command.append("-H %s " % remote_ip)
 332         command.append("-R %s " % ret_file)
 333         if cipher:
 334             command.append("-c %s " % cipher)
 335         if cipher_key:
 336             command.append("-k %s " % cipher_key)
 337         if txqueuelen:
 338             command.append("-q %s " % txqueuelen)
 339         if bwlimit:
 340             command.append("-b %s " % bwlimit)
 341
 342         command.append(")")
 343
 344         command = " ".join(command)
 345         command = self.replace_paths(command)
 346
 347         return command
 348
 349     def gre_connect_command(self, remote_endpoint, connection_run_home):
 350         # Set the remote endpoint
 351         self.set("pointopoint", remote_endpoint.get("ip4"))
 352         self.set("greRemote", socket.gethostbyname(
 353             remote_endpoint.node.get("hostname")))
 354
 355         # Generate GRE connect command
 356
 357         # Use vif_down command to first kill existing TAP in GRE mode
 358         vif_down_command = self._vif_down_command
 359
 360         # Use pl-vif-up.py script to configure TAP with peer info
 361         vif_up_command = self._vif_up_command
 362
 363         command = ["("]
 364         command.append(vif_down_command)
 365         command.append(") ; (")
 366         command.append(vif_up_command)
 367         command.append(")")
 368
 369         command = " ".join(command)
 370         command = self.replace_paths(command)
 371
 372         return command
 373
 374     @property
 375     def _start_command(self):
 376         if self.gre_enabled:
 377             command = []
 378         else:
 379             command = ["sudo -S python ${SRC}/pl-vif-create.py"]
 380
 381             command.append("-t %s" % self.vif_type)
 382             command.append("-a %s" % self.get("ip4"))
 383             command.append("-n %d" % self.get("prefix4"))
 384             command.append("-f %s " % self.vif_name_file)
 385             command.append("-S %s " % self.sock_name)
 386
 387             if self.get("snat") == True:
 388                 command.append("-s")
 389
 390             if self.get("pointopoint"):
 391                 command.append("-p %s" % self.get("pointopoint"))
 392
 393             if self.get("txqueuelen"):
 394                 command.append("-q %s" % self.get("txqueuelen"))
 395
 396         return " ".join(command)
 397
 398     @property
 399     def _stop_command(self):
 400         if self.gre_enabled:
 401             command = self._vif_down_command
 402         else:
 403             command = ["sudo -S "]
 404             command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 405             command.append("python ${SRC}/pl-vif-down.py")
 406             command.append("-S %s " % self.sock_name)
 407             command = " ".join(command)
 408
 409         return command
 410
 411     @property
 412     def _vif_up_command(self):
 413         if self.gre_enabled:
 414             device_name = "%s" % self.guid
 415         else:
 416             device_name = self.get("deviceName")
 417
 418         # Use pl-vif-up.py script to configure TAP
 419         command = ["sudo -S "]
 420         command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 421         command.append("python ${SRC}/pl-vif-up.py")
 422         command.append("-u %s" % self.node.get("username"))
 423         command.append("-N %s" % device_name)
 424         command.append("-t %s" % self.vif_type)
 425         command.append("-a %s" % self.get("ip4"))
 426         command.append("-n %d" % self.get("prefix4"))
 427
 428         if self.get("snat") == True:
 429             command.append("-s")
 430
 431         if self.get("pointopoint"):
 432             command.append("-p %s" % self.get("pointopoint"))
 433
 434         if self.get("txqueuelen"):
 435             command.append("-q %s" % self.get("txqueuelen"))
 436
 437         if self.gre_enabled:
 438             command.append("-g %s" % self.get("greKey"))
 439             command.append("-G %s" % self.get("greRemote"))
 440
 441         command.append("-f %s " % self.vif_name_file)
 442
 443         return " ".join(command)
 444
 445     @property
 446     def _vif_down_command(self):
 447         if self.gre_enabled:
 448             device_name = "%s" % self.guid
 449         else:
 450             device_name = self.get("deviceName")
 451
 452         command = ["sudo -S "]
 453         command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
 454         command.append("python ${SRC}/pl-vif-down.py")
 455         command.append("-N %s " % device_name)
 456
 457         if self.gre_enabled:
 458             command.append("-u %s" % self.node.get("username"))
 459             command.append("-t %s" % self.vif_type)
 460             command.append("-D")
 461
 462         return " ".join(command)
 463
 464     @property
 465     def vif_type(self):
 466         return "IFF_TAP"
 467
 468     @property
 469     def vif_name_file(self):
 470         return os.path.join(self.run_home, "vif_name")
 471
 472     @property
 473     def sock_name(self):
 474         return os.path.join(self.run_home, "tap.sock")
 475
 476     @property
 477     def _dependencies(self):
 478         return "mercurial make gcc"
 479
 480     @property
 481     def _install(self):
 482         # Install python-vsys and python-passfd
 483         install_vsys = ( " ( "
 484                     "   python -c 'import vsys, os;  vsys.__version__ == \"%(version)s\" or os._exit(1)' "
 485                     " ) "
 486                     " || "
 487                     " ( "
 488                     "   cd ${SRC} ; "
 489                     "   hg clone http://nepi.inria.fr/code/python-vsys ; "
 490                     "   cd python-vsys ; "
 491                     "   make all ; "
 492                     "   sudo -S make install "
 493                     " )" ) % ({
 494                         "version": PYTHON_VSYS_VERSION
 495                         })
 496
 497         install_passfd = ( " ( python -c 'import passfd' ) "
 498                     " || "
 499                     " ( "
 500                     "   cd ${SRC} ; "
 501                     "   hg clone http://nepi.inria.fr/code/python-passfd ; "
 502                     "   cd python-passfd ; "
 503                     "   make all ; "
 504                     "   sudo -S make install "
 505                     " )" )
 506
 507         return "%s ; %s" % ( install_vsys, install_passfd )
 508
 509     def valid_connection(self, guid):
 510         # TODO: Validate!
 511         return True
 512