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