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