Annotation of src/usr.bin/tmux/job.c, Revision 1.37
1.37 ! nicm 1: /* $OpenBSD: job.c,v 1.36 2015/06/17 16:44:49 nicm Exp $ */
1.1 nicm 2:
3: /*
4: * Copyright (c) 2009 Nicholas Marriott <nicm@users.sourceforge.net>
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.25 nicm 36: void job_callback(struct bufferevent *, short, void *);
1.29 nicm 37: void job_write_callback(struct bufferevent *, void *);
1.25 nicm 38:
1.2 nicm 39: /* All jobs list. */
1.24 nicm 40: struct joblist all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2 nicm 41:
1.25 nicm 42: /* Start a job running, if it isn't already. */
1.1 nicm 43: struct job *
1.35 nicm 44: job_run(const char *cmd, struct session *s, int cwd,
1.1 nicm 45: void (*callbackfn)(struct job *), void (*freefn)(void *), void *data)
46: {
47: struct job *job;
1.37 ! nicm 48: struct environ *env;
1.25 nicm 49: pid_t pid;
50: int nullfd, out[2];
1.1 nicm 51:
1.11 nicm 52: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
1.25 nicm 53: return (NULL);
1.1 nicm 54:
1.37 ! nicm 55: env = environ_create();
! 56: environ_copy(global_environ, env);
1.29 nicm 57: if (s != NULL)
1.37 ! nicm 58: environ_copy(s->environ, env);
! 59: server_fill_environ(s, env);
1.23 nicm 60:
1.25 nicm 61: switch (pid = fork()) {
1.1 nicm 62: case -1:
1.37 ! nicm 63: environ_free(env);
1.33 nicm 64: close(out[0]);
65: close(out[1]);
1.25 nicm 66: return (NULL);
1.1 nicm 67: case 0: /* child */
1.20 nicm 68: clear_signals(1);
1.35 nicm 69:
70: if (cwd != -1 && fchdir(cwd) != 0)
71: chdir("/");
1.16 nicm 72:
1.37 ! nicm 73: environ_push(env);
! 74: environ_free(env);
1.1 nicm 75:
1.29 nicm 76: if (dup2(out[1], STDIN_FILENO) == -1)
77: fatal("dup2 failed");
1.7 nicm 78: if (dup2(out[1], STDOUT_FILENO) == -1)
1.6 nicm 79: fatal("dup2 failed");
1.29 nicm 80: if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
1.7 nicm 81: close(out[1]);
82: close(out[0]);
1.6 nicm 83:
1.7 nicm 84: nullfd = open(_PATH_DEVNULL, O_RDWR, 0);
1.1 nicm 85: if (nullfd < 0)
86: fatal("open failed");
87: if (dup2(nullfd, STDERR_FILENO) == -1)
88: fatal("dup2 failed");
1.29 nicm 89: if (nullfd != STDERR_FILENO)
1.1 nicm 90: close(nullfd);
91:
1.21 nicm 92: closefrom(STDERR_FILENO + 1);
93:
1.25 nicm 94: execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1 nicm 95: fatal("execl failed");
1.25 nicm 96: }
97:
98: /* parent */
1.37 ! nicm 99: environ_free(env);
1.25 nicm 100: close(out[1]);
101:
102: job = xmalloc(sizeof *job);
1.36 nicm 103: job->state = JOB_RUNNING;
104:
1.25 nicm 105: job->cmd = xstrdup(cmd);
106: job->pid = pid;
107: job->status = 0;
108:
109: LIST_INSERT_HEAD(&all_jobs, job, lentry);
110:
111: job->callbackfn = callbackfn;
112: job->freefn = freefn;
113: job->data = data;
114:
115: job->fd = out[0];
116: setblocking(job->fd, 0);
117:
1.29 nicm 118: job->event = bufferevent_new(job->fd, NULL, job_write_callback,
119: job_callback, job);
1.30 nicm 120: bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25 nicm 121:
122: log_debug("run job %p: %s, pid %ld", job, job->cmd, (long) job->pid);
123: return (job);
124: }
125:
126: /* Kill and free an individual job. */
127: void
128: job_free(struct job *job)
129: {
130: log_debug("free job %p: %s", job, job->cmd);
1.1 nicm 131:
1.25 nicm 132: LIST_REMOVE(job, lentry);
1.27 nicm 133: free(job->cmd);
1.1 nicm 134:
1.25 nicm 135: if (job->freefn != NULL && job->data != NULL)
136: job->freefn(job->data);
137:
138: if (job->pid != -1)
139: kill(job->pid, SIGTERM);
1.26 nicm 140: if (job->event != NULL)
141: bufferevent_free(job->event);
1.25 nicm 142: if (job->fd != -1)
143: close(job->fd);
1.1 nicm 144:
1.27 nicm 145: free(job);
1.29 nicm 146: }
147:
148: /* Called when output buffer falls below low watermark (default is 0). */
149: void
150: job_write_callback(unused struct bufferevent *bufev, void *data)
151: {
152: struct job *job = data;
153: size_t len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
154:
1.31 nicm 155: log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32 nicm 156: (long) job->pid, len);
1.29 nicm 157:
158: if (len == 0) {
159: shutdown(job->fd, SHUT_WR);
160: bufferevent_disable(job->event, EV_WRITE);
161: }
1.11 nicm 162: }
163:
164: /* Job buffer error callback. */
165: void
166: job_callback(unused struct bufferevent *bufev, unused short events, void *data)
167: {
168: struct job *job = data;
169:
1.25 nicm 170: log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11 nicm 171:
1.36 nicm 172: if (job->state == JOB_DEAD) {
1.12 nicm 173: if (job->callbackfn != NULL)
174: job->callbackfn(job);
1.25 nicm 175: job_free(job);
176: } else {
177: bufferevent_disable(job->event, EV_READ);
1.36 nicm 178: job->state = JOB_CLOSED;
1.12 nicm 179: }
1.11 nicm 180: }
181:
182: /* Job died (waitpid() returned its pid). */
183: void
184: job_died(struct job *job, int status)
185: {
1.25 nicm 186: log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
187:
1.11 nicm 188: job->status = status;
1.14 nicm 189:
1.36 nicm 190: if (job->state == JOB_CLOSED) {
1.12 nicm 191: if (job->callbackfn != NULL)
192: job->callbackfn(job);
1.25 nicm 193: job_free(job);
1.36 nicm 194: } else {
1.25 nicm 195: job->pid = -1;
1.36 nicm 196: job->state = JOB_DEAD;
197: }
1.1 nicm 198: }