2 * Copyright (c) 2017 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 <vnet/session/segment_manager.h>
17 #include <vnet/session/session.h>
18 #include <vnet/session/application.h>
21 * Counter used to build segment names
23 u32 segment_name_counter = 0;
26 * Pool of segment managers
28 segment_manager_t *segment_managers = 0;
31 * Pool of segment manager properties
33 static segment_manager_properties_t *segment_manager_properties_pool;
36 * Process private segment index
38 u32 *private_segment_indices;
41 * Default fifo and segment size. TODO config.
43 u32 default_fifo_size = 1 << 16;
44 u32 default_segment_size = 1 << 20;
46 segment_manager_properties_t *
47 segment_manager_properties_alloc (void)
49 segment_manager_properties_t *props;
50 pool_get (segment_manager_properties_pool, props);
51 memset (props, 0, sizeof (*props));
56 segment_manager_properties_free (segment_manager_properties_t * props)
58 pool_put (segment_manager_properties_pool, props);
59 memset (props, 0xFB, sizeof (*props));
62 segment_manager_properties_t *
63 segment_manager_properties_get (u32 smp_index)
65 if (pool_is_free_index (segment_manager_properties_pool, smp_index))
67 return pool_elt_at_index (segment_manager_properties_pool, smp_index);
71 segment_manager_properties_index (segment_manager_properties_t * p)
73 return p - segment_manager_properties_pool;
77 segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size)
79 svm_fifo_segment_private_t *s;
80 s = svm_fifo_segment_get_segment (index);
81 *name = s->h->segment_name;
82 *size = s->ssvm.ssvm_size;
86 session_manager_add_segment_i (segment_manager_t * sm, u32 segment_size,
89 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
90 segment_manager_properties_t *props;
93 memset (ca, 0, sizeof (*ca));
94 props = segment_manager_properties_get (sm->properties_index);
95 if (!props->use_private_segment)
97 ca->segment_name = (char *) segment_name;
98 ca->segment_size = segment_size;
99 ca->rx_fifo_size = props->rx_fifo_size;
100 ca->tx_fifo_size = props->tx_fifo_size;
101 ca->preallocated_fifo_pairs = props->preallocated_fifo_pairs;
103 rv = svm_fifo_segment_create (ca);
106 clib_warning ("svm_fifo_segment_create ('%s', %d) failed",
107 ca->segment_name, ca->segment_size);
108 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
113 u32 rx_fifo_size, tx_fifo_size, rx_rounded_data_size,
114 tx_rounded_data_size;
115 u32 approx_segment_count;
116 u64 approx_total_size;
118 ca->segment_name = "process-private-segment";
119 ca->segment_size = ~0;
120 ca->rx_fifo_size = props->rx_fifo_size;
121 ca->tx_fifo_size = props->tx_fifo_size;
122 ca->preallocated_fifo_pairs = props->preallocated_fifo_pairs;
123 ca->private_segment_count = props->private_segment_count;
124 ca->private_segment_size = props->private_segment_size;
126 /* Default to a small private segment */
127 if (ca->private_segment_size == 0)
128 ca->private_segment_size = 128 << 20;
130 /* Calculate space requirements */
131 rx_rounded_data_size = (1 << (max_log2 (ca->rx_fifo_size)));
132 tx_rounded_data_size = (1 << (max_log2 (ca->tx_fifo_size)));
134 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
135 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
137 approx_total_size = (u64) ca->preallocated_fifo_pairs
138 * (rx_fifo_size + tx_fifo_size);
139 approx_segment_count =
141 (ca->private_segment_size - 1)) / (u64) ca->private_segment_size;
143 /* The user asked us to figure it out... */
144 if (ca->private_segment_count == 0)
146 ca->private_segment_count = approx_segment_count;
148 /* Follow directions, but issue a warning */
149 else if (approx_segment_count != ca->private_segment_count)
152 ("Honoring segment count %u, but calculated count was %u",
153 ca->private_segment_count, approx_segment_count);
156 if (svm_fifo_segment_create_process_private (ca))
157 clib_warning ("Failed to create process private segment");
159 ASSERT (vec_len (ca->new_segment_indices));
161 vec_append (sm->segment_indices, ca->new_segment_indices);
162 vec_free (ca->new_segment_indices);
167 session_manager_add_segment (segment_manager_t * sm)
169 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
170 segment_manager_properties_t *props;
171 u32 add_segment_size;
175 memset (ca, 0, sizeof (*ca));
176 props = segment_manager_properties_get (sm->properties_index);
177 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
178 add_segment_size = props->add_segment_size ?
179 props->add_segment_size : default_segment_size;
181 rv = session_manager_add_segment_i (sm, add_segment_size, segment_name);
182 vec_free (segment_name);
187 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size)
192 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
193 rv = session_manager_add_segment_i (sm, segment_size, segment_name);
194 vec_free (segment_name);
199 segment_manager_new ()
201 segment_manager_t *sm;
202 pool_get (segment_managers, sm);
203 memset (sm, 0, sizeof (*sm));
208 * Initializes segment manager based on options provided.
209 * Returns error if svm segment allocation fails.
212 segment_manager_init (segment_manager_t * sm, u32 props_index,
217 /* app allocates these */
218 sm->properties_index = props_index;
219 first_seg_size = first_seg_size > 0 ? first_seg_size : default_segment_size;
220 rv = session_manager_add_first_segment (sm, first_seg_size);
223 clib_warning ("Failed to allocate segment");
227 clib_spinlock_init (&sm->lockp);
232 segment_manager_has_fifos (segment_manager_t * sm)
234 svm_fifo_segment_private_t *segment;
237 for (i = 0; i < vec_len (sm->segment_indices); i++)
239 segment = svm_fifo_segment_get_segment (sm->segment_indices[i]);
240 if (CLIB_DEBUG && i && !svm_fifo_segment_has_fifos (segment)
241 && !(segment->h->flags & FIFO_SEGMENT_F_IS_PREALLOCATED))
242 clib_warning ("segment %d has no fifos!", sm->segment_indices[i]);
243 if (svm_fifo_segment_has_fifos (segment))
250 segment_manager_app_detached (segment_manager_t * sm)
252 return (sm->app_index == SEGMENT_MANAGER_INVALID_APP_INDEX);
256 segment_manager_app_detach (segment_manager_t * sm)
258 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
262 segment_manager_del_segment (segment_manager_t * sm, u32 segment_index)
264 svm_fifo_segment_private_t *fifo_segment;
265 u32 svm_segment_index;
266 clib_spinlock_lock (&sm->lockp);
267 svm_segment_index = sm->segment_indices[segment_index];
268 fifo_segment = svm_fifo_segment_get_segment (svm_segment_index);
270 || ((fifo_segment->h->flags & FIFO_SEGMENT_F_IS_PREALLOCATED)
271 && !segment_manager_app_detached (sm)))
273 clib_spinlock_unlock (&sm->lockp);
276 svm_fifo_segment_delete (fifo_segment);
277 vec_del1 (sm->segment_indices, segment_index);
278 clib_spinlock_unlock (&sm->lockp);
282 * Initiate disconnects for all sessions 'owned' by a segment manager
285 segment_manager_del_sessions (segment_manager_t * sm)
288 svm_fifo_segment_private_t *fifo_segment;
291 ASSERT (vec_len (sm->segment_indices));
293 /* Across all fifo segments used by the server */
294 for (j = 0; j < vec_len (sm->segment_indices); j++)
296 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
297 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
300 * Remove any residual sessions from the session lookup table
301 * Don't bother deleting the individual fifos, we're going to
302 * throw away the fifo segment in a minute.
306 u32 session_index, thread_index;
307 stream_session_t *session;
309 session_index = fifo->master_session_index;
310 thread_index = fifo->master_thread_index;
311 session = session_get (session_index, thread_index);
313 /* Instead of directly removing the session call disconnect */
314 if (session->session_state != SESSION_STATE_CLOSED)
316 session->session_state = SESSION_STATE_CLOSED;
317 session_send_session_evt_to_thread (session_handle
319 FIFO_EVENT_DISCONNECT,
325 /* Instead of removing the segment, test when cleaning up disconnected
326 * sessions if the segment can be removed.
332 * Removes segment manager.
334 * Since the fifos allocated in the segment keep backpointers to the sessions
335 * prior to removing the segment, we call session disconnect. This
336 * subsequently propagates into transport.
339 segment_manager_del (segment_manager_t * sm)
343 ASSERT (!segment_manager_has_fifos (sm)
344 && segment_manager_app_detached (sm));
346 /* If we have empty preallocated segments that haven't been removed, remove
347 * them now. Apart from that, the first segment in the first segment manager
348 * is not removed when all fifos are removed. It can only be removed when
349 * the manager is explicitly deleted/detached by the app. */
350 for (i = vec_len (sm->segment_indices) - 1; i >= 0; i--)
354 svm_fifo_segment_private_t *segment;
355 segment = svm_fifo_segment_get_segment (sm->segment_indices[i]);
356 ASSERT (!svm_fifo_segment_has_fifos (segment));
358 segment_manager_del_segment (sm, i);
360 clib_spinlock_free (&sm->lockp);
362 memset (sm, 0xfe, sizeof (*sm));
363 pool_put (segment_managers, sm);
367 segment_manager_init_del (segment_manager_t * sm)
369 segment_manager_app_detach (sm);
370 if (segment_manager_has_fifos (sm))
371 segment_manager_del_sessions (sm);
374 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
375 segment_manager_del (sm);
380 segment_manager_alloc_session_fifos (segment_manager_t * sm,
381 svm_fifo_t ** server_rx_fifo,
382 svm_fifo_t ** server_tx_fifo,
383 u32 * fifo_segment_index)
385 svm_fifo_segment_private_t *fifo_segment;
386 segment_manager_properties_t *props;
387 u32 fifo_size, sm_index;
388 u8 added_a_segment = 0;
391 ASSERT (vec_len (sm->segment_indices));
393 /* Make sure we don't have multiple threads trying to allocate segments
394 * at the same time. */
395 clib_spinlock_lock (&sm->lockp);
397 /* Allocate svm fifos */
398 props = segment_manager_properties_get (sm->properties_index);
400 for (i = 0; i < vec_len (sm->segment_indices); i++)
402 *fifo_segment_index = sm->segment_indices[i];
403 fifo_segment = svm_fifo_segment_get_segment (*fifo_segment_index);
405 fifo_size = props->rx_fifo_size;
406 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
408 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
409 FIFO_SEGMENT_RX_FREELIST);
411 fifo_size = props->tx_fifo_size;
412 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
414 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
415 FIFO_SEGMENT_TX_FREELIST);
417 if (*server_rx_fifo == 0)
419 /* This would be very odd, but handle it... */
420 if (*server_tx_fifo != 0)
422 svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo,
423 FIFO_SEGMENT_TX_FREELIST);
428 if (*server_tx_fifo == 0)
430 if (*server_rx_fifo != 0)
432 svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo,
433 FIFO_SEGMENT_RX_FREELIST);
441 /* See if we're supposed to create another segment */
442 if (*server_rx_fifo == 0)
444 if (props->add_segment && !props->use_private_segment)
448 clib_warning ("added a segment, still can't allocate a fifo");
449 clib_spinlock_unlock (&sm->lockp);
450 return SESSION_ERROR_NEW_SEG_NO_SPACE;
453 if (session_manager_add_segment (sm))
455 clib_spinlock_unlock (&sm->lockp);
456 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
464 clib_warning ("No space to allocate fifos!");
465 clib_spinlock_unlock (&sm->lockp);
466 return SESSION_ERROR_NO_SPACE;
470 /* Backpointers to segment manager */
471 sm_index = segment_manager_index (sm);
472 (*server_tx_fifo)->segment_manager = sm_index;
473 (*server_rx_fifo)->segment_manager = sm_index;
475 clib_spinlock_unlock (&sm->lockp);
478 return application_add_segment_notify (sm->app_index,
479 *fifo_segment_index);
485 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
486 svm_fifo_t * tx_fifo)
488 segment_manager_t *sm;
489 svm_fifo_segment_private_t *fifo_segment;
490 u32 i, segment_index = ~0;
493 sm = segment_manager_get_if_valid (rx_fifo->segment_manager);
495 /* It's possible to have no segment manager if the session was removed
496 * as result of a detach. */
500 fifo_segment = svm_fifo_segment_get_segment (svm_segment_index);
501 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
502 FIFO_SEGMENT_RX_FREELIST);
503 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
504 FIFO_SEGMENT_TX_FREELIST);
507 * Try to remove svm segment if it has no fifos. This can be done only if
508 * the segment is not the first in the segment manager or if it is first
509 * and it is not protected. Moreover, if the segment is first and the app
510 * has detached from the segment manager, remove the segment manager.
512 if (!svm_fifo_segment_has_fifos (fifo_segment))
514 is_first = sm->segment_indices[0] == svm_segment_index;
516 /* Remove segment if it holds no fifos or first but not protected */
517 if (!is_first || !sm->first_is_protected)
519 /* Find the segment manager segment index */
520 for (i = 0; i < vec_len (sm->segment_indices); i++)
521 if (sm->segment_indices[i] == svm_segment_index)
526 ASSERT (segment_index != (u32) ~ 0);
527 segment_manager_del_segment (sm, segment_index);
530 /* Remove segment manager if no sessions and detached from app */
531 if (segment_manager_app_detached (sm)
532 && !segment_manager_has_fifos (sm))
533 segment_manager_del (sm);
538 * Allocates shm queue in the first segment
540 unix_shared_memory_queue_t *
541 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
543 ssvm_shared_header_t *sh;
544 svm_fifo_segment_private_t *segment;
545 unix_shared_memory_queue_t *q;
548 ASSERT (sm->segment_indices != 0);
550 segment = svm_fifo_segment_get_segment (sm->segment_indices[0]);
551 sh = segment->ssvm.sh;
553 oldheap = ssvm_push_heap (sh);
554 q = unix_shared_memory_queue_init (queue_size,
555 sizeof (session_fifo_event_t),
556 0 /* consumer pid */ ,
557 0 /* signal when queue non-empty */ );
558 ssvm_pop_heap (oldheap);
563 * Frees shm queue allocated in the first segment
566 segment_manager_dealloc_queue (segment_manager_t * sm,
567 unix_shared_memory_queue_t * q)
569 ssvm_shared_header_t *sh;
570 svm_fifo_segment_private_t *segment;
573 ASSERT (sm->segment_indices != 0);
575 segment = svm_fifo_segment_get_segment (sm->segment_indices[0]);
576 sh = segment->ssvm.sh;
578 oldheap = ssvm_push_heap (sh);
579 unix_shared_memory_queue_free (q);
580 ssvm_pop_heap (oldheap);
583 static clib_error_t *
584 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
585 vlib_cli_command_t * cmd)
587 svm_fifo_segment_private_t *segments, *seg;
588 segment_manager_t *sm;
589 u8 show_segments = 0, verbose = 0, *name;
595 mheap_t *heap_header;
597 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
599 if (unformat (input, "segments"))
601 else if (unformat (input, "verbose"))
604 return clib_error_return (0, "unknown input `%U'",
605 format_unformat_error, input);
607 vlib_cli_output (vm, "%d segment managers allocated",
608 pool_elts (segment_managers));
609 if (verbose && pool_elts (segment_managers))
611 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
615 pool_foreach (sm, segment_managers, ({
616 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index(sm),
617 sm->app_index, vec_len (sm->segment_indices));
624 segments = svm_fifo_segment_segments_pool ();
625 vlib_cli_output (vm, "%d svm fifo segments allocated",
626 pool_elts (segments));
627 vlib_cli_output (vm, "%-20s%=12s%=16s%=16s%=16s", "Name",
628 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
631 pool_foreach (seg, segments, ({
632 if (seg->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
634 address = pointer_to_uword (seg->ssvm.sh->heap);
635 if (seg->h->flags & FIFO_SEGMENT_F_IS_MAIN_HEAP)
636 name = format (0, "main heap");
638 name = format (0, "private heap");
639 heap_header = mheap_header (seg->ssvm.sh->heap);
640 size = heap_header->max_size;
644 address = seg->ssvm.sh->ssvm_va;
645 size = seg->ssvm.ssvm_size;
646 name = seg->ssvm.sh->name;
648 active_fifos = svm_fifo_segment_num_fifos (seg);
649 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
650 vlib_cli_output (vm, "%-20v%=16llu%=16u%=16u%16llx",
651 name, size >> 20ULL, active_fifos, free_fifos,
654 vlib_cli_output (vm, "%U",
655 format_svm_fifo_segment, seg, verbose);
656 if (seg->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
666 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
668 .path = "show segment-manager",
669 .short_help = "show segment-manager [segments][verbose]",
670 .function = segment_manager_show_fn,
675 * fd.io coding-style-patch-verification: ON
678 * eval: (c-set-style "gnu")