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_NOT_FOUND] = "Not found",
28 [UBUS_STATUS_NO_DATA] = "No response",
31 static struct blob_buf b;
33 static const struct blob_attr_info ubus_policy[UBUS_ATTR_MAX] = {
34 [UBUS_ATTR_STATUS] = { .type = BLOB_ATTR_INT32 },
35 [UBUS_ATTR_OBJID] = { .type = BLOB_ATTR_INT32 },
36 [UBUS_ATTR_OBJPATH] = { .type = BLOB_ATTR_STRING },
38 static struct blob_attr *attrbuf[UBUS_ATTR_MAX];
40 struct ubus_pending_data {
41 struct list_head list;
43 struct blob_attr data[];
46 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
48 const uint32_t *id1 = k1, *id2 = k2;
56 struct blob_attr **ubus_parse_msg(struct blob_attr *msg)
58 blob_parse(msg, attrbuf, ubus_policy, UBUS_ATTR_MAX);
62 const char *ubus_strerror(int error)
66 if (error < 0 || error >= __UBUS_STATUS_LAST)
69 if (!__ubus_strerror[error])
72 return __ubus_strerror[error];
75 sprintf(err, "Unknown error: %d", error);
79 static int ubus_send_msg(struct ubus_context *ctx, uint32_t seq,
80 struct blob_attr *msg, int cmd, uint32_t peer)
82 struct ubus_msghdr hdr;
83 struct iovec iov[2] = {
97 iov[1].iov_base = (char *) msg;
98 iov[1].iov_len = blob_raw_len(msg);
100 return writev(ctx->sock.fd, iov, 2);
103 int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
104 struct blob_attr *msg, int cmd, uint32_t peer)
106 memset(req, 0, sizeof(*req));
108 INIT_LIST_HEAD(&req->list);
109 INIT_LIST_HEAD(&req->pending);
112 req->seq = ++ctx->request_seq;
113 return ubus_send_msg(ctx, req->seq, msg, cmd, peer);
116 static bool recv_retry(int fd, struct iovec *iov, bool wait)
120 while (iov->iov_len > 0) {
121 bytes = read(fd, iov->iov_base, iov->iov_len);
127 if (errno != EAGAIN) {
136 iov->iov_len -= bytes;
137 iov->iov_base += bytes;
143 static bool ubus_validate_hdr(struct ubus_msghdr *hdr)
145 if (hdr->version != 0)
148 if (blob_raw_len(hdr->data) < sizeof(*hdr->data))
151 if (blob_raw_len(hdr->data) + sizeof(*hdr) > UBUS_MAX_MSGLEN)
157 static bool get_next_msg(struct ubus_context *ctx, bool wait)
159 struct iovec iov = STATIC_IOV(ctx->msgbuf.hdr);
161 /* receive header + start attribute */
162 iov.iov_len += sizeof(struct blob_attr);
163 if (!recv_retry(ctx->sock.fd, &iov, wait))
166 iov.iov_len = blob_len(ctx->msgbuf.hdr.data);
167 if (iov.iov_len > 0 && !recv_retry(ctx->sock.fd, &iov, true))
170 return ubus_validate_hdr(&ctx->msgbuf.hdr);
173 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
175 ubus_parse_msg(hdr->data);
177 if (!attrbuf[UBUS_ATTR_STATUS])
180 *ret = blob_get_int32(attrbuf[UBUS_ATTR_STATUS]);
184 static void ubus_process_req_data(struct ubus_request *req)
186 struct ubus_pending_data *data;
188 while (!list_empty(&req->pending)) {
189 data = list_first_entry(&req->pending,
190 struct ubus_pending_data, list);
191 list_del(&data->list);
193 req->data_cb(req, data->type, data->data);
198 static void ubus_req_complete_cb(struct ubus_request *req)
200 ubus_complete_handler_t cb = req->complete_cb;
205 req->complete_cb = NULL;
206 cb(req, req->status_code);
209 static int ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
211 int ret = UBUS_STATUS_INVALID_ARGUMENT;
213 if (!list_empty(&req->list))
214 list_del(&req->list);
216 ubus_get_status(hdr, &ret);
217 req->peer = hdr->peer;
218 req->status_msg = true;
219 req->status_code = ret;
221 ubus_req_complete_cb(req);
226 static void ubus_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
228 struct ubus_pending_data *data;
233 req->data_cb(req, hdr->type, hdr->data);
234 ubus_process_req_data(req);
235 req->blocked = false;
238 ubus_req_complete_cb(req);
243 len = blob_raw_len(hdr->data);
244 data = calloc(1, sizeof(*data) + len);
248 data->type = hdr->type;
249 memcpy(data->data, hdr->data, len);
250 list_add(&data->list, &req->pending);
253 static struct ubus_request *ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer)
255 struct ubus_request *req;
257 list_for_each_entry(req, &ctx->requests, list) {
258 if (seq != req->seq || peer != req->peer)
266 static void ubus_process_invoke(struct ubus_context *ctx, struct ubus_msghdr *hdr)
271 ubus_parse_msg(hdr->data);
273 if (attrbuf[UBUS_ATTR_OBJID])
274 objid = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
276 blob_buf_init(&b, 0);
277 blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
278 blob_put_int32(&b, UBUS_ATTR_OBJID, objid);
279 ubus_send_msg(ctx, hdr->seq, b.head, UBUS_MSG_STATUS, hdr->peer);
282 static void ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
284 struct ubus_request *req;
287 case UBUS_MSG_STATUS:
288 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
292 ubus_process_req_status(req, hdr);
296 req = ubus_find_request(ctx, hdr->seq, hdr->peer);
297 if (req && req->data_cb)
298 ubus_req_data(req, hdr);
301 case UBUS_MSG_INVOKE:
302 ubus_process_invoke(ctx, hdr);
305 DPRINTF("unknown message type: %d\n", hdr->type);
310 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
312 if (!list_empty(&req->list))
315 req->cancelled = true;
316 ubus_process_req_data(req);
317 list_del(&req->list);
320 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
322 if (!list_empty(&req->list))
325 list_add(&req->list, &ctx->requests);
328 static void ubus_handle_data(struct uloop_fd *u, unsigned int events)
330 struct ubus_context *ctx = container_of(u, struct ubus_context, sock);
331 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
333 while (get_next_msg(ctx, false))
334 ubus_process_msg(ctx, hdr);
337 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req)
339 struct ubus_msghdr *hdr = &ctx->msgbuf.hdr;
341 if (!list_empty(&req->list))
342 list_del(&req->list);
346 return req->status_code;
349 return UBUS_STATUS_NO_DATA;
351 if (!get_next_msg(ctx, true))
352 return UBUS_STATUS_NO_DATA;
354 if (hdr->seq != req->seq || hdr->peer != req->peer)
358 case UBUS_MSG_STATUS:
359 return ubus_process_req_status(req, hdr);
362 ubus_req_data(req, hdr);
369 ubus_process_msg(ctx, hdr);
373 void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
374 struct blob_attr *msg, struct ubus_request *req)
376 blob_buf_init(&b, 0);
377 blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
378 blob_put_string(&b, UBUS_ATTR_METHOD, method);
379 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
381 ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj);
384 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
385 struct blob_attr *msg, ubus_data_handler_t cb, void *priv)
387 struct ubus_request req;
389 ubus_invoke_async(ctx, obj, method, msg, &req);
392 return ubus_complete_request(ctx, &req);
395 static void ubus_publish_cb(struct ubus_request *req, int type, struct blob_attr *msg)
397 struct ubus_object *obj = req->priv;
401 if (!attrbuf[UBUS_ATTR_OBJID])
404 obj->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJID]);
406 if (attrbuf[UBUS_ATTR_OBJTYPE])
407 obj->type->id = blob_get_int32(attrbuf[UBUS_ATTR_OBJTYPE]);
409 obj->avl.key = &obj->id;
410 avl_insert(&req->ctx->objects, &obj->avl);
413 static bool ubus_push_table_data(const struct ubus_signature **sig, int *rem, bool array)
415 const struct ubus_signature *cur;
423 case UBUS_SIGNATURE_END:
425 case BLOBMSG_TYPE_INT32:
426 case BLOBMSG_TYPE_STRING:
427 blobmsg_add_u32(&b, cur->name, cur->type);
429 case BLOBMSG_TYPE_TABLE:
430 case BLOBMSG_TYPE_ARRAY:
431 nest_type = cur->type == BLOBMSG_TYPE_ARRAY;
432 nest = blobmsg_open_nested(&b, cur->name, nest_type);
433 if (!ubus_push_table_data(sig, rem, nest_type))
435 blobmsg_close_table(&b, nest);
446 static bool ubus_push_object_type(struct ubus_object_type *type)
449 int rem = type->n_signature;
450 const struct ubus_signature *sig = type->signature;
452 s = blob_nest_start(&b, UBUS_ATTR_SIGNATURE);
454 if (sig->type != UBUS_SIGNATURE_METHOD)
457 m = blobmsg_open_table(&b, sig->name);
461 if (!ubus_push_table_data(&sig, &rem, false))
464 blobmsg_close_table(&b, m);
466 blob_nest_end(&b, s);
471 int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj)
473 struct ubus_request req;
476 if (obj->id || !obj->name || !obj->type)
477 return UBUS_STATUS_INVALID_ARGUMENT;
479 blob_buf_init(&b, 0);
480 blob_put_string(&b, UBUS_ATTR_OBJPATH, obj->name);
483 blob_put_int32(&b, UBUS_ATTR_OBJTYPE, obj->type->id);
484 else if (!ubus_push_object_type(obj->type))
485 return UBUS_STATUS_INVALID_ARGUMENT;
487 ubus_start_request(ctx, &req, b.head, UBUS_MSG_PUBLISH, 0);
488 req.data_cb = ubus_publish_cb;
490 ret = ubus_complete_request(ctx, &req);
495 return UBUS_STATUS_NO_DATA;
500 struct ubus_context *ubus_connect(const char *path)
502 struct ubus_context *ctx;
504 struct ubus_msghdr hdr;
505 struct blob_attr data;
507 struct blob_attr *buf;
510 path = UBUS_UNIX_SOCKET;
512 ctx = calloc(1, sizeof(*ctx));
516 ctx->sock.fd = usock(USOCK_UNIX, path, NULL);
517 if (ctx->sock.fd < 0) {
518 DPRINTF("Failed to connect to server\n");
521 ctx->sock.cb = ubus_handle_data;
523 if (read(ctx->sock.fd, &hdr, sizeof(hdr)) != sizeof(hdr)) {
524 DPRINTF("Failed to read initial message data\n");
528 if (!ubus_validate_hdr(&hdr.hdr)) {
529 DPRINTF("Failed to validate initial message header\n");
533 if (hdr.hdr.type != UBUS_MSG_HELLO) {
534 DPRINTF("Unexpected initial message\n");
538 buf = calloc(1, blob_raw_len(&hdr.data));
542 memcpy(buf, &hdr.data, sizeof(hdr.data));
543 if (read(ctx->sock.fd, blob_data(buf), blob_len(buf)) != blob_len(buf)) {
544 DPRINTF("Failed to retrieve initial message data\n");
548 ctx->local_id = hdr.hdr.peer;
551 INIT_LIST_HEAD(&ctx->requests);
552 avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
554 if (!ctx->local_id) {
555 DPRINTF("Failed to get local peer id\n");
571 void ubus_free(struct ubus_context *ctx)