procutil.py 20.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
# procutil.py - utility for managing processes and executable environment
#
#  Copyright 2005 K. Thananchayan <thananck@yahoo.com>
#  Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
#  Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.

from __future__ import absolute_import

12
import contextlib
13
import errno
14
15
16
17
18
import io
import os
import signal
import subprocess
import sys
19
import threading
20
21
22
import time

from ..i18n import _
23
24
25
26
from ..pycompat import (
    getattr,
    open,
)
27
28
29
30
31
32
33
34

from .. import (
    encoding,
    error,
    policy,
    pycompat,
)

35
36
37
# Import like this to keep import-checker happy
from ..utils import resourceutil

38
osutil = policy.importmod('osutil')
39

40
41
42
43
44
if pycompat.iswindows:
    from .. import windows as platform
else:
    from .. import posix as platform

45

46
47
48
49
50
51
def isatty(fp):
    try:
        return fp.isatty()
    except AttributeError:
        return False

52

53
54
55
class LineBufferedWrapper(object):
    def __init__(self, orig):
        self.orig = orig
56

57
58
    def __getattr__(self, attr):
        return getattr(self.orig, attr)
59

60
61
62
63
64
65
    def write(self, s):
        orig = self.orig
        res = orig.write(s)
        if s.endswith(b'\n'):
            orig.flush()
        return res
66

67
68

io.BufferedIOBase.register(LineBufferedWrapper)
69
70


71
72
73
74
75
76
77
78
79
80
81
82
def make_line_buffered(stream):
    if pycompat.ispy3 and not isinstance(stream, io.BufferedIOBase):
        # On Python 3, buffered streams can be expected to subclass
        # BufferedIOBase. This is definitively the case for the streams
        # initialized by the interpreter. For unbuffered streams, we don't need
        # to emulate line buffering.
        return stream
    if isinstance(stream, LineBufferedWrapper):
        return stream
    return LineBufferedWrapper(stream)


83
84
85
86
87
88
89
90
91
92
if pycompat.ispy3:
    # TODO: .buffer might not exist if std streams were replaced; we'll need
    # a silly wrapper to make a bytes stream backed by a unicode one.
    stdin = sys.stdin.buffer
    stdout = sys.stdout.buffer
    stderr = sys.stderr.buffer
else:
    stdin = sys.stdin
    stdout = sys.stdout
    stderr = sys.stderr
93

94
95
96
if pycompat.iswindows:
    stdout = platform.winstdout(stdout)

97
98
# glibc determines buffering on first write to stdout - if we replace a TTY
# destined stdout with a pipe destined stdout (e.g. pager), we want line
99
# buffering.
100
if isatty(stdout):
101
    if pycompat.ispy3 or pycompat.iswindows:
102
        # On Python 3, buffered binary streams can't be set line-buffered.
103
        # On Python 2, Windows doesn't support line buffering.
104
        # Therefore we have a wrapper that implements line buffering.
105
        stdout = make_line_buffered(stdout)
106
    else:
107
        stdout = os.fdopen(stdout.fileno(), 'wb', 1)
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


findexe = platform.findexe
_gethgcmd = platform.gethgcmd
getuser = platform.getuser
getpid = os.getpid
hidewindow = platform.hidewindow
readpipe = platform.readpipe
setbinary = platform.setbinary
setsignalhandler = platform.setsignalhandler
shellquote = platform.shellquote
shellsplit = platform.shellsplit
spawndetached = platform.spawndetached
sshargs = platform.sshargs
testpid = platform.testpid

try:
    setprocname = osutil.setprocname
except AttributeError:
    pass
try:
    unblocksignal = osutil.unblocksignal
except AttributeError:
    pass

closefds = pycompat.isposix

135

136
def explainexit(code):
137
    """return a message describing a subprocess status
138
139
    (codes from kill are negative - not os.system/wait encoding)"""
    if code >= 0:
140
141
        return _(b"exited with status %d") % code
    return _(b"killed by signal %d") % -code
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
class _pfile(object):
    """File-like wrapper for a stream opened by subprocess.Popen()"""

    def __init__(self, proc, fp):
        self._proc = proc
        self._fp = fp

    def close(self):
        # unlike os.popen(), this returns an integer in subprocess coding
        self._fp.close()
        return self._proc.wait()

    def __iter__(self):
        return iter(self._fp)

    def __getattr__(self, attr):
        return getattr(self._fp, attr)

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_value, exc_tb):
        self.close()

168

169
170
def popen(cmd, mode=b'rb', bufsize=-1):
    if mode == b'rb':
171
        return _popenreader(cmd, bufsize)
172
    elif mode == b'wb':
173
        return _popenwriter(cmd, bufsize)
174
    raise error.ProgrammingError(b'unsupported mode: %r' % mode)
175

176

177
def _popenreader(cmd, bufsize):
178
    p = subprocess.Popen(
179
        tonativestr(cmd),
180
181
182
183
184
        shell=True,
        bufsize=bufsize,
        close_fds=closefds,
        stdout=subprocess.PIPE,
    )
185
186
    return _pfile(p, p.stdout)

187

188
def _popenwriter(cmd, bufsize):
189
    p = subprocess.Popen(
190
        tonativestr(cmd),
191
192
193
194
195
        shell=True,
        bufsize=bufsize,
        close_fds=closefds,
        stdin=subprocess.PIPE,
    )
196
197
    return _pfile(p, p.stdin)

198

199
def popen2(cmd, env=None):
200
201
202
    # Setting bufsize to -1 lets the system decide the buffer size.
    # The default for bufsize is 0, meaning unbuffered. This leads to
    # poor performance on Mac OS X: http://bugs.python.org/issue4194
203
204
205
206
207
208
209
210
211
    p = subprocess.Popen(
        tonativestr(cmd),
        shell=True,
        bufsize=-1,
        close_fds=closefds,
        stdin=subprocess.PIPE,
        stdout=subprocess.PIPE,
        env=tonativeenv(env),
    )
212
213
    return p.stdin, p.stdout

214

215
216
def popen3(cmd, env=None):
    stdin, stdout, stderr, p = popen4(cmd, env)
217
218
    return stdin, stdout, stderr

219

220
def popen4(cmd, env=None, bufsize=-1):
221
222
223
224
225
226
227
228
229
230
    p = subprocess.Popen(
        tonativestr(cmd),
        shell=True,
        bufsize=bufsize,
        close_fds=closefds,
        stdin=subprocess.PIPE,
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE,
        env=tonativeenv(env),
    )
231
232
    return p.stdin, p.stdout, p.stderr, p

233

234
235
def pipefilter(s, cmd):
    '''filter string S through command CMD, returning its output'''
236
237
238
239
240
241
242
    p = subprocess.Popen(
        tonativestr(cmd),
        shell=True,
        close_fds=closefds,
        stdin=subprocess.PIPE,
        stdout=subprocess.PIPE,
    )
243
244
245
    pout, perr = p.communicate(s)
    return pout

246

247
248
249
250
251
252
253
def tempfilter(s, cmd):
    '''filter string S through a pair of temporary files with CMD.
    CMD is used as a template to create the real command to be run,
    with the strings INFILE and OUTFILE replaced by the real names of
    the temporary files generated.'''
    inname, outname = None, None
    try:
254
        infd, inname = pycompat.mkstemp(prefix=b'hg-filter-in-')
255
        fp = os.fdopen(infd, 'wb')
256
257
        fp.write(s)
        fp.close()
258
        outfd, outname = pycompat.mkstemp(prefix=b'hg-filter-out-')
259
        os.close(outfd)
260
261
        cmd = cmd.replace(b'INFILE', inname)
        cmd = cmd.replace(b'OUTFILE', outname)
262
        code = system(cmd)
263
        if pycompat.sysplatform == b'OpenVMS' and code & 1:
264
265
            code = 0
        if code:
266
            raise error.Abort(
267
                _(b"command '%s' failed: %s") % (cmd, explainexit(code))
268
            )
269
        with open(outname, b'rb') as fp:
270
271
272
273
274
275
276
277
278
279
280
281
282
            return fp.read()
    finally:
        try:
            if inname:
                os.unlink(inname)
        except OSError:
            pass
        try:
            if outname:
                os.unlink(outname)
        except OSError:
            pass

283

284
_filtertable = {
285
286
    b'tempfile:': tempfilter,
    b'pipe:': pipefilter,
287
288
}

289

290
def filter(s, cmd):
291
292
    """filter a string through a command that transforms its input to its
    output"""
293
    for name, fn in pycompat.iteritems(_filtertable):
294
        if cmd.startswith(name):
295
            return fn(s, cmd[len(name) :].lstrip())
296
297
    return pipefilter(s, cmd)

298

299
300
_hgexecutable = None

301

302
303
304
305
306
307
def hgexecutable():
    """return location of the 'hg' executable.

    Defaults to $HG or 'hg' in the search path.
    """
    if _hgexecutable is None:
308
        hg = encoding.environ.get(b'HG')
309
        mainmod = sys.modules['__main__']
310
311
        if hg:
            _sethgexecutable(hg)
312
        elif resourceutil.mainfrozen():
313
            if getattr(sys, 'frozen', None) == 'macosx_app':
314
                # Env variable set by py2app
315
                _sethgexecutable(encoding.environ[b'EXECUTABLEPATH'])
316
317
            else:
                _sethgexecutable(pycompat.sysexecutable)
318
319
        elif (
            not pycompat.iswindows
320
            and os.path.basename(getattr(mainmod, '__file__', '')) == 'hg'
321
        ):
322
323
            _sethgexecutable(pycompat.fsencode(mainmod.__file__))
        else:
324
            _sethgexecutable(
325
                findexe(b'hg') or os.path.basename(pycompat.sysargv[0])
326
            )
327
328
    return _hgexecutable

329

330
331
332
333
334
def _sethgexecutable(path):
    """set location of the 'hg' executable"""
    global _hgexecutable
    _hgexecutable = path

335

336
337
338
339
340
def _testfileno(f, stdf):
    fileno = getattr(f, 'fileno', None)
    try:
        return fileno and fileno() == stdf.fileno()
    except io.UnsupportedOperation:
341
342
        return False  # fileno() raised UnsupportedOperation

343
344
345
346

def isstdin(f):
    return _testfileno(f, sys.__stdin__)

347

348
349
350
def isstdout(f):
    return _testfileno(f, sys.__stdout__)

351

352
def protectstdio(uin, uout):
353
354
355
356
    """Duplicate streams and redirect original if (uin, uout) are stdio

    If uin is stdin, it's redirected to /dev/null. If uout is stdout, it's
    redirected to stderr so the output is still readable.
357
358
359
360
361
362

    Returns (fin, fout) which point to the original (uin, uout) fds, but
    may be copy of (uin, uout). The returned streams can be considered
    "owned" in that print(), exec(), etc. never reach to them.
    """
    uout.flush()
363
    fin, fout = uin, uout
364
    if _testfileno(uin, stdin):
365
        newfd = os.dup(uin.fileno())
366
        nullfd = os.open(os.devnull, os.O_RDONLY)
367
        os.dup2(nullfd, uin.fileno())
368
        os.close(nullfd)
369
        fin = os.fdopen(newfd, 'rb')
370
    if _testfileno(uout, stdout):
371
        newfd = os.dup(uout.fileno())
372
        os.dup2(stderr.fileno(), uout.fileno())
373
        fout = os.fdopen(newfd, 'wb')
374
    return fin, fout
375

376

377
378
379
380
381
382
383
384
def restorestdio(uin, uout, fin, fout):
    """Restore (uin, uout) streams from possibly duplicated (fin, fout)"""
    uout.flush()
    for f, uif in [(fin, uin), (fout, uout)]:
        if f is not uif:
            os.dup2(f.fileno(), uif.fileno())
            f.close()

385

386
387
def shellenviron(environ=None):
    """return environ with optional override, useful for shelling out"""
388

389
    def py2shell(val):
390
        """convert python object into string that is useful to shell"""
391
        if val is None or val is False:
392
            return b'0'
393
        if val is True:
394
            return b'1'
395
        return pycompat.bytestr(val)
396

397
398
    env = dict(encoding.environ)
    if environ:
399
        env.update((k, py2shell(v)) for k, v in pycompat.iteritems(environ))
400
    env[b'HG'] = hgexecutable()
401
402
    return env

403

404
if pycompat.iswindows:
405

406
    def shelltonative(cmd, env):
407
408
409
        return platform.shelltocmdexe(  # pytype: disable=module-attr
            cmd, shellenviron(env)
        )
410
411

    tonativestr = encoding.strfromlocal
412
else:
413

414
415
416
    def shelltonative(cmd, env):
        return cmd

417
418
    tonativestr = pycompat.identity

419

420
421
422
423
424
def tonativeenv(env):
    '''convert the environment from bytes to strings suitable for Popen(), etc.
    '''
    return pycompat.rapply(tonativestr, env)

425

426
427
428
429
430
431
432
433
434
435
436
437
def system(cmd, environ=None, cwd=None, out=None):
    '''enhanced shell command execution.
    run with environment maybe modified, maybe in different dir.

    if out is specified, it is assumed to be a file-like object that has a
    write() method. stdout and stderr will be redirected to out.'''
    try:
        stdout.flush()
    except Exception:
        pass
    env = shellenviron(environ)
    if out is None or isstdout(out):
438
439
440
441
442
443
444
        rc = subprocess.call(
            tonativestr(cmd),
            shell=True,
            close_fds=closefds,
            env=tonativeenv(env),
            cwd=pycompat.rapply(tonativestr, cwd),
        )
445
    else:
446
447
448
449
450
451
452
453
454
        proc = subprocess.Popen(
            tonativestr(cmd),
            shell=True,
            close_fds=closefds,
            env=tonativeenv(env),
            cwd=pycompat.rapply(tonativestr, cwd),
            stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT,
        )
455
        for line in iter(proc.stdout.readline, b''):
456
457
458
            out.write(line)
        proc.wait()
        rc = proc.returncode
459
    if pycompat.sysplatform == b'OpenVMS' and rc & 1:
460
461
462
        rc = 0
    return rc

463

464
465
466
467
_is_gui = None


def _gui():
468
469
    '''Are we running in a GUI?'''
    if pycompat.isdarwin:
470
        if b'SSH_CONNECTION' in encoding.environ:
471
472
473
474
475
476
477
478
479
            # handle SSH access to a box where the user is logged in
            return False
        elif getattr(osutil, 'isgui', None):
            # check if a CoreGraphics session is available
            return osutil.isgui()
        else:
            # pure build; use a safe default
            return True
    else:
480
        return pycompat.iswindows or encoding.environ.get(b"DISPLAY")
481

482

483
484
485
486
487
488
489
def gui():
    global _is_gui
    if _is_gui is None:
        _is_gui = _gui()
    return _is_gui


490
491
492
493
494
495
496
def hgcmd():
    """Return the command used to execute current hg

    This is different from hgexecutable() because on Windows we want
    to avoid things opening new shell windows like batch files, so we
    get either the python call or current executable.
    """
497
    if resourceutil.mainfrozen():
498
        if getattr(sys, 'frozen', None) == 'macosx_app':
499
            # Env variable set by py2app
500
            return [encoding.environ[b'EXECUTABLEPATH']]
501
502
503
504
        else:
            return [pycompat.sysexecutable]
    return _gethgcmd()

505

506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
def rundetached(args, condfn):
    """Execute the argument list in a detached process.

    condfn is a callable which is called repeatedly and should return
    True once the child process is known to have started successfully.
    At this point, the child process PID is returned. If the child
    process fails to start or finishes before condfn() evaluates to
    True, return -1.
    """
    # Windows case is easier because the child process is either
    # successfully starting and validating the condition or exiting
    # on failure. We just poll on its PID. On Unix, if the child
    # process fails to start, it will be left in a zombie state until
    # the parent wait on it, which we cannot do since we expect a long
    # running process on success. Instead we listen for SIGCHLD telling
    # us our child process terminated.
    terminated = set()
523

524
525
    def handler(signum, frame):
        terminated.add(os.wait())
526

527
528
529
530
531
532
533
    prevhandler = None
    SIGCHLD = getattr(signal, 'SIGCHLD', None)
    if SIGCHLD is not None:
        prevhandler = signal.signal(SIGCHLD, handler)
    try:
        pid = spawndetached(args)
        while not condfn():
534
            if (pid in terminated or not testpid(pid)) and not condfn():
535
536
537
538
539
540
                return -1
            time.sleep(0.1)
        return pid
    finally:
        if prevhandler is not None:
            signal.signal(signal.SIGCHLD, prevhandler)
541

542

543
@contextlib.contextmanager
544
def uninterruptible(warn):
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
    """Inhibit SIGINT handling on a region of code.

    Note that if this is called in a non-main thread, it turns into a no-op.

    Args:
      warn: A callable which takes no arguments, and returns True if the
            previous signal handling should be restored.
    """

    oldsiginthandler = [signal.getsignal(signal.SIGINT)]
    shouldbail = []

    def disabledsiginthandler(*args):
        if warn():
            signal.signal(signal.SIGINT, oldsiginthandler[0])
            del oldsiginthandler[0]
        shouldbail.append(True)

    try:
        try:
            signal.signal(signal.SIGINT, disabledsiginthandler)
        except ValueError:
            # wrong thread, oh well, we tried
            del oldsiginthandler[0]
        yield
    finally:
        if oldsiginthandler:
            signal.signal(signal.SIGINT, oldsiginthandler[0])
        if shouldbail:
            raise KeyboardInterrupt
575

576

577
578
579
580
581
if pycompat.iswindows:
    # no fork on Windows, but we can create a detached process
    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms684863.aspx
    # No stdlib constant exists for this value
    DETACHED_PROCESS = 0x00000008
582
583
584
    # Following creation flags might create a console GUI window.
    # Using subprocess.CREATE_NEW_CONSOLE might helps.
    # See https://phab.mercurial-scm.org/D1701 for discussion
585
586
587
588
    _creationflags = (
        DETACHED_PROCESS
        | subprocess.CREATE_NEW_PROCESS_GROUP  # pytype: disable=module-attr
    )
589

590
    def runbgcommand(
591
592
593
594
595
596
597
        script,
        env,
        shell=False,
        stdout=None,
        stderr=None,
        ensurestart=True,
        record_wait=None,
598
    ):
599
600
601
        '''Spawn a command without waiting for it to finish.'''
        # we can't use close_fds *and* redirect stdin. I'm not sure that we
        # need to because the detached process has no console connection.
602
        p = subprocess.Popen(
603
            tonativestr(script),
604
605
606
607
608
609
610
            shell=shell,
            env=tonativeenv(env),
            close_fds=True,
            creationflags=_creationflags,
            stdout=stdout,
            stderr=stderr,
        )
611
612
        if record_wait is not None:
            record_wait(p.wait)
613
614


615
else:
616

617
    def runbgcommand(
618
619
620
621
622
623
624
        cmd,
        env,
        shell=False,
        stdout=None,
        stderr=None,
        ensurestart=True,
        record_wait=None,
625
    ):
626
627
628
629
630
631
632
633
        '''Spawn a command without waiting for it to finish.


        When `record_wait` is not None, the spawned process will not be fully
        detached and the `record_wait` argument will be called with a the
        `Subprocess.wait` function for the spawned process.  This is mostly
        useful for developers that need to make sure the spawned process
        finished before a certain point. (eg: writing test)'''
634
635
636
637
638
        if pycompat.isdarwin:
            # avoid crash in CoreFoundation in case another thread
            # calls gui() while we're calling fork().
            gui()

639
640
        # double-fork to completely detach from the parent process
        # based on http://code.activestate.com/recipes/278731
641
642
643
644
        if record_wait is None:
            pid = os.fork()
            if pid:
                if not ensurestart:
645
646
647
648
649
650
651
                    # Even though we're not waiting on the child process,
                    # we still must call waitpid() on it at some point so
                    # it's not a zombie/defunct. This is especially relevant for
                    # chg since the parent process won't die anytime soon.
                    # We use a thread to make the overhead tiny.
                    def _do_wait():
                        os.waitpid(pid, 0)
652

653
654
655
                    t = threading.Thread(target=_do_wait)
                    t.daemon = True
                    t.start()
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
                    return
                # Parent process
                (_pid, status) = os.waitpid(pid, 0)
                if os.WIFEXITED(status):
                    returncode = os.WEXITSTATUS(status)
                else:
                    returncode = -(os.WTERMSIG(status))
                if returncode != 0:
                    # The child process's return code is 0 on success, an errno
                    # value on failure, or 255 if we don't have a valid errno
                    # value.
                    #
                    # (It would be slightly nicer to return the full exception info
                    # over a pipe as the subprocess module does.  For now it
                    # doesn't seem worth adding that complexity here, though.)
                    if returncode == 255:
                        returncode = errno.EINVAL
                    raise OSError(
                        returncode,
                        b'error running %r: %s'
                        % (cmd, os.strerror(returncode)),
                    )
678
                return
679
680
681

        returncode = 255
        try:
682
683
684
            if record_wait is None:
                # Start a new session
                os.setsid()
685

686
            stdin = open(os.devnull, b'r')
687
            if stdout is None:
688
                stdout = open(os.devnull, b'w')
689
            if stderr is None:
690
                stderr = open(os.devnull, b'w')
691
692
693

            # connect stdin to devnull to make sure the subprocess can't
            # muck up that stream for mercurial.
694
            p = subprocess.Popen(
695
696
697
698
699
700
701
702
                cmd,
                shell=shell,
                env=env,
                close_fds=True,
                stdin=stdin,
                stdout=stdout,
                stderr=stderr,
            )
703
704
            if record_wait is not None:
                record_wait(p.wait)
705
706
            returncode = 0
        except EnvironmentError as ex:
707
            returncode = ex.errno & 0xFF
708
709
710
711
712
713
714
715
716
            if returncode == 0:
                # This shouldn't happen, but just in case make sure the
                # return code is never 0 here.
                returncode = 255
        except Exception:
            returncode = 255
        finally:
            # mission accomplished, this child needs to exit and not
            # continue the hg process here.
717
718
            if record_wait is None:
                os._exit(returncode)