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 },
39 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
41 struct ubus_pending_data {
42 struct list_head list;
44 struct blob_attr data[];
47 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
49 const uint32_t *id1 = k1, *id2 = k2;
57 struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
59 blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
63 const char *ubus_strerror(int error)
67 if (error < 0 || error >= __UBUS_STATUS_LAST)
70 if (!__ubus_strerror[error])
73 return __ubus_strerror[error];
76 sprintf(err, "Unknown error: %d", error);
80 static int ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
81 struct blob_attr *msg, int cmd, uint32_t peer)
83 struct ubus_msghdr hdr;
84 struct iovec iov[2] = {
98 iov[1].iov_base = (char *) msg;
99 iov[1].iov_len = blob_raw_len(msg);
101 return writev(ctx->sock.fd, iov, 2);
104 int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
105 struct blob_attr *msg, int cmd, uint32_t peer)
107 memset(req, 0, sizeof(*req));
109 INIT_LIST_HEAD(&req->list);
110 INIT_LIST_HEAD(&req->pending);
113 req->seq = ++ctx->request_seq;
114 return ubus_send_msg(ctx, req->seq, msg, cmd, peer);
117 static bool recv_retry(int fd, struct iovec *iov, bool wait)
121 while (iov->iov_len > 0) {
122 bytes = read(fd, iov->iov_base, iov->iov_len);
128 if (errno != EAGAIN) {
137 iov->iov_len -= bytes;
138 iov->iov_base += bytes;
144 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
146 if (hdr->version != 0)
149 if (blob_raw_len(hdr->data) < sizeof(*hdr->data))
152 if (blob_raw_len(hdr->data) + sizeof(*hdr) > UBUS_MAX_MSGLEN)
158 static bool get_next_msg(struct ubus_context *ctx, bool wait)
160 struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
162 /* receive header + start attribute */
163 iov.iov_len += sizeof(struct blob_attr);
164 if (!recv_retry(ctx->sock.fd, &iov, wait))
167 iov.iov_len = blob_len(ctx->msgbuf.hdr.data);
168 if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true))
171 return ubus_validate_hdr(&ctx->msgbuf.hdr);
174 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
176 ubus_parse_msg(hdr->data);
178 if (!attrbuf[UBUS_ATTR_STATUS])
181 *ret = blob_get_int32(attrbuf[UBUS_ATTR_STATUS]);
185 static void ubus_process_req_data(struct ubus_request *req)
187 struct ubus_pending_data *data;
189 while (!list_empty(&req->pending)) {
190 data = list_first_entry(&req->pending,
191 struct ubus_pending_data, list);
192 list_del(&data->list);
194 req->data_cb(req, data->type, data->data);
199 static void ubus_req_complete_cb(struct ubus_request *req)
201 ubus_complete_handler_t cb = req->complete_cb;
206 req->complete_cb = NULL;
207 cb(req, req->status_code);
210 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
212 int ret = UBUS_STATUS_INVALID_ARGUMENT;
214 if (!list_empty(&req->list))
215 list_del(&req->list);
217 ubus_get_status(hdr, &ret);
218 req->peer = hdr->peer;
219 req->status_msg = true;
220 req->status_code = ret;
222 ubus_req_complete_cb(req);
227 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
229 struct ubus_pending_data *data;
234 req->data_cb(req, hdr->type, hdr->data);
235 ubus_process_req_data(req);
236 req->blocked = false;
239 ubus_req_complete_cb(req);
244 len = blob_raw_len(hdr->data);
245 data = calloc(1, sizeof(*data) + len);
249 data->type = hdr->type;
250 memcpy(data->data, hdr->data, len);
251 list_add(&data->list, &req->pending);
254 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
256 struct ubus_request *req;
258 list_for_each_entry(req, &ctx->requests, list) {
259 if (seq != req->seq || peer != req->peer)
267 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
269 struct ubus_request_data req;
270 struct ubus_object *obj;
275 ubus_parse_msg(hdr->data);
277 if (!attrbuf[UBUS_ATTR_METHOD] || !attrbuf[UBUS_ATTR_OBJID]) {
278 ret = UBUS_STATUS_INVALID_ARGUMENT;
282 objid = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
283 obj = avl_find_element(&ctx->objects, &objid, obj, avl);
285 ret = UBUS_STATUS_NOT_FOUND;
289 for (method = 0; method < obj->n_methods; method++)
290 if (!strcmp(obj->methods[method].name,
291 blob_data(attrbuf[UBUS_ATTR_METHOD])))
295 ret = UBUS_STATUS_METHOD_NOT_FOUND;
300 req.peer = hdr->peer;
302 ret = obj->methods[method].handler(obj, &req, obj->methods[method].name,
303 attrbuf[UBUS_ATTR_DATA]);
306 blob_buf_init(&b, 0);
307 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
308 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
309 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
312 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
314 struct ubus_request *req;
317 case UBUS_MSG_STATUS:
318 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
322 ubus_process_req_status(req, hdr);
326 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
327 if (req && req->data_cb)
328 ubus_req_data(req, hdr);
331 case UBUS_MSG_INVOKE:
332 ubus_process_invoke(ctx, hdr);
335 DPRINTF("unknown message type: %d\n", hdr->type);
340 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
342 if (!list_empty(&req->list))
345 req->cancelled = true;
346 ubus_process_req_data(req);
347 list_del(&req->list);
350 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
352 if (!list_empty(&req->list))
355 list_add(&req->list, &ctx->requests);
358 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
360 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
361 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
363 while (get_next_msg(ctx, false))
364 ubus_process_msg(ctx, hdr);
367 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req)
369 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
371 if (!list_empty(&req->list))
372 list_del(&req->list);
376 return req->status_code;
379 return UBUS_STATUS_NO_DATA;
381 if (!get_next_msg(ctx, true))
382 return UBUS_STATUS_NO_DATA;
384 if (hdr->seq != req->seq || hdr->peer != req->peer)
388 case UBUS_MSG_STATUS:
389 return ubus_process_req_status(req, hdr);
392 ubus_req_data(req, hdr);
399 ubus_process_msg(ctx, hdr);
403 void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
404 struct blob_attr *msg, struct ubus_request *req)
406 blob_buf_init(&b, 0);
407 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
408 blob_put_string(&b, UBUS_ATTR_METHOD, method);
409 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
411 ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj);
414 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
415 struct blob_attr *msg, ubus_data_handler_t cb, void *priv)
417 struct ubus_request req;
419 ubus_invoke_async(ctx, obj, method, msg, &req);
422 return ubus_complete_request(ctx, &req);
425 static void ubus_publish_cb(struct ubus_request *req, int type, struct blob_attr *msg)
427 struct ubus_object *obj = req->priv;
431 if (!attrbuf[UBUS_ATTR_OBJID])
434 obj->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
436 if (attrbuf[UBUS_ATTR_OBJTYPE])
437 obj->type->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJTYPE]);
439 obj->avl.key = &obj->id;
440 avl_insert(&req->ctx->objects, &obj->avl);
443 static bool ubus_push_table_data(const struct ubus_signature **sig, int *rem, bool array)
445 const struct ubus_signature *cur;
453 case UBUS_SIGNATURE_END:
455 case BLOBMSG_TYPE_INT32:
456 case BLOBMSG_TYPE_STRING:
457 blobmsg_add_u32(&b, cur->name, cur->type);
459 case BLOBMSG_TYPE_TABLE:
460 case BLOBMSG_TYPE_ARRAY:
461 nest_type = cur->type == BLOBMSG_TYPE_ARRAY;
462 nest = blobmsg_open_nested(&b, cur->name, nest_type);
463 if (!ubus_push_table_data(sig, rem, nest_type))
465 blobmsg_close_table(&b, nest);
476 static bool ubus_push_object_type(struct ubus_object_type *type)
479 int rem = type->n_signature;
480 const struct ubus_signature *sig = type->signature;
482 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
484 if (sig->type != UBUS_SIGNATURE_METHOD)
487 m = blobmsg_open_table(&b, sig->name);
491 if (!ubus_push_table_data(&sig, &rem, false))
494 blobmsg_close_table(&b, m);
496 blob_nest_end(&b, s);
501 int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
503 struct ubus_request req;
506 if (obj->id || !obj->name || !obj->type)
507 return UBUS_STATUS_INVALID_ARGUMENT;
509 blob_buf_init(&b, 0);
510 blob_put_string(&b, UBUS_ATTR_OBJPATH, obj->name);
513 blob_put_int32(&b, UBUS_ATTR_OBJTYPE, obj->type->id);
514 else if (!ubus_push_object_type(obj->type))
515 return UBUS_STATUS_INVALID_ARGUMENT;
517 ubus_start_request(ctx, &req, b.head, UBUS_MSG_PUBLISH, 0);
518 req.data_cb = ubus_publish_cb;
520 ret = ubus_complete_request(ctx, &req);
525 return UBUS_STATUS_NO_DATA;
530 struct ubus_context *ubus_connect(const char *path)
532 struct ubus_context *ctx;
534 struct ubus_msghdr hdr;
535 struct blob_attr data;
537 struct blob_attr *buf;
540 path = UBUS_UNIX_SOCKET;
542 ctx = calloc(1, sizeof(*ctx));
546 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
547 if (ctx->sock.fd < 0) {
548 DPRINTF("Failed to connect to server\n");
551 ctx->sock.cb = ubus_handle_data;
553 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr)) {
554 DPRINTF("Failed to read initial message data\n");
558 if (!ubus_validate_hdr(&hdr.hdr)) {
559 DPRINTF("Failed to validate initial message header\n");
563 if (hdr.hdr.type != UBUS_MSG_HELLO) {
564 DPRINTF("Unexpected initial message\n");
568 buf = calloc(1, blob_raw_len(&hdr.data));
572 memcpy(buf, &hdr.data, sizeof(hdr.data));
573 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf)) {
574 DPRINTF("Failed to retrieve initial message data\n");
578 ctx->local_id = hdr.hdr.peer;
581 INIT_LIST_HEAD(&ctx->requests);
582 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
584 if (!ctx->local_id) {
585 DPRINTF("Failed to get local peer id\n");
601 void ubus_free(struct ubus_context *ctx)