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 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_complete_handler_t)(struct ubus_request *req, int ret);
57 typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req,
60 #define UBUS_OBJECT_TYPE(_name, _methods) \
64 .n_methods = ARRAY_SIZE(_methods), \
68 #define UBUS_METHOD(_name, _handler, _policy) \
71 .handler = _handler, \
73 .n_policy = ARRAY_SIZE(_policy) \
76 #define UBUS_METHOD_NOARG(_name, _handler) \
79 .handler = _handler, \
84 ubus_handler_t handler;
86 const struct blobmsg_policy *policy;
90 struct ubus_object_type {
94 const struct ubus_method *methods;
105 struct ubus_object_type *type;
107 ubus_state_handler_t subscribe_cb;
108 bool has_subscribers;
110 const struct ubus_method *methods;
114 struct ubus_subscriber {
115 struct ubus_object obj;
118 ubus_remove_handler_t remove_cb;
121 struct ubus_event_handler {
122 struct ubus_object obj;
124 ubus_event_handler_t cb;
127 struct ubus_context {
128 struct list_head requests;
129 struct avl_tree objects;
130 struct list_head pending;
132 struct uloop_fd sock;
135 uint16_t request_seq;
138 void (*connection_lost)(struct ubus_context *ctx);
141 struct ubus_msghdr hdr;
142 char data[UBUS_MAX_MSGLEN];
146 struct ubus_object_data {
150 struct blob_attr *signature;
153 struct ubus_request_data {
160 struct ubus_request {
161 struct list_head list;
163 struct list_head pending;
173 ubus_data_handler_t raw_data_cb;
174 ubus_data_handler_t data_cb;
175 ubus_complete_handler_t complete_cb;
177 struct ubus_context *ctx;
181 struct ubus_notify_request {
182 struct ubus_request req;
184 ubus_notify_complete_handler_t status_cb;
185 ubus_notify_complete_handler_t complete_cb;
188 uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1];
191 struct ubus_context *ubus_connect(const char *path);
192 int ubus_reconnect(struct ubus_context *ctx, const char *path);
193 void ubus_free(struct ubus_context *ctx);
195 const char *ubus_strerror(int error);
197 static inline void ubus_add_uloop(struct ubus_context *ctx)
199 uloop_fd_add(&ctx->sock, ULOOP_BLOCKING | ULOOP_READ);
202 /* call this for read events on ctx->sock.fd when not using uloop */
203 static inline void ubus_handle_event(struct ubus_context *ctx)
205 ctx->sock.cb(&ctx->sock, ULOOP_READ);
208 /* ----------- raw request handling ----------- */
210 /* wait for a request to complete and return its status */
211 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
214 /* complete a request asynchronously */
215 void ubus_complete_request_async(struct ubus_context *ctx,
216 struct ubus_request *req);
218 /* abort an asynchronous request */
219 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
221 /* ----------- objects ----------- */
223 int ubus_lookup(struct ubus_context *ctx, const char *path,
224 ubus_lookup_handler_t cb, void *priv);
226 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
228 /* make an object visible to remote connections */
229 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
231 /* remove the object from the ubus connection */
232 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
234 /* add a subscriber notifications from another object */
235 int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj);
238 ubus_unregister_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj)
240 return ubus_remove_object(ctx, &obj->obj);
243 int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
244 int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
246 /* ----------- rpc ----------- */
248 /* invoke a method on a specific object */
249 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
250 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
253 /* asynchronous version of ubus_invoke() */
254 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
255 struct blob_attr *msg, struct ubus_request *req);
257 /* send a reply to an incoming object method call */
258 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
259 struct blob_attr *msg);
261 static inline void ubus_defer_request(struct ubus_context *ctx,
262 struct ubus_request_data *req,
263 struct ubus_request_data *new_req)
265 memcpy(new_req, req, sizeof(*req));
266 req->deferred = true;
269 void ubus_complete_deferred_request(struct ubus_context *ctx,
270 struct ubus_request_data *req, int ret);
273 * send a notification to all subscribers of an object
274 * if timeout < 0, no reply is expected from subscribers
276 int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
277 const char *type, struct blob_attr *msg, int timeout);
279 int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
280 const char *type, struct blob_attr *msg,
281 struct ubus_notify_request *req);
284 /* ----------- events ----------- */
286 int ubus_send_event(struct ubus_context *ctx, const char *id,
287 struct blob_attr *data);
289 int ubus_register_event_handler(struct ubus_context *ctx,
290 struct ubus_event_handler *ev,
291 const char *pattern);
293 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
294 struct ubus_event_handler *ev)
296 return ubus_remove_object(ctx, &ev->obj);