rz_subprocess.h

Go to the documentation of this file.

// 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>
 
typedef enum rz_subprocess_pipe_create_t {
    RZ_SUBPROCESS_PIPE_NONE,
    RZ_SUBPROCESS_PIPE_CREATE,
    RZ_SUBPROCESS_PIPE_STDOUT,
} RzSubprocessPipeCreate;
 
#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;
 
typedef struct rz_process_output_t {
    ut8 *out;
    int out_len;
    ut8 *err;
    int err_len;
    int ret;
    bool timeout;
} RzSubprocessOutput;
 
typedef struct rz_subprocess_opt_t {
    const char *file;
    const char **args;
    size_t args_size;
    const char **envvars;
    const char **envvals;
    size_t env_size;
    RzSubprocessPipeCreate stdin_pipe;
    RzSubprocessPipeCreate stdout_pipe;
    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