lib/spawn-pipe.h

   1 /* Creation of subprocesses, communicating via pipes.
   2    Copyright (C) 2001-2003, 2006, 2008-2020 Free Software Foundation, Inc.
   3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
   4
   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.
   9
  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.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _SPAWN_PIPE_H
  19 #define _SPAWN_PIPE_H
  20
  21 /* Get pid_t.  */
  22 #include <stdlib.h>
  23 #include <unistd.h>
  24 #include <sys/types.h>
  25
  26 #include <stdbool.h>
  27
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33
  34 /* All these functions create a subprocess and don't wait for its termination.
  35    They return the process id of the subprocess.  They also return in fd[]
  36    one or two file descriptors for communication with the subprocess.
  37    If the subprocess creation fails: if exit_on_error is true, the main
  38    process exits with an error message; otherwise, an error message is given
  39    if null_stderr is false, then -1 is returned, with errno set, and fd[]
  40    remain uninitialized.
  41
  42    After finishing communication, the caller should call wait_subprocess()
  43    to get rid of the subprocess in the process table.
  44
  45    progname is the name of the program to be executed by the subprocess, used
  46    for error messages.
  47    prog_path is the file name of the program to be executed by the subprocess.
  48    If it contains no slashes, a search is conducted in $PATH.  An operating
  49    system dependent suffix is added, if necessary.
  50    prog_argv is the array of strings that the subprocess shall receive in
  51    argv[].  It is a NULL-terminated array.  prog_argv[0] should normally be
  52    identical to prog_path.
  53
  54    If slave_process is true, the child process will be terminated when its
  55    creator receives a catchable fatal signal or exits normally.  If
  56    slave_process is false, the child process will continue running in this
  57    case, until it is lucky enough to attempt to communicate with its creator
  58    and thus get a SIGPIPE signal.
  59
  60    If exit_on_error is false, a child process id of -1 should be treated the
  61    same way as a subprocess which accepts no input, produces no output and
  62    terminates with exit code 127.  Why?  Some errors during posix_spawnp()
  63    cause the function posix_spawnp() to return an error code; some other
  64    errors cause the subprocess to exit with return code 127.  It is
  65    implementation dependent which error is reported which way.  The caller
  66    must treat both cases as equivalent.
  67
  68    It is recommended that no signal is blocked or ignored (i.e. have a
  69    signal handler with value SIG_IGN) while any of these functions is called.
  70    The reason is that child processes inherit the mask of blocked signals
  71    from their parent (both through posix_spawn() and fork()/exec());
  72    likewise, signals ignored in the parent are also ignored in the child
  73    (except possibly for SIGCHLD).  And POSIX:2001 says [in the description
  74    of exec()]:
  75        "it should be noted that many existing applications wrongly
  76         assume that they start with certain signals set to the default
  77         action and/or unblocked. In particular, applications written
  78         with a simpler signal model that does not include blocking of
  79         signals, such as the one in the ISO C standard, may not behave
  80         properly if invoked with some signals blocked. Therefore, it is
  81         best not to block or ignore signals across execs without explicit
  82         reason to do so, and especially not to block signals across execs
  83         of arbitrary (not closely co-operating) programs."  */
  84
  85 /* Open a pipe for output to a child process.
  86  * The child's stdout goes to a file.
  87  *
  88  *           write       system                read
  89  *    parent  ->   fd[0]   ->   STDIN_FILENO    ->   child
  90  *
  91  * Note: When writing to a child process, it is useful to ignore the SIGPIPE
  92  * signal and the EPIPE error code.
  93  */
  94 extern pid_t create_pipe_out (const char *progname,
  95                               const char *prog_path, char **prog_argv,
  96                               const char *prog_stdout, bool null_stderr,
  97                               bool slave_process, bool exit_on_error,
  98                               int fd[1]);
  99
 100 /* Open a pipe for input from a child process.
 101  * The child's stdin comes from a file.
 102  *
 103  *           read        system                write
 104  *    parent  <-   fd[0]   <-   STDOUT_FILENO   <-   child
 105  *
 106  */
 107 extern pid_t create_pipe_in (const char *progname,
 108                              const char *prog_path, char **prog_argv,
 109                              const char *prog_stdin, bool null_stderr,
 110                              bool slave_process, bool exit_on_error,
 111                              int fd[1]);
 112
 113 /* Open a bidirectional pipe.
 114  *
 115  *           write       system                read
 116  *    parent  ->   fd[1]   ->   STDIN_FILENO    ->   child
 117  *    parent  <-   fd[0]   <-   STDOUT_FILENO   <-   child
 118  *           read        system                write
 119  *
 120  * Note: When writing to a child process, it is useful to ignore the SIGPIPE
 121  * signal and the EPIPE error code.
 122  *
 123  * Note: The parent process must be careful to avoid deadlock.
 124  * 1) If you write more than PIPE_MAX bytes or, more generally, if you write
 125  *    more bytes than the subprocess can handle at once, the subprocess
 126  *    may write its data and wait on you to read it, but you are currently
 127  *    busy writing.
 128  * 2) When you don't know ahead of time how many bytes the subprocess
 129  *    will produce, the usual technique of calling read (fd, buf, BUFSIZ)
 130  *    with a fixed BUFSIZ will, on Linux 2.2.17 and on BSD systems, cause
 131  *    the read() call to block until *all* of the buffer has been filled.
 132  *    But the subprocess cannot produce more data until you gave it more
 133  *    input.  But you are currently busy reading from it.
 134  */
 135 extern pid_t create_pipe_bidi (const char *progname,
 136                                const char *prog_path, char **prog_argv,
 137                                bool null_stderr,
 138                                bool slave_process, bool exit_on_error,
 139                                int fd[2]);
 140
 141 /* The name of the "always silent" device.  */
 142 #if defined _WIN32 && ! defined __CYGWIN__
 143 /* Native Windows API.  */
 144 # define DEV_NULL "NUL"
 145 #else
 146 /* Unix API.  */
 147 # define DEV_NULL "/dev/null"
 148 #endif
 149
 150
 151 #ifdef __cplusplus
 152 }
 153 #endif
 154
 155
 156 #endif /* _SPAWN_PIPE_H */