pd.if.org Git - liblfds/blob - liblfds/liblfds7.1.0/liblfds710/inc/liblfds710/lfds710_list_addonly_singlylinked_unordered.h

   1 /***** defines *****/
   2 #define LFDS710_LIST_ASU_GET_START( list_asu_state )                                             ( LFDS710_MISC_BARRIER_LOAD, (list_asu_state).start->next )
   3 #define LFDS710_LIST_ASU_GET_NEXT( list_asu_element )                                            ( LFDS710_MISC_BARRIER_LOAD, (list_asu_element).next )
   4 #define LFDS710_LIST_ASU_GET_START_AND_THEN_NEXT( list_asu_state, pointer_to_list_asu_element )  ( (pointer_to_list_asu_element) == NULL ? ( (pointer_to_list_asu_element) = LFDS710_LIST_ASU_GET_START(list_asu_state) ) : ( (pointer_to_list_asu_element) = LFDS710_LIST_ASU_GET_NEXT(*(pointer_to_list_asu_element)) ) )
   5 #define LFDS710_LIST_ASU_GET_KEY_FROM_ELEMENT( list_asu_element )                                ( (list_asu_element).key )
   6 #define LFDS710_LIST_ASU_SET_KEY_IN_ELEMENT( list_asu_element, new_key )                         ( (list_asu_element).key = (void *) (lfds710_pal_uint_t) (new_key) )
   7 #define LFDS710_LIST_ASU_GET_VALUE_FROM_ELEMENT( list_asu_element )                              ( LFDS710_MISC_BARRIER_LOAD, (list_asu_element).value )
   8 #define LFDS710_LIST_ASU_SET_VALUE_IN_ELEMENT( list_asu_element, new_value )                     { LFDS710_PAL_ATOMIC_SET( &(list_asu_element).value, new_value ); }
   9 #define LFDS710_LIST_ASU_GET_USER_STATE_FROM_STATE( list_asu_state )                             ( (list_asu_state).user_state )
  10
  11 /***** enums *****/
  12 enum lfds710_list_asu_position
  13 {
  14   LFDS710_LIST_ASU_POSITION_START,
  15   LFDS710_LIST_ASU_POSITION_END,
  16   LFDS710_LIST_ASU_POSITION_AFTER
  17 };
  18
  19 enum lfds710_list_asu_query
  20 {
  21   LFDS710_LIST_ASU_QUERY_GET_POTENTIALLY_INACCURATE_COUNT,
  22   LFDS710_LIST_ASU_QUERY_SINGLETHREADED_VALIDATE
  23 };
  24
  25 /***** structures *****/
  26 struct lfds710_list_asu_element
  27 {
  28   struct lfds710_list_asu_element LFDS710_PAL_ALIGN(LFDS710_PAL_ALIGN_SINGLE_POINTER)
  29     *volatile next;
  30
  31   void LFDS710_PAL_ALIGN(LFDS710_PAL_ALIGN_SINGLE_POINTER)
  32     *volatile value;
  33
  34   void
  35     *key;
  36 };
  37
  38 struct lfds710_list_asu_state
  39 {
  40   struct lfds710_list_asu_element LFDS710_PAL_ALIGN(LFDS710_PAL_ATOMIC_ISOLATION_IN_BYTES)
  41     dummy_element;
  42
  43   struct lfds710_list_asu_element LFDS710_PAL_ALIGN(LFDS710_PAL_ATOMIC_ISOLATION_IN_BYTES)
  44     *volatile end;
  45
  46   struct lfds710_list_asu_element LFDS710_PAL_ALIGN(LFDS710_PAL_ATOMIC_ISOLATION_IN_BYTES)
  47     *start;
  48
  49   void
  50     *user_state;
  51
  52   struct lfds710_misc_backoff_state
  53     after_backoff,
  54     end_backoff,
  55     start_backoff;
  56 };
  57
  58 /***** public prototypes *****/
  59 void lfds710_list_asu_init_valid_on_current_logical_core( struct lfds710_list_asu_state *lasus,
  60                                                           void *user_state );
  61   // TRD : used in conjunction with the #define LFDS710_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE
  62
  63 void lfds710_list_asu_cleanup( struct lfds710_list_asu_state *lasus,
  64                                void (*element_cleanup_callback)(struct lfds710_list_asu_state *lasus, struct lfds710_list_asu_element *lasue) );
  65
  66 void lfds710_list_asu_insert_at_position( struct lfds710_list_asu_state *lasus,
  67                                           struct lfds710_list_asu_element *lasue,
  68                                           struct lfds710_list_asu_element *lasue_predecessor,
  69                                           enum lfds710_list_asu_position position );
  70
  71 void lfds710_list_asu_insert_at_start( struct lfds710_list_asu_state *lasus,
  72                                        struct lfds710_list_asu_element *lasue );
  73
  74 void lfds710_list_asu_insert_at_end( struct lfds710_list_asu_state *lasus,
  75                                      struct lfds710_list_asu_element *lasue );
  76
  77 void lfds710_list_asu_insert_after_element( struct lfds710_list_asu_state *lasus,
  78                                             struct lfds710_list_asu_element *lasue,
  79                                             struct lfds710_list_asu_element *lasue_predecessor );
  80
  81 int lfds710_list_asu_get_by_key( struct lfds710_list_asu_state *lasus,
  82                                  int (*key_compare_function)(void const *new_key, void const *existing_key),
  83                                  void *key,
  84                                  struct lfds710_list_asu_element **lasue );
  85
  86 void lfds710_list_asu_query( struct lfds710_list_asu_state *lasus,
  87                              enum lfds710_list_asu_query query_type,
  88                              void *query_input,
  89                              void *query_output );
  90