2 * Copyright (C) 2011 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.
14 #include <libubox/avl.h>
15 #include <libubox/list.h>
16 #include <libubox/blobmsg.h>
17 #include <libubox/uloop.h>
20 #include "ubus_common.h"
26 struct ubus_request_data
;
27 struct ubus_object_data
;
28 struct ubus_event_handler
;
29 struct ubus_watch_object
;
31 typedef void (*ubus_lookup_handler_t
)(struct ubus_context
*ctx
,
32 struct ubus_object_data
*obj
,
34 typedef int (*ubus_handler_t
)(struct ubus_context
*ctx
, struct ubus_object
*obj
,
35 struct ubus_request_data
*req
,
36 const char *method
, struct blob_attr
*msg
);
37 typedef void (*ubus_event_handler_t
)(struct ubus_context
*ctx
, struct ubus_event_handler
*ev
,
38 const char *type
, struct blob_attr
*msg
);
39 typedef void (*ubus_watch_handler_t
)(struct ubus_context
*ctx
, struct ubus_watch_object
*w
,
41 typedef void (*ubus_data_handler_t
)(struct ubus_request
*req
,
42 int type
, struct blob_attr
*msg
);
43 typedef void (*ubus_complete_handler_t
)(struct ubus_request
*req
, int ret
);
45 #define UBUS_OBJECT_TYPE(_name, _methods) \
49 .n_methods = ARRAY_SIZE(_methods), \
53 #define UBUS_METHOD(_name, _handler, _policy) \
56 .handler = _handler, \
58 .n_policy = ARRAY_SIZE(_policy) \
63 ubus_handler_t handler
;
65 const struct blobmsg_policy
*policy
;
69 struct ubus_object_type
{
73 const struct ubus_method
*methods
;
84 struct ubus_object_type
*type
;
86 const struct ubus_method
*methods
;
90 struct ubus_watch_object
{
91 struct ubus_object obj
;
93 ubus_watch_handler_t cb
;
96 struct ubus_event_handler
{
97 struct ubus_object obj
;
99 ubus_event_handler_t cb
;
102 struct ubus_context
{
103 struct list_head requests
;
104 struct avl_tree objects
;
105 struct list_head pending
;
107 struct uloop_fd sock
;
110 uint32_t request_seq
;
113 void (*connection_lost
)(struct ubus_context
*ctx
);
116 struct ubus_msghdr hdr
;
117 char data
[UBUS_MAX_MSGLEN
];
121 struct ubus_object_data
{
125 struct blob_attr
*signature
;
128 struct ubus_request_data
{
134 struct ubus_request
{
135 struct list_head list
;
137 struct list_head pending
;
146 ubus_data_handler_t raw_data_cb
;
147 ubus_data_handler_t data_cb
;
148 ubus_complete_handler_t complete_cb
;
150 struct ubus_context
*ctx
;
155 struct ubus_context
*ubus_connect(const char *path
);
156 void ubus_free(struct ubus_context
*ctx
);
158 const char *ubus_strerror(int error
);
160 static inline void ubus_add_uloop(struct ubus_context
*ctx
)
162 uloop_fd_add(&ctx
->sock
, ULOOP_BLOCKING
| ULOOP_READ
);
165 /* call this for read events on ctx->sock.fd when not using uloop */
166 static inline void ubus_handle_event(struct ubus_context
*ctx
)
168 ctx
->sock
.cb(&ctx
->sock
, ULOOP_READ
);
171 /* ----------- raw request handling ----------- */
173 /* wait for a request to complete and return its status */
174 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
,
177 /* complete a request asynchronously */
178 void ubus_complete_request_async(struct ubus_context
*ctx
,
179 struct ubus_request
*req
);
181 /* abort an asynchronous request */
182 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
);
184 /* ----------- objects ----------- */
186 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
187 ubus_lookup_handler_t cb
, void *priv
);
189 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
);
191 /* make an object visible to remote connections */
192 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
194 /* remove the object from the ubus connection */
195 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
197 /* add an object for watching other object state changes */
198 int ubus_register_watch_object(struct ubus_context
*ctx
, struct ubus_watch_object
*obj
);
200 int ubus_watch_object_add(struct ubus_context
*ctx
, struct ubus_watch_object
*obj
, uint32_t id
);
202 int ubus_watch_object_remove(struct ubus_context
*ctx
, struct ubus_watch_object
*obj
, uint32_t id
);
204 /* ----------- rpc ----------- */
206 /* invoke a method on a specific object */
207 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
208 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
,
211 /* asynchronous version of ubus_invoke() */
212 int ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
213 struct blob_attr
*msg
, struct ubus_request
*req
);
215 /* send a reply to an incoming object method call */
216 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
217 struct blob_attr
*msg
);
219 /* ----------- events ----------- */
221 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
222 struct blob_attr
*data
);
224 int ubus_register_event_handler(struct ubus_context
*ctx
,
225 struct ubus_event_handler
*ev
,
226 const char *pattern
);
228 static inline int ubus_unregister_event_handler(struct ubus_context
*ctx
,
229 struct ubus_event_handler
*ev
)
231 return ubus_remove_object(ctx
, &ev
->obj
);