circlecloud/tmux
1
0
Fork 0
mirror of https://github.com/tmux/tmux.git synced 2025-11-04 00:56:10 +00:00
Code Issues Projects Releases Wiki Activity

Bring in updated imsg.

Browse Source
This commit is contained in:
Nicholas Marriott
2024-11-22 08:03:55 +00:00
parent b82c7b40b0
commit 990c724bd8
3 changed files with 520 additions and 344 deletions
Download Patch File Download Diff File Expand all files Collapse all files

537
compat/imsg-buffer.c
View File

@@ -1,4 +1,4 @@
/* $OpenBSD: imsg-buffer.c,v 1.18 2023/12/12 15:47:41 claudio Exp $ */ /* $OpenBSD: imsg-buffer.c,v 1.30 2024/11/22 07:20:50 tb Exp $ */
/* /*
* Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org> * Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org>
@@ -20,10 +20,10 @@
#include <sys/types.h> #include <sys/types.h>
#include <sys/socket.h> #include <sys/socket.h>
#include <sys/uio.h> #include <sys/uio.h>
#include <arpa/inet.h>
#include <limits.h> #include <limits.h>
#include <errno.h> #include <errno.h>
#include <endian.h>
#include <stdint.h> #include <stdint.h>
#include <stdlib.h> #include <stdlib.h>
#include <string.h> #include <string.h>
@@ -45,25 +45,37 @@
#undef be64toh #undef be64toh
#define be64toh ntohll #define be64toh ntohll
static int ibuf_realloc(struct ibuf *, size_t); struct msgbuf {
static void ibuf_enqueue(struct msgbuf *, struct ibuf *); TAILQ_HEAD(, ibuf) bufs;
static void ibuf_dequeue(struct msgbuf *, struct ibuf *); TAILQ_HEAD(, ibuf) rbufs;
uint32_t queued;
char *rbuf;
struct ibuf *rpmsg;
ssize_t (*readhdr)(struct ibuf *, void *);
void *rarg;
size_t roff;
size_t hdrsize;
};
static void msgbuf_read_enqueue(struct msgbuf *, struct ibuf *);
static void msgbuf_enqueue(struct msgbuf *, struct ibuf *);
static void msgbuf_dequeue(struct msgbuf *, struct ibuf *);
static void msgbuf_drain(struct msgbuf *, size_t); static void msgbuf_drain(struct msgbuf *, size_t);
#define IBUF_FD_MARK_ON_STACK -2
struct ibuf * struct ibuf *
ibuf_open(size_t len) ibuf_open(size_t len)
{ {
struct ibuf *buf; struct ibuf *buf;
if (len == 0) {
errno = EINVAL;
return (NULL);
}
if ((buf = calloc(1, sizeof(struct ibuf))) == NULL) if ((buf = calloc(1, sizeof(struct ibuf))) == NULL)
return (NULL); return (NULL);
if ((buf->buf = calloc(len, 1)) == NULL) { if (len > 0) {
free(buf); if ((buf->buf = calloc(len, 1)) == NULL) {
return (NULL); free(buf);
return (NULL);
}
} }
buf->size = buf->max = len; buf->size = buf->max = len;
buf->fd = -1; buf->fd = -1;
@@ -96,39 +108,36 @@ ibuf_dynamic(size_t len, size_t max)
return (buf); return (buf);
} }
static int
ibuf_realloc(struct ibuf *buf, size_t len)
{
unsigned char *b;
/* on static buffers max is eq size and so the following fails */
if (len > SIZE_MAX - buf->wpos || buf->wpos + len > buf->max) {
errno = ERANGE;
return (-1);
}
b = recallocarray(buf->buf, buf->size, buf->wpos + len, 1);
if (b == NULL)
return (-1);
buf->buf = b;
buf->size = buf->wpos + len;
return (0);
}
void * void *
ibuf_reserve(struct ibuf *buf, size_t len) ibuf_reserve(struct ibuf *buf, size_t len)
{ {
void *b; void *b;
if (len > SIZE_MAX - buf->wpos || buf->max == 0) { if (len > SIZE_MAX - buf->wpos) {
errno = ERANGE; errno = ERANGE;
return (NULL); return (NULL);
} }
if (buf->fd == IBUF_FD_MARK_ON_STACK) {
/* can not grow stack buffers */
errno = EINVAL;
return (NULL);
}
if (buf->wpos + len > buf->size) if (buf->wpos + len > buf->size) {
if (ibuf_realloc(buf, len) == -1) unsigned char *nb;
/* check if buffer is allowed to grow */
if (buf->wpos + len > buf->max) {
errno = ERANGE;
return (NULL); return (NULL);
}
nb = realloc(buf->buf, buf->wpos + len);
if (nb == NULL)
return (NULL);
memset(nb + buf->size, 0, buf->wpos + len - buf->size);
buf->buf = nb;
buf->size = buf->wpos + len;
}
b = buf->buf + buf->wpos; b = buf->buf + buf->wpos;
buf->wpos += len; buf->wpos += len;
@@ -153,13 +162,6 @@ ibuf_add_ibuf(struct ibuf *buf, const struct ibuf *from)
return ibuf_add(buf, ibuf_data(from), ibuf_size(from)); return ibuf_add(buf, ibuf_data(from), ibuf_size(from));
} }
/* remove after tree is converted */
int
ibuf_add_buf(struct ibuf *buf, const struct ibuf *from)
{
return ibuf_add_ibuf(buf, from);
}
int int
ibuf_add_n8(struct ibuf *buf, uint64_t value) ibuf_add_n8(struct ibuf *buf, uint64_t value)
{ {
@@ -367,7 +369,8 @@ ibuf_size(const struct ibuf *buf)
size_t size_t
ibuf_left(const struct ibuf *buf) ibuf_left(const struct ibuf *buf)
{ {
if (buf->max == 0) /* on stack buffers have no space left */
if (buf->fd == IBUF_FD_MARK_ON_STACK)
return (0); return (0);
return (buf->max - buf->wpos); return (buf->max - buf->wpos);
} }
@@ -379,8 +382,8 @@ ibuf_truncate(struct ibuf *buf, size_t len)
buf->wpos = buf->rpos + len; buf->wpos = buf->rpos + len;
return (0); return (0);
} }
if (buf->max == 0) { if (buf->fd == IBUF_FD_MARK_ON_STACK) {
/* only allow to truncate down */ /* only allow to truncate down for stack buffers */
errno = ERANGE; errno = ERANGE;
return (-1); return (-1);
} }
@@ -396,7 +399,7 @@ ibuf_rewind(struct ibuf *buf)
void void
ibuf_close(struct msgbuf *msgbuf, struct ibuf *buf) ibuf_close(struct msgbuf *msgbuf, struct ibuf *buf)
{ {
ibuf_enqueue(msgbuf, buf); msgbuf_enqueue(msgbuf, buf);
} }
void void
@@ -405,7 +408,7 @@ ibuf_from_buffer(struct ibuf *buf, void *data, size_t len)
memset(buf, 0, sizeof(*buf)); memset(buf, 0, sizeof(*buf));
buf->buf = data; buf->buf = data;
buf->size = buf->wpos = len; buf->size = buf->wpos = len;
buf->fd = -1; buf->fd = IBUF_FD_MARK_ON_STACK;
} }
void void
@@ -440,6 +443,24 @@ ibuf_get_ibuf(struct ibuf *buf, size_t len, struct ibuf *new)
return (0); return (0);
} }
int
ibuf_get_h16(struct ibuf *buf, uint16_t *value)
{
return ibuf_get(buf, value, sizeof(*value));
}
int
ibuf_get_h32(struct ibuf *buf, uint32_t *value)
{
return ibuf_get(buf, value, sizeof(*value));
}
int
ibuf_get_h64(struct ibuf *buf, uint64_t *value)
{
return ibuf_get(buf, value, sizeof(*value));
}
int int
ibuf_get_n8(struct ibuf *buf, uint8_t *value) ibuf_get_n8(struct ibuf *buf, uint8_t *value)
{ {
@@ -476,22 +497,21 @@ ibuf_get_n64(struct ibuf *buf, uint64_t *value)
return (rv); return (rv);
} }
int char *
ibuf_get_h16(struct ibuf *buf, uint16_t *value) ibuf_get_string(struct ibuf *buf, size_t len)
{ {
return ibuf_get(buf, value, sizeof(*value)); char *str;
}
int if (ibuf_size(buf) < len) {
ibuf_get_h32(struct ibuf *buf, uint32_t *value) errno = EBADMSG;
{ return (NULL);
return ibuf_get(buf, value, sizeof(*value)); }
}
int str = strndup(ibuf_data(buf), len);
ibuf_get_h64(struct ibuf *buf, uint64_t *value) if (str == NULL)
{ return (NULL);
return ibuf_get(buf, value, sizeof(*value)); buf->rpos += len;
return (str);
} }
int int
@@ -511,9 +531,10 @@ ibuf_free(struct ibuf *buf)
{ {
if (buf == NULL) if (buf == NULL)
return; return;
if (buf->max == 0) /* if buf lives on the stack */ /* if buf lives on the stack abort before causing more harm */
abort(); /* abort before causing more harm */ if (buf->fd == IBUF_FD_MARK_ON_STACK)
if (buf->fd != -1) abort();
if (buf->fd >= 0)
close(buf->fd); close(buf->fd);
freezero(buf->buf, buf->size); freezero(buf->buf, buf->size);
free(buf); free(buf);
@@ -522,7 +543,7 @@ ibuf_free(struct ibuf *buf)
int int
ibuf_fd_avail(struct ibuf *buf) ibuf_fd_avail(struct ibuf *buf)
{ {
return (buf->fd != -1); return (buf->fd >= 0);
} }
int int
@@ -530,6 +551,9 @@ ibuf_fd_get(struct ibuf *buf)
{ {
int fd; int fd;
/* negative fds are internal use and equivalent to -1 */
if (buf->fd < 0)
return (-1);
fd = buf->fd; fd = buf->fd;
buf->fd = -1; buf->fd = -1;
return (fd); return (fd);
@@ -538,15 +562,107 @@ ibuf_fd_get(struct ibuf *buf)
void void
ibuf_fd_set(struct ibuf *buf, int fd) ibuf_fd_set(struct ibuf *buf, int fd)
{ {
if (buf->max == 0) /* if buf lives on the stack */ /* if buf lives on the stack abort before causing more harm */
abort(); /* abort before causing more harm */ if (buf->fd == IBUF_FD_MARK_ON_STACK)
if (buf->fd != -1) abort();
if (buf->fd >= 0)
close(buf->fd); close(buf->fd);
buf->fd = fd; buf->fd = -1;
if (fd >= 0)
buf->fd = fd;
}
struct msgbuf *
msgbuf_new(void)
{
struct msgbuf *msgbuf;
if ((msgbuf = calloc(1, sizeof(*msgbuf))) == NULL)
return (NULL);
msgbuf->queued = 0;
TAILQ_INIT(&msgbuf->bufs);
TAILQ_INIT(&msgbuf->rbufs);
return msgbuf;
}
struct msgbuf *
msgbuf_new_reader(size_t hdrsz, ssize_t (*readhdr)(struct ibuf *, void *),
void *arg)
{
struct msgbuf *msgbuf;
char *buf;
if (hdrsz == 0 || hdrsz > IBUF_READ_SIZE / 2) {
errno = EINVAL;
return (NULL);
}
if ((buf = malloc(IBUF_READ_SIZE)) == NULL)
return (NULL);
msgbuf = msgbuf_new();
if (msgbuf == NULL) {
free(buf);
return (NULL);
}
msgbuf->rbuf = buf;
msgbuf->hdrsize = hdrsz;
msgbuf->readhdr = readhdr;
msgbuf->rarg = arg;
return (msgbuf);
}
void
msgbuf_free(struct msgbuf *msgbuf)
{
if (msgbuf == NULL)
return;
msgbuf_clear(msgbuf);
free(msgbuf->rbuf);
free(msgbuf);
}
uint32_t
msgbuf_queuelen(struct msgbuf *msgbuf)
{
return (msgbuf->queued);
}
void
msgbuf_clear(struct msgbuf *msgbuf)
{
struct ibuf *buf;
/* write side */
while ((buf = TAILQ_FIRST(&msgbuf->bufs)) != NULL)
msgbuf_dequeue(msgbuf, buf);
msgbuf->queued = 0;
/* read side */
while ((buf = TAILQ_FIRST(&msgbuf->rbufs)) != NULL) {
TAILQ_REMOVE(&msgbuf->rbufs, buf, entry);
ibuf_free(buf);
}
msgbuf->roff = 0;
ibuf_free(msgbuf->rpmsg);
msgbuf->rpmsg = NULL;
}
struct ibuf *
msgbuf_get(struct msgbuf *msgbuf)
{
struct ibuf *buf;
if ((buf = TAILQ_FIRST(&msgbuf->rbufs)) != NULL)
TAILQ_REMOVE(&msgbuf->rbufs, buf, entry);
return buf;
} }
int int
ibuf_write(struct msgbuf *msgbuf) ibuf_write(int fd, struct msgbuf *msgbuf)
{ {
struct iovec iov[IOV_MAX]; struct iovec iov[IOV_MAX];
struct ibuf *buf; struct ibuf *buf;
@@ -561,63 +677,25 @@ ibuf_write(struct msgbuf *msgbuf)
iov[i].iov_len = ibuf_size(buf); iov[i].iov_len = ibuf_size(buf);
i++; i++;
} }
if (i == 0)
return (0); /* nothing queued */
again: again:
if ((n = writev(msgbuf->fd, iov, i)) == -1) { if ((n = writev(fd, iov, i)) == -1) {
if (errno == EINTR) if (errno == EINTR)
goto again; goto again;
if (errno == ENOBUFS) if (errno == EAGAIN || errno == ENOBUFS)
errno = EAGAIN; /* lets retry later again */
return (0);
return (-1); return (-1);
} }
if (n == 0) { /* connection closed */
errno = 0;
return (0);
}
msgbuf_drain(msgbuf, n); msgbuf_drain(msgbuf, n);
return (0);
return (1);
}
void
msgbuf_init(struct msgbuf *msgbuf)
{
msgbuf->queued = 0;
msgbuf->fd = -1;
TAILQ_INIT(&msgbuf->bufs);
}
static void
msgbuf_drain(struct msgbuf *msgbuf, size_t n)
{
struct ibuf *buf, *next;
for (buf = TAILQ_FIRST(&msgbuf->bufs); buf != NULL && n > 0;
buf = next) {
next = TAILQ_NEXT(buf, entry);
if (n >= ibuf_size(buf)) {
n -= ibuf_size(buf);
ibuf_dequeue(msgbuf, buf);
} else {
buf->rpos += n;
n = 0;
}
}
}
void
msgbuf_clear(struct msgbuf *msgbuf)
{
struct ibuf *buf;
while ((buf = TAILQ_FIRST(&msgbuf->bufs)) != NULL)
ibuf_dequeue(msgbuf, buf);
} }
int int
msgbuf_write(struct msgbuf *msgbuf) msgbuf_write(int fd, struct msgbuf *msgbuf)
{ {
struct iovec iov[IOV_MAX]; struct iovec iov[IOV_MAX];
struct ibuf *buf, *buf0 = NULL; struct ibuf *buf, *buf0 = NULL;
@@ -645,6 +723,9 @@ msgbuf_write(struct msgbuf *msgbuf)
buf0 = buf; buf0 = buf;
} }
if (i == 0)
return (0); /* nothing queued */
msg.msg_iov = iov; msg.msg_iov = iov;
msg.msg_iovlen = i; msg.msg_iovlen = i;
@@ -658,20 +739,16 @@ msgbuf_write(struct msgbuf *msgbuf)
*(int *)CMSG_DATA(cmsg) = buf0->fd; *(int *)CMSG_DATA(cmsg) = buf0->fd;
} }
again: again:
if ((n = sendmsg(msgbuf->fd, &msg, 0)) == -1) { if ((n = sendmsg(fd, &msg, 0)) == -1) {
if (errno == EINTR) if (errno == EINTR)
goto again; goto again;
if (errno == ENOBUFS) if (errno == EAGAIN || errno == ENOBUFS)
errno = EAGAIN; /* lets retry later again */
return (0);
return (-1); return (-1);
} }
if (n == 0) { /* connection closed */
errno = 0;
return (0);
}
/* /*
* assumption: fd got sent if sendmsg sent anything * assumption: fd got sent if sendmsg sent anything
* this works because fds are passed one at a time * this works because fds are passed one at a time
@@ -683,28 +760,222 @@ again:
msgbuf_drain(msgbuf, n); msgbuf_drain(msgbuf, n);
return (1); return (0);
} }
uint32_t static int
msgbuf_queuelen(struct msgbuf *msgbuf) ibuf_read_process(struct msgbuf *msgbuf, int fd)
{ {
return (msgbuf->queued); struct ibuf rbuf, msg;
ssize_t sz;
ibuf_from_buffer(&rbuf, msgbuf->rbuf, msgbuf->roff);
/* fds must be passed at start of message of at least hdrsize bytes */
if (msgbuf->rpmsg != NULL && fd != -1) {
close(fd);
fd = -1;
}
do {
if (msgbuf->rpmsg == NULL) {
if (ibuf_size(&rbuf) < msgbuf->hdrsize) {
if (fd != -1) {
close(fd);
fd = -1;
}
break;
}
/* get size from header */
ibuf_from_buffer(&msg, ibuf_data(&rbuf),
msgbuf->hdrsize);
sz = msgbuf->readhdr(&msg, msgbuf->rarg);
if (sz == -1)
goto fail;
if ((msgbuf->rpmsg = ibuf_open(sz)) == NULL)
goto fail;
if (fd != -1) {
ibuf_fd_set(msgbuf->rpmsg, fd);
fd = -1;
}
}
if (ibuf_left(msgbuf->rpmsg) <= ibuf_size(&rbuf))
sz = ibuf_left(msgbuf->rpmsg);
else
sz = ibuf_size(&rbuf);
/* neither call below can fail */
if (ibuf_get_ibuf(&rbuf, sz, &msg) == -1 ||
ibuf_add_ibuf(msgbuf->rpmsg, &msg) == -1)
goto fail;
if (ibuf_left(msgbuf->rpmsg) == 0) {
msgbuf_read_enqueue(msgbuf, msgbuf->rpmsg);
msgbuf->rpmsg = NULL;
}
} while (ibuf_size(&rbuf) > 0);
if (ibuf_size(&rbuf) > 0)
memmove(msgbuf->rbuf, ibuf_data(&rbuf), ibuf_size(&rbuf));
msgbuf->roff = ibuf_size(&rbuf);
return (1);
fail:
/* XXX cleanup */
return (-1);
}
int
ibuf_read(int fd, struct msgbuf *msgbuf)
{
struct iovec iov;
ssize_t n;
if (msgbuf->rbuf == NULL) {
errno = EINVAL;
return (-1);
}
iov.iov_base = msgbuf->rbuf + msgbuf->roff;
iov.iov_len = IBUF_READ_SIZE - msgbuf->roff;
again:
if ((n = readv(fd, &iov, 1)) == -1) {
if (errno == EINTR)
goto again;
if (errno == EAGAIN)
/* lets retry later again */
return (1);
return (-1);
}
if (n == 0) /* connection closed */
return (0);
msgbuf->roff += n;
/* new data arrived, try to process it */
return (ibuf_read_process(msgbuf, -1));
}
int
msgbuf_read(int fd, struct msgbuf *msgbuf)
{
struct msghdr msg;
struct cmsghdr *cmsg;
union {
struct cmsghdr hdr;
char buf[CMSG_SPACE(sizeof(int) * 1)];
} cmsgbuf;
struct iovec iov;
ssize_t n;
int fdpass = -1;
if (msgbuf->rbuf == NULL) {
errno = EINVAL;
return (-1);
}
memset(&msg, 0, sizeof(msg));
memset(&cmsgbuf, 0, sizeof(cmsgbuf));
iov.iov_base = msgbuf->rbuf + msgbuf->roff;
iov.iov_len = IBUF_READ_SIZE - msgbuf->roff;
msg.msg_iov = &iov;
msg.msg_iovlen = 1;
msg.msg_control = &cmsgbuf.buf;
msg.msg_controllen = sizeof(cmsgbuf.buf);
again:
if ((n = recvmsg(fd, &msg, 0)) == -1) {
if (errno == EINTR)
goto again;
if (errno == EMSGSIZE)
/*
* Not enough fd slots: fd passing failed, retry
* to receive the message without fd.
* imsg_get_fd() will return -1 in that case.
*/
goto again;
if (errno == EAGAIN)
/* lets retry later again */
return (1);
return (-1);
}
if (n == 0) /* connection closed */
return (0);
msgbuf->roff += n;
for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL;
cmsg = CMSG_NXTHDR(&msg, cmsg)) {
if (cmsg->cmsg_level == SOL_SOCKET &&
cmsg->cmsg_type == SCM_RIGHTS) {
int i, j, f;
/*
* We only accept one file descriptor. Due to C
* padding rules, our control buffer might contain
* more than one fd, and we must close them.
*/
j = ((char *)cmsg + cmsg->cmsg_len -
(char *)CMSG_DATA(cmsg)) / sizeof(int);
for (i = 0; i < j; i++) {
f = ((int *)CMSG_DATA(cmsg))[i];
if (i == 0)
fdpass = f;
else
close(f);
}
}
/* we do not handle other ctl data level */
}
/* new data arrived, try to process it */
return (ibuf_read_process(msgbuf, fdpass));
} }
static void static void
ibuf_enqueue(struct msgbuf *msgbuf, struct ibuf *buf) msgbuf_read_enqueue(struct msgbuf *msgbuf, struct ibuf *buf)
{ {
if (buf->max == 0) /* if buf lives on the stack */ /* if buf lives on the stack abort before causing more harm */
abort(); /* abort before causing more harm */ if (buf->fd == IBUF_FD_MARK_ON_STACK)
abort();
TAILQ_INSERT_TAIL(&msgbuf->rbufs, buf, entry);
}
static void
msgbuf_enqueue(struct msgbuf *msgbuf, struct ibuf *buf)
{
/* if buf lives on the stack abort before causing more harm */
if (buf->fd == IBUF_FD_MARK_ON_STACK)
abort();
TAILQ_INSERT_TAIL(&msgbuf->bufs, buf, entry); TAILQ_INSERT_TAIL(&msgbuf->bufs, buf, entry);
msgbuf->queued++; msgbuf->queued++;
} }
static void static void
ibuf_dequeue(struct msgbuf *msgbuf, struct ibuf *buf) msgbuf_dequeue(struct msgbuf *msgbuf, struct ibuf *buf)
{ {
TAILQ_REMOVE(&msgbuf->bufs, buf, entry); TAILQ_REMOVE(&msgbuf->bufs, buf, entry);
msgbuf->queued--; msgbuf->queued--;
ibuf_free(buf); ibuf_free(buf);
} }
static void
msgbuf_drain(struct msgbuf *msgbuf, size_t n)
{
struct ibuf *buf, *next;
for (buf = TAILQ_FIRST(&msgbuf->bufs); buf != NULL && n > 0;
buf = next) {
next = TAILQ_NEXT(buf, entry);
if (n >= ibuf_size(buf)) {
n -= ibuf_size(buf);
msgbuf_dequeue(msgbuf, buf);
} else {
buf->rpos += n;
n = 0;
}
}
}

272
compat/imsg.c
View File

@@ -1,4 +1,4 @@
/* $OpenBSD: imsg.c,v 1.23 2023/12/12 15:47:41 claudio Exp $ */ /* $OpenBSD: imsg.c,v 1.36 2024/11/21 13:03:21 claudio Exp $ */
/* /*
* Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org> * Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org>
@@ -29,158 +29,105 @@
#include "compat.h" #include "compat.h"
#include "imsg.h" #include "imsg.h"
struct imsg_fd { #define IMSG_ALLOW_FDPASS 0x01
TAILQ_ENTRY(imsg_fd) entry;
int fd;
};
int imsg_fd_overhead = 0; static ssize_t imsg_parse_hdr(struct ibuf *, void *);
static int imsg_dequeue_fd(struct imsgbuf *); int
imsgbuf_init(struct imsgbuf *imsgbuf, int fd)
void
imsg_init(struct imsgbuf *imsgbuf, int fd)
{ {
msgbuf_init(&imsgbuf->w); imsgbuf->w = msgbuf_new_reader(IMSG_HEADER_SIZE, imsg_parse_hdr,
memset(&imsgbuf->r, 0, sizeof(imsgbuf->r)); imsgbuf);
imsgbuf->fd = fd; if (imsgbuf->w == NULL)
imsgbuf->w.fd = fd; return (-1);
imsgbuf->pid = getpid(); imsgbuf->pid = getpid();
TAILQ_INIT(&imsgbuf->fds); imsgbuf->maxsize = MAX_IMSGSIZE;
imsgbuf->fd = fd;
imsgbuf->flags = 0;
return (0);
} }
ssize_t void
imsg_read(struct imsgbuf *imsgbuf) imsgbuf_allow_fdpass(struct imsgbuf *imsgbuf)
{ {
struct msghdr msg; imsgbuf->flags |= IMSG_ALLOW_FDPASS;
struct cmsghdr *cmsg; }
union {
struct cmsghdr hdr;
char buf[CMSG_SPACE(sizeof(int) * 1)];
} cmsgbuf;
struct iovec iov;
ssize_t n = -1;
int fd;
struct imsg_fd *ifd;
memset(&msg, 0, sizeof(msg)); void
memset(&cmsgbuf, 0, sizeof(cmsgbuf)); imsgbuf_set_maxsize(struct imsgbuf *imsgbuf, uint32_t maxsize)
{
if (maxsize < IMSG_HEADER_SIZE)
return;
imsgbuf->maxsize = maxsize;
}
iov.iov_base = imsgbuf->r.buf + imsgbuf->r.wpos; int
iov.iov_len = sizeof(imsgbuf->r.buf) - imsgbuf->r.wpos; imsgbuf_read(struct imsgbuf *imsgbuf)
msg.msg_iov = &iov; {
msg.msg_iovlen = 1; if (imsgbuf->flags & IMSG_ALLOW_FDPASS)
msg.msg_control = &cmsgbuf.buf; return msgbuf_read(imsgbuf->fd, imsgbuf->w);
msg.msg_controllen = sizeof(cmsgbuf.buf); else
return ibuf_read(imsgbuf->fd, imsgbuf->w);
}
if ((ifd = calloc(1, sizeof(struct imsg_fd))) == NULL) int
return (-1); imsgbuf_write(struct imsgbuf *imsgbuf)
{
if (imsgbuf->flags & IMSG_ALLOW_FDPASS)
return msgbuf_write(imsgbuf->fd, imsgbuf->w);
else
return ibuf_write(imsgbuf->fd, imsgbuf->w);
}
again: int
if (getdtablecount() + imsg_fd_overhead + imsgbuf_flush(struct imsgbuf *imsgbuf)
(int)((CMSG_SPACE(sizeof(int))-CMSG_SPACE(0))/sizeof(int)) {
>= getdtablesize()) { while (imsgbuf_queuelen(imsgbuf) > 0) {
errno = EAGAIN; if (imsgbuf_write(imsgbuf) == -1)
free(ifd); return (-1);
return (-1);
} }
return (0);
}
if ((n = recvmsg(imsgbuf->fd, &msg, 0)) == -1) { void
if (errno == EINTR) imsgbuf_clear(struct imsgbuf *imsgbuf)
goto again; {
goto fail; msgbuf_free(imsgbuf->w);
} imsgbuf->w = NULL;
}
imsgbuf->r.wpos += n; uint32_t
imsgbuf_queuelen(struct imsgbuf *imsgbuf)
for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL; {
cmsg = CMSG_NXTHDR(&msg, cmsg)) { return msgbuf_queuelen(imsgbuf->w);
if (cmsg->cmsg_level == SOL_SOCKET &&
cmsg->cmsg_type == SCM_RIGHTS) {
int i;
int j;
/*
* We only accept one file descriptor. Due to C
* padding rules, our control buffer might contain
* more than one fd, and we must close them.
*/
j = ((char *)cmsg + cmsg->cmsg_len -
(char *)CMSG_DATA(cmsg)) / sizeof(int);
for (i = 0; i < j; i++) {
fd = ((int *)CMSG_DATA(cmsg))[i];
if (ifd != NULL) {
ifd->fd = fd;
TAILQ_INSERT_TAIL(&imsgbuf->fds, ifd,
entry);
ifd = NULL;
} else
close(fd);
}
}
/* we do not handle other ctl data level */
}
fail:
free(ifd);
return (n);
} }
ssize_t ssize_t
imsg_get(struct imsgbuf *imsgbuf, struct imsg *imsg) imsg_get(struct imsgbuf *imsgbuf, struct imsg *imsg)
{ {
struct imsg m; struct imsg m;
size_t av, left, datalen; struct ibuf *buf;
av = imsgbuf->r.wpos; if ((buf = msgbuf_get(imsgbuf->w)) == NULL)
if (IMSG_HEADER_SIZE > av)
return (0); return (0);
memcpy(&m.hdr, imsgbuf->r.buf, sizeof(m.hdr)); if (ibuf_get(buf, &m.hdr, sizeof(m.hdr)) == -1)
if (m.hdr.len < IMSG_HEADER_SIZE ||
m.hdr.len > MAX_IMSGSIZE) {
errno = ERANGE;
return (-1); return (-1);
}
if (m.hdr.len > av)
return (0);
m.fd = -1; if (ibuf_size(buf))
m.buf = NULL; m.data = ibuf_data(buf);
m.data = NULL; else
m.data = NULL;
datalen = m.hdr.len - IMSG_HEADER_SIZE; m.buf = buf;
imsgbuf->r.rptr = imsgbuf->r.buf + IMSG_HEADER_SIZE;
if (datalen != 0) {
if ((m.buf = ibuf_open(datalen)) == NULL)
return (-1);
if (ibuf_add(m.buf, imsgbuf->r.rptr, datalen) == -1) {
/* this should never fail */
ibuf_free(m.buf);
return (-1);
}
m.data = ibuf_data(m.buf);
}
if (m.hdr.flags & IMSGF_HASFD)
m.fd = imsg_dequeue_fd(imsgbuf);
if (m.hdr.len < av) {
left = av - m.hdr.len;
memmove(&imsgbuf->r.buf, imsgbuf->r.buf + m.hdr.len, left);
imsgbuf->r.wpos = left;
} else
imsgbuf->r.wpos = 0;
*imsg = m; *imsg = m;
return (datalen + IMSG_HEADER_SIZE); return (ibuf_size(buf) + IMSG_HEADER_SIZE);
} }
int int
imsg_get_ibuf(struct imsg *imsg, struct ibuf *ibuf) imsg_get_ibuf(struct imsg *imsg, struct ibuf *ibuf)
{ {
if (imsg->buf == NULL) { if (ibuf_size(imsg->buf) == 0) {
errno = EBADMSG; errno = EBADMSG;
return (-1); return (-1);
} }
@@ -194,7 +141,7 @@ imsg_get_data(struct imsg *imsg, void *data, size_t len)
errno = EINVAL; errno = EINVAL;
return (-1); return (-1);
} }
if (imsg->buf == NULL || ibuf_size(imsg->buf) != len) { if (ibuf_size(imsg->buf) != len) {
errno = EBADMSG; errno = EBADMSG;
return (-1); return (-1);
} }
@@ -204,10 +151,7 @@ imsg_get_data(struct imsg *imsg, void *data, size_t len)
int int
imsg_get_fd(struct imsg *imsg) imsg_get_fd(struct imsg *imsg)
{ {
int fd = imsg->fd; return ibuf_fd_get(imsg->buf);
imsg->fd = -1;
return fd;
} }
uint32_t uint32_t
@@ -219,8 +163,6 @@ imsg_get_id(struct imsg *imsg)
size_t size_t
imsg_get_len(struct imsg *imsg) imsg_get_len(struct imsg *imsg)
{ {
if (imsg->buf == NULL)
return 0;
return ibuf_size(imsg->buf); return ibuf_size(imsg->buf);
} }
@@ -290,14 +232,13 @@ imsg_compose_ibuf(struct imsgbuf *imsgbuf, uint32_t type, uint32_t id,
struct imsg_hdr hdr; struct imsg_hdr hdr;
int save_errno; int save_errno;
if (ibuf_size(buf) + IMSG_HEADER_SIZE > MAX_IMSGSIZE) { if (ibuf_size(buf) + IMSG_HEADER_SIZE > imsgbuf->maxsize) {
errno = ERANGE; errno = ERANGE;
goto fail; goto fail;
} }
hdr.type = type; hdr.type = type;
hdr.len = ibuf_size(buf) + IMSG_HEADER_SIZE; hdr.len = ibuf_size(buf) + IMSG_HEADER_SIZE;
hdr.flags = 0;
hdr.peerid = id; hdr.peerid = id;
if ((hdr.pid = pid) == 0) if ((hdr.pid = pid) == 0)
hdr.pid = imsgbuf->pid; hdr.pid = imsgbuf->pid;
@@ -307,8 +248,8 @@ imsg_compose_ibuf(struct imsgbuf *imsgbuf, uint32_t type, uint32_t id,
if (imsg_add(hdrbuf, &hdr, sizeof(hdr)) == -1) if (imsg_add(hdrbuf, &hdr, sizeof(hdr)) == -1)
goto fail; goto fail;
ibuf_close(&imsgbuf->w, hdrbuf); ibuf_close(imsgbuf->w, hdrbuf);
ibuf_close(&imsgbuf->w, buf); ibuf_close(imsgbuf->w, buf);
return (1); return (1);
fail: fail:
@@ -328,22 +269,16 @@ imsg_forward(struct imsgbuf *imsgbuf, struct imsg *msg)
struct ibuf *wbuf; struct ibuf *wbuf;
size_t len = 0; size_t len = 0;
if (msg->fd != -1) { ibuf_rewind(msg->buf);
close(msg->fd); ibuf_skip(msg->buf, sizeof(msg->hdr));
msg->fd = -1; len = ibuf_size(msg->buf);
}
if (msg->buf != NULL) {
ibuf_rewind(msg->buf);
len = ibuf_size(msg->buf);
}
if ((wbuf = imsg_create(imsgbuf, msg->hdr.type, msg->hdr.peerid, if ((wbuf = imsg_create(imsgbuf, msg->hdr.type, msg->hdr.peerid,
msg->hdr.pid, len)) == NULL) msg->hdr.pid, len)) == NULL)
return (-1); return (-1);
if (msg->buf != NULL) { if (msg->buf != NULL) {
if (ibuf_add_buf(wbuf, msg->buf) == -1) { if (ibuf_add_ibuf(wbuf, msg->buf) == -1) {
ibuf_free(wbuf); ibuf_free(wbuf);
return (-1); return (-1);
} }
@@ -361,17 +296,16 @@ imsg_create(struct imsgbuf *imsgbuf, uint32_t type, uint32_t id, pid_t pid,
struct imsg_hdr hdr; struct imsg_hdr hdr;
datalen += IMSG_HEADER_SIZE; datalen += IMSG_HEADER_SIZE;
if (datalen > MAX_IMSGSIZE) { if (datalen > imsgbuf->maxsize) {
errno = ERANGE; errno = ERANGE;
return (NULL); return (NULL);
} }
hdr.type = type; hdr.type = type;
hdr.flags = 0;
hdr.peerid = id; hdr.peerid = id;
if ((hdr.pid = pid) == 0) if ((hdr.pid = pid) == 0)
hdr.pid = imsgbuf->pid; hdr.pid = imsgbuf->pid;
if ((wbuf = ibuf_dynamic(datalen, MAX_IMSGSIZE)) == NULL) { if ((wbuf = ibuf_dynamic(datalen, imsgbuf->maxsize)) == NULL) {
return (NULL); return (NULL);
} }
if (imsg_add(wbuf, &hdr, sizeof(hdr)) == -1) if (imsg_add(wbuf, &hdr, sizeof(hdr)) == -1)
@@ -397,13 +331,8 @@ imsg_close(struct imsgbuf *imsgbuf, struct ibuf *msg)
struct imsg_hdr *hdr; struct imsg_hdr *hdr;
hdr = (struct imsg_hdr *)msg->buf; hdr = (struct imsg_hdr *)msg->buf;
hdr->flags &= ~IMSGF_HASFD;
if (ibuf_fd_avail(msg))
hdr->flags |= IMSGF_HASFD;
hdr->len = ibuf_size(msg); hdr->len = ibuf_size(msg);
ibuf_close(imsgbuf->w, msg);
ibuf_close(&imsgbuf->w, msg);
} }
void void
@@ -412,37 +341,18 @@ imsg_free(struct imsg *imsg)
ibuf_free(imsg->buf); ibuf_free(imsg->buf);
} }
static int static ssize_t
imsg_dequeue_fd(struct imsgbuf *imsgbuf) imsg_parse_hdr(struct ibuf *buf, void *arg)
{ {
int fd; struct imsgbuf *imsgbuf = arg;
struct imsg_fd *ifd; struct imsg_hdr hdr;
if ((ifd = TAILQ_FIRST(&imsgbuf->fds)) == NULL) if (ibuf_get(buf, &hdr, sizeof(hdr)) == -1)
return -1;
if (hdr.len < IMSG_HEADER_SIZE ||
hdr.len > imsgbuf->maxsize) {
errno = ERANGE;
return (-1); return (-1);
}
fd = ifd->fd; return hdr.len;
TAILQ_REMOVE(&imsgbuf->fds, ifd, entry);
free(ifd);
return (fd);
}
int
imsg_flush(struct imsgbuf *imsgbuf)
{
while (imsgbuf->w.queued)
if (msgbuf_write(&imsgbuf->w) <= 0)
return (-1);
return (0);
}
void
imsg_clear(struct imsgbuf *imsgbuf)
{
int fd;
msgbuf_clear(&imsgbuf->w);
while ((fd = imsg_dequeue_fd(imsgbuf)) != -1)
close(fd);
} }

55
compat/imsg.h
View File

@@ -1,4 +1,4 @@
/* $OpenBSD: imsg.h,v 1.8 2023/12/12 15:47:41 claudio Exp $ */ /* $OpenBSD: imsg.h,v 1.18 2024/11/21 13:03:21 claudio Exp $ */
/* /*
* Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org> * Copyright (c) 2023 Claudio Jeker <claudio@openbsd.org>
@@ -38,40 +38,25 @@ struct ibuf {
int fd; int fd;
}; };
struct msgbuf { struct msgbuf;
TAILQ_HEAD(, ibuf) bufs;
uint32_t queued;
int fd;
};
struct ibuf_read {
unsigned char buf[IBUF_READ_SIZE];
unsigned char *rptr;
size_t wpos;
};
struct imsg_fd;
struct imsgbuf { struct imsgbuf {
TAILQ_HEAD(, imsg_fd) fds; struct msgbuf *w;
struct ibuf_read r;
struct msgbuf w;
int fd;
pid_t pid; pid_t pid;
uint32_t maxsize;
int fd;
int flags;
}; };
#define IMSGF_HASFD 1
struct imsg_hdr { struct imsg_hdr {
uint32_t type; uint32_t type;
uint16_t len; uint32_t len;
uint16_t flags;
uint32_t peerid; uint32_t peerid;
uint32_t pid; uint32_t pid;
}; };
struct imsg { struct imsg {
struct imsg_hdr hdr; struct imsg_hdr hdr;
int fd;
void *data; void *data;
struct ibuf *buf; struct ibuf *buf;
}; };
@@ -82,7 +67,6 @@ struct iovec;
struct ibuf *ibuf_open(size_t); struct ibuf *ibuf_open(size_t);
struct ibuf *ibuf_dynamic(size_t, size_t); struct ibuf *ibuf_dynamic(size_t, size_t);
int ibuf_add(struct ibuf *, const void *, size_t); int ibuf_add(struct ibuf *, const void *, size_t);
int ibuf_add_buf(struct ibuf *, const struct ibuf *);
int ibuf_add_ibuf(struct ibuf *, const struct ibuf *); int ibuf_add_ibuf(struct ibuf *, const struct ibuf *);
int ibuf_add_zero(struct ibuf *, size_t); int ibuf_add_zero(struct ibuf *, size_t);
int ibuf_add_n8(struct ibuf *, uint64_t); int ibuf_add_n8(struct ibuf *, uint64_t);
@@ -119,20 +103,33 @@ int ibuf_get_n64(struct ibuf *, uint64_t *);
int ibuf_get_h16(struct ibuf *, uint16_t *); int ibuf_get_h16(struct ibuf *, uint16_t *);
int ibuf_get_h32(struct ibuf *, uint32_t *); int ibuf_get_h32(struct ibuf *, uint32_t *);
int ibuf_get_h64(struct ibuf *, uint64_t *); int ibuf_get_h64(struct ibuf *, uint64_t *);
char *ibuf_get_string(struct ibuf *, size_t);
int ibuf_skip(struct ibuf *, size_t); int ibuf_skip(struct ibuf *, size_t);
void ibuf_free(struct ibuf *); void ibuf_free(struct ibuf *);
int ibuf_fd_avail(struct ibuf *); int ibuf_fd_avail(struct ibuf *);
int ibuf_fd_get(struct ibuf *); int ibuf_fd_get(struct ibuf *);
void ibuf_fd_set(struct ibuf *, int); void ibuf_fd_set(struct ibuf *, int);
int ibuf_write(struct msgbuf *); struct msgbuf *msgbuf_new(void);
void msgbuf_init(struct msgbuf *); struct msgbuf *msgbuf_new_reader(size_t, ssize_t (*)(struct ibuf *, void *),
void *);
void msgbuf_free(struct msgbuf *);
void msgbuf_clear(struct msgbuf *); void msgbuf_clear(struct msgbuf *);
uint32_t msgbuf_queuelen(struct msgbuf *); uint32_t msgbuf_queuelen(struct msgbuf *);
int msgbuf_write(struct msgbuf *); int ibuf_write(int, struct msgbuf *);
int msgbuf_write(int, struct msgbuf *);
int ibuf_read(int, struct msgbuf *);
int msgbuf_read(int, struct msgbuf *);
struct ibuf *msgbuf_get(struct msgbuf *);
/* imsg.c */ /* imsg.c */
void imsg_init(struct imsgbuf *, int); int imsgbuf_init(struct imsgbuf *, int);
ssize_t imsg_read(struct imsgbuf *); void imsgbuf_allow_fdpass(struct imsgbuf *imsgbuf);
void imsgbuf_set_maxsize(struct imsgbuf *, uint32_t);
int imsgbuf_read(struct imsgbuf *);
int imsgbuf_write(struct imsgbuf *);
int imsgbuf_flush(struct imsgbuf *);
void imsgbuf_clear(struct imsgbuf *);
uint32_t imsgbuf_queuelen(struct imsgbuf *);
ssize_t imsg_get(struct imsgbuf *, struct imsg *); ssize_t imsg_get(struct imsgbuf *, struct imsg *);
int imsg_get_ibuf(struct imsg *, struct ibuf *); int imsg_get_ibuf(struct imsg *, struct ibuf *);
int imsg_get_data(struct imsg *, void *, size_t); int imsg_get_data(struct imsg *, void *, size_t);
@@ -152,7 +149,5 @@ struct ibuf *imsg_create(struct imsgbuf *, uint32_t, uint32_t, pid_t, size_t);
int imsg_add(struct ibuf *, const void *, size_t); int imsg_add(struct ibuf *, const void *, size_t);
void imsg_close(struct imsgbuf *, struct ibuf *); void imsg_close(struct imsgbuf *, struct ibuf *);
void imsg_free(struct imsg *); void imsg_free(struct imsg *);
int imsg_flush(struct imsgbuf *);
void imsg_clear(struct imsgbuf *);
#endif #endif