1 #include <libubox/avl.h>
2 #include <libubox/list.h>
3 #include <libubox/blobmsg.h>
4 #include <libubox/uloop.h>
7 #include "ubus_common.h"
13 struct ubus_request_data;
14 struct ubus_object_data;
15 struct ubus_event_handler;
17 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
18 struct ubus_object_data *obj,
20 typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
21 struct ubus_request_data *req,
22 const char *method, struct blob_attr *msg);
23 typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
24 const char *type, struct blob_attr *msg);
25 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
26 int type, struct blob_attr *msg);
27 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
30 #define UBUS_SIGNATURE(_type, _name) { .type = _type, .name = _name }
32 #define UBUS_METHOD_START(_name) UBUS_SIGNATURE(UBUS_SIGNATURE_METHOD, _name)
33 #define UBUS_METHOD_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
35 #define UBUS_FIELD(_type, _name) UBUS_SIGNATURE(BLOBMSG_TYPE_ ## _type, _name)
37 #define UBUS_ARRAY(_name) UBUS_FIELD(ARRAY, _name)
38 #define UBUS_ARRAY_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
40 #define UBUS_TABLE_START(_name) UBUS_FIELD(TABLE, _name)
41 #define UBUS_TABLE_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
43 #define UBUS_OBJECT_TYPE(_name, _signature) \
47 .n_signature = ARRAY_SIZE(_signature), \
48 .signature = _signature \
51 struct ubus_signature {
56 struct ubus_object_type {
60 const struct ubus_signature *signature;
65 ubus_handler_t handler;
75 struct ubus_object_type *type;
77 const struct ubus_method *methods;
81 struct ubus_event_handler {
82 struct ubus_object obj;
84 ubus_event_handler_t cb;
88 struct list_head requests;
89 struct avl_tree objects;
96 void (*connection_lost)(struct ubus_context *ctx);
99 struct ubus_msghdr hdr;
100 char data[UBUS_MAX_MSGLEN];
104 struct ubus_object_data {
108 struct blob_attr *signature;
111 struct ubus_request_data {
117 struct ubus_request {
118 struct list_head list;
120 struct list_head pending;
129 ubus_data_handler_t raw_data_cb;
130 ubus_data_handler_t data_cb;
131 ubus_complete_handler_t complete_cb;
133 struct ubus_context *ctx;
138 struct ubus_context *ubus_connect(const char *path);
139 void ubus_free(struct ubus_context *ctx);
141 const char *ubus_strerror(int error);
143 static inline void ubus_add_uloop(struct ubus_context *ctx)
145 uloop_fd_add(&ctx->sock, ULOOP_EDGE_TRIGGER | ULOOP_BLOCKING | ULOOP_READ);
148 /* call this for read events on ctx->sock.fd when not using uloop */
149 static inline void ubus_handle_event(struct ubus_context *ctx)
151 ctx->sock.cb(&ctx->sock, ULOOP_READ);
154 /* ----------- raw request handling ----------- */
156 /* wait for a request to complete and return its status */
157 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
160 /* complete a request asynchronously */
161 void ubus_complete_request_async(struct ubus_context *ctx,
162 struct ubus_request *req);
164 /* abort an asynchronous request */
165 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
167 /* ----------- objects ----------- */
169 int ubus_lookup(struct ubus_context *ctx, const char *path,
170 ubus_lookup_handler_t cb, void *priv);
172 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
174 /* make an object visible to remote connections */
175 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
177 /* remove the object from the ubus connection */
178 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
180 /* ----------- rpc ----------- */
182 /* invoke a method on a specific object */
183 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
184 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
187 /* asynchronous version of ubus_invoke() */
188 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
189 struct blob_attr *msg, struct ubus_request *req);
191 /* send a reply to an incoming object method call */
192 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
193 struct blob_attr *msg);
195 /* ----------- events ----------- */
197 int ubus_send_event(struct ubus_context *ctx, const char *id,
198 struct blob_attr *data);
200 int ubus_register_event_handler(struct ubus_context *ctx,
201 struct ubus_event_handler *ev,
202 const char *pattern);
204 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
205 struct ubus_event_handler *ev)
207 return ubus_remove_object(ctx, &ev->obj);