1 c9c44c65 2023-07-02 op /* $OpenBSD: imsg-buffer.c,v 1.16 2023/06/19 17:19:50 claudio Exp $ */
4 6b191ed5 2021-02-23 op * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
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.
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.
19 6b191ed5 2021-02-23 op #include "../config.h"
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>
25 6b191ed5 2021-02-23 op #include <limits.h>
26 6b191ed5 2021-02-23 op #include <errno.h>
27 6b191ed5 2021-02-23 op #include <stdlib.h>
28 6b191ed5 2021-02-23 op #include <string.h>
29 6b191ed5 2021-02-23 op #include <unistd.h>
31 6b191ed5 2021-02-23 op #include "imsg.h"
33 6b191ed5 2021-02-23 op static int ibuf_realloc(struct ibuf *, size_t);
34 6b191ed5 2021-02-23 op static void ibuf_enqueue(struct msgbuf *, struct ibuf *);
35 6b191ed5 2021-02-23 op static void ibuf_dequeue(struct msgbuf *, struct ibuf *);
36 c9c44c65 2023-07-02 op static void msgbuf_drain(struct msgbuf *, size_t);
39 6b191ed5 2021-02-23 op ibuf_open(size_t len)
41 6b191ed5 2021-02-23 op struct ibuf *buf;
43 c9c44c65 2023-07-02 op if (len == 0) {
44 c9c44c65 2023-07-02 op errno = EINVAL;
45 c9c44c65 2023-07-02 op return (NULL);
47 6b191ed5 2021-02-23 op if ((buf = calloc(1, sizeof(struct ibuf))) == NULL)
48 6b191ed5 2021-02-23 op return (NULL);
49 c9c44c65 2023-07-02 op if ((buf->buf = calloc(len, 1)) == NULL) {
51 6b191ed5 2021-02-23 op return (NULL);
53 6b191ed5 2021-02-23 op buf->size = buf->max = len;
60 6b191ed5 2021-02-23 op ibuf_dynamic(size_t len, size_t max)
62 6b191ed5 2021-02-23 op struct ibuf *buf;
64 c9c44c65 2023-07-02 op if (max < len) {
65 c9c44c65 2023-07-02 op errno = EINVAL;
66 6b191ed5 2021-02-23 op return (NULL);
69 c9c44c65 2023-07-02 op if ((buf = calloc(1, sizeof(struct ibuf))) == NULL)
70 6b191ed5 2021-02-23 op return (NULL);
71 c9c44c65 2023-07-02 op if (len > 0) {
72 c9c44c65 2023-07-02 op if ((buf->buf = calloc(len, 1)) == NULL) {
74 c9c44c65 2023-07-02 op return (NULL);
77 c9c44c65 2023-07-02 op buf->size = len;
78 c9c44c65 2023-07-02 op buf->max = max;
85 6b191ed5 2021-02-23 op ibuf_realloc(struct ibuf *buf, size_t len)
87 6b191ed5 2021-02-23 op unsigned char *b;
89 6b191ed5 2021-02-23 op /* on static buffers max is eq size and so the following fails */
90 c9c44c65 2023-07-02 op if (len > SIZE_MAX - buf->wpos || buf->wpos + len > buf->max) {
91 6b191ed5 2021-02-23 op errno = ERANGE;
95 6b191ed5 2021-02-23 op b = recallocarray(buf->buf, buf->size, buf->wpos + len, 1);
96 6b191ed5 2021-02-23 op if (b == NULL)
99 6b191ed5 2021-02-23 op buf->size = buf->wpos + len;
105 6b191ed5 2021-02-23 op ibuf_reserve(struct ibuf *buf, size_t len)
109 c9c44c65 2023-07-02 op if (len > SIZE_MAX - buf->wpos) {
110 c9c44c65 2023-07-02 op errno = ERANGE;
111 c9c44c65 2023-07-02 op return (NULL);
114 6b191ed5 2021-02-23 op if (buf->wpos + len > buf->size)
115 6b191ed5 2021-02-23 op if (ibuf_realloc(buf, len) == -1)
116 6b191ed5 2021-02-23 op return (NULL);
118 6b191ed5 2021-02-23 op b = buf->buf + buf->wpos;
119 6b191ed5 2021-02-23 op buf->wpos += len;
120 c9c44c65 2023-07-02 op memset(b, 0, len);
125 c9c44c65 2023-07-02 op ibuf_add(struct ibuf *buf, const void *data, size_t len)
129 c9c44c65 2023-07-02 op if ((b = ibuf_reserve(buf, len)) == NULL)
132 c9c44c65 2023-07-02 op memcpy(b, data, len);
137 c9c44c65 2023-07-02 op ibuf_add_buf(struct ibuf *buf, const struct ibuf *from)
139 c9c44c65 2023-07-02 op return ibuf_add(buf, from->buf, from->wpos);
143 c9c44c65 2023-07-02 op ibuf_add_n8(struct ibuf *buf, uint64_t value)
147 c9c44c65 2023-07-02 op if (value > UINT8_MAX) {
148 c9c44c65 2023-07-02 op errno = EINVAL;
152 c9c44c65 2023-07-02 op return ibuf_add(buf, &v, sizeof(v));
156 c9c44c65 2023-07-02 op ibuf_add_n16(struct ibuf *buf, uint64_t value)
160 c9c44c65 2023-07-02 op if (value > UINT16_MAX) {
161 c9c44c65 2023-07-02 op errno = EINVAL;
164 c9c44c65 2023-07-02 op v = htobe16(value);
165 c9c44c65 2023-07-02 op return ibuf_add(buf, &v, sizeof(v));
169 c9c44c65 2023-07-02 op ibuf_add_n32(struct ibuf *buf, uint64_t value)
173 c9c44c65 2023-07-02 op if (value > UINT32_MAX) {
174 c9c44c65 2023-07-02 op errno = EINVAL;
177 c9c44c65 2023-07-02 op v = htobe32(value);
178 c9c44c65 2023-07-02 op return ibuf_add(buf, &v, sizeof(v));
182 c9c44c65 2023-07-02 op ibuf_add_n64(struct ibuf *buf, uint64_t value)
184 c9c44c65 2023-07-02 op value = htobe64(value);
185 c9c44c65 2023-07-02 op return ibuf_add(buf, &value, sizeof(value));
189 c9c44c65 2023-07-02 op ibuf_add_zero(struct ibuf *buf, size_t len)
193 c9c44c65 2023-07-02 op if ((b = ibuf_reserve(buf, len)) == NULL)
199 6b191ed5 2021-02-23 op ibuf_seek(struct ibuf *buf, size_t pos, size_t len)
201 6b191ed5 2021-02-23 op /* only allowed to seek in already written parts */
202 c9c44c65 2023-07-02 op if (len > SIZE_MAX - pos || pos + len > buf->wpos) {
203 c9c44c65 2023-07-02 op errno = ERANGE;
204 6b191ed5 2021-02-23 op return (NULL);
207 6b191ed5 2021-02-23 op return (buf->buf + pos);
211 c9c44c65 2023-07-02 op ibuf_set(struct ibuf *buf, size_t pos, const void *data, size_t len)
215 c9c44c65 2023-07-02 op if ((b = ibuf_seek(buf, pos, len)) == NULL)
218 c9c44c65 2023-07-02 op memcpy(b, data, len);
223 c9c44c65 2023-07-02 op ibuf_set_n8(struct ibuf *buf, size_t pos, uint64_t value)
227 c9c44c65 2023-07-02 op if (value > UINT8_MAX) {
228 c9c44c65 2023-07-02 op errno = EINVAL;
232 c9c44c65 2023-07-02 op return (ibuf_set(buf, pos, &v, sizeof(v)));
236 c9c44c65 2023-07-02 op ibuf_set_n16(struct ibuf *buf, size_t pos, uint64_t value)
240 c9c44c65 2023-07-02 op if (value > UINT16_MAX) {
241 c9c44c65 2023-07-02 op errno = EINVAL;
244 c9c44c65 2023-07-02 op v = htobe16(value);
245 c9c44c65 2023-07-02 op return (ibuf_set(buf, pos, &v, sizeof(v)));
249 c9c44c65 2023-07-02 op ibuf_set_n32(struct ibuf *buf, size_t pos, uint64_t value)
253 c9c44c65 2023-07-02 op if (value > UINT32_MAX) {
254 c9c44c65 2023-07-02 op errno = EINVAL;
257 c9c44c65 2023-07-02 op v = htobe32(value);
258 c9c44c65 2023-07-02 op return (ibuf_set(buf, pos, &v, sizeof(v)));
262 c9c44c65 2023-07-02 op ibuf_set_n64(struct ibuf *buf, size_t pos, uint64_t value)
264 c9c44c65 2023-07-02 op value = htobe64(value);
265 c9c44c65 2023-07-02 op return (ibuf_set(buf, pos, &value, sizeof(value)));
269 c9c44c65 2023-07-02 op ibuf_data(struct ibuf *buf)
271 c9c44c65 2023-07-02 op return (buf->buf);
275 6b191ed5 2021-02-23 op ibuf_size(struct ibuf *buf)
277 6b191ed5 2021-02-23 op return (buf->wpos);
281 6b191ed5 2021-02-23 op ibuf_left(struct ibuf *buf)
283 6b191ed5 2021-02-23 op return (buf->max - buf->wpos);
287 6b191ed5 2021-02-23 op ibuf_close(struct msgbuf *msgbuf, struct ibuf *buf)
289 6b191ed5 2021-02-23 op ibuf_enqueue(msgbuf, buf);
293 c9c44c65 2023-07-02 op ibuf_free(struct ibuf *buf)
295 c9c44c65 2023-07-02 op if (buf == NULL)
297 c9c44c65 2023-07-02 op #ifdef NOTYET
298 c9c44c65 2023-07-02 op if (buf->fd != -1)
299 c9c44c65 2023-07-02 op close(buf->fd);
301 c9c44c65 2023-07-02 op freezero(buf->buf, buf->size);
306 c9c44c65 2023-07-02 op ibuf_fd_avail(struct ibuf *buf)
308 c9c44c65 2023-07-02 op return (buf->fd != -1);
312 c9c44c65 2023-07-02 op ibuf_fd_get(struct ibuf *buf)
316 c9c44c65 2023-07-02 op fd = buf->fd;
317 c9c44c65 2023-07-02 op #ifdef NOTYET
318 c9c44c65 2023-07-02 op buf->fd = -1;
324 c9c44c65 2023-07-02 op ibuf_fd_set(struct ibuf *buf, int fd)
326 c9c44c65 2023-07-02 op if (buf->fd != -1)
327 c9c44c65 2023-07-02 op close(buf->fd);
328 c9c44c65 2023-07-02 op buf->fd = fd;
332 6b191ed5 2021-02-23 op ibuf_write(struct msgbuf *msgbuf)
334 6b191ed5 2021-02-23 op struct iovec iov[IOV_MAX];
335 6b191ed5 2021-02-23 op struct ibuf *buf;
336 6b191ed5 2021-02-23 op unsigned int i = 0;
339 6b191ed5 2021-02-23 op memset(&iov, 0, sizeof(iov));
340 6b191ed5 2021-02-23 op TAILQ_FOREACH(buf, &msgbuf->bufs, entry) {
341 6b191ed5 2021-02-23 op if (i >= IOV_MAX)
343 6b191ed5 2021-02-23 op iov[i].iov_base = buf->buf + buf->rpos;
344 6b191ed5 2021-02-23 op iov[i].iov_len = buf->wpos - buf->rpos;
349 6b191ed5 2021-02-23 op if ((n = writev(msgbuf->fd, iov, i)) == -1) {
350 6b191ed5 2021-02-23 op if (errno == EINTR)
352 6b191ed5 2021-02-23 op if (errno == ENOBUFS)
353 6b191ed5 2021-02-23 op errno = EAGAIN;
357 6b191ed5 2021-02-23 op if (n == 0) { /* connection closed */
362 6b191ed5 2021-02-23 op msgbuf_drain(msgbuf, n);
368 6b191ed5 2021-02-23 op msgbuf_init(struct msgbuf *msgbuf)
370 6b191ed5 2021-02-23 op msgbuf->queued = 0;
371 6b191ed5 2021-02-23 op msgbuf->fd = -1;
372 6b191ed5 2021-02-23 op TAILQ_INIT(&msgbuf->bufs);
376 6b191ed5 2021-02-23 op msgbuf_drain(struct msgbuf *msgbuf, size_t n)
378 6b191ed5 2021-02-23 op struct ibuf *buf, *next;
380 6b191ed5 2021-02-23 op for (buf = TAILQ_FIRST(&msgbuf->bufs); buf != NULL && n > 0;
381 6b191ed5 2021-02-23 op buf = next) {
382 6b191ed5 2021-02-23 op next = TAILQ_NEXT(buf, entry);
383 c9c44c65 2023-07-02 op if (n >= buf->wpos - buf->rpos) {
384 6b191ed5 2021-02-23 op n -= buf->wpos - buf->rpos;
385 6b191ed5 2021-02-23 op ibuf_dequeue(msgbuf, buf);
387 6b191ed5 2021-02-23 op buf->rpos += n;
394 6b191ed5 2021-02-23 op msgbuf_clear(struct msgbuf *msgbuf)
396 6b191ed5 2021-02-23 op struct ibuf *buf;
398 6b191ed5 2021-02-23 op while ((buf = TAILQ_FIRST(&msgbuf->bufs)) != NULL)
399 6b191ed5 2021-02-23 op ibuf_dequeue(msgbuf, buf);
403 6b191ed5 2021-02-23 op msgbuf_write(struct msgbuf *msgbuf)
405 6b191ed5 2021-02-23 op struct iovec iov[IOV_MAX];
406 894e9984 2022-03-19 op struct ibuf *buf, *buf0 = NULL;
407 6b191ed5 2021-02-23 op unsigned int i = 0;
409 6b191ed5 2021-02-23 op struct msghdr msg;
410 6b191ed5 2021-02-23 op struct cmsghdr *cmsg;
412 6b191ed5 2021-02-23 op struct cmsghdr hdr;
413 6b191ed5 2021-02-23 op char buf[CMSG_SPACE(sizeof(int))];
416 6b191ed5 2021-02-23 op memset(&iov, 0, sizeof(iov));
417 6b191ed5 2021-02-23 op memset(&msg, 0, sizeof(msg));
418 6b191ed5 2021-02-23 op memset(&cmsgbuf, 0, sizeof(cmsgbuf));
419 6b191ed5 2021-02-23 op TAILQ_FOREACH(buf, &msgbuf->bufs, entry) {
420 6b191ed5 2021-02-23 op if (i >= IOV_MAX)
422 894e9984 2022-03-19 op if (i > 0 && buf->fd != -1)
424 6b191ed5 2021-02-23 op iov[i].iov_base = buf->buf + buf->rpos;
425 6b191ed5 2021-02-23 op iov[i].iov_len = buf->wpos - buf->rpos;
427 6b191ed5 2021-02-23 op if (buf->fd != -1)
431 6b191ed5 2021-02-23 op msg.msg_iov = iov;
432 6b191ed5 2021-02-23 op msg.msg_iovlen = i;
434 894e9984 2022-03-19 op if (buf0 != NULL) {
435 6b191ed5 2021-02-23 op msg.msg_control = (caddr_t)&cmsgbuf.buf;
436 6b191ed5 2021-02-23 op msg.msg_controllen = sizeof(cmsgbuf.buf);
437 6b191ed5 2021-02-23 op cmsg = CMSG_FIRSTHDR(&msg);
438 6b191ed5 2021-02-23 op cmsg->cmsg_len = CMSG_LEN(sizeof(int));
439 6b191ed5 2021-02-23 op cmsg->cmsg_level = SOL_SOCKET;
440 6b191ed5 2021-02-23 op cmsg->cmsg_type = SCM_RIGHTS;
441 894e9984 2022-03-19 op *(int *)CMSG_DATA(cmsg) = buf0->fd;
445 6b191ed5 2021-02-23 op if ((n = sendmsg(msgbuf->fd, &msg, 0)) == -1) {
446 6b191ed5 2021-02-23 op if (errno == EINTR)
448 6b191ed5 2021-02-23 op if (errno == ENOBUFS)
449 6b191ed5 2021-02-23 op errno = EAGAIN;
453 6b191ed5 2021-02-23 op if (n == 0) { /* connection closed */
459 6b191ed5 2021-02-23 op * assumption: fd got sent if sendmsg sent anything
460 6b191ed5 2021-02-23 op * this works because fds are passed one at a time
462 894e9984 2022-03-19 op if (buf0 != NULL) {
463 894e9984 2022-03-19 op close(buf0->fd);
464 894e9984 2022-03-19 op buf0->fd = -1;
467 6b191ed5 2021-02-23 op msgbuf_drain(msgbuf, n);
473 6b191ed5 2021-02-23 op ibuf_enqueue(struct msgbuf *msgbuf, struct ibuf *buf)
475 6b191ed5 2021-02-23 op TAILQ_INSERT_TAIL(&msgbuf->bufs, buf, entry);
476 6b191ed5 2021-02-23 op msgbuf->queued++;
480 6b191ed5 2021-02-23 op ibuf_dequeue(struct msgbuf *msgbuf, struct ibuf *buf)
482 6b191ed5 2021-02-23 op TAILQ_REMOVE(&msgbuf->bufs, buf, entry);
484 c9c44c65 2023-07-02 op if (buf->fd != -1) {
485 6b191ed5 2021-02-23 op close(buf->fd);
486 c9c44c65 2023-07-02 op buf->fd = -1;
489 6b191ed5 2021-02-23 op msgbuf->queued--;
490 6b191ed5 2021-02-23 op ibuf_free(buf);