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 inline fifo_slice_private_t *
56 fs_slice_private_get (fifo_segment_t *fs, u32 slice_index)
58 ASSERT (slice_index < fs->n_slices);
59 return &fs->slices[slice_index];
62 static char *fifo_segment_mem_status_strings[] = {
63 #define _(sym,str) str,
64 foreach_segment_mem_status
69 fsh_n_free_bytes (fifo_segment_header_t * fsh)
71 uword cur_pos = clib_atomic_load_relax_n (&fsh->byte_index);
72 ASSERT (fsh->max_byte_index > cur_pos);
73 return fsh->max_byte_index - cur_pos;
77 fsh_cached_bytes_add (fifo_segment_header_t * fsh, uword size)
79 clib_atomic_fetch_add_rel (&fsh->n_cached_bytes, size);
83 fsh_cached_bytes_sub (fifo_segment_header_t * fsh, uword size)
85 clib_atomic_fetch_sub_rel (&fsh->n_cached_bytes, size);
89 fsh_n_cached_bytes (fifo_segment_header_t * fsh)
91 uword n_cached = clib_atomic_load_relax_n (&fsh->n_cached_bytes);
96 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
98 clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
102 fsh_n_active_fifos (fifo_segment_header_t * fsh)
104 return clib_atomic_load_relax_n (&fsh->n_active_fifos);
108 fsh_virtual_mem (fifo_segment_header_t * fsh)
110 fifo_segment_slice_t *fss;
114 for (i = 0; i < fsh->n_slices; i++)
116 fss = fsh_slice_get (fsh, i);
117 total_vm += clib_atomic_load_relax_n (&fss->virtual_mem);
123 fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
126 fifo_segment_slice_t *fss = fsh_slice_get (fsh, slice_index);
127 fss->virtual_mem += n_bytes;
131 fss_chunk_freelist_lock (fifo_segment_slice_t *fss)
134 while (!clib_atomic_cmp_and_swap_acq_relax_n (&fss->chunk_lock, &free, 1, 0))
136 /* atomic load limits number of compare_exchange executions */
137 while (clib_atomic_load_relax_n (&fss->chunk_lock))
139 /* on failure, compare_exchange writes (*p)->lock into free */
145 fss_chunk_freelist_unlock (fifo_segment_slice_t *fss)
147 /* Make sure all reads/writes are complete before releasing the lock */
148 clib_atomic_release (&fss->chunk_lock);
152 fss_chunk_fl_index_is_valid (fifo_segment_slice_t * fss, u32 fl_index)
154 return (fl_index < FS_CHUNK_VEC_LEN);
158 fss_chunk_free_list_push (fifo_segment_header_t *fsh,
159 fifo_segment_slice_t *fss, u32 fl_index,
162 fss_chunk_freelist_lock (fss);
163 c->next = fss->free_chunks[fl_index];
164 fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, c);
165 fss_chunk_freelist_unlock (fss);
169 fss_chunk_free_list_push_list (fifo_segment_header_t *fsh,
170 fifo_segment_slice_t *fss, u32 fl_index,
171 svm_fifo_chunk_t *head, svm_fifo_chunk_t *tail)
173 fss_chunk_freelist_lock (fss);
174 tail->next = fss->free_chunks[fl_index];
175 fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, head);
176 fss_chunk_freelist_unlock (fss);
179 static svm_fifo_chunk_t *
180 fss_chunk_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
185 ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
187 fss_chunk_freelist_lock (fss);
189 if (!fss->free_chunks[fl_index])
191 fss_chunk_freelist_unlock (fss);
195 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
196 fss->free_chunks[fl_index] = c->next;
198 fss_chunk_freelist_unlock (fss);
204 pfss_fifo_add_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
206 if (pfss->active_fifos)
208 pfss->active_fifos->prev = f;
209 f->next = pfss->active_fifos;
211 pfss->active_fifos = f;
215 pfss_fifo_del_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
217 if (f->flags & SVM_FIFO_F_LL_TRACKED)
220 f->prev->next = f->next;
222 pfss->active_fifos = f->next;
224 f->next->prev = f->prev;
229 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
231 return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
235 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
237 clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
241 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
243 clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
247 * Initialize fifo segment shared header
250 fifo_segment_init (fifo_segment_t * fs)
252 u32 align = 8, offset = 2 * 4096, slices_sz, i;
253 uword max_fifo, seg_start, seg_sz;
254 fifo_segment_header_t *fsh;
255 ssvm_shared_header_t *sh;
258 /* TODO remove ssvm heap entirely */
261 seg_data = (u8 *) sh + offset;
262 seg_sz = sh->ssvm_size - offset;
264 fs->n_slices = clib_max (fs->n_slices, 1);
265 slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
267 seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
268 fsh = uword_to_pointer (seg_start, void *);
269 memset (fsh, 0, sizeof (*fsh) + slices_sz);
271 fsh->byte_index = sizeof (*fsh) + slices_sz;
272 fsh->max_byte_index = seg_sz;
273 fsh->n_slices = fs->n_slices;
274 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
275 fsh->max_log2_fifo_size = min_log2 (max_fifo);
276 fsh->n_cached_bytes = 0;
277 fsh->n_reserved_bytes = fsh->byte_index;
278 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
280 fs->max_byte_index = fsh->max_byte_index;
281 fs->h = sh->opaque[0] = fsh;
283 vec_validate (fs->slices, fs->n_slices - 1);
284 for (i = 0; i < fs->n_slices; i++)
285 fs->slices[i].fifos =
286 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
293 * Create a fifo segment and initialize as master
296 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
302 /* Allocate a fresh segment */
303 pool_get_zero (sm->segments, fs);
305 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
306 fs->ssvm.ssvm_size = a->segment_size;
307 fs->ssvm.is_server = 1;
308 fs->ssvm.my_pid = getpid ();
309 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
310 fs->ssvm.requested_va = baseva;
312 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
314 pool_put (sm->segments, fs);
318 /* Note: requested_va updated due to seg base addr randomization */
319 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
321 fifo_segment_init (fs);
322 vec_add1 (a->new_segment_indices, fs - sm->segments);
327 * Attach as slave to a fifo segment
330 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
332 fifo_segment_header_t *fsh;
336 pool_get_zero (sm->segments, fs);
338 fs->ssvm.ssvm_size = a->segment_size;
339 fs->ssvm.my_pid = getpid ();
340 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
341 fs->ssvm.requested_va = sm->next_baseva;
342 if (a->segment_type == SSVM_SEGMENT_MEMFD)
343 fs->ssvm.fd = a->memfd_fd;
345 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
347 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
349 _vec_len (fs) = vec_len (fs) - 1;
353 /* Fish the segment header */
354 fsh = fs->h = fs->ssvm.sh->opaque[0];
356 /* Probably a segment without fifos */
360 fs->max_byte_index = fsh->max_byte_index;
361 vec_validate (fs->slices, 0);
362 fs->slices[0].fifos =
363 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
366 vec_add1 (a->new_segment_indices, fs - sm->segments);
371 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
373 fifo_segment_cleanup (s);
374 ssvm_delete (&s->ssvm);
375 clib_memset (s, 0xfe, sizeof (*s));
376 pool_put (sm->segments, s);
380 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
382 return s - sm->segments;
386 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
388 return pool_elt_at_index (sm->segments, segment_index);
392 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
394 *address = (char *) seg->ssvm.sh->ssvm_va;
395 *size = seg->ssvm.ssvm_size;
399 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
400 u32 timeout_in_seconds)
402 sm->next_baseva = baseva;
403 sm->timeout_in_seconds = timeout_in_seconds;
407 fs_freelist_for_size (u32 size)
409 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
411 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
412 FS_CHUNK_VEC_LEN - 1);
416 fs_freelist_index_to_size (u32 fl_index)
418 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
422 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
425 * 4K minimum. It's not likely that anything good will happen
426 * with a smaller FIFO.
428 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
429 size <= (1ULL << fsh->max_log2_fifo_size);
433 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
434 fifo_segment_slice_t * fss, u32 data_bytes)
436 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
437 svm_fifo_chunk_t *c, *first = 0, *next;
439 fl_index = fs_freelist_for_size (req_bytes);
443 fl_size = fs_freelist_index_to_size (fl_index);
447 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
450 c->next = fs_chunk_sptr (fsh, first);
453 req_bytes -= clib_min (fl_size, req_bytes);
457 /* Failed to allocate with smaller chunks */
460 /* Free all chunks if any allocated */
464 fl_index = fs_freelist_for_size (c->length);
465 next = fs_chunk_ptr (fsh, c->next);
466 fss_chunk_free_list_push (fsh, fss, fl_index, c);
471 /* As last attempt, try allocating a chunk larger than
472 * the requested size, if possible */
473 fl_index = fs_freelist_for_size (data_bytes) + 1;
474 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
476 first = fss_chunk_free_list_pop (fsh, fss, fl_index);
480 n_alloc = fs_freelist_index_to_size (fl_index);
486 fl_size = fl_size >> 1;
491 fss_fl_chunk_bytes_sub (fss, n_alloc);
492 fsh_cached_bytes_sub (fsh, n_alloc);
497 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
498 fifo_segment_slice_t * fss, u32 batch_size)
500 svm_fifo_shared_t *f;
505 ASSERT (batch_size != 0);
507 size = (uword) sizeof (*f) * batch_size;
509 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
513 /* Carve fifo hdr space */
514 for (i = 0; i < batch_size; i++)
516 f = (svm_fifo_shared_t *) fmem;
517 memset (f, 0, sizeof (*f));
518 f->next = fss->free_fifos;
527 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
528 fifo_segment_slice_t * fss,
529 u32 fl_index, u32 batch_size)
531 svm_fifo_chunk_t *c, *head = 0, *tail;
532 uword size, total_chunk_bytes;
533 u32 rounded_data_size;
537 ASSERT (batch_size != 0);
539 rounded_data_size = fs_freelist_index_to_size (fl_index);
540 total_chunk_bytes = (uword) batch_size *rounded_data_size;
541 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
543 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
547 /* Carve fifo + chunk space */
548 tail = c = (svm_fifo_chunk_t *) cmem;
549 for (i = 0; i < batch_size; i++)
552 c->length = rounded_data_size;
553 c->next = fs_chunk_sptr (fsh, head);
555 cmem += sizeof (*c) + rounded_data_size;
556 c = (svm_fifo_chunk_t *) cmem;
559 fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
560 fss->num_chunks[fl_index] += batch_size;
561 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
562 fsh_cached_bytes_add (fsh, total_chunk_bytes);
568 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
569 fifo_segment_slice_t * fss,
570 u32 fl_index, u32 batch_size)
572 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
574 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
577 static svm_fifo_shared_t *
578 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
580 svm_fifo_shared_t *f;
582 if (!fss->free_fifos)
584 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
585 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
590 fss->free_fifos = f->next;
591 memset (f, 0, sizeof (*f));
595 static svm_fifo_chunk_t *
596 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
597 fifo_segment_slice_t * fss, u32 data_bytes)
602 fl_index = fs_freelist_for_size (data_bytes);
605 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
609 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
610 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
614 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
617 chunk_size = fs_freelist_index_to_size (fl_index);
618 n_free = fsh_n_free_bytes (fsh);
620 if (chunk_size <= n_free)
622 batch = chunk_size * batch <= n_free ? batch : 1;
623 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
626 /* Failed to allocate larger chunk, try to allocate multi-chunk
627 * that is close to what was actually requested */
628 if (data_bytes <= fss_fl_chunk_bytes (fss))
630 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
633 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
634 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
637 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
639 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
641 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
642 batch = clib_min (batch + 1, n_free / min_size);
643 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
645 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
655 * Try to allocate new fifo
657 * Tries the following steps in order:
658 * - grab fifo and chunk from freelists
659 * - batch fifo and chunk allocation
660 * - single fifo allocation
661 * - grab multiple fifo chunks from freelists
663 static svm_fifo_shared_t *
664 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
666 fifo_segment_slice_t *fss;
667 u32 fl_index, min_size;
669 svm_fifo_shared_t *sf = 0;
671 fss = fsh_slice_get (fsh, slice_index);
672 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
673 fl_index = fs_freelist_for_size (min_size);
675 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
678 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
682 c = fsh_try_alloc_chunk (fsh, fss, min_size);
685 sf->next = fss->free_fifos;
686 fss->free_fifos = sf;
690 sf->start_chunk = fs_chunk_sptr (fsh, c);
692 c = fs_chunk_ptr (fsh, c->next);
693 sf->end_chunk = fs_chunk_sptr (fsh, c);
694 sf->size = data_bytes;
695 sf->slice_index = slice_index;
701 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
703 fifo_segment_slice_t *fss;
706 fss = fsh_slice_get (fsh, slice_index);
707 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
713 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
714 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
716 u32 n_collect = 0, fl_index;
717 svm_fifo_chunk_t *next;
721 CLIB_MEM_UNPOISON (c, sizeof (*c));
722 next = fs_chunk_ptr (fsh, c->next);
723 fl_index = fs_freelist_for_size (c->length);
724 fss_chunk_free_list_push (fsh, fss, fl_index, c);
725 n_collect += fs_freelist_index_to_size (fl_index);
729 fss_fl_chunk_bytes_add (fss, n_collect);
730 fsh_cached_bytes_add (fsh, n_collect);
734 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
735 svm_fifo_chunk_t * c)
737 fifo_segment_slice_t *fss;
738 fss = fsh_slice_get (fsh, slice_index);
739 fsh_slice_collect_chunks (fsh, fss, c);
743 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
745 fifo_slice_private_t *pfss = &fs->slices[slice_index];
748 f = clib_mem_bulk_alloc (pfss->fifos);
749 clib_memset (f, 0, sizeof (*f));
754 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f)
756 u32 slice_index = f->shr->slice_index;
757 fifo_slice_private_t *pfss;
759 pfss = &fs->slices[slice_index];
760 clib_mem_bulk_free (pfss->fifos, f);
764 fifo_segment_cleanup (fifo_segment_t *fs)
768 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
769 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
773 * Allocate fifo in fifo segment
776 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
777 u32 data_bytes, fifo_segment_ftype_t ftype)
779 fifo_segment_header_t *fsh = fs->h;
780 fifo_slice_private_t *pfss;
781 fifo_segment_slice_t *fss;
782 svm_fifo_shared_t *sf;
785 ASSERT (slice_index < fs->n_slices);
787 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
790 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
794 f = fs_fifo_alloc (fs, slice_index);
798 svm_fifo_init (f, data_bytes);
800 fss = fsh_slice_get (fsh, slice_index);
801 pfss = fs_slice_private_get (fs, slice_index);
803 /* If rx fifo type add to active fifos list. When cleaning up segment,
804 * we need a list of active sessions that should be disconnected. Since
805 * both rx and tx fifos keep pointers to the session, it's enough to track
807 if (ftype == FIFO_SEGMENT_RX_FIFO)
809 pfss_fifo_add_active_list (pfss, f);
810 f->flags |= SVM_FIFO_F_LL_TRACKED;
813 fsh_active_fifos_update (fsh, 1);
814 fss->virtual_mem += svm_fifo_size (f);
821 fifo_segment_alloc_fifo_w_shared (fifo_segment_t *fs, svm_fifo_shared_t *sf)
823 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
827 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
828 f->segment_index = SVM_FIFO_INVALID_INDEX;
834 * Free fifo allocated in fifo segment
837 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
839 fifo_segment_header_t *fsh = fs->h;
840 fifo_slice_private_t *pfss;
841 fifo_segment_slice_t *fss;
842 svm_fifo_shared_t *sf;
844 ASSERT (f->refcnt > 0);
850 * Cleanup shared state
854 fss = fsh_slice_get (fsh, sf->slice_index);
855 pfss = fs_slice_private_get (fs, sf->slice_index);
857 /* Free fifo chunks */
858 fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
860 sf->start_chunk = sf->end_chunk = 0;
861 sf->head_chunk = sf->tail_chunk = 0;
863 /* Add to free list */
864 sf->next = fss->free_fifos;
865 fss->free_fifos = sf;
867 fss->virtual_mem -= svm_fifo_size (f);
870 * Cleanup private state
873 /* Remove from active list. Only rx fifos are tracked */
874 if (f->flags & SVM_FIFO_F_LL_TRACKED)
876 pfss_fifo_del_active_list (pfss, f);
877 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
880 svm_fifo_free_chunk_lookup (f);
881 svm_fifo_free_ooo_data (f);
885 sf->master_session_index = ~0;
886 f->master_thread_index = ~0;
889 f->ooo_enq = f->ooo_deq = 0;
892 fs_fifo_free (fs, f);
894 fsh_active_fifos_update (fsh, -1);
898 fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f)
900 fifo_slice_private_t *pfss;
901 fifo_segment_slice_t *fss;
905 ASSERT (f->refcnt == 1);
907 fss = fsh_slice_get (fs->h, f->shr->slice_index);
908 pfss = fs_slice_private_get (fs, f->shr->slice_index);
909 fss->virtual_mem -= svm_fifo_size (f);
910 if (f->flags & SVM_FIFO_F_LL_TRACKED)
911 pfss_fifo_del_active_list (pfss, f);
913 c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
916 fl_index = fs_freelist_for_size (c->length);
917 clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
918 c = fs_chunk_ptr (fs->h, c->next);
923 fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
926 fifo_slice_private_t *pfss;
927 fifo_segment_slice_t *fss;
931 f->shr->slice_index = slice_index;
932 fss = fsh_slice_get (fs->h, f->shr->slice_index);
933 pfss = fs_slice_private_get (fs, f->shr->slice_index);
934 fss->virtual_mem += svm_fifo_size (f);
935 if (f->flags & SVM_FIFO_F_LL_TRACKED)
936 pfss_fifo_add_active_list (pfss, f);
938 c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
941 fl_index = fs_freelist_for_size (c->length);
942 clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
943 c = fs_chunk_ptr (fs->h, c->next);
948 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
951 fifo_segment_header_t *fsh = fs->h;
952 fifo_segment_slice_t *fss;
954 fss = fsh_slice_get (fsh, slice_index);
955 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
959 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
960 u32 chunk_size, u32 batch_size)
962 fifo_segment_header_t *fsh = fs->h;
963 fifo_segment_slice_t *fss;
966 if (!fs_chunk_size_is_valid (fsh, chunk_size))
968 clib_warning ("chunk size out of range %d", chunk_size);
972 fl_index = fs_freelist_for_size (chunk_size);
973 fss = fsh_slice_get (fsh, slice_index);
975 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
979 * Pre-allocates fifo pairs in fifo segment
982 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
983 u32 rx_fifo_size, u32 tx_fifo_size,
986 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
987 u32 hdrs, pairs_per_slice, alloc_now;
988 fifo_segment_header_t *fsh = fs->h;
989 int rx_fl_index, tx_fl_index, i;
990 fifo_segment_slice_t *fss;
991 uword space_available;
993 /* Parameter check */
994 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
997 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
999 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1003 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1005 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1009 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1010 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1011 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1012 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1014 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1016 /* Calculate space requirements */
1017 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1018 space_available = fsh_n_free_bytes (fsh);
1019 pairs_to_alloc = space_available / pair_size;
1020 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1021 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1022 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1024 if (!pairs_per_slice)
1027 for (i = 0; i < fs->n_slices; i++)
1029 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1033 fss = fsh_slice_get (fsh, i);
1034 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1035 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1036 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1037 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1039 /* Account for the pairs allocated */
1040 *n_fifo_pairs -= alloc_now;
1045 * Get number of active fifos
1048 fifo_segment_num_fifos (fifo_segment_t * fs)
1050 return fsh_n_active_fifos (fs->h);
1054 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1056 svm_fifo_shared_t *f;
1059 f = fss->free_fifos;
1072 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1074 fifo_segment_header_t *fsh = fs->h;
1075 fifo_segment_slice_t *fss;
1079 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1081 fss = fsh_slice_get (fsh, slice_index);
1082 count += fs_slice_num_free_fifos (fss);
1088 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1089 fifo_segment_slice_t *fss, u32 size)
1091 u32 count = 0, rounded_size, fl_index;
1092 svm_fifo_chunk_t *c;
1095 /* Count all free chunks? */
1098 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1100 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1106 c = fs_chunk_ptr (fsh, c->next);
1113 rounded_size = (1 << (max_log2 (size)));
1114 fl_index = fs_freelist_for_size (rounded_size);
1116 if (fl_index >= FS_CHUNK_VEC_LEN)
1119 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
1125 c = fs_chunk_ptr (fsh, c->next);
1132 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1134 fifo_segment_header_t *fsh = fs->h;
1135 fifo_segment_slice_t *fss;
1139 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1141 fss = fsh_slice_get (fsh, slice_index);
1142 count += fs_slice_num_free_chunks (fsh, fss, size);
1148 fifo_segment_size (fifo_segment_t * fs)
1150 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1154 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1156 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1160 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1162 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1166 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1168 void *rv = fsh_alloc (fs->h, size);
1169 /* Mark externally allocated bytes as reserved. This helps
1170 * @ref fifo_segment_size report bytes used only for fifos */
1171 fs->h->n_reserved_bytes += size;
1176 fifo_segment_free_bytes (fifo_segment_t * fs)
1178 return fsh_n_free_bytes (fs->h);
1182 fifo_segment_cached_bytes (fifo_segment_t * fs)
1184 return fsh_n_cached_bytes (fs->h);
1188 fifo_segment_available_bytes (fifo_segment_t * fs)
1190 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1194 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1196 fifo_segment_header_t *fsh = fs->h;
1197 fifo_segment_slice_t *fss;
1201 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1203 fss = fsh_slice_get (fsh, slice_index);
1204 n_bytes += fss_fl_chunk_bytes (fss);
1211 fifo_segment_has_fifos (fifo_segment_t * fs)
1213 return (fsh_n_active_fifos (fs->h) != 0);
1217 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1219 fifo_slice_private_t *pfss;
1221 pfss = fs_slice_private_get (fs, slice_index);
1222 return pfss->active_fifos;
1226 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1230 size = fifo_segment_size (fs);
1232 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1233 return (in_use * 100) / size;
1236 fifo_segment_mem_status_t
1237 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1239 if (!fsh->high_watermark || !fsh->low_watermark)
1240 return MEMORY_PRESSURE_NO_PRESSURE;
1242 /* once the no-memory is detected, the status continues
1243 * until memory usage gets below the high watermark
1245 if (fsh_has_reached_mem_limit (fsh))
1247 if (usage >= fsh->high_watermark)
1248 return MEMORY_PRESSURE_NO_MEMORY;
1250 fsh_reset_mem_limit (fsh);
1253 if (usage >= fsh->high_watermark)
1254 return MEMORY_PRESSURE_HIGH_PRESSURE;
1256 else if (usage >= fsh->low_watermark)
1257 return MEMORY_PRESSURE_LOW_PRESSURE;
1259 return MEMORY_PRESSURE_NO_PRESSURE;
1262 fifo_segment_mem_status_t
1263 fifo_segment_get_mem_status (fifo_segment_t * fs)
1265 fifo_segment_header_t *fsh = fs->h;
1266 u8 usage = fifo_segment_get_mem_usage (fs);
1268 return fifo_segment_determine_status (fsh, usage);
1272 format_fifo_segment_type (u8 * s, va_list * args)
1275 sp = va_arg (*args, fifo_segment_t *);
1276 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1278 if (st == SSVM_SEGMENT_PRIVATE)
1279 s = format (s, "%s", "private");
1280 else if (st == SSVM_SEGMENT_MEMFD)
1281 s = format (s, "%s", "memfd");
1282 else if (st == SSVM_SEGMENT_SHM)
1283 s = format (s, "%s", "shm");
1285 s = format (s, "%s", "unknown");
1290 * Segment format function
1293 format_fifo_segment (u8 * s, va_list * args)
1295 u32 count, indent, active_fifos, free_fifos;
1296 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1297 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1298 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1299 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1300 uword tracked_cached_bytes;
1301 uword fifo_hdr = 0, reserved;
1302 fifo_segment_header_t *fsh;
1303 fifo_segment_slice_t *fss;
1304 svm_fifo_chunk_t *c;
1309 uword allocated, in_use, virt;
1311 fifo_segment_mem_status_t mem_st;
1313 indent = format_get_indent (s) + 2;
1317 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1318 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1322 fifo_segment_info (fs, &address, &size);
1323 active_fifos = fifo_segment_num_fifos (fs);
1324 free_fifos = fifo_segment_num_free_fifos (fs);
1326 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1327 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1328 free_fifos, address);
1335 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1338 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1341 s = format (s, "\n");
1343 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1345 fss = fsh_slice_get (fsh, slice_index);
1346 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1348 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1349 if (c == 0 && fss->num_chunks[i] == 0)
1354 c = fs_chunk_ptr (fsh, c->next);
1358 chunk_size = fs_freelist_index_to_size (i);
1359 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1360 chunk_size >> 10, count, fss->num_chunks[i]);
1362 chunk_bytes += count * chunk_size;
1366 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1367 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1368 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1369 free_seg_bytes = fifo_segment_free_bytes (fs);
1370 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1371 allocated = fifo_segment_size (fs);
1372 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1373 usage = (100.0 * in_use) / allocated;
1374 mem_st = fifo_segment_get_mem_status (fs);
1375 virt = fsh_virtual_mem (fsh);
1376 reserved = fsh->n_reserved_bytes;
1378 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1379 " %U (%lu)\n", format_white_space, indent + 2,
1380 format_memory_size, free_seg_bytes, free_seg_bytes,
1381 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1382 format_memory_size, reserved, reserved);
1383 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1384 " %U (%lu)\n", format_white_space, indent + 2,
1385 format_memory_size, chunk_bytes, chunk_bytes,
1386 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1387 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1388 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1389 format_white_space, indent + 2, fsh->n_active_fifos,
1390 format_memory_size, fifo_hdr, fifo_hdr);
1391 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1392 format_white_space, indent + 2, usage, format_memory_size,
1393 in_use, format_memory_size, allocated, format_memory_size, virt,
1394 fifo_segment_mem_status_strings[mem_st]);
1395 s = format (s, "\n");
1401 * fd.io coding-style-patch-verification: ON
1404 * eval: (c-set-style "gnu")