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 u32 default_fifo_size = 1 << 12;
31 u32 default_segment_size = 1 << 20;
33 segment_manager_properties_t *
34 segment_manager_properties_get (segment_manager_t * sm)
36 return application_get_segment_manager_properties (sm->app_index);
39 segment_manager_properties_t *
40 segment_manager_properties_init (segment_manager_properties_t * props)
42 props->add_segment_size = default_segment_size;
43 props->rx_fifo_size = default_fifo_size;
44 props->tx_fifo_size = default_fifo_size;
49 segment_manager_app_detached (segment_manager_t * sm)
51 return (sm->app_index == SEGMENT_MANAGER_INVALID_APP_INDEX);
55 segment_manager_app_detach (segment_manager_t * sm)
57 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
61 segment_manager_segment_index (segment_manager_t * sm,
62 svm_fifo_segment_private_t * seg)
64 return (seg - sm->segments);
68 * Remove segment without lock
71 segment_manager_del_segment (segment_manager_t * sm,
72 svm_fifo_segment_private_t * fs)
74 segment_manager_main_t *smm = &segment_manager_main;
76 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
77 clib_valloc_free (&smm->va_allocator, fs->ssvm.requested_va);
79 ssvm_delete (&fs->ssvm);
82 memset (fs, 0xfb, sizeof (*fs));
83 pool_put (sm->segments, fs);
87 * Removes segment after acquiring writer lock
90 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
92 svm_fifo_segment_private_t *fs;
95 clib_rwlock_writer_lock (&sm->segments_rwlock);
96 fs = segment_manager_get_segment (sm, fs_index);
97 is_prealloc = svm_fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
98 if (is_prealloc && !segment_manager_app_detached (sm))
100 clib_rwlock_writer_unlock (&sm->segments_rwlock);
104 segment_manager_del_segment (sm, fs);
105 clib_rwlock_writer_unlock (&sm->segments_rwlock);
109 * Reads a segment from the segment manager's pool without lock
111 svm_fifo_segment_private_t *
112 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
114 return pool_elt_at_index (sm->segments, segment_index);
118 * Reads a segment from the segment manager's pool and acquires reader lock
120 * Caller must drop the reader's lock by calling
121 * @ref segment_manager_segment_reader_unlock once it finishes working with
124 svm_fifo_segment_private_t *
125 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
127 clib_rwlock_reader_lock (&sm->segments_rwlock);
128 return pool_elt_at_index (sm->segments, segment_index);
132 segment_manager_segment_reader_unlock (segment_manager_t * sm)
134 clib_rwlock_reader_unlock (&sm->segments_rwlock);
138 segment_manager_segment_writer_unlock (segment_manager_t * sm)
140 clib_rwlock_writer_unlock (&sm->segments_rwlock);
144 * Adds segment to segment manager's pool
146 * If needed a writer's lock is acquired before allocating a new segment
147 * to avoid affecting any of the segments pool readers.
150 segment_manager_add_segment (segment_manager_t * sm, u32 segment_size)
152 segment_manager_main_t *smm = &segment_manager_main;
153 u32 rnd_margin = 128 << 10, seg_index;
154 segment_manager_properties_t *props;
155 uword baseva = (u64) ~ 0, alloc_size;
156 svm_fifo_segment_private_t *seg;
160 props = segment_manager_properties_get (sm);
162 /* Not configured for addition of new segments and not first */
163 if (!props->add_segment && !segment_size)
165 clib_warning ("cannot allocate new segment");
166 return VNET_API_ERROR_INVALID_VALUE;
170 * Allocate fifo segment and lock if needed
172 if (vlib_num_workers ())
174 clib_rwlock_writer_lock (&sm->segments_rwlock);
175 pool_get (sm->segments, seg);
179 pool_get (sm->segments, seg);
181 memset (seg, 0, sizeof (*seg));
184 * Initialize ssvm segment and svm fifo private header
186 segment_size = segment_size ? segment_size : props->add_segment_size;
187 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
189 seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
190 alloc_size = segment_size + rnd_margin;
191 baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
194 clib_warning ("out of space for segments");
199 seg_name = format (0, "%s%c", "process-private-segment", 0);
201 seg->ssvm.ssvm_size = segment_size;
202 seg->ssvm.name = seg_name;
203 seg->ssvm.requested_va = baseva;
205 if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
207 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
210 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
211 clib_valloc_free (&smm->va_allocator, baseva);
212 pool_put (sm->segments, seg);
216 svm_fifo_segment_init (seg);
219 * Save segment index before dropping lock, if any held
221 seg_index = seg - sm->segments;
223 if (vlib_num_workers ())
224 clib_rwlock_writer_unlock (&sm->segments_rwlock);
230 segment_manager_new ()
232 segment_manager_main_t *smm = &segment_manager_main;
233 segment_manager_t *sm;
234 pool_get (smm->segment_managers, sm);
235 memset (sm, 0, sizeof (*sm));
236 clib_rwlock_init (&sm->segments_rwlock);
241 * Initializes segment manager based on options provided.
242 * Returns error if ssvm segment(s) allocation fails.
245 segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
246 u32 evt_q_size, u32 prealloc_fifo_pairs)
248 u32 rx_fifo_size, tx_fifo_size, pair_size;
249 u32 rx_rounded_data_size, tx_rounded_data_size;
250 u64 approx_total_size, max_seg_size =
251 ((u64) 1 << 32) - clib_mem_get_page_size ();
252 segment_manager_properties_t *props;
253 svm_fifo_segment_private_t *segment;
254 u32 approx_segment_count;
257 props = segment_manager_properties_get (sm);
258 first_seg_size = clib_max (first_seg_size, default_segment_size);
260 if (prealloc_fifo_pairs)
262 /* Figure out how many segments should be preallocated */
263 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
264 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
266 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
267 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
268 pair_size = rx_fifo_size + tx_fifo_size;
270 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
271 if (first_seg_size > approx_total_size)
272 max_seg_size = first_seg_size;
273 approx_segment_count = (approx_total_size + (max_seg_size - 1))
276 /* Allocate the segments */
277 for (i = 0; i < approx_segment_count + 1; i++)
279 seg_index = segment_manager_add_segment (sm, max_seg_size);
282 clib_warning ("Failed to preallocate segment %d", i);
287 sm->event_queue = segment_manager_alloc_queue (sm, evt_q_size);
289 segment = segment_manager_get_segment (sm, seg_index);
290 svm_fifo_segment_preallocate_fifo_pairs (segment,
293 &prealloc_fifo_pairs);
294 svm_fifo_segment_flags (segment) = FIFO_SEGMENT_F_IS_PREALLOCATED;
295 if (prealloc_fifo_pairs == 0)
301 seg_index = segment_manager_add_segment (sm, first_seg_size);
304 clib_warning ("Failed to allocate segment");
307 sm->event_queue = segment_manager_alloc_queue (sm, evt_q_size);
314 segment_manager_has_fifos (segment_manager_t * sm)
316 svm_fifo_segment_private_t *seg;
320 segment_manager_foreach_segment_w_lock (seg, sm, ({
321 if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
322 && !(svm_fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
324 clib_warning ("segment %d has no fifos!",
325 segment_manager_segment_index (sm, seg));
328 if (svm_fifo_segment_has_fifos (seg))
330 segment_manager_segment_reader_unlock (sm);
340 * Initiate disconnects for all sessions 'owned' by a segment manager
343 segment_manager_del_sessions (segment_manager_t * sm)
345 svm_fifo_segment_private_t *fifo_segment;
346 stream_session_t *session;
349 ASSERT (pool_elts (sm->segments) != 0);
351 /* Across all fifo segments used by the server */
353 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
354 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
357 * Remove any residual sessions from the session lookup table
358 * Don't bother deleting the individual fifos, we're going to
359 * throw away the fifo segment in a minute.
363 session = session_get (fifo->master_session_index,
364 fifo->master_thread_index);
365 stream_session_disconnect (session);
369 /* Instead of removing the segment, test when cleaning up disconnected
370 * sessions if the segment can be removed.
377 * Removes segment manager.
379 * Since the fifos allocated in the segment keep backpointers to the sessions
380 * prior to removing the segment, we call session disconnect. This
381 * subsequently propagates into transport.
384 segment_manager_del (segment_manager_t * sm)
386 segment_manager_main_t *smm = &segment_manager_main;
387 svm_fifo_segment_private_t *fifo_segment;
389 ASSERT (!segment_manager_has_fifos (sm)
390 && segment_manager_app_detached (sm));
392 /* If we have empty preallocated segments that haven't been removed, remove
393 * them now. Apart from that, the first segment in the first segment manager
394 * is not removed when all fifos are removed. It can only be removed when
395 * the manager is explicitly deleted/detached by the app. */
396 clib_rwlock_writer_lock (&sm->segments_rwlock);
399 pool_foreach (fifo_segment, sm->segments, ({
400 segment_manager_del_segment (sm, fifo_segment);
404 clib_rwlock_writer_unlock (&sm->segments_rwlock);
406 clib_rwlock_free (&sm->segments_rwlock);
408 memset (sm, 0xfe, sizeof (*sm));
409 pool_put (smm->segment_managers, sm);
413 segment_manager_init_del (segment_manager_t * sm)
415 segment_manager_app_detach (sm);
416 if (segment_manager_has_fifos (sm))
417 segment_manager_del_sessions (sm);
420 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
421 segment_manager_del (sm);
426 segment_try_alloc_fifos (svm_fifo_segment_private_t * fifo_segment,
427 u32 rx_fifo_size, u32 tx_fifo_size,
428 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
430 rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
431 *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
432 FIFO_SEGMENT_RX_FREELIST);
434 tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
435 *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
436 FIFO_SEGMENT_TX_FREELIST);
440 /* This would be very odd, but handle it... */
443 svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
444 FIFO_SEGMENT_TX_FREELIST);
453 svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
454 FIFO_SEGMENT_RX_FREELIST);
464 segment_manager_alloc_session_fifos (segment_manager_t * sm,
465 svm_fifo_t ** rx_fifo,
466 svm_fifo_t ** tx_fifo,
467 u32 * fifo_segment_index)
469 svm_fifo_segment_private_t *fifo_segment;
470 int alloc_fail = 1, rv = 0, new_fs_index;
471 segment_manager_properties_t *props;
472 u8 added_a_segment = 0;
475 ASSERT (pool_elts (sm->segments) != 0);
476 props = segment_manager_properties_get (sm);
479 * Find the first free segment to allocate the fifos in
483 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
484 alloc_fail = segment_try_alloc_fifos (fifo_segment, props->rx_fifo_size,
485 props->tx_fifo_size, rx_fifo,
487 /* Exit with lock held, drop it after notifying app */
500 ASSERT (rx_fifo && tx_fifo);
501 sm_index = segment_manager_index (sm);
502 (*tx_fifo)->segment_manager = sm_index;
503 (*rx_fifo)->segment_manager = sm_index;
504 *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
507 rv = application_add_segment_notify (sm->app_index,
508 &fifo_segment->ssvm);
509 /* Drop the lock after app is notified */
510 segment_manager_segment_reader_unlock (sm);
515 * Allocation failed, see if we can add a new segment
517 if (props->add_segment)
521 clib_warning ("Added a segment, still can't allocate a fifo");
522 segment_manager_segment_reader_unlock (sm);
523 return SESSION_ERROR_NEW_SEG_NO_SPACE;
525 if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
527 clib_warning ("Failed to add new segment");
528 return SESSION_ERROR_SEG_CREATE;
530 fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
531 alloc_fail = segment_try_alloc_fifos (fifo_segment, props->rx_fifo_size,
532 props->tx_fifo_size, rx_fifo,
539 clib_warning ("Can't add new seg and no space to allocate fifos!");
540 return SESSION_ERROR_NO_SPACE;
545 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
546 svm_fifo_t * tx_fifo)
548 svm_fifo_segment_private_t *fifo_segment;
549 segment_manager_t *sm;
551 /* It's possible to have no segment manager if the session was removed
552 * as result of a detach. */
553 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
556 fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
557 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
558 FIFO_SEGMENT_RX_FREELIST);
559 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
560 FIFO_SEGMENT_TX_FREELIST);
563 * Try to remove svm segment if it has no fifos. This can be done only if
564 * the segment is not the first in the segment manager or if it is first
565 * and it is not protected. Moreover, if the segment is first and the app
566 * has detached from the segment manager, remove the segment manager.
568 if (!svm_fifo_segment_has_fifos (fifo_segment))
570 segment_manager_segment_reader_unlock (sm);
572 /* Remove segment if it holds no fifos or first but not protected */
573 if (segment_index != 0 || !sm->first_is_protected)
574 segment_manager_lock_and_del_segment (sm, segment_index);
576 /* Remove segment manager if no sessions and detached from app */
577 if (segment_manager_app_detached (sm)
578 && !segment_manager_has_fifos (sm))
579 segment_manager_del (sm);
582 segment_manager_segment_reader_unlock (sm);
586 * Allocates shm queue in the first segment
588 * Must be called with lock held
591 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
593 svm_fifo_segment_private_t *segment;
594 ssvm_shared_header_t *sh;
598 ASSERT (!pool_is_free_index (sm->segments, 0));
600 segment = segment_manager_get_segment (sm, 0);
601 sh = segment->ssvm.sh;
603 oldheap = ssvm_push_heap (sh);
604 q = svm_queue_init (queue_size, sizeof (session_fifo_event_t),
605 0 /* consumer pid */ ,
606 0 /* signal when queue non-empty */ );
607 ssvm_pop_heap (oldheap);
612 * Frees shm queue allocated in the first segment
615 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
617 svm_fifo_segment_private_t *segment;
618 ssvm_shared_header_t *sh;
621 ASSERT (!pool_is_free_index (sm->segments, 0));
623 segment = segment_manager_get_segment_w_lock (sm, 0);
624 sh = segment->ssvm.sh;
626 oldheap = ssvm_push_heap (sh);
628 ssvm_pop_heap (oldheap);
629 segment_manager_segment_reader_unlock (sm);
633 * Init segment vm address allocator
636 segment_manager_main_init (segment_manager_main_init_args_t * a)
638 segment_manager_main_t *sm = &segment_manager_main;
639 clib_valloc_chunk_t _ip, *ip = &_ip;
641 ip->baseva = a->baseva;
644 clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
647 static clib_error_t *
648 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
649 vlib_cli_command_t * cmd)
651 segment_manager_main_t *smm = &segment_manager_main;
652 svm_fifo_segment_private_t *seg;
653 segment_manager_t *sm;
654 u8 show_segments = 0, verbose = 0;
660 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
662 if (unformat (input, "segments"))
664 else if (unformat (input, "verbose"))
667 return clib_error_return (0, "unknown input `%U'",
668 format_unformat_error, input);
670 vlib_cli_output (vm, "%d segment managers allocated",
671 pool_elts (smm->segment_managers));
672 if (verbose && pool_elts (smm->segment_managers))
674 vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
678 pool_foreach (sm, smm->segment_managers, ({
679 vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index(sm),
680 sm->app_index, pool_elts (sm->segments));
687 vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
688 "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
691 pool_foreach (sm, smm->segment_managers, ({
692 segment_manager_foreach_segment_w_lock (seg, sm, ({
693 svm_fifo_segment_info (seg, &address, &size);
694 active_fifos = svm_fifo_segment_num_fifos (seg);
695 free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
696 vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
697 ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
698 seg, size >> 20ULL, active_fifos, free_fifos,
701 vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
711 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
713 .path = "show segment-manager",
714 .short_help = "show segment-manager [segments][verbose]",
715 .function = segment_manager_show_fn,
720 * fd.io coding-style-patch-verification: ON
723 * eval: (c-set-style "gnu")