xref: /minix3/external/bsd/tmux/dist/compat/imsg.c (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc /* Id */
2eda6f593SDavid van Moolenbroek /*	$OpenBSD: imsg.c,v 1.3 2010/05/26 13:56:07 nicm Exp $	*/
3eda6f593SDavid van Moolenbroek 
4eda6f593SDavid van Moolenbroek /*
5eda6f593SDavid van Moolenbroek  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
6eda6f593SDavid van Moolenbroek  *
7eda6f593SDavid van Moolenbroek  * Permission to use, copy, modify, and distribute this software for any
8eda6f593SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
9eda6f593SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
10eda6f593SDavid van Moolenbroek  *
11eda6f593SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12eda6f593SDavid van Moolenbroek  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13eda6f593SDavid van Moolenbroek  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14eda6f593SDavid van Moolenbroek  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15eda6f593SDavid van Moolenbroek  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16eda6f593SDavid van Moolenbroek  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17eda6f593SDavid van Moolenbroek  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18eda6f593SDavid van Moolenbroek  */
19eda6f593SDavid van Moolenbroek 
20eda6f593SDavid van Moolenbroek #include <sys/param.h>
21eda6f593SDavid van Moolenbroek #include <sys/socket.h>
22eda6f593SDavid van Moolenbroek #include <sys/uio.h>
23eda6f593SDavid van Moolenbroek 
24eda6f593SDavid van Moolenbroek #include <errno.h>
25eda6f593SDavid van Moolenbroek #include <stdlib.h>
26eda6f593SDavid van Moolenbroek #include <string.h>
27*0a6a1f1dSLionel Sambuc #include <strings.h>
28eda6f593SDavid van Moolenbroek #include <unistd.h>
29eda6f593SDavid van Moolenbroek 
30eda6f593SDavid van Moolenbroek #include "tmux.h"
31eda6f593SDavid van Moolenbroek 
32eda6f593SDavid van Moolenbroek int	 imsg_get_fd(struct imsgbuf *);
33eda6f593SDavid van Moolenbroek 
34eda6f593SDavid van Moolenbroek void
imsg_init(struct imsgbuf * ibuf,int fd)35eda6f593SDavid van Moolenbroek imsg_init(struct imsgbuf *ibuf, int fd)
36eda6f593SDavid van Moolenbroek {
37eda6f593SDavid van Moolenbroek 	msgbuf_init(&ibuf->w);
38eda6f593SDavid van Moolenbroek 	bzero(&ibuf->r, sizeof(ibuf->r));
39eda6f593SDavid van Moolenbroek 	ibuf->fd = fd;
40eda6f593SDavid van Moolenbroek 	ibuf->w.fd = fd;
41eda6f593SDavid van Moolenbroek 	ibuf->pid = getpid();
42eda6f593SDavid van Moolenbroek 	TAILQ_INIT(&ibuf->fds);
43eda6f593SDavid van Moolenbroek }
44eda6f593SDavid van Moolenbroek 
45eda6f593SDavid van Moolenbroek ssize_t
imsg_read(struct imsgbuf * ibuf)46eda6f593SDavid van Moolenbroek imsg_read(struct imsgbuf *ibuf)
47eda6f593SDavid van Moolenbroek {
48eda6f593SDavid van Moolenbroek 	struct msghdr		 msg;
49eda6f593SDavid van Moolenbroek 	struct cmsghdr		*cmsg;
50eda6f593SDavid van Moolenbroek 	union {
51eda6f593SDavid van Moolenbroek 		struct cmsghdr hdr;
52eda6f593SDavid van Moolenbroek 		char	buf[CMSG_SPACE(sizeof(int) * 16)];
53eda6f593SDavid van Moolenbroek 	} cmsgbuf;
54eda6f593SDavid van Moolenbroek 	struct iovec		 iov;
55eda6f593SDavid van Moolenbroek 	ssize_t			 n;
56eda6f593SDavid van Moolenbroek 	int			 fd;
57eda6f593SDavid van Moolenbroek 	struct imsg_fd		*ifd;
58eda6f593SDavid van Moolenbroek 
59eda6f593SDavid van Moolenbroek 	bzero(&msg, sizeof(msg));
60eda6f593SDavid van Moolenbroek 
61eda6f593SDavid van Moolenbroek 	iov.iov_base = ibuf->r.buf + ibuf->r.wpos;
62eda6f593SDavid van Moolenbroek 	iov.iov_len = sizeof(ibuf->r.buf) - ibuf->r.wpos;
63eda6f593SDavid van Moolenbroek 	msg.msg_iov = &iov;
64eda6f593SDavid van Moolenbroek 	msg.msg_iovlen = 1;
65eda6f593SDavid van Moolenbroek 	msg.msg_control = &cmsgbuf.buf;
66eda6f593SDavid van Moolenbroek 	msg.msg_controllen = CMSG_SPACE(sizeof(int) * 16);
67eda6f593SDavid van Moolenbroek 
68eda6f593SDavid van Moolenbroek 	if ((n = recvmsg(ibuf->fd, &msg, 0)) == -1) {
69eda6f593SDavid van Moolenbroek 		if (errno != EINTR && errno != EAGAIN) {
70eda6f593SDavid van Moolenbroek 			return (-1);
71eda6f593SDavid van Moolenbroek 		}
72eda6f593SDavid van Moolenbroek 		return (-2);
73eda6f593SDavid van Moolenbroek 	}
74eda6f593SDavid van Moolenbroek 
75eda6f593SDavid van Moolenbroek 	ibuf->r.wpos += n;
76eda6f593SDavid van Moolenbroek 
77eda6f593SDavid van Moolenbroek 	for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL;
78eda6f593SDavid van Moolenbroek 	    cmsg = CMSG_NXTHDR(&msg, cmsg)) {
79eda6f593SDavid van Moolenbroek 		if (cmsg->cmsg_level == SOL_SOCKET &&
80eda6f593SDavid van Moolenbroek 		    cmsg->cmsg_type == SCM_RIGHTS) {
81eda6f593SDavid van Moolenbroek 			fd = (*(int *)CMSG_DATA(cmsg));
82eda6f593SDavid van Moolenbroek 			if ((ifd = calloc(1, sizeof(struct imsg_fd))) == NULL) {
83eda6f593SDavid van Moolenbroek 				close(fd);
84eda6f593SDavid van Moolenbroek 				return (-1);
85eda6f593SDavid van Moolenbroek 			}
86eda6f593SDavid van Moolenbroek 			ifd->fd = fd;
87eda6f593SDavid van Moolenbroek 			TAILQ_INSERT_TAIL(&ibuf->fds, ifd, entry);
88eda6f593SDavid van Moolenbroek 		}
89eda6f593SDavid van Moolenbroek 		/* we do not handle other ctl data level */
90eda6f593SDavid van Moolenbroek 	}
91eda6f593SDavid van Moolenbroek 
92eda6f593SDavid van Moolenbroek 	return (n);
93eda6f593SDavid van Moolenbroek }
94eda6f593SDavid van Moolenbroek 
95eda6f593SDavid van Moolenbroek ssize_t
imsg_get(struct imsgbuf * ibuf,struct imsg * imsg)96eda6f593SDavid van Moolenbroek imsg_get(struct imsgbuf *ibuf, struct imsg *imsg)
97eda6f593SDavid van Moolenbroek {
98eda6f593SDavid van Moolenbroek 	size_t			 av, left, datalen;
99eda6f593SDavid van Moolenbroek 
100eda6f593SDavid van Moolenbroek 	av = ibuf->r.wpos;
101eda6f593SDavid van Moolenbroek 
102eda6f593SDavid van Moolenbroek 	if (IMSG_HEADER_SIZE > av)
103eda6f593SDavid van Moolenbroek 		return (0);
104eda6f593SDavid van Moolenbroek 
105eda6f593SDavid van Moolenbroek 	memcpy(&imsg->hdr, ibuf->r.buf, sizeof(imsg->hdr));
106eda6f593SDavid van Moolenbroek 	if (imsg->hdr.len < IMSG_HEADER_SIZE ||
107eda6f593SDavid van Moolenbroek 	    imsg->hdr.len > MAX_IMSGSIZE) {
108eda6f593SDavid van Moolenbroek 		errno = ERANGE;
109eda6f593SDavid van Moolenbroek 		return (-1);
110eda6f593SDavid van Moolenbroek 	}
111eda6f593SDavid van Moolenbroek 	if (imsg->hdr.len > av)
112eda6f593SDavid van Moolenbroek 		return (0);
113eda6f593SDavid van Moolenbroek 	datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
114eda6f593SDavid van Moolenbroek 	ibuf->r.rptr = ibuf->r.buf + IMSG_HEADER_SIZE;
115eda6f593SDavid van Moolenbroek 	if ((imsg->data = malloc(datalen)) == NULL && datalen != 0)
116eda6f593SDavid van Moolenbroek 		return (-1);
117eda6f593SDavid van Moolenbroek 
118eda6f593SDavid van Moolenbroek 	if (imsg->hdr.flags & IMSGF_HASFD)
119eda6f593SDavid van Moolenbroek 		imsg->fd = imsg_get_fd(ibuf);
120eda6f593SDavid van Moolenbroek 	else
121eda6f593SDavid van Moolenbroek 		imsg->fd = -1;
122eda6f593SDavid van Moolenbroek 
123eda6f593SDavid van Moolenbroek 	memcpy(imsg->data, ibuf->r.rptr, datalen);
124eda6f593SDavid van Moolenbroek 
125eda6f593SDavid van Moolenbroek 	if (imsg->hdr.len < av) {
126eda6f593SDavid van Moolenbroek 		left = av - imsg->hdr.len;
127eda6f593SDavid van Moolenbroek 		memmove(&ibuf->r.buf, ibuf->r.buf + imsg->hdr.len, left);
128eda6f593SDavid van Moolenbroek 		ibuf->r.wpos = left;
129eda6f593SDavid van Moolenbroek 	} else
130eda6f593SDavid van Moolenbroek 		ibuf->r.wpos = 0;
131eda6f593SDavid van Moolenbroek 
132eda6f593SDavid van Moolenbroek 	return (datalen + IMSG_HEADER_SIZE);
133eda6f593SDavid van Moolenbroek }
134eda6f593SDavid van Moolenbroek 
135eda6f593SDavid van Moolenbroek int
imsg_compose(struct imsgbuf * ibuf,u_int32_t type,u_int32_t peerid,pid_t pid,int fd,void * data,u_int16_t datalen)136eda6f593SDavid van Moolenbroek imsg_compose(struct imsgbuf *ibuf, u_int32_t type, u_int32_t peerid,
137eda6f593SDavid van Moolenbroek     pid_t pid, int fd, void *data, u_int16_t datalen)
138eda6f593SDavid van Moolenbroek {
139eda6f593SDavid van Moolenbroek 	struct ibuf	*wbuf;
140eda6f593SDavid van Moolenbroek 
141eda6f593SDavid van Moolenbroek 	if ((wbuf = imsg_create(ibuf, type, peerid, pid, datalen)) == NULL)
142eda6f593SDavid van Moolenbroek 		return (-1);
143eda6f593SDavid van Moolenbroek 
144eda6f593SDavid van Moolenbroek 	if (imsg_add(wbuf, data, datalen) == -1)
145eda6f593SDavid van Moolenbroek 		return (-1);
146eda6f593SDavid van Moolenbroek 
147eda6f593SDavid van Moolenbroek 	wbuf->fd = fd;
148eda6f593SDavid van Moolenbroek 
149eda6f593SDavid van Moolenbroek 	imsg_close(ibuf, wbuf);
150eda6f593SDavid van Moolenbroek 
151eda6f593SDavid van Moolenbroek 	return (1);
152eda6f593SDavid van Moolenbroek }
153eda6f593SDavid van Moolenbroek 
154eda6f593SDavid van Moolenbroek int
imsg_composev(struct imsgbuf * ibuf,u_int32_t type,u_int32_t peerid,pid_t pid,int fd,const struct iovec * iov,int iovcnt)155eda6f593SDavid van Moolenbroek imsg_composev(struct imsgbuf *ibuf, u_int32_t type, u_int32_t peerid,
156eda6f593SDavid van Moolenbroek     pid_t pid, int fd, const struct iovec *iov, int iovcnt)
157eda6f593SDavid van Moolenbroek {
158eda6f593SDavid van Moolenbroek 	struct ibuf	*wbuf;
159eda6f593SDavid van Moolenbroek 	int		 i, datalen = 0;
160eda6f593SDavid van Moolenbroek 
161eda6f593SDavid van Moolenbroek 	for (i = 0; i < iovcnt; i++)
162eda6f593SDavid van Moolenbroek 		datalen += iov[i].iov_len;
163eda6f593SDavid van Moolenbroek 
164eda6f593SDavid van Moolenbroek 	if ((wbuf = imsg_create(ibuf, type, peerid, pid, datalen)) == NULL)
165eda6f593SDavid van Moolenbroek 		return (-1);
166eda6f593SDavid van Moolenbroek 
167eda6f593SDavid van Moolenbroek 	for (i = 0; i < iovcnt; i++)
168eda6f593SDavid van Moolenbroek 		if (imsg_add(wbuf, iov[i].iov_base, iov[i].iov_len) == -1)
169eda6f593SDavid van Moolenbroek 			return (-1);
170eda6f593SDavid van Moolenbroek 
171eda6f593SDavid van Moolenbroek 	wbuf->fd = fd;
172eda6f593SDavid van Moolenbroek 
173eda6f593SDavid van Moolenbroek 	imsg_close(ibuf, wbuf);
174eda6f593SDavid van Moolenbroek 
175eda6f593SDavid van Moolenbroek 	return (1);
176eda6f593SDavid van Moolenbroek }
177eda6f593SDavid van Moolenbroek 
178eda6f593SDavid van Moolenbroek /* ARGSUSED */
179eda6f593SDavid van Moolenbroek struct ibuf *
imsg_create(struct imsgbuf * ibuf,u_int32_t type,u_int32_t peerid,pid_t pid,u_int16_t datalen)180eda6f593SDavid van Moolenbroek imsg_create(struct imsgbuf *ibuf, u_int32_t type, u_int32_t peerid,
181eda6f593SDavid van Moolenbroek     pid_t pid, u_int16_t datalen)
182eda6f593SDavid van Moolenbroek {
183eda6f593SDavid van Moolenbroek 	struct ibuf	*wbuf;
184eda6f593SDavid van Moolenbroek 	struct imsg_hdr	 hdr;
185eda6f593SDavid van Moolenbroek 
186eda6f593SDavid van Moolenbroek 	datalen += IMSG_HEADER_SIZE;
187eda6f593SDavid van Moolenbroek 	if (datalen > MAX_IMSGSIZE) {
188eda6f593SDavid van Moolenbroek 		errno = ERANGE;
189eda6f593SDavid van Moolenbroek 		return (NULL);
190eda6f593SDavid van Moolenbroek 	}
191eda6f593SDavid van Moolenbroek 
192eda6f593SDavid van Moolenbroek 	hdr.type = type;
193eda6f593SDavid van Moolenbroek 	hdr.flags = 0;
194eda6f593SDavid van Moolenbroek 	hdr.peerid = peerid;
195eda6f593SDavid van Moolenbroek 	if ((hdr.pid = pid) == 0)
196eda6f593SDavid van Moolenbroek 		hdr.pid = ibuf->pid;
197eda6f593SDavid van Moolenbroek 	if ((wbuf = ibuf_dynamic(datalen, MAX_IMSGSIZE)) == NULL) {
198eda6f593SDavid van Moolenbroek 		return (NULL);
199eda6f593SDavid van Moolenbroek 	}
200eda6f593SDavid van Moolenbroek 	if (imsg_add(wbuf, &hdr, sizeof(hdr)) == -1)
201eda6f593SDavid van Moolenbroek 		return (NULL);
202eda6f593SDavid van Moolenbroek 
203eda6f593SDavid van Moolenbroek 	return (wbuf);
204eda6f593SDavid van Moolenbroek }
205eda6f593SDavid van Moolenbroek 
206eda6f593SDavid van Moolenbroek int
imsg_add(struct ibuf * msg,void * data,u_int16_t datalen)207eda6f593SDavid van Moolenbroek imsg_add(struct ibuf *msg, void *data, u_int16_t datalen)
208eda6f593SDavid van Moolenbroek {
209eda6f593SDavid van Moolenbroek 	if (datalen)
210eda6f593SDavid van Moolenbroek 		if (ibuf_add(msg, data, datalen) == -1) {
211eda6f593SDavid van Moolenbroek 			ibuf_free(msg);
212eda6f593SDavid van Moolenbroek 			return (-1);
213eda6f593SDavid van Moolenbroek 		}
214eda6f593SDavid van Moolenbroek 	return (datalen);
215eda6f593SDavid van Moolenbroek }
216eda6f593SDavid van Moolenbroek 
217eda6f593SDavid van Moolenbroek void
imsg_close(struct imsgbuf * ibuf,struct ibuf * msg)218eda6f593SDavid van Moolenbroek imsg_close(struct imsgbuf *ibuf, struct ibuf *msg)
219eda6f593SDavid van Moolenbroek {
220eda6f593SDavid van Moolenbroek 	struct imsg_hdr	*hdr;
221eda6f593SDavid van Moolenbroek 
222eda6f593SDavid van Moolenbroek 	hdr = (struct imsg_hdr *)msg->buf;
223eda6f593SDavid van Moolenbroek 
224eda6f593SDavid van Moolenbroek 	hdr->flags &= ~IMSGF_HASFD;
225eda6f593SDavid van Moolenbroek 	if (msg->fd != -1)
226eda6f593SDavid van Moolenbroek 		hdr->flags |= IMSGF_HASFD;
227eda6f593SDavid van Moolenbroek 
228eda6f593SDavid van Moolenbroek 	hdr->len = (u_int16_t)msg->wpos;
229eda6f593SDavid van Moolenbroek 
230eda6f593SDavid van Moolenbroek 	ibuf_close(&ibuf->w, msg);
231eda6f593SDavid van Moolenbroek }
232eda6f593SDavid van Moolenbroek 
233eda6f593SDavid van Moolenbroek void
imsg_free(struct imsg * imsg)234eda6f593SDavid van Moolenbroek imsg_free(struct imsg *imsg)
235eda6f593SDavid van Moolenbroek {
236eda6f593SDavid van Moolenbroek 	free(imsg->data);
237eda6f593SDavid van Moolenbroek }
238eda6f593SDavid van Moolenbroek 
239eda6f593SDavid van Moolenbroek int
imsg_get_fd(struct imsgbuf * ibuf)240eda6f593SDavid van Moolenbroek imsg_get_fd(struct imsgbuf *ibuf)
241eda6f593SDavid van Moolenbroek {
242eda6f593SDavid van Moolenbroek 	int		 fd;
243eda6f593SDavid van Moolenbroek 	struct imsg_fd	*ifd;
244eda6f593SDavid van Moolenbroek 
245eda6f593SDavid van Moolenbroek 	if ((ifd = TAILQ_FIRST(&ibuf->fds)) == NULL)
246eda6f593SDavid van Moolenbroek 		return (-1);
247eda6f593SDavid van Moolenbroek 
248eda6f593SDavid van Moolenbroek 	fd = ifd->fd;
249eda6f593SDavid van Moolenbroek 	TAILQ_REMOVE(&ibuf->fds, ifd, entry);
250eda6f593SDavid van Moolenbroek 	free(ifd);
251eda6f593SDavid van Moolenbroek 
252eda6f593SDavid van Moolenbroek 	return (fd);
253eda6f593SDavid van Moolenbroek }
254eda6f593SDavid van Moolenbroek 
255eda6f593SDavid van Moolenbroek int
imsg_flush(struct imsgbuf * ibuf)256eda6f593SDavid van Moolenbroek imsg_flush(struct imsgbuf *ibuf)
257eda6f593SDavid van Moolenbroek {
258eda6f593SDavid van Moolenbroek 	while (ibuf->w.queued)
259eda6f593SDavid van Moolenbroek 		if (msgbuf_write(&ibuf->w) < 0)
260eda6f593SDavid van Moolenbroek 			return (-1);
261eda6f593SDavid van Moolenbroek 	return (0);
262eda6f593SDavid van Moolenbroek }
263eda6f593SDavid van Moolenbroek 
264eda6f593SDavid van Moolenbroek void
imsg_clear(struct imsgbuf * ibuf)265eda6f593SDavid van Moolenbroek imsg_clear(struct imsgbuf *ibuf)
266eda6f593SDavid van Moolenbroek {
267eda6f593SDavid van Moolenbroek 	int	fd;
268eda6f593SDavid van Moolenbroek 
269eda6f593SDavid van Moolenbroek 	msgbuf_clear(&ibuf->w);
270eda6f593SDavid van Moolenbroek 	while ((fd = imsg_get_fd(ibuf)) != -1)
271eda6f593SDavid van Moolenbroek 		close(fd);
272eda6f593SDavid van Moolenbroek }
273