blob.h File Reference

#include <stdbool.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include "utils.h"

Go to the source code of this file.

Data Structures
struct	blob_attr
struct	blob_attr_info
struct	blob_buf

Macros
#define	BLOB_COOKIE   0x01234567
#define	BLOB_ATTR_ID_MASK   0x7f000000
#define	BLOB_ATTR_ID_SHIFT   24
#define	BLOB_ATTR_LEN_MASK   0x00ffffff
#define	BLOB_ATTR_ALIGN   4
#define	BLOB_ATTR_EXTENDED   0x80000000
#define	blob_put_int8   blob_put_u8
#define	blob_put_int16   blob_put_u16
#define	blob_put_int32   blob_put_u32
#define	blob_put_int64   blob_put_u64
#define	__blob_for_each_attr(pos, attr, rem)
#define	blob_for_each_attr(pos, attr, rem)
#define	blob_for_each_attr_len(pos, attr, attr_len, rem)

Enumerations
enum	{   BLOB_ATTR_UNSPEC , BLOB_ATTR_NESTED , BLOB_ATTR_BINARY , BLOB_ATTR_STRING ,   BLOB_ATTR_INT8 , BLOB_ATTR_INT16 , BLOB_ATTR_INT32 , BLOB_ATTR_INT64 ,   BLOB_ATTR_DOUBLE , BLOB_ATTR_LAST }

Functions
struct blob_attr	__attribute__ ((packed))
static void *	blob_data (const struct blob_attr *attr)
static unsigned int	blob_id (const struct blob_attr *attr)
static bool	blob_is_extended (const struct blob_attr *attr)
static size_t	blob_len (const struct blob_attr *attr)
static size_t	blob_raw_len (const struct blob_attr *attr)
static size_t	blob_pad_len (const struct blob_attr *attr)
static uint8_t	blob_get_u8 (const struct blob_attr *attr)
static uint16_t	blob_get_u16 (const struct blob_attr *attr)
static uint32_t	blob_get_u32 (const struct blob_attr *attr)
static uint64_t	blob_get_u64 (const struct blob_attr *attr)
static int8_t	blob_get_int8 (const struct blob_attr *attr)
static int16_t	blob_get_int16 (const struct blob_attr *attr)
static int32_t	blob_get_int32 (const struct blob_attr *attr)
static int64_t	blob_get_int64 (const struct blob_attr *attr)
static const char *	blob_get_string (const struct blob_attr *attr)
static struct blob_attr *	blob_next (const struct blob_attr *attr)
void	blob_fill_pad (struct blob_attr *attr)
void	blob_set_raw_len (struct blob_attr *attr, unsigned int len)
bool	blob_attr_equal (const struct blob_attr *a1, const struct blob_attr *a2)
int	blob_buf_init (struct blob_buf *buf, int id)
void	blob_buf_free (struct blob_buf *buf)
bool	blob_buf_grow (struct blob_buf *buf, int required)
struct blob_attr *	blob_new (struct blob_buf *buf, int id, int payload)
void *	blob_nest_start (struct blob_buf *buf, int id)
void	blob_nest_end (struct blob_buf *buf, void *cookie)
struct blob_attr *	blob_put (struct blob_buf *buf, int id, const void *ptr, unsigned int len)
bool	blob_check_type (const void *ptr, unsigned int len, int type)
int	blob_parse (struct blob_attr *attr, struct blob_attr **data, const struct blob_attr_info *info, int max)
int	blob_parse_untrusted (struct blob_attr *attr, size_t attr_len, struct blob_attr **data, const struct blob_attr_info *info, int max)
struct blob_attr *	blob_memdup (struct blob_attr *attr)
struct blob_attr *	blob_put_raw (struct blob_buf *buf, const void *ptr, unsigned int len)
static struct blob_attr *	blob_put_string (struct blob_buf *buf, int id, const char *str)
static struct blob_attr *	blob_put_u8 (struct blob_buf *buf, int id, uint8_t val)
static struct blob_attr *	blob_put_u16 (struct blob_buf *buf, int id, uint16_t val)
static struct blob_attr *	blob_put_u32 (struct blob_buf *buf, int id, uint32_t val)
static struct blob_attr *	blob_put_u64 (struct blob_buf *buf, int id, uint64_t val)

Variables
uint32_t	id_len
char	data []
struct blob_attr_info	__attribute__

Macro Definition Documentation

__blob_for_each_attr

#define __blob_for_each_attr	(		pos,
			attr,
			rem
	)

Value:

        for (pos = (struct blob_attr *) attr; \
             rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
             (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
             rem -= blob_pad_len(pos), pos = blob_next(pos))

Definition at line 244 of file blob.h.

BLOB_ATTR_ALIGN

#define BLOB_ATTR_ALIGN   4

Definition at line 49 of file blob.h.

BLOB_ATTR_EXTENDED

#define BLOB_ATTR_EXTENDED   0x80000000

Definition at line 50 of file blob.h.

BLOB_ATTR_ID_MASK

#define BLOB_ATTR_ID_MASK   0x7f000000

Definition at line 46 of file blob.h.

BLOB_ATTR_ID_SHIFT

#define BLOB_ATTR_ID_SHIFT   24

Definition at line 47 of file blob.h.

BLOB_ATTR_LEN_MASK

#define BLOB_ATTR_LEN_MASK   0x00ffffff

Definition at line 48 of file blob.h.

BLOB_COOKIE

#define BLOB_COOKIE   0x01234567

Definition at line 31 of file blob.h.

blob_for_each_attr

#define blob_for_each_attr	(		pos,
			attr,
			rem
	)

Value:

        for (rem = attr ? blob_len(attr) : 0, \
             pos = (struct blob_attr *) (attr ? blob_data(attr) : NULL); \
             rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
             (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
             rem -= blob_pad_len(pos), pos = blob_next(pos))

Definition at line 251 of file blob.h.

blob_for_each_attr_len

#define blob_for_each_attr_len	(		pos,
			attr,
			attr_len,
			rem
	)

Value:

        for (rem = attr ? blob_len(attr) : 0, \
             pos = (struct blob_attr *) (attr ? blob_data(attr) : NULL); \
             rem >= sizeof(struct blob_attr) && rem < attr_len && (blob_pad_len(pos) <= rem) && \
             (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
             rem -= blob_pad_len(pos), pos = blob_next(pos))

Definition at line 258 of file blob.h.

blob_put_int16

#define blob_put_int16   blob_put_u16

Definition at line 240 of file blob.h.

blob_put_int32

#define blob_put_int32   blob_put_u32

Definition at line 241 of file blob.h.

blob_put_int64

#define blob_put_int64   blob_put_u64

Definition at line 242 of file blob.h.

blob_put_int8

#define blob_put_int8   blob_put_u8

Definition at line 239 of file blob.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
BLOB_ATTR_UNSPEC
BLOB_ATTR_NESTED
BLOB_ATTR_BINARY
BLOB_ATTR_STRING
BLOB_ATTR_INT8
BLOB_ATTR_INT16
BLOB_ATTR_INT32
BLOB_ATTR_INT64
BLOB_ATTR_DOUBLE
BLOB_ATTR_LAST

Definition at line 33 of file blob.h.

     {
        BLOB_ATTR_UNSPEC,
        BLOB_ATTR_NESTED,
        BLOB_ATTR_BINARY,
        BLOB_ATTR_STRING,
        BLOB_ATTR_INT8,
        BLOB_ATTR_INT16,
        BLOB_ATTR_INT32,
        BLOB_ATTR_INT64,
        BLOB_ATTR_DOUBLE,
        BLOB_ATTR_LAST
};

Function Documentation

__attribute__()

struct blob_attr __attribute__

(

(packed)

)

blob_attr_equal()

bool blob_attr_equal	(	const struct blob_attr *	a1,
		const struct blob_attr *	a2
	)

Definition at line 311 of file blob.c.

{
        if (!a1 && !a2)
                return true;
 
        if (!a1 || !a2)
                return false;
 
        if (blob_pad_len(a1) != blob_pad_len(a2))
                return false;
 
        return !memcmp(a1, a2, blob_pad_len(a1));
}

Here is the call graph for this function:

blob_buf_free()

void blob_buf_free

(

struct blob_buf *

buf

)

Definition at line 104 of file blob.c.

{
        free(buf->buf);
        buf->buf = NULL;
        buf->head = NULL;
        buf->buflen = 0;
}

Here is the caller graph for this function:

blob_buf_grow()

bool blob_buf_grow	(	struct blob_buf *	buf,
		int	required
	)

Definition at line 57 of file blob.c.

{
        int offset_head = attr_to_offset(buf, buf->head);
 
        if ((buf->buflen + required) > BLOB_ATTR_LEN_MASK)
                return false;
        if (!buf->grow || !buf->grow(buf, required))
                return false;
 
        buf->head = offset_to_attr(buf, offset_head);
        return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_buf_init()

int blob_buf_init	(	struct blob_buf *	buf,
		int	id
	)

Definition at line 91 of file blob.c.

{
        if (!buf->grow)
                buf->grow = blob_buffer_grow;
 
        buf->head = buf->buf;
        if (blob_add(buf, buf->buf, id, 0) == NULL)
                return -ENOMEM;
 
        return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_check_type()

bool blob_check_type	(	const void *	ptr,
		unsigned int	len,
		int	type
	)

Definition at line 202 of file blob.c.

{
        const char *data = ptr;
 
        if (type >= BLOB_ATTR_LAST)
                return false;
 
        if (type >= BLOB_ATTR_INT8 && type <= BLOB_ATTR_INT64) {
                if (len != blob_type_minlen[type])
                        return false;
        } else {
                if (len < blob_type_minlen[type])
                        return false;
        }
 
        if (type == BLOB_ATTR_STRING && data[len - 1] != 0)
                return false;
 
        return true;
}

Here is the caller graph for this function:

blob_data()

static void* blob_data ( const struct blob_attr *  attr )

inlinestatic

Definition at line 75 of file blob.h.

{
        return (void *) attr->data;
}

Here is the caller graph for this function:

blob_fill_pad()

void blob_fill_pad

(

struct blob_attr *

attr

)

Definition at line 113 of file blob.c.

{
        char *buf = (char *) attr;
        int len = blob_pad_len(attr);
        int delta = len - blob_raw_len(attr);
 
        if (delta > 0)
                memset(buf + len - delta, 0, delta);
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_get_int16()

static int16_t blob_get_int16 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 161 of file blob.h.

{
        return blob_get_u16(attr);
}

Here is the call graph for this function:

blob_get_int32()

static int32_t blob_get_int32 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 167 of file blob.h.

{
        return blob_get_u32(attr);
}

Here is the call graph for this function:

blob_get_int64()

static int64_t blob_get_int64 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 173 of file blob.h.

{
        return blob_get_u64(attr);
}

Here is the call graph for this function:

blob_get_int8()

static int8_t blob_get_int8 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 155 of file blob.h.

{
        return blob_get_u8(attr);
}

Here is the call graph for this function:

blob_get_string()

static const char* blob_get_string ( const struct blob_attr *  attr )

inlinestatic

Definition at line 179 of file blob.h.

{
        return attr->data;
}

blob_get_u16()

static uint16_t blob_get_u16 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 132 of file blob.h.

{
        uint16_t *tmp = (uint16_t*)attr->data;
        return be16_to_cpu(*tmp);
}

Here is the caller graph for this function:

blob_get_u32()

static uint32_t blob_get_u32 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 139 of file blob.h.

{
        uint32_t *tmp = (uint32_t*)attr->data;
        return be32_to_cpu(*tmp);
}

Here is the caller graph for this function:

blob_get_u64()

static uint64_t blob_get_u64 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 146 of file blob.h.

{
        uint32_t *ptr = (uint32_t *) blob_data(attr);
        uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
        tmp |= be32_to_cpu(ptr[1]);
        return tmp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_get_u8()

static uint8_t blob_get_u8 ( const struct blob_attr *  attr )

inlinestatic

Definition at line 126 of file blob.h.

{
        return *((uint8_t *) attr->data);
}

Here is the caller graph for this function:

blob_id()

static unsigned int blob_id ( const struct blob_attr *  attr )

inlinestatic

Definition at line 84 of file blob.h.

{
        int id = (be32_to_cpu(attr->id_len) & BLOB_ATTR_ID_MASK) >> BLOB_ATTR_ID_SHIFT;
        return id;
}

Here is the caller graph for this function:

blob_is_extended()

static bool blob_is_extended ( const struct blob_attr *  attr )

inlinestatic

Definition at line 91 of file blob.h.

{
        return !!(attr->id_len & cpu_to_be32(BLOB_ATTR_EXTENDED));
}

Here is the caller graph for this function:

blob_len()

static size_t blob_len ( const struct blob_attr *  attr )

inlinestatic

Definition at line 100 of file blob.h.

{
        return (be32_to_cpu(attr->id_len) & BLOB_ATTR_LEN_MASK) - sizeof(struct blob_attr);
}

Here is the caller graph for this function:

blob_memdup()

struct blob_attr* blob_memdup

(

struct blob_attr *

attr

)

Definition at line 326 of file blob.c.

{
        struct blob_attr *ret;
        int size = blob_pad_len(attr);
 
        ret = malloc(size);
        if (!ret)
                return NULL;
 
        memcpy(ret, attr, size);
        return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_nest_end()

void blob_nest_end	(	struct blob_buf *	buf,
		void *	cookie
	)

Definition at line 185 of file blob.c.

{
        struct blob_attr *attr = offset_to_attr(buf, (unsigned long) cookie);
        blob_set_raw_len(attr, blob_pad_len(attr) + blob_len(buf->head));
        buf->head = attr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_nest_start()

void* blob_nest_start	(	struct blob_buf *	buf,
		int	id
	)

Definition at line 175 of file blob.c.

{
        unsigned long offset = attr_to_offset(buf, buf->head);
        buf->head = blob_new(buf, id, 0);
        if (!buf->head)
                return NULL;
        return (void *) offset;
}

Here is the call graph for this function:

blob_new()

struct blob_attr* blob_new	(	struct blob_buf *	buf,
		int	id,
		int	payload
	)

Definition at line 132 of file blob.c.

{
        struct blob_attr *attr;
 
        attr = blob_add(buf, blob_next(buf->head), id, payload);
        if (!attr)
                return NULL;
 
        blob_set_raw_len(buf->head, blob_pad_len(buf->head) + blob_pad_len(attr));
        return attr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_next()

static struct blob_attr* blob_next ( const struct blob_attr *  attr )

inlinestatic

Definition at line 185 of file blob.h.

{
        return (struct blob_attr *) ((char *) attr + blob_pad_len(attr));
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_pad_len()

static size_t blob_pad_len ( const struct blob_attr *  attr )

inlinestatic

Definition at line 118 of file blob.h.

{
        unsigned int len = blob_raw_len(attr);
        len = (len + BLOB_ATTR_ALIGN - 1) & ~(BLOB_ATTR_ALIGN - 1);
        return len;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_parse()

int blob_parse	(	struct blob_attr *	attr,
		struct blob_attr **	data,
		const struct blob_attr_info *	info,
		int	max
	)

Definition at line 296 of file blob.c.

{
        struct blob_attr *pos;
        int found = 0;
        size_t rem;
 
        memset(data, 0, sizeof(struct blob_attr *) * max);
        blob_for_each_attr(pos, attr, rem) {
                found += blob_parse_attr(pos, rem, data, info, max);
        }
 
        return found;
}

Here is the call graph for this function:

blob_parse_untrusted()

int blob_parse_untrusted	(	struct blob_attr *	attr,
		size_t	attr_len,
		struct blob_attr **	data,
		const struct blob_attr_info *	info,
		int	max
	)

Definition at line 272 of file blob.c.

{
        struct blob_attr *pos;
        size_t len = 0;
        int found = 0;
        size_t rem;
 
        if (!attr || attr_len < sizeof(struct blob_attr))
                return 0;
 
        len = blob_raw_len(attr);
        if (attr_len < len)
                return 0;
 
        memset(data, 0, sizeof(struct blob_attr *) * max);
        blob_for_each_attr_len(pos, attr, len, rem) {
                found += blob_parse_attr(pos, rem, data, info, max);
        }
 
        return found;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_put()

struct blob_attr* blob_put	(	struct blob_buf *	buf,
		int	id,
		const void *	ptr,
		unsigned int	len
	)

Definition at line 161 of file blob.c.

{
        struct blob_attr *attr;
 
        attr = blob_new(buf, id, len);
        if (!attr)
                return NULL;
 
        if (ptr)
                memcpy(blob_data(attr), ptr, len);
        return attr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_put_raw()

struct blob_attr* blob_put_raw	(	struct blob_buf *	buf,
		const void *	ptr,
		unsigned int	len
	)

Definition at line 145 of file blob.c.

{
        struct blob_attr *attr;
 
        if (len < sizeof(struct blob_attr) || !ptr)
                return NULL;
 
        attr = blob_add(buf, blob_next(buf->head), 0, len - sizeof(struct blob_attr));
        if (!attr)
                return NULL;
        blob_set_raw_len(buf->head, blob_pad_len(buf->head) + len);
        memcpy(attr, ptr, len);
        return attr;
}

Here is the call graph for this function:

blob_put_string()

static struct blob_attr* blob_put_string ( struct blob_buf *  buf, int  id, const char *  str  )

inlinestatic

Definition at line 207 of file blob.h.

{
        return blob_put(buf, id, str, strlen(str) + 1);
}

Here is the call graph for this function:

blob_put_u16()

static struct blob_attr* blob_put_u16 ( struct blob_buf *  buf, int  id, uint16_t  val  )

inlinestatic

Definition at line 219 of file blob.h.

{
        val = cpu_to_be16(val);
        return blob_put(buf, id, &val, sizeof(val));
}

Here is the call graph for this function:

blob_put_u32()

static struct blob_attr* blob_put_u32 ( struct blob_buf *  buf, int  id, uint32_t  val  )

inlinestatic

Definition at line 226 of file blob.h.

{
        val = cpu_to_be32(val);
        return blob_put(buf, id, &val, sizeof(val));
}

Here is the call graph for this function:

blob_put_u64()

static struct blob_attr* blob_put_u64 ( struct blob_buf *  buf, int  id, uint64_t  val  )

inlinestatic

Definition at line 233 of file blob.h.

{
        val = cpu_to_be64(val);
        return blob_put(buf, id, &val, sizeof(val));
}

Here is the call graph for this function:

blob_put_u8()

static struct blob_attr* blob_put_u8 ( struct blob_buf *  buf, int  id, uint8_t  val  )

inlinestatic

Definition at line 213 of file blob.h.

{
        return blob_put(buf, id, &val, sizeof(val));
}

Here is the call graph for this function:

blob_raw_len()

static size_t blob_raw_len ( const struct blob_attr *  attr )

inlinestatic

Definition at line 109 of file blob.h.

{
        return blob_len(attr) + sizeof(struct blob_attr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

blob_set_raw_len()

void blob_set_raw_len	(	struct blob_attr *	attr,
		unsigned int	len
	)

Definition at line 124 of file blob.c.

{
        len &= BLOB_ATTR_LEN_MASK;
        attr->id_len &= ~cpu_to_be32(BLOB_ATTR_LEN_MASK);
        attr->id_len |= cpu_to_be32(len);
}

Here is the caller graph for this function:

Variable Documentation

__attribute__

__attribute__

Definition at line 107 of file ulog.c.

{
        FILE *out = stderr;
 
        if (_ulog_ident)
                fprintf(out, "%s: ", _ulog_ident);
 
        vfprintf(out, fmt, ap);
}

data

char data[]

Definition at line 1 of file blob.h.

id_len

uint32_t id_len

Definition at line 0 of file blob.h.