View source for r7.0.0:Misc

{{DISPLAYTITLE:Misc}}
==Source Files==
 └───liblfds700
     ├───inc
     │   └───liblfds700
     │           lfds700_misc.h
     └───src
         └───lfds700_misc
                 lfds700_misc_cleanup.c
                 lfds700_misc_globals.c
                 lfds700_misc_init.c
                 lfds700_misc_prng.c
                 lfds700_misc_query.c

==Defines==
 #define [[r7.0.0:LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE|LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE]]
 #define [[r7.0.0:define LFDS700_MISC_PRNG_SEED|LFDS700_MISC_PRNG_SEED]]

==Enums==
 enum [[r7.0.0:enum lfds700_misc_cas_strength|lfds700_misc_cas_strength]]
 {
   LFDS700_MISC_CAS_STRENGTH_WEAK,
   LFDS700_MISC_CAS_STRENGTH_STRONG
 };
 
 enum [[r7.0.0:enum lfds700_misc_flag|lfds700_misc_flag]]
 {
   LFDS700_MISC_FLAG_LOWERED,
   LFDS700_MISC_FLAG_RAISED
 };
 
 enum [[r7.0.0:enum lfds700_misc_validity|lfds700_misc_validity]]
 {
   LFDS700_MISC_VALIDITY_VALID,
   LFDS700_MISC_VALIDITY_INVALID_LOOP,
   LFDS700_MISC_VALIDITY_INVALID_MISSING_ELEMENTS,
   LFDS700_MISC_VALIDITY_INVALID_ADDITIONAL_ELEMENTS,
   LFDS700_MISC_VALIDITY_INVALID_TEST_DATA,
   LFDS700_MISC_VALIDITY_INVALID_ORDER
 };
 
 enum [[r7.0.0:enum lfds700_misc_query|lfds700_misc_query]]
 {
   LFDS700_MISC_QUERY_GET_EXPONENTIAL_BACKOFF_TIMESLOT_LENGTH_IN_LOOP_ITERATIONS_FOR_CAS,
   LFDS700_MISC_QUERY_SET_EXPONENTIAL_BACKOFF_TIMESLOT_LENGTH_IN_LOOP_ITERATIONS_FOR_CAS,
   LFDS700_MISC_QUERY_GET_EXPONENTIAL_BACKOFF_TIMESLOT_LENGTH_IN_LOOP_ITERATIONS_FOR_DWCAS,
   LFDS700_MISC_QUERY_SET_EXPONENTIAL_BACKOFF_TIMESLOT_LENGTH_IN_LOOP_ITERATIONS_FOR_DWCAS,
   LFDS700_MISC_QUERY_GET_BUILD_AND_VERSION_STRING
 };

==Structures==
 struct [[r7.0.0:struct lfds700_misc_validation_info|lfds700_misc_validation_info]]
 {
   lfds700_pal_uint_t
     min_elements,
     max_elements;
 };

==Opaque Structures==
 struct [[r7.0.0:struct lfds700_misc_prng_state|lfds700_misc_prng_state]];

==Prototypes==
 void [[r7.0.0:function lfds700_misc_library_init_valid_on_current_logical_core|lfds700_misc_library_init_valid_on_current_logical_core]]( void );
 
 void [[r7.0.0:function lfds700_misc_library_cleanup|lfds700_misc_library_cleanup]]( void );
 
 void [[r7.0.0:function lfds700_misc_prng_init|lfds700_misc_prng_init]]( struct lfds700_misc_prng_state *ps );
 
 void [[r7.0.0:function lfds700_misc_query|lfds700_misc_query]]( enum lfds700_misc_query query_type, void *query_input, void *query_output );

==Overview==
This API is not a data structure but rather a set of support functions, for initiaizing and cleaning up the library, and for random number generation (which is vital for dealing with live-lock).

==Lock-free Specific Behaviour==
The state initialization function, ''lfds700_misc_library_init_valid_on_current_logical_core'', as the same suggests, initializes the state structure but that initialization is only valid on the current logical core.  For the initialization to be valid on other logical cores (i.e. other threads where they are running on other logical cores) those other threads need to call the long-windedly named macro ''[[r7.0.0:define LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE|LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE]]'', which will do that which its name suggests.

==See Also==
* [[r7.0.0:Release_7.0.0_Documentation|Release 7.0.0 Documentation]]