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
  23 from nepi.resources.linux.tunnel import LinuxTunnel
  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 LinuxUdpTunnel(LinuxTunnel):
  33     _rtype = "LinuxUdpTunnel"
  34     _help = "Constructs a tunnel between two Linux endpoints using a UDP connection "
  35     _backend = "linux"
  36
  37     @classmethod
  38     def _register_attributes(cls):
  39         cipher = Attribute("cipher",
  40                "Cipher to encript communication. "
  41                 "One of PLAIN, AES, Blowfish, DES, DES3. ",
  42                 default = None,
  43                 allowed = ["PLAIN", "AES", "Blowfish", "DES", "DES3"],
  44                 type = Types.Enumerate,
  45                 flags = Flags.Design)
  46
  47         cipher_key = Attribute("cipherKey",
  48                 "Specify a symmetric encryption key with which to protect "
  49                 "packets across the tunnel. python-crypto must be installed "
  50                 "on the system." ,
  51                 flags = Flags.Design)
  52
  53         txqueuelen = Attribute("txQueueLen",
  54                 "Specifies the interface's transmission queue length. "
  55                 "Defaults to 1000. ",
  56                 type = Types.Integer,
  57                 flags = Flags.Design)
  58
  59         bwlimit = Attribute("bwLimit",
  60                 "Specifies the interface's emulated bandwidth in bytes "
  61                 "per second.",
  62                 type = Types.Integer,
  63                 flags = Flags.Design)
  64
  65         cls._register_attribute(cipher)
  66         cls._register_attribute(cipher_key)
  67         cls._register_attribute(txqueuelen)
  68         cls._register_attribute(bwlimit)
  69
  70     def __init__(self, ec, guid):
  71         super(LinuxUdpTunnel, self).__init__(ec, guid)
  72         self._home = "udp-tunnel-%s" % self.guid
  73         self._pids = dict()
  74
  75     def log_message(self, msg):
  76         return " guid %d - udptunnel %s - %s - %s " % (self.guid,
  77                 self.endpoint1.node.get("hostname"),
  78                 self.endpoint2.node.get("hostname"),
  79                 msg)
  80
  81     def initiate_connection(self, endpoint, remote_endpoint):
  82         cipher = self.get("cipher")
  83         cipher_key = self.get("cipherKey")
  84         bwlimit = self.get("bwLimit")
  85         txqueuelen = self.get("txQueueLen")
  86
  87         # Return the command to execute to initiate the connection to the
  88         # other endpoint
  89         connection_run_home = self.run_home(endpoint)
  90         udp_connect_command = endpoint.udp_connect_command(
  91                 remote_endpoint, connection_run_home,
  92                 cipher, cipher_key, bwlimit, txqueuelen)
  93
  94         # upload command to connect.sh script
  95         shfile = os.path.join(self.app_home(endpoint), "udp-connect.sh")
  96         endpoint.node.upload(udp_connect_command,
  97                 shfile,
  98                 text = True,
  99                 overwrite = False)
 100
 101         # invoke connect script
 102         cmd = "bash %s" % shfile
 103         (out, err), proc = endpoint.node.run(cmd, self.run_home(endpoint))
 104
 105         # check if execution errors occurred
 106         msg = " Failed to connect endpoints "
 107
 108         if proc.poll():
 109             self.error(msg, out, err)
 110             raise RuntimeError, msg
 111
 112         # Wait for pid file to be generated
 113         pid, ppid = endpoint.node.wait_pid(self.run_home(endpoint))
 114
 115         # If the process is not running, check for error information
 116         # on the remote machine
 117         if not pid or not ppid:
 118             (out, err), proc = endpoint.node.check_errors(self.run_home(endpoint))
 119             # Out is what was written in the stderr file
 120             if err:
 121                 msg = " Failed to start command '%s' " % command
 122                 self.error(msg, out, err)
 123                 raise RuntimeError, msg
 124
 125         # wait until port is written to file
 126         port = self.wait_local_port(endpoint)
 127
 128         self._pids[endpoint] = (pid, ppid)
 129
 130         return port
 131
 132     def establish_connection(self, endpoint, remote_endpoint, port):
 133         self.upload_remote_port(endpoint, port)
 134
 135     def verify_connection(self, endpoint, remote_endpoint):
 136         self.wait_result(endpoint)
 137
 138     def terminate_connection(self, endpoint, remote_endpoint):
 139         pid, ppid = self._pids[endpoint]
 140
 141         if pid and ppid:
 142             (out, err), proc = endpoint.node.kill(pid, ppid,
 143                     sudo = True)
 144
 145             # check if execution errors occurred
 146             if proc.poll() and err:
 147                 msg = " Failed to STOP tunnel"
 148                 self.error(msg, out, err)
 149                 raise RuntimeError, msg
 150
 151     def check_state_connection(self):
 152         # Make sure the process is still running in background
 153         # No execution errors occurred. Make sure the background
 154         # process with the recorded pid is still running.
 155         pid1, ppid1 = self._pids[self.endpoint1]
 156         pid2, ppid2 = self._pids[self.endpoint2]
 157
 158         status1 = self.endpoint1.node.status(pid1, ppid1)
 159         status2 = self.endpoint2.node.status(pid2, ppid2)
 160
 161         if status1 == ProcStatus.FINISHED and \
 162                 status2 == ProcStatus.FINISHED:
 163
 164             # check if execution errors occurred
 165             (out1, err1), proc1 = self.endpoint1.node.check_errors(
 166                     self.run_home(self.endpoint1))
 167
 168             (out2, err2), proc2 = self.endpoint2.node.check_errors(
 169                     self.run_home(self.endpoint2))
 170
 171             if err1 or err2:
 172                 msg = "Error occurred in tunnel"
 173                 self.error(msg, err1, err2)
 174                 self.fail()
 175             else:
 176                 self.set_stopped()
 177
 178     def wait_local_port(self, endpoint):
 179         """ Waits until the local_port file for the endpoint is generated,
 180         and returns the port number
 181
 182         """
 183         return self.wait_file(endpoint, "local_port")
 184
 185     def wait_result(self, endpoint):
 186         """ Waits until the return code file for the endpoint is generated
 187
 188         """
 189         return self.wait_file(endpoint, "ret_file")
 190
 191     def wait_file(self, endpoint, filename):
 192         """ Waits until file on endpoint is generated """
 193         result = None
 194         delay = 1.0
 195
 196         for i in xrange(20):
 197             (out, err), proc = endpoint.node.check_output(
 198                     self.run_home(endpoint), filename)
 199
 200             if out:
 201                 result = out.strip()
 202                 break
 203             else:
 204                 time.sleep(delay)
 205                 delay = delay * 1.5
 206         else:
 207             msg = "Couldn't retrieve %s" % filename
 208             self.error(msg, out, err)
 209             raise RuntimeError, msg
 210
 211         return result
 212
 213     def upload_remote_port(self, endpoint, port):
 214         # upload remote port number to file
 215         port = "%s\n" % port
 216         endpoint.node.upload(port,
 217                 os.path.join(self.run_home(endpoint), "remote_port"),
 218                 text = True,
 219                 overwrite = False)
 220
 221