[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.44

1.44    ! nicm        1: /* $OpenBSD: job.c,v 1.43 2017/04/20 09:20:22 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.2       nicm       40: /* All jobs list. */
1.24      nicm       41: struct joblist all_jobs = LIST_HEAD_INITIALIZER(all_jobs);
1.2       nicm       42:
1.25      nicm       43: /* Start a job running, if it isn't already. */
1.1       nicm       44: struct job *
1.38      nicm       45: job_run(const char *cmd, struct session *s, const char *cwd,
1.43      nicm       46:     job_update_cb updatecb, job_complete_cb completecb, job_free_cb freecb,
                     47:     void *data)
1.1       nicm       48: {
                     49:        struct job      *job;
1.37      nicm       50:        struct environ  *env;
1.25      nicm       51:        pid_t            pid;
                     52:        int              nullfd, out[2];
1.38      nicm       53:        const char      *home;
1.1       nicm       54:
1.11      nicm       55:        if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, out) != 0)
1.25      nicm       56:                return (NULL);
1.1       nicm       57:
1.44    ! nicm       58:        /*
        !            59:         * Do not set TERM during .tmux.conf, it is nice to be able to use
        !            60:         * if-shell to decide on default-terminal based on outside TERM.
        !            61:         */
        !            62:        env = environ_for_session(s, !cfg_finished);
        !            63:
1.25      nicm       64:        switch (pid = fork()) {
1.1       nicm       65:        case -1:
1.37      nicm       66:                environ_free(env);
1.33      nicm       67:                close(out[0]);
                     68:                close(out[1]);
1.25      nicm       69:                return (NULL);
1.1       nicm       70:        case 0:         /* child */
1.20      nicm       71:                clear_signals(1);
1.35      nicm       72:
1.38      nicm       73:                if (cwd == NULL || chdir(cwd) != 0) {
                     74:                        if ((home = find_home()) == NULL || chdir(home) != 0)
                     75:                                chdir("/");
                     76:                }
1.16      nicm       77:
1.37      nicm       78:                environ_push(env);
                     79:                environ_free(env);
1.1       nicm       80:
1.29      nicm       81:                if (dup2(out[1], STDIN_FILENO) == -1)
                     82:                        fatal("dup2 failed");
1.7       nicm       83:                if (dup2(out[1], STDOUT_FILENO) == -1)
1.6       nicm       84:                        fatal("dup2 failed");
1.29      nicm       85:                if (out[1] != STDIN_FILENO && out[1] != STDOUT_FILENO)
1.7       nicm       86:                        close(out[1]);
                     87:                close(out[0]);
1.6       nicm       88:
1.7       nicm       89:                nullfd = open(_PATH_DEVNULL, O_RDWR, 0);
1.1       nicm       90:                if (nullfd < 0)
                     91:                        fatal("open failed");
                     92:                if (dup2(nullfd, STDERR_FILENO) == -1)
                     93:                        fatal("dup2 failed");
1.29      nicm       94:                if (nullfd != STDERR_FILENO)
1.1       nicm       95:                        close(nullfd);
                     96:
1.21      nicm       97:                closefrom(STDERR_FILENO + 1);
                     98:
1.25      nicm       99:                execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1       nicm      100:                fatal("execl failed");
1.25      nicm      101:        }
                    102:
                    103:        /* parent */
1.37      nicm      104:        environ_free(env);
1.25      nicm      105:        close(out[1]);
                    106:
                    107:        job = xmalloc(sizeof *job);
1.36      nicm      108:        job->state = JOB_RUNNING;
                    109:
1.25      nicm      110:        job->cmd = xstrdup(cmd);
                    111:        job->pid = pid;
                    112:        job->status = 0;
                    113:
1.43      nicm      114:        LIST_INSERT_HEAD(&all_jobs, job, entry);
1.25      nicm      115:
1.43      nicm      116:        job->updatecb = updatecb;
                    117:        job->completecb = completecb;
                    118:        job->freecb = freecb;
1.25      nicm      119:        job->data = data;
                    120:
                    121:        job->fd = out[0];
                    122:        setblocking(job->fd, 0);
                    123:
1.43      nicm      124:        job->event = bufferevent_new(job->fd, job_read_callback,
                    125:            job_write_callback, job_error_callback, job);
1.30      nicm      126:        bufferevent_enable(job->event, EV_READ|EV_WRITE);
1.25      nicm      127:
                    128:        log_debug("run job %p: %s, pid %ld", job, job->cmd, (long) job->pid);
                    129:        return (job);
                    130: }
                    131:
                    132: /* Kill and free an individual job. */
                    133: void
                    134: job_free(struct job *job)
                    135: {
                    136:        log_debug("free job %p: %s", job, job->cmd);
1.1       nicm      137:
1.43      nicm      138:        LIST_REMOVE(job, entry);
1.27      nicm      139:        free(job->cmd);
1.1       nicm      140:
1.43      nicm      141:        if (job->freecb != NULL && job->data != NULL)
                    142:                job->freecb(job->data);
1.25      nicm      143:
                    144:        if (job->pid != -1)
                    145:                kill(job->pid, SIGTERM);
1.26      nicm      146:        if (job->event != NULL)
                    147:                bufferevent_free(job->event);
1.25      nicm      148:        if (job->fd != -1)
                    149:                close(job->fd);
1.1       nicm      150:
1.27      nicm      151:        free(job);
1.29      nicm      152: }
                    153:
1.43      nicm      154: /* Job buffer read callback. */
                    155: static void
                    156: job_read_callback(__unused struct bufferevent *bufev, void *data)
                    157: {
                    158:        struct job      *job = data;
                    159:
                    160:        if (job->updatecb != NULL)
                    161:                job->updatecb (job);
                    162: }
                    163:
                    164: /*
                    165:  * Job buffer write callback. Fired when the buffer falls below watermark
                    166:  * (default is empty). If all the data has been written, disable the write
                    167:  * event.
                    168:  */
1.41      nicm      169: static void
1.39      nicm      170: job_write_callback(__unused struct bufferevent *bufev, void *data)
1.29      nicm      171: {
                    172:        struct job      *job = data;
                    173:        size_t           len = EVBUFFER_LENGTH(EVBUFFER_OUTPUT(job->event));
                    174:
1.31      nicm      175:        log_debug("job write %p: %s, pid %ld, output left %zu", job, job->cmd,
1.32      nicm      176:            (long) job->pid, len);
1.29      nicm      177:
                    178:        if (len == 0) {
                    179:                shutdown(job->fd, SHUT_WR);
                    180:                bufferevent_disable(job->event, EV_WRITE);
                    181:        }
1.11      nicm      182: }
                    183:
                    184: /* Job buffer error callback. */
1.41      nicm      185: static void
1.43      nicm      186: job_error_callback(__unused struct bufferevent *bufev, __unused short events,
1.39      nicm      187:     void *data)
1.11      nicm      188: {
                    189:        struct job      *job = data;
                    190:
1.25      nicm      191:        log_debug("job error %p: %s, pid %ld", job, job->cmd, (long) job->pid);
1.11      nicm      192:
1.36      nicm      193:        if (job->state == JOB_DEAD) {
1.43      nicm      194:                if (job->completecb != NULL)
                    195:                        job->completecb(job);
1.25      nicm      196:                job_free(job);
                    197:        } else {
                    198:                bufferevent_disable(job->event, EV_READ);
1.36      nicm      199:                job->state = JOB_CLOSED;
1.12      nicm      200:        }
1.11      nicm      201: }
                    202:
                    203: /* Job died (waitpid() returned its pid). */
                    204: void
                    205: job_died(struct job *job, int status)
                    206: {
1.25      nicm      207:        log_debug("job died %p: %s, pid %ld", job, job->cmd, (long) job->pid);
                    208:
1.11      nicm      209:        job->status = status;
1.14      nicm      210:
1.36      nicm      211:        if (job->state == JOB_CLOSED) {
1.43      nicm      212:                if (job->completecb != NULL)
                    213:                        job->completecb(job);
1.25      nicm      214:                job_free(job);
1.36      nicm      215:        } else {
1.25      nicm      216:                job->pid = -1;
1.36      nicm      217:                job->state = JOB_DEAD;
                    218:        }
1.1       nicm      219: }