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 struct dlmallinfo dlminfo;
45 dlminfo = mspace_mallinfo (fsh->ssvm_sh->heap);
46 return dlminfo.fordblks;
50 fsh_free_bytes_sub (fifo_segment_header_t * fsh, int size)
52 clib_atomic_fetch_sub_rel (&fsh->n_free_bytes, size);
56 fsh_n_free_bytes (fifo_segment_header_t * fsh)
58 uword n_free = clib_atomic_load_relax_n (&fsh->n_free_bytes);
59 return n_free > fsh->n_reserved_bytes ? n_free - fsh->n_reserved_bytes : 0;
63 fsh_update_free_bytes (fifo_segment_header_t * fsh)
65 clib_atomic_store_rel_n (&fsh->n_free_bytes, fsh_free_space (fsh));
69 fsh_cached_bytes_add (fifo_segment_header_t * fsh, int size)
71 clib_atomic_fetch_add_rel (&fsh->n_cached_bytes, size);
75 fsh_cached_bytes_sub (fifo_segment_header_t * fsh, int size)
77 clib_atomic_fetch_sub_rel (&fsh->n_cached_bytes, size);
81 fsh_n_cached_bytes (fifo_segment_header_t * fsh)
83 uword n_cached = clib_atomic_load_relax_n (&fsh->n_cached_bytes);
88 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
90 clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
94 fsh_virtual_mem (fifo_segment_header_t * fsh)
96 fifo_segment_slice_t *fss;
100 for (i = 0; i < fsh->n_slices; i++)
102 fss = fsh_slice_get (fsh, i);
103 total_vm += clib_atomic_load_relax_n (&fss->virtual_mem);
109 fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
112 fifo_segment_slice_t *fss = fsh_slice_get (fsh, slice_index);
113 fss->virtual_mem += n_bytes;
117 fsh_check_mem (fifo_segment_header_t * fsh)
121 if (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT)
124 thresh = clib_max (0.01 * fsh->ssvm_sh->ssvm_size,
125 2 * fsh->n_reserved_bytes);
126 if (fsh->n_free_bytes > thresh)
129 fsh->flags |= FIFO_SEGMENT_F_MEM_LIMIT;
130 fsh_update_free_bytes (fsh);
134 * Initialize fifo segment shared header
137 fifo_segment_init (fifo_segment_t * fs)
139 fifo_segment_header_t *fsh;
140 fifo_segment_slice_t *fss;
141 ssvm_shared_header_t *sh;
148 oldheap = ssvm_push_heap (sh);
151 * Manually align the fifo segment header to sizeof(uword) = 8 bytes.
152 * Long story made short: the "process-private" fifo segment
153 * is allocated from the main heap, not mmapped. dlmalloc
154 * only guarantees 4-byte alignment, and on aarch64
155 * the fsh can end up 4-byte but not 8-byte aligned.
156 * That eventually causes the atomic op in fifo_segment_update_free_bytes
159 fsh = clib_mem_alloc_aligned (sizeof (*fsh), sizeof (uword));
160 clib_memset (fsh, 0, sizeof (*fsh));
161 fs->h = sh->opaque[0] = fsh;
162 fs->n_slices = clib_max (fs->n_slices, 1);
164 fsh->ssvm_sh = fs->ssvm.sh;
165 fsh->n_slices = fs->n_slices;
166 max_fifo = clib_min ((fsh_free_space (fsh) - 4096) / 2,
167 FIFO_SEGMENT_MAX_FIFO_SIZE);
168 fsh->max_log2_chunk_size = max_log2 (max_fifo);
170 fsh->slices = clib_mem_alloc (sizeof (*fss) * fs->n_slices);
171 clib_memset (fsh->slices, 0, sizeof (*fss) * fs->n_slices);
172 max_chunk_sz = fsh->max_log2_chunk_size - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
174 for (i = 0; i < fs->n_slices; i++)
176 fss = fsh_slice_get (fsh, i);
177 vec_validate_init_empty (fss->free_chunks, max_chunk_sz, 0);
178 vec_validate_init_empty (fss->num_chunks, max_chunk_sz, 0);
179 clib_spinlock_init (&fss->chunk_lock);
182 ssvm_pop_heap (oldheap);
184 fsh->n_free_bytes = fsh_free_space (fsh);
185 fsh->n_cached_bytes = 0;
186 fsh->n_reserved_bytes = clib_min (0.01 * fsh->n_free_bytes, 256 << 10);
192 * Create a fifo segment and initialize as master
195 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
201 /* Allocate a fresh segment */
202 pool_get_zero (sm->segments, fs);
204 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
205 fs->ssvm.ssvm_size = a->segment_size;
206 fs->ssvm.i_am_master = 1;
207 fs->ssvm.my_pid = getpid ();
208 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
209 fs->ssvm.requested_va = baseva;
211 if ((rv = ssvm_master_init (&fs->ssvm, a->segment_type)))
213 pool_put (sm->segments, fs);
217 /* Note: requested_va updated due to seg base addr randomization */
218 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
220 fifo_segment_init (fs);
221 vec_add1 (a->new_segment_indices, fs - sm->segments);
226 * Attach as slave to a fifo segment
229 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
234 pool_get_zero (sm->segments, fs);
236 fs->ssvm.ssvm_size = a->segment_size;
237 fs->ssvm.my_pid = getpid ();
238 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
239 fs->ssvm.requested_va = sm->next_baseva;
240 if (a->segment_type == SSVM_SEGMENT_MEMFD)
241 fs->ssvm.fd = a->memfd_fd;
243 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
245 if ((rv = ssvm_slave_init (&fs->ssvm, a->segment_type)))
247 _vec_len (fs) = vec_len (fs) - 1;
251 /* Fish the segment header */
252 fs->h = fs->ssvm.sh->opaque[0];
254 vec_add1 (a->new_segment_indices, fs - sm->segments);
259 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
261 ssvm_delete (&s->ssvm);
262 clib_memset (s, 0xfe, sizeof (*s));
263 pool_put (sm->segments, s);
267 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
269 return s - sm->segments;
273 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
275 return pool_elt_at_index (sm->segments, segment_index);
279 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
281 *address = (char *) seg->ssvm.sh->ssvm_va;
282 *size = seg->ssvm.ssvm_size;
286 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
287 u32 timeout_in_seconds)
289 sm->next_baseva = baseva;
290 sm->timeout_in_seconds = timeout_in_seconds;
294 fs_freelist_for_size (u32 size)
296 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
298 return max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
302 fs_freelist_index_to_size (u32 fl_index)
304 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
308 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
311 * 4K minimum. It's not likely that anything good will happen
312 * with a smaller FIFO.
314 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE
315 && size <= (1ULL << fsh->max_log2_chunk_size);
319 fs_try_alloc_fifo_freelist (fifo_segment_slice_t * fss, u32 fl_index)
325 c = fss->free_chunks[fl_index];
330 fss->free_fifos = f->next;
331 fss->free_chunks[fl_index] = c->next;
334 memset (f, 0, sizeof (*f));
338 fss->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
343 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
344 fifo_segment_slice_t * fss, u32 data_bytes)
346 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
347 svm_fifo_chunk_t *c, *first = 0, *next;
349 fl_index = fs_freelist_for_size (req_bytes);
353 fl_size = fs_freelist_index_to_size (fl_index);
357 c = fss->free_chunks[fl_index];
360 fss->free_chunks[fl_index] = c->next;
364 req_bytes -= clib_min (fl_size, req_bytes);
368 /* Failed to allocate with smaller chunks */
371 /* free all chunks if any allocated */
375 fl_index = fs_freelist_for_size (c->length);
376 fl_size = fs_freelist_index_to_size (fl_index);
378 c->next = fss->free_chunks[fl_index];
379 fss->free_chunks[fl_index] = c;
380 fss->n_fl_chunk_bytes += fl_size;
385 fl_index = fs_freelist_for_size (data_bytes);
386 if (fss->free_chunks[fl_index + 1])
389 fl_size = fs_freelist_index_to_size (fl_index);
396 fl_size = fl_size >> 1;
400 fss->n_fl_chunk_bytes -= n_alloc;
401 fsh_cached_bytes_sub (fsh, n_alloc);
406 fs_try_alloc_fifo_freelist_multi_chunk (fifo_segment_header_t * fsh,
407 fifo_segment_slice_t * fss,
410 svm_fifo_chunk_t *c, *first = 0, *last = 0, *next;
411 u32 fl_index, fl_size, n_alloc = 0;
417 void *oldheap = ssvm_push_heap (fsh->ssvm_sh);
418 f = clib_mem_alloc_aligned (sizeof (*f), CLIB_CACHE_LINE_BYTES);
419 ssvm_pop_heap (oldheap);
422 memset (f, 0, sizeof (*f));
423 fsh_free_bytes_sub (fsh, sizeof (*f));
427 fss->free_fifos = f->next;
430 fl_index = fs_freelist_for_size (data_bytes);
434 fl_size = fs_freelist_index_to_size (fl_index);
438 c = fss->free_chunks[fl_index];
441 fss->free_chunks[fl_index] = c->next;
447 data_bytes -= clib_min (fl_size, data_bytes);
451 /* Failed to allocate with smaller chunks */
454 /* free all chunks if any allocated */
458 fl_index = fs_freelist_for_size (c->length);
459 fl_size = fs_freelist_index_to_size (fl_index);
461 c->next = fss->free_chunks[fl_index];
462 fss->free_chunks[fl_index] = c;
463 fss->n_fl_chunk_bytes += fl_size;
465 data_bytes += fl_size;
469 fl_index = fs_freelist_for_size (data_bytes);
470 if (fss->free_chunks[fl_index + 1])
473 fl_size = fs_freelist_index_to_size (fl_index);
477 f->next = fss->free_fifos;
482 fl_size = fl_size >> 1;
486 f->start_chunk = first;
488 fss->n_fl_chunk_bytes -= n_alloc;
489 fsh_cached_bytes_sub (fsh, n_alloc);
494 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
495 fifo_segment_slice_t * fss,
496 u32 fl_index, u32 batch_size)
498 u32 rounded_data_size;
505 rounded_data_size = fs_freelist_index_to_size (fl_index);
506 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
508 oldheap = ssvm_push_heap (fsh->ssvm_sh);
509 cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
510 0 /* align_offset */ ,
511 0 /* os_out_of_memory */ );
512 ssvm_pop_heap (oldheap);
518 /* Carve fifo + chunk space */
519 for (i = 0; i < batch_size; i++)
521 c = (svm_fifo_chunk_t *) cmem;
523 c->length = rounded_data_size;
524 c->enq_rb_index = RBTREE_TNIL_INDEX;
525 c->deq_rb_index = RBTREE_TNIL_INDEX;
526 c->next = fss->free_chunks[fl_index];
527 fss->free_chunks[fl_index] = c;
528 cmem += sizeof (*c) + rounded_data_size;
531 fss->num_chunks[fl_index] += batch_size;
532 fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
533 fsh_cached_bytes_add (fsh, batch_size * rounded_data_size);
534 fsh_free_bytes_sub (fsh, size);
540 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
541 fifo_segment_slice_t * fss,
542 u32 fl_index, u32 batch_size)
544 u32 hdrs, rounded_data_size;
552 rounded_data_size = fs_freelist_index_to_size (fl_index);
553 hdrs = sizeof (*f) + sizeof (*c);
554 size = (uword) (hdrs + rounded_data_size) * batch_size;
556 oldheap = ssvm_push_heap (fsh->ssvm_sh);
557 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
558 0 /* align_offset */ ,
559 0 /* os_out_of_memory */ );
560 ssvm_pop_heap (oldheap);
566 /* Carve fifo + chunk space */
567 for (i = 0; i < batch_size; i++)
569 f = (svm_fifo_t *) fmem;
570 memset (f, 0, sizeof (*f));
571 f->next = fss->free_fifos;
573 c = (svm_fifo_chunk_t *) (fmem + sizeof (*f));
575 c->length = rounded_data_size;
576 c->enq_rb_index = RBTREE_TNIL_INDEX;
577 c->deq_rb_index = RBTREE_TNIL_INDEX;
578 c->next = fss->free_chunks[fl_index];
579 fss->free_chunks[fl_index] = c;
580 fmem += hdrs + rounded_data_size;
583 fss->num_chunks[fl_index] += batch_size;
584 fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
585 fsh_cached_bytes_add (fsh, batch_size * rounded_data_size);
586 fsh_free_bytes_sub (fsh, size);
592 * Try to allocate new fifo
594 * Tries the following steps in order:
595 * - grab fifo and chunk from freelists
596 * - batch fifo and chunk allocation
597 * - single fifo allocation
598 * - grab multiple fifo chunks from freelists
601 fs_try_alloc_fifo (fifo_segment_header_t * fsh, fifo_segment_slice_t * fss,
604 u32 fifo_sz, fl_index;
609 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
610 fl_index = fs_freelist_for_size (min_size);
612 clib_spinlock_lock (&fss->chunk_lock);
614 if (fss->free_fifos && fss->free_chunks[fl_index])
616 f = fs_try_alloc_fifo_freelist (fss, fl_index);
619 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
624 fifo_sz = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
625 fifo_sz += 1 << max_log2 (min_size);
626 n_free_bytes = fsh_n_free_bytes (fsh);
628 if (fifo_sz * FIFO_SEGMENT_ALLOC_BATCH_SIZE < n_free_bytes)
630 if (!fs_try_alloc_fifo_batch (fsh, fss, fl_index,
631 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
633 f = fs_try_alloc_fifo_freelist (fss, fl_index);
636 fsh_cached_bytes_sub (fsh,
637 fs_freelist_index_to_size (fl_index));
644 n_free_bytes = fsh_n_free_bytes (fsh);
647 if (fifo_sz <= n_free_bytes)
649 void *oldheap = ssvm_push_heap (fsh->ssvm_sh);
650 f = svm_fifo_alloc (min_size);
651 ssvm_pop_heap (oldheap);
654 fss->num_chunks[fl_index] += 1;
655 fsh_free_bytes_sub (fsh, fifo_sz);
660 /* All failed, try to allocate min of data bytes and fifo sz */
661 fifo_sz = clib_min (fifo_sz, data_bytes);
662 if (fifo_sz <= fss->n_fl_chunk_bytes)
663 f = fs_try_alloc_fifo_freelist_multi_chunk (fsh, fss, fifo_sz);
666 clib_spinlock_unlock (&fss->chunk_lock);
670 f->size = data_bytes;
677 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
679 fifo_segment_slice_t *fss;
683 fl_index = fs_freelist_for_size (chunk_size);
684 fss = fsh_slice_get (fsh, slice_index);
686 clib_spinlock_lock (&fss->chunk_lock);
688 c = fss->free_chunks[fl_index];
692 fss->free_chunks[fl_index] = c->next;
694 fss->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
695 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
703 chunk_size = fs_freelist_index_to_size (fl_index);
704 n_free = fsh_n_free_bytes (fsh);
706 if (chunk_size <= n_free)
708 oldheap = ssvm_push_heap (fsh->ssvm_sh);
709 c = svm_fifo_chunk_alloc (chunk_size);
710 ssvm_pop_heap (oldheap);
714 fss->num_chunks[fl_index] += 1;
715 fsh_free_bytes_sub (fsh, chunk_size + sizeof (*c));
720 n_free = fsh_n_free_bytes (fsh);
722 if (chunk_size <= fss->n_fl_chunk_bytes)
724 c = fs_try_alloc_multi_chunk (fsh, fss, chunk_size);
727 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
728 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
734 if (chunk_size <= fss->n_fl_chunk_bytes + n_free)
736 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
738 batch = (chunk_size - fss->n_fl_chunk_bytes) / min_size;
739 batch = clib_min (batch + 1, n_free / min_size);
740 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
745 c = fs_try_alloc_multi_chunk (fsh, fss, chunk_size);
751 clib_spinlock_unlock (&fss->chunk_lock);
757 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
758 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
760 svm_fifo_chunk_t *next;
764 clib_spinlock_lock (&fss->chunk_lock);
769 fl_index = fs_freelist_for_size (c->length);
770 c->next = fss->free_chunks[fl_index];
771 c->enq_rb_index = RBTREE_TNIL_INDEX;
772 c->deq_rb_index = RBTREE_TNIL_INDEX;
773 fss->free_chunks[fl_index] = c;
774 n_collect += fs_freelist_index_to_size (fl_index);
778 fss->n_fl_chunk_bytes += n_collect;
779 fsh_cached_bytes_add (fsh, n_collect);
781 clib_spinlock_unlock (&fss->chunk_lock);
785 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
786 svm_fifo_chunk_t * c)
788 fifo_segment_slice_t *fss;
789 fss = fsh_slice_get (fsh, slice_index);
790 fsh_slice_collect_chunks (fsh, fss, c);
794 * Allocate fifo in fifo segment
797 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
798 u32 data_bytes, fifo_segment_ftype_t ftype)
800 fifo_segment_header_t *fsh = fs->h;
801 fifo_segment_slice_t *fss;
804 ASSERT (slice_index < fs->n_slices);
806 fss = fsh_slice_get (fsh, slice_index);
807 f = fs_try_alloc_fifo (fsh, fss, data_bytes);
811 f->slice_index = slice_index;
813 svm_fifo_init (f, data_bytes);
815 /* If rx fifo type add to active fifos list. When cleaning up segment,
816 * we need a list of active sessions that should be disconnected. Since
817 * both rx and tx fifos keep pointers to the session, it's enough to track
819 if (ftype == FIFO_SEGMENT_RX_FIFO)
823 fss->fifos->prev = f;
824 f->next = fss->fifos;
827 f->flags |= SVM_FIFO_F_LL_TRACKED;
829 svm_fifo_init_ooo_lookup (f, 0 /* ooo enq */ );
833 svm_fifo_init_ooo_lookup (f, 1 /* ooo deq */ );
836 fsh_active_fifos_update (fsh, 1);
837 fss->virtual_mem += svm_fifo_size (f);
844 * Free fifo allocated in fifo segment
847 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
849 fifo_segment_header_t *fsh = fs->h;
850 fifo_segment_slice_t *fss;
852 ASSERT (f->refcnt > 0);
857 fss = fsh_slice_get (fsh, f->slice_index);
859 /* Remove from active list. Only rx fifos are tracked */
860 if (f->flags & SVM_FIFO_F_LL_TRACKED)
863 f->prev->next = f->next;
865 fss->fifos = f->next;
867 f->next->prev = f->prev;
868 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
871 /* Free fifo chunks */
872 fsh_slice_collect_chunks (fsh, fss, f->start_chunk);
874 f->start_chunk = f->end_chunk = 0;
875 f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = 0;
877 /* not allocated on segment heap */
878 svm_fifo_free_chunk_lookup (f);
879 svm_fifo_free_ooo_data (f);
883 f->master_session_index = ~0;
884 f->master_thread_index = ~0;
887 fss->virtual_mem -= svm_fifo_size (f);
889 /* Add to free list */
890 f->next = fss->free_fifos;
894 fsh_active_fifos_update (fsh, -1);
898 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
901 fifo_segment_header_t *fsh = fs->h;
902 fifo_segment_slice_t *fss;
909 fss = fsh_slice_get (fsh, slice_index);
910 size = (uword) (sizeof (*f)) * batch_size;
912 oldheap = ssvm_push_heap (fsh->ssvm_sh);
913 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
914 0 /* align_offset */ ,
915 0 /* os_out_of_memory */ );
916 ssvm_pop_heap (oldheap);
922 /* Carve fifo + chunk space */
923 for (i = 0; i < batch_size; i++)
925 f = (svm_fifo_t *) fmem;
926 memset (f, 0, sizeof (*f));
927 f->next = fss->free_fifos;
932 fsh_free_bytes_sub (fsh, size);
938 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
939 u32 chunk_size, u32 batch_size)
941 fifo_segment_header_t *fsh = fs->h;
942 u32 rounded_data_size, fl_index;
943 fifo_segment_slice_t *fss;
950 if (!fs_chunk_size_is_valid (fsh, chunk_size))
952 clib_warning ("chunk size out of range %d", chunk_size);
956 fl_index = fs_freelist_for_size (chunk_size);
957 rounded_data_size = fs_freelist_index_to_size (fl_index);
958 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
960 oldheap = ssvm_push_heap (fsh->ssvm_sh);
961 cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
962 0 /* align_offset */ ,
963 0 /* os_out_of_memory */ );
964 ssvm_pop_heap (oldheap);
970 fss = fsh_slice_get (fsh, slice_index);
972 /* Carve fifo + chunk space */
973 for (i = 0; i < batch_size; i++)
975 c = (svm_fifo_chunk_t *) cmem;
977 c->length = rounded_data_size;
978 c->next = fss->free_chunks[fl_index];
979 fss->free_chunks[fl_index] = c;
980 cmem += sizeof (*c) + rounded_data_size;
981 fsh_cached_bytes_add (fsh, rounded_data_size);
984 fss->num_chunks[fl_index] += batch_size;
985 fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
986 fsh_free_bytes_sub (fsh, size);
992 * Pre-allocates fifo pairs in fifo segment
995 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
996 u32 rx_fifo_size, u32 tx_fifo_size,
999 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1000 u32 hdrs, pairs_per_slice, alloc_now;
1001 fifo_segment_header_t *fsh = fs->h;
1002 int rx_fl_index, tx_fl_index, i;
1003 fifo_segment_slice_t *fss;
1004 uword space_available;
1006 /* Parameter check */
1007 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1010 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1012 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1016 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1018 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1022 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1023 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1024 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1025 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1027 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1029 /* Calculate space requirements */
1030 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1031 space_available = fsh_free_space (fsh);
1032 pairs_to_alloc = space_available / pair_size;
1033 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1034 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1035 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1037 if (!pairs_per_slice)
1040 for (i = 0; i < fs->n_slices; i++)
1042 fss = fsh_slice_get (fsh, i);
1043 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1044 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1045 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1046 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1047 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1049 /* Account for the pairs allocated */
1050 *n_fifo_pairs -= alloc_now;
1055 * Get number of active fifos
1058 fifo_segment_num_fifos (fifo_segment_t * fs)
1060 return clib_atomic_load_relax_n (&fs->h->n_active_fifos);
1064 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1069 f = fss->free_fifos;
1082 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1084 fifo_segment_header_t *fsh = fs->h;
1085 fifo_segment_slice_t *fss;
1089 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1091 fss = fsh_slice_get (fsh, slice_index);
1092 count += fs_slice_num_free_fifos (fss);
1098 fs_slice_num_free_chunks (fifo_segment_slice_t * fss, u32 size)
1100 u32 count = 0, rounded_size, fl_index;
1101 svm_fifo_chunk_t *c;
1104 /* Count all free chunks? */
1107 for (i = 0; i < vec_len (fss->free_chunks); i++)
1109 c = fss->free_chunks[i];
1122 rounded_size = (1 << (max_log2 (size)));
1123 fl_index = fs_freelist_for_size (rounded_size);
1125 if (fl_index >= vec_len (fss->free_chunks))
1128 c = fss->free_chunks[fl_index];
1141 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1143 fifo_segment_header_t *fsh = fs->h;
1144 fifo_segment_slice_t *fss;
1148 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1150 fss = fsh_slice_get (fsh, slice_index);
1151 count += fs_slice_num_free_chunks (fss, size);
1157 fifo_segment_update_free_bytes (fifo_segment_t * fs)
1159 fsh_update_free_bytes (fs->h);
1163 fifo_segment_size (fifo_segment_t * fs)
1165 return fs->ssvm.ssvm_size;
1169 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1171 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1175 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1177 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1181 fifo_segment_free_bytes (fifo_segment_t * fs)
1183 return fsh_n_free_bytes (fs->h);
1187 fifo_segment_cached_bytes (fifo_segment_t * fs)
1189 return fsh_n_cached_bytes (fs->h);
1193 fifo_segment_available_bytes (fifo_segment_t * fs)
1195 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1199 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1201 fifo_segment_header_t *fsh = fs->h;
1202 fifo_segment_slice_t *fss;
1206 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1208 fss = fsh_slice_get (fsh, slice_index);
1209 n_bytes += fss->n_fl_chunk_bytes;
1216 fifo_segment_has_fifos (fifo_segment_t * fs)
1218 fifo_segment_header_t *fsh = fs->h;
1219 fifo_segment_slice_t *fss;
1222 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1224 fss = fsh_slice_get (fsh, slice_index);
1232 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1234 fifo_segment_header_t *fsh = fs->h;
1235 fifo_segment_slice_t *fss;
1237 fss = fsh_slice_get (fsh, slice_index);
1242 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1246 size = fifo_segment_size (fs);
1248 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1249 return (in_use * 100) / size;
1252 fifo_segment_mem_status_t
1253 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1255 if (!fsh->high_watermark || !fsh->low_watermark)
1256 return MEMORY_PRESSURE_NO_PRESSURE;
1258 /* once the no-memory is detected, the status continues
1259 * until memory usage gets below the high watermark
1261 if (fsh_has_reached_mem_limit (fsh))
1263 if (usage >= fsh->high_watermark)
1264 return MEMORY_PRESSURE_NO_MEMORY;
1266 fsh_reset_mem_limit (fsh);
1269 if (usage >= fsh->high_watermark)
1270 return MEMORY_PRESSURE_HIGH_PRESSURE;
1272 else if (usage >= fsh->low_watermark)
1273 return MEMORY_PRESSURE_LOW_PRESSURE;
1275 return MEMORY_PRESSURE_NO_PRESSURE;
1278 fifo_segment_mem_status_t
1279 fifo_segment_get_mem_status (fifo_segment_t * fs)
1281 fifo_segment_header_t *fsh = fs->h;
1282 u8 usage = fifo_segment_get_mem_usage (fs);
1284 return fifo_segment_determine_status (fsh, usage);
1288 format_fifo_segment_type (u8 * s, va_list * args)
1291 sp = va_arg (*args, fifo_segment_t *);
1292 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1294 if (st == SSVM_SEGMENT_PRIVATE)
1295 s = format (s, "%s", "private-heap");
1296 else if (st == SSVM_SEGMENT_MEMFD)
1297 s = format (s, "%s", "memfd");
1298 else if (st == SSVM_SEGMENT_SHM)
1299 s = format (s, "%s", "shm");
1301 s = format (s, "%s", "unknown");
1306 * Segment format function
1309 format_fifo_segment (u8 * s, va_list * args)
1311 u32 count, indent, active_fifos, free_fifos;
1312 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1313 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1314 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1315 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1316 uword tracked_cached_bytes;
1317 uword fifo_hdr = 0, reserved;
1318 fifo_segment_header_t *fsh;
1319 fifo_segment_slice_t *fss;
1320 svm_fifo_chunk_t *c;
1325 uword allocated, in_use, virt;
1327 fifo_segment_mem_status_t mem_st;
1329 indent = format_get_indent (s) + 2;
1333 s = format (s, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
1334 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1338 fifo_segment_info (fs, &address, &size);
1339 active_fifos = fifo_segment_num_fifos (fs);
1340 free_fifos = fifo_segment_num_free_fifos (fs);
1342 s = format (s, "%-15v%15U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1343 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1344 free_fifos, address);
1351 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1354 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1357 s = format (s, "\n");
1359 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1361 fss = fsh_slice_get (fsh, slice_index);
1362 for (i = 0; i < vec_len (fss->free_chunks); i++)
1364 c = fss->free_chunks[i];
1365 if (c == 0 && fss->num_chunks[i] == 0)
1374 chunk_size = fs_freelist_index_to_size (i);
1375 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1376 chunk_size >> 10, count, fss->num_chunks[i]);
1378 chunk_bytes += count * chunk_size;
1382 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1383 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1384 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1385 fifo_segment_update_free_bytes (fs);
1386 free_seg_bytes = fifo_segment_free_bytes (fs);
1387 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1388 allocated = fifo_segment_size (fs);
1389 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1390 usage = (100.0 * in_use) / allocated;
1391 mem_st = fifo_segment_get_mem_status (fs);
1392 virt = fsh_virtual_mem (fsh);
1393 reserved = fsh->n_reserved_bytes;
1395 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1396 " %U (%lu)\n", format_white_space, indent + 2,
1397 format_memory_size, free_seg_bytes, free_seg_bytes,
1398 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1399 format_memory_size, reserved, reserved);
1400 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1401 " %U (%lu)\n", format_white_space, indent + 2,
1402 format_memory_size, chunk_bytes, chunk_bytes,
1403 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1404 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1405 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1406 format_white_space, indent + 2, fsh->n_active_fifos,
1407 format_memory_size, fifo_hdr, fifo_hdr);
1408 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1409 format_white_space, indent + 2, usage, format_memory_size,
1410 in_use, format_memory_size, allocated, format_memory_size, virt,
1411 fifo_segment_mem_status_strings[mem_st]);
1412 s = format (s, "\n");
1418 * fd.io coding-style-patch-verification: ON
1421 * eval: (c-set-style "gnu")