Section 3: library functions
NAME ck_hs_next – iterate to next entry in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_next ck_hs_t *hs ck_hs_iterator_t *iterator void **entry DESCRIPTION The Fn ck_hs_next 3 function will increment the iterator object pointed to by Fa iterator to point to the next non-empty hash set entry. If Fn…
NAME ck_hs_move – move one from hash set to another LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_move ck_hs_t *destination ck_hs_t *source ck_hs_hash_cb_t *hash_cb ck_hs_compare_cb_t *compare_cb struct ck_malloc *m DESCRIPTION The Fn ck_hs_move 3 function will initialize Fa source from Fa destination . The hash function is set to Fa hash_cb…
NAME ck_hs_iterator_init – initialize hash set iterator LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h ck_hs_iterator_t iterator = CK_HS_ITERATOR_INITIALIZER Ft void Fn ck_hs_iterator_init ck_hs_iterator_t *iterator DESCRIPTION The Fn ck_hs_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_HS_ITERATOR_INITIALIZER…
NAME ck_hs_init – initialize a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft typedef unsigned long Fn ck_hs_hash_cb_t const void *key unsigned long seed Ft typedef bool Fn ck_hs_compare_cb_t const void *c1 const void *c2 Ft bool Fn ck_hs_init ck_hs_t *hs unsigned int mode ck_hs_hash_cb_t *hash_function ck_hs_compare_cb_t *compare struct ck_malloc *allocator unsigned…
NAME ck_hs_grow – enlarge hash set capacity LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_grow ck_hs_t *hs unsigned long capacity DESCRIPTION The Fn ck_hs_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_hs_get – load a key from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft void * Fn ck_hs_get ck_hs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_hs_get 3 function will return a pointer to a key in the hash set Fa hs that is of equivalent value…
NAME ck_hs_gc – perform maintenance on a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_gc ck_hs_t *hs unsigned long cycles unsigned long seed DESCRIPTION The Fn ck_hs_gc 3 function will perform various maintenance routines on the hash set pointed to by Fa hs , including defragmentation of probe sequences…
NAME ck_hs_fas – fetch and store key in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_fas ck_hs_t *hs unsigned long hash const void *key void **previous DESCRIPTION The Fn ck_hs_fas 3 function will fetch and store the key specified by the Fa key argument in the hash set pointed…
NAME ck_hs_destroy – destroy hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft void Fn ck_hs_destroy ck_hs_t *hs DESCRIPTION The Fn ck_hs_destroy 3 function will request that the underlying allocator, as specified by the ck_hs_init3 function, immediately destroy the object pointed to by the Fa hs argument. The user must guarantee that no…
NAME ck_hs_count – returns number of entries in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft unsigned long Fn ck_hs_count ck_hs_t *hs DESCRIPTION The Fn ck_hs_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_hs_apply – apply a function to hash set value LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft void * Fn ck_hs_apply_fn_t void *key void *closure Ft bool Fn ck_hs_apply ck_hs_t *hs unsigned long hash const void *key ck_hs_apply_fn_t *function void *argument DESCRIPTION The Fn ck_hs_apply 3 function will lookup the hash set slot…
NAME ck_epoch_unregister – unregister a thread for epoch reclamation LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_unregister ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_unregister 3 function allows for the record pointed by the Fa record pointer to be used as a return value by the Fn ck_epoch_recycle 3 function. This record can…
NAME ck_epoch_synchronize – block until a grace period has been detected LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_synchronize ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_synchronize 3 function will block the caller until a grace period has been detected, according to the semantics of epoch reclamation. Any objects requiring safe memory reclamation…
NAME ck_epoch_register – register a thread for epoch reclamation LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_register ck_epoch_t *epoch ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_register 3 function associates a record object specified by the Fa record pointer with the epoch object pointed to by Fa epoch . Any thread or processor…
NAME ck_epoch_recycle – return an epoch record that may be used by caller LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft ck_epoch_record_t * Fn ck_epoch_recycle ck_epoch_t *epoch DESCRIPTION The Fn ck_epoch_recycle 3 function attempts to return an unused epoch record object for use by the caller. These epoch records were associated with previous calls…
NAME ck_epoch_reclaim – immediately execute all deferred callbacks LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_reclaim ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_reclaim 3 function will unconditionally execute all callbacks that have been deferred with Fn ck_epoch_call 3 . EXAMPLE #include <ck_epoch.h> #include <ck_stack.h> #include <stdlib.h> /* * epoch was previously initialized…
NAME ck_epoch_poll – non-blocking poll of epoch object for dispatch cycles LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft bool Fn ck_epoch_poll ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_poll 3 function will attempt to dispatch any functions associated with the object pointed to by Fa epoch via Fn ck_epoch_call 3 if deemed safe. This function…
NAME ck_epoch_init – initialize epoch reclamation object LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_init ck_epoch_t *epoch DESCRIPTION The Fn ck_epoch_init function initializes the epoch object pointed to by the Fa epoch pointer. RETURN VALUES This function has no return value. ERRORS The behavior of Fn ck_epoch_init is undefined if Fa…
NAME ck_epoch_end – end epoch-protected segment of execution LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_end ck_epoch_record_t *record ck_epoch_section_t *section DESCRIPTION The Fn ck_epoch_end 3 function will mark the end of an epoch-protected code section. Fa section must point to a section object initialized previously with Fn ck_epoch_begin 3 . RETURN…
NAME ck_epoch_call – defer function execution until a grace period LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h typedef struct ck_epoch_entry ck_epoch_entry_t; typedef void ck_epoch_cb_t(ck_epoch_entry_t *); Ft void Fn ck_epoch_call ck_epoch_record_t *record ck_epoch_entry_t *entry ck_epoch_cb_t *function DESCRIPTION The Fn ck_epoch_call 3 function will defer the execution of the function pointed to by Fa function until…