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_NOT_FOUND
] = "Not found",
28 [UBUS_STATUS_NO_DATA
] = "No response",
31 static struct blob_buf b
;
33 static const struct blob_attr_info ubus_policy
[UBUS_ATTR_MAX
] = {
34 [UBUS_ATTR_STATUS
] = { .type
= BLOB_ATTR_INT32
},
35 [UBUS_ATTR_OBJID
] = { .type
= BLOB_ATTR_INT32
},
36 [UBUS_ATTR_OBJPATH
] = { .type
= BLOB_ATTR_STRING
},
38 static struct blob_attr
*attrbuf
[UBUS_ATTR_MAX
];
40 struct ubus_pending_data
{
41 struct list_head list
;
43 struct blob_attr data
[];
46 struct blob_attr
**ubus_parse_msg(struct blob_attr
*msg
)
48 blob_parse(msg
, attrbuf
, ubus_policy
, UBUS_ATTR_MAX
);
52 const char *ubus_strerror(int error
)
56 if (error
< 0 || error
>= __UBUS_STATUS_LAST
)
59 if (!__ubus_strerror
[error
])
62 return __ubus_strerror
[error
];
65 sprintf(err
, "Unknown error: %d", error
);
69 static int ubus_send_msg(struct ubus_context
*ctx
, uint32_t seq
,
70 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
72 struct ubus_msghdr hdr
;
73 struct iovec iov
[2] = {
87 iov
[1].iov_base
= (char *) msg
;
88 iov
[1].iov_len
= blob_raw_len(msg
);
90 return writev(ctx
->sock
.fd
, iov
, 2);
93 int ubus_start_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
94 struct blob_attr
*msg
, int cmd
, uint32_t peer
)
96 memset(req
, 0, sizeof(*req
));
98 INIT_LIST_HEAD(&req
->list
);
99 INIT_LIST_HEAD(&req
->pending
);
101 req
->seq
= ++ctx
->request_seq
;
102 return ubus_send_msg(ctx
, req
->seq
, msg
, cmd
, peer
);
105 static bool recv_retry(int fd
, struct iovec
*iov
, bool wait
)
109 while (iov
->iov_len
> 0) {
110 bytes
= read(fd
, iov
->iov_base
, iov
->iov_len
);
116 if (errno
!= EAGAIN
) {
125 iov
->iov_len
-= bytes
;
126 iov
->iov_base
+= bytes
;
132 static bool ubus_validate_hdr(struct ubus_msghdr
*hdr
)
134 if (hdr
->version
!= 0)
137 if (blob_raw_len(hdr
->data
) < sizeof(*hdr
->data
))
140 if (blob_raw_len(hdr
->data
) + sizeof(*hdr
) > UBUS_MAX_MSGLEN
)
146 static bool get_next_msg(struct ubus_context
*ctx
, bool wait
)
148 struct iovec iov
= STATIC_IOV(ctx
->msgbuf
.hdr
);
150 /* receive header + start attribute */
151 iov
.iov_len
+= sizeof(struct blob_attr
);
152 if (!recv_retry(ctx
->sock
.fd
, &iov
, wait
))
155 iov
.iov_len
= blob_len(ctx
->msgbuf
.hdr
.data
);
156 if (iov
.iov_len
> 0 && !recv_retry(ctx
->sock
.fd
, &iov
, true))
159 return ubus_validate_hdr(&ctx
->msgbuf
.hdr
);
162 static bool ubus_get_status(struct ubus_msghdr
*hdr
, int *ret
)
164 ubus_parse_msg(hdr
->data
);
166 if (!attrbuf
[UBUS_ATTR_STATUS
])
169 *ret
= blob_get_int32(attrbuf
[UBUS_ATTR_STATUS
]);
173 static void ubus_process_req_data(struct ubus_request
*req
)
175 struct ubus_pending_data
*data
;
177 while (!list_empty(&req
->pending
)) {
178 data
= list_first_entry(&req
->pending
,
179 struct ubus_pending_data
, list
);
180 list_del(&data
->list
);
182 req
->data_cb(req
, data
->type
, data
->data
);
187 static void ubus_req_complete_cb(struct ubus_request
*req
)
189 ubus_complete_handler_t cb
= req
->complete_cb
;
194 req
->complete_cb
= NULL
;
195 cb(req
, req
->status_code
);
198 static int ubus_process_req_status(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
200 int ret
= UBUS_STATUS_INVALID_ARGUMENT
;
202 if (!list_empty(&req
->list
))
203 list_del(&req
->list
);
205 ubus_get_status(hdr
, &ret
);
206 req
->peer
= hdr
->peer
;
207 req
->status_msg
= true;
208 req
->status_code
= ret
;
210 ubus_req_complete_cb(req
);
215 static void ubus_req_data(struct ubus_request
*req
, struct ubus_msghdr
*hdr
)
217 struct ubus_pending_data
*data
;
222 req
->data_cb(req
, hdr
->type
, hdr
->data
);
223 ubus_process_req_data(req
);
224 req
->blocked
= false;
227 ubus_req_complete_cb(req
);
232 len
= blob_raw_len(hdr
->data
);
233 data
= calloc(1, sizeof(*data
) + len
);
237 data
->type
= hdr
->type
;
238 memcpy(data
->data
, hdr
->data
, len
);
239 list_add(&data
->list
, &req
->pending
);
242 static struct ubus_request
*ubus_find_request(struct ubus_context
*ctx
, uint32_t seq
, uint32_t peer
)
244 struct ubus_request
*req
;
246 list_for_each_entry(req
, &ctx
->requests
, list
) {
247 if (seq
!= req
->seq
|| peer
!= req
->peer
)
255 static void ubus_process_invoke(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
260 ubus_parse_msg(hdr
->data
);
262 if (attrbuf
[UBUS_ATTR_OBJID
])
263 objid
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
265 blob_buf_init(&b
, 0);
266 blob_put_int32(&b
, UBUS_ATTR_STATUS
, ret
);
267 blob_put_int32(&b
, UBUS_ATTR_OBJID
, objid
);
268 ubus_send_msg(ctx
, hdr
->seq
, b
.head
, UBUS_MSG_STATUS
, hdr
->peer
);
271 static void ubus_process_msg(struct ubus_context
*ctx
, struct ubus_msghdr
*hdr
)
273 struct ubus_request
*req
;
276 case UBUS_MSG_STATUS
:
277 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
281 ubus_process_req_status(req
, hdr
);
285 req
= ubus_find_request(ctx
, hdr
->seq
, hdr
->peer
);
286 if (req
&& req
->data_cb
)
287 ubus_req_data(req
, hdr
);
290 case UBUS_MSG_INVOKE
:
291 ubus_process_invoke(ctx
, hdr
);
294 DPRINTF("unknown message type: %d\n", hdr
->type
);
299 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
301 if (!list_empty(&req
->list
))
304 req
->cancelled
= true;
305 ubus_process_req_data(req
);
306 list_del(&req
->list
);
309 void ubus_complete_request_async(struct ubus_context
*ctx
, struct ubus_request
*req
)
311 if (!list_empty(&req
->list
))
314 list_add(&req
->list
, &ctx
->requests
);
317 static void ubus_handle_data(struct uloop_fd
*u
, unsigned int events
)
319 struct ubus_context
*ctx
= container_of(u
, struct ubus_context
, sock
);
320 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
322 while (get_next_msg(ctx
, false))
323 ubus_process_msg(ctx
, hdr
);
326 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
)
328 struct ubus_msghdr
*hdr
= &ctx
->msgbuf
.hdr
;
330 if (!list_empty(&req
->list
))
331 list_del(&req
->list
);
335 return req
->status_code
;
338 return UBUS_STATUS_NO_DATA
;
340 if (!get_next_msg(ctx
, true))
341 return UBUS_STATUS_NO_DATA
;
343 if (hdr
->seq
!= req
->seq
|| hdr
->peer
!= req
->peer
)
347 case UBUS_MSG_STATUS
:
348 return ubus_process_req_status(req
, hdr
);
351 ubus_req_data(req
, hdr
);
358 ubus_process_msg(ctx
, hdr
);
362 void ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
363 struct blob_attr
*msg
, struct ubus_request
*req
)
365 blob_buf_init(&b
, 0);
366 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
);
367 blob_put_string(&b
, UBUS_ATTR_METHOD
, method
);
368 blob_put(&b
, UBUS_ATTR_DATA
, blob_data(msg
), blob_len(msg
));
370 ubus_start_request(ctx
, req
, b
.head
, UBUS_MSG_INVOKE
, obj
);
373 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
374 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
)
376 struct ubus_request req
;
378 ubus_invoke_async(ctx
, obj
, method
, msg
, &req
);
381 return ubus_complete_request(ctx
, &req
);
384 static void ubus_publish_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
386 struct ubus_object
*obj
= req
->priv
;
390 if (!attrbuf
[UBUS_ATTR_OBJID
])
393 obj
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJID
]);
395 if (attrbuf
[UBUS_ATTR_OBJTYPE
])
396 obj
->type
->id
= blob_get_int32(attrbuf
[UBUS_ATTR_OBJTYPE
]);
399 static bool ubus_push_table_data(const struct ubus_signature
**sig
, int *rem
, bool array
)
401 const struct ubus_signature
*cur
;
409 case UBUS_SIGNATURE_END
:
411 case BLOBMSG_TYPE_INT32
:
412 case BLOBMSG_TYPE_STRING
:
413 blobmsg_add_u32(&b
, cur
->name
, cur
->type
);
415 case BLOBMSG_TYPE_TABLE
:
416 case BLOBMSG_TYPE_ARRAY
:
417 nest_type
= cur
->type
== BLOBMSG_TYPE_ARRAY
;
418 nest
= blobmsg_open_nested(&b
, cur
->name
, nest_type
);
419 if (!ubus_push_table_data(sig
, rem
, nest_type
))
421 blobmsg_close_table(&b
, nest
);
432 static bool ubus_push_object_type(struct ubus_object_type
*type
)
435 int rem
= type
->n_signature
;
436 const struct ubus_signature
*sig
= type
->signature
;
438 s
= blob_nest_start(&b
, UBUS_ATTR_SIGNATURE
);
440 if (sig
->type
!= UBUS_SIGNATURE_METHOD
)
443 m
= blobmsg_open_table(&b
, sig
->name
);
447 if (!ubus_push_table_data(&sig
, &rem
, false))
450 blobmsg_close_table(&b
, m
);
452 blob_nest_end(&b
, s
);
457 int ubus_publish(struct ubus_context
*ctx
, struct ubus_object
*obj
)
459 struct ubus_request req
;
462 if (obj
->id
|| !obj
->name
|| !obj
->type
)
463 return UBUS_STATUS_INVALID_ARGUMENT
;
465 blob_buf_init(&b
, 0);
466 blob_put_string(&b
, UBUS_ATTR_OBJPATH
, obj
->name
);
468 blob_put_int32(&b
, UBUS_ATTR_OBJID
, obj
->parent
->id
);
471 blob_put_int32(&b
, UBUS_ATTR_OBJTYPE
, obj
->type
->id
);
472 else if (!ubus_push_object_type(obj
->type
))
473 return UBUS_STATUS_INVALID_ARGUMENT
;
475 ubus_start_request(ctx
, &req
, b
.head
, UBUS_MSG_PUBLISH
, 0);
476 req
.data_cb
= ubus_publish_cb
;
478 ret
= ubus_complete_request(ctx
, &req
);
483 return UBUS_STATUS_NO_DATA
;
488 struct ubus_context
*ubus_connect(const char *path
)
490 struct ubus_context
*ctx
;
492 struct ubus_msghdr hdr
;
493 struct blob_attr data
;
495 struct blob_attr
*buf
;
498 path
= UBUS_UNIX_SOCKET
;
500 ctx
= calloc(1, sizeof(*ctx
));
504 ctx
->sock
.fd
= usock(USOCK_UNIX
, path
, NULL
);
505 if (ctx
->sock
.fd
< 0) {
506 DPRINTF("Failed to connect to server\n");
509 ctx
->sock
.cb
= ubus_handle_data
;
511 if (read(ctx
->sock
.fd
, &hdr
, sizeof(hdr
)) != sizeof(hdr
)) {
512 DPRINTF("Failed to read initial message data\n");
516 if (!ubus_validate_hdr(&hdr
.hdr
)) {
517 DPRINTF("Failed to validate initial message header\n");
521 if (hdr
.hdr
.type
!= UBUS_MSG_HELLO
) {
522 DPRINTF("Unexpected initial message\n");
526 buf
= calloc(1, blob_raw_len(&hdr
.data
));
530 memcpy(buf
, &hdr
.data
, sizeof(hdr
.data
));
531 if (read(ctx
->sock
.fd
, blob_data(buf
), blob_len(buf
)) != blob_len(buf
)) {
532 DPRINTF("Failed to retrieve initial message data\n");
536 ctx
->local_id
= hdr
.hdr
.peer
;
537 INIT_LIST_HEAD(&ctx
->requests
);
540 if (!ctx
->local_id
) {
541 DPRINTF("Failed to get local peer id\n");
557 void ubus_free(struct ubus_context
*ctx
)