Annotation of src/usr.bin/tmux/job.c, Revision 1.49
1.49 ! nicm 1: /* $OpenBSD: job.c,v 1.48 2017/07/14 18:49:07 nicm Exp $ */
1.1 nicm 2:
3: /*
1.40 nicm 4: * Copyright (c) 2009 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15: * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16: * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18:
19: #include <sys/types.h>
1.11 nicm 20: #include <sys/socket.h>
1.1 nicm 21:
22: #include <fcntl.h>
23: #include <paths.h>
1.34 nicm 24: #include <signal.h>
1.27 nicm 25: #include <stdlib.h>
1.1 nicm 26: #include <string.h>
27: #include <unistd.h>
28:
29: #include "tmux.h"
30:
31: /*
32: * Job scheduling. Run queued commands in the background and record their
33: * output.
34: */
35:
1.43 nicm 36: static void job_read_callback(struct bufferevent *, void *);
1.41 nicm 37: static void job_write_callback(struct bufferevent *, void *);
1.43 nicm 38: static void job_error_callback(struct bufferevent *, short, void *);
1.25 nicm 39:
1.2 nicm 40: /* All jobs list. */
1.24 nicm 41: struct joblist all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2 nicm 42:
1.25 nicm 43: /* Start a job running, if it isn't already. */
1.1 nicm 44: struct job *
1.38 nicm 45: job_run(const char *cmd, struct session *s, const char *cwd,
1.43 nicm 46: job_update_cb updatecb, job_complete_cb completecb, job_free_cb freecb,
1.49 ! nicm 47: void *data, int flags)
1.1 nicm 48: {
49: struct job *job;
1.37 nicm 50: struct environ *env;
1.25 nicm 51: pid_t pid;
52: int nullfd, out[2];
1.38 nicm 53: const char *home;
1.47 nicm 54: sigset_t set, oldset;
1.1 nicm 55:
1.11 nicm 56: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
1.25 nicm 57: return (NULL);
1.1 nicm 58:
1.44 nicm 59: /*
60: * Do not set TERM during .tmux.conf, it is nice to be able to use
61: * if-shell to decide on default-terminal based on outside TERM.
62: */
63: env = environ_for_session(s, !cfg_finished);
64:
1.47 nicm 65: sigfillset(&set);
66: sigprocmask(SIG_BLOCK, &set, &oldset);
1.25 nicm 67: switch (pid = fork()) {
1.1 nicm 68: case -1:
1.47 nicm 69: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 70: environ_free(env);
1.33 nicm 71: close(out[0]);
72: close(out[1]);
1.25 nicm 73: return (NULL);
1.47 nicm 74: case 0:
1.48 nicm 75: proc_clear_signals(server_proc, 1);
1.47 nicm 76: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.35 nicm 77:
1.38 nicm 78: if (cwd == NULL || chdir(cwd) != 0) {
79: if ((home = find_home()) == NULL || chdir(home) != 0)
80: chdir("/");
81: }
1.16 nicm 82:
1.37 nicm 83: environ_push(env);
84: environ_free(env);
1.1 nicm 85:
1.29 nicm 86: if (dup2(out[1], STDIN_FILENO) == -1)
87: fatal("dup2 failed");
1.7 nicm 88: if (dup2(out[1], STDOUT_FILENO) == -1)
1.6 nicm 89: fatal("dup2 failed");
1.29 nicm 90: if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
1.7 nicm 91: close(out[1]);
92: close(out[0]);
1.6 nicm 93:
1.7 nicm 94: nullfd = open(_PATH_DEVNULL, O_RDWR, 0);
1.1 nicm 95: if (nullfd < 0)
96: fatal("open failed");
97: if (dup2(nullfd, STDERR_FILENO) == -1)
98: fatal("dup2 failed");
1.29 nicm 99: if (nullfd != STDERR_FILENO)
1.1 nicm 100: close(nullfd);
101:
1.21 nicm 102: closefrom(STDERR_FILENO + 1);
103:
1.25 nicm 104: execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1 nicm 105: fatal("execl failed");
1.25 nicm 106: }
107:
1.47 nicm 108: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 109: environ_free(env);
1.25 nicm 110: close(out[1]);
111:
112: job = xmalloc(sizeof *job);
1.36 nicm 113: job->state = JOB_RUNNING;
1.49 ! nicm 114: job->flags = flags;
1.36 nicm 115:
1.25 nicm 116: job->cmd = xstrdup(cmd);
117: job->pid = pid;
118: job->status = 0;
119:
1.43 nicm 120: LIST_INSERT_HEAD(&all_jobs, job, entry);
1.25 nicm 121:
1.43 nicm 122: job->updatecb = updatecb;
123: job->completecb = completecb;
124: job->freecb = freecb;
1.25 nicm 125: job->data = data;
126:
127: job->fd = out[0];
128: setblocking(job->fd, 0);
129:
1.43 nicm 130: job->event = bufferevent_new(job->fd, job_read_callback,
131: job_write_callback, job_error_callback, job);
1.30 nicm 132: bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25 nicm 133:
134: log_debug("run job %p: %s, pid %ld", job, job->cmd, (long) job->pid);
135: return (job);
136: }
137:
138: /* Kill and free an individual job. */
139: void
140: job_free(struct job *job)
141: {
142: log_debug("free job %p: %s", job, job->cmd);
1.1 nicm 143:
1.43 nicm 144: LIST_REMOVE(job, entry);
1.27 nicm 145: free(job->cmd);
1.1 nicm 146:
1.43 nicm 147: if (job->freecb != NULL && job->data != NULL)
148: job->freecb(job->data);
1.25 nicm 149:
150: if (job->pid != -1)
151: kill(job->pid, SIGTERM);
1.26 nicm 152: if (job->event != NULL)
153: bufferevent_free(job->event);
1.25 nicm 154: if (job->fd != -1)
155: close(job->fd);
1.1 nicm 156:
1.27 nicm 157: free(job);
1.29 nicm 158: }
159:
1.43 nicm 160: /* Job buffer read callback. */
161: static void
162: job_read_callback(__unused struct bufferevent *bufev, void *data)
163: {
164: struct job *job = data;
165:
166: if (job->updatecb != NULL)
1.45 nicm 167: job->updatecb(job);
1.43 nicm 168: }
169:
170: /*
171: * Job buffer write callback. Fired when the buffer falls below watermark
172: * (default is empty). If all the data has been written, disable the write
173: * event.
174: */
1.41 nicm 175: static void
1.39 nicm 176: job_write_callback(__unused struct bufferevent *bufev, void *data)
1.29 nicm 177: {
178: struct job *job = data;
179: size_t len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
180:
1.31 nicm 181: log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32 nicm 182: (long) job->pid, len);
1.29 nicm 183:
184: if (len == 0) {
185: shutdown(job->fd, SHUT_WR);
186: bufferevent_disable(job->event, EV_WRITE);
187: }
1.11 nicm 188: }
189:
190: /* Job buffer error callback. */
1.41 nicm 191: static void
1.43 nicm 192: job_error_callback(__unused struct bufferevent *bufev, __unused short events,
1.39 nicm 193: void *data)
1.11 nicm 194: {
195: struct job *job = data;
196:
1.25 nicm 197: log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11 nicm 198:
1.36 nicm 199: if (job->state == JOB_DEAD) {
1.43 nicm 200: if (job->completecb != NULL)
201: job->completecb(job);
1.25 nicm 202: job_free(job);
203: } else {
204: bufferevent_disable(job->event, EV_READ);
1.36 nicm 205: job->state = JOB_CLOSED;
1.12 nicm 206: }
1.11 nicm 207: }
208:
209: /* Job died (waitpid() returned its pid). */
210: void
211: job_died(struct job *job, int status)
212: {
1.25 nicm 213: log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
214:
1.11 nicm 215: job->status = status;
1.14 nicm 216:
1.36 nicm 217: if (job->state == JOB_CLOSED) {
1.43 nicm 218: if (job->completecb != NULL)
219: job->completecb(job);
1.25 nicm 220: job_free(job);
1.36 nicm 221: } else {
1.25 nicm 222: job->pid = -1;
1.36 nicm 223: job->state = JOB_DEAD;
224: }
1.1 nicm 225: }