pd.if.org Git - liblfds/blob - liblfds/liblfds7.0.0/liblfds700/inc/liblfds700/lfds700_list_addonly_ordered_singlylinked.h

   1 /***** defines *****/
   2 #define LFDS700_LIST_AOS_GET_START( list_aos_state )                                             ( LFDS700_MISC_BARRIER_LOAD, (list_aos_state).start->next )
   3 #define LFDS700_LIST_AOS_GET_NEXT( list_aos_element )                                            ( LFDS700_MISC_BARRIER_LOAD, (list_aos_element).next )
   4 #define LFDS700_LIST_AOS_GET_START_AND_THEN_NEXT( list_aos_state, pointer_to_list_aos_element )  ( (pointer_to_list_aos_element) == NULL ? ( (pointer_to_list_aos_element) = LFDS700_LIST_AOS_GET_START(list_aos_state) ) : ( (pointer_to_list_aos_element) = LFDS700_LIST_AOS_GET_NEXT(*(pointer_to_list_aos_element)) ) )
   5 #define LFDS700_LIST_AOS_GET_KEY_FROM_ELEMENT( list_aos_element )                                ( (list_aos_element).key )
   6 #define LFDS700_LIST_AOS_SET_KEY_IN_ELEMENT( list_aos_element, new_key )                         ( (list_aos_element).key = (void *) (lfds700_pal_uint_t) (new_key) )
   7 #define LFDS700_LIST_AOS_GET_VALUE_FROM_ELEMENT( list_aos_element )                              ( LFDS700_MISC_BARRIER_LOAD, (list_aos_element).value )
   8 #define LFDS700_LIST_AOS_SET_VALUE_IN_ELEMENT( list_aos_element, new_value )                     { void *local_new_value = (void *) (lfds700_pal_uint_t) (new_value); LFDS700_PAL_ATOMIC_EXCHANGE( &(list_aos_element).value, &local_new_value ); }
   9 #define LFDS700_LIST_AOS_GET_USER_STATE_FROM_STATE( list_aos_state )                             ( (list_aos_state).user_state )
  10
  11 /***** enums *****/
  12 enum lfds700_list_aos_existing_key
  13 {
  14   LFDS700_LIST_AOS_EXISTING_KEY_OVERWRITE,
  15   LFDS700_LIST_AOS_EXISTING_KEY_FAIL
  16 };
  17
  18 enum lfds700_list_aos_insert_result
  19 {
  20   LFDS700_LIST_AOS_INSERT_RESULT_FAILURE_EXISTING_KEY,
  21   LFDS700_LIST_AOS_INSERT_RESULT_SUCCESS_OVERWRITE,
  22   LFDS700_LIST_AOS_INSERT_RESULT_SUCCESS
  23 };
  24
  25 enum lfds700_list_aos_query
  26 {
  27   LFDS700_LIST_AOS_QUERY_GET_POTENTIALLY_INACCURATE_COUNT,
  28   LFDS700_LIST_AOS_QUERY_SINGLETHREADED_VALIDATE
  29 };
  30
  31 /***** structures *****/
  32 struct lfds700_list_aos_element
  33 {
  34   struct lfds700_list_aos_element LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  35     *volatile next;
  36
  37   void LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  38     *volatile value;
  39
  40   void LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  41     *key;
  42 };
  43
  44 struct lfds700_list_aos_state
  45 {
  46   struct lfds700_list_aos_element LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  47     *volatile start;
  48
  49   struct lfds700_list_aos_element LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  50     dummy_element;
  51
  52   int LFDS700_PAL_ALIGN(LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES)
  53     (*key_compare_function)( void const *new_key, void const *existing_key );
  54
  55   enum lfds700_list_aos_existing_key
  56     existing_key;
  57
  58   void
  59     *user_state;
  60 };
  61
  62 /***** public prototypes *****/
  63 void lfds700_list_aos_init_valid_on_current_logical_core( struct lfds700_list_aos_state *laoss,
  64                                                           int (*key_compare_function)(void const *new_key, void const *existing_key),
  65                                                           enum lfds700_list_aos_existing_key existing_key,
  66                                                           void *user_state );
  67   // TRD : used in conjunction with the #define LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE
  68
  69 void lfds700_list_aos_cleanup( struct lfds700_list_aos_state *laoss,
  70                                void (*element_cleanup_callback)(struct lfds700_list_aos_state *laoss, struct lfds700_list_aos_element *laose) );
  71
  72 enum lfds700_list_aos_insert_result lfds700_list_aos_insert( struct lfds700_list_aos_state *laoss,
  73                                                              struct lfds700_list_aos_element *laose,
  74                                                              struct lfds700_list_aos_element **existing_laose,
  75                                                              struct lfds700_misc_prng_state *ps );
  76
  77 int lfds700_list_aos_get_by_key( struct lfds700_list_aos_state *laoss,
  78                                  void *key,
  79                                  struct lfds700_list_aos_element **laose );
  80
  81 void lfds700_list_aos_query( struct lfds700_list_aos_state *laoss,
  82                              enum lfds700_list_aos_query query_type,
  83                              void *query_input,
  84                              void *query_output );
  85