Annotation of src/usr.bin/tmux/job.c, Revision 1.57
1.57 ! nicm 1: /* $OpenBSD: job.c,v 1.56 2020/03/19 13:43:18 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.57 ! nicm 20: #include <sys/ioctl.h>
1.11 nicm 21: #include <sys/socket.h>
1.1 nicm 22:
23: #include <fcntl.h>
24: #include <paths.h>
1.34 nicm 25: #include <signal.h>
1.27 nicm 26: #include <stdlib.h>
1.1 nicm 27: #include <string.h>
28: #include <unistd.h>
1.56 nicm 29: #include <util.h>
1.1 nicm 30:
31: #include "tmux.h"
32:
33: /*
34: * Job scheduling. Run queued commands in the background and record their
35: * output.
36: */
37:
1.43 nicm 38: static void job_read_callback(struct bufferevent *, void *);
1.41 nicm 39: static void job_write_callback(struct bufferevent *, void *);
1.43 nicm 40: static void job_error_callback(struct bufferevent *, short, void *);
1.25 nicm 41:
1.51 nicm 42: /* A single job. */
1.50 nicm 43: struct job {
44: enum {
45: JOB_RUNNING,
46: JOB_DEAD,
47: JOB_CLOSED
48: } state;
49:
50: int flags;
51:
52: char *cmd;
53: pid_t pid;
54: int status;
55:
56: int fd;
57: struct bufferevent *event;
58:
59: job_update_cb updatecb;
60: job_complete_cb completecb;
61: job_free_cb freecb;
62: void *data;
63:
64: LIST_ENTRY(job) entry;
65: };
66:
1.2 nicm 67: /* All jobs list. */
1.51 nicm 68: static LIST_HEAD(joblist, job) all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2 nicm 69:
1.25 nicm 70: /* Start a job running, if it isn't already. */
1.1 nicm 71: struct job *
1.38 nicm 72: job_run(const char *cmd, struct session *s, const char *cwd,
1.43 nicm 73: job_update_cb updatecb, job_complete_cb completecb, job_free_cb freecb,
1.56 nicm 74: void *data, int flags, int sx, int sy)
1.1 nicm 75: {
76: struct job *job;
1.37 nicm 77: struct environ *env;
1.25 nicm 78: pid_t pid;
1.56 nicm 79: int nullfd, out[2], master;
1.38 nicm 80: const char *home;
1.47 nicm 81: sigset_t set, oldset;
1.56 nicm 82: struct winsize ws;
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.56 nicm 92:
93: if (flags & JOB_PTY) {
94: memset(&ws, 0, sizeof ws);
95: ws.ws_col = sx;
96: ws.ws_row = sy;
97: pid = fdforkpty(ptm_fd, &master, NULL, NULL, &ws);
98: } else {
99: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
100: goto fail;
101: pid = fork();
102: }
103: log_debug("%s: cmd=%s, cwd=%s", __func__, cmd, cwd == NULL ? "" : cwd);
104:
105: switch (pid) {
1.1 nicm 106: case -1:
1.56 nicm 107: if (~flags & JOB_PTY) {
108: close(out[0]);
109: close(out[1]);
110: }
111: goto fail;
1.47 nicm 112: case 0:
1.48 nicm 113: proc_clear_signals(server_proc, 1);
1.47 nicm 114: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.35 nicm 115:
1.38 nicm 116: if (cwd == NULL || chdir(cwd) != 0) {
117: if ((home = find_home()) == NULL || chdir(home) != 0)
118: chdir("/");
119: }
1.16 nicm 120:
1.37 nicm 121: environ_push(env);
122: environ_free(env);
1.1 nicm 123:
1.56 nicm 124: if (~flags & JOB_PTY) {
125: if (dup2(out[1], STDIN_FILENO) == -1)
126: fatal("dup2 failed");
127: if (dup2(out[1], STDOUT_FILENO) == -1)
128: fatal("dup2 failed");
129: if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
130: close(out[1]);
131: close(out[0]);
132:
133: nullfd = open(_PATH_DEVNULL, O_RDWR, 0);
134: if (nullfd == -1)
135: fatal("open failed");
136: if (dup2(nullfd, STDERR_FILENO) == -1)
137: fatal("dup2 failed");
138: if (nullfd != STDERR_FILENO)
139: close(nullfd);
140: }
1.21 nicm 141: closefrom(STDERR_FILENO + 1);
142:
1.25 nicm 143: execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1 nicm 144: fatal("execl failed");
1.25 nicm 145: }
146:
1.47 nicm 147: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 148: environ_free(env);
1.25 nicm 149:
150: job = xmalloc(sizeof *job);
1.36 nicm 151: job->state = JOB_RUNNING;
1.49 nicm 152: job->flags = flags;
1.36 nicm 153:
1.25 nicm 154: job->cmd = xstrdup(cmd);
155: job->pid = pid;
156: job->status = 0;
157:
1.43 nicm 158: LIST_INSERT_HEAD(&all_jobs, job, entry);
1.25 nicm 159:
1.43 nicm 160: job->updatecb = updatecb;
161: job->completecb = completecb;
162: job->freecb = freecb;
1.25 nicm 163: job->data = data;
164:
1.56 nicm 165: if (~flags & JOB_PTY) {
166: close(out[1]);
167: job->fd = out[0];
168: } else
169: job->fd = master;
1.25 nicm 170: setblocking(job->fd, 0);
171:
1.43 nicm 172: job->event = bufferevent_new(job->fd, job_read_callback,
173: job_write_callback, job_error_callback, job);
1.54 nicm 174: if (job->event == NULL)
175: fatalx("out of memory");
1.30 nicm 176: bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25 nicm 177:
178: log_debug("run job %p: %s, pid %ld", job, job->cmd, (long) job->pid);
179: return (job);
1.56 nicm 180:
181: fail:
182: sigprocmask(SIG_SETMASK, &oldset, NULL);
183: environ_free(env);
184: return (NULL);
1.25 nicm 185: }
186:
187: /* Kill and free an individual job. */
188: void
189: job_free(struct job *job)
190: {
191: log_debug("free job %p: %s", job, job->cmd);
1.1 nicm 192:
1.43 nicm 193: LIST_REMOVE(job, entry);
1.27 nicm 194: free(job->cmd);
1.1 nicm 195:
1.43 nicm 196: if (job->freecb != NULL && job->data != NULL)
197: job->freecb(job->data);
1.25 nicm 198:
199: if (job->pid != -1)
200: kill(job->pid, SIGTERM);
1.26 nicm 201: if (job->event != NULL)
202: bufferevent_free(job->event);
1.25 nicm 203: if (job->fd != -1)
204: close(job->fd);
1.1 nicm 205:
1.27 nicm 206: free(job);
1.57 ! nicm 207: }
! 208:
! 209: /* Resize job. */
! 210: void
! 211: job_resize(struct job *job, u_int sx, u_int sy)
! 212: {
! 213: struct winsize ws;
! 214:
! 215: if (job->fd == -1 || (~job->flags & JOB_PTY))
! 216: return;
! 217:
! 218: log_debug("resize job %p: %ux%u", job, sx, sy);
! 219:
! 220: memset(&ws, 0, sizeof ws);
! 221: ws.ws_col = sx;
! 222: ws.ws_row = sy;
! 223: if (ioctl(job->fd, TIOCSWINSZ, &ws) == -1)
! 224: fatal("ioctl failed");
1.29 nicm 225: }
226:
1.43 nicm 227: /* Job buffer read callback. */
228: static void
229: job_read_callback(__unused struct bufferevent *bufev, void *data)
230: {
231: struct job *job = data;
232:
233: if (job->updatecb != NULL)
1.45 nicm 234: job->updatecb(job);
1.43 nicm 235: }
236:
237: /*
238: * Job buffer write callback. Fired when the buffer falls below watermark
239: * (default is empty). If all the data has been written, disable the write
240: * event.
241: */
1.41 nicm 242: static void
1.39 nicm 243: job_write_callback(__unused struct bufferevent *bufev, void *data)
1.29 nicm 244: {
245: struct job *job = data;
246: size_t len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
247:
1.31 nicm 248: log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32 nicm 249: (long) job->pid, len);
1.29 nicm 250:
1.56 nicm 251: if (len == 0 && (~job->flags & JOB_KEEPWRITE)) {
1.29 nicm 252: shutdown(job->fd, SHUT_WR);
253: bufferevent_disable(job->event, EV_WRITE);
254: }
1.11 nicm 255: }
256:
257: /* Job buffer error callback. */
1.41 nicm 258: static void
1.43 nicm 259: job_error_callback(__unused struct bufferevent *bufev, __unused short events,
1.39 nicm 260: void *data)
1.11 nicm 261: {
262: struct job *job = data;
263:
1.25 nicm 264: log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11 nicm 265:
1.36 nicm 266: if (job->state == JOB_DEAD) {
1.43 nicm 267: if (job->completecb != NULL)
268: job->completecb(job);
1.25 nicm 269: job_free(job);
270: } else {
271: bufferevent_disable(job->event, EV_READ);
1.36 nicm 272: job->state = JOB_CLOSED;
1.12 nicm 273: }
1.11 nicm 274: }
275:
276: /* Job died (waitpid() returned its pid). */
277: void
1.50 nicm 278: job_check_died(pid_t pid, int status)
1.11 nicm 279: {
1.50 nicm 280: struct job *job;
281:
282: LIST_FOREACH(job, &all_jobs, entry) {
283: if (pid == job->pid)
284: break;
285: }
286: if (job == NULL)
287: return;
1.25 nicm 288: log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
289:
1.11 nicm 290: job->status = status;
1.14 nicm 291:
1.36 nicm 292: if (job->state == JOB_CLOSED) {
1.43 nicm 293: if (job->completecb != NULL)
294: job->completecb(job);
1.25 nicm 295: job_free(job);
1.36 nicm 296: } else {
1.25 nicm 297: job->pid = -1;
1.36 nicm 298: job->state = JOB_DEAD;
1.50 nicm 299: }
300: }
301:
302: /* Get job status. */
303: int
304: job_get_status(struct job *job)
305: {
306: return (job->status);
307: }
308:
309: /* Get job data. */
310: void *
311: job_get_data(struct job *job)
312: {
313: return (job->data);
314: }
315:
316: /* Get job event. */
317: struct bufferevent *
318: job_get_event(struct job *job)
319: {
320: return (job->event);
321: }
322:
323: /* Kill all jobs. */
324: void
325: job_kill_all(void)
326: {
327: struct job *job;
328:
329: LIST_FOREACH(job, &all_jobs, entry) {
330: if (job->pid != -1)
331: kill(job->pid, SIGTERM);
332: }
333: }
334:
335: /* Are any jobs still running? */
336: int
337: job_still_running(void)
338: {
339: struct job *job;
340:
341: LIST_FOREACH(job, &all_jobs, entry) {
342: if ((~job->flags & JOB_NOWAIT) && job->state == JOB_RUNNING)
343: return (1);
344: }
345: return (0);
346: }
347:
348: /* Print job summary. */
349: void
350: job_print_summary(struct cmdq_item *item, int blank)
351: {
352: struct job *job;
353: u_int n = 0;
354:
355: LIST_FOREACH(job, &all_jobs, entry) {
356: if (blank) {
357: cmdq_print(item, "%s", "");
358: blank = 0;
359: }
360: cmdq_print(item, "Job %u: %s [fd=%d, pid=%ld, status=%d]",
361: n, job->cmd, job->fd, (long)job->pid, job->status);
362: n++;
1.36 nicm 363: }
1.1 nicm 364: }
![[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