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.
16 #include <svm/fifo_segment.h>
18 static inline fifo_segment_slice_t *
19 fsh_slice_get (fifo_segment_header_t * fsh, u32 slice_index)
21 return &fsh->slices[slice_index];
24 static char *fifo_segment_mem_status_strings[] = {
25 #define _(sym,str) str,
26 foreach_segment_mem_status
31 * Fifo segment free space
33 * Queries the underlying memory manager, dlmalloc, for free space. Since this
34 * ends up walking the internal data structures, it should not be called
37 * @param fs fifo segment
38 * @return number of free bytes
41 fsh_free_space (fifo_segment_header_t * fsh)
43 return clib_mem_get_heap_free_space (fsh->ssvm_sh->heap);
47 fsh_free_bytes_sub (fifo_segment_header_t * fsh, int size)
49 clib_atomic_fetch_sub_rel (&fsh->n_free_bytes, size);
53 fsh_n_free_bytes (fifo_segment_header_t * fsh)
55 uword n_free = clib_atomic_load_relax_n (&fsh->n_free_bytes);
56 return n_free > fsh->n_reserved_bytes ? n_free - fsh->n_reserved_bytes : 0;
60 fsh_update_free_bytes (fifo_segment_header_t * fsh)
62 clib_atomic_store_rel_n (&fsh->n_free_bytes, fsh_free_space (fsh));
66 fsh_cached_bytes_add (fifo_segment_header_t * fsh, int size)
68 clib_atomic_fetch_add_rel (&fsh->n_cached_bytes, size);
72 fsh_cached_bytes_sub (fifo_segment_header_t * fsh, int size)
74 clib_atomic_fetch_sub_rel (&fsh->n_cached_bytes, size);
78 fsh_n_cached_bytes (fifo_segment_header_t * fsh)
80 uword n_cached = clib_atomic_load_relax_n (&fsh->n_cached_bytes);
85 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
87 clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
91 fsh_n_active_fifos (fifo_segment_header_t * fsh)
93 return clib_atomic_load_relax_n (&fsh->n_active_fifos);
97 fsh_virtual_mem (fifo_segment_header_t * fsh)
99 fifo_segment_slice_t *fss;
103 for (i = 0; i < fsh->n_slices; i++)
105 fss = fsh_slice_get (fsh, i);
106 total_vm += clib_atomic_load_relax_n (&fss->virtual_mem);
112 fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
115 fifo_segment_slice_t *fss = fsh_slice_get (fsh, slice_index);
116 fss->virtual_mem += n_bytes;
120 fsh_check_mem (fifo_segment_header_t * fsh)
124 if (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT)
127 thresh = clib_max (0.01 * fsh->ssvm_sh->ssvm_size,
128 2 * fsh->n_reserved_bytes);
129 if (fsh->n_free_bytes > thresh)
132 fsh->flags |= FIFO_SEGMENT_F_MEM_LIMIT;
133 fsh_update_free_bytes (fsh);
137 fss_chunk_fl_index_is_valid (fifo_segment_slice_t * fss, u32 fl_index)
139 return (fl_index < vec_len (fss->free_chunks));
143 fss_chunk_free_list_push (fifo_segment_slice_t * fss, u32 fl_index,
144 svm_fifo_chunk_t * c)
146 c->next = fss->free_chunks[fl_index];
147 fss->free_chunks[fl_index] = c;
151 fss_chunk_free_list_push_list (fifo_segment_slice_t * fss, u32 fl_index,
152 svm_fifo_chunk_t * head,
153 svm_fifo_chunk_t * tail)
155 tail->next = fss->free_chunks[fl_index];
156 fss->free_chunks[fl_index] = head;
159 static svm_fifo_chunk_t *
160 fss_chunk_free_list_pop (fifo_segment_slice_t * fss, u32 fl_index)
164 ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
166 if (!fss->free_chunks[fl_index])
169 c = fss->free_chunks[fl_index];
170 fss->free_chunks[fl_index] = c->next;
176 fss_fifo_add_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
180 fss->fifos->prev = f;
181 f->next = fss->fifos;
187 fss_fifo_del_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
189 if (f->flags & SVM_FIFO_F_LL_TRACKED)
192 f->prev->next = f->next;
194 fss->fifos = f->next;
196 f->next->prev = f->prev;
201 * Initialize fifo segment shared header
204 fifo_segment_init (fifo_segment_t * fs)
206 fifo_segment_header_t *fsh;
207 fifo_segment_slice_t *fss;
208 ssvm_shared_header_t *sh;
215 oldheap = ssvm_push_heap (sh);
218 * Manually align the fifo segment header to sizeof(uword) = 8 bytes.
219 * Long story made short: the "process-private" fifo segment
220 * is allocated from the main heap, not mmapped. dlmalloc
221 * only guarantees 4-byte alignment, and on aarch64
222 * the fsh can end up 4-byte but not 8-byte aligned.
223 * That eventually causes the atomic op in fifo_segment_update_free_bytes
226 fsh = clib_mem_alloc_aligned (sizeof (*fsh), sizeof (uword));
227 clib_memset (fsh, 0, sizeof (*fsh));
228 fs->h = sh->opaque[0] = fsh;
229 fs->n_slices = clib_max (fs->n_slices, 1);
231 fsh->ssvm_sh = fs->ssvm.sh;
232 fsh->n_slices = fs->n_slices;
233 max_fifo = clib_min ((fsh_free_space (fsh) - 4096) / 2,
234 FIFO_SEGMENT_MAX_FIFO_SIZE);
235 fsh->max_log2_chunk_size = max_log2 (max_fifo);
237 fsh->slices = clib_mem_alloc (sizeof (*fss) * fs->n_slices);
238 clib_memset (fsh->slices, 0, sizeof (*fss) * fs->n_slices);
239 max_chunk_sz = fsh->max_log2_chunk_size - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
241 for (i = 0; i < fs->n_slices; i++)
243 fss = fsh_slice_get (fsh, i);
244 vec_validate_init_empty (fss->free_chunks, max_chunk_sz, 0);
245 vec_validate_init_empty (fss->num_chunks, max_chunk_sz, 0);
246 clib_spinlock_init (&fss->chunk_lock);
249 ssvm_pop_heap (oldheap);
251 fsh->n_free_bytes = fsh_free_space (fsh);
252 fsh->n_cached_bytes = 0;
253 fsh->n_reserved_bytes = clib_min (0.01 * fsh->n_free_bytes, 256 << 10);
259 * Create a fifo segment and initialize as master
262 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
268 /* Allocate a fresh segment */
269 pool_get_zero (sm->segments, fs);
271 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
272 fs->ssvm.ssvm_size = a->segment_size;
273 fs->ssvm.is_server = 1;
274 fs->ssvm.my_pid = getpid ();
275 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
276 fs->ssvm.requested_va = baseva;
278 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
280 pool_put (sm->segments, fs);
284 /* Note: requested_va updated due to seg base addr randomization */
285 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
287 fifo_segment_init (fs);
288 vec_add1 (a->new_segment_indices, fs - sm->segments);
293 * Attach as slave to a fifo segment
296 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
301 pool_get_zero (sm->segments, fs);
303 fs->ssvm.ssvm_size = a->segment_size;
304 fs->ssvm.my_pid = getpid ();
305 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
306 fs->ssvm.requested_va = sm->next_baseva;
307 if (a->segment_type == SSVM_SEGMENT_MEMFD)
308 fs->ssvm.fd = a->memfd_fd;
310 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
312 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
314 _vec_len (fs) = vec_len (fs) - 1;
318 /* Fish the segment header */
319 fs->h = fs->ssvm.sh->opaque[0];
321 vec_add1 (a->new_segment_indices, fs - sm->segments);
326 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
328 ssvm_delete (&s->ssvm);
329 clib_memset (s, 0xfe, sizeof (*s));
330 pool_put (sm->segments, s);
334 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
336 return s - sm->segments;
340 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
342 return pool_elt_at_index (sm->segments, segment_index);
346 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
348 *address = (char *) seg->ssvm.sh->ssvm_va;
349 *size = seg->ssvm.ssvm_size;
353 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
354 u32 timeout_in_seconds)
356 sm->next_baseva = baseva;
357 sm->timeout_in_seconds = timeout_in_seconds;
361 fs_freelist_for_size (u32 size)
363 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
365 return max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
369 fs_freelist_index_to_size (u32 fl_index)
371 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
375 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
378 * 4K minimum. It's not likely that anything good will happen
379 * with a smaller FIFO.
381 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE
382 && size <= (1ULL << fsh->max_log2_chunk_size);
386 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
387 fifo_segment_slice_t * fss, u32 data_bytes)
389 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
390 svm_fifo_chunk_t *c, *first = 0, *next;
392 fl_index = fs_freelist_for_size (req_bytes);
396 fl_size = fs_freelist_index_to_size (fl_index);
400 c = fss_chunk_free_list_pop (fss, fl_index);
406 req_bytes -= clib_min (fl_size, req_bytes);
410 /* Failed to allocate with smaller chunks */
413 /* Free all chunks if any allocated */
417 fl_index = fs_freelist_for_size (c->length);
419 fss_chunk_free_list_push (fss, fl_index, c);
424 /* As last attempt, try allocating a chunk larger than
425 * the requested size, if possible */
426 fl_index = fs_freelist_for_size (data_bytes) + 1;
427 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
429 first = fss_chunk_free_list_pop (fss, fl_index);
433 n_alloc = fs_freelist_index_to_size (fl_index);
439 fl_size = fl_size >> 1;
444 fss->n_fl_chunk_bytes -= n_alloc;
445 fsh_cached_bytes_sub (fsh, n_alloc);
450 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
451 fifo_segment_slice_t * fss, u32 batch_size)
459 size = (uword) sizeof (*f) * batch_size;
461 oldheap = ssvm_push_heap (fsh->ssvm_sh);
462 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
463 0 /* align_offset */ ,
464 0 /* os_out_of_memory */ );
465 ssvm_pop_heap (oldheap);
471 /* Carve fifo hdr space */
472 for (i = 0; i < batch_size; i++)
474 f = (svm_fifo_t *) fmem;
475 memset (f, 0, sizeof (*f));
476 f->next = fss->free_fifos;
485 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
486 fifo_segment_slice_t * fss,
487 u32 fl_index, u32 batch_size)
489 u32 rounded_data_size;
490 svm_fifo_chunk_t *c, *head = 0, *tail;
496 rounded_data_size = fs_freelist_index_to_size (fl_index);
497 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
499 oldheap = ssvm_push_heap (fsh->ssvm_sh);
500 cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
501 0 /* align_offset */ ,
502 0 /* os_out_of_memory */ );
503 ssvm_pop_heap (oldheap);
509 /* Carve fifo + chunk space */
510 tail = c = (svm_fifo_chunk_t *) cmem;
511 for (i = 0; i < batch_size; i++)
514 c->length = rounded_data_size;
515 c->enq_rb_index = RBTREE_TNIL_INDEX;
516 c->deq_rb_index = RBTREE_TNIL_INDEX;
519 cmem += sizeof (*c) + rounded_data_size;
520 c = (svm_fifo_chunk_t *) cmem;
523 fss_chunk_free_list_push_list (fss, fl_index, head, tail);
524 fss->num_chunks[fl_index] += batch_size;
525 fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
526 fsh_cached_bytes_add (fsh, batch_size * rounded_data_size);
527 fsh_free_bytes_sub (fsh, size);
533 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
534 fifo_segment_slice_t * fss,
535 u32 fl_index, u32 batch_size)
537 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
539 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
543 fsh_try_alloc_fifo_hdr (fifo_segment_header_t * fsh,
544 fifo_segment_slice_t * fss)
548 if (!fss->free_fifos)
550 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
551 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
556 fss->free_fifos = f->next;
557 memset (f, 0, sizeof (*f));
561 static svm_fifo_chunk_t *
562 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
563 fifo_segment_slice_t * fss, u32 data_bytes)
568 fl_index = fs_freelist_for_size (data_bytes);
571 c = fss_chunk_free_list_pop (fss, fl_index);
575 fss->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
576 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
580 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
583 chunk_size = fs_freelist_index_to_size (fl_index);
584 n_free = fsh_n_free_bytes (fsh);
586 if (chunk_size <= n_free)
588 batch = chunk_size * batch <= n_free ? batch : 1;
589 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
592 /* Failed to allocate larger chunk, try to allocate multi-chunk
593 * that is close to what was actually requested */
594 if (data_bytes <= fss->n_fl_chunk_bytes)
596 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
599 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
600 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
606 if (data_bytes <= fss->n_fl_chunk_bytes + n_free)
608 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
610 batch = (data_bytes - fss->n_fl_chunk_bytes) / min_size;
611 batch = clib_min (batch + 1, n_free / min_size);
612 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
617 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
627 * Try to allocate new fifo
629 * Tries the following steps in order:
630 * - grab fifo and chunk from freelists
631 * - batch fifo and chunk allocation
632 * - single fifo allocation
633 * - grab multiple fifo chunks from freelists
636 fs_try_alloc_fifo (fifo_segment_header_t * fsh, fifo_segment_slice_t * fss,
644 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
645 fl_index = fs_freelist_for_size (min_size);
647 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
650 clib_spinlock_lock (&fss->chunk_lock);
652 f = fsh_try_alloc_fifo_hdr (fsh, fss);
656 c = fsh_try_alloc_chunk (fsh, fss, min_size);
666 f->next = fss->free_fifos;
672 clib_spinlock_unlock (&fss->chunk_lock);
676 f->size = data_bytes;
683 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
685 fifo_segment_slice_t *fss;
688 fss = fsh_slice_get (fsh, slice_index);
690 clib_spinlock_lock (&fss->chunk_lock);
691 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
692 clib_spinlock_unlock (&fss->chunk_lock);
698 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
699 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
701 u32 n_collect = 0, fl_index;
702 svm_fifo_chunk_t *next;
704 clib_spinlock_lock (&fss->chunk_lock);
708 CLIB_MEM_UNPOISON (c, sizeof (*c));
710 fl_index = fs_freelist_for_size (c->length);
711 c->enq_rb_index = RBTREE_TNIL_INDEX;
712 c->deq_rb_index = RBTREE_TNIL_INDEX;
713 fss_chunk_free_list_push (fss, fl_index, c);
714 n_collect += fs_freelist_index_to_size (fl_index);
718 fss->n_fl_chunk_bytes += n_collect;
719 fsh_cached_bytes_add (fsh, n_collect);
721 clib_spinlock_unlock (&fss->chunk_lock);
725 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
726 svm_fifo_chunk_t * c)
728 fifo_segment_slice_t *fss;
729 fss = fsh_slice_get (fsh, slice_index);
730 fsh_slice_collect_chunks (fsh, fss, c);
734 * Allocate fifo in fifo segment
737 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
738 u32 data_bytes, fifo_segment_ftype_t ftype)
740 fifo_segment_header_t *fsh = fs->h;
741 fifo_segment_slice_t *fss;
744 ASSERT (slice_index < fs->n_slices);
746 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_chunk_size))
749 fss = fsh_slice_get (fsh, slice_index);
750 f = fs_try_alloc_fifo (fsh, fss, data_bytes);
754 f->slice_index = slice_index;
756 svm_fifo_init (f, data_bytes);
758 /* If rx fifo type add to active fifos list. When cleaning up segment,
759 * we need a list of active sessions that should be disconnected. Since
760 * both rx and tx fifos keep pointers to the session, it's enough to track
762 if (ftype == FIFO_SEGMENT_RX_FIFO)
764 fss_fifo_add_active_list (fss, f);
765 f->flags |= SVM_FIFO_F_LL_TRACKED;
768 fsh_active_fifos_update (fsh, 1);
769 fss->virtual_mem += svm_fifo_size (f);
776 * Free fifo allocated in fifo segment
779 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
781 fifo_segment_header_t *fsh = fs->h;
782 fifo_segment_slice_t *fss;
784 ASSERT (f->refcnt > 0);
789 fss = fsh_slice_get (fsh, f->slice_index);
791 /* Remove from active list. Only rx fifos are tracked */
792 if (f->flags & SVM_FIFO_F_LL_TRACKED)
794 fss_fifo_del_active_list (fss, f);
795 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
798 /* Free fifo chunks */
799 fsh_slice_collect_chunks (fsh, fss, f->start_chunk);
801 f->start_chunk = f->end_chunk = 0;
802 f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = 0;
804 /* not allocated on segment heap */
805 svm_fifo_free_chunk_lookup (f);
806 svm_fifo_free_ooo_data (f);
810 f->master_session_index = ~0;
811 f->master_thread_index = ~0;
814 fss->virtual_mem -= svm_fifo_size (f);
816 /* Add to free list */
817 f->next = fss->free_fifos;
821 fsh_active_fifos_update (fsh, -1);
825 fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f)
827 fifo_segment_slice_t *fss;
831 ASSERT (f->refcnt == 1);
833 fss = fsh_slice_get (fs->h, f->slice_index);
834 fss->virtual_mem -= svm_fifo_size (f);
835 if (f->flags & SVM_FIFO_F_LL_TRACKED)
836 fss_fifo_del_active_list (fss, f);
841 fl_index = fs_freelist_for_size (c->length);
842 clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
848 fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
851 fifo_segment_slice_t *fss;
855 f->slice_index = slice_index;
856 fss = fsh_slice_get (fs->h, f->slice_index);
857 fss->virtual_mem += svm_fifo_size (f);
858 if (f->flags & SVM_FIFO_F_LL_TRACKED)
859 fss_fifo_add_active_list (fss, f);
864 fl_index = fs_freelist_for_size (c->length);
865 clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
871 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
874 fifo_segment_header_t *fsh = fs->h;
875 fifo_segment_slice_t *fss;
882 fss = fsh_slice_get (fsh, slice_index);
883 size = (uword) (sizeof (*f)) * batch_size;
885 oldheap = ssvm_push_heap (fsh->ssvm_sh);
886 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
887 0 /* align_offset */ ,
888 0 /* os_out_of_memory */ );
889 ssvm_pop_heap (oldheap);
895 /* Carve fifo + chunk space */
896 for (i = 0; i < batch_size; i++)
898 f = (svm_fifo_t *) fmem;
899 memset (f, 0, sizeof (*f));
900 f->next = fss->free_fifos;
905 fsh_free_bytes_sub (fsh, size);
911 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
912 u32 chunk_size, u32 batch_size)
914 fifo_segment_header_t *fsh = fs->h;
915 fifo_segment_slice_t *fss;
918 if (!fs_chunk_size_is_valid (fsh, chunk_size))
920 clib_warning ("chunk size out of range %d", chunk_size);
924 fl_index = fs_freelist_for_size (chunk_size);
925 fss = fsh_slice_get (fsh, slice_index);
927 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
931 * Pre-allocates fifo pairs in fifo segment
934 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
935 u32 rx_fifo_size, u32 tx_fifo_size,
938 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
939 u32 hdrs, pairs_per_slice, alloc_now;
940 fifo_segment_header_t *fsh = fs->h;
941 int rx_fl_index, tx_fl_index, i;
942 fifo_segment_slice_t *fss;
943 uword space_available;
945 /* Parameter check */
946 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
949 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
951 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
955 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
957 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
961 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
962 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
963 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
964 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
966 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
968 /* Calculate space requirements */
969 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
970 space_available = fsh_free_space (fsh);
971 pairs_to_alloc = space_available / pair_size;
972 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
973 pairs_per_slice = pairs_to_alloc / fs->n_slices;
974 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
976 if (!pairs_per_slice)
979 for (i = 0; i < fs->n_slices; i++)
981 fss = fsh_slice_get (fsh, i);
982 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
983 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
984 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
985 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
986 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
988 /* Account for the pairs allocated */
989 *n_fifo_pairs -= alloc_now;
994 * Get number of active fifos
997 fifo_segment_num_fifos (fifo_segment_t * fs)
999 return fsh_n_active_fifos (fs->h);
1003 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1008 f = fss->free_fifos;
1021 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1023 fifo_segment_header_t *fsh = fs->h;
1024 fifo_segment_slice_t *fss;
1028 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1030 fss = fsh_slice_get (fsh, slice_index);
1031 count += fs_slice_num_free_fifos (fss);
1037 fs_slice_num_free_chunks (fifo_segment_slice_t * fss, u32 size)
1039 u32 count = 0, rounded_size, fl_index;
1040 svm_fifo_chunk_t *c;
1043 /* Count all free chunks? */
1046 for (i = 0; i < vec_len (fss->free_chunks); i++)
1048 c = fss->free_chunks[i];
1061 rounded_size = (1 << (max_log2 (size)));
1062 fl_index = fs_freelist_for_size (rounded_size);
1064 if (fl_index >= vec_len (fss->free_chunks))
1067 c = fss->free_chunks[fl_index];
1080 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1082 fifo_segment_header_t *fsh = fs->h;
1083 fifo_segment_slice_t *fss;
1087 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1089 fss = fsh_slice_get (fsh, slice_index);
1090 count += fs_slice_num_free_chunks (fss, size);
1096 fifo_segment_update_free_bytes (fifo_segment_t * fs)
1098 fsh_update_free_bytes (fs->h);
1102 fifo_segment_size (fifo_segment_t * fs)
1104 return fs->ssvm.ssvm_size;
1108 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1110 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1114 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1116 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1120 fifo_segment_free_bytes (fifo_segment_t * fs)
1122 return fsh_n_free_bytes (fs->h);
1126 fifo_segment_cached_bytes (fifo_segment_t * fs)
1128 return fsh_n_cached_bytes (fs->h);
1132 fifo_segment_available_bytes (fifo_segment_t * fs)
1134 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1138 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1140 fifo_segment_header_t *fsh = fs->h;
1141 fifo_segment_slice_t *fss;
1145 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1147 fss = fsh_slice_get (fsh, slice_index);
1148 n_bytes += fss->n_fl_chunk_bytes;
1155 fifo_segment_has_fifos (fifo_segment_t * fs)
1157 return (fsh_n_active_fifos (fs->h) != 0);
1161 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1163 fifo_segment_header_t *fsh = fs->h;
1164 fifo_segment_slice_t *fss;
1166 fss = fsh_slice_get (fsh, slice_index);
1171 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1175 size = fifo_segment_size (fs);
1177 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1178 return (in_use * 100) / size;
1181 fifo_segment_mem_status_t
1182 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1184 if (!fsh->high_watermark || !fsh->low_watermark)
1185 return MEMORY_PRESSURE_NO_PRESSURE;
1187 /* once the no-memory is detected, the status continues
1188 * until memory usage gets below the high watermark
1190 if (fsh_has_reached_mem_limit (fsh))
1192 if (usage >= fsh->high_watermark)
1193 return MEMORY_PRESSURE_NO_MEMORY;
1195 fsh_reset_mem_limit (fsh);
1198 if (usage >= fsh->high_watermark)
1199 return MEMORY_PRESSURE_HIGH_PRESSURE;
1201 else if (usage >= fsh->low_watermark)
1202 return MEMORY_PRESSURE_LOW_PRESSURE;
1204 return MEMORY_PRESSURE_NO_PRESSURE;
1207 fifo_segment_mem_status_t
1208 fifo_segment_get_mem_status (fifo_segment_t * fs)
1210 fifo_segment_header_t *fsh = fs->h;
1211 u8 usage = fifo_segment_get_mem_usage (fs);
1213 return fifo_segment_determine_status (fsh, usage);
1217 format_fifo_segment_type (u8 * s, va_list * args)
1220 sp = va_arg (*args, fifo_segment_t *);
1221 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1223 if (st == SSVM_SEGMENT_PRIVATE)
1224 s = format (s, "%s", "private");
1225 else if (st == SSVM_SEGMENT_MEMFD)
1226 s = format (s, "%s", "memfd");
1227 else if (st == SSVM_SEGMENT_SHM)
1228 s = format (s, "%s", "shm");
1230 s = format (s, "%s", "unknown");
1235 * Segment format function
1238 format_fifo_segment (u8 * s, va_list * args)
1240 u32 count, indent, active_fifos, free_fifos;
1241 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1242 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1243 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1244 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1245 uword tracked_cached_bytes;
1246 uword fifo_hdr = 0, reserved;
1247 fifo_segment_header_t *fsh;
1248 fifo_segment_slice_t *fss;
1249 svm_fifo_chunk_t *c;
1254 uword allocated, in_use, virt;
1256 fifo_segment_mem_status_t mem_st;
1258 indent = format_get_indent (s) + 2;
1262 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1263 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1267 fifo_segment_info (fs, &address, &size);
1268 active_fifos = fifo_segment_num_fifos (fs);
1269 free_fifos = fifo_segment_num_free_fifos (fs);
1271 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1272 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1273 free_fifos, address);
1280 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1283 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1286 s = format (s, "\n");
1288 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1290 fss = fsh_slice_get (fsh, slice_index);
1291 for (i = 0; i < vec_len (fss->free_chunks); i++)
1293 c = fss->free_chunks[i];
1294 if (c == 0 && fss->num_chunks[i] == 0)
1303 chunk_size = fs_freelist_index_to_size (i);
1304 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1305 chunk_size >> 10, count, fss->num_chunks[i]);
1307 chunk_bytes += count * chunk_size;
1311 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1312 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1313 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1314 fifo_segment_update_free_bytes (fs);
1315 free_seg_bytes = fifo_segment_free_bytes (fs);
1316 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1317 allocated = fifo_segment_size (fs);
1318 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1319 usage = (100.0 * in_use) / allocated;
1320 mem_st = fifo_segment_get_mem_status (fs);
1321 virt = fsh_virtual_mem (fsh);
1322 reserved = fsh->n_reserved_bytes;
1324 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1325 " %U (%lu)\n", format_white_space, indent + 2,
1326 format_memory_size, free_seg_bytes, free_seg_bytes,
1327 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1328 format_memory_size, reserved, reserved);
1329 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1330 " %U (%lu)\n", format_white_space, indent + 2,
1331 format_memory_size, chunk_bytes, chunk_bytes,
1332 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1333 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1334 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1335 format_white_space, indent + 2, fsh->n_active_fifos,
1336 format_memory_size, fifo_hdr, fifo_hdr);
1337 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1338 format_white_space, indent + 2, usage, format_memory_size,
1339 in_use, format_memory_size, allocated, format_memory_size, virt,
1340 fifo_segment_mem_status_strings[mem_st]);
1341 s = format (s, "\n");
1347 * fd.io coding-style-patch-verification: ON
1350 * eval: (c-set-style "gnu")