98 lines
No EOL
3.6 KiB
C
98 lines
No EOL
3.6 KiB
C
// SPDX-FileCopyrightText: Florian Märkl <info@florianmaerkl.de>, Riccardo Schirone <sirmy15@gmail.com>
|
|
// SPDX-License-Identifier: LGPL-3.0-only
|
|
|
|
#ifndef RZ_UTIL_SUBPROCESS_H
|
|
#define RZ_UTIL_SUBPROCESS_H
|
|
|
|
#include <rz_types.h>
|
|
#include <rz_util/rz_strbuf.h>
|
|
|
|
/**
|
|
* Enum used to determine how pipes should be created, if at all, in the
|
|
* subprocess.
|
|
*/
|
|
typedef enum rz_subprocess_pipe_create_t {
|
|
///< No pipe should be created. It can be used for stdin, stdout and stderr.
|
|
RZ_SUBPROCESS_PIPE_NONE,
|
|
///< A new pipe should be created. It can be used for stdin, stdout and stderr.
|
|
RZ_SUBPROCESS_PIPE_CREATE,
|
|
///< Re-use the same pipe as stdout. It can be used for stderr only.
|
|
RZ_SUBPROCESS_PIPE_STDOUT,
|
|
} RzSubprocessPipeCreate;
|
|
|
|
/**
|
|
* Values passed to rz_subprocess API to mention stdin, stdout, stderr or a combination of those
|
|
*/
|
|
#define RZ_SUBPROCESS_STDIN (1 << 0)
|
|
#define RZ_SUBPROCESS_STDOUT (1 << 1)
|
|
#define RZ_SUBPROCESS_STDERR (1 << 2)
|
|
|
|
typedef enum rz_process_wait_reason_t {
|
|
RZ_SUBPROCESS_DEAD,
|
|
RZ_SUBPROCESS_TIMEDOUT,
|
|
RZ_SUBPROCESS_BYTESREAD,
|
|
} RzSubprocessWaitReason;
|
|
|
|
/**
|
|
* Provide results from running a sub-process, like output, return value, etc.
|
|
*/
|
|
typedef struct rz_process_output_t {
|
|
///< Output generated by the process
|
|
ut8 *out;
|
|
///< Number of bytes in the \p out field
|
|
int out_len;
|
|
///< Error generated by the process
|
|
ut8 *err;
|
|
///< Number of bytes in the \p err field
|
|
int err_len;
|
|
///< Return value (exit code) of the sub-process
|
|
int ret;
|
|
///< True if the process has exited because of a timeout
|
|
bool timeout;
|
|
} RzSubprocessOutput;
|
|
|
|
/**
|
|
* Specify how the new subprocess should be created.
|
|
*/
|
|
typedef struct rz_subprocess_opt_t {
|
|
///< Name of the executable to run. It is searched also in PATH
|
|
const char *file;
|
|
///< Arguments to pass to the subprocess. These are just the arguments and do not include the program name (aka argv[0])
|
|
const char **args;
|
|
///< Number of arguments in \p args array
|
|
size_t args_size;
|
|
///< Names of environment variables that subprocess should have differently from parent
|
|
const char **envvars;
|
|
///< Values of environment variables that subprocess should have differently from parent
|
|
const char **envvals;
|
|
///< Number of elements contained in both \p envvars and \p envvals
|
|
size_t env_size;
|
|
///< Specify how to deal with subprocess stdin
|
|
RzSubprocessPipeCreate stdin_pipe;
|
|
///< Specify how to deal with subprocess stdout
|
|
RzSubprocessPipeCreate stdout_pipe;
|
|
///< Specify how to deal with subprocess stderr
|
|
RzSubprocessPipeCreate stderr_pipe;
|
|
} RzSubprocessOpt;
|
|
|
|
typedef struct rz_subprocess_t RzSubprocess;
|
|
|
|
RZ_API bool rz_subprocess_init(void);
|
|
RZ_API void rz_subprocess_fini(void);
|
|
RZ_API RzSubprocess *rz_subprocess_start(
|
|
const char *file, const char *args[], size_t args_size,
|
|
const char *envvars[], const char *envvals[], size_t env_size);
|
|
RZ_API RzSubprocess *rz_subprocess_start_opt(RzSubprocessOpt *opt);
|
|
RZ_API void rz_subprocess_free(RzSubprocess *proc);
|
|
RZ_API RzSubprocessWaitReason rz_subprocess_wait(RzSubprocess *proc, ut64 timeout_ms);
|
|
RZ_API void rz_subprocess_kill(RzSubprocess *proc);
|
|
RZ_API int rz_subprocess_ret(RzSubprocess *proc);
|
|
RZ_API ut8 *rz_subprocess_out(RzSubprocess *proc, int *length);
|
|
RZ_API ut8 *rz_subprocess_err(RzSubprocess *proc, int *length);
|
|
RZ_API ssize_t rz_subprocess_stdin_write(RzSubprocess *proc, const ut8 *buf, size_t buf_size);
|
|
RZ_API RzStrBuf *rz_subprocess_stdout_read(RzSubprocess *proc, size_t n, ut64 timeout_ms);
|
|
RZ_API RzStrBuf *rz_subprocess_stdout_readline(RzSubprocess *proc, ut64 timeout_ms);
|
|
RZ_API RzSubprocessOutput *rz_subprocess_drain(RzSubprocess *proc);
|
|
RZ_API void rz_subprocess_output_free(RzSubprocessOutput *out);
|
|
|
|
#endif |