2 * Copyright (C) 2011-2012 Felix Fietkau <nbd@openwrt.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License version 2.1
6 * as published by the Free Software Foundation
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
17 #include <libubox/avl.h>
18 #include <libubox/list.h>
19 #include <libubox/blobmsg.h>
20 #include <libubox/uloop.h>
23 #include "ubus_common.h"
25 #define UBUS_MAX_NOTIFY_PEERS 16
31 struct ubus_request_data
;
32 struct ubus_object_data
;
33 struct ubus_event_handler
;
34 struct ubus_subscriber
;
35 struct ubus_notify_request
;
37 typedef void (*ubus_lookup_handler_t
)(struct ubus_context
*ctx
,
38 struct ubus_object_data
*obj
,
40 typedef int (*ubus_handler_t
)(struct ubus_context
*ctx
, struct ubus_object
*obj
,
41 struct ubus_request_data
*req
,
42 const char *method
, struct blob_attr
*msg
);
43 typedef void (*ubus_state_handler_t
)(struct ubus_context
*ctx
, struct ubus_object
*obj
);
44 typedef void (*ubus_remove_handler_t
)(struct ubus_context
*ctx
,
45 struct ubus_subscriber
*obj
, uint32_t id
);
46 typedef void (*ubus_event_handler_t
)(struct ubus_context
*ctx
, struct ubus_event_handler
*ev
,
47 const char *type
, struct blob_attr
*msg
);
48 typedef void (*ubus_data_handler_t
)(struct ubus_request
*req
,
49 int type
, struct blob_attr
*msg
);
50 typedef void (*ubus_complete_handler_t
)(struct ubus_request
*req
, int ret
);
51 typedef void (*ubus_notify_complete_handler_t
)(struct ubus_notify_request
*req
,
54 #define UBUS_OBJECT_TYPE(_name, _methods) \
58 .n_methods = ARRAY_SIZE(_methods), \
62 #define UBUS_METHOD(_name, _handler, _policy) \
65 .handler = _handler, \
67 .n_policy = ARRAY_SIZE(_policy) \
70 #define UBUS_METHOD_NOARG(_name, _handler) \
73 .handler = _handler, \
78 ubus_handler_t handler
;
80 const struct blobmsg_policy
*policy
;
84 struct ubus_object_type
{
88 const struct ubus_method
*methods
;
99 struct ubus_object_type
*type
;
101 ubus_state_handler_t subscribe_cb
;
102 bool has_subscribers
;
104 const struct ubus_method
*methods
;
108 struct ubus_subscriber
{
109 struct ubus_object obj
;
112 ubus_remove_handler_t remove_cb
;
115 struct ubus_event_handler
{
116 struct ubus_object obj
;
118 ubus_event_handler_t cb
;
121 struct ubus_context
{
122 struct list_head requests
;
123 struct avl_tree objects
;
124 struct list_head pending
;
126 struct uloop_fd sock
;
129 uint16_t request_seq
;
132 void (*connection_lost
)(struct ubus_context
*ctx
);
135 struct ubus_msghdr hdr
;
136 char data
[UBUS_MAX_MSGLEN
];
140 struct ubus_object_data
{
144 struct blob_attr
*signature
;
147 struct ubus_request_data
{
154 struct ubus_request
{
155 struct list_head list
;
157 struct list_head pending
;
167 ubus_data_handler_t raw_data_cb
;
168 ubus_data_handler_t data_cb
;
169 ubus_complete_handler_t complete_cb
;
171 struct ubus_context
*ctx
;
175 struct ubus_notify_request
{
176 struct ubus_request req
;
178 ubus_notify_complete_handler_t status_cb
;
179 ubus_notify_complete_handler_t complete_cb
;
182 uint32_t id
[UBUS_MAX_NOTIFY_PEERS
+ 1];
185 struct ubus_context
*ubus_connect(const char *path
);
186 int ubus_reconnect(struct ubus_context
*ctx
, const char *path
);
187 void ubus_free(struct ubus_context
*ctx
);
189 const char *ubus_strerror(int error
);
191 static inline void ubus_add_uloop(struct ubus_context
*ctx
)
193 uloop_fd_add(&ctx
->sock
, ULOOP_BLOCKING
| ULOOP_READ
);
196 /* call this for read events on ctx->sock.fd when not using uloop */
197 static inline void ubus_handle_event(struct ubus_context
*ctx
)
199 ctx
->sock
.cb(&ctx
->sock
, ULOOP_READ
);
202 /* ----------- raw request handling ----------- */
204 /* wait for a request to complete and return its status */
205 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
208 /* complete a request asynchronously */
209 void ubus_complete_request_async(struct ubus_context
*ctx
,
210 struct ubus_request
*req
);
212 /* abort an asynchronous request */
213 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
);
215 /* ----------- objects ----------- */
217 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
218 ubus_lookup_handler_t cb
, void *priv
);
220 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
);
222 /* make an object visible to remote connections */
223 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
225 /* remove the object from the ubus connection */
226 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
228 /* add a subscriber notifications from another object */
229 int ubus_register_subscriber(struct ubus_context
*ctx
, struct ubus_subscriber
*obj
);
230 int ubus_subscribe(struct ubus_context
*ctx
, struct ubus_subscriber
*obj
, uint32_t id
);
231 int ubus_unsubscribe(struct ubus_context
*ctx
, struct ubus_subscriber
*obj
, uint32_t id
);
233 /* ----------- rpc ----------- */
235 /* invoke a method on a specific object */
236 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
237 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
,
240 /* asynchronous version of ubus_invoke() */
241 int ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
242 struct blob_attr
*msg
, struct ubus_request
*req
);
244 /* send a reply to an incoming object method call */
245 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
246 struct blob_attr
*msg
);
248 static inline void ubus_defer_request(struct ubus_context
*ctx
,
249 struct ubus_request_data
*req
,
250 struct ubus_request_data
*new_req
)
252 memcpy(new_req
, req
, sizeof(*req
));
253 req
->deferred
= true;
256 void ubus_complete_deferred_request(struct ubus_context
*ctx
,
257 struct ubus_request_data
*req
, int ret
);
260 * send a notification to all subscribers of an object
261 * if timeout < 0, no reply is expected from subscribers
263 int ubus_notify(struct ubus_context
*ctx
, struct ubus_object
*obj
,
264 const char *type
, struct blob_attr
*msg
, int timeout
);
266 int ubus_notify_async(struct ubus_context
*ctx
, struct ubus_object
*obj
,
267 const char *type
, struct blob_attr
*msg
,
268 struct ubus_notify_request
*req
);
271 /* ----------- events ----------- */
273 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
274 struct blob_attr
*data
);
276 int ubus_register_event_handler(struct ubus_context
*ctx
,
277 struct ubus_event_handler
*ev
,
278 const char *pattern
);
280 static inline int ubus_unregister_event_handler(struct ubus_context
*ctx
,
281 struct ubus_event_handler
*ev
)
283 return ubus_remove_object(ctx
, &ev
->obj
);