2 * Copyright (c) 2020 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.
16 #ifndef SRC_SVM_FIFO_TYPES_H_
17 #define SRC_SVM_FIFO_TYPES_H_
20 #include <vppinfra/clib.h>
21 #include <vppinfra/rbtree.h>
22 #include <vppinfra/lock.h>
24 #define FS_MIN_LOG2_CHUNK_SZ 12 /**< also min fifo size */
25 #define FS_MAX_LOG2_CHUNK_SZ 22 /**< 4MB max chunk size */
26 #define FS_CHUNK_VEC_LEN 11 /**< number of chunk sizes */
28 STATIC_ASSERT ((FS_MAX_LOG2_CHUNK_SZ - FS_MIN_LOG2_CHUNK_SZ) ==
30 "update chunk sizes");
32 #define SVM_FIFO_TRACE (0)
33 #define SVM_FIFO_MAX_EVT_SUBSCRIBERS 7
35 typedef struct fifo_segment_header_ fifo_segment_header_t;
37 typedef struct svm_fifo_chunk_
39 u32 start_byte; /**< chunk start byte */
40 u32 length; /**< length of chunk in bytes */
41 struct svm_fifo_chunk_ *next; /**< pointer to next chunk in linked-lists */
42 rb_node_index_t enq_rb_index; /**< enq node index if chunk in rbtree */
43 rb_node_index_t deq_rb_index; /**< deq node index if chunk in rbtree */
44 u8 data[0]; /**< start of chunk data */
49 u32 next; /**< Next linked-list element pool index */
50 u32 prev; /**< Previous linked-list element pool index */
51 u32 start; /**< Start of segment, normalized*/
52 u32 length; /**< Length of segment */
60 } svm_fifo_trace_elem_t;
62 typedef struct _svm_fifo
64 CLIB_CACHE_LINE_ALIGN_MARK (shared_first);
65 fifo_segment_header_t *fs_hdr;/**< fifo segment header for fifo */
66 svm_fifo_chunk_t *start_chunk;/**< first chunk in fifo chunk list */
67 svm_fifo_chunk_t *end_chunk; /**< end chunk in fifo chunk list */
68 u32 min_alloc; /**< min chunk alloc if space available */
69 u32 size; /**< size of the fifo in bytes */
70 u8 flags; /**< fifo flags */
71 u8 slice_index; /**< segment slice for fifo */
73 CLIB_CACHE_LINE_ALIGN_MARK (shared_second);
74 volatile u32 has_event; /**< non-zero if deq event exists */
75 u32 master_session_index; /**< session layer session index */
76 u32 client_session_index; /**< app session index */
77 u8 master_thread_index; /**< session layer thread index */
78 u8 client_thread_index; /**< app worker index */
79 i8 refcnt; /**< reference count */
80 u32 segment_manager; /**< session layer segment manager index */
81 u32 segment_index; /**< segment index in segment manager */
82 struct _svm_fifo *next; /**< next in freelist/active chain */
83 struct _svm_fifo *prev; /**< prev in active chain */
85 CLIB_CACHE_LINE_ALIGN_MARK (consumer);
86 rb_tree_t ooo_deq_lookup; /**< rbtree for ooo deq chunk lookup */
87 svm_fifo_chunk_t *head_chunk; /**< tracks chunk where head lands */
88 svm_fifo_chunk_t *ooo_deq; /**< last chunk used for ooo dequeue */
89 u32 head; /**< fifo head position/byte */
90 volatile u32 want_deq_ntf; /**< producer wants nudge */
91 volatile u32 has_deq_ntf;
93 CLIB_CACHE_LINE_ALIGN_MARK (producer);
94 rb_tree_t ooo_enq_lookup; /**< rbtree for ooo enq chunk lookup */
95 u32 tail; /**< fifo tail position/byte */
96 u32 ooos_list_head; /**< Head of out-of-order linked-list */
97 svm_fifo_chunk_t *tail_chunk; /**< tracks chunk where tail lands */
98 svm_fifo_chunk_t *ooo_enq; /**< last chunk used for ooo enqueue */
99 ooo_segment_t *ooo_segments; /**< Pool of ooo segments */
100 u32 ooos_newest; /**< Last segment to have been updated */
101 volatile u8 n_subscribers; /**< Number of subscribers for io events */
102 u8 subscribers[SVM_FIFO_MAX_EVT_SUBSCRIBERS];
105 svm_fifo_trace_elem_t *trace;
110 typedef struct fifo_segment_slice_
112 svm_fifo_chunk_t *free_chunks[FS_CHUNK_VEC_LEN]; /**< Free chunks by size */
113 svm_fifo_t *fifos; /**< Linked list of active RX fifos */
114 svm_fifo_t *free_fifos; /**< Freelists by fifo size */
115 uword n_fl_chunk_bytes; /**< Chunk bytes on freelist */
116 uword virtual_mem; /**< Slice sum of all fifo sizes */
117 u32 num_chunks[FS_CHUNK_VEC_LEN]; /**< Allocated chunks by chunk size */
119 CLIB_CACHE_LINE_ALIGN_MARK (lock);
121 } fifo_segment_slice_t;
123 struct fifo_segment_header_
125 uword n_cached_bytes; /**< Cached bytes */
126 u32 n_active_fifos; /**< Number of active fifos */
127 u32 n_reserved_bytes; /**< Bytes not to be allocated */
128 u32 max_log2_fifo_size; /**< Max log2(chunk size) for fs */
129 u8 flags; /**< Segment flags */
130 u8 n_slices; /**< Number of slices */
131 u8 high_watermark; /**< Memory pressure watermark high */
132 u8 low_watermark; /**< Memory pressure watermark low */
133 u8 pct_first_alloc; /**< Pct of fifo size to alloc */
134 CLIB_CACHE_LINE_ALIGN_MARK (allocator);
136 uword max_byte_index;
137 CLIB_CACHE_LINE_ALIGN_MARK (slice);
138 fifo_segment_slice_t slices[0]; /** Fixed array of slices */
141 void fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
144 #endif /* SRC_SVM_FIFO_TYPES_H_ */
147 * fd.io coding-style-patch-verification: ON
150 * eval: (c-set-style "gnu")