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 static inline struct blob_attr *
38 ubus_msghdr_data(struct ubus_msghdr *hdr)
40 return (struct blob_attr *) (hdr + 1);
43 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
44 struct ubus_object_data *obj,
46 typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
47 struct ubus_request_data *req,
48 const char *method, struct blob_attr *msg);
49 typedef void (*ubus_state_handler_t)(struct ubus_context *ctx, struct ubus_object *obj);
50 typedef void (*ubus_remove_handler_t)(struct ubus_context *ctx,
51 struct ubus_subscriber *obj, uint32_t id);
52 typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
53 const char *type, struct blob_attr *msg);
54 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
55 int type, struct blob_attr *msg);
56 typedef void (*ubus_fd_handler_t)(struct ubus_request *req, int fd);
57 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
58 typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req,
60 typedef void (*ubus_connect_handler_t)(struct ubus_context *ctx);
62 #define UBUS_OBJECT_TYPE(_name, _methods) \
66 .n_methods = ARRAY_SIZE(_methods), \
70 #define __UBUS_METHOD_NOARG(_name, _handler) \
74 #define __UBUS_METHOD(_name, _handler, _policy) \
75 __UBUS_METHOD_NOARG(_name, _handler), \
77 .n_policy = ARRAY_SIZE(_policy)
79 #define UBUS_METHOD(_name, _handler, _policy) \
80 { __UBUS_METHOD(_name, _handler, _policy) }
82 #define UBUS_METHOD_MASK(_name, _handler, _policy, _mask) \
84 __UBUS_METHOD(_name, _handler, _policy),\
88 #define UBUS_METHOD_NOARG(_name, _handler) \
89 { __UBUS_METHOD_NOARG(_name, _handler) }
93 ubus_handler_t handler;
96 const struct blobmsg_policy *policy;
100 struct ubus_object_type {
104 const struct ubus_method *methods;
115 struct ubus_object_type *type;
117 ubus_state_handler_t subscribe_cb;
118 bool has_subscribers;
120 const struct ubus_method *methods;
124 struct ubus_subscriber {
125 struct ubus_object obj;
128 ubus_remove_handler_t remove_cb;
131 struct ubus_event_handler {
132 struct ubus_object obj;
134 ubus_event_handler_t cb;
137 struct ubus_context {
138 struct list_head requests;
139 struct avl_tree objects;
140 struct list_head pending;
142 struct uloop_fd sock;
145 uint16_t request_seq;
148 void (*connection_lost)(struct ubus_context *ctx);
151 struct ubus_msghdr hdr;
152 char data[UBUS_MAX_MSGLEN];
156 struct ubus_object_data {
160 struct blob_attr *signature;
163 struct ubus_request_data {
173 struct ubus_request {
174 struct list_head list;
176 struct list_head pending;
186 ubus_data_handler_t raw_data_cb;
187 ubus_data_handler_t data_cb;
188 ubus_fd_handler_t fd_cb;
189 ubus_complete_handler_t complete_cb;
191 struct ubus_context *ctx;
195 struct ubus_notify_request {
196 struct ubus_request req;
198 ubus_notify_complete_handler_t status_cb;
199 ubus_notify_complete_handler_t complete_cb;
202 uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1];
205 struct ubus_auto_conn {
206 struct ubus_context ctx;
207 struct uloop_timeout timer;
209 ubus_connect_handler_t cb;
212 struct ubus_context *ubus_connect(const char *path);
213 void ubus_auto_connect(struct ubus_auto_conn *conn);
214 int ubus_reconnect(struct ubus_context *ctx, const char *path);
215 void ubus_free(struct ubus_context *ctx);
217 const char *ubus_strerror(int error);
219 static inline void ubus_add_uloop(struct ubus_context *ctx)
221 uloop_fd_add(&ctx->sock, ULOOP_BLOCKING | ULOOP_READ);
224 /* call this for read events on ctx->sock.fd when not using uloop */
225 static inline void ubus_handle_event(struct ubus_context *ctx)
227 ctx->sock.cb(&ctx->sock, ULOOP_READ);
230 /* ----------- raw request handling ----------- */
232 /* wait for a request to complete and return its status */
233 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
236 /* complete a request asynchronously */
237 void ubus_complete_request_async(struct ubus_context *ctx,
238 struct ubus_request *req);
240 /* abort an asynchronous request */
241 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
243 /* ----------- objects ----------- */
245 int ubus_lookup(struct ubus_context *ctx, const char *path,
246 ubus_lookup_handler_t cb, void *priv);
248 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
250 /* make an object visible to remote connections */
251 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
253 /* remove the object from the ubus connection */
254 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
256 /* add a subscriber notifications from another object */
257 int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj);
260 ubus_unregister_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj)
262 return ubus_remove_object(ctx, &obj->obj);
265 int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
266 int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
268 /* ----------- rpc ----------- */
270 /* invoke a method on a specific object */
271 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
272 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
275 /* asynchronous version of ubus_invoke() */
276 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
277 struct blob_attr *msg, struct ubus_request *req);
279 /* send a reply to an incoming object method call */
280 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
281 struct blob_attr *msg);
283 static inline void ubus_defer_request(struct ubus_context *ctx,
284 struct ubus_request_data *req,
285 struct ubus_request_data *new_req)
287 memcpy(new_req, req, sizeof(*req));
288 req->deferred = true;
291 static inline void ubus_request_set_fd(struct ubus_context *ctx,
292 struct ubus_request_data *req, int fd)
297 void ubus_complete_deferred_request(struct ubus_context *ctx,
298 struct ubus_request_data *req, int ret);
301 * send a notification to all subscribers of an object
302 * if timeout < 0, no reply is expected from subscribers
304 int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
305 const char *type, struct blob_attr *msg, int timeout);
307 int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
308 const char *type, struct blob_attr *msg,
309 struct ubus_notify_request *req);
312 /* ----------- events ----------- */
314 int ubus_send_event(struct ubus_context *ctx, const char *id,
315 struct blob_attr *data);
317 int ubus_register_event_handler(struct ubus_context *ctx,
318 struct ubus_event_handler *ev,
319 const char *pattern);
321 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
322 struct ubus_event_handler *ev)
324 return ubus_remove_object(ctx, &ev->obj);