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