X-Git-Url: http://git.archive.openwrt.org/?p=project%2Fubus.git;a=blobdiff_plain;f=libubus.h;h=1b219b7f9e4520208408957ce477ccee0af7a6db;hp=a120eb6d9f419dd99702cd56030af254393a73db;hb=6a86e65f7d4836bfe387d213a6dfaea1d5d162dd;hpb=3642af8097bf546fc7ce476a730e1187a35a3942 diff --git a/libubus.h b/libubus.h index a120eb6..1b219b7 100644 --- a/libubus.h +++ b/libubus.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2011-2012 Felix Fietkau + * Copyright (C) 2011-2014 Felix Fietkau * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 2.1 @@ -34,6 +34,11 @@ struct ubus_event_handler; struct ubus_subscriber; struct ubus_notify_request; +struct ubus_msghdr_buf { + struct ubus_msghdr hdr; + struct blob_attr *data; +}; + typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx, struct ubus_object_data *obj, void *priv); @@ -47,9 +52,11 @@ typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event const char *type, struct blob_attr *msg); typedef void (*ubus_data_handler_t)(struct ubus_request *req, int type, struct blob_attr *msg); +typedef void (*ubus_fd_handler_t)(struct ubus_request *req, int fd); typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret); typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req, int idx, int ret); +typedef void (*ubus_connect_handler_t)(struct ubus_context *ctx); #define UBUS_OBJECT_TYPE(_name, _methods) \ { \ @@ -59,18 +66,44 @@ typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req, .methods = _methods \ } +#define __UBUS_METHOD_NOARG(_name, _handler, _tags) \ + .name = _name, \ + .handler = _handler, \ + .tags = _tags + +#define __UBUS_METHOD(_name, _handler, _policy, _tags) \ + __UBUS_METHOD_NOARG(_name, _handler, _tags), \ + .policy = _policy, \ + .n_policy = ARRAY_SIZE(_policy) + #define UBUS_METHOD(_name, _handler, _policy) \ + { __UBUS_METHOD(_name, _handler, _policy, 0) } + +#define UBUS_METHOD_TAG(_name, _handler, _policy, _tags)\ + { __UBUS_METHOD(_name, _handler, _policy, _tags) } + +#define UBUS_METHOD_MASK(_name, _handler, _policy, _mask) \ { \ - .name = _name, \ - .handler = _handler, \ - .policy = _policy, \ - .n_policy = ARRAY_SIZE(_policy) \ + __UBUS_METHOD(_name, _handler, _policy, 0),\ + .mask = _mask \ } +#define UBUS_METHOD_NOARG(_name, _handler) \ + { __UBUS_METHOD_NOARG(_name, _handler, 0) } + +#define UBUS_METHOD_TAG_NOARG(_name, _handler, _tags) \ + { __UBUS_METHOD_NOARG(_name, _handler, _tags) } + +#define UBUS_TAG_STATUS BIT(0) +#define UBUS_TAG_ADMIN BIT(1) +#define UBUS_TAG_PRIVATE BIT(2) + struct ubus_method { const char *name; ubus_handler_t handler; + unsigned long mask; + unsigned long tags; const struct blobmsg_policy *policy; int n_policy; }; @@ -118,17 +151,18 @@ struct ubus_context { struct list_head pending; struct uloop_fd sock; + struct uloop_timeout pending_timer; uint32_t local_id; uint16_t request_seq; int stack_depth; void (*connection_lost)(struct ubus_context *ctx); + void (*monitor_cb)(struct ubus_context *ctx, uint32_t seq, struct blob_attr *data); - struct { - struct ubus_msghdr hdr; - char data[UBUS_MAX_MSGLEN]; - } msgbuf; + struct ubus_msghdr_buf msgbuf; + uint32_t msgbuf_data_len; + int msgbuf_reduction_counter; }; struct ubus_object_data { @@ -138,11 +172,22 @@ struct ubus_object_data { struct blob_attr *signature; }; +struct ubus_acl_key { + const char *user; + const char *group; + const char *object; +}; + struct ubus_request_data { uint32_t object; uint32_t peer; uint16_t seq; + + struct ubus_acl_key acl; + + /* internal use */ bool deferred; + int fd; }; struct ubus_request { @@ -160,6 +205,7 @@ struct ubus_request { ubus_data_handler_t raw_data_cb; ubus_data_handler_t data_cb; + ubus_fd_handler_t fd_cb; ubus_complete_handler_t complete_cb; struct ubus_context *ctx; @@ -176,10 +222,30 @@ struct ubus_notify_request { uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1]; }; +struct ubus_auto_conn { + struct ubus_context ctx; + struct uloop_timeout timer; + const char *path; + ubus_connect_handler_t cb; +}; + struct ubus_context *ubus_connect(const char *path); +int ubus_connect_ctx(struct ubus_context *ctx, const char *path); +void ubus_auto_connect(struct ubus_auto_conn *conn); int ubus_reconnect(struct ubus_context *ctx, const char *path); + +/* call this only for struct ubus_context pointers returned by ubus_connect() */ void ubus_free(struct ubus_context *ctx); +/* call this only for struct ubus_context pointers initialised by ubus_connect_ctx() */ +void ubus_shutdown(struct ubus_context *ctx); + +static inline void ubus_auto_shutdown(struct ubus_auto_conn *conn) +{ + uloop_timeout_cancel(&conn->timer); + ubus_shutdown(&conn->ctx); +} + const char *ubus_strerror(int error); static inline void ubus_add_uloop(struct ubus_context *ctx) @@ -221,9 +287,44 @@ int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj); /* add a subscriber notifications from another object */ int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj); + +static inline int +ubus_unregister_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj) +{ + return ubus_remove_object(ctx, &obj->obj); +} + int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id); int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id); +int __ubus_monitor(struct ubus_context *ctx, const char *type); + +static inline int ubus_monitor_start(struct ubus_context *ctx) +{ + return __ubus_monitor(ctx, "add"); +} + +static inline int ubus_monitor_stop(struct ubus_context *ctx) +{ + return __ubus_monitor(ctx, "remove"); +} + + +/* ----------- acl ----------- */ + +struct acl_object { + struct ubus_acl_key key; + struct avl_node avl; + struct blob_attr *acl; +}; + +extern struct avl_tree acl_objects; +int ubus_register_acl(struct ubus_context *ctx); + +#define acl_for_each(o, m) \ + if ((m)->object && (m)->user && (m)->group) \ + avl_for_element_range(avl_find_ge_element(&acl_objects, m, o, avl), avl_find_le_element(&acl_objects, m, o, avl), o, avl) + /* ----------- rpc ----------- */ /* invoke a method on a specific object */ @@ -247,6 +348,12 @@ static inline void ubus_defer_request(struct ubus_context *ctx, req->deferred = true; } +static inline void ubus_request_set_fd(struct ubus_context *ctx, + struct ubus_request_data *req, int fd) +{ + req->fd = fd; +} + void ubus_complete_deferred_request(struct ubus_context *ctx, struct ubus_request_data *req, int ret);