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>
19 * Fifo segment free space
21 * Queries the underlying memory manager, dlmalloc, for free space. Since this
22 * ends up walking the internal data structures, it should not be called
25 * @param fs fifo segment
26 * @return number of free bytes
29 fs_free_space (fifo_segment_t * fs)
31 struct dlmallinfo dlminfo;
33 dlminfo = mspace_mallinfo (fs->ssvm.sh->heap);
34 return dlminfo.fordblks;
38 * Initialize fifo segment shared header
41 fifo_segment_init (fifo_segment_t * fs)
43 fifo_segment_header_t *fsh;
44 ssvm_shared_header_t *sh;
48 oldheap = ssvm_push_heap (sh);
50 fsh = clib_mem_alloc (sizeof (*fsh));
51 clib_memset (fsh, 0, sizeof (*fsh));
52 fs->h = sh->opaque[0] = fsh;
54 ssvm_pop_heap (oldheap);
56 fsh->n_free_bytes = fs_free_space (fs);
62 * Create a fifo segment and initialize as master
65 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
71 /* Allocate a fresh segment */
72 pool_get_zero (sm->segments, fs);
74 baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
75 fs->ssvm.ssvm_size = a->segment_size;
76 fs->ssvm.i_am_master = 1;
77 fs->ssvm.my_pid = getpid ();
78 fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
79 fs->ssvm.requested_va = baseva;
81 if ((rv = ssvm_master_init (&fs->ssvm, a->segment_type)))
83 pool_put (sm->segments, fs);
87 /* Note: requested_va updated due to seg base addr randomization */
88 sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
90 fifo_segment_init (fs);
91 vec_add1 (a->new_segment_indices, fs - sm->segments);
96 * Attach as slave to a fifo segment
99 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
104 pool_get_zero (sm->segments, s);
106 s->ssvm.ssvm_size = a->segment_size;
107 s->ssvm.my_pid = getpid ();
108 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
109 s->ssvm.requested_va = sm->next_baseva;
110 if (a->segment_type == SSVM_SEGMENT_MEMFD)
111 s->ssvm.fd = a->memfd_fd;
113 s->ssvm.attach_timeout = sm->timeout_in_seconds;
115 if ((rv = ssvm_slave_init (&s->ssvm, a->segment_type)))
117 _vec_len (s) = vec_len (s) - 1;
121 /* Fish the segment header */
122 s->h = s->ssvm.sh->opaque[0];
124 vec_add1 (a->new_segment_indices, s - sm->segments);
129 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
131 ssvm_delete (&s->ssvm);
132 clib_memset (s, 0xfe, sizeof (*s));
133 pool_put (sm->segments, s);
137 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
139 return s - sm->segments;
143 svm_fifo_segment_heap (fifo_segment_t * seg)
145 return seg->ssvm.sh->heap;
149 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
151 return pool_elt_at_index (sm->segments, segment_index);
155 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
157 *address = (char *) seg->ssvm.sh->ssvm_va;
158 *size = seg->ssvm.ssvm_size;
162 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
163 u32 timeout_in_seconds)
165 sm->next_baseva = baseva;
166 sm->timeout_in_seconds = timeout_in_seconds;
170 fs_freelist_for_size (u32 size)
172 return max_log2 (size) - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
176 fs_freelist_index_to_size (u32 fl_index)
178 return 1 << (fl_index + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE));
182 fs_chunk_size_is_valid (u32 size)
185 * 4K minimum. It's not likely that anything good will happen
186 * with a smaller FIFO.
188 return size >= FIFO_SEGMENT_MIN_FIFO_SIZE
189 && size <= FIFO_SEGMENT_MAX_FIFO_SIZE;
193 fs_try_alloc_fifo_freelist (fifo_segment_t * fs, u32 fl_index, u32 data_bytes)
195 fifo_segment_header_t *fsh = fs->h;
200 c = fsh->free_chunks[fl_index];
205 fsh->free_fifos = f->next;
206 fsh->free_chunks[fl_index] = c->next;
209 c->length = data_bytes;
210 memset (f, 0, sizeof (*f));
214 fsh->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
219 fs_try_alloc_fifo_freelist_multi_chunk (fifo_segment_t * fs, u32 data_bytes)
221 svm_fifo_chunk_t *c, *first = 0, *last = 0;
222 fifo_segment_header_t *fsh = fs->h;
223 u32 fl_index, fl_size, n_alloc = 0;
229 void *oldheap = ssvm_push_heap (fs->ssvm.sh);
230 f = clib_mem_alloc_aligned (sizeof (*f), CLIB_CACHE_LINE_BYTES);
231 ssvm_pop_heap (oldheap);
234 memset (f, 0, sizeof (*f));
237 fl_index = fs_freelist_for_size (data_bytes) - 1;
238 vec_validate_init_empty (fsh->free_chunks, fl_index, 0);
239 fl_size = fs_freelist_index_to_size (fl_index);
243 c = fsh->free_chunks[fl_index];
246 fsh->free_chunks[fl_index] = c->next;
252 c->length = clib_min (fl_size, data_bytes);
253 data_bytes -= c->length;
257 ASSERT (fl_index > 0);
259 fl_size = fl_size >> 1;
262 f->start_chunk = first;
265 fsh->n_fl_chunk_bytes -= n_alloc;
270 fs_try_alloc_fifo_batch (fifo_segment_t * fs, u32 fl_index, u32 batch_size)
272 fifo_segment_header_t *fsh = fs->h;
273 u32 size, hdrs, rounded_data_size;
280 vec_validate_init_empty (fsh->free_chunks, fl_index, 0);
281 rounded_data_size = fs_freelist_index_to_size (fl_index);
282 hdrs = sizeof (*f) + sizeof (*c);
283 size = (hdrs + rounded_data_size) * batch_size;
285 oldheap = ssvm_push_heap (fs->ssvm.sh);
286 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
287 0 /* align_offset */ ,
288 0 /* os_out_of_memory */ );
289 ssvm_pop_heap (oldheap);
295 /* Carve fifo + chunk space */
296 for (i = 0; i < batch_size; i++)
298 f = (svm_fifo_t *) fmem;
299 memset (f, 0, sizeof (*f));
300 f->next = fsh->free_fifos;
302 c = (svm_fifo_chunk_t *) (fmem + sizeof (*f));
304 c->length = rounded_data_size;
305 c->next = fsh->free_chunks[fl_index];
306 fsh->free_chunks[fl_index] = c;
307 fmem += hdrs + rounded_data_size;
310 fsh->n_fl_chunk_bytes += batch_size * rounded_data_size;
311 fsh->n_free_bytes -= size;
317 * Try to allocate new fifo
319 * Tries the following steps in order:
320 * - grab fifo and chunk from freelists
321 * - batch fifo and chunk allocation
322 * - single fifo allocation
323 * - grab multiple fifo chunks from freelists
326 fs_try_alloc_fifo (fifo_segment_t * fs, u32 data_bytes)
328 fifo_segment_header_t *fsh = fs->h;
329 u32 fifo_sz, fl_index;
332 fl_index = fs_freelist_for_size (data_bytes);
333 vec_validate_init_empty (fsh->free_chunks, fl_index, 0);
334 fifo_sz = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
335 fifo_sz += 1 << max_log2 (data_bytes);
337 if (fsh->free_fifos && fsh->free_chunks[fl_index])
339 f = fs_try_alloc_fifo_freelist (fs, fl_index, data_bytes);
343 if (fifo_sz * FIFO_SEGMENT_ALLOC_BATCH_SIZE < fsh->n_free_bytes)
345 if (fs_try_alloc_fifo_batch (fs, fl_index,
346 FIFO_SEGMENT_ALLOC_BATCH_SIZE))
349 f = fs_try_alloc_fifo_freelist (fs, fl_index, data_bytes);
352 if (fifo_sz <= fsh->n_free_bytes)
354 void *oldheap = ssvm_push_heap (fs->ssvm.sh);
355 f = svm_fifo_create (data_bytes);
356 ssvm_pop_heap (oldheap);
359 fsh->n_free_bytes -= fifo_sz;
363 if (data_bytes <= fsh->n_fl_chunk_bytes)
364 f = fs_try_alloc_fifo_freelist_multi_chunk (fs, data_bytes);
372 * Allocate fifo in fifo segment
375 fifo_segment_alloc_fifo (fifo_segment_t * fs, u32 data_bytes,
376 fifo_segment_ftype_t ftype)
378 fifo_segment_header_t *fsh;
381 if (!fs_chunk_size_is_valid (data_bytes))
383 clib_warning ("fifo size out of range %d", data_bytes);
388 ssvm_lock_non_recursive (fs->ssvm.sh, 1);
390 f = fs_try_alloc_fifo (fs, data_bytes);
394 /* (re)initialize the fifo, as in svm_fifo_create */
395 svm_fifo_init (f, data_bytes);
397 /* Initialize chunks and rbtree for multi-chunk fifos */
398 if (f->start_chunk->next != f->start_chunk)
400 void *oldheap = ssvm_push_heap (fs->ssvm.sh);
401 svm_fifo_init_chunks (f);
402 ssvm_pop_heap (oldheap);
405 /* If rx fifo type add to active fifos list. When cleaning up segment,
406 * we need a list of active sessions that should be disconnected. Since
407 * both rx and tx fifos keep pointers to the session, it's enough to track
409 if (ftype == FIFO_SEGMENT_RX_FIFO)
413 fsh->fifos->prev = f;
414 f->next = fsh->fifos;
417 f->flags |= SVM_FIFO_F_LL_TRACKED;
419 fsh->n_active_fifos++;
422 ssvm_unlock_non_recursive (fs->ssvm.sh);
427 * Free fifo allocated in fifo segment
430 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
432 svm_fifo_chunk_t *cur, *next;
433 fifo_segment_header_t *fsh;
434 ssvm_shared_header_t *sh;
438 ASSERT (f->refcnt > 0);
446 ssvm_lock_non_recursive (sh, 2);
448 /* Remove from active list. Only rx fifos are tracked */
449 if (f->flags & SVM_FIFO_F_LL_TRACKED)
452 f->prev->next = f->next;
454 fsh->fifos = f->next;
456 f->next->prev = f->prev;
457 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
460 /* Add to free list */
461 f->next = fsh->free_fifos;
465 /* Free fifo chunks */
466 cur = f->start_chunk;
470 fl_index = fs_freelist_for_size (cur->length);
471 ASSERT (fl_index < vec_len (fsh->free_chunks));
472 cur->next = fsh->free_chunks[fl_index];
473 fsh->free_chunks[fl_index] = cur;
474 fsh->n_fl_chunk_bytes += fs_freelist_index_to_size (fl_index);
477 while (cur != f->start_chunk);
479 f->start_chunk = f->end_chunk = f->new_chunks = 0;
480 f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = 0;
482 oldheap = ssvm_push_heap (sh);
483 svm_fifo_free_chunk_lookup (f);
484 ssvm_pop_heap (oldheap);
486 /* not allocated on segment heap */
487 svm_fifo_free_ooo_data (f);
491 f->master_session_index = ~0;
492 f->master_thread_index = ~0;
495 fsh->n_active_fifos--;
496 ssvm_unlock_non_recursive (sh);
500 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 batch_size)
502 fifo_segment_header_t *fsh = fs->h;
509 size = (sizeof (*f)) * batch_size;
511 oldheap = ssvm_push_heap (fs->ssvm.sh);
512 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
513 0 /* align_offset */ ,
514 0 /* os_out_of_memory */ );
515 ssvm_pop_heap (oldheap);
521 /* Carve fifo + chunk space */
522 for (i = 0; i < batch_size; i++)
524 f = (svm_fifo_t *) fmem;
525 memset (f, 0, sizeof (*f));
526 f->next = fsh->free_fifos;
531 fsh->n_free_bytes -= size;
537 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 chunk_size,
540 fifo_segment_header_t *fsh = fs->h;
541 u32 size, rounded_data_size, fl_index;
547 if (!fs_chunk_size_is_valid (chunk_size))
549 clib_warning ("chunk size out of range %d", chunk_size);
553 fl_index = fs_freelist_for_size (chunk_size);
554 vec_validate_init_empty (fsh->free_chunks, fl_index, 0);
555 rounded_data_size = fs_freelist_index_to_size (fl_index);
556 size = (sizeof (*c) + rounded_data_size) * batch_size;
558 oldheap = ssvm_push_heap (fs->ssvm.sh);
559 cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
560 0 /* align_offset */ ,
561 0 /* os_out_of_memory */ );
562 ssvm_pop_heap (oldheap);
568 /* Carve fifo + chunk space */
569 for (i = 0; i < batch_size; i++)
571 c = (svm_fifo_chunk_t *) cmem;
573 c->length = rounded_data_size;
574 c->next = fsh->free_chunks[fl_index];
575 fsh->free_chunks[fl_index] = c;
576 cmem += sizeof (*c) + rounded_data_size;
579 fsh->n_fl_chunk_bytes += batch_size * rounded_data_size;
580 fsh->n_free_bytes -= size;
586 * Pre-allocates fifo pairs in fifo segment
589 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
590 u32 rx_fifo_size, u32 tx_fifo_size,
593 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
594 int rx_fl_index, tx_fl_index;
595 uword space_available;
598 /* Parameter check */
599 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
602 if (!fs_chunk_size_is_valid (rx_fifo_size))
604 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
608 if (!fs_chunk_size_is_valid (tx_fifo_size))
610 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
614 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
615 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
616 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
617 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
619 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
621 /* Calculate space requirements */
622 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
623 space_available = fs_free_space (fs);
624 pairs_to_alloc = space_available / pair_size;
625 pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
630 if (fs_try_alloc_fifo_batch (fs, rx_fl_index, pairs_to_alloc))
631 clib_warning ("rx prealloc failed: pairs %u", pairs_to_alloc);
632 if (fs_try_alloc_fifo_batch (fs, tx_fl_index, pairs_to_alloc))
633 clib_warning ("tx prealloc failed: pairs %u", pairs_to_alloc);
635 /* Account for the pairs allocated */
636 *n_fifo_pairs -= pairs_to_alloc;
640 fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f, u32 chunk_size)
642 ssvm_shared_header_t *sh;
647 if (!fs_chunk_size_is_valid (chunk_size))
649 clib_warning ("chunk size out of range %d", chunk_size);
653 fl_index = fs_freelist_for_size (chunk_size);
656 ssvm_lock_non_recursive (sh, 1);
658 vec_validate_init_empty (fs->h->free_chunks, fl_index, 0);
659 c = fs->h->free_chunks[fl_index];
661 oldheap = ssvm_push_heap (sh);
665 c = svm_fifo_chunk_alloc (chunk_size);
668 ssvm_pop_heap (oldheap);
669 ssvm_unlock_non_recursive (sh);
675 fs->h->free_chunks[fl_index] = c->next;
677 fs->h->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
680 svm_fifo_add_chunk (f, c);
682 ssvm_pop_heap (oldheap);
683 ssvm_unlock_non_recursive (sh);
688 fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f)
690 svm_fifo_chunk_t *cur, *next;
691 ssvm_shared_header_t *sh;
696 ssvm_lock_non_recursive (sh, 1);
698 oldheap = ssvm_push_heap (sh);
699 cur = svm_fifo_collect_chunks (f);
704 fl_index = fs_freelist_for_size (cur->length);
705 cur->next = fs->h->free_chunks[fl_index];
706 fs->h->free_chunks[fl_index] = cur;
710 ssvm_pop_heap (oldheap);
711 ssvm_unlock_non_recursive (sh);
717 * Get number of active fifos
720 fifo_segment_num_fifos (fifo_segment_t * fs)
722 return fs->h->n_active_fifos;
726 fifo_segment_num_free_fifos (fifo_segment_t * fs)
728 fifo_segment_header_t *fsh = fs->h;
745 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
747 u32 count = 0, rounded_size, fl_index;
748 fifo_segment_header_t *fsh;
754 /* Count all free chunks? */
757 for (i = 0; i < vec_len (fsh->free_chunks); i++)
759 c = fsh->free_chunks[i];
772 rounded_size = (1 << (max_log2 (size)));
773 fl_index = fs_freelist_for_size (rounded_size);
775 if (fl_index >= vec_len (fsh->free_chunks))
778 c = fsh->free_chunks[fl_index];
791 fifo_segment_update_free_bytes (fifo_segment_t * fs)
793 fs->h->n_free_bytes = fs_free_space (fs);
797 fifo_segment_free_bytes (fifo_segment_t * fs)
799 return fs->h->n_free_bytes;
803 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
805 return fs->h->n_fl_chunk_bytes;
809 fifo_segment_has_fifos (fifo_segment_t * fs)
811 return fs->h->fifos != 0;
815 fifo_segment_get_fifo_list (fifo_segment_t * fs)
821 format_fifo_segment_type (u8 * s, va_list * args)
824 sp = va_arg (*args, fifo_segment_t *);
825 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
827 if (st == SSVM_SEGMENT_PRIVATE)
828 s = format (s, "%s", "private-heap");
829 else if (st == SSVM_SEGMENT_MEMFD)
830 s = format (s, "%s", "memfd");
831 else if (st == SSVM_SEGMENT_SHM)
832 s = format (s, "%s", "shm");
834 s = format (s, "%s", "unknown");
839 * Segment format function
842 format_fifo_segment (u8 * s, va_list * args)
844 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
845 int verbose __attribute__ ((unused)) = va_arg (*args, int);
846 fifo_segment_header_t *fsh;
855 indent = format_get_indent (s) + 2;
856 #if USE_DLMALLOC == 0
857 s = format (s, "%U segment heap: %U\n", format_white_space, indent,
858 format_mheap, svm_fifo_segment_heap (fs), verbose);
859 s = format (s, "%U segment has %u active fifos\n",
860 format_white_space, indent, fifo_segment_num_fifos (fs));
865 s = format (s, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
866 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
871 fifo_segment_info (fs, &address, &size);
872 active_fifos = fifo_segment_num_fifos (fs);
873 free_fifos = fifo_segment_num_free_fifos (fs);
875 s = format (s, "%-15v%15U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
876 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
877 free_fifos, address);
882 s = format (s, "\n");
883 for (i = 0; i < vec_len (fsh->free_chunks); i++)
885 c = fsh->free_chunks[i];
895 s = format (s, "%U%-5u Kb: %u free", format_white_space, indent + 2,
896 1 << (i + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE) - 10),
899 s = format (s, "%Ufree bytes %U", format_white_space, indent + 2,
900 format_memory_size, fsh->n_free_bytes);
906 * fd.io coding-style-patch-verification: ON
909 * eval: (c-set-style "gnu")