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