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