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",
32 static struct blob_buf b
;
34 static const struct blob_attr_info ubus_policy
[UBUS_ATTR_MAX
] = {
35 [UBUS_ATTR_STATUS
] = { .type
= BLOB_ATTR_INT32
},
36 [UBUS_ATTR_OBJID
] = { .type
= BLOB_ATTR_INT32
},
37 [UBUS_ATTR_OBJPATH
] = { .type
= BLOB_ATTR_STRING
},
38 [UBUS_ATTR_METHOD
] = { .type
= BLOB_ATTR_STRING
},
40 static struct blob_attr
*attrbuf
[UBUS_ATTR_MAX
];
42 struct ubus_pending_data
{
43 struct list_head list
;
45 struct blob_attr data
[];
48 static int ubus_cmp_id(const void *k1
, const void *k2
, void *ptr
)
50 const uint32_t *id1
= k1
, *id2
= k2
;
58 struct blob_attr
**ubus_parse_msg(struct blob_attr
*msg
)
60 blob_parse(msg
, attrbuf
, ubus_policy
, UBUS_ATTR_MAX
);
64 const char *ubus_strerror(int error
)
68 if (error
< 0 || error
>= __UBUS_STATUS_LAST
)
71 if (!__ubus_strerror
[error
])
74 return __ubus_strerror
[error
];
77 sprintf(err
, "Unknown error: %d", error
);
81 static int ubus_send_msg(struct ubus_context
*ctx
, uint32_t seq
,
82 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
84 struct ubus_msghdr hdr
;
85 struct iovec iov
[2] = {
99 iov
[1].iov_base
= (char *) msg
;
100 iov
[1].iov_len
= blob_raw_len(msg
);
102 return writev(ctx
->sock
.fd
, iov
, 2);
105 int ubus_start_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
106 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
108 memset(req
, 0, sizeof(*req
));
110 INIT_LIST_HEAD(&req
->list
);
111 INIT_LIST_HEAD(&req
->pending
);
114 req
->seq
= ++ctx
->request_seq
;
115 return ubus_send_msg(ctx
, req
->seq
, msg
, cmd
, peer
);
118 static bool recv_retry(int fd
, struct iovec
*iov
, bool wait
)
122 while (iov
->iov_len
> 0) {
123 bytes
= read(fd
, iov
->iov_base
, iov
->iov_len
);
129 if (errno
!= EAGAIN
) {
138 iov
->iov_len
-= bytes
;
139 iov
->iov_base
+= bytes
;
145 static bool ubus_validate_hdr(struct ubus_msghdr
*hdr
)
147 if (hdr
->version
!= 0)
150 if (blob_raw_len(hdr
->data
) < sizeof(*hdr
->data
))
153 if (blob_raw_len(hdr
->data
) + sizeof(*hdr
) > UBUS_MAX_MSGLEN
)
159 static bool get_next_msg(struct ubus_context
*ctx
, bool wait
)
161 struct iovec iov
= STATIC_IOV(ctx
->msgbuf
.hdr
);
163 /* receive header + start attribute */
164 iov
.iov_len
+= sizeof(struct blob_attr
);
165 if (!recv_retry(ctx
->sock
.fd
, &iov
, wait
))
168 iov
.iov_len
= blob_len(ctx
->msgbuf
.hdr
.data
);
169 if (iov
.iov_len
> 0 && !recv_retry(ctx
->sock
.fd
, &iov
, true))
172 return ubus_validate_hdr(&ctx
->msgbuf
.hdr
);
175 static bool ubus_get_status(struct ubus_msghdr
*hdr
, int *ret
)
177 ubus_parse_msg(hdr
->data
);
179 if (!attrbuf
[UBUS_ATTR_STATUS
])
182 *ret
= blob_get_int32(attrbuf
[UBUS_ATTR_STATUS
]);
186 static void ubus_process_req_data(struct ubus_request
*req
)
188 struct ubus_pending_data
*data
;
190 while (!list_empty(&req
->pending
)) {
191 data
= list_first_entry(&req
->pending
,
192 struct ubus_pending_data
, list
);
193 list_del(&data
->list
);
195 req
->data_cb(req
, data
->type
, data
->data
);
200 static void ubus_req_complete_cb(struct ubus_request
*req
)
202 ubus_complete_handler_t cb
= req
->complete_cb
;
207 req
->complete_cb
= NULL
;
208 cb(req
, req
->status_code
);
211 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
213 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
215 if (!list_empty(&req
->list
))
216 list_del(&req
->list
);
218 ubus_get_status(hdr
, &ret
);
219 req
->peer
= hdr
->peer
;
220 req
->status_msg
= true;
221 req
->status_code
= ret
;
223 ubus_req_complete_cb(req
);
228 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
230 struct ubus_pending_data
*data
;
235 req
->data_cb(req
, hdr
->type
, hdr
->data
);
236 ubus_process_req_data(req
);
237 req
->blocked
= false;
240 ubus_req_complete_cb(req
);
245 len
= blob_raw_len(hdr
->data
);
246 data
= calloc(1, sizeof(*data
) + len
);
250 data
->type
= hdr
->type
;
251 memcpy(data
->data
, hdr
->data
, len
);
252 list_add(&data
->list
, &req
->pending
);
255 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
257 struct ubus_request
*req
;
259 list_for_each_entry(req
, &ctx
->requests
, list
) {
260 if (seq
!= req
->seq
|| peer
!= req
->peer
)
268 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
270 struct ubus_request_data req
;
271 struct ubus_object
*obj
;
276 ubus_parse_msg(hdr
->data
);
278 if (!attrbuf
[UBUS_ATTR_METHOD
] || !attrbuf
[UBUS_ATTR_OBJID
]) {
279 ret
= UBUS_STATUS_INVALID_ARGUMENT
;
283 objid
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
284 obj
= avl_find_element(&ctx
->objects
, &objid
, obj
, avl
);
286 ret
= UBUS_STATUS_NOT_FOUND
;
290 for (method
= 0; method
< obj
->n_methods
; method
++)
291 if (!strcmp(obj
->methods
[method
].name
,
292 blob_data(attrbuf
[UBUS_ATTR_METHOD
])))
296 ret
= UBUS_STATUS_METHOD_NOT_FOUND
;
301 req
.peer
= hdr
->peer
;
303 ret
= obj
->methods
[method
].handler(obj
, &req
, obj
->methods
[method
].name
,
304 attrbuf
[UBUS_ATTR_DATA
]);
307 blob_buf_init(&b
, 0);
308 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
309 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
310 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
313 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
315 struct ubus_request
*req
;
318 case UBUS_MSG_STATUS
:
319 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
323 ubus_process_req_status(req
, hdr
);
327 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
328 if (req
&& req
->data_cb
)
329 ubus_req_data(req
, hdr
);
332 case UBUS_MSG_INVOKE
:
333 ubus_process_invoke(ctx
, hdr
);
336 DPRINTF("unknown message type: %d\n", hdr
->type
);
341 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
343 if (!list_empty(&req
->list
))
346 req
->cancelled
= true;
347 ubus_process_req_data(req
);
348 list_del(&req
->list
);
351 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
353 if (!list_empty(&req
->list
))
356 list_add(&req
->list
, &ctx
->requests
);
359 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
361 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
362 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
364 while (get_next_msg(ctx
, false))
365 ubus_process_msg(ctx
, hdr
);
368 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
370 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
372 if (!list_empty(&req
->list
))
373 list_del(&req
->list
);
377 return req
->status_code
;
380 return UBUS_STATUS_NO_DATA
;
382 if (!get_next_msg(ctx
, true))
383 return UBUS_STATUS_NO_DATA
;
385 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
389 case UBUS_MSG_STATUS
:
390 return ubus_process_req_status(req
, hdr
);
393 ubus_req_data(req
, hdr
);
400 ubus_process_msg(ctx
, hdr
);
404 void ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
405 struct blob_attr
*msg
, struct ubus_request
*req
)
407 blob_buf_init(&b
, 0);
408 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
);
409 blob_put_string(&b
, UBUS_ATTR_METHOD
, method
);
410 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
412 ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
);
415 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
416 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
418 struct ubus_request req
;
420 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
423 return ubus_complete_request(ctx
, &req
);
426 static void ubus_publish_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
428 struct ubus_object
*obj
= req
->priv
;
432 if (!attrbuf
[UBUS_ATTR_OBJID
])
435 obj
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
437 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
438 obj
->type
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
440 obj
->avl
.key
= &obj
->id
;
441 avl_insert(&req
->ctx
->objects
, &obj
->avl
);
444 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
446 const struct ubus_signature
*cur
;
454 case UBUS_SIGNATURE_END
:
456 case BLOBMSG_TYPE_INT32
:
457 case BLOBMSG_TYPE_STRING
:
458 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
460 case BLOBMSG_TYPE_TABLE
:
461 case BLOBMSG_TYPE_ARRAY
:
462 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
463 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
464 if (!ubus_push_table_data(sig
, rem
, nest_type
))
466 blobmsg_close_table(&b
, nest
);
477 static bool ubus_push_object_type(struct ubus_object_type
*type
)
480 int rem
= type
->n_signature
;
481 const struct ubus_signature
*sig
= type
->signature
;
483 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
485 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
488 m
= blobmsg_open_table(&b
, sig
->name
);
492 if (!ubus_push_table_data(&sig
, &rem
, false))
495 blobmsg_close_table(&b
, m
);
497 blob_nest_end(&b
, s
);
502 int ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
504 struct ubus_request req
;
507 if (obj
->id
|| !obj
->name
|| !obj
->type
)
508 return UBUS_STATUS_INVALID_ARGUMENT
;
510 blob_buf_init(&b
, 0);
511 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
514 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
515 else if (!ubus_push_object_type(obj
->type
))
516 return UBUS_STATUS_INVALID_ARGUMENT
;
518 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_PUBLISH
, 0);
519 req
.data_cb
= ubus_publish_cb
;
521 ret
= ubus_complete_request(ctx
, &req
);
526 return UBUS_STATUS_NO_DATA
;
531 struct ubus_context
*ubus_connect(const char *path
)
533 struct ubus_context
*ctx
;
535 struct ubus_msghdr hdr
;
536 struct blob_attr data
;
538 struct blob_attr
*buf
;
541 path
= UBUS_UNIX_SOCKET
;
543 ctx
= calloc(1, sizeof(*ctx
));
547 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
548 if (ctx
->sock
.fd
< 0) {
549 DPRINTF("Failed to connect to server\n");
552 ctx
->sock
.cb
= ubus_handle_data
;
554 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
)) {
555 DPRINTF("Failed to read initial message data\n");
559 if (!ubus_validate_hdr(&hdr
.hdr
)) {
560 DPRINTF("Failed to validate initial message header\n");
564 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
) {
565 DPRINTF("Unexpected initial message\n");
569 buf
= calloc(1, blob_raw_len(&hdr
.data
));
573 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
574 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
)) {
575 DPRINTF("Failed to retrieve initial message data\n");
579 ctx
->local_id
= hdr
.hdr
.peer
;
582 INIT_LIST_HEAD(&ctx
->requests
);
583 avl_init(&ctx
->objects
, ubus_cmp_id
, false, NULL
);
585 if (!ctx
->local_id
) {
586 DPRINTF("Failed to get local peer id\n");
602 void ubus_free(struct ubus_context
*ctx
)