libubus.c File Reference

#include <sys/types.h>
#include <sys/socket.h>
#include <unistd.h>
#include <libubox/blob.h>
#include <libubox/blobmsg.h>
#include "libubus.h"
#include "libubus-internal.h"
#include "ubusmsg.h"

Go to the source code of this file.

Data Structures
struct	ubus_pending_msg
struct	ubus_lookup_request

Functions
static int	ubus_cmp_id (const void *k1, const void *k2, void *ptr)
const char *	ubus_strerror (int error)
static void	ubus_queue_msg (struct ubus_context *ctx, struct ubus_msghdr_buf *buf)
void __hidden	ubus_process_msg (struct ubus_context *ctx, struct ubus_msghdr_buf *buf, int fd)
static void	ubus_process_pending_msg (struct uloop_timeout *timeout)
static void	ubus_lookup_cb (struct ubus_request *ureq, int type, struct blob_attr *msg)
int	ubus_lookup (struct ubus_context *ctx, const char *path, ubus_lookup_handler_t cb, void *priv)
static void	ubus_lookup_id_cb (struct ubus_request *req, int type, struct blob_attr *msg)
int	ubus_lookup_id (struct ubus_context *ctx, const char *path, uint32_t *id)
static int	ubus_event_cb (struct ubus_context *ctx, struct ubus_object *obj, struct ubus_request_data *req, const char *method, struct blob_attr *msg)
int	ubus_register_event_handler (struct ubus_context *ctx, struct ubus_event_handler *ev, const char *pattern)
int	ubus_send_event (struct ubus_context *ctx, const char *id, struct blob_attr *data)
static void	ubus_default_connection_lost (struct ubus_context *ctx)
int	ubus_connect_ctx (struct ubus_context *ctx, const char *path)
static void	ubus_auto_reconnect_cb (struct uloop_timeout *timeout)
static void	ubus_auto_disconnect_cb (struct ubus_context *ctx)
static void	ubus_auto_connect_cb (struct uloop_timeout *timeout)
void	ubus_auto_connect (struct ubus_auto_conn *conn)
struct ubus_context *	ubus_connect (const char *path)
void	ubus_shutdown (struct ubus_context *ctx)
void	ubus_free (struct ubus_context *ctx)

Variables
const char *	__ubus_strerror [__UBUS_STATUS_LAST]
struct blob_buf b	__hidden = {}
static const struct ubus_method	event_method

Function Documentation

ubus_auto_connect()

void ubus_auto_connect

(

struct ubus_auto_conn *

conn

)

Definition at line 345 of file libubus.c.

{
        conn->timer.cb = ubus_auto_connect_cb;
        ubus_auto_connect_cb(&conn->timer);
}

Here is the call graph for this function:

ubus_auto_connect_cb()

static void ubus_auto_connect_cb ( struct uloop_timeout *  timeout )

static

Definition at line 330 of file libubus.c.

{
        struct ubus_auto_conn *conn = container_of(timeout, struct ubus_auto_conn, timer);
 
        if (ubus_connect_ctx(&conn->ctx, conn->path)) {
                uloop_timeout_set(timeout, 1000);
                fprintf(stderr, "failed to connect to ubus\n");
                return;
        }
        conn->ctx.connection_lost = ubus_auto_disconnect_cb;
        if (conn->cb)
                conn->cb(&conn->ctx);
        ubus_add_uloop(&conn->ctx);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_auto_disconnect_cb()

static void ubus_auto_disconnect_cb ( struct ubus_context *  ctx )

static

Definition at line 322 of file libubus.c.

{
        struct ubus_auto_conn *conn = container_of(ctx, struct ubus_auto_conn, ctx);
 
        conn->timer.cb = ubus_auto_reconnect_cb;
        uloop_timeout_set(&conn->timer, 1000);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_auto_reconnect_cb()

static void ubus_auto_reconnect_cb ( struct uloop_timeout *  timeout )

static

Definition at line 312 of file libubus.c.

{
        struct ubus_auto_conn *conn = container_of(timeout, struct ubus_auto_conn, timer);
 
        if (!ubus_reconnect(&conn->ctx, conn->path))
                ubus_add_uloop(&conn->ctx);
        else
                uloop_timeout_set(timeout, 1000);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_cmp_id()

static int ubus_cmp_id ( const void *  k1, const void *  k2, void *  ptr  )

static

Definition at line 49 of file libubus.c.

{
        const uint32_t *id1 = k1, *id2 = k2;
 
        if (*id1 < *id2)
                return -1;
        else
                return *id1 > *id2;
}

Here is the caller graph for this function:

ubus_connect()

struct ubus_context* ubus_connect

(

const char *

path

)

Definition at line 351 of file libubus.c.

{
        struct ubus_context *ctx;
 
        ctx = calloc(1, sizeof(*ctx));
        if (!ctx)
                return NULL;
 
        if (ubus_connect_ctx(ctx, path)) {
                free(ctx);
                ctx = NULL;
        }
 
        return ctx;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_connect_ctx()

int ubus_connect_ctx	(	struct ubus_context *	ctx,
		const char *	path
	)

Definition at line 284 of file libubus.c.

{
        uloop_init();
        memset(ctx, 0, sizeof(*ctx));
 
        ctx->sock.fd = -1;
        ctx->sock.cb = ubus_handle_data;
        ctx->connection_lost = ubus_default_connection_lost;
        ctx->pending_timer.cb = ubus_process_pending_msg;
 
        ctx->msgbuf.data = calloc(1, UBUS_MSG_CHUNK_SIZE);
        if (!ctx->msgbuf.data)
                return -1;
        ctx->msgbuf_data_len = UBUS_MSG_CHUNK_SIZE;
 
        INIT_LIST_HEAD(&ctx->requests);
        INIT_LIST_HEAD(&ctx->pending);
        INIT_LIST_HEAD(&ctx->auto_subscribers);
        avl_init(&ctx->objects, ubus_cmp_id, false, NULL);
        if (ubus_reconnect(ctx, path)) {
                free(ctx->msgbuf.data);
                ctx->msgbuf.data = NULL;
                return -1;
        }
 
        return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_default_connection_lost()

static void ubus_default_connection_lost ( struct ubus_context *  ctx )

static

Definition at line 278 of file libubus.c.

{
        if (ctx->sock.registered)
                uloop_end();
}

Here is the caller graph for this function:

ubus_event_cb()

static int ubus_event_cb ( struct ubus_context *  ctx, struct ubus_object *  obj, struct ubus_request_data *  req, const char *  method, struct blob_attr *  msg  )

static

Definition at line 209 of file libubus.c.

{
        struct ubus_event_handler *ev;
 
        ev = container_of(obj, struct ubus_event_handler, obj);
        ev->cb(ctx, ev, method, msg);
        return 0;
}

ubus_free()

void ubus_free

(

struct ubus_context *

ctx

)

Definition at line 378 of file libubus.c.

{
        ubus_shutdown(ctx);
        free(ctx);
}

Here is the caller graph for this function:

ubus_lookup()

int ubus_lookup	(	struct ubus_context *	ctx,
		const char *	path,
		ubus_lookup_handler_t	cb,
		void *	priv
	)

Definition at line 161 of file libubus.c.

{
        struct ubus_lookup_request lookup;
 
        blob_buf_init(&b, 0);
        if (path)
                blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
 
        if (ubus_start_request(ctx, &lookup.req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
                return UBUS_STATUS_INVALID_ARGUMENT;
 
        lookup.req.raw_data_cb = ubus_lookup_cb;
        lookup.req.priv = priv;
        lookup.cb = cb;
        return ubus_complete_request(ctx, &lookup.req, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_lookup_cb()

static void ubus_lookup_cb ( struct ubus_request *  ureq, int  type, struct blob_attr *  msg  )

static

Definition at line 141 of file libubus.c.

{
        struct ubus_lookup_request *req;
        struct ubus_object_data obj = {};
        struct blob_attr **attr;
 
        req = container_of(ureq, struct ubus_lookup_request, req);
        attr = ubus_parse_msg(msg, blob_raw_len(msg));
 
        if (!attr[UBUS_ATTR_OBJID] || !attr[UBUS_ATTR_OBJPATH] ||
            !attr[UBUS_ATTR_OBJTYPE])
                return;
 
        obj.id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
        obj.path = blob_data(attr[UBUS_ATTR_OBJPATH]);
        obj.type_id = blob_get_u32(attr[UBUS_ATTR_OBJTYPE]);
        obj.signature = attr[UBUS_ATTR_SIGNATURE];
        req->cb(ureq->ctx, &obj, ureq->priv);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_lookup_id()

int ubus_lookup_id	(	struct ubus_context *	ctx,
		const char *	path,
		uint32_t *	id
	)

Definition at line 192 of file libubus.c.

{
        struct ubus_request req;
 
        blob_buf_init(&b, 0);
        if (path)
                blob_put_string(&b, UBUS_ATTR_OBJPATH, path);
 
        if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_LOOKUP, 0) < 0)
                return UBUS_STATUS_INVALID_ARGUMENT;
 
        req.raw_data_cb = ubus_lookup_id_cb;
        req.priv = id;
 
        return ubus_complete_request(ctx, &req, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_lookup_id_cb()

static void ubus_lookup_id_cb ( struct ubus_request *  req, int  type, struct blob_attr *  msg  )

static

Definition at line 179 of file libubus.c.

{
        struct blob_attr **attr;
        uint32_t *id = req->priv;
 
        attr = ubus_parse_msg(msg, blob_raw_len(msg));
 
        if (!attr[UBUS_ATTR_OBJID])
                return;
 
        *id = blob_get_u32(attr[UBUS_ATTR_OBJID]);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_process_msg()

void __hidden ubus_process_msg	(	struct ubus_context *	ctx,
		struct ubus_msghdr_buf *	buf,
		int	fd
	)

Definition at line 93 of file libubus.c.

{
        switch(buf->hdr.type) {
        case UBUS_MSG_STATUS:
        case UBUS_MSG_DATA:
                ubus_process_req_msg(ctx, buf, fd);
                break;
 
        case UBUS_MSG_INVOKE:
        case UBUS_MSG_UNSUBSCRIBE:
        case UBUS_MSG_NOTIFY:
                if (ctx->stack_depth) {
                        ubus_queue_msg(ctx, buf);
                        break;
                }
 
                ctx->stack_depth++;
                ubus_process_obj_msg(ctx, buf, fd);
                ctx->stack_depth--;
                break;
        case UBUS_MSG_MONITOR:
                if (ctx->monitor_cb)
                        ctx->monitor_cb(ctx, buf->hdr.seq, buf->data);
                break;
        }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_process_pending_msg()

static void ubus_process_pending_msg ( struct uloop_timeout *  timeout )

static

Definition at line 120 of file libubus.c.

{
        struct ubus_context *ctx = container_of(timeout, struct ubus_context, pending_timer);
        struct ubus_pending_msg *pending;
 
        while (!list_empty(&ctx->pending)) {
                if (ctx->stack_depth)
                        break;
 
                pending = list_first_entry(&ctx->pending, struct ubus_pending_msg, list);
                list_del(&pending->list);
                ubus_process_msg(ctx, &pending->hdr, -1);
                free(pending);
        }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_queue_msg()

static void ubus_queue_msg ( struct ubus_context *  ctx, struct ubus_msghdr_buf *  buf  )

static

Definition at line 77 of file libubus.c.

{
        struct ubus_pending_msg *pending;
        void *data;
 
        pending = calloc_a(sizeof(*pending), &data, blob_raw_len(buf->data));
 
        pending->hdr.data = data;
        memcpy(&pending->hdr.hdr, &buf->hdr, sizeof(buf->hdr));
        memcpy(data, buf->data, blob_raw_len(buf->data));
        list_add_tail(&pending->list, &ctx->pending);
        if (ctx->sock.registered)
                uloop_timeout_set(&ctx->pending_timer, 1);
}

Here is the caller graph for this function:

ubus_register_event_handler()

int ubus_register_event_handler	(	struct ubus_context *	ctx,
		struct ubus_event_handler *	ev,
		const char *	pattern
	)

Definition at line 225 of file libubus.c.

{
        struct ubus_object *obj = &ev->obj;
        struct blob_buf b2 = {};
        int ret;
 
        if (!obj->id) {
                obj->methods = &event_method;
                obj->n_methods = 1;
 
                if (!!obj->name ^ !!obj->type)
                        return UBUS_STATUS_INVALID_ARGUMENT;
 
                ret = ubus_add_object(ctx, obj);
                if (ret)
                        return ret;
        }
 
        /* use a second buffer, ubus_invoke() overwrites the primary one */
        blob_buf_init(&b2, 0);
        blobmsg_add_u32(&b2, "object", obj->id);
        if (pattern)
                blobmsg_add_string(&b2, "pattern", pattern);
 
        ret = ubus_invoke(ctx, UBUS_SYSTEM_OBJECT_EVENT, "register", b2.head,
                          NULL, NULL, 0);
        blob_buf_free(&b2);
 
        return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_send_event()

int ubus_send_event	(	struct ubus_context *	ctx,
		const char *	id,
		struct blob_attr *	data
	)

Definition at line 258 of file libubus.c.

{
        struct ubus_request req;
        void *s;
 
        blob_buf_init(&b, 0);
        blob_put_int32(&b, UBUS_ATTR_OBJID, UBUS_SYSTEM_OBJECT_EVENT);
        blob_put_string(&b, UBUS_ATTR_METHOD, "send");
        s = blob_nest_start(&b, UBUS_ATTR_DATA);
        blobmsg_add_string(&b, "id", id);
        blobmsg_add_field(&b, BLOBMSG_TYPE_TABLE, "data", blob_data(data), blob_len(data));
        blob_nest_end(&b, s);
 
        if (ubus_start_request(ctx, &req, b.head, UBUS_MSG_INVOKE, UBUS_SYSTEM_OBJECT_EVENT) < 0)
                return UBUS_STATUS_INVALID_ARGUMENT;
 
        return ubus_complete_request(ctx, &req, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ubus_shutdown()

void ubus_shutdown

(

struct ubus_context *

ctx

)

Definition at line 367 of file libubus.c.

{
        blob_buf_free(&b);
        if (!ctx)
                return;
        uloop_fd_delete(&ctx->sock);
        close(ctx->sock.fd);
        uloop_timeout_cancel(&ctx->pending_timer);
        free(ctx->msgbuf.data);
}

Here is the caller graph for this function:

ubus_strerror()

const char* ubus_strerror

(

int

error

)

Definition at line 59 of file libubus.c.

{
        static char err[32];
 
        if (error < 0 || error >= __UBUS_STATUS_LAST)
                goto out;
 
        if (!__ubus_strerror[error])
                goto out;
 
        return __ubus_strerror[error];
 
out:
        sprintf(err, "Unknown error: %d", error);
        return err;
}

Here is the caller graph for this function:

Variable Documentation

__hidden

struct blob_buf b __hidden = {}

Definition at line 25 of file libubus.c.

__ubus_strerror

const char* __ubus_strerror[__UBUS_STATUS_LAST]

Initial value:

= {
        [UBUS_STATUS_OK] = "Success",
        [UBUS_STATUS_INVALID_COMMAND] = "Invalid command",
        [UBUS_STATUS_INVALID_ARGUMENT] = "Invalid argument",
        [UBUS_STATUS_METHOD_NOT_FOUND] = "Method not found",
        [UBUS_STATUS_NOT_FOUND] = "Not found",
        [UBUS_STATUS_NO_DATA] = "No response",
        [UBUS_STATUS_PERMISSION_DENIED] = "Permission denied",
        [UBUS_STATUS_TIMEOUT] = "Request timed out",
        [UBUS_STATUS_NOT_SUPPORTED] = "Operation not supported",
        [UBUS_STATUS_UNKNOWN_ERROR] = "Unknown error",
        [UBUS_STATUS_CONNECTION_FAILED] = "Connection failed",
        [UBUS_STATUS_NO_MEMORY] = "Out of memory",
        [UBUS_STATUS_PARSE_ERROR] = "Parsing message data failed",
        [UBUS_STATUS_SYSTEM_ERROR] = "System error",
}

Definition at line 25 of file libubus.c.

event_method

const struct ubus_method event_method

static

Initial value:

= {
        .name = NULL,
        .handler = ubus_event_cb,
}

Definition at line 209 of file libubus.c.