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 typedef struct segment_manager_main_
22 segment_manager_t *segment_managers; /**< Pool of segment managers */
23 u32 seg_name_counter; /**< Counter for segment names */
28 u32 default_fifo_size; /**< default rx/tx fifo size */
29 u32 default_segment_size; /**< default fifo segment size */
30 u32 default_app_mq_size; /**< default app msg q size */
31 u32 default_max_fifo_size; /**< default max fifo size */
32 u8 default_high_watermark; /**< default high watermark % */
33 u8 default_low_watermark; /**< default low watermark % */
34 } segment_manager_main_t;
36 static segment_manager_main_t sm_main;
38 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY) \
40 clib_rwlock_reader_lock (&(SM)->segments_rwlock); \
41 pool_foreach((VAR), ((SM)->segments)) (BODY); \
42 clib_rwlock_reader_unlock (&(SM)->segments_rwlock); \
45 static segment_manager_props_t *
46 segment_manager_properties_get (segment_manager_t * sm)
48 app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
49 return application_get_segment_manager_properties (app_wrk->app_index);
52 segment_manager_props_t *
53 segment_manager_props_init (segment_manager_props_t * props)
55 props->add_segment_size = sm_main.default_segment_size;
56 props->rx_fifo_size = sm_main.default_fifo_size;
57 props->tx_fifo_size = sm_main.default_fifo_size;
58 props->evt_q_size = sm_main.default_app_mq_size;
59 props->max_fifo_size = sm_main.default_max_fifo_size;
60 props->high_watermark = sm_main.default_high_watermark;
61 props->low_watermark = sm_main.default_low_watermark;
62 props->n_slices = vlib_num_workers () + 1;
67 segment_manager_app_detached (segment_manager_t * sm)
69 return (sm->flags & SEG_MANAGER_F_DETACHED);
73 segment_manager_app_detach (segment_manager_t * sm)
75 sm->flags |= SEG_MANAGER_F_DETACHED;
79 segment_manager_segment_index (segment_manager_t * sm, fifo_segment_t * seg)
81 return (seg - sm->segments);
85 * Adds segment to segment manager's pool
87 * If needed a writer's lock is acquired before allocating a new segment
88 * to avoid affecting any of the segments pool readers.
91 segment_manager_add_segment_inline (segment_manager_t *sm, uword segment_size,
92 u8 notify_app, u8 flags, u8 need_lock)
94 segment_manager_main_t *smm = &sm_main;
95 segment_manager_props_t *props;
96 app_worker_t *app_wrk;
102 props = segment_manager_properties_get (sm);
103 app_wrk = app_worker_get (sm->app_wrk_index);
105 /* Not configured for addition of new segments and not first */
106 if (!props->add_segment && !segment_size)
108 clib_warning ("cannot allocate new segment");
109 return VNET_API_ERROR_INVALID_VALUE;
113 * Allocate fifo segment and grab lock if needed
116 clib_rwlock_writer_lock (&sm->segments_rwlock);
118 pool_get_zero (sm->segments, fs);
121 * Allocate ssvm segment
123 segment_size = segment_size ? segment_size : props->add_segment_size;
124 /* add overhead to ensure the result segment size is at least
125 * of that requested */
127 sizeof (fifo_segment_header_t) +
128 vlib_thread_main.n_vlib_mains * sizeof (fifo_segment_slice_t) +
129 FIFO_SEGMENT_ALLOC_OVERHEAD;
130 segment_size = round_pow2 (segment_size, clib_mem_get_page_size ());
132 seg_name = format (0, "seg-%u-%u-%u%c", app_wrk->app_index,
133 app_wrk->wrk_index, smm->seg_name_counter++, 0);
135 fs->ssvm.ssvm_size = segment_size;
136 fs->ssvm.name = seg_name;
137 fs->ssvm.requested_va = 0;
139 if ((rv = ssvm_server_init (&fs->ssvm, props->segment_type)))
141 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
143 pool_put (sm->segments, fs);
148 * Initialize fifo segment
150 fs->n_slices = props->n_slices;
151 fifo_segment_init (fs);
154 * Save segment index before dropping lock, if any held
156 fs_index = fs - sm->segments;
157 fs->fs_index = fs_index;
158 fs->sm_index = segment_manager_index (sm);
161 * Set watermarks in segment
163 fs->high_watermark = sm->high_watermark;
164 fs->low_watermark = sm->low_watermark;
166 fs->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
167 fs->h->pct_first_alloc = props->pct_first_alloc;
171 app_worker_t *app_wrk;
173 fs_handle = segment_manager_segment_handle (sm, fs);
174 app_wrk = app_worker_get (sm->app_wrk_index);
175 rv = app_worker_add_segment_notify (app_wrk, fs_handle);
185 clib_rwlock_writer_unlock (&sm->segments_rwlock);
191 segment_manager_add_segment (segment_manager_t *sm, uword segment_size,
194 return segment_manager_add_segment_inline (sm, segment_size, notify_app,
195 0 /* flags */, 0 /* need_lock */);
199 segment_manager_add_segment2 (segment_manager_t *sm, uword segment_size,
202 return segment_manager_add_segment_inline (sm, segment_size, 0, flags,
203 vlib_num_workers ());
207 * Remove segment without lock
210 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
212 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
214 if (!segment_manager_app_detached (sm))
216 app_worker_t *app_wrk;
218 app_wrk = app_worker_get (sm->app_wrk_index);
219 segment_handle = segment_manager_segment_handle (sm, fs);
220 app_worker_del_segment_notify (app_wrk, segment_handle);
224 fifo_segment_cleanup (fs);
225 ssvm_delete (&fs->ssvm);
228 clib_memset (fs, 0xfb, sizeof (*fs));
229 pool_put (sm->segments, fs);
232 static fifo_segment_t *
233 segment_manager_get_segment_if_valid (segment_manager_t * sm,
236 if (pool_is_free_index (sm->segments, segment_index))
238 return pool_elt_at_index (sm->segments, segment_index);
242 * Removes segment after acquiring writer lock
245 sm_lock_and_del_segment_inline (segment_manager_t *sm, u32 fs_index,
251 clib_rwlock_writer_lock (&sm->segments_rwlock);
253 fs = segment_manager_get_segment_if_valid (sm, fs_index);
257 if (check_if_empty && fifo_segment_has_fifos (fs))
260 is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
261 if (is_prealloc && !segment_manager_app_detached (sm))
264 segment_manager_del_segment (sm, fs);
267 clib_rwlock_writer_unlock (&sm->segments_rwlock);
271 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
273 sm_lock_and_del_segment_inline (sm, fs_index, 0 /* check_if_empty */);
277 * Reads a segment from the segment manager's pool without lock
280 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
282 return pool_elt_at_index (sm->segments, segment_index);
286 segment_manager_segment_handle (segment_manager_t * sm,
287 fifo_segment_t * segment)
289 u32 segment_index = segment_manager_segment_index (sm, segment);
290 return (((u64) segment_manager_index (sm) << 32) | segment_index);
294 segment_manager_make_segment_handle (u32 segment_manager_index,
297 return (((u64) segment_manager_index << 32) | segment_index);
301 segment_manager_get_segment_w_handle (u64 segment_handle)
303 u32 sm_index, segment_index;
304 segment_manager_t *sm;
306 segment_manager_parse_segment_handle (segment_handle, &sm_index,
308 sm = segment_manager_get (sm_index);
309 if (!sm || pool_is_free_index (sm->segments, segment_index))
311 return pool_elt_at_index (sm->segments, segment_index);
315 * Reads a segment from the segment manager's pool and acquires reader lock
317 * Caller must drop the reader's lock by calling
318 * @ref segment_manager_segment_reader_unlock once it finishes working with
322 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
324 clib_rwlock_reader_lock (&sm->segments_rwlock);
325 return pool_elt_at_index (sm->segments, segment_index);
329 segment_manager_segment_reader_lock (segment_manager_t * sm)
331 clib_rwlock_reader_lock (&sm->segments_rwlock);
335 segment_manager_segment_reader_unlock (segment_manager_t * sm)
337 clib_rwlock_reader_unlock (&sm->segments_rwlock);
341 segment_manager_alloc (void)
343 segment_manager_main_t *smm = &sm_main;
344 segment_manager_t *sm;
346 pool_get_zero (smm->segment_managers, sm);
347 clib_rwlock_init (&sm->segments_rwlock);
352 segment_manager_init (segment_manager_t * sm)
354 segment_manager_props_t *props;
356 props = segment_manager_properties_get (sm);
358 sm->max_fifo_size = props->max_fifo_size ?
359 props->max_fifo_size : sm_main.default_max_fifo_size;
360 sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
362 segment_manager_set_watermarks (sm,
363 props->high_watermark,
364 props->low_watermark);
369 * Initializes segment manager based on options provided.
370 * Returns error if ssvm segment(s) allocation fails.
373 segment_manager_init_first (segment_manager_t * sm)
375 segment_manager_props_t *props;
376 uword first_seg_size;
380 segment_manager_init (sm);
381 props = segment_manager_properties_get (sm);
382 first_seg_size = clib_max (props->segment_size,
383 sm_main.default_segment_size);
385 if (props->prealloc_fifos)
387 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
388 u32 rx_rounded_data_size, tx_rounded_data_size;
389 u32 prealloc_fifo_pairs = props->prealloc_fifos;
390 u32 rx_fifo_size, tx_fifo_size, pair_size;
391 u32 approx_segment_count;
393 /* Figure out how many segments should be preallocated */
394 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
395 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
397 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
398 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
399 pair_size = rx_fifo_size + tx_fifo_size;
401 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
402 if (first_seg_size > approx_total_size)
403 max_seg_size = first_seg_size;
404 approx_segment_count = (approx_total_size + (max_seg_size - 1))
407 /* Allocate the segments */
408 for (i = 0; i < approx_segment_count + 1; i++)
410 fs_index = segment_manager_add_segment (sm, max_seg_size, 0);
413 clib_warning ("Failed to preallocate segment %d", i);
417 fs = segment_manager_get_segment (sm, fs_index);
419 sm->event_queue = segment_manager_alloc_queue (fs, props);
421 fifo_segment_preallocate_fifo_pairs (fs,
424 &prealloc_fifo_pairs);
425 fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
426 if (prealloc_fifo_pairs == 0)
432 fs_index = segment_manager_add_segment (sm, first_seg_size, 0);
435 clib_warning ("Failed to allocate segment");
439 fs = segment_manager_get_segment (sm, fs_index);
440 sm->event_queue = segment_manager_alloc_queue (fs, props);
442 if (props->prealloc_fifo_hdrs)
446 /* Do not preallocate on slice associated to main thread */
447 i = (vlib_num_workers ()? 1 : 0);
448 hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
450 for (; i < fs->n_slices; i++)
452 if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
453 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
461 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
463 app_worker_t *app_wrk;
465 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
469 app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
473 * Cleanup segment manager.
476 segment_manager_free (segment_manager_t * sm)
478 segment_manager_main_t *smm = &sm_main;
479 fifo_segment_t *fifo_segment;
481 ASSERT (vlib_get_thread_index () == 0
482 && !segment_manager_has_fifos (sm)
483 && segment_manager_app_detached (sm));
485 if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
486 segment_manager_cleanup_detached_listener (sm);
488 /* If we have empty preallocated segments that haven't been removed, remove
489 * them now. Apart from that, the first segment in the first segment manager
490 * is not removed when all fifos are removed. It can only be removed when
491 * the manager is explicitly deleted/detached by the app. */
492 clib_rwlock_writer_lock (&sm->segments_rwlock);
495 pool_foreach (fifo_segment, sm->segments) {
496 segment_manager_del_segment (sm, fifo_segment);
500 pool_free (sm->segments);
501 clib_rwlock_writer_unlock (&sm->segments_rwlock);
503 clib_rwlock_free (&sm->segments_rwlock);
505 clib_memset (sm, 0xfe, sizeof (*sm));
506 pool_put (smm->segment_managers, sm);
510 sm_free_w_index_helper (void *arg)
512 u32 sm_index = *(u32 *) arg;
513 segment_manager_t *sm;
515 ASSERT (vlib_get_thread_index () == 0);
517 if ((sm = segment_manager_get_if_valid (sm_index)))
518 segment_manager_free (sm);
522 segment_manager_free_safe (segment_manager_t *sm)
524 if (!vlib_thread_is_main_w_barrier ())
526 u32 sm_index = segment_manager_index (sm);
527 vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
532 segment_manager_free (sm);
537 segment_manager_init_free (segment_manager_t * sm)
539 ASSERT (vlib_get_thread_index () == 0);
541 segment_manager_app_detach (sm);
542 if (segment_manager_has_fifos (sm))
543 segment_manager_del_sessions (sm);
546 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
547 segment_manager_free (sm);
552 segment_manager_get (u32 index)
554 return pool_elt_at_index (sm_main.segment_managers, index);
558 segment_manager_get_if_valid (u32 index)
560 if (pool_is_free_index (sm_main.segment_managers, index))
562 return pool_elt_at_index (sm_main.segment_managers, index);
566 segment_manager_index (segment_manager_t * sm)
568 return sm - sm_main.segment_managers;
572 segment_manager_has_fifos (segment_manager_t * sm)
578 segment_manager_foreach_segment_w_lock (seg, sm, ({
579 if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
580 && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
582 clib_warning ("segment %d has no fifos!",
583 segment_manager_segment_index (sm, seg));
586 if (fifo_segment_has_fifos (seg))
588 segment_manager_segment_reader_unlock (sm);
598 * Initiate disconnects for all sessions 'owned' by a segment manager
601 segment_manager_del_sessions (segment_manager_t * sm)
603 session_handle_t *handles = 0, *handle;
609 ASSERT (pool_elts (sm->segments) != 0);
611 /* Across all fifo segments used by the server */
613 segment_manager_foreach_segment_w_lock (fs, sm, ({
614 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
616 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
619 * Remove any residual sessions from the session lookup table
620 * Don't bother deleting the individual fifos, we're going to
621 * throw away the fifo segment in a minute.
625 session = session_get_if_valid (f->shr->master_session_index,
626 f->master_thread_index);
628 vec_add1 (handles, session_handle (session));
633 /* Instead of removing the segment, test when cleaning up disconnected
634 * sessions if the segment can be removed.
639 vec_foreach (handle, handles)
641 session = session_get_from_handle (*handle);
642 session_close (session);
643 /* Avoid propagating notifications back to the app */
644 session->app_wrk_index = APP_INVALID_INDEX;
650 * Initiate disconnects for sessions in specified state 'owned' by a segment
654 segment_manager_del_sessions_filter (segment_manager_t *sm,
655 session_state_t *states)
657 session_handle_t *handles = 0, *handle;
663 ASSERT (pool_elts (sm->segments) != 0);
665 /* Across all fifo segments used by the server */
666 segment_manager_foreach_segment_w_lock (
668 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
670 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
673 session = session_get_if_valid (f->shr->master_session_index,
674 f->master_thread_index);
677 session_state_t *state;
678 vec_foreach (state, states)
680 if (session->session_state == *state)
682 vec_add1 (handles, session_handle (session));
692 vec_foreach (handle, handles)
694 session = session_get_from_handle (*handle);
695 session_close (session);
696 /* Avoid propagating notifications back to the app */
697 session->app_wrk_index = APP_INVALID_INDEX;
703 segment_manager_try_alloc_fifos (fifo_segment_t *fs, u32 thread_index,
704 u32 rx_fifo_size, u32 tx_fifo_size,
705 svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
707 rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
708 *rx_fifo = fifo_segment_alloc_fifo_w_slice (fs, thread_index, rx_fifo_size,
709 FIFO_SEGMENT_RX_FIFO);
711 tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
712 *tx_fifo = fifo_segment_alloc_fifo_w_slice (fs, thread_index, tx_fifo_size,
713 FIFO_SEGMENT_TX_FIFO);
717 /* This would be very odd, but handle it... */
720 fifo_segment_free_fifo (fs, *tx_fifo);
723 return SESSION_E_SEG_NO_SPACE;
729 fifo_segment_free_fifo (fs, *rx_fifo);
732 return SESSION_E_SEG_NO_SPACE;
739 sm_lookup_segment_and_alloc_fifos (segment_manager_t *sm,
740 segment_manager_props_t *props,
741 u32 thread_index, svm_fifo_t **rx_fifo,
742 svm_fifo_t **tx_fifo)
744 uword free_bytes, max_free_bytes;
745 fifo_segment_t *cur, *fs = 0;
747 max_free_bytes = props->rx_fifo_size + props->tx_fifo_size - 1;
749 pool_foreach (cur, sm->segments)
751 if (fifo_segment_flags (cur) & FIFO_SEGMENT_F_CUSTOM_USE)
753 free_bytes = fifo_segment_available_bytes (cur);
754 if (free_bytes > max_free_bytes)
756 max_free_bytes = free_bytes;
761 if (PREDICT_FALSE (!fs))
762 return SESSION_E_SEG_NO_SPACE;
764 return segment_manager_try_alloc_fifos (
765 fs, thread_index, props->rx_fifo_size, props->tx_fifo_size, rx_fifo,
770 sm_lock_and_alloc_segment_and_fifos (segment_manager_t *sm,
771 segment_manager_props_t *props,
772 u32 thread_index, svm_fifo_t **rx_fifo,
773 svm_fifo_t **tx_fifo)
775 int new_fs_index, rv;
778 if (!props->add_segment)
779 return SESSION_E_SEG_NO_SPACE;
781 clib_rwlock_writer_lock (&sm->segments_rwlock);
783 /* Make sure there really is no free space. Another worker might've freed
784 * some fifos or allocated a segment */
785 rv = sm_lookup_segment_and_alloc_fifos (sm, props, thread_index, rx_fifo,
791 segment_manager_add_segment (sm, 0 /* segment_size*/, 1 /* notify_app */);
792 if (new_fs_index < 0)
794 rv = SESSION_E_SEG_CREATE;
797 fs = segment_manager_get_segment (sm, new_fs_index);
798 rv = segment_manager_try_alloc_fifos (fs, thread_index, props->rx_fifo_size,
799 props->tx_fifo_size, rx_fifo, tx_fifo);
802 clib_warning ("Added a segment, still can't allocate a fifo");
803 rv = SESSION_E_SEG_NO_SPACE2;
809 clib_rwlock_writer_unlock (&sm->segments_rwlock);
815 segment_manager_alloc_session_fifos (segment_manager_t * sm,
817 svm_fifo_t ** rx_fifo,
818 svm_fifo_t ** tx_fifo)
820 segment_manager_props_t *props;
823 props = segment_manager_properties_get (sm);
826 * Fast path: find the first segment with enough free space and
827 * try to allocate the fifos. Done with reader lock
830 segment_manager_segment_reader_lock (sm);
832 rv = sm_lookup_segment_and_alloc_fifos (sm, props, thread_index, rx_fifo,
835 segment_manager_segment_reader_unlock (sm);
838 * Slow path: if no fifo segment or alloc fail grab writer lock and try
839 * to allocate new segment
841 if (PREDICT_FALSE (rv < 0))
842 return sm_lock_and_alloc_segment_and_fifos (sm, props, thread_index,
849 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
851 segment_manager_t *sm;
856 if (!rx_fifo || !tx_fifo)
859 /* It's possible to have no segment manager if the session was removed
860 * as result of a detach. */
861 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
864 segment_index = rx_fifo->segment_index;
865 fs = segment_manager_get_segment_w_lock (sm, segment_index);
866 fifo_segment_free_fifo (fs, rx_fifo);
867 fifo_segment_free_fifo (fs, tx_fifo);
870 * Try to remove fifo segment if it has no fifos. This can be done only if
871 * the segment is not the first in the segment manager or if it is first
872 * and it is not protected. Moreover, if the segment is first and the app
873 * has detached from the segment manager, remove the segment manager.
875 if (!fifo_segment_has_fifos (fs))
877 /* If first, remove only if not protected */
878 try_delete = segment_index != 0 || !sm->first_is_protected;
881 segment_manager_segment_reader_unlock (sm);
883 if (PREDICT_FALSE (try_delete))
885 /* Only remove if empty after writer lock acquired */
886 sm_lock_and_del_segment_inline (sm, segment_index,
887 1 /* check_if_empty */);
889 /* Remove segment manager if no sessions and detached from app */
890 if (segment_manager_app_detached (sm)
891 && !segment_manager_has_fifos (sm))
892 segment_manager_free_safe (sm);
897 segment_manager_detach_fifo (segment_manager_t *sm, svm_fifo_t **f)
901 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
902 fifo_segment_detach_fifo (fs, f);
903 segment_manager_segment_reader_unlock (sm);
907 segment_manager_attach_fifo (segment_manager_t *sm, svm_fifo_t **f,
912 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
913 fifo_segment_attach_fifo (fs, f, s->thread_index);
914 segment_manager_segment_reader_unlock (sm);
916 (*f)->shr->master_session_index = s->session_index;
917 (*f)->master_thread_index = s->thread_index;
921 segment_manager_evt_q_expected_size (u32 q_len)
923 u32 fifo_evt_size, notif_q_size, q_hdrs;
924 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
926 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
927 notif_q_size = clib_max (16, q_len >> 4);
929 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
930 fifo_evt_ring_sz = q_len * fifo_evt_size;
931 session_ntf_ring_sz = notif_q_size * 256;
932 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
934 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
938 * Allocates shm queue in the first segment
940 * Must be called with lock held
943 segment_manager_alloc_queue (fifo_segment_t * segment,
944 segment_manager_props_t * props)
946 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
947 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
950 fifo_evt_size = sizeof (session_event_t);
951 notif_q_size = clib_max (16, props->evt_q_size >> 4);
953 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
954 {props->evt_q_size, fifo_evt_size, 0},
955 {notif_q_size, session_evt_size, 0}
958 cfg->consumer_pid = 0;
960 cfg->q_nitems = props->evt_q_size;
963 q = fifo_segment_msg_q_alloc (segment, 0, cfg);
965 if (props->use_mq_eventfd)
967 if (svm_msg_q_alloc_eventfd (q))
968 clib_warning ("failed to alloc eventfd");
974 segment_manager_event_queue (segment_manager_t * sm)
976 return sm->event_queue;
980 * Frees shm queue allocated in the first segment
983 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
985 fifo_segment_t *segment;
986 ssvm_shared_header_t *sh;
989 ASSERT (!pool_is_free_index (sm->segments, 0));
991 segment = segment_manager_get_segment_w_lock (sm, 0);
992 sh = segment->ssvm.sh;
994 oldheap = ssvm_push_heap (sh);
996 ssvm_pop_heap (oldheap);
997 segment_manager_segment_reader_unlock (sm);
1001 * Init segment vm address allocator
1004 segment_manager_main_init (void)
1006 segment_manager_main_t *sm = &sm_main;
1008 sm->default_fifo_size = 1 << 12;
1009 sm->default_segment_size = 1 << 20;
1010 sm->default_app_mq_size = 128;
1011 sm->default_max_fifo_size = 4 << 20;
1012 sm->default_high_watermark = 80;
1013 sm->default_low_watermark = 50;
1017 format_segment_manager (u8 *s, va_list *args)
1019 segment_manager_t *sm = va_arg (*args, segment_manager_t *);
1020 int verbose = va_arg (*args, int);
1021 app_worker_t *app_wrk;
1022 uword max_fifo_size;
1023 fifo_segment_t *seg;
1027 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
1028 app = app_wrk ? application_get (app_wrk->app_index) : 0;
1029 custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
1030 max_fifo_size = sm->max_fifo_size;
1033 "[%u] %v app-wrk: %u segs: %u max-fifo-sz: %U "
1034 "wmarks: %u %u %s flags: 0x%x",
1035 segment_manager_index (sm), app ? app->name : 0,
1036 sm->app_wrk_index, pool_elts (sm->segments), format_memory_size,
1037 max_fifo_size, sm->high_watermark, sm->low_watermark,
1038 custom_logic ? "custom-tuning" : "no-tuning", sm->flags);
1040 if (!verbose || !pool_elts (sm->segments))
1043 s = format (s, "\n\n");
1045 segment_manager_foreach_segment_w_lock (
1046 seg, sm, ({ s = format (s, " *%U", format_fifo_segment, seg, verbose); }));
1051 static clib_error_t *
1052 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
1053 vlib_cli_command_t * cmd)
1055 unformat_input_t _line_input, *line_input = &_line_input;
1056 segment_manager_main_t *smm = &sm_main;
1057 u8 show_segments = 0, verbose = 0;
1058 segment_manager_t *sm;
1061 if (!unformat_user (input, unformat_line_input, line_input))
1063 vlib_cli_output (vm, "%d segment managers allocated",
1064 pool_elts (smm->segment_managers));
1068 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1070 if (unformat (line_input, "segments"))
1072 else if (unformat (line_input, "verbose"))
1074 else if (unformat (line_input, "index %u", &sm_index))
1078 vlib_cli_output (vm, "unknown input [%U]", format_unformat_error,
1084 if (!pool_elts (smm->segment_managers))
1089 sm = segment_manager_get_if_valid (sm_index);
1092 vlib_cli_output (vm, "segment manager %u not allocated", sm_index);
1095 vlib_cli_output (vm, "%U", format_segment_manager, sm, 1 /* verbose */);
1099 if (verbose || show_segments)
1101 pool_foreach (sm, smm->segment_managers) {
1102 vlib_cli_output (vm, "%U", format_segment_manager, sm,
1106 vlib_cli_output (vm, "\n");
1111 unformat_free (line_input);
1117 VLIB_CLI_COMMAND (segment_manager_show_command, static) = {
1118 .path = "show segment-manager",
1119 .short_help = "show segment-manager [segments][verbose][index <nn>]",
1120 .function = segment_manager_show_fn,
1125 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1127 vlib_main_t *vm = vlib_get_main ();
1128 app_worker_t *app_wrk;
1138 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s%-15s%-10s",
1139 "Connection", "App", "API Client", "SegManager");
1141 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s", "Connection",
1146 app_wrk = app_worker_get (sm->app_wrk_index);
1147 app_name = application_name_from_index (app_wrk->app_index);
1149 clib_rwlock_reader_lock (&sm->segments_rwlock);
1152 pool_foreach (fs, sm->segments) {
1153 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1155 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1158 u32 session_index, thread_index;
1161 session_index = f->shr->master_session_index;
1162 thread_index = f->master_thread_index;
1164 session = session_get (session_index, thread_index);
1165 str = format (0, "%U", format_session, session, verbose);
1168 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v%-15u%-10u", str,
1169 app_name, app_wrk->api_client_index,
1170 app_wrk->connects_seg_manager);
1172 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v", str, app_name);
1174 vlib_cli_output (vm, "%v", s);
1175 vec_reset_length (s);
1185 clib_rwlock_reader_unlock (&sm->segments_rwlock);
1189 segment_manager_set_watermarks (segment_manager_t * sm,
1190 u8 high_watermark, u8 low_watermark)
1192 ASSERT (high_watermark <= 100 && low_watermark <= 100 &&
1193 low_watermark <= high_watermark);
1195 sm->high_watermark = high_watermark;
1196 sm->low_watermark = low_watermark;
1200 * fd.io coding-style-patch-verification: ON
1203 * eval: (c-set-style "gnu")