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   volatile u32 want_tx_evt;     /**< producer wants nudge */
  66     CLIB_CACHE_LINE_ALIGN_MARK (end_consumer);
  67
  68   /* producer */
  69   u32 tail;
  70
  71   ooo_segment_t *ooo_segments;  /**< Pool of ooo segments */
  72   u32 ooos_list_head;           /**< Head of out-of-order linked-list */
  73   u32 ooos_newest;              /**< Last segment to have been updated */
  74   struct _svm_fifo *next;       /**< next in freelist/active chain */
  75   struct _svm_fifo *prev;       /**< prev in active chain */
  76 #if SVM_FIFO_TRACE
  77   svm_fifo_trace_elem_t *trace;
  78 #endif
  79   u32 freelist_index;           /**< aka log2(allocated_size) - const. */
  80   i8 refcnt;                    /**< reference count  */
  81     CLIB_CACHE_LINE_ALIGN_MARK (data);
  82 } svm_fifo_t;
  83
  84 typedef enum
  85 {
  86   SVM_FIFO_FULL = -2,
  87 } svm_fifo_err_t;
  88
  89 typedef struct svm_fifo_segment_
  90 {
  91   u8 *data;
  92   u32 len;
  93 } svm_fifo_segment_t;
  94
  95 #if SVM_FIFO_TRACE
  96 #define svm_fifo_trace_add(_f, _s, _l, _t)              \
  97 {                                                       \
  98   svm_fifo_trace_elem_t *trace_elt;                     \
  99   vec_add2(_f->trace, trace_elt, 1);                    \
 100   trace_elt->offset = _s;                               \
 101   trace_elt->len = _l;                                  \
 102   trace_elt->action = _t;                               \
 103 }
 104 #else
 105 #define svm_fifo_trace_add(_f, _s, _l, _t)
 106 #endif
 107
 108 u8 *svm_fifo_dump_trace (u8 * s, svm_fifo_t * f);
 109 u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
 110
 111 static inline u32
 112 svm_fifo_max_dequeue (svm_fifo_t * f)
 113 {
 114   return f->cursize;
 115 }
 116
 117 static inline int
 118 svm_fifo_is_full (svm_fifo_t * f)
 119 {
 120   return (f->cursize == f->nitems);
 121 }
 122
 123 static inline int
 124 svm_fifo_is_empty (svm_fifo_t * f)
 125 {
 126   return (f->cursize == 0);
 127 }
 128
 129 static inline u32
 130 svm_fifo_max_enqueue (svm_fifo_t * f)
 131 {
 132   return f->nitems - svm_fifo_max_dequeue (f);
 133 }
 134
 135 static inline int
 136 svm_fifo_has_event (svm_fifo_t * f)
 137 {
 138   return f->has_event;
 139 }
 140
 141 static inline u8
 142 svm_fifo_has_ooo_data (svm_fifo_t * f)
 143 {
 144   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 145 }
 146
 147 /**
 148  * Sets fifo event flag.
 149  *
 150  * Also acts as a release barrier.
 151  *
 152  * @return 1 if flag was not set.
 153  */
 154 always_inline u8
 155 svm_fifo_set_event (svm_fifo_t * f)
 156 {
 157   /* return __sync_lock_test_and_set (&f->has_event, 1) == 0;
 158      return __sync_bool_compare_and_swap (&f->has_event, 0, 1); */
 159   return !__atomic_exchange_n (&f->has_event, 1, __ATOMIC_RELEASE);
 160 }
 161
 162 /**
 163  * Unsets fifo event flag.
 164  *
 165  * Also acts as a release barrier.
 166  */
 167 always_inline void
 168 svm_fifo_unset_event (svm_fifo_t * f)
 169 {
 170   __sync_lock_release (&f->has_event);
 171 }
 172
 173 static inline void
 174 svm_fifo_set_want_tx_evt (svm_fifo_t * f, u8 want_evt)
 175 {
 176   f->want_tx_evt = want_evt;
 177 }
 178
 179 static inline u8
 180 svm_fifo_want_tx_evt (svm_fifo_t * f)
 181 {
 182   return f->want_tx_evt;
 183 }
 184
 185 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 186 void svm_fifo_free (svm_fifo_t * f);
 187
 188 int svm_fifo_enqueue_nowait (svm_fifo_t * f, u32 max_bytes,
 189                              const u8 * copy_from_here);
 190 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset,
 191                                   u32 required_bytes, u8 * copy_from_here);
 192 int svm_fifo_dequeue_nowait (svm_fifo_t * f, u32 max_bytes, u8 * copy_here);
 193
 194 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 max_bytes, u8 * copy_here);
 195 int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 max_bytes);
 196 void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
 197 int svm_fifo_segments (svm_fifo_t * f, svm_fifo_segment_t * fs);
 198 void svm_fifo_segments_free (svm_fifo_t * f, svm_fifo_segment_t * fs);
 199 u32 svm_fifo_number_ooo_segments (svm_fifo_t * f);
 200 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
 201 void svm_fifo_init_pointers (svm_fifo_t * f, u32 pointer);
 202 void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * data, u32 len);
 203
 204 format_function_t format_svm_fifo;
 205
 206 always_inline ooo_segment_t *
 207 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 208 {
 209   if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
 210     return 0;
 211   return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
 212 }
 213
 214 always_inline void
 215 svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
 216 {
 217   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 218 }
 219
 220 /**
 221  * Max contiguous chunk of data that can be read
 222  */
 223 always_inline u32
 224 svm_fifo_max_read_chunk (svm_fifo_t * f)
 225 {
 226   return ((f->tail > f->head) ? (f->tail - f->head) : (f->nitems - f->head));
 227 }
 228
 229 /**
 230  * Max contiguous chunk of data that can be written
 231  */
 232 always_inline u32
 233 svm_fifo_max_write_chunk (svm_fifo_t * f)
 234 {
 235   return ((f->tail >= f->head) ? (f->nitems - f->tail) : (f->head - f->tail));
 236 }
 237
 238 /**
 239  * Advance tail pointer
 240  *
 241  * Useful for moving tail pointer after external enqueue.
 242  */
 243 always_inline void
 244 svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 bytes)
 245 {
 246   ASSERT (bytes <= svm_fifo_max_enqueue (f));
 247   f->tail = (f->tail + bytes) % f->nitems;
 248   f->cursize += bytes;
 249 }
 250
 251 always_inline u8 *
 252 svm_fifo_head (svm_fifo_t * f)
 253 {
 254   return (f->data + f->head);
 255 }
 256
 257 always_inline u8 *
 258 svm_fifo_tail (svm_fifo_t * f)
 259 {
 260   return (f->data + f->tail);
 261 }
 262
 263 always_inline u32
 264 ooo_segment_distance_from_tail (svm_fifo_t * f, u32 pos)
 265 {
 266   /* Ambiguous. Assumption is that ooo segments don't touch tail */
 267   if (PREDICT_FALSE (pos == f->tail && f->tail == f->head))
 268     return f->nitems;
 269
 270   return (((f->nitems + pos) - f->tail) % f->nitems);
 271 }
 272
 273 always_inline u32
 274 ooo_segment_distance_to_tail (svm_fifo_t * f, u32 pos)
 275 {
 276   return (((f->nitems + f->tail) - pos) % f->nitems);
 277 }
 278
 279 always_inline u32
 280 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 281 {
 282   return ooo_segment_distance_from_tail (f, s->start);
 283 }
 284
 285 always_inline u32
 286 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 287 {
 288   return ooo_segment_distance_from_tail (f, s->start) + s->length;
 289 }
 290
 291 always_inline u32
 292 ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
 293 {
 294   return s->length;
 295 }
 296
 297 always_inline ooo_segment_t *
 298 ooo_segment_get_prev (svm_fifo_t * f, ooo_segment_t * s)
 299 {
 300   if (s->prev == OOO_SEGMENT_INVALID_INDEX)
 301     return 0;
 302   return pool_elt_at_index (f->ooo_segments, s->prev);
 303 }
 304
 305 always_inline ooo_segment_t *
 306 ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
 307 {
 308   if (s->next == OOO_SEGMENT_INVALID_INDEX)
 309     return 0;
 310   return pool_elt_at_index (f->ooo_segments, s->next);
 311 }
 312
 313 #endif /* __included_ssvm_fifo_h__ */
 314
 315 /*
 316  * fd.io coding-style-patch-verification: ON
 317  *
 318  * Local Variables:
 319  * eval: (c-set-style "gnu")
 320  * End:
 321  */