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 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 ubus_process_req_data(struct ubus_request *req)
188 struct ubus_pending_data *data;
190 while (!list_empty(&req->pending)) {
191 data = list_first_entry(&req->pending,
192 struct ubus_pending_data, list);
193 list_del(&data->list);
195 req->data_cb(req, data->type, data->data);
200 static void ubus_req_complete_cb(struct ubus_request *req)
202 ubus_complete_handler_t cb = req->complete_cb;
207 req->complete_cb = NULL;
208 cb(req, req->status_code);
211 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
213 int ret = UBUS_STATUS_INVALID_ARGUMENT;
215 if (!list_empty(&req->list))
216 list_del(&req->list);
218 ubus_get_status(hdr, &ret);
219 req->peer = hdr->peer;
220 req->status_msg = true;
221 req->status_code = ret;
223 ubus_req_complete_cb(req);
228 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
230 struct ubus_pending_data *data;
235 req->data_cb(req, hdr->type, hdr->data);
236 ubus_process_req_data(req);
237 req->blocked = false;
240 ubus_req_complete_cb(req);
245 len = blob_raw_len(hdr->data);
246 data = calloc(1, sizeof(*data) + len);
250 data->type = hdr->type;
251 memcpy(data->data, hdr->data, len);
252 list_add(&data->list, &req->pending);
255 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
257 struct ubus_request *req;
259 list_for_each_entry(req, &ctx->requests, list) {
260 if (seq != req->seq || peer != req->peer)
268 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
270 struct ubus_request_data req;
271 struct ubus_object *obj;
276 ubus_parse_msg(hdr->data);
278 if (!attrbuf[UBUS_ATTR_OBJID])
281 objid = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
283 if (!attrbuf[UBUS_ATTR_METHOD]) {
284 ret = UBUS_STATUS_INVALID_ARGUMENT;
288 obj = avl_find_element(&ctx->objects, &objid, obj, avl);
290 ret = UBUS_STATUS_NOT_FOUND;
294 for (method = 0; method < obj->n_methods; method++)
295 if (!strcmp(obj->methods[method].name,
296 blob_data(attrbuf[UBUS_ATTR_METHOD])))
300 ret = UBUS_STATUS_METHOD_NOT_FOUND;
305 req.peer = hdr->peer;
307 ret = obj->methods[method].handler(obj, &req, obj->methods[method].name,
308 attrbuf[UBUS_ATTR_DATA]);
311 blob_buf_init(&b, 0);
312 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
313 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
314 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
317 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
319 struct ubus_request *req;
322 case UBUS_MSG_STATUS:
323 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
327 ubus_process_req_status(req, hdr);
331 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
332 if (req && req->data_cb)
333 ubus_req_data(req, hdr);
336 case UBUS_MSG_INVOKE:
337 ubus_process_invoke(ctx, hdr);
340 DPRINTF("unknown message type: %d\n", hdr->type);
345 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
347 if (!list_empty(&req->list))
350 req->cancelled = true;
351 ubus_process_req_data(req);
352 list_del(&req->list);
355 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
357 if (!list_empty(&req->list))
360 list_add(&req->list, &ctx->requests);
363 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
365 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
366 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
368 while (get_next_msg(ctx, false))
369 ubus_process_msg(ctx, hdr);
372 ctx->connection_lost(ctx);
375 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req)
377 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
379 if (!list_empty(&req->list))
380 list_del(&req->list);
384 return req->status_code;
387 return UBUS_STATUS_NO_DATA;
389 if (!get_next_msg(ctx, true))
390 return UBUS_STATUS_NO_DATA;
392 if (hdr->seq != req->seq || hdr->peer != req->peer)
396 case UBUS_MSG_STATUS:
397 return ubus_process_req_status(req, hdr);
400 ubus_req_data(req, hdr);
407 ubus_process_msg(ctx, hdr);
411 void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
412 struct blob_attr *msg, struct ubus_request *req)
414 blob_buf_init(&b, 0);
415 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
416 blob_put_string(&b, UBUS_ATTR_METHOD, method);
417 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
419 ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj);
422 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
423 struct blob_attr *msg, ubus_data_handler_t cb, void *priv)
425 struct ubus_request req;
427 ubus_invoke_async(ctx, obj, method, msg, &req);
430 return ubus_complete_request(ctx, &req);
433 static void ubus_publish_cb(struct ubus_request *req, int type, struct blob_attr *msg)
435 struct ubus_object *obj = req->priv;
439 if (!attrbuf[UBUS_ATTR_OBJID])
442 obj->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
444 if (attrbuf[UBUS_ATTR_OBJTYPE])
445 obj->type->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJTYPE]);
447 obj->avl.key = &obj->id;
448 avl_insert(&req->ctx->objects, &obj->avl);
451 static bool ubus_push_table_data(const struct ubus_signature **sig, int *rem, bool array)
453 const struct ubus_signature *cur;
461 case UBUS_SIGNATURE_END:
463 case BLOBMSG_TYPE_INT32:
464 case BLOBMSG_TYPE_STRING:
465 blobmsg_add_u32(&b, cur->name, cur->type);
467 case BLOBMSG_TYPE_TABLE:
468 case BLOBMSG_TYPE_ARRAY:
469 nest_type = cur->type == BLOBMSG_TYPE_ARRAY;
470 nest = blobmsg_open_nested(&b, cur->name, nest_type);
471 if (!ubus_push_table_data(sig, rem, nest_type))
473 blobmsg_close_table(&b, nest);
484 static bool ubus_push_object_type(struct ubus_object_type *type)
487 int rem = type->n_signature;
488 const struct ubus_signature *sig = type->signature;
490 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
492 if (sig->type != UBUS_SIGNATURE_METHOD)
495 m = blobmsg_open_table(&b, sig->name);
499 if (!ubus_push_table_data(&sig, &rem, false))
502 blobmsg_close_table(&b, m);
504 blob_nest_end(&b, s);
509 int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
511 struct ubus_request req;
514 if (obj->id || !obj->name || !obj->type)
515 return UBUS_STATUS_INVALID_ARGUMENT;
517 blob_buf_init(&b, 0);
518 blob_put_string(&b, UBUS_ATTR_OBJPATH, obj->name);
521 blob_put_int32(&b, UBUS_ATTR_OBJTYPE, obj->type->id);
522 else if (!ubus_push_object_type(obj->type))
523 return UBUS_STATUS_INVALID_ARGUMENT;
525 ubus_start_request(ctx, &req, b.head, UBUS_MSG_PUBLISH, 0);
526 req.data_cb = ubus_publish_cb;
528 ret = ubus_complete_request(ctx, &req);
533 return UBUS_STATUS_NO_DATA;
538 void ubus_default_connection_lost(struct ubus_context *ctx)
540 if (ctx->sock.registered)
544 struct ubus_context *ubus_connect(const char *path)
546 struct ubus_context *ctx;
548 struct ubus_msghdr hdr;
549 struct blob_attr data;
551 struct blob_attr *buf;
554 path = UBUS_UNIX_SOCKET;
556 ctx = calloc(1, sizeof(*ctx));
560 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
561 if (ctx->sock.fd < 0) {
562 DPRINTF("Failed to connect to server\n");
565 ctx->sock.cb = ubus_handle_data;
567 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr)) {
568 DPRINTF("Failed to read initial message data\n");
572 if (!ubus_validate_hdr(&hdr.hdr)) {
573 DPRINTF("Failed to validate initial message header\n");
577 if (hdr.hdr.type != UBUS_MSG_HELLO) {
578 DPRINTF("Unexpected initial message\n");
582 buf = calloc(1, blob_raw_len(&hdr.data));
586 memcpy(buf, &hdr.data, sizeof(hdr.data));
587 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf)) {
588 DPRINTF("Failed to retrieve initial message data\n");
592 ctx->local_id = hdr.hdr.peer;
595 ctx->connection_lost = ubus_default_connection_lost;
597 INIT_LIST_HEAD(&ctx->requests);
598 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
600 if (!ctx->local_id) {
601 DPRINTF("Failed to get local peer id\n");
617 void ubus_free(struct ubus_context *ctx)