libubus-req.c

   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 #include <unistd.h>
  15 #include "libubus.h"
  16 #include "libubus-internal.h"
  17
  18 struct ubus_pending_data {
  19         struct list_head list;
  20         int type;
  21         struct blob_attr data[];
  22 };
  23
  24 static void req_data_cb(struct ubus_request *req, int type, struct blob_attr *data)
  25 {
  26         struct blob_attr **attr;
  27
  28         if (req->raw_data_cb)
  29                 req->raw_data_cb(req, type, data);
  30
  31         if (!req->data_cb)
  32                 return;
  33
  34         attr = ubus_parse_msg(data);
  35         req->data_cb(req, type, attr[UBUS_ATTR_DATA]);
  36 }
  37
  38 static void __ubus_process_req_data(struct ubus_request *req)
  39 {
  40         struct ubus_pending_data *data;
  41
  42         while (!list_empty(&req->pending)) {
  43                 data = list_first_entry(&req->pending,
  44                         struct ubus_pending_data, list);
  45                 list_del(&data->list);
  46                 if (!req->cancelled)
  47                         req_data_cb(req, data->type, data->data);
  48                 free(data);
  49         }
  50 }
  51
  52 int __hidden ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
  53                                 struct blob_attr *msg, int cmd, uint32_t peer)
  54 {
  55         memset(req, 0, sizeof(*req));
  56
  57         if (msg && blob_pad_len(msg) > UBUS_MAX_MSGLEN)
  58                 return -1;
  59
  60         INIT_LIST_HEAD(&req->list);
  61         INIT_LIST_HEAD(&req->pending);
  62         req->ctx = ctx;
  63         req->peer = peer;
  64         req->seq = ++ctx->request_seq;
  65         return ubus_send_msg(ctx, req->seq, msg, cmd, peer, -1);
  66 }
  67
  68 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req)
  69 {
  70         if (list_empty(&req->list))
  71                 return;
  72
  73         req->cancelled = true;
  74         __ubus_process_req_data(req);
  75         list_del_init(&req->list);
  76 }
  77
  78 void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req)
  79 {
  80         if (!list_empty(&req->list))
  81                 return;
  82
  83         list_add(&req->list, &ctx->requests);
  84 }
  85
  86 static void
  87 ubus_req_complete_cb(struct ubus_request *req)
  88 {
  89         ubus_complete_handler_t cb = req->complete_cb;
  90
  91         if (!cb)
  92                 return;
  93
  94         req->complete_cb = NULL;
  95         cb(req, req->status_code);
  96 }
  97
  98 static void
  99 ubus_set_req_status(struct ubus_request *req, int ret)
 100 {
 101         if (!list_empty(&req->list))
 102                 list_del_init(&req->list);
 103
 104         req->status_msg = true;
 105         req->status_code = ret;
 106         if (!req->blocked)
 107                 ubus_req_complete_cb(req);
 108 }
 109
 110 static void ubus_sync_req_cb(struct ubus_request *req, int ret)
 111 {
 112         req->status_msg = true;
 113         req->status_code = ret;
 114         uloop_end();
 115 }
 116
 117 static int64_t get_time_msec(void)
 118 {
 119         struct timespec ts;
 120         int64_t val;
 121
 122         clock_gettime(CLOCK_MONOTONIC, &ts);
 123         val = (int64_t) ts.tv_sec * 1000LL;
 124         val += ts.tv_nsec / 1000000LL;
 125         return val;
 126 }
 127
 128 int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
 129                           int req_timeout)
 130 {
 131         ubus_complete_handler_t complete_cb = req->complete_cb;
 132         bool registered = ctx->sock.registered;
 133         int status = UBUS_STATUS_NO_DATA;
 134         int64_t timeout = 0, time_end = 0;
 135
 136         if (!registered) {
 137                 uloop_init();
 138                 ubus_add_uloop(ctx);
 139         }
 140
 141         if (req_timeout)
 142                 time_end = get_time_msec() + req_timeout;
 143
 144         ubus_complete_request_async(ctx, req);
 145         req->complete_cb = ubus_sync_req_cb;
 146
 147         ctx->stack_depth++;
 148         while (!req->status_msg) {
 149                 bool cancelled = uloop_cancelled;
 150
 151                 uloop_cancelled = false;
 152                 if (req_timeout) {
 153                         timeout = time_end - get_time_msec();
 154                         if (timeout <= 0) {
 155                                 ubus_set_req_status(req, UBUS_STATUS_TIMEOUT);
 156                                 break;
 157                         }
 158                 }
 159                 ubus_poll_data(ctx, (unsigned int) timeout);
 160
 161                 uloop_cancelled = cancelled;
 162         }
 163         ctx->stack_depth--;
 164         if (ctx->stack_depth)
 165                 uloop_cancelled = true;
 166
 167         if (req->status_msg)
 168                 status = req->status_code;
 169
 170         req->complete_cb = complete_cb;
 171         if (req->complete_cb)
 172                 req->complete_cb(req, status);
 173
 174         if (!registered) {
 175                 uloop_fd_delete(&ctx->sock);
 176
 177                 if (ctx->stack_depth)
 178                         ctx->pending_timer.cb(&ctx->pending_timer);
 179         }
 180
 181         return status;
 182 }
 183
 184 void ubus_complete_deferred_request(struct ubus_context *ctx, struct ubus_request_data *req, int ret)
 185 {
 186         blob_buf_init(&b, 0);
 187         blob_put_int32(&b, UBUS_ATTR_STATUS, ret);
 188         blob_put_int32(&b, UBUS_ATTR_OBJID, req->object);
 189         ubus_send_msg(ctx, req->seq, b.head, UBUS_MSG_STATUS, req->peer, req->fd);
 190 }
 191
 192 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
 193                     struct blob_attr *msg)
 194 {
 195         int ret;
 196
 197         blob_buf_init(&b, 0);
 198         blob_put_int32(&b, UBUS_ATTR_OBJID, req->object);
 199         blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
 200         ret = ubus_send_msg(ctx, req->seq, b.head, UBUS_MSG_DATA, req->peer, -1);
 201         if (ret < 0)
 202                 return UBUS_STATUS_NO_DATA;
 203
 204         return 0;
 205 }
 206
 207 int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
 208                        struct blob_attr *msg, struct ubus_request *req)
 209 {
 210         blob_buf_init(&b, 0);
 211         blob_put_int32(&b, UBUS_ATTR_OBJID, obj);
 212         blob_put_string(&b, UBUS_ATTR_METHOD, method);
 213         if (msg)
 214                 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
 215
 216         if (ubus_start_request(ctx, req, b.head, UBUS_MSG_INVOKE, obj) < 0)
 217                 return UBUS_STATUS_INVALID_ARGUMENT;
 218
 219         return 0;
 220 }
 221
 222 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
 223                 struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
 224                 int timeout)
 225 {
 226         struct ubus_request req;
 227
 228         ubus_invoke_async(ctx, obj, method, msg, &req);
 229         req.data_cb = cb;
 230         req.priv = priv;
 231         return ubus_complete_request(ctx, &req, timeout);
 232 }
 233
 234 static void
 235 ubus_notify_complete_cb(struct ubus_request *req, int ret)
 236 {
 237         struct ubus_notify_request *nreq;
 238
 239         nreq = container_of(req, struct ubus_notify_request, req);
 240         if (!nreq->complete_cb)
 241                 return;
 242
 243         nreq->complete_cb(nreq, 0, 0);
 244 }
 245
 246 static int
 247 __ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
 248                     const char *type, struct blob_attr *msg,
 249                     struct ubus_notify_request *req, bool reply)
 250 {
 251         memset(req, 0, sizeof(*req));
 252
 253         blob_buf_init(&b, 0);
 254         blob_put_int32(&b, UBUS_ATTR_OBJID, obj->id);
 255         blob_put_string(&b, UBUS_ATTR_METHOD, type);
 256
 257         if (!reply)
 258                 blob_put_int8(&b, UBUS_ATTR_NO_REPLY, true);
 259
 260         if (msg)
 261                 blob_put(&b, UBUS_ATTR_DATA, blob_data(msg), blob_len(msg));
 262
 263         if (ubus_start_request(ctx, &req->req, b.head, UBUS_MSG_NOTIFY, obj->id) < 0)
 264                 return UBUS_STATUS_INVALID_ARGUMENT;
 265
 266         /* wait for status message from ubusd first */
 267         req->req.notify = true;
 268         req->pending = 1;
 269         req->id[0] = obj->id;
 270         req->req.complete_cb = ubus_notify_complete_cb;
 271
 272         return 0;
 273 }
 274
 275 int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
 276                       const char *type, struct blob_attr *msg,
 277                       struct ubus_notify_request *req)
 278 {
 279         return __ubus_notify_async(ctx, obj, type, msg, req, true);
 280 }
 281
 282 int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
 283                 const char *type, struct blob_attr *msg, int timeout)
 284 {
 285         struct ubus_notify_request req;
 286         int ret;
 287
 288         ret = __ubus_notify_async(ctx, obj, type, msg, &req, timeout >= 0);
 289         if (ret < 0)
 290                 return ret;
 291
 292         if (timeout < 0) {
 293                 ubus_abort_request(ctx, &req.req);
 294                 return 0;
 295         }
 296
 297         return ubus_complete_request(ctx, &req.req, timeout);
 298 }
 299
 300 static bool ubus_get_status(struct ubus_msghdr *hdr, int *ret)
 301 {
 302         struct blob_attr **attrbuf = ubus_parse_msg(ubus_msghdr_data(hdr));
 303
 304         if (!attrbuf[UBUS_ATTR_STATUS])
 305                 return false;
 306
 307         *ret = blob_get_u32(attrbuf[UBUS_ATTR_STATUS]);
 308         return true;
 309 }
 310
 311 static int
 312 ubus_process_req_status(struct ubus_request *req, struct ubus_msghdr *hdr)
 313 {
 314         int ret = UBUS_STATUS_INVALID_ARGUMENT;
 315
 316         ubus_get_status(hdr, &ret);
 317         req->peer = hdr->peer;
 318         ubus_set_req_status(req, ret);
 319
 320         return ret;
 321 }
 322
 323 static void
 324 ubus_process_req_data(struct ubus_request *req, struct ubus_msghdr *hdr)
 325 {
 326         struct blob_attr *msg_data = ubus_msghdr_data(hdr);
 327         struct ubus_pending_data *data;
 328         int len;
 329
 330         if (!req->blocked) {
 331                 req->blocked = true;
 332                 req_data_cb(req, hdr->type, msg_data);
 333                 __ubus_process_req_data(req);
 334                 req->blocked = false;
 335
 336                 if (req->status_msg)
 337                         ubus_req_complete_cb(req);
 338
 339                 return;
 340         }
 341
 342         len = blob_raw_len(msg_data);
 343         data = calloc(1, sizeof(*data) + len);
 344         if (!data)
 345                 return;
 346
 347         data->type = hdr->type;
 348         memcpy(data->data, msg_data, len);
 349         list_add(&data->list, &req->pending);
 350 }
 351
 352 static int
 353 ubus_find_notify_id(struct ubus_notify_request *n, uint32_t objid)
 354 {
 355         uint32_t pending = n->pending;
 356         int i;
 357
 358         for (i = 0; pending; i++, pending >>= 1) {
 359                 if (!(pending & 1))
 360                         continue;
 361
 362                 if (n->id[i] == objid)
 363                         return i;
 364         }
 365
 366         return -1;
 367 }
 368
 369 static struct ubus_request *
 370 ubus_find_request(struct ubus_context *ctx, uint32_t seq, uint32_t peer, int *id)
 371 {
 372         struct ubus_request *req;
 373
 374         list_for_each_entry(req, &ctx->requests, list) {
 375                 struct ubus_notify_request *nreq;
 376                 nreq = container_of(req, struct ubus_notify_request, req);
 377
 378                 if (seq != req->seq)
 379                         continue;
 380
 381                 if (req->notify) {
 382                         if (!nreq->pending)
 383                                 continue;
 384
 385                         *id = ubus_find_notify_id(nreq, peer);
 386                         if (*id < 0)
 387                                 continue;
 388                 } else if (peer != req->peer)
 389                         continue;
 390
 391                 return req;
 392         }
 393         return NULL;
 394 }
 395
 396 static void ubus_process_notify_status(struct ubus_request *req, int id, struct ubus_msghdr *hdr)
 397 {
 398         struct ubus_notify_request *nreq;
 399         struct blob_attr **tb;
 400         struct blob_attr *cur;
 401         int rem, idx = 1;
 402         int ret = 0;
 403
 404         nreq = container_of(req, struct ubus_notify_request, req);
 405         nreq->pending &= ~(1 << id);
 406
 407         if (!id) {
 408                 /* first id: ubusd's status message with a list of ids */
 409                 tb = ubus_parse_msg(ubus_msghdr_data(hdr));
 410                 if (tb[UBUS_ATTR_SUBSCRIBERS]) {
 411                         blob_for_each_attr(cur, tb[UBUS_ATTR_SUBSCRIBERS], rem) {
 412                                 if (!blob_check_type(blob_data(cur), blob_len(cur), BLOB_ATTR_INT32))
 413                                         continue;
 414
 415                                 nreq->pending |= (1 << idx);
 416                                 nreq->id[idx] = blob_get_int32(cur);
 417                                 idx++;
 418
 419                                 if (idx == UBUS_MAX_NOTIFY_PEERS + 1)
 420                                         break;
 421                         }
 422                 }
 423         } else {
 424                 ubus_get_status(hdr, &ret);
 425                 if (nreq->status_cb)
 426                         nreq->status_cb(nreq, id, ret);
 427         }
 428
 429         if (!nreq->pending)
 430                 ubus_set_req_status(req, 0);
 431 }
 432
 433 void __hidden ubus_process_req_msg(struct ubus_context *ctx, struct ubus_msghdr *hdr, int fd)
 434 {
 435         struct ubus_request *req;
 436         int id = -1;
 437
 438         switch(hdr->type) {
 439         case UBUS_MSG_STATUS:
 440                 req = ubus_find_request(ctx, hdr->seq, hdr->peer, &id);
 441                 if (!req)
 442                         break;
 443
 444                 if (fd >= 0) {
 445                         if (req->fd_cb)
 446                                 req->fd_cb(req, fd);
 447                         else
 448                                 close(fd);
 449                 }
 450
 451                 if (id >= 0)
 452                         ubus_process_notify_status(req, id, hdr);
 453                 else
 454                         ubus_process_req_status(req, hdr);
 455                 break;
 456
 457         case UBUS_MSG_DATA:
 458                 req = ubus_find_request(ctx, hdr->seq, hdr->peer, &id);
 459                 if (req && (req->data_cb || req->raw_data_cb))
 460                         ubus_process_req_data(req, hdr);
 461                 break;
 462         }
 463 }