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",
32 static struct blob_buf b;
34 static const struct blob_attr_info ubus_policy[UBUS_ATTR_MAX] = {
35 [UBUS_ATTR_STATUS] = { .type = BLOB_ATTR_INT32 },
36 [UBUS_ATTR_OBJID] = { .type = BLOB_ATTR_INT32 },
37 [UBUS_ATTR_OBJPATH] = { .type = BLOB_ATTR_STRING },
38 [UBUS_ATTR_METHOD] = { .type = BLOB_ATTR_STRING },
40 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
42 struct ubus_pending_data {
43 struct list_head list;
45 struct blob_attr data[];
48 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
50 const uint32_t *id1 = k1, *id2 = k2;
58 struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
60 blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
64 const char *ubus_strerror(int error)
68 if (error < 0 || error >= __UBUS_STATUS_LAST)
71 if (!__ubus_strerror[error])
74 return __ubus_strerror[error];
77 sprintf(err, "Unknown error: %d", error);
81 static int ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
82 struct blob_attr *msg, int cmd, uint32_t peer)
84 struct ubus_msghdr hdr;
85 struct iovec iov[2] = {
99 iov[1].iov_base = (char *) msg;
100 iov[1].iov_len = blob_raw_len(msg);
102 return writev(ctx->sock.fd, iov, 2);
105 static int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
106 struct blob_attr *msg, int cmd, uint32_t peer)
108 memset(req, 0, sizeof(*req));
110 INIT_LIST_HEAD(&req->list);
111 INIT_LIST_HEAD(&req->pending);
114 req->seq = ++ctx->request_seq;
115 return ubus_send_msg(ctx, req->seq, msg, cmd, peer);
118 static bool recv_retry(int fd, struct iovec *iov, bool wait)
122 while (iov->iov_len > 0) {
123 bytes = read(fd, iov->iov_base, iov->iov_len);
129 if (errno != EAGAIN) {
138 iov->iov_len -= bytes;
139 iov->iov_base += bytes;
145 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
147 if (hdr->version != 0)
150 if (blob_raw_len(hdr->data) < sizeof(*hdr->data))
153 if (blob_raw_len(hdr->data) + sizeof(*hdr) > UBUS_MAX_MSGLEN)
159 static bool get_next_msg(struct ubus_context *ctx, bool wait)
161 struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
163 /* receive header + start attribute */
164 iov.iov_len += sizeof(struct blob_attr);
165 if (!recv_retry(ctx->sock.fd, &iov, wait))
168 iov.iov_len = blob_len(ctx->msgbuf.hdr.data);
169 if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true))
172 return ubus_validate_hdr(&ctx->msgbuf.hdr);
175 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
177 ubus_parse_msg(hdr->data);
179 if (!attrbuf[UBUS_ATTR_STATUS])
182 *ret = blob_get_int32(attrbuf[UBUS_ATTR_STATUS]);
186 static void req_data_cb(struct ubus_request *req, int type, struct blob_attr *data)
188 struct blob_attr **attr;
190 if (req->raw_data_cb)
191 req->raw_data_cb(req, type, data);
196 attr = ubus_parse_msg(data);
197 req->data_cb(req, type, attr[UBUS_ATTR_DATA]);
200 static void ubus_process_req_data(struct ubus_request *req)
202 struct ubus_pending_data *data;
204 while (!list_empty(&req->pending)) {
205 data = list_first_entry(&req->pending,
206 struct ubus_pending_data, list);
207 list_del(&data->list);
209 req_data_cb(req, data->type, data->data);
214 static void ubus_req_complete_cb(struct ubus_request *req)
216 ubus_complete_handler_t cb = req->complete_cb;
221 req->complete_cb = NULL;
222 cb(req, req->status_code);
225 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
227 int ret = UBUS_STATUS_INVALID_ARGUMENT;
229 if (!list_empty(&req->list))
230 list_del(&req->list);
232 ubus_get_status(hdr, &ret);
233 req->peer = hdr->peer;
234 req->status_msg = true;
235 req->status_code = ret;
237 ubus_req_complete_cb(req);
242 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
244 struct ubus_pending_data *data;
249 req_data_cb(req, hdr->type, hdr->data);
250 ubus_process_req_data(req);
251 req->blocked = false;
254 ubus_req_complete_cb(req);
259 len = blob_raw_len(hdr->data);
260 data = calloc(1, sizeof(*data) + len);
264 data->type = hdr->type;
265 memcpy(data->data, hdr->data, len);
266 list_add(&data->list, &req->pending);
269 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
271 struct ubus_request *req;
273 list_for_each_entry(req, &ctx->requests, list) {
274 if (seq != req->seq || peer != req->peer)
282 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
284 struct ubus_request_data req;
285 struct ubus_object *obj;
290 ubus_parse_msg(hdr->data);
292 if (!attrbuf[UBUS_ATTR_OBJID])
295 objid = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
297 if (!attrbuf[UBUS_ATTR_METHOD]) {
298 ret = UBUS_STATUS_INVALID_ARGUMENT;
302 obj = avl_find_element(&ctx->objects, &objid, obj, avl);
304 ret = UBUS_STATUS_NOT_FOUND;
308 for (method = 0; method < obj->n_methods; method++)
309 if (!strcmp(obj->methods[method].name,
310 blob_data(attrbuf[UBUS_ATTR_METHOD])))
314 ret = UBUS_STATUS_METHOD_NOT_FOUND;
319 req.peer = hdr->peer;
321 ret = obj->methods[method].handler(ctx, obj, &req,
322 obj->methods[method].name,
323 attrbuf[UBUS_ATTR_DATA]);
326 blob_buf_init(&b, 0);
327 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
328 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
329 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
332 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
334 struct ubus_request *req;
337 case UBUS_MSG_STATUS:
338 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
342 ubus_process_req_status(req, hdr);
346 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
347 if (req && (req->data_cb || req->raw_data_cb))
348 ubus_req_data(req, hdr);
351 case UBUS_MSG_INVOKE:
352 ubus_process_invoke(ctx, hdr);
355 DPRINTF("unknown message type: %d\n", hdr->type);
360 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
362 if (!list_empty(&req->list))
365 req->cancelled = true;
366 ubus_process_req_data(req);
367 list_del(&req->list);
370 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
372 if (!list_empty(&req->list))
375 list_add(&req->list, &ctx->requests);
378 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
380 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
381 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
383 while (get_next_msg(ctx, false))
384 ubus_process_msg(ctx, hdr);
387 ctx->connection_lost(ctx);
390 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req)
392 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
394 if (!list_empty(&req->list))
395 list_del(&req->list);
399 return req->status_code;
402 return UBUS_STATUS_NO_DATA;
404 if (!get_next_msg(ctx, true))
405 return UBUS_STATUS_NO_DATA;
407 if (hdr->seq != req->seq || hdr->peer != req->peer)
411 case UBUS_MSG_STATUS:
412 return ubus_process_req_status(req, hdr);
414 if (req->data_cb || req->raw_data_cb)
415 ubus_req_data(req, hdr);
422 ubus_process_msg(ctx, hdr);
426 struct ubus_lookup_request {
427 struct ubus_request req;
428 ubus_lookup_handler_t cb;
431 static void ubus_lookup_cb(struct ubus_request *ureq, int type, struct blob_attr *msg)
433 struct ubus_lookup_request *req;
434 struct ubus_object_data obj;
435 struct blob_attr **attr;
437 req = container_of(ureq, struct ubus_lookup_request, req);
438 attr = ubus_parse_msg(msg);
440 if (!attr[UBUS_ATTR_OBJID] || !attr[UBUS_ATTR_OBJPATH] ||
441 !attr[UBUS_ATTR_OBJTYPE])
444 memset(&obj, 0, sizeof(obj));
445 obj.id = blob_get_int32(attr[UBUS_ATTR_OBJID]);
446 obj.path = blob_data(attr[UBUS_ATTR_OBJPATH]);
447 obj.type_id = blob_get_int32(attr[UBUS_ATTR_OBJTYPE]);
448 obj.signature = attr[UBUS_ATTR_SIGNATURE];
449 req->cb(ureq->ctx, &obj, ureq->priv);
452 int ubus_lookup(struct ubus_context *ctx, const char *path,
453 ubus_lookup_handler_t cb, void *priv)
455 struct ubus_lookup_request lookup;
457 blob_buf_init(&b, 0);
459 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
460 ubus_start_request(ctx, &lookup.req, b.head, UBUS_MSG_LOOKUP, 0);
461 lookup.req.raw_data_cb = ubus_lookup_cb;
462 lookup.req.priv = priv;
464 return ubus_complete_request(ctx, &lookup.req);
467 static void ubus_lookup_id_cb(struct ubus_request *req, int type, struct blob_attr *msg)
469 struct blob_attr **attr;
470 uint32_t *id = req->priv;
472 attr = ubus_parse_msg(msg);
474 if (!attr[UBUS_ATTR_OBJID])
477 *id = blob_get_int32(attr[UBUS_ATTR_OBJID]);
480 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id)
482 struct ubus_request req;
484 blob_buf_init(&b, 0);
486 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
487 ubus_start_request(ctx, &req, b.head, UBUS_MSG_LOOKUP, 0);
488 req.raw_data_cb = ubus_lookup_id_cb;
491 return ubus_complete_request(ctx, &req);
494 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
495 struct blob_attr *msg)
499 blob_buf_init(&b, 0);
500 blob_put_int32(&b, UBUS_ATTR_OBJID, req->object);
501 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
502 ret = ubus_send_msg(ctx, req->seq, b.head, UBUS_MSG_DATA, req->peer);
504 return UBUS_STATUS_NO_DATA;
509 void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
510 struct blob_attr *msg, struct ubus_request *req)
512 blob_buf_init(&b, 0);
513 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
514 blob_put_string(&b, UBUS_ATTR_METHOD, method);
516 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
518 ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj);
521 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
522 struct blob_attr *msg, ubus_data_handler_t cb, void *priv)
524 struct ubus_request req;
526 ubus_invoke_async(ctx, obj, method, msg, &req);
529 return ubus_complete_request(ctx, &req);
532 static void ubus_publish_cb(struct ubus_request *req, int type, struct blob_attr *msg)
534 struct ubus_object *obj = req->priv;
538 if (!attrbuf[UBUS_ATTR_OBJID])
541 obj->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
543 if (attrbuf[UBUS_ATTR_OBJTYPE])
544 obj->type->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJTYPE]);
546 obj->avl.key = &obj->id;
547 avl_insert(&req->ctx->objects, &obj->avl);
550 static bool ubus_push_table_data(const struct ubus_signature **sig, int *rem, bool array)
552 const struct ubus_signature *cur;
560 case UBUS_SIGNATURE_END:
562 case BLOBMSG_TYPE_INT32:
563 case BLOBMSG_TYPE_STRING:
564 blobmsg_add_u32(&b, cur->name, cur->type);
566 case BLOBMSG_TYPE_TABLE:
567 case BLOBMSG_TYPE_ARRAY:
568 nest_type = cur->type == BLOBMSG_TYPE_ARRAY;
569 nest = blobmsg_open_nested(&b, cur->name, nest_type);
570 if (!ubus_push_table_data(sig, rem, nest_type))
572 blobmsg_close_table(&b, nest);
583 static bool ubus_push_object_type(struct ubus_object_type *type)
586 int rem = type->n_signature;
587 const struct ubus_signature *sig = type->signature;
589 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
591 if (sig->type != UBUS_SIGNATURE_METHOD)
594 m = blobmsg_open_table(&b, sig->name);
598 if (!ubus_push_table_data(&sig, &rem, false))
601 blobmsg_close_table(&b, m);
603 blob_nest_end(&b, s);
608 int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
610 struct ubus_request req;
613 if (obj->id || !obj->name || !obj->type)
614 return UBUS_STATUS_INVALID_ARGUMENT;
616 blob_buf_init(&b, 0);
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;
624 ubus_start_request(ctx, &req, b.head, UBUS_MSG_PUBLISH, 0);
625 req.raw_data_cb = ubus_publish_cb;
627 ret = ubus_complete_request(ctx, &req);
632 return UBUS_STATUS_NO_DATA;
637 void ubus_default_connection_lost(struct ubus_context *ctx)
639 if (ctx->sock.registered)
643 struct ubus_context *ubus_connect(const char *path)
645 struct ubus_context *ctx;
647 struct ubus_msghdr hdr;
648 struct blob_attr data;
650 struct blob_attr *buf;
653 path = UBUS_UNIX_SOCKET;
655 ctx = calloc(1, sizeof(*ctx));
659 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
660 if (ctx->sock.fd < 0) {
661 DPRINTF("Failed to connect to server\n");
664 ctx->sock.cb = ubus_handle_data;
666 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr)) {
667 DPRINTF("Failed to read initial message data\n");
671 if (!ubus_validate_hdr(&hdr.hdr)) {
672 DPRINTF("Failed to validate initial message header\n");
676 if (hdr.hdr.type != UBUS_MSG_HELLO) {
677 DPRINTF("Unexpected initial message\n");
681 buf = calloc(1, blob_raw_len(&hdr.data));
685 memcpy(buf, &hdr.data, sizeof(hdr.data));
686 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf)) {
687 DPRINTF("Failed to retrieve initial message data\n");
691 ctx->local_id = hdr.hdr.peer;
694 ctx->connection_lost = ubus_default_connection_lost;
696 INIT_LIST_HEAD(&ctx->requests);
697 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
699 if (!ctx->local_id) {
700 DPRINTF("Failed to get local peer id\n");
716 void ubus_free(struct ubus_context *ctx)