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;
251 n_alloc += c->length;
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 /* If rx fifo type add to active fifos list. When cleaning up segment,
398 * we need a list of active sessions that should be disconnected. Since
399 * both rx and tx fifos keep pointers to the session, it's enough to track
401 if (ftype == FIFO_SEGMENT_RX_FIFO)
405 fsh->fifos->prev = f;
406 f->next = fsh->fifos;
409 f->flags |= SVM_FIFO_F_LL_TRACKED;
411 fsh->n_active_fifos++;
414 ssvm_unlock_non_recursive (fs->ssvm.sh);
419 * Free fifo allocated in fifo segment
422 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
424 svm_fifo_chunk_t *cur, *next;
425 fifo_segment_header_t *fsh;
426 ssvm_shared_header_t *sh;
430 ASSERT (f->refcnt > 0);
438 ssvm_lock_non_recursive (sh, 2);
440 /* Remove from active list. Only rx fifos are tracked */
441 if (f->flags & SVM_FIFO_F_LL_TRACKED)
444 f->prev->next = f->next;
446 fsh->fifos = f->next;
448 f->next->prev = f->prev;
449 f->flags &= ~SVM_FIFO_F_LL_TRACKED;
452 /* Add to free list */
453 f->next = fsh->free_fifos;
457 /* Free fifo chunks */
458 cur = f->start_chunk;
462 fl_index = fs_freelist_for_size (cur->length);
463 ASSERT (fl_index < vec_len (fsh->free_chunks));
464 cur->next = fsh->free_chunks[fl_index];
465 fsh->free_chunks[fl_index] = cur;
466 fsh->n_fl_chunk_bytes += fs_freelist_index_to_size (fl_index);
469 while (cur != f->start_chunk);
471 oldheap = ssvm_push_heap (sh);
472 svm_fifo_free_chunk_lookup (f);
473 ssvm_pop_heap (oldheap);
475 /* not allocated on segment heap */
476 svm_fifo_free_ooo_data (f);
480 f->master_session_index = ~0;
481 f->master_thread_index = ~0;
484 fsh->n_active_fifos--;
485 ssvm_unlock_non_recursive (sh);
489 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 batch_size)
491 fifo_segment_header_t *fsh = fs->h;
498 size = (sizeof (*f)) * batch_size;
500 oldheap = ssvm_push_heap (fs->ssvm.sh);
501 fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
502 0 /* align_offset */ ,
503 0 /* os_out_of_memory */ );
504 ssvm_pop_heap (oldheap);
510 /* Carve fifo + chunk space */
511 for (i = 0; i < batch_size; i++)
513 f = (svm_fifo_t *) fmem;
514 memset (f, 0, sizeof (*f));
515 f->next = fsh->free_fifos;
520 fsh->n_free_bytes -= size;
526 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 chunk_size,
529 fifo_segment_header_t *fsh = fs->h;
530 u32 size, rounded_data_size, fl_index;
536 if (!fs_chunk_size_is_valid (chunk_size))
538 clib_warning ("chunk size out of range %d", chunk_size);
542 fl_index = fs_freelist_for_size (chunk_size);
543 vec_validate_init_empty (fsh->free_chunks, fl_index, 0);
544 rounded_data_size = fs_freelist_index_to_size (fl_index);
545 size = (sizeof (*c) + rounded_data_size) * batch_size;
547 oldheap = ssvm_push_heap (fs->ssvm.sh);
548 cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
549 0 /* align_offset */ ,
550 0 /* os_out_of_memory */ );
551 ssvm_pop_heap (oldheap);
557 /* Carve fifo + chunk space */
558 for (i = 0; i < batch_size; i++)
560 c = (svm_fifo_chunk_t *) cmem;
562 c->length = rounded_data_size;
563 c->next = fsh->free_chunks[fl_index];
564 fsh->free_chunks[fl_index] = c;
565 cmem += sizeof (*c) + rounded_data_size;
568 fsh->n_fl_chunk_bytes += batch_size * rounded_data_size;
569 fsh->n_free_bytes -= size;
575 * Pre-allocates fifo pairs in fifo segment
578 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
579 u32 rx_fifo_size, u32 tx_fifo_size,
582 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
583 int rx_fl_index, tx_fl_index;
584 uword space_available;
587 /* Parameter check */
588 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
591 if (!fs_chunk_size_is_valid (rx_fifo_size))
593 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
597 if (!fs_chunk_size_is_valid (tx_fifo_size))
599 clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
603 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
604 rx_fl_index = fs_freelist_for_size (rx_fifo_size);
605 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
606 tx_fl_index = fs_freelist_for_size (tx_fifo_size);
608 hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
610 /* Calculate space requirements */
611 pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
612 space_available = fs_free_space (fs);
613 pairs_to_alloc = clib_min (space_available / pair_size, *n_fifo_pairs);
615 if (fs_try_alloc_fifo_batch (fs, rx_fl_index, pairs_to_alloc))
616 clib_warning ("rx prealloc failed");
617 if (fs_try_alloc_fifo_batch (fs, tx_fl_index, pairs_to_alloc))
618 clib_warning ("tx prealloc failed");
620 /* Account for the pairs allocated */
621 *n_fifo_pairs -= pairs_to_alloc;
625 fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f, u32 chunk_size)
627 ssvm_shared_header_t *sh;
632 if (!fs_chunk_size_is_valid (chunk_size))
634 clib_warning ("chunk size out of range %d", chunk_size);
638 fl_index = fs_freelist_for_size (chunk_size);
641 ssvm_lock_non_recursive (sh, 1);
643 vec_validate_init_empty (fs->h->free_chunks, fl_index, 0);
644 c = fs->h->free_chunks[fl_index];
646 oldheap = ssvm_push_heap (sh);
650 c = svm_fifo_chunk_alloc (chunk_size);
653 ssvm_pop_heap (oldheap);
659 fs->h->free_chunks[fl_index] = c->next;
663 svm_fifo_add_chunk (f, c);
665 ssvm_pop_heap (oldheap);
666 ssvm_unlock_non_recursive (sh);
671 fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f)
673 svm_fifo_chunk_t *cur, *next;
674 ssvm_shared_header_t *sh;
679 ssvm_lock_non_recursive (sh, 1);
681 oldheap = ssvm_push_heap (sh);
682 cur = svm_fifo_collect_chunks (f);
687 fl_index = fs_freelist_for_size (cur->length);
688 cur->next = fs->h->free_chunks[fl_index];
689 fs->h->free_chunks[fl_index] = cur;
693 ssvm_pop_heap (oldheap);
694 ssvm_unlock_non_recursive (sh);
700 * Get number of active fifos
703 fifo_segment_num_fifos (fifo_segment_t * fs)
705 return fs->h->n_active_fifos;
709 fifo_segment_num_free_fifos (fifo_segment_t * fs)
711 fifo_segment_header_t *fsh = fs->h;
728 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
730 u32 count = 0, rounded_size, fl_index;
731 fifo_segment_header_t *fsh;
737 /* Count all free chunks? */
740 for (i = 0; i < vec_len (fsh->free_chunks); i++)
742 c = fsh->free_chunks[i];
755 rounded_size = (1 << (max_log2 (size)));
756 fl_index = fs_freelist_for_size (rounded_size);
758 if (fl_index >= vec_len (fsh->free_chunks))
761 c = fsh->free_chunks[fl_index];
774 fifo_segment_update_free_bytes (fifo_segment_t * fs)
776 fs->h->n_free_bytes = fs_free_space (fs);
780 fifo_segment_free_bytes (fifo_segment_t * fs)
782 return fs->h->n_free_bytes;
786 fifo_segment_chunk_prealloc_bytes (fifo_segment_t * fs)
788 return fs->h->n_fl_chunk_bytes;
792 fifo_segment_has_fifos (fifo_segment_t * fs)
794 return fs->h->fifos != 0;
798 fifo_segment_get_fifo_list (fifo_segment_t * fs)
804 format_fifo_segment_type (u8 * s, va_list * args)
807 sp = va_arg (*args, fifo_segment_t *);
808 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
810 if (st == SSVM_SEGMENT_PRIVATE)
811 s = format (s, "%s", "private-heap");
812 else if (st == SSVM_SEGMENT_MEMFD)
813 s = format (s, "%s", "memfd");
814 else if (st == SSVM_SEGMENT_SHM)
815 s = format (s, "%s", "shm");
817 s = format (s, "%s", "unknown");
822 * Segment format function
825 format_fifo_segment (u8 * s, va_list * args)
827 fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
828 int verbose __attribute__ ((unused)) = va_arg (*args, int);
829 fifo_segment_header_t *fsh;
838 indent = format_get_indent (s) + 2;
839 #if USE_DLMALLOC == 0
840 s = format (s, "%U segment heap: %U\n", format_white_space, indent,
841 format_mheap, svm_fifo_segment_heap (fs), verbose);
842 s = format (s, "%U segment has %u active fifos\n",
843 format_white_space, indent, fifo_segment_num_fifos (fs));
848 s = format (s, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
849 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
854 fifo_segment_info (fs, &address, &size);
855 active_fifos = fifo_segment_num_fifos (fs);
856 free_fifos = fifo_segment_num_free_fifos (fs);
858 s = format (s, "%-15v%15U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
859 format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
860 free_fifos, address);
865 s = format (s, "\n");
866 for (i = 0; i < vec_len (fsh->free_chunks); i++)
868 c = fsh->free_chunks[i];
878 s = format (s, "%U%-5u Kb: %u free", format_white_space, indent + 2,
879 1 << (i + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE) - 10),
882 s = format (s, "%Ufree bytes %U", format_white_space, indent + 2,
883 format_memory_size, fsh->n_free_bytes);
889 * fd.io coding-style-patch-verification: ON
892 * eval: (c-set-style "gnu")