FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
fifo_segment.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_fifo_segment_h__
16 #define __included_fifo_segment_h__
17 
18 #include <svm/ssvm.h>
19 #include <svm/fifo_types.h>
20 #include <svm/message_queue.h>
21 #include <svm/svm_fifo.h>
22 
23 typedef enum
24 {
30 
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 */
35 
36 typedef enum fifo_segment_flags_
37 {
42 
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")
48 
49 typedef enum
50 {
51 #define _(sym,str) MEMORY_PRESSURE_##sym,
53 #undef _
56 
57 #if 0
58 typedef enum fifo_segment_mem_status_
59 {
60  MEMORY_PRESSURE_NO_PRESSURE,
61  MEMORY_PRESSURE_LOW_PRESSURE,
62  MEMORY_PRESSURE_HIGH_PRESSURE,
63  MEMORY_PRESSURE_NO_MEMORY,
65 #endif
66 
67 typedef struct
68 {
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 */
76 
77 typedef struct
78 {
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 */
83 
84 typedef struct
85 {
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 */
92 
93 #define fifo_segment_flags(_fs) _fs->h->flags
94 
103  u32 fs_index);
105  u32 segment_index);
107 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
108 
109 always_inline void *
111 {
112  return (void *) ((u8 *) fs->h + offset);
113 }
114 
117 {
118  return (uword) ((u8 *) p - (u8 *) fs->h);
119 }
120 
121 /**
122  * Allocate fifo in fifo segment
123  *
124  * @param fs fifo segment for fifo
125  * @param data_bytes size of default fifo chunk in bytes
126  * @param ftype fifo type @ref fifo_segment_ftype_t
127  * @return new fifo or 0 if alloc failed
128  */
130  u32 slice_index,
131  u32 data_bytes,
132  fifo_segment_ftype_t ftype);
134  uword offset);
136 
137 /**
138  * Free fifo allocated in fifo segment
139  *
140  * @param fs fifo segment for fifo
141  * @param f fifo to be freed
142  */
144 
145 /**
146  * Free fifo allocated by external applications
147  *
148  * @params fs fifo segment for fifo
149  * @param f fifo to be freed
150  */
152 
155  u32 slice_index);
157 
158 /**
159  * Allocate message queue on segment
160  *
161  * @param fs fifo segment for mq
162  * @param mq_index index in private mqs vector to use to attach
163  * @param cfg configuration for mq
164  * @return attached message queue
165  */
167  svm_msg_q_cfg_t *cfg);
168 
169 /**
170  * Attach message queue at fifo segment offset
171  *
172  * @param fs fifo segment for mq
173  * @param offset offset for shared mq on the segment
174  * @param mq_index index in private mqs vector to use to attach
175  * @return attached message queue
176  */
178  u32 mq_index);
179 
180 /**
181  * Discover mqs on mq only segment
182  *
183  * @param fs fifo segment for mq
184  * @param fds array of fds is mqs use eventfds
185  * @param n_fds number of fds
186  */
187 void fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds);
188 
189 /**
190  * Message queue offset on segment
191  *
192  * @param fs fifo segment for mq
193  * @param mq_index index of mq in private mqs vector
194  * @return offset of the shared mq the private mq is attached to
195  */
197 
198 /**
199  * Try to preallocate fifo headers
200  *
201  * Tries to preallocate fifo headers and adds them to freelist.
202  *
203  * @param fs fifo segment
204  * @param batch_size number of chunks to be allocated
205  * @return 0 on success, negative number otherwise
206  */
207 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
208  u32 batch_size);
209 
210 /**
211  * Try to preallocate fifo chunks on segment
212  *
213  * Tries to preallocate chunks of requested size on segment and adds them
214  * to chunk freelist.
215  *
216  * @param fs fifo segment
217  * @param chunk_size size of chunks to be allocated in bytes
218  * @param batch_size number of chunks to be allocated
219  * @return 0 on success, negative number otherwise
220  */
222  u32 chunk_size, u32 batch_size);
223 /**
224  * Pre-allocates fifo pairs in fifo segment
225  *
226  * The number of fifos pre-allocated is the minimum of the requested number
227  * of pairs and the maximum number that fit within the segment. If the maximum
228  * is hit, the number of fifo pairs requested is updated by subtracting the
229  * number of fifos that have been successfully allocated.
230  *
231  * @param fs fifo segment for fifo
232  * @param rx_fifo_size data size of rx fifos
233  * @param tx_fifo_size data size of tx fifos
234  * @param n_fifo_pairs number of pairs requested. Prior to returning, this
235  * is decremented by the the number of pairs allocated.
236  */
238  u32 rx_fifo_size,
239  u32 tx_fifo_size,
240  u32 * n_fifo_pairs);
241 
242 /**
243  * Allocate chunks in fifo segment
244  *
245  * @param fsh fifo segment header
246  * @param slice_index slice where chunks should be alocated
247  * @param chunk_size chunk size needed
248  * @return chunk (or chunks) that cover at least chunk_size bytes
249  * on success, 0 on failure.
250  */
252  u32 slice_index, u32 chunk_size);
253 
254 /**
255  * Return chunks to fifo segment
256  *
257  * @param fsh fifo segment header
258  * @param slice_index slice where chunks should be returned
259  * @param c pointer to first chunk in 0 terminated linked list
260  */
261 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
262  svm_fifo_chunk_t * c);
263 
264 /**
265  * Fifo segment has reached mem limit
266  *
267  * @param fsh fifo segment header
268  * @return 1 (if reached) or 0 (otherwise)
269  */
271 
272 /**
273  * Fifo segment reset mem limit flag
274  *
275  * @param fs fifo segment
276  */
278 
279 /**
280  * Fifo segment reset mem limit flag
281  *
282  * @param fs fifo segment
283  * @param size size requested
284  * @return pointer to memory allocated or 0
285  */
287 /**
288  * Fifo segment allocated size
289  *
290  * Returns fifo segment's allocated size
291  *
292  * @param fs fifo segment
293  * @return allocated size in bytes
294  */
296 
297 /**
298  * Fifo segment estimate of number of free bytes
299  *
300  * Returns fifo segment's internal estimate of the number of free bytes.
301  * To force a synchronization between the segment and the underlying
302  * memory allocator, call @ref fifo_segment_update_free_bytes
303  *
304  * @param fs fifo segment
305  * @return free bytes estimate
306  */
308 
309 /**
310  * Fifo segment number of cached bytes
311  *
312  * Returns fifo segment's number of cached bytes.
313  *
314  * @param fs fifo segment
315  * @return cached bytes
316  */
318 
320 
321 /**
322  * Number of bytes on chunk free lists
323  *
324  * @param fs fifo segment
325  * @return free bytes on chunk free lists
326  */
330  u32 slice_index);
333 
335  u32 slice_index,
336  u32 chunk_size);
337 void fifo_segment_collect_chunk (fifo_segment_t *fs, u32 slice_index,
340 
341 /**
342  * Find number of free chunks of given size
343  *
344  * @param fs fifo segment
345  * @param size chunk size of interest or ~0 if all should be counted
346  * @return number of chunks of given size
347  */
349 
352  (fifo_segment_header_t * fsh, u8 usage);
354 
356  u32 timeout_in_seconds);
357 
360 
361 #endif /* __included_fifo_segment_h__ */
362 
363 /*
364  * fd.io coding-style-patch-verification: ON
365  *
366  * Local Variables:
367  * eval: (c-set-style "gnu")
368  * End:
369  */
fifo_segment_msg_q_alloc
svm_msg_q_t * fifo_segment_msg_q_alloc(fifo_segment_t *fs, u32 mq_index, svm_msg_q_cfg_t *cfg)
Allocate message queue on segment.
Definition: fifo_segment.c:1078
fifo_segment_prealloc_fifo_chunks
int fifo_segment_prealloc_fifo_chunks(fifo_segment_t *fs, u32 slice_index, u32 chunk_size, u32 batch_size)
Try to preallocate fifo chunks on segment.
Definition: fifo_segment.c:1185
fifo_segment_determine_status
fifo_segment_mem_status_t fifo_segment_determine_status(fifo_segment_header_t *fsh, u8 usage)
Definition: fifo_segment.c:1463
fifo_segment_offset
static uword fifo_segment_offset(fifo_segment_t *fs, void *p)
Definition: fifo_segment.h:116
fifo_segment_preallocate_fifo_pairs
void fifo_segment_preallocate_fifo_pairs(fifo_segment_t *fs, u32 rx_fifo_size, u32 tx_fifo_size, u32 *n_fifo_pairs)
Pre-allocates fifo pairs in fifo segment.
Definition: fifo_segment.c:1208
fifo_segment_num_fifos
u32 fifo_segment_num_fifos(fifo_segment_t *fs)
Get number of active fifos.
Definition: fifo_segment.c:1274
fifo_segment_free_client_fifo
void fifo_segment_free_client_fifo(fifo_segment_t *fs, svm_fifo_t *f)
Free fifo allocated by external applications.
Definition: fifo_segment.c:978
FIFO_SEGMENT_FTYPE_NONE
@ FIFO_SEGMENT_FTYPE_NONE
Definition: fifo_segment.h:25
fifo_segment_main_t::timeout_in_seconds
u32 timeout_in_seconds
Time to wait during attach.
Definition: fifo_segment.h:81
fifo_segment_alloc
void * fifo_segment_alloc(fifo_segment_t *fs, uword size)
Fifo segment reset mem limit flag.
Definition: fifo_segment.c:1392
fsh_has_reached_mem_limit
u8 fsh_has_reached_mem_limit(fifo_segment_header_t *fsh)
Fifo segment has reached mem limit.
Definition: fifo_segment.c:1380
f
vlib_frame_t * f
Definition: interface_output.c:1080
fifo_segment_create
int fifo_segment_create(fifo_segment_main_t *sm, fifo_segment_create_args_t *a)
Create a fifo segment and initialize as master.
Definition: fifo_segment.c:347
usage
static void usage(void)
Definition: health_check.c:14
fifo_segment_t
Definition: fifo_segment.h:67
svm_fifo_chunk_
Definition: fifo_types.h:38
message_queue.h
Unidirectional shared-memory multi-ring message queue.
fifo_segment_main_t::next_baseva
uword next_baseva
Where to put the next one.
Definition: fifo_segment.h:80
fifo_segment_free_bytes
uword fifo_segment_free_bytes(fifo_segment_t *fs)
Fifo segment estimate of number of free bytes.
Definition: fifo_segment.c:1402
fifo_segment_attach
int fifo_segment_attach(fifo_segment_main_t *sm, fifo_segment_create_args_t *a)
Attach as slave to a fifo segment.
Definition: fifo_segment.c:381
fifo_segment_create_args_t::memfd_fd
int memfd_fd
fd for memfd segments
Definition: fifo_segment.h:88
ssvm_segment_type_t
enum ssvm_segment_type_ ssvm_segment_type_t
foreach_segment_mem_status
#define foreach_segment_mem_status
Definition: fifo_segment.h:43
fifo_segment_has_fifos
u8 fifo_segment_has_fifos(fifo_segment_t *fs)
Definition: fifo_segment.c:1437
svm_fifo_t
struct _svm_fifo svm_fifo_t
fifo_segment_create_args_t::segment_size
u32 segment_size
size of the segment
Definition: fifo_segment.h:87
fifo_segment_msg_q_offset
uword fifo_segment_msg_q_offset(fifo_segment_t *fs, u32 mq_index)
Message queue offset on segment.
Definition: fifo_segment.c:1162
fifo_segment_init
int fifo_segment_init(fifo_segment_t *fs)
Initialize fifo segment shared header.
Definition: fifo_segment.c:295
fifo_segment_alloc_chunk_w_slice
svm_fifo_chunk_t * fifo_segment_alloc_chunk_w_slice(fifo_segment_t *fs, u32 slice_index, u32 chunk_size)
Definition: fifo_segment.c:1054
svm_fifo.h
fifo_segment_flags_
fifo_segment_flags_
Definition: fifo_segment.h:36
fifo_segment_num_free_fifos
u32 fifo_segment_num_free_fifos(fifo_segment_t *fs)
Definition: fifo_segment.c:1298
fifo_segment_header_
Definition: fifo_types.h:137
c
svmdb_client_t * c
Definition: vpp_get_metrics.c:48
FIFO_SEGMENT_F_MEM_LIMIT
@ FIFO_SEGMENT_F_MEM_LIMIT
Definition: fifo_segment.h:40
fifo_segment_chunk_offset
uword fifo_segment_chunk_offset(fifo_segment_t *fs, svm_fifo_chunk_t *c)
Definition: fifo_segment.c:1072
uword
u64 uword
Definition: types.h:112
fifo_segment_fifo_offset
uword fifo_segment_fifo_offset(svm_fifo_t *f)
Definition: fifo_segment.c:1048
fifo_segment_delete
void fifo_segment_delete(fifo_segment_main_t *sm, fifo_segment_t *fs)
Definition: fifo_segment.c:420
fifo_segment_attach_fifo
void fifo_segment_attach_fifo(fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
Definition: fifo_segment.c:1011
address
manual_print typedef address
Definition: ip_types.api:96
fifo_segment_ptr
static void * fifo_segment_ptr(fifo_segment_t *fs, uword offset)
Definition: fifo_segment.h:110
FIFO_SEGMENT_TX_FIFO
@ FIFO_SEGMENT_TX_FIFO
Definition: fifo_segment.h:27
fifo_segment_available_bytes
uword fifo_segment_available_bytes(fifo_segment_t *fs)
Definition: fifo_segment.c:1414
fifo_segment_alloc_fifo_w_offset
svm_fifo_t * fifo_segment_alloc_fifo_w_offset(fifo_segment_t *fs, uword offset)
Definition: fifo_segment.c:891
format_fifo_segment_type
format_function_t format_fifo_segment_type
Definition: fifo_segment.h:359
fifo_segment_size
uword fifo_segment_size(fifo_segment_t *fs)
Fifo segment allocated size.
Definition: fifo_segment.c:1374
svm_msg_q_
Definition: message_queue.h:72
fifo_segment_get_mem_status
fifo_segment_mem_status_t fifo_segment_get_mem_status(fifo_segment_t *fs)
Definition: fifo_segment.c:1489
fifo_segment_detach_fifo
void fifo_segment_detach_fifo(fifo_segment_t *fs, svm_fifo_t **f)
Definition: fifo_segment.c:984
fifo_segment_t::n_slices
u8 n_slices
number of fifo segment slices
Definition: fifo_segment.h:72
FIFO_SEGMENT_RX_FIFO
@ FIFO_SEGMENT_RX_FIFO
Definition: fifo_segment.h:26
fifo_segment_create_args_t::segment_type
ssvm_segment_type_t segment_type
type of segment requested
Definition: fifo_segment.h:86
fsh_alloc_chunk
svm_fifo_chunk_t * fsh_alloc_chunk(fifo_segment_header_t *fsh, u32 slice_index, u32 chunk_size)
Allocate chunks in fifo segment.
Definition: fifo_segment.c:761
format_function_t
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
fifo_segment_t::ssvm
ssvm_private_t ssvm
ssvm segment data
Definition: fifo_segment.h:69
size
u32 size
Definition: vhost_user.h:125
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
clib_bihash_value
template key/value backing page structure
Definition: bihash_doc.h:44
fifo_segment_index
u32 fifo_segment_index(fifo_segment_main_t *sm, fifo_segment_t *fs)
Definition: fifo_segment.c:429
fifo_segment_get_segment_if_valid
fifo_segment_t * fifo_segment_get_segment_if_valid(fifo_segment_main_t *sm, u32 segment_index)
Definition: fifo_segment.c:441
fifo_slice_private_
Definition: fifo_types.h:130
fifo_segment_prealloc_fifo_hdrs
int fifo_segment_prealloc_fifo_hdrs(fifo_segment_t *fs, u32 slice_index, u32 batch_size)
Try to preallocate fifo headers.
Definition: fifo_segment.c:1174
u64
unsigned long u64
Definition: types.h:89
fifo_segment_msg_qs_discover
void fifo_segment_msg_qs_discover(fifo_segment_t *fs, int *fds, u32 n_fds)
Discover mqs on mq only segment.
Definition: fifo_segment.c:1130
FIFO_SEGMENT_F_WILL_DELETE
@ FIFO_SEGMENT_F_WILL_DELETE
Definition: fifo_segment.h:39
fifo_segment_fl_chunk_bytes
uword fifo_segment_fl_chunk_bytes(fifo_segment_t *fs)
Number of bytes on chunk free lists.
Definition: fifo_segment.c:1420
u32
unsigned int u32
Definition: types.h:88
fifo_segment_get_slice_fifo_list
svm_fifo_t * fifo_segment_get_slice_fifo_list(fifo_segment_t *fs, u32 slice_index)
Definition: fifo_segment.c:1443
fifo_segment_collect_chunk
void fifo_segment_collect_chunk(fifo_segment_t *fs, u32 slice_index, svm_fifo_chunk_t *c)
Definition: fifo_segment.c:1065
FIFO_SEGMENT_N_FTYPES
@ FIFO_SEGMENT_N_FTYPES
Definition: fifo_segment.h:28
fsh_collect_chunks
void fsh_collect_chunks(fifo_segment_header_t *fsh, u32 slice_index, svm_fifo_chunk_t *c)
Return chunks to fifo segment.
Definition: fifo_segment.c:794
fifo_segment_t::max_byte_index
uword max_byte_index
Definition: fifo_segment.h:71
fsh_reset_mem_limit
void fsh_reset_mem_limit(fifo_segment_header_t *fsh)
Fifo segment reset mem limit flag.
Definition: fifo_segment.c:1386
fifo_segment_main_t
Definition: fifo_segment.h:77
fifo_segment_create_args_t::segment_name
char * segment_name
segment name
Definition: fifo_segment.h:89
fifo_segment_cleanup
void fifo_segment_cleanup(fifo_segment_t *fs)
Definition: fifo_segment.c:826
svm_msg_q_cfg_
Definition: message_queue.h:85
fifo_segment_create_args_t::new_segment_indices
u32 * new_segment_indices
return vec of new seg indices
Definition: fifo_segment.h:90
fifo_segment_flags_t
enum fifo_segment_flags_ fifo_segment_flags_t
fifo_segment_num_free_chunks
u32 fifo_segment_num_free_chunks(fifo_segment_t *fs, u32 size)
Find number of free chunks of given size.
Definition: fifo_segment.c:1358
fifo_segment_t::mqs
svm_msg_q_t * mqs
private vec of attached mqs
Definition: fifo_segment.h:74
u8
unsigned char u8
Definition: types.h:56
a
a
Definition: bitmap.h:544
fifo_segment_cached_bytes
uword fifo_segment_cached_bytes(fifo_segment_t *fs)
Fifo segment number of cached bytes.
Definition: fifo_segment.c:1408
fifo_segment_main_t::segments
fifo_segment_t * segments
pool of fifo segments
Definition: fifo_segment.h:79
fifo_segment_t::slices
fifo_slice_private_t * slices
private slice information
Definition: fifo_segment.h:73
fifo_segment_get_segment
fifo_segment_t * fifo_segment_get_segment(fifo_segment_main_t *sm, u32 fs_index)
Definition: fifo_segment.c:435
fifo_segment_alloc_fifo_w_slice
svm_fifo_t * fifo_segment_alloc_fifo_w_slice(fifo_segment_t *fs, u32 slice_index, u32 data_bytes, fifo_segment_ftype_t ftype)
Allocate fifo in fifo segment.
Definition: fifo_segment.c:846
fifo_segment_get_mem_usage
u8 fifo_segment_get_mem_usage(fifo_segment_t *fs)
Definition: fifo_segment.c:1452
fifo_segment_free_fifo
void fifo_segment_free_fifo(fifo_segment_t *fs, svm_fifo_t *f)
Free fifo allocated in fifo segment.
Definition: fifo_segment.c:918
fifo_segment_ftype_t
fifo_segment_ftype_t
Definition: fifo_segment.h:23
fifo_segment_main_init
void fifo_segment_main_init(fifo_segment_main_t *sm, u64 baseva, u32 timeout_in_seconds)
Definition: fifo_segment.c:456
ssvm.h
ssvm_private_t
Definition: ssvm.h:81
fifo_segment_create_args_t
Definition: fifo_segment.h:84
fifo_segment_t::h
fifo_segment_header_t * h
fifo segment data
Definition: fifo_segment.h:70
fifo_segment_msg_q_attach
svm_msg_q_t * fifo_segment_msg_q_attach(fifo_segment_t *fs, uword offset, u32 mq_index)
Attach message queue at fifo segment offset.
Definition: fifo_segment.c:1105
MEMORY_N_PRESSURE
@ MEMORY_N_PRESSURE
Definition: fifo_segment.h:54
fifo_segment_info
void fifo_segment_info(fifo_segment_t *seg, char **address, size_t *size)
Definition: fifo_segment.c:449
FIFO_SEGMENT_F_IS_PREALLOCATED
@ FIFO_SEGMENT_F_IS_PREALLOCATED
Definition: fifo_segment.h:38
fifo_types.h
fifo_segment_duplicate_fifo
svm_fifo_t * fifo_segment_duplicate_fifo(fifo_segment_t *fs, svm_fifo_t *f)
Definition: fifo_segment.c:907
fifo_segment_mem_status_t
fifo_segment_mem_status_t
Definition: fifo_segment.h:49
format_fifo_segment
format_function_t format_fifo_segment
Definition: fifo_segment.h:358