2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
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.
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.
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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 from nepi.util.sshfuncs import ProcStatus, STDOUT, log, shell_escape
31 Executes a local command, returns ((stdout,stderr),process)
35 for envkey, envval in env.iteritems():
36 export += '%s=%s ' % (envkey, envval)
37 command = "%s %s" % (export, command)
40 command = "sudo %s" % command
42 command = "su %s ; %s " % (user, command)
44 proc = subprocess.Popen(command,
46 stdout = subprocess.PIPE,
47 stderr = subprocess.PIPE)
50 log_msg = "lexec - command %s " % command
53 out, err = proc.communicate()
54 log(log_msg, logging.DEBUG, out, err)
56 log(log_msg, logging.ERROR, out, err)
59 return ((out, err), proc)
61 def lcopy(source, dest, recursive = False):
63 Copies from/to localy.
70 if isinstance(source, list):
75 if isinstance(dest, list):
80 proc = subprocess.Popen(args,
81 stdout=subprocess.PIPE,
82 stderr=subprocess.PIPE)
85 command = " ".join(args)
86 log_msg = " lcopy - command %s " % command
89 out, err = proc.communicate()
90 log(log_msg, logging.DEBUG, out, err)
92 log(log_msg, logging.ERROR, out, err)
95 return ((out, err), proc)
97 def lspawn(command, pidfile,
106 Spawn a local command such that it will continue working asynchronously.
109 command: the command to run - it should be a single line.
111 pidfile: path of a (ideally unique to this task) pidfile for tracking the process.
113 stdout: path of a file to redirect standard output to - must be a string.
114 Defaults to /dev/null
115 stderr: path of a file to redirect standard error to - string or the special STDOUT value
116 to redirect to the same file stdout was redirected to. Defaults to STDOUT.
117 stdin: path of a file with input to be piped into the command's standard input
119 home: path of a folder to use as working directory - should exist, unless you specify create_home
121 create_home: if True, the home folder will be created first with mkdir -p
123 sudo: whether the command needs to be executed as root
126 (stdout, stderr), process
128 Of the spawning process, which only captures errors at spawning time.
129 Usually only useful for diagnostics.
131 # Start process in a "daemonized" way, using nohup and heavy
132 # stdin/out redirection to avoid connection issues
136 stderr = ' ' + stderr
138 daemon_command = '{ { %(command)s > %(stdout)s 2>%(stderr)s < %(stdin)s & } ; echo $! 1 > %(pidfile)s ; }' % {
140 'pidfile' : shell_escape(pidfile),
146 cmd = "%(create)s%(gohome)s rm -f %(pidfile)s ; %(sudo)s bash -c %(command)s " % {
147 'command' : shell_escape(daemon_command),
148 'sudo' : 'sudo -S' if sudo else '',
149 'pidfile' : shell_escape(pidfile),
150 'gohome' : 'cd %s ; ' % (shell_escape(home),) if home else '',
151 'create' : 'mkdir -p %s ; ' % (shell_escape(home),) if create_home else '',
154 (out,err), proc = lexec(cmd)
157 raise RuntimeError, "Failed to set up application on host %s: %s %s" % (host, out,err,)
159 return ((out,err), proc)
161 def lgetpid(pidfile):
163 Check the pidfile of a process spawned with remote_spawn.
166 pidfile: the pidfile passed to remote_span
170 A (pid, ppid) tuple useful for calling remote_status and remote_kill,
171 or None if the pidfile isn't valid yet (maybe the process is still starting).
174 (out,err), proc = lexec("cat %s" % pidfile )
181 return map(int,out.strip().split(' ',1))
183 # Ignore, many ways to fail that don't matter that much
186 def lstatus(pid, ppid):
188 Check the status of a process spawned with remote_spawn.
191 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
195 One of NOT_STARTED, RUNNING, FINISHED
198 (out,err), proc = lexec(
199 # Check only by pid. pid+ppid does not always work (especially with sudo)
200 " (( ps --pid %(pid)d -o pid | grep -c %(pid)d && echo 'wait') || echo 'done' ) | tail -n 1" % {
206 return ProcStatus.NOT_STARTED
210 status = (out.strip() == 'wait')
212 return ProcStatus.NOT_STARTED
214 return ProcStatus.RUNNING if status else ProcStatus.FINISHED
216 def lkill(pid, ppid, sudo = False):
218 Kill a process spawned with lspawn.
220 First tries a SIGTERM, and if the process does not end in 10 seconds,
224 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
226 sudo: whether the command was run with sudo - careful killing like this.
230 Nothing, should have killed the process
233 subkill = "$(ps --ppid %(pid)d -o pid h)" % { 'pid' : pid }
235 SUBKILL="%(subkill)s" ;
236 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
237 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
238 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
240 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` == '0' ]; then
243 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
244 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
248 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` != '0' ]; then
249 %(sudo)s kill -9 -- -%(pid)d $SUBKILL || /bin/true
250 %(sudo)s kill -9 %(pid)d $SUBKILL || /bin/true
254 cmd = "( %s ) >/dev/null 2>/dev/null </dev/null &" % (cmd,)
256 (out,err),proc = lexec(
260 'sudo' : 'sudo -S' if sudo else '',