src/svm/svm_fifo.h

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_ssvm_fifo_h__
  16 #define __included_ssvm_fifo_h__
  17
  18 #include <vppinfra/clib.h>
  19 #include <vppinfra/vec.h>
  20 #include <vppinfra/mheap.h>
  21 #include <vppinfra/heap.h>
  22 #include <vppinfra/pool.h>
  23 #include <vppinfra/format.h>
  24 #include <pthread.h>
  25
  26 /** Out-of-order segment */
  27 typedef struct
  28 {
  29   u32 next;     /**< Next linked-list element pool index */
  30   u32 prev;     /**< Previous linked-list element pool index */
  31
  32   u32 start;    /**< Start of segment, normalized*/
  33   u32 length;   /**< Length of segment */
  34 } ooo_segment_t;
  35
  36 format_function_t format_ooo_segment;
  37 format_function_t format_ooo_list;
  38
  39 #define SVM_FIFO_TRACE (0)
  40 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
  41
  42 typedef struct
  43 {
  44   u32 offset;
  45   u32 len;
  46   u32 action;
  47 } svm_fifo_trace_elem_t;
  48
  49 typedef struct _svm_fifo
  50 {
  51   volatile u32 cursize;         /**< current fifo size */
  52   u32 nitems;
  53     CLIB_CACHE_LINE_ALIGN_MARK (end_cursize);
  54
  55   volatile u32 has_event;       /**< non-zero if deq event exists */
  56
  57   /* Backpointers */
  58   u32 master_session_index;
  59   u32 client_session_index;
  60   u8 master_thread_index;
  61   u8 client_thread_index;
  62   u32 segment_manager;
  63     CLIB_CACHE_LINE_ALIGN_MARK (end_shared);
  64   u32 head;
  65     CLIB_CACHE_LINE_ALIGN_MARK (end_consumer);
  66
  67   /* producer */
  68   u32 tail;
  69
  70   ooo_segment_t *ooo_segments;  /**< Pool of ooo segments */
  71   u32 ooos_list_head;           /**< Head of out-of-order linked-list */
  72   u32 ooos_newest;              /**< Last segment to have been updated */
  73   struct _svm_fifo *next;       /**< next in freelist/active chain */
  74   struct _svm_fifo *prev;       /**< prev in active chain */
  75 #if SVM_FIFO_TRACE
  76   svm_fifo_trace_elem_t *trace;
  77 #endif
  78   u32 freelist_index;           /**< aka log2(allocated_size) - const. */
  79   i8 refcnt;                    /**< reference count  */
  80     CLIB_CACHE_LINE_ALIGN_MARK (data);
  81 } svm_fifo_t;
  82
  83 typedef enum
  84 {
  85   SVM_FIFO_FULL = -2,
  86 } svm_fifo_err_t;
  87
  88 #if SVM_FIFO_TRACE
  89 #define svm_fifo_trace_add(_f, _s, _l, _t)              \
  90 {                                                       \
  91   svm_fifo_trace_elem_t *trace_elt;                     \
  92   vec_add2(_f->trace, trace_elt, 1);                    \
  93   trace_elt->offset = _s;                               \
  94   trace_elt->len = _l;                                  \
  95   trace_elt->action = _t;                               \
  96 }
  97 #else
  98 #define svm_fifo_trace_add(_f, _s, _l, _t)
  99 #endif
 100
 101 u8 *svm_fifo_dump_trace (u8 * s, svm_fifo_t * f);
 102 u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
 103
 104 static inline u32
 105 svm_fifo_max_dequeue (svm_fifo_t * f)
 106 {
 107   return f->cursize;
 108 }
 109
 110 static inline int
 111 svm_fifo_is_full (svm_fifo_t * f)
 112 {
 113   return (f->cursize == f->nitems);
 114 }
 115
 116 static inline int
 117 svm_fifo_is_empty (svm_fifo_t * f)
 118 {
 119   return (f->cursize == 0);
 120 }
 121
 122 static inline u32
 123 svm_fifo_max_enqueue (svm_fifo_t * f)
 124 {
 125   return f->nitems - svm_fifo_max_dequeue (f);
 126 }
 127
 128 static inline int
 129 svm_fifo_has_event (svm_fifo_t * f)
 130 {
 131   return f->has_event;
 132 }
 133
 134 static inline u8
 135 svm_fifo_has_ooo_data (svm_fifo_t * f)
 136 {
 137   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 138 }
 139
 140 /**
 141  * Sets fifo event flag.
 142  *
 143  * @return 1 if flag was not set.
 144  */
 145 always_inline u8
 146 svm_fifo_set_event (svm_fifo_t * f)
 147 {
 148   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 149   return __sync_lock_test_and_set (&f->has_event, 1) == 0;
 150 }
 151
 152 /**
 153  * Unsets fifo event flag.
 154  */
 155 always_inline void
 156 svm_fifo_unset_event (svm_fifo_t * f)
 157 {
 158   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 159   __sync_lock_release (&f->has_event);
 160 }
 161
 162 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 163 void svm_fifo_free (svm_fifo_t * f);
 164
 165 int svm_fifo_enqueue_nowait (svm_fifo_t * f, u32 max_bytes,
 166                              const u8 * copy_from_here);
 167 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset,
 168                                   u32 required_bytes, u8 * copy_from_here);
 169 int svm_fifo_dequeue_nowait (svm_fifo_t * f, u32 max_bytes, u8 * copy_here);
 170
 171 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 max_bytes, u8 * copy_here);
 172 int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 max_bytes);
 173 void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
 174 u32 svm_fifo_number_ooo_segments (svm_fifo_t * f);
 175 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
 176 void svm_fifo_init_pointers (svm_fifo_t * f, u32 pointer);
 177 void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * data, u32 len);
 178
 179 format_function_t format_svm_fifo;
 180
 181 always_inline ooo_segment_t *
 182 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 183 {
 184   if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
 185     return 0;
 186   return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
 187 }
 188
 189 always_inline void
 190 svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
 191 {
 192   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 193 }
 194
 195 /**
 196  * Max contiguous chunk of data that can be read
 197  */
 198 always_inline u32
 199 svm_fifo_max_read_chunk (svm_fifo_t * f)
 200 {
 201   return ((f->tail > f->head) ? (f->tail - f->head) : (f->nitems - f->head));
 202 }
 203
 204 /**
 205  * Max contiguous chunk of data that can be written
 206  */
 207 always_inline u32
 208 svm_fifo_max_write_chunk (svm_fifo_t * f)
 209 {
 210   return ((f->tail >= f->head) ? (f->nitems - f->tail) : (f->head - f->tail));
 211 }
 212
 213 /**
 214  * Advance tail pointer
 215  *
 216  * Useful for moving tail pointer after external enqueue.
 217  */
 218 always_inline void
 219 svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 bytes)
 220 {
 221   ASSERT (bytes <= svm_fifo_max_enqueue (f));
 222   f->tail = (f->tail + bytes) % f->nitems;
 223   f->cursize += bytes;
 224 }
 225
 226 always_inline u8 *
 227 svm_fifo_head (svm_fifo_t * f)
 228 {
 229   return (f->data + f->head);
 230 }
 231
 232 always_inline u8 *
 233 svm_fifo_tail (svm_fifo_t * f)
 234 {
 235   return (f->data + f->tail);
 236 }
 237
 238 always_inline u32
 239 ooo_segment_distance_from_tail (svm_fifo_t * f, u32 pos)
 240 {
 241   /* Ambiguous. Assumption is that ooo segments don't touch tail */
 242   if (PREDICT_FALSE (pos == f->tail && f->tail == f->head))
 243     return f->nitems;
 244
 245   return (((f->nitems + pos) - f->tail) % f->nitems);
 246 }
 247
 248 always_inline u32
 249 ooo_segment_distance_to_tail (svm_fifo_t * f, u32 pos)
 250 {
 251   return (((f->nitems + f->tail) - pos) % f->nitems);
 252 }
 253
 254 always_inline u32
 255 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 256 {
 257   return ooo_segment_distance_from_tail (f, s->start);
 258 }
 259
 260 always_inline u32
 261 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 262 {
 263   return ooo_segment_distance_from_tail (f, s->start) + s->length;
 264 }
 265
 266 always_inline u32
 267 ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
 268 {
 269   return s->length;
 270 }
 271
 272 always_inline ooo_segment_t *
 273 ooo_segment_get_prev (svm_fifo_t * f, ooo_segment_t * s)
 274 {
 275   if (s->prev == OOO_SEGMENT_INVALID_INDEX)
 276     return 0;
 277   return pool_elt_at_index (f->ooo_segments, s->prev);
 278 }
 279
 280 always_inline ooo_segment_t *
 281 ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
 282 {
 283   if (s->next == OOO_SEGMENT_INVALID_INDEX)
 284     return 0;
 285   return pool_elt_at_index (f->ooo_segments, s->next);
 286 }
 287
 288 #endif /* __included_ssvm_fifo_h__ */
 289
 290 /*
 291  * fd.io coding-style-patch-verification: ON
 292  *
 293  * Local Variables:
 294  * eval: (c-set-style "gnu")
 295  * End:
 296  */