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/svm_fifo.h>
23 FIFO_SEGMENT_FTYPE_NONE = -1,
24 FIFO_SEGMENT_RX_FIFO = 0,
27 } fifo_segment_ftype_t;
29 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096 /* 4kB min fifo size */
30 #define FIFO_SEGMENT_MAX_FIFO_SIZE (2 << 30) /* 2GB max fifo size */
31 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32 /* Allocation quantum */
33 typedef enum fifo_segment_flags_
35 FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
36 FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
37 } fifo_segment_flags_t;
41 svm_fifo_t *fifos; /**< Linked list of active RX fifos */
42 svm_fifo_t *free_fifos; /**< Freelists by fifo size */
43 svm_fifo_chunk_t **free_chunks; /**< Freelists by chunk size */
44 u32 n_active_fifos; /**< Number of active fifos */
45 u8 flags; /**< Segment flags */
46 u32 n_free_bytes; /**< Bytes usable for new allocs */
47 u32 n_fl_chunk_bytes; /**< Chunk bytes on freelist */
48 } fifo_segment_header_t;
52 ssvm_private_t ssvm; /**< ssvm segment data */
53 fifo_segment_header_t *h; /**< fifo segment data */
58 fifo_segment_t *segments; /**< pool of fifo segments */
59 u64 next_baseva; /**< Where to put the next one */
60 u32 timeout_in_seconds; /**< Time to wait during attach */
61 } fifo_segment_main_t;
65 ssvm_segment_type_t segment_type; /**< type of segment requested */
66 u32 segment_size; /**< size of the segment */
67 int memfd_fd; /**< fd for memfd segments */
68 char *segment_name; /**< segment name */
69 u32 *new_segment_indices; /**< return vec of new seg indices */
70 } fifo_segment_create_args_t;
72 #define fifo_segment_flags(_fs) _fs->h->flags
74 int fifo_segment_init (fifo_segment_t * fs);
75 int fifo_segment_create (fifo_segment_main_t * sm,
76 fifo_segment_create_args_t * a);
77 int fifo_segment_attach (fifo_segment_main_t * sm,
78 fifo_segment_create_args_t * a);
79 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
80 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
82 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
83 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
86 * Allocate fifo in fifo segment
88 * @param fs fifo segment for fifo
89 * @param data_bytes size of default fifo chunk in bytes
90 * @param ftype fifo type @ref fifo_segment_ftype_t
91 * @return new fifo or 0 if alloc failed
93 svm_fifo_t *fifo_segment_alloc_fifo (fifo_segment_t * fs,
95 fifo_segment_ftype_t ftype);
98 * Free fifo allocated in fifo segment
100 * @param fs fifo segment for fifo
101 * @param f fifo to be freed
103 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
106 * Try to preallocate fifo headers
108 * Tries to preallocate fifo headers and adds them to freelist.
110 * @param fs fifo segment
111 * @param batch_size number of chunks to be allocated
112 * @return 0 on success, negative number otherwise
114 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 batch_size);
117 * Try to preallocate fifo chunks on segment
119 * Tries to preallocate chunks of requested size on segment and adds them
122 * @param fs fifo segment
123 * @param chunk_size size of chunks to be allocated in bytes
124 * @param batch_size number of chunks to be allocated
125 * @return 0 on success, negative number otherwise
127 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 chunk_size,
130 * Pre-allocates fifo pairs in fifo segment
132 * The number of fifos pre-allocated is the minimum of the requested number
133 * of pairs and the maximum number that fit within the segment. If the maximum
134 * is hit, the number of fifo pairs requested is updated by subtracting the
135 * number of fifos that have been successfully allocated.
137 * @param fs fifo segment for fifo
138 * @param rx_fifo_size data size of rx fifos
139 * @param tx_fifo_size data size of tx fifos
140 * @param n_fifo_pairs number of pairs requested. Prior to returning, this
141 * is decremented by the the number of pairs allocated.
143 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
148 * Grow fifo size by adding an additional chunk of memory
150 * @param fs fifo segment for fifo
151 * @param f fifo to be grown
152 * @param chunk_size number of bytes to be added to fifo
153 * @return 0 on success or a negative number otherwise
155 int fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f,
159 * Collect unused chunks for fifo
161 * @param fs fifo segment for fifo
162 * @param f fifo whose chunks are to be collected
163 * @return 0 on success, error otherwise
165 int fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f);
168 * Fifo segment estimate of number of free bytes
170 * Returns fifo segment's internal estimate of the number of free bytes.
171 * To force a synchronization between the segment and the underlying
172 * memory allocator, call @ref fifo_segment_update_free_bytes
174 * @param fs fifo segment
175 * @return free bytes estimate
177 u32 fifo_segment_free_bytes (fifo_segment_t * fs);
180 * Update fifo segment free bytes estimate
182 * Forces fifo segment free bytes estimate synchronization with underlying
185 * @param fs fifo segment
187 void fifo_segment_update_free_bytes (fifo_segment_t * fs);
190 * Number of bytes on chunk free lists
192 * @param fs fifo segment
193 * @return free bytes on chunk free lists
195 u32 fifo_segment_chunk_prealloc_bytes (fifo_segment_t * fs);
196 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
197 svm_fifo_t *fifo_segment_get_fifo_list (fifo_segment_t * fs);
198 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
199 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
201 * Find number of free chunks of given size
203 * @param fs fifo segment
204 * @param size chunk size of interest or ~0 if all should be counted
205 * @return number of chunks of given size
207 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
209 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
210 u32 timeout_in_seconds);
212 format_function_t format_fifo_segment;
213 format_function_t format_fifo_segment_type;
215 #endif /* __included_fifo_segment_h__ */
218 * fd.io coding-style-patch-verification: ON
221 * eval: (c-set-style "gnu")