3 #include <sys/socket.h>
6 #include <libubox/blob.h>
7 #include <libubox/blobmsg.h>
8 #include <libubox/usock.h>
16 #define DPRINTF(_format, ...) fprintf(stderr, "ubus: " _format, ## __VA_ARGS__)
18 #define DPRINTF(...) do {} while(0)
21 #define STATIC_IOV(_var) { .iov_base = (char *) &(_var), .iov_len = sizeof(_var) }
23 const char *__ubus_strerror[__UBUS_STATUS_LAST] = {
24 [UBUS_STATUS_OK] = "Success",
25 [UBUS_STATUS_INVALID_COMMAND] = "Invalid command",
26 [UBUS_STATUS_INVALID_ARGUMENT] = "Invalid argument",
27 [UBUS_STATUS_METHOD_NOT_FOUND] = "Method not found",
28 [UBUS_STATUS_NOT_FOUND] = "Not found",
29 [UBUS_STATUS_NO_DATA] = "No response",
30 [UBUS_STATUS_PERMISSION_DENIED] = "Permission denied",
33 static struct blob_buf b;
35 static const struct blob_attr_info ubus_policy[UBUS_ATTR_MAX] = {
36 [UBUS_ATTR_STATUS] = { .type = BLOB_ATTR_INT32 },
37 [UBUS_ATTR_OBJID] = { .type = BLOB_ATTR_INT32 },
38 [UBUS_ATTR_OBJPATH] = { .type = BLOB_ATTR_STRING },
39 [UBUS_ATTR_METHOD] = { .type = BLOB_ATTR_STRING },
41 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
43 struct ubus_pending_data {
44 struct list_head list;
46 struct blob_attr data[];
49 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
51 const uint32_t *id1 = k1, *id2 = k2;
59 static struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
61 blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
65 const char *ubus_strerror(int error)
69 if (error < 0 || error >= __UBUS_STATUS_LAST)
72 if (!__ubus_strerror[error])
75 return __ubus_strerror[error];
78 sprintf(err, "Unknown error: %d", error);
82 static int ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
83 struct blob_attr *msg, int cmd, uint32_t peer)
85 struct ubus_msghdr hdr;
86 struct iovec iov[2] = {
100 iov[1].iov_base = (char *) msg;
101 iov[1].iov_len = blob_raw_len(msg);
103 return writev(ctx->sock.fd, iov, 2);
106 static int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
107 struct blob_attr *msg, int cmd, uint32_t peer)
109 memset(req, 0, sizeof(*req));
111 INIT_LIST_HEAD(&req->list);
112 INIT_LIST_HEAD(&req->pending);
115 req->seq = ++ctx->request_seq;
116 return ubus_send_msg(ctx, req->seq, msg, cmd, peer);
119 static bool recv_retry(int fd, struct iovec *iov, bool wait)
123 while (iov->iov_len > 0) {
124 bytes = read(fd, iov->iov_base, iov->iov_len);
130 if (errno != EAGAIN) {
139 iov->iov_len -= bytes;
140 iov->iov_base += bytes;
146 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
148 if (hdr->version != 0)
151 if (blob_raw_len(hdr->data) < sizeof(*hdr->data))
154 if (blob_raw_len(hdr->data) + sizeof(*hdr) > UBUS_MAX_MSGLEN)
160 static bool get_next_msg(struct ubus_context *ctx, bool wait)
162 struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
164 /* receive header + start attribute */
165 iov.iov_len += sizeof(struct blob_attr);
166 if (!recv_retry(ctx->sock.fd, &iov, wait))
169 iov.iov_len = blob_len(ctx->msgbuf.hdr.data);
170 if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true))
173 return ubus_validate_hdr(&ctx->msgbuf.hdr);
176 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
178 ubus_parse_msg(hdr->data);
180 if (!attrbuf[UBUS_ATTR_STATUS])
183 *ret = blob_get_int32(attrbuf[UBUS_ATTR_STATUS]);
187 static void req_data_cb(struct ubus_request *req, int type, struct blob_attr *data)
189 struct blob_attr **attr;
191 if (req->raw_data_cb)
192 req->raw_data_cb(req, type, data);
197 attr = ubus_parse_msg(data);
198 req->data_cb(req, type, attr[UBUS_ATTR_DATA]);
201 static void ubus_process_req_data(struct ubus_request *req)
203 struct ubus_pending_data *data;
205 while (!list_empty(&req->pending)) {
206 data = list_first_entry(&req->pending,
207 struct ubus_pending_data, list);
208 list_del(&data->list);
210 req_data_cb(req, data->type, data->data);
215 static void ubus_req_complete_cb(struct ubus_request *req)
217 ubus_complete_handler_t cb = req->complete_cb;
222 req->complete_cb = NULL;
223 cb(req, req->status_code);
226 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
228 int ret = UBUS_STATUS_INVALID_ARGUMENT;
230 if (!list_empty(&req->list))
231 list_del(&req->list);
233 ubus_get_status(hdr, &ret);
234 req->peer = hdr->peer;
235 req->status_msg = true;
236 req->status_code = ret;
238 ubus_req_complete_cb(req);
243 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
245 struct ubus_pending_data *data;
250 req_data_cb(req, hdr->type, hdr->data);
251 ubus_process_req_data(req);
252 req->blocked = false;
255 ubus_req_complete_cb(req);
260 len = blob_raw_len(hdr->data);
261 data = calloc(1, sizeof(*data) + len);
265 data->type = hdr->type;
266 memcpy(data->data, hdr->data, len);
267 list_add(&data->list, &req->pending);
270 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
272 struct ubus_request *req;
274 list_for_each_entry(req, &ctx->requests, list) {
275 if (seq != req->seq || peer != req->peer)
283 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
285 struct ubus_request_data req;
286 struct ubus_object *obj;
291 ubus_parse_msg(hdr->data);
293 if (!attrbuf[UBUS_ATTR_OBJID])
296 objid = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
298 if (!attrbuf[UBUS_ATTR_METHOD]) {
299 ret = UBUS_STATUS_INVALID_ARGUMENT;
303 obj = avl_find_element(&ctx->objects, &objid, obj, avl);
305 ret = UBUS_STATUS_NOT_FOUND;
309 for (method = 0; method < obj->n_methods; method++)
310 if (!strcmp(obj->methods[method].name,
311 blob_data(attrbuf[UBUS_ATTR_METHOD])))
315 ret = UBUS_STATUS_METHOD_NOT_FOUND;
320 req.peer = hdr->peer;
322 ret = obj->methods[method].handler(ctx, obj, &req,
323 obj->methods[method].name,
324 attrbuf[UBUS_ATTR_DATA]);
327 blob_buf_init(&b, 0);
328 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
329 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
330 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
333 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
335 struct ubus_request *req;
338 case UBUS_MSG_STATUS:
339 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
343 ubus_process_req_status(req, hdr);
347 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
348 if (req && (req->data_cb || req->raw_data_cb))
349 ubus_req_data(req, hdr);
352 case UBUS_MSG_INVOKE:
353 ubus_process_invoke(ctx, hdr);
356 DPRINTF("unknown message type: %d\n", hdr->type);
361 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
363 if (!list_empty(&req->list))
366 req->cancelled = true;
367 ubus_process_req_data(req);
368 list_del(&req->list);
371 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
373 if (!list_empty(&req->list))
376 list_add(&req->list, &ctx->requests);
379 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
381 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
382 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
384 while (get_next_msg(ctx, false))
385 ubus_process_msg(ctx, hdr);
388 ctx->connection_lost(ctx);
391 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req)
393 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
395 if (!list_empty(&req->list))
396 list_del(&req->list);
400 return req->status_code;
403 return UBUS_STATUS_NO_DATA;
405 if (!get_next_msg(ctx, true))
406 return UBUS_STATUS_NO_DATA;
408 if (hdr->seq != req->seq || hdr->peer != req->peer)
412 case UBUS_MSG_STATUS:
413 return ubus_process_req_status(req, hdr);
415 if (req->data_cb || req->raw_data_cb)
416 ubus_req_data(req, hdr);
423 ubus_process_msg(ctx, hdr);
427 struct ubus_lookup_request {
428 struct ubus_request req;
429 ubus_lookup_handler_t cb;
432 static void ubus_lookup_cb(struct ubus_request *ureq, int type, struct blob_attr *msg)
434 struct ubus_lookup_request *req;
435 struct ubus_object_data obj;
436 struct blob_attr **attr;
438 req = container_of(ureq, struct ubus_lookup_request, req);
439 attr = ubus_parse_msg(msg);
441 if (!attr[UBUS_ATTR_OBJID] || !attr[UBUS_ATTR_OBJPATH] ||
442 !attr[UBUS_ATTR_OBJTYPE])
445 memset(&obj, 0, sizeof(obj));
446 obj.id = blob_get_int32(attr[UBUS_ATTR_OBJID]);
447 obj.path = blob_data(attr[UBUS_ATTR_OBJPATH]);
448 obj.type_id = blob_get_int32(attr[UBUS_ATTR_OBJTYPE]);
449 obj.signature = attr[UBUS_ATTR_SIGNATURE];
450 req->cb(ureq->ctx, &obj, ureq->priv);
453 int ubus_lookup(struct ubus_context *ctx, const char *path,
454 ubus_lookup_handler_t cb, void *priv)
456 struct ubus_lookup_request lookup;
458 blob_buf_init(&b, 0);
460 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
461 ubus_start_request(ctx, &lookup.req, b.head, UBUS_MSG_LOOKUP, 0);
462 lookup.req.raw_data_cb = ubus_lookup_cb;
463 lookup.req.priv = priv;
465 return ubus_complete_request(ctx, &lookup.req);
468 static void ubus_lookup_id_cb(struct ubus_request *req, int type, struct blob_attr *msg)
470 struct blob_attr **attr;
471 uint32_t *id = req->priv;
473 attr = ubus_parse_msg(msg);
475 if (!attr[UBUS_ATTR_OBJID])
478 *id = blob_get_int32(attr[UBUS_ATTR_OBJID]);
481 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id)
483 struct ubus_request req;
485 blob_buf_init(&b, 0);
487 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
488 ubus_start_request(ctx, &req, b.head, UBUS_MSG_LOOKUP, 0);
489 req.raw_data_cb = ubus_lookup_id_cb;
492 return ubus_complete_request(ctx, &req);
495 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
496 struct blob_attr *msg)
500 blob_buf_init(&b, 0);
501 blob_put_int32(&b, UBUS_ATTR_OBJID, req->object);
502 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
503 ret = ubus_send_msg(ctx, req->seq, b.head, UBUS_MSG_DATA, req->peer);
505 return UBUS_STATUS_NO_DATA;
510 void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
511 struct blob_attr *msg, struct ubus_request *req)
513 blob_buf_init(&b, 0);
514 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
515 blob_put_string(&b, UBUS_ATTR_METHOD, method);
517 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
519 ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj);
522 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
523 struct blob_attr *msg, ubus_data_handler_t cb, void *priv)
525 struct ubus_request req;
527 ubus_invoke_async(ctx, obj, method, msg, &req);
530 return ubus_complete_request(ctx, &req);
533 static void ubus_publish_cb(struct ubus_request *req, int type, struct blob_attr *msg)
535 struct ubus_object *obj = req->priv;
539 if (!attrbuf[UBUS_ATTR_OBJID])
542 obj->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
544 if (attrbuf[UBUS_ATTR_OBJTYPE])
545 obj->type->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJTYPE]);
547 obj->avl.key = &obj->id;
548 avl_insert(&req->ctx->objects, &obj->avl);
551 static bool ubus_push_table_data(const struct ubus_signature **sig, int *rem, bool array)
553 const struct ubus_signature *cur;
561 case UBUS_SIGNATURE_END:
563 case BLOBMSG_TYPE_INT32:
564 case BLOBMSG_TYPE_STRING:
565 blobmsg_add_u32(&b, cur->name, cur->type);
567 case BLOBMSG_TYPE_TABLE:
568 case BLOBMSG_TYPE_ARRAY:
569 nest_type = cur->type == BLOBMSG_TYPE_ARRAY;
570 nest = blobmsg_open_nested(&b, cur->name, nest_type);
571 if (!ubus_push_table_data(sig, rem, nest_type))
573 blobmsg_close_table(&b, nest);
584 static bool ubus_push_object_type(struct ubus_object_type *type)
587 int rem = type->n_signature;
588 const struct ubus_signature *sig = type->signature;
590 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
592 if (sig->type != UBUS_SIGNATURE_METHOD)
595 m = blobmsg_open_table(&b, sig->name);
599 if (!ubus_push_table_data(&sig, &rem, false))
602 blobmsg_close_table(&b, m);
604 blob_nest_end(&b, s);
609 static int __ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
611 struct ubus_request req;
614 blob_buf_init(&b, 0);
616 if (obj->name && obj->type) {
617 blob_put_string(&b, UBUS_ATTR_OBJPATH, obj->name);
620 blob_put_int32(&b, UBUS_ATTR_OBJTYPE, obj->type->id);
621 else if (!ubus_push_object_type(obj->type))
622 return UBUS_STATUS_INVALID_ARGUMENT;
625 ubus_start_request(ctx, &req, b.head, UBUS_MSG_PUBLISH, 0);
626 req.raw_data_cb = ubus_publish_cb;
628 ret = ubus_complete_request(ctx, &req);
633 return UBUS_STATUS_NO_DATA;
638 int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
640 if (!obj->name || !obj->type)
641 return UBUS_STATUS_INVALID_ARGUMENT;
643 return __ubus_publish(ctx, obj);
646 int ubus_register_event_handler(struct ubus_context *ctx, struct ubus_object *obj,
653 if (!!obj->name ^ !!obj->type)
654 return UBUS_STATUS_INVALID_ARGUMENT;
656 ret = __ubus_publish(ctx, obj);
661 /* use a second buffer, ubus_invoke() overwrites the primary one */
662 memset(&b2, 0, sizeof(b2));
663 blob_buf_init(&b2, 0);
664 blobmsg_add_u32(&b2, "object", obj->id);
666 blobmsg_add_string(&b2, "pattern", pattern);
668 ret = ubus_invoke(ctx, UBUS_SYSTEM_OBJECT_EVENT, "register", b2.head,
675 void ubus_default_connection_lost(struct ubus_context *ctx)
677 if (ctx->sock.registered)
681 struct ubus_context *ubus_connect(const char *path)
683 struct ubus_context *ctx;
685 struct ubus_msghdr hdr;
686 struct blob_attr data;
688 struct blob_attr *buf;
691 path = UBUS_UNIX_SOCKET;
693 ctx = calloc(1, sizeof(*ctx));
697 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
698 if (ctx->sock.fd < 0)
701 ctx->sock.cb = ubus_handle_data;
703 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr))
706 if (!ubus_validate_hdr(&hdr.hdr))
709 if (hdr.hdr.type != UBUS_MSG_HELLO)
712 buf = calloc(1, blob_raw_len(&hdr.data));
716 memcpy(buf, &hdr.data, sizeof(hdr.data));
717 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf))
720 ctx->local_id = hdr.hdr.peer;
723 ctx->connection_lost = ubus_default_connection_lost;
725 INIT_LIST_HEAD(&ctx->requests);
726 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
743 void ubus_free(struct ubus_context *ctx)