Section 3: library functions
NAME ck_epoch_begin – begin epoch-protected segment of execution LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_begin ck_epoch_record_t *record ck_epoch_section_t *section DESCRIPTION The Fn ck_epoch_begin 3 function will mark the beginning of an epoch-protected code section. An epoch-protected code section is delimited by a call to the Fn ck_epoch_end 3 function. Though…
NAME ck_epoch_barrier – block until a grace period and all callbacks have been dispatched LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_epoch.h Ft void Fn ck_epoch_barrier ck_epoch_record_t *record DESCRIPTION The Fn ck_epoch_barrier 3 function will block the caller until a grace period has been detected, according to the semantics of epoch reclamation. Any objects requiring…
NAME CK_ELIDE_PROTOTYPE CK_ELIDE_LOCK_ADAPTIVE CK_ELIDE_UNLOCK_ADAPTIVE CK_ELIDE_LOCK CK_ELIDE_UNLOCK CK_ELIDE_TRYLOCK_PROTOTYPE CK_ELIDE_TRYLOCK – lock elision wrappers LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_elide.h ck_elide_stat_t stat = CK_ELIDE_STAT_INITIALIZER; Ft void Fn ck_elide_stat_init ck_elide_stat_t * struct ck_elide_config config = CK_ELIDE_CONFIG_DEFAULT_INITIALIZER; struct ck_elide_config { unsigned short skip_busy; short retry_busy; unsigned short skip_other; short retry_other; unsigned short skip_conflict; short retry_conflict; }; Fn…
NAME ck_cohort – generalized interface for lock cohorts LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_cohort.h Fn CK_COHORT_PROTOTYPE COHORT_NAME cohort_name LOCK_FXN global_lock_method LOCK_FXN global_unlock_method LOCK_FXN local_lock_method LOCK_FXN local_unlock_method Fn CK_COHORT_TRYLOCK_PROTOTYPE COHORT_NAME cohort_name LOCK_FXN global_lock_method LOCK_FXN global_unlock_method BOOL_LOCK_FXN global_locked_method BOOL_LOCK_FXN global_trylock_method LOCK_FXN local_lock_method LOCK_FXN local_unlock_method BOOL_LOCK_FXN local_locked_method BOOL_LOCK_FXN local_trylock_method Fn CK_COHORT_INSTANCE COHORT_NAME cohort_name Fn CK_COHORT_INIT COHORT_NAME…
NAME ck_brlock_init ck_brlock_write_lock ck_brlock_write_unlock ck_brlock_write_trylock ck_brlock_read_register ck_brlock_read_unregister ck_brlock_read_lock ck_brlock_read_trylock ck_brlock_read_unlock – big-reader locks LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_brlock.h ck_brlock_t brlock = CK_BRLOCK_INITIALIZER; ck_brlock_reader_t reader = CK_BRLOCK_READER_INITIALIZER; Ft void Fn ck_brlock_init ck_brlock_t *br Ft void Fn ck_brlock_write_lock ck_brlock_t *br Ft void Fn ck_brlock_write_unlock ck_brlock_t *br Ft bool Fn ck_brlock_write_trylock ck_brlock_t *br unsigned int…
NAME ck_bitmap_union – generates union of two bitmaps LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void Fn ck_bitmap_union ck_bitmap_t *dst ck_bitmap_t *src DESCRIPTION The Fn ck_bitmap_union function sets all bits in the bitmap pointed to by Fa src in the bitmap pointed to by Fa dst . RETURN VALUES This function has no…
NAME ck_bitmap_test – determine if the bit at the specified index is set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft bool Fn ck_bitmap_test ck_bitmap_t *bitmap unsigned int n DESCRIPTION The Fn ck_bitmap_test determines if the bit at the offset specified by the argument Fa n is set to 1 RETURN VALUES This function…
NAME ck_bitmap_size – returns necessary number of bytes for bitmap LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft unsigned int Fn ck_bitmap_size unsigned int n_bits DESCRIPTION The Fn ck_bitmap_size function returns the number of bytes that are necessary to allocate for a bitmap that will contain the number of bits specified by Fa n_bits…
NAME ck_bitmap_set – set the bit at the specified index LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void Fn ck_bitmap_set ck_bitmap_t *bitmap unsigned int n DESCRIPTION The Fn ck_bitmap_set sets the bit at offset specified by the argument Fa n to 1 RETURN VALUES This function has no return value. SEE ALSO ck_bitmap_base3,…
NAME ck_bitmap_reset – resets the bit at the specified index LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void Fn ck_bitmap_reset ck_bitmap_t *bitmap unsigned int n DESCRIPTION The Fn ck_bitmap_reset resets the bit at offset specified by the argument Fa n to 0 RETURN VALUES This function has no return value. SEE ALSO ck_bitmap_base3,…
NAME ck_bitmap_next – iterate to the next set bit in bitmap LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft bool Fn ck_bitmap_next ck_bitmap_t *bitmap ck_bitmap_iterator_t iterator unsigned int *bit DESCRIPTION The Fn ck_bitmap_next function will increment the iterator object pointed to by Fa iterator to point to the next set bit in the bitmap….
NAME ck_bitmap_iterator_init – initialize bitmap iterator LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_bitmap_iterator_init ck_bitmap_iterator_t *iterator ck_bitmap_t *bitmap DESCRIPTION The Fn ck_bitmap_iterator_init function will initialize the object pointed to by the Fa iterator argument for use with Fa bitmap . An iterator is used to iterate through set bitmap bits with…
NAME ck_bitmap_init – initialize a bitmap LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void Fn ck_bitmap_init ck_bitmap_t *bitmap unsigned int n_bits bool set DESCRIPTION The Fn ck_bitmap_init function initializes the bitmap pointed to by the Fa bitmap pointer. The argument Fa n_bits specifies the number of bits that are to be stored in…
NAME ck_bitmap_clear – reset all bits LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void Fn ck_bitmap_clear ck_bitmap_t *bitmap DESCRIPTION The Fn ck_bitmap_clear function sets all bits in the bitmap pointed to by Fa bitmap to 0. RETURN VALUES This function has no return value. SEE ALSO ck_bitmap_base3, ck_bitmap_size3, ck_bitmap_init3, ck_bitmap_set3, ck_bitmap_reset3, ck_bitmap_test3, ck_bitmap_bits3,…
NAME ck_bitmap_buffer – returns pointer to bit array LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft void * Fn ck_bitmap_buffer ck_bitmap_t *bitmap DESCRIPTION The Fn ck_bitmap_buffer functions returns a pointer to the actual bit array. For ck_bitmap pointers, the bit array is of type CK_BITMAP_WORD[] and consists of ck_bitmap_base(bitmap) / sizeof(CK_BITMAP_WORD) elements. On currently…
NAME ck_bitmap_bts – set the bit at the specified index and fetch its original value LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft bool Fn ck_bitmap_bts ck_bitmap_t *bitmap unsigned int n DESCRIPTION Fn ck_bitmap_bts sets the bit at the offset specified by the argument Fa n to 1 and fetches its original value. RETURN…
NAME ck_bitmap_bits – return number of addressable bits in bitmap LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft unsigned int Fn ck_bitmap_bits ck_bitmap_t *bitmap DESCRIPTION The Fn ck_bitmap_bits function returns the maximum number of addressable bits in the object pointed to by Fa bitmap . RETURN VALUES This function returns a non-zero value. SEE…
NAME ck_bitmap_base – determine the size of a bit array in bytes LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_bitmap.h Ft unsigned int Fn ck_bitmap_base unsigned int n_bits DESCRIPTION The Fn ck_bitmap_base function returns the number of bytes that would be used to store the number of bits specified by Fa n_bits . RETURN VALUES…
NAME ck_array_remove – attempt immediate or deferred removal of a pointer from an array LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_array.h Ft bool Fn ck_array_remove ck_array_t *array void *pointer DESCRIPTION The Fn ck_array_remove 3 function will attempt to remove the value of Fa pointer into the array pointed to by Fa array . The…
NAME ck_array_put_unique – attempt immediate or deferred insertion of a unique pointer into array LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_array.h Ft int Fn ck_array_put_unique ck_array_t *array void *pointer DESCRIPTION The Fn ck_array_put_unique 3 function will attempt to insert the value of Fa pointer into the array pointed to by Fa array . This…