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
30 Executes a local command, returns ((stdout,stderr),process)
34 for envkey, envval in env.iteritems():
35 export += '%s=%s ' % (envkey, envval)
36 command = "%s %s" % (export, command)
39 command = "sudo %s" % command
41 command = "su %s ; %s " % (user, command)
44 proc = subprocess.Popen(command, shell=True,
45 stdout = subprocess.PIPE,
46 stderr = subprocess.PIPE)
49 out, err = proc.communicate()
50 return ((out, err), proc)
52 def lcopy(source, dest, recursive = False):
54 Copies from/to localy.
58 print "scp", source, dest
67 proc = subprocess.Popen(command,
68 stdout=subprocess.PIPE,
69 stderr=subprocess.PIPE)
71 out, err = p.communicate()
72 return ((out, err), proc)
74 def lspawn(command, pidfile,
83 Spawn a local command such that it will continue working asynchronously.
86 command: the command to run - it should be a single line.
88 pidfile: path of a (ideally unique to this task) pidfile for tracking the process.
90 stdout: path of a file to redirect standard output to - must be a string.
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
96 home: path of a folder to use as working directory - should exist, unless you specify create_home
98 create_home: if True, the home folder will be created first with mkdir -p
100 sudo: whether the command needs to be executed as root
103 (stdout, stderr), process
105 Of the spawning process, which only captures errors at spawning time.
106 Usually only useful for diagnostics.
108 # Start process in a "daemonized" way, using nohup and heavy
109 # stdin/out redirection to avoid connection issues
113 stderr = ' ' + stderr
115 daemon_command = '{ { %(command)s > %(stdout)s 2>%(stderr)s < %(stdin)s & } ; echo $! 1 > %(pidfile)s ; }' % {
117 'pidfile' : shell_escape(pidfile),
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 '',
131 (out,err), proc = lexec(cmd)
134 raise RuntimeError, "Failed to set up application on host %s: %s %s" % (host, out,err,)
136 return ((out,err), proc)
138 def lgetpid(pidfile):
140 Check the pidfile of a process spawned with remote_spawn.
143 pidfile: the pidfile passed to remote_span
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).
151 (out,err), proc = lexec("cat %s" % pidfile )
158 return map(int,out.strip().split(' ',1))
160 # Ignore, many ways to fail that don't matter that much
163 def lstatus(pid, ppid):
165 Check the status of a process spawned with remote_spawn.
168 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
172 One of NOT_STARTED, RUNNING, FINISHED
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" % {
183 return ProcStatus.NOT_STARTED
187 status = (out.strip() == 'wait')
189 return ProcStatus.NOT_STARTED
191 return ProcStatus.RUNNING if status else ProcStatus.FINISHED
193 def lkill(pid, ppid, sudo = False):
195 Kill a process spawned with lspawn.
197 First tries a SIGTERM, and if the process does not end in 10 seconds,
201 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
203 sudo: whether the command was run with sudo - careful killing like this.
207 Nothing, should have killed the process
210 subkill = "$(ps --ppid %(pid)d -o pid h)" % { 'pid' : pid }
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
217 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` == '0' ]; then
220 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
221 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
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
231 cmd = "( %s ) >/dev/null 2>/dev/null </dev/null &" % (cmd,)
233 (out,err),proc = lexec(
237 'sudo' : 'sudo -S' if sudo else '',