Annotation of src/usr.bin/tmux/cmd-pipe-pane.c, Revision 1.53
1.53 ! nicm 1: /* $OpenBSD: cmd-pipe-pane.c,v 1.52 2020/04/13 08:26:27 nicm Exp $ */
1.1 nicm 2:
3: /*
1.36 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.4 nicm 20: #include <sys/socket.h>
1.1 nicm 21:
22: #include <errno.h>
23: #include <fcntl.h>
24: #include <paths.h>
1.45 nicm 25: #include <signal.h>
1.29 nicm 26: #include <stdlib.h>
1.1 nicm 27: #include <string.h>
1.13 nicm 28: #include <time.h>
1.1 nicm 29: #include <unistd.h>
30:
31: #include "tmux.h"
32:
33: /*
34: * Open pipe to redirect pane output. If already open, close first.
35: */
36:
1.39 nicm 37: static enum cmd_retval cmd_pipe_pane_exec(struct cmd *, struct cmdq_item *);
1.1 nicm 38:
1.47 nicm 39: static void cmd_pipe_pane_read_callback(struct bufferevent *, void *);
1.43 nicm 40: static void cmd_pipe_pane_write_callback(struct bufferevent *, void *);
1.37 nicm 41: static void cmd_pipe_pane_error_callback(struct bufferevent *, short, void *);
1.4 nicm 42:
1.1 nicm 43: const struct cmd_entry cmd_pipe_pane_entry = {
1.34 nicm 44: .name = "pipe-pane",
45: .alias = "pipep",
46:
1.47 nicm 47: .args = { "IOot:", 0, 1 },
48: .usage = "[-IOo] " CMD_TARGET_PANE_USAGE " [command]",
1.34 nicm 49:
1.41 nicm 50: .target = { 't', CMD_FIND_PANE, 0 },
1.35 nicm 51:
1.38 nicm 52: .flags = CMD_AFTERHOOK,
1.34 nicm 53: .exec = cmd_pipe_pane_exec
1.1 nicm 54: };
55:
1.37 nicm 56: static enum cmd_retval
1.39 nicm 57: cmd_pipe_pane_exec(struct cmd *self, struct cmdq_item *item)
1.1 nicm 58: {
1.52 nicm 59: struct args *args = cmd_get_args(self);
1.53 ! nicm 60: struct cmd_find_state *target = cmdq_get_target(item);
1.41 nicm 61: struct client *c = cmd_find_client(item, NULL, 1);
1.53 ! nicm 62: struct window_pane *wp = target->wp;
! 63: struct session *s = target->s;
! 64: struct winlink *wl = target->wl;
1.29 nicm 65: char *cmd;
1.47 nicm 66: int old_fd, pipe_fd[2], null_fd, in, out;
1.29 nicm 67: struct format_tree *ft;
1.45 nicm 68: sigset_t set, oldset;
1.1 nicm 69:
70: /* Destroy the old pipe. */
71: old_fd = wp->pipe_fd;
72: if (wp->pipe_fd != -1) {
1.4 nicm 73: bufferevent_free(wp->pipe_event);
1.1 nicm 74: close(wp->pipe_fd);
75: wp->pipe_fd = -1;
1.43 nicm 76:
77: if (window_pane_destroy_ready(wp)) {
78: server_destroy_pane(wp, 1);
79: return (CMD_RETURN_NORMAL);
80: }
1.1 nicm 81: }
82:
83: /* If no pipe command, that is enough. */
1.17 nicm 84: if (args->argc == 0 || *args->argv[0] == '\0')
1.22 nicm 85: return (CMD_RETURN_NORMAL);
1.1 nicm 86:
87: /*
88: * With -o, only open the new pipe if there was no previous one. This
89: * allows a pipe to be toggled with a single key, for example:
90: *
91: * bind ^p pipep -o 'cat >>~/output'
92: */
1.52 nicm 93: if (args_has(args, 'o') && old_fd != -1)
1.22 nicm 94: return (CMD_RETURN_NORMAL);
1.1 nicm 95:
1.47 nicm 96: /* What do we want to do? Neither -I or -O is -O. */
1.52 nicm 97: if (args_has(args, 'I')) {
1.47 nicm 98: in = 1;
1.52 nicm 99: out = args_has(args, 'O');
1.47 nicm 100: } else {
101: in = 0;
102: out = 1;
103: }
104:
1.1 nicm 105: /* Open the new pipe. */
1.4 nicm 106: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, pipe_fd) != 0) {
1.39 nicm 107: cmdq_error(item, "socketpair error: %s", strerror(errno));
1.22 nicm 108: return (CMD_RETURN_ERROR);
1.1 nicm 109: }
110:
1.29 nicm 111: /* Expand the command. */
1.53 ! nicm 112: ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
1.29 nicm 113: format_defaults(ft, c, s, wl, wp);
1.51 nicm 114: cmd = format_expand_time(ft, args->argv[0]);
1.29 nicm 115: format_free(ft);
116:
1.1 nicm 117: /* Fork the child. */
1.45 nicm 118: sigfillset(&set);
119: sigprocmask(SIG_BLOCK, &set, &oldset);
1.1 nicm 120: switch (fork()) {
121: case -1:
1.45 nicm 122: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.39 nicm 123: cmdq_error(item, "fork error: %s", strerror(errno));
1.29 nicm 124:
125: free(cmd);
1.22 nicm 126: return (CMD_RETURN_ERROR);
1.1 nicm 127: case 0:
128: /* Child process. */
1.46 nicm 129: proc_clear_signals(server_proc, 1);
1.45 nicm 130: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.1 nicm 131: close(pipe_fd[0]);
132:
133: null_fd = open(_PATH_DEVNULL, O_WRONLY, 0);
1.47 nicm 134: if (out) {
135: if (dup2(pipe_fd[1], STDIN_FILENO) == -1)
136: _exit(1);
137: } else {
138: if (dup2(null_fd, STDIN_FILENO) == -1)
139: _exit(1);
140: }
141: if (in) {
142: if (dup2(pipe_fd[1], STDOUT_FILENO) == -1)
143: _exit(1);
144: if (pipe_fd[1] != STDOUT_FILENO)
145: close(pipe_fd[1]);
146: } else {
147: if (dup2(null_fd, STDOUT_FILENO) == -1)
148: _exit(1);
149: }
1.1 nicm 150: if (dup2(null_fd, STDERR_FILENO) == -1)
151: _exit(1);
1.16 nicm 152: closefrom(STDERR_FILENO + 1);
153:
1.29 nicm 154: execl(_PATH_BSHELL, "sh", "-c", cmd, (char *) NULL);
1.1 nicm 155: _exit(1);
156: default:
157: /* Parent process. */
1.45 nicm 158: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.1 nicm 159: close(pipe_fd[1]);
160:
161: wp->pipe_fd = pipe_fd[0];
1.49 nicm 162: if (wp->fd != -1)
163: wp->pipe_off = EVBUFFER_LENGTH(wp->event->input);
164: else
165: wp->pipe_off = 0;
1.9 nicm 166:
1.47 nicm 167: setblocking(wp->pipe_fd, 0);
168: wp->pipe_event = bufferevent_new(wp->pipe_fd,
169: cmd_pipe_pane_read_callback,
170: cmd_pipe_pane_write_callback,
171: cmd_pipe_pane_error_callback,
1.43 nicm 172: wp);
1.48 nicm 173: if (wp->pipe_event == NULL)
174: fatalx("out of memory");
1.47 nicm 175: if (out)
176: bufferevent_enable(wp->pipe_event, EV_WRITE);
177: if (in)
178: bufferevent_enable(wp->pipe_event, EV_READ);
1.29 nicm 179:
180: free(cmd);
1.22 nicm 181: return (CMD_RETURN_NORMAL);
1.1 nicm 182: }
1.4 nicm 183: }
184:
1.37 nicm 185: static void
1.47 nicm 186: cmd_pipe_pane_read_callback(__unused struct bufferevent *bufev, void *data)
187: {
188: struct window_pane *wp = data;
189: struct evbuffer *evb = wp->pipe_event->input;
190: size_t available;
191:
192: available = EVBUFFER_LENGTH(evb);
193: log_debug("%%%u pipe read %zu", wp->id, available);
194:
195: bufferevent_write(wp->event, EVBUFFER_DATA(evb), available);
196: evbuffer_drain(evb, available);
197:
198: if (window_pane_destroy_ready(wp))
199: server_destroy_pane(wp, 1);
200: }
201:
202: static void
1.43 nicm 203: cmd_pipe_pane_write_callback(__unused struct bufferevent *bufev, void *data)
204: {
205: struct window_pane *wp = data;
206:
207: log_debug("%%%u pipe empty", wp->id);
1.47 nicm 208:
1.43 nicm 209: if (window_pane_destroy_ready(wp))
210: server_destroy_pane(wp, 1);
211: }
212:
213: static void
1.30 nicm 214: cmd_pipe_pane_error_callback(__unused struct bufferevent *bufev,
215: __unused short what, void *data)
1.4 nicm 216: {
217: struct window_pane *wp = data;
218:
1.43 nicm 219: log_debug("%%%u pipe error", wp->id);
220:
1.4 nicm 221: bufferevent_free(wp->pipe_event);
222: close(wp->pipe_fd);
223: wp->pipe_fd = -1;
1.43 nicm 224:
225: if (window_pane_destroy_ready(wp))
226: server_destroy_pane(wp, 1);
1.1 nicm 227: }