libubus.h

   1 /*
   2  * Copyright (C) 2011 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 struct ubus_context;
  26 struct ubus_msg_src;
  27 struct ubus_object;
  28 struct ubus_request;
  29 struct ubus_request_data;
  30 struct ubus_object_data;
  31 struct ubus_event_handler;
  32 struct ubus_watch_object;
  33
  34 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
  35                                       struct ubus_object_data *obj,
  36                                       void *priv);
  37 typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
  38                               struct ubus_request_data *req,
  39                               const char *method, struct blob_attr *msg);
  40 typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
  41                                      const char *type, struct blob_attr *msg);
  42 typedef void (*ubus_watch_handler_t)(struct ubus_context *ctx, struct ubus_watch_object *w,
  43                                      uint32_t id);
  44 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
  45                                     int type, struct blob_attr *msg);
  46 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
  47
  48 #define UBUS_OBJECT_TYPE(_name, _methods)               \
  49         {                                               \
  50                 .name = _name,                          \
  51                 .id = 0,                                \
  52                 .n_methods = ARRAY_SIZE(_methods),      \
  53                 .methods = _methods                     \
  54         }
  55
  56 #define UBUS_METHOD(_name, _handler, _policy)           \
  57         {                                               \
  58                 .name = _name,                          \
  59                 .handler = _handler,                    \
  60                 .policy = _policy,                      \
  61                 .n_policy = ARRAY_SIZE(_policy)         \
  62         }
  63
  64 struct ubus_method {
  65         const char *name;
  66         ubus_handler_t handler;
  67
  68         const struct blobmsg_policy *policy;
  69         int n_policy;
  70 };
  71
  72 struct ubus_object_type {
  73         const char *name;
  74         uint32_t id;
  75
  76         const struct ubus_method *methods;
  77         int n_methods;
  78 };
  79
  80 struct ubus_object {
  81         struct avl_node avl;
  82
  83         const char *name;
  84         uint32_t id;
  85
  86         const char *path;
  87         struct ubus_object_type *type;
  88
  89         const struct ubus_method *methods;
  90         int n_methods;
  91 };
  92
  93 struct ubus_watch_object {
  94         struct ubus_object obj;
  95
  96         ubus_watch_handler_t cb;
  97 };
  98
  99 struct ubus_event_handler {
 100         struct ubus_object obj;
 101
 102         ubus_event_handler_t cb;
 103 };
 104
 105 struct ubus_context {
 106         struct list_head requests;
 107         struct avl_tree objects;
 108         struct list_head pending;
 109
 110         struct uloop_fd sock;
 111
 112         uint32_t local_id;
 113         uint32_t request_seq;
 114         int stack_depth;
 115
 116         void (*connection_lost)(struct ubus_context *ctx);
 117
 118         struct {
 119                 struct ubus_msghdr hdr;
 120                 char data[UBUS_MAX_MSGLEN];
 121         } msgbuf;
 122 };
 123
 124 struct ubus_object_data {
 125         uint32_t id;
 126         uint32_t type_id;
 127         const char *path;
 128         struct blob_attr *signature;
 129 };
 130
 131 struct ubus_request_data {
 132         uint32_t object;
 133         uint32_t peer;
 134         uint32_t seq;
 135         bool deferred;
 136 };
 137
 138 struct ubus_request {
 139         struct list_head list;
 140
 141         struct list_head pending;
 142         bool status_msg;
 143         int status_code;
 144         bool blocked;
 145         bool cancelled;
 146
 147         uint32_t peer;
 148         uint32_t seq;
 149
 150         ubus_data_handler_t raw_data_cb;
 151         ubus_data_handler_t data_cb;
 152         ubus_complete_handler_t complete_cb;
 153
 154         struct ubus_context *ctx;
 155         void *priv;
 156 };
 157
 158
 159 struct ubus_context *ubus_connect(const char *path);
 160 int ubus_reconnect(struct ubus_context *ctx, const char *path);
 161 void ubus_free(struct ubus_context *ctx);
 162
 163 const char *ubus_strerror(int error);
 164
 165 static inline void ubus_add_uloop(struct ubus_context *ctx)
 166 {
 167         uloop_fd_add(&ctx->sock, ULOOP_BLOCKING | ULOOP_READ);
 168 }
 169
 170 /* call this for read events on ctx->sock.fd when not using uloop */
 171 static inline void ubus_handle_event(struct ubus_context *ctx)
 172 {
 173         ctx->sock.cb(&ctx->sock, ULOOP_READ);
 174 }
 175
 176 /* ----------- raw request handling ----------- */
 177
 178 /* wait for a request to complete and return its status */
 179 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
 180                           int timeout);
 181
 182 /* complete a request asynchronously */
 183 void ubus_complete_request_async(struct ubus_context *ctx,
 184                                  struct ubus_request *req);
 185
 186 /* abort an asynchronous request */
 187 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
 188
 189 /* ----------- objects ----------- */
 190
 191 int ubus_lookup(struct ubus_context *ctx, const char *path,
 192                 ubus_lookup_handler_t cb, void *priv);
 193
 194 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
 195
 196 /* make an object visible to remote connections */
 197 int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
 198
 199 /* remove the object from the ubus connection */
 200 int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
 201
 202 /* add an object for watching other object state changes */
 203 int ubus_register_watch_object(struct ubus_context *ctx, struct ubus_watch_object *obj);
 204
 205 int ubus_watch_object_add(struct ubus_context *ctx, struct ubus_watch_object *obj, uint32_t id);
 206
 207 int ubus_watch_object_remove(struct ubus_context *ctx, struct ubus_watch_object *obj, uint32_t id);
 208
 209 /* ----------- rpc ----------- */
 210
 211 /* invoke a method on a specific object */
 212 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
 213                 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
 214                 int timeout);
 215
 216 /* asynchronous version of ubus_invoke() */
 217 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
 218                       struct blob_attr *msg, struct ubus_request *req);
 219
 220 /* send a reply to an incoming object method call */
 221 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
 222                     struct blob_attr *msg);
 223
 224 static inline void ubus_defer_request(struct ubus_context *ctx,
 225                                       struct ubus_request_data *req,
 226                                       struct ubus_request_data *new_req)
 227 {
 228     memcpy(new_req, req, sizeof(*req));
 229     req->deferred = true;
 230 }
 231
 232 void ubus_complete_deferred_request(struct ubus_context *ctx,
 233                                     struct ubus_request_data *req, int ret);
 234
 235 /* ----------- events ----------- */
 236
 237 int ubus_send_event(struct ubus_context *ctx, const char *id,
 238                     struct blob_attr *data);
 239
 240 int ubus_register_event_handler(struct ubus_context *ctx,
 241                                 struct ubus_event_handler *ev,
 242                                 const char *pattern);
 243
 244 static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
 245                                                 struct ubus_event_handler *ev)
 246 {
 247     return ubus_remove_object(ctx, &ev->obj);
 248 }
 249
 250 #endif