3 #include <sys/socket.h>
7 #include <libubox/blob.h>
8 #include <libubox/blobmsg.h>
9 #include <libubox/usock.h>
14 #define STATIC_IOV(_var) { .iov_base = (char *) &(_var), .iov_len = sizeof(_var) }
16 const char *__ubus_strerror
[__UBUS_STATUS_LAST
] = {
17 [UBUS_STATUS_OK
] = "Success",
18 [UBUS_STATUS_INVALID_COMMAND
] = "Invalid command",
19 [UBUS_STATUS_INVALID_ARGUMENT
] = "Invalid argument",
20 [UBUS_STATUS_METHOD_NOT_FOUND
] = "Method not found",
21 [UBUS_STATUS_NOT_FOUND
] = "Not found",
22 [UBUS_STATUS_NO_DATA
] = "No response",
23 [UBUS_STATUS_PERMISSION_DENIED
] = "Permission denied",
26 static struct blob_buf b
;
28 static const struct blob_attr_info ubus_policy
[UBUS_ATTR_MAX
] = {
29 [UBUS_ATTR_STATUS
] = { .type
= BLOB_ATTR_INT32
},
30 [UBUS_ATTR_OBJID
] = { .type
= BLOB_ATTR_INT32
},
31 [UBUS_ATTR_OBJPATH
] = { .type
= BLOB_ATTR_STRING
},
32 [UBUS_ATTR_METHOD
] = { .type
= BLOB_ATTR_STRING
},
34 static struct blob_attr
*attrbuf
[UBUS_ATTR_MAX
];
36 struct ubus_pending_data
{
37 struct list_head list
;
39 struct blob_attr data
[];
42 static int ubus_cmp_id(const void *k1
, const void *k2
, void *ptr
)
44 const uint32_t *id1
= k1
, *id2
= k2
;
52 static struct blob_attr
**ubus_parse_msg(struct blob_attr
*msg
)
54 blob_parse(msg
, attrbuf
, ubus_policy
, UBUS_ATTR_MAX
);
58 const char *ubus_strerror(int error
)
62 if (error
< 0 || error
>= __UBUS_STATUS_LAST
)
65 if (!__ubus_strerror
[error
])
68 return __ubus_strerror
[error
];
71 sprintf(err
, "Unknown error: %d", error
);
75 static int writev_retry(int fd
, struct iovec
*iov
, int iov_len
)
80 int cur_len
= writev(fd
, iov
, iov_len
);
84 /* turn off non-blocking mode */
85 fcntl(fd
, F_SETFL
, fcntl(fd
, F_GETFL
) &
96 while (cur_len
>= iov
->iov_len
) {
97 cur_len
-= iov
->iov_len
;
100 if (!cur_len
|| !iov_len
)
103 iov
->iov_len
-= cur_len
;
107 static int ubus_send_msg(struct ubus_context
*ctx
, uint32_t seq
,
108 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
110 struct ubus_msghdr hdr
;
111 struct iovec iov
[2] = {
121 blob_buf_init(&b
, 0);
125 iov
[1].iov_base
= (char *) msg
;
126 iov
[1].iov_len
= blob_raw_len(msg
);
128 return writev_retry(ctx
->sock
.fd
, iov
, ARRAY_SIZE(iov
));
131 static int ubus_start_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
132 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
134 memset(req
, 0, sizeof(*req
));
136 if (msg
&& blob_pad_len(msg
) > UBUS_MAX_MSGLEN
)
139 INIT_LIST_HEAD(&req
->list
);
140 INIT_LIST_HEAD(&req
->pending
);
143 req
->seq
= ++ctx
->request_seq
;
144 return ubus_send_msg(ctx
, req
->seq
, msg
, cmd
, peer
);
147 static bool recv_retry(int fd
, struct iovec
*iov
, bool wait
)
151 while (iov
->iov_len
> 0) {
152 bytes
= read(fd
, iov
->iov_base
, iov
->iov_len
);
160 if (errno
!= EAGAIN
) {
169 iov
->iov_len
-= bytes
;
170 iov
->iov_base
+= bytes
;
176 static bool ubus_validate_hdr(struct ubus_msghdr
*hdr
)
178 if (hdr
->version
!= 0)
181 if (blob_raw_len(hdr
->data
) < sizeof(*hdr
->data
))
184 if (blob_pad_len(hdr
->data
) > UBUS_MAX_MSGLEN
)
190 static bool get_next_msg(struct ubus_context
*ctx
, bool wait
)
192 struct iovec iov
= STATIC_IOV(ctx
->msgbuf
.hdr
);
194 /* receive header + start attribute */
195 iov
.iov_len
+= sizeof(struct blob_attr
);
196 if (!recv_retry(ctx
->sock
.fd
, &iov
, wait
))
199 iov
.iov_len
= blob_len(ctx
->msgbuf
.hdr
.data
);
200 if (iov
.iov_len
> 0 && !recv_retry(ctx
->sock
.fd
, &iov
, true))
203 return ubus_validate_hdr(&ctx
->msgbuf
.hdr
);
206 static bool ubus_get_status(struct ubus_msghdr
*hdr
, int *ret
)
208 ubus_parse_msg(hdr
->data
);
210 if (!attrbuf
[UBUS_ATTR_STATUS
])
213 *ret
= blob_get_u32(attrbuf
[UBUS_ATTR_STATUS
]);
217 static void req_data_cb(struct ubus_request
*req
, int type
, struct blob_attr
*data
)
219 struct blob_attr
**attr
;
221 if (req
->raw_data_cb
)
222 req
->raw_data_cb(req
, type
, data
);
227 attr
= ubus_parse_msg(data
);
228 req
->data_cb(req
, type
, attr
[UBUS_ATTR_DATA
]);
231 static void ubus_process_req_data(struct ubus_request
*req
)
233 struct ubus_pending_data
*data
;
235 while (!list_empty(&req
->pending
)) {
236 data
= list_first_entry(&req
->pending
,
237 struct ubus_pending_data
, list
);
238 list_del(&data
->list
);
240 req_data_cb(req
, data
->type
, data
->data
);
245 static void ubus_req_complete_cb(struct ubus_request
*req
)
247 ubus_complete_handler_t cb
= req
->complete_cb
;
252 req
->complete_cb
= NULL
;
253 cb(req
, req
->status_code
);
256 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
258 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
260 if (!list_empty(&req
->list
))
261 list_del(&req
->list
);
263 ubus_get_status(hdr
, &ret
);
264 req
->peer
= hdr
->peer
;
265 req
->status_msg
= true;
266 req
->status_code
= ret
;
268 ubus_req_complete_cb(req
);
273 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
275 struct ubus_pending_data
*data
;
280 req_data_cb(req
, hdr
->type
, hdr
->data
);
281 ubus_process_req_data(req
);
282 req
->blocked
= false;
285 ubus_req_complete_cb(req
);
290 len
= blob_raw_len(hdr
->data
);
291 data
= calloc(1, sizeof(*data
) + len
);
295 data
->type
= hdr
->type
;
296 memcpy(data
->data
, hdr
->data
, len
);
297 list_add(&data
->list
, &req
->pending
);
300 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
302 struct ubus_request
*req
;
304 list_for_each_entry(req
, &ctx
->requests
, list
) {
305 if (seq
!= req
->seq
|| peer
!= req
->peer
)
313 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
315 struct ubus_request_data req
;
316 struct ubus_object
*obj
;
321 ubus_parse_msg(hdr
->data
);
323 if (!attrbuf
[UBUS_ATTR_OBJID
])
326 objid
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJID
]);
328 if (!attrbuf
[UBUS_ATTR_METHOD
]) {
329 ret
= UBUS_STATUS_INVALID_ARGUMENT
;
333 obj
= avl_find_element(&ctx
->objects
, &objid
, obj
, avl
);
335 ret
= UBUS_STATUS_NOT_FOUND
;
339 for (method
= 0; method
< obj
->n_methods
; method
++)
340 if (!obj
->methods
[method
].name
||
341 !strcmp(obj
->methods
[method
].name
,
342 blob_data(attrbuf
[UBUS_ATTR_METHOD
])))
346 ret
= UBUS_STATUS_METHOD_NOT_FOUND
;
351 req
.peer
= hdr
->peer
;
353 ret
= obj
->methods
[method
].handler(ctx
, obj
, &req
,
354 blob_data(attrbuf
[UBUS_ATTR_METHOD
]),
355 attrbuf
[UBUS_ATTR_DATA
]);
358 blob_buf_init(&b
, 0);
359 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
360 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
361 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
364 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
366 struct ubus_request
*req
;
369 case UBUS_MSG_STATUS
:
370 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
374 ubus_process_req_status(req
, hdr
);
378 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
379 if (req
&& (req
->data_cb
|| req
->raw_data_cb
))
380 ubus_req_data(req
, hdr
);
383 case UBUS_MSG_INVOKE
:
384 ubus_process_invoke(ctx
, hdr
);
389 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
391 if (!list_empty(&req
->list
))
394 req
->cancelled
= true;
395 ubus_process_req_data(req
);
396 list_del(&req
->list
);
399 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
401 if (!list_empty(&req
->list
))
404 list_add(&req
->list
, &ctx
->requests
);
407 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
409 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
410 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
412 while (get_next_msg(ctx
, false))
413 ubus_process_msg(ctx
, hdr
);
416 ctx
->connection_lost(ctx
);
419 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
421 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
423 if (!list_empty(&req
->list
))
424 list_del(&req
->list
);
428 return req
->status_code
;
431 return UBUS_STATUS_NO_DATA
;
433 if (!get_next_msg(ctx
, true))
434 return UBUS_STATUS_NO_DATA
;
436 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
440 case UBUS_MSG_STATUS
:
441 return ubus_process_req_status(req
, hdr
);
443 if (req
->data_cb
|| req
->raw_data_cb
)
444 ubus_req_data(req
, hdr
);
451 ubus_process_msg(ctx
, hdr
);
455 struct ubus_lookup_request
{
456 struct ubus_request req
;
457 ubus_lookup_handler_t cb
;
460 static void ubus_lookup_cb(struct ubus_request
*ureq
, int type
, struct blob_attr
*msg
)
462 struct ubus_lookup_request
*req
;
463 struct ubus_object_data obj
;
464 struct blob_attr
**attr
;
466 req
= container_of(ureq
, struct ubus_lookup_request
, req
);
467 attr
= ubus_parse_msg(msg
);
469 if (!attr
[UBUS_ATTR_OBJID
] || !attr
[UBUS_ATTR_OBJPATH
] ||
470 !attr
[UBUS_ATTR_OBJTYPE
])
473 memset(&obj
, 0, sizeof(obj
));
474 obj
.id
= blob_get_u32(attr
[UBUS_ATTR_OBJID
]);
475 obj
.path
= blob_data(attr
[UBUS_ATTR_OBJPATH
]);
476 obj
.type_id
= blob_get_u32(attr
[UBUS_ATTR_OBJTYPE
]);
477 obj
.signature
= attr
[UBUS_ATTR_SIGNATURE
];
478 req
->cb(ureq
->ctx
, &obj
, ureq
->priv
);
481 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
482 ubus_lookup_handler_t cb
, void *priv
)
484 struct ubus_lookup_request lookup
;
486 blob_buf_init(&b
, 0);
488 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
490 if (ubus_start_request(ctx
, &lookup
.req
, b
.head
, UBUS_MSG_LOOKUP
, 0) < 0)
491 return UBUS_STATUS_INVALID_ARGUMENT
;
493 lookup
.req
.raw_data_cb
= ubus_lookup_cb
;
494 lookup
.req
.priv
= priv
;
496 return ubus_complete_request(ctx
, &lookup
.req
);
499 static void ubus_lookup_id_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
501 struct blob_attr
**attr
;
502 uint32_t *id
= req
->priv
;
504 attr
= ubus_parse_msg(msg
);
506 if (!attr
[UBUS_ATTR_OBJID
])
509 *id
= blob_get_u32(attr
[UBUS_ATTR_OBJID
]);
512 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
)
514 struct ubus_request req
;
516 blob_buf_init(&b
, 0);
518 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
520 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_LOOKUP
, 0) < 0)
521 return UBUS_STATUS_INVALID_ARGUMENT
;
523 req
.raw_data_cb
= ubus_lookup_id_cb
;
526 return ubus_complete_request(ctx
, &req
);
529 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
530 struct blob_attr
*msg
)
534 blob_buf_init(&b
, 0);
535 blob_put_int32(&b
, UBUS_ATTR_OBJID
, req
->object
);
536 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
537 ret
= ubus_send_msg(ctx
, req
->seq
, b
.head
, UBUS_MSG_DATA
, req
->peer
);
539 return UBUS_STATUS_NO_DATA
;
544 int ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
545 struct blob_attr
*msg
, struct ubus_request
*req
)
547 blob_buf_init(&b
, 0);
548 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
);
549 blob_put_string(&b
, UBUS_ATTR_METHOD
, method
);
551 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
553 if (ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
) < 0)
554 return UBUS_STATUS_INVALID_ARGUMENT
;
559 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
560 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
562 struct ubus_request req
;
564 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
567 return ubus_complete_request(ctx
, &req
);
570 static void ubus_add_object_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
572 struct ubus_object
*obj
= req
->priv
;
576 if (!attrbuf
[UBUS_ATTR_OBJID
])
579 obj
->id
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJID
]);
581 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
582 obj
->type
->id
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
584 obj
->avl
.key
= &obj
->id
;
585 avl_insert(&req
->ctx
->objects
, &obj
->avl
);
588 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
590 const struct ubus_signature
*cur
;
598 case UBUS_SIGNATURE_END
:
600 case BLOBMSG_TYPE_INT32
:
601 case BLOBMSG_TYPE_STRING
:
602 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
604 case BLOBMSG_TYPE_TABLE
:
605 case BLOBMSG_TYPE_ARRAY
:
606 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
607 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
608 if (!ubus_push_table_data(sig
, rem
, nest_type
))
610 blobmsg_close_table(&b
, nest
);
621 static bool ubus_push_object_type(struct ubus_object_type
*type
)
624 int rem
= type
->n_signature
;
625 const struct ubus_signature
*sig
= type
->signature
;
627 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
629 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
632 m
= blobmsg_open_table(&b
, sig
->name
);
636 if (!ubus_push_table_data(&sig
, &rem
, false))
639 blobmsg_close_table(&b
, m
);
641 blob_nest_end(&b
, s
);
646 static int __ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
648 struct ubus_request req
;
651 blob_buf_init(&b
, 0);
653 if (obj
->name
&& obj
->type
) {
654 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
657 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
658 else if (!ubus_push_object_type(obj
->type
))
659 return UBUS_STATUS_INVALID_ARGUMENT
;
662 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_ADD_OBJECT
, 0) < 0)
663 return UBUS_STATUS_INVALID_ARGUMENT
;
665 req
.raw_data_cb
= ubus_add_object_cb
;
667 ret
= ubus_complete_request(ctx
, &req
);
672 return UBUS_STATUS_NO_DATA
;
677 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
679 if (!obj
->name
|| !obj
->type
)
680 return UBUS_STATUS_INVALID_ARGUMENT
;
682 return __ubus_add_object(ctx
, obj
);
685 static void ubus_remove_object_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
687 struct ubus_object
*obj
= req
->priv
;
691 if (!attrbuf
[UBUS_ATTR_OBJID
])
696 if (attrbuf
[UBUS_ATTR_OBJTYPE
] && obj
->type
)
699 avl_delete(&req
->ctx
->objects
, &obj
->avl
);
702 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
704 struct ubus_request req
;
707 blob_buf_init(&b
, 0);
708 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
->id
);
710 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_REMOVE_OBJECT
, 0) < 0)
711 return UBUS_STATUS_INVALID_ARGUMENT
;
713 req
.raw_data_cb
= ubus_remove_object_cb
;
715 ret
= ubus_complete_request(ctx
, &req
);
720 return UBUS_STATUS_NO_DATA
;
725 static int ubus_event_cb(struct ubus_context
*ctx
, struct ubus_object
*obj
,
726 struct ubus_request_data
*req
,
727 const char *method
, struct blob_attr
*msg
)
729 struct ubus_event_handler
*ev
;
731 ev
= container_of(obj
, struct ubus_event_handler
, obj
);
732 ev
->cb(ctx
, ev
, method
, msg
);
736 static const struct ubus_method event_method
= {
738 .handler
= ubus_event_cb
,
741 int ubus_register_event_handler(struct ubus_context
*ctx
,
742 struct ubus_event_handler
*ev
,
745 struct ubus_object
*obj
= &ev
->obj
;
750 obj
->methods
= &event_method
;
753 if (!!obj
->name
^ !!obj
->type
)
754 return UBUS_STATUS_INVALID_ARGUMENT
;
756 ret
= __ubus_add_object(ctx
, obj
);
761 /* use a second buffer, ubus_invoke() overwrites the primary one */
762 memset(&b2
, 0, sizeof(b2
));
763 blob_buf_init(&b2
, 0);
764 blobmsg_add_u32(&b2
, "object", obj
->id
);
766 blobmsg_add_string(&b2
, "pattern", pattern
);
768 ret
= ubus_invoke(ctx
, UBUS_SYSTEM_OBJECT_EVENT
, "register", b2
.head
,
774 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
775 struct blob_attr
*data
)
777 struct ubus_request req
;
780 blob_buf_init(&b
, 0);
781 blob_put_int32(&b
, UBUS_ATTR_OBJID
, UBUS_SYSTEM_OBJECT_EVENT
);
782 blob_put_string(&b
, UBUS_ATTR_METHOD
, "send");
783 s
= blob_nest_start(&b
, UBUS_ATTR_DATA
);
784 blobmsg_add_string(&b
, "id", id
);
785 blobmsg_add_field(&b
, BLOBMSG_TYPE_TABLE
, "data", blob_data(data
), blob_len(data
));
786 blob_nest_end(&b
, s
);
788 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_INVOKE
, UBUS_SYSTEM_OBJECT_EVENT
) < 0)
789 return UBUS_STATUS_INVALID_ARGUMENT
;
791 return ubus_complete_request(ctx
, &req
);
794 static void ubus_default_connection_lost(struct ubus_context
*ctx
)
796 if (ctx
->sock
.registered
)
800 struct ubus_context
*ubus_connect(const char *path
)
802 struct ubus_context
*ctx
;
804 struct ubus_msghdr hdr
;
805 struct blob_attr data
;
807 struct blob_attr
*buf
;
810 path
= UBUS_UNIX_SOCKET
;
812 ctx
= calloc(1, sizeof(*ctx
));
816 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
817 if (ctx
->sock
.fd
< 0)
820 ctx
->sock
.cb
= ubus_handle_data
;
822 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
))
825 if (!ubus_validate_hdr(&hdr
.hdr
))
828 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
)
831 buf
= calloc(1, blob_raw_len(&hdr
.data
));
835 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
836 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
))
839 ctx
->local_id
= hdr
.hdr
.peer
;
842 ctx
->connection_lost
= ubus_default_connection_lost
;
844 INIT_LIST_HEAD(&ctx
->requests
);
845 avl_init(&ctx
->objects
, ubus_cmp_id
, false, NULL
);
862 void ubus_free(struct ubus_context
*ctx
)