Section 3: library functions
NAME ck_rhs_move – move one from hash set to another LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_move ck_rhs_t *destination ck_rhs_t *source ck_rhs_hash_cb_t *hash_cb ck_rhs_compare_cb_t *compare_cb struct ck_malloc *m DESCRIPTION The Fn ck_rhs_move 3 function will initialize Fa source from Fa destination . The hash function is set to Fa hash_cb…
NAME ck_rhs_iterator_init – initialize hash set iterator LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h ck_rhs_iterator_t iterator = CK_RHS_ITERATOR_INITIALIZER Ft void Fn ck_rhs_iterator_init ck_rhs_iterator_t *iterator DESCRIPTION The Fn ck_rhs_iterator_init 3 function will initialize the object pointed to by the Fa iterator argument. Alternatively, an iterator may be statically initialized by assigning it to the CK_RHS_ITERATOR_INITIALIZER…
NAME ck_rhs_init – initialize a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft typedef unsigned long Fn ck_rhs_hash_cb_t const void *key unsigned long seed Ft typedef bool Fn ck_rhs_compare_cb_t const void *c1 const void *c2 Ft bool Fn ck_rhs_init ck_rhs_t *hs unsigned int mode ck_rhs_hash_cb_t *hash_function ck_rhs_compare_cb_t *compare struct ck_malloc *allocator unsigned…
NAME ck_rhs_grow – enlarge hash set capacity LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_grow ck_rhs_t *hs unsigned long capacity DESCRIPTION The Fn ck_rhs_grow 3 function will resize the hash set in order to be able to store at least the number of entries specified by Fa capacity at a load…
NAME ck_rhs_get – load a key from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft void * Fn ck_rhs_get ck_rhs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_rhs_get 3 function will return a pointer to a key in the hash set Fa hs that is of equivalent value…
NAME ck_rhs_gc – perform maintenance on a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_gc ck_rhs_t *hs DESCRIPTION The Fn ck_rhs_gc 3 function will perform various maintenance routines on the hash set pointed to by Fa hs , including recalculating the maximum number of probes. RETURN VALUES Upon successful…
NAME ck_rhs_fas – fetch and store key in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_fas ck_rhs_t *hs unsigned long hash const void *key void **previous DESCRIPTION The Fn ck_rhs_fas 3 function will fetch and store the key specified by the Fa key argument in the hash set pointed…
NAME ck_rhs_destroy – destroy hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft void Fn ck_rhs_destroy ck_rhs_t *hs DESCRIPTION The Fn ck_rhs_destroy 3 function will request that the underlying allocator, as specified by the ck_rhs_init3 function, immediately destroy the object pointed to by the Fa hs argument. The user must guarantee that no…
NAME ck_rhs_count – returns number of entries in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft unsigned long Fn ck_rhs_count ck_rhs_t *hs DESCRIPTION The Fn ck_rhs_count 3 function returns the number of keys currently stored in Fa hs . ERRORS Behavior is undefined if Fa hs is uninitialized. Behavior is undefined if…
NAME ck_rhs_apply – apply a function to hash set value LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft void * Fn ck_rhs_apply_fn_t void *key void *closure Ft bool Fn ck_rhs_apply ck_rhs_t *hs unsigned long hash const void *key ck_rhs_apply_fn_t *function void *argument DESCRIPTION The Fn ck_rhs_apply 3 function will lookup the hash set slot…
NAME CK_LIST_EMPTY CK_LIST_ENTRY CK_LIST_FIRST CK_LIST_FOREACH CK_LIST_FOREACH_SAFE CK_LIST_HEAD CK_LIST_HEAD_INITIALIZER CK_LIST_INIT CK_LIST_INSERT_AFTER CK_LIST_INSERT_BEFORE CK_LIST_INSERT_HEAD CK_LIST_MOVE CK_LIST_NEXT CK_LIST_REMOVE CK_LIST_SWAP CK_SLIST_EMPTY CK_SLIST_ENTRY CK_SLIST_FIRST CK_SLIST_FOREACH CK_SLIST_FOREACH_PREVPTR CK_SLIST_FOREACH_SAFE CK_SLIST_HEAD CK_SLIST_HEAD_INITIALIZER CK_SLIST_INIT CK_SLIST_INSERT_AFTER CK_SLIST_INSERT_HEAD CK_SLIST_MOVE CK_SLIST_NEXT CK_SLIST_REMOVE CK_SLIST_REMOVE_AFTER CK_SLIST_REMOVE_HEAD CK_SLIST_SWAP CK_STAILQ_CONCAT CK_STAILQ_EMPTY CK_STAILQ_ENTRY CK_STAILQ_FIRST CK_STAILQ_FOREACH CK_STAILQ_FOREACH_SAFE CK_STAILQ_HEAD CK_STAILQ_HEAD_INITIALIZER CK_STAILQ_INIT CK_STAILQ_INSERT_AFTER CK_STAILQ_INSERT_HEAD CK_STAILQ_INSERT_TAIL CK_STAILQ_MOVE CK_STAILQ_NEXT CK_STAILQ_REMOVE CK_STAILQ_REMOVE_AFTER CK_STAILQ_REMOVE_HEAD CK_STAILQ_SWAP – multi-reader single-writer singly-linked…
NAME ck_pr_xor_ptr ck_pr_xor_char ck_pr_xor_uint ck_pr_xor_int ck_pr_xor_64 ck_pr_xor_32 ck_pr_xor_16 ck_pr_xor_8 – atomic bitwise-xor operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_xor_ptr void *target uintptr_t delta Ft void Fn ck_pr_xor_char char *target char delta Ft void Fn ck_pr_xor_uint unsigned int *target unsigned int delta Ft void Fn ck_pr_xor_int int *target int delta…
NAME ck_pr_sub_ptr ck_pr_sub_double ck_pr_sub_char ck_pr_sub_uint ck_pr_sub_int ck_pr_sub_64 ck_pr_sub_32 ck_pr_sub_16 ck_pr_sub_8 – atomic subtraction operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_sub_ptr void *target uintptr_t delta Ft void Fn ck_pr_sub_double double *target double delta Ft void Fn ck_pr_sub_char char *target char delta Ft void Fn ck_pr_sub_uint unsigned int *target unsigned int…
NAME ck_pr_store_ptr ck_pr_store_double ck_pr_store_uint ck_pr_store_int ck_pr_store_char ck_pr_store_64 ck_pr_store_32 ck_pr_store_16 ck_pr_store_8 – atomic volatile store operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_store_ptr void *target void *value Ft void Fn ck_pr_store_double double *target double value Ft void Fn ck_pr_store_uint unsigned int *target unsigned int value Ft void Fn ck_pr_store_int int *target…
NAME ck_pr_stall – busy-wait primitive LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_stall void DESCRIPTION The Fn ck_pr_stall 3 function should be used inside retry paths of busy-wait loops. It not only serves as a compiler barrier, but on some architectures it emits cycle-saving instructions. EXAMPLE #include <ck_pr.h> static int ready…
NAME ck_pr_rtm_begin ck_pr_rtm_end ck_pr_rtm_abort ck_pr_rtm_test – restricted transactional memory LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft unsigned int Fn ck_pr_rtm_begin void Ft void Fn ck_pr_rtm_end void Ft void Fn ck_pr_rtm_abort const unsigned int status Ft bool Fn ck_pr_rtm_test void DESCRIPTION These family of functions implement support for restricted transactional memory, if available on…
NAME ck_pr_or_ptr ck_pr_or_char ck_pr_or_uint ck_pr_or_int ck_pr_or_64 ck_pr_or_32 ck_pr_or_16 ck_pr_or_8 – atomic bitwise-or operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_or_ptr void *target uintptr_t delta Ft void Fn ck_pr_or_char char *target char delta Ft void Fn ck_pr_or_uint unsigned int *target unsigned int delta Ft void Fn ck_pr_or_int int *target int delta…
NAME ck_pr_not_ptr ck_pr_not_double ck_pr_not_char ck_pr_not_uint ck_pr_not_int ck_pr_not_64 ck_pr_not_32 ck_pr_not_16 ck_pr_not_8 – atomic complement operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_not_ptr void *target Ft void Fn ck_pr_not_double double *target Ft void Fn ck_pr_not_char char *target Ft void Fn ck_pr_not_uint unsigned int *target Ft void Fn ck_pr_not_int int *target Ft void…
NAME ck_pr_neg_ptr ck_pr_neg_ptr_zero ck_pr_neg_double ck_pr_neg_double_zero ck_pr_neg_char ck_pr_neg_char_zero ck_pr_neg_uint ck_pr_neg_uint_zero ck_pr_neg_int ck_pr_neg_int_zero ck_pr_neg_64 ck_pr_neg_64_zero ck_pr_neg_32 ck_pr_neg_32_zero ck_pr_neg_16 ck_pr_neg_16_zero ck_pr_neg_8 ck_pr_neg_8_zero – atomic negation operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void Fn ck_pr_neg_ptr void *target Ft void Fn ck_pr_neg_ptr_zero void *target bool *z Ft void Fn ck_pr_neg_double double *target Ft void Fn ck_pr_neg_double_zero…
NAME ck_pr_load_ptr ck_pr_load_double ck_pr_load_uint ck_pr_load_int ck_pr_load_char ck_pr_load_64 ck_pr_load_32 ck_pr_load_16 ck_pr_load_8 – atomic volatile load operations LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_pr.h Ft void * Fn ck_pr_load_ptr const void *target Ft double Fn ck_pr_load_double const double *target Ft unsigned int Fn ck_pr_load_uint const unsigned int *target Ft int Fn ck_pr_load_int const int *target Ft…