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