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

   1 /***** enums *****/
   2 #define LFDS710_RINGBUFFER_GET_USER_STATE_FROM_STATE( ringbuffer_state )  ( (ringbuffer_state).user_state )
   3
   4 /***** enums *****/
   5 enum lfds710_ringbuffer_query
   6 {
   7   LFDS710_RINGBUFFER_QUERY_SINGLETHREADED_GET_COUNT,
   8   LFDS710_RINGBUFFER_QUERY_SINGLETHREADED_VALIDATE
   9 };
  10
  11 /***** structures *****/
  12 struct lfds710_ringbuffer_element
  13 {
  14   struct lfds710_freelist_element
  15     fe;
  16
  17   struct lfds710_queue_umm_element
  18     qumme;
  19
  20   struct lfds710_queue_umm_element
  21     *qumme_use; // TRD : hack; we need a new queue with no dummy element
  22
  23   void
  24     *key,
  25     *value;
  26 };
  27
  28 struct lfds710_ringbuffer_state
  29 {
  30   struct lfds710_freelist_state
  31     fs;
  32
  33   struct lfds710_queue_umm_state
  34     qumms;
  35
  36   void
  37     (*element_cleanup_callback)( struct lfds710_ringbuffer_state *rs, void *key, void *value, enum lfds710_misc_flag unread_flag ),
  38     *user_state;
  39 };
  40
  41 /***** public prototypes *****/
  42 void lfds710_ringbuffer_init_valid_on_current_logical_core( struct lfds710_ringbuffer_state *rs,
  43                                                             struct lfds710_ringbuffer_element *re_array_inc_dummy,
  44                                                             lfds710_pal_uint_t number_elements_inc_dummy,
  45                                                             void *user_state );
  46   // TRD : used in conjunction with the #define LFDS710_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE
  47
  48 void lfds710_ringbuffer_cleanup( struct lfds710_ringbuffer_state *rs,
  49                                  void (*element_cleanup_callback)(struct lfds710_ringbuffer_state *rs, void *key, void *value, enum lfds710_misc_flag unread_flag) );
  50
  51 int lfds710_ringbuffer_read( struct lfds710_ringbuffer_state *rs,
  52                              void **key,
  53                              void **value );
  54
  55 void lfds710_ringbuffer_write( struct lfds710_ringbuffer_state *rs,
  56                                void *key,
  57                                void *value,
  58                                enum lfds710_misc_flag *overwrite_occurred_flag,
  59                                void **overwritten_key,
  60                                void **overwritten_value );
  61
  62 void lfds710_ringbuffer_query( struct lfds710_ringbuffer_state *rs,
  63                                enum lfds710_ringbuffer_query query_type,
  64                                void *query_input,
  65                                void *query_output );
  66