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_header_t *fsh,
152 fifo_segment_slice_t *fss, u32 fl_index,
155 fss_chunk_freelist_lock (fss);
156 c->next = fss->free_chunks[fl_index];
157 fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, c);
158 fss_chunk_freelist_unlock (fss);
162 fss_chunk_free_list_push_list (fifo_segment_header_t *fsh,
163 fifo_segment_slice_t *fss, u32 fl_index,
164 svm_fifo_chunk_t *head, svm_fifo_chunk_t *tail)
166 fss_chunk_freelist_lock (fss);
167 tail->next = fss->free_chunks[fl_index];
168 fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, head);
169 fss_chunk_freelist_unlock (fss);
172 static svm_fifo_chunk_t *
173 fss_chunk_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
178 ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
180 fss_chunk_freelist_lock (fss);
182 if (!fss->free_chunks[fl_index])
184 fss_chunk_freelist_unlock (fss);
188 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
189 fss->free_chunks[fl_index] = c->next;
191 fss_chunk_freelist_unlock (fss);
197 fss_fifo_add_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
201 fss->fifos->prev = f;
202 f->next = fss->fifos;
208 fss_fifo_del_active_list (fifo_segment_slice_t * fss, svm_fifo_t * f)
210 if (f->flags & SVM_FIFO_F_LL_TRACKED)
213 f->prev->next = f->next;
215 fss->fifos = f->next;
217 f->next->prev = f->prev;
222 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
224 return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
228 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
230 clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
234 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
236 clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
240 * Initialize fifo segment shared header
243 fifo_segment_init (fifo_segment_t * fs)
245 u32 align = 8, offset = 2 * 4096, slices_sz, i;
246 uword max_fifo, seg_start, seg_sz;
247 fifo_segment_header_t *fsh;
248 ssvm_shared_header_t *sh;
251 /* TODO remove ssvm heap entirely */
254 seg_data = (u8 *) sh + offset;
255 seg_sz = sh->ssvm_size - offset;
257 fs->n_slices = clib_max (fs->n_slices, 1);
258 slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
260 seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
261 fsh = uword_to_pointer (seg_start, void *);
262 memset (fsh, 0, sizeof (*fsh) + slices_sz);
264 fsh->byte_index = sizeof (*fsh) + slices_sz;
265 fsh->max_byte_index = seg_sz;
266 fsh->n_slices = fs->n_slices;
267 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
268 fsh->max_log2_fifo_size = min_log2 (max_fifo);
269 fsh->n_cached_bytes = 0;
270 fsh->n_reserved_bytes = fsh->byte_index;
271 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
273 fs->max_byte_index = fsh->max_byte_index;
274 fs->h = sh->opaque[0] = fsh;
276 vec_validate (fs->slices, fs->n_slices - 1);
277 for (i = 0; i < fs->n_slices; i++)
278 fs->slices[i].fifos =
279 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
286 * Create a fifo segment and initialize as master
289 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
295 /* Allocate a fresh segment */
296 pool_get_zero (sm->segments, fs);
298 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
299 fs->ssvm.ssvm_size = a->segment_size;
300 fs->ssvm.is_server = 1;
301 fs->ssvm.my_pid = getpid ();
302 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
303 fs->ssvm.requested_va = baseva;
305 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
307 pool_put (sm->segments, fs);
311 /* Note: requested_va updated due to seg base addr randomization */
312 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
314 fifo_segment_init (fs);
315 vec_add1 (a->new_segment_indices, fs - sm->segments);
320 * Attach as slave to a fifo segment
323 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
325 fifo_segment_header_t *fsh;
329 pool_get_zero (sm->segments, fs);
331 fs->ssvm.ssvm_size = a->segment_size;
332 fs->ssvm.my_pid = getpid ();
333 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
334 fs->ssvm.requested_va = sm->next_baseva;
335 if (a->segment_type == SSVM_SEGMENT_MEMFD)
336 fs->ssvm.fd = a->memfd_fd;
338 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
340 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
342 _vec_len (fs) = vec_len (fs) - 1;
346 /* Fish the segment header */
347 fsh = fs->h = fs->ssvm.sh->opaque[0];
349 /* Probably a segment without fifos */
353 fs->max_byte_index = fsh->max_byte_index;
354 vec_validate (fs->slices, 0);
355 fs->slices[0].fifos =
356 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
359 vec_add1 (a->new_segment_indices, fs - sm->segments);
364 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
366 fifo_segment_cleanup (s);
367 ssvm_delete (&s->ssvm);
368 clib_memset (s, 0xfe, sizeof (*s));
369 pool_put (sm->segments, s);
373 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
375 return s - sm->segments;
379 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
381 return pool_elt_at_index (sm->segments, segment_index);
385 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
387 *address = (char *) seg->ssvm.sh->ssvm_va;
388 *size = seg->ssvm.ssvm_size;
392 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
393 u32 timeout_in_seconds)
395 sm->next_baseva = baseva;
396 sm->timeout_in_seconds = timeout_in_seconds;
400 fs_freelist_for_size (u32 size)
402 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
404 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
405 FS_CHUNK_VEC_LEN - 1);
409 fs_freelist_index_to_size (u32 fl_index)
411 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
415 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
418 * 4K minimum. It's not likely that anything good will happen
419 * with a smaller FIFO.
421 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
422 size <= (1ULL << fsh->max_log2_fifo_size);
426 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
427 fifo_segment_slice_t * fss, u32 data_bytes)
429 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
430 svm_fifo_chunk_t *c, *first = 0, *next;
432 fl_index = fs_freelist_for_size (req_bytes);
436 fl_size = fs_freelist_index_to_size (fl_index);
440 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
443 c->next = fs_chunk_sptr (fsh, first);
446 req_bytes -= clib_min (fl_size, req_bytes);
450 /* Failed to allocate with smaller chunks */
453 /* Free all chunks if any allocated */
457 fl_index = fs_freelist_for_size (c->length);
458 next = fs_chunk_ptr (fsh, c->next);
459 fss_chunk_free_list_push (fsh, fss, fl_index, c);
464 /* As last attempt, try allocating a chunk larger than
465 * the requested size, if possible */
466 fl_index = fs_freelist_for_size (data_bytes) + 1;
467 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
469 first = fss_chunk_free_list_pop (fsh, fss, fl_index);
473 n_alloc = fs_freelist_index_to_size (fl_index);
479 fl_size = fl_size >> 1;
484 fss_fl_chunk_bytes_sub (fss, n_alloc);
485 fsh_cached_bytes_sub (fsh, n_alloc);
490 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
491 fifo_segment_slice_t * fss, u32 batch_size)
493 svm_fifo_shared_t *f;
498 ASSERT (batch_size != 0);
500 size = (uword) sizeof (*f) * batch_size;
502 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
506 /* Carve fifo hdr space */
507 for (i = 0; i < batch_size; i++)
509 f = (svm_fifo_shared_t *) fmem;
510 memset (f, 0, sizeof (*f));
511 f->next = fss->free_fifos;
520 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
521 fifo_segment_slice_t * fss,
522 u32 fl_index, u32 batch_size)
524 svm_fifo_chunk_t *c, *head = 0, *tail;
525 uword size, total_chunk_bytes;
526 u32 rounded_data_size;
530 ASSERT (batch_size != 0);
532 rounded_data_size = fs_freelist_index_to_size (fl_index);
533 total_chunk_bytes = (uword) batch_size *rounded_data_size;
534 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
536 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
540 /* Carve fifo + chunk space */
541 tail = c = (svm_fifo_chunk_t *) cmem;
542 for (i = 0; i < batch_size; i++)
545 c->length = rounded_data_size;
546 c->next = fs_chunk_sptr (fsh, head);
548 cmem += sizeof (*c) + rounded_data_size;
549 c = (svm_fifo_chunk_t *) cmem;
552 fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
553 fss->num_chunks[fl_index] += batch_size;
554 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
555 fsh_cached_bytes_add (fsh, total_chunk_bytes);
561 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
562 fifo_segment_slice_t * fss,
563 u32 fl_index, u32 batch_size)
565 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
567 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
570 static svm_fifo_shared_t *
571 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
573 svm_fifo_shared_t *f;
575 if (!fss->free_fifos)
577 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
578 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
583 fss->free_fifos = f->next;
584 memset (f, 0, sizeof (*f));
588 static svm_fifo_chunk_t *
589 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
590 fifo_segment_slice_t * fss, u32 data_bytes)
595 fl_index = fs_freelist_for_size (data_bytes);
598 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
602 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
603 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
607 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
610 chunk_size = fs_freelist_index_to_size (fl_index);
611 n_free = fsh_n_free_bytes (fsh);
613 if (chunk_size <= n_free)
615 batch = chunk_size * batch <= n_free ? batch : 1;
616 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
619 /* Failed to allocate larger chunk, try to allocate multi-chunk
620 * that is close to what was actually requested */
621 if (data_bytes <= fss_fl_chunk_bytes (fss))
623 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
626 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
627 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
630 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
632 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
634 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
635 batch = clib_min (batch + 1, n_free / min_size);
636 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
638 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
648 * Try to allocate new fifo
650 * Tries the following steps in order:
651 * - grab fifo and chunk from freelists
652 * - batch fifo and chunk allocation
653 * - single fifo allocation
654 * - grab multiple fifo chunks from freelists
656 static svm_fifo_shared_t *
657 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
659 fifo_segment_slice_t *fss;
660 u32 fl_index, min_size;
662 svm_fifo_shared_t *sf = 0;
664 fss = fsh_slice_get (fsh, slice_index);
665 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
666 fl_index = fs_freelist_for_size (min_size);
668 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
671 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
675 c = fsh_try_alloc_chunk (fsh, fss, min_size);
678 sf->next = fss->free_fifos;
679 fss->free_fifos = sf;
683 sf->start_chunk = fs_chunk_sptr (fsh, c);
685 c = fs_chunk_ptr (fsh, c->next);
686 sf->end_chunk = fs_chunk_sptr (fsh, c);
687 sf->size = data_bytes;
688 sf->slice_index = slice_index;
694 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
696 fifo_segment_slice_t *fss;
699 fss = fsh_slice_get (fsh, slice_index);
700 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
706 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
707 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
709 u32 n_collect = 0, fl_index;
710 svm_fifo_chunk_t *next;
714 CLIB_MEM_UNPOISON (c, sizeof (*c));
715 next = fs_chunk_ptr (fsh, c->next);
716 fl_index = fs_freelist_for_size (c->length);
717 fss_chunk_free_list_push (fsh, fss, fl_index, c);
718 n_collect += fs_freelist_index_to_size (fl_index);
722 fss_fl_chunk_bytes_add (fss, n_collect);
723 fsh_cached_bytes_add (fsh, n_collect);
727 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
728 svm_fifo_chunk_t * c)
730 fifo_segment_slice_t *fss;
731 fss = fsh_slice_get (fsh, slice_index);
732 fsh_slice_collect_chunks (fsh, fss, c);
736 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
738 fifo_slice_private_t *pfss = &fs->slices[slice_index];
741 f = clib_mem_bulk_alloc (pfss->fifos);
742 clib_memset (f, 0, sizeof (*f));
747 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f)
749 u32 slice_index = f->shr->slice_index;
750 fifo_slice_private_t *pfss;
752 pfss = &fs->slices[slice_index];
753 clib_mem_bulk_free (pfss->fifos, f);
757 fifo_segment_cleanup (fifo_segment_t *fs)
761 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
762 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
766 * Allocate fifo in fifo segment
769 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
770 u32 data_bytes, fifo_segment_ftype_t ftype)
772 fifo_segment_header_t *fsh = fs->h;
773 fifo_segment_slice_t *fss;
774 svm_fifo_shared_t *sf;
777 ASSERT (slice_index < fs->n_slices);
779 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
782 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
786 f = fs_fifo_alloc (fs, slice_index);
790 svm_fifo_init (f, data_bytes);
792 fss = fsh_slice_get (fsh, slice_index);
794 /* If rx fifo type add to active fifos list. When cleaning up segment,
795 * we need a list of active sessions that should be disconnected. Since
796 * both rx and tx fifos keep pointers to the session, it's enough to track
798 if (ftype == FIFO_SEGMENT_RX_FIFO)
800 fss_fifo_add_active_list (fss, f);
801 f->flags |= SVM_FIFO_F_LL_TRACKED;
804 fsh_active_fifos_update (fsh, 1);
805 fss->virtual_mem += svm_fifo_size (f);
812 fifo_segment_alloc_fifo_w_shared (fifo_segment_t *fs, svm_fifo_shared_t *sf)
814 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
818 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
819 f->segment_index = SVM_FIFO_INVALID_INDEX;
825 * Free fifo allocated in fifo segment
828 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
830 fifo_segment_header_t *fsh = fs->h;
831 fifo_segment_slice_t *fss;
832 svm_fifo_shared_t *sf;
834 ASSERT (f->refcnt > 0);
840 * Cleanup shared state
844 fss = fsh_slice_get (fsh, sf->slice_index);
846 /* Free fifo chunks */
847 fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
849 sf->start_chunk = sf->end_chunk = 0;
850 sf->head_chunk = sf->tail_chunk = 0;
852 /* Add to free list */
853 sf->next = fss->free_fifos;
854 fss->free_fifos = sf;
856 fss->virtual_mem -= svm_fifo_size (f);
859 * Cleanup private state
862 /* Remove from active list. Only rx fifos are tracked */
863 if (f->flags & SVM_FIFO_F_LL_TRACKED)
865 fss_fifo_del_active_list (fss, f);
866 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
869 svm_fifo_free_chunk_lookup (f);
870 svm_fifo_free_ooo_data (f);
874 sf->master_session_index = ~0;
875 f->master_thread_index = ~0;
878 f->ooo_enq = f->ooo_deq = 0;
881 fs_fifo_free (fs, f);
883 fsh_active_fifos_update (fsh, -1);
887 fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f)
889 fifo_segment_slice_t *fss;
893 ASSERT (f->refcnt == 1);
895 fss = fsh_slice_get (fs->h, f->shr->slice_index);
896 fss->virtual_mem -= svm_fifo_size (f);
897 if (f->flags & SVM_FIFO_F_LL_TRACKED)
898 fss_fifo_del_active_list (fss, f);
900 c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
903 fl_index = fs_freelist_for_size (c->length);
904 clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
905 c = fs_chunk_ptr (fs->h, c->next);
910 fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
913 fifo_segment_slice_t *fss;
917 f->shr->slice_index = slice_index;
918 fss = fsh_slice_get (fs->h, f->shr->slice_index);
919 fss->virtual_mem += svm_fifo_size (f);
920 if (f->flags & SVM_FIFO_F_LL_TRACKED)
921 fss_fifo_add_active_list (fss, f);
923 c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
926 fl_index = fs_freelist_for_size (c->length);
927 clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
928 c = fs_chunk_ptr (fs->h, c->next);
933 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
936 fifo_segment_header_t *fsh = fs->h;
937 fifo_segment_slice_t *fss;
939 fss = fsh_slice_get (fsh, slice_index);
940 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
944 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
945 u32 chunk_size, u32 batch_size)
947 fifo_segment_header_t *fsh = fs->h;
948 fifo_segment_slice_t *fss;
951 if (!fs_chunk_size_is_valid (fsh, chunk_size))
953 clib_warning ("chunk size out of range %d", chunk_size);
957 fl_index = fs_freelist_for_size (chunk_size);
958 fss = fsh_slice_get (fsh, slice_index);
960 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
964 * Pre-allocates fifo pairs in fifo segment
967 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
968 u32 rx_fifo_size, u32 tx_fifo_size,
971 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
972 u32 hdrs, pairs_per_slice, alloc_now;
973 fifo_segment_header_t *fsh = fs->h;
974 int rx_fl_index, tx_fl_index, i;
975 fifo_segment_slice_t *fss;
976 uword space_available;
978 /* Parameter check */
979 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
982 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
984 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
988 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
990 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
994 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
995 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
996 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
997 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
999 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1001 /* Calculate space requirements */
1002 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1003 space_available = fsh_n_free_bytes (fsh);
1004 pairs_to_alloc = space_available / pair_size;
1005 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1006 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1007 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1009 if (!pairs_per_slice)
1012 for (i = 0; i < fs->n_slices; i++)
1014 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1018 fss = fsh_slice_get (fsh, i);
1019 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1020 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1021 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1022 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1024 /* Account for the pairs allocated */
1025 *n_fifo_pairs -= alloc_now;
1030 * Get number of active fifos
1033 fifo_segment_num_fifos (fifo_segment_t * fs)
1035 return fsh_n_active_fifos (fs->h);
1039 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1041 svm_fifo_shared_t *f;
1044 f = fss->free_fifos;
1057 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1059 fifo_segment_header_t *fsh = fs->h;
1060 fifo_segment_slice_t *fss;
1064 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1066 fss = fsh_slice_get (fsh, slice_index);
1067 count += fs_slice_num_free_fifos (fss);
1073 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1074 fifo_segment_slice_t *fss, u32 size)
1076 u32 count = 0, rounded_size, fl_index;
1077 svm_fifo_chunk_t *c;
1080 /* Count all free chunks? */
1083 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1085 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1091 c = fs_chunk_ptr (fsh, c->next);
1098 rounded_size = (1 << (max_log2 (size)));
1099 fl_index = fs_freelist_for_size (rounded_size);
1101 if (fl_index >= FS_CHUNK_VEC_LEN)
1104 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
1110 c = fs_chunk_ptr (fsh, c->next);
1117 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1119 fifo_segment_header_t *fsh = fs->h;
1120 fifo_segment_slice_t *fss;
1124 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1126 fss = fsh_slice_get (fsh, slice_index);
1127 count += fs_slice_num_free_chunks (fsh, fss, size);
1133 fifo_segment_size (fifo_segment_t * fs)
1135 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1139 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1141 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1145 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1147 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1151 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1153 void *rv = fsh_alloc (fs->h, size);
1154 /* Mark externally allocated bytes as reserved. This helps
1155 * @ref fifo_segment_size report bytes used only for fifos */
1156 fs->h->n_reserved_bytes += size;
1161 fifo_segment_free_bytes (fifo_segment_t * fs)
1163 return fsh_n_free_bytes (fs->h);
1167 fifo_segment_cached_bytes (fifo_segment_t * fs)
1169 return fsh_n_cached_bytes (fs->h);
1173 fifo_segment_available_bytes (fifo_segment_t * fs)
1175 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1179 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1181 fifo_segment_header_t *fsh = fs->h;
1182 fifo_segment_slice_t *fss;
1186 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1188 fss = fsh_slice_get (fsh, slice_index);
1189 n_bytes += fss_fl_chunk_bytes (fss);
1196 fifo_segment_has_fifos (fifo_segment_t * fs)
1198 return (fsh_n_active_fifos (fs->h) != 0);
1202 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1204 fifo_segment_header_t *fsh = fs->h;
1205 fifo_segment_slice_t *fss;
1207 fss = fsh_slice_get (fsh, slice_index);
1212 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1216 size = fifo_segment_size (fs);
1218 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1219 return (in_use * 100) / size;
1222 fifo_segment_mem_status_t
1223 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1225 if (!fsh->high_watermark || !fsh->low_watermark)
1226 return MEMORY_PRESSURE_NO_PRESSURE;
1228 /* once the no-memory is detected, the status continues
1229 * until memory usage gets below the high watermark
1231 if (fsh_has_reached_mem_limit (fsh))
1233 if (usage >= fsh->high_watermark)
1234 return MEMORY_PRESSURE_NO_MEMORY;
1236 fsh_reset_mem_limit (fsh);
1239 if (usage >= fsh->high_watermark)
1240 return MEMORY_PRESSURE_HIGH_PRESSURE;
1242 else if (usage >= fsh->low_watermark)
1243 return MEMORY_PRESSURE_LOW_PRESSURE;
1245 return MEMORY_PRESSURE_NO_PRESSURE;
1248 fifo_segment_mem_status_t
1249 fifo_segment_get_mem_status (fifo_segment_t * fs)
1251 fifo_segment_header_t *fsh = fs->h;
1252 u8 usage = fifo_segment_get_mem_usage (fs);
1254 return fifo_segment_determine_status (fsh, usage);
1258 format_fifo_segment_type (u8 * s, va_list * args)
1261 sp = va_arg (*args, fifo_segment_t *);
1262 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1264 if (st == SSVM_SEGMENT_PRIVATE)
1265 s = format (s, "%s", "private");
1266 else if (st == SSVM_SEGMENT_MEMFD)
1267 s = format (s, "%s", "memfd");
1268 else if (st == SSVM_SEGMENT_SHM)
1269 s = format (s, "%s", "shm");
1271 s = format (s, "%s", "unknown");
1276 * Segment format function
1279 format_fifo_segment (u8 * s, va_list * args)
1281 u32 count, indent, active_fifos, free_fifos;
1282 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1283 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1284 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1285 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1286 uword tracked_cached_bytes;
1287 uword fifo_hdr = 0, reserved;
1288 fifo_segment_header_t *fsh;
1289 fifo_segment_slice_t *fss;
1290 svm_fifo_chunk_t *c;
1295 uword allocated, in_use, virt;
1297 fifo_segment_mem_status_t mem_st;
1299 indent = format_get_indent (s) + 2;
1303 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1304 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1308 fifo_segment_info (fs, &address, &size);
1309 active_fifos = fifo_segment_num_fifos (fs);
1310 free_fifos = fifo_segment_num_free_fifos (fs);
1312 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1313 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1314 free_fifos, address);
1321 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1324 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1327 s = format (s, "\n");
1329 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1331 fss = fsh_slice_get (fsh, slice_index);
1332 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1334 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1335 if (c == 0 && fss->num_chunks[i] == 0)
1340 c = fs_chunk_ptr (fsh, c->next);
1344 chunk_size = fs_freelist_index_to_size (i);
1345 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1346 chunk_size >> 10, count, fss->num_chunks[i]);
1348 chunk_bytes += count * chunk_size;
1352 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1353 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1354 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1355 free_seg_bytes = fifo_segment_free_bytes (fs);
1356 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1357 allocated = fifo_segment_size (fs);
1358 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1359 usage = (100.0 * in_use) / allocated;
1360 mem_st = fifo_segment_get_mem_status (fs);
1361 virt = fsh_virtual_mem (fsh);
1362 reserved = fsh->n_reserved_bytes;
1364 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1365 " %U (%lu)\n", format_white_space, indent + 2,
1366 format_memory_size, free_seg_bytes, free_seg_bytes,
1367 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1368 format_memory_size, reserved, reserved);
1369 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1370 " %U (%lu)\n", format_white_space, indent + 2,
1371 format_memory_size, chunk_bytes, chunk_bytes,
1372 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1373 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1374 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1375 format_white_space, indent + 2, fsh->n_active_fifos,
1376 format_memory_size, fifo_hdr, fifo_hdr);
1377 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1378 format_white_space, indent + 2, usage, format_memory_size,
1379 in_use, format_memory_size, allocated, format_memory_size, virt,
1380 fifo_segment_mem_status_strings[mem_st]);
1381 s = format (s, "\n");
1387 * fd.io coding-style-patch-verification: ON
1390 * eval: (c-set-style "gnu")