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 start;    /**< Start of segment, normalized*/
  40   u32 length;           /**< Length of segment */
  41 } ooo_segment_t;
  42
  43 format_function_t format_ooo_segment;
  44 format_function_t format_ooo_list;
  45
  46 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
  47
  48 typedef struct
  49 {
  50   volatile u32 cursize;         /**< current fifo size */
  51   u32 nitems;
  52     CLIB_CACHE_LINE_ALIGN_MARK (end_cursize);
  53
  54   volatile u8 has_event;        /**< non-zero if deq event exists */
  55   u32 owner_pid;
  56
  57   /* Backpointers */
  58   u32 server_session_index;
  59   u32 client_session_index;
  60   u8 server_thread_index;
  61   u8 client_thread_index;
  62   u32 segment_manager;
  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 u32
  78 svm_fifo_max_dequeue (svm_fifo_t * f)
  79 {
  80   return f->cursize;
  81 }
  82
  83 static inline u32
  84 svm_fifo_max_enqueue (svm_fifo_t * f)
  85 {
  86   return f->nitems - svm_fifo_max_dequeue (f);
  87 }
  88
  89 static inline u8
  90 svm_fifo_has_ooo_data (svm_fifo_t * f)
  91 {
  92   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
  93 }
  94
  95 /**
  96  * Sets fifo event flag.
  97  *
  98  * @return 1 if flag was not set.
  99  */
 100 always_inline u8
 101 svm_fifo_set_event (svm_fifo_t * f)
 102 {
 103   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 104   return __sync_lock_test_and_set (&f->has_event, 1) == 0;
 105 }
 106
 107 /**
 108  * Unsets fifo event flag.
 109  */
 110 always_inline void
 111 svm_fifo_unset_event (svm_fifo_t * f)
 112 {
 113   /* Probably doesn't need to be atomic. Still, better avoid surprises */
 114   __sync_lock_test_and_set (&f->has_event, 0);
 115 }
 116
 117 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
 118 void svm_fifo_free (svm_fifo_t * f);
 119
 120 int svm_fifo_enqueue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 121                              u8 * copy_from_here);
 122
 123 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, int pid,
 124                                   u32 offset, u32 required_bytes,
 125                                   u8 * copy_from_here);
 126
 127 int svm_fifo_dequeue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
 128                              u8 * copy_here);
 129
 130 int svm_fifo_peek (svm_fifo_t * f, int pid, u32 offset, u32 max_bytes,
 131                    u8 * copy_here);
 132 int svm_fifo_dequeue_drop (svm_fifo_t * f, int pid, u32 max_bytes);
 133 u32 svm_fifo_number_ooo_segments (svm_fifo_t * f);
 134 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
 135
 136 format_function_t format_svm_fifo;
 137
 138 always_inline ooo_segment_t *
 139 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 140 {
 141   return f->ooo_segments + f->ooos_newest;
 142 }
 143
 144 always_inline u32
 145 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
 146 {
 147 //  return ((f->nitems + s->fifo_position - f->tail) % f->nitems);
 148   return s->start;
 149 }
 150
 151 always_inline u32
 152 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
 153 {
 154 //  return ((f->nitems + s->fifo_position + s->length - f->tail) % f->nitems);
 155   return s->start + s->length;
 156 }
 157
 158 always_inline ooo_segment_t *
 159 ooo_segment_get_prev (svm_fifo_t * f, ooo_segment_t * s)
 160 {
 161   if (s->prev == OOO_SEGMENT_INVALID_INDEX)
 162     return 0;
 163   return pool_elt_at_index (f->ooo_segments, s->prev);
 164 }
 165
 166 #endif /* __included_ssvm_fifo_h__ */
 167
 168 /*
 169  * fd.io coding-style-patch-verification: ON
 170  *
 171  * Local Variables:
 172  * eval: (c-set-style "gnu")
 173  * End:
 174  */