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