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_F_CUSTOM_USE = 1 << 3,
42 } fifo_segment_flags_t;
44 #define foreach_segment_mem_status \
45 _(NO_PRESSURE, "No pressure") \
46 _(LOW_PRESSURE, "Low pressure") \
47 _(HIGH_PRESSURE, "High pressure") \
48 _(NO_MEMORY, "No memory")
52 #define _(sym,str) MEMORY_PRESSURE_##sym,
53 foreach_segment_mem_status
56 } fifo_segment_mem_status_t;
59 typedef enum fifo_segment_mem_status_
61 MEMORY_PRESSURE_NO_PRESSURE,
62 MEMORY_PRESSURE_LOW_PRESSURE,
63 MEMORY_PRESSURE_HIGH_PRESSURE,
64 MEMORY_PRESSURE_NO_MEMORY,
65 } fifo_segment_mem_status_t;
70 ssvm_private_t ssvm; /**< ssvm segment data */
71 fifo_segment_header_t *h; /**< fifo segment data */
72 fifo_slice_private_t *slices; /**< private slice information */
73 svm_msg_q_t *mqs; /**< private vec of attached mqs */
74 uword max_byte_index; /**< max byte index for segment */
75 u8 n_slices; /**< number of fifo segment slices */
76 u8 flags; /**< private fifo segment flags */
77 u8 high_watermark; /**< memory pressure watermark high */
78 u8 low_watermark; /**< memory pressure watermark low */
83 fifo_segment_t *segments; /**< pool of fifo segments */
84 uword next_baseva; /**< Where to put the next one */
85 u32 timeout_in_seconds; /**< Time to wait during attach */
86 } fifo_segment_main_t;
90 ssvm_segment_type_t segment_type; /**< type of segment requested */
91 u32 segment_size; /**< size of the segment */
92 int memfd_fd; /**< fd for memfd segments */
93 char *segment_name; /**< segment name */
94 u32 *new_segment_indices; /**< return vec of new seg indices */
95 } fifo_segment_create_args_t;
97 #define fifo_segment_flags(_fs) _fs->flags
99 int fifo_segment_init (fifo_segment_t * fs);
100 int fifo_segment_create (fifo_segment_main_t * sm,
101 fifo_segment_create_args_t * a);
102 int fifo_segment_attach (fifo_segment_main_t * sm,
103 fifo_segment_create_args_t * a);
104 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
105 void fifo_segment_cleanup (fifo_segment_t *fs);
106 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
108 fifo_segment_t *fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm,
110 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
111 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
114 fifo_segment_ptr (fifo_segment_t *fs, uword offset)
116 return (void *) ((u8 *) fs->h + offset);
120 fifo_segment_offset (fifo_segment_t *fs, void *p)
122 return (uword) ((u8 *) p - (u8 *) fs->h);
126 * Allocate fifo in fifo segment
128 * @param fs fifo segment for fifo
129 * @param data_bytes size of default fifo chunk in bytes
130 * @param ftype fifo type @ref fifo_segment_ftype_t
131 * @return new fifo or 0 if alloc failed
133 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
136 fifo_segment_ftype_t ftype);
137 svm_fifo_t *fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs,
139 svm_fifo_t *fifo_segment_duplicate_fifo (fifo_segment_t *fs, svm_fifo_t *f);
142 * Free fifo allocated in fifo segment
144 * @param fs fifo segment for fifo
145 * @param f fifo to be freed
147 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
150 * Free fifo allocated by external applications
152 * @params fs fifo segment for fifo
153 * @param f fifo to be freed
155 void fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f);
157 void fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f);
158 void fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f,
160 uword fifo_segment_fifo_offset (svm_fifo_t *f);
163 * Allocate message queue on segment
165 * @param fs fifo segment for mq
166 * @param mq_index index in private mqs vector to use to attach
167 * @param cfg configuration for mq
168 * @return attached message queue
170 svm_msg_q_t *fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
171 svm_msg_q_cfg_t *cfg);
174 * Attach message queue at fifo segment offset
176 * @param fs fifo segment for mq
177 * @param offset offset for shared mq on the segment
178 * @param mq_index index in private mqs vector to use to attach
179 * @return attached message queue
181 svm_msg_q_t *fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset,
185 * Discover mqs on mq only segment
187 * @param fs fifo segment for mq
188 * @param fds array of fds is mqs use eventfds
189 * @param n_fds number of fds
191 void fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds);
194 * Message queue offset on segment
196 * @param fs fifo segment for mq
197 * @param mq_index index of mq in private mqs vector
198 * @return offset of the shared mq the private mq is attached to
200 uword fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index);
203 * Try to preallocate fifo headers
205 * Tries to preallocate fifo headers and adds them to freelist.
207 * @param fs fifo segment
208 * @param batch_size number of chunks to be allocated
209 * @return 0 on success, negative number otherwise
211 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
215 * Try to preallocate fifo chunks on segment
217 * Tries to preallocate chunks of requested size on segment and adds them
220 * @param fs fifo segment
221 * @param chunk_size size of chunks to be allocated in bytes
222 * @param batch_size number of chunks to be allocated
223 * @return 0 on success, negative number otherwise
225 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
226 u32 chunk_size, u32 batch_size);
228 * Pre-allocates fifo pairs in fifo segment
230 * The number of fifos pre-allocated is the minimum of the requested number
231 * of pairs and the maximum number that fit within the segment. If the maximum
232 * is hit, the number of fifo pairs requested is updated by subtracting the
233 * number of fifos that have been successfully allocated.
235 * @param fs fifo segment for fifo
236 * @param rx_fifo_size data size of rx fifos
237 * @param tx_fifo_size data size of tx fifos
238 * @param n_fifo_pairs number of pairs requested. Prior to returning, this
239 * is decremented by the the number of pairs allocated.
241 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
247 * Allocate chunks in fifo segment
249 * @param fsh fifo segment header
250 * @param slice_index slice where chunks should be alocated
251 * @param chunk_size chunk size needed
252 * @return chunk (or chunks) that cover at least chunk_size bytes
253 * on success, 0 on failure.
255 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
256 u32 slice_index, u32 chunk_size);
259 * Return chunks to fifo segment
261 * @param fsh fifo segment header
262 * @param slice_index slice where chunks should be returned
263 * @param c pointer to first chunk in 0 terminated linked list
265 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
266 svm_fifo_chunk_t * c);
269 * Fifo segment reset mem limit flag
271 * @param fs fifo segment
272 * @param size size requested
273 * @return pointer to memory allocated or 0
275 void *fifo_segment_alloc (fifo_segment_t *fs, uword size);
277 * Fifo segment allocated size
279 * Returns fifo segment's allocated size
281 * @param fs fifo segment
282 * @return allocated size in bytes
284 uword fifo_segment_size (fifo_segment_t * fs);
287 * Fifo segment estimate of number of free bytes
289 * Returns fifo segment's internal estimate of the number of free bytes.
290 * To force a synchronization between the segment and the underlying
291 * memory allocator, call @ref fifo_segment_update_free_bytes
293 * @param fs fifo segment
294 * @return free bytes estimate
296 uword fifo_segment_free_bytes (fifo_segment_t * fs);
299 * Fifo segment number of cached bytes
301 * Returns fifo segment's number of cached bytes.
303 * @param fs fifo segment
304 * @return cached bytes
306 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
308 uword fifo_segment_available_bytes (fifo_segment_t * fs);
311 * Number of bytes on chunk free lists
313 * @param fs fifo segment
314 * @return free bytes on chunk free lists
316 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
317 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
318 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
320 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
321 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
323 svm_fifo_chunk_t *fifo_segment_alloc_chunk_w_slice (fifo_segment_t *fs,
326 void fifo_segment_collect_chunk (fifo_segment_t *fs, u32 slice_index,
327 svm_fifo_chunk_t *c);
328 uword fifo_segment_chunk_offset (fifo_segment_t *fs, svm_fifo_chunk_t *c);
331 * Find number of free chunks of given size
333 * @param fs fifo segment
334 * @param size chunk size of interest or ~0 if all should be counted
335 * @return number of chunks of given size
337 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
339 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
340 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
342 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
343 u32 timeout_in_seconds);
345 format_function_t format_fifo_segment;
346 format_function_t format_fifo_segment_type;
348 #endif /* __included_fifo_segment_h__ */
351 * fd.io coding-style-patch-verification: ON
354 * eval: (c-set-style "gnu")