2 * Copyright (c) 2017-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 <vnet/session/segment_manager.h>
17 #include <vnet/session/session.h>
18 #include <vnet/session/application.h>
20 segment_manager_main_t segment_manager_main;
23 * Counter used to build segment names
25 static u32 segment_name_counter = 0;
28 * Default fifo and segment size. TODO config.
30 static u32 default_fifo_size = 1 << 12;
31 static u32 default_segment_size = 1 << 20;
32 static u32 default_app_evt_queue_size = 128;
34 segment_manager_properties_t *
35 segment_manager_properties_get (segment_manager_t * sm)
37 app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
38 return application_get_segment_manager_properties (app_wrk->app_index);
41 segment_manager_properties_t *
42 segment_manager_properties_init (segment_manager_properties_t * props)
44 props->add_segment_size = default_segment_size;
45 props->rx_fifo_size = default_fifo_size;
46 props->tx_fifo_size = default_fifo_size;
47 props->evt_q_size = default_app_evt_queue_size;
52 segment_manager_app_detached (segment_manager_t * sm)
54 return (sm->app_wrk_index == SEGMENT_MANAGER_INVALID_APP_INDEX);
58 segment_manager_app_detach (segment_manager_t * sm)
60 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
64 segment_manager_segment_index (segment_manager_t * sm,
65 svm_fifo_segment_private_t * seg)
67 return (seg - sm->segments);
71 * Remove segment without lock
74 segment_manager_del_segment (segment_manager_t * sm,
75 svm_fifo_segment_private_t * fs)
77 segment_manager_main_t *smm = &segment_manager_main;
79 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
81 clib_valloc_free (&smm->va_allocator, fs->ssvm.requested_va);
83 if (sm->app_wrk_index != SEGMENT_MANAGER_INVALID_APP_INDEX)
85 app_worker_t *app_wrk;
87 app_wrk = app_worker_get (sm->app_wrk_index);
88 segment_handle = segment_manager_segment_handle (sm, fs);
89 app_worker_del_segment_notify (app_wrk, segment_handle);
93 ssvm_delete (&fs->ssvm);
96 clib_memset (fs, 0xfb, sizeof (*fs));
97 pool_put (sm->segments, fs);
101 * Removes segment after acquiring writer lock
104 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
106 svm_fifo_segment_private_t *fs;
109 clib_rwlock_writer_lock (&sm->segments_rwlock);
110 fs = segment_manager_get_segment (sm, fs_index);
111 is_prealloc = svm_fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
112 if (is_prealloc && !segment_manager_app_detached (sm))
114 clib_rwlock_writer_unlock (&sm->segments_rwlock);
118 segment_manager_del_segment (sm, fs);
119 clib_rwlock_writer_unlock (&sm->segments_rwlock);
123 * Reads a segment from the segment manager's pool without lock
125 svm_fifo_segment_private_t *
126 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
128 return pool_elt_at_index (sm->segments, segment_index);
132 segment_manager_segment_handle (segment_manager_t * sm,
133 svm_fifo_segment_private_t * segment)
135 u32 segment_index = segment_manager_segment_index (sm, segment);
136 return (((u64) segment_manager_index (sm) << 32) | segment_index);
140 segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
143 *sm_index = segment_handle >> 32;
144 *segment_index = segment_handle & 0xFFFFFFFF;
147 svm_fifo_segment_private_t *
148 segment_manager_get_segment_w_handle (u64 segment_handle)
150 u32 sm_index, segment_index;
151 segment_manager_t *sm;
153 segment_manager_parse_segment_handle (segment_handle, &sm_index,
155 sm = segment_manager_get (sm_index);
156 if (!sm || pool_is_free_index (sm->segments, segment_index))
158 return pool_elt_at_index (sm->segments, segment_index);
162 * Reads a segment from the segment manager's pool and acquires reader lock
164 * Caller must drop the reader's lock by calling
165 * @ref segment_manager_segment_reader_unlock once it finishes working with
168 svm_fifo_segment_private_t *
169 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
171 clib_rwlock_reader_lock (&sm->segments_rwlock);
172 return pool_elt_at_index (sm->segments, segment_index);
176 segment_manager_segment_reader_unlock (segment_manager_t * sm)
178 ASSERT (sm->segments_rwlock->n_readers > 0);
179 clib_rwlock_reader_unlock (&sm->segments_rwlock);
183 segment_manager_segment_writer_unlock (segment_manager_t * sm)
185 clib_rwlock_writer_unlock (&sm->segments_rwlock);
189 * Adds segment to segment manager's pool
191 * If needed a writer's lock is acquired before allocating a new segment
192 * to avoid affecting any of the segments pool readers.
195 segment_manager_add_segment (segment_manager_t * sm, u32 segment_size)
197 segment_manager_main_t *smm = &segment_manager_main;
198 u32 rnd_margin = 128 << 10, seg_index = ~0, page_size;
199 segment_manager_properties_t *props;
200 uword baseva = (uword) ~ 0ULL, alloc_size;
201 svm_fifo_segment_private_t *seg;
205 props = segment_manager_properties_get (sm);
207 /* Not configured for addition of new segments and not first */
208 if (!props->add_segment && !segment_size)
210 clib_warning ("cannot allocate new segment");
211 return VNET_API_ERROR_INVALID_VALUE;
215 * Allocate fifo segment and lock if needed
217 if (vlib_num_workers ())
218 clib_rwlock_writer_lock (&sm->segments_rwlock);
220 pool_get_zero (sm->segments, seg);
223 * Initialize ssvm segment and svm fifo private header
225 segment_size = segment_size ? segment_size : props->add_segment_size;
226 page_size = clib_mem_get_page_size ();
227 segment_size = (segment_size + page_size - 1) & ~(page_size - 1);
228 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
230 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
231 alloc_size = (uword) segment_size + rnd_margin;
232 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
235 clib_warning ("out of space for segments");
236 pool_put (sm->segments, seg);
241 seg_name = format (0, "%s%c", "process-private-segment", 0);
243 seg->ssvm.ssvm_size = segment_size;
244 seg->ssvm.name = seg_name;
245 seg->ssvm.requested_va = baseva;
247 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
249 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
252 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
253 clib_valloc_free (&smm->va_allocator, baseva);
254 pool_put (sm->segments, seg);
258 svm_fifo_segment_init (seg);
261 * Save segment index before dropping lock, if any held
263 seg_index = seg - sm->segments;
267 if (vlib_num_workers ())
268 clib_rwlock_writer_unlock (&sm->segments_rwlock);
274 segment_manager_new ()
276 segment_manager_main_t *smm = &segment_manager_main;
277 segment_manager_t *sm;
278 pool_get (smm->segment_managers, sm);
279 clib_memset (sm, 0, sizeof (*sm));
280 clib_rwlock_init (&sm->segments_rwlock);
285 * Initializes segment manager based on options provided.
286 * Returns error if ssvm segment(s) allocation fails.
289 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
290 u32 prealloc_fifo_pairs)
292 u32 rx_fifo_size, tx_fifo_size, pair_size;
293 u32 rx_rounded_data_size, tx_rounded_data_size;
294 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
295 segment_manager_properties_t *props;
296 svm_fifo_segment_private_t *segment;
297 u32 approx_segment_count;
300 props = segment_manager_properties_get (sm);
301 first_seg_size = clib_max (first_seg_size, default_segment_size);
303 if (prealloc_fifo_pairs)
305 /* Figure out how many segments should be preallocated */
306 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
307 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
309 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
310 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
311 pair_size = rx_fifo_size + tx_fifo_size;
313 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
314 if (first_seg_size > approx_total_size)
315 max_seg_size = first_seg_size;
316 approx_segment_count = (approx_total_size + (max_seg_size - 1))
319 /* Allocate the segments */
320 for (i = 0; i < approx_segment_count + 1; i++)
322 seg_index = segment_manager_add_segment (sm, max_seg_size);
325 clib_warning ("Failed to preallocate segment %d", i);
329 segment = segment_manager_get_segment (sm, seg_index);
331 sm->event_queue = segment_manager_alloc_queue (segment, props);
333 svm_fifo_segment_preallocate_fifo_pairs (segment,
336 &prealloc_fifo_pairs);
337 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
338 if (prealloc_fifo_pairs == 0)
344 seg_index = segment_manager_add_segment (sm, first_seg_size);
347 clib_warning ("Failed to allocate segment");
350 segment = segment_manager_get_segment (sm, seg_index);
351 sm->event_queue = segment_manager_alloc_queue (segment, props);
358 segment_manager_has_fifos (segment_manager_t * sm)
360 svm_fifo_segment_private_t *seg;
364 segment_manager_foreach_segment_w_lock (seg, sm, ({
365 if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
366 && !(svm_fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
368 clib_warning ("segment %d has no fifos!",
369 segment_manager_segment_index (sm, seg));
372 if (svm_fifo_segment_has_fifos (seg))
374 segment_manager_segment_reader_unlock (sm);
384 * Initiate disconnects for all sessions 'owned' by a segment manager
387 segment_manager_del_sessions (segment_manager_t * sm)
389 svm_fifo_segment_private_t *fifo_segment;
390 session_handle_t *handles = 0, *handle;
394 ASSERT (pool_elts (sm->segments) != 0);
396 /* Across all fifo segments used by the server */
398 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
399 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
402 * Remove any residual sessions from the session lookup table
403 * Don't bother deleting the individual fifos, we're going to
404 * throw away the fifo segment in a minute.
408 session = session_get_if_valid (fifo->master_session_index,
409 fifo->master_thread_index);
411 vec_add1 (handles, session_handle (session));
415 /* Instead of removing the segment, test when cleaning up disconnected
416 * sessions if the segment can be removed.
421 vec_foreach (handle, handles)
422 session_close (session_get_from_handle (*handle));
426 * Removes segment manager.
428 * Since the fifos allocated in the segment keep backpointers to the sessions
429 * prior to removing the segment, we call session disconnect. This
430 * subsequently propagates into transport.
433 segment_manager_del (segment_manager_t * sm)
435 segment_manager_main_t *smm = &segment_manager_main;
436 svm_fifo_segment_private_t *fifo_segment;
438 ASSERT (!segment_manager_has_fifos (sm)
439 && segment_manager_app_detached (sm));
441 /* If we have empty preallocated segments that haven't been removed, remove
442 * them now. Apart from that, the first segment in the first segment manager
443 * is not removed when all fifos are removed. It can only be removed when
444 * the manager is explicitly deleted/detached by the app. */
445 clib_rwlock_writer_lock (&sm->segments_rwlock);
448 pool_foreach (fifo_segment, sm->segments, ({
449 segment_manager_del_segment (sm, fifo_segment);
453 clib_rwlock_writer_unlock (&sm->segments_rwlock);
455 clib_rwlock_free (&sm->segments_rwlock);
457 clib_memset (sm, 0xfe, sizeof (*sm));
458 pool_put (smm->segment_managers, sm);
462 segment_manager_init_del (segment_manager_t * sm)
464 segment_manager_app_detach (sm);
465 if (segment_manager_has_fifos (sm))
466 segment_manager_del_sessions (sm);
469 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
470 segment_manager_del (sm);
475 segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
476 u32 rx_fifo_size, u32 tx_fifo_size,
477 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
479 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
480 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
481 FIFO_SEGMENT_RX_FREELIST);
483 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
484 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
485 FIFO_SEGMENT_TX_FREELIST);
489 /* This would be very odd, but handle it... */
492 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
493 FIFO_SEGMENT_TX_FREELIST);
502 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
503 FIFO_SEGMENT_RX_FREELIST);
513 segment_manager_alloc_session_fifos (segment_manager_t * sm,
514 svm_fifo_t ** rx_fifo,
515 svm_fifo_t ** tx_fifo,
516 u32 * fifo_segment_index)
518 svm_fifo_segment_private_t *fifo_segment = 0;
519 int alloc_fail = 1, rv = 0, new_fs_index;
520 segment_manager_properties_t *props;
521 u8 added_a_segment = 0;
525 props = segment_manager_properties_get (sm);
528 * Find the first free segment to allocate the fifos in
532 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
533 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
537 /* Exit with lock held, drop it after notifying app */
550 ASSERT (rx_fifo && tx_fifo);
551 sm_index = segment_manager_index (sm);
552 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
553 (*tx_fifo)->segment_manager = sm_index;
554 (*rx_fifo)->segment_manager = sm_index;
555 (*tx_fifo)->segment_index = *fifo_segment_index;
556 (*rx_fifo)->segment_index = *fifo_segment_index;
560 app_worker_t *app_wrk;
561 segment_handle = segment_manager_segment_handle (sm, fifo_segment);
562 app_wrk = app_worker_get (sm->app_wrk_index);
563 rv = app_worker_add_segment_notify (app_wrk, segment_handle);
565 /* Drop the lock after app is notified */
566 segment_manager_segment_reader_unlock (sm);
571 * Allocation failed, see if we can add a new segment
573 if (props->add_segment)
577 clib_warning ("Added a segment, still can't allocate a fifo");
578 segment_manager_segment_reader_unlock (sm);
579 return SESSION_ERROR_NEW_SEG_NO_SPACE;
581 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
583 clib_warning ("Failed to add new segment");
584 return SESSION_ERROR_SEG_CREATE;
586 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
587 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
596 clib_warning ("Can't add new seg and no space to allocate fifos!");
597 return SESSION_ERROR_NO_SPACE;
602 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
604 svm_fifo_segment_private_t *fifo_segment;
605 segment_manager_t *sm;
608 if (!rx_fifo || !tx_fifo)
611 /* It's possible to have no segment manager if the session was removed
612 * as result of a detach. */
613 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
616 segment_index = rx_fifo->segment_index;
617 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
618 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
619 FIFO_SEGMENT_RX_FREELIST);
620 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
621 FIFO_SEGMENT_TX_FREELIST);
624 * Try to remove svm segment if it has no fifos. This can be done only if
625 * the segment is not the first in the segment manager or if it is first
626 * and it is not protected. Moreover, if the segment is first and the app
627 * has detached from the segment manager, remove the segment manager.
629 if (!svm_fifo_segment_has_fifos (fifo_segment))
631 segment_manager_segment_reader_unlock (sm);
633 /* Remove segment if it holds no fifos or first but not protected */
634 if (segment_index != 0 || !sm->first_is_protected)
635 segment_manager_lock_and_del_segment (sm, segment_index);
637 /* Remove segment manager if no sessions and detached from app */
638 if (segment_manager_app_detached (sm)
639 && !segment_manager_has_fifos (sm))
641 segment_manager_del (sm);
645 segment_manager_segment_reader_unlock (sm);
649 segment_manager_evt_q_expected_size (u32 q_len)
651 u32 fifo_evt_size, notif_q_size, q_hdrs;
652 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
654 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
655 notif_q_size = clib_max (16, q_len >> 4);
657 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
658 fifo_evt_ring_sz = q_len * fifo_evt_size;
659 session_ntf_ring_sz = notif_q_size * 256;
660 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
662 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
666 * Allocates shm queue in the first segment
668 * Must be called with lock held
671 segment_manager_alloc_queue (svm_fifo_segment_private_t * segment,
672 segment_manager_properties_t * props)
674 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
675 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
679 fifo_evt_size = sizeof (session_event_t);
680 notif_q_size = clib_max (16, props->evt_q_size >> 4);
682 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
683 {props->evt_q_size, fifo_evt_size, 0},
684 {notif_q_size, session_evt_size, 0}
687 cfg->consumer_pid = 0;
689 cfg->q_nitems = props->evt_q_size;
692 oldheap = ssvm_push_heap (segment->ssvm.sh);
693 q = svm_msg_q_alloc (cfg);
694 ssvm_pop_heap (oldheap);
696 if (props->use_mq_eventfd)
698 if (svm_msg_q_alloc_producer_eventfd (q))
699 clib_warning ("failed to alloc eventfd");
705 * Frees shm queue allocated in the first segment
708 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
710 svm_fifo_segment_private_t *segment;
711 ssvm_shared_header_t *sh;
714 ASSERT (!pool_is_free_index (sm->segments, 0));
716 segment = segment_manager_get_segment_w_lock (sm, 0);
717 sh = segment->ssvm.sh;
719 oldheap = ssvm_push_heap (sh);
721 ssvm_pop_heap (oldheap);
722 segment_manager_segment_reader_unlock (sm);
726 * Init segment vm address allocator
729 segment_manager_main_init (segment_manager_main_init_args_t * a)
731 segment_manager_main_t *sm = &segment_manager_main;
732 clib_valloc_chunk_t _ip, *ip = &_ip;
734 ip->baseva = a->baseva;
737 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
740 static clib_error_t *
741 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
742 vlib_cli_command_t * cmd)
744 segment_manager_main_t *smm = &segment_manager_main;
745 svm_fifo_segment_private_t *seg;
746 segment_manager_t *sm;
747 u8 show_segments = 0, verbose = 0;
753 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
755 if (unformat (input, "segments"))
757 else if (unformat (input, "verbose"))
760 return clib_error_return (0, "unknown input `%U'",
761 format_unformat_error, input);
763 vlib_cli_output (vm, "%d segment managers allocated",
764 pool_elts (smm->segment_managers));
765 if (verbose && pool_elts (smm->segment_managers))
767 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
771 pool_foreach (sm, smm->segment_managers, ({
772 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index (sm),
773 sm->app_wrk_index, pool_elts (sm->segments));
780 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
781 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
784 pool_foreach (sm, smm->segment_managers, ({
785 segment_manager_foreach_segment_w_lock (seg, sm, ({
786 svm_fifo_segment_info (seg, &address, &size);
787 active_fifos = svm_fifo_segment_num_fifos (seg);
788 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
789 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
790 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
791 seg, size >> 20ULL, active_fifos, free_fifos,
794 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
804 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
806 .path = "show segment-manager",
807 .short_help = "show segment-manager [segments][verbose]",
808 .function = segment_manager_show_fn,
813 * fd.io coding-style-patch-verification: ON
816 * eval: (c-set-style "gnu")