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
);
132 if (errno
!= EAGAIN
) {
141 iov
->iov_len
-= bytes
;
142 iov
->iov_base
+= bytes
;
148 static bool ubus_validate_hdr(struct ubus_msghdr
*hdr
)
150 if (hdr
->version
!= 0)
153 if (blob_raw_len(hdr
->data
) < sizeof(*hdr
->data
))
156 if (blob_raw_len(hdr
->data
) + sizeof(*hdr
) > UBUS_MAX_MSGLEN
)
162 static bool get_next_msg(struct ubus_context
*ctx
, bool wait
)
164 struct iovec iov
= STATIC_IOV(ctx
->msgbuf
.hdr
);
166 /* receive header + start attribute */
167 iov
.iov_len
+= sizeof(struct blob_attr
);
168 if (!recv_retry(ctx
->sock
.fd
, &iov
, wait
))
171 iov
.iov_len
= blob_len(ctx
->msgbuf
.hdr
.data
);
172 if (iov
.iov_len
> 0 && !recv_retry(ctx
->sock
.fd
, &iov
, true))
175 return ubus_validate_hdr(&ctx
->msgbuf
.hdr
);
178 static bool ubus_get_status(struct ubus_msghdr
*hdr
, int *ret
)
180 ubus_parse_msg(hdr
->data
);
182 if (!attrbuf
[UBUS_ATTR_STATUS
])
185 *ret
= blob_get_int32(attrbuf
[UBUS_ATTR_STATUS
]);
189 static void req_data_cb(struct ubus_request
*req
, int type
, struct blob_attr
*data
)
191 struct blob_attr
**attr
;
193 if (req
->raw_data_cb
)
194 req
->raw_data_cb(req
, type
, data
);
199 attr
= ubus_parse_msg(data
);
200 req
->data_cb(req
, type
, attr
[UBUS_ATTR_DATA
]);
203 static void ubus_process_req_data(struct ubus_request
*req
)
205 struct ubus_pending_data
*data
;
207 while (!list_empty(&req
->pending
)) {
208 data
= list_first_entry(&req
->pending
,
209 struct ubus_pending_data
, list
);
210 list_del(&data
->list
);
212 req_data_cb(req
, data
->type
, data
->data
);
217 static void ubus_req_complete_cb(struct ubus_request
*req
)
219 ubus_complete_handler_t cb
= req
->complete_cb
;
224 req
->complete_cb
= NULL
;
225 cb(req
, req
->status_code
);
228 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
230 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
232 if (!list_empty(&req
->list
))
233 list_del(&req
->list
);
235 ubus_get_status(hdr
, &ret
);
236 req
->peer
= hdr
->peer
;
237 req
->status_msg
= true;
238 req
->status_code
= ret
;
240 ubus_req_complete_cb(req
);
245 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
247 struct ubus_pending_data
*data
;
252 req_data_cb(req
, hdr
->type
, hdr
->data
);
253 ubus_process_req_data(req
);
254 req
->blocked
= false;
257 ubus_req_complete_cb(req
);
262 len
= blob_raw_len(hdr
->data
);
263 data
= calloc(1, sizeof(*data
) + len
);
267 data
->type
= hdr
->type
;
268 memcpy(data
->data
, hdr
->data
, len
);
269 list_add(&data
->list
, &req
->pending
);
272 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
274 struct ubus_request
*req
;
276 list_for_each_entry(req
, &ctx
->requests
, list
) {
277 if (seq
!= req
->seq
|| peer
!= req
->peer
)
285 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
287 struct ubus_request_data req
;
288 struct ubus_object
*obj
;
293 ubus_parse_msg(hdr
->data
);
295 if (!attrbuf
[UBUS_ATTR_OBJID
])
298 objid
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
300 if (!attrbuf
[UBUS_ATTR_METHOD
]) {
301 ret
= UBUS_STATUS_INVALID_ARGUMENT
;
305 obj
= avl_find_element(&ctx
->objects
, &objid
, obj
, avl
);
307 ret
= UBUS_STATUS_NOT_FOUND
;
311 for (method
= 0; method
< obj
->n_methods
; method
++)
312 if (!obj
->methods
[method
].name
||
313 !strcmp(obj
->methods
[method
].name
,
314 blob_data(attrbuf
[UBUS_ATTR_METHOD
])))
318 ret
= UBUS_STATUS_METHOD_NOT_FOUND
;
323 req
.peer
= hdr
->peer
;
325 ret
= obj
->methods
[method
].handler(ctx
, obj
, &req
,
326 obj
->methods
[method
].name
,
327 attrbuf
[UBUS_ATTR_DATA
]);
330 blob_buf_init(&b
, 0);
331 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
332 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
333 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
336 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
338 struct ubus_request
*req
;
341 case UBUS_MSG_STATUS
:
342 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
346 ubus_process_req_status(req
, hdr
);
350 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
351 if (req
&& (req
->data_cb
|| req
->raw_data_cb
))
352 ubus_req_data(req
, hdr
);
355 case UBUS_MSG_INVOKE
:
356 ubus_process_invoke(ctx
, hdr
);
359 DPRINTF("unknown message type: %d\n", hdr
->type
);
364 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
366 if (!list_empty(&req
->list
))
369 req
->cancelled
= true;
370 ubus_process_req_data(req
);
371 list_del(&req
->list
);
374 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
376 if (!list_empty(&req
->list
))
379 list_add(&req
->list
, &ctx
->requests
);
382 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
384 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
385 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
387 while (get_next_msg(ctx
, false))
388 ubus_process_msg(ctx
, hdr
);
391 ctx
->connection_lost(ctx
);
394 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
396 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
398 if (!list_empty(&req
->list
))
399 list_del(&req
->list
);
403 return req
->status_code
;
406 return UBUS_STATUS_NO_DATA
;
408 if (!get_next_msg(ctx
, true))
409 return UBUS_STATUS_NO_DATA
;
411 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
415 case UBUS_MSG_STATUS
:
416 return ubus_process_req_status(req
, hdr
);
418 if (req
->data_cb
|| req
->raw_data_cb
)
419 ubus_req_data(req
, hdr
);
426 ubus_process_msg(ctx
, hdr
);
430 struct ubus_lookup_request
{
431 struct ubus_request req
;
432 ubus_lookup_handler_t cb
;
435 static void ubus_lookup_cb(struct ubus_request
*ureq
, int type
, struct blob_attr
*msg
)
437 struct ubus_lookup_request
*req
;
438 struct ubus_object_data obj
;
439 struct blob_attr
**attr
;
441 req
= container_of(ureq
, struct ubus_lookup_request
, req
);
442 attr
= ubus_parse_msg(msg
);
444 if (!attr
[UBUS_ATTR_OBJID
] || !attr
[UBUS_ATTR_OBJPATH
] ||
445 !attr
[UBUS_ATTR_OBJTYPE
])
448 memset(&obj
, 0, sizeof(obj
));
449 obj
.id
= blob_get_int32(attr
[UBUS_ATTR_OBJID
]);
450 obj
.path
= blob_data(attr
[UBUS_ATTR_OBJPATH
]);
451 obj
.type_id
= blob_get_int32(attr
[UBUS_ATTR_OBJTYPE
]);
452 obj
.signature
= attr
[UBUS_ATTR_SIGNATURE
];
453 req
->cb(ureq
->ctx
, &obj
, ureq
->priv
);
456 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
457 ubus_lookup_handler_t cb
, void *priv
)
459 struct ubus_lookup_request lookup
;
461 blob_buf_init(&b
, 0);
463 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
464 ubus_start_request(ctx
, &lookup
.req
, b
.head
, UBUS_MSG_LOOKUP
, 0);
465 lookup
.req
.raw_data_cb
= ubus_lookup_cb
;
466 lookup
.req
.priv
= priv
;
468 return ubus_complete_request(ctx
, &lookup
.req
);
471 static void ubus_lookup_id_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
473 struct blob_attr
**attr
;
474 uint32_t *id
= req
->priv
;
476 attr
= ubus_parse_msg(msg
);
478 if (!attr
[UBUS_ATTR_OBJID
])
481 *id
= blob_get_int32(attr
[UBUS_ATTR_OBJID
]);
484 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
)
486 struct ubus_request req
;
488 blob_buf_init(&b
, 0);
490 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
491 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_LOOKUP
, 0);
492 req
.raw_data_cb
= ubus_lookup_id_cb
;
495 return ubus_complete_request(ctx
, &req
);
498 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
499 struct blob_attr
*msg
)
503 blob_buf_init(&b
, 0);
504 blob_put_int32(&b
, UBUS_ATTR_OBJID
, req
->object
);
505 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
506 ret
= ubus_send_msg(ctx
, req
->seq
, b
.head
, UBUS_MSG_DATA
, req
->peer
);
508 return UBUS_STATUS_NO_DATA
;
513 void ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
514 struct blob_attr
*msg
, struct ubus_request
*req
)
516 blob_buf_init(&b
, 0);
517 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
);
518 blob_put_string(&b
, UBUS_ATTR_METHOD
, method
);
520 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
522 ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
);
525 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
526 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
528 struct ubus_request req
;
530 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
533 return ubus_complete_request(ctx
, &req
);
536 static void ubus_publish_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
538 struct ubus_object
*obj
= req
->priv
;
542 if (!attrbuf
[UBUS_ATTR_OBJID
])
545 obj
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
547 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
548 obj
->type
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
550 obj
->avl
.key
= &obj
->id
;
551 avl_insert(&req
->ctx
->objects
, &obj
->avl
);
554 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
556 const struct ubus_signature
*cur
;
564 case UBUS_SIGNATURE_END
:
566 case BLOBMSG_TYPE_INT32
:
567 case BLOBMSG_TYPE_STRING
:
568 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
570 case BLOBMSG_TYPE_TABLE
:
571 case BLOBMSG_TYPE_ARRAY
:
572 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
573 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
574 if (!ubus_push_table_data(sig
, rem
, nest_type
))
576 blobmsg_close_table(&b
, nest
);
587 static bool ubus_push_object_type(struct ubus_object_type
*type
)
590 int rem
= type
->n_signature
;
591 const struct ubus_signature
*sig
= type
->signature
;
593 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
595 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
598 m
= blobmsg_open_table(&b
, sig
->name
);
602 if (!ubus_push_table_data(&sig
, &rem
, false))
605 blobmsg_close_table(&b
, m
);
607 blob_nest_end(&b
, s
);
612 static int __ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
614 struct ubus_request req
;
617 blob_buf_init(&b
, 0);
619 if (obj
->name
&& obj
->type
) {
620 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
623 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
624 else if (!ubus_push_object_type(obj
->type
))
625 return UBUS_STATUS_INVALID_ARGUMENT
;
628 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_PUBLISH
, 0);
629 req
.raw_data_cb
= ubus_publish_cb
;
631 ret
= ubus_complete_request(ctx
, &req
);
636 return UBUS_STATUS_NO_DATA
;
641 int ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
643 if (!obj
->name
|| !obj
->type
)
644 return UBUS_STATUS_INVALID_ARGUMENT
;
646 return __ubus_publish(ctx
, obj
);
649 static int ubus_event_cb(struct ubus_context
*ctx
, struct ubus_object
*obj
,
650 struct ubus_request_data
*req
,
651 const char *method
, struct blob_attr
*msg
)
653 struct ubus_event_handler
*ev
;
655 ev
= container_of(obj
, struct ubus_event_handler
, obj
);
656 ev
->cb(ctx
, ev
, method
, msg
);
660 static const struct ubus_method event_method
= {
662 .handler
= ubus_event_cb
,
665 int ubus_register_event_handler(struct ubus_context
*ctx
,
666 struct ubus_event_handler
*ev
,
669 struct ubus_object
*obj
= &ev
->obj
;
674 obj
->methods
= &event_method
;
677 if (!!obj
->name
^ !!obj
->type
)
678 return UBUS_STATUS_INVALID_ARGUMENT
;
680 ret
= __ubus_publish(ctx
, obj
);
685 /* use a second buffer, ubus_invoke() overwrites the primary one */
686 memset(&b2
, 0, sizeof(b2
));
687 blob_buf_init(&b2
, 0);
688 blobmsg_add_u32(&b2
, "object", obj
->id
);
690 blobmsg_add_string(&b2
, "pattern", pattern
);
692 ret
= ubus_invoke(ctx
, UBUS_SYSTEM_OBJECT_EVENT
, "register", b2
.head
,
699 void ubus_default_connection_lost(struct ubus_context
*ctx
)
701 if (ctx
->sock
.registered
)
705 struct ubus_context
*ubus_connect(const char *path
)
707 struct ubus_context
*ctx
;
709 struct ubus_msghdr hdr
;
710 struct blob_attr data
;
712 struct blob_attr
*buf
;
715 path
= UBUS_UNIX_SOCKET
;
717 ctx
= calloc(1, sizeof(*ctx
));
721 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
722 if (ctx
->sock
.fd
< 0)
725 ctx
->sock
.cb
= ubus_handle_data
;
727 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
))
730 if (!ubus_validate_hdr(&hdr
.hdr
))
733 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
)
736 buf
= calloc(1, blob_raw_len(&hdr
.data
));
740 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
741 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
))
744 ctx
->local_id
= hdr
.hdr
.peer
;
747 ctx
->connection_lost
= ubus_default_connection_lost
;
749 INIT_LIST_HEAD(&ctx
->requests
);
750 avl_init(&ctx
->objects
, ubus_cmp_id
, false, NULL
);
767 void ubus_free(struct ubus_context
*ctx
)