libubus: implement file descriptor passing support
[project/ubus.git] / libubus-io.c
1 /*
2  * Copyright (C) 2011-2014 Felix Fietkau <nbd@openwrt.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 2.1
6  * as published by the Free Software Foundation
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  */
13
14 #include <sys/types.h>
15 #include <sys/uio.h>
16 #include <sys/socket.h>
17
18 #include <unistd.h>
19 #include <fcntl.h>
20 #include <poll.h>
21
22 #include <libubox/usock.h>
23 #include <libubox/blob.h>
24 #include <libubox/blobmsg.h>
25
26 #include "libubus.h"
27 #include "libubus-internal.h"
28
29 #define STATIC_IOV(_var) { .iov_base = (char *) &(_var), .iov_len = sizeof(_var) }
30
31 static const struct blob_attr_info ubus_policy[UBUS_ATTR_MAX] = {
32         [UBUS_ATTR_STATUS] = { .type = BLOB_ATTR_INT32 },
33         [UBUS_ATTR_OBJID] = { .type = BLOB_ATTR_INT32 },
34         [UBUS_ATTR_OBJPATH] = { .type = BLOB_ATTR_STRING },
35         [UBUS_ATTR_METHOD] = { .type = BLOB_ATTR_STRING },
36         [UBUS_ATTR_ACTIVE] = { .type = BLOB_ATTR_INT8 },
37         [UBUS_ATTR_NO_REPLY] = { .type = BLOB_ATTR_INT8 },
38         [UBUS_ATTR_SUBSCRIBERS] = { .type = BLOB_ATTR_NESTED },
39 };
40
41 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
42
43 __hidden struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
44 {
45         blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
46         return attrbuf;
47 }
48
49 static void wait_data(int fd, bool write)
50 {
51         struct pollfd pfd = { .fd = fd };
52
53         pfd.events = write ? POLLOUT : POLLIN;
54         poll(&pfd, 1, 0);
55 }
56
57 static int writev_retry(int fd, struct iovec *iov, int iov_len, int sock_fd)
58 {
59         static struct {
60                 struct cmsghdr h;
61                 int fd;
62         } fd_buf = {
63                 .h = {
64                         .cmsg_len = sizeof(fd_buf),
65                         .cmsg_level = SOL_SOCKET,
66                         .cmsg_type = SCM_RIGHTS,
67                 }
68         };
69         struct msghdr msghdr = {
70                 .msg_iov = iov,
71                 .msg_iovlen = iov_len,
72                 .msg_control = &fd_buf,
73                 .msg_controllen = sizeof(fd_buf),
74         };
75         int len = 0;
76
77         do {
78                 int cur_len;
79
80                 if (sock_fd < 0) {
81                         msghdr.msg_control = NULL;
82                         msghdr.msg_controllen = 0;
83                 } else {
84                         fd_buf.fd = sock_fd;
85                 }
86
87                 cur_len = sendmsg(fd, &msghdr, 0);
88                 if (cur_len < 0) {
89                         switch(errno) {
90                         case EAGAIN:
91                                 wait_data(fd, true);
92                                 break;
93                         case EINTR:
94                                 break;
95                         default:
96                                 return -1;
97                         }
98                         continue;
99                 }
100
101                 if (len > 0)
102                         sock_fd = -1;
103
104                 len += cur_len;
105                 while (cur_len >= iov->iov_len) {
106                         cur_len -= iov->iov_len;
107                         iov_len--;
108                         iov++;
109                         if (!iov_len)
110                                 return len;
111                 }
112                 iov->iov_len -= cur_len;
113         } while (1);
114
115         /* Should never reach here */
116         return -1;
117 }
118
119 int __hidden ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
120                            struct blob_attr *msg, int cmd, uint32_t peer, int fd)
121 {
122         struct ubus_msghdr hdr;
123         struct iovec iov[2] = {
124                 STATIC_IOV(hdr)
125         };
126         int ret;
127
128         hdr.version = 0;
129         hdr.type = cmd;
130         hdr.seq = seq;
131         hdr.peer = peer;
132
133         if (!msg) {
134                 blob_buf_init(&b, 0);
135                 msg = b.head;
136         }
137
138         iov[1].iov_base = (char *) msg;
139         iov[1].iov_len = blob_raw_len(msg);
140
141         ret = writev_retry(ctx->sock.fd, iov, ARRAY_SIZE(iov), fd);
142         if (ret < 0)
143                 ctx->sock.eof = true;
144
145         return ret;
146 }
147
148 static int recv_retry(int fd, struct iovec *iov, bool wait, int *recv_fd)
149 {
150         int bytes, total = 0;
151         static struct {
152                 struct cmsghdr h;
153                 int fd;
154         } fd_buf = {
155                 .h = {
156                         .cmsg_type = SCM_RIGHTS,
157                         .cmsg_level = SOL_SOCKET,
158                         .cmsg_len = sizeof(fd_buf),
159                 },
160         };
161         struct msghdr msghdr = {
162                 .msg_iov = iov,
163                 .msg_iovlen = 1,
164         };
165
166         while (iov->iov_len > 0) {
167                 if (wait)
168                         wait_data(fd, false);
169
170                 if (recv_fd) {
171                         msghdr.msg_control = &fd_buf;
172                         msghdr.msg_controllen = sizeof(fd_buf);
173                 } else {
174                         msghdr.msg_control = NULL;
175                         msghdr.msg_controllen = 0;
176                 }
177
178                 fd_buf.fd = -1;
179                 bytes = recvmsg(fd, &msghdr, 0);
180                 if (!bytes)
181                         return -1;
182
183                 if (bytes < 0) {
184                         bytes = 0;
185                         if (uloop_cancelled)
186                                 return 0;
187                         if (errno == EINTR)
188                                 continue;
189
190                         if (errno != EAGAIN)
191                                 return -1;
192                 }
193                 if (!wait && !bytes)
194                         return 0;
195
196                 if (recv_fd)
197                         *recv_fd = fd_buf.fd;
198
199                 recv_fd = NULL;
200
201                 wait = true;
202                 iov->iov_len -= bytes;
203                 iov->iov_base += bytes;
204                 total += bytes;
205         }
206
207         return total;
208 }
209
210 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
211 {
212         struct blob_attr *data = ubus_msghdr_data(hdr);
213
214         if (hdr->version != 0)
215                 return false;
216
217         if (blob_raw_len(data) < sizeof(*data))
218                 return false;
219
220         if (blob_pad_len(data) > UBUS_MAX_MSGLEN)
221                 return false;
222
223         return true;
224 }
225
226 static bool get_next_msg(struct ubus_context *ctx, int *recv_fd)
227 {
228         struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
229         int r;
230
231         /* receive header + start attribute */
232         iov.iov_len += sizeof(struct blob_attr);
233         r = recv_retry(ctx->sock.fd, &iov, false, recv_fd);
234         if (r <= 0) {
235                 if (r < 0)
236                         ctx->sock.eof = true;
237
238                 return false;
239         }
240
241         iov.iov_len = blob_len(ubus_msghdr_data(&ctx->msgbuf.hdr));
242         if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true, NULL))
243                 return false;
244
245         return ubus_validate_hdr(&ctx->msgbuf.hdr);
246 }
247
248 void __hidden ubus_handle_data(struct uloop_fd *u, unsigned int events)
249 {
250         struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
251         struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
252         int recv_fd = -1;
253
254         while (get_next_msg(ctx, &recv_fd)) {
255                 ubus_process_msg(ctx, hdr, recv_fd);
256                 if (uloop_cancelled)
257                         break;
258         }
259
260         if (u->eof)
261                 ctx->connection_lost(ctx);
262 }
263
264 static void
265 ubus_refresh_state(struct ubus_context *ctx)
266 {
267         struct ubus_object *obj, *tmp;
268         struct ubus_object **objs;
269         int n, i = 0;
270
271         /* clear all type IDs, they need to be registered again */
272         avl_for_each_element(&ctx->objects, obj, avl)
273                 if (obj->type)
274                         obj->type->id = 0;
275
276         /* push out all objects again */
277         objs = alloca(ctx->objects.count * sizeof(*objs));
278         avl_remove_all_elements(&ctx->objects, obj, avl, tmp) {
279                 objs[i++] = obj;
280                 obj->id = 0;
281         }
282
283         for (n = i, i = 0; i < n; i++)
284                 ubus_add_object(ctx, objs[i]);
285 }
286
287 int ubus_reconnect(struct ubus_context *ctx, const char *path)
288 {
289         struct {
290                 struct ubus_msghdr hdr;
291                 struct blob_attr data;
292         } hdr;
293         struct blob_attr *buf;
294         int ret = UBUS_STATUS_UNKNOWN_ERROR;
295
296         if (!path)
297                 path = UBUS_UNIX_SOCKET;
298
299         if (ctx->sock.fd >= 0) {
300                 if (ctx->sock.registered)
301                         uloop_fd_delete(&ctx->sock);
302
303                 close(ctx->sock.fd);
304         }
305
306         ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
307         if (ctx->sock.fd < 0)
308                 return UBUS_STATUS_CONNECTION_FAILED;
309
310         if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr))
311                 goto out_close;
312
313         if (!ubus_validate_hdr(&hdr.hdr))
314                 goto out_close;
315
316         if (hdr.hdr.type != UBUS_MSG_HELLO)
317                 goto out_close;
318
319         buf = calloc(1, blob_raw_len(&hdr.data));
320         if (!buf)
321                 goto out_close;
322
323         memcpy(buf, &hdr.data, sizeof(hdr.data));
324         if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf))
325                 goto out_free;
326
327         ctx->local_id = hdr.hdr.peer;
328         if (!ctx->local_id)
329                 goto out_free;
330
331         ret = UBUS_STATUS_OK;
332         fcntl(ctx->sock.fd, F_SETFL, fcntl(ctx->sock.fd, F_GETFL) | O_NONBLOCK);
333
334         ubus_refresh_state(ctx);
335
336 out_free:
337         free(buf);
338 out_close:
339         if (ret)
340                 close(ctx->sock.fd);
341
342         return ret;
343 }