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