/* This file is part of libcapwap. libcapwap is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. libcapwap 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. You should have received a copy of the GNU General Public License along with Foobar. If not, see . */ #ifndef __MBAG_H #define __MBAG_H /** * @defgroup MBAG MBAG * @{ */ #include #include "mavl.h" #include "bstr.h" #include "sock.h" /* Forward declaration */ struct mbag_item; /** * The MBAG Type * * It's simply an #mavl AVL Tree. */ typedef mavl_t mbag_t; /** * Definition for MABG data types */ struct mbag_typedef{ /** A human readable name for this type */ const char *name; /** A pointer to a function to delete elements of this type */ void (*del)(void*); /** A pointer to a function to convert elements of this type to a string. This function is mainly used to store elements to an SQL database or to json strings */ int (*to_str)(void*,char *dst); /** Cereate an item of this type from a string, which was previously created by the #del function. */ struct mbag_item * (*from_str)(const char *src); struct mbag_item * (*get)(const uint8_t*src, int len); /** A method to put this object to a buffer */ int (*put)(struct mbag_item *i,uint8_t*dst); int (*def)(void *, void *); }; /** The type for an mbag typedef */ typedef const struct mbag_typedef * mbagtype_t; /** * The MBAG item */ struct mbag_item{ union { uint32_t iid; /** * Key of this item * * This could be either a string (default) or an integer uint32_t value. * If you whant to use with uint32_t keys, use the mbag_i_* functions, to * create mbags. */ const char *id; }; /** * Indicates if the key is dynamic oder static. * If dynamic, the id will be freed using free, * if mbag_item is deleted */ uint8_t dynid; /** Type of this item */ const struct mbag_typedef * type; union { /** Value of this item */ void *data; uint8_t byte; uint16_t word; uint32_t dword; }; }; typedef struct mbag_item mbag_item_t; extern const struct mbag_typedef mbag_type_byte; extern const struct mbag_typedef mbag_type_word; extern const struct mbag_typedef mtype_dword; extern const struct mbag_typedef mbag_type_mbag; extern const struct mbag_typedef mbag_type_bstr; extern const struct mbag_typedef mbag_type_bstr16; extern const struct mbag_typedef mbag_type_bstrv; extern const struct mbag_typedef mbag_type_str; extern const struct mbag_typedef mbag_type_ptr; extern const struct mbag_typedef mbag_type_avltree; extern const struct mbag_typedef mbag_type_const_data; extern const struct mbag_typedef mbag_type_mbag_dyn; extern const struct mbag_typedef mbag_type_sockaddr; extern const struct mbag_typedef mbag_type_data; /** *@defgroup MBAG_TYPES MBAG Types *@{ */ /** MBAG_BYTE stores one byte */ #define MBAG_BYTE (&mbag_type_byte) /** MBAG_WORD stores one word */ #define MBAG_WORD (&mbag_type_word) /** MTYPE_DWORD stores one dword */ #define MTYPE_DWORD (&mtype_dword) /** MBAG_MBAG stores an MBAG */ #define MBAG_MBAG (&mbag_type_mbag) #define MBAG_MBAG_DYN (&mbag_type_mbag_dyn) /** * MBAG_BSTR stores a #bstr_t value * The to_str converts it either to a readable string * if it detects utf8 or to an hex string otherwise */ #define MBAG_BSTR (&mbag_type_bstr) /** * MBAG_BSTR16 holds an #bstr16_t value. * @see MBAG_BSTR */ #define MBAG_BSTR16 (&mbag_type_bstr16) #define MBAG_DATA (&mbag_type_data) #define MBAG_BIN MBAG_DATA /** MBAG_BSTRV holds a #bstr_t value */ #define MBAG_VENDORSTR (&mbag_type_bstrv) /** MBAG_STR holds a zero terminated string */ #define MBAG_STR (&mbag_type_str) /** * MBAG_PTR holds a pointer to some data. * The data will be free'd when the object is destroyed. * There is no to_str or from_str method defined. */ #define MBAG_PTR (&mbag_type_ptr) #define MBAG_AVLTREE (&mbag_type_avltree) #define MBAG_FUN MBAG_STR #define MBAG_CONST_DATA (&mbag_type_const_data) /** MBAG_SOCK_ADDR holds a sockkaddr structure */ #define MBAG_SOCKADDR (&mbag_type_sockaddr) /**@}*/ extern mbag_t mbag_create(); extern mbag_t mbag_i_create(); struct mbag_item *mbag_item_create(mbag_t s, const char *id); struct mbag_item *mbag_i_item_create(mbag_t s, uint32_t id); bstrv_t mbag_set_bstrv(mbag_t s, const char *id, uint32_t vendor_id, uint8_t * version, int len); int mbag_set_data(mbag_t s, const char *id, const struct mbag_typedef *type, void *data); int mbag_set_mbag(mbag_t s, const char *id, mbag_t mbag); int mbag_i_set_mbag(mbag_t s, uint32_t id, mbag_t mbag); struct mbag_item * mbag_set_dword(mbag_t s, const char *id, uint32_t dword); struct mbag_item * mbag_set_word(mbag_t s, const char *id, uint16_t word); int mbag_set_byte(mbag_t s, const char *id, uint8_t byte); int mbag_set(mbag_t t,mbag_item_t *is); mbag_item_t *mbag_item_new(mbagtype_t type); #define mbag_set_bstr(m,i,d) mbag_set_data(m,i,MBAG_BSTR,d) #define mbag_set_bstr16(m,i,d) mbag_set_data(m,i,MBAG_BSTR16,d) void * mbag_get_data(mbag_t s, const char *id, const struct mbag_typedef * type, void * def); void mbag_del(mbag_t s,const char *id); mbag_item_t *mbag_i_get(mbag_t s, uint32_t id); mbag_item_t *mbag_get(mbag_t s, const char *id); #define mbag_get_bstr(m,i,d) mbag_get_data(m,i,MBAG_BSTR,d) #define mbag_get_bstr16(m,i,d) mbag_get_data(m,i,MBAG_BSTR16,d) static inline void * mbag_get_raw(mbag_t s, const char *id, void * def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; return i->data; } static inline uint8_t mbag_get_byte(mbag_t s, const char *id, uint8_t def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; if (i->type != MBAG_BYTE) return def; return i->byte; } static inline uint16_t mbag_get_word(mbag_t s, const char *id, uint16_t def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; if (i->type != MBAG_WORD) return def; return i->word; } static inline uint32_t mbag_get_dword(mbag_t s, const char *id, uint32_t def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; if (i->type != MTYPE_DWORD) return def; return i->dword; } static inline mbag_t mbag_i_get_mbag(mbag_t s, uint32_t id, mbag_t def) { struct mbag_item *i = mbag_i_get(s, id); if (!i) return def; if (i->type != MBAG_MBAG) return def; return i->data; } static inline mbag_t mbag_get_mbag(mbag_t s, const char *id, mbag_t def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; if (i->type != MBAG_MBAG) return def; return i->data; } static inline mbag_item_t * mbag_set_bstrn(mbag_t s, const char *id, uint8_t * data, int len) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return NULL; i->type = MBAG_BSTR; i->data = bstr_create(data, len); return i; } static inline struct mavl *mbag_get_mavl(mbag_t s, const char *id) { struct mbag_item *i = mbag_get(s, id); if (!i) return NULL; if (i->type != MBAG_AVLTREE) return NULL; return i->data; } static inline int mbag_i_set_mavl(mbag_t s, uint32_t id, mavl_t t) { struct mbag_item *i = mbag_i_item_create(s, id); if (!i) return 0; i->type = MBAG_AVLTREE; i->data = t; return 1; } static inline int mbag_set_mavl(mbag_t s, const char *id, mavl_t t) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_AVLTREE; i->data = t; return 1; } /* static inline struct mavl *mbag_get_avltree_c(mbag_t s, const char *id, struct mavl *(creator) ()) { struct mavl * avltree = mbag_get_mavl(s, id); if (avltree){ return avltree; } avltree = creator(); if (!avltree) return NULL; mbag_set_mavl(s, id, avltree); return avltree; } */ static inline mavl_t mbag_get_mavl_c(mbag_t s, const char *id, mavl_t (creator) ()) { struct mbag_item *i = mbag_get(s, id); if (i) return i->data; if (!creator) return NULL; mavl_t avltree = creator(); if (!avltree) return NULL; mbag_set_mavl(s, id, avltree); return avltree; } static inline mavl_t mbag_get_mbag_c(mbag_t s, const char *id, mavl_t (creator) ()) { struct mbag_item *i = mbag_get(s, id); if (i) return i->data; if (!creator) return NULL; mavl_t avltree = creator(); if (!avltree) return NULL; mbag_set_mbag(s, id, avltree); return avltree; } static inline int mbag_inc_word(mbag_t s, const char * id,int n) { uint16_t w = mbag_get_word(s,id,0); mbag_set_word(s,id,w+n); return 1; } static inline mavl_t mbag_i_get_mbag_c(mbag_t s, uint32_t iid, mavl_t (creator) ()) { struct mbag_item *i = mbag_i_get(s, iid); if (i) return i->data; if (!creator) return NULL; mavl_t avltree = creator(); if (!avltree) return NULL; mbag_i_set_mbag(s, iid, avltree); return avltree; } static inline mavl_t mbag_i_get_mavl(mbag_t s, uint32_t id, mavl_t (creator) ()) { struct mbag_item *i = mbag_i_get(s, id); if (i) return i->data; if (!creator) return NULL; mavl_t avltree = creator(); if (!avltree) return NULL; mbag_i_set_mavl(s, id, avltree); return avltree; } /** @} */ static inline char *mbag_get_str(mbag_t s, const char *id, char *def) { struct mbag_item *i = mbag_get(s, id); if (!i) return def; return i->data; }; static inline int mbag_set_str(mbag_t s, const char *id, const char *str) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_STR; i->data = strdup(str); return 1; } static inline int mbag_set_sockaddr(mbag_t s, const char *id, const struct sockaddr * sa) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; struct sockaddr_storage * sad = malloc(sizeof(struct sockaddr_storage)); if (!sad){ free(i); return 0; } sock_copyaddr(sad,sa); i->type = MBAG_SOCKADDR; i->data = sad; return 1; } struct mbag_item_fundef { void *(*get) (void *arg); void (*free) (void *arg, void *data); void *arg; }; static inline void *mbag_item_get_data_ptr(struct mbag_item *item) { if (item->type == MBAG_FUN ) { struct mbag_item_fundef *fundef = (struct mbag_item_fundef *) item->data; if (!fundef) return NULL; return fundef->get(fundef->arg); } return item->data; } static inline void mbag_item_release_data_ptr(struct mbag_item *item, void *data) { if (item->type == MBAG_FUN) { struct mbag_item_fundef *fundef = (struct mbag_item_fundef *) item->data; if (!fundef) return; if (!fundef->free) return; return fundef->free(fundef->arg, data); } } static inline int mbag_set_strn(mbag_t s, const char *id, const char *str, int n) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_STR; i->data = strndup(str, n); return 1; } static inline int mbag_set_bstr16n(mbag_t s, const char *id, uint8_t * data, int len) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_BSTR16; i->data = bstr16_create(data, len); return 1; } static inline mbag_item_t * mbag_set_const_ptr(mbag_t s, const char *id, void *ptr) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_CONST_DATA; i->data = ptr; return i; } static inline int mbag_set_ptr(mbag_t s, const char *id, void *ptr) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; i->type = MBAG_PTR; i->data = ptr; return 1; } static inline int mbag_set_fun(mbag_t s, const char *id, void *(*funget) (void *arg), void (*funfree) (void *arg, void *data), void *arg) { struct mbag_item *i = mbag_item_create(s, id); if (!i) return 0; struct mbag_item_fundef *fundef = malloc(sizeof(struct mbag_item_fundef)); i->data = fundef; if (!fundef) return 0; fundef->get = funget; fundef->free = funfree; fundef->arg = arg; i->type=MBAG_FUN; return 1; } int mbag_set_from_buf(mbag_t dst, mbagtype_t type, const char *item_id, uint8_t *data, int len); /** * Delete all objects in ab mbag. * * @see #mavl_del_all */ #define mbag_del_all mavl_del_all #endif