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 typedef enum
  27 {
  28   SVM_FIFO_TAG_NOT_HELD = 0,
  29   SVM_FIFO_TAG_DEQUEUE,
  30   SVM_FIFO_TAG_ENQUEUE,
  31 } svm_lock_tag_t;
  32
  33 /** Out-of-order segment */
  34 typedef struct
  35 {
  36   u32 next;     /**< Next linked-list element pool index */
  37   u32 prev;     /**< Previous linked-list element pool index */
  38
  39   u32 fifo_position;    /**< Start of segment, normalized*/
  40   u32 length;           /**< Length of segment */
  41 } ooo_segment_t;
  42
  43 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
  44
  45 typedef struct
  46 {
  47   volatile u32 cursize;         /**< current fifo size */
  48   u32 nitems;
  49     CLIB_CACHE_LINE_ALIGN_MARK (end_cursize);
  50
  51   volatile u8 has_event;        /**< non-zero if deq event exists */
  52   u32 owner_pid;
  53
  54   /* Backpointers */
  55   u32 server_session_index;
  56   u32 client_session_index;
  57   u8 server_thread_index;
  58   u8 client_thread_index;
  59   u32 segment_manager;
  60     CLIB_CACHE_LINE_ALIGN_MARK (end_shared);
  61   u32 head;
  62     CLIB_CACHE_LINE_ALIGN_MARK (end_consumer);
  63
  64   /* producer */
  65   u32 tail;
  66
  67   ooo_segment_t *ooo_segments;  /**< Pool of ooo segments */
  68   u32 ooos_list_head;           /**< Head of out-of-order linked-list */
  69   u32 ooos_newest;              /**< Last segment to have been updated */
  70
  71     CLIB_CACHE_LINE_ALIGN_MARK (data);
  72 } svm_fifo_t;
  73
  74 static inline u32
  75 svm_fifo_max_dequeue (svm_fifo_t * f)
  76 {
  77   return f->cursize;
  78 }
  79
  80 static inline u32
  81 svm_fifo_max_enqueue (svm_fifo_t * f)
  82 {
  83   return f->nitems - svm_fifo_max_dequeue (f);
  84 }
  85
  86 static inline u8
  87 svm_fifo_has_ooo_data (svm_fifo_t * f)
  88 {
  89   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
  90 }
  91
  92 /**
  93  * Sets fifo event flag.
  94  *
  95  * @return 1 if flag was not set.
  96  */
  97 always_inline u8
  98 svm_fifo_set_event (svm_fifo_t * f)
  99 {
 100   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 101   return __sync_lock_test_and_set (&f->has_event, 1) == 0;
 102 }
 103
 104 /**
 105  * Unsets fifo event flag.
 106  */
 107 always_inline void
 108 svm_fifo_unset_event (svm_fifo_t * f)
 109 {
 110   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 111   __sync_lock_test_and_set (&f->has_event, 0);
 112 }
 113
 114 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 115 void svm_fifo_free (svm_fifo_t * f);
 116
 117 int svm_fifo_enqueue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 118                              u8 * copy_from_here);
 119
 120 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, int pid,
 121                                   u32 offset, u32 required_bytes,
 122                                   u8 * copy_from_here);
 123
 124 int svm_fifo_dequeue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 125                              u8 * copy_here);
 126
 127 int svm_fifo_peek (svm_fifo_t * f, int pid, u32 offset, u32 max_bytes,
 128                    u8 * copy_here);
 129 int svm_fifo_dequeue_drop (svm_fifo_t * f, int pid, u32 max_bytes);
 130
 131 format_function_t format_svm_fifo;
 132
 133 always_inline ooo_segment_t *
 134 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 135 {
 136   return f->ooo_segments + f->ooos_newest;
 137 }
 138
 139 always_inline u32
 140 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 141 {
 142   return ((f->nitems + s->fifo_position - f->tail) % f->nitems);
 143 }
 144
 145 always_inline u32
 146 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 147 {
 148   return ((f->nitems + s->fifo_position + s->length - f->tail) % f->nitems);
 149 }
 150
 151 #endif /* __included_ssvm_fifo_h__ */
 152
 153 /*
 154  * fd.io coding-style-patch-verification: ON
 155  *
 156  * Local Variables:
 157  * eval: (c-set-style "gnu")
 158  * End:
 159  */