Annotation of src/usr.bin/tmux/job.c, Revision 1.51
1.51 ! nicm 1: /* $OpenBSD: job.c,v 1.50 2018/08/23 15:45:05 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.51 ! nicm 40: /* A single job. */
1.50 nicm 41: struct job {
42: enum {
43: JOB_RUNNING,
44: JOB_DEAD,
45: JOB_CLOSED
46: } state;
47:
48: int flags;
49:
50: char *cmd;
51: pid_t pid;
52: int status;
53:
54: int fd;
55: struct bufferevent *event;
56:
57: job_update_cb updatecb;
58: job_complete_cb completecb;
59: job_free_cb freecb;
60: void *data;
61:
62: LIST_ENTRY(job) entry;
63: };
64:
1.2 nicm 65: /* All jobs list. */
1.51 ! nicm 66: static LIST_HEAD(joblist, job) all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2 nicm 67:
1.25 nicm 68: /* Start a job running, if it isn't already. */
1.1 nicm 69: struct job *
1.38 nicm 70: job_run(const char *cmd, struct session *s, const char *cwd,
1.43 nicm 71: job_update_cb updatecb, job_complete_cb completecb, job_free_cb freecb,
1.49 nicm 72: void *data, int flags)
1.1 nicm 73: {
74: struct job *job;
1.37 nicm 75: struct environ *env;
1.25 nicm 76: pid_t pid;
77: int nullfd, out[2];
1.38 nicm 78: const char *home;
1.47 nicm 79: sigset_t set, oldset;
1.1 nicm 80:
1.11 nicm 81: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
1.25 nicm 82: return (NULL);
1.1 nicm 83:
1.44 nicm 84: /*
85: * Do not set TERM during .tmux.conf, it is nice to be able to use
86: * if-shell to decide on default-terminal based on outside TERM.
87: */
88: env = environ_for_session(s, !cfg_finished);
89:
1.47 nicm 90: sigfillset(&set);
91: sigprocmask(SIG_BLOCK, &set, &oldset);
1.25 nicm 92: switch (pid = fork()) {
1.1 nicm 93: case -1:
1.47 nicm 94: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 95: environ_free(env);
1.33 nicm 96: close(out[0]);
97: close(out[1]);
1.25 nicm 98: return (NULL);
1.47 nicm 99: case 0:
1.48 nicm 100: proc_clear_signals(server_proc, 1);
1.47 nicm 101: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.35 nicm 102:
1.38 nicm 103: if (cwd == NULL || chdir(cwd) != 0) {
104: if ((home = find_home()) == NULL || chdir(home) != 0)
105: chdir("/");
106: }
1.16 nicm 107:
1.37 nicm 108: environ_push(env);
109: environ_free(env);
1.1 nicm 110:
1.29 nicm 111: if (dup2(out[1], STDIN_FILENO) == -1)
112: fatal("dup2 failed");
1.7 nicm 113: if (dup2(out[1], STDOUT_FILENO) == -1)
1.6 nicm 114: fatal("dup2 failed");
1.29 nicm 115: if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
1.7 nicm 116: close(out[1]);
117: close(out[0]);
1.6 nicm 118:
1.7 nicm 119: nullfd = open(_PATH_DEVNULL, O_RDWR, 0);
1.1 nicm 120: if (nullfd < 0)
121: fatal("open failed");
122: if (dup2(nullfd, STDERR_FILENO) == -1)
123: fatal("dup2 failed");
1.29 nicm 124: if (nullfd != STDERR_FILENO)
1.1 nicm 125: close(nullfd);
126:
1.21 nicm 127: closefrom(STDERR_FILENO + 1);
128:
1.25 nicm 129: execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1 nicm 130: fatal("execl failed");
1.25 nicm 131: }
132:
1.47 nicm 133: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 134: environ_free(env);
1.25 nicm 135: close(out[1]);
136:
137: job = xmalloc(sizeof *job);
1.36 nicm 138: job->state = JOB_RUNNING;
1.49 nicm 139: job->flags = flags;
1.36 nicm 140:
1.25 nicm 141: job->cmd = xstrdup(cmd);
142: job->pid = pid;
143: job->status = 0;
144:
1.43 nicm 145: LIST_INSERT_HEAD(&all_jobs, job, entry);
1.25 nicm 146:
1.43 nicm 147: job->updatecb = updatecb;
148: job->completecb = completecb;
149: job->freecb = freecb;
1.25 nicm 150: job->data = data;
151:
152: job->fd = out[0];
153: setblocking(job->fd, 0);
154:
1.43 nicm 155: job->event = bufferevent_new(job->fd, job_read_callback,
156: job_write_callback, job_error_callback, job);
1.30 nicm 157: bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25 nicm 158:
159: log_debug("run job %p: %s, pid %ld", job, job->cmd, (long) job->pid);
160: return (job);
161: }
162:
163: /* Kill and free an individual job. */
164: void
165: job_free(struct job *job)
166: {
167: log_debug("free job %p: %s", job, job->cmd);
1.1 nicm 168:
1.43 nicm 169: LIST_REMOVE(job, entry);
1.27 nicm 170: free(job->cmd);
1.1 nicm 171:
1.43 nicm 172: if (job->freecb != NULL && job->data != NULL)
173: job->freecb(job->data);
1.25 nicm 174:
175: if (job->pid != -1)
176: kill(job->pid, SIGTERM);
1.26 nicm 177: if (job->event != NULL)
178: bufferevent_free(job->event);
1.25 nicm 179: if (job->fd != -1)
180: close(job->fd);
1.1 nicm 181:
1.27 nicm 182: free(job);
1.29 nicm 183: }
184:
1.43 nicm 185: /* Job buffer read callback. */
186: static void
187: job_read_callback(__unused struct bufferevent *bufev, void *data)
188: {
189: struct job *job = data;
190:
191: if (job->updatecb != NULL)
1.45 nicm 192: job->updatecb(job);
1.43 nicm 193: }
194:
195: /*
196: * Job buffer write callback. Fired when the buffer falls below watermark
197: * (default is empty). If all the data has been written, disable the write
198: * event.
199: */
1.41 nicm 200: static void
1.39 nicm 201: job_write_callback(__unused struct bufferevent *bufev, void *data)
1.29 nicm 202: {
203: struct job *job = data;
204: size_t len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
205:
1.31 nicm 206: log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32 nicm 207: (long) job->pid, len);
1.29 nicm 208:
209: if (len == 0) {
210: shutdown(job->fd, SHUT_WR);
211: bufferevent_disable(job->event, EV_WRITE);
212: }
1.11 nicm 213: }
214:
215: /* Job buffer error callback. */
1.41 nicm 216: static void
1.43 nicm 217: job_error_callback(__unused struct bufferevent *bufev, __unused short events,
1.39 nicm 218: void *data)
1.11 nicm 219: {
220: struct job *job = data;
221:
1.25 nicm 222: log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11 nicm 223:
1.36 nicm 224: if (job->state == JOB_DEAD) {
1.43 nicm 225: if (job->completecb != NULL)
226: job->completecb(job);
1.25 nicm 227: job_free(job);
228: } else {
229: bufferevent_disable(job->event, EV_READ);
1.36 nicm 230: job->state = JOB_CLOSED;
1.12 nicm 231: }
1.11 nicm 232: }
233:
234: /* Job died (waitpid() returned its pid). */
235: void
1.50 nicm 236: job_check_died(pid_t pid, int status)
1.11 nicm 237: {
1.50 nicm 238: struct job *job;
239:
240: LIST_FOREACH(job, &all_jobs, entry) {
241: if (pid == job->pid)
242: break;
243: }
244: if (job == NULL)
245: return;
1.25 nicm 246: log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
247:
1.11 nicm 248: job->status = status;
1.14 nicm 249:
1.36 nicm 250: if (job->state == JOB_CLOSED) {
1.43 nicm 251: if (job->completecb != NULL)
252: job->completecb(job);
1.25 nicm 253: job_free(job);
1.36 nicm 254: } else {
1.25 nicm 255: job->pid = -1;
1.36 nicm 256: job->state = JOB_DEAD;
1.50 nicm 257: }
258: }
259:
260: /* Get job status. */
261: int
262: job_get_status(struct job *job)
263: {
264: return (job->status);
265: }
266:
267: /* Get job data. */
268: void *
269: job_get_data(struct job *job)
270: {
271: return (job->data);
272: }
273:
274: /* Get job event. */
275: struct bufferevent *
276: job_get_event(struct job *job)
277: {
278: return (job->event);
279: }
280:
281: /* Kill all jobs. */
282: void
283: job_kill_all(void)
284: {
285: struct job *job;
286:
287: LIST_FOREACH(job, &all_jobs, entry) {
288: if (job->pid != -1)
289: kill(job->pid, SIGTERM);
290: }
291: }
292:
293: /* Are any jobs still running? */
294: int
295: job_still_running(void)
296: {
297: struct job *job;
298:
299: LIST_FOREACH(job, &all_jobs, entry) {
300: if ((~job->flags & JOB_NOWAIT) && job->state == JOB_RUNNING)
301: return (1);
302: }
303: return (0);
304: }
305:
306: /* Print job summary. */
307: void
308: job_print_summary(struct cmdq_item *item, int blank)
309: {
310: struct job *job;
311: u_int n = 0;
312:
313: LIST_FOREACH(job, &all_jobs, entry) {
314: if (blank) {
315: cmdq_print(item, "%s", "");
316: blank = 0;
317: }
318: cmdq_print(item, "Job %u: %s [fd=%d, pid=%ld, status=%d]",
319: n, job->cmd, job->fd, (long)job->pid, job->status);
320: n++;
1.36 nicm 321: }
1.1 nicm 322: }
![[BACK]](/icons/back.gif){kind=icon}
Return to job.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tmux