[BACK]Return to job.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / tmux

Annotation of src/usr.bin/tmux/job.c, Revision 1.42

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