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