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, page_size;
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 page_size = clib_mem_get_page_size ();
191 segment_size = (segment_size + page_size - 1) & ~(page_size - 1);
192 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
194 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
195 alloc_size = segment_size + rnd_margin;
196 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
199 clib_warning ("out of space for segments");
204 seg_name = format (0, "%s%c", "process-private-segment", 0);
206 seg->ssvm.ssvm_size = segment_size;
207 seg->ssvm.name = seg_name;
208 seg->ssvm.requested_va = baseva;
210 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
212 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
215 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
216 clib_valloc_free (&smm->va_allocator, baseva);
217 pool_put (sm->segments, seg);
221 svm_fifo_segment_init (seg);
224 * Save segment index before dropping lock, if any held
226 seg_index = seg - sm->segments;
228 if (vlib_num_workers ())
229 clib_rwlock_writer_unlock (&sm->segments_rwlock);
235 segment_manager_new ()
237 segment_manager_main_t *smm = &segment_manager_main;
238 segment_manager_t *sm;
239 pool_get (smm->segment_managers, sm);
240 memset (sm, 0, sizeof (*sm));
241 clib_rwlock_init (&sm->segments_rwlock);
246 * Initializes segment manager based on options provided.
247 * Returns error if ssvm segment(s) allocation fails.
250 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
251 u32 prealloc_fifo_pairs)
253 u32 rx_fifo_size, tx_fifo_size, pair_size;
254 u32 rx_rounded_data_size, tx_rounded_data_size;
255 u64 approx_total_size, max_seg_size =
256 ((u64) 1 << 32) - clib_mem_get_page_size ();
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,
296 svm_fifo_segment_preallocate_fifo_pairs (segment,
299 &prealloc_fifo_pairs);
300 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
301 if (prealloc_fifo_pairs == 0)
307 seg_index = segment_manager_add_segment (sm, first_seg_size);
310 clib_warning ("Failed to allocate segment");
313 segment = segment_manager_get_segment (sm, seg_index);
314 sm->event_queue = segment_manager_alloc_queue (segment,
322 segment_manager_has_fifos (segment_manager_t * sm)
324 svm_fifo_segment_private_t *seg;
328 segment_manager_foreach_segment_w_lock (seg, sm, ({
329 if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
330 && !(svm_fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
332 clib_warning ("segment %d has no fifos!",
333 segment_manager_segment_index (sm, seg));
336 if (svm_fifo_segment_has_fifos (seg))
338 segment_manager_segment_reader_unlock (sm);
348 * Initiate disconnects for all sessions 'owned' by a segment manager
351 segment_manager_del_sessions (segment_manager_t * sm)
353 svm_fifo_segment_private_t *fifo_segment;
354 stream_session_t *session;
357 ASSERT (pool_elts (sm->segments) != 0);
359 /* Across all fifo segments used by the server */
361 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
362 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
365 * Remove any residual sessions from the session lookup table
366 * Don't bother deleting the individual fifos, we're going to
367 * throw away the fifo segment in a minute.
371 if (fifo->master_thread_index == 255)
373 svm_fifo_t *next = fifo->next;
374 application_local_session_disconnect_w_index (sm->app_index,
375 fifo->master_session_index);
379 session = session_get (fifo->master_session_index,
380 fifo->master_thread_index);
381 stream_session_disconnect (session);
385 /* Instead of removing the segment, test when cleaning up disconnected
386 * sessions if the segment can be removed.
393 * Removes segment manager.
395 * Since the fifos allocated in the segment keep backpointers to the sessions
396 * prior to removing the segment, we call session disconnect. This
397 * subsequently propagates into transport.
400 segment_manager_del (segment_manager_t * sm)
402 segment_manager_main_t *smm = &segment_manager_main;
403 svm_fifo_segment_private_t *fifo_segment;
405 ASSERT (!segment_manager_has_fifos (sm)
406 && segment_manager_app_detached (sm));
408 /* If we have empty preallocated segments that haven't been removed, remove
409 * them now. Apart from that, the first segment in the first segment manager
410 * is not removed when all fifos are removed. It can only be removed when
411 * the manager is explicitly deleted/detached by the app. */
412 clib_rwlock_writer_lock (&sm->segments_rwlock);
415 pool_foreach (fifo_segment, sm->segments, ({
416 segment_manager_del_segment (sm, fifo_segment);
420 clib_rwlock_writer_unlock (&sm->segments_rwlock);
422 clib_rwlock_free (&sm->segments_rwlock);
424 memset (sm, 0xfe, sizeof (*sm));
425 pool_put (smm->segment_managers, sm);
429 segment_manager_init_del (segment_manager_t * sm)
431 segment_manager_app_detach (sm);
432 if (segment_manager_has_fifos (sm))
433 segment_manager_del_sessions (sm);
436 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
437 segment_manager_del (sm);
442 segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
443 u32 rx_fifo_size, u32 tx_fifo_size,
444 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
446 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
447 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
448 FIFO_SEGMENT_RX_FREELIST);
450 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
451 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
452 FIFO_SEGMENT_TX_FREELIST);
456 /* This would be very odd, but handle it... */
459 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
460 FIFO_SEGMENT_TX_FREELIST);
469 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
470 FIFO_SEGMENT_RX_FREELIST);
480 segment_manager_alloc_session_fifos (segment_manager_t * sm,
481 svm_fifo_t ** rx_fifo,
482 svm_fifo_t ** tx_fifo,
483 u32 * fifo_segment_index)
485 svm_fifo_segment_private_t *fifo_segment = 0;
486 int alloc_fail = 1, rv = 0, new_fs_index;
487 segment_manager_properties_t *props;
488 u8 added_a_segment = 0;
491 props = segment_manager_properties_get (sm);
494 * Find the first free segment to allocate the fifos in
498 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
499 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
503 /* Exit with lock held, drop it after notifying app */
516 ASSERT (rx_fifo && tx_fifo);
517 sm_index = segment_manager_index (sm);
518 (*tx_fifo)->segment_manager = sm_index;
519 (*rx_fifo)->segment_manager = sm_index;
520 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
523 rv = application_add_segment_notify (sm->app_index,
524 &fifo_segment->ssvm);
525 /* Drop the lock after app is notified */
526 segment_manager_segment_reader_unlock (sm);
531 * Allocation failed, see if we can add a new segment
533 if (props->add_segment)
537 clib_warning ("Added a segment, still can't allocate a fifo");
538 segment_manager_segment_reader_unlock (sm);
539 return SESSION_ERROR_NEW_SEG_NO_SPACE;
541 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
543 clib_warning ("Failed to add new segment");
544 return SESSION_ERROR_SEG_CREATE;
546 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
547 alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
556 clib_warning ("Can't add new seg and no space to allocate fifos!");
557 return SESSION_ERROR_NO_SPACE;
562 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
563 svm_fifo_t * tx_fifo)
565 svm_fifo_segment_private_t *fifo_segment;
566 segment_manager_t *sm;
568 /* It's possible to have no segment manager if the session was removed
569 * as result of a detach. */
570 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
573 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
574 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
575 FIFO_SEGMENT_RX_FREELIST);
576 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
577 FIFO_SEGMENT_TX_FREELIST);
580 * Try to remove svm segment if it has no fifos. This can be done only if
581 * the segment is not the first in the segment manager or if it is first
582 * and it is not protected. Moreover, if the segment is first and the app
583 * has detached from the segment manager, remove the segment manager.
585 if (!svm_fifo_segment_has_fifos (fifo_segment))
587 segment_manager_segment_reader_unlock (sm);
589 /* Remove segment if it holds no fifos or first but not protected */
590 if (segment_index != 0 || !sm->first_is_protected)
591 segment_manager_lock_and_del_segment (sm, segment_index);
593 /* Remove segment manager if no sessions and detached from app */
594 if (segment_manager_app_detached (sm)
595 && !segment_manager_has_fifos (sm))
596 segment_manager_del (sm);
599 segment_manager_segment_reader_unlock (sm);
603 * Allocates shm queue in the first segment
605 * Must be called with lock held
608 segment_manager_alloc_queue (svm_fifo_segment_private_t * segment,
611 ssvm_shared_header_t *sh;
615 sh = segment->ssvm.sh;
617 oldheap = ssvm_push_heap (sh);
618 q = svm_queue_init (queue_size, sizeof (session_fifo_event_t),
619 0 /* consumer pid */ ,
620 0 /* signal when queue non-empty */ );
621 ssvm_pop_heap (oldheap);
626 * Frees shm queue allocated in the first segment
629 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
631 svm_fifo_segment_private_t *segment;
632 ssvm_shared_header_t *sh;
635 ASSERT (!pool_is_free_index (sm->segments, 0));
637 segment = segment_manager_get_segment_w_lock (sm, 0);
638 sh = segment->ssvm.sh;
640 oldheap = ssvm_push_heap (sh);
642 ssvm_pop_heap (oldheap);
643 segment_manager_segment_reader_unlock (sm);
647 * Init segment vm address allocator
650 segment_manager_main_init (segment_manager_main_init_args_t * a)
652 segment_manager_main_t *sm = &segment_manager_main;
653 clib_valloc_chunk_t _ip, *ip = &_ip;
655 ip->baseva = a->baseva;
658 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
661 static clib_error_t *
662 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
663 vlib_cli_command_t * cmd)
665 segment_manager_main_t *smm = &segment_manager_main;
666 svm_fifo_segment_private_t *seg;
667 segment_manager_t *sm;
668 u8 show_segments = 0, verbose = 0;
674 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
676 if (unformat (input, "segments"))
678 else if (unformat (input, "verbose"))
681 return clib_error_return (0, "unknown input `%U'",
682 format_unformat_error, input);
684 vlib_cli_output (vm, "%d segment managers allocated",
685 pool_elts (smm->segment_managers));
686 if (verbose && pool_elts (smm->segment_managers))
688 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
692 pool_foreach (sm, smm->segment_managers, ({
693 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index(sm),
694 sm->app_index, pool_elts (sm->segments));
701 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
702 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
705 pool_foreach (sm, smm->segment_managers, ({
706 segment_manager_foreach_segment_w_lock (seg, sm, ({
707 svm_fifo_segment_info (seg, &address, &size);
708 active_fifos = svm_fifo_segment_num_fifos (seg);
709 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
710 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
711 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
712 seg, size >> 20ULL, active_fifos, free_fifos,
715 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
725 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
727 .path = "show segment-manager",
728 .short_help = "show segment-manager [segments][verbose]",
729 .function = segment_manager_show_fn,
734 * fd.io coding-style-patch-verification: ON
737 * eval: (c-set-style "gnu")