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>
23 #define FIFO_SEGMENT_ALLOC_OVERHEAD (2 * clib_mem_get_page_size ())
27 FIFO_SEGMENT_FTYPE_NONE = -1,
28 FIFO_SEGMENT_RX_FIFO = 0,
31 } fifo_segment_ftype_t;
33 #define FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE 12 /**< 4kB min fifo size */
34 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096 /**< 4kB min fifo size */
35 #define FIFO_SEGMENT_MAX_FIFO_SIZE (2ULL << 30) /**< 2GB max fifo size */
36 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32 /* Allocation quantum */
38 typedef enum fifo_segment_flags_
40 FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
41 FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
42 FIFO_SEGMENT_F_MEM_LIMIT = 1 << 2,
43 FIFO_SEGMENT_F_CUSTOM_USE = 1 << 3,
44 } fifo_segment_flags_t;
46 #define foreach_segment_mem_status \
47 _(NO_PRESSURE, "No pressure") \
48 _(LOW_PRESSURE, "Low pressure") \
49 _(HIGH_PRESSURE, "High pressure") \
50 _(NO_MEMORY, "No memory")
54 #define _(sym,str) MEMORY_PRESSURE_##sym,
55 foreach_segment_mem_status
58 } fifo_segment_mem_status_t;
61 typedef enum fifo_segment_mem_status_
63 MEMORY_PRESSURE_NO_PRESSURE,
64 MEMORY_PRESSURE_LOW_PRESSURE,
65 MEMORY_PRESSURE_HIGH_PRESSURE,
66 MEMORY_PRESSURE_NO_MEMORY,
67 } fifo_segment_mem_status_t;
72 ssvm_private_t ssvm; /**< ssvm segment data */
73 fifo_segment_header_t *h; /**< fifo segment data */
74 fifo_slice_private_t *slices; /**< private slice information */
75 svm_msg_q_t *mqs; /**< private vec of attached mqs */
76 uword max_byte_index; /**< max byte index for segment */
77 u8 n_slices; /**< number of fifo segment slices */
78 u8 flags; /**< private fifo segment flags */
79 u8 high_watermark; /**< memory pressure watermark high */
80 u8 low_watermark; /**< memory pressure watermark low */
85 fifo_segment_t *segments; /**< pool of fifo segments */
86 uword next_baseva; /**< Where to put the next one */
87 u32 timeout_in_seconds; /**< Time to wait during attach */
88 } fifo_segment_main_t;
92 ssvm_segment_type_t segment_type; /**< type of segment requested */
93 u32 segment_size; /**< size of the segment */
94 int memfd_fd; /**< fd for memfd segments */
95 char *segment_name; /**< segment name */
96 u32 *new_segment_indices; /**< return vec of new seg indices */
97 } fifo_segment_create_args_t;
99 #define fifo_segment_flags(_fs) _fs->flags
101 int fifo_segment_init (fifo_segment_t * fs);
102 int fifo_segment_create (fifo_segment_main_t * sm,
103 fifo_segment_create_args_t * a);
104 int fifo_segment_attach (fifo_segment_main_t * sm,
105 fifo_segment_create_args_t * a);
106 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
107 void fifo_segment_cleanup (fifo_segment_t *fs);
108 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
110 fifo_segment_t *fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm,
112 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
113 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
116 fifo_segment_ptr (fifo_segment_t *fs, uword offset)
118 return (void *) ((u8 *) fs->h + offset);
122 fifo_segment_offset (fifo_segment_t *fs, void *p)
124 return (uword) ((u8 *) p - (u8 *) fs->h);
128 * Allocate fifo in fifo segment
130 * @param fs fifo segment for fifo
131 * @param data_bytes size of default fifo chunk in bytes
132 * @param ftype fifo type @ref fifo_segment_ftype_t
133 * @return new fifo or 0 if alloc failed
135 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
138 fifo_segment_ftype_t ftype);
139 svm_fifo_t *fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs,
141 svm_fifo_t *fifo_segment_duplicate_fifo (fifo_segment_t *fs, svm_fifo_t *f);
144 * Free fifo allocated in fifo segment
146 * @param fs fifo segment for fifo
147 * @param f fifo to be freed
149 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
152 * Free fifo allocated by external applications
154 * @params fs fifo segment for fifo
155 * @param f fifo to be freed
157 void fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f);
159 void fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f);
160 void fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f,
162 uword fifo_segment_fifo_offset (svm_fifo_t *f);
165 * Allocate message queue on segment
167 * @param fs fifo segment for mq
168 * @param mq_index index in private mqs vector to use to attach
169 * @param cfg configuration for mq
170 * @return attached message queue
172 svm_msg_q_t *fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
173 svm_msg_q_cfg_t *cfg);
176 * Attach message queue at fifo segment offset
178 * @param fs fifo segment for mq
179 * @param offset offset for shared mq on the segment
180 * @param mq_index index in private mqs vector to use to attach
181 * @return attached message queue
183 svm_msg_q_t *fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset,
187 * Discover mqs on mq only segment
189 * @param fs fifo segment for mq
190 * @param fds array of fds is mqs use eventfds
191 * @param n_fds number of fds
193 void fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds);
196 * Message queue offset on segment
198 * @param fs fifo segment for mq
199 * @param mq_index index of mq in private mqs vector
200 * @return offset of the shared mq the private mq is attached to
202 uword fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index);
205 * Try to preallocate fifo headers
207 * Tries to preallocate fifo headers and adds them to freelist.
209 * @param fs fifo segment
210 * @param batch_size number of chunks to be allocated
211 * @return 0 on success, negative number otherwise
213 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
217 * Try to preallocate fifo chunks on segment
219 * Tries to preallocate chunks of requested size on segment and adds them
222 * @param fs fifo segment
223 * @param chunk_size size of chunks to be allocated in bytes
224 * @param batch_size number of chunks to be allocated
225 * @return 0 on success, negative number otherwise
227 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
228 u32 chunk_size, u32 batch_size);
230 * Pre-allocates fifo pairs in fifo segment
232 * The number of fifos pre-allocated is the minimum of the requested number
233 * of pairs and the maximum number that fit within the segment. If the maximum
234 * is hit, the number of fifo pairs requested is updated by subtracting the
235 * number of fifos that have been successfully allocated.
237 * @param fs fifo segment for fifo
238 * @param rx_fifo_size data size of rx fifos
239 * @param tx_fifo_size data size of tx fifos
240 * @param n_fifo_pairs number of pairs requested. Prior to returning, this
241 * is decremented by the the number of pairs allocated.
243 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
249 * Allocate chunks in fifo segment
251 * @param fsh fifo segment header
252 * @param slice_index slice where chunks should be alocated
253 * @param chunk_size chunk size needed
254 * @return chunk (or chunks) that cover at least chunk_size bytes
255 * on success, 0 on failure.
257 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
258 u32 slice_index, u32 chunk_size);
261 * Return chunks to fifo segment
263 * @param fsh fifo segment header
264 * @param slice_index slice where chunks should be returned
265 * @param c pointer to first chunk in 0 terminated linked list
267 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
268 svm_fifo_chunk_t * c);
271 * Fifo segment reset mem limit flag
273 * @param fs fifo segment
274 * @param size size requested
275 * @return pointer to memory allocated or 0
277 void *fifo_segment_alloc (fifo_segment_t *fs, uword size);
279 * Fifo segment allocated size
281 * Returns fifo segment's allocated size
283 * @param fs fifo segment
284 * @return allocated size in bytes
286 uword fifo_segment_size (fifo_segment_t * fs);
289 * Fifo segment estimate of number of free bytes
291 * Returns fifo segment's internal estimate of the number of free bytes.
292 * To force a synchronization between the segment and the underlying
293 * memory allocator, call @ref fifo_segment_update_free_bytes
295 * @param fs fifo segment
296 * @return free bytes estimate
298 uword fifo_segment_free_bytes (fifo_segment_t * fs);
301 * Fifo segment number of cached bytes
303 * Returns fifo segment's number of cached bytes.
305 * @param fs fifo segment
306 * @return cached bytes
308 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
310 uword fifo_segment_available_bytes (fifo_segment_t * fs);
313 * Number of bytes on chunk free lists
315 * @param fs fifo segment
316 * @return free bytes on chunk free lists
318 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
319 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
320 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
322 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
323 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
325 svm_fifo_chunk_t *fifo_segment_alloc_chunk_w_slice (fifo_segment_t *fs,
328 void fifo_segment_collect_chunk (fifo_segment_t *fs, u32 slice_index,
329 svm_fifo_chunk_t *c);
330 uword fifo_segment_chunk_offset (fifo_segment_t *fs, svm_fifo_chunk_t *c);
333 * Find number of free chunks of given size
335 * @param fs fifo segment
336 * @param size chunk size of interest or ~0 if all should be counted
337 * @return number of chunks of given size
339 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
341 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
342 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
344 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
345 u32 timeout_in_seconds);
347 format_function_t format_fifo_segment;
348 format_function_t format_fifo_segment_type;
350 #endif /* __included_fifo_segment_h__ */
353 * fd.io coding-style-patch-verification: ON
356 * eval: (c-set-style "gnu")