/* * Copyright (C) 2011 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 * as published by the Free Software Foundation * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. */ #include #include #include #include #include #include "ubusmsg.h" #include "ubus_common.h" struct ubus_context; struct ubus_msg_src; struct ubus_object; struct ubus_request; struct ubus_request_data; struct ubus_object_data; struct ubus_event_handler; typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx, struct ubus_object_data *obj, void *priv); typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj, struct ubus_request_data *req, const char *method, struct blob_attr *msg); typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev, 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_complete_handler_t)(struct ubus_request *req, int ret); #define UBUS_OBJECT_TYPE(_name, _methods) \ { \ .name = _name, \ .id = 0, \ .n_methods = ARRAY_SIZE(_methods), \ .methods = _methods \ } #define UBUS_METHOD(_name, _handler, _policy) \ { \ .name = _name, \ .handler = _handler, \ .policy = _policy, \ .n_policy = ARRAY_SIZE(_policy) \ } struct ubus_method { const char *name; ubus_handler_t handler; const struct blobmsg_policy *policy; int n_policy; }; struct ubus_object_type { const char *name; uint32_t id; const struct ubus_method *methods; int n_methods; }; struct ubus_object { struct avl_node avl; const char *name; uint32_t id; const char *path; struct ubus_object_type *type; const struct ubus_method *methods; int n_methods; }; struct ubus_event_handler { struct ubus_object obj; ubus_event_handler_t cb; }; struct ubus_context { struct list_head requests; struct avl_tree objects; struct list_head pending; struct uloop_fd sock; uint32_t local_id; uint32_t request_seq; int stack_depth; void (*connection_lost)(struct ubus_context *ctx); struct { struct ubus_msghdr hdr; char data[UBUS_MAX_MSGLEN]; } msgbuf; }; struct ubus_object_data { uint32_t id; uint32_t type_id; const char *path; struct blob_attr *signature; }; struct ubus_request_data { uint32_t object; uint32_t peer; uint32_t seq; }; struct ubus_request { struct list_head list; struct list_head pending; bool status_msg; int status_code; bool blocked; bool cancelled; uint32_t peer; uint32_t seq; ubus_data_handler_t raw_data_cb; ubus_data_handler_t data_cb; ubus_complete_handler_t complete_cb; struct ubus_context *ctx; void *priv; }; struct ubus_context *ubus_connect(const char *path); void ubus_free(struct ubus_context *ctx); const char *ubus_strerror(int error); static inline void ubus_add_uloop(struct ubus_context *ctx) { uloop_fd_add(&ctx->sock, ULOOP_EDGE_TRIGGER | ULOOP_BLOCKING | ULOOP_READ); } /* call this for read events on ctx->sock.fd when not using uloop */ static inline void ubus_handle_event(struct ubus_context *ctx) { ctx->sock.cb(&ctx->sock, ULOOP_READ); } /* ----------- raw request handling ----------- */ /* wait for a request to complete and return its status */ int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req, int timeout); /* complete a request asynchronously */ void ubus_complete_request_async(struct ubus_context *ctx, struct ubus_request *req); /* abort an asynchronous request */ void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req); /* ----------- objects ----------- */ int ubus_lookup(struct ubus_context *ctx, const char *path, ubus_lookup_handler_t cb, void *priv); int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id); /* make an object visible to remote connections */ int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj); /* remove the object from the ubus connection */ int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj); /* ----------- rpc ----------- */ /* invoke a method on a specific object */ int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method, struct blob_attr *msg, ubus_data_handler_t cb, void *priv, int timeout); /* asynchronous version of ubus_invoke() */ int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method, struct blob_attr *msg, struct ubus_request *req); /* send a reply to an incoming object method call */ int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req, struct blob_attr *msg); /* ----------- events ----------- */ int ubus_send_event(struct ubus_context *ctx, const char *id, struct blob_attr *data); int ubus_register_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev, const char *pattern); static inline int ubus_unregister_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev) { return ubus_remove_object(ctx, &ev->obj); }