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/svm_fifo_segment.h>
19 fifo_init_for_segment (svm_fifo_segment_header_t * fsh, u8 * fifo_space,
20 u32 size, u32 freelist_index)
24 f = (svm_fifo_t *) fifo_space;
25 f->freelist_index = freelist_index;
26 f->default_chunk.start_byte = 0;
27 f->default_chunk.length = size;
28 f->default_chunk.next = f->start_chunk = f->end_chunk = &f->default_chunk;
29 f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = f->start_chunk;
30 f->next = fsh->free_fifos[freelist_index];
31 fsh->free_fifos[freelist_index] = f;
35 allocate_new_fifo_chunk (svm_fifo_segment_header_t * fsh,
36 u32 data_size_in_bytes, int chunk_size)
41 u32 rounded_data_size;
45 rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
46 freelist_index = max_log2 (rounded_data_size)
47 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
49 /* Calculate space requirement $$$ round-up data_size_in_bytes */
50 size = (sizeof (*f) + rounded_data_size) * chunk_size;
52 /* Allocate fifo space. May fail. */
53 fifo_space = clib_mem_alloc_aligned_at_offset
54 (size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
55 0 /* os_out_of_memory */ );
61 /* Carve fifo space */
62 for (i = 0; i < chunk_size; i++)
64 fifo_init_for_segment (fsh, fifo_space, rounded_data_size,
66 fifo_space += sizeof (*f) + rounded_data_size;
71 * Pre-allocates fifo pairs in fifo segment
73 * The number of fifos pre-allocated is the minimum of the requested number
74 * of pairs and the maximum number that fit within the segment. If the maximum
75 * is hit, the number of fifo pairs requested is updated by subtracting the
76 * number of fifos that have been successfully allocated.
79 svm_fifo_segment_preallocate_fifo_pairs (svm_fifo_segment_private_t * s,
80 u32 rx_fifo_size, u32 tx_fifo_size,
83 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size;
84 u32 rx_fifos_size, tx_fifos_size, pairs_to_allocate;
85 int rx_freelist_index, tx_freelist_index;
86 ssvm_shared_header_t *sh = s->ssvm.sh;
87 svm_fifo_segment_header_t *fsh = s->h;
88 u8 *rx_fifo_space, *tx_fifo_space;
89 uword space_available;
95 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
98 if (rx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
99 rx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
101 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
105 if (tx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
106 tx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
108 clib_warning ("tx fifo_size out of range %d", rx_fifo_size);
112 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
113 rx_freelist_index = max_log2 (rx_fifo_size)
114 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
115 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
116 tx_freelist_index = max_log2 (tx_fifo_size)
117 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
119 /* Calculate space requirements */
120 pair_size = 2 * sizeof (*f) + rx_rounded_data_size + tx_rounded_data_size;
121 #if USE_DLMALLOC == 0
122 space_available = s->ssvm.ssvm_size - mheap_bytes (sh->heap);
124 space_available = s->ssvm.ssvm_size - mspace_usable_size (sh->heap);
127 pairs_to_allocate = clib_min (space_available / pair_size, *n_fifo_pairs);
128 rx_fifos_size = (sizeof (*f) + rx_rounded_data_size) * pairs_to_allocate;
129 tx_fifos_size = (sizeof (*f) + tx_rounded_data_size) * pairs_to_allocate;
131 vec_validate_init_empty (fsh->free_fifos,
132 clib_max (rx_freelist_index, tx_freelist_index),
135 oldheap = ssvm_push_heap (sh);
136 /* Allocate rx fifo space. May fail. */
137 rx_fifo_space = clib_mem_alloc_aligned_at_offset
138 (rx_fifos_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
139 0 /* os_out_of_memory */ );
142 tx_fifo_space = clib_mem_alloc_aligned_at_offset
143 (tx_fifos_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
144 0 /* os_out_of_memory */ );
146 /* Make sure it worked. Clean up if it didn't... */
147 if (rx_fifo_space == 0 || tx_fifo_space == 0)
150 clib_mem_free (rx_fifo_space);
152 clib_warning ("rx fifo preallocation failure: size %d npairs %d",
153 rx_fifo_size, *n_fifo_pairs);
156 clib_mem_free (tx_fifo_space);
158 clib_warning ("tx fifo preallocation failure: size %d nfifos %d",
159 tx_fifo_size, *n_fifo_pairs);
160 ssvm_pop_heap (oldheap);
164 /* Carve rx fifo space */
165 for (i = 0; i < pairs_to_allocate; i++)
167 fifo_init_for_segment (fsh, rx_fifo_space, rx_rounded_data_size,
169 rx_fifo_space += sizeof (*f) + rx_rounded_data_size;
171 /* Carve tx fifo space */
172 for (i = 0; i < pairs_to_allocate; i++)
174 fifo_init_for_segment (fsh, tx_fifo_space, tx_rounded_data_size,
176 tx_fifo_space += sizeof (*f) + tx_rounded_data_size;
179 /* Account for the pairs allocated */
180 *n_fifo_pairs -= pairs_to_allocate;
181 ssvm_pop_heap (oldheap);
185 * Initialize svm fifo segment shared header
188 svm_fifo_segment_init (svm_fifo_segment_private_t * s)
190 svm_fifo_segment_header_t *fsh;
191 ssvm_shared_header_t *sh;
195 oldheap = ssvm_push_heap (sh);
197 fsh = clib_mem_alloc (sizeof (*fsh));
198 clib_memset (fsh, 0, sizeof (*fsh));
199 s->h = sh->opaque[0] = fsh;
201 ssvm_pop_heap (oldheap);
208 * Create an svm fifo segment and initialize as master
211 svm_fifo_segment_create (svm_fifo_segment_main_t * sm,
212 svm_fifo_segment_create_args_t * a)
214 svm_fifo_segment_private_t *s;
217 /* Allocate a fresh segment */
218 pool_get (sm->segments, s);
219 clib_memset (s, 0, sizeof (*s));
221 s->ssvm.ssvm_size = a->segment_size;
222 s->ssvm.i_am_master = 1;
223 s->ssvm.my_pid = getpid ();
224 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
225 s->ssvm.requested_va = sm->next_baseva;
227 if ((rv = ssvm_master_init (&s->ssvm, a->segment_type)))
229 pool_put (sm->segments, s);
233 /* Note: requested_va updated due to seg base addr randomization */
234 sm->next_baseva = s->ssvm.sh->ssvm_va + a->segment_size;
236 svm_fifo_segment_init (s);
237 vec_add1 (a->new_segment_indices, s - sm->segments);
242 * Create an svm fifo segment in process-private memory
245 svm_fifo_segment_create_process_private (svm_fifo_segment_main_t * sm,
246 svm_fifo_segment_create_args_t * a)
248 svm_fifo_segment_private_t *s;
249 ssvm_shared_header_t *sh;
252 u32 pagesize = clib_mem_get_page_size ();
254 pool_get (sm->segments, s);
255 clib_memset (s, 0, sizeof (*s));
257 rnd_size = (a->segment_size + (pagesize - 1)) & ~pagesize;
259 #if USE_DLMALLOC == 0
260 heap = mheap_alloc (0, rnd_size);
263 clib_unix_warning ("mheap alloc");
264 pool_put (sm->segments, s);
268 mheap_t *heap_header;
269 heap_header = mheap_header (heap);
270 heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
273 heap = create_mspace (rnd_size, 1 /* locked */ );
276 s->ssvm.ssvm_size = rnd_size;
277 s->ssvm.i_am_master = 1;
278 s->ssvm.my_pid = getpid ();
279 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
280 s->ssvm.requested_va = ~0;
282 /* Allocate a [sic] shared memory header, in process memory... */
283 sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
286 clib_memset (sh, 0, sizeof (*sh));
289 svm_fifo_segment_init (s);
290 vec_add1 (a->new_segment_indices, s - sm->segments);
296 * Attach as slave to an svm fifo segment
299 svm_fifo_segment_attach (svm_fifo_segment_main_t * sm,
300 svm_fifo_segment_create_args_t * a)
302 svm_fifo_segment_private_t *s;
305 /* Allocate a fresh segment */
306 pool_get (sm->segments, s);
307 clib_memset (s, 0, sizeof (*s));
309 s->ssvm.ssvm_size = a->segment_size;
310 s->ssvm.my_pid = getpid ();
311 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
312 s->ssvm.requested_va = sm->next_baseva;
313 if (a->segment_type == SSVM_SEGMENT_MEMFD)
314 s->ssvm.fd = a->memfd_fd;
316 s->ssvm.attach_timeout = sm->timeout_in_seconds;
318 if ((rv = ssvm_slave_init (&s->ssvm, a->segment_type)))
320 _vec_len (s) = vec_len (s) - 1;
324 /* Fish the segment header */
325 s->h = s->ssvm.sh->opaque[0];
327 vec_add1 (a->new_segment_indices, s - sm->segments);
332 svm_fifo_segment_delete (svm_fifo_segment_main_t * sm,
333 svm_fifo_segment_private_t * s)
335 ssvm_delete (&s->ssvm);
336 clib_memset (s, 0xfe, sizeof (*s));
337 pool_put (sm->segments, s);
341 * Allocate fifo in svm segment
344 svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * fs,
345 u32 data_size_in_bytes,
346 svm_fifo_segment_freelist_t list_index)
348 ssvm_shared_header_t *sh;
349 svm_fifo_segment_header_t *fsh;
355 * 4K minimum. It's not likely that anything good will happen
356 * with a smaller FIFO.
358 if (data_size_in_bytes < FIFO_SEGMENT_MIN_FIFO_SIZE ||
359 data_size_in_bytes > FIFO_SEGMENT_MAX_FIFO_SIZE)
361 clib_warning ("fifo size out of range %d", data_size_in_bytes);
365 freelist_index = max_log2 (data_size_in_bytes)
366 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
369 ssvm_lock_non_recursive (sh, 1);
370 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
374 case FIFO_SEGMENT_RX_FREELIST:
375 case FIFO_SEGMENT_TX_FREELIST:
376 vec_validate_init_empty (fsh->free_fifos, freelist_index, 0);
377 f = fsh->free_fifos[freelist_index];
378 if (PREDICT_FALSE (!f))
380 oldheap = ssvm_push_heap (sh);
381 allocate_new_fifo_chunk (fsh, data_size_in_bytes,
382 FIFO_SEGMENT_ALLOC_CHUNK_SIZE);
383 ssvm_pop_heap (oldheap);
384 f = fsh->free_fifos[freelist_index];
386 if (PREDICT_TRUE (f != 0))
388 fsh->free_fifos[freelist_index] = f->next;
389 /* (re)initialize the fifo, as in svm_fifo_create */
390 clib_memset (f, 0, sizeof (*f));
391 svm_fifo_init (f, data_size_in_bytes);
395 case FIFO_SEGMENT_FREELIST_NONE:
399 clib_warning ("ignore bogus freelist %d", list_index);
403 /* Catch all that allocates just one fifo. Note: this can fail,
404 * in which case: create another segment */
405 oldheap = ssvm_push_heap (sh);
406 f = svm_fifo_create (data_size_in_bytes);
407 ssvm_pop_heap (oldheap);
408 if (PREDICT_FALSE (f == 0))
410 f->freelist_index = freelist_index;
413 /* If rx_freelist add to active fifos list. When cleaning up segment,
414 * we need a list of active sessions that should be disconnected. Since
415 * both rx and tx fifos keep pointers to the session, it's enough to track
417 if (list_index == FIFO_SEGMENT_RX_FREELIST)
421 fsh->fifos->prev = f;
422 f->next = fsh->fifos;
426 fsh->n_active_fifos++;
429 ssvm_unlock_non_recursive (sh);
434 svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
435 svm_fifo_segment_freelist_t list_index)
437 ssvm_shared_header_t *sh;
438 svm_fifo_segment_header_t *fsh;
441 ASSERT (f->refcnt > 0);
447 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
449 freelist_index = f->freelist_index;
451 ASSERT (freelist_index < vec_len (fsh->free_fifos));
453 ssvm_lock_non_recursive (sh, 2);
457 case FIFO_SEGMENT_RX_FREELIST:
458 /* Remove from active list */
460 f->prev->next = f->next;
462 fsh->fifos = f->next;
464 f->next->prev = f->prev;
465 /* Fall through: we add only rx fifos to active pool */
466 case FIFO_SEGMENT_TX_FREELIST:
467 /* Add to free list */
468 f->next = fsh->free_fifos[freelist_index];
470 fsh->free_fifos[freelist_index] = f;
472 case FIFO_SEGMENT_FREELIST_NONE:
476 clib_warning ("ignore bogus freelist %d", list_index);
482 f->master_session_index = ~0;
483 f->master_thread_index = ~0;
486 fsh->n_active_fifos--;
487 ssvm_unlock_non_recursive (sh);
491 svm_fifo_segment_main_init (svm_fifo_segment_main_t * sm, u64 baseva,
492 u32 timeout_in_seconds)
494 sm->next_baseva = baseva;
495 sm->timeout_in_seconds = timeout_in_seconds;
499 svm_fifo_segment_index (svm_fifo_segment_main_t * sm,
500 svm_fifo_segment_private_t * s)
502 return s - sm->segments;
506 * Retrieve svm segments pool. Used only for debug purposes.
508 svm_fifo_segment_private_t *
509 svm_fifo_segment_segments_pool (svm_fifo_segment_main_t * sm)
515 * Get number of active fifos
518 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment)
520 return fifo_segment->h->n_active_fifos;
524 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t * fifo_segment,
525 u32 fifo_size_in_bytes)
527 ssvm_shared_header_t *sh;
528 svm_fifo_segment_header_t *fsh;
531 u32 count = 0, rounded_data_size, freelist_index;
533 sh = fifo_segment->ssvm.sh;
534 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
536 /* Count all free fifos? */
537 if (fifo_size_in_bytes == ~0)
539 for (i = 0; i < vec_len (fsh->free_fifos); i++)
541 f = fsh->free_fifos[i];
554 rounded_data_size = (1 << (max_log2 (fifo_size_in_bytes)));
555 freelist_index = max_log2 (rounded_data_size)
556 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
558 if (freelist_index >= vec_len (fsh->free_fifos))
561 f = fsh->free_fifos[freelist_index];
574 svm_fifo_segment_info (svm_fifo_segment_private_t * seg, char **address,
577 if (ssvm_type (&seg->ssvm) == SSVM_SEGMENT_PRIVATE)
579 #if USE_DLMALLOC == 0
580 mheap_t *heap_header;
582 *address = pointer_to_uword (seg->ssvm.sh->heap);
583 heap_header = mheap_header (seg->ssvm.sh->heap);
584 *size = heap_header->max_size;
586 mspace_get_address_and_size (seg->ssvm.sh->heap, address, size);
591 *address = (char *) seg->ssvm.sh->ssvm_va;
592 *size = seg->ssvm.ssvm_size;
597 svm_fifo_segment_heap (svm_fifo_segment_private_t * seg)
599 return seg->ssvm.sh->heap;
603 format_svm_fifo_segment_type (u8 * s, va_list * args)
605 svm_fifo_segment_private_t *sp;
606 sp = va_arg (*args, svm_fifo_segment_private_t *);
607 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
609 if (st == SSVM_SEGMENT_PRIVATE)
610 s = format (s, "%s", "private-heap");
611 else if (st == SSVM_SEGMENT_MEMFD)
612 s = format (s, "%s", "memfd");
613 else if (st == SSVM_SEGMENT_SHM)
614 s = format (s, "%s", "shm");
616 s = format (s, "%s", "unknown");
621 * Segment format function
624 format_svm_fifo_segment (u8 * s, va_list * args)
626 svm_fifo_segment_private_t *sp
627 = va_arg (*args, svm_fifo_segment_private_t *);
628 int verbose __attribute__ ((unused)) = va_arg (*args, int);
629 svm_fifo_segment_header_t *fsh = sp->h;
634 indent = format_get_indent (s) + 2;
635 #if USE_DLMALLOC == 0
636 s = format (s, "%U segment heap: %U\n", format_white_space, indent,
637 format_mheap, svm_fifo_segment_heap (sp), verbose);
638 s = format (s, "%U segment has %u active fifos\n",
639 format_white_space, indent, svm_fifo_segment_num_fifos (sp));
642 for (i = 0; i < vec_len (fsh->free_fifos); i++)
644 f = fsh->free_fifos[i];
654 s = format (s, "%U%-5u Kb: %u free",
655 format_white_space, indent + 2,
656 1 << (i + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE) - 10),
663 * fd.io coding-style-patch-verification: ON
666 * eval: (c-set-style "gnu")