src/nepi/util/execfuncs.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.util.sshfuncs import ProcStatus, STDOUT
  21
  22 import subprocess
  23
  24 def lexec(command,
  25         user = None,
  26         sudo = False,
  27         stdin = None,
  28         env = None):
  29     """
  30     Executes a local command, returns ((stdout,stderr),process)
  31     """
  32     if env:
  33         export = ''
  34         for envkey, envval in env.iteritems():
  35             export += '%s=%s ' % (envkey, envval)
  36         command = "%s %s" % (export, command)
  37
  38     if sudo:
  39         command = "sudo %s" % command
  40     elif user:
  41         command = "su %s ; %s " % (user, command)
  42
  43
  44     proc = subprocess.Popen(command, shell=True,
  45             stdout = subprocess.PIPE,
  46             stderr = subprocess.PIPE)
  47             #stdin  = stdin)
  48
  49     out, err = proc.communicate()
  50     return ((out, err), proc)
  51
  52 def lcopy(source, dest, recursive = False):
  53     """
  54     Copies from/to localy.
  55     """
  56
  57     if TRACE:
  58         print "scp", source, dest
  59
  60     command = ["cp"]
  61     if recursive:
  62         command.append("-R")
  63
  64     command.append(src)
  65     command.append(dst)
  66
  67     proc = subprocess.Popen(command,
  68         stdout=subprocess.PIPE,
  69         stderr=subprocess.PIPE)
  70
  71     out, err = p.communicate()
  72     return ((out, err), proc)
  73
  74 def lspawn(command, pidfile,
  75         stdout = '/dev/null',
  76         stderr = STDOUT,
  77         stdin = '/dev/null',
  78         home = None,
  79         create_home = False,
  80         sudo = False,
  81         user = None):
  82     """
  83     Spawn a local command such that it will continue working asynchronously.
  84
  85     Parameters:
  86         command: the command to run - it should be a single line.
  87
  88         pidfile: path of a (ideally unique to this task) pidfile for tracking the process.
  89
  90         stdout: path of a file to redirect standard output to - must be a string.
  91             Defaults to /dev/null
  92         stderr: path of a file to redirect standard error to - string or the special STDOUT value
  93             to redirect to the same file stdout was redirected to. Defaults to STDOUT.
  94         stdin: path of a file with input to be piped into the command's standard input
  95
  96         home: path of a folder to use as working directory - should exist, unless you specify create_home
  97
  98         create_home: if True, the home folder will be created first with mkdir -p
  99
 100         sudo: whether the command needs to be executed as root
 101
 102     Returns:
 103         (stdout, stderr), process
 104
 105         Of the spawning process, which only captures errors at spawning time.
 106         Usually only useful for diagnostics.
 107     """
 108     # Start process in a "daemonized" way, using nohup and heavy
 109     # stdin/out redirection to avoid connection issues
 110     if stderr is STDOUT:
 111         stderr = '&1'
 112     else:
 113         stderr = ' ' + stderr
 114
 115     daemon_command = '{ { %(command)s  > %(stdout)s 2>%(stderr)s < %(stdin)s & } ; echo $! 1 > %(pidfile)s ; }' % {
 116         'command' : command,
 117         'pidfile' : shell_escape(pidfile),
 118         'stdout' : stdout,
 119         'stderr' : stderr,
 120         'stdin' : stdin,
 121     }
 122
 123     cmd = "%(create)s%(gohome)s rm -f %(pidfile)s ; %(sudo)s nohup bash -c %(command)s " % {
 124             'command' : shell_escape(daemon_command),
 125             'sudo' : 'sudo -S' if sudo else '',
 126             'pidfile' : shell_escape(pidfile),
 127             'gohome' : 'cd %s ; ' % (shell_escape(home),) if home else '',
 128             'create' : 'mkdir -p %s ; ' % (shell_escape(home),) if create_home else '',
 129         }
 130
 131     (out,err), proc = lexec(cmd)
 132
 133     if proc.wait():
 134         raise RuntimeError, "Failed to set up application on host %s: %s %s" % (host, out,err,)
 135
 136     return ((out,err), proc)
 137
 138 def lgetpid(pidfile):
 139     """
 140     Check the pidfile of a process spawned with remote_spawn.
 141
 142     Parameters:
 143         pidfile: the pidfile passed to remote_span
 144
 145     Returns:
 146
 147         A (pid, ppid) tuple useful for calling remote_status and remote_kill,
 148         or None if the pidfile isn't valid yet (maybe the process is still starting).
 149     """
 150
 151     (out,err), proc = lexec("cat %s" % pidfile )
 152
 153     if proc.wait():
 154         return None
 155
 156     if out:
 157         try:
 158             return map(int,out.strip().split(' ',1))
 159         except:
 160             # Ignore, many ways to fail that don't matter that much
 161             return None
 162
 163 def lstatus(pid, ppid):
 164     """
 165     Check the status of a process spawned with remote_spawn.
 166
 167     Parameters:
 168         pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
 169
 170     Returns:
 171
 172         One of NOT_STARTED, RUNNING, FINISHED
 173     """
 174
 175     (out,err), proc = lexec(
 176         # Check only by pid. pid+ppid does not always work (especially with sudo)
 177         " (( ps --pid %(pid)d -o pid | grep -c %(pid)d && echo 'wait')  || echo 'done' ) | tail -n 1" % {
 178             'ppid' : ppid,
 179             'pid' : pid,
 180         })
 181
 182     if proc.wait():
 183         return ProcStatus.NOT_STARTED
 184
 185     status = False
 186     if out:
 187         status = (out.strip() == 'wait')
 188     else:
 189         return ProcStatus.NOT_STARTED
 190
 191     return ProcStatus.RUNNING if status else ProcStatus.FINISHED
 192
 193 def lkill(pid, ppid, sudo = False):
 194     """
 195     Kill a process spawned with lspawn.
 196
 197     First tries a SIGTERM, and if the process does not end in 10 seconds,
 198     it sends a SIGKILL.
 199
 200     Parameters:
 201         pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
 202
 203         sudo: whether the command was run with sudo - careful killing like this.
 204
 205     Returns:
 206
 207         Nothing, should have killed the process
 208     """
 209
 210     subkill = "$(ps --ppid %(pid)d -o pid h)" % { 'pid' : pid }
 211     cmd = """
 212 SUBKILL="%(subkill)s" ;
 213 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
 214 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
 215 for x in 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 ; do
 216     sleep 0.2
 217     if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` == '0' ]; then
 218         break
 219     else
 220         %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
 221         %(sudo)s kill %(pid)d $SUBKILL || /bin/true
 222     fi
 223     sleep 1.8
 224 done
 225 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` != '0' ]; then
 226     %(sudo)s kill -9 -- -%(pid)d $SUBKILL || /bin/true
 227     %(sudo)s kill -9 %(pid)d $SUBKILL || /bin/true
 228 fi
 229 """
 230     if nowait:
 231         cmd = "( %s ) >/dev/null 2>/dev/null </dev/null &" % (cmd,)
 232
 233     (out,err),proc = lexec(
 234         cmd % {
 235             'ppid' : ppid,
 236             'pid' : pid,
 237             'sudo' : 'sudo -S' if sudo else '',
 238             'subkill' : subkill,
 239         })
 240
 241