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   u32 owner_pid;
  50   svm_lock_tag_t tag;
  51   volatile u32 cursize;
  52   u32 nitems;
  53
  54   /* Backpointers */
  55   u32 server_session_index;
  56   u32 client_session_index;
  57   u8 server_thread_index;
  58   u8 client_thread_index;
  59     CLIB_CACHE_LINE_ALIGN_MARK (end_shared);
  60   u32 head;
  61     CLIB_CACHE_LINE_ALIGN_MARK (end_consumer);
  62
  63   /* producer */
  64   u32 tail;
  65
  66   ooo_segment_t *ooo_segments;  /**< Pool of ooo segments */
  67   u32 ooos_list_head;           /**< Head of out-of-order linked-list */
  68   u32 ooos_newest;              /**< Last segment to have been updated */
  69
  70     CLIB_CACHE_LINE_ALIGN_MARK (data);
  71 } svm_fifo_t;
  72
  73 static inline int
  74 svm_fifo_lock (svm_fifo_t * f, u32 pid, u32 tag, int nowait)
  75 {
  76   if (PREDICT_TRUE (nowait == 0))
  77     pthread_mutex_lock (&f->mutex);
  78   else
  79     {
  80       if (pthread_mutex_trylock (&f->mutex))
  81         return -1;
  82     }
  83   f->owner_pid = pid;
  84   f->tag = tag;
  85   return 0;
  86 }
  87
  88 static inline void
  89 svm_fifo_unlock (svm_fifo_t * f)
  90 {
  91   f->owner_pid = 0;
  92   f->tag = 0;
  93   CLIB_MEMORY_BARRIER ();
  94   pthread_mutex_unlock (&f->mutex);
  95 }
  96
  97 static inline u32
  98 svm_fifo_max_dequeue (svm_fifo_t * f)
  99 {
 100   return f->cursize;
 101 }
 102
 103 static inline u32
 104 svm_fifo_max_enqueue (svm_fifo_t * f)
 105 {
 106   return f->nitems - f->cursize;
 107 }
 108
 109 static inline u8
 110 svm_fifo_has_ooo_data (svm_fifo_t * f)
 111 {
 112   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 113 }
 114
 115 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 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 always_inline ooo_segment_t *
 132 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 133 {
 134   return f->ooo_segments + f->ooos_newest;
 135 }
 136
 137 always_inline u32
 138 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 139 {
 140   return ((f->nitems + s->fifo_position - f->tail) % f->nitems);
 141 }
 142
 143 always_inline u32
 144 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 145 {
 146   return ((f->nitems + s->fifo_position + s->length - f->tail) % f->nitems);
 147 }
 148
 149 #endif /* __included_ssvm_fifo_h__ */
 150
 151 /*
 152  * fd.io coding-style-patch-verification: ON
 153  *
 154  * Local Variables:
 155  * eval: (c-set-style "gnu")
 156  * End:
 157  */