3 #include <sys/socket.h>
6 #include <libubox/blob.h>
7 #include <libubox/blobmsg.h>
8 #include <libubox/usock.h>
13 #define STATIC_IOV(_var) { .iov_base = (char *) &(_var), .iov_len = sizeof(_var) }
15 const char *__ubus_strerror
[__UBUS_STATUS_LAST
] = {
16 [UBUS_STATUS_OK
] = "Success",
17 [UBUS_STATUS_INVALID_COMMAND
] = "Invalid command",
18 [UBUS_STATUS_INVALID_ARGUMENT
] = "Invalid argument",
19 [UBUS_STATUS_METHOD_NOT_FOUND
] = "Method not found",
20 [UBUS_STATUS_NOT_FOUND
] = "Not found",
21 [UBUS_STATUS_NO_DATA
] = "No response",
22 [UBUS_STATUS_PERMISSION_DENIED
] = "Permission denied",
25 static struct blob_buf b
;
27 static const struct blob_attr_info ubus_policy
[UBUS_ATTR_MAX
] = {
28 [UBUS_ATTR_STATUS
] = { .type
= BLOB_ATTR_INT32
},
29 [UBUS_ATTR_OBJID
] = { .type
= BLOB_ATTR_INT32
},
30 [UBUS_ATTR_OBJPATH
] = { .type
= BLOB_ATTR_STRING
},
31 [UBUS_ATTR_METHOD
] = { .type
= BLOB_ATTR_STRING
},
33 static struct blob_attr
*attrbuf
[UBUS_ATTR_MAX
];
35 struct ubus_pending_data
{
36 struct list_head list
;
38 struct blob_attr data
[];
41 static int ubus_cmp_id(const void *k1
, const void *k2
, void *ptr
)
43 const uint32_t *id1
= k1
, *id2
= k2
;
51 static struct blob_attr
**ubus_parse_msg(struct blob_attr
*msg
)
53 blob_parse(msg
, attrbuf
, ubus_policy
, UBUS_ATTR_MAX
);
57 const char *ubus_strerror(int error
)
61 if (error
< 0 || error
>= __UBUS_STATUS_LAST
)
64 if (!__ubus_strerror
[error
])
67 return __ubus_strerror
[error
];
70 sprintf(err
, "Unknown error: %d", error
);
74 static int ubus_send_msg(struct ubus_context
*ctx
, uint32_t seq
,
75 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
77 struct ubus_msghdr hdr
;
78 struct iovec iov
[2] = {
92 iov
[1].iov_base
= (char *) msg
;
93 iov
[1].iov_len
= blob_raw_len(msg
);
95 return writev(ctx
->sock
.fd
, iov
, 2);
98 static int ubus_start_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
99 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
101 memset(req
, 0, sizeof(*req
));
103 if (msg
&& blob_pad_len(msg
) > UBUS_MAX_MSGLEN
)
106 INIT_LIST_HEAD(&req
->list
);
107 INIT_LIST_HEAD(&req
->pending
);
110 req
->seq
= ++ctx
->request_seq
;
111 return ubus_send_msg(ctx
, req
->seq
, msg
, cmd
, peer
);
114 static bool recv_retry(int fd
, struct iovec
*iov
, bool wait
)
118 while (iov
->iov_len
> 0) {
119 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_pad_len(hdr
->data
) > 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_u32(attrbuf
[UBUS_ATTR_STATUS
]);
184 static void req_data_cb(struct ubus_request
*req
, int type
, struct blob_attr
*data
)
186 struct blob_attr
**attr
;
188 if (req
->raw_data_cb
)
189 req
->raw_data_cb(req
, type
, data
);
194 attr
= ubus_parse_msg(data
);
195 req
->data_cb(req
, type
, attr
[UBUS_ATTR_DATA
]);
198 static void ubus_process_req_data(struct ubus_request
*req
)
200 struct ubus_pending_data
*data
;
202 while (!list_empty(&req
->pending
)) {
203 data
= list_first_entry(&req
->pending
,
204 struct ubus_pending_data
, list
);
205 list_del(&data
->list
);
207 req_data_cb(req
, data
->type
, data
->data
);
212 static void ubus_req_complete_cb(struct ubus_request
*req
)
214 ubus_complete_handler_t cb
= req
->complete_cb
;
219 req
->complete_cb
= NULL
;
220 cb(req
, req
->status_code
);
223 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
225 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
227 if (!list_empty(&req
->list
))
228 list_del(&req
->list
);
230 ubus_get_status(hdr
, &ret
);
231 req
->peer
= hdr
->peer
;
232 req
->status_msg
= true;
233 req
->status_code
= ret
;
235 ubus_req_complete_cb(req
);
240 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
242 struct ubus_pending_data
*data
;
247 req_data_cb(req
, hdr
->type
, hdr
->data
);
248 ubus_process_req_data(req
);
249 req
->blocked
= false;
252 ubus_req_complete_cb(req
);
257 len
= blob_raw_len(hdr
->data
);
258 data
= calloc(1, sizeof(*data
) + len
);
262 data
->type
= hdr
->type
;
263 memcpy(data
->data
, hdr
->data
, len
);
264 list_add(&data
->list
, &req
->pending
);
267 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
269 struct ubus_request
*req
;
271 list_for_each_entry(req
, &ctx
->requests
, list
) {
272 if (seq
!= req
->seq
|| peer
!= req
->peer
)
280 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
282 struct ubus_request_data req
;
283 struct ubus_object
*obj
;
288 ubus_parse_msg(hdr
->data
);
290 if (!attrbuf
[UBUS_ATTR_OBJID
])
293 objid
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJID
]);
295 if (!attrbuf
[UBUS_ATTR_METHOD
]) {
296 ret
= UBUS_STATUS_INVALID_ARGUMENT
;
300 obj
= avl_find_element(&ctx
->objects
, &objid
, obj
, avl
);
302 ret
= UBUS_STATUS_NOT_FOUND
;
306 for (method
= 0; method
< obj
->n_methods
; method
++)
307 if (!obj
->methods
[method
].name
||
308 !strcmp(obj
->methods
[method
].name
,
309 blob_data(attrbuf
[UBUS_ATTR_METHOD
])))
313 ret
= UBUS_STATUS_METHOD_NOT_FOUND
;
318 req
.peer
= hdr
->peer
;
320 ret
= obj
->methods
[method
].handler(ctx
, obj
, &req
,
321 blob_data(attrbuf
[UBUS_ATTR_METHOD
]),
322 attrbuf
[UBUS_ATTR_DATA
]);
325 blob_buf_init(&b
, 0);
326 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
327 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
328 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
331 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
333 struct ubus_request
*req
;
336 case UBUS_MSG_STATUS
:
337 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
341 ubus_process_req_status(req
, hdr
);
345 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
346 if (req
&& (req
->data_cb
|| req
->raw_data_cb
))
347 ubus_req_data(req
, hdr
);
350 case UBUS_MSG_INVOKE
:
351 ubus_process_invoke(ctx
, hdr
);
356 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
358 if (!list_empty(&req
->list
))
361 req
->cancelled
= true;
362 ubus_process_req_data(req
);
363 list_del(&req
->list
);
366 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
368 if (!list_empty(&req
->list
))
371 list_add(&req
->list
, &ctx
->requests
);
374 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
376 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
377 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
379 while (get_next_msg(ctx
, false))
380 ubus_process_msg(ctx
, hdr
);
383 ctx
->connection_lost(ctx
);
386 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
388 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
390 if (!list_empty(&req
->list
))
391 list_del(&req
->list
);
395 return req
->status_code
;
398 return UBUS_STATUS_NO_DATA
;
400 if (!get_next_msg(ctx
, true))
401 return UBUS_STATUS_NO_DATA
;
403 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
407 case UBUS_MSG_STATUS
:
408 return ubus_process_req_status(req
, hdr
);
410 if (req
->data_cb
|| req
->raw_data_cb
)
411 ubus_req_data(req
, hdr
);
418 ubus_process_msg(ctx
, hdr
);
422 struct ubus_lookup_request
{
423 struct ubus_request req
;
424 ubus_lookup_handler_t cb
;
427 static void ubus_lookup_cb(struct ubus_request
*ureq
, int type
, struct blob_attr
*msg
)
429 struct ubus_lookup_request
*req
;
430 struct ubus_object_data obj
;
431 struct blob_attr
**attr
;
433 req
= container_of(ureq
, struct ubus_lookup_request
, req
);
434 attr
= ubus_parse_msg(msg
);
436 if (!attr
[UBUS_ATTR_OBJID
] || !attr
[UBUS_ATTR_OBJPATH
] ||
437 !attr
[UBUS_ATTR_OBJTYPE
])
440 memset(&obj
, 0, sizeof(obj
));
441 obj
.id
= blob_get_u32(attr
[UBUS_ATTR_OBJID
]);
442 obj
.path
= blob_data(attr
[UBUS_ATTR_OBJPATH
]);
443 obj
.type_id
= blob_get_u32(attr
[UBUS_ATTR_OBJTYPE
]);
444 obj
.signature
= attr
[UBUS_ATTR_SIGNATURE
];
445 req
->cb(ureq
->ctx
, &obj
, ureq
->priv
);
448 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
449 ubus_lookup_handler_t cb
, void *priv
)
451 struct ubus_lookup_request lookup
;
453 blob_buf_init(&b
, 0);
455 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
457 if (ubus_start_request(ctx
, &lookup
.req
, b
.head
, UBUS_MSG_LOOKUP
, 0) < 0)
458 return UBUS_STATUS_INVALID_ARGUMENT
;
460 lookup
.req
.raw_data_cb
= ubus_lookup_cb
;
461 lookup
.req
.priv
= priv
;
463 return ubus_complete_request(ctx
, &lookup
.req
);
466 static void ubus_lookup_id_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
468 struct blob_attr
**attr
;
469 uint32_t *id
= req
->priv
;
471 attr
= ubus_parse_msg(msg
);
473 if (!attr
[UBUS_ATTR_OBJID
])
476 *id
= blob_get_u32(attr
[UBUS_ATTR_OBJID
]);
479 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
)
481 struct ubus_request req
;
483 blob_buf_init(&b
, 0);
485 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
487 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_LOOKUP
, 0) < 0)
488 return UBUS_STATUS_INVALID_ARGUMENT
;
490 req
.raw_data_cb
= ubus_lookup_id_cb
;
493 return ubus_complete_request(ctx
, &req
);
496 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
497 struct blob_attr
*msg
)
501 blob_buf_init(&b
, 0);
502 blob_put_int32(&b
, UBUS_ATTR_OBJID
, req
->object
);
503 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
504 ret
= ubus_send_msg(ctx
, req
->seq
, b
.head
, UBUS_MSG_DATA
, req
->peer
);
506 return UBUS_STATUS_NO_DATA
;
511 int ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
512 struct blob_attr
*msg
, struct ubus_request
*req
)
514 blob_buf_init(&b
, 0);
515 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
);
516 blob_put_string(&b
, UBUS_ATTR_METHOD
, method
);
518 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
520 if (ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
) < 0)
521 return UBUS_STATUS_INVALID_ARGUMENT
;
526 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
527 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
529 struct ubus_request req
;
531 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
534 return ubus_complete_request(ctx
, &req
);
537 static void ubus_add_object_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
539 struct ubus_object
*obj
= req
->priv
;
543 if (!attrbuf
[UBUS_ATTR_OBJID
])
546 obj
->id
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJID
]);
548 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
549 obj
->type
->id
= blob_get_u32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
551 obj
->avl
.key
= &obj
->id
;
552 avl_insert(&req
->ctx
->objects
, &obj
->avl
);
555 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
557 const struct ubus_signature
*cur
;
565 case UBUS_SIGNATURE_END
:
567 case BLOBMSG_TYPE_INT32
:
568 case BLOBMSG_TYPE_STRING
:
569 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
571 case BLOBMSG_TYPE_TABLE
:
572 case BLOBMSG_TYPE_ARRAY
:
573 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
574 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
575 if (!ubus_push_table_data(sig
, rem
, nest_type
))
577 blobmsg_close_table(&b
, nest
);
588 static bool ubus_push_object_type(struct ubus_object_type
*type
)
591 int rem
= type
->n_signature
;
592 const struct ubus_signature
*sig
= type
->signature
;
594 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
596 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
599 m
= blobmsg_open_table(&b
, sig
->name
);
603 if (!ubus_push_table_data(&sig
, &rem
, false))
606 blobmsg_close_table(&b
, m
);
608 blob_nest_end(&b
, s
);
613 static int __ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
615 struct ubus_request req
;
618 blob_buf_init(&b
, 0);
620 if (obj
->name
&& obj
->type
) {
621 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
624 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
625 else if (!ubus_push_object_type(obj
->type
))
626 return UBUS_STATUS_INVALID_ARGUMENT
;
629 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_ADD_OBJECT
, 0) < 0)
630 return UBUS_STATUS_INVALID_ARGUMENT
;
632 req
.raw_data_cb
= ubus_add_object_cb
;
634 ret
= ubus_complete_request(ctx
, &req
);
639 return UBUS_STATUS_NO_DATA
;
644 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
646 if (!obj
->name
|| !obj
->type
)
647 return UBUS_STATUS_INVALID_ARGUMENT
;
649 return __ubus_add_object(ctx
, obj
);
652 static void ubus_remove_object_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
654 struct ubus_object
*obj
= req
->priv
;
658 if (!attrbuf
[UBUS_ATTR_OBJID
])
663 if (attrbuf
[UBUS_ATTR_OBJTYPE
] && obj
->type
)
666 avl_delete(&req
->ctx
->objects
, &obj
->avl
);
669 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
)
671 struct ubus_request req
;
674 blob_buf_init(&b
, 0);
675 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
->id
);
677 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_REMOVE_OBJECT
, 0) < 0)
678 return UBUS_STATUS_INVALID_ARGUMENT
;
680 req
.raw_data_cb
= ubus_remove_object_cb
;
682 ret
= ubus_complete_request(ctx
, &req
);
687 return UBUS_STATUS_NO_DATA
;
692 static int ubus_event_cb(struct ubus_context
*ctx
, struct ubus_object
*obj
,
693 struct ubus_request_data
*req
,
694 const char *method
, struct blob_attr
*msg
)
696 struct ubus_event_handler
*ev
;
698 ev
= container_of(obj
, struct ubus_event_handler
, obj
);
699 ev
->cb(ctx
, ev
, method
, msg
);
703 static const struct ubus_method event_method
= {
705 .handler
= ubus_event_cb
,
708 int ubus_register_event_handler(struct ubus_context
*ctx
,
709 struct ubus_event_handler
*ev
,
712 struct ubus_object
*obj
= &ev
->obj
;
717 obj
->methods
= &event_method
;
720 if (!!obj
->name
^ !!obj
->type
)
721 return UBUS_STATUS_INVALID_ARGUMENT
;
723 ret
= __ubus_add_object(ctx
, obj
);
728 /* use a second buffer, ubus_invoke() overwrites the primary one */
729 memset(&b2
, 0, sizeof(b2
));
730 blob_buf_init(&b2
, 0);
731 blobmsg_add_u32(&b2
, "object", obj
->id
);
733 blobmsg_add_string(&b2
, "pattern", pattern
);
735 ret
= ubus_invoke(ctx
, UBUS_SYSTEM_OBJECT_EVENT
, "register", b2
.head
,
741 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
742 struct blob_attr
*data
)
744 struct ubus_request req
;
747 blob_buf_init(&b
, 0);
748 blob_put_int32(&b
, UBUS_ATTR_OBJID
, UBUS_SYSTEM_OBJECT_EVENT
);
749 blob_put_string(&b
, UBUS_ATTR_METHOD
, "send");
750 s
= blob_nest_start(&b
, UBUS_ATTR_DATA
);
751 blobmsg_add_string(&b
, "id", id
);
752 blobmsg_add_field(&b
, BLOBMSG_TYPE_TABLE
, "data", blob_data(data
), blob_len(data
));
753 blob_nest_end(&b
, s
);
755 if (ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_INVOKE
, UBUS_SYSTEM_OBJECT_EVENT
) < 0)
756 return UBUS_STATUS_INVALID_ARGUMENT
;
758 return ubus_complete_request(ctx
, &req
);
761 static void ubus_default_connection_lost(struct ubus_context
*ctx
)
763 if (ctx
->sock
.registered
)
767 struct ubus_context
*ubus_connect(const char *path
)
769 struct ubus_context
*ctx
;
771 struct ubus_msghdr hdr
;
772 struct blob_attr data
;
774 struct blob_attr
*buf
;
777 path
= UBUS_UNIX_SOCKET
;
779 ctx
= calloc(1, sizeof(*ctx
));
783 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
784 if (ctx
->sock
.fd
< 0)
787 ctx
->sock
.cb
= ubus_handle_data
;
789 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
))
792 if (!ubus_validate_hdr(&hdr
.hdr
))
795 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
)
798 buf
= calloc(1, blob_raw_len(&hdr
.data
));
802 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
803 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
))
806 ctx
->local_id
= hdr
.hdr
.peer
;
809 ctx
->connection_lost
= ubus_default_connection_lost
;
811 INIT_LIST_HEAD(&ctx
->requests
);
812 avl_init(&ctx
->objects
, ubus_cmp_id
, false, NULL
);
829 void ubus_free(struct ubus_context
*ctx
)