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)
80 clib_valloc_free (&smm->va_allocator, fs->ssvm.requested_va);
82 ssvm_delete (&fs->ssvm);
85 clib_memset (fs, 0xfb, sizeof (*fs));
86 pool_put (sm->segments, fs);
90 * Removes segment after acquiring writer lock
93 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
95 svm_fifo_segment_private_t *fs;
98 clib_rwlock_writer_lock (&sm->segments_rwlock);
99 fs = segment_manager_get_segment (sm, fs_index);
100 is_prealloc = svm_fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
101 if (is_prealloc && !segment_manager_app_detached (sm))
103 clib_rwlock_writer_unlock (&sm->segments_rwlock);
107 segment_manager_del_segment (sm, fs);
108 clib_rwlock_writer_unlock (&sm->segments_rwlock);
112 * Reads a segment from the segment manager's pool without lock
114 svm_fifo_segment_private_t *
115 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
117 return pool_elt_at_index (sm->segments, segment_index);
121 segment_manager_segment_handle (segment_manager_t * sm,
122 svm_fifo_segment_private_t * segment)
124 u32 segment_index = segment_manager_segment_index (sm, segment);
125 return (((u64) segment_manager_index (sm) << 32) | segment_index);
129 segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
132 *sm_index = segment_handle >> 32;
133 *segment_index = segment_handle & 0xFFFFFFFF;
136 svm_fifo_segment_private_t *
137 segment_manager_get_segment_w_handle (u64 segment_handle)
139 u32 sm_index, segment_index;
140 segment_manager_t *sm;
142 segment_manager_parse_segment_handle (segment_handle, &sm_index,
144 sm = segment_manager_get (sm_index);
145 if (!sm || pool_is_free_index (sm->segments, segment_index))
147 return pool_elt_at_index (sm->segments, segment_index);
151 * Reads a segment from the segment manager's pool and acquires reader lock
153 * Caller must drop the reader's lock by calling
154 * @ref segment_manager_segment_reader_unlock once it finishes working with
157 svm_fifo_segment_private_t *
158 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
160 clib_rwlock_reader_lock (&sm->segments_rwlock);
161 return pool_elt_at_index (sm->segments, segment_index);
165 segment_manager_segment_reader_unlock (segment_manager_t * sm)
167 ASSERT (sm->segments_rwlock->n_readers > 0);
168 clib_rwlock_reader_unlock (&sm->segments_rwlock);
172 segment_manager_segment_writer_unlock (segment_manager_t * sm)
174 clib_rwlock_writer_unlock (&sm->segments_rwlock);
178 * Adds segment to segment manager's pool
180 * If needed a writer's lock is acquired before allocating a new segment
181 * to avoid affecting any of the segments pool readers.
184 segment_manager_add_segment (segment_manager_t * sm, u32 segment_size)
186 segment_manager_main_t *smm = &segment_manager_main;
187 u32 rnd_margin = 128 << 10, seg_index, page_size;
188 segment_manager_properties_t *props;
189 uword baseva = (uword) ~ 0ULL, alloc_size;
190 svm_fifo_segment_private_t *seg;
194 props = segment_manager_properties_get (sm);
196 /* Not configured for addition of new segments and not first */
197 if (!props->add_segment && !segment_size)
199 clib_warning ("cannot allocate new segment");
200 return VNET_API_ERROR_INVALID_VALUE;
204 * Allocate fifo segment and lock if needed
206 if (vlib_num_workers ())
208 clib_rwlock_writer_lock (&sm->segments_rwlock);
209 pool_get (sm->segments, seg);
213 pool_get (sm->segments, seg);
215 clib_memset (seg, 0, sizeof (*seg));
218 * Initialize ssvm segment and svm fifo private header
220 segment_size = segment_size ? segment_size : props->add_segment_size;
221 page_size = clib_mem_get_page_size ();
222 segment_size = (segment_size + page_size - 1) & ~(page_size - 1);
223 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
225 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
226 alloc_size = (uword) segment_size + rnd_margin;
227 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
230 clib_warning ("out of space for segments");
235 seg_name = format (0, "%s%c", "process-private-segment", 0);
237 seg->ssvm.ssvm_size = segment_size;
238 seg->ssvm.name = seg_name;
239 seg->ssvm.requested_va = baseva;
241 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
243 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
246 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
247 clib_valloc_free (&smm->va_allocator, baseva);
248 pool_put (sm->segments, seg);
252 svm_fifo_segment_init (seg);
255 * Save segment index before dropping lock, if any held
257 seg_index = seg - sm->segments;
259 if (vlib_num_workers ())
260 clib_rwlock_writer_unlock (&sm->segments_rwlock);
266 segment_manager_new ()
268 segment_manager_main_t *smm = &segment_manager_main;
269 segment_manager_t *sm;
270 pool_get (smm->segment_managers, sm);
271 clib_memset (sm, 0, sizeof (*sm));
272 clib_rwlock_init (&sm->segments_rwlock);
277 * Initializes segment manager based on options provided.
278 * Returns error if ssvm segment(s) allocation fails.
281 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
282 u32 prealloc_fifo_pairs)
284 u32 rx_fifo_size, tx_fifo_size, pair_size;
285 u32 rx_rounded_data_size, tx_rounded_data_size;
286 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
287 segment_manager_properties_t *props;
288 svm_fifo_segment_private_t *segment;
289 u32 approx_segment_count;
292 props = segment_manager_properties_get (sm);
293 first_seg_size = clib_max (first_seg_size, default_segment_size);
295 if (prealloc_fifo_pairs)
297 /* Figure out how many segments should be preallocated */
298 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
299 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
301 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
302 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
303 pair_size = rx_fifo_size + tx_fifo_size;
305 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
306 if (first_seg_size > approx_total_size)
307 max_seg_size = first_seg_size;
308 approx_segment_count = (approx_total_size + (max_seg_size - 1))
311 /* Allocate the segments */
312 for (i = 0; i < approx_segment_count + 1; i++)
314 seg_index = segment_manager_add_segment (sm, max_seg_size);
317 clib_warning ("Failed to preallocate segment %d", i);
321 segment = segment_manager_get_segment (sm, seg_index);
323 sm->event_queue = segment_manager_alloc_queue (segment, props);
325 svm_fifo_segment_preallocate_fifo_pairs (segment,
328 &prealloc_fifo_pairs);
329 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
330 if (prealloc_fifo_pairs == 0)
336 seg_index = segment_manager_add_segment (sm, first_seg_size);
339 clib_warning ("Failed to allocate segment");
342 segment = segment_manager_get_segment (sm, seg_index);
343 sm->event_queue = segment_manager_alloc_queue (segment, props);
350 segment_manager_has_fifos (segment_manager_t * sm)
352 svm_fifo_segment_private_t *seg;
356 segment_manager_foreach_segment_w_lock (seg, sm, ({
357 if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
358 && !(svm_fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
360 clib_warning ("segment %d has no fifos!",
361 segment_manager_segment_index (sm, seg));
364 if (svm_fifo_segment_has_fifos (seg))
366 segment_manager_segment_reader_unlock (sm);
376 * Initiate disconnects for all sessions 'owned' by a segment manager
379 segment_manager_del_sessions (segment_manager_t * sm)
381 svm_fifo_segment_private_t *fifo_segment;
385 ASSERT (pool_elts (sm->segments) != 0);
387 /* Across all fifo segments used by the server */
389 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
390 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
393 * Remove any residual sessions from the session lookup table
394 * Don't bother deleting the individual fifos, we're going to
395 * throw away the fifo segment in a minute.
399 if (fifo->ct_session_index != SVM_FIFO_INVALID_SESSION_INDEX)
401 svm_fifo_t *next = fifo->next;
402 application_local_session_disconnect_w_index (sm->app_wrk_index,
403 fifo->ct_session_index);
407 session = session_get (fifo->master_session_index,
408 fifo->master_thread_index);
409 session_close (session);
413 /* Instead of removing the segment, test when cleaning up disconnected
414 * sessions if the segment can be removed.
421 * Removes segment manager.
423 * Since the fifos allocated in the segment keep backpointers to the sessions
424 * prior to removing the segment, we call session disconnect. This
425 * subsequently propagates into transport.
428 segment_manager_del (segment_manager_t * sm)
430 segment_manager_main_t *smm = &segment_manager_main;
431 svm_fifo_segment_private_t *fifo_segment;
433 ASSERT (!segment_manager_has_fifos (sm)
434 && segment_manager_app_detached (sm));
436 /* If we have empty preallocated segments that haven't been removed, remove
437 * them now. Apart from that, the first segment in the first segment manager
438 * is not removed when all fifos are removed. It can only be removed when
439 * the manager is explicitly deleted/detached by the app. */
440 clib_rwlock_writer_lock (&sm->segments_rwlock);
443 pool_foreach (fifo_segment, sm->segments, ({
444 segment_manager_del_segment (sm, fifo_segment);
448 clib_rwlock_writer_unlock (&sm->segments_rwlock);
450 clib_rwlock_free (&sm->segments_rwlock);
452 clib_memset (sm, 0xfe, sizeof (*sm));
453 pool_put (smm->segment_managers, sm);
457 segment_manager_init_del (segment_manager_t * sm)
459 segment_manager_app_detach (sm);
460 if (segment_manager_has_fifos (sm))
461 segment_manager_del_sessions (sm);
464 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
465 segment_manager_del (sm);
470 segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
471 u32 rx_fifo_size, u32 tx_fifo_size,
472 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
474 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
475 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
476 FIFO_SEGMENT_RX_FREELIST);
478 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
479 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
480 FIFO_SEGMENT_TX_FREELIST);
484 /* This would be very odd, but handle it... */
487 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
488 FIFO_SEGMENT_TX_FREELIST);
497 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
498 FIFO_SEGMENT_RX_FREELIST);
508 segment_manager_alloc_session_fifos (segment_manager_t * sm,
509 svm_fifo_t ** rx_fifo,
510 svm_fifo_t ** tx_fifo,
511 u32 * fifo_segment_index)
513 svm_fifo_segment_private_t *fifo_segment = 0;
514 int alloc_fail = 1, rv = 0, new_fs_index;
515 segment_manager_properties_t *props;
516 u8 added_a_segment = 0;
520 props = segment_manager_properties_get (sm);
523 * Find the first free segment to allocate the fifos in
527 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
528 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
532 /* Exit with lock held, drop it after notifying app */
545 ASSERT (rx_fifo && tx_fifo);
546 sm_index = segment_manager_index (sm);
547 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
548 (*tx_fifo)->segment_manager = sm_index;
549 (*rx_fifo)->segment_manager = sm_index;
550 (*tx_fifo)->segment_index = *fifo_segment_index;
551 (*rx_fifo)->segment_index = *fifo_segment_index;
555 segment_handle = segment_manager_segment_handle (sm, fifo_segment);
556 rv = app_worker_add_segment_notify (sm->app_wrk_index,
559 /* Drop the lock after app is notified */
560 segment_manager_segment_reader_unlock (sm);
565 * Allocation failed, see if we can add a new segment
567 if (props->add_segment)
571 clib_warning ("Added a segment, still can't allocate a fifo");
572 segment_manager_segment_reader_unlock (sm);
573 return SESSION_ERROR_NEW_SEG_NO_SPACE;
575 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
577 clib_warning ("Failed to add new segment");
578 return SESSION_ERROR_SEG_CREATE;
580 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
581 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
590 clib_warning ("Can't add new seg and no space to allocate fifos!");
591 return SESSION_ERROR_NO_SPACE;
596 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
597 svm_fifo_t * tx_fifo)
599 svm_fifo_segment_private_t *fifo_segment;
600 segment_manager_t *sm;
602 if (!rx_fifo || !tx_fifo)
605 /* It's possible to have no segment manager if the session was removed
606 * as result of a detach. */
607 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
610 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
611 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
612 FIFO_SEGMENT_RX_FREELIST);
613 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
614 FIFO_SEGMENT_TX_FREELIST);
617 * Try to remove svm segment if it has no fifos. This can be done only if
618 * the segment is not the first in the segment manager or if it is first
619 * and it is not protected. Moreover, if the segment is first and the app
620 * has detached from the segment manager, remove the segment manager.
622 if (!svm_fifo_segment_has_fifos (fifo_segment))
624 segment_manager_segment_reader_unlock (sm);
626 /* Remove segment if it holds no fifos or first but not protected */
627 if (segment_index != 0 || !sm->first_is_protected)
628 segment_manager_lock_and_del_segment (sm, segment_index);
630 /* Remove segment manager if no sessions and detached from app */
631 if (segment_manager_app_detached (sm)
632 && !segment_manager_has_fifos (sm))
634 segment_manager_del (sm);
638 segment_manager_segment_reader_unlock (sm);
642 segment_manager_evt_q_expected_size (u32 q_len)
644 u32 fifo_evt_size, notif_q_size, q_hdrs;
645 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
647 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
648 notif_q_size = clib_max (16, q_len >> 4);
650 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
651 fifo_evt_ring_sz = q_len * fifo_evt_size;
652 session_ntf_ring_sz = notif_q_size * 256;
653 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
655 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
659 * Allocates shm queue in the first segment
661 * Must be called with lock held
664 segment_manager_alloc_queue (svm_fifo_segment_private_t * segment,
665 segment_manager_properties_t * props)
667 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
668 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
672 fifo_evt_size = sizeof (session_event_t);
673 notif_q_size = clib_max (16, props->evt_q_size >> 4);
675 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
676 {props->evt_q_size, fifo_evt_size, 0},
677 {notif_q_size, session_evt_size, 0}
680 cfg->consumer_pid = 0;
682 cfg->q_nitems = props->evt_q_size;
685 oldheap = ssvm_push_heap (segment->ssvm.sh);
686 q = svm_msg_q_alloc (cfg);
687 ssvm_pop_heap (oldheap);
689 if (props->use_mq_eventfd)
691 if (svm_msg_q_alloc_producer_eventfd (q))
692 clib_warning ("failed to alloc eventfd");
698 * Frees shm queue allocated in the first segment
701 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
703 svm_fifo_segment_private_t *segment;
704 ssvm_shared_header_t *sh;
707 ASSERT (!pool_is_free_index (sm->segments, 0));
709 segment = segment_manager_get_segment_w_lock (sm, 0);
710 sh = segment->ssvm.sh;
712 oldheap = ssvm_push_heap (sh);
714 ssvm_pop_heap (oldheap);
715 segment_manager_segment_reader_unlock (sm);
719 * Init segment vm address allocator
722 segment_manager_main_init (segment_manager_main_init_args_t * a)
724 segment_manager_main_t *sm = &segment_manager_main;
725 clib_valloc_chunk_t _ip, *ip = &_ip;
727 ip->baseva = a->baseva;
730 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
733 static clib_error_t *
734 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
735 vlib_cli_command_t * cmd)
737 segment_manager_main_t *smm = &segment_manager_main;
738 svm_fifo_segment_private_t *seg;
739 segment_manager_t *sm;
740 u8 show_segments = 0, verbose = 0;
746 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
748 if (unformat (input, "segments"))
750 else if (unformat (input, "verbose"))
753 return clib_error_return (0, "unknown input `%U'",
754 format_unformat_error, input);
756 vlib_cli_output (vm, "%d segment managers allocated",
757 pool_elts (smm->segment_managers));
758 if (verbose && pool_elts (smm->segment_managers))
760 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
764 pool_foreach (sm, smm->segment_managers, ({
765 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index (sm),
766 sm->app_wrk_index, pool_elts (sm->segments));
773 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
774 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
777 pool_foreach (sm, smm->segment_managers, ({
778 segment_manager_foreach_segment_w_lock (seg, sm, ({
779 svm_fifo_segment_info (seg, &address, &size);
780 active_fifos = svm_fifo_segment_num_fifos (seg);
781 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
782 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
783 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
784 seg, size >> 20ULL, active_fifos, free_fifos,
787 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
797 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
799 .path = "show segment-manager",
800 .short_help = "show segment-manager [segments][verbose]",
801 .function = segment_manager_show_fn,
806 * fd.io coding-style-patch-verification: ON
809 * eval: (c-set-style "gnu")