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 version 2 as
7 # published by the Free Software Foundation;
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 from nepi.util.sshfuncs import ProcStatus, STDOUT, log, shell_escape
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 # XXX: Doing 'su user' blocks waiting for a password on stdin
43 # command = "su %s ; %s " % (user, command)
45 proc = subprocess.Popen(command,
47 stdout = subprocess.PIPE,
48 stderr = subprocess.PIPE)
51 log_msg = "lexec - command %s " % command
54 out, err = proc.communicate()
55 log(log_msg, logging.DEBUG, out, err)
57 log(log_msg, logging.ERROR, out, err)
60 return ((out, err), proc)
62 def lcopy(source, dest, recursive = False):
64 Copies from/to localy.
71 if isinstance(source, list):
76 if isinstance(dest, list):
81 proc = subprocess.Popen(args,
82 stdout=subprocess.PIPE,
83 stderr=subprocess.PIPE)
86 command = " ".join(args)
87 log_msg = " lcopy - command %s " % command
90 out, err = proc.communicate()
91 log(log_msg, logging.DEBUG, out, err)
93 log(log_msg, logging.ERROR, out, err)
96 return ((out, err), proc)
98 def lspawn(command, pidfile,
107 Spawn a local command such that it will continue working asynchronously.
110 command: the command to run - it should be a single line.
112 pidfile: path of a (ideally unique to this task) pidfile for tracking the process.
114 stdout: path of a file to redirect standard output to - must be a string.
115 Defaults to /dev/null
116 stderr: path of a file to redirect standard error to - string or the special STDOUT value
117 to redirect to the same file stdout was redirected to. Defaults to STDOUT.
118 stdin: path of a file with input to be piped into the command's standard input
120 home: path of a folder to use as working directory - should exist, unless you specify create_home
122 create_home: if True, the home folder will be created first with mkdir -p
124 sudo: whether the command needs to be executed as root
127 (stdout, stderr), process
129 Of the spawning process, which only captures errors at spawning time.
130 Usually only useful for diagnostics.
132 # Start process in a "daemonized" way, using nohup and heavy
133 # stdin/out redirection to avoid connection issues
137 stderr = ' ' + stderr
139 daemon_command = '{ { %(command)s > %(stdout)s 2>%(stderr)s < %(stdin)s & } ; echo $! 1 > %(pidfile)s ; }' % {
141 'pidfile' : shell_escape(pidfile),
147 cmd = "%(create)s%(gohome)s rm -f %(pidfile)s ; %(sudo)s bash -c %(command)s " % {
148 'command' : shell_escape(daemon_command),
149 'sudo' : 'sudo -S' if sudo else '',
150 'pidfile' : shell_escape(pidfile),
151 'gohome' : 'cd %s ; ' % (shell_escape(home),) if home else '',
152 'create' : 'mkdir -p %s ; ' % (shell_escape(home),) if create_home else '',
155 (out,err), proc = lexec(cmd)
158 raise RuntimeError, "Failed to set up application on host %s: %s %s" % (host, out,err,)
160 return ((out,err), proc)
162 def lgetpid(pidfile):
164 Check the pidfile of a process spawned with remote_spawn.
167 pidfile: the pidfile passed to remote_span
171 A (pid, ppid) tuple useful for calling remote_status and remote_kill,
172 or None if the pidfile isn't valid yet (maybe the process is still starting).
175 (out,err), proc = lexec("cat %s" % pidfile )
182 return map(int,out.strip().split(' ',1))
184 # Ignore, many ways to fail that don't matter that much
187 def lstatus(pid, ppid):
189 Check the status of a process spawned with remote_spawn.
192 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
196 One of NOT_STARTED, RUNNING, FINISHED
199 (out,err), proc = lexec(
200 # Check only by pid. pid+ppid does not always work (especially with sudo)
201 " (( ps --pid %(pid)d -o pid | grep -c %(pid)d && echo 'wait') || echo 'done' ) | tail -n 1" % {
207 return ProcStatus.NOT_STARTED
211 status = (out.strip() == 'wait')
213 return ProcStatus.NOT_STARTED
215 return ProcStatus.RUNNING if status else ProcStatus.FINISHED
217 def lkill(pid, ppid, sudo = False):
219 Kill a process spawned with lspawn.
221 First tries a SIGTERM, and if the process does not end in 10 seconds,
225 pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid
227 sudo: whether the command was run with sudo - careful killing like this.
231 Nothing, should have killed the process
234 subkill = "$(ps --ppid %(pid)d -o pid h)" % { 'pid' : pid }
236 SUBKILL="%(subkill)s" ;
237 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
238 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
239 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
241 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` == '0' ]; then
244 %(sudo)s kill -- -%(pid)d $SUBKILL || /bin/true
245 %(sudo)s kill %(pid)d $SUBKILL || /bin/true
249 if [ `ps --pid %(pid)d -o pid | grep -c %(pid)d` != '0' ]; then
250 %(sudo)s kill -9 -- -%(pid)d $SUBKILL || /bin/true
251 %(sudo)s kill -9 %(pid)d $SUBKILL || /bin/true
255 cmd = "( %s ) >/dev/null 2>/dev/null </dev/null &" % (cmd,)
257 (out,err),proc = lexec(
261 'sudo' : 'sudo -S' if sudo else '',