Annotation of src/usr.bin/tmux/job.c, Revision 1.68
1.68 ! nicm 1: /* $OpenBSD: job.c,v 1.67 2022/02/01 12:05:42 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.58 nicm 22: #include <sys/wait.h>
1.1 nicm 23:
24: #include <fcntl.h>
25: #include <paths.h>
1.34 nicm 26: #include <signal.h>
1.27 nicm 27: #include <stdlib.h>
1.1 nicm 28: #include <string.h>
29: #include <unistd.h>
1.56 nicm 30: #include <util.h>
1.1 nicm 31:
32: #include "tmux.h"
33:
34: /*
35: * Job scheduling. Run queued commands in the background and record their
36: * output.
37: */
38:
1.43 nicm 39: static void job_read_callback(struct bufferevent *, void *);
1.41 nicm 40: static void job_write_callback(struct bufferevent *, void *);
1.43 nicm 41: static void job_error_callback(struct bufferevent *, short, void *);
1.25 nicm 42:
1.51 nicm 43: /* A single job. */
1.50 nicm 44: struct job {
45: enum {
46: JOB_RUNNING,
47: JOB_DEAD,
48: JOB_CLOSED
49: } state;
50:
51: int flags;
52:
53: char *cmd;
54: pid_t pid;
1.62 nicm 55: char tty[TTY_NAME_MAX];
1.50 nicm 56: int status;
57:
58: int fd;
59: struct bufferevent *event;
60:
61: job_update_cb updatecb;
62: job_complete_cb completecb;
63: job_free_cb freecb;
64: void *data;
65:
66: LIST_ENTRY(job) entry;
67: };
68:
1.2 nicm 69: /* All jobs list. */
1.51 nicm 70: static LIST_HEAD(joblist, job) all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2 nicm 71:
1.60 nicm 72: /* Start a job running. */
1.1 nicm 73: struct job *
1.65 nicm 74: job_run(const char *cmd, int argc, char **argv, struct environ *e, struct session *s,
1.60 nicm 75: const char *cwd, job_update_cb updatecb, job_complete_cb completecb,
76: job_free_cb freecb, void *data, int flags, int sx, int sy)
1.1 nicm 77: {
1.60 nicm 78: struct job *job;
79: struct environ *env;
80: pid_t pid;
81: int nullfd, out[2], master;
1.68 ! nicm 82: const char *home, *shell;
1.60 nicm 83: sigset_t set, oldset;
84: struct winsize ws;
1.68 ! nicm 85: char **argvp, tty[TTY_NAME_MAX], *argv0;
1.1 nicm 86:
1.44 nicm 87: /*
1.68 ! nicm 88: * Do not set TERM during .tmux.conf (second argument here), it is nice
! 89: * to be able to use if-shell to decide on default-terminal based on
! 90: * outside TERM.
1.44 nicm 91: */
92: env = environ_for_session(s, !cfg_finished);
1.67 nicm 93: if (e != NULL)
1.65 nicm 94: environ_copy(e, env);
1.44 nicm 95:
1.68 ! nicm 96: if (s != NULL)
! 97: shell = options_get_string(s->options, "default-shell");
! 98: else
! 99: shell = options_get_string(global_s_options, "default-shell");
! 100: if (!checkshell(shell))
! 101: shell = _PATH_BSHELL;
! 102: argv0 = shell_argv0(shell, 0);
! 103:
1.47 nicm 104: sigfillset(&set);
105: sigprocmask(SIG_BLOCK, &set, &oldset);
1.56 nicm 106:
107: if (flags & JOB_PTY) {
108: memset(&ws, 0, sizeof ws);
109: ws.ws_col = sx;
110: ws.ws_row = sy;
1.62 nicm 111: pid = fdforkpty(ptm_fd, &master, tty, NULL, &ws);
1.56 nicm 112: } else {
113: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
114: goto fail;
115: pid = fork();
116: }
1.60 nicm 117: if (cmd == NULL) {
118: cmd_log_argv(argc, argv, "%s:", __func__);
1.68 ! nicm 119: log_debug("%s: cwd=%s, shell=%s", __func__,
! 120: cwd == NULL ? "" : cwd, shell);
1.60 nicm 121: } else {
1.68 ! nicm 122: log_debug("%s: cmd=%s, cwd=%s, shell=%s", __func__, cmd,
! 123: cwd == NULL ? "" : cwd, shell);
1.60 nicm 124: }
1.56 nicm 125:
126: switch (pid) {
1.1 nicm 127: case -1:
1.56 nicm 128: if (~flags & JOB_PTY) {
129: close(out[0]);
130: close(out[1]);
131: }
132: goto fail;
1.47 nicm 133: case 0:
1.48 nicm 134: proc_clear_signals(server_proc, 1);
1.47 nicm 135: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.35 nicm 136:
1.59 nicm 137: if ((cwd == NULL || chdir(cwd) != 0) &&
138: ((home = find_home()) == NULL || chdir(home) != 0) &&
139: chdir("/") != 0)
140: fatal("chdir failed");
1.16 nicm 141:
1.37 nicm 142: environ_push(env);
143: environ_free(env);
1.1 nicm 144:
1.56 nicm 145: if (~flags & JOB_PTY) {
146: if (dup2(out[1], STDIN_FILENO) == -1)
147: fatal("dup2 failed");
148: if (dup2(out[1], STDOUT_FILENO) == -1)
149: fatal("dup2 failed");
150: if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
151: close(out[1]);
152: close(out[0]);
153:
1.66 deraadt 154: nullfd = open(_PATH_DEVNULL, O_RDWR);
1.56 nicm 155: if (nullfd == -1)
156: fatal("open failed");
157: if (dup2(nullfd, STDERR_FILENO) == -1)
158: fatal("dup2 failed");
159: if (nullfd != STDERR_FILENO)
160: close(nullfd);
161: }
1.21 nicm 162: closefrom(STDERR_FILENO + 1);
163:
1.60 nicm 164: if (cmd != NULL) {
1.68 ! nicm 165: setenv("SHELL", shell, 1);
! 166: execl(shell, argv0, "-c", cmd, (char *)NULL);
1.60 nicm 167: fatal("execl failed");
168: } else {
169: argvp = cmd_copy_argv(argc, argv);
170: execvp(argvp[0], argvp);
171: fatal("execvp failed");
172: }
1.25 nicm 173: }
174:
1.47 nicm 175: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.37 nicm 176: environ_free(env);
1.68 ! nicm 177: free(argv0);
1.25 nicm 178:
179: job = xmalloc(sizeof *job);
1.36 nicm 180: job->state = JOB_RUNNING;
1.49 nicm 181: job->flags = flags;
1.36 nicm 182:
1.60 nicm 183: if (cmd != NULL)
184: job->cmd = xstrdup(cmd);
185: else
186: job->cmd = cmd_stringify_argv(argc, argv);
1.25 nicm 187: job->pid = pid;
1.62 nicm 188: strlcpy(job->tty, tty, sizeof job->tty);
1.25 nicm 189: job->status = 0;
190:
1.43 nicm 191: LIST_INSERT_HEAD(&all_jobs, job, entry);
1.25 nicm 192:
1.43 nicm 193: job->updatecb = updatecb;
194: job->completecb = completecb;
195: job->freecb = freecb;
1.25 nicm 196: job->data = data;
197:
1.56 nicm 198: if (~flags & JOB_PTY) {
199: close(out[1]);
200: job->fd = out[0];
201: } else
202: job->fd = master;
1.25 nicm 203: setblocking(job->fd, 0);
204:
1.43 nicm 205: job->event = bufferevent_new(job->fd, job_read_callback,
206: job_write_callback, job_error_callback, job);
1.54 nicm 207: if (job->event == NULL)
208: fatalx("out of memory");
1.30 nicm 209: bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25 nicm 210:
1.68 ! nicm 211: log_debug("run job %p: %s, pid %ld", job, job->cmd, (long)job->pid);
1.25 nicm 212: return (job);
1.56 nicm 213:
214: fail:
215: sigprocmask(SIG_SETMASK, &oldset, NULL);
216: environ_free(env);
1.68 ! nicm 217: free(argv0);
1.56 nicm 218: return (NULL);
1.61 nicm 219: }
220:
221: /* Take job's file descriptor and free the job. */
222: int
1.62 nicm 223: job_transfer(struct job *job, pid_t *pid, char *tty, size_t ttylen)
1.61 nicm 224: {
225: int fd = job->fd;
226:
227: log_debug("transfer job %p: %s", job, job->cmd);
1.62 nicm 228:
229: if (pid != NULL)
230: *pid = job->pid;
231: if (tty != NULL)
232: strlcpy(tty, job->tty, ttylen);
1.61 nicm 233:
234: LIST_REMOVE(job, entry);
235: free(job->cmd);
236:
237: if (job->freecb != NULL && job->data != NULL)
238: job->freecb(job->data);
239:
240: if (job->event != NULL)
241: bufferevent_free(job->event);
242:
243: free(job);
244: return (fd);
1.25 nicm 245: }
246:
247: /* Kill and free an individual job. */
248: void
249: job_free(struct job *job)
250: {
251: log_debug("free job %p: %s", job, job->cmd);
1.1 nicm 252:
1.43 nicm 253: LIST_REMOVE(job, entry);
1.27 nicm 254: free(job->cmd);
1.1 nicm 255:
1.43 nicm 256: if (job->freecb != NULL && job->data != NULL)
257: job->freecb(job->data);
1.25 nicm 258:
259: if (job->pid != -1)
260: kill(job->pid, SIGTERM);
1.26 nicm 261: if (job->event != NULL)
262: bufferevent_free(job->event);
1.25 nicm 263: if (job->fd != -1)
264: close(job->fd);
1.1 nicm 265:
1.27 nicm 266: free(job);
1.57 nicm 267: }
268:
269: /* Resize job. */
270: void
271: job_resize(struct job *job, u_int sx, u_int sy)
272: {
273: struct winsize ws;
274:
275: if (job->fd == -1 || (~job->flags & JOB_PTY))
276: return;
277:
278: log_debug("resize job %p: %ux%u", job, sx, sy);
279:
280: memset(&ws, 0, sizeof ws);
281: ws.ws_col = sx;
282: ws.ws_row = sy;
283: if (ioctl(job->fd, TIOCSWINSZ, &ws) == -1)
284: fatal("ioctl failed");
1.29 nicm 285: }
286:
1.43 nicm 287: /* Job buffer read callback. */
288: static void
289: job_read_callback(__unused struct bufferevent *bufev, void *data)
290: {
291: struct job *job = data;
292:
293: if (job->updatecb != NULL)
1.45 nicm 294: job->updatecb(job);
1.43 nicm 295: }
296:
297: /*
298: * Job buffer write callback. Fired when the buffer falls below watermark
299: * (default is empty). If all the data has been written, disable the write
300: * event.
301: */
1.41 nicm 302: static void
1.39 nicm 303: job_write_callback(__unused struct bufferevent *bufev, void *data)
1.29 nicm 304: {
305: struct job *job = data;
306: size_t len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
307:
1.31 nicm 308: log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32 nicm 309: (long) job->pid, len);
1.29 nicm 310:
1.56 nicm 311: if (len == 0 && (~job->flags & JOB_KEEPWRITE)) {
1.29 nicm 312: shutdown(job->fd, SHUT_WR);
313: bufferevent_disable(job->event, EV_WRITE);
314: }
1.11 nicm 315: }
316:
317: /* Job buffer error callback. */
1.41 nicm 318: static void
1.43 nicm 319: job_error_callback(__unused struct bufferevent *bufev, __unused short events,
1.39 nicm 320: void *data)
1.11 nicm 321: {
322: struct job *job = data;
323:
1.25 nicm 324: log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11 nicm 325:
1.36 nicm 326: if (job->state == JOB_DEAD) {
1.43 nicm 327: if (job->completecb != NULL)
328: job->completecb(job);
1.25 nicm 329: job_free(job);
330: } else {
331: bufferevent_disable(job->event, EV_READ);
1.36 nicm 332: job->state = JOB_CLOSED;
1.12 nicm 333: }
1.11 nicm 334: }
335:
336: /* Job died (waitpid() returned its pid). */
337: void
1.50 nicm 338: job_check_died(pid_t pid, int status)
1.11 nicm 339: {
1.50 nicm 340: struct job *job;
341:
342: LIST_FOREACH(job, &all_jobs, entry) {
343: if (pid == job->pid)
344: break;
345: }
346: if (job == NULL)
347: return;
1.58 nicm 348: if (WIFSTOPPED(status)) {
349: if (WSTOPSIG(status) == SIGTTIN || WSTOPSIG(status) == SIGTTOU)
350: return;
351: killpg(job->pid, SIGCONT);
352: return;
353: }
1.25 nicm 354: log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
355:
1.11 nicm 356: job->status = status;
1.14 nicm 357:
1.36 nicm 358: if (job->state == JOB_CLOSED) {
1.43 nicm 359: if (job->completecb != NULL)
360: job->completecb(job);
1.25 nicm 361: job_free(job);
1.36 nicm 362: } else {
1.25 nicm 363: job->pid = -1;
1.36 nicm 364: job->state = JOB_DEAD;
1.50 nicm 365: }
366: }
367:
368: /* Get job status. */
369: int
370: job_get_status(struct job *job)
371: {
372: return (job->status);
373: }
374:
375: /* Get job data. */
376: void *
377: job_get_data(struct job *job)
378: {
379: return (job->data);
380: }
381:
382: /* Get job event. */
383: struct bufferevent *
384: job_get_event(struct job *job)
385: {
386: return (job->event);
387: }
388:
389: /* Kill all jobs. */
390: void
391: job_kill_all(void)
392: {
393: struct job *job;
394:
395: LIST_FOREACH(job, &all_jobs, entry) {
396: if (job->pid != -1)
397: kill(job->pid, SIGTERM);
398: }
399: }
400:
401: /* Are any jobs still running? */
402: int
403: job_still_running(void)
404: {
405: struct job *job;
406:
407: LIST_FOREACH(job, &all_jobs, entry) {
408: if ((~job->flags & JOB_NOWAIT) && job->state == JOB_RUNNING)
409: return (1);
410: }
411: return (0);
412: }
413:
414: /* Print job summary. */
415: void
416: job_print_summary(struct cmdq_item *item, int blank)
417: {
418: struct job *job;
419: u_int n = 0;
420:
421: LIST_FOREACH(job, &all_jobs, entry) {
422: if (blank) {
423: cmdq_print(item, "%s", "");
424: blank = 0;
425: }
426: cmdq_print(item, "Job %u: %s [fd=%d, pid=%ld, status=%d]",
427: n, job->cmd, job->fd, (long)job->pid, job->status);
428: n++;
1.36 nicm 429: }
1.1 nicm 430: }
![[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