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