[thirdparty/openssl.git] / include / openssl / lhash.h

/*
 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the OpenSSL license (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/*
 * Header for dynamic hash table routines Author - Eric Young
 */

#ifndef HEADER_LHASH_H
# define HEADER_LHASH_H

# include <openssl/e_os2.h>
# include <openssl/bio.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct lhash_node_st OPENSSL_LH_NODE;
typedef int (*OPENSSL_LH_COMPFUNC) (const void *, const void *);
typedef unsigned long (*OPENSSL_LH_HASHFUNC) (const void *);
typedef void (*OPENSSL_LH_DOALL_FUNC) (void *);
typedef void (*OPENSSL_LH_DOALL_FUNCARG) (void *, void *);
typedef struct lhash_st OPENSSL_LHASH;

/*
 * Macros for declaring and implementing type-safe wrappers for LHASH
 * callbacks. This way, callbacks can be provided to LHASH structures without
 * function pointer casting and the macro-defined callbacks provide
 * per-variable casting before deferring to the underlying type-specific
 * callbacks. NB: It is possible to place a "static" in front of both the
 * DECLARE and IMPLEMENT macros if the functions are strictly internal.
 */

/* First: "hash" functions */
# define DECLARE_LHASH_HASH_FN(name, o_type) \
        unsigned long name##_LHASH_HASH(const void *);
# define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
        unsigned long name##_LHASH_HASH(const void *arg) { \
                const o_type *a = arg; \
                return name##_hash(a); }
# define LHASH_HASH_FN(name) name##_LHASH_HASH

/* Second: "compare" functions */
# define DECLARE_LHASH_COMP_FN(name, o_type) \
        int name##_LHASH_COMP(const void *, const void *);
# define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
        int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
                const o_type *a = arg1;             \
                const o_type *b = arg2; \
                return name##_cmp(a,b); }
# define LHASH_COMP_FN(name) name##_LHASH_COMP

/* Fourth: "doall_arg" functions */
# define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
        void name##_LHASH_DOALL_ARG(void *, void *);
# define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
        void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
                o_type *a = arg1; \
                a_type *b = arg2; \
                name##_doall_arg(a, b); }
# define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG


# define LH_LOAD_MULT    256

int OPENSSL_LH_error(OPENSSL_LHASH *lh);
OPENSSL_LHASH *OPENSSL_LH_new(OPENSSL_LH_HASHFUNC h, OPENSSL_LH_COMPFUNC c);
void OPENSSL_LH_free(OPENSSL_LHASH *lh);
void *OPENSSL_LH_insert(OPENSSL_LHASH *lh, void *data);
void *OPENSSL_LH_delete(OPENSSL_LHASH *lh, const void *data);
void *OPENSSL_LH_retrieve(OPENSSL_LHASH *lh, const void *data);
void OPENSSL_LH_doall(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNC func);
void OPENSSL_LH_doall_arg(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNCARG func, void *arg);
unsigned long OPENSSL_LH_strhash(const char *c);
unsigned long OPENSSL_LH_num_items(const OPENSSL_LHASH *lh);
unsigned long OPENSSL_LH_get_down_load(const OPENSSL_LHASH *lh);
void OPENSSL_LH_set_down_load(OPENSSL_LHASH *lh, unsigned long down_load);

# ifndef OPENSSL_NO_STDIO
void OPENSSL_LH_stats(const OPENSSL_LHASH *lh, FILE *fp);
void OPENSSL_LH_node_stats(const OPENSSL_LHASH *lh, FILE *fp);
void OPENSSL_LH_node_usage_stats(const OPENSSL_LHASH *lh, FILE *fp);
# endif
void OPENSSL_LH_stats_bio(const OPENSSL_LHASH *lh, BIO *out);
void OPENSSL_LH_node_stats_bio(const OPENSSL_LHASH *lh, BIO *out);
void OPENSSL_LH_node_usage_stats_bio(const OPENSSL_LHASH *lh, BIO *out);

# if !OPENSSL_API_1_1_0
#  define _LHASH OPENSSL_LHASH
#  define LHASH_NODE OPENSSL_LH_NODE
#  define lh_error OPENSSL_LH_error
#  define lh_new OPENSSL_LH_new
#  define lh_free OPENSSL_LH_free
#  define lh_insert OPENSSL_LH_insert
#  define lh_delete OPENSSL_LH_delete
#  define lh_retrieve OPENSSL_LH_retrieve
#  define lh_doall OPENSSL_LH_doall
#  define lh_doall_arg OPENSSL_LH_doall_arg
#  define lh_strhash OPENSSL_LH_strhash
#  define lh_num_items OPENSSL_LH_num_items
#  ifndef OPENSSL_NO_STDIO
#   define lh_stats OPENSSL_LH_stats
#   define lh_node_stats OPENSSL_LH_node_stats
#   define lh_node_usage_stats OPENSSL_LH_node_usage_stats
#  endif
#  define lh_stats_bio OPENSSL_LH_stats_bio
#  define lh_node_stats_bio OPENSSL_LH_node_stats_bio
#  define lh_node_usage_stats_bio OPENSSL_LH_node_usage_stats_bio
# endif

/* Type checking... */

# define LHASH_OF(type) struct lhash_st_##type

# define DEFINE_LHASH_OF(type) \
    LHASH_OF(type) { union lh_##type##_dummy { void* d1; unsigned long d2; int d3; } dummy; }; \
    static ossl_inline LHASH_OF(type) * \
        lh_##type##_new(unsigned long (*hfn)(const type *), \
                        int (*cfn)(const type *, const type *)) \
    { \
        return (LHASH_OF(type) *) \
            OPENSSL_LH_new((OPENSSL_LH_HASHFUNC)hfn, (OPENSSL_LH_COMPFUNC)cfn); \
    } \
    static ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \
    { \
        OPENSSL_LH_free((OPENSSL_LHASH *)lh); \
    } \
    static ossl_inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \
    { \
        return (type *)OPENSSL_LH_insert((OPENSSL_LHASH *)lh, d); \
    } \
    static ossl_inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \
    { \
        return (type *)OPENSSL_LH_delete((OPENSSL_LHASH *)lh, d); \
    } \
    static ossl_inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \
    { \
        return (type *)OPENSSL_LH_retrieve((OPENSSL_LHASH *)lh, d); \
    } \
    static ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \
    { \
        return OPENSSL_LH_error((OPENSSL_LHASH *)lh); \
    } \
    static ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
    { \
        return OPENSSL_LH_num_items((OPENSSL_LHASH *)lh); \
    } \
    static ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
    { \
        OPENSSL_LH_node_stats_bio((const OPENSSL_LHASH *)lh, out); \
    } \
    static ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
    { \
        OPENSSL_LH_node_usage_stats_bio((const OPENSSL_LHASH *)lh, out); \
    } \
    static ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
    { \
        OPENSSL_LH_stats_bio((const OPENSSL_LHASH *)lh, out); \
    } \
    static ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
    { \
        return OPENSSL_LH_get_down_load((OPENSSL_LHASH *)lh); \
    } \
    static ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
    { \
        OPENSSL_LH_set_down_load((OPENSSL_LHASH *)lh, dl); \
    } \
    static ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \
                                         void (*doall)(type *)) \
    { \
        OPENSSL_LH_doall((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNC)doall); \
    } \
    LHASH_OF(type)

#define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \
    int_implement_lhash_doall(type, argtype, const type)

#define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \
    int_implement_lhash_doall(type, argtype, type)

#define int_implement_lhash_doall(type, argtype, cbargtype) \
    static ossl_inline void \
        lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \
                                   void (*fn)(cbargtype *, argtype *), \
                                   argtype *arg) \
    { \
        OPENSSL_LH_doall_arg((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNCARG)fn, (void *)arg); \
    } \
    LHASH_OF(type)

DEFINE_LHASH_OF(OPENSSL_STRING);
# ifdef _MSC_VER
/*
 * push and pop this warning:
 *   warning C4090: 'function': different 'const' qualifiers
 */
#  pragma warning (push)
#  pragma warning (disable: 4090)
# endif

DEFINE_LHASH_OF(OPENSSL_CSTRING);

# ifdef _MSC_VER
#  pragma warning (pop)
# endif

#ifdef  __cplusplus
}
#endif

#endif
Commit	Line	Data
21dcbebc RS	1	/*
21dcbebc RS	2	* Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
0f113f3e	3	*
21dcbebc RS	4	* Licensed under the OpenSSL license (the "License"). You may not use
	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
d02b48c6 RE	8	*/
d02b48c6 RE	9
0f113f3e MC	10	/*
0f113f3e MC	11	* Header for dynamic hash table routines Author - Eric Young
d02b48c6 RE	12	*/
	13
	14	#ifndef HEADER_LHASH_H
0f113f3e	15	# define HEADER_LHASH_H
d02b48c6	16
0f113f3e	17	# include <openssl/e_os2.h>
a00ae6c4	18	# include <openssl/bio.h>
ef33b970	19
82271cee RL	20	#ifdef __cplusplus
	21	extern "C" {
	22	#endif
	23
739a1eb1 RS	24	typedef struct lhash_node_st OPENSSL_LH_NODE;
	25	typedef int (OPENSSL_LH_COMPFUNC) (const void , const void *);
	26	typedef unsigned long (OPENSSL_LH_HASHFUNC) (const void );
	27	typedef void (OPENSSL_LH_DOALL_FUNC) (void );
	28	typedef void (OPENSSL_LH_DOALL_FUNCARG) (void , void *);
	29	typedef struct lhash_st OPENSSL_LHASH;
0f113f3e MC	30
	31	/*
	32	* Macros for declaring and implementing type-safe wrappers for LHASH
	33	* callbacks. This way, callbacks can be provided to LHASH structures without
	34	* function pointer casting and the macro-defined callbacks provide
	35	* per-variable casting before deferring to the underlying type-specific
	36	* callbacks. NB: It is possible to place a "static" in front of both the
	37	* DECLARE and IMPLEMENT macros if the functions are strictly internal.
	38	*/
dfa46e50 GT	39
dfa46e50 GT	40	/* First: "hash" functions */
0f113f3e MC	41	# define DECLARE_LHASH_HASH_FN(name, o_type) \
	42	unsigned long name##_LHASH_HASH(const void *);
	43	# define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
	44	unsigned long name##_LHASH_HASH(const void *arg) { \
	45	const o_type *a = arg; \
	46	return name##_hash(a); }
	47	# define LHASH_HASH_FN(name) name##_LHASH_HASH
dfa46e50 GT	48
dfa46e50 GT	49	/* Second: "compare" functions */
0f113f3e MC	50	# define DECLARE_LHASH_COMP_FN(name, o_type) \
	51	int name##_LHASH_COMP(const void , const void );
	52	# define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
	53	int name##_LHASH_COMP(const void arg1, const void arg2) { \
	54	const o_type *a = arg1; \
	55	const o_type *b = arg2; \
	56	return name##_cmp(a,b); }
	57	# define LHASH_COMP_FN(name) name##_LHASH_COMP
dfa46e50	58
18602745	59	/* Fourth: "doall_arg" functions */
0f113f3e MC	60	# define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
	61	void name##_LHASH_DOALL_ARG(void , void );
	62	# define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
	63	void name##_LHASH_DOALL_ARG(void arg1, void arg2) { \
	64	o_type *a = arg1; \
	65	a_type *b = arg2; \
	66	name##_doall_arg(a, b); }
	67	# define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
	68
0f113f3e MC	69
	70	# define LH_LOAD_MULT 256
	71
739a1eb1 RS	72	int OPENSSL_LH_error(OPENSSL_LHASH *lh);
	73	OPENSSL_LHASH *OPENSSL_LH_new(OPENSSL_LH_HASHFUNC h, OPENSSL_LH_COMPFUNC c);
	74	void OPENSSL_LH_free(OPENSSL_LHASH *lh);
	75	void OPENSSL_LH_insert(OPENSSL_LHASH lh, void *data);
	76	void OPENSSL_LH_delete(OPENSSL_LHASH lh, const void *data);
	77	void OPENSSL_LH_retrieve(OPENSSL_LHASH lh, const void *data);
	78	void OPENSSL_LH_doall(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNC func);
	79	void OPENSSL_LH_doall_arg(OPENSSL_LHASH lh, OPENSSL_LH_DOALL_FUNCARG func, void arg);
	80	unsigned long OPENSSL_LH_strhash(const char *c);
	81	unsigned long OPENSSL_LH_num_items(const OPENSSL_LHASH *lh);
	82	unsigned long OPENSSL_LH_get_down_load(const OPENSSL_LHASH *lh);
	83	void OPENSSL_LH_set_down_load(OPENSSL_LHASH *lh, unsigned long down_load);
d02b48c6	84
474e469b	85	# ifndef OPENSSL_NO_STDIO
739a1eb1 RS	86	void OPENSSL_LH_stats(const OPENSSL_LHASH lh, FILE fp);
	87	void OPENSSL_LH_node_stats(const OPENSSL_LHASH lh, FILE fp);
	88	void OPENSSL_LH_node_usage_stats(const OPENSSL_LHASH lh, FILE fp);
	89	# endif
	90	void OPENSSL_LH_stats_bio(const OPENSSL_LHASH lh, BIO out);
	91	void OPENSSL_LH_node_stats_bio(const OPENSSL_LHASH lh, BIO out);
	92	void OPENSSL_LH_node_usage_stats_bio(const OPENSSL_LHASH lh, BIO out);
	93
fcd2d5a6	94	# if !OPENSSL_API_1_1_0
739a1eb1 RS	95	# define _LHASH OPENSSL_LHASH
	96	# define LHASH_NODE OPENSSL_LH_NODE
	97	# define lh_error OPENSSL_LH_error
b3c42fc2	98	# define lh_new OPENSSL_LH_new
739a1eb1 RS	99	# define lh_free OPENSSL_LH_free
	100	# define lh_insert OPENSSL_LH_insert
	101	# define lh_delete OPENSSL_LH_delete
	102	# define lh_retrieve OPENSSL_LH_retrieve
	103	# define lh_doall OPENSSL_LH_doall
	104	# define lh_doall_arg OPENSSL_LH_doall_arg
	105	# define lh_strhash OPENSSL_LH_strhash
	106	# define lh_num_items OPENSSL_LH_num_items
	107	# ifndef OPENSSL_NO_STDIO
	108	# define lh_stats OPENSSL_LH_stats
	109	# define lh_node_stats OPENSSL_LH_node_stats
	110	# define lh_node_usage_stats OPENSSL_LH_node_usage_stats
	111	# endif
	112	# define lh_stats_bio OPENSSL_LH_stats_bio
	113	# define lh_node_stats_bio OPENSSL_LH_node_stats_bio
	114	# define lh_node_usage_stats_bio OPENSSL_LH_node_usage_stats_bio
474e469b	115	# endif
3c1d6bbc	116
220903f9	117	/* Type checking... */
3c1d6bbc	118
0f113f3e	119	# define LHASH_OF(type) struct lhash_st_##type
3c1d6bbc	120
89d6aa10	121	# define DEFINE_LHASH_OF(type) \
703f44e7	122	LHASH_OF(type) { union lh_##type##_dummy { void* d1; unsigned long d2; int d3; } dummy; }; \
89d6aa10	123	static ossl_inline LHASH_OF(type) * \
62d0577e DSH	124	lh_##type##_new(unsigned long (hfn)(const type ), \
	125	int (cfn)(const type , const type *)) \
	126	{ \
	127	return (LHASH_OF(type) *) \
739a1eb1	128	OPENSSL_LH_new((OPENSSL_LH_HASHFUNC)hfn, (OPENSSL_LH_COMPFUNC)cfn); \
62d0577e	129	} \
89d6aa10	130	static ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \
e6b5c341	131	{ \
739a1eb1	132	OPENSSL_LH_free((OPENSSL_LHASH *)lh); \
e6b5c341	133	} \
89d6aa10	134	static ossl_inline type lh_##type##_insert(LHASH_OF(type) lh, type *d) \
e6b5c341	135	{ \
739a1eb1	136	return (type )OPENSSL_LH_insert((OPENSSL_LHASH )lh, d); \
e6b5c341	137	} \
89d6aa10	138	static ossl_inline type lh_##type##_delete(LHASH_OF(type) lh, const type *d) \
e6b5c341	139	{ \
739a1eb1	140	return (type )OPENSSL_LH_delete((OPENSSL_LHASH )lh, d); \
e6b5c341	141	} \
89d6aa10	142	static ossl_inline type lh_##type##_retrieve(LHASH_OF(type) lh, const type *d) \
e6b5c341	143	{ \
739a1eb1	144	return (type )OPENSSL_LH_retrieve((OPENSSL_LHASH )lh, d); \
e6b5c341	145	} \
89d6aa10	146	static ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \
e6b5c341	147	{ \
739a1eb1	148	return OPENSSL_LH_error((OPENSSL_LHASH *)lh); \
e6b5c341	149	} \
89d6aa10	150	static ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
e6b5c341	151	{ \
739a1eb1	152	return OPENSSL_LH_num_items((OPENSSL_LHASH *)lh); \
e6b5c341	153	} \
89d6aa10	154	static ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) lh, BIO out) \
e6b5c341	155	{ \
4591e5fb	156	OPENSSL_LH_node_stats_bio((const OPENSSL_LHASH *)lh, out); \
e6b5c341	157	} \
89d6aa10	158	static ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) lh, BIO out) \
e6b5c341	159	{ \
4591e5fb	160	OPENSSL_LH_node_usage_stats_bio((const OPENSSL_LHASH *)lh, out); \
e6b5c341	161	} \
89d6aa10	162	static ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) lh, BIO out) \
e6b5c341	163	{ \
4591e5fb	164	OPENSSL_LH_stats_bio((const OPENSSL_LHASH *)lh, out); \
e6b5c341	165	} \
89d6aa10	166	static ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
e6b5c341	167	{ \
739a1eb1	168	return OPENSSL_LH_get_down_load((OPENSSL_LHASH *)lh); \
e6b5c341	169	} \
89d6aa10	170	static ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
e6b5c341	171	{ \
739a1eb1	172	OPENSSL_LH_set_down_load((OPENSSL_LHASH *)lh, dl); \
e6b5c341	173	} \
89d6aa10	174	static ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \
63c75cd6 DSH	175	void (doall)(type )) \
63c75cd6 DSH	176	{ \
739a1eb1	177	OPENSSL_LH_doall((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNC)doall); \
63c75cd6	178	} \
e6b5c341	179	LHASH_OF(type)
3c1d6bbc	180
2a056de8 DSH	181	#define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \
	182	int_implement_lhash_doall(type, argtype, const type)
	183
	184	#define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \
	185	int_implement_lhash_doall(type, argtype, type)
	186
	187	#define int_implement_lhash_doall(type, argtype, cbargtype) \
89d6aa10	188	static ossl_inline void \
2a056de8 DSH	189	lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \
	190	void (fn)(cbargtype , argtype *), \
	191	argtype *arg) \
	192	{ \
739a1eb1	193	OPENSSL_LH_doall_arg((OPENSSL_LHASH )lh, (OPENSSL_LH_DOALL_FUNCARG)fn, (void )arg); \
2a056de8 DSH	194	} \
	195	LHASH_OF(type)
	196
89d6aa10	197	DEFINE_LHASH_OF(OPENSSL_STRING);
05004f36 RS	198	# ifdef _MSC_VER
	199	/*
	200	* push and pop this warning:
	201	* warning C4090: 'function': different 'const' qualifiers
	202	*/
	203	# pragma warning (push)
	204	# pragma warning (disable: 4090)
	205	# endif
	206
89d6aa10	207	DEFINE_LHASH_OF(OPENSSL_CSTRING);
3c1d6bbc	208
05004f36 RS	209	# ifdef _MSC_VER
	210	# pragma warning (pop)
	211	# endif
	212
d02b48c6 RE	213	#ifdef __cplusplus
	214	}
	215	#endif
	216
	217	#endif