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