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>
17 #include <vppinfra/mem.h>
20 fsh_alloc_aligned (fifo_segment_header_t *fsh, uword size, uword align)
22 uword cur_pos, cur_pos_align, new_pos;
24 cur_pos = clib_atomic_load_relax_n (&fsh->byte_index);
25 cur_pos_align = round_pow2_u64 (cur_pos, align);
26 size = round_pow2_u64 (size, align);
27 new_pos = cur_pos_align + size;
29 if (new_pos >= fsh->max_byte_index)
32 while (!clib_atomic_cmp_and_swap_acq_relax (&fsh->byte_index, &cur_pos,
33 &new_pos, 1 /* weak */))
35 cur_pos_align = round_pow2_u64 (cur_pos, align);
36 new_pos = cur_pos_align + size;
37 if (new_pos >= fsh->max_byte_index)
40 return uword_to_pointer ((u8 *) fsh + cur_pos_align, void *);
44 fsh_alloc (fifo_segment_header_t *fsh, uword size)
46 return fsh_alloc_aligned (fsh, size, 8);
49 static inline fifo_segment_slice_t *
50 fsh_slice_get (fifo_segment_header_t * fsh, u32 slice_index)
52 return &fsh->slices[slice_index];
55 static char *fifo_segment_mem_status_strings[] = {
56 #define _(sym,str) str,
57 foreach_segment_mem_status
62 fsh_n_free_bytes (fifo_segment_header_t * fsh)
64 uword cur_pos = clib_atomic_load_relax_n (&fsh->byte_index);
65 ASSERT (fsh->max_byte_index > cur_pos);
66 return fsh->max_byte_index - cur_pos;
70 fsh_cached_bytes_add (fifo_segment_header_t * fsh, uword size)
72 clib_atomic_fetch_add_rel (&fsh->n_cached_bytes, size);
76 fsh_cached_bytes_sub (fifo_segment_header_t * fsh, uword size)
78 clib_atomic_fetch_sub_rel (&fsh->n_cached_bytes, size);
82 fsh_n_cached_bytes (fifo_segment_header_t * fsh)
84 uword n_cached = clib_atomic_load_relax_n (&fsh->n_cached_bytes);
89 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
91 clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
95 fsh_n_active_fifos (fifo_segment_header_t * fsh)
97 return clib_atomic_load_relax_n (&fsh->n_active_fifos);
101 fsh_virtual_mem (fifo_segment_header_t * fsh)
103 fifo_segment_slice_t *fss;
107 for (i = 0; i < fsh->n_slices; i++)
109 fss = fsh_slice_get (fsh, i);
110 total_vm += clib_atomic_load_relax_n (&fss->virtual_mem);
116 fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
119 fifo_segment_slice_t *fss = fsh_slice_get (fsh, slice_index);
120 fss->virtual_mem += n_bytes;
124 fss_chunk_freelist_lock (fifo_segment_slice_t *fss)
127 while (!clib_atomic_cmp_and_swap_acq_relax_n (&fss->chunk_lock, &free, 1, 0))
129 /* atomic load limits number of compare_exchange executions */
130 while (clib_atomic_load_relax_n (&fss->chunk_lock))
132 /* on failure, compare_exchange writes (*p)->lock into free */
138 fss_chunk_freelist_unlock (fifo_segment_slice_t *fss)
140 /* Make sure all reads/writes are complete before releasing the lock */
141 clib_atomic_release (&fss->chunk_lock);
145 fss_chunk_fl_index_is_valid (fifo_segment_slice_t * fss, u32 fl_index)
147 return (fl_index < FS_CHUNK_VEC_LEN);
151 fss_chunk_free_list_push (fifo_segment_slice_t * fss, u32 fl_index,
152 svm_fifo_chunk_t * c)
154 fss_chunk_freelist_lock (fss);
155 c->next = fss->free_chunks[fl_index];
156 fss->free_chunks[fl_index] = c;
157 fss_chunk_freelist_unlock (fss);
161 fss_chunk_free_list_push_list (fifo_segment_slice_t * fss, u32 fl_index,
162 svm_fifo_chunk_t * head,
163 svm_fifo_chunk_t * tail)
165 fss_chunk_freelist_lock (fss);
166 tail->next = fss->free_chunks[fl_index];
167 fss->free_chunks[fl_index] = head;
168 fss_chunk_freelist_unlock (fss);
171 static svm_fifo_chunk_t *
172 fss_chunk_free_list_pop (fifo_segment_slice_t * fss, u32 fl_index)
176 ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
178 fss_chunk_freelist_lock (fss);
180 if (!fss->free_chunks[fl_index])
182 fss_chunk_freelist_unlock (fss);
186 c = fss->free_chunks[fl_index];
187 fss->free_chunks[fl_index] = c->next;
189 fss_chunk_freelist_unlock (fss);
195 fss_fifo_add_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
199 fss->fifos->prev = f;
200 f->next = fss->fifos;
206 fss_fifo_del_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
208 if (f->flags & SVM_FIFO_F_LL_TRACKED)
211 f->prev->next = f->next;
213 fss->fifos = f->next;
215 f->next->prev = f->prev;
220 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
222 return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
226 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
228 clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
232 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
234 clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
238 * Initialize fifo segment shared header
241 fifo_segment_init (fifo_segment_t * fs)
243 u32 align = 8, offset = 2 * 4096, slices_sz, i;
244 uword max_fifo, seg_start, seg_sz;
245 fifo_segment_header_t *fsh;
246 ssvm_shared_header_t *sh;
249 /* TODO remove ssvm heap entirely */
252 seg_data = (u8 *) sh + offset;
253 seg_sz = sh->ssvm_size - offset;
255 fs->n_slices = clib_max (fs->n_slices, 1);
256 slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
258 seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
259 fsh = uword_to_pointer (seg_start, void *);
260 memset (fsh, 0, sizeof (*fsh) + slices_sz);
262 fsh->byte_index = sizeof (*fsh) + slices_sz;
263 fsh->max_byte_index = seg_sz;
264 fsh->n_slices = fs->n_slices;
265 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
266 fsh->max_log2_fifo_size = min_log2 (max_fifo);
267 fsh->n_cached_bytes = 0;
268 fsh->n_reserved_bytes = fsh->byte_index;
269 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
271 fs->max_byte_index = fsh->max_byte_index;
272 fs->h = sh->opaque[0] = fsh;
274 vec_validate (fs->slices, fs->n_slices - 1);
275 for (i = 0; i < fs->n_slices; i++)
276 fs->slices[i].fifos =
277 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
284 * Create a fifo segment and initialize as master
287 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
293 /* Allocate a fresh segment */
294 pool_get_zero (sm->segments, fs);
296 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
297 fs->ssvm.ssvm_size = a->segment_size;
298 fs->ssvm.is_server = 1;
299 fs->ssvm.my_pid = getpid ();
300 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
301 fs->ssvm.requested_va = baseva;
303 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
305 pool_put (sm->segments, fs);
309 /* Note: requested_va updated due to seg base addr randomization */
310 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
312 fifo_segment_init (fs);
313 vec_add1 (a->new_segment_indices, fs - sm->segments);
318 * Attach as slave to a fifo segment
321 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
323 fifo_segment_header_t *fsh;
327 pool_get_zero (sm->segments, fs);
329 fs->ssvm.ssvm_size = a->segment_size;
330 fs->ssvm.my_pid = getpid ();
331 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
332 fs->ssvm.requested_va = sm->next_baseva;
333 if (a->segment_type == SSVM_SEGMENT_MEMFD)
334 fs->ssvm.fd = a->memfd_fd;
336 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
338 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
340 _vec_len (fs) = vec_len (fs) - 1;
344 /* Fish the segment header */
345 fsh = fs->h = fs->ssvm.sh->opaque[0];
347 /* Probably a segment without fifos */
351 fs->max_byte_index = fsh->max_byte_index;
352 vec_validate (fs->slices, 0);
353 fs->slices[0].fifos =
354 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
357 vec_add1 (a->new_segment_indices, fs - sm->segments);
362 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
364 fifo_segment_cleanup (s);
365 ssvm_delete (&s->ssvm);
366 clib_memset (s, 0xfe, sizeof (*s));
367 pool_put (sm->segments, s);
371 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
373 return s - sm->segments;
377 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
379 return pool_elt_at_index (sm->segments, segment_index);
383 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
385 *address = (char *) seg->ssvm.sh->ssvm_va;
386 *size = seg->ssvm.ssvm_size;
390 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
391 u32 timeout_in_seconds)
393 sm->next_baseva = baseva;
394 sm->timeout_in_seconds = timeout_in_seconds;
398 fs_freelist_for_size (u32 size)
400 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
402 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
403 FS_CHUNK_VEC_LEN - 1);
407 fs_freelist_index_to_size (u32 fl_index)
409 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
413 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
416 * 4K minimum. It's not likely that anything good will happen
417 * with a smaller FIFO.
419 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
420 size <= (1ULL << fsh->max_log2_fifo_size);
424 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
425 fifo_segment_slice_t * fss, u32 data_bytes)
427 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
428 svm_fifo_chunk_t *c, *first = 0, *next;
430 fl_index = fs_freelist_for_size (req_bytes);
434 fl_size = fs_freelist_index_to_size (fl_index);
438 c = fss_chunk_free_list_pop (fss, fl_index);
444 req_bytes -= clib_min (fl_size, req_bytes);
448 /* Failed to allocate with smaller chunks */
451 /* Free all chunks if any allocated */
455 fl_index = fs_freelist_for_size (c->length);
457 fss_chunk_free_list_push (fss, fl_index, c);
462 /* As last attempt, try allocating a chunk larger than
463 * the requested size, if possible */
464 fl_index = fs_freelist_for_size (data_bytes) + 1;
465 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
467 first = fss_chunk_free_list_pop (fss, fl_index);
471 n_alloc = fs_freelist_index_to_size (fl_index);
477 fl_size = fl_size >> 1;
482 fss_fl_chunk_bytes_sub (fss, n_alloc);
483 fsh_cached_bytes_sub (fsh, n_alloc);
488 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
489 fifo_segment_slice_t * fss, u32 batch_size)
491 svm_fifo_shared_t *f;
496 ASSERT (batch_size != 0);
498 size = (uword) sizeof (*f) * batch_size;
500 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
504 /* Carve fifo hdr space */
505 for (i = 0; i < batch_size; i++)
507 f = (svm_fifo_shared_t *) fmem;
508 memset (f, 0, sizeof (*f));
509 f->next = fss->free_fifos;
518 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
519 fifo_segment_slice_t * fss,
520 u32 fl_index, u32 batch_size)
522 svm_fifo_chunk_t *c, *head = 0, *tail;
523 uword size, total_chunk_bytes;
524 u32 rounded_data_size;
528 ASSERT (batch_size != 0);
530 rounded_data_size = fs_freelist_index_to_size (fl_index);
531 total_chunk_bytes = (uword) batch_size *rounded_data_size;
532 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
534 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
538 /* Carve fifo + chunk space */
539 tail = c = (svm_fifo_chunk_t *) cmem;
540 for (i = 0; i < batch_size; i++)
543 c->length = rounded_data_size;
546 cmem += sizeof (*c) + rounded_data_size;
547 c = (svm_fifo_chunk_t *) cmem;
550 fss_chunk_free_list_push_list (fss, fl_index, head, tail);
551 fss->num_chunks[fl_index] += batch_size;
552 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
553 fsh_cached_bytes_add (fsh, total_chunk_bytes);
559 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
560 fifo_segment_slice_t * fss,
561 u32 fl_index, u32 batch_size)
563 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
565 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
568 static svm_fifo_shared_t *
569 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
571 svm_fifo_shared_t *f;
573 if (!fss->free_fifos)
575 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
576 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
581 fss->free_fifos = f->next;
582 memset (f, 0, sizeof (*f));
586 static svm_fifo_chunk_t *
587 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
588 fifo_segment_slice_t * fss, u32 data_bytes)
593 fl_index = fs_freelist_for_size (data_bytes);
596 c = fss_chunk_free_list_pop (fss, fl_index);
600 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
601 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
605 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
608 chunk_size = fs_freelist_index_to_size (fl_index);
609 n_free = fsh_n_free_bytes (fsh);
611 if (chunk_size <= n_free)
613 batch = chunk_size * batch <= n_free ? batch : 1;
614 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
617 /* Failed to allocate larger chunk, try to allocate multi-chunk
618 * that is close to what was actually requested */
619 if (data_bytes <= fss_fl_chunk_bytes (fss))
621 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
624 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
625 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
628 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
630 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
632 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
633 batch = clib_min (batch + 1, n_free / min_size);
634 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
636 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
646 * Try to allocate new fifo
648 * Tries the following steps in order:
649 * - grab fifo and chunk from freelists
650 * - batch fifo and chunk allocation
651 * - single fifo allocation
652 * - grab multiple fifo chunks from freelists
654 static svm_fifo_shared_t *
655 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
657 fifo_segment_slice_t *fss;
658 u32 fl_index, min_size;
660 svm_fifo_shared_t *sf = 0;
662 fss = fsh_slice_get (fsh, slice_index);
663 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
664 fl_index = fs_freelist_for_size (min_size);
666 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
669 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
673 c = fsh_try_alloc_chunk (fsh, fss, min_size);
676 sf->next = fss->free_fifos;
677 fss->free_fifos = sf;
685 sf->size = data_bytes;
686 sf->slice_index = slice_index;
692 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
694 fifo_segment_slice_t *fss;
697 fss = fsh_slice_get (fsh, slice_index);
698 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
704 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
705 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
707 u32 n_collect = 0, fl_index;
708 svm_fifo_chunk_t *next;
712 CLIB_MEM_UNPOISON (c, sizeof (*c));
714 fl_index = fs_freelist_for_size (c->length);
715 fss_chunk_free_list_push (fss, fl_index, c);
716 n_collect += fs_freelist_index_to_size (fl_index);
720 fss_fl_chunk_bytes_add (fss, n_collect);
721 fsh_cached_bytes_add (fsh, n_collect);
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 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
736 fifo_slice_private_t *pfss = &fs->slices[slice_index];
739 f = clib_mem_bulk_alloc (pfss->fifos);
740 clib_memset (f, 0, sizeof (*f));
745 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f)
747 u32 slice_index = f->shr->slice_index;
748 fifo_slice_private_t *pfss;
750 pfss = &fs->slices[slice_index];
751 clib_mem_bulk_free (pfss->fifos, f);
755 fifo_segment_cleanup (fifo_segment_t *fs)
759 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
760 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
764 * Allocate fifo in fifo segment
767 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
768 u32 data_bytes, fifo_segment_ftype_t ftype)
770 fifo_segment_header_t *fsh = fs->h;
771 fifo_segment_slice_t *fss;
772 svm_fifo_shared_t *sf;
775 ASSERT (slice_index < fs->n_slices);
777 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
780 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
784 f = fs_fifo_alloc (fs, slice_index);
788 svm_fifo_init (f, data_bytes);
790 fss = fsh_slice_get (fsh, slice_index);
792 /* If rx fifo type add to active fifos list. When cleaning up segment,
793 * we need a list of active sessions that should be disconnected. Since
794 * both rx and tx fifos keep pointers to the session, it's enough to track
796 if (ftype == FIFO_SEGMENT_RX_FIFO)
798 fss_fifo_add_active_list (fss, f);
799 f->flags |= SVM_FIFO_F_LL_TRACKED;
802 fsh_active_fifos_update (fsh, 1);
803 fss->virtual_mem += svm_fifo_size (f);
810 fifo_segment_alloc_fifo_w_shared (fifo_segment_t *fs, svm_fifo_shared_t *sf)
812 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
816 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
817 f->segment_index = SVM_FIFO_INVALID_INDEX;
823 * Free fifo allocated in fifo segment
826 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
828 fifo_segment_header_t *fsh = fs->h;
829 fifo_segment_slice_t *fss;
830 svm_fifo_shared_t *sf;
832 ASSERT (f->refcnt > 0);
838 * Cleanup shared state
842 fss = fsh_slice_get (fsh, sf->slice_index);
844 /* Free fifo chunks */
845 fsh_slice_collect_chunks (fsh, fss, sf->start_chunk);
847 sf->start_chunk = sf->end_chunk = 0;
848 sf->head_chunk = sf->tail_chunk = 0;
850 /* Add to free list */
851 sf->next = fss->free_fifos;
852 fss->free_fifos = sf;
854 fss->virtual_mem -= svm_fifo_size (f);
857 * Cleanup private state
860 /* Remove from active list. Only rx fifos are tracked */
861 if (f->flags & SVM_FIFO_F_LL_TRACKED)
863 fss_fifo_del_active_list (fss, f);
864 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
867 svm_fifo_free_chunk_lookup (f);
868 svm_fifo_free_ooo_data (f);
872 sf->master_session_index = ~0;
873 f->master_thread_index = ~0;
876 f->ooo_enq = f->ooo_deq = 0;
879 fs_fifo_free (fs, f);
881 fsh_active_fifos_update (fsh, -1);
885 fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f)
887 fifo_segment_slice_t *fss;
891 ASSERT (f->refcnt == 1);
893 fss = fsh_slice_get (fs->h, f->shr->slice_index);
894 fss->virtual_mem -= svm_fifo_size (f);
895 if (f->flags & SVM_FIFO_F_LL_TRACKED)
896 fss_fifo_del_active_list (fss, f);
898 c = f->shr->start_chunk;
901 fl_index = fs_freelist_for_size (c->length);
902 clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
908 fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
911 fifo_segment_slice_t *fss;
915 f->shr->slice_index = slice_index;
916 fss = fsh_slice_get (fs->h, f->shr->slice_index);
917 fss->virtual_mem += svm_fifo_size (f);
918 if (f->flags & SVM_FIFO_F_LL_TRACKED)
919 fss_fifo_add_active_list (fss, f);
921 c = f->shr->start_chunk;
924 fl_index = fs_freelist_for_size (c->length);
925 clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
931 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
934 fifo_segment_header_t *fsh = fs->h;
935 fifo_segment_slice_t *fss;
937 fss = fsh_slice_get (fsh, slice_index);
938 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
942 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
943 u32 chunk_size, u32 batch_size)
945 fifo_segment_header_t *fsh = fs->h;
946 fifo_segment_slice_t *fss;
949 if (!fs_chunk_size_is_valid (fsh, chunk_size))
951 clib_warning ("chunk size out of range %d", chunk_size);
955 fl_index = fs_freelist_for_size (chunk_size);
956 fss = fsh_slice_get (fsh, slice_index);
958 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
962 * Pre-allocates fifo pairs in fifo segment
965 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
966 u32 rx_fifo_size, u32 tx_fifo_size,
969 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
970 u32 hdrs, pairs_per_slice, alloc_now;
971 fifo_segment_header_t *fsh = fs->h;
972 int rx_fl_index, tx_fl_index, i;
973 fifo_segment_slice_t *fss;
974 uword space_available;
976 /* Parameter check */
977 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
980 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
982 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
986 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
988 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
992 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
993 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
994 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
995 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
997 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
999 /* Calculate space requirements */
1000 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1001 space_available = fsh_n_free_bytes (fsh);
1002 pairs_to_alloc = space_available / pair_size;
1003 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1004 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1005 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1007 if (!pairs_per_slice)
1010 for (i = 0; i < fs->n_slices; i++)
1012 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1016 fss = fsh_slice_get (fsh, i);
1017 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1018 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1019 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1020 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1022 /* Account for the pairs allocated */
1023 *n_fifo_pairs -= alloc_now;
1028 * Get number of active fifos
1031 fifo_segment_num_fifos (fifo_segment_t * fs)
1033 return fsh_n_active_fifos (fs->h);
1037 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1039 svm_fifo_shared_t *f;
1042 f = fss->free_fifos;
1055 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1057 fifo_segment_header_t *fsh = fs->h;
1058 fifo_segment_slice_t *fss;
1062 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1064 fss = fsh_slice_get (fsh, slice_index);
1065 count += fs_slice_num_free_fifos (fss);
1071 fs_slice_num_free_chunks (fifo_segment_slice_t * fss, u32 size)
1073 u32 count = 0, rounded_size, fl_index;
1074 svm_fifo_chunk_t *c;
1077 /* Count all free chunks? */
1080 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1082 c = fss->free_chunks[i];
1095 rounded_size = (1 << (max_log2 (size)));
1096 fl_index = fs_freelist_for_size (rounded_size);
1098 if (fl_index >= FS_CHUNK_VEC_LEN)
1101 c = fss->free_chunks[fl_index];
1114 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1116 fifo_segment_header_t *fsh = fs->h;
1117 fifo_segment_slice_t *fss;
1121 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1123 fss = fsh_slice_get (fsh, slice_index);
1124 count += fs_slice_num_free_chunks (fss, size);
1130 fifo_segment_size (fifo_segment_t * fs)
1132 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1136 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1138 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1142 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1144 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1148 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1150 void *rv = fsh_alloc (fs->h, size);
1151 /* Mark externally allocated bytes as reserved. This helps
1152 * @ref fifo_segment_size report bytes used only for fifos */
1153 fs->h->n_reserved_bytes += size;
1158 fifo_segment_free_bytes (fifo_segment_t * fs)
1160 return fsh_n_free_bytes (fs->h);
1164 fifo_segment_cached_bytes (fifo_segment_t * fs)
1166 return fsh_n_cached_bytes (fs->h);
1170 fifo_segment_available_bytes (fifo_segment_t * fs)
1172 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1176 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1178 fifo_segment_header_t *fsh = fs->h;
1179 fifo_segment_slice_t *fss;
1183 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1185 fss = fsh_slice_get (fsh, slice_index);
1186 n_bytes += fss_fl_chunk_bytes (fss);
1193 fifo_segment_has_fifos (fifo_segment_t * fs)
1195 return (fsh_n_active_fifos (fs->h) != 0);
1199 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1201 fifo_segment_header_t *fsh = fs->h;
1202 fifo_segment_slice_t *fss;
1204 fss = fsh_slice_get (fsh, slice_index);
1209 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1213 size = fifo_segment_size (fs);
1215 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1216 return (in_use * 100) / size;
1219 fifo_segment_mem_status_t
1220 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1222 if (!fsh->high_watermark || !fsh->low_watermark)
1223 return MEMORY_PRESSURE_NO_PRESSURE;
1225 /* once the no-memory is detected, the status continues
1226 * until memory usage gets below the high watermark
1228 if (fsh_has_reached_mem_limit (fsh))
1230 if (usage >= fsh->high_watermark)
1231 return MEMORY_PRESSURE_NO_MEMORY;
1233 fsh_reset_mem_limit (fsh);
1236 if (usage >= fsh->high_watermark)
1237 return MEMORY_PRESSURE_HIGH_PRESSURE;
1239 else if (usage >= fsh->low_watermark)
1240 return MEMORY_PRESSURE_LOW_PRESSURE;
1242 return MEMORY_PRESSURE_NO_PRESSURE;
1245 fifo_segment_mem_status_t
1246 fifo_segment_get_mem_status (fifo_segment_t * fs)
1248 fifo_segment_header_t *fsh = fs->h;
1249 u8 usage = fifo_segment_get_mem_usage (fs);
1251 return fifo_segment_determine_status (fsh, usage);
1255 format_fifo_segment_type (u8 * s, va_list * args)
1258 sp = va_arg (*args, fifo_segment_t *);
1259 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1261 if (st == SSVM_SEGMENT_PRIVATE)
1262 s = format (s, "%s", "private");
1263 else if (st == SSVM_SEGMENT_MEMFD)
1264 s = format (s, "%s", "memfd");
1265 else if (st == SSVM_SEGMENT_SHM)
1266 s = format (s, "%s", "shm");
1268 s = format (s, "%s", "unknown");
1273 * Segment format function
1276 format_fifo_segment (u8 * s, va_list * args)
1278 u32 count, indent, active_fifos, free_fifos;
1279 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1280 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1281 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1282 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1283 uword tracked_cached_bytes;
1284 uword fifo_hdr = 0, reserved;
1285 fifo_segment_header_t *fsh;
1286 fifo_segment_slice_t *fss;
1287 svm_fifo_chunk_t *c;
1292 uword allocated, in_use, virt;
1294 fifo_segment_mem_status_t mem_st;
1296 indent = format_get_indent (s) + 2;
1300 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1301 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1305 fifo_segment_info (fs, &address, &size);
1306 active_fifos = fifo_segment_num_fifos (fs);
1307 free_fifos = fifo_segment_num_free_fifos (fs);
1309 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1310 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1311 free_fifos, address);
1318 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1321 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1324 s = format (s, "\n");
1326 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1328 fss = fsh_slice_get (fsh, slice_index);
1329 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1331 c = fss->free_chunks[i];
1332 if (c == 0 && fss->num_chunks[i] == 0)
1341 chunk_size = fs_freelist_index_to_size (i);
1342 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1343 chunk_size >> 10, count, fss->num_chunks[i]);
1345 chunk_bytes += count * chunk_size;
1349 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1350 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1351 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1352 free_seg_bytes = fifo_segment_free_bytes (fs);
1353 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1354 allocated = fifo_segment_size (fs);
1355 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1356 usage = (100.0 * in_use) / allocated;
1357 mem_st = fifo_segment_get_mem_status (fs);
1358 virt = fsh_virtual_mem (fsh);
1359 reserved = fsh->n_reserved_bytes;
1361 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1362 " %U (%lu)\n", format_white_space, indent + 2,
1363 format_memory_size, free_seg_bytes, free_seg_bytes,
1364 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1365 format_memory_size, reserved, reserved);
1366 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1367 " %U (%lu)\n", format_white_space, indent + 2,
1368 format_memory_size, chunk_bytes, chunk_bytes,
1369 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1370 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1371 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1372 format_white_space, indent + 2, fsh->n_active_fifos,
1373 format_memory_size, fifo_hdr, fifo_hdr);
1374 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1375 format_white_space, indent + 2, usage, format_memory_size,
1376 in_use, format_memory_size, allocated, format_memory_size, virt,
1377 fifo_segment_mem_status_strings[mem_st]);
1378 s = format (s, "\n");
1384 * fd.io coding-style-patch-verification: ON
1387 * eval: (c-set-style "gnu")