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