2  * Copyright 2024-2025 The OpenSSL Project Authors. All Rights Reserved.
23  * Represents a key to a hashtable
31  * Represents a value in the hash table
34     void *value;  member
36     HT_KEY key;  member
53     uint64_t (*ht_hash_fn)(uint8_t *key, size_t keylen);
60  * Hashtable key rules
61  * Any struct can be used to formulate a hash table key, as long as the
63  * 1) The first element of the struct defining the key must be an HT_KEY
65  * 3) Pointers can be used, but the value of the pointer, rather than
68  * The key definition macros will assist with enforcing these rules
72  * Starts the definition of a hash table key
80  * Ends a hash table key definitions
87  * Defines a field in a hash table key
93  * array field in a hash table key
99  * Defines a uint8_t (blob) field in a hash table key
105  * Initializes a key
107 #define HT_INIT_KEY(key) do { \  argument
108 memset((key), 0, sizeof(*(key))); \
109 (key)->key_header.keysize = (sizeof(*(key)) - sizeof(HT_KEY)); \
110 (key)->key_header.keybuf = (((uint8_t *)key) + sizeof(HT_KEY)); \
114  * Resets a hash table key to a known state
116 #define HT_KEY_RESET(key) memset((key)->key_header.keybuf, 0, (key)->key_header.keysize)  argument
119  * Sets a scalar field in a hash table key
121 #define HT_SET_KEY_FIELD(key, member, value) (key)->keyfields.member = value;  argument
124  * Sets a string field in a hash table key, preserving
127 #define HT_SET_KEY_STRING(key, member, value) do { \  argument
128     if ((value) != NULL) \
129         strncpy((key)->keyfields.member, value, sizeof((key)->keyfields.member) - 1); \
134  * ossl_ht_strcase to make the value being passed case insensitive
136  * key value to hash to the same entry
138 #define HT_SET_KEY_STRING_CASE(key, member, value) do { \  argument
139    ossl_ht_strcase((key)->keyfields.member, value, sizeof((key)->keyfields.member) -1); \
145 #define HT_SET_KEY_STRING_N(key, member, value, len) do { \  argument
146     if ((value) != NULL) { \
147         if (len < sizeof((key)->keyfields.member)) \
148             strncpy((key)->keyfields.member, value, len); \
150             strncpy((key)->keyfields.member, value, sizeof((key)->keyfields.member) - 1); \
155 #define HT_SET_KEY_STRING_CASE_N(key, member, value, len) do { \  argument
156     if (len < sizeof((key)->keyfields.member)) \
157         ossl_ht_strcase((key)->keyfields.member, value, len); \
159         ossl_ht_strcase((key)->keyfields.member, value, sizeof((key)->keyfields.member) - 1); \
163  * Sets a uint8_t (blob) field in a hash table key
165 #define HT_SET_KEY_BLOB(key, member, value, len) do { \  argument
166     if (value != NULL) \
167         memcpy((key)->keyfields.member, value, len); \
171  * Converts a defined key type to an HT_KEY
173 #define TO_HT_KEY(key) &(key)->key_header  argument
179 #define FROM_HT_KEY(key, type) (type)(key)  argument
183  * ossl_ht_NAME_TYPE_insert - insert a value to a hash table of type TYPE
184  * ossl_ht_NAME_TYPE_get - gets a value of a specific type from the hash table
185  * ossl_ht_NAME_TYPE_from_value - converts an HT_VALUE to its type
186  * ossl_ht_NAME_TYPE_to_value - converts a TYPE to an HT_VALUE
187  * ossl_ht_NAME_TYPE_type - boolean to detect if a value is of TYPE
191 pfx ossl_unused int ossl_ht_##name##_##vtype##_insert(HT *h, HT_KEY *key,      \
198     inval.value = data;                                                        \
200     rc = ossl_ht_insert(h, key, &inval, olddata == NULL ? NULL : &oval);       \
202         *olddata = (vtype *)oval->value;                                       \
211     if (v->type_id != expect_type)                                             \
213     return (vtype *)v->value;                                                  \
217                                                                   HT_KEY *key, \
221     vv = ossl_ht_get(h, key);                                                  \
231     v->type_id = &name##_##vtype##_id;                                         \
232     v->value = data;                                                           \
238     return h->type_id == &name##_##vtype##_id;                                 \
242 int ossl_ht_##name##_##vtype##_insert(HT *h, HT_KEY *key, vtype *data,         \
246                                                   HT_KEY *key,                 \
310 int ossl_ht_insert(HT *htable, HT_KEY *key, HT_VALUE *data,
314  * Deletes a value from a hash table, based on key
315  * Returns 1 if the key was removed, 0 if they key was not found
317 int ossl_ht_delete(HT *htable, HT_KEY *key);
336  * filter function return value.  Returns NULL on error,
350  * Fetches a value from the hash table, based
351  * on key.  Returns NULL if the element was not found.
353 HT_VALUE *ossl_ht_get(HT *htable, HT_KEY *key);