2 * Copyright (c) 2016-2019 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_fifo_segment_h__
16 #define __included_fifo_segment_h__
19 #include <svm/fifo_types.h>
20 #include <svm/svm_fifo.h>
24 FIFO_SEGMENT_FTYPE_NONE = -1,
25 FIFO_SEGMENT_RX_FIFO = 0,
28 } fifo_segment_ftype_t;
30 #define FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE 12 /**< 4kB min fifo size */
31 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096 /**< 4kB min fifo size */
32 #define FIFO_SEGMENT_MAX_FIFO_SIZE (2 << 30) /**< 2GB max fifo size */
33 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32 /* Allocation quantum */
35 typedef enum fifo_segment_flags_
37 FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
38 FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
39 FIFO_SEGMENT_F_MEM_LIMIT = 1 << 2,
40 } fifo_segment_flags_t;
42 #define foreach_segment_mem_status \
43 _(NO_PRESSURE, "No pressure") \
44 _(LOW_PRESSURE, "Low pressure") \
45 _(HIGH_PRESSURE, "High pressure") \
46 _(NO_MEMORY, "No memory")
50 #define _(sym,str) MEMORY_PRESSURE_##sym,
51 foreach_segment_mem_status
54 } fifo_segment_mem_status_t;
57 typedef enum fifo_segment_mem_status_
59 MEMORY_PRESSURE_NO_PRESSURE,
60 MEMORY_PRESSURE_LOW_PRESSURE,
61 MEMORY_PRESSURE_HIGH_PRESSURE,
62 MEMORY_PRESSURE_NO_MEMORY,
63 } fifo_segment_mem_status_t;
68 ssvm_private_t ssvm; /**< ssvm segment data */
69 fifo_segment_header_t *h; /**< fifo segment data */
70 u8 n_slices; /**< number of fifo segment slices */
75 fifo_segment_t *segments; /**< pool of fifo segments */
76 uword next_baseva; /**< Where to put the next one */
77 u32 timeout_in_seconds; /**< Time to wait during attach */
78 } fifo_segment_main_t;
82 ssvm_segment_type_t segment_type; /**< type of segment requested */
83 u32 segment_size; /**< size of the segment */
84 int memfd_fd; /**< fd for memfd segments */
85 char *segment_name; /**< segment name */
86 u32 *new_segment_indices; /**< return vec of new seg indices */
87 } fifo_segment_create_args_t;
89 #define fifo_segment_flags(_fs) _fs->h->flags
91 int fifo_segment_init (fifo_segment_t * fs);
92 int fifo_segment_create (fifo_segment_main_t * sm,
93 fifo_segment_create_args_t * a);
94 int fifo_segment_attach (fifo_segment_main_t * sm,
95 fifo_segment_create_args_t * a);
96 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
97 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
99 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
100 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
103 * Allocate fifo in fifo segment
105 * @param fs fifo segment for fifo
106 * @param data_bytes size of default fifo chunk in bytes
107 * @param ftype fifo type @ref fifo_segment_ftype_t
108 * @return new fifo or 0 if alloc failed
110 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
113 fifo_segment_ftype_t ftype);
116 * Free fifo allocated in fifo segment
118 * @param fs fifo segment for fifo
119 * @param f fifo to be freed
121 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
124 * Try to preallocate fifo headers
126 * Tries to preallocate fifo headers and adds them to freelist.
128 * @param fs fifo segment
129 * @param batch_size number of chunks to be allocated
130 * @return 0 on success, negative number otherwise
132 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
136 * Try to preallocate fifo chunks on segment
138 * Tries to preallocate chunks of requested size on segment and adds them
141 * @param fs fifo segment
142 * @param chunk_size size of chunks to be allocated in bytes
143 * @param batch_size number of chunks to be allocated
144 * @return 0 on success, negative number otherwise
146 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
147 u32 chunk_size, u32 batch_size);
149 * Pre-allocates fifo pairs in fifo segment
151 * The number of fifos pre-allocated is the minimum of the requested number
152 * of pairs and the maximum number that fit within the segment. If the maximum
153 * is hit, the number of fifo pairs requested is updated by subtracting the
154 * number of fifos that have been successfully allocated.
156 * @param fs fifo segment for fifo
157 * @param rx_fifo_size data size of rx fifos
158 * @param tx_fifo_size data size of tx fifos
159 * @param n_fifo_pairs number of pairs requested. Prior to returning, this
160 * is decremented by the the number of pairs allocated.
162 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
168 * Allocate chunks in fifo segment
170 * @param fsh fifo segment header
171 * @param slice_index slice where chunks should be alocated
172 * @param chunk_size chunk size needed
173 * @return chunk (or chunks) that cover at least chunk_size bytes
174 * on success, 0 on failure.
176 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
177 u32 slice_index, u32 chunk_size);
180 * Return chunks to fifo segment
182 * @param fsh fifo segment header
183 * @param slice_index slice where chunks should be returned
184 * @param c pointer to first chunk in 0 terminated linked list
186 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
187 svm_fifo_chunk_t * c);
190 * Fifo segment has reached mem limit
192 * @param fsh fifo segment header
193 * @return 1 (if reached) or 0 (otherwise)
195 u8 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh);
198 * Fifo segment reset mem limit flag
200 * @param fs fifo segment
202 void fsh_reset_mem_limit (fifo_segment_header_t * fsh);
205 * Fifo segment allocated size
207 * Returns fifo segment's allocated size
209 * @param fs fifo segment
210 * @return allocated size in bytes
212 uword fifo_segment_size (fifo_segment_t * fs);
215 * Fifo segment estimate of number of free bytes
217 * Returns fifo segment's internal estimate of the number of free bytes.
218 * To force a synchronization between the segment and the underlying
219 * memory allocator, call @ref fifo_segment_update_free_bytes
221 * @param fs fifo segment
222 * @return free bytes estimate
224 uword fifo_segment_free_bytes (fifo_segment_t * fs);
227 * Update fifo segment free bytes estimate
229 * Forces fifo segment free bytes estimate synchronization with underlying
232 * @param fs fifo segment
234 void fifo_segment_update_free_bytes (fifo_segment_t * fs);
237 * Fifo segment number of cached bytes
239 * Returns fifo segment's number of cached bytes.
241 * @param fs fifo segment
242 * @return cached bytes
244 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
246 uword fifo_segment_available_bytes (fifo_segment_t * fs);
249 * Number of bytes on chunk free lists
251 * @param fs fifo segment
252 * @return free bytes on chunk free lists
254 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
255 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
256 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
258 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
259 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
261 * Find number of free chunks of given size
263 * @param fs fifo segment
264 * @param size chunk size of interest or ~0 if all should be counted
265 * @return number of chunks of given size
267 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
269 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
270 fifo_segment_mem_status_t fifo_segment_determine_status
271 (fifo_segment_header_t * fsh, u8 usage);
272 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
274 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
275 u32 timeout_in_seconds);
277 format_function_t format_fifo_segment;
278 format_function_t format_fifo_segment_type;
280 #endif /* __included_fifo_segment_h__ */
283 * fd.io coding-style-patch-verification: ON
286 * eval: (c-set-style "gnu")