libubus.c

   1 /*
   2  * Copyright (C) 2011-2012 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 #include <sys/types.h>
  15 #include <sys/socket.h>
  16 #include <unistd.h>
  17
  18 #include <libubox/blob.h>
  19 #include <libubox/blobmsg.h>
  20
  21 #include "libubus.h"
  22 #include "libubus-internal.h"
  23 #include "ubusmsg.h"
  24
  25 const char *__ubus_strerror[__UBUS_STATUS_LAST] = {
  26         [UBUS_STATUS_OK] = "Success",
  27         [UBUS_STATUS_INVALID_COMMAND] = "Invalid command",
  28         [UBUS_STATUS_INVALID_ARGUMENT] = "Invalid argument",
  29         [UBUS_STATUS_METHOD_NOT_FOUND] = "Method not found",
  30         [UBUS_STATUS_NOT_FOUND] = "Not found",
  31         [UBUS_STATUS_NO_DATA] = "No response",
  32         [UBUS_STATUS_PERMISSION_DENIED] = "Permission denied",
  33         [UBUS_STATUS_TIMEOUT] = "Request timed out",
  34         [UBUS_STATUS_NOT_SUPPORTED] = "Operation not supported",
  35         [UBUS_STATUS_UNKNOWN_ERROR] = "Unknown error",
  36         [UBUS_STATUS_CONNECTION_FAILED] = "Connection failed",
  37 };
  38
  39 struct blob_buf b __hidden = {};
  40
  41 struct ubus_pending_msg {
  42         struct list_head list;
  43         struct ubus_msghdr hdr;
  44 };
  45
  46 static int ubus_cmp_id(const void *k1, const void *k2, void *ptr)
  47 {
  48         const uint32_t *id1 = k1, *id2 = k2;
  49
  50         if (*id1 < *id2)
  51                 return -1;
  52         else
  53                 return *id1 > *id2;
  54 }
  55
  56 const char *ubus_strerror(int error)
  57 {
  58         static char err[32];
  59
  60         if (error < 0 || error >= __UBUS_STATUS_LAST)
  61                 goto out;
  62
  63         if (!__ubus_strerror[error])
  64                 goto out;
  65
  66         return __ubus_strerror[error];
  67
  68 out:
  69         sprintf(err, "Unknown error: %d", error);
  70         return err;
  71 }
  72
  73 static void
  74 ubus_queue_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
  75 {
  76         struct ubus_pending_msg *pending;
  77
  78         pending = calloc(1, sizeof(*pending) + blob_raw_len(hdr->data));
  79         if (!pending)
  80                 return;
  81
  82         memcpy(&pending->hdr, hdr, sizeof(*hdr) + blob_raw_len(hdr->data));
  83         list_add(&pending->list, &ctx->pending);
  84 }
  85
  86 void __hidden
  87 ubus_process_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr)
  88 {
  89
  90         switch(hdr->type) {
  91         case UBUS_MSG_STATUS:
  92         case UBUS_MSG_DATA:
  93                 ubus_process_req_msg(ctx, hdr);
  94                 break;
  95
  96         case UBUS_MSG_INVOKE:
  97         case UBUS_MSG_UNSUBSCRIBE:
  98         case UBUS_MSG_NOTIFY:
  99                 if (ctx->stack_depth > 2) {
 100                         ubus_queue_msg(ctx, hdr);
 101                         break;
 102                 }
 103
 104                 ubus_process_obj_msg(ctx, hdr);
 105                 break;
 106         }
 107 }
 108
 109 void __hidden ubus_process_pending_msg(struct ubus_context *ctx)
 110 {
 111         struct ubus_pending_msg *pending;
 112
 113         while (!list_empty(&ctx->pending)) {
 114                 pending = list_first_entry(&ctx->pending, struct ubus_pending_msg, list);
 115                 list_del(&pending->list);
 116                 ubus_process_msg(ctx, &pending->hdr);
 117                 free(pending);
 118                 if (ctx->stack_depth > 2)
 119                         break;
 120         }
 121 }
 122
 123 struct ubus_lookup_request {
 124         struct ubus_request req;
 125         ubus_lookup_handler_t cb;
 126 };
 127
 128 static void ubus_lookup_cb(struct ubus_request *ureq, int type, struct blob_attr *msg)
 129 {
 130         struct ubus_lookup_request *req;
 131         struct ubus_object_data obj;
 132         struct blob_attr **attr;
 133
 134         req = container_of(ureq, struct ubus_lookup_request, req);
 135         attr = ubus_parse_msg(msg);
 136
 137         if (!attr[UBUS_ATTR_OBJID] || !attr[UBUS_ATTR_OBJPATH] ||
 138             !attr[UBUS_ATTR_OBJTYPE])
 139                 return;
 140
 141         memset(&obj, 0, sizeof(obj));
 142         obj.id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
 143         obj.path = blob_data(attr[UBUS_ATTR_OBJPATH]);
 144         obj.type_id = blob_get_u32(attr[UBUS_ATTR_OBJTYPE]);
 145         obj.signature = attr[UBUS_ATTR_SIGNATURE];
 146         req->cb(ureq->ctx, &obj, ureq->priv);
 147 }
 148
 149 int ubus_lookup(struct ubus_context *ctx, const char *path,
 150                 ubus_lookup_handler_t cb, void *priv)
 151 {
 152         struct ubus_lookup_request lookup;
 153
 154         blob_buf_init(&b, 0);
 155         if (path)
 156                 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
 157
 158         if (ubus_start_request(ctx, &lookup.req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
 159                 return UBUS_STATUS_INVALID_ARGUMENT;
 160
 161         lookup.req.raw_data_cb = ubus_lookup_cb;
 162         lookup.req.priv = priv;
 163         lookup.cb = cb;
 164         return ubus_complete_request(ctx, &lookup.req, 0);
 165 }
 166
 167 static void ubus_lookup_id_cb(struct ubus_request *req, int type, struct blob_attr *msg)
 168 {
 169         struct blob_attr **attr;
 170         uint32_t *id = req->priv;
 171
 172         attr = ubus_parse_msg(msg);
 173
 174         if (!attr[UBUS_ATTR_OBJID])
 175                 return;
 176
 177         *id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
 178 }
 179
 180 int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id)
 181 {
 182         struct ubus_request req;
 183
 184         blob_buf_init(&b, 0);
 185         if (path)
 186                 blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
 187
 188         if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
 189                 return UBUS_STATUS_INVALID_ARGUMENT;
 190
 191         req.raw_data_cb = ubus_lookup_id_cb;
 192         req.priv = id;
 193
 194         return ubus_complete_request(ctx, &req, 0);
 195 }
 196
 197 static int ubus_event_cb(struct ubus_context *ctx, struct ubus_object *obj,
 198                          struct ubus_request_data *req,
 199                          const char *method, struct blob_attr *msg)
 200 {
 201         struct ubus_event_handler *ev;
 202
 203         ev = container_of(obj, struct ubus_event_handler, obj);
 204         ev->cb(ctx, ev, method, msg);
 205         return 0;
 206 }
 207
 208 static const struct ubus_method event_method = {
 209         .name = NULL,
 210         .handler = ubus_event_cb,
 211 };
 212
 213 int ubus_register_event_handler(struct ubus_context *ctx,
 214                                 struct ubus_event_handler *ev,
 215                                 const char *pattern)
 216 {
 217         struct ubus_object *obj = &ev->obj;
 218         struct blob_buf b2;
 219         int ret;
 220
 221         if (!obj->id) {
 222                 obj->methods = &event_method;
 223                 obj->n_methods = 1;
 224
 225                 if (!!obj->name ^ !!obj->type)
 226                         return UBUS_STATUS_INVALID_ARGUMENT;
 227
 228                 ret = ubus_add_object(ctx, obj);
 229                 if (ret)
 230                         return ret;
 231         }
 232
 233         /* use a second buffer, ubus_invoke() overwrites the primary one */
 234         memset(&b2, 0, sizeof(b2));
 235         blob_buf_init(&b2, 0);
 236         blobmsg_add_u32(&b2, "object", obj->id);
 237         if (pattern)
 238                 blobmsg_add_string(&b2, "pattern", pattern);
 239
 240         return ubus_invoke(ctx, UBUS_SYSTEM_OBJECT_EVENT, "register", b2.head,
 241                           NULL, NULL, 0);
 242 }
 243
 244 int ubus_send_event(struct ubus_context *ctx, const char *id,
 245                     struct blob_attr *data)
 246 {
 247         struct ubus_request req;
 248         void *s;
 249
 250         blob_buf_init(&b, 0);
 251         blob_put_int32(&b, UBUS_ATTR_OBJID, UBUS_SYSTEM_OBJECT_EVENT);
 252         blob_put_string(&b, UBUS_ATTR_METHOD, "send");
 253         s = blob_nest_start(&b, UBUS_ATTR_DATA);
 254         blobmsg_add_string(&b, "id", id);
 255         blobmsg_add_field(&b, BLOBMSG_TYPE_TABLE, "data", blob_data(data), blob_len(data));
 256         blob_nest_end(&b, s);
 257
 258         if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_INVOKE, UBUS_SYSTEM_OBJECT_EVENT) < 0)
 259                 return UBUS_STATUS_INVALID_ARGUMENT;
 260
 261         return ubus_complete_request(ctx, &req, 0);
 262 }
 263
 264 static void ubus_default_connection_lost(struct ubus_context *ctx)
 265 {
 266         if (ctx->sock.registered)
 267                 uloop_end();
 268 }
 269
 270 struct ubus_context *ubus_connect(const char *path)
 271 {
 272         struct ubus_context *ctx;
 273
 274         ctx = calloc(1, sizeof(*ctx));
 275         if (!ctx)
 276                 return NULL;
 277
 278         ctx->sock.fd = -1;
 279         ctx->sock.cb = ubus_handle_data;
 280         ctx->connection_lost = ubus_default_connection_lost;
 281
 282         INIT_LIST_HEAD(&ctx->requests);
 283         INIT_LIST_HEAD(&ctx->pending);
 284         avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
 285         if (ubus_reconnect(ctx, path)) {
 286                 free(ctx);
 287                 ctx = NULL;
 288         }
 289
 290         return ctx;
 291 }
 292
 293 void ubus_free(struct ubus_context *ctx)
 294 {
 295         blob_buf_free(&b);
 296         close(ctx->sock.fd);
 297         free(ctx);
 298 }