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/message_queue.h>
21 #include <svm/svm_fifo.h>
25 FIFO_SEGMENT_FTYPE_NONE = -1,
26 FIFO_SEGMENT_RX_FIFO = 0,
29 } fifo_segment_ftype_t;
31 #define FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE 12 /**< 4kB min fifo size */
32 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096 /**< 4kB min fifo size */
33 #define FIFO_SEGMENT_MAX_FIFO_SIZE (2ULL << 30) /**< 2GB max fifo size */
34 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32 /* Allocation quantum */
36 typedef enum fifo_segment_flags_
38 FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
39 FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
40 FIFO_SEGMENT_F_MEM_LIMIT = 1 << 2,
41 } fifo_segment_flags_t;
43 #define foreach_segment_mem_status \
44 _(NO_PRESSURE, "No pressure") \
45 _(LOW_PRESSURE, "Low pressure") \
46 _(HIGH_PRESSURE, "High pressure") \
47 _(NO_MEMORY, "No memory")
51 #define _(sym,str) MEMORY_PRESSURE_##sym,
52 foreach_segment_mem_status
55 } fifo_segment_mem_status_t;
58 typedef enum fifo_segment_mem_status_
60 MEMORY_PRESSURE_NO_PRESSURE,
61 MEMORY_PRESSURE_LOW_PRESSURE,
62 MEMORY_PRESSURE_HIGH_PRESSURE,
63 MEMORY_PRESSURE_NO_MEMORY,
64 } fifo_segment_mem_status_t;
69 ssvm_private_t ssvm; /**< ssvm segment data */
70 fifo_segment_header_t *h; /**< fifo segment data */
72 u8 n_slices; /**< number of fifo segment slices */
73 fifo_slice_private_t *slices; /**< private slice information */
74 svm_msg_q_t *mqs; /**< private vec of attached mqs */
79 fifo_segment_t *segments; /**< pool of fifo segments */
80 uword next_baseva; /**< Where to put the next one */
81 u32 timeout_in_seconds; /**< Time to wait during attach */
82 } fifo_segment_main_t;
86 ssvm_segment_type_t segment_type; /**< type of segment requested */
87 u32 segment_size; /**< size of the segment */
88 int memfd_fd; /**< fd for memfd segments */
89 char *segment_name; /**< segment name */
90 u32 *new_segment_indices; /**< return vec of new seg indices */
91 } fifo_segment_create_args_t;
93 #define fifo_segment_flags(_fs) _fs->h->flags
95 int fifo_segment_init (fifo_segment_t * fs);
96 int fifo_segment_create (fifo_segment_main_t * sm,
97 fifo_segment_create_args_t * a);
98 int fifo_segment_attach (fifo_segment_main_t * sm,
99 fifo_segment_create_args_t * a);
100 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
101 void fifo_segment_cleanup (fifo_segment_t *fs);
102 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
104 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
105 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
108 * Allocate fifo in fifo segment
110 * @param fs fifo segment for fifo
111 * @param data_bytes size of default fifo chunk in bytes
112 * @param ftype fifo type @ref fifo_segment_ftype_t
113 * @return new fifo or 0 if alloc failed
115 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
118 fifo_segment_ftype_t ftype);
119 svm_fifo_t *fifo_segment_alloc_fifo_w_shared (fifo_segment_t *fs,
120 svm_fifo_shared_t *sf);
123 * Free fifo allocated in fifo segment
125 * @param fs fifo segment for fifo
126 * @param f fifo to be freed
128 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
130 void fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f);
131 void fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
135 * Allocate message queue on segment
137 * @param fs fifo segment for mq
138 * @param mq_index index in private mqs vector to use to attach
139 * @param cfg configuration for mq
140 * @return attached message queue
142 svm_msg_q_t *fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
143 svm_msg_q_cfg_t *cfg);
146 * Attach message queue at fifo segment offset
148 * @param fs fifo segment for mq
149 * @param offset offset for shared mq on the segment
150 * @param mq_index index in private mqs vector to use to attach
151 * @return attached message queue
153 svm_msg_q_t *fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset,
157 * Message queue offset on segment
159 * @param fs fifo segment for mq
160 * @param mq_index index of mq in private mqs vector
161 * @return offset of the shared mq the private mq is attached to
163 uword fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index);
166 * Try to preallocate fifo headers
168 * Tries to preallocate fifo headers and adds them to freelist.
170 * @param fs fifo segment
171 * @param batch_size number of chunks to be allocated
172 * @return 0 on success, negative number otherwise
174 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
178 * Try to preallocate fifo chunks on segment
180 * Tries to preallocate chunks of requested size on segment and adds them
183 * @param fs fifo segment
184 * @param chunk_size size of chunks to be allocated in bytes
185 * @param batch_size number of chunks to be allocated
186 * @return 0 on success, negative number otherwise
188 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
189 u32 chunk_size, u32 batch_size);
191 * Pre-allocates fifo pairs in fifo segment
193 * The number of fifos pre-allocated is the minimum of the requested number
194 * of pairs and the maximum number that fit within the segment. If the maximum
195 * is hit, the number of fifo pairs requested is updated by subtracting the
196 * number of fifos that have been successfully allocated.
198 * @param fs fifo segment for fifo
199 * @param rx_fifo_size data size of rx fifos
200 * @param tx_fifo_size data size of tx fifos
201 * @param n_fifo_pairs number of pairs requested. Prior to returning, this
202 * is decremented by the the number of pairs allocated.
204 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
210 * Allocate chunks in fifo segment
212 * @param fsh fifo segment header
213 * @param slice_index slice where chunks should be alocated
214 * @param chunk_size chunk size needed
215 * @return chunk (or chunks) that cover at least chunk_size bytes
216 * on success, 0 on failure.
218 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
219 u32 slice_index, u32 chunk_size);
222 * Return chunks to fifo segment
224 * @param fsh fifo segment header
225 * @param slice_index slice where chunks should be returned
226 * @param c pointer to first chunk in 0 terminated linked list
228 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
229 svm_fifo_chunk_t * c);
232 * Fifo segment has reached mem limit
234 * @param fsh fifo segment header
235 * @return 1 (if reached) or 0 (otherwise)
237 u8 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh);
240 * Fifo segment reset mem limit flag
242 * @param fs fifo segment
244 void fsh_reset_mem_limit (fifo_segment_header_t * fsh);
247 * Fifo segment reset mem limit flag
249 * @param fs fifo segment
250 * @param size size requested
251 * @return pointer to memory allocated or 0
253 void *fifo_segment_alloc (fifo_segment_t *fs, uword size);
255 * Fifo segment allocated size
257 * Returns fifo segment's allocated size
259 * @param fs fifo segment
260 * @return allocated size in bytes
262 uword fifo_segment_size (fifo_segment_t * fs);
265 * Fifo segment estimate of number of free bytes
267 * Returns fifo segment's internal estimate of the number of free bytes.
268 * To force a synchronization between the segment and the underlying
269 * memory allocator, call @ref fifo_segment_update_free_bytes
271 * @param fs fifo segment
272 * @return free bytes estimate
274 uword fifo_segment_free_bytes (fifo_segment_t * fs);
277 * Fifo segment number of cached bytes
279 * Returns fifo segment's number of cached bytes.
281 * @param fs fifo segment
282 * @return cached bytes
284 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
286 uword fifo_segment_available_bytes (fifo_segment_t * fs);
289 * Number of bytes on chunk free lists
291 * @param fs fifo segment
292 * @return free bytes on chunk free lists
294 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
295 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
296 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
298 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
299 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
301 * Find number of free chunks of given size
303 * @param fs fifo segment
304 * @param size chunk size of interest or ~0 if all should be counted
305 * @return number of chunks of given size
307 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
309 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
310 fifo_segment_mem_status_t fifo_segment_determine_status
311 (fifo_segment_header_t * fsh, u8 usage);
312 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
314 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
315 u32 timeout_in_seconds);
317 format_function_t format_fifo_segment;
318 format_function_t format_fifo_segment_type;
320 #endif /* __included_fifo_segment_h__ */
323 * fd.io coding-style-patch-verification: ON
326 * eval: (c-set-style "gnu")