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;
30 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
31 struct ubus_object_data *obj,
33 typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
34 struct ubus_request_data *req,
35 const char *method, struct blob_attr *msg);
36 typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
37 const char *type, struct blob_attr *msg);
38 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
39 int type, struct blob_attr *msg);
40 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
42 #define UBUS_OBJECT_TYPE(_name, _methods) \
46 .n_methods = ARRAY_SIZE(_methods), \
50 #define UBUS_METHOD(_name, _handler, _policy) \
53 .handler = _handler, \
55 .n_policy = ARRAY_SIZE(_policy) \
60 ubus_handler_t handler;
62 const struct blobmsg_policy *policy;
66 struct ubus_object_type {
70 const struct ubus_method *methods;
81 struct ubus_object_type *type;
83 const struct ubus_method *methods;
87 struct ubus_event_handler {
88 struct ubus_object obj;
90 ubus_event_handler_t cb;
94 struct list_head requests;
95 struct avl_tree objects;
96 struct list_head pending;
101 uint32_t request_seq;
104 void (*connection_lost)(struct ubus_context *ctx);
107 struct ubus_msghdr hdr;
108 char data[UBUS_MAX_MSGLEN];
112 struct ubus_object_data {
116 struct blob_attr *signature;
119 struct ubus_request_data {
125 struct ubus_request {
126 struct list_head list;
128 struct list_head pending;
137 ubus_data_handler_t raw_data_cb;
138 ubus_data_handler_t data_cb;
139 ubus_complete_handler_t complete_cb;
141 struct ubus_context *ctx;
146 struct ubus_context *ubus_connect(const char *path);
147 void ubus_free(struct ubus_context *ctx);
149 const char *ubus_strerror(int error);
151 static inline void ubus_add_uloop(struct ubus_context *ctx)
153 uloop_fd_add(&ctx->sock, ULOOP_EDGE_TRIGGER | ULOOP_BLOCKING | ULOOP_READ);
156 /* call this for read events on ctx->sock.fd when not using uloop */
157 static inline void ubus_handle_event(struct ubus_context *ctx)
159 ctx->sock.cb(&ctx->sock, ULOOP_READ);
162 /* ----------- raw request handling ----------- */
164 /* wait for a request to complete and return its status */
165 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
168 /* complete a request asynchronously */
169 void ubus_complete_request_async(struct ubus_context *ctx,
170 struct ubus_request *req);
172 /* abort an asynchronous request */
173 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
175 /* ----------- objects ----------- */
177 int ubus_lookup(struct ubus_context *ctx, const char *path,
178 ubus_lookup_handler_t cb, void *priv);
180 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
182 /* make an object visible to remote connections */
183 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
185 /* remove the object from the ubus connection */
186 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
188 /* ----------- rpc ----------- */
190 /* invoke a method on a specific object */
191 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
192 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
195 /* asynchronous version of ubus_invoke() */
196 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
197 struct blob_attr *msg, struct ubus_request *req);
199 /* send a reply to an incoming object method call */
200 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
201 struct blob_attr *msg);
203 /* ----------- events ----------- */
205 int ubus_send_event(struct ubus_context *ctx, const char *id,
206 struct blob_attr *data);
208 int ubus_register_event_handler(struct ubus_context *ctx,
209 struct ubus_event_handler *ev,
210 const char *pattern);
212 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
213 struct ubus_event_handler *ev)
215 return ubus_remove_object(ctx, &ev->obj);