2 * Copyright (C) 2011 Felix Fietkau <nbd@openwrt.org>
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
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.
14 #include <sys/types.h>
16 #include <sys/socket.h>
20 #include <libubox/blob.h>
21 #include <libubox/blobmsg.h>
22 #include <libubox/usock.h>
27 #define STATIC_IOV(_var) { .iov_base = (char *) &(_var), .iov_len = sizeof(_var) }
29 const char *__ubus_strerror[__UBUS_STATUS_LAST] = {
30 [UBUS_STATUS_OK] = "Success",
31 [UBUS_STATUS_INVALID_COMMAND] = "Invalid command",
32 [UBUS_STATUS_INVALID_ARGUMENT] = "Invalid argument",
33 [UBUS_STATUS_METHOD_NOT_FOUND] = "Method not found",
34 [UBUS_STATUS_NOT_FOUND] = "Not found",
35 [UBUS_STATUS_NO_DATA] = "No response",
36 [UBUS_STATUS_PERMISSION_DENIED] = "Permission denied",
37 [UBUS_STATUS_TIMEOUT] = "Request timed out",
38 [UBUS_STATUS_NOT_SUPPORTED] = "Operation not supported",
41 static struct blob_buf b;
43 static const struct blob_attr_info ubus_policy[UBUS_ATTR_MAX] = {
44 [UBUS_ATTR_STATUS] = { .type = BLOB_ATTR_INT32 },
45 [UBUS_ATTR_OBJID] = { .type = BLOB_ATTR_INT32 },
46 [UBUS_ATTR_OBJPATH] = { .type = BLOB_ATTR_STRING },
47 [UBUS_ATTR_METHOD] = { .type = BLOB_ATTR_STRING },
49 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
51 struct ubus_pending_data {
52 struct list_head list;
54 struct blob_attr data[];
57 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
59 const uint32_t *id1 = k1, *id2 = k2;
67 static struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
69 blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
73 const char *ubus_strerror(int error)
77 if (error < 0 || error >= __UBUS_STATUS_LAST)
80 if (!__ubus_strerror[error])
83 return __ubus_strerror[error];
86 sprintf(err, "Unknown error: %d", error);
90 static int writev_retry(int fd, struct iovec *iov, int iov_len)
95 int cur_len = writev(fd, iov, iov_len);
99 /* turn off non-blocking mode */
100 fcntl(fd, F_SETFL, fcntl(fd, F_GETFL) &
111 while (cur_len >= iov->iov_len) {
112 cur_len -= iov->iov_len;
115 if (!cur_len || !iov_len)
118 iov->iov_len -= cur_len;
122 static int ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
123 struct blob_attr *msg, int cmd, uint32_t peer)
125 struct ubus_msghdr hdr;
126 struct iovec iov[2] = {
136 blob_buf_init(&b, 0);
140 iov[1].iov_base = (char *) msg;
141 iov[1].iov_len = blob_raw_len(msg);
143 return writev_retry(ctx->sock.fd, iov, ARRAY_SIZE(iov));
146 static int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
147 struct blob_attr *msg, int cmd, uint32_t peer)
149 memset(req, 0, sizeof(*req));
151 if (msg && blob_pad_len(msg) > UBUS_MAX_MSGLEN)
154 INIT_LIST_HEAD(&req->list);
155 INIT_LIST_HEAD(&req->pending);
158 req->seq = ++ctx->request_seq;
159 return ubus_send_msg(ctx, req->seq, msg, cmd, peer);
162 static bool recv_retry(int fd, struct iovec *iov, bool wait)
166 while (iov->iov_len > 0) {
167 bytes = read(fd, iov->iov_base, iov->iov_len);
182 iov->iov_len -= bytes;
183 iov->iov_base += bytes;
189 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
191 if (hdr->version != 0)
194 if (blob_raw_len(hdr->data) < sizeof(*hdr->data))
197 if (blob_pad_len(hdr->data) > UBUS_MAX_MSGLEN)
203 static bool get_next_msg(struct ubus_context *ctx)
205 struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
207 /* receive header + start attribute */
208 iov.iov_len += sizeof(struct blob_attr);
209 if (!recv_retry(ctx->sock.fd, &iov, false))
212 iov.iov_len = blob_len(ctx->msgbuf.hdr.data);
213 if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true))
216 return ubus_validate_hdr(&ctx->msgbuf.hdr);
219 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
221 ubus_parse_msg(hdr->data);
223 if (!attrbuf[UBUS_ATTR_STATUS])
226 *ret = blob_get_u32(attrbuf[UBUS_ATTR_STATUS]);
230 static void req_data_cb(struct ubus_request *req, int type, struct blob_attr *data)
232 struct blob_attr **attr;
234 if (req->raw_data_cb)
235 req->raw_data_cb(req, type, data);
240 attr = ubus_parse_msg(data);
241 req->data_cb(req, type, attr[UBUS_ATTR_DATA]);
244 static void ubus_process_req_data(struct ubus_request *req)
246 struct ubus_pending_data *data;
248 while (!list_empty(&req->pending)) {
249 data = list_first_entry(&req->pending,
250 struct ubus_pending_data, list);
251 list_del(&data->list);
253 req_data_cb(req, data->type, data->data);
258 static void ubus_req_complete_cb(struct ubus_request *req)
260 ubus_complete_handler_t cb = req->complete_cb;
265 req->complete_cb = NULL;
266 cb(req, req->status_code);
269 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
271 int ret = UBUS_STATUS_INVALID_ARGUMENT;
273 if (!list_empty(&req->list))
274 list_del(&req->list);
276 ubus_get_status(hdr, &ret);
277 req->peer = hdr->peer;
278 req->status_msg = true;
279 req->status_code = ret;
281 ubus_req_complete_cb(req);
286 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
288 struct ubus_pending_data *data;
293 req_data_cb(req, hdr->type, hdr->data);
294 ubus_process_req_data(req);
295 req->blocked = false;
298 ubus_req_complete_cb(req);
303 len = blob_raw_len(hdr->data);
304 data = calloc(1, sizeof(*data) + len);
308 data->type = hdr->type;
309 memcpy(data->data, hdr->data, len);
310 list_add(&data->list, &req->pending);
313 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
315 struct ubus_request *req;
317 list_for_each_entry(req, &ctx->requests, list) {
318 if (seq != req->seq || peer != req->peer)
326 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
328 struct ubus_request_data req;
329 struct ubus_object *obj;
334 ubus_parse_msg(hdr->data);
336 if (!attrbuf[UBUS_ATTR_OBJID])
339 objid = blob_get_u32(attrbuf[UBUS_ATTR_OBJID]);
341 if (!attrbuf[UBUS_ATTR_METHOD]) {
342 ret = UBUS_STATUS_INVALID_ARGUMENT;
346 obj = avl_find_element(&ctx->objects, &objid, obj, avl);
348 ret = UBUS_STATUS_NOT_FOUND;
352 for (method = 0; method < obj->n_methods; method++)
353 if (!obj->methods[method].name ||
354 !strcmp(obj->methods[method].name,
355 blob_data(attrbuf[UBUS_ATTR_METHOD])))
359 ret = UBUS_STATUS_METHOD_NOT_FOUND;
364 req.peer = hdr->peer;
366 ret = obj->methods[method].handler(ctx, obj, &req,
367 blob_data(attrbuf[UBUS_ATTR_METHOD]),
368 attrbuf[UBUS_ATTR_DATA]);
371 blob_buf_init(&b, 0);
372 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
373 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
374 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
377 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
379 struct ubus_request *req;
382 case UBUS_MSG_STATUS:
383 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
387 ubus_process_req_status(req, hdr);
391 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
392 if (req && (req->data_cb || req->raw_data_cb))
393 ubus_req_data(req, hdr);
396 case UBUS_MSG_INVOKE:
397 ubus_process_invoke(ctx, hdr);
402 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
404 if (!list_empty(&req->list))
407 req->cancelled = true;
408 ubus_process_req_data(req);
409 list_del(&req->list);
412 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
414 if (!list_empty(&req->list))
417 list_add(&req->list, &ctx->requests);
420 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
422 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
423 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
425 while (get_next_msg(ctx)) {
426 ubus_process_msg(ctx, hdr);
432 ctx->connection_lost(ctx);
435 static void ubus_sync_req_cb(struct ubus_request *req, int ret)
437 req->status_msg = true;
438 req->status_code = ret;
442 struct ubus_sync_req_cb {
443 struct uloop_timeout timeout;
444 struct ubus_request *req;
447 static void ubus_sync_req_timeout_cb(struct uloop_timeout *timeout)
449 struct ubus_sync_req_cb *cb;
451 cb = container_of(timeout, struct ubus_sync_req_cb, timeout);
452 ubus_sync_req_cb(cb->req, UBUS_STATUS_TIMEOUT);
455 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
458 struct ubus_sync_req_cb cb;
459 ubus_complete_handler_t complete_cb = req->complete_cb;
460 bool registered = ctx->sock.registered;
461 bool cancelled = uloop_cancelled;
462 int status = UBUS_STATUS_NO_DATA;
470 memset(&cb, 0, sizeof(cb));
472 cb.timeout.cb = ubus_sync_req_timeout_cb;
473 uloop_timeout_set(&cb.timeout, timeout);
476 ubus_complete_request_async(ctx, req);
477 req->complete_cb = ubus_sync_req_cb;
482 uloop_timeout_cancel(&cb.timeout);
485 status = req->status_code;
487 req->complete_cb = complete_cb;
488 if (req->complete_cb)
489 req->complete_cb(req, status);
491 uloop_cancelled = cancelled;
493 uloop_fd_delete(&ctx->sock);
498 struct ubus_lookup_request {
499 struct ubus_request req;
500 ubus_lookup_handler_t cb;
503 static void ubus_lookup_cb(struct ubus_request *ureq, int type, struct blob_attr *msg)
505 struct ubus_lookup_request *req;
506 struct ubus_object_data obj;
507 struct blob_attr **attr;
509 req = container_of(ureq, struct ubus_lookup_request, req);
510 attr = ubus_parse_msg(msg);
512 if (!attr[UBUS_ATTR_OBJID] || !attr[UBUS_ATTR_OBJPATH] ||
513 !attr[UBUS_ATTR_OBJTYPE])
516 memset(&obj, 0, sizeof(obj));
517 obj.id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
518 obj.path = blob_data(attr[UBUS_ATTR_OBJPATH]);
519 obj.type_id = blob_get_u32(attr[UBUS_ATTR_OBJTYPE]);
520 obj.signature = attr[UBUS_ATTR_SIGNATURE];
521 req->cb(ureq->ctx, &obj, ureq->priv);
524 int ubus_lookup(struct ubus_context *ctx, const char *path,
525 ubus_lookup_handler_t cb, void *priv)
527 struct ubus_lookup_request lookup;
529 blob_buf_init(&b, 0);
531 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
533 if (ubus_start_request(ctx, &lookup.req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
534 return UBUS_STATUS_INVALID_ARGUMENT;
536 lookup.req.raw_data_cb = ubus_lookup_cb;
537 lookup.req.priv = priv;
539 return ubus_complete_request(ctx, &lookup.req, 0);
542 static void ubus_lookup_id_cb(struct ubus_request *req, int type, struct blob_attr *msg)
544 struct blob_attr **attr;
545 uint32_t *id = req->priv;
547 attr = ubus_parse_msg(msg);
549 if (!attr[UBUS_ATTR_OBJID])
552 *id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
555 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id)
557 struct ubus_request req;
559 blob_buf_init(&b, 0);
561 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
563 if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
564 return UBUS_STATUS_INVALID_ARGUMENT;
566 req.raw_data_cb = ubus_lookup_id_cb;
569 return ubus_complete_request(ctx, &req, 0);
572 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
573 struct blob_attr *msg)
577 blob_buf_init(&b, 0);
578 blob_put_int32(&b, UBUS_ATTR_OBJID, req->object);
579 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
580 ret = ubus_send_msg(ctx, req->seq, b.head, UBUS_MSG_DATA, req->peer);
582 return UBUS_STATUS_NO_DATA;
587 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
588 struct blob_attr *msg, struct ubus_request *req)
590 blob_buf_init(&b, 0);
591 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
592 blob_put_string(&b, UBUS_ATTR_METHOD, method);
594 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
596 if (ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj) < 0)
597 return UBUS_STATUS_INVALID_ARGUMENT;
602 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
603 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
606 struct ubus_request req;
608 ubus_invoke_async(ctx, obj, method, msg, &req);
611 return ubus_complete_request(ctx, &req, timeout);
614 static void ubus_add_object_cb(struct ubus_request *req, int type, struct blob_attr *msg)
616 struct ubus_object *obj = req->priv;
620 if (!attrbuf[UBUS_ATTR_OBJID])
623 obj->id = blob_get_u32(attrbuf[UBUS_ATTR_OBJID]);
625 if (attrbuf[UBUS_ATTR_OBJTYPE])
626 obj->type->id = blob_get_u32(attrbuf[UBUS_ATTR_OBJTYPE]);
628 obj->avl.key = &obj->id;
629 avl_insert(&req->ctx->objects, &obj->avl);
632 static void ubus_push_method_data(const struct ubus_method *m)
637 mtbl = blobmsg_open_table(&b, m->name);
639 for (i = 0; i < m->n_policy; i++)
640 blobmsg_add_u32(&b, m->policy[i].name, m->policy[i].type);
642 blobmsg_close_table(&b, mtbl);
645 static bool ubus_push_object_type(const struct ubus_object_type *type)
650 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
652 for (i = 0; i < type->n_methods; i++)
653 ubus_push_method_data(&type->methods[i]);
655 blob_nest_end(&b, s);
660 static int __ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj)
662 struct ubus_request req;
665 blob_buf_init(&b, 0);
667 if (obj->name && obj->type) {
668 blob_put_string(&b, UBUS_ATTR_OBJPATH, obj->name);
671 blob_put_int32(&b, UBUS_ATTR_OBJTYPE, obj->type->id);
672 else if (!ubus_push_object_type(obj->type))
673 return UBUS_STATUS_INVALID_ARGUMENT;
676 if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_ADD_OBJECT, 0) < 0)
677 return UBUS_STATUS_INVALID_ARGUMENT;
679 req.raw_data_cb = ubus_add_object_cb;
681 ret = ubus_complete_request(ctx, &req, 0);
686 return UBUS_STATUS_NO_DATA;
691 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj)
693 if (!obj->name || !obj->type)
694 return UBUS_STATUS_INVALID_ARGUMENT;
696 return __ubus_add_object(ctx, obj);
699 static void ubus_remove_object_cb(struct ubus_request *req, int type, struct blob_attr *msg)
701 struct ubus_object *obj = req->priv;
705 if (!attrbuf[UBUS_ATTR_OBJID])
710 if (attrbuf[UBUS_ATTR_OBJTYPE] && obj->type)
713 avl_delete(&req->ctx->objects, &obj->avl);
716 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj)
718 struct ubus_request req;
721 blob_buf_init(&b, 0);
722 blob_put_int32(&b, UBUS_ATTR_OBJID, obj->id);
724 if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_REMOVE_OBJECT, 0) < 0)
725 return UBUS_STATUS_INVALID_ARGUMENT;
727 req.raw_data_cb = ubus_remove_object_cb;
729 ret = ubus_complete_request(ctx, &req, 0);
734 return UBUS_STATUS_NO_DATA;
739 static int ubus_event_cb(struct ubus_context *ctx, struct ubus_object *obj,
740 struct ubus_request_data *req,
741 const char *method, struct blob_attr *msg)
743 struct ubus_event_handler *ev;
745 ev = container_of(obj, struct ubus_event_handler, obj);
746 ev->cb(ctx, ev, method, msg);
750 static const struct ubus_method event_method = {
752 .handler = ubus_event_cb,
755 int ubus_register_event_handler(struct ubus_context *ctx,
756 struct ubus_event_handler *ev,
759 struct ubus_object *obj = &ev->obj;
764 obj->methods = &event_method;
767 if (!!obj->name ^ !!obj->type)
768 return UBUS_STATUS_INVALID_ARGUMENT;
770 ret = __ubus_add_object(ctx, obj);
775 /* use a second buffer, ubus_invoke() overwrites the primary one */
776 memset(&b2, 0, sizeof(b2));
777 blob_buf_init(&b2, 0);
778 blobmsg_add_u32(&b2, "object", obj->id);
780 blobmsg_add_string(&b2, "pattern", pattern);
782 return ubus_invoke(ctx, UBUS_SYSTEM_OBJECT_EVENT, "register", b2.head,
786 int ubus_send_event(struct ubus_context *ctx, const char *id,
787 struct blob_attr *data)
789 struct ubus_request req;
792 blob_buf_init(&b, 0);
793 blob_put_int32(&b, UBUS_ATTR_OBJID, UBUS_SYSTEM_OBJECT_EVENT);
794 blob_put_string(&b, UBUS_ATTR_METHOD, "send");
795 s = blob_nest_start(&b, UBUS_ATTR_DATA);
796 blobmsg_add_string(&b, "id", id);
797 blobmsg_add_field(&b, BLOBMSG_TYPE_TABLE, "data", blob_data(data), blob_len(data));
798 blob_nest_end(&b, s);
800 if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_INVOKE, UBUS_SYSTEM_OBJECT_EVENT) < 0)
801 return UBUS_STATUS_INVALID_ARGUMENT;
803 return ubus_complete_request(ctx, &req, 0);
806 static void ubus_default_connection_lost(struct ubus_context *ctx)
808 if (ctx->sock.registered)
812 struct ubus_context *ubus_connect(const char *path)
814 struct ubus_context *ctx;
816 struct ubus_msghdr hdr;
817 struct blob_attr data;
819 struct blob_attr *buf;
822 path = UBUS_UNIX_SOCKET;
824 ctx = calloc(1, sizeof(*ctx));
828 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
829 if (ctx->sock.fd < 0)
832 ctx->sock.cb = ubus_handle_data;
834 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr))
837 if (!ubus_validate_hdr(&hdr.hdr))
840 if (hdr.hdr.type != UBUS_MSG_HELLO)
843 buf = calloc(1, blob_raw_len(&hdr.data));
847 memcpy(buf, &hdr.data, sizeof(hdr.data));
848 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf))
851 ctx->local_id = hdr.hdr.peer;
854 ctx->connection_lost = ubus_default_connection_lost;
856 INIT_LIST_HEAD(&ctx->requests);
857 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
874 void ubus_free(struct ubus_context *ctx)