libubus.h

   1 /*
   2  * Copyright (C) 2011-2014 Felix Fietkau <nbd@openwrt.org>
   3  *
   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
   7  *
   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.
  12  */
  13
  14 #ifndef __LIBUBUS_H
  15 #define __LIBUBUS_H
  16
  17 #include <libubox/avl.h>
  18 #include <libubox/list.h>
  19 #include <libubox/blobmsg.h>
  20 #include <libubox/uloop.h>
  21 #include <stdint.h>
  22 #include "ubusmsg.h"
  23 #include "ubus_common.h"
  24
  25 #define UBUS_MAX_NOTIFY_PEERS   16
  26
  27 struct ubus_context;
  28 struct ubus_msg_src;
  29 struct ubus_object;
  30 struct ubus_request;
  31 struct ubus_request_data;
  32 struct ubus_object_data;
  33 struct ubus_event_handler;
  34 struct ubus_subscriber;
  35 struct ubus_notify_request;
  36
  37 struct ubus_msghdr_buf {
  38         struct ubus_msghdr hdr;
  39         struct blob_attr *data;
  40 };
  41
  42 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
  43                                       struct ubus_object_data *obj,
  44                                       void *priv);
  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,
  58                                                int idx, int ret);
  59 typedef void (*ubus_connect_handler_t)(struct ubus_context *ctx);
  60
  61 #define UBUS_OBJECT_TYPE(_name, _methods)               \
  62         {                                               \
  63                 .name = _name,                          \
  64                 .id = 0,                                \
  65                 .n_methods = ARRAY_SIZE(_methods),      \
  66                 .methods = _methods                     \
  67         }
  68
  69 #define __UBUS_METHOD_NOARG(_name, _handler, _tags)     \
  70         .name = _name,                                  \
  71         .handler = _handler,                            \
  72         .tags = _tags
  73
  74 #define __UBUS_METHOD(_name, _handler, _policy, _tags)  \
  75         __UBUS_METHOD_NOARG(_name, _handler, _tags),    \
  76         .policy = _policy,                              \
  77         .n_policy = ARRAY_SIZE(_policy)
  78
  79 #define UBUS_METHOD(_name, _handler, _policy)           \
  80         { __UBUS_METHOD(_name, _handler, _policy, 0) }
  81
  82 #define UBUS_METHOD_TAG(_name, _handler, _policy, _tags)\
  83         { __UBUS_METHOD(_name, _handler, _policy, _tags) }
  84
  85 #define UBUS_METHOD_MASK(_name, _handler, _policy, _mask) \
  86         {                                               \
  87                 __UBUS_METHOD(_name, _handler, _policy, 0),\
  88                 .mask = _mask                           \
  89         }
  90
  91 #define UBUS_METHOD_NOARG(_name, _handler)              \
  92         { __UBUS_METHOD_NOARG(_name, _handler, 0) }
  93
  94 #define UBUS_METHOD_TAG_NOARG(_name, _handler, _tags)   \
  95         { __UBUS_METHOD_NOARG(_name, _handler, _tags) }
  96
  97 #define UBUS_TAG_STATUS         BIT(0)
  98 #define UBUS_TAG_ADMIN          BIT(1)
  99 #define UBUS_TAG_PRIVATE        BIT(2)
 100
 101 struct ubus_method {
 102         const char *name;
 103         ubus_handler_t handler;
 104
 105         unsigned long mask;
 106         unsigned long tags;
 107         const struct blobmsg_policy *policy;
 108         int n_policy;
 109 };
 110
 111 struct ubus_object_type {
 112         const char *name;
 113         uint32_t id;
 114
 115         const struct ubus_method *methods;
 116         int n_methods;
 117 };
 118
 119 struct ubus_object {
 120         struct avl_node avl;
 121
 122         const char *name;
 123         uint32_t id;
 124
 125         const char *path;
 126         struct ubus_object_type *type;
 127
 128         ubus_state_handler_t subscribe_cb;
 129         bool has_subscribers;
 130
 131         const struct ubus_method *methods;
 132         int n_methods;
 133 };
 134
 135 struct ubus_subscriber {
 136         struct ubus_object obj;
 137
 138         ubus_handler_t cb;
 139         ubus_remove_handler_t remove_cb;
 140 };
 141
 142 struct ubus_event_handler {
 143         struct ubus_object obj;
 144
 145         ubus_event_handler_t cb;
 146 };
 147
 148 struct ubus_context {
 149         struct list_head requests;
 150         struct avl_tree objects;
 151         struct list_head pending;
 152
 153         struct uloop_fd sock;
 154         struct uloop_timeout pending_timer;
 155
 156         uint32_t local_id;
 157         uint16_t request_seq;
 158         int stack_depth;
 159
 160         void (*connection_lost)(struct ubus_context *ctx);
 161         void (*monitor_cb)(struct ubus_context *ctx, uint32_t seq, struct blob_attr *data);
 162
 163         struct ubus_msghdr_buf msgbuf;
 164         uint32_t msgbuf_data_len;
 165         int msgbuf_reduction_counter;
 166 };
 167
 168 struct ubus_object_data {
 169         uint32_t id;
 170         uint32_t type_id;
 171         const char *path;
 172         struct blob_attr *signature;
 173 };
 174
 175 struct ubus_acl_key {
 176         const char *user;
 177         const char *group;
 178         const char *object;
 179 };
 180
 181 struct ubus_request_data {
 182         uint32_t object;
 183         uint32_t peer;
 184         uint16_t seq;
 185
 186         struct ubus_acl_key acl;
 187
 188         /* internal use */
 189         bool deferred;
 190         int fd;
 191 };
 192
 193 struct ubus_request {
 194         struct list_head list;
 195
 196         struct list_head pending;
 197         int status_code;
 198         bool status_msg;
 199         bool blocked;
 200         bool cancelled;
 201         bool notify;
 202
 203         uint32_t peer;
 204         uint16_t seq;
 205
 206         ubus_data_handler_t raw_data_cb;
 207         ubus_data_handler_t data_cb;
 208         ubus_fd_handler_t fd_cb;
 209         ubus_complete_handler_t complete_cb;
 210
 211         struct ubus_context *ctx;
 212         void *priv;
 213 };
 214
 215 struct ubus_notify_request {
 216         struct ubus_request req;
 217
 218         ubus_notify_complete_handler_t status_cb;
 219         ubus_notify_complete_handler_t complete_cb;
 220
 221         uint32_t pending;
 222         uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1];
 223 };
 224
 225 struct ubus_auto_conn {
 226         struct ubus_context ctx;
 227         struct uloop_timeout timer;
 228         const char *path;
 229         ubus_connect_handler_t cb;
 230 };
 231
 232 struct ubus_context *ubus_connect(const char *path);
 233 int ubus_connect_ctx(struct ubus_context *ctx, const char *path);
 234 void ubus_auto_connect(struct ubus_auto_conn *conn);
 235 int ubus_reconnect(struct ubus_context *ctx, const char *path);
 236
 237 /* call this only for struct ubus_context pointers returned by ubus_connect() */
 238 void ubus_free(struct ubus_context *ctx);
 239
 240 /* call this only for struct ubus_context pointers initialised by ubus_connect_ctx() */
 241 void ubus_shutdown(struct ubus_context *ctx);
 242
 243 static inline void ubus_auto_shutdown(struct ubus_auto_conn *conn)
 244 {
 245         uloop_timeout_cancel(&conn->timer);
 246         ubus_shutdown(&conn->ctx);
 247 }
 248
 249 const char *ubus_strerror(int error);
 250
 251 static inline void ubus_add_uloop(struct ubus_context *ctx)
 252 {
 253         uloop_fd_add(&ctx->sock, ULOOP_BLOCKING | ULOOP_READ);
 254 }
 255
 256 /* call this for read events on ctx->sock.fd when not using uloop */
 257 static inline void ubus_handle_event(struct ubus_context *ctx)
 258 {
 259         ctx->sock.cb(&ctx->sock, ULOOP_READ);
 260 }
 261
 262 /* ----------- raw request handling ----------- */
 263
 264 /* wait for a request to complete and return its status */
 265 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
 266                           int timeout);
 267
 268 /* complete a request asynchronously */
 269 void ubus_complete_request_async(struct ubus_context *ctx,
 270                                  struct ubus_request *req);
 271
 272 /* abort an asynchronous request */
 273 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
 274
 275 /* ----------- objects ----------- */
 276
 277 int ubus_lookup(struct ubus_context *ctx, const char *path,
 278                 ubus_lookup_handler_t cb, void *priv);
 279
 280 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
 281
 282 /* make an object visible to remote connections */
 283 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
 284
 285 /* remove the object from the ubus connection */
 286 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
 287
 288 /* add a subscriber notifications from another object */
 289 int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj);
 290
 291 static inline int
 292 ubus_unregister_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj)
 293 {
 294         return ubus_remove_object(ctx, &obj->obj);
 295 }
 296
 297 int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
 298 int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
 299
 300 int __ubus_monitor(struct ubus_context *ctx, const char *type);
 301
 302 static inline int ubus_monitor_start(struct ubus_context *ctx)
 303 {
 304         return __ubus_monitor(ctx, "add");
 305 }
 306
 307 static inline int ubus_monitor_stop(struct ubus_context *ctx)
 308 {
 309         return __ubus_monitor(ctx, "remove");
 310 }
 311
 312
 313 /* ----------- acl ----------- */
 314
 315 struct acl_object {
 316         struct ubus_acl_key key;
 317         struct avl_node avl;
 318         struct blob_attr *acl;
 319 };
 320
 321 extern struct avl_tree acl_objects;
 322 int ubus_register_acl(struct ubus_context *ctx);
 323
 324 #define acl_for_each(o, m) \
 325         if ((m)->object && (m)->user && (m)->group) \
 326                 avl_for_element_range(avl_find_ge_element(&acl_objects, m, o, avl), avl_find_le_element(&acl_objects, m, o, avl), o, avl)
 327
 328 /* ----------- rpc ----------- */
 329
 330 /* invoke a method on a specific object */
 331 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
 332                 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
 333                 int timeout);
 334
 335 /* asynchronous version of ubus_invoke() */
 336 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
 337                       struct blob_attr *msg, struct ubus_request *req);
 338
 339 /* send a reply to an incoming object method call */
 340 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
 341                     struct blob_attr *msg);
 342
 343 static inline void ubus_defer_request(struct ubus_context *ctx,
 344                                       struct ubus_request_data *req,
 345                                       struct ubus_request_data *new_req)
 346 {
 347     (void) ctx;
 348     memcpy(new_req, req, sizeof(*req));
 349     req->deferred = true;
 350 }
 351
 352 static inline void ubus_request_set_fd(struct ubus_context *ctx,
 353                                        struct ubus_request_data *req, int fd)
 354 {
 355     (void) ctx;
 356     req->fd = fd;
 357 }
 358
 359 void ubus_complete_deferred_request(struct ubus_context *ctx,
 360                                     struct ubus_request_data *req, int ret);
 361
 362 /*
 363  * send a notification to all subscribers of an object
 364  * if timeout < 0, no reply is expected from subscribers
 365  */
 366 int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
 367                 const char *type, struct blob_attr *msg, int timeout);
 368
 369 int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
 370                       const char *type, struct blob_attr *msg,
 371                       struct ubus_notify_request *req);
 372
 373
 374 /* ----------- events ----------- */
 375
 376 int ubus_send_event(struct ubus_context *ctx, const char *id,
 377                     struct blob_attr *data);
 378
 379 int ubus_register_event_handler(struct ubus_context *ctx,
 380                                 struct ubus_event_handler *ev,
 381                                 const char *pattern);
 382
 383 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
 384                                                 struct ubus_event_handler *ev)
 385 {
 386     return ubus_remove_object(ctx, &ev->obj);
 387 }
 388
 389 #endif