2 * Copyright (C) 2011-2014 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 struct ubus_msghdr_buf {
38 struct ubus_msghdr hdr;
39 struct blob_attr *data;
42 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
43 struct ubus_object_data *obj,
45 typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
46 struct ubus_request_data *req,
47 const char *method, struct blob_attr *msg);
48 typedef void (*ubus_state_handler_t)(struct ubus_context *ctx, struct ubus_object *obj);
49 typedef void (*ubus_remove_handler_t)(struct ubus_context *ctx,
50 struct ubus_subscriber *obj, uint32_t id);
51 typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
52 const char *type, struct blob_attr *msg);
53 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
54 int type, struct blob_attr *msg);
55 typedef void (*ubus_fd_handler_t)(struct ubus_request *req, int fd);
56 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
57 typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req,
59 typedef void (*ubus_connect_handler_t)(struct ubus_context *ctx);
61 #define UBUS_OBJECT_TYPE(_name, _methods) \
65 .n_methods = ARRAY_SIZE(_methods), \
69 #define __UBUS_METHOD_NOARG(_name, _handler) \
73 #define __UBUS_METHOD(_name, _handler, _policy) \
74 __UBUS_METHOD_NOARG(_name, _handler), \
76 .n_policy = ARRAY_SIZE(_policy)
78 #define UBUS_METHOD(_name, _handler, _policy) \
79 { __UBUS_METHOD(_name, _handler, _policy) }
81 #define UBUS_METHOD_MASK(_name, _handler, _policy, _mask) \
83 __UBUS_METHOD(_name, _handler, _policy),\
87 #define UBUS_METHOD_NOARG(_name, _handler) \
88 { __UBUS_METHOD_NOARG(_name, _handler) }
92 ubus_handler_t handler;
95 const struct blobmsg_policy *policy;
99 struct ubus_object_type {
103 const struct ubus_method *methods;
114 struct ubus_object_type *type;
116 ubus_state_handler_t subscribe_cb;
117 bool has_subscribers;
119 const struct ubus_method *methods;
123 struct ubus_subscriber {
124 struct ubus_object obj;
127 ubus_remove_handler_t remove_cb;
130 struct ubus_event_handler {
131 struct ubus_object obj;
133 ubus_event_handler_t cb;
136 struct ubus_context {
137 struct list_head requests;
138 struct avl_tree objects;
139 struct list_head pending;
141 struct uloop_fd sock;
142 struct uloop_timeout pending_timer;
145 uint16_t request_seq;
148 void (*connection_lost)(struct ubus_context *ctx);
150 struct ubus_msghdr_buf msgbuf;
151 uint32_t msgbuf_data_len;
152 int msgbuf_reduction_counter;
155 struct ubus_object_data {
159 struct blob_attr *signature;
162 struct ubus_request_data {
172 struct ubus_request {
173 struct list_head list;
175 struct list_head pending;
185 ubus_data_handler_t raw_data_cb;
186 ubus_data_handler_t data_cb;
187 ubus_fd_handler_t fd_cb;
188 ubus_complete_handler_t complete_cb;
190 struct ubus_context *ctx;
194 struct ubus_notify_request {
195 struct ubus_request req;
197 ubus_notify_complete_handler_t status_cb;
198 ubus_notify_complete_handler_t complete_cb;
201 uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1];
204 struct ubus_auto_conn {
205 struct ubus_context ctx;
206 struct uloop_timeout timer;
208 ubus_connect_handler_t cb;
211 struct ubus_context *ubus_connect(const char *path);
212 int ubus_connect_ctx(struct ubus_context *ctx, const char *path);
213 void ubus_auto_connect(struct ubus_auto_conn *conn);
214 int ubus_reconnect(struct ubus_context *ctx, const char *path);
216 /* call this only for struct ubus_context pointers returned by ubus_connect() */
217 void ubus_free(struct ubus_context *ctx);
219 /* call this only for struct ubus_context pointers initialised by ubus_connect_ctx() */
220 void ubus_shutdown(struct ubus_context *ctx);
222 const char *ubus_strerror(int error);
224 static inline void ubus_add_uloop(struct ubus_context *ctx)
226 uloop_fd_add(&ctx->sock, ULOOP_BLOCKING | ULOOP_READ);
229 /* call this for read events on ctx->sock.fd when not using uloop */
230 static inline void ubus_handle_event(struct ubus_context *ctx)
232 ctx->sock.cb(&ctx->sock, ULOOP_READ);
235 /* ----------- raw request handling ----------- */
237 /* wait for a request to complete and return its status */
238 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
241 /* complete a request asynchronously */
242 void ubus_complete_request_async(struct ubus_context *ctx,
243 struct ubus_request *req);
245 /* abort an asynchronous request */
246 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
248 /* ----------- objects ----------- */
250 int ubus_lookup(struct ubus_context *ctx, const char *path,
251 ubus_lookup_handler_t cb, void *priv);
253 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
255 /* make an object visible to remote connections */
256 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
258 /* remove the object from the ubus connection */
259 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
261 /* add a subscriber notifications from another object */
262 int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj);
265 ubus_unregister_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj)
267 return ubus_remove_object(ctx, &obj->obj);
270 int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
271 int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
273 /* ----------- rpc ----------- */
275 /* invoke a method on a specific object */
276 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
277 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
280 /* asynchronous version of ubus_invoke() */
281 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
282 struct blob_attr *msg, struct ubus_request *req);
284 /* send a reply to an incoming object method call */
285 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
286 struct blob_attr *msg);
288 static inline void ubus_defer_request(struct ubus_context *ctx,
289 struct ubus_request_data *req,
290 struct ubus_request_data *new_req)
292 memcpy(new_req, req, sizeof(*req));
293 req->deferred = true;
296 static inline void ubus_request_set_fd(struct ubus_context *ctx,
297 struct ubus_request_data *req, int fd)
302 void ubus_complete_deferred_request(struct ubus_context *ctx,
303 struct ubus_request_data *req, int ret);
306 * send a notification to all subscribers of an object
307 * if timeout < 0, no reply is expected from subscribers
309 int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
310 const char *type, struct blob_attr *msg, int timeout);
312 int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
313 const char *type, struct blob_attr *msg,
314 struct ubus_notify_request *req);
317 /* ----------- events ----------- */
319 int ubus_send_event(struct ubus_context *ctx, const char *id,
320 struct blob_attr *data);
322 int ubus_register_event_handler(struct ubus_context *ctx,
323 struct ubus_event_handler *ev,
324 const char *pattern);
326 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
327 struct ubus_event_handler *ev)
329 return ubus_remove_object(ctx, &ev->obj);