src/nepi/resources/linux/udptunnel.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, failtrap
  23 from nepi.resources.linux.application import LinuxApplication
  24 from nepi.util.sshfuncs import ProcStatus
  25 from nepi.util.timefuncs import tnow, tdiffsec
  26
  27 import os
  28 import socket
  29 import time
  30
  31 @clsinit_copy
  32 class UdpTunnel(LinuxApplication):
  33     _rtype = "UdpTunnel"
  34     _help = "Constructs a tunnel between two Linux endpoints using a UDP connection "
  35     _backend = "linux"
  36
  37
  38     @classmethod
  39     def _register_attributes(cls):
  40         cipher = Attribute("cipher",
  41                "Cipher to encript communication. "
  42                 "One of PLAIN, AES, Blowfish, DES, DES3. ",
  43                 default = None,
  44                 allowed = ["PLAIN", "AES", "Blowfish", "DES", "DES3"],
  45                 type = Types.Enumerate,
  46                 flags = Flags.ExecReadOnly)
  47
  48         cipher_key = Attribute("cipherKey",
  49                 "Specify a symmetric encryption key with which to protect "
  50                 "packets across the tunnel. python-crypto must be installed "
  51                 "on the system." ,
  52                 flags = Flags.ExecReadOnly)
  53
  54         txqueuelen = Attribute("txQueueLen",
  55                 "Specifies the interface's transmission queue length. "
  56                 "Defaults to 1000. ",
  57                 type = Types.Integer,
  58                 flags = Flags.ExecReadOnly)
  59
  60         bwlimit = Attribute("bwLimit",
  61                 "Specifies the interface's emulated bandwidth in bytes "
  62                 "per second.",
  63                 type = Types.Integer,
  64                 flags = Flags.ExecReadOnly)
  65
  66         cls._register_attribute(cipher)
  67         cls._register_attribute(cipher_key)
  68         cls._register_attribute(txqueuelen)
  69         cls._register_attribute(bwlimit)
  70
  71     def __init__(self, ec, guid):
  72         super(UdpTunnel, self).__init__(ec, guid)
  73         self._home = "udp-tunnel-%s" % self.guid
  74         self._pid1 = None
  75         self._ppid1 = None
  76         self._pid2 = None
  77         self._ppid2 = None
  78
  79     def log_message(self, msg):
  80         return " guid %d - tunnel %s - %s - %s " % (self.guid,
  81                 self.endpoint1.node.get("hostname"),
  82                 self.endpoint2.node.get("hostname"),
  83                 msg)
  84
  85     def get_endpoints(self):
  86         """ Returns the list of RM that are endpoints to the tunnel
  87         """
  88         connected = []
  89         for guid in self.connections:
  90             rm = self.ec.get_resource(guid)
  91             if hasattr(rm, "udp_connect_command"):
  92                 connected.append(rm)
  93         return connected
  94
  95     @property
  96     def endpoint1(self):
  97         endpoints = self.get_endpoints()
  98         if endpoints: return endpoints[0]
  99         return None
 100
 101     @property
 102     def endpoint2(self):
 103         endpoints = self.get_endpoints()
 104         if endpoints and len(endpoints) > 1: return endpoints[1]
 105         return None
 106
 107     def app_home(self, endpoint):
 108         return os.path.join(endpoint.node.exp_home, self._home)
 109
 110     def run_home(self, endpoint):
 111         return os.path.join(self.app_home(endpoint), self.ec.run_id)
 112
 113     def udp_connect(self, endpoint, remote_ip):
 114         # Get udp connect command
 115         local_port_file = os.path.join(self.run_home(endpoint),
 116                 "local_port")
 117         remote_port_file = os.path.join(self.run_home(endpoint),
 118                 "remote_port")
 119         ret_file = os.path.join(self.run_home(endpoint),
 120                 "ret_file")
 121         cipher = self.get("cipher")
 122         cipher_key = self.get("cipherKey")
 123         bwlimit = self.get("bwLimit")
 124         txqueuelen = self.get("txQueueLen")
 125         udp_connect_command = endpoint.udp_connect_command(
 126                 remote_ip, local_port_file, remote_port_file,
 127                 ret_file, cipher, cipher_key, bwlimit, txqueuelen)
 128
 129         # upload command to connect.sh script
 130         shfile = os.path.join(self.app_home(endpoint), "udp-connect.sh")
 131         endpoint.node.upload(udp_connect_command,
 132                 shfile,
 133                 text = True,
 134                 overwrite = False)
 135
 136         # invoke connect script
 137         cmd = "bash %s" % shfile
 138         (out, err), proc = endpoint.node.run(cmd, self.run_home(endpoint))
 139
 140         # check if execution errors occurred
 141         msg = " Failed to connect endpoints "
 142
 143         if proc.poll():
 144             self.error(msg, out, err)
 145             raise RuntimeError, msg
 146
 147         # Wait for pid file to be generated
 148         pid, ppid = endpoint.node.wait_pid(self.run_home(endpoint))
 149
 150         # If the process is not running, check for error information
 151         # on the remote machine
 152         if not pid or not ppid:
 153             (out, err), proc = endpoint.node.check_errors(self.run_home(endpoint))
 154             # Out is what was written in the stderr file
 155             if err:
 156                 msg = " Failed to start command '%s' " % command
 157                 self.error(msg, out, err)
 158                 raise RuntimeError, msg
 159
 160         # wait until port is written to file
 161         port = self.wait_local_port(endpoint)
 162         return (port, pid, ppid)
 163
 164     @failtrap
 165     def provision(self):
 166         # create run dir for tunnel on each node
 167         self.endpoint1.node.mkdir(self.run_home(self.endpoint1))
 168         self.endpoint2.node.mkdir(self.run_home(self.endpoint2))
 169
 170         # Invoke connect script in endpoint 1
 171         remote_ip1 = socket.gethostbyname(self.endpoint2.node.get("hostname"))
 172         (port1, self._pid1, self._ppid1) = self.udp_connect(self.endpoint1,
 173                 remote_ip1)
 174
 175         # Invoke connect script in endpoint 2
 176         remote_ip2 = socket.gethostbyname(self.endpoint1.node.get("hostname"))
 177         (port2, self._pid2, self._ppid2) = self.udp_connect(self.endpoint2,
 178                 remote_ip2)
 179
 180         # upload file with port 2 to endpoint 1
 181         self.upload_remote_port(self.endpoint1, port2)
 182
 183         # upload file with port 1 to endpoint 2
 184         self.upload_remote_port(self.endpoint2, port1)
 185
 186         # check if connection was successful on both sides
 187         self.wait_result(self.endpoint1)
 188         self.wait_result(self.endpoint2)
 189
 190         self.info("Provisioning finished")
 191
 192         self.set_provisioned()
 193
 194     @failtrap
 195     def deploy(self):
 196         if (not self.endpoint1 or self.endpoint1.state < ResourceState.READY) or \
 197             (not self.endpoint2 or self.endpoint2.state < ResourceState.READY):
 198             self.ec.schedule(reschedule_delay, self.deploy)
 199         else:
 200             self.discover()
 201             self.provision()
 202
 203             self.debug("----- READY ---- ")
 204             self.set_ready()
 205
 206     @failtrap
 207     def start(self):
 208         if self.state == ResourceState.READY:
 209             command = self.get("command")
 210             self.info("Starting command '%s'" % command)
 211
 212             self.set_started()
 213         else:
 214             msg = " Failed to execute command '%s'" % command
 215             self.error(msg, out, err)
 216             raise RuntimeError, msg
 217
 218     @failtrap
 219     def stop(self):
 220         """ Stops application execution
 221         """
 222         if self.state == ResourceState.STARTED:
 223             self.info("Stopping tunnel")
 224
 225             # Only try to kill the process if the pid and ppid
 226             # were retrieved
 227             if self._pid1 and self._ppid1 and self._pid2 and self._ppid2:
 228                 (out1, err1), proc1 = self.endpoint1.node.kill(self._pid1,
 229                         self._ppid1, sudo = True)
 230                 (out2, err2), proc2 = self.endpoint2.node.kill(self._pid2,
 231                         self._ppid2, sudo = True)
 232
 233                 if err1 or err2 or proc1.poll() or proc2.poll():
 234                     # check if execution errors occurred
 235                     msg = " Failed to STOP tunnel"
 236                     self.error(msg, err1, err2)
 237                     raise RuntimeError, msg
 238
 239             self.set_stopped()
 240
 241     @property
 242     def state(self):
 243         """ Returns the state of the application
 244         """
 245         if self._state == ResourceState.STARTED:
 246             # In order to avoid overwhelming the remote host and
 247             # the local processor with too many ssh queries, the state is only
 248             # requested every 'state_check_delay' seconds.
 249             state_check_delay = 0.5
 250             if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 251                 if self._pid1 and self._ppid1 and self._pid2 and self._ppid2:
 252                     # Make sure the process is still running in background
 253                     # No execution errors occurred. Make sure the background
 254                     # process with the recorded pid is still running.
 255                     status1 = self.endpoint1.node.status(self._pid1, self._ppid1)
 256                     status2 = self.endpoint2.node.status(self._pid2, self._ppid2)
 257
 258                     if status1 == ProcStatus.FINISHED and \
 259                             status2 == ProcStatus.FINISHED:
 260
 261                         # check if execution errors occurred
 262                         (out1, err1), proc1 = self.endpoint1.node.check_errors(
 263                                 self.run_home(self.endpoint1))
 264
 265                         (out2, err2), proc2 = self.endpoint2.node.check_errors(
 266                                 self.run_home(self.endpoint2))
 267
 268                         if err1 or err2:
 269                             msg = "Error occurred in tunnel"
 270                             self.error(msg, err1, err2)
 271                             self.fail()
 272                         else:
 273                             self.set_finished()
 274
 275                 self._last_state_check = tnow()
 276
 277         return self._state
 278
 279     def wait_local_port(self, endpoint):
 280         """ Waits until the local_port file for the endpoint is generated,
 281         and returns the port number
 282
 283         """
 284         return self.wait_file(endpoint, "local_port")
 285
 286     def wait_result(self, endpoint):
 287         """ Waits until the return code file for the endpoint is generated
 288
 289         """
 290         return self.wait_file(endpoint, "ret_file")
 291
 292     def wait_file(self, endpoint, filename):
 293         """ Waits until file on endpoint is generated """
 294         result = None
 295         delay = 1.0
 296
 297         for i in xrange(4):
 298             (out, err), proc = endpoint.node.check_output(
 299                     self.run_home(endpoint), filename)
 300
 301             if out:
 302                 result = out.strip()
 303                 break
 304             else:
 305                 time.sleep(delay)
 306                 delay = delay * 1.5
 307         else:
 308             msg = "Couldn't retrieve %s" % filename
 309             self.error(msg, out, err)
 310             raise RuntimeError, msg
 311
 312         return result
 313
 314     def upload_remote_port(self, endpoint, port):
 315         # upload remote port number to file
 316         port = "%s\n" % port
 317         endpoint.node.upload(port,
 318                 os.path.join(self.run_home(endpoint), "remote_port"),
 319                 text = True,
 320                 overwrite = False)
 321
 322     def valid_connection(self, guid):
 323         # TODO: Validate!
 324         return True
 325