Documentation/technical/api-run-command.txt

   1 run-command API
   2 ===============
   3
   4 The run-command API offers a versatile tool to run sub-processes with
   5 redirected input and output as well as with a modified environment
   6 and an alternate current directory.
   7
   8 A similar API offers the capability to run a function asynchronously,
   9 which is primarily used to capture the output that the function
  10 produces in the caller in order to process it.
  11
  12
  13 Functions
  14 ---------
  15
  16 `child_process_init`
  17
  18         Initialize a struct child_process variable.
  19
  20 `start_command`::
  21
  22         Start a sub-process. Takes a pointer to a `struct child_process`
  23         that specifies the details and returns pipe FDs (if requested).
  24         See below for details.
  25
  26 `finish_command`::
  27
  28         Wait for the completion of a sub-process that was started with
  29         start_command().
  30
  31 `run_command`::
  32
  33         A convenience function that encapsulates a sequence of
  34         start_command() followed by finish_command(). Takes a pointer
  35         to a `struct child_process` that specifies the details.
  36
  37 `run_command_v_opt`, `run_command_v_opt_cd_env`::
  38
  39         Convenience functions that encapsulate a sequence of
  40         start_command() followed by finish_command(). The argument argv
  41         specifies the program and its arguments. The argument opt is zero
  42         or more of the flags `RUN_COMMAND_NO_STDIN`, `RUN_GIT_CMD`,
  43         `RUN_COMMAND_STDOUT_TO_STDERR`, or `RUN_SILENT_EXEC_FAILURE`
  44         that correspond to the members .no_stdin, .git_cmd,
  45         .stdout_to_stderr, .silent_exec_failure of `struct child_process`.
  46         The argument dir corresponds the member .dir. The argument env
  47         corresponds to the member .env.
  48
  49 The functions above do the following:
  50
  51 . If a system call failed, errno is set and -1 is returned. A diagnostic
  52   is printed.
  53
  54 . If the program was not found, then -1 is returned and errno is set to
  55   ENOENT; a diagnostic is printed only if .silent_exec_failure is 0.
  56
  57 . Otherwise, the program is run. If it terminates regularly, its exit
  58   code is returned. No diagnostic is printed, even if the exit code is
  59   non-zero.
  60
  61 . If the program terminated due to a signal, then the return value is the
  62   signal number + 128, ie. the same value that a POSIX shell's $? would
  63   report.  A diagnostic is printed.
  64
  65
  66 `start_async`::
  67
  68         Run a function asynchronously. Takes a pointer to a `struct
  69         async` that specifies the details and returns a set of pipe FDs
  70         for communication with the function. See below for details.
  71
  72 `finish_async`::
  73
  74         Wait for the completion of an asynchronous function that was
  75         started with start_async().
  76
  77 `run_hook`::
  78
  79         Run a hook.
  80         The first argument is a pathname to an index file, or NULL
  81         if the hook uses the default index file or no index is needed.
  82         The second argument is the name of the hook.
  83         The further arguments correspond to the hook arguments.
  84         The last argument has to be NULL to terminate the arguments list.
  85         If the hook does not exist or is not executable, the return
  86         value will be zero.
  87         If it is executable, the hook will be executed and the exit
  88         status of the hook is returned.
  89         On execution, .stdout_to_stderr and .no_stdin will be set.
  90         (See below.)
  91
  92
  93 Data structures
  94 ---------------
  95
  96 * `struct child_process`
  97
  98 This describes the arguments, redirections, and environment of a
  99 command to run in a sub-process.
 100
 101 The caller:
 102
 103 1. allocates and clears (using child_process_init() or
 104    CHILD_PROCESS_INIT) a struct child_process variable;
 105 2. initializes the members;
 106 3. calls start_command();
 107 4. processes the data;
 108 5. closes file descriptors (if necessary; see below);
 109 6. calls finish_command().
 110
 111 The .argv member is set up as an array of string pointers (NULL
 112 terminated), of which .argv[0] is the program name to run (usually
 113 without a path). If the command to run is a git command, set argv[0] to
 114 the command name without the 'git-' prefix and set .git_cmd = 1.
 115
 116 Note that the ownership of the memory pointed to by .argv stays with the
 117 caller, but it should survive until `finish_command` completes. If the
 118 .argv member is NULL, `start_command` will point it at the .args
 119 `argv_array` (so you may use one or the other, but you must use exactly
 120 one). The memory in .args will be cleaned up automatically during
 121 `finish_command` (or during `start_command` when it is unsuccessful).
 122
 123 The members .in, .out, .err are used to redirect stdin, stdout,
 124 stderr as follows:
 125
 126 . Specify 0 to request no special redirection. No new file descriptor
 127   is allocated. The child process simply inherits the channel from the
 128   parent.
 129
 130 . Specify -1 to have a pipe allocated; start_command() replaces -1
 131   by the pipe FD in the following way:
 132
 133         .in: Returns the writable pipe end into which the caller writes;
 134                 the readable end of the pipe becomes the child's stdin.
 135
 136         .out, .err: Returns the readable pipe end from which the caller
 137                 reads; the writable end of the pipe end becomes child's
 138                 stdout/stderr.
 139
 140   The caller of start_command() must close the so returned FDs
 141   after it has completed reading from/writing to it!
 142
 143 . Specify a file descriptor > 0 to be used by the child:
 144
 145         .in: The FD must be readable; it becomes child's stdin.
 146         .out: The FD must be writable; it becomes child's stdout.
 147         .err: The FD must be writable; it becomes child's stderr.
 148
 149   The specified FD is closed by start_command(), even if it fails to
 150   run the sub-process!
 151
 152 . Special forms of redirection are available by setting these members
 153   to 1:
 154
 155         .no_stdin, .no_stdout, .no_stderr: The respective channel is
 156                 redirected to /dev/null.
 157
 158         .stdout_to_stderr: stdout of the child is redirected to its
 159                 stderr. This happens after stderr is itself redirected.
 160                 So stdout will follow stderr to wherever it is
 161                 redirected.
 162
 163 To modify the environment of the sub-process, specify an array of
 164 string pointers (NULL terminated) in .env:
 165
 166 . If the string is of the form "VAR=value", i.e. it contains '='
 167   the variable is added to the child process's environment.
 168
 169 . If the string does not contain '=', it names an environment
 170   variable that will be removed from the child process's environment.
 171
 172 To specify a new initial working directory for the sub-process,
 173 specify it in the .dir member.
 174
 175 If the program cannot be found, the functions return -1 and set
 176 errno to ENOENT. Normally, an error message is printed, but if
 177 .silent_exec_failure is set to 1, no message is printed for this
 178 special error condition.
 179
 180
 181 * `struct async`
 182
 183 This describes a function to run asynchronously, whose purpose is
 184 to produce output that the caller reads.
 185
 186 The caller:
 187
 188 1. allocates and clears (memset(&asy, 0, sizeof(asy));) a
 189    struct async variable;
 190 2. initializes .proc and .data;
 191 3. calls start_async();
 192 4. processes communicates with proc through .in and .out;
 193 5. closes .in and .out;
 194 6. calls finish_async().
 195
 196 The members .in, .out are used to provide a set of fd's for
 197 communication between the caller and the callee as follows:
 198
 199 . Specify 0 to have no file descriptor passed.  The callee will
 200   receive -1 in the corresponding argument.
 201
 202 . Specify < 0 to have a pipe allocated; start_async() replaces
 203   with the pipe FD in the following way:
 204
 205         .in: Returns the writable pipe end into which the caller
 206         writes; the readable end of the pipe becomes the function's
 207         in argument.
 208
 209         .out: Returns the readable pipe end from which the caller
 210         reads; the writable end of the pipe becomes the function's
 211         out argument.
 212
 213   The caller of start_async() must close the returned FDs after it
 214   has completed reading from/writing from them.
 215
 216 . Specify a file descriptor > 0 to be used by the function:
 217
 218         .in: The FD must be readable; it becomes the function's in.
 219         .out: The FD must be writable; it becomes the function's out.
 220
 221   The specified FD is closed by start_async(), even if it fails to
 222   run the function.
 223
 224 The function pointer in .proc has the following signature:
 225
 226         int proc(int in, int out, void *data);
 227
 228 . in, out specifies a set of file descriptors to which the function
 229   must read/write the data that it needs/produces.  The function
 230   *must* close these descriptors before it returns.  A descriptor
 231   may be -1 if the caller did not configure a descriptor for that
 232   direction.
 233
 234 . data is the value that the caller has specified in the .data member
 235   of struct async.
 236
 237 . The return value of the function is 0 on success and non-zero
 238   on failure. If the function indicates failure, finish_async() will
 239   report failure as well.
 240
 241
 242 There are serious restrictions on what the asynchronous function can do
 243 because this facility is implemented by a thread in the same address
 244 space on most platforms (when pthreads is available), but by a pipe to
 245 a forked process otherwise:
 246
 247 . It cannot change the program's state (global variables, environment,
 248   etc.) in a way that the caller notices; in other words, .in and .out
 249   are the only communication channels to the caller.
 250
 251 . It must not change the program's state that the caller of the
 252   facility also uses.