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)
94 segment_manager_main_t *smm = &sm_main;
95 segment_manager_props_t *props;
101 props = segment_manager_properties_get (sm);
103 /* Not configured for addition of new segments and not first */
104 if (!props->add_segment && !segment_size)
106 clib_warning ("cannot allocate new segment");
107 return VNET_API_ERROR_INVALID_VALUE;
111 * Allocate fifo segment and grab lock if needed
113 if (vlib_num_workers ())
114 clib_rwlock_writer_lock (&sm->segments_rwlock);
116 pool_get_zero (sm->segments, fs);
119 * Allocate ssvm segment
121 segment_size = segment_size ? segment_size : props->add_segment_size;
122 /* add overhead to ensure the result segment size is at least
123 * of that requested */
125 sizeof (fifo_segment_header_t) +
126 vlib_thread_main.n_vlib_mains * sizeof (fifo_segment_slice_t) +
127 FIFO_SEGMENT_ALLOC_OVERHEAD;
128 segment_size = round_pow2 (segment_size, clib_mem_get_page_size ());
130 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
132 seg_name = format (0, "%d-%d%c", getpid (), smm->seg_name_counter++, 0);
136 app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
137 application_t *app = application_get (app_wrk->app_index);
138 seg_name = format (0, "%v segment%c", app->name, 0);
141 fs->ssvm.ssvm_size = segment_size;
142 fs->ssvm.name = seg_name;
143 fs->ssvm.requested_va = 0;
145 if ((rv = ssvm_server_init (&fs->ssvm, props->segment_type)))
147 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
149 pool_put (sm->segments, fs);
154 * Initialize fifo segment
156 fs->n_slices = props->n_slices;
157 fifo_segment_init (fs);
160 * Save segment index before dropping lock, if any held
162 fs_index = fs - sm->segments;
165 * Set watermarks in segment
167 fs->high_watermark = sm->high_watermark;
168 fs->low_watermark = sm->low_watermark;
170 fs->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
171 fs->h->pct_first_alloc = props->pct_first_alloc;
175 app_worker_t *app_wrk;
177 fs_handle = segment_manager_segment_handle (sm, fs);
178 app_wrk = app_worker_get (sm->app_wrk_index);
179 rv = app_worker_add_segment_notify (app_wrk, fs_handle);
188 if (vlib_num_workers ())
189 clib_rwlock_writer_unlock (&sm->segments_rwlock);
195 segment_manager_add_segment (segment_manager_t *sm, uword segment_size,
198 return segment_manager_add_segment_inline (sm, segment_size, notify_app, 0);
202 segment_manager_add_segment2 (segment_manager_t *sm, uword segment_size,
205 return segment_manager_add_segment_inline (sm, segment_size, 0, flags);
209 * Remove segment without lock
212 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
214 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
216 if (!segment_manager_app_detached (sm))
218 app_worker_t *app_wrk;
220 app_wrk = app_worker_get (sm->app_wrk_index);
221 segment_handle = segment_manager_segment_handle (sm, fs);
222 app_worker_del_segment_notify (app_wrk, segment_handle);
226 fifo_segment_cleanup (fs);
227 ssvm_delete (&fs->ssvm);
230 clib_memset (fs, 0xfb, sizeof (*fs));
231 pool_put (sm->segments, fs);
234 static fifo_segment_t *
235 segment_manager_get_segment_if_valid (segment_manager_t * sm,
238 if (pool_is_free_index (sm->segments, segment_index))
240 return pool_elt_at_index (sm->segments, segment_index);
244 * Removes segment after acquiring writer lock
247 sm_lock_and_del_segment_inline (segment_manager_t *sm, u32 fs_index,
253 clib_rwlock_writer_lock (&sm->segments_rwlock);
255 fs = segment_manager_get_segment_if_valid (sm, fs_index);
259 if (check_if_empty && fifo_segment_has_fifos (fs))
262 is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
263 if (is_prealloc && !segment_manager_app_detached (sm))
266 segment_manager_del_segment (sm, fs);
269 clib_rwlock_writer_unlock (&sm->segments_rwlock);
273 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
275 sm_lock_and_del_segment_inline (sm, fs_index, 0 /* check_if_empty */);
279 * Reads a segment from the segment manager's pool without lock
282 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
284 return pool_elt_at_index (sm->segments, segment_index);
288 segment_manager_segment_handle (segment_manager_t * sm,
289 fifo_segment_t * segment)
291 u32 segment_index = segment_manager_segment_index (sm, segment);
292 return (((u64) segment_manager_index (sm) << 32) | segment_index);
296 segment_manager_make_segment_handle (u32 segment_manager_index,
299 return (((u64) segment_manager_index << 32) | segment_index);
303 segment_manager_get_segment_w_handle (u64 segment_handle)
305 u32 sm_index, segment_index;
306 segment_manager_t *sm;
308 segment_manager_parse_segment_handle (segment_handle, &sm_index,
310 sm = segment_manager_get (sm_index);
311 if (!sm || pool_is_free_index (sm->segments, segment_index))
313 return pool_elt_at_index (sm->segments, segment_index);
317 * Reads a segment from the segment manager's pool and acquires reader lock
319 * Caller must drop the reader's lock by calling
320 * @ref segment_manager_segment_reader_unlock once it finishes working with
324 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
326 clib_rwlock_reader_lock (&sm->segments_rwlock);
327 return pool_elt_at_index (sm->segments, segment_index);
331 segment_manager_segment_reader_lock (segment_manager_t * sm)
333 clib_rwlock_reader_lock (&sm->segments_rwlock);
337 segment_manager_segment_reader_unlock (segment_manager_t * sm)
339 clib_rwlock_reader_unlock (&sm->segments_rwlock);
343 segment_manager_segment_writer_unlock (segment_manager_t * sm)
345 clib_rwlock_writer_unlock (&sm->segments_rwlock);
349 segment_manager_alloc (void)
351 segment_manager_main_t *smm = &sm_main;
352 segment_manager_t *sm;
354 pool_get_zero (smm->segment_managers, sm);
355 clib_rwlock_init (&sm->segments_rwlock);
360 segment_manager_init (segment_manager_t * sm)
362 segment_manager_props_t *props;
364 props = segment_manager_properties_get (sm);
366 sm->max_fifo_size = props->max_fifo_size ?
367 props->max_fifo_size : sm_main.default_max_fifo_size;
368 sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
370 segment_manager_set_watermarks (sm,
371 props->high_watermark,
372 props->low_watermark);
377 * Initializes segment manager based on options provided.
378 * Returns error if ssvm segment(s) allocation fails.
381 segment_manager_init_first (segment_manager_t * sm)
383 segment_manager_props_t *props;
384 uword first_seg_size;
388 segment_manager_init (sm);
389 props = segment_manager_properties_get (sm);
390 first_seg_size = clib_max (props->segment_size,
391 sm_main.default_segment_size);
393 if (props->prealloc_fifos)
395 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
396 u32 rx_rounded_data_size, tx_rounded_data_size;
397 u32 prealloc_fifo_pairs = props->prealloc_fifos;
398 u32 rx_fifo_size, tx_fifo_size, pair_size;
399 u32 approx_segment_count;
401 /* Figure out how many segments should be preallocated */
402 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
403 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
405 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
406 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
407 pair_size = rx_fifo_size + tx_fifo_size;
409 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
410 if (first_seg_size > approx_total_size)
411 max_seg_size = first_seg_size;
412 approx_segment_count = (approx_total_size + (max_seg_size - 1))
415 /* Allocate the segments */
416 for (i = 0; i < approx_segment_count + 1; i++)
418 fs_index = segment_manager_add_segment (sm, max_seg_size, 0);
421 clib_warning ("Failed to preallocate segment %d", i);
425 fs = segment_manager_get_segment (sm, fs_index);
427 sm->event_queue = segment_manager_alloc_queue (fs, props);
429 fifo_segment_preallocate_fifo_pairs (fs,
432 &prealloc_fifo_pairs);
433 fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
434 if (prealloc_fifo_pairs == 0)
440 fs_index = segment_manager_add_segment (sm, first_seg_size, 0);
443 clib_warning ("Failed to allocate segment");
447 fs = segment_manager_get_segment (sm, fs_index);
448 sm->event_queue = segment_manager_alloc_queue (fs, props);
450 if (props->prealloc_fifo_hdrs)
454 /* Do not preallocate on slice associated to main thread */
455 i = (vlib_num_workers ()? 1 : 0);
456 hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
458 for (; i < fs->n_slices; i++)
460 if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
461 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
469 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
471 app_worker_t *app_wrk;
473 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
477 app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
481 * Cleanup segment manager.
484 segment_manager_free (segment_manager_t * sm)
486 segment_manager_main_t *smm = &sm_main;
487 fifo_segment_t *fifo_segment;
489 ASSERT (vlib_get_thread_index () == 0
490 && !segment_manager_has_fifos (sm)
491 && segment_manager_app_detached (sm));
493 if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
494 segment_manager_cleanup_detached_listener (sm);
496 /* If we have empty preallocated segments that haven't been removed, remove
497 * them now. Apart from that, the first segment in the first segment manager
498 * is not removed when all fifos are removed. It can only be removed when
499 * the manager is explicitly deleted/detached by the app. */
500 clib_rwlock_writer_lock (&sm->segments_rwlock);
503 pool_foreach (fifo_segment, sm->segments) {
504 segment_manager_del_segment (sm, fifo_segment);
508 pool_free (sm->segments);
509 clib_rwlock_writer_unlock (&sm->segments_rwlock);
511 clib_rwlock_free (&sm->segments_rwlock);
513 clib_memset (sm, 0xfe, sizeof (*sm));
514 pool_put (smm->segment_managers, sm);
518 sm_free_w_index_helper (void *arg)
520 u32 sm_index = *(u32 *) arg;
521 segment_manager_t *sm;
523 ASSERT (vlib_get_thread_index () == 0);
525 if ((sm = segment_manager_get_if_valid (sm_index)))
526 segment_manager_free (sm);
530 segment_manager_free_safe (segment_manager_t *sm)
532 if (!vlib_thread_is_main_w_barrier ())
534 u32 sm_index = segment_manager_index (sm);
535 vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
540 segment_manager_free (sm);
545 segment_manager_init_free (segment_manager_t * sm)
547 ASSERT (vlib_get_thread_index () == 0);
549 segment_manager_app_detach (sm);
550 if (segment_manager_has_fifos (sm))
551 segment_manager_del_sessions (sm);
554 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
555 segment_manager_free (sm);
560 segment_manager_get (u32 index)
562 return pool_elt_at_index (sm_main.segment_managers, index);
566 segment_manager_get_if_valid (u32 index)
568 if (pool_is_free_index (sm_main.segment_managers, index))
570 return pool_elt_at_index (sm_main.segment_managers, index);
574 segment_manager_index (segment_manager_t * sm)
576 return sm - sm_main.segment_managers;
580 segment_manager_has_fifos (segment_manager_t * sm)
586 segment_manager_foreach_segment_w_lock (seg, sm, ({
587 if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
588 && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
590 clib_warning ("segment %d has no fifos!",
591 segment_manager_segment_index (sm, seg));
594 if (fifo_segment_has_fifos (seg))
596 segment_manager_segment_reader_unlock (sm);
606 * Initiate disconnects for all sessions 'owned' by a segment manager
609 segment_manager_del_sessions (segment_manager_t * sm)
611 session_handle_t *handles = 0, *handle;
617 ASSERT (pool_elts (sm->segments) != 0);
619 /* Across all fifo segments used by the server */
621 segment_manager_foreach_segment_w_lock (fs, sm, ({
622 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
624 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
627 * Remove any residual sessions from the session lookup table
628 * Don't bother deleting the individual fifos, we're going to
629 * throw away the fifo segment in a minute.
633 session = session_get_if_valid (f->shr->master_session_index,
634 f->master_thread_index);
636 vec_add1 (handles, session_handle (session));
641 /* Instead of removing the segment, test when cleaning up disconnected
642 * sessions if the segment can be removed.
647 vec_foreach (handle, handles)
649 session = session_get_from_handle (*handle);
650 session_close (session);
651 /* Avoid propagating notifications back to the app */
652 session->app_wrk_index = APP_INVALID_INDEX;
658 * Initiate disconnects for sessions in specified state 'owned' by a segment
662 segment_manager_del_sessions_filter (segment_manager_t *sm,
663 session_state_t *states)
665 session_handle_t *handles = 0, *handle;
671 ASSERT (pool_elts (sm->segments) != 0);
673 /* Across all fifo segments used by the server */
674 segment_manager_foreach_segment_w_lock (
676 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
678 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
681 session = session_get_if_valid (f->shr->master_session_index,
682 f->master_thread_index);
685 session_state_t *state;
686 vec_foreach (state, states)
688 if (session->session_state == *state)
690 vec_add1 (handles, session_handle (session));
700 vec_foreach (handle, handles)
702 session = session_get_from_handle (*handle);
703 session_close (session);
704 /* Avoid propagating notifications back to the app */
705 session->app_wrk_index = APP_INVALID_INDEX;
711 segment_manager_try_alloc_fifos (fifo_segment_t * fifo_segment,
713 u32 rx_fifo_size, u32 tx_fifo_size,
714 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
716 rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
717 *rx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
719 FIFO_SEGMENT_RX_FIFO);
721 tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
722 *tx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
724 FIFO_SEGMENT_TX_FIFO);
728 /* This would be very odd, but handle it... */
731 fifo_segment_free_fifo (fifo_segment, *tx_fifo);
740 fifo_segment_free_fifo (fifo_segment, *rx_fifo);
750 segment_manager_alloc_session_fifos (segment_manager_t * sm,
752 svm_fifo_t ** rx_fifo,
753 svm_fifo_t ** tx_fifo)
755 int alloc_fail = 1, rv = 0, new_fs_index;
756 uword free_bytes, max_free_bytes = 0;
757 segment_manager_props_t *props;
758 fifo_segment_t *fs = 0, *cur;
759 u32 sm_index, fs_index;
761 props = segment_manager_properties_get (sm);
764 * Find the first free segment to allocate the fifos in
767 segment_manager_segment_reader_lock (sm);
769 pool_foreach (cur, sm->segments) {
770 if (fifo_segment_flags (cur) & FIFO_SEGMENT_F_CUSTOM_USE)
772 free_bytes = fifo_segment_available_bytes (cur);
773 if (free_bytes > max_free_bytes)
775 max_free_bytes = free_bytes;
782 alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
786 /* On success, keep lock until fifos are initialized */
791 segment_manager_segment_reader_unlock (sm);
794 * Allocation failed, see if we can add a new segment
796 if (props->add_segment)
798 if ((new_fs_index = segment_manager_add_segment (sm, 0, 1)) < 0)
800 clib_warning ("Failed to add new segment");
801 return SESSION_E_SEG_CREATE;
803 fs = segment_manager_get_segment_w_lock (sm, new_fs_index);
804 alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
810 clib_warning ("Added a segment, still can't allocate a fifo");
811 segment_manager_segment_reader_unlock (sm);
812 return SESSION_E_SEG_NO_SPACE2;
817 SESSION_DBG ("Can't add new seg and no space to allocate fifos!");
818 return SESSION_E_SEG_NO_SPACE;
822 ASSERT (rx_fifo && tx_fifo);
824 sm_index = segment_manager_index (sm);
825 fs_index = segment_manager_segment_index (sm, fs);
826 (*tx_fifo)->segment_manager = sm_index;
827 (*rx_fifo)->segment_manager = sm_index;
828 (*tx_fifo)->segment_index = fs_index;
829 (*rx_fifo)->segment_index = fs_index;
831 /* Drop the lock after app is notified */
832 segment_manager_segment_reader_unlock (sm);
838 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
840 segment_manager_t *sm;
845 if (!rx_fifo || !tx_fifo)
848 /* It's possible to have no segment manager if the session was removed
849 * as result of a detach. */
850 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
853 segment_index = rx_fifo->segment_index;
854 fs = segment_manager_get_segment_w_lock (sm, segment_index);
855 fifo_segment_free_fifo (fs, rx_fifo);
856 fifo_segment_free_fifo (fs, tx_fifo);
859 * Try to remove fifo segment if it has no fifos. This can be done only if
860 * the segment is not the first in the segment manager or if it is first
861 * and it is not protected. Moreover, if the segment is first and the app
862 * has detached from the segment manager, remove the segment manager.
864 if (!fifo_segment_has_fifos (fs))
866 /* If first, remove only if not protected */
867 try_delete = segment_index != 0 || !sm->first_is_protected;
870 segment_manager_segment_reader_unlock (sm);
872 if (PREDICT_FALSE (try_delete))
874 /* Only remove if empty after writer lock acquired */
875 sm_lock_and_del_segment_inline (sm, segment_index,
876 1 /* check_if_empty */);
878 /* Remove segment manager if no sessions and detached from app */
879 if (segment_manager_app_detached (sm)
880 && !segment_manager_has_fifos (sm))
881 segment_manager_free_safe (sm);
886 segment_manager_detach_fifo (segment_manager_t *sm, svm_fifo_t **f)
890 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
891 fifo_segment_detach_fifo (fs, f);
892 segment_manager_segment_reader_unlock (sm);
896 segment_manager_attach_fifo (segment_manager_t *sm, svm_fifo_t **f,
901 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
902 fifo_segment_attach_fifo (fs, f, s->thread_index);
903 segment_manager_segment_reader_unlock (sm);
905 (*f)->shr->master_session_index = s->session_index;
906 (*f)->master_thread_index = s->thread_index;
910 segment_manager_evt_q_expected_size (u32 q_len)
912 u32 fifo_evt_size, notif_q_size, q_hdrs;
913 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
915 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
916 notif_q_size = clib_max (16, q_len >> 4);
918 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
919 fifo_evt_ring_sz = q_len * fifo_evt_size;
920 session_ntf_ring_sz = notif_q_size * 256;
921 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
923 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
927 * Allocates shm queue in the first segment
929 * Must be called with lock held
932 segment_manager_alloc_queue (fifo_segment_t * segment,
933 segment_manager_props_t * props)
935 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
936 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
939 fifo_evt_size = sizeof (session_event_t);
940 notif_q_size = clib_max (16, props->evt_q_size >> 4);
942 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
943 {props->evt_q_size, fifo_evt_size, 0},
944 {notif_q_size, session_evt_size, 0}
947 cfg->consumer_pid = 0;
949 cfg->q_nitems = props->evt_q_size;
952 q = fifo_segment_msg_q_alloc (segment, 0, cfg);
954 if (props->use_mq_eventfd)
956 if (svm_msg_q_alloc_eventfd (q))
957 clib_warning ("failed to alloc eventfd");
963 segment_manager_event_queue (segment_manager_t * sm)
965 return sm->event_queue;
969 * Frees shm queue allocated in the first segment
972 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
974 fifo_segment_t *segment;
975 ssvm_shared_header_t *sh;
978 ASSERT (!pool_is_free_index (sm->segments, 0));
980 segment = segment_manager_get_segment_w_lock (sm, 0);
981 sh = segment->ssvm.sh;
983 oldheap = ssvm_push_heap (sh);
985 ssvm_pop_heap (oldheap);
986 segment_manager_segment_reader_unlock (sm);
990 * Init segment vm address allocator
993 segment_manager_main_init (void)
995 segment_manager_main_t *sm = &sm_main;
997 sm->default_fifo_size = 1 << 12;
998 sm->default_segment_size = 1 << 20;
999 sm->default_app_mq_size = 128;
1000 sm->default_max_fifo_size = 4 << 20;
1001 sm->default_high_watermark = 80;
1002 sm->default_low_watermark = 50;
1005 static clib_error_t *
1006 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
1007 vlib_cli_command_t * cmd)
1009 segment_manager_main_t *smm = &sm_main;
1010 u8 show_segments = 0, verbose = 0;
1011 uword max_fifo_size;
1012 segment_manager_t *sm;
1013 fifo_segment_t *seg;
1014 app_worker_t *app_wrk;
1018 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1020 if (unformat (input, "segments"))
1022 else if (unformat (input, "verbose"))
1025 return clib_error_return (0, "unknown input `%U'",
1026 format_unformat_error, input);
1028 vlib_cli_output (vm, "%d segment managers allocated",
1029 pool_elts (smm->segment_managers));
1030 if (verbose && pool_elts (smm->segment_managers))
1032 vlib_cli_output (vm, "%-6s%=10s%=10s%=13s%=11s%=11s%=12s",
1033 "Index", "AppIndex", "Segments", "MaxFifoSize",
1034 "HighWater", "LowWater", "FifoTuning");
1037 pool_foreach (sm, smm->segment_managers) {
1038 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
1039 app = app_wrk ? application_get (app_wrk->app_index) : 0;
1040 custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
1041 max_fifo_size = sm->max_fifo_size;
1043 vlib_cli_output (vm, "%-6d%=10d%=10d%=13U%=11d%=11d%=12s",
1044 segment_manager_index (sm),
1045 sm->app_wrk_index, pool_elts (sm->segments),
1046 format_memory_size, max_fifo_size,
1047 sm->high_watermark, sm->low_watermark,
1048 custom_logic ? "custom" : "none");
1052 vlib_cli_output (vm, "\n");
1056 vlib_cli_output (vm, "%U", format_fifo_segment, 0, verbose);
1059 pool_foreach (sm, smm->segment_managers) {
1060 segment_manager_foreach_segment_w_lock (seg, sm, ({
1061 vlib_cli_output (vm, "%U", format_fifo_segment, seg, verbose);
1071 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
1073 .path = "show segment-manager",
1074 .short_help = "show segment-manager [segments][verbose]",
1075 .function = segment_manager_show_fn,
1080 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1082 vlib_main_t *vm = vlib_get_main ();
1083 app_worker_t *app_wrk;
1093 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s%-15s%-10s",
1094 "Connection", "App", "API Client", "SegManager");
1096 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s", "Connection",
1101 app_wrk = app_worker_get (sm->app_wrk_index);
1102 app_name = application_name_from_index (app_wrk->app_index);
1104 clib_rwlock_reader_lock (&sm->segments_rwlock);
1107 pool_foreach (fs, sm->segments) {
1108 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1110 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1113 u32 session_index, thread_index;
1116 session_index = f->shr->master_session_index;
1117 thread_index = f->master_thread_index;
1119 session = session_get (session_index, thread_index);
1120 str = format (0, "%U", format_session, session, verbose);
1123 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v%-15u%-10u", str,
1124 app_name, app_wrk->api_client_index,
1125 app_wrk->connects_seg_manager);
1127 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v", str, app_name);
1129 vlib_cli_output (vm, "%v", s);
1130 vec_reset_length (s);
1140 clib_rwlock_reader_unlock (&sm->segments_rwlock);
1144 segment_manager_set_watermarks (segment_manager_t * sm,
1145 u8 high_watermark, u8 low_watermark)
1147 ASSERT (high_watermark <= 100 && low_watermark <= 100 &&
1148 low_watermark <= high_watermark);
1150 sm->high_watermark = high_watermark;
1151 sm->low_watermark = low_watermark;
1155 * fd.io coding-style-patch-verification: ON
1158 * eval: (c-set-style "gnu")