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
);
130 if (errno
!= EAGAIN
) {
139 iov
->iov_len
-= bytes
;
140 iov
->iov_base
+= bytes
;
146 static bool ubus_validate_hdr(struct ubus_msghdr
*hdr
)
148 if (hdr
->version
!= 0)
151 if (blob_raw_len(hdr
->data
) < sizeof(*hdr
->data
))
154 if (blob_raw_len(hdr
->data
) + sizeof(*hdr
) > UBUS_MAX_MSGLEN
)
160 static bool get_next_msg(struct ubus_context
*ctx
, bool wait
)
162 struct iovec iov
= STATIC_IOV(ctx
->msgbuf
.hdr
);
164 /* receive header + start attribute */
165 iov
.iov_len
+= sizeof(struct blob_attr
);
166 if (!recv_retry(ctx
->sock
.fd
, &iov
, wait
))
169 iov
.iov_len
= blob_len(ctx
->msgbuf
.hdr
.data
);
170 if (iov
.iov_len
> 0 && !recv_retry(ctx
->sock
.fd
, &iov
, true))
173 return ubus_validate_hdr(&ctx
->msgbuf
.hdr
);
176 static bool ubus_get_status(struct ubus_msghdr
*hdr
, int *ret
)
178 ubus_parse_msg(hdr
->data
);
180 if (!attrbuf
[UBUS_ATTR_STATUS
])
183 *ret
= blob_get_int32(attrbuf
[UBUS_ATTR_STATUS
]);
187 static void req_data_cb(struct ubus_request
*req
, int type
, struct blob_attr
*data
)
189 struct blob_attr
**attr
;
191 if (req
->raw_data_cb
)
192 req
->raw_data_cb(req
, type
, data
);
197 attr
= ubus_parse_msg(data
);
198 req
->data_cb(req
, type
, attr
[UBUS_ATTR_DATA
]);
201 static void ubus_process_req_data(struct ubus_request
*req
)
203 struct ubus_pending_data
*data
;
205 while (!list_empty(&req
->pending
)) {
206 data
= list_first_entry(&req
->pending
,
207 struct ubus_pending_data
, list
);
208 list_del(&data
->list
);
210 req_data_cb(req
, data
->type
, data
->data
);
215 static void ubus_req_complete_cb(struct ubus_request
*req
)
217 ubus_complete_handler_t cb
= req
->complete_cb
;
222 req
->complete_cb
= NULL
;
223 cb(req
, req
->status_code
);
226 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
228 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
230 if (!list_empty(&req
->list
))
231 list_del(&req
->list
);
233 ubus_get_status(hdr
, &ret
);
234 req
->peer
= hdr
->peer
;
235 req
->status_msg
= true;
236 req
->status_code
= ret
;
238 ubus_req_complete_cb(req
);
243 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
245 struct ubus_pending_data
*data
;
250 req_data_cb(req
, hdr
->type
, hdr
->data
);
251 ubus_process_req_data(req
);
252 req
->blocked
= false;
255 ubus_req_complete_cb(req
);
260 len
= blob_raw_len(hdr
->data
);
261 data
= calloc(1, sizeof(*data
) + len
);
265 data
->type
= hdr
->type
;
266 memcpy(data
->data
, hdr
->data
, len
);
267 list_add(&data
->list
, &req
->pending
);
270 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
272 struct ubus_request
*req
;
274 list_for_each_entry(req
, &ctx
->requests
, list
) {
275 if (seq
!= req
->seq
|| peer
!= req
->peer
)
283 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
285 struct ubus_request_data req
;
286 struct ubus_object
*obj
;
291 ubus_parse_msg(hdr
->data
);
293 if (!attrbuf
[UBUS_ATTR_OBJID
])
296 objid
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
298 if (!attrbuf
[UBUS_ATTR_METHOD
]) {
299 ret
= UBUS_STATUS_INVALID_ARGUMENT
;
303 obj
= avl_find_element(&ctx
->objects
, &objid
, obj
, avl
);
305 ret
= UBUS_STATUS_NOT_FOUND
;
309 for (method
= 0; method
< obj
->n_methods
; method
++)
310 if (!obj
->methods
[method
].name
||
311 !strcmp(obj
->methods
[method
].name
,
312 blob_data(attrbuf
[UBUS_ATTR_METHOD
])))
316 ret
= UBUS_STATUS_METHOD_NOT_FOUND
;
321 req
.peer
= hdr
->peer
;
323 ret
= obj
->methods
[method
].handler(ctx
, obj
, &req
,
324 obj
->methods
[method
].name
,
325 attrbuf
[UBUS_ATTR_DATA
]);
328 blob_buf_init(&b
, 0);
329 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
330 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
331 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
334 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
336 struct ubus_request
*req
;
339 case UBUS_MSG_STATUS
:
340 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
344 ubus_process_req_status(req
, hdr
);
348 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
349 if (req
&& (req
->data_cb
|| req
->raw_data_cb
))
350 ubus_req_data(req
, hdr
);
353 case UBUS_MSG_INVOKE
:
354 ubus_process_invoke(ctx
, hdr
);
357 DPRINTF("unknown message type: %d\n", hdr
->type
);
362 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
364 if (!list_empty(&req
->list
))
367 req
->cancelled
= true;
368 ubus_process_req_data(req
);
369 list_del(&req
->list
);
372 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
374 if (!list_empty(&req
->list
))
377 list_add(&req
->list
, &ctx
->requests
);
380 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
382 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
383 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
385 while (get_next_msg(ctx
, false))
386 ubus_process_msg(ctx
, hdr
);
389 ctx
->connection_lost(ctx
);
392 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
394 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
396 if (!list_empty(&req
->list
))
397 list_del(&req
->list
);
401 return req
->status_code
;
404 return UBUS_STATUS_NO_DATA
;
406 if (!get_next_msg(ctx
, true))
407 return UBUS_STATUS_NO_DATA
;
409 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
413 case UBUS_MSG_STATUS
:
414 return ubus_process_req_status(req
, hdr
);
416 if (req
->data_cb
|| req
->raw_data_cb
)
417 ubus_req_data(req
, hdr
);
424 ubus_process_msg(ctx
, hdr
);
428 struct ubus_lookup_request
{
429 struct ubus_request req
;
430 ubus_lookup_handler_t cb
;
433 static void ubus_lookup_cb(struct ubus_request
*ureq
, int type
, struct blob_attr
*msg
)
435 struct ubus_lookup_request
*req
;
436 struct ubus_object_data obj
;
437 struct blob_attr
**attr
;
439 req
= container_of(ureq
, struct ubus_lookup_request
, req
);
440 attr
= ubus_parse_msg(msg
);
442 if (!attr
[UBUS_ATTR_OBJID
] || !attr
[UBUS_ATTR_OBJPATH
] ||
443 !attr
[UBUS_ATTR_OBJTYPE
])
446 memset(&obj
, 0, sizeof(obj
));
447 obj
.id
= blob_get_int32(attr
[UBUS_ATTR_OBJID
]);
448 obj
.path
= blob_data(attr
[UBUS_ATTR_OBJPATH
]);
449 obj
.type_id
= blob_get_int32(attr
[UBUS_ATTR_OBJTYPE
]);
450 obj
.signature
= attr
[UBUS_ATTR_SIGNATURE
];
451 req
->cb(ureq
->ctx
, &obj
, ureq
->priv
);
454 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
455 ubus_lookup_handler_t cb
, void *priv
)
457 struct ubus_lookup_request lookup
;
459 blob_buf_init(&b
, 0);
461 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
462 ubus_start_request(ctx
, &lookup
.req
, b
.head
, UBUS_MSG_LOOKUP
, 0);
463 lookup
.req
.raw_data_cb
= ubus_lookup_cb
;
464 lookup
.req
.priv
= priv
;
466 return ubus_complete_request(ctx
, &lookup
.req
);
469 static void ubus_lookup_id_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
471 struct blob_attr
**attr
;
472 uint32_t *id
= req
->priv
;
474 attr
= ubus_parse_msg(msg
);
476 if (!attr
[UBUS_ATTR_OBJID
])
479 *id
= blob_get_int32(attr
[UBUS_ATTR_OBJID
]);
482 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
)
484 struct ubus_request req
;
486 blob_buf_init(&b
, 0);
488 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, path
);
489 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_LOOKUP
, 0);
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 void 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 ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
);
523 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
524 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
526 struct ubus_request req
;
528 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
531 return ubus_complete_request(ctx
, &req
);
534 static void ubus_publish_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
536 struct ubus_object
*obj
= req
->priv
;
540 if (!attrbuf
[UBUS_ATTR_OBJID
])
543 obj
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
545 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
546 obj
->type
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
548 obj
->avl
.key
= &obj
->id
;
549 avl_insert(&req
->ctx
->objects
, &obj
->avl
);
552 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
554 const struct ubus_signature
*cur
;
562 case UBUS_SIGNATURE_END
:
564 case BLOBMSG_TYPE_INT32
:
565 case BLOBMSG_TYPE_STRING
:
566 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
568 case BLOBMSG_TYPE_TABLE
:
569 case BLOBMSG_TYPE_ARRAY
:
570 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
571 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
572 if (!ubus_push_table_data(sig
, rem
, nest_type
))
574 blobmsg_close_table(&b
, nest
);
585 static bool ubus_push_object_type(struct ubus_object_type
*type
)
588 int rem
= type
->n_signature
;
589 const struct ubus_signature
*sig
= type
->signature
;
591 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
593 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
596 m
= blobmsg_open_table(&b
, sig
->name
);
600 if (!ubus_push_table_data(&sig
, &rem
, false))
603 blobmsg_close_table(&b
, m
);
605 blob_nest_end(&b
, s
);
610 static int __ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
612 struct ubus_request req
;
615 blob_buf_init(&b
, 0);
617 if (obj
->name
&& obj
->type
) {
618 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
621 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
622 else if (!ubus_push_object_type(obj
->type
))
623 return UBUS_STATUS_INVALID_ARGUMENT
;
626 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_PUBLISH
, 0);
627 req
.raw_data_cb
= ubus_publish_cb
;
629 ret
= ubus_complete_request(ctx
, &req
);
634 return UBUS_STATUS_NO_DATA
;
639 int ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
641 if (!obj
->name
|| !obj
->type
)
642 return UBUS_STATUS_INVALID_ARGUMENT
;
644 return __ubus_publish(ctx
, obj
);
647 static int ubus_event_cb(struct ubus_context
*ctx
, struct ubus_object
*obj
,
648 struct ubus_request_data
*req
,
649 const char *method
, struct blob_attr
*msg
)
651 struct ubus_event_handler
*ev
;
653 ev
= container_of(obj
, struct ubus_event_handler
, obj
);
654 ev
->cb(ctx
, ev
, method
, msg
);
658 static const struct ubus_method event_method
= {
660 .handler
= ubus_event_cb
,
663 int ubus_register_event_handler(struct ubus_context
*ctx
,
664 struct ubus_event_handler
*ev
,
667 struct ubus_object
*obj
= &ev
->obj
;
672 obj
->methods
= &event_method
;
675 if (!!obj
->name
^ !!obj
->type
)
676 return UBUS_STATUS_INVALID_ARGUMENT
;
678 ret
= __ubus_publish(ctx
, obj
);
683 /* use a second buffer, ubus_invoke() overwrites the primary one */
684 memset(&b2
, 0, sizeof(b2
));
685 blob_buf_init(&b2
, 0);
686 blobmsg_add_u32(&b2
, "object", obj
->id
);
688 blobmsg_add_string(&b2
, "pattern", pattern
);
690 ret
= ubus_invoke(ctx
, UBUS_SYSTEM_OBJECT_EVENT
, "register", b2
.head
,
697 void ubus_default_connection_lost(struct ubus_context
*ctx
)
699 if (ctx
->sock
.registered
)
703 struct ubus_context
*ubus_connect(const char *path
)
705 struct ubus_context
*ctx
;
707 struct ubus_msghdr hdr
;
708 struct blob_attr data
;
710 struct blob_attr
*buf
;
713 path
= UBUS_UNIX_SOCKET
;
715 ctx
= calloc(1, sizeof(*ctx
));
719 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
720 if (ctx
->sock
.fd
< 0)
723 ctx
->sock
.cb
= ubus_handle_data
;
725 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
))
728 if (!ubus_validate_hdr(&hdr
.hdr
))
731 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
)
734 buf
= calloc(1, blob_raw_len(&hdr
.data
));
738 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
739 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
))
742 ctx
->local_id
= hdr
.hdr
.peer
;
745 ctx
->connection_lost
= ubus_default_connection_lost
;
747 INIT_LIST_HEAD(&ctx
->requests
);
748 avl_init(&ctx
->objects
, ubus_cmp_id
, false, NULL
);
765 void ubus_free(struct ubus_context
*ctx
)