2 * Copyright (c) 2016 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>
18 svm_fifo_segment_main_t svm_fifo_segment_main;
21 allocate_new_fifo_chunk (svm_fifo_segment_header_t * fsh,
22 u32 data_size_in_bytes, int chunk_size)
27 u32 rounded_data_size;
31 rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
32 freelist_index = max_log2 (rounded_data_size)
33 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
35 /* Calculate space requirement $$$ round-up data_size_in_bytes */
36 size = (sizeof (*f) + rounded_data_size) * chunk_size;
38 /* Allocate fifo space. May fail. */
39 fifo_space = clib_mem_alloc_aligned_at_offset
40 (size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
41 0 /* os_out_of_memory */ );
47 /* Carve fifo space */
48 f = (svm_fifo_t *) fifo_space;
49 for (i = 0; i < chunk_size; i++)
51 f->freelist_index = freelist_index;
52 f->next = fsh->free_fifos[freelist_index];
53 fsh->free_fifos[freelist_index] = f;
54 fifo_space += sizeof (*f) + rounded_data_size;
55 f = (svm_fifo_t *) fifo_space;
60 * Pre-allocates fifo pairs in fifo segment
62 * The number of fifos pre-allocated is the minimum of the requested number
63 * of pairs and the maximum number that fit within the segment. If the maximum
64 * is hit, the number of fifo pairs requested is updated by subtracting the
65 * number of fifos that have been successfully allocated.
68 svm_fifo_segment_preallocate_fifo_pairs (svm_fifo_segment_private_t * s,
69 u32 rx_fifo_size, u32 tx_fifo_size,
72 u32 rx_rounded_data_size, tx_rounded_data_size, pair_size;
73 u32 rx_fifos_size, tx_fifos_size, pairs_to_allocate;
74 int rx_freelist_index, tx_freelist_index;
75 ssvm_shared_header_t *sh = s->ssvm.sh;
76 svm_fifo_segment_header_t *fsh = s->h;
77 u8 *rx_fifo_space, *tx_fifo_space;
78 uword space_available;
84 if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
87 if (rx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
88 rx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
90 clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
94 if (tx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
95 tx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
97 clib_warning ("tx fifo_size out of range %d", rx_fifo_size);
101 rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
102 rx_freelist_index = max_log2 (rx_fifo_size)
103 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
104 tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
105 tx_freelist_index = max_log2 (tx_fifo_size)
106 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
108 /* Calculate space requirements */
109 pair_size = 2 * sizeof (*f) + rx_rounded_data_size + tx_rounded_data_size;
110 #if USE_DLMALLOC == 0
111 space_available = s->ssvm.ssvm_size - mheap_bytes (sh->heap);
113 space_available = s->ssvm.ssvm_size - mspace_usable_size (sh->heap);
116 pairs_to_allocate = clib_min (space_available / pair_size, *n_fifo_pairs);
117 rx_fifos_size = (sizeof (*f) + rx_rounded_data_size) * pairs_to_allocate;
118 tx_fifos_size = (sizeof (*f) + tx_rounded_data_size) * pairs_to_allocate;
120 vec_validate_init_empty (fsh->free_fifos,
121 clib_max (rx_freelist_index, tx_freelist_index),
124 oldheap = ssvm_push_heap (sh);
125 /* Allocate rx fifo space. May fail. */
126 rx_fifo_space = clib_mem_alloc_aligned_at_offset
127 (rx_fifos_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
128 0 /* os_out_of_memory */ );
131 tx_fifo_space = clib_mem_alloc_aligned_at_offset
132 (tx_fifos_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
133 0 /* os_out_of_memory */ );
135 /* Make sure it worked. Clean up if it didn't... */
136 if (rx_fifo_space == 0 || tx_fifo_space == 0)
139 clib_mem_free (rx_fifo_space);
141 clib_warning ("rx fifo preallocation failure: size %d npairs %d",
142 rx_fifo_size, *n_fifo_pairs);
145 clib_mem_free (tx_fifo_space);
147 clib_warning ("tx fifo preallocation failure: size %d nfifos %d",
148 tx_fifo_size, *n_fifo_pairs);
149 ssvm_pop_heap (oldheap);
153 /* Carve rx fifo space */
154 f = (svm_fifo_t *) rx_fifo_space;
155 for (i = 0; i < pairs_to_allocate; i++)
157 f->freelist_index = rx_freelist_index;
158 f->next = fsh->free_fifos[rx_freelist_index];
159 fsh->free_fifos[rx_freelist_index] = f;
160 rx_fifo_space += sizeof (*f) + rx_rounded_data_size;
161 f = (svm_fifo_t *) rx_fifo_space;
163 /* Carve tx fifo space */
164 f = (svm_fifo_t *) tx_fifo_space;
165 for (i = 0; i < pairs_to_allocate; i++)
167 f->freelist_index = tx_freelist_index;
168 f->next = fsh->free_fifos[tx_freelist_index];
169 fsh->free_fifos[tx_freelist_index] = f;
170 tx_fifo_space += sizeof (*f) + tx_rounded_data_size;
171 f = (svm_fifo_t *) tx_fifo_space;
174 /* Account for the pairs allocated */
175 *n_fifo_pairs -= pairs_to_allocate;
176 ssvm_pop_heap (oldheap);
180 * Initialize svm fifo segment shared header
183 svm_fifo_segment_init (svm_fifo_segment_private_t * s)
185 svm_fifo_segment_header_t *fsh;
186 ssvm_shared_header_t *sh;
190 oldheap = ssvm_push_heap (sh);
192 fsh = clib_mem_alloc (sizeof (*fsh));
193 clib_memset (fsh, 0, sizeof (*fsh));
194 s->h = sh->opaque[0] = fsh;
196 ssvm_pop_heap (oldheap);
203 * Create an svm fifo segment and initialize as master
206 svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
208 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
209 svm_fifo_segment_private_t *s;
212 /* Allocate a fresh segment */
213 pool_get (sm->segments, s);
214 clib_memset (s, 0, sizeof (*s));
216 s->ssvm.ssvm_size = a->segment_size;
217 s->ssvm.i_am_master = 1;
218 s->ssvm.my_pid = getpid ();
219 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
220 s->ssvm.requested_va = sm->next_baseva;
222 if ((rv = ssvm_master_init (&s->ssvm, a->segment_type)))
224 pool_put (sm->segments, s);
228 /* Note: requested_va updated due to seg base addr randomization */
229 sm->next_baseva = s->ssvm.sh->ssvm_va + a->segment_size;
231 svm_fifo_segment_init (s);
232 vec_add1 (a->new_segment_indices, s - sm->segments);
237 * Create an svm fifo segment in process-private memory
240 svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
242 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
243 svm_fifo_segment_private_t *s;
244 ssvm_shared_header_t *sh;
247 u32 pagesize = clib_mem_get_page_size ();
249 pool_get (sm->segments, s);
250 clib_memset (s, 0, sizeof (*s));
252 rnd_size = (a->segment_size + (pagesize - 1)) & ~pagesize;
254 #if USE_DLMALLOC == 0
255 heap = mheap_alloc (0, rnd_size);
258 clib_unix_warning ("mheap alloc");
259 pool_put (sm->segments, s);
263 mheap_t *heap_header;
264 heap_header = mheap_header (heap);
265 heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
268 heap = create_mspace (rnd_size, 1 /* locked */ );
271 s->ssvm.ssvm_size = rnd_size;
272 s->ssvm.i_am_master = 1;
273 s->ssvm.my_pid = getpid ();
274 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
275 s->ssvm.requested_va = ~0;
277 /* Allocate a [sic] shared memory header, in process memory... */
278 sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
281 clib_memset (sh, 0, sizeof (*sh));
284 svm_fifo_segment_init (s);
285 vec_add1 (a->new_segment_indices, s - sm->segments);
291 * Attach as slave to an svm fifo segment
294 svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
296 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
297 svm_fifo_segment_private_t *s;
300 /* Allocate a fresh segment */
301 pool_get (sm->segments, s);
302 clib_memset (s, 0, sizeof (*s));
304 s->ssvm.ssvm_size = a->segment_size;
305 s->ssvm.my_pid = getpid ();
306 s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
307 s->ssvm.requested_va = sm->next_baseva;
308 if (a->segment_type == SSVM_SEGMENT_MEMFD)
309 s->ssvm.fd = a->memfd_fd;
311 s->ssvm.attach_timeout = sm->timeout_in_seconds;
313 if ((rv = ssvm_slave_init (&s->ssvm, a->segment_type)))
315 _vec_len (s) = vec_len (s) - 1;
319 /* Fish the segment header */
320 s->h = s->ssvm.sh->opaque[0];
322 vec_add1 (a->new_segment_indices, s - sm->segments);
327 svm_fifo_segment_delete (svm_fifo_segment_private_t * s)
329 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
331 ssvm_delete (&s->ssvm);
332 clib_memset (s, 0xfe, sizeof (*s));
333 pool_put (sm->segments, s);
337 * Allocate fifo in svm segment
340 svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
341 u32 data_size_in_bytes,
342 svm_fifo_segment_freelist_t list_index)
344 ssvm_shared_header_t *sh;
345 svm_fifo_segment_header_t *fsh;
351 * 4K minimum. It's not likely that anything good will happen
352 * with a smaller FIFO.
354 if (data_size_in_bytes < FIFO_SEGMENT_MIN_FIFO_SIZE ||
355 data_size_in_bytes > FIFO_SEGMENT_MAX_FIFO_SIZE)
357 clib_warning ("fifo size out of range %d", data_size_in_bytes);
361 freelist_index = max_log2 (data_size_in_bytes)
362 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
365 ssvm_lock_non_recursive (sh, 1);
366 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
370 case FIFO_SEGMENT_RX_FREELIST:
371 case FIFO_SEGMENT_TX_FREELIST:
372 vec_validate_init_empty (fsh->free_fifos, freelist_index, 0);
373 f = fsh->free_fifos[freelist_index];
374 if (PREDICT_FALSE (!f))
376 /* Preallocated and no fifo left. Don't even try */
377 if (fsh->flags & FIFO_SEGMENT_F_IS_PREALLOCATED)
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 f->nitems = data_size_in_bytes;
392 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
393 f->ct_session_index = SVM_FIFO_INVALID_SESSION_INDEX;
395 f->freelist_index = freelist_index;
399 case FIFO_SEGMENT_FREELIST_NONE:
403 clib_warning ("ignore bogus freelist %d", list_index);
407 /* Catch all that allocates just one fifo. Note: this can fail,
408 * in which case: create another segment */
409 oldheap = ssvm_push_heap (sh);
410 f = svm_fifo_create (data_size_in_bytes);
411 ssvm_pop_heap (oldheap);
412 if (PREDICT_FALSE (f == 0))
414 f->freelist_index = freelist_index;
417 /* If rx_freelist add to active fifos list. When cleaning up segment,
418 * we need a list of active sessions that should be disconnected. Since
419 * both rx and tx fifos keep pointers to the session, it's enough to track
421 if (list_index == FIFO_SEGMENT_RX_FREELIST)
425 fsh->fifos->prev = f;
426 f->next = fsh->fifos;
430 fsh->n_active_fifos++;
433 ssvm_unlock_non_recursive (sh);
438 svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
439 svm_fifo_segment_freelist_t list_index)
441 ssvm_shared_header_t *sh;
442 svm_fifo_segment_header_t *fsh;
446 ASSERT (f->refcnt > 0);
452 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
454 freelist_index = f->freelist_index;
456 ASSERT (freelist_index < vec_len (fsh->free_fifos));
458 ssvm_lock_non_recursive (sh, 2);
459 oldheap = ssvm_push_heap (sh);
463 case FIFO_SEGMENT_RX_FREELIST:
464 /* Remove from active list */
466 f->prev->next = f->next;
468 fsh->fifos = f->next;
470 f->next->prev = f->prev;
471 /* Fall through: we add only rx fifos to active pool */
472 case FIFO_SEGMENT_TX_FREELIST:
473 /* Add to free list */
474 f->next = fsh->free_fifos[freelist_index];
476 fsh->free_fifos[freelist_index] = f;
478 case FIFO_SEGMENT_FREELIST_NONE:
482 clib_warning ("ignore bogus freelist %d", list_index);
488 f->master_session_index = ~0;
489 f->master_thread_index = ~0;
492 fsh->n_active_fifos--;
493 ssvm_pop_heap (oldheap);
494 ssvm_unlock_non_recursive (sh);
498 svm_fifo_segment_main_init (u64 baseva, u32 timeout_in_seconds)
500 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
502 sm->next_baseva = baseva;
503 sm->timeout_in_seconds = timeout_in_seconds;
507 svm_fifo_segment_index (svm_fifo_segment_private_t * s)
509 return s - svm_fifo_segment_main.segments;
513 * Retrieve svm segments pool. Used only for debug purposes.
515 svm_fifo_segment_private_t *
516 svm_fifo_segment_segments_pool (void)
518 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
523 * Get number of active fifos
526 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment)
528 return fifo_segment->h->n_active_fifos;
532 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t * fifo_segment,
533 u32 fifo_size_in_bytes)
535 ssvm_shared_header_t *sh;
536 svm_fifo_segment_header_t *fsh;
539 u32 count = 0, rounded_data_size, freelist_index;
541 sh = fifo_segment->ssvm.sh;
542 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
544 /* Count all free fifos? */
545 if (fifo_size_in_bytes == ~0)
547 for (i = 0; i < vec_len (fsh->free_fifos); i++)
549 f = fsh->free_fifos[i];
562 rounded_data_size = (1 << (max_log2 (fifo_size_in_bytes)));
563 freelist_index = max_log2 (rounded_data_size)
564 - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
566 if (freelist_index >= vec_len (fsh->free_fifos))
569 f = fsh->free_fifos[freelist_index];
582 svm_fifo_segment_info (svm_fifo_segment_private_t * seg, uword * address,
585 if (ssvm_type (&seg->ssvm) == SSVM_SEGMENT_PRIVATE)
587 #if USE_DLMALLOC == 0
588 mheap_t *heap_header;
590 *address = pointer_to_uword (seg->ssvm.sh->heap);
591 heap_header = mheap_header (seg->ssvm.sh->heap);
592 *size = heap_header->max_size;
594 mspace_get_address_and_size (seg->ssvm.sh->heap,
595 (unsigned long long *) address,
596 (unsigned long long *) size);
601 *address = seg->ssvm.sh->ssvm_va;
602 *size = seg->ssvm.ssvm_size;
607 svm_fifo_segment_heap (svm_fifo_segment_private_t * seg)
609 return seg->ssvm.sh->heap;
613 format_svm_fifo_segment_type (u8 * s, va_list * args)
615 svm_fifo_segment_private_t *sp;
616 sp = va_arg (*args, svm_fifo_segment_private_t *);
617 ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
619 if (st == SSVM_SEGMENT_PRIVATE)
620 s = format (s, "%s", "private-heap");
621 else if (st == SSVM_SEGMENT_MEMFD)
622 s = format (s, "%s", "memfd");
623 else if (st == SSVM_SEGMENT_SHM)
624 s = format (s, "%s", "shm");
626 s = format (s, "%s", "unknown");
631 * Segment format function
634 format_svm_fifo_segment (u8 * s, va_list * args)
636 svm_fifo_segment_private_t *sp
637 = va_arg (*args, svm_fifo_segment_private_t *);
638 int verbose __attribute__ ((unused)) = va_arg (*args, int);
639 svm_fifo_segment_header_t *fsh = sp->h;
644 indent = format_get_indent (s) + 2;
645 #if USE_DLMALLOC == 0
646 s = format (s, "%U segment heap: %U\n", format_white_space, indent,
647 format_mheap, svm_fifo_segment_heap (sp), verbose);
648 s = format (s, "%U segment has %u active fifos\n",
649 format_white_space, indent, svm_fifo_segment_num_fifos (sp));
652 for (i = 0; i < vec_len (fsh->free_fifos); i++)
654 f = fsh->free_fifos[i];
664 s = format (s, "%U%-5u Kb: %u free",
665 format_white_space, indent + 2,
666 1 << (i + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE) - 10),
673 * fd.io coding-style-patch-verification: ON
676 * eval: (c-set-style "gnu")