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