icmap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2017 Red Hat, Inc.
 *
 * Author: Jan Friesse (jfriesse@redhat.com)
 *
 * All rights reserved.
 *
 * This software licensed under BSD license, the text of which follows:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of the Red Hat, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ICMAP_H_DEFINED
#define ICMAP_H_DEFINED
 
#include <stdlib.h>
#include <corosync/corotypes.h>
#include <qb/qbmap.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ICMAP_KEYNAME_MAXLEN            255
 
#define ICMAP_KEYNAME_MINLEN            3
 
typedef enum {
    ICMAP_VALUETYPE_INT8        =  1,
    ICMAP_VALUETYPE_UINT8       =  2,
    ICMAP_VALUETYPE_INT16       =  3,
    ICMAP_VALUETYPE_UINT16      =  4,
    ICMAP_VALUETYPE_INT32       =  5,
    ICMAP_VALUETYPE_UINT32      =  6,
    ICMAP_VALUETYPE_INT64       =  7,
    ICMAP_VALUETYPE_UINT64      =  8,
    ICMAP_VALUETYPE_FLOAT       =  9,
    ICMAP_VALUETYPE_DOUBLE      = 10,
    ICMAP_VALUETYPE_STRING      = 11,
    ICMAP_VALUETYPE_BINARY      = 12,
} icmap_value_types_t;
 
/*
 * Tracking values.
 */
#define ICMAP_TRACK_ADD         4
#define ICMAP_TRACK_DELETE      1
#define ICMAP_TRACK_MODIFY      2
 
#define ICMAP_TRACK_PREFIX      8
 
struct icmap_notify_value {
        icmap_value_types_t type;
        size_t len;
        const void *data;
};
 
typedef void (*icmap_notify_fn_t) (
        int32_t event,
        const char *key_name,
        struct icmap_notify_value new_value,
        struct icmap_notify_value old_value,
        void *user_data);
 
typedef struct icmap_map *icmap_map_t;
 
typedef qb_map_iter_t *icmap_iter_t;
 
typedef struct icmap_track *icmap_track_t;
 
extern cs_error_t icmap_init(void);
 
extern cs_error_t icmap_init_r(icmap_map_t *result);
 
extern void icmap_fini(void);
 
extern void icmap_fini_r(const icmap_map_t map);
 
extern icmap_map_t icmap_get_global_map(void);
 
extern int icmap_key_value_eq(
        const icmap_map_t map1,
        const char *key_name1,
        const icmap_map_t map2,
        const char *key_name2);
 
extern cs_error_t icmap_set(
        const char *key_name,
        const void *value,
        size_t value_len,
        icmap_value_types_t type);
 
extern cs_error_t icmap_set_r(
        const icmap_map_t map,
        const char *key_name,
        const void *value,
        size_t value_len,
        icmap_value_types_t type);
 
/*
 * Shortcuts for setting values
 */
extern cs_error_t icmap_set_int8(const char *key_name, int8_t value);
extern cs_error_t icmap_set_uint8(const char *key_name, uint8_t value);
extern cs_error_t icmap_set_int16(const char *key_name, int16_t value);
extern cs_error_t icmap_set_uint16(const char *key_name, uint16_t value);
extern cs_error_t icmap_set_int32(const char *key_name, int32_t value);
extern cs_error_t icmap_set_uint32(const char *key_name, uint32_t value);
extern cs_error_t icmap_set_int64(const char *key_name, int64_t value);
extern cs_error_t icmap_set_uint64(const char *key_name, uint64_t value);
extern cs_error_t icmap_set_float(const char *key_name, float value);
extern cs_error_t icmap_set_double(const char *key_name, double value);
extern cs_error_t icmap_set_string(const char *key_name, const char *value);
 
extern cs_error_t icmap_set_int8_r(const icmap_map_t map, const char *key_name, int8_t value);
extern cs_error_t icmap_set_uint8_r(const icmap_map_t map, const char *key_name, uint8_t value);
extern cs_error_t icmap_set_int16_r(const icmap_map_t map, const char *key_name, int16_t value);
extern cs_error_t icmap_set_uint16_r(const icmap_map_t map, const char *key_name, uint16_t value);
extern cs_error_t icmap_set_int32_r(const icmap_map_t map, const char *key_name, int32_t value);
extern cs_error_t icmap_set_uint32_r(const icmap_map_t map, const char *key_name, uint32_t value);
extern cs_error_t icmap_set_int64_r(const icmap_map_t map, const char *key_name, int64_t value);
extern cs_error_t icmap_set_uint64_r(const icmap_map_t map, const char *key_name, uint64_t value);
extern cs_error_t icmap_set_float_r(const icmap_map_t map, const char *key_name, float value);
extern cs_error_t icmap_set_double_r(const icmap_map_t map, const char *key_name, double value);
extern cs_error_t icmap_set_string_r(const icmap_map_t map, const char *key_name, const char *value);
 
extern cs_error_t icmap_delete(const char *key_name);
 
extern cs_error_t icmap_delete_r(const icmap_map_t map, const char *key_name);
 
extern cs_error_t icmap_get(
        const char *key_name,
        void *value,
        size_t *value_len,
        icmap_value_types_t *type);
 
extern cs_error_t icmap_get_r(
        const icmap_map_t map,
        const char *key_name,
        void *value,
        size_t *value_len,
        icmap_value_types_t *type);
 
/*
 * Shortcuts for icmap_get
 */
extern cs_error_t icmap_get_int8(const char *key_name, int8_t *i8);
extern cs_error_t icmap_get_uint8(const char *key_name, uint8_t *u8);
extern cs_error_t icmap_get_int16(const char *key_name, int16_t *i16);
extern cs_error_t icmap_get_uint16(const char *key_name, uint16_t *u16);
extern cs_error_t icmap_get_int32(const char *key_name, int32_t *i32);
extern cs_error_t icmap_get_uint32(const char *key_name, uint32_t *u32);
extern cs_error_t icmap_get_int64(const char *key_name, int64_t *i64);
extern cs_error_t icmap_get_uint64(const char *key_name, uint64_t *u64);
extern cs_error_t icmap_get_float(const char *key_name, float *flt);
extern cs_error_t icmap_get_double(const char *key_name, double *dbl);
 
/*
 * Shortcuts for icmap_get_r
 */
extern cs_error_t icmap_get_int8_r(const icmap_map_t map, const char *key_name, int8_t *i8);
extern cs_error_t icmap_get_uint8_r(const icmap_map_t map, const char *key_name, uint8_t *u8);
extern cs_error_t icmap_get_int16_r(const icmap_map_t map, const char *key_name, int16_t *i16);
extern cs_error_t icmap_get_uint16_r(const icmap_map_t map, const char *key_name, uint16_t *u16);
extern cs_error_t icmap_get_int32_r(const icmap_map_t map, const char *key_name, int32_t *i32);
extern cs_error_t icmap_get_uint32_r(const icmap_map_t map, const char *key_name, uint32_t *u32);
extern cs_error_t icmap_get_int64_r(const icmap_map_t map, const char *key_name, int64_t *i64);
extern cs_error_t icmap_get_uint64_r(const icmap_map_t map, const char *key_name, uint64_t *u64);
extern cs_error_t icmap_get_float_r(const icmap_map_t map, const char *key_name, float *flt);
extern cs_error_t icmap_get_double_r(const icmap_map_t map, const char *key_name, double *dbl);
extern cs_error_t icmap_get_string_r(const icmap_map_t map, const char *key_name, char **str);
 
extern cs_error_t icmap_get_string(const char *key_name, char **str);
 
extern cs_error_t icmap_adjust_int(const char *key_name, int32_t step);
 
extern cs_error_t icmap_adjust_int_r(const icmap_map_t map, const char *key_name, int32_t step);
 
extern cs_error_t icmap_fast_adjust_int(const char *key_name, int32_t step);
 
extern cs_error_t icmap_fast_adjust_int_r(const icmap_map_t map, const char *key_name, int32_t step);
 
extern cs_error_t icmap_inc(const char *key_name);
 
extern cs_error_t icmap_inc_r(const icmap_map_t map, const char *key_name);
 
extern cs_error_t icmap_dec(const char *key_name);
 
extern cs_error_t icmap_dec_r(const icmap_map_t map, const char *key_name);
 
extern cs_error_t icmap_fast_inc(const char *key_name);
 
extern cs_error_t icmap_fast_inc_r(const icmap_map_t map, const char *key_name);
 
extern cs_error_t icmap_fast_dec(const char *key_name);
 
extern cs_error_t icmap_fast_dec_r(const icmap_map_t map, const char *key_name);
 
extern icmap_iter_t icmap_iter_init(const char *prefix);
 
extern icmap_iter_t icmap_iter_init_r(const icmap_map_t map, const char *prefix);
 
extern const char *icmap_iter_next(icmap_iter_t iter, size_t *value_len, icmap_value_types_t *type);
 
extern void icmap_iter_finalize(icmap_iter_t iter);
 
extern cs_error_t icmap_track_add(
        const char *key_name,
        int32_t track_type,
        icmap_notify_fn_t notify_fn,
        void *user_data,
        icmap_track_t *icmap_track);
 
extern void *icmap_track_get_user_data(icmap_track_t icmap_track);
 
extern cs_error_t icmap_track_delete(icmap_track_t icmap_track);
 
extern cs_error_t icmap_set_ro_access(const char *key_name, int prefix, int ro_access);
 
extern int icmap_is_key_ro(const char *key_name);
 
extern void icmap_convert_name_to_valid_name(char *key_name);
 
extern cs_error_t icmap_copy_map(icmap_map_t dst_map, const icmap_map_t src_map);
 
/*
 * Returns length of value of given type, or 0 for string and binary data type
 */
size_t icmap_get_valuetype_len(icmap_value_types_t type);
 
/*
 * Converts track type of icmap to qb
 */
int32_t icmap_tt_to_qbtt(int32_t track_type);
 
/*
 * Convert track type of qb to icmap
 */
int32_t icmap_qbtt_to_tt(int32_t track_type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICMAP_H_DEFINED */