mirror of
https://github.com/neovim/neovim.git
synced 2025-09-15 07:48:18 +00:00
job: Refactor process spawning and startup arguments
- process spawning was decoupled from the rest of the job control logic. The goal is reusing it for spawning processes connected to pseudo terminal file descriptors. - job_start now receives a JobOptions structure containing all the startup options.
This commit is contained in:
@@ -10,5 +10,7 @@
|
|||||||
Memcheck:Leak
|
Memcheck:Leak
|
||||||
fun:malloc
|
fun:malloc
|
||||||
fun:uv_spawn
|
fun:uv_spawn
|
||||||
|
fun:pipe_process_spawn
|
||||||
|
fun:process_spawn
|
||||||
fun:job_start
|
fun:job_start
|
||||||
}
|
}
|
||||||
|
@@ -10725,15 +10725,13 @@ static void f_jobstart(typval_T *argvars, typval_T *rettv)
|
|||||||
|
|
||||||
// The last item of argv must be NULL
|
// The last item of argv must be NULL
|
||||||
argv[i] = NULL;
|
argv[i] = NULL;
|
||||||
|
JobOptions opts = JOB_OPTIONS_INIT;
|
||||||
job_start(argv,
|
opts.argv = argv;
|
||||||
xstrdup((char *)argvars[0].vval.v_string),
|
opts.data = xstrdup((char *)argvars[0].vval.v_string);
|
||||||
true,
|
opts.stdout_cb = on_job_stdout;
|
||||||
on_job_stdout,
|
opts.stderr_cb = on_job_stderr;
|
||||||
on_job_stderr,
|
opts.exit_cb = on_job_exit;
|
||||||
on_job_exit,
|
job_start(opts, &rettv->vval.v_number);
|
||||||
0,
|
|
||||||
&rettv->vval.v_number);
|
|
||||||
|
|
||||||
if (rettv->vval.v_number <= 0) {
|
if (rettv->vval.v_number <= 0) {
|
||||||
if (rettv->vval.v_number == 0) {
|
if (rettv->vval.v_number == 0) {
|
||||||
|
@@ -132,14 +132,13 @@ uint64_t channel_from_job(char **argv)
|
|||||||
incref(channel); // job channels are only closed by the exit_cb
|
incref(channel); // job channels are only closed by the exit_cb
|
||||||
|
|
||||||
int status;
|
int status;
|
||||||
channel->data.job = job_start(argv,
|
JobOptions opts = JOB_OPTIONS_INIT;
|
||||||
channel,
|
opts.argv = argv;
|
||||||
true,
|
opts.data = channel;
|
||||||
job_out,
|
opts.stdout_cb = job_out;
|
||||||
job_err,
|
opts.stderr_cb = job_err;
|
||||||
job_exit,
|
opts.exit_cb = job_exit;
|
||||||
0,
|
channel->data.job = job_start(opts, &status);
|
||||||
&status);
|
|
||||||
|
|
||||||
if (status <= 0) {
|
if (status <= 0) {
|
||||||
if (status == 0) { // Two decrefs needed if status == 0.
|
if (status == 0) { // Two decrefs needed if status == 0.
|
||||||
|
@@ -6,13 +6,13 @@
|
|||||||
#include "nvim/os/uv_helpers.h"
|
#include "nvim/os/uv_helpers.h"
|
||||||
#include "nvim/os/job.h"
|
#include "nvim/os/job.h"
|
||||||
#include "nvim/os/job_defs.h"
|
#include "nvim/os/job_defs.h"
|
||||||
|
#include "nvim/os/job_private.h"
|
||||||
#include "nvim/os/rstream.h"
|
#include "nvim/os/rstream.h"
|
||||||
#include "nvim/os/rstream_defs.h"
|
#include "nvim/os/rstream_defs.h"
|
||||||
#include "nvim/os/wstream.h"
|
#include "nvim/os/wstream.h"
|
||||||
#include "nvim/os/wstream_defs.h"
|
#include "nvim/os/wstream_defs.h"
|
||||||
#include "nvim/os/event.h"
|
#include "nvim/os/event.h"
|
||||||
#include "nvim/os/event_defs.h"
|
#include "nvim/os/event_defs.h"
|
||||||
#include "nvim/os/shell.h"
|
|
||||||
#include "nvim/os/time.h"
|
#include "nvim/os/time.h"
|
||||||
#include "nvim/vim.h"
|
#include "nvim/vim.h"
|
||||||
#include "nvim/memory.h"
|
#include "nvim/memory.h"
|
||||||
@@ -29,8 +29,8 @@
|
|||||||
if (job->stream) { \
|
if (job->stream) { \
|
||||||
type##stream_free(job->stream); \
|
type##stream_free(job->stream); \
|
||||||
job->stream = NULL; \
|
job->stream = NULL; \
|
||||||
if (!uv_is_closing((uv_handle_t *)&job->proc_std##stream)) { \
|
if (!uv_is_closing((uv_handle_t *)job->proc_std##stream)) { \
|
||||||
uv_close((uv_handle_t *)&job->proc_std##stream, close_cb); \
|
uv_close((uv_handle_t *)job->proc_std##stream, close_cb); \
|
||||||
} \
|
} \
|
||||||
} \
|
} \
|
||||||
} while (0)
|
} while (0)
|
||||||
@@ -39,37 +39,9 @@
|
|||||||
#define close_job_out(job) close_job_stream(job, out, r)
|
#define close_job_out(job) close_job_stream(job, out, r)
|
||||||
#define close_job_err(job) close_job_stream(job, err, r)
|
#define close_job_err(job) close_job_stream(job, err, r)
|
||||||
|
|
||||||
struct job {
|
Job *table[MAX_RUNNING_JOBS] = {NULL};
|
||||||
// Job id the index in the job table plus one.
|
|
||||||
int id;
|
|
||||||
// Exit status code of the job process
|
|
||||||
int status;
|
|
||||||
// Number of references to the job. The job resources will only be freed by
|
|
||||||
// close_cb when this is 0
|
|
||||||
int refcount;
|
|
||||||
// Time when job_stop was called for the job.
|
|
||||||
uint64_t stopped_time;
|
|
||||||
// If SIGTERM was already sent to the job(only send one before SIGKILL)
|
|
||||||
bool term_sent;
|
|
||||||
// Data associated with the job
|
|
||||||
void *data;
|
|
||||||
// Callbacks
|
|
||||||
job_exit_cb exit_cb;
|
|
||||||
rstream_cb stdout_cb, stderr_cb;
|
|
||||||
// Readable streams(std{out,err})
|
|
||||||
RStream *out, *err;
|
|
||||||
// Writable stream(stdin)
|
|
||||||
WStream *in;
|
|
||||||
// Structures for process spawning/management used by libuv
|
|
||||||
uv_process_t proc;
|
|
||||||
uv_process_options_t proc_opts;
|
|
||||||
uv_stdio_container_t stdio[3];
|
|
||||||
uv_pipe_t proc_stdin, proc_stdout, proc_stderr;
|
|
||||||
};
|
|
||||||
|
|
||||||
static Job *table[MAX_RUNNING_JOBS] = {NULL};
|
|
||||||
size_t stop_requests = 0;
|
size_t stop_requests = 0;
|
||||||
static uv_timer_t job_stop_timer;
|
uv_timer_t job_stop_timer;
|
||||||
|
|
||||||
// Some helpers shared in this module
|
// Some helpers shared in this module
|
||||||
|
|
||||||
@@ -106,29 +78,10 @@ void job_teardown(void)
|
|||||||
|
|
||||||
/// Tries to start a new job.
|
/// Tries to start a new job.
|
||||||
///
|
///
|
||||||
/// @param argv Argument vector for the process. The first item is the
|
|
||||||
/// executable to run.
|
|
||||||
/// [consumed]
|
|
||||||
/// @param data Caller data that will be associated with the job
|
|
||||||
/// @param writable If true the job stdin will be available for writing with
|
|
||||||
/// job_write, otherwise it will be redirected to /dev/null
|
|
||||||
/// @param stdout_cb Callback that will be invoked when data is available
|
|
||||||
/// on stdout. If NULL stdout will be redirected to /dev/null.
|
|
||||||
/// @param stderr_cb Callback that will be invoked when data is available
|
|
||||||
/// on stderr. If NULL stderr will be redirected to /dev/null.
|
|
||||||
/// @param job_exit_cb Callback that will be invoked when the job exits
|
|
||||||
/// @param maxmem Maximum amount of memory used by the job WStream
|
|
||||||
/// @param[out] status The job id if the job started successfully, 0 if the job
|
/// @param[out] status The job id if the job started successfully, 0 if the job
|
||||||
/// table is full, -1 if the program could not be executed.
|
/// table is full, -1 if the program could not be executed.
|
||||||
/// @return The job pointer if the job started successfully, NULL otherwise
|
/// @return The job pointer if the job started successfully, NULL otherwise
|
||||||
Job *job_start(char **argv,
|
Job *job_start(JobOptions opts, int *status)
|
||||||
void *data,
|
|
||||||
bool writable,
|
|
||||||
rstream_cb stdout_cb,
|
|
||||||
rstream_cb stderr_cb,
|
|
||||||
job_exit_cb job_exit_cb,
|
|
||||||
size_t maxmem,
|
|
||||||
int *status)
|
|
||||||
{
|
{
|
||||||
int i;
|
int i;
|
||||||
Job *job;
|
Job *job;
|
||||||
@@ -142,7 +95,7 @@ Job *job_start(char **argv,
|
|||||||
|
|
||||||
if (i == MAX_RUNNING_JOBS) {
|
if (i == MAX_RUNNING_JOBS) {
|
||||||
// No free slots
|
// No free slots
|
||||||
shell_free_argv(argv);
|
shell_free_argv(opts.argv);
|
||||||
*status = 0;
|
*status = 0;
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
@@ -153,92 +106,64 @@ Job *job_start(char **argv,
|
|||||||
*status = job->id;
|
*status = job->id;
|
||||||
job->status = -1;
|
job->status = -1;
|
||||||
job->refcount = 1;
|
job->refcount = 1;
|
||||||
job->data = data;
|
|
||||||
job->stdout_cb = stdout_cb;
|
|
||||||
job->stderr_cb = stderr_cb;
|
|
||||||
job->exit_cb = job_exit_cb;
|
|
||||||
job->stopped_time = 0;
|
job->stopped_time = 0;
|
||||||
job->term_sent = false;
|
job->term_sent = false;
|
||||||
job->proc_opts.file = argv[0];
|
|
||||||
job->proc_opts.args = argv;
|
|
||||||
job->proc_opts.stdio = job->stdio;
|
|
||||||
job->proc_opts.stdio_count = 3;
|
|
||||||
job->proc_opts.flags = UV_PROCESS_WINDOWS_HIDE;
|
|
||||||
job->proc_opts.exit_cb = exit_cb;
|
|
||||||
job->proc_opts.cwd = NULL;
|
|
||||||
job->proc_opts.env = NULL;
|
|
||||||
job->proc.data = NULL;
|
|
||||||
job->proc_stdin.data = NULL;
|
|
||||||
job->proc_stdout.data = NULL;
|
|
||||||
job->proc_stderr.data = NULL;
|
|
||||||
job->in = NULL;
|
job->in = NULL;
|
||||||
job->out = NULL;
|
job->out = NULL;
|
||||||
job->err = NULL;
|
job->err = NULL;
|
||||||
|
job->opts = opts;
|
||||||
|
job->closed = false;
|
||||||
|
|
||||||
// Initialize the job std{in,out,err}
|
process_init(job);
|
||||||
job->stdio[0].flags = UV_IGNORE;
|
|
||||||
job->stdio[1].flags = UV_IGNORE;
|
|
||||||
job->stdio[2].flags = UV_IGNORE;
|
|
||||||
|
|
||||||
if (writable) {
|
if (opts.writable) {
|
||||||
uv_pipe_init(uv_default_loop(), &job->proc_stdin, 0);
|
handle_set_job((uv_handle_t *)job->proc_stdin, job);
|
||||||
job->stdio[0].flags = UV_CREATE_PIPE | UV_READABLE_PIPE;
|
|
||||||
job->stdio[0].data.stream = (uv_stream_t *)&job->proc_stdin;
|
|
||||||
handle_set_job((uv_handle_t *)&job->proc_stdin, job);
|
|
||||||
job->refcount++;
|
job->refcount++;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stdout_cb) {
|
if (opts.stdout_cb) {
|
||||||
uv_pipe_init(uv_default_loop(), &job->proc_stdout, 0);
|
handle_set_job((uv_handle_t *)job->proc_stdout, job);
|
||||||
job->stdio[1].flags = UV_CREATE_PIPE | UV_WRITABLE_PIPE;
|
|
||||||
job->stdio[1].data.stream = (uv_stream_t *)&job->proc_stdout;
|
|
||||||
handle_set_job((uv_handle_t *)&job->proc_stdout, job);
|
|
||||||
job->refcount++;
|
job->refcount++;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stderr_cb) {
|
if (opts.stderr_cb) {
|
||||||
uv_pipe_init(uv_default_loop(), &job->proc_stderr, 0);
|
handle_set_job((uv_handle_t *)job->proc_stderr, job);
|
||||||
job->stdio[2].flags = UV_CREATE_PIPE | UV_WRITABLE_PIPE;
|
|
||||||
job->stdio[2].data.stream = (uv_stream_t *)&job->proc_stderr;
|
|
||||||
handle_set_job((uv_handle_t *)&job->proc_stderr, job);
|
|
||||||
job->refcount++;
|
job->refcount++;
|
||||||
}
|
}
|
||||||
|
|
||||||
handle_set_job((uv_handle_t *)&job->proc, job);
|
|
||||||
|
|
||||||
// Spawn the job
|
// Spawn the job
|
||||||
if (uv_spawn(uv_default_loop(), &job->proc, &job->proc_opts) != 0) {
|
if (!process_spawn(job)) {
|
||||||
if (writable) {
|
if (opts.writable) {
|
||||||
uv_close((uv_handle_t *)&job->proc_stdin, close_cb);
|
uv_close((uv_handle_t *)&job->proc_stdin, close_cb);
|
||||||
}
|
}
|
||||||
if (stdout_cb) {
|
if (opts.stdout_cb) {
|
||||||
uv_close((uv_handle_t *)&job->proc_stdout, close_cb);
|
uv_close((uv_handle_t *)&job->proc_stdout, close_cb);
|
||||||
}
|
}
|
||||||
if (stderr_cb) {
|
if (opts.stderr_cb) {
|
||||||
uv_close((uv_handle_t *)&job->proc_stderr, close_cb);
|
uv_close((uv_handle_t *)&job->proc_stderr, close_cb);
|
||||||
}
|
}
|
||||||
uv_close((uv_handle_t *)&job->proc, close_cb);
|
process_close(job);
|
||||||
event_poll(0);
|
event_poll(0);
|
||||||
// Manually invoke the close_cb to free the job resources
|
// Manually invoke the close_cb to free the job resources
|
||||||
*status = -1;
|
*status = -1;
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (writable) {
|
if (opts.writable) {
|
||||||
job->in = wstream_new(maxmem);
|
job->in = wstream_new(opts.maxmem);
|
||||||
wstream_set_stream(job->in, (uv_stream_t *)&job->proc_stdin);
|
wstream_set_stream(job->in, job->proc_stdin);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Start the readable streams
|
// Start the readable streams
|
||||||
if (stdout_cb) {
|
if (opts.stdout_cb) {
|
||||||
job->out = rstream_new(read_cb, rbuffer_new(JOB_BUFFER_SIZE), job);
|
job->out = rstream_new(read_cb, rbuffer_new(JOB_BUFFER_SIZE), job);
|
||||||
rstream_set_stream(job->out, (uv_stream_t *)&job->proc_stdout);
|
rstream_set_stream(job->out, job->proc_stdout);
|
||||||
rstream_start(job->out);
|
rstream_start(job->out);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stderr_cb) {
|
if (opts.stderr_cb) {
|
||||||
job->err = rstream_new(read_cb, rbuffer_new(JOB_BUFFER_SIZE), job);
|
job->err = rstream_new(read_cb, rbuffer_new(JOB_BUFFER_SIZE), job);
|
||||||
rstream_set_stream(job->err, (uv_stream_t *)&job->proc_stderr);
|
rstream_set_stream(job->err, job->proc_stderr);
|
||||||
rstream_start(job->err);
|
rstream_start(job->err);
|
||||||
}
|
}
|
||||||
// Save the job to the table
|
// Save the job to the table
|
||||||
@@ -327,7 +252,8 @@ int job_wait(Job *job, int ms) FUNC_ATTR_NONNULL_ALL
|
|||||||
// Job exited, collect status and manually invoke close_cb to free the job
|
// Job exited, collect status and manually invoke close_cb to free the job
|
||||||
// resources
|
// resources
|
||||||
status = job->status;
|
status = job->status;
|
||||||
close_cb((uv_handle_t *)&job->proc);
|
job_close_streams(job);
|
||||||
|
job_decref(job);
|
||||||
} else {
|
} else {
|
||||||
job->refcount--;
|
job->refcount--;
|
||||||
}
|
}
|
||||||
@@ -391,25 +317,7 @@ int job_id(Job *job)
|
|||||||
/// @return The job data
|
/// @return The job data
|
||||||
void *job_data(Job *job)
|
void *job_data(Job *job)
|
||||||
{
|
{
|
||||||
return job->data;
|
return job->opts.data;
|
||||||
}
|
|
||||||
|
|
||||||
static void job_exit_callback(Job *job)
|
|
||||||
{
|
|
||||||
// Free the slot now, 'exit_cb' may want to start another job to replace
|
|
||||||
// this one
|
|
||||||
table[job->id - 1] = NULL;
|
|
||||||
|
|
||||||
if (job->exit_cb) {
|
|
||||||
// Invoke the exit callback
|
|
||||||
job->exit_cb(job, job->data);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (stop_requests && !--stop_requests) {
|
|
||||||
// Stop the timer if no more stop requests are pending
|
|
||||||
DLOG("Stopping job kill timer");
|
|
||||||
uv_timer_stop(&job_stop_timer);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Iterates the table, sending SIGTERM to stopped jobs and SIGKILL to those
|
/// Iterates the table, sending SIGTERM to stopped jobs and SIGKILL to those
|
||||||
@@ -428,11 +336,12 @@ static void job_stop_timer_cb(uv_timer_t *handle)
|
|||||||
|
|
||||||
if (!job->term_sent && elapsed >= TERM_TIMEOUT) {
|
if (!job->term_sent && elapsed >= TERM_TIMEOUT) {
|
||||||
ILOG("Sending SIGTERM to job(id: %d)", job->id);
|
ILOG("Sending SIGTERM to job(id: %d)", job->id);
|
||||||
uv_process_kill(&job->proc, SIGTERM);
|
uv_kill(job->pid, SIGTERM);
|
||||||
job->term_sent = true;
|
job->term_sent = true;
|
||||||
} else if (elapsed >= KILL_TIMEOUT) {
|
} else if (elapsed >= KILL_TIMEOUT) {
|
||||||
ILOG("Sending SIGKILL to job(id: %d)", job->id);
|
ILOG("Sending SIGKILL to job(id: %d)", job->id);
|
||||||
uv_process_kill(&job->proc, SIGKILL);
|
uv_kill(job->pid, SIGKILL);
|
||||||
|
process_close(job);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -443,48 +352,26 @@ static void read_cb(RStream *rstream, void *data, bool eof)
|
|||||||
Job *job = data;
|
Job *job = data;
|
||||||
|
|
||||||
if (rstream == job->out) {
|
if (rstream == job->out) {
|
||||||
job->stdout_cb(rstream, data, eof);
|
job->opts.stdout_cb(rstream, data, eof);
|
||||||
if (eof) {
|
if (eof) {
|
||||||
close_job_out(job);
|
close_job_out(job);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
job->stderr_cb(rstream, data, eof);
|
job->opts.stderr_cb(rstream, data, eof);
|
||||||
if (eof) {
|
if (eof) {
|
||||||
close_job_err(job);
|
close_job_err(job);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Emits a JobExit event if both rstreams are closed
|
void job_close_streams(Job *job)
|
||||||
static void exit_cb(uv_process_t *proc, int64_t status, int term_signal)
|
|
||||||
{
|
{
|
||||||
Job *job = handle_get_job((uv_handle_t *)proc);
|
close_job_in(job);
|
||||||
|
close_job_out(job);
|
||||||
job->status = (int)status;
|
close_job_err(job);
|
||||||
uv_close((uv_handle_t *)&job->proc, close_cb);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
static void close_cb(uv_handle_t *handle)
|
static void close_cb(uv_handle_t *handle)
|
||||||
{
|
{
|
||||||
Job *job = handle_get_job(handle);
|
job_decref(handle_get_job(handle));
|
||||||
|
|
||||||
if (handle == (uv_handle_t *)&job->proc) {
|
|
||||||
// Make sure all streams are properly closed to trigger callback invocation
|
|
||||||
// when job->proc is closed
|
|
||||||
close_job_in(job);
|
|
||||||
close_job_out(job);
|
|
||||||
close_job_err(job);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (--job->refcount == 0) {
|
|
||||||
// Invoke the exit_cb
|
|
||||||
job_exit_callback(job);
|
|
||||||
// Free all memory allocated for the job
|
|
||||||
free(job->proc.data);
|
|
||||||
free(job->proc_stdin.data);
|
|
||||||
free(job->proc_stdout.data);
|
|
||||||
free(job->proc_stderr.data);
|
|
||||||
shell_free_argv(job->proc_opts.args);
|
|
||||||
free(job);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@@ -1,7 +1,9 @@
|
|||||||
#ifndef NVIM_OS_JOB_DEFS_H
|
#ifndef NVIM_OS_JOB_DEFS_H
|
||||||
#define NVIM_OS_JOB_DEFS_H
|
#define NVIM_OS_JOB_DEFS_H
|
||||||
|
|
||||||
|
#include <uv.h>
|
||||||
#include "nvim/os/rstream_defs.h"
|
#include "nvim/os/rstream_defs.h"
|
||||||
|
#include "nvim/os/wstream_defs.h"
|
||||||
|
|
||||||
typedef struct job Job;
|
typedef struct job Job;
|
||||||
|
|
||||||
@@ -11,4 +13,39 @@ typedef struct job Job;
|
|||||||
/// @param data Some data associated with the job by the caller
|
/// @param data Some data associated with the job by the caller
|
||||||
typedef void (*job_exit_cb)(Job *job, void *data);
|
typedef void (*job_exit_cb)(Job *job, void *data);
|
||||||
|
|
||||||
|
// Job startup options
|
||||||
|
// job_exit_cb Callback that will be invoked when the job exits
|
||||||
|
// maxmem Maximum amount of memory used by the job WStream
|
||||||
|
typedef struct {
|
||||||
|
// Argument vector for the process. The first item is the
|
||||||
|
// executable to run.
|
||||||
|
// [consumed]
|
||||||
|
char **argv;
|
||||||
|
// Caller data that will be associated with the job
|
||||||
|
void *data;
|
||||||
|
// If true the job stdin will be available for writing with job_write,
|
||||||
|
// otherwise it will be redirected to /dev/null
|
||||||
|
bool writable;
|
||||||
|
// Callback that will be invoked when data is available on stdout. If NULL
|
||||||
|
// stdout will be redirected to /dev/null.
|
||||||
|
rstream_cb stdout_cb;
|
||||||
|
// Callback that will be invoked when data is available on stderr. If NULL
|
||||||
|
// stderr will be redirected to /dev/null.
|
||||||
|
rstream_cb stderr_cb;
|
||||||
|
// Callback that will be invoked when the job has exited and will not send
|
||||||
|
// data
|
||||||
|
job_exit_cb exit_cb;
|
||||||
|
// Maximum memory used by the job's WStream
|
||||||
|
size_t maxmem;
|
||||||
|
} JobOptions;
|
||||||
|
|
||||||
|
#define JOB_OPTIONS_INIT ((JobOptions) { \
|
||||||
|
.argv = NULL, \
|
||||||
|
.data = NULL, \
|
||||||
|
.writable = true, \
|
||||||
|
.stdout_cb = NULL, \
|
||||||
|
.stderr_cb = NULL, \
|
||||||
|
.exit_cb = NULL, \
|
||||||
|
.maxmem = 0 \
|
||||||
|
})
|
||||||
#endif // NVIM_OS_JOB_DEFS_H
|
#endif // NVIM_OS_JOB_DEFS_H
|
||||||
|
104
src/nvim/os/job_private.h
Normal file
104
src/nvim/os/job_private.h
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
#ifndef NVIM_OS_JOB_PRIVATE_H
|
||||||
|
#define NVIM_OS_JOB_PRIVATE_H
|
||||||
|
|
||||||
|
#include <stdlib.h>
|
||||||
|
|
||||||
|
#include <uv.h>
|
||||||
|
|
||||||
|
#include "nvim/os/rstream_defs.h"
|
||||||
|
#include "nvim/os/wstream_defs.h"
|
||||||
|
#include "nvim/os/pipe_process.h"
|
||||||
|
#include "nvim/os/shell.h"
|
||||||
|
#include "nvim/log.h"
|
||||||
|
|
||||||
|
struct job {
|
||||||
|
// Job id the index in the job table plus one.
|
||||||
|
int id;
|
||||||
|
// Process id
|
||||||
|
int pid;
|
||||||
|
// Exit status code of the job process
|
||||||
|
int status;
|
||||||
|
// Number of references to the job. The job resources will only be freed by
|
||||||
|
// close_cb when this is 0
|
||||||
|
int refcount;
|
||||||
|
// Time when job_stop was called for the job.
|
||||||
|
uint64_t stopped_time;
|
||||||
|
// If SIGTERM was already sent to the job(only send one before SIGKILL)
|
||||||
|
bool term_sent;
|
||||||
|
// Readable streams(std{out,err})
|
||||||
|
RStream *out, *err;
|
||||||
|
// Writable stream(stdin)
|
||||||
|
WStream *in;
|
||||||
|
// Libuv streams representing stdin/stdout/stderr
|
||||||
|
uv_stream_t *proc_stdin, *proc_stdout, *proc_stderr;
|
||||||
|
// Extra data set by the process spawner
|
||||||
|
void *process;
|
||||||
|
// If process_close has been called on this job
|
||||||
|
bool closed;
|
||||||
|
// Startup options
|
||||||
|
JobOptions opts;
|
||||||
|
};
|
||||||
|
|
||||||
|
extern Job *table[];
|
||||||
|
extern size_t stop_requests;
|
||||||
|
extern uv_timer_t job_stop_timer;
|
||||||
|
|
||||||
|
static inline bool process_spawn(Job *job)
|
||||||
|
{
|
||||||
|
return pipe_process_spawn(job);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void process_init(Job *job)
|
||||||
|
{
|
||||||
|
pipe_process_init(job);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void process_close(Job *job)
|
||||||
|
{
|
||||||
|
if (job->closed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
job->closed = true;
|
||||||
|
pipe_process_close(job);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void process_destroy(Job *job)
|
||||||
|
{
|
||||||
|
pipe_process_destroy(job);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void job_exit_callback(Job *job)
|
||||||
|
{
|
||||||
|
// Free the slot now, 'exit_cb' may want to start another job to replace
|
||||||
|
// this one
|
||||||
|
table[job->id - 1] = NULL;
|
||||||
|
|
||||||
|
if (job->opts.exit_cb) {
|
||||||
|
// Invoke the exit callback
|
||||||
|
job->opts.exit_cb(job, job->opts.data);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (stop_requests && !--stop_requests) {
|
||||||
|
// Stop the timer if no more stop requests are pending
|
||||||
|
DLOG("Stopping job kill timer");
|
||||||
|
uv_timer_stop(&job_stop_timer);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void job_decref(Job *job)
|
||||||
|
{
|
||||||
|
if (--job->refcount == 0) {
|
||||||
|
// Invoke the exit_cb
|
||||||
|
job_exit_callback(job);
|
||||||
|
// Free all memory allocated for the job
|
||||||
|
free(job->proc_stdin->data);
|
||||||
|
free(job->proc_stdout->data);
|
||||||
|
free(job->proc_stderr->data);
|
||||||
|
shell_free_argv(job->opts.argv);
|
||||||
|
process_destroy(job);
|
||||||
|
free(job);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#endif // NVIM_OS_JOB_PRIVATE_H
|
110
src/nvim/os/pipe_process.c
Normal file
110
src/nvim/os/pipe_process.c
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
#include <stdbool.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
|
||||||
|
#include <uv.h>
|
||||||
|
|
||||||
|
#include "nvim/os/uv_helpers.h"
|
||||||
|
#include "nvim/os/job.h"
|
||||||
|
#include "nvim/os/job_defs.h"
|
||||||
|
#include "nvim/os/job_private.h"
|
||||||
|
#include "nvim/os/pipe_process.h"
|
||||||
|
#include "nvim/memory.h"
|
||||||
|
|
||||||
|
#ifdef INCLUDE_GENERATED_DECLARATIONS
|
||||||
|
# include "os/pipe_process.c.generated.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
// Structures for process spawning/management used by libuv
|
||||||
|
uv_process_t proc;
|
||||||
|
uv_process_options_t proc_opts;
|
||||||
|
uv_stdio_container_t stdio[3];
|
||||||
|
uv_pipe_t proc_stdin, proc_stdout, proc_stderr;
|
||||||
|
} UvProcess;
|
||||||
|
|
||||||
|
void pipe_process_init(Job *job)
|
||||||
|
{
|
||||||
|
UvProcess *pipeproc = xmalloc(sizeof(UvProcess));
|
||||||
|
pipeproc->proc_opts.file = job->opts.argv[0];
|
||||||
|
pipeproc->proc_opts.args = job->opts.argv;
|
||||||
|
pipeproc->proc_opts.stdio = pipeproc->stdio;
|
||||||
|
pipeproc->proc_opts.stdio_count = 3;
|
||||||
|
pipeproc->proc_opts.flags = UV_PROCESS_WINDOWS_HIDE;
|
||||||
|
pipeproc->proc_opts.exit_cb = exit_cb;
|
||||||
|
pipeproc->proc_opts.cwd = NULL;
|
||||||
|
pipeproc->proc_opts.env = NULL;
|
||||||
|
pipeproc->proc.data = NULL;
|
||||||
|
pipeproc->proc_stdin.data = NULL;
|
||||||
|
pipeproc->proc_stdout.data = NULL;
|
||||||
|
pipeproc->proc_stderr.data = NULL;
|
||||||
|
|
||||||
|
// Initialize the job std{in,out,err}
|
||||||
|
pipeproc->stdio[0].flags = UV_IGNORE;
|
||||||
|
pipeproc->stdio[1].flags = UV_IGNORE;
|
||||||
|
pipeproc->stdio[2].flags = UV_IGNORE;
|
||||||
|
|
||||||
|
handle_set_job((uv_handle_t *)&pipeproc->proc, job);
|
||||||
|
|
||||||
|
if (job->opts.writable) {
|
||||||
|
uv_pipe_init(uv_default_loop(), &pipeproc->proc_stdin, 0);
|
||||||
|
pipeproc->stdio[0].flags = UV_CREATE_PIPE | UV_READABLE_PIPE;
|
||||||
|
pipeproc->stdio[0].data.stream = (uv_stream_t *)&pipeproc->proc_stdin;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (job->opts.stdout_cb) {
|
||||||
|
uv_pipe_init(uv_default_loop(), &pipeproc->proc_stdout, 0);
|
||||||
|
pipeproc->stdio[1].flags = UV_CREATE_PIPE | UV_WRITABLE_PIPE;
|
||||||
|
pipeproc->stdio[1].data.stream = (uv_stream_t *)&pipeproc->proc_stdout;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (job->opts.stderr_cb) {
|
||||||
|
uv_pipe_init(uv_default_loop(), &pipeproc->proc_stderr, 0);
|
||||||
|
pipeproc->stdio[2].flags = UV_CREATE_PIPE | UV_WRITABLE_PIPE;
|
||||||
|
pipeproc->stdio[2].data.stream = (uv_stream_t *)&pipeproc->proc_stderr;
|
||||||
|
}
|
||||||
|
|
||||||
|
job->proc_stdin = (uv_stream_t *)&pipeproc->proc_stdin;
|
||||||
|
job->proc_stdout = (uv_stream_t *)&pipeproc->proc_stdout;
|
||||||
|
job->proc_stderr = (uv_stream_t *)&pipeproc->proc_stderr;
|
||||||
|
job->process = pipeproc;
|
||||||
|
}
|
||||||
|
|
||||||
|
void pipe_process_destroy(Job *job)
|
||||||
|
{
|
||||||
|
UvProcess *pipeproc = job->process;
|
||||||
|
free(pipeproc->proc.data);
|
||||||
|
free(pipeproc);
|
||||||
|
job->process = NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool pipe_process_spawn(Job *job)
|
||||||
|
{
|
||||||
|
UvProcess *pipeproc = job->process;
|
||||||
|
|
||||||
|
if (uv_spawn(uv_default_loop(), &pipeproc->proc, &pipeproc->proc_opts) != 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
job->pid = pipeproc->proc.pid;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void pipe_process_close(Job *job)
|
||||||
|
{
|
||||||
|
UvProcess *pipeproc = job->process;
|
||||||
|
uv_close((uv_handle_t *)&pipeproc->proc, close_cb);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void exit_cb(uv_process_t *proc, int64_t status, int term_signal)
|
||||||
|
{
|
||||||
|
Job *job = handle_get_job((uv_handle_t *)proc);
|
||||||
|
job->status = (int)status;
|
||||||
|
pipe_process_close(job);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void close_cb(uv_handle_t *handle)
|
||||||
|
{
|
||||||
|
Job *job = handle_get_job(handle);
|
||||||
|
job_close_streams(job);
|
||||||
|
job_decref(job);
|
||||||
|
}
|
7
src/nvim/os/pipe_process.h
Normal file
7
src/nvim/os/pipe_process.h
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
#ifndef NVIM_OS_PIPE_PROCESS_H
|
||||||
|
#define NVIM_OS_PIPE_PROCESS_H
|
||||||
|
|
||||||
|
#ifdef INCLUDE_GENERATED_DECLARATIONS
|
||||||
|
# include "os/pipe_process.h.generated.h"
|
||||||
|
#endif
|
||||||
|
#endif // NVIM_OS_PIPE_PROCESS_H
|
@@ -201,14 +201,14 @@ static int shell(const char *cmd,
|
|||||||
char **argv = shell_build_argv(cmd, extra_args);
|
char **argv = shell_build_argv(cmd, extra_args);
|
||||||
|
|
||||||
int status;
|
int status;
|
||||||
Job *job = job_start(argv,
|
JobOptions opts = JOB_OPTIONS_INIT;
|
||||||
&buf,
|
opts.argv = argv;
|
||||||
input != NULL,
|
opts.data = &buf;
|
||||||
data_cb,
|
opts.writable = input != NULL;
|
||||||
data_cb,
|
opts.stdout_cb = data_cb;
|
||||||
NULL,
|
opts.stderr_cb = data_cb;
|
||||||
0,
|
opts.exit_cb = NULL;
|
||||||
&status);
|
Job *job = job_start(opts, &status);
|
||||||
|
|
||||||
if (status <= 0) {
|
if (status <= 0) {
|
||||||
// Failed, probably due to `sh` not being executable
|
// Failed, probably due to `sh` not being executable
|
||||||
|
Reference in New Issue
Block a user