xref: /openbsd/usr.bin/tmux/proc.c (revision 3b700139)
1 /* $OpenBSD: proc.c,v 1.14 2017/07/14 08:04:23 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2015 Nicholas Marriott <nicholas.marriott@gmail.com>
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>
20 #include <sys/queue.h>
21 #include <sys/uio.h>
22 #include <sys/utsname.h>
23 
24 #include <errno.h>
25 #include <event.h>
26 #include <imsg.h>
27 #include <signal.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <unistd.h>
31 
32 #include "tmux.h"
33 
34 struct tmuxproc {
35 	const char	 *name;
36 	int		  exit;
37 
38 	void		(*signalcb)(int);
39 
40 	struct event	  ev_sighup;
41 	struct event	  ev_sigchld;
42 	struct event	  ev_sigcont;
43 	struct event	  ev_sigterm;
44 	struct event	  ev_sigusr1;
45 	struct event	  ev_sigusr2;
46 	struct event	  ev_sigwinch;
47 };
48 
49 struct tmuxpeer {
50 	struct tmuxproc	*parent;
51 
52 	struct imsgbuf	 ibuf;
53 	struct event	 event;
54 
55 	int		 flags;
56 #define PEER_BAD 0x1
57 
58 	void		(*dispatchcb)(struct imsg *, void *);
59 	void		 *arg;
60 };
61 
62 static int	peer_check_version(struct tmuxpeer *, struct imsg *);
63 static void	proc_update_event(struct tmuxpeer *);
64 
65 static void
66 proc_event_cb(__unused int fd, short events, void *arg)
67 {
68 	struct tmuxpeer	*peer = arg;
69 	ssize_t		 n;
70 	struct imsg	 imsg;
71 
72 	if (!(peer->flags & PEER_BAD) && (events & EV_READ)) {
73 		if (((n = imsg_read(&peer->ibuf)) == -1 && errno != EAGAIN) ||
74 		    n == 0) {
75 			peer->dispatchcb(NULL, peer->arg);
76 			return;
77 		}
78 		for (;;) {
79 			if ((n = imsg_get(&peer->ibuf, &imsg)) == -1) {
80 				peer->dispatchcb(NULL, peer->arg);
81 				return;
82 			}
83 			if (n == 0)
84 				break;
85 			log_debug("peer %p message %d", peer, imsg.hdr.type);
86 
87 			if (peer_check_version(peer, &imsg) != 0) {
88 				if (imsg.fd != -1)
89 					close(imsg.fd);
90 				imsg_free(&imsg);
91 				break;
92 			}
93 
94 			peer->dispatchcb(&imsg, peer->arg);
95 			imsg_free(&imsg);
96 		}
97 	}
98 
99 	if (events & EV_WRITE) {
100 		if (msgbuf_write(&peer->ibuf.w) <= 0 && errno != EAGAIN) {
101 			peer->dispatchcb(NULL, peer->arg);
102 			return;
103 		}
104 	}
105 
106 	if ((peer->flags & PEER_BAD) && peer->ibuf.w.queued == 0) {
107 		peer->dispatchcb(NULL, peer->arg);
108 		return;
109 	}
110 
111 	proc_update_event(peer);
112 }
113 
114 static void
115 proc_signal_cb(int signo, __unused short events, void *arg)
116 {
117 	struct tmuxproc	*tp = arg;
118 
119 	tp->signalcb(signo);
120 }
121 
122 static int
123 peer_check_version(struct tmuxpeer *peer, struct imsg *imsg)
124 {
125 	int	version;
126 
127 	version = imsg->hdr.peerid & 0xff;
128 	if (imsg->hdr.type != MSG_VERSION && version != PROTOCOL_VERSION) {
129 		log_debug("peer %p bad version %d", peer, version);
130 
131 		proc_send(peer, MSG_VERSION, -1, NULL, 0);
132 		peer->flags |= PEER_BAD;
133 
134 		return (-1);
135 	}
136 	return (0);
137 }
138 
139 static void
140 proc_update_event(struct tmuxpeer *peer)
141 {
142 	short	events;
143 
144 	event_del(&peer->event);
145 
146 	events = EV_READ;
147 	if (peer->ibuf.w.queued > 0)
148 		events |= EV_WRITE;
149 	event_set(&peer->event, peer->ibuf.fd, events, proc_event_cb, peer);
150 
151 	event_add(&peer->event, NULL);
152 }
153 
154 int
155 proc_send(struct tmuxpeer *peer, enum msgtype type, int fd, const void *buf,
156     size_t len)
157 {
158 	struct imsgbuf	*ibuf = &peer->ibuf;
159 	void		*vp = (void *)buf;
160 	int		 retval;
161 
162 	if (peer->flags & PEER_BAD)
163 		return (-1);
164 	log_debug("sending message %d to peer %p (%zu bytes)", type, peer, len);
165 
166 	retval = imsg_compose(ibuf, type, PROTOCOL_VERSION, -1, fd, vp, len);
167 	if (retval != 1)
168 		return (-1);
169 	proc_update_event(peer);
170 	return (0);
171 }
172 
173 struct tmuxproc *
174 proc_start(const char *name)
175 {
176 	struct tmuxproc	*tp;
177 	struct utsname	 u;
178 
179 	log_open(name);
180 	setproctitle("%s (%s)", name, socket_path);
181 
182 	if (uname(&u) < 0)
183 		memset(&u, 0, sizeof u);
184 
185 	log_debug("%s started (%ld): socket %s, protocol %d", name,
186 	    (long)getpid(), socket_path, PROTOCOL_VERSION);
187 	log_debug("on %s %s %s; libevent %s (%s)", u.sysname, u.release,
188 	    u.version, event_get_version(), event_get_method());
189 
190 	tp = xcalloc(1, sizeof *tp);
191 	tp->name = xstrdup(name);
192 
193 	return (tp);
194 }
195 
196 void
197 proc_loop(struct tmuxproc *tp, int (*loopcb)(void))
198 {
199 	log_debug("%s loop enter", tp->name);
200 	do
201 		event_loop(EVLOOP_ONCE);
202 	while (!tp->exit && (loopcb == NULL || !loopcb ()));
203 	log_debug("%s loop exit", tp->name);
204 }
205 
206 void
207 proc_exit(struct tmuxproc *tp)
208 {
209 	tp->exit = 1;
210 }
211 
212 void
213 proc_set_signals(struct tmuxproc *tp, void (*signalcb)(int))
214 {
215 	struct sigaction	sa;
216 
217 	tp->signalcb = signalcb;
218 
219 	memset(&sa, 0, sizeof sa);
220 	sigemptyset(&sa.sa_mask);
221 	sa.sa_flags = SA_RESTART;
222 	sa.sa_handler = SIG_IGN;
223 
224 	sigaction(SIGINT, &sa, NULL);
225 	sigaction(SIGPIPE, &sa, NULL);
226 	sigaction(SIGTSTP, &sa, NULL);
227 
228 	signal_set(&tp->ev_sighup, SIGHUP, proc_signal_cb, tp);
229 	signal_add(&tp->ev_sighup, NULL);
230 	signal_set(&tp->ev_sigchld, SIGCHLD, proc_signal_cb, tp);
231 	signal_add(&tp->ev_sigchld, NULL);
232 	signal_set(&tp->ev_sigcont, SIGCONT, proc_signal_cb, tp);
233 	signal_add(&tp->ev_sigcont, NULL);
234 	signal_set(&tp->ev_sigterm, SIGTERM, proc_signal_cb, tp);
235 	signal_add(&tp->ev_sigterm, NULL);
236 	signal_set(&tp->ev_sigusr1, SIGUSR1, proc_signal_cb, tp);
237 	signal_add(&tp->ev_sigusr1, NULL);
238 	signal_set(&tp->ev_sigusr2, SIGUSR2, proc_signal_cb, tp);
239 	signal_add(&tp->ev_sigusr2, NULL);
240 	signal_set(&tp->ev_sigwinch, SIGWINCH, proc_signal_cb, tp);
241 	signal_add(&tp->ev_sigwinch, NULL);
242 }
243 
244 void
245 proc_clear_signals(struct tmuxproc *tp)
246 {
247 	struct sigaction	sa;
248 
249 	memset(&sa, 0, sizeof sa);
250 	sigemptyset(&sa.sa_mask);
251 	sa.sa_flags = SA_RESTART;
252 	sa.sa_handler = SIG_DFL;
253 
254 	sigaction(SIGINT, &sa, NULL);
255 	sigaction(SIGPIPE, &sa, NULL);
256 	sigaction(SIGTSTP, &sa, NULL);
257 
258 	signal_del(&tp->ev_sighup);
259 	signal_del(&tp->ev_sigchld);
260 	signal_del(&tp->ev_sigcont);
261 	signal_del(&tp->ev_sigterm);
262 	signal_del(&tp->ev_sigusr1);
263 	signal_del(&tp->ev_sigusr2);
264 	signal_del(&tp->ev_sigwinch);
265 }
266 
267 struct tmuxpeer *
268 proc_add_peer(struct tmuxproc *tp, int fd,
269     void (*dispatchcb)(struct imsg *, void *), void *arg)
270 {
271 	struct tmuxpeer	*peer;
272 
273 	peer = xcalloc(1, sizeof *peer);
274 	peer->parent = tp;
275 
276 	peer->dispatchcb = dispatchcb;
277 	peer->arg = arg;
278 
279 	imsg_init(&peer->ibuf, fd);
280 	event_set(&peer->event, fd, EV_READ, proc_event_cb, peer);
281 
282 	log_debug("add peer %p: %d (%p)", peer, fd, arg);
283 
284 	proc_update_event(peer);
285 	return (peer);
286 }
287 
288 void
289 proc_remove_peer(struct tmuxpeer *peer)
290 {
291 	log_debug("remove peer %p", peer);
292 
293 	event_del(&peer->event);
294 	imsg_clear(&peer->ibuf);
295 
296 	close(peer->ibuf.fd);
297 	free(peer);
298 }
299 
300 void
301 proc_kill_peer(struct tmuxpeer *peer)
302 {
303 	peer->flags |= PEER_BAD;
304 }
305 
306 void
307 proc_toggle_log(struct tmuxproc *tp)
308 {
309 	log_toggle(tp->name);
310 }
311