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 CLIB_MEM_UNPOISON (fsh, seg_sz);
296 memset (fsh, 0, sizeof (*fsh) + slices_sz);
298 fsh->byte_index = sizeof (*fsh) + slices_sz;
299 fsh->max_byte_index = seg_sz;
300 fsh->n_slices = fs->n_slices;
301 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
302 fsh->max_log2_fifo_size = min_log2 (max_fifo);
303 fsh->n_cached_bytes = 0;
304 fsh->n_reserved_bytes = fsh->byte_index;
305 fsh->start_byte_index = fsh->byte_index;
306 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
308 fs->max_byte_index = fsh->max_byte_index;
310 sh->opaque[0] = (void *) ((u8 *) fsh - (u8 *) fs->ssvm.sh);
312 /* Allow random offsets */
313 fs->ssvm.sh->ssvm_va = 0;
315 vec_validate (fs->slices, fs->n_slices - 1);
316 for (i = 0; i < fs->n_slices; i++)
317 fs->slices[i].fifos =
318 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
325 * Create a fifo segment and initialize as master
328 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
334 /* Allocate a fresh segment */
335 pool_get_zero (sm->segments, fs);
337 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
338 fs->ssvm.ssvm_size = a->segment_size;
339 fs->ssvm.is_server = 1;
340 fs->ssvm.my_pid = getpid ();
341 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
342 fs->ssvm.requested_va = baseva;
344 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
346 pool_put (sm->segments, fs);
350 /* Note: requested_va updated due to seg base addr randomization */
351 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
353 fifo_segment_init (fs);
354 vec_add1 (a->new_segment_indices, fs - sm->segments);
359 * Attach as slave to a fifo segment
362 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
364 fifo_segment_header_t *fsh;
368 pool_get_zero (sm->segments, fs);
370 fs->ssvm.ssvm_size = a->segment_size;
371 fs->ssvm.my_pid = getpid ();
372 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
373 fs->ssvm.requested_va = 0;
374 if (a->segment_type == SSVM_SEGMENT_MEMFD)
375 fs->ssvm.fd = a->memfd_fd;
377 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
379 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
381 pool_put (sm->segments, fs);
385 /* Probably a segment without fifos */
386 if (!fs->ssvm.sh->opaque[0])
389 fsh = fs->h = (void *) fs->ssvm.sh + (uword) fs->ssvm.sh->opaque[0];
390 fs->max_byte_index = fsh->max_byte_index;
391 vec_validate (fs->slices, 0);
392 fs->slices[0].fifos =
393 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
396 vec_add1 (a->new_segment_indices, fs - sm->segments);
401 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
403 fifo_segment_cleanup (s);
404 ssvm_delete (&s->ssvm);
405 clib_memset (s, 0xfe, sizeof (*s));
406 pool_put (sm->segments, s);
410 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
412 return s - sm->segments;
416 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
418 return pool_elt_at_index (sm->segments, segment_index);
422 fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm, u32 segment_index)
424 if (pool_is_free_index (sm->segments, segment_index))
426 return pool_elt_at_index (sm->segments, segment_index);
430 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
432 *address = (char *) seg->ssvm.sh->ssvm_va;
433 *size = seg->ssvm.ssvm_size;
437 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
438 u32 timeout_in_seconds)
440 sm->next_baseva = baseva;
441 sm->timeout_in_seconds = timeout_in_seconds;
445 fs_freelist_for_size (u32 size)
447 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
449 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
450 FS_CHUNK_VEC_LEN - 1);
454 fs_freelist_index_to_size (u32 fl_index)
456 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
460 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
463 * 4K minimum. It's not likely that anything good will happen
464 * with a smaller FIFO.
466 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
467 size <= (1ULL << fsh->max_log2_fifo_size);
471 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
472 fifo_segment_slice_t * fss, u32 data_bytes)
474 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
475 svm_fifo_chunk_t *c, *first = 0, *next;
477 fl_index = fs_freelist_for_size (req_bytes);
481 fl_size = fs_freelist_index_to_size (fl_index);
485 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
488 c->next = fs_chunk_sptr (fsh, first);
491 req_bytes -= clib_min (fl_size, req_bytes);
495 /* Failed to allocate with smaller chunks */
498 /* Free all chunks if any allocated */
502 fl_index = fs_freelist_for_size (c->length);
503 next = fs_chunk_ptr (fsh, c->next);
504 fss_chunk_free_list_push (fsh, fss, fl_index, c);
509 /* As last attempt, try allocating a chunk larger than
510 * the requested size, if possible */
511 fl_index = fs_freelist_for_size (data_bytes) + 1;
512 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
514 first = fss_chunk_free_list_pop (fsh, fss, fl_index);
518 n_alloc = fs_freelist_index_to_size (fl_index);
524 fl_size = fl_size >> 1;
529 fss_fl_chunk_bytes_sub (fss, n_alloc);
530 fsh_cached_bytes_sub (fsh, n_alloc);
535 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
536 fifo_segment_slice_t * fss, u32 batch_size)
538 svm_fifo_shared_t *f, *head = 0, *tail;
543 ASSERT (batch_size != 0);
545 size = (uword) sizeof (*f) * batch_size;
547 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
551 /* Carve fifo hdr space */
552 tail = f = (svm_fifo_shared_t *) fmem;
553 for (i = 0; i < batch_size; i++)
555 clib_memset (f, 0, sizeof (*f));
556 f->next = fs_sptr (fsh, head);
559 f = (svm_fifo_shared_t *) fmem;
562 fss_fifo_free_list_push_list (fsh, fss, head, tail);
568 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
569 fifo_segment_slice_t * fss,
570 u32 fl_index, u32 batch_size)
572 svm_fifo_chunk_t *c, *head = 0, *tail;
573 uword size, total_chunk_bytes;
574 u32 rounded_data_size;
578 ASSERT (batch_size != 0);
580 rounded_data_size = fs_freelist_index_to_size (fl_index);
581 total_chunk_bytes = (uword) batch_size *rounded_data_size;
582 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
584 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
588 /* Carve fifo + chunk space */
589 tail = c = (svm_fifo_chunk_t *) cmem;
590 for (i = 0; i < batch_size; i++)
593 c->length = rounded_data_size;
594 c->next = fs_chunk_sptr (fsh, head);
596 cmem += sizeof (*c) + rounded_data_size;
597 c = (svm_fifo_chunk_t *) cmem;
600 fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
601 fss->num_chunks[fl_index] += batch_size;
602 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
603 fsh_cached_bytes_add (fsh, total_chunk_bytes);
609 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
610 fifo_segment_slice_t * fss,
611 u32 fl_index, u32 batch_size)
613 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
615 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
618 static svm_fifo_shared_t *
619 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
621 svm_fifo_shared_t *sf;
623 if (!fss->free_fifos)
625 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
626 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
630 sf = fss_fifo_free_list_pop (fsh, fss);
631 clib_memset (sf, 0, sizeof (*sf));
636 static svm_fifo_chunk_t *
637 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
638 fifo_segment_slice_t * fss, u32 data_bytes)
643 fl_index = fs_freelist_for_size (data_bytes);
646 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
650 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
651 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
655 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
658 chunk_size = fs_freelist_index_to_size (fl_index);
659 n_free = fsh_n_free_bytes (fsh);
661 if (chunk_size <= n_free)
663 batch = chunk_size * batch <= n_free ? batch : 1;
664 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
667 /* Failed to allocate larger chunk, try to allocate multi-chunk
668 * that is close to what was actually requested */
669 if (data_bytes <= fss_fl_chunk_bytes (fss))
671 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
674 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
675 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
678 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
680 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
682 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
683 batch = clib_min (batch + 1, n_free / min_size);
684 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
686 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
696 * Try to allocate new fifo
698 * Tries the following steps in order:
699 * - grab fifo and chunk from freelists
700 * - batch fifo and chunk allocation
701 * - single fifo allocation
702 * - grab multiple fifo chunks from freelists
704 static svm_fifo_shared_t *
705 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
707 fifo_segment_slice_t *fss;
708 u32 fl_index, min_size;
710 svm_fifo_shared_t *sf = 0;
712 fss = fsh_slice_get (fsh, slice_index);
713 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
714 fl_index = fs_freelist_for_size (min_size);
716 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
719 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
723 c = fsh_try_alloc_chunk (fsh, fss, min_size);
726 fss_fifo_free_list_push (fsh, fss, sf);
730 sf->start_chunk = fs_chunk_sptr (fsh, c);
732 c = fs_chunk_ptr (fsh, c->next);
733 sf->end_chunk = fs_chunk_sptr (fsh, c);
734 sf->size = data_bytes;
735 sf->slice_index = slice_index;
741 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
743 fifo_segment_slice_t *fss;
746 fss = fsh_slice_get (fsh, slice_index);
747 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
753 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
754 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
756 u32 n_collect = 0, fl_index;
757 svm_fifo_chunk_t *next;
761 CLIB_MEM_UNPOISON (c, sizeof (*c));
762 next = fs_chunk_ptr (fsh, c->next);
763 fl_index = fs_freelist_for_size (c->length);
764 fss_chunk_free_list_push (fsh, fss, fl_index, c);
765 n_collect += fs_freelist_index_to_size (fl_index);
769 fss_fl_chunk_bytes_add (fss, n_collect);
770 fsh_cached_bytes_add (fsh, n_collect);
774 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
775 svm_fifo_chunk_t * c)
777 fifo_segment_slice_t *fss;
778 fss = fsh_slice_get (fsh, slice_index);
779 fsh_slice_collect_chunks (fsh, fss, c);
783 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
785 fifo_slice_private_t *pfss = &fs->slices[slice_index];
788 f = clib_mem_bulk_alloc (pfss->fifos);
789 clib_memset (f, 0, sizeof (*f));
794 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f, u32 slice_index)
796 fifo_slice_private_t *pfss;
799 clib_memset (f, 0xfc, sizeof (*f));
801 pfss = &fs->slices[slice_index];
802 clib_mem_bulk_free (pfss->fifos, f);
806 fifo_segment_cleanup (fifo_segment_t *fs)
811 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
812 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
814 vec_foreach (fs->mqs, mq)
815 vec_free (mq->rings);
821 * Allocate fifo in fifo segment
824 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
825 u32 data_bytes, fifo_segment_ftype_t ftype)
827 fifo_segment_header_t *fsh = fs->h;
828 fifo_slice_private_t *pfss;
829 fifo_segment_slice_t *fss;
830 svm_fifo_shared_t *sf;
833 ASSERT (slice_index < fs->n_slices);
835 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
838 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
842 f = fs_fifo_alloc (fs, slice_index);
846 svm_fifo_init (f, data_bytes);
848 fss = fsh_slice_get (fsh, slice_index);
849 pfss = fs_slice_private_get (fs, slice_index);
851 /* If rx fifo type add to active fifos list. When cleaning up segment,
852 * we need a list of active sessions that should be disconnected. Since
853 * both rx and tx fifos keep pointers to the session, it's enough to track
855 if (ftype == FIFO_SEGMENT_RX_FIFO)
857 pfss_fifo_add_active_list (pfss, f);
858 f->flags |= SVM_FIFO_F_LL_TRACKED;
861 fsh_active_fifos_update (fsh, 1);
862 fss->virtual_mem += svm_fifo_size (f);
869 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
871 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
872 svm_fifo_shared_t *sf;
874 sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
878 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
879 f->segment_index = SVM_FIFO_INVALID_INDEX;
885 * Free fifo allocated in fifo segment
888 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
890 fifo_segment_header_t *fsh = fs->h;
891 fifo_slice_private_t *pfss;
892 fifo_segment_slice_t *fss;
893 svm_fifo_shared_t *sf;
895 ASSERT (f->refcnt > 0);
901 * Cleanup shared state
905 fss = fsh_slice_get (fsh, sf->slice_index);
906 pfss = fs_slice_private_get (fs, sf->slice_index);
908 /* Free fifo chunks */
909 fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
911 sf->start_chunk = sf->end_chunk = 0;
912 sf->head_chunk = sf->tail_chunk = 0;
914 /* Add to free list */
915 fss_fifo_free_list_push (fsh, fss, sf);
917 fss->virtual_mem -= svm_fifo_size (f);
920 * Cleanup private state
923 /* Remove from active list. Only rx fifos are tracked */
924 if (f->flags & SVM_FIFO_F_LL_TRACKED)
926 pfss_fifo_del_active_list (pfss, f);
927 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
930 svm_fifo_free_chunk_lookup (f);
931 svm_fifo_free_ooo_data (f);
935 sf->master_session_index = ~0;
936 f->master_thread_index = ~0;
939 f->ooo_enq = f->ooo_deq = 0;
942 fs_fifo_free (fs, f, f->shr->slice_index);
944 fsh_active_fifos_update (fsh, -1);
948 fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f)
950 fs_fifo_free (fs, f, 0 /* clients attach fifos in slice 0 */);
954 fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f)
956 fifo_slice_private_t *pfss;
957 fifo_segment_slice_t *fss;
961 slice_index = of->master_thread_index;
962 fss = fsh_slice_get (fs->h, slice_index);
963 pfss = fs_slice_private_get (fs, slice_index);
964 fss->virtual_mem -= svm_fifo_size (of);
965 if (of->flags & SVM_FIFO_F_LL_TRACKED)
966 pfss_fifo_del_active_list (pfss, of);
968 /* Collect chunks that were provided in return for those detached */
969 fsh_slice_collect_chunks (fs->h, fss, of->chunks_at_attach);
970 of->chunks_at_attach = 0;
972 /* Collect hdr that was provided in return for the detached */
973 fss_fifo_free_list_push (fs->h, fss, of->hdr_at_attach);
974 of->hdr_at_attach = 0;
976 clib_mem_bulk_free (pfss->fifos, *f);
981 fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
983 svm_fifo_chunk_t *c, *nc, *pc = 0;
984 fifo_slice_private_t *pfss;
985 fifo_segment_slice_t *fss;
988 nf = fs_fifo_alloc (fs, slice_index);
989 clib_memcpy_fast (nf, *f, sizeof (*nf));
991 fss = fsh_slice_get (fs->h, slice_index);
992 pfss = fs_slice_private_get (fs, slice_index);
993 fss->virtual_mem += svm_fifo_size (nf);
994 nf->next = nf->prev = 0;
995 if (nf->flags & SVM_FIFO_F_LL_TRACKED)
996 pfss_fifo_add_active_list (pfss, nf);
998 /* Allocate shared hdr and chunks to be collected at detach in return
999 * for those that are being attached now */
1001 of->hdr_at_attach = fsh_try_alloc_fifo_hdr (fs->h, fss);
1003 c = fs_chunk_ptr (fs->h, nf->shr->start_chunk);
1004 of->chunks_at_attach = pc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1006 while ((c = fs_chunk_ptr (fs->h, c->next)))
1008 nc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1009 pc->next = fs_chunk_sptr (fs->h, nc);
1013 nf->shr->slice_index = slice_index;
1018 fifo_segment_fifo_offset (svm_fifo_t *f)
1020 return (u8 *) f->shr - (u8 *) f->fs_hdr;
1024 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
1025 svm_msg_q_cfg_t *cfg)
1027 fifo_segment_header_t *fsh = fs->h;
1028 svm_msg_q_shared_t *smq;
1035 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1036 vec_validate (fs->mqs, n_mqs - 1);
1039 size = svm_msg_q_size_to_alloc (cfg);
1040 base = fsh_alloc_aligned (fsh, size, 8);
1041 fsh->n_reserved_bytes += size;
1043 smq = svm_msg_q_init (base, cfg);
1044 mq = vec_elt_at_index (fs->mqs, mq_index);
1045 svm_msg_q_attach (mq, smq);
1051 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
1057 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1058 vec_validate (fs->mqs, n_mqs - 1);
1061 mq = vec_elt_at_index (fs->mqs, mq_index);
1065 svm_msg_q_shared_t *smq;
1066 smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1067 svm_msg_q_attach (mq, smq);
1070 ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1076 fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds)
1078 svm_msg_q_shared_t *smq;
1080 uword offset = 0, n_alloced;
1083 n_mqs = fs->h->n_mqs;
1084 if (n_fds && n_mqs != n_fds)
1086 clib_warning ("expected %u fds got %u", n_mqs, n_fds);
1090 vec_validate (fs->mqs, n_mqs - 1);
1091 n_alloced = fs->h->n_reserved_bytes - fs->h->start_byte_index;
1092 ASSERT (n_alloced % n_mqs == 0);
1093 size = n_alloced / n_mqs;
1095 offset = fs->h->start_byte_index;
1096 for (i = 0; i < n_mqs; i++)
1098 mq = vec_elt_at_index (fs->mqs, i);
1099 smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1100 svm_msg_q_attach (mq, smq);
1102 svm_msg_q_set_eventfd (mq, fds[i]);
1108 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1110 svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1115 return (uword) ((u8 *) mq->q.shr - (u8 *) fs->h) -
1116 sizeof (svm_msg_q_shared_t);
1120 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1123 fifo_segment_header_t *fsh = fs->h;
1124 fifo_segment_slice_t *fss;
1126 fss = fsh_slice_get (fsh, slice_index);
1127 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1131 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1132 u32 chunk_size, u32 batch_size)
1134 fifo_segment_header_t *fsh = fs->h;
1135 fifo_segment_slice_t *fss;
1138 if (!fs_chunk_size_is_valid (fsh, chunk_size))
1140 clib_warning ("chunk size out of range %d", chunk_size);
1144 fl_index = fs_freelist_for_size (chunk_size);
1145 fss = fsh_slice_get (fsh, slice_index);
1147 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1151 * Pre-allocates fifo pairs in fifo segment
1154 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1155 u32 rx_fifo_size, u32 tx_fifo_size,
1158 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1159 u32 hdrs, pairs_per_slice, alloc_now;
1160 fifo_segment_header_t *fsh = fs->h;
1161 int rx_fl_index, tx_fl_index, i;
1162 fifo_segment_slice_t *fss;
1163 uword space_available;
1165 /* Parameter check */
1166 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1169 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1171 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1175 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1177 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1181 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1182 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1183 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1184 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1186 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1188 /* Calculate space requirements */
1189 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1190 space_available = fsh_n_free_bytes (fsh);
1191 pairs_to_alloc = space_available / pair_size;
1192 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1193 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1194 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1196 if (!pairs_per_slice)
1199 for (i = 0; i < fs->n_slices; i++)
1201 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1205 fss = fsh_slice_get (fsh, i);
1206 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1207 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1208 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1209 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1211 /* Account for the pairs allocated */
1212 *n_fifo_pairs -= alloc_now;
1217 * Get number of active fifos
1220 fifo_segment_num_fifos (fifo_segment_t * fs)
1222 return fsh_n_active_fifos (fs->h);
1226 fs_slice_num_free_fifos (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
1228 svm_fifo_shared_t *f;
1231 f = fs_ptr (fsh, fss->free_fifos);
1237 f = fs_ptr (fsh, f->next);
1244 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1246 fifo_segment_header_t *fsh = fs->h;
1247 fifo_segment_slice_t *fss;
1251 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1253 fss = fsh_slice_get (fsh, slice_index);
1254 count += fs_slice_num_free_fifos (fsh, fss);
1260 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1261 fifo_segment_slice_t *fss, u32 size)
1263 u32 count = 0, rounded_size, fl_index;
1264 svm_fifo_chunk_t *c;
1267 /* Count all free chunks? */
1270 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1272 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1278 c = fs_chunk_ptr (fsh, c->next);
1285 rounded_size = (1 << (max_log2 (size)));
1286 fl_index = fs_freelist_for_size (rounded_size);
1288 if (fl_index >= FS_CHUNK_VEC_LEN)
1291 c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
1297 c = fs_chunk_ptr (fsh, c->next);
1304 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1306 fifo_segment_header_t *fsh = fs->h;
1307 fifo_segment_slice_t *fss;
1311 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1313 fss = fsh_slice_get (fsh, slice_index);
1314 count += fs_slice_num_free_chunks (fsh, fss, size);
1320 fifo_segment_size (fifo_segment_t * fs)
1322 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1326 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1328 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1332 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1334 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1338 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1340 void *rv = fsh_alloc (fs->h, size);
1341 /* Mark externally allocated bytes as reserved. This helps
1342 * @ref fifo_segment_size report bytes used only for fifos */
1343 fs->h->n_reserved_bytes += size;
1348 fifo_segment_free_bytes (fifo_segment_t * fs)
1350 return fsh_n_free_bytes (fs->h);
1354 fifo_segment_cached_bytes (fifo_segment_t * fs)
1356 return fsh_n_cached_bytes (fs->h);
1360 fifo_segment_available_bytes (fifo_segment_t * fs)
1362 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1366 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1368 fifo_segment_header_t *fsh = fs->h;
1369 fifo_segment_slice_t *fss;
1373 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1375 fss = fsh_slice_get (fsh, slice_index);
1376 n_bytes += fss_fl_chunk_bytes (fss);
1383 fifo_segment_has_fifos (fifo_segment_t * fs)
1385 return (fsh_n_active_fifos (fs->h) != 0);
1389 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1391 fifo_slice_private_t *pfss;
1393 pfss = fs_slice_private_get (fs, slice_index);
1394 return pfss->active_fifos;
1398 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1402 size = fifo_segment_size (fs);
1404 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1405 return (in_use * 100) / size;
1408 fifo_segment_mem_status_t
1409 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1411 if (!fsh->high_watermark || !fsh->low_watermark)
1412 return MEMORY_PRESSURE_NO_PRESSURE;
1414 /* once the no-memory is detected, the status continues
1415 * until memory usage gets below the high watermark
1417 if (fsh_has_reached_mem_limit (fsh))
1419 if (usage >= fsh->high_watermark)
1420 return MEMORY_PRESSURE_NO_MEMORY;
1422 fsh_reset_mem_limit (fsh);
1425 if (usage >= fsh->high_watermark)
1426 return MEMORY_PRESSURE_HIGH_PRESSURE;
1428 else if (usage >= fsh->low_watermark)
1429 return MEMORY_PRESSURE_LOW_PRESSURE;
1431 return MEMORY_PRESSURE_NO_PRESSURE;
1434 fifo_segment_mem_status_t
1435 fifo_segment_get_mem_status (fifo_segment_t * fs)
1437 fifo_segment_header_t *fsh = fs->h;
1438 u8 usage = fifo_segment_get_mem_usage (fs);
1440 return fifo_segment_determine_status (fsh, usage);
1444 format_fifo_segment_type (u8 * s, va_list * args)
1447 sp = va_arg (*args, fifo_segment_t *);
1448 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1450 if (st == SSVM_SEGMENT_PRIVATE)
1451 s = format (s, "%s", "private");
1452 else if (st == SSVM_SEGMENT_MEMFD)
1453 s = format (s, "%s", "memfd");
1454 else if (st == SSVM_SEGMENT_SHM)
1455 s = format (s, "%s", "shm");
1457 s = format (s, "%s", "unknown");
1462 * Segment format function
1465 format_fifo_segment (u8 * s, va_list * args)
1467 u32 count, indent, active_fifos, free_fifos;
1468 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1469 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1470 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1471 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1472 uword tracked_cached_bytes;
1473 uword fifo_hdr = 0, reserved;
1474 fifo_segment_header_t *fsh;
1475 fifo_segment_slice_t *fss;
1476 svm_fifo_chunk_t *c;
1481 uword allocated, in_use, virt;
1483 fifo_segment_mem_status_t mem_st;
1485 indent = format_get_indent (s) + 2;
1489 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1490 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1494 fifo_segment_info (fs, &address, &size);
1495 active_fifos = fifo_segment_num_fifos (fs);
1496 free_fifos = fifo_segment_num_free_fifos (fs);
1498 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1499 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1500 free_fifos, address);
1507 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1510 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1513 s = format (s, "\n");
1515 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1517 fss = fsh_slice_get (fsh, slice_index);
1518 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1520 c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1521 if (c == 0 && fss->num_chunks[i] == 0)
1526 c = fs_chunk_ptr (fsh, c->next);
1530 chunk_size = fs_freelist_index_to_size (i);
1531 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1532 chunk_size >> 10, count, fss->num_chunks[i]);
1534 chunk_bytes += count * chunk_size;
1538 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1539 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1540 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1541 free_seg_bytes = fifo_segment_free_bytes (fs);
1542 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1543 allocated = fifo_segment_size (fs);
1544 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1545 usage = (100.0 * in_use) / allocated;
1546 mem_st = fifo_segment_get_mem_status (fs);
1547 virt = fsh_virtual_mem (fsh);
1548 reserved = fsh->n_reserved_bytes;
1550 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1551 " %U (%lu)\n", format_white_space, indent + 2,
1552 format_memory_size, free_seg_bytes, free_seg_bytes,
1553 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1554 format_memory_size, reserved, reserved);
1555 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1556 " %U (%lu)\n", format_white_space, indent + 2,
1557 format_memory_size, chunk_bytes, chunk_bytes,
1558 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1559 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1560 s = format (s, "%Ufifo active: %u hdr free: %u bytes: %U (%u) \n",
1561 format_white_space, indent + 2, fsh->n_active_fifos, free_fifos,
1562 format_memory_size, fifo_hdr, fifo_hdr);
1563 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1564 format_white_space, indent + 2, usage, format_memory_size,
1565 in_use, format_memory_size, allocated, format_memory_size, virt,
1566 fifo_segment_mem_status_strings[mem_st]);
1567 s = format (s, "\n");
1573 * fd.io coding-style-patch-verification: ON
1576 * eval: (c-set-style "gnu")