run-command.h 2.64 KB
Newer Older
1 2 3 4 5 6
#ifndef RUN_COMMAND_H
#define RUN_COMMAND_H

enum {
	ERR_RUN_COMMAND_FORK = 10000,
	ERR_RUN_COMMAND_EXEC,
7
	ERR_RUN_COMMAND_PIPE,
8 9 10 11 12 13
	ERR_RUN_COMMAND_WAITPID,
	ERR_RUN_COMMAND_WAITPID_WRONG_PID,
	ERR_RUN_COMMAND_WAITPID_SIGNAL,
	ERR_RUN_COMMAND_WAITPID_NOEXIT,
};

14 15
struct child_process {
	const char **argv;
16
	pid_t pid;
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
	/*
	 * Using .in, .out, .err:
	 * - Specify 0 for no redirections (child inherits stdin, stdout,
	 *   stderr from parent).
	 * - Specify -1 to have a pipe allocated as follows:
	 *     .in: returns the writable pipe end; parent writes to it,
	 *          the readable pipe end becomes child's stdin
	 *     .out, .err: returns the readable pipe end; parent reads from
	 *          it, the writable pipe end becomes child's stdout/stderr
	 *   The caller of start_command() must close the returned FDs
	 *   after it has completed reading from/writing to it!
	 * - Specify > 0 to set a channel to a particular FD as follows:
	 *     .in: a readable FD, becomes child's stdin
	 *     .out: a writable FD, becomes child's stdout/stderr
	 *     .err > 0 not supported
	 *   The specified FD is closed by start_command(), even in case
	 *   of errors!
	 */
35
	int in;
36
	int out;
37
	int err;
38
	const char *dir;
39
	const char *const *env;
40
	unsigned no_stdin:1;
41
	unsigned no_stdout:1;
42
	unsigned no_stderr:1;
43 44
	unsigned git_cmd:1; /* if this is to be git sub-command */
	unsigned stdout_to_stderr:1;
45
	void (*preexec_cb)(void);
46 47
};

48 49
int start_command(struct child_process *);
int finish_command(struct child_process *);
50 51
int run_command(struct child_process *);

52
#define RUN_COMMAND_NO_STDIN 1
53
#define RUN_GIT_CMD	     2	/*If this is to be git sub-command */
54
#define RUN_COMMAND_STDOUT_TO_STDERR 4
55
int run_command_v_opt(const char **argv, int opt);
56 57 58 59 60

/*
 * env (the environment) is to be formatted like environ: "VAR=VALUE".
 * To unset an environment variable use just "VAR".
 */
61
int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
62

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
/*
 * The purpose of the following functions is to feed a pipe by running
 * a function asynchronously and providing output that the caller reads.
 *
 * It is expected that no synchronization and mutual exclusion between
 * the caller and the feed function is necessary so that the function
 * can run in a thread without interfering with the caller.
 */
struct async {
	/*
	 * proc writes to fd and closes it;
	 * returns 0 on success, non-zero on failure
	 */
	int (*proc)(int fd, void *data);
	void *data;
	int out;	/* caller reads from here and closes it */
79
#ifndef __MINGW32__
80
	pid_t pid;
81 82 83 84
#else
	HANDLE tid;
	int fd_for_proc;
#endif
85 86 87 88 89
};

int start_async(struct async *async);
int finish_async(struct async *async);

90
#endif