Blame


1 bbcba3ed 2022-01-10 op /* $OpenBSD: imsg-buffer.c,v 1.12 2019/01/20 02:50:03 bcook Exp $ */
2 bbcba3ed 2022-01-10 op
3 bbcba3ed 2022-01-10 op /*
4 bbcba3ed 2022-01-10 op * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
5 bbcba3ed 2022-01-10 op *
6 bbcba3ed 2022-01-10 op * Permission to use, copy, modify, and distribute this software for any
7 bbcba3ed 2022-01-10 op * purpose with or without fee is hereby granted, provided that the above
8 bbcba3ed 2022-01-10 op * copyright notice and this permission notice appear in all copies.
9 bbcba3ed 2022-01-10 op *
10 bbcba3ed 2022-01-10 op * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 bbcba3ed 2022-01-10 op * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 bbcba3ed 2022-01-10 op * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 bbcba3ed 2022-01-10 op * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 bbcba3ed 2022-01-10 op * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 bbcba3ed 2022-01-10 op * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 bbcba3ed 2022-01-10 op * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 bbcba3ed 2022-01-10 op */
18 bbcba3ed 2022-01-10 op
19 bbcba3ed 2022-01-10 op #include "compat.h"
20 bbcba3ed 2022-01-10 op
21 bbcba3ed 2022-01-10 op #include <sys/types.h>
22 bbcba3ed 2022-01-10 op #include <sys/socket.h>
23 bbcba3ed 2022-01-10 op #include <sys/uio.h>
24 bbcba3ed 2022-01-10 op
25 bbcba3ed 2022-01-10 op #include <limits.h>
26 bbcba3ed 2022-01-10 op #include <errno.h>
27 bbcba3ed 2022-01-10 op #include <stdlib.h>
28 bbcba3ed 2022-01-10 op #include <string.h>
29 bbcba3ed 2022-01-10 op #include <unistd.h>
30 bbcba3ed 2022-01-10 op
31 bbcba3ed 2022-01-10 op #include "imsg.h"
32 bbcba3ed 2022-01-10 op
33 bbcba3ed 2022-01-10 op static int ibuf_realloc(struct ibuf *, size_t);
34 bbcba3ed 2022-01-10 op static void ibuf_enqueue(struct msgbuf *, struct ibuf *);
35 bbcba3ed 2022-01-10 op static void ibuf_dequeue(struct msgbuf *, struct ibuf *);
36 bbcba3ed 2022-01-10 op
37 bbcba3ed 2022-01-10 op struct ibuf *
38 bbcba3ed 2022-01-10 op ibuf_open(size_t len)
39 bbcba3ed 2022-01-10 op {
40 bbcba3ed 2022-01-10 op struct ibuf *buf;
41 bbcba3ed 2022-01-10 op
42 bbcba3ed 2022-01-10 op if ((buf = calloc(1, sizeof(struct ibuf))) == NULL)
43 bbcba3ed 2022-01-10 op return (NULL);
44 bbcba3ed 2022-01-10 op if ((buf->buf = malloc(len)) == NULL) {
45 bbcba3ed 2022-01-10 op free(buf);
46 bbcba3ed 2022-01-10 op return (NULL);
47 bbcba3ed 2022-01-10 op }
48 bbcba3ed 2022-01-10 op buf->size = buf->max = len;
49 bbcba3ed 2022-01-10 op buf->fd = -1;
50 bbcba3ed 2022-01-10 op
51 bbcba3ed 2022-01-10 op return (buf);
52 bbcba3ed 2022-01-10 op }
53 bbcba3ed 2022-01-10 op
54 bbcba3ed 2022-01-10 op struct ibuf *
55 bbcba3ed 2022-01-10 op ibuf_dynamic(size_t len, size_t max)
56 bbcba3ed 2022-01-10 op {
57 bbcba3ed 2022-01-10 op struct ibuf *buf;
58 bbcba3ed 2022-01-10 op
59 bbcba3ed 2022-01-10 op if (max < len)
60 bbcba3ed 2022-01-10 op return (NULL);
61 bbcba3ed 2022-01-10 op
62 bbcba3ed 2022-01-10 op if ((buf = ibuf_open(len)) == NULL)
63 bbcba3ed 2022-01-10 op return (NULL);
64 bbcba3ed 2022-01-10 op
65 bbcba3ed 2022-01-10 op if (max > 0)
66 bbcba3ed 2022-01-10 op buf->max = max;
67 bbcba3ed 2022-01-10 op
68 bbcba3ed 2022-01-10 op return (buf);
69 bbcba3ed 2022-01-10 op }
70 bbcba3ed 2022-01-10 op
71 bbcba3ed 2022-01-10 op static int
72 bbcba3ed 2022-01-10 op ibuf_realloc(struct ibuf *buf, size_t len)
73 bbcba3ed 2022-01-10 op {
74 bbcba3ed 2022-01-10 op unsigned char *b;
75 bbcba3ed 2022-01-10 op
76 bbcba3ed 2022-01-10 op /* on static buffers max is eq size and so the following fails */
77 bbcba3ed 2022-01-10 op if (buf->wpos + len > buf->max) {
78 bbcba3ed 2022-01-10 op errno = ERANGE;
79 bbcba3ed 2022-01-10 op return (-1);
80 bbcba3ed 2022-01-10 op }
81 bbcba3ed 2022-01-10 op
82 bbcba3ed 2022-01-10 op b = recallocarray(buf->buf, buf->size, buf->wpos + len, 1);
83 bbcba3ed 2022-01-10 op if (b == NULL)
84 bbcba3ed 2022-01-10 op return (-1);
85 bbcba3ed 2022-01-10 op buf->buf = b;
86 bbcba3ed 2022-01-10 op buf->size = buf->wpos + len;
87 bbcba3ed 2022-01-10 op
88 bbcba3ed 2022-01-10 op return (0);
89 bbcba3ed 2022-01-10 op }
90 bbcba3ed 2022-01-10 op
91 bbcba3ed 2022-01-10 op int
92 bbcba3ed 2022-01-10 op ibuf_add(struct ibuf *buf, const void *data, size_t len)
93 bbcba3ed 2022-01-10 op {
94 bbcba3ed 2022-01-10 op if (buf->wpos + len > buf->size)
95 bbcba3ed 2022-01-10 op if (ibuf_realloc(buf, len) == -1)
96 bbcba3ed 2022-01-10 op return (-1);
97 bbcba3ed 2022-01-10 op
98 bbcba3ed 2022-01-10 op memcpy(buf->buf + buf->wpos, data, len);
99 bbcba3ed 2022-01-10 op buf->wpos += len;
100 bbcba3ed 2022-01-10 op return (0);
101 bbcba3ed 2022-01-10 op }
102 bbcba3ed 2022-01-10 op
103 bbcba3ed 2022-01-10 op void *
104 bbcba3ed 2022-01-10 op ibuf_reserve(struct ibuf *buf, size_t len)
105 bbcba3ed 2022-01-10 op {
106 bbcba3ed 2022-01-10 op void *b;
107 bbcba3ed 2022-01-10 op
108 bbcba3ed 2022-01-10 op if (buf->wpos + len > buf->size)
109 bbcba3ed 2022-01-10 op if (ibuf_realloc(buf, len) == -1)
110 bbcba3ed 2022-01-10 op return (NULL);
111 bbcba3ed 2022-01-10 op
112 bbcba3ed 2022-01-10 op b = buf->buf + buf->wpos;
113 bbcba3ed 2022-01-10 op buf->wpos += len;
114 bbcba3ed 2022-01-10 op return (b);
115 bbcba3ed 2022-01-10 op }
116 bbcba3ed 2022-01-10 op
117 bbcba3ed 2022-01-10 op void *
118 bbcba3ed 2022-01-10 op ibuf_seek(struct ibuf *buf, size_t pos, size_t len)
119 bbcba3ed 2022-01-10 op {
120 bbcba3ed 2022-01-10 op /* only allowed to seek in already written parts */
121 bbcba3ed 2022-01-10 op if (pos + len > buf->wpos)
122 bbcba3ed 2022-01-10 op return (NULL);
123 bbcba3ed 2022-01-10 op
124 bbcba3ed 2022-01-10 op return (buf->buf + pos);
125 bbcba3ed 2022-01-10 op }
126 bbcba3ed 2022-01-10 op
127 bbcba3ed 2022-01-10 op size_t
128 bbcba3ed 2022-01-10 op ibuf_size(struct ibuf *buf)
129 bbcba3ed 2022-01-10 op {
130 bbcba3ed 2022-01-10 op return (buf->wpos);
131 bbcba3ed 2022-01-10 op }
132 bbcba3ed 2022-01-10 op
133 bbcba3ed 2022-01-10 op size_t
134 bbcba3ed 2022-01-10 op ibuf_left(struct ibuf *buf)
135 bbcba3ed 2022-01-10 op {
136 bbcba3ed 2022-01-10 op return (buf->max - buf->wpos);
137 bbcba3ed 2022-01-10 op }
138 bbcba3ed 2022-01-10 op
139 bbcba3ed 2022-01-10 op void
140 bbcba3ed 2022-01-10 op ibuf_close(struct msgbuf *msgbuf, struct ibuf *buf)
141 bbcba3ed 2022-01-10 op {
142 bbcba3ed 2022-01-10 op ibuf_enqueue(msgbuf, buf);
143 bbcba3ed 2022-01-10 op }
144 bbcba3ed 2022-01-10 op
145 bbcba3ed 2022-01-10 op int
146 bbcba3ed 2022-01-10 op ibuf_write(struct msgbuf *msgbuf)
147 bbcba3ed 2022-01-10 op {
148 bbcba3ed 2022-01-10 op struct iovec iov[IOV_MAX];
149 bbcba3ed 2022-01-10 op struct ibuf *buf;
150 bbcba3ed 2022-01-10 op unsigned int i = 0;
151 bbcba3ed 2022-01-10 op ssize_t n;
152 bbcba3ed 2022-01-10 op
153 bbcba3ed 2022-01-10 op memset(&iov, 0, sizeof(iov));
154 bbcba3ed 2022-01-10 op TAILQ_FOREACH(buf, &msgbuf->bufs, entry) {
155 bbcba3ed 2022-01-10 op if (i >= IOV_MAX)
156 bbcba3ed 2022-01-10 op break;
157 bbcba3ed 2022-01-10 op iov[i].iov_base = buf->buf + buf->rpos;
158 bbcba3ed 2022-01-10 op iov[i].iov_len = buf->wpos - buf->rpos;
159 bbcba3ed 2022-01-10 op i++;
160 bbcba3ed 2022-01-10 op }
161 bbcba3ed 2022-01-10 op
162 bbcba3ed 2022-01-10 op again:
163 bbcba3ed 2022-01-10 op if ((n = writev(msgbuf->fd, iov, i)) == -1) {
164 bbcba3ed 2022-01-10 op if (errno == EINTR)
165 bbcba3ed 2022-01-10 op goto again;
166 bbcba3ed 2022-01-10 op if (errno == ENOBUFS)
167 bbcba3ed 2022-01-10 op errno = EAGAIN;
168 bbcba3ed 2022-01-10 op return (-1);
169 bbcba3ed 2022-01-10 op }
170 bbcba3ed 2022-01-10 op
171 bbcba3ed 2022-01-10 op if (n == 0) { /* connection closed */
172 bbcba3ed 2022-01-10 op errno = 0;
173 bbcba3ed 2022-01-10 op return (0);
174 bbcba3ed 2022-01-10 op }
175 bbcba3ed 2022-01-10 op
176 bbcba3ed 2022-01-10 op msgbuf_drain(msgbuf, n);
177 bbcba3ed 2022-01-10 op
178 bbcba3ed 2022-01-10 op return (1);
179 bbcba3ed 2022-01-10 op }
180 bbcba3ed 2022-01-10 op
181 bbcba3ed 2022-01-10 op void
182 bbcba3ed 2022-01-10 op ibuf_free(struct ibuf *buf)
183 bbcba3ed 2022-01-10 op {
184 bbcba3ed 2022-01-10 op if (buf == NULL)
185 bbcba3ed 2022-01-10 op return;
186 bbcba3ed 2022-01-10 op freezero(buf->buf, buf->size);
187 bbcba3ed 2022-01-10 op free(buf);
188 bbcba3ed 2022-01-10 op }
189 bbcba3ed 2022-01-10 op
190 bbcba3ed 2022-01-10 op void
191 bbcba3ed 2022-01-10 op msgbuf_init(struct msgbuf *msgbuf)
192 bbcba3ed 2022-01-10 op {
193 bbcba3ed 2022-01-10 op msgbuf->queued = 0;
194 bbcba3ed 2022-01-10 op msgbuf->fd = -1;
195 bbcba3ed 2022-01-10 op TAILQ_INIT(&msgbuf->bufs);
196 bbcba3ed 2022-01-10 op }
197 bbcba3ed 2022-01-10 op
198 bbcba3ed 2022-01-10 op void
199 bbcba3ed 2022-01-10 op msgbuf_drain(struct msgbuf *msgbuf, size_t n)
200 bbcba3ed 2022-01-10 op {
201 bbcba3ed 2022-01-10 op struct ibuf *buf, *next;
202 bbcba3ed 2022-01-10 op
203 bbcba3ed 2022-01-10 op for (buf = TAILQ_FIRST(&msgbuf->bufs); buf != NULL && n > 0;
204 bbcba3ed 2022-01-10 op buf = next) {
205 bbcba3ed 2022-01-10 op next = TAILQ_NEXT(buf, entry);
206 bbcba3ed 2022-01-10 op if (buf->rpos + n >= buf->wpos) {
207 bbcba3ed 2022-01-10 op n -= buf->wpos - buf->rpos;
208 bbcba3ed 2022-01-10 op ibuf_dequeue(msgbuf, buf);
209 bbcba3ed 2022-01-10 op } else {
210 bbcba3ed 2022-01-10 op buf->rpos += n;
211 bbcba3ed 2022-01-10 op n = 0;
212 bbcba3ed 2022-01-10 op }
213 bbcba3ed 2022-01-10 op }
214 bbcba3ed 2022-01-10 op }
215 bbcba3ed 2022-01-10 op
216 bbcba3ed 2022-01-10 op void
217 bbcba3ed 2022-01-10 op msgbuf_clear(struct msgbuf *msgbuf)
218 bbcba3ed 2022-01-10 op {
219 bbcba3ed 2022-01-10 op struct ibuf *buf;
220 bbcba3ed 2022-01-10 op
221 bbcba3ed 2022-01-10 op while ((buf = TAILQ_FIRST(&msgbuf->bufs)) != NULL)
222 bbcba3ed 2022-01-10 op ibuf_dequeue(msgbuf, buf);
223 bbcba3ed 2022-01-10 op }
224 bbcba3ed 2022-01-10 op
225 bbcba3ed 2022-01-10 op int
226 bbcba3ed 2022-01-10 op msgbuf_write(struct msgbuf *msgbuf)
227 bbcba3ed 2022-01-10 op {
228 bbcba3ed 2022-01-10 op struct iovec iov[IOV_MAX];
229 bbcba3ed 2022-01-10 op struct ibuf *buf;
230 bbcba3ed 2022-01-10 op unsigned int i = 0;
231 bbcba3ed 2022-01-10 op ssize_t n;
232 bbcba3ed 2022-01-10 op struct msghdr msg;
233 bbcba3ed 2022-01-10 op struct cmsghdr *cmsg;
234 bbcba3ed 2022-01-10 op union {
235 bbcba3ed 2022-01-10 op struct cmsghdr hdr;
236 bbcba3ed 2022-01-10 op char buf[CMSG_SPACE(sizeof(int))];
237 bbcba3ed 2022-01-10 op } cmsgbuf;
238 bbcba3ed 2022-01-10 op
239 bbcba3ed 2022-01-10 op memset(&iov, 0, sizeof(iov));
240 bbcba3ed 2022-01-10 op memset(&msg, 0, sizeof(msg));
241 bbcba3ed 2022-01-10 op memset(&cmsgbuf, 0, sizeof(cmsgbuf));
242 bbcba3ed 2022-01-10 op TAILQ_FOREACH(buf, &msgbuf->bufs, entry) {
243 bbcba3ed 2022-01-10 op if (i >= IOV_MAX)
244 bbcba3ed 2022-01-10 op break;
245 bbcba3ed 2022-01-10 op iov[i].iov_base = buf->buf + buf->rpos;
246 bbcba3ed 2022-01-10 op iov[i].iov_len = buf->wpos - buf->rpos;
247 bbcba3ed 2022-01-10 op i++;
248 bbcba3ed 2022-01-10 op if (buf->fd != -1)
249 bbcba3ed 2022-01-10 op break;
250 bbcba3ed 2022-01-10 op }
251 bbcba3ed 2022-01-10 op
252 bbcba3ed 2022-01-10 op msg.msg_iov = iov;
253 bbcba3ed 2022-01-10 op msg.msg_iovlen = i;
254 bbcba3ed 2022-01-10 op
255 bbcba3ed 2022-01-10 op if (buf != NULL && buf->fd != -1) {
256 bbcba3ed 2022-01-10 op msg.msg_control = (caddr_t)&cmsgbuf.buf;
257 bbcba3ed 2022-01-10 op msg.msg_controllen = sizeof(cmsgbuf.buf);
258 bbcba3ed 2022-01-10 op cmsg = CMSG_FIRSTHDR(&msg);
259 bbcba3ed 2022-01-10 op cmsg->cmsg_len = CMSG_LEN(sizeof(int));
260 bbcba3ed 2022-01-10 op cmsg->cmsg_level = SOL_SOCKET;
261 bbcba3ed 2022-01-10 op cmsg->cmsg_type = SCM_RIGHTS;
262 bbcba3ed 2022-01-10 op *(int *)CMSG_DATA(cmsg) = buf->fd;
263 bbcba3ed 2022-01-10 op }
264 bbcba3ed 2022-01-10 op
265 bbcba3ed 2022-01-10 op again:
266 bbcba3ed 2022-01-10 op if ((n = sendmsg(msgbuf->fd, &msg, 0)) == -1) {
267 bbcba3ed 2022-01-10 op if (errno == EINTR)
268 bbcba3ed 2022-01-10 op goto again;
269 bbcba3ed 2022-01-10 op if (errno == ENOBUFS)
270 bbcba3ed 2022-01-10 op errno = EAGAIN;
271 bbcba3ed 2022-01-10 op return (-1);
272 bbcba3ed 2022-01-10 op }
273 bbcba3ed 2022-01-10 op
274 bbcba3ed 2022-01-10 op if (n == 0) { /* connection closed */
275 bbcba3ed 2022-01-10 op errno = 0;
276 bbcba3ed 2022-01-10 op return (0);
277 bbcba3ed 2022-01-10 op }
278 bbcba3ed 2022-01-10 op
279 bbcba3ed 2022-01-10 op /*
280 bbcba3ed 2022-01-10 op * assumption: fd got sent if sendmsg sent anything
281 bbcba3ed 2022-01-10 op * this works because fds are passed one at a time
282 bbcba3ed 2022-01-10 op */
283 bbcba3ed 2022-01-10 op if (buf != NULL && buf->fd != -1) {
284 bbcba3ed 2022-01-10 op close(buf->fd);
285 bbcba3ed 2022-01-10 op buf->fd = -1;
286 bbcba3ed 2022-01-10 op }
287 bbcba3ed 2022-01-10 op
288 bbcba3ed 2022-01-10 op msgbuf_drain(msgbuf, n);
289 bbcba3ed 2022-01-10 op
290 bbcba3ed 2022-01-10 op return (1);
291 bbcba3ed 2022-01-10 op }
292 bbcba3ed 2022-01-10 op
293 bbcba3ed 2022-01-10 op static void
294 bbcba3ed 2022-01-10 op ibuf_enqueue(struct msgbuf *msgbuf, struct ibuf *buf)
295 bbcba3ed 2022-01-10 op {
296 bbcba3ed 2022-01-10 op TAILQ_INSERT_TAIL(&msgbuf->bufs, buf, entry);
297 bbcba3ed 2022-01-10 op msgbuf->queued++;
298 bbcba3ed 2022-01-10 op }
299 bbcba3ed 2022-01-10 op
300 bbcba3ed 2022-01-10 op static void
301 bbcba3ed 2022-01-10 op ibuf_dequeue(struct msgbuf *msgbuf, struct ibuf *buf)
302 bbcba3ed 2022-01-10 op {
303 bbcba3ed 2022-01-10 op TAILQ_REMOVE(&msgbuf->bufs, buf, entry);
304 bbcba3ed 2022-01-10 op
305 bbcba3ed 2022-01-10 op if (buf->fd != -1)
306 bbcba3ed 2022-01-10 op close(buf->fd);
307 bbcba3ed 2022-01-10 op
308 bbcba3ed 2022-01-10 op msgbuf->queued--;
309 bbcba3ed 2022-01-10 op ibuf_free(buf);
310 bbcba3ed 2022-01-10 op }