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   pthread_mutex_t mutex;        /* 8 bytes */
  52   pthread_cond_t condvar;       /* 8 bytes */
  53   svm_lock_tag_t tag;
  54
  55   volatile u8 has_event;        /**< non-zero if deq event exists */
  56   u32 owner_pid;
  57
  58   /* Backpointers */
  59   u32 server_session_index;
  60   u32 client_session_index;
  61   u8 server_thread_index;
  62   u8 client_thread_index;
  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
  74     CLIB_CACHE_LINE_ALIGN_MARK (data);
  75 } svm_fifo_t;
  76
  77 static inline int
  78 svm_fifo_lock (svm_fifo_t * f, u32 pid, u32 tag, int nowait)
  79 {
  80   if (PREDICT_TRUE (nowait == 0))
  81     pthread_mutex_lock (&f->mutex);
  82   else
  83     {
  84       if (pthread_mutex_trylock (&f->mutex))
  85         return -1;
  86     }
  87   f->owner_pid = pid;
  88   f->tag = tag;
  89   return 0;
  90 }
  91
  92 static inline void
  93 svm_fifo_unlock (svm_fifo_t * f)
  94 {
  95   f->owner_pid = 0;
  96   f->tag = 0;
  97   CLIB_MEMORY_BARRIER ();
  98   pthread_mutex_unlock (&f->mutex);
  99 }
 100
 101 static inline u32
 102 svm_fifo_max_dequeue (svm_fifo_t * f)
 103 {
 104   return f->cursize;
 105 }
 106
 107 static inline u32
 108 svm_fifo_max_enqueue (svm_fifo_t * f)
 109 {
 110   return f->nitems - svm_fifo_max_dequeue (f);
 111 }
 112
 113 static inline u8
 114 svm_fifo_has_ooo_data (svm_fifo_t * f)
 115 {
 116   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 117 }
 118
 119 /**
 120  * Sets fifo event flag.
 121  *
 122  * @return 1 if flag was not set.
 123  */
 124 always_inline u8
 125 svm_fifo_set_event (svm_fifo_t * f)
 126 {
 127   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 128   return __sync_lock_test_and_set (&f->has_event, 1) == 0;
 129 }
 130
 131 /**
 132  * Unsets fifo event flag.
 133  */
 134 always_inline void
 135 svm_fifo_unset_event (svm_fifo_t * f)
 136 {
 137   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 138   __sync_lock_test_and_set (&f->has_event, 0);
 139 }
 140
 141 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 142
 143 int svm_fifo_enqueue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 144                              u8 * copy_from_here);
 145
 146 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, int pid,
 147                                   u32 offset, u32 required_bytes,
 148                                   u8 * copy_from_here);
 149
 150 int svm_fifo_dequeue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 151                              u8 * copy_here);
 152
 153 int svm_fifo_peek (svm_fifo_t * f, int pid, u32 offset, u32 max_bytes,
 154                    u8 * copy_here);
 155 int svm_fifo_dequeue_drop (svm_fifo_t * f, int pid, u32 max_bytes);
 156
 157 always_inline ooo_segment_t *
 158 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 159 {
 160   return f->ooo_segments + f->ooos_newest;
 161 }
 162
 163 always_inline u32
 164 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 165 {
 166   return ((f->nitems + s->fifo_position - f->tail) % f->nitems);
 167 }
 168
 169 always_inline u32
 170 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 171 {
 172   return ((f->nitems + s->fifo_position + s->length - f->tail) % f->nitems);
 173 }
 174
 175 #endif /* __included_ssvm_fifo_h__ */
 176
 177 /*
 178  * fd.io coding-style-patch-verification: ON
 179  *
 180  * Local Variables:
 181  * eval: (c-set-style "gnu")
 182  * End:
 183  */