function lfds711_hash_a_init_valid_on_current_logical_core
Source Files
└───liblfds711
├───inc
│ └───liblfds711
│ lfds711_hash_addonly.h
└───src
└───llfds711_hash_addonly
lfds711_hash_addonly_init.c
Enums
enum lfds711_hash_a_existing_key { LFDS711_HASH_A_EXISTING_KEY_OVERWRITE, LFDS711_HASH_A_EXISTING_KEY_FAIL };
Opaque Structures
struct lfds711_btree_au_state; struct lfds711_hash_a_state;
Prototype
void lfds711_hash_a_init_valid_on_current_logical_core( struct lfds711_hash_a_state *has,
struct lfds711_btree_au_state *baus_array,
lfds711_uint_t array_size,
int (*key_compare_function)(void const *new_key, void const *existing_key),
void (*key_hash_function)(void const *key, lfds711_uint_t *hash),
enum lfds711_hash_a_existing_key existing_key,
void *user_state );
Parameters
struct lfds711_hash_a_state *has
- A pointer to a user-allocated LFDS711_PAL_ATOMIC_ISOLATION_IN_BYTES aligned struct lfds711_hash_a_state. Stack declared variables will automatically be correctly aligned by the compiler, due to the information in the structure definitions; nothing has to be done. Heap allocated variables however will by no means be correctly aligned and an aligned malloc must be used.
struct lfds711_btree_au_state *baus_array
- An array of uninitialized user-allocated LFDS711_PAL_ATOMIC_ISOLATION_IN_BYTES aligned struct lfds711_btree_au_states. These are the hash buckets. Stack declared variables will automatically be correctly aligned by the compiler, due to the information in the structure definitions; nothing has to be done. Heap allocated variables however will by no means be correctly aligned and an aligned malloc must be used.
lfds711_uint_t array_size
- The number of elements in baus_array.
int (*key_compare_function)(void const *new_key, void const *existing_key)
- A callback used by the hash to compare elements.
void (*key_hash_function)(void const *key, lfds711_uint_t *hash)
- A callback used by the hash to hash elements.
enum lfds711_hash_a_existing_key existing_key
- This argument specifies how the hash should behave when attempting to put a key which already exists.
void *user_state
- A pointer to void, supplied by the user, which is returned to the user in various callback functions, permitting the user to pass his own state into those functions. This argument can be NULL.
Notes
As the function name indicates, the initialization work performed on the hash state is only valid on the current logical core. To make this work valid on other logical cores, threads on other cores must call LFDS711_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE.
This function instantiates a hash by initializing the hash state. The caller is responsible for all memory allocation and, after lfds711_hash_a_cleanup is called, for all deallocation.