Section 3: library functions
NAME ck_pr_btc_ptr ck_pr_btc_uint ck_pr_btc_int ck_pr_btc_64 ck_pr_btc_32 ck_pr_btc_16 – atomic bit test-and-complement operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft bool Fn ck_pr_btc_ptr void *target unsigned int bit_index Ft bool Fn ck_pr_btc_uint uint *target unsigned int bit_index Ft bool Fn ck_pr_btc_int int *target unsigned int bit_index Ft bool Fn ck_pr_btc_64 uint64_t *target unsigned int…
NAME ck_pr_barrier – compiler optimization barrier LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_barrier void DESCRIPTION The Fn ck_pr_barrier 3 function is used to disable code movement optimizations across the invocation of the function. SEE ALSO ck_pr_fence_load3, ck_pr_fence_load_depends3, ck_pr_fence_store3, ck_pr_fence_memory3, ck_pr_fas3, ck_pr_load3, ck_pr_store3, ck_pr_faa3, ck_pr_inc3, ck_pr_dec3, ck_pr_neg3, ck_pr_not3, ck_pr_add3, ck_pr_sub3, ck_pr_and3,…
NAME ck_pr_and_ptr ck_pr_and_char ck_pr_and_uint ck_pr_and_int ck_pr_and_64 ck_pr_and_32 ck_pr_and_16 ck_pr_and_8 – atomic bitwise-and operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_and_ptr void *target uintptr_t delta Ft void Fn ck_pr_and_char char *target char delta Ft void Fn ck_pr_and_uint unsigned int *target unsigned int delta Ft void Fn ck_pr_and_int int *target int delta…
NAME ck_pr_add_ptr ck_pr_add_double ck_pr_add_char ck_pr_add_uint ck_pr_add_int ck_pr_add_64 ck_pr_add_32 ck_pr_add_16 ck_pr_add_8 – atomic addition operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_add_ptr void *target uintptr_t delta Ft void Fn ck_pr_add_double double *target double delta Ft void Fn ck_pr_add_char char *target char delta Ft void Fn ck_pr_add_uint unsigned int *target unsigned int…
NAME ck_pr – concurrency primitives interface LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h DESCRIPTION ck_pr.h provides an interface to volatile atomic instructions, memory barriers and busy-wait facilities as provided by the underlying processor. The presence of an atomic operation is detected by the presence of a corresponding CK_F_PR macro. For example, the availability of…
NAME ck_pflock_init ck_pflock_write_lock ck_pflock_write_unlock ck_pflock_read_lock ck_pflock_read_unlock – centralized phase-fair reader-writer locks LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pflock.h ck_pflock_t lock = CK_PFLOCK_INITIALIZER; Ft void Fn ck_pflock_init ck_pflock_t *lock Ft void Fn ck_pflock_write_lock ck_pflock_t *lock Ft void Fn ck_pflock_write_unlock ck_pflock_t *lock Ft void Fn ck_pflock_read_lock ck_pflock_t *lock Ft void Fn ck_pflock_read_unlock ck_pflock_t *lock DESCRIPTION This…
NAME ck_ht_stat – get hash table status LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_stat ck_ht_t *ht struct ck_ht_stat *st DESCRIPTION The Fn ck_ht_stat 3 function will store various hash set statistics in the object pointed to by Fa st . The ck_ht_stat structure is defined as follows: struct ck_ht_stat {…
NAME ck_ht_set_spmc – store key-value pair into hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_set_spmc ck_ht_t *ht ck_ht_hash_t h ck_ht_entry_t *entry DESCRIPTION The Fn ck_ht_set_spmc function will store the key-value pair specified in the Fa entry argument in the hash table pointed to by the Fa ht argument. The…
NAME ck_ht_reset_spmc – remove all entries from a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_reset_spmc ck_ht_t *ht DESCRIPTION The Fn ck_ht_reset_spmc function will remove all key-value pairs stored in the hash table pointed to by the Fa ht argument. RETURN VALUES If successful, Fn ck_ht_reset_spmc will return true…
NAME ck_ht_reset_size_spmc – remove all entries from a hash table and reset size LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_reset_size_spmc ck_ht_t *ht uint64_t capacity DESCRIPTION The Fn ck_ht_reset_size_spmc function will remove all key-value pairs stored in the hash table pointed to by the Fa ht argument and create a new…
NAME ck_ht_remove_spmc – resize a hash table if necessary LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_remove_spmc ck_ht_t *ht ck_ht_hash_t h ck_ht_entry_t *entry DESCRIPTION The Fn ck_ht_remove_spmc function will remove the key-value pair associated with the key specified by the Fa entry argument. If Fa ht was created with CK_HT_MODE_BYTESTRING then…
NAME ck_ht_put_spmc – store unique key-value pair into hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_put_spmc ck_ht_t *ht ck_ht_hash_t h ck_ht_entry_t *entry DESCRIPTION The Fn ck_ht_put_spmc function will store the key-value pair specified in the Fa entry argument in the hash table pointed to by the Fa ht argument….
NAME ck_ht_next – iterate to next entry in hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_next ck_ht_t *ht ck_ht_iterator_t *iterator ck_ht_entry_t **entry DESCRIPTION The Fn ck_ht_next function will increment the iterator object pointed to by Fa iterator to point to the next non-empty hash table entry. If Fn ck_ht_next…
NAME ck_ht_iterator_init – initialize hash table iterator LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h ck_ht_iterator_t iterator = CK_HT_ITERATOR_INITIALIZER Ft void Fn ck_ht_iterator_init ck_ht_iterator_t *iterator DESCRIPTION The Fn ck_ht_iterator_init function will initialize the object pointed to by the Fa iterator argument. Alternatively, an iterator may be statically initialized by assigning it the CK_HT_ITERATOR_INITIALIZER value. An…
NAME ck_ht_init – initialize a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft typedef void Fn ck_ht_hash_cb_t ck_ht_hash_t *h const void *key size_t key_length uint64_t seed Ft bool Fn ck_ht_init ck_ht_t *ht enum ck_ht_mode mode ck_ht_hash_cb_t *hash_function struct ck_malloc *allocator uint64_t capacity uint64_t seed DESCRIPTION The Fn ck_ht_init function initializes the hash…
NAME ck_ht_hash_direct – generate a hash value for a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_hash_direct ck_ht_hash_t *h ck_ht_t *ht uintptr_t key DESCRIPTION The Fn ck_ht_hash_direct function will generate a hash value in the object pointed to by the Fa h argument. The hash value is valid for…
NAME ck_ht_hash – generate a hash value for a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_hash ck_ht_hash_t *h ck_ht_t *ht const void *key uint16_t key_length DESCRIPTION The Fn ck_ht_hash function will generate a hash value in the object pointed to by the Fa h argument. The hash value…
NAME ck_ht_grow_spmc – resize a hash table if necessary LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_grow_spmc ck_ht_t *ht uint64_t capacity DESCRIPTION The Fn ck_ht_grow_spmc function will resize the hash table in order to be able to at least store the number of entries specified by Fa capacity at a load…
NAME ck_ht_get_spmc – load a key-value pair from a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_get_spmc ck_ht_t *ht ck_ht_hash_t h ck_ht_entry_t *entry DESCRIPTION The Fn ck_ht_get_spmc function will return the value associated with the key specified in the Fa entry argument in the hash table pointed to by…
NAME ck_ht_gc – perform maintenance on a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_gc ck_ht_t *ht unsigned long cycles unsigned long seed DESCRIPTION The Fn ck_ht_gc function will perform various maintenance routines on the hash table pointed to by Fa ht , including defragmentation of probe sequences with…