1#ifndef RUN_COMMAND_H 2#define RUN_COMMAND_H 3 4#ifndef NO_PTHREADS 5#include <pthread.h> 6#endif 7 8#include"argv-array.h" 9 10struct child_process { 11const char**argv; 12struct argv_array args; 13struct argv_array env_array; 14 pid_t pid; 15/* 16 * Using .in, .out, .err: 17 * - Specify 0 for no redirections (child inherits stdin, stdout, 18 * stderr from parent). 19 * - Specify -1 to have a pipe allocated as follows: 20 * .in: returns the writable pipe end; parent writes to it, 21 * the readable pipe end becomes child's stdin 22 * .out, .err: returns the readable pipe end; parent reads from 23 * it, the writable pipe end becomes child's stdout/stderr 24 * The caller of start_command() must close the returned FDs 25 * after it has completed reading from/writing to it! 26 * - Specify > 0 to set a channel to a particular FD as follows: 27 * .in: a readable FD, becomes child's stdin 28 * .out: a writable FD, becomes child's stdout/stderr 29 * .err: a writable FD, becomes child's stderr 30 * The specified FD is closed by start_command(), even in case 31 * of errors! 32 */ 33int in; 34int out; 35int err; 36const char*dir; 37const char*const*env; 38unsigned no_stdin:1; 39unsigned no_stdout:1; 40unsigned no_stderr:1; 41unsigned git_cmd:1;/* if this is to be git sub-command */ 42unsigned silent_exec_failure:1; 43unsigned stdout_to_stderr:1; 44unsigned use_shell:1; 45unsigned clean_on_exit:1; 46}; 47 48#define CHILD_PROCESS_INIT { NULL, ARGV_ARRAY_INIT, ARGV_ARRAY_INIT } 49voidchild_process_init(struct child_process *); 50 51intstart_command(struct child_process *); 52intfinish_command(struct child_process *); 53intrun_command(struct child_process *); 54 55externconst char*find_hook(const char*name); 56LAST_ARG_MUST_BE_NULL 57externintrun_hook_le(const char*const*env,const char*name, ...); 58externintrun_hook_ve(const char*const*env,const char*name,va_list args); 59 60LAST_ARG_MUST_BE_NULL 61__attribute__((deprecated)) 62externintrun_hook_with_custom_index(const char*index_file,const char*name, ...); 63 64#define RUN_COMMAND_NO_STDIN 1 65#define RUN_GIT_CMD 2/*If this is to be git sub-command */ 66#define RUN_COMMAND_STDOUT_TO_STDERR 4 67#define RUN_SILENT_EXEC_FAILURE 8 68#define RUN_USING_SHELL 16 69#define RUN_CLEAN_ON_EXIT 32 70intrun_command_v_opt(const char**argv,int opt); 71 72/* 73 * env (the environment) is to be formatted like environ: "VAR=VALUE". 74 * To unset an environment variable use just "VAR". 75 */ 76intrun_command_v_opt_cd_env(const char**argv,int opt,const char*dir,const char*const*env); 77 78/* 79 * The purpose of the following functions is to feed a pipe by running 80 * a function asynchronously and providing output that the caller reads. 81 * 82 * It is expected that no synchronization and mutual exclusion between 83 * the caller and the feed function is necessary so that the function 84 * can run in a thread without interfering with the caller. 85 */ 86struct async { 87/* 88 * proc reads from in; closes it before return 89 * proc writes to out; closes it before return 90 * returns 0 on success, non-zero on failure 91 */ 92int(*proc)(int in,int out,void*data); 93void*data; 94int in;/* caller writes here and closes it */ 95int out;/* caller reads from here and closes it */ 96#ifdef NO_PTHREADS 97 pid_t pid; 98#else 99 pthread_t tid; 100int proc_in; 101int proc_out; 102#endif 103}; 104 105intstart_async(struct async *async); 106intfinish_async(struct async *async); 107 108#endif