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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_ssvm_fifo_h__
16 #define __included_ssvm_fifo_h__
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>
28 SVM_FIFO_TAG_NOT_HELD = 0,
33 /** Out-of-order segment */
36 u32 next; /**< Next linked-list element pool index */
37 u32 prev; /**< Previous linked-list element pool index */
39 u32 fifo_position; /**< Start of segment, normalized*/
40 u32 length; /**< Length of segment */
43 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
47 volatile u32 cursize; /**< current fifo size */
49 CLIB_CACHE_LINE_ALIGN_MARK (end_cursize);
51 volatile u8 has_event; /**< non-zero if deq event exists */
55 u32 server_session_index;
56 u32 client_session_index;
57 u8 server_thread_index;
58 u8 client_thread_index;
60 CLIB_CACHE_LINE_ALIGN_MARK (end_shared);
62 CLIB_CACHE_LINE_ALIGN_MARK (end_consumer);
67 ooo_segment_t *ooo_segments; /**< Pool of ooo segments */
68 u32 ooos_list_head; /**< Head of out-of-order linked-list */
69 u32 ooos_newest; /**< Last segment to have been updated */
71 CLIB_CACHE_LINE_ALIGN_MARK (data);
75 svm_fifo_max_dequeue (svm_fifo_t * f)
81 svm_fifo_max_enqueue (svm_fifo_t * f)
83 return f->nitems - svm_fifo_max_dequeue (f);
87 svm_fifo_has_ooo_data (svm_fifo_t * f)
89 return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
93 * Sets fifo event flag.
95 * @return 1 if flag was not set.
98 svm_fifo_set_event (svm_fifo_t * f)
100 /* Probably doesn't need to be atomic. Still, better avoid surprises */
101 return __sync_lock_test_and_set (&f->has_event, 1) == 0;
105 * Unsets fifo event flag.
108 svm_fifo_unset_event (svm_fifo_t * f)
110 /* Probably doesn't need to be atomic. Still, better avoid surprises */
111 __sync_lock_test_and_set (&f->has_event, 0);
114 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
115 void svm_fifo_free (svm_fifo_t * f);
117 int svm_fifo_enqueue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
118 u8 * copy_from_here);
120 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, int pid,
121 u32 offset, u32 required_bytes,
122 u8 * copy_from_here);
124 int svm_fifo_dequeue_nowait (svm_fifo_t * f, int pid, u32 max_bytes,
127 int svm_fifo_peek (svm_fifo_t * f, int pid, u32 offset, u32 max_bytes,
129 int svm_fifo_dequeue_drop (svm_fifo_t * f, int pid, u32 max_bytes);
131 format_function_t format_svm_fifo;
133 always_inline ooo_segment_t *
134 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
136 return f->ooo_segments + f->ooos_newest;
140 ooo_segment_offset (svm_fifo_t * f, ooo_segment_t * s)
142 return ((f->nitems + s->fifo_position - f->tail) % f->nitems);
146 ooo_segment_end_offset (svm_fifo_t * f, ooo_segment_t * s)
148 return ((f->nitems + s->fifo_position + s->length - f->tail) % f->nitems);
151 #endif /* __included_ssvm_fifo_h__ */
154 * fd.io coding-style-patch-verification: ON
157 * eval: (c-set-style "gnu")