1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
|
"""
subprocess related functionality
"""
__all__ = [
"cleanup_pids",
"spawn",
"spawn_sandbox",
"spawn_bash",
"spawn_get_output",
"bash_version",
]
import atexit
import itertools
import os
import signal
import sys
from ..mappings import ProtectedDict
from ..osutils import access
from . import find_binary
BASH_BINARY = find_binary("bash", fallback="/bin/bash")
SANDBOX_BINARY = find_binary("sandbox", fallback="/usr/bin/sandbox")
try:
import resource
max_fd_limit = resource.getrlimit(resource.RLIMIT_NOFILE)[0]
except ImportError:
max_fd_limit = 256
def bash_version(force=False):
"""Get the system bash version of the form major.minor.patch."""
if not force:
try:
return bash_version.cached_result
except AttributeError:
pass
try:
ret, ver = spawn_get_output(
[
BASH_BINARY,
"--norc",
"--noprofile",
"-c",
"printf ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}.${BASH_VERSINFO[2]}",
]
)
if ret == 0:
try:
ver = ver[0]
except IndexError:
ver = None
else:
ver = None
except ExecutionFailure:
ver = None
bash_version.cached_result = ver
return ver
def spawn_bash(mycommand, debug=False, name=None, **kwds):
"""spawn the command via bash -c"""
args = [BASH_BINARY, "--norc", "--noprofile"]
if debug:
# Print commands and their arguments as they are executed.
args.append("-x")
args.append("-c")
if isinstance(mycommand, str):
args.append(mycommand)
else:
args.extend(mycommand)
if name is None:
name = os.path.basename(args[3])
return spawn(args, name=name, **kwds)
def spawn_sandbox(mycommand, name=None, **kwds):
"""spawn the command under sandboxed"""
if not is_sandbox_capable():
return spawn_bash(mycommand, name=name, **kwds)
args = [SANDBOX_BINARY]
if isinstance(mycommand, str):
args.extend(mycommand.split())
else:
args.extend(mycommand)
if name is None:
name = os.path.basename(args[1])
return spawn(args, name=name, **kwds)
_exithandlers = []
def atexit_register(func, *args, **kargs):
"""Wrapper around atexit.register that is needed in order to track
what is registered. For example, when portage restarts itself via
os.execv, the atexit module does not work so we have to do it
manually by calling the run_exitfuncs() function in this module."""
_exithandlers.append((func, args, kargs))
def run_exitfuncs():
"""This should behave identically to the routine performed by
the atexit module at exit time. It's only necessary to call this
function when atexit will not work (because of os.execv, for
example)."""
exc_info = None
while _exithandlers:
func, targs, kargs = _exithandlers.pop()
try:
func(*targs, **kargs)
except SystemExit:
exc_info = sys.exc_info()
except:
exc_info = sys.exc_info()
if exc_info is not None:
raise exc_info[0](exc_info[1]).with_traceback(exc_info[2])
atexit.register(run_exitfuncs)
# We need to make sure that any processes spawned are killed off when
# we exit. spawn() takes care of adding and removing pids to this list
# as it creates and cleans up processes.
spawned_pids = []
def cleanup_pids(pids=None):
"""reap list of pids if specified, else all children"""
global spawned_pids
if pids is None:
pids = spawned_pids
elif pids is not spawned_pids:
pids = list(pids)
while pids:
pid = pids.pop()
try:
if os.waitpid(pid, os.WNOHANG) == (0, 0):
os.kill(pid, signal.SIGTERM)
os.waitpid(pid, 0)
except OSError:
# This pid has been cleaned up outside
# of spawn().
pass
if spawned_pids is not pids:
try:
spawned_pids.remove(pid)
except ValueError:
pass
def spawn(
mycommand,
env=None,
name=None,
fd_pipes=None,
returnpid=False,
uid=None,
gid=None,
groups=None,
umask=None,
cwd=None,
pgid=None,
):
"""wrapper around execve
:type mycommand: list or string
:type env: mapping with string keys and values
:param name: controls what the process is named
(what it would show up as under top for example)
:type fd_pipes: mapping from existing fd to fd (inside the new process)
:param fd_pipes: controls what fd's are left open in the spawned process-
:param returnpid: controls whether spawn waits for the process to finish,
or returns the pid.
"""
# mycommand is either a str or a list
if isinstance(mycommand, str):
mycommand = mycommand.split()
# If an absolute path to an name file isn't given
# search for it unless we've been told not to.
binary = find_binary(mycommand[0])
# mypids will hold the pids of all processes created.
mypids = []
pid = os.fork()
if not pid:
# 'Catch "Exception"'
# pylint: disable-msg=W0703
try:
_exec(
binary,
mycommand,
name,
fd_pipes,
env,
gid,
groups,
uid,
umask,
cwd,
pgid,
)
except Exception as e:
# We need to catch _any_ exception so that it doesn't
# propogate out of this function and cause exiting
# with anything other than os._exit()
sys.stderr.write("%s:\n %s\n" % (e, " ".join(mycommand)))
os._exit(1)
# Add the pid to our local and the global pid lists.
mypids.append(pid)
spawned_pids.append(pid)
# If the caller wants to handle cleaning up the processes, we tell
# it about all processes that were created.
if returnpid:
return mypids
try:
# Otherwise we clean them up.
while mypids:
# Pull the last reader in the pipe chain. If all processes
# in the pipe are well behaved, it will die when the process
# it is reading from dies.
pid = mypids.pop(0)
# and wait for it.
retval = os.waitpid(pid, 0)[1]
# When it's done, we can remove it from the
# global pid list as well.
spawned_pids.remove(pid)
if retval:
# If it failed, kill off anything else that
# isn't dead yet.
for pid in mypids:
if os.waitpid(pid, os.WNOHANG) == (0, 0):
os.kill(pid, signal.SIGTERM)
os.waitpid(pid, 0)
spawned_pids.remove(pid)
return process_exit_code(retval)
finally:
cleanup_pids(mypids)
# Everything succeeded
return 0
def _exec(
binary,
mycommand,
name=None,
fd_pipes=None,
env=None,
gid=None,
groups=None,
uid=None,
umask=None,
cwd=None,
pgid=None,
):
"""internal function to handle exec'ing the child process.
If it succeeds this function does not return. It might raise an
exception, and since this runs after fork calling code needs to
make sure this is caught and os._exit is called if it does (or
atexit handlers run twice).
"""
if env is None:
env = {}
# If the process we're creating hasn't been given a name
# assign it the name of the binary.
if name is None:
name = os.path.basename(binary)
# Set up the command's argument list.
myargs = [name]
myargs.extend(mycommand[1:])
def _find_unused_pid(protected):
for potential in itertools.count():
if potential not in protected:
protected.add(potential)
yield potential
# If we haven't been told what file descriptors to use
# default to propogating our stdin, stdout and stderr.
if fd_pipes is None:
fd_pipes = {0: 0, 1: 1, 2: 2}
# Set up the command's pipes.
my_fds = {}
# To protect from cases where direct assignment could
# clobber needed fds ({1:2, 2:1}) we first dupe the fds
# into unused fds.
protected = set(fd_pipes)
protected.update(fd_pipes.values())
fd_source = _find_unused_pid(protected)
for trg_fd, src_fd in fd_pipes.items():
if trg_fd != src_fd:
if trg_fd not in protected:
# Nothing is in the way; move it immediately.
os.dup2(src_fd, trg_fd)
else:
x = my_fds[trg_fd] = next(fd_source)
os.dup2(src_fd, x)
# reassign whats required now.
for trg_fd, src_fd in my_fds.items():
os.dup2(src_fd, trg_fd)
# Then close _all_ fds that haven't been explicitly
# requested to be kept open.
last = 0
for fd in sorted(fd_pipes):
if fd != last:
os.closerange(last, fd)
last = fd + 1
os.closerange(last, max_fd_limit)
if cwd is not None:
os.chdir(cwd)
# Set requested process permissions.
if gid is not None:
os.setgid(gid)
if groups is not None:
os.setgroups(groups)
if uid is not None:
os.setuid(uid)
if umask is not None:
os.umask(umask)
if pgid is not None:
os.setpgid(0, pgid)
# finally, we reset the signal handlers that python screws with back to defaults.
# gentoo bug #309001, #289486
signal.signal(signal.SIGPIPE, signal.SIG_DFL)
signal.signal(signal.SIGQUIT, signal.SIG_DFL)
# unneeded, but being paranoid should spawn grow a spawn_func target again.
signal.signal(signal.SIGINT, signal.SIG_DFL)
signal.signal(signal.SIGTERM, signal.SIG_DFL)
signal.signal(signal.SIGCHLD, signal.SIG_DFL)
# And switch to the new process.
os.execve(binary, myargs, env)
def spawn_get_output(
mycommand,
spawn_type=None,
raw_exit_code=False,
collect_fds=(1,),
fd_pipes=None,
split_lines=True,
**kwds,
):
"""Call spawn, collecting the output to fd's specified in collect_fds list.
:param spawn_type: the passed in function to call- typically :func:`spawn_bash`
:func:`spawn`, or :func:`spawn_sandbox`.
Defaults to :func:`spawn`.
"""
if spawn_type is None:
spawn_type = spawn
pr, pw = None, None
if fd_pipes is None:
fd_pipes = {0: 0}
else:
fd_pipes = ProtectedDict(fd_pipes)
try:
pr, pw = os.pipe()
for x in collect_fds:
fd_pipes[x] = pw
kwds["returnpid"] = True
mypid = spawn_type(mycommand, fd_pipes=fd_pipes, **kwds)
os.close(pw)
pw = None
if not isinstance(mypid, (list, tuple)):
raise ExecutionFailure()
fd = os.fdopen(pr, "r")
try:
if not split_lines:
mydata = fd.read()
else:
mydata = fd.readlines()
finally:
fd.close()
pw = None
retval = os.waitpid(mypid[0], 0)[1]
cleanup_pids(mypid)
if raw_exit_code:
return retval, mydata
return process_exit_code(retval), mydata
finally:
if pr is not None:
try:
os.close(pr)
except OSError:
pass
if pw is not None:
try:
os.close(pw)
except OSError:
pass
def process_exit_code(retval):
"""Process a waitpid returned exit code.
:return: The exit code if it exit'd, the signal if it died from signalling.
"""
# If it got a signal, return the signal that was sent.
if retval & 0xFF:
return (retval & 0xFF) << 8
# Otherwise, return its exit code.
return retval >> 8
class ExecutionFailure(Exception):
def __init__(self, msg):
super().__init__(msg)
self.msg = msg
def __str__(self):
return f"Execution Failure: {self.msg}"
# cached capabilities
def is_sandbox_capable(force=False):
if not force:
try:
return is_sandbox_capable.cached_result
except AttributeError:
pass
if "SANDBOX_ACTIVE" in os.environ:
# we can not spawn a sandbox inside another one
res = False
elif not (os.path.isfile(SANDBOX_BINARY) and access(SANDBOX_BINARY, os.X_OK)):
res = False
else:
try:
r, s = spawn_get_output([SANDBOX_BINARY, "--version"])
res = (r == 0) and ("gentoo" in s[0].lower())
except ExecutionFailure:
res = False
is_sandbox_capable.cached_result = res
return res
def is_userpriv_capable(force=False):
if not force:
try:
return is_userpriv_capable.cached_result
except AttributeError:
pass
res = is_userpriv_capable.cached_result = os.getuid() == 0
return res
|