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_fl_index_is_valid (fifo_segment_slice_t *fss, u32 fl_index)
133 return (fl_index < FS_CHUNK_VEC_LEN);
136 #define FS_CL_HEAD_MASK 0xFFFFFFFFFFFF
137 #define FS_CL_HEAD_TMASK 0xFFFF000000000000
138 #define FS_CL_HEAD_TINC (1ULL << 48)
140 static svm_fifo_chunk_t *
141 fss_chunk_free_list_head (fifo_segment_header_t *fsh,
142 fifo_segment_slice_t *fss, u32 fl_index)
144 fs_sptr_t headsp = clib_atomic_load_relax_n (&fss->free_chunks[fl_index]);
145 return fs_chunk_ptr (fsh, headsp & FS_CL_HEAD_MASK);
149 fss_chunk_free_list_push (fifo_segment_header_t *fsh,
150 fifo_segment_slice_t *fss, u32 fl_index,
153 fs_sptr_t old_head, new_head, csp;
155 csp = fs_chunk_sptr (fsh, c);
156 ASSERT (csp <= FS_CL_HEAD_MASK);
157 old_head = clib_atomic_load_relax_n (&fss->free_chunks[fl_index]);
161 c->next = old_head & FS_CL_HEAD_MASK;
162 new_head = csp + ((old_head + FS_CL_HEAD_TINC) & FS_CL_HEAD_TMASK);
164 while (!clib_atomic_cmp_and_swap_acq_relax (
165 &fss->free_chunks[fl_index], &old_head, &new_head, 1 /* weak */));
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 fs_sptr_t old_head, new_head, headsp;
175 headsp = fs_chunk_sptr (fsh, head);
176 ASSERT (headsp <= FS_CL_HEAD_MASK);
177 old_head = clib_atomic_load_relax_n (&fss->free_chunks[fl_index]);
181 tail->next = old_head & FS_CL_HEAD_MASK;
182 new_head = headsp + ((old_head + FS_CL_HEAD_TINC) & FS_CL_HEAD_TMASK);
184 while (!clib_atomic_cmp_and_swap_acq_relax (
185 &fss->free_chunks[fl_index], &old_head, &new_head, 1 /* weak */));
188 static svm_fifo_chunk_t *
189 fss_chunk_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
192 fs_sptr_t old_head, new_head;
195 ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
197 old_head = clib_atomic_load_relax_n (&fss->free_chunks[fl_index]);
199 /* Lock-free stacks are affected by ABA if a side allocates a chunk and
200 * shortly thereafter frees it. To circumvent that, reuse the upper bits
201 * of the head of the list shared pointer, i.e., offset to where the chunk
202 * is, as a tag. The tag is incremented with each push/pop operation and
203 * therefore collisions can only happen if an element is popped and pushed
204 * exactly after a complete wrap of the tag (16 bits). It's unlikely either
205 * of the sides will be descheduled for that long */
208 if (!(old_head & FS_CL_HEAD_MASK))
210 c = fs_chunk_ptr (fsh, old_head & FS_CL_HEAD_MASK);
211 new_head = c->next + ((old_head + FS_CL_HEAD_TINC) & FS_CL_HEAD_TMASK);
213 while (!clib_atomic_cmp_and_swap_acq_relax (
214 &fss->free_chunks[fl_index], &old_head, &new_head, 1 /* weak */));
220 fss_fifo_free_list_push (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
221 svm_fifo_shared_t *sf)
223 sf->next = fss->free_fifos;
224 fss->free_fifos = fs_sptr (fsh, sf);
228 fss_fifo_free_list_push_list (fifo_segment_header_t *fsh,
229 fifo_segment_slice_t *fss,
230 svm_fifo_shared_t *head, svm_fifo_shared_t *tail)
232 tail->next = fss->free_fifos;
233 fss->free_fifos = fs_sptr (fsh, head);
237 fss_fifo_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
239 svm_fifo_shared_t *sf;
240 sf = fs_ptr (fsh, fss->free_fifos);
241 fss->free_fifos = sf->next;
246 pfss_fifo_add_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
248 if (pfss->active_fifos)
250 pfss->active_fifos->prev = f;
251 f->next = pfss->active_fifos;
253 pfss->active_fifos = f;
257 pfss_fifo_del_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
259 if (f->flags & SVM_FIFO_F_LL_TRACKED)
262 f->prev->next = f->next;
264 pfss->active_fifos = f->next;
266 f->next->prev = f->prev;
271 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
273 return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
277 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
279 clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
283 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
285 clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
289 * Initialize fifo segment shared header
292 fifo_segment_init (fifo_segment_t * fs)
294 u32 align = 8, offset = 2 * 4096, slices_sz, i;
295 uword max_fifo, seg_start, seg_sz;
296 fifo_segment_header_t *fsh;
297 ssvm_shared_header_t *sh;
300 /* TODO remove ssvm heap entirely */
303 seg_data = (u8 *) sh + offset;
304 seg_sz = sh->ssvm_size - offset;
306 fs->n_slices = clib_max (fs->n_slices, 1);
307 slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
309 seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
310 fsh = uword_to_pointer (seg_start, void *);
311 CLIB_MEM_UNPOISON (fsh, seg_sz);
312 memset (fsh, 0, sizeof (*fsh) + slices_sz);
314 fsh->byte_index = sizeof (*fsh) + slices_sz;
315 fsh->max_byte_index = seg_sz;
316 fsh->n_slices = fs->n_slices;
317 max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
318 fsh->max_log2_fifo_size = min_log2 (max_fifo);
319 fsh->n_cached_bytes = 0;
320 fsh->n_reserved_bytes = fsh->byte_index;
321 fsh->start_byte_index = fsh->byte_index;
322 ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
324 fs->max_byte_index = fsh->max_byte_index;
326 sh->opaque[0] = (void *) ((u8 *) fsh - (u8 *) fs->ssvm.sh);
328 /* Allow random offsets */
329 fs->ssvm.sh->ssvm_va = 0;
331 vec_validate (fs->slices, fs->n_slices - 1);
332 for (i = 0; i < fs->n_slices; i++)
333 fs->slices[i].fifos =
334 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
341 * Create a fifo segment and initialize as master
344 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
350 /* Allocate a fresh segment */
351 pool_get_zero (sm->segments, fs);
353 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
354 fs->ssvm.ssvm_size = a->segment_size;
355 fs->ssvm.is_server = 1;
356 fs->ssvm.my_pid = getpid ();
357 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
358 fs->ssvm.requested_va = baseva;
360 if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
362 pool_put (sm->segments, fs);
366 /* Note: requested_va updated due to seg base addr randomization */
367 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
369 fifo_segment_init (fs);
370 vec_add1 (a->new_segment_indices, fs - sm->segments);
375 * Attach as slave to a fifo segment
378 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
380 fifo_segment_header_t *fsh;
384 pool_get_zero (sm->segments, fs);
386 fs->ssvm.ssvm_size = a->segment_size;
387 fs->ssvm.my_pid = getpid ();
388 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
389 fs->ssvm.requested_va = 0;
390 if (a->segment_type == SSVM_SEGMENT_MEMFD)
391 fs->ssvm.fd = a->memfd_fd;
393 fs->ssvm.attach_timeout = sm->timeout_in_seconds;
395 if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
397 pool_put (sm->segments, fs);
401 /* Probably a segment without fifos */
402 if (!fs->ssvm.sh->opaque[0])
405 fsh = fs->h = (void *) fs->ssvm.sh + (uword) fs->ssvm.sh->opaque[0];
406 fs->max_byte_index = fsh->max_byte_index;
407 vec_validate (fs->slices, 0);
408 fs->slices[0].fifos =
409 clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
412 vec_add1 (a->new_segment_indices, fs - sm->segments);
417 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
419 fifo_segment_cleanup (s);
420 ssvm_delete (&s->ssvm);
421 clib_memset (s, 0xfe, sizeof (*s));
422 pool_put (sm->segments, s);
426 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
428 return s - sm->segments;
432 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
434 return pool_elt_at_index (sm->segments, segment_index);
438 fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm, u32 segment_index)
440 if (pool_is_free_index (sm->segments, segment_index))
442 return pool_elt_at_index (sm->segments, segment_index);
446 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
448 *address = (char *) seg->ssvm.sh->ssvm_va;
449 *size = seg->ssvm.ssvm_size;
453 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
454 u32 timeout_in_seconds)
456 sm->next_baseva = baseva;
457 sm->timeout_in_seconds = timeout_in_seconds;
461 fs_freelist_for_size (u32 size)
463 if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
465 return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
466 FS_CHUNK_VEC_LEN - 1);
470 fs_freelist_index_to_size (u32 fl_index)
472 return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
476 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
479 * 4K minimum. It's not likely that anything good will happen
480 * with a smaller FIFO.
482 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
483 size <= (1ULL << fsh->max_log2_fifo_size);
487 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
488 fifo_segment_slice_t * fss, u32 data_bytes)
490 u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
491 svm_fifo_chunk_t *c, *first = 0, *next;
493 fl_index = fs_freelist_for_size (req_bytes);
497 fl_size = fs_freelist_index_to_size (fl_index);
501 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
504 c->next = fs_chunk_sptr (fsh, first);
507 req_bytes -= clib_min (fl_size, req_bytes);
511 /* Failed to allocate with smaller chunks */
514 /* Free all chunks if any allocated */
518 fl_index = fs_freelist_for_size (c->length);
519 next = fs_chunk_ptr (fsh, c->next);
520 fss_chunk_free_list_push (fsh, fss, fl_index, c);
525 /* As last attempt, try allocating a chunk larger than
526 * the requested size, if possible */
527 fl_index = fs_freelist_for_size (data_bytes) + 1;
528 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
530 first = fss_chunk_free_list_pop (fsh, fss, fl_index);
534 n_alloc = fs_freelist_index_to_size (fl_index);
540 fl_size = fl_size >> 1;
545 fss_fl_chunk_bytes_sub (fss, n_alloc);
546 fsh_cached_bytes_sub (fsh, n_alloc);
551 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
552 fifo_segment_slice_t * fss, u32 batch_size)
554 svm_fifo_shared_t *f, *head = 0, *tail;
559 ASSERT (batch_size != 0);
561 size = (uword) sizeof (*f) * batch_size;
563 fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
567 /* Carve fifo hdr space */
568 tail = f = (svm_fifo_shared_t *) fmem;
569 for (i = 0; i < batch_size; i++)
571 clib_memset (f, 0, sizeof (*f));
572 f->next = fs_sptr (fsh, head);
575 f = (svm_fifo_shared_t *) fmem;
578 fss_fifo_free_list_push_list (fsh, fss, head, tail);
584 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
585 fifo_segment_slice_t * fss,
586 u32 fl_index, u32 batch_size)
588 svm_fifo_chunk_t *c, *head = 0, *tail;
589 uword size, total_chunk_bytes;
590 u32 rounded_data_size;
594 ASSERT (batch_size != 0);
596 rounded_data_size = fs_freelist_index_to_size (fl_index);
597 total_chunk_bytes = (uword) batch_size *rounded_data_size;
598 size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
600 cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
604 /* Carve fifo + chunk space */
605 tail = c = (svm_fifo_chunk_t *) cmem;
606 for (i = 0; i < batch_size; i++)
609 c->length = rounded_data_size;
610 c->next = fs_chunk_sptr (fsh, head);
612 cmem += sizeof (*c) + rounded_data_size;
613 c = (svm_fifo_chunk_t *) cmem;
616 fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
617 fss->num_chunks[fl_index] += batch_size;
618 fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
619 fsh_cached_bytes_add (fsh, total_chunk_bytes);
625 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
626 fifo_segment_slice_t * fss,
627 u32 fl_index, u32 batch_size)
629 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
631 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
634 static svm_fifo_shared_t *
635 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
637 svm_fifo_shared_t *sf;
639 if (!fss->free_fifos)
641 if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
642 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
646 sf = fss_fifo_free_list_pop (fsh, fss);
647 clib_memset (sf, 0, sizeof (*sf));
652 static svm_fifo_chunk_t *
653 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
654 fifo_segment_slice_t * fss, u32 data_bytes)
659 fl_index = fs_freelist_for_size (data_bytes);
662 c = fss_chunk_free_list_pop (fsh, fss, fl_index);
666 fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
667 fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
671 u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
674 chunk_size = fs_freelist_index_to_size (fl_index);
675 n_free = fsh_n_free_bytes (fsh);
677 if (chunk_size <= n_free)
679 batch = chunk_size * batch <= n_free ? batch : 1;
680 if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
683 /* Failed to allocate larger chunk, try to allocate multi-chunk
684 * that is close to what was actually requested */
685 if (data_bytes <= fss_fl_chunk_bytes (fss))
687 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
690 batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
691 if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
694 if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
696 u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
698 batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
699 batch = clib_min (batch + 1, n_free / min_size);
700 if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
702 c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
712 * Try to allocate new fifo
714 * Tries the following steps in order:
715 * - grab fifo and chunk from freelists
716 * - batch fifo and chunk allocation
717 * - single fifo allocation
718 * - grab multiple fifo chunks from freelists
720 static svm_fifo_shared_t *
721 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
723 fifo_segment_slice_t *fss;
724 u32 fl_index, min_size;
726 svm_fifo_shared_t *sf = 0;
728 fss = fsh_slice_get (fsh, slice_index);
729 min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
730 fl_index = fs_freelist_for_size (min_size);
732 if (!fss_chunk_fl_index_is_valid (fss, fl_index))
735 sf = fsh_try_alloc_fifo_hdr (fsh, fss);
739 c = fsh_try_alloc_chunk (fsh, fss, min_size);
742 fss_fifo_free_list_push (fsh, fss, sf);
746 sf->start_chunk = fs_chunk_sptr (fsh, c);
748 c = fs_chunk_ptr (fsh, c->next);
749 sf->end_chunk = fs_chunk_sptr (fsh, c);
750 sf->size = data_bytes;
751 sf->slice_index = slice_index;
757 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
759 fifo_segment_slice_t *fss;
762 fss = fsh_slice_get (fsh, slice_index);
763 c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
769 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
770 fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
772 u32 n_collect = 0, fl_index;
773 svm_fifo_chunk_t *next;
777 CLIB_MEM_UNPOISON (c, sizeof (*c));
778 next = fs_chunk_ptr (fsh, c->next);
779 fl_index = fs_freelist_for_size (c->length);
780 fss_chunk_free_list_push (fsh, fss, fl_index, c);
781 n_collect += fs_freelist_index_to_size (fl_index);
785 fss_fl_chunk_bytes_add (fss, n_collect);
786 fsh_cached_bytes_add (fsh, n_collect);
790 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
791 svm_fifo_chunk_t * c)
793 fifo_segment_slice_t *fss;
794 fss = fsh_slice_get (fsh, slice_index);
795 fsh_slice_collect_chunks (fsh, fss, c);
799 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
801 fifo_slice_private_t *pfss = &fs->slices[slice_index];
804 f = clib_mem_bulk_alloc (pfss->fifos);
805 clib_memset (f, 0, sizeof (*f));
810 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f, u32 slice_index)
812 fifo_slice_private_t *pfss;
815 clib_memset (f, 0xfc, sizeof (*f));
817 pfss = &fs->slices[slice_index];
818 clib_mem_bulk_free (pfss->fifos, f);
822 fifo_segment_cleanup (fifo_segment_t *fs)
827 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
828 clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
830 vec_free (fs->slices);
832 vec_foreach (fs->mqs, mq)
833 svm_msg_q_cleanup (mq);
839 * Allocate fifo in fifo segment
842 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
843 u32 data_bytes, fifo_segment_ftype_t ftype)
845 fifo_segment_header_t *fsh = fs->h;
846 fifo_slice_private_t *pfss;
847 fifo_segment_slice_t *fss;
848 svm_fifo_shared_t *sf;
851 ASSERT (slice_index < fs->n_slices);
853 if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
856 sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
860 f = fs_fifo_alloc (fs, slice_index);
864 svm_fifo_init (f, data_bytes);
866 fss = fsh_slice_get (fsh, slice_index);
867 pfss = fs_slice_private_get (fs, slice_index);
869 /* If rx fifo type add to active fifos list. When cleaning up segment,
870 * we need a list of active sessions that should be disconnected. Since
871 * both rx and tx fifos keep pointers to the session, it's enough to track
873 if (ftype == FIFO_SEGMENT_RX_FIFO)
875 pfss_fifo_add_active_list (pfss, f);
876 f->flags |= SVM_FIFO_F_LL_TRACKED;
879 fsh_active_fifos_update (fsh, 1);
880 fss->virtual_mem += svm_fifo_size (f);
887 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
889 svm_fifo_t *f = fs_fifo_alloc (fs, 0);
890 svm_fifo_shared_t *sf;
892 sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
896 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
897 f->segment_index = SVM_FIFO_INVALID_INDEX;
903 * Free fifo allocated in fifo segment
906 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
908 fifo_segment_header_t *fsh = fs->h;
909 fifo_slice_private_t *pfss;
910 fifo_segment_slice_t *fss;
911 svm_fifo_shared_t *sf;
913 ASSERT (f->refcnt > 0);
919 * Cleanup shared state
923 fss = fsh_slice_get (fsh, sf->slice_index);
924 pfss = fs_slice_private_get (fs, sf->slice_index);
926 /* Free fifo chunks */
927 fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
929 sf->start_chunk = sf->end_chunk = 0;
930 sf->head_chunk = sf->tail_chunk = 0;
932 /* Add to free list */
933 fss_fifo_free_list_push (fsh, fss, sf);
935 fss->virtual_mem -= svm_fifo_size (f);
938 * Cleanup private state
941 /* Remove from active list. Only rx fifos are tracked */
942 if (f->flags & SVM_FIFO_F_LL_TRACKED)
944 pfss_fifo_del_active_list (pfss, f);
945 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
948 svm_fifo_free_chunk_lookup (f);
949 svm_fifo_free_ooo_data (f);
953 sf->master_session_index = ~0;
954 f->master_thread_index = ~0;
957 f->ooo_enq = f->ooo_deq = 0;
960 fs_fifo_free (fs, f, f->shr->slice_index);
962 fsh_active_fifos_update (fsh, -1);
966 fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f)
968 fs_fifo_free (fs, f, 0 /* clients attach fifos in slice 0 */);
972 fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f)
974 fifo_slice_private_t *pfss;
975 fifo_segment_slice_t *fss;
979 slice_index = of->master_thread_index;
980 fss = fsh_slice_get (fs->h, slice_index);
981 pfss = fs_slice_private_get (fs, slice_index);
982 fss->virtual_mem -= svm_fifo_size (of);
983 if (of->flags & SVM_FIFO_F_LL_TRACKED)
984 pfss_fifo_del_active_list (pfss, of);
986 /* Collect chunks that were provided in return for those detached */
987 fsh_slice_collect_chunks (fs->h, fss, of->chunks_at_attach);
988 of->chunks_at_attach = 0;
990 /* Collect hdr that was provided in return for the detached */
991 fss_fifo_free_list_push (fs->h, fss, of->hdr_at_attach);
992 of->hdr_at_attach = 0;
994 clib_mem_bulk_free (pfss->fifos, *f);
999 fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
1001 svm_fifo_chunk_t *c, *nc, *pc = 0;
1002 fifo_slice_private_t *pfss;
1003 fifo_segment_slice_t *fss;
1004 svm_fifo_t *nf, *of;
1006 nf = fs_fifo_alloc (fs, slice_index);
1007 clib_memcpy_fast (nf, *f, sizeof (*nf));
1009 fss = fsh_slice_get (fs->h, slice_index);
1010 pfss = fs_slice_private_get (fs, slice_index);
1011 fss->virtual_mem += svm_fifo_size (nf);
1012 nf->next = nf->prev = 0;
1013 if (nf->flags & SVM_FIFO_F_LL_TRACKED)
1014 pfss_fifo_add_active_list (pfss, nf);
1016 /* Allocate shared hdr and chunks to be collected at detach in return
1017 * for those that are being attached now */
1019 of->hdr_at_attach = fsh_try_alloc_fifo_hdr (fs->h, fss);
1021 c = fs_chunk_ptr (fs->h, nf->shr->start_chunk);
1022 of->chunks_at_attach = pc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1024 while ((c = fs_chunk_ptr (fs->h, c->next)))
1026 nc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1027 pc->next = fs_chunk_sptr (fs->h, nc);
1031 nf->shr->slice_index = slice_index;
1036 fifo_segment_fifo_offset (svm_fifo_t *f)
1038 return (u8 *) f->shr - (u8 *) f->fs_hdr;
1042 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
1043 svm_msg_q_cfg_t *cfg)
1045 fifo_segment_header_t *fsh = fs->h;
1046 svm_msg_q_shared_t *smq;
1053 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1054 vec_validate (fs->mqs, n_mqs - 1);
1057 size = svm_msg_q_size_to_alloc (cfg);
1058 base = fsh_alloc_aligned (fsh, size, 8);
1059 fsh->n_reserved_bytes += size;
1061 smq = svm_msg_q_init (base, cfg);
1062 mq = vec_elt_at_index (fs->mqs, mq_index);
1063 svm_msg_q_attach (mq, smq);
1069 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
1075 u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1076 vec_validate (fs->mqs, n_mqs - 1);
1079 mq = vec_elt_at_index (fs->mqs, mq_index);
1083 svm_msg_q_shared_t *smq;
1084 smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1085 svm_msg_q_attach (mq, smq);
1088 ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1094 fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds)
1096 svm_msg_q_shared_t *smq;
1098 uword offset = 0, n_alloced;
1101 n_mqs = fs->h->n_mqs;
1102 if (n_fds && n_mqs != n_fds)
1104 clib_warning ("expected %u fds got %u", n_mqs, n_fds);
1108 vec_validate (fs->mqs, n_mqs - 1);
1109 n_alloced = fs->h->n_reserved_bytes - fs->h->start_byte_index;
1110 ASSERT (n_alloced % n_mqs == 0);
1111 size = n_alloced / n_mqs;
1113 offset = fs->h->start_byte_index;
1114 for (i = 0; i < n_mqs; i++)
1116 mq = vec_elt_at_index (fs->mqs, i);
1117 smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1118 svm_msg_q_attach (mq, smq);
1120 svm_msg_q_set_eventfd (mq, fds[i]);
1126 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1128 svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1133 return (uword) ((u8 *) mq->q.shr - (u8 *) fs->h) -
1134 sizeof (svm_msg_q_shared_t);
1138 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1141 fifo_segment_header_t *fsh = fs->h;
1142 fifo_segment_slice_t *fss;
1144 fss = fsh_slice_get (fsh, slice_index);
1145 return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1149 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1150 u32 chunk_size, u32 batch_size)
1152 fifo_segment_header_t *fsh = fs->h;
1153 fifo_segment_slice_t *fss;
1156 if (!fs_chunk_size_is_valid (fsh, chunk_size))
1158 clib_warning ("chunk size out of range %d", chunk_size);
1162 fl_index = fs_freelist_for_size (chunk_size);
1163 fss = fsh_slice_get (fsh, slice_index);
1165 return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1169 * Pre-allocates fifo pairs in fifo segment
1172 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1173 u32 rx_fifo_size, u32 tx_fifo_size,
1176 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1177 u32 hdrs, pairs_per_slice, alloc_now;
1178 fifo_segment_header_t *fsh = fs->h;
1179 int rx_fl_index, tx_fl_index, i;
1180 fifo_segment_slice_t *fss;
1181 uword space_available;
1183 /* Parameter check */
1184 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1187 if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1189 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1193 if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1195 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1199 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1200 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1201 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1202 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1204 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1206 /* Calculate space requirements */
1207 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1208 space_available = fsh_n_free_bytes (fsh);
1209 pairs_to_alloc = space_available / pair_size;
1210 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1211 pairs_per_slice = pairs_to_alloc / fs->n_slices;
1212 pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1214 if (!pairs_per_slice)
1217 for (i = 0; i < fs->n_slices; i++)
1219 alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1223 fss = fsh_slice_get (fsh, i);
1224 if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1225 clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1226 if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1227 clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1229 /* Account for the pairs allocated */
1230 *n_fifo_pairs -= alloc_now;
1235 * Get number of active fifos
1238 fifo_segment_num_fifos (fifo_segment_t * fs)
1240 return fsh_n_active_fifos (fs->h);
1244 fs_slice_num_free_fifos (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
1246 svm_fifo_shared_t *f;
1249 f = fs_ptr (fsh, fss->free_fifos);
1255 f = fs_ptr (fsh, f->next);
1262 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1264 fifo_segment_header_t *fsh = fs->h;
1265 fifo_segment_slice_t *fss;
1269 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1271 fss = fsh_slice_get (fsh, slice_index);
1272 count += fs_slice_num_free_fifos (fsh, fss);
1278 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1279 fifo_segment_slice_t *fss, u32 size)
1281 u32 count = 0, rounded_size, fl_index;
1282 svm_fifo_chunk_t *c;
1285 /* Count all free chunks? */
1288 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1290 c = fss_chunk_free_list_head (fsh, fss, i);
1296 c = fs_chunk_ptr (fsh, c->next);
1303 rounded_size = (1 << (max_log2 (size)));
1304 fl_index = fs_freelist_for_size (rounded_size);
1306 if (fl_index >= FS_CHUNK_VEC_LEN)
1309 c = fss_chunk_free_list_head (fsh, fss, fl_index);
1315 c = fs_chunk_ptr (fsh, c->next);
1322 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1324 fifo_segment_header_t *fsh = fs->h;
1325 fifo_segment_slice_t *fss;
1329 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1331 fss = fsh_slice_get (fsh, slice_index);
1332 count += fs_slice_num_free_chunks (fsh, fss, size);
1338 fifo_segment_size (fifo_segment_t * fs)
1340 return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1344 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1346 return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1350 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1352 fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1356 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1358 void *rv = fsh_alloc (fs->h, size);
1359 /* Mark externally allocated bytes as reserved. This helps
1360 * @ref fifo_segment_size report bytes used only for fifos */
1361 fs->h->n_reserved_bytes += size;
1366 fifo_segment_free_bytes (fifo_segment_t * fs)
1368 return fsh_n_free_bytes (fs->h);
1372 fifo_segment_cached_bytes (fifo_segment_t * fs)
1374 return fsh_n_cached_bytes (fs->h);
1378 fifo_segment_available_bytes (fifo_segment_t * fs)
1380 return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1384 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1386 fifo_segment_header_t *fsh = fs->h;
1387 fifo_segment_slice_t *fss;
1391 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1393 fss = fsh_slice_get (fsh, slice_index);
1394 n_bytes += fss_fl_chunk_bytes (fss);
1401 fifo_segment_has_fifos (fifo_segment_t * fs)
1403 return (fsh_n_active_fifos (fs->h) != 0);
1407 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1409 fifo_slice_private_t *pfss;
1411 pfss = fs_slice_private_get (fs, slice_index);
1412 return pfss->active_fifos;
1416 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1420 size = fifo_segment_size (fs);
1422 size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1423 return (in_use * 100) / size;
1426 fifo_segment_mem_status_t
1427 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1429 if (!fsh->high_watermark || !fsh->low_watermark)
1430 return MEMORY_PRESSURE_NO_PRESSURE;
1432 /* once the no-memory is detected, the status continues
1433 * until memory usage gets below the high watermark
1435 if (fsh_has_reached_mem_limit (fsh))
1437 if (usage >= fsh->high_watermark)
1438 return MEMORY_PRESSURE_NO_MEMORY;
1440 fsh_reset_mem_limit (fsh);
1443 if (usage >= fsh->high_watermark)
1444 return MEMORY_PRESSURE_HIGH_PRESSURE;
1446 else if (usage >= fsh->low_watermark)
1447 return MEMORY_PRESSURE_LOW_PRESSURE;
1449 return MEMORY_PRESSURE_NO_PRESSURE;
1452 fifo_segment_mem_status_t
1453 fifo_segment_get_mem_status (fifo_segment_t * fs)
1455 fifo_segment_header_t *fsh = fs->h;
1456 u8 usage = fifo_segment_get_mem_usage (fs);
1458 return fifo_segment_determine_status (fsh, usage);
1462 format_fifo_segment_type (u8 * s, va_list * args)
1465 sp = va_arg (*args, fifo_segment_t *);
1466 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1468 if (st == SSVM_SEGMENT_PRIVATE)
1469 s = format (s, "%s", "private");
1470 else if (st == SSVM_SEGMENT_MEMFD)
1471 s = format (s, "%s", "memfd");
1472 else if (st == SSVM_SEGMENT_SHM)
1473 s = format (s, "%s", "shm");
1475 s = format (s, "%s", "unknown");
1480 * Segment format function
1483 format_fifo_segment (u8 * s, va_list * args)
1485 u32 count, indent, active_fifos, free_fifos;
1486 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1487 int verbose __attribute__ ((unused)) = va_arg (*args, int);
1488 uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1489 uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1490 uword tracked_cached_bytes;
1491 uword fifo_hdr = 0, reserved;
1492 fifo_segment_header_t *fsh;
1493 fifo_segment_slice_t *fss;
1494 svm_fifo_chunk_t *c;
1499 uword allocated, in_use, virt;
1501 fifo_segment_mem_status_t mem_st;
1503 indent = format_get_indent (s) + 2;
1507 s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1508 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1512 fifo_segment_info (fs, &address, &size);
1513 active_fifos = fifo_segment_num_fifos (fs);
1514 free_fifos = fifo_segment_num_free_fifos (fs);
1516 s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1517 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1518 free_fifos, address);
1525 free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1528 format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1531 s = format (s, "\n");
1533 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1535 fss = fsh_slice_get (fsh, slice_index);
1536 for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1538 c = fss_chunk_free_list_head (fsh, fss, i);
1539 if (c == 0 && fss->num_chunks[i] == 0)
1544 c = fs_chunk_ptr (fsh, c->next);
1548 chunk_size = fs_freelist_index_to_size (i);
1549 s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1550 chunk_size >> 10, count, fss->num_chunks[i]);
1552 chunk_bytes += count * chunk_size;
1556 fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1557 est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1558 est_free_seg_bytes = fifo_segment_free_bytes (fs);
1559 free_seg_bytes = fifo_segment_free_bytes (fs);
1560 tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1561 allocated = fifo_segment_size (fs);
1562 in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1563 usage = (100.0 * in_use) / allocated;
1564 mem_st = fifo_segment_get_mem_status (fs);
1565 virt = fsh_virtual_mem (fsh);
1566 reserved = fsh->n_reserved_bytes;
1568 s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1569 " %U (%lu)\n", format_white_space, indent + 2,
1570 format_memory_size, free_seg_bytes, free_seg_bytes,
1571 format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1572 format_memory_size, reserved, reserved);
1573 s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1574 " %U (%lu)\n", format_white_space, indent + 2,
1575 format_memory_size, chunk_bytes, chunk_bytes,
1576 format_memory_size, est_chunk_bytes, est_chunk_bytes,
1577 format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1578 s = format (s, "%Ufifo active: %u hdr free: %u bytes: %U (%u) \n",
1579 format_white_space, indent + 2, fsh->n_active_fifos, free_fifos,
1580 format_memory_size, fifo_hdr, fifo_hdr);
1581 s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1582 format_white_space, indent + 2, usage, format_memory_size,
1583 in_use, format_memory_size, allocated, format_memory_size, virt,
1584 fifo_segment_mem_status_strings[mem_st]);
1585 s = format (s, "\n");
1591 * fd.io coding-style-patch-verification: ON
1594 * eval: (c-set-style "gnu")