1*b077aed3SPierre Pronchery/* 2*b077aed3SPierre Pronchery * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved. 3*b077aed3SPierre Pronchery * 4*b077aed3SPierre Pronchery * Licensed under the Apache License 2.0 (the "License"). You may not use 5*b077aed3SPierre Pronchery * this file except in compliance with the License. You can obtain a copy 6*b077aed3SPierre Pronchery * in the file LICENSE in the source distribution or at 7*b077aed3SPierre Pronchery * https://www.openssl.org/source/license.html 8*b077aed3SPierre Pronchery */ 9*b077aed3SPierre Pronchery 10*b077aed3SPierre Pronchery{- 11*b077aed3SPierre Proncheryuse OpenSSL::stackhash qw(generate_lhash_macros); 12*b077aed3SPierre Pronchery-} 13*b077aed3SPierre Pronchery 14*b077aed3SPierre Pronchery/* 15*b077aed3SPierre Pronchery * Header for dynamic hash table routines Author - Eric Young 16*b077aed3SPierre Pronchery */ 17*b077aed3SPierre Pronchery 18*b077aed3SPierre Pronchery#ifndef OPENSSL_LHASH_H 19*b077aed3SPierre Pronchery# define OPENSSL_LHASH_H 20*b077aed3SPierre Pronchery# pragma once 21*b077aed3SPierre Pronchery 22*b077aed3SPierre Pronchery# include <openssl/macros.h> 23*b077aed3SPierre Pronchery# ifndef OPENSSL_NO_DEPRECATED_3_0 24*b077aed3SPierre Pronchery# define HEADER_LHASH_H 25*b077aed3SPierre Pronchery# endif 26*b077aed3SPierre Pronchery 27*b077aed3SPierre Pronchery# include <openssl/e_os2.h> 28*b077aed3SPierre Pronchery# include <openssl/bio.h> 29*b077aed3SPierre Pronchery 30*b077aed3SPierre Pronchery#ifdef __cplusplus 31*b077aed3SPierre Proncheryextern "C" { 32*b077aed3SPierre Pronchery#endif 33*b077aed3SPierre Pronchery 34*b077aed3SPierre Proncherytypedef struct lhash_node_st OPENSSL_LH_NODE; 35*b077aed3SPierre Proncherytypedef int (*OPENSSL_LH_COMPFUNC) (const void *, const void *); 36*b077aed3SPierre Proncherytypedef unsigned long (*OPENSSL_LH_HASHFUNC) (const void *); 37*b077aed3SPierre Proncherytypedef void (*OPENSSL_LH_DOALL_FUNC) (void *); 38*b077aed3SPierre Proncherytypedef void (*OPENSSL_LH_DOALL_FUNCARG) (void *, void *); 39*b077aed3SPierre Proncherytypedef struct lhash_st OPENSSL_LHASH; 40*b077aed3SPierre Pronchery 41*b077aed3SPierre Pronchery/* 42*b077aed3SPierre Pronchery * Macros for declaring and implementing type-safe wrappers for LHASH 43*b077aed3SPierre Pronchery * callbacks. This way, callbacks can be provided to LHASH structures without 44*b077aed3SPierre Pronchery * function pointer casting and the macro-defined callbacks provide 45*b077aed3SPierre Pronchery * per-variable casting before deferring to the underlying type-specific 46*b077aed3SPierre Pronchery * callbacks. NB: It is possible to place a "static" in front of both the 47*b077aed3SPierre Pronchery * DECLARE and IMPLEMENT macros if the functions are strictly internal. 48*b077aed3SPierre Pronchery */ 49*b077aed3SPierre Pronchery 50*b077aed3SPierre Pronchery/* First: "hash" functions */ 51*b077aed3SPierre Pronchery# define DECLARE_LHASH_HASH_FN(name, o_type) \ 52*b077aed3SPierre Pronchery unsigned long name##_LHASH_HASH(const void *); 53*b077aed3SPierre Pronchery# define IMPLEMENT_LHASH_HASH_FN(name, o_type) \ 54*b077aed3SPierre Pronchery unsigned long name##_LHASH_HASH(const void *arg) { \ 55*b077aed3SPierre Pronchery const o_type *a = arg; \ 56*b077aed3SPierre Pronchery return name##_hash(a); } 57*b077aed3SPierre Pronchery# define LHASH_HASH_FN(name) name##_LHASH_HASH 58*b077aed3SPierre Pronchery 59*b077aed3SPierre Pronchery/* Second: "compare" functions */ 60*b077aed3SPierre Pronchery# define DECLARE_LHASH_COMP_FN(name, o_type) \ 61*b077aed3SPierre Pronchery int name##_LHASH_COMP(const void *, const void *); 62*b077aed3SPierre Pronchery# define IMPLEMENT_LHASH_COMP_FN(name, o_type) \ 63*b077aed3SPierre Pronchery int name##_LHASH_COMP(const void *arg1, const void *arg2) { \ 64*b077aed3SPierre Pronchery const o_type *a = arg1; \ 65*b077aed3SPierre Pronchery const o_type *b = arg2; \ 66*b077aed3SPierre Pronchery return name##_cmp(a,b); } 67*b077aed3SPierre Pronchery# define LHASH_COMP_FN(name) name##_LHASH_COMP 68*b077aed3SPierre Pronchery 69*b077aed3SPierre Pronchery/* Fourth: "doall_arg" functions */ 70*b077aed3SPierre Pronchery# define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ 71*b077aed3SPierre Pronchery void name##_LHASH_DOALL_ARG(void *, void *); 72*b077aed3SPierre Pronchery# define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ 73*b077aed3SPierre Pronchery void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \ 74*b077aed3SPierre Pronchery o_type *a = arg1; \ 75*b077aed3SPierre Pronchery a_type *b = arg2; \ 76*b077aed3SPierre Pronchery name##_doall_arg(a, b); } 77*b077aed3SPierre Pronchery# define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG 78*b077aed3SPierre Pronchery 79*b077aed3SPierre Pronchery 80*b077aed3SPierre Pronchery# define LH_LOAD_MULT 256 81*b077aed3SPierre Pronchery 82*b077aed3SPierre Proncheryint OPENSSL_LH_error(OPENSSL_LHASH *lh); 83*b077aed3SPierre ProncheryOPENSSL_LHASH *OPENSSL_LH_new(OPENSSL_LH_HASHFUNC h, OPENSSL_LH_COMPFUNC c); 84*b077aed3SPierre Proncheryvoid OPENSSL_LH_free(OPENSSL_LHASH *lh); 85*b077aed3SPierre Proncheryvoid OPENSSL_LH_flush(OPENSSL_LHASH *lh); 86*b077aed3SPierre Proncheryvoid *OPENSSL_LH_insert(OPENSSL_LHASH *lh, void *data); 87*b077aed3SPierre Proncheryvoid *OPENSSL_LH_delete(OPENSSL_LHASH *lh, const void *data); 88*b077aed3SPierre Proncheryvoid *OPENSSL_LH_retrieve(OPENSSL_LHASH *lh, const void *data); 89*b077aed3SPierre Proncheryvoid OPENSSL_LH_doall(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNC func); 90*b077aed3SPierre Proncheryvoid OPENSSL_LH_doall_arg(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNCARG func, void *arg); 91*b077aed3SPierre Proncheryunsigned long OPENSSL_LH_strhash(const char *c); 92*b077aed3SPierre Proncheryunsigned long OPENSSL_LH_num_items(const OPENSSL_LHASH *lh); 93*b077aed3SPierre Proncheryunsigned long OPENSSL_LH_get_down_load(const OPENSSL_LHASH *lh); 94*b077aed3SPierre Proncheryvoid OPENSSL_LH_set_down_load(OPENSSL_LHASH *lh, unsigned long down_load); 95*b077aed3SPierre Pronchery 96*b077aed3SPierre Pronchery# ifndef OPENSSL_NO_STDIO 97*b077aed3SPierre Proncheryvoid OPENSSL_LH_stats(const OPENSSL_LHASH *lh, FILE *fp); 98*b077aed3SPierre Proncheryvoid OPENSSL_LH_node_stats(const OPENSSL_LHASH *lh, FILE *fp); 99*b077aed3SPierre Proncheryvoid OPENSSL_LH_node_usage_stats(const OPENSSL_LHASH *lh, FILE *fp); 100*b077aed3SPierre Pronchery# endif 101*b077aed3SPierre Proncheryvoid OPENSSL_LH_stats_bio(const OPENSSL_LHASH *lh, BIO *out); 102*b077aed3SPierre Proncheryvoid OPENSSL_LH_node_stats_bio(const OPENSSL_LHASH *lh, BIO *out); 103*b077aed3SPierre Proncheryvoid OPENSSL_LH_node_usage_stats_bio(const OPENSSL_LHASH *lh, BIO *out); 104*b077aed3SPierre Pronchery 105*b077aed3SPierre Pronchery# ifndef OPENSSL_NO_DEPRECATED_1_1_0 106*b077aed3SPierre Pronchery# define _LHASH OPENSSL_LHASH 107*b077aed3SPierre Pronchery# define LHASH_NODE OPENSSL_LH_NODE 108*b077aed3SPierre Pronchery# define lh_error OPENSSL_LH_error 109*b077aed3SPierre Pronchery# define lh_new OPENSSL_LH_new 110*b077aed3SPierre Pronchery# define lh_free OPENSSL_LH_free 111*b077aed3SPierre Pronchery# define lh_insert OPENSSL_LH_insert 112*b077aed3SPierre Pronchery# define lh_delete OPENSSL_LH_delete 113*b077aed3SPierre Pronchery# define lh_retrieve OPENSSL_LH_retrieve 114*b077aed3SPierre Pronchery# define lh_doall OPENSSL_LH_doall 115*b077aed3SPierre Pronchery# define lh_doall_arg OPENSSL_LH_doall_arg 116*b077aed3SPierre Pronchery# define lh_strhash OPENSSL_LH_strhash 117*b077aed3SPierre Pronchery# define lh_num_items OPENSSL_LH_num_items 118*b077aed3SPierre Pronchery# ifndef OPENSSL_NO_STDIO 119*b077aed3SPierre Pronchery# define lh_stats OPENSSL_LH_stats 120*b077aed3SPierre Pronchery# define lh_node_stats OPENSSL_LH_node_stats 121*b077aed3SPierre Pronchery# define lh_node_usage_stats OPENSSL_LH_node_usage_stats 122*b077aed3SPierre Pronchery# endif 123*b077aed3SPierre Pronchery# define lh_stats_bio OPENSSL_LH_stats_bio 124*b077aed3SPierre Pronchery# define lh_node_stats_bio OPENSSL_LH_node_stats_bio 125*b077aed3SPierre Pronchery# define lh_node_usage_stats_bio OPENSSL_LH_node_usage_stats_bio 126*b077aed3SPierre Pronchery# endif 127*b077aed3SPierre Pronchery 128*b077aed3SPierre Pronchery/* Type checking... */ 129*b077aed3SPierre Pronchery 130*b077aed3SPierre Pronchery# define LHASH_OF(type) struct lhash_st_##type 131*b077aed3SPierre Pronchery 132*b077aed3SPierre Pronchery/* Helper macro for internal use */ 133*b077aed3SPierre Pronchery# define DEFINE_LHASH_OF_INTERNAL(type) \ 134*b077aed3SPierre Pronchery LHASH_OF(type) { union lh_##type##_dummy { void* d1; unsigned long d2; int d3; } dummy; }; \ 135*b077aed3SPierre Pronchery typedef int (*lh_##type##_compfunc)(const type *a, const type *b); \ 136*b077aed3SPierre Pronchery typedef unsigned long (*lh_##type##_hashfunc)(const type *a); \ 137*b077aed3SPierre Pronchery typedef void (*lh_##type##_doallfunc)(type *a); \ 138*b077aed3SPierre Pronchery static ossl_unused ossl_inline type *ossl_check_##type##_lh_plain_type(type *ptr) \ 139*b077aed3SPierre Pronchery { \ 140*b077aed3SPierre Pronchery return ptr; \ 141*b077aed3SPierre Pronchery } \ 142*b077aed3SPierre Pronchery static ossl_unused ossl_inline const type *ossl_check_const_##type##_lh_plain_type(const type *ptr) \ 143*b077aed3SPierre Pronchery { \ 144*b077aed3SPierre Pronchery return ptr; \ 145*b077aed3SPierre Pronchery } \ 146*b077aed3SPierre Pronchery static ossl_unused ossl_inline const OPENSSL_LHASH *ossl_check_const_##type##_lh_type(const LHASH_OF(type) *lh) \ 147*b077aed3SPierre Pronchery { \ 148*b077aed3SPierre Pronchery return (const OPENSSL_LHASH *)lh; \ 149*b077aed3SPierre Pronchery } \ 150*b077aed3SPierre Pronchery static ossl_unused ossl_inline OPENSSL_LHASH *ossl_check_##type##_lh_type(LHASH_OF(type) *lh) \ 151*b077aed3SPierre Pronchery { \ 152*b077aed3SPierre Pronchery return (OPENSSL_LHASH *)lh; \ 153*b077aed3SPierre Pronchery } \ 154*b077aed3SPierre Pronchery static ossl_unused ossl_inline OPENSSL_LH_COMPFUNC ossl_check_##type##_lh_compfunc_type(lh_##type##_compfunc cmp) \ 155*b077aed3SPierre Pronchery { \ 156*b077aed3SPierre Pronchery return (OPENSSL_LH_COMPFUNC)cmp; \ 157*b077aed3SPierre Pronchery } \ 158*b077aed3SPierre Pronchery static ossl_unused ossl_inline OPENSSL_LH_HASHFUNC ossl_check_##type##_lh_hashfunc_type(lh_##type##_hashfunc hfn) \ 159*b077aed3SPierre Pronchery { \ 160*b077aed3SPierre Pronchery return (OPENSSL_LH_HASHFUNC)hfn; \ 161*b077aed3SPierre Pronchery } \ 162*b077aed3SPierre Pronchery static ossl_unused ossl_inline OPENSSL_LH_DOALL_FUNC ossl_check_##type##_lh_doallfunc_type(lh_##type##_doallfunc dfn) \ 163*b077aed3SPierre Pronchery { \ 164*b077aed3SPierre Pronchery return (OPENSSL_LH_DOALL_FUNC)dfn; \ 165*b077aed3SPierre Pronchery } \ 166*b077aed3SPierre Pronchery LHASH_OF(type) 167*b077aed3SPierre Pronchery 168*b077aed3SPierre Pronchery# define DEFINE_LHASH_OF(type) \ 169*b077aed3SPierre Pronchery LHASH_OF(type) { union lh_##type##_dummy { void* d1; unsigned long d2; int d3; } dummy; }; \ 170*b077aed3SPierre Pronchery static ossl_unused ossl_inline LHASH_OF(type) *lh_##type##_new(unsigned long (*hfn)(const type *), \ 171*b077aed3SPierre Pronchery int (*cfn)(const type *, const type *)) \ 172*b077aed3SPierre Pronchery { \ 173*b077aed3SPierre Pronchery return (LHASH_OF(type) *) \ 174*b077aed3SPierre Pronchery OPENSSL_LH_new((OPENSSL_LH_HASHFUNC)hfn, (OPENSSL_LH_COMPFUNC)cfn); \ 175*b077aed3SPierre Pronchery } \ 176*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \ 177*b077aed3SPierre Pronchery { \ 178*b077aed3SPierre Pronchery OPENSSL_LH_free((OPENSSL_LHASH *)lh); \ 179*b077aed3SPierre Pronchery } \ 180*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_flush(LHASH_OF(type) *lh) \ 181*b077aed3SPierre Pronchery { \ 182*b077aed3SPierre Pronchery OPENSSL_LH_flush((OPENSSL_LHASH *)lh); \ 183*b077aed3SPierre Pronchery } \ 184*b077aed3SPierre Pronchery static ossl_unused ossl_inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \ 185*b077aed3SPierre Pronchery { \ 186*b077aed3SPierre Pronchery return (type *)OPENSSL_LH_insert((OPENSSL_LHASH *)lh, d); \ 187*b077aed3SPierre Pronchery } \ 188*b077aed3SPierre Pronchery static ossl_unused ossl_inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \ 189*b077aed3SPierre Pronchery { \ 190*b077aed3SPierre Pronchery return (type *)OPENSSL_LH_delete((OPENSSL_LHASH *)lh, d); \ 191*b077aed3SPierre Pronchery } \ 192*b077aed3SPierre Pronchery static ossl_unused ossl_inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \ 193*b077aed3SPierre Pronchery { \ 194*b077aed3SPierre Pronchery return (type *)OPENSSL_LH_retrieve((OPENSSL_LHASH *)lh, d); \ 195*b077aed3SPierre Pronchery } \ 196*b077aed3SPierre Pronchery static ossl_unused ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \ 197*b077aed3SPierre Pronchery { \ 198*b077aed3SPierre Pronchery return OPENSSL_LH_error((OPENSSL_LHASH *)lh); \ 199*b077aed3SPierre Pronchery } \ 200*b077aed3SPierre Pronchery static ossl_unused ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \ 201*b077aed3SPierre Pronchery { \ 202*b077aed3SPierre Pronchery return OPENSSL_LH_num_items((OPENSSL_LHASH *)lh); \ 203*b077aed3SPierre Pronchery } \ 204*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \ 205*b077aed3SPierre Pronchery { \ 206*b077aed3SPierre Pronchery OPENSSL_LH_node_stats_bio((const OPENSSL_LHASH *)lh, out); \ 207*b077aed3SPierre Pronchery } \ 208*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \ 209*b077aed3SPierre Pronchery { \ 210*b077aed3SPierre Pronchery OPENSSL_LH_node_usage_stats_bio((const OPENSSL_LHASH *)lh, out); \ 211*b077aed3SPierre Pronchery } \ 212*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \ 213*b077aed3SPierre Pronchery { \ 214*b077aed3SPierre Pronchery OPENSSL_LH_stats_bio((const OPENSSL_LHASH *)lh, out); \ 215*b077aed3SPierre Pronchery } \ 216*b077aed3SPierre Pronchery static ossl_unused ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \ 217*b077aed3SPierre Pronchery { \ 218*b077aed3SPierre Pronchery return OPENSSL_LH_get_down_load((OPENSSL_LHASH *)lh); \ 219*b077aed3SPierre Pronchery } \ 220*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \ 221*b077aed3SPierre Pronchery { \ 222*b077aed3SPierre Pronchery OPENSSL_LH_set_down_load((OPENSSL_LHASH *)lh, dl); \ 223*b077aed3SPierre Pronchery } \ 224*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \ 225*b077aed3SPierre Pronchery void (*doall)(type *)) \ 226*b077aed3SPierre Pronchery { \ 227*b077aed3SPierre Pronchery OPENSSL_LH_doall((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNC)doall); \ 228*b077aed3SPierre Pronchery } \ 229*b077aed3SPierre Pronchery static ossl_unused ossl_inline void lh_##type##_doall_arg(LHASH_OF(type) *lh, \ 230*b077aed3SPierre Pronchery void (*doallarg)(type *, void *), \ 231*b077aed3SPierre Pronchery void *arg) \ 232*b077aed3SPierre Pronchery { \ 233*b077aed3SPierre Pronchery OPENSSL_LH_doall_arg((OPENSSL_LHASH *)lh, \ 234*b077aed3SPierre Pronchery (OPENSSL_LH_DOALL_FUNCARG)doallarg, arg); \ 235*b077aed3SPierre Pronchery } \ 236*b077aed3SPierre Pronchery LHASH_OF(type) 237*b077aed3SPierre Pronchery 238*b077aed3SPierre Pronchery#define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \ 239*b077aed3SPierre Pronchery int_implement_lhash_doall(type, argtype, const type) 240*b077aed3SPierre Pronchery 241*b077aed3SPierre Pronchery#define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \ 242*b077aed3SPierre Pronchery int_implement_lhash_doall(type, argtype, type) 243*b077aed3SPierre Pronchery 244*b077aed3SPierre Pronchery#define int_implement_lhash_doall(type, argtype, cbargtype) \ 245*b077aed3SPierre Pronchery static ossl_unused ossl_inline void \ 246*b077aed3SPierre Pronchery lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \ 247*b077aed3SPierre Pronchery void (*fn)(cbargtype *, argtype *), \ 248*b077aed3SPierre Pronchery argtype *arg) \ 249*b077aed3SPierre Pronchery { \ 250*b077aed3SPierre Pronchery OPENSSL_LH_doall_arg((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNCARG)fn, (void *)arg); \ 251*b077aed3SPierre Pronchery } \ 252*b077aed3SPierre Pronchery LHASH_OF(type) 253*b077aed3SPierre Pronchery 254*b077aed3SPierre Pronchery{- 255*b077aed3SPierre Pronchery generate_lhash_macros("OPENSSL_STRING") 256*b077aed3SPierre Pronchery .generate_lhash_macros("OPENSSL_CSTRING"); 257*b077aed3SPierre Pronchery-} 258*b077aed3SPierre Pronchery 259*b077aed3SPierre Pronchery#ifdef __cplusplus 260*b077aed3SPierre Pronchery} 261*b077aed3SPierre Pronchery#endif 262*b077aed3SPierre Pronchery 263*b077aed3SPierre Pronchery#endif 264