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 return application_get_segment_manager_properties (sm->app_index);
40 segment_manager_properties_t *
41 segment_manager_properties_init (segment_manager_properties_t * props)
43 props->add_segment_size = default_segment_size;
44 props->rx_fifo_size = default_fifo_size;
45 props->tx_fifo_size = default_fifo_size;
46 props->evt_q_size = default_app_evt_queue_size;
51 segment_manager_app_detached (segment_manager_t * sm)
53 return (sm->app_index == SEGMENT_MANAGER_INVALID_APP_INDEX);
57 segment_manager_app_detach (segment_manager_t * sm)
59 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
63 segment_manager_segment_index (segment_manager_t * sm,
64 svm_fifo_segment_private_t * seg)
66 return (seg - sm->segments);
70 * Remove segment without lock
73 segment_manager_del_segment (segment_manager_t * sm,
74 svm_fifo_segment_private_t * fs)
76 segment_manager_main_t *smm = &segment_manager_main;
78 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
79 clib_valloc_free (&smm->va_allocator, fs->ssvm.requested_va);
81 ssvm_delete (&fs->ssvm);
84 memset (fs, 0xfb, sizeof (*fs));
85 pool_put (sm->segments, fs);
89 * Removes segment after acquiring writer lock
92 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
94 svm_fifo_segment_private_t *fs;
97 clib_rwlock_writer_lock (&sm->segments_rwlock);
98 fs = segment_manager_get_segment (sm, fs_index);
99 is_prealloc = svm_fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
100 if (is_prealloc && !segment_manager_app_detached (sm))
102 clib_rwlock_writer_unlock (&sm->segments_rwlock);
106 segment_manager_del_segment (sm, fs);
107 clib_rwlock_writer_unlock (&sm->segments_rwlock);
111 * Reads a segment from the segment manager's pool without lock
113 svm_fifo_segment_private_t *
114 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
116 return pool_elt_at_index (sm->segments, segment_index);
120 * Reads a segment from the segment manager's pool and acquires reader lock
122 * Caller must drop the reader's lock by calling
123 * @ref segment_manager_segment_reader_unlock once it finishes working with
126 svm_fifo_segment_private_t *
127 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
129 clib_rwlock_reader_lock (&sm->segments_rwlock);
130 return pool_elt_at_index (sm->segments, segment_index);
134 segment_manager_segment_reader_unlock (segment_manager_t * sm)
136 ASSERT (sm->segments_rwlock->n_readers > 0);
137 clib_rwlock_reader_unlock (&sm->segments_rwlock);
141 segment_manager_segment_writer_unlock (segment_manager_t * sm)
143 clib_rwlock_writer_unlock (&sm->segments_rwlock);
147 * Adds segment to segment manager's pool
149 * If needed a writer's lock is acquired before allocating a new segment
150 * to avoid affecting any of the segments pool readers.
153 segment_manager_add_segment (segment_manager_t * sm, u32 segment_size)
155 segment_manager_main_t *smm = &segment_manager_main;
156 u32 rnd_margin = 128 << 10, seg_index;
157 segment_manager_properties_t *props;
158 uword baseva = (u64) ~ 0, alloc_size;
159 svm_fifo_segment_private_t *seg;
163 props = segment_manager_properties_get (sm);
165 /* Not configured for addition of new segments and not first */
166 if (!props->add_segment && !segment_size)
168 clib_warning ("cannot allocate new segment");
169 return VNET_API_ERROR_INVALID_VALUE;
173 * Allocate fifo segment and lock if needed
175 if (vlib_num_workers ())
177 clib_rwlock_writer_lock (&sm->segments_rwlock);
178 pool_get (sm->segments, seg);
182 pool_get (sm->segments, seg);
184 memset (seg, 0, sizeof (*seg));
187 * Initialize ssvm segment and svm fifo private header
189 segment_size = segment_size ? segment_size : props->add_segment_size;
190 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
192 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
193 alloc_size = segment_size + rnd_margin;
194 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
197 clib_warning ("out of space for segments");
202 seg_name = format (0, "%s%c", "process-private-segment", 0);
204 seg->ssvm.ssvm_size = segment_size;
205 seg->ssvm.name = seg_name;
206 seg->ssvm.requested_va = baseva;
208 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
210 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
213 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
214 clib_valloc_free (&smm->va_allocator, baseva);
215 pool_put (sm->segments, seg);
219 svm_fifo_segment_init (seg);
222 * Save segment index before dropping lock, if any held
224 seg_index = seg - sm->segments;
226 if (vlib_num_workers ())
227 clib_rwlock_writer_unlock (&sm->segments_rwlock);
233 segment_manager_new ()
235 segment_manager_main_t *smm = &segment_manager_main;
236 segment_manager_t *sm;
237 pool_get (smm->segment_managers, sm);
238 memset (sm, 0, sizeof (*sm));
239 clib_rwlock_init (&sm->segments_rwlock);
244 * Initializes segment manager based on options provided.
245 * Returns error if ssvm segment(s) allocation fails.
248 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
249 u32 prealloc_fifo_pairs)
251 u32 rx_fifo_size, tx_fifo_size, pair_size;
252 u32 rx_rounded_data_size, tx_rounded_data_size;
253 u64 approx_total_size, max_seg_size =
254 ((u64) 1 << 32) - clib_mem_get_page_size ();
255 segment_manager_properties_t *props;
256 svm_fifo_segment_private_t *segment;
257 u32 approx_segment_count;
260 props = segment_manager_properties_get (sm);
261 first_seg_size = clib_max (first_seg_size, default_segment_size);
263 if (prealloc_fifo_pairs)
265 /* Figure out how many segments should be preallocated */
266 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
267 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
269 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
270 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
271 pair_size = rx_fifo_size + tx_fifo_size;
273 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
274 if (first_seg_size > approx_total_size)
275 max_seg_size = first_seg_size;
276 approx_segment_count = (approx_total_size + (max_seg_size - 1))
279 /* Allocate the segments */
280 for (i = 0; i < approx_segment_count + 1; i++)
282 seg_index = segment_manager_add_segment (sm, max_seg_size);
285 clib_warning ("Failed to preallocate segment %d", i);
289 segment = segment_manager_get_segment (sm, seg_index);
291 sm->event_queue = segment_manager_alloc_queue (segment,
294 svm_fifo_segment_preallocate_fifo_pairs (segment,
297 &prealloc_fifo_pairs);
298 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
299 if (prealloc_fifo_pairs == 0)
305 seg_index = segment_manager_add_segment (sm, first_seg_size);
308 clib_warning ("Failed to allocate segment");
311 segment = segment_manager_get_segment (sm, seg_index);
312 sm->event_queue = segment_manager_alloc_queue (segment,
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 session = session_get (fifo->master_session_index,
370 fifo->master_thread_index);
371 stream_session_disconnect (session);
375 /* Instead of removing the segment, test when cleaning up disconnected
376 * sessions if the segment can be removed.
383 * Removes segment manager.
385 * Since the fifos allocated in the segment keep backpointers to the sessions
386 * prior to removing the segment, we call session disconnect. This
387 * subsequently propagates into transport.
390 segment_manager_del (segment_manager_t * sm)
392 segment_manager_main_t *smm = &segment_manager_main;
393 svm_fifo_segment_private_t *fifo_segment;
395 ASSERT (!segment_manager_has_fifos (sm)
396 && segment_manager_app_detached (sm));
398 /* If we have empty preallocated segments that haven't been removed, remove
399 * them now. Apart from that, the first segment in the first segment manager
400 * is not removed when all fifos are removed. It can only be removed when
401 * the manager is explicitly deleted/detached by the app. */
402 clib_rwlock_writer_lock (&sm->segments_rwlock);
405 pool_foreach (fifo_segment, sm->segments, ({
406 segment_manager_del_segment (sm, fifo_segment);
410 clib_rwlock_writer_unlock (&sm->segments_rwlock);
412 clib_rwlock_free (&sm->segments_rwlock);
414 memset (sm, 0xfe, sizeof (*sm));
415 pool_put (smm->segment_managers, sm);
419 segment_manager_init_del (segment_manager_t * sm)
421 segment_manager_app_detach (sm);
422 if (segment_manager_has_fifos (sm))
423 segment_manager_del_sessions (sm);
426 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
427 segment_manager_del (sm);
432 segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
433 u32 rx_fifo_size, u32 tx_fifo_size,
434 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
436 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
437 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
438 FIFO_SEGMENT_RX_FREELIST);
440 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
441 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
442 FIFO_SEGMENT_TX_FREELIST);
446 /* This would be very odd, but handle it... */
449 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
450 FIFO_SEGMENT_TX_FREELIST);
459 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
460 FIFO_SEGMENT_RX_FREELIST);
470 segment_manager_alloc_session_fifos (segment_manager_t * sm,
471 svm_fifo_t ** rx_fifo,
472 svm_fifo_t ** tx_fifo,
473 u32 * fifo_segment_index)
475 svm_fifo_segment_private_t *fifo_segment = 0;
476 int alloc_fail = 1, rv = 0, new_fs_index;
477 segment_manager_properties_t *props;
478 u8 added_a_segment = 0;
481 props = segment_manager_properties_get (sm);
484 * Find the first free segment to allocate the fifos in
488 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
489 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
493 /* Exit with lock held, drop it after notifying app */
506 ASSERT (rx_fifo && tx_fifo);
507 sm_index = segment_manager_index (sm);
508 (*tx_fifo)->segment_manager = sm_index;
509 (*rx_fifo)->segment_manager = sm_index;
510 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
513 rv = application_add_segment_notify (sm->app_index,
514 &fifo_segment->ssvm);
515 /* Drop the lock after app is notified */
516 segment_manager_segment_reader_unlock (sm);
521 * Allocation failed, see if we can add a new segment
523 if (props->add_segment)
527 clib_warning ("Added a segment, still can't allocate a fifo");
528 segment_manager_segment_reader_unlock (sm);
529 return SESSION_ERROR_NEW_SEG_NO_SPACE;
531 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
533 clib_warning ("Failed to add new segment");
534 return SESSION_ERROR_SEG_CREATE;
536 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
537 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
546 clib_warning ("Can't add new seg and no space to allocate fifos!");
547 return SESSION_ERROR_NO_SPACE;
552 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
553 svm_fifo_t * tx_fifo)
555 svm_fifo_segment_private_t *fifo_segment;
556 segment_manager_t *sm;
558 /* It's possible to have no segment manager if the session was removed
559 * as result of a detach. */
560 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
563 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
564 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
565 FIFO_SEGMENT_RX_FREELIST);
566 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
567 FIFO_SEGMENT_TX_FREELIST);
570 * Try to remove svm segment if it has no fifos. This can be done only if
571 * the segment is not the first in the segment manager or if it is first
572 * and it is not protected. Moreover, if the segment is first and the app
573 * has detached from the segment manager, remove the segment manager.
575 if (!svm_fifo_segment_has_fifos (fifo_segment))
577 segment_manager_segment_reader_unlock (sm);
579 /* Remove segment if it holds no fifos or first but not protected */
580 if (segment_index != 0 || !sm->first_is_protected)
581 segment_manager_lock_and_del_segment (sm, segment_index);
583 /* Remove segment manager if no sessions and detached from app */
584 if (segment_manager_app_detached (sm)
585 && !segment_manager_has_fifos (sm))
586 segment_manager_del (sm);
589 segment_manager_segment_reader_unlock (sm);
593 * Allocates shm queue in the first segment
595 * Must be called with lock held
598 segment_manager_alloc_queue (svm_fifo_segment_private_t * segment,
601 ssvm_shared_header_t *sh;
605 sh = segment->ssvm.sh;
607 oldheap = ssvm_push_heap (sh);
608 q = svm_queue_init (queue_size, sizeof (session_fifo_event_t),
609 0 /* consumer pid */ ,
610 0 /* signal when queue non-empty */ );
611 ssvm_pop_heap (oldheap);
616 * Frees shm queue allocated in the first segment
619 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
621 svm_fifo_segment_private_t *segment;
622 ssvm_shared_header_t *sh;
625 ASSERT (!pool_is_free_index (sm->segments, 0));
627 segment = segment_manager_get_segment_w_lock (sm, 0);
628 sh = segment->ssvm.sh;
630 oldheap = ssvm_push_heap (sh);
632 ssvm_pop_heap (oldheap);
633 segment_manager_segment_reader_unlock (sm);
637 * Init segment vm address allocator
640 segment_manager_main_init (segment_manager_main_init_args_t * a)
642 segment_manager_main_t *sm = &segment_manager_main;
643 clib_valloc_chunk_t _ip, *ip = &_ip;
645 ip->baseva = a->baseva;
648 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
651 static clib_error_t *
652 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
653 vlib_cli_command_t * cmd)
655 segment_manager_main_t *smm = &segment_manager_main;
656 svm_fifo_segment_private_t *seg;
657 segment_manager_t *sm;
658 u8 show_segments = 0, verbose = 0;
664 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
666 if (unformat (input, "segments"))
668 else if (unformat (input, "verbose"))
671 return clib_error_return (0, "unknown input `%U'",
672 format_unformat_error, input);
674 vlib_cli_output (vm, "%d segment managers allocated",
675 pool_elts (smm->segment_managers));
676 if (verbose && pool_elts (smm->segment_managers))
678 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
682 pool_foreach (sm, smm->segment_managers, ({
683 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index(sm),
684 sm->app_index, pool_elts (sm->segments));
691 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
692 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
695 pool_foreach (sm, smm->segment_managers, ({
696 segment_manager_foreach_segment_w_lock (seg, sm, ({
697 svm_fifo_segment_info (seg, &address, &size);
698 active_fifos = svm_fifo_segment_num_fifos (seg);
699 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
700 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
701 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
702 seg, size >> 20ULL, active_fifos, free_fifos,
705 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
715 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
717 .path = "show segment-manager",
718 .short_help = "show segment-manager [segments][verbose]",
719 .function = segment_manager_show_fn,
724 * fd.io coding-style-patch-verification: ON
727 * eval: (c-set-style "gnu")