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>
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 * Reads a segment from the segment manager's pool and acquires reader lock
123 * Caller must drop the reader's lock by calling
124 * @ref segment_manager_segment_reader_unlock once it finishes working with
127 svm_fifo_segment_private_t *
128 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
130 clib_rwlock_reader_lock (&sm->segments_rwlock);
131 return pool_elt_at_index (sm->segments, segment_index);
135 segment_manager_segment_reader_unlock (segment_manager_t * sm)
137 ASSERT (sm->segments_rwlock->n_readers > 0);
138 clib_rwlock_reader_unlock (&sm->segments_rwlock);
142 segment_manager_segment_writer_unlock (segment_manager_t * sm)
144 clib_rwlock_writer_unlock (&sm->segments_rwlock);
148 * Adds segment to segment manager's pool
150 * If needed a writer's lock is acquired before allocating a new segment
151 * to avoid affecting any of the segments pool readers.
154 segment_manager_add_segment (segment_manager_t * sm, u32 segment_size)
156 segment_manager_main_t *smm = &segment_manager_main;
157 u32 rnd_margin = 128 << 10, seg_index, page_size;
158 segment_manager_properties_t *props;
159 uword baseva = (u64) ~ 0, alloc_size;
160 svm_fifo_segment_private_t *seg;
164 props = segment_manager_properties_get (sm);
166 /* Not configured for addition of new segments and not first */
167 if (!props->add_segment && !segment_size)
169 clib_warning ("cannot allocate new segment");
170 return VNET_API_ERROR_INVALID_VALUE;
174 * Allocate fifo segment and lock if needed
176 if (vlib_num_workers ())
178 clib_rwlock_writer_lock (&sm->segments_rwlock);
179 pool_get (sm->segments, seg);
183 pool_get (sm->segments, seg);
185 clib_memset (seg, 0, sizeof (*seg));
188 * Initialize ssvm segment and svm fifo private header
190 segment_size = segment_size ? segment_size : props->add_segment_size;
191 page_size = clib_mem_get_page_size ();
192 segment_size = (segment_size + page_size - 1) & ~(page_size - 1);
193 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
195 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
196 alloc_size = (uword) segment_size + rnd_margin;
197 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
200 clib_warning ("out of space for segments");
205 seg_name = format (0, "%s%c", "process-private-segment", 0);
207 seg->ssvm.ssvm_size = segment_size;
208 seg->ssvm.name = seg_name;
209 seg->ssvm.requested_va = baseva;
211 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
213 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
216 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
217 clib_valloc_free (&smm->va_allocator, baseva);
218 pool_put (sm->segments, seg);
222 svm_fifo_segment_init (seg);
225 * Save segment index before dropping lock, if any held
227 seg_index = seg - sm->segments;
229 if (vlib_num_workers ())
230 clib_rwlock_writer_unlock (&sm->segments_rwlock);
236 segment_manager_new ()
238 segment_manager_main_t *smm = &segment_manager_main;
239 segment_manager_t *sm;
240 pool_get (smm->segment_managers, sm);
241 clib_memset (sm, 0, sizeof (*sm));
242 clib_rwlock_init (&sm->segments_rwlock);
247 * Initializes segment manager based on options provided.
248 * Returns error if ssvm segment(s) allocation fails.
251 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
252 u32 prealloc_fifo_pairs)
254 u32 rx_fifo_size, tx_fifo_size, pair_size;
255 u32 rx_rounded_data_size, tx_rounded_data_size;
256 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
257 segment_manager_properties_t *props;
258 svm_fifo_segment_private_t *segment;
259 u32 approx_segment_count;
262 props = segment_manager_properties_get (sm);
263 first_seg_size = clib_max (first_seg_size, default_segment_size);
265 if (prealloc_fifo_pairs)
267 /* Figure out how many segments should be preallocated */
268 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
269 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
271 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
272 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
273 pair_size = rx_fifo_size + tx_fifo_size;
275 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
276 if (first_seg_size > approx_total_size)
277 max_seg_size = first_seg_size;
278 approx_segment_count = (approx_total_size + (max_seg_size - 1))
281 /* Allocate the segments */
282 for (i = 0; i < approx_segment_count + 1; i++)
284 seg_index = segment_manager_add_segment (sm, max_seg_size);
287 clib_warning ("Failed to preallocate segment %d", i);
291 segment = segment_manager_get_segment (sm, seg_index);
293 sm->event_queue = segment_manager_alloc_queue (segment, props);
295 svm_fifo_segment_preallocate_fifo_pairs (segment,
298 &prealloc_fifo_pairs);
299 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
300 if (prealloc_fifo_pairs == 0)
306 seg_index = segment_manager_add_segment (sm, first_seg_size);
309 clib_warning ("Failed to allocate segment");
312 segment = segment_manager_get_segment (sm, seg_index);
313 sm->event_queue = segment_manager_alloc_queue (segment, props);
320 segment_manager_has_fifos (segment_manager_t * sm)
322 svm_fifo_segment_private_t *seg;
326 segment_manager_foreach_segment_w_lock (seg, sm, ({
327 if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
328 && !(svm_fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
330 clib_warning ("segment %d has no fifos!",
331 segment_manager_segment_index (sm, seg));
334 if (svm_fifo_segment_has_fifos (seg))
336 segment_manager_segment_reader_unlock (sm);
346 * Initiate disconnects for all sessions 'owned' by a segment manager
349 segment_manager_del_sessions (segment_manager_t * sm)
351 svm_fifo_segment_private_t *fifo_segment;
352 stream_session_t *session;
355 ASSERT (pool_elts (sm->segments) != 0);
357 /* Across all fifo segments used by the server */
359 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
360 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
363 * Remove any residual sessions from the session lookup table
364 * Don't bother deleting the individual fifos, we're going to
365 * throw away the fifo segment in a minute.
369 if (fifo->ct_session_index != SVM_FIFO_INVALID_SESSION_INDEX)
371 svm_fifo_t *next = fifo->next;
372 application_local_session_disconnect_w_index (sm->app_wrk_index,
373 fifo->ct_session_index);
377 session = session_get (fifo->master_session_index,
378 fifo->master_thread_index);
379 stream_session_disconnect (session);
383 /* Instead of removing the segment, test when cleaning up disconnected
384 * sessions if the segment can be removed.
391 * Removes segment manager.
393 * Since the fifos allocated in the segment keep backpointers to the sessions
394 * prior to removing the segment, we call session disconnect. This
395 * subsequently propagates into transport.
398 segment_manager_del (segment_manager_t * sm)
400 segment_manager_main_t *smm = &segment_manager_main;
401 svm_fifo_segment_private_t *fifo_segment;
403 ASSERT (!segment_manager_has_fifos (sm)
404 && segment_manager_app_detached (sm));
406 /* If we have empty preallocated segments that haven't been removed, remove
407 * them now. Apart from that, the first segment in the first segment manager
408 * is not removed when all fifos are removed. It can only be removed when
409 * the manager is explicitly deleted/detached by the app. */
410 clib_rwlock_writer_lock (&sm->segments_rwlock);
413 pool_foreach (fifo_segment, sm->segments, ({
414 segment_manager_del_segment (sm, fifo_segment);
418 clib_rwlock_writer_unlock (&sm->segments_rwlock);
420 clib_rwlock_free (&sm->segments_rwlock);
422 clib_memset (sm, 0xfe, sizeof (*sm));
423 pool_put (smm->segment_managers, sm);
427 segment_manager_init_del (segment_manager_t * sm)
429 segment_manager_app_detach (sm);
430 if (segment_manager_has_fifos (sm))
431 segment_manager_del_sessions (sm);
434 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
435 segment_manager_del (sm);
440 segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
441 u32 rx_fifo_size, u32 tx_fifo_size,
442 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
444 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
445 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
446 FIFO_SEGMENT_RX_FREELIST);
448 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
449 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
450 FIFO_SEGMENT_TX_FREELIST);
454 /* This would be very odd, but handle it... */
457 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
458 FIFO_SEGMENT_TX_FREELIST);
467 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
468 FIFO_SEGMENT_RX_FREELIST);
478 segment_manager_alloc_session_fifos (segment_manager_t * sm,
479 svm_fifo_t ** rx_fifo,
480 svm_fifo_t ** tx_fifo,
481 u32 * fifo_segment_index)
483 svm_fifo_segment_private_t *fifo_segment = 0;
484 int alloc_fail = 1, rv = 0, new_fs_index;
485 segment_manager_properties_t *props;
486 u8 added_a_segment = 0;
489 props = segment_manager_properties_get (sm);
492 * Find the first free segment to allocate the fifos in
496 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
497 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
501 /* Exit with lock held, drop it after notifying app */
514 ASSERT (rx_fifo && tx_fifo);
515 sm_index = segment_manager_index (sm);
516 (*tx_fifo)->segment_manager = sm_index;
517 (*rx_fifo)->segment_manager = sm_index;
518 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
521 rv = app_worker_add_segment_notify (sm->app_wrk_index,
522 &fifo_segment->ssvm);
523 /* Drop the lock after app is notified */
524 segment_manager_segment_reader_unlock (sm);
529 * Allocation failed, see if we can add a new segment
531 if (props->add_segment)
535 clib_warning ("Added a segment, still can't allocate a fifo");
536 segment_manager_segment_reader_unlock (sm);
537 return SESSION_ERROR_NEW_SEG_NO_SPACE;
539 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
541 clib_warning ("Failed to add new segment");
542 return SESSION_ERROR_SEG_CREATE;
544 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
545 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
554 clib_warning ("Can't add new seg and no space to allocate fifos!");
555 return SESSION_ERROR_NO_SPACE;
560 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
561 svm_fifo_t * tx_fifo)
563 svm_fifo_segment_private_t *fifo_segment;
564 segment_manager_t *sm;
566 /* It's possible to have no segment manager if the session was removed
567 * as result of a detach. */
568 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
571 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
572 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
573 FIFO_SEGMENT_RX_FREELIST);
574 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
575 FIFO_SEGMENT_TX_FREELIST);
578 * Try to remove svm segment if it has no fifos. This can be done only if
579 * the segment is not the first in the segment manager or if it is first
580 * and it is not protected. Moreover, if the segment is first and the app
581 * has detached from the segment manager, remove the segment manager.
583 if (!svm_fifo_segment_has_fifos (fifo_segment))
585 segment_manager_segment_reader_unlock (sm);
587 /* Remove segment if it holds no fifos or first but not protected */
588 if (segment_index != 0 || !sm->first_is_protected)
589 segment_manager_lock_and_del_segment (sm, segment_index);
591 /* Remove segment manager if no sessions and detached from app */
592 if (segment_manager_app_detached (sm)
593 && !segment_manager_has_fifos (sm))
595 segment_manager_del (sm);
599 segment_manager_segment_reader_unlock (sm);
603 segment_manager_evt_q_expected_size (u32 q_len)
605 u32 fifo_evt_size, notif_q_size, q_hdrs;
606 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
608 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
609 notif_q_size = clib_max (16, q_len >> 4);
611 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
612 fifo_evt_ring_sz = q_len * fifo_evt_size;
613 session_ntf_ring_sz = notif_q_size * 256;
614 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
616 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
620 * Allocates shm queue in the first segment
622 * Must be called with lock held
625 segment_manager_alloc_queue (svm_fifo_segment_private_t * segment,
626 segment_manager_properties_t * props)
628 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
629 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
633 fifo_evt_size = sizeof (session_event_t);
634 notif_q_size = clib_max (16, props->evt_q_size >> 4);
636 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
637 {props->evt_q_size, fifo_evt_size, 0},
638 {notif_q_size, session_evt_size, 0}
641 cfg->consumer_pid = 0;
643 cfg->q_nitems = props->evt_q_size;
646 oldheap = ssvm_push_heap (segment->ssvm.sh);
647 q = svm_msg_q_alloc (cfg);
648 ssvm_pop_heap (oldheap);
650 if (props->use_mq_eventfd)
652 if (svm_msg_q_alloc_producer_eventfd (q))
653 clib_warning ("failed to alloc eventfd");
659 * Frees shm queue allocated in the first segment
662 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
664 svm_fifo_segment_private_t *segment;
665 ssvm_shared_header_t *sh;
668 ASSERT (!pool_is_free_index (sm->segments, 0));
670 segment = segment_manager_get_segment_w_lock (sm, 0);
671 sh = segment->ssvm.sh;
673 oldheap = ssvm_push_heap (sh);
675 ssvm_pop_heap (oldheap);
676 segment_manager_segment_reader_unlock (sm);
680 * Init segment vm address allocator
683 segment_manager_main_init (segment_manager_main_init_args_t * a)
685 segment_manager_main_t *sm = &segment_manager_main;
686 clib_valloc_chunk_t _ip, *ip = &_ip;
688 ip->baseva = a->baseva;
691 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
694 static clib_error_t *
695 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
696 vlib_cli_command_t * cmd)
698 segment_manager_main_t *smm = &segment_manager_main;
699 svm_fifo_segment_private_t *seg;
700 segment_manager_t *sm;
701 u8 show_segments = 0, verbose = 0;
707 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
709 if (unformat (input, "segments"))
711 else if (unformat (input, "verbose"))
714 return clib_error_return (0, "unknown input `%U'",
715 format_unformat_error, input);
717 vlib_cli_output (vm, "%d segment managers allocated",
718 pool_elts (smm->segment_managers));
719 if (verbose && pool_elts (smm->segment_managers))
721 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
725 pool_foreach (sm, smm->segment_managers, ({
726 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index (sm),
727 sm->app_wrk_index, pool_elts (sm->segments));
734 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
735 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
738 pool_foreach (sm, smm->segment_managers, ({
739 segment_manager_foreach_segment_w_lock (seg, sm, ({
740 svm_fifo_segment_info (seg, &address, &size);
741 active_fifos = svm_fifo_segment_num_fifos (seg);
742 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
743 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
744 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
745 seg, size >> 20ULL, active_fifos, free_fifos,
748 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
758 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
760 .path = "show segment-manager",
761 .short_help = "show segment-manager [segments][verbose]",
762 .function = segment_manager_show_fn,
767 * fd.io coding-style-patch-verification: ON
770 * eval: (c-set-style "gnu")