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 fss_fifo_free_list_push (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
205 svm_fifo_shared_t *sf)
207 sf->next = fss->free_fifos;
208 fss->free_fifos = fs_sptr (fsh, sf);
212 fss_fifo_free_list_push_list (fifo_segment_header_t *fsh,
213 fifo_segment_slice_t *fss,
214 svm_fifo_shared_t *head, svm_fifo_shared_t *tail)
216 tail->next = fss->free_fifos;
217 fss->free_fifos = fs_sptr (fsh, head);
221 fss_fifo_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
223 svm_fifo_shared_t *sf;
224 sf = fs_ptr (fsh, fss->free_fifos);
225 fss->free_fifos = sf->next;
230 pfss_fifo_add_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
232 if (pfss->active_fifos)
234 pfss->active_fifos->prev = f;
235 f->next = pfss->active_fifos;
237 pfss->active_fifos = f;
241 pfss_fifo_del_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
243 if (f->flags & SVM_FIFO_F_LL_TRACKED)
246 f->prev->next = f->next;
248 pfss->active_fifos = f->next;
250 f->next->prev = f->prev;
255 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
257 return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
261 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
263 clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
267 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
269 clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
273 * Initialize fifo segment shared header
276 fifo_segment_init (fifo_segment_t * fs)
278 u32 align = 8, offset = 2 * 4096, slices_sz, i;
279 uword max_fifo, seg_start, seg_sz;
280 fifo_segment_header_t *fsh;
281 ssvm_shared_header_t *sh;
284 /* TODO remove ssvm heap entirely */
287 seg_data = (u8 *) sh + offset;
288 seg_sz = sh->ssvm_size - offset;
290 fs->n_slices = clib_max (fs->n_slices, 1);
291 slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
293 seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
294 fsh = uword_to_pointer (seg_start, void *);
295 memset (fsh, 0, sizeof (*fsh) + slices_sz);
297 fsh->byte_index = sizeof (*fsh) + slices_sz;
298 fsh->max_byte_index = seg_sz;
299 fsh->n_slices = fs->n_slices;
300 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
301 fsh->max_log2_fifo_size = min_log2 (max_fifo);
302 fsh->n_cached_bytes = 0;
303 fsh->n_reserved_bytes = fsh->byte_index;
304 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
306 fs->max_byte_index = fsh->max_byte_index;
308 sh->opaque[0] = (void *) ((u8 *) fsh - (u8 *) fs->ssvm.sh);
310 /* Allow random offsets */
311 fs->ssvm.sh->ssvm_va = 0;
313 vec_validate (fs->slices, fs->n_slices - 1);
314 for (i = 0; i < fs->n_slices; i++)
315 fs->slices[i].fifos =
316 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
323 * Create a fifo segment and initialize as master
326 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
332 /* Allocate a fresh segment */
333 pool_get_zero (sm->segments, fs);
335 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
336 fs->ssvm.ssvm_size = a->segment_size;
337 fs->ssvm.is_server = 1;
338 fs->ssvm.my_pid = getpid ();
339 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
340 fs->ssvm.requested_va = baseva;
342 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
344 pool_put (sm->segments, fs);
348 /* Note: requested_va updated due to seg base addr randomization */
349 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
351 fifo_segment_init (fs);
352 vec_add1 (a->new_segment_indices, fs - sm->segments);
357 * Attach as slave to a fifo segment
360 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
362 fifo_segment_header_t *fsh;
366 pool_get_zero (sm->segments, fs);
368 fs->ssvm.ssvm_size = a->segment_size;
369 fs->ssvm.my_pid = getpid ();
370 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
371 fs->ssvm.requested_va = 0;
372 if (a->segment_type == SSVM_SEGMENT_MEMFD)
373 fs->ssvm.fd = a->memfd_fd;
375 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
377 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
379 pool_put (sm->segments, fs);
383 /* Probably a segment without fifos */
384 if (!fs->ssvm.sh->opaque[0])
387 fsh = fs->h = (void *) fs->ssvm.sh + (uword) fs->ssvm.sh->opaque[0];
388 fs->max_byte_index = fsh->max_byte_index;
389 vec_validate (fs->slices, 0);
390 fs->slices[0].fifos =
391 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
394 vec_add1 (a->new_segment_indices, fs - sm->segments);
399 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
401 fifo_segment_cleanup (s);
402 ssvm_delete (&s->ssvm);
403 clib_memset (s, 0xfe, sizeof (*s));
404 pool_put (sm->segments, s);
408 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
410 return s - sm->segments;
414 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
416 return pool_elt_at_index (sm->segments, segment_index);
420 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
422 *address = (char *) seg->ssvm.sh->ssvm_va;
423 *size = seg->ssvm.ssvm_size;
427 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
428 u32 timeout_in_seconds)
430 sm->next_baseva = baseva;
431 sm->timeout_in_seconds = timeout_in_seconds;
435 fs_freelist_for_size (u32 size)
437 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
439 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
440 FS_CHUNK_VEC_LEN - 1);
444 fs_freelist_index_to_size (u32 fl_index)
446 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
450 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
453 * 4K minimum. It's not likely that anything good will happen
454 * with a smaller FIFO.
456 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
457 size <= (1ULL << fsh->max_log2_fifo_size);
461 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
462 fifo_segment_slice_t * fss, u32 data_bytes)
464 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
465 svm_fifo_chunk_t *c, *first = 0, *next;
467 fl_index = fs_freelist_for_size (req_bytes);
471 fl_size = fs_freelist_index_to_size (fl_index);
475 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
478 c->next = fs_chunk_sptr (fsh, first);
481 req_bytes -= clib_min (fl_size, req_bytes);
485 /* Failed to allocate with smaller chunks */
488 /* Free all chunks if any allocated */
492 fl_index = fs_freelist_for_size (c->length);
493 next = fs_chunk_ptr (fsh, c->next);
494 fss_chunk_free_list_push (fsh, fss, fl_index, c);
499 /* As last attempt, try allocating a chunk larger than
500 * the requested size, if possible */
501 fl_index = fs_freelist_for_size (data_bytes) + 1;
502 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
504 first = fss_chunk_free_list_pop (fsh, fss, fl_index);
508 n_alloc = fs_freelist_index_to_size (fl_index);
514 fl_size = fl_size >> 1;
519 fss_fl_chunk_bytes_sub (fss, n_alloc);
520 fsh_cached_bytes_sub (fsh, n_alloc);
525 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
526 fifo_segment_slice_t * fss, u32 batch_size)
528 svm_fifo_shared_t *f, *head = 0, *tail;
533 ASSERT (batch_size != 0);
535 size = (uword) sizeof (*f) * batch_size;
537 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
541 /* Carve fifo hdr space */
542 tail = f = (svm_fifo_shared_t *) fmem;
543 for (i = 0; i < batch_size; i++)
545 clib_memset (f, 0, sizeof (*f));
546 f->next = fs_sptr (fsh, head);
549 f = (svm_fifo_shared_t *) fmem;
552 fss_fifo_free_list_push_list (fsh, fss, head, tail);
558 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
559 fifo_segment_slice_t * fss,
560 u32 fl_index, u32 batch_size)
562 svm_fifo_chunk_t *c, *head = 0, *tail;
563 uword size, total_chunk_bytes;
564 u32 rounded_data_size;
568 ASSERT (batch_size != 0);
570 rounded_data_size = fs_freelist_index_to_size (fl_index);
571 total_chunk_bytes = (uword) batch_size *rounded_data_size;
572 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
574 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
578 /* Carve fifo + chunk space */
579 tail = c = (svm_fifo_chunk_t *) cmem;
580 for (i = 0; i < batch_size; i++)
583 c->length = rounded_data_size;
584 c->next = fs_chunk_sptr (fsh, head);
586 cmem += sizeof (*c) + rounded_data_size;
587 c = (svm_fifo_chunk_t *) cmem;
590 fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
591 fss->num_chunks[fl_index] += batch_size;
592 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
593 fsh_cached_bytes_add (fsh, total_chunk_bytes);
599 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
600 fifo_segment_slice_t * fss,
601 u32 fl_index, u32 batch_size)
603 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
605 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
608 static svm_fifo_shared_t *
609 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
611 svm_fifo_shared_t *sf;
613 if (!fss->free_fifos)
615 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
616 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
620 sf = fss_fifo_free_list_pop (fsh, fss);
621 clib_memset (sf, 0, sizeof (*sf));
626 static svm_fifo_chunk_t *
627 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
628 fifo_segment_slice_t * fss, u32 data_bytes)
633 fl_index = fs_freelist_for_size (data_bytes);
636 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
640 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
641 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
645 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
648 chunk_size = fs_freelist_index_to_size (fl_index);
649 n_free = fsh_n_free_bytes (fsh);
651 if (chunk_size <= n_free)
653 batch = chunk_size * batch <= n_free ? batch : 1;
654 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
657 /* Failed to allocate larger chunk, try to allocate multi-chunk
658 * that is close to what was actually requested */
659 if (data_bytes <= fss_fl_chunk_bytes (fss))
661 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
664 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
665 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
668 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
670 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
672 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
673 batch = clib_min (batch + 1, n_free / min_size);
674 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
676 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
686 * Try to allocate new fifo
688 * Tries the following steps in order:
689 * - grab fifo and chunk from freelists
690 * - batch fifo and chunk allocation
691 * - single fifo allocation
692 * - grab multiple fifo chunks from freelists
694 static svm_fifo_shared_t *
695 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
697 fifo_segment_slice_t *fss;
698 u32 fl_index, min_size;
700 svm_fifo_shared_t *sf = 0;
702 fss = fsh_slice_get (fsh, slice_index);
703 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
704 fl_index = fs_freelist_for_size (min_size);
706 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
709 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
713 c = fsh_try_alloc_chunk (fsh, fss, min_size);
716 fss_fifo_free_list_push (fsh, fss, sf);
720 sf->start_chunk = fs_chunk_sptr (fsh, c);
722 c = fs_chunk_ptr (fsh, c->next);
723 sf->end_chunk = fs_chunk_sptr (fsh, c);
724 sf->size = data_bytes;
725 sf->slice_index = slice_index;
731 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
733 fifo_segment_slice_t *fss;
736 fss = fsh_slice_get (fsh, slice_index);
737 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
743 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
744 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
746 u32 n_collect = 0, fl_index;
747 svm_fifo_chunk_t *next;
751 CLIB_MEM_UNPOISON (c, sizeof (*c));
752 next = fs_chunk_ptr (fsh, c->next);
753 fl_index = fs_freelist_for_size (c->length);
754 fss_chunk_free_list_push (fsh, fss, fl_index, c);
755 n_collect += fs_freelist_index_to_size (fl_index);
759 fss_fl_chunk_bytes_add (fss, n_collect);
760 fsh_cached_bytes_add (fsh, n_collect);
764 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
765 svm_fifo_chunk_t * c)
767 fifo_segment_slice_t *fss;
768 fss = fsh_slice_get (fsh, slice_index);
769 fsh_slice_collect_chunks (fsh, fss, c);
773 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
775 fifo_slice_private_t *pfss = &fs->slices[slice_index];
778 f = clib_mem_bulk_alloc (pfss->fifos);
779 clib_memset (f, 0, sizeof (*f));
784 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f)
786 u32 slice_index = f->shr->slice_index;
787 fifo_slice_private_t *pfss;
789 pfss = &fs->slices[slice_index];
790 clib_mem_bulk_free (pfss->fifos, f);
794 fifo_segment_cleanup (fifo_segment_t *fs)
799 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
800 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
802 vec_foreach (fs->mqs, mq)
803 vec_free (mq->rings);
809 * Allocate fifo in fifo segment
812 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
813 u32 data_bytes, fifo_segment_ftype_t ftype)
815 fifo_segment_header_t *fsh = fs->h;
816 fifo_slice_private_t *pfss;
817 fifo_segment_slice_t *fss;
818 svm_fifo_shared_t *sf;
821 ASSERT (slice_index < fs->n_slices);
823 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
826 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
830 f = fs_fifo_alloc (fs, slice_index);
834 svm_fifo_init (f, data_bytes);
836 fss = fsh_slice_get (fsh, slice_index);
837 pfss = fs_slice_private_get (fs, slice_index);
839 /* If rx fifo type add to active fifos list. When cleaning up segment,
840 * we need a list of active sessions that should be disconnected. Since
841 * both rx and tx fifos keep pointers to the session, it's enough to track
843 if (ftype == FIFO_SEGMENT_RX_FIFO)
845 pfss_fifo_add_active_list (pfss, f);
846 f->flags |= SVM_FIFO_F_LL_TRACKED;
849 fsh_active_fifos_update (fsh, 1);
850 fss->virtual_mem += svm_fifo_size (f);
857 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
859 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
860 svm_fifo_shared_t *sf;
862 sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
866 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
867 f->segment_index = SVM_FIFO_INVALID_INDEX;
873 * Free fifo allocated in fifo segment
876 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
878 fifo_segment_header_t *fsh = fs->h;
879 fifo_slice_private_t *pfss;
880 fifo_segment_slice_t *fss;
881 svm_fifo_shared_t *sf;
883 ASSERT (f->refcnt > 0);
889 * Cleanup shared state
893 fss = fsh_slice_get (fsh, sf->slice_index);
894 pfss = fs_slice_private_get (fs, sf->slice_index);
896 /* Free fifo chunks */
897 fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
899 sf->start_chunk = sf->end_chunk = 0;
900 sf->head_chunk = sf->tail_chunk = 0;
902 /* Add to free list */
903 fss_fifo_free_list_push (fsh, fss, sf);
905 fss->virtual_mem -= svm_fifo_size (f);
908 * Cleanup private state
911 /* Remove from active list. Only rx fifos are tracked */
912 if (f->flags & SVM_FIFO_F_LL_TRACKED)
914 pfss_fifo_del_active_list (pfss, f);
915 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
918 svm_fifo_free_chunk_lookup (f);
919 svm_fifo_free_ooo_data (f);
923 sf->master_session_index = ~0;
924 f->master_thread_index = ~0;
927 f->ooo_enq = f->ooo_deq = 0;
930 fs_fifo_free (fs, f);
932 fsh_active_fifos_update (fsh, -1);
936 fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f)
938 fifo_slice_private_t *pfss;
939 fifo_segment_slice_t *fss;
940 u32 fl_index, slice_index;
941 svm_fifo_chunk_t **c;
944 slice_index = of->master_thread_index;
945 fss = fsh_slice_get (fs->h, slice_index);
946 pfss = fs_slice_private_get (fs, slice_index);
947 fss->virtual_mem -= svm_fifo_size (of);
948 if (of->flags & SVM_FIFO_F_LL_TRACKED)
949 pfss_fifo_del_active_list (pfss, of);
951 /* Update slice counts for chunks that were detached */
952 vec_foreach (c, of->chunks_at_attach)
954 fl_index = fs_freelist_for_size ((*c)->length);
955 clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
957 vec_free (of->chunks_at_attach);
959 clib_mem_bulk_free (pfss->fifos, *f);
964 fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
966 fifo_slice_private_t *pfss;
967 fifo_segment_slice_t *fss;
972 nf = fs_fifo_alloc (fs, slice_index);
973 clib_memcpy_fast (nf, *f, sizeof (*nf));
975 fss = fsh_slice_get (fs->h, slice_index);
976 pfss = fs_slice_private_get (fs, slice_index);
977 fss->virtual_mem += svm_fifo_size (nf);
978 if (nf->flags & SVM_FIFO_F_LL_TRACKED)
979 pfss_fifo_add_active_list (pfss, nf);
981 /* Update allocated chunks for fifo segment and build list
982 * of chunks to be freed at detach */
984 of->chunks_at_attach = 0;
986 c = fs_chunk_ptr (fs->h, nf->shr->start_chunk);
989 fl_index = fs_freelist_for_size (c->length);
990 clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
991 vec_add1 (of->chunks_at_attach, c);
992 c = fs_chunk_ptr (fs->h, c->next);
995 nf->shr->slice_index = slice_index;
1000 fifo_segment_fifo_offset (svm_fifo_t *f)
1002 return (u8 *) f->shr - (u8 *) f->fs_hdr;
1006 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
1007 svm_msg_q_cfg_t *cfg)
1009 fifo_segment_header_t *fsh = fs->h;
1010 svm_msg_q_shared_t *smq;
1017 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1018 vec_validate (fs->mqs, n_mqs - 1);
1021 size = svm_msg_q_size_to_alloc (cfg);
1022 base = fsh_alloc_aligned (fsh, size, 8);
1023 fsh->n_reserved_bytes += size;
1025 smq = svm_msg_q_init (base, cfg);
1026 mq = vec_elt_at_index (fs->mqs, mq_index);
1027 svm_msg_q_attach (mq, smq);
1033 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
1039 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1040 vec_validate (fs->mqs, n_mqs - 1);
1043 mq = vec_elt_at_index (fs->mqs, mq_index);
1047 svm_msg_q_shared_t *smq;
1048 smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1049 svm_msg_q_attach (mq, smq);
1052 ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1058 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1060 svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1065 return (uword) ((u8 *) mq->q.shr - (u8 *) fs->h) -
1066 sizeof (svm_msg_q_shared_t);
1070 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1073 fifo_segment_header_t *fsh = fs->h;
1074 fifo_segment_slice_t *fss;
1076 fss = fsh_slice_get (fsh, slice_index);
1077 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1081 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1082 u32 chunk_size, u32 batch_size)
1084 fifo_segment_header_t *fsh = fs->h;
1085 fifo_segment_slice_t *fss;
1088 if (!fs_chunk_size_is_valid (fsh, chunk_size))
1090 clib_warning ("chunk size out of range %d", chunk_size);
1094 fl_index = fs_freelist_for_size (chunk_size);
1095 fss = fsh_slice_get (fsh, slice_index);
1097 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1101 * Pre-allocates fifo pairs in fifo segment
1104 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1105 u32 rx_fifo_size, u32 tx_fifo_size,
1108 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1109 u32 hdrs, pairs_per_slice, alloc_now;
1110 fifo_segment_header_t *fsh = fs->h;
1111 int rx_fl_index, tx_fl_index, i;
1112 fifo_segment_slice_t *fss;
1113 uword space_available;
1115 /* Parameter check */
1116 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1119 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1121 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1125 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1127 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1131 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1132 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1133 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1134 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1136 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1138 /* Calculate space requirements */
1139 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1140 space_available = fsh_n_free_bytes (fsh);
1141 pairs_to_alloc = space_available / pair_size;
1142 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1143 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1144 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1146 if (!pairs_per_slice)
1149 for (i = 0; i < fs->n_slices; i++)
1151 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1155 fss = fsh_slice_get (fsh, i);
1156 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1157 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1158 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1159 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1161 /* Account for the pairs allocated */
1162 *n_fifo_pairs -= alloc_now;
1167 * Get number of active fifos
1170 fifo_segment_num_fifos (fifo_segment_t * fs)
1172 return fsh_n_active_fifos (fs->h);
1176 fs_slice_num_free_fifos (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
1178 svm_fifo_shared_t *f;
1181 f = fs_ptr (fsh, fss->free_fifos);
1187 f = fs_ptr (fsh, f->next);
1194 fifo_segment_num_free_fifos (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 count += fs_slice_num_free_fifos (fsh, fss);
1210 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1211 fifo_segment_slice_t *fss, u32 size)
1213 u32 count = 0, rounded_size, fl_index;
1214 svm_fifo_chunk_t *c;
1217 /* Count all free chunks? */
1220 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1222 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1228 c = fs_chunk_ptr (fsh, c->next);
1235 rounded_size = (1 << (max_log2 (size)));
1236 fl_index = fs_freelist_for_size (rounded_size);
1238 if (fl_index >= FS_CHUNK_VEC_LEN)
1241 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
1247 c = fs_chunk_ptr (fsh, c->next);
1254 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1256 fifo_segment_header_t *fsh = fs->h;
1257 fifo_segment_slice_t *fss;
1261 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1263 fss = fsh_slice_get (fsh, slice_index);
1264 count += fs_slice_num_free_chunks (fsh, fss, size);
1270 fifo_segment_size (fifo_segment_t * fs)
1272 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1276 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1278 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1282 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1284 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1288 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1290 void *rv = fsh_alloc (fs->h, size);
1291 /* Mark externally allocated bytes as reserved. This helps
1292 * @ref fifo_segment_size report bytes used only for fifos */
1293 fs->h->n_reserved_bytes += size;
1298 fifo_segment_free_bytes (fifo_segment_t * fs)
1300 return fsh_n_free_bytes (fs->h);
1304 fifo_segment_cached_bytes (fifo_segment_t * fs)
1306 return fsh_n_cached_bytes (fs->h);
1310 fifo_segment_available_bytes (fifo_segment_t * fs)
1312 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1316 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1318 fifo_segment_header_t *fsh = fs->h;
1319 fifo_segment_slice_t *fss;
1323 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1325 fss = fsh_slice_get (fsh, slice_index);
1326 n_bytes += fss_fl_chunk_bytes (fss);
1333 fifo_segment_has_fifos (fifo_segment_t * fs)
1335 return (fsh_n_active_fifos (fs->h) != 0);
1339 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1341 fifo_slice_private_t *pfss;
1343 pfss = fs_slice_private_get (fs, slice_index);
1344 return pfss->active_fifos;
1348 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1352 size = fifo_segment_size (fs);
1354 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1355 return (in_use * 100) / size;
1358 fifo_segment_mem_status_t
1359 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1361 if (!fsh->high_watermark || !fsh->low_watermark)
1362 return MEMORY_PRESSURE_NO_PRESSURE;
1364 /* once the no-memory is detected, the status continues
1365 * until memory usage gets below the high watermark
1367 if (fsh_has_reached_mem_limit (fsh))
1369 if (usage >= fsh->high_watermark)
1370 return MEMORY_PRESSURE_NO_MEMORY;
1372 fsh_reset_mem_limit (fsh);
1375 if (usage >= fsh->high_watermark)
1376 return MEMORY_PRESSURE_HIGH_PRESSURE;
1378 else if (usage >= fsh->low_watermark)
1379 return MEMORY_PRESSURE_LOW_PRESSURE;
1381 return MEMORY_PRESSURE_NO_PRESSURE;
1384 fifo_segment_mem_status_t
1385 fifo_segment_get_mem_status (fifo_segment_t * fs)
1387 fifo_segment_header_t *fsh = fs->h;
1388 u8 usage = fifo_segment_get_mem_usage (fs);
1390 return fifo_segment_determine_status (fsh, usage);
1394 format_fifo_segment_type (u8 * s, va_list * args)
1397 sp = va_arg (*args, fifo_segment_t *);
1398 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1400 if (st == SSVM_SEGMENT_PRIVATE)
1401 s = format (s, "%s", "private");
1402 else if (st == SSVM_SEGMENT_MEMFD)
1403 s = format (s, "%s", "memfd");
1404 else if (st == SSVM_SEGMENT_SHM)
1405 s = format (s, "%s", "shm");
1407 s = format (s, "%s", "unknown");
1412 * Segment format function
1415 format_fifo_segment (u8 * s, va_list * args)
1417 u32 count, indent, active_fifos, free_fifos;
1418 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1419 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1420 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1421 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1422 uword tracked_cached_bytes;
1423 uword fifo_hdr = 0, reserved;
1424 fifo_segment_header_t *fsh;
1425 fifo_segment_slice_t *fss;
1426 svm_fifo_chunk_t *c;
1431 uword allocated, in_use, virt;
1433 fifo_segment_mem_status_t mem_st;
1435 indent = format_get_indent (s) + 2;
1439 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1440 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1444 fifo_segment_info (fs, &address, &size);
1445 active_fifos = fifo_segment_num_fifos (fs);
1446 free_fifos = fifo_segment_num_free_fifos (fs);
1448 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1449 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1450 free_fifos, address);
1457 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1460 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1463 s = format (s, "\n");
1465 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1467 fss = fsh_slice_get (fsh, slice_index);
1468 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1470 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1471 if (c == 0 && fss->num_chunks[i] == 0)
1476 c = fs_chunk_ptr (fsh, c->next);
1480 chunk_size = fs_freelist_index_to_size (i);
1481 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1482 chunk_size >> 10, count, fss->num_chunks[i]);
1484 chunk_bytes += count * chunk_size;
1488 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1489 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1490 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1491 free_seg_bytes = fifo_segment_free_bytes (fs);
1492 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1493 allocated = fifo_segment_size (fs);
1494 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1495 usage = (100.0 * in_use) / allocated;
1496 mem_st = fifo_segment_get_mem_status (fs);
1497 virt = fsh_virtual_mem (fsh);
1498 reserved = fsh->n_reserved_bytes;
1500 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1501 " %U (%lu)\n", format_white_space, indent + 2,
1502 format_memory_size, free_seg_bytes, free_seg_bytes,
1503 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1504 format_memory_size, reserved, reserved);
1505 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1506 " %U (%lu)\n", format_white_space, indent + 2,
1507 format_memory_size, chunk_bytes, chunk_bytes,
1508 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1509 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1510 s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1511 format_white_space, indent + 2, fsh->n_active_fifos,
1512 format_memory_size, fifo_hdr, fifo_hdr);
1513 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1514 format_white_space, indent + 2, usage, format_memory_size,
1515 in_use, format_memory_size, allocated, format_memory_size, virt,
1516 fifo_segment_mem_status_strings[mem_st]);
1517 s = format (s, "\n");
1523 * fd.io coding-style-patch-verification: ON
1526 * eval: (c-set-style "gnu")