TABLE OF CONTENTS

1. Component Library: Spinlock/cl_spinlock_acquire
2. Component Library: Spinlock/cl_spinlock_construct
3. Component Library: Spinlock/cl_spinlock_destroy
4. Component Library: Spinlock/cl_spinlock_init
5. Component Library: Spinlock/cl_spinlock_release
6. Public/Spinlock

Component Library: Spinlock/cl_spinlock_acquire

    cl_spinlock_acquire

    The cl_spinlock_acquire function acquires a spin lock.

void
cl_spinlock_acquire( 
    IN  cl_spinlock_t* const    p_spinlock );

    p_spin_lock 
        [in] Pointer to a spin lock structure to acquire.

    This function does not return a value.

    Spinlock, cl_spin_lock_release

Component Library: Spinlock/cl_spinlock_construct

    cl_spinlock_construct

    The cl_spinlock_construct function initializes the state of a 
    spin lock.

void
cl_spinlock_construct( 
    IN  cl_spinlock_t* const    p_spinlock );

    p_spin_lock 
        [in] Pointer to a spin lock structure whose state to initialize.

    This function does not return a value.

    Allows calling cl_spin_lock_destroy without first calling 
    cl_spin_lock_init.

    Calling cl_spinlock_construct is a prerequisite to calling any other
    spin lock function except cl_spinlock_init.

    Spinlock, cl_spin_lock_init, cl_spin_lock_destroy

Component Library: Spinlock/cl_spinlock_destroy

    cl_spinlock_destroy

    The cl_spinlock_destroy function performs all necessary cleanup of a 
    spin lock.

void
cl_spinlock_destroy( 
    IN  cl_spinlock_t* const    p_spinlock );

    p_spin_lock 
        [in] Pointer to a spin lock structure to destroy.

    This function does not return a value.

    Performs any necessary cleanup of a spin lock. This function must only 
    be called if either cl_spin_lock_construct or cl_spin_lock_init has been 
    called.

    Spinlock, cl_spin_lock_construct, cl_spin_lock_init

Component Library: Spinlock/cl_spinlock_init

    cl_spinlock_init

    The cl_spin_lock_init function initializes a spin lock for use.

cl_status_t
cl_spinlock_init( 
    IN  cl_spinlock_t* const    p_spinlock );

    p_spin_lock 
        [in] Pointer to a spin lock structure to initialize.

    CL_SUCCESS if initialization succeeded.

    CL_ERROR if initialization failed. Callers should call 
    cl_spin_lock_destroy to clean up any resources allocated during 
    initialization.

    Initialize the spin lock structure. Allows calling cl_spin_lock_aquire 
    and cl_spin_lock_release.

    Spinlock, cl_spin_lock_construct, cl_spin_lock_destroy, 
    cl_spin_lock_acquire, cl_spin_lock_release

Component Library: Spinlock/cl_spinlock_release

    cl_spinlock_release

    The cl_spinlock_release function releases a spin lock object.

void
cl_spinlock_release(
    IN  cl_spinlock_t* const    p_spinlock );

    p_spin_lock 
        [in] Pointer to a spin lock structure to release.

    This function does not return a value.

    Releases a spin lock after a call to cl_spinlock_acquire.

    Spinlock, cl_spin_lock_acquire

Public/Spinlock

    Spinlock

    Spinlock provides synchronization between threads for exclusive access to 
    a resource.

    The spinlock functions manipulate a cl_spinlock_t structure which should 
    be treated as opaque and should be manipulated only through the provided 
    functions.

    Structures:
        cl_spinlock_t

    Initialization:
        cl_spinlock_construct, cl_spinlock_init, cl_spinlock_destroy

    Manipulation
        cl_spinlock_acquire, cl_spinlock_release