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 segment_size = round_pow2 (segment_size, clib_mem_get_page_size ());
124 if (props->segment_type != SSVM_SEGMENT_PRIVATE)
126 seg_name = format (0, "%d-%d%c", getpid (), smm->seg_name_counter++, 0);
130 app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
131 application_t *app = application_get (app_wrk->app_index);
132 seg_name = format (0, "%v segment%c", app->name, 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;
159 * Set watermarks in segment
161 fs->high_watermark = sm->high_watermark;
162 fs->low_watermark = sm->low_watermark;
164 fs->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
165 fs->h->pct_first_alloc = props->pct_first_alloc;
169 app_worker_t *app_wrk;
171 fs_handle = segment_manager_segment_handle (sm, fs);
172 app_wrk = app_worker_get (sm->app_wrk_index);
173 rv = app_worker_add_segment_notify (app_wrk, fs_handle);
179 if (vlib_num_workers ())
180 clib_rwlock_writer_unlock (&sm->segments_rwlock);
186 segment_manager_add_segment (segment_manager_t *sm, uword segment_size,
189 return segment_manager_add_segment_inline (sm, segment_size, notify_app, 0);
193 segment_manager_add_segment2 (segment_manager_t *sm, uword segment_size,
196 return segment_manager_add_segment_inline (sm, segment_size, 0, flags);
200 * Remove segment without lock
203 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
205 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
207 if (!segment_manager_app_detached (sm))
209 app_worker_t *app_wrk;
211 app_wrk = app_worker_get (sm->app_wrk_index);
212 segment_handle = segment_manager_segment_handle (sm, fs);
213 app_worker_del_segment_notify (app_wrk, segment_handle);
217 fifo_segment_cleanup (fs);
218 ssvm_delete (&fs->ssvm);
221 clib_memset (fs, 0xfb, sizeof (*fs));
222 pool_put (sm->segments, fs);
225 static fifo_segment_t *
226 segment_manager_get_segment_if_valid (segment_manager_t * sm,
229 if (pool_is_free_index (sm->segments, segment_index))
231 return pool_elt_at_index (sm->segments, segment_index);
235 * Removes segment after acquiring writer lock
238 sm_lock_and_del_segment_inline (segment_manager_t * sm, u32 fs_index)
243 clib_rwlock_writer_lock (&sm->segments_rwlock);
245 fs = segment_manager_get_segment_if_valid (sm, fs_index);
249 is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
250 if (is_prealloc && !segment_manager_app_detached (sm))
253 segment_manager_del_segment (sm, fs);
256 clib_rwlock_writer_unlock (&sm->segments_rwlock);
260 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
262 sm_lock_and_del_segment_inline (sm, fs_index);
266 * Reads a segment from the segment manager's pool without lock
269 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
271 return pool_elt_at_index (sm->segments, segment_index);
275 segment_manager_segment_handle (segment_manager_t * sm,
276 fifo_segment_t * segment)
278 u32 segment_index = segment_manager_segment_index (sm, segment);
279 return (((u64) segment_manager_index (sm) << 32) | segment_index);
283 segment_manager_make_segment_handle (u32 segment_manager_index,
286 return (((u64) segment_manager_index << 32) | segment_index);
290 segment_manager_get_segment_w_handle (u64 segment_handle)
292 u32 sm_index, segment_index;
293 segment_manager_t *sm;
295 segment_manager_parse_segment_handle (segment_handle, &sm_index,
297 sm = segment_manager_get (sm_index);
298 if (!sm || pool_is_free_index (sm->segments, segment_index))
300 return pool_elt_at_index (sm->segments, segment_index);
304 * Reads a segment from the segment manager's pool and acquires reader lock
306 * Caller must drop the reader's lock by calling
307 * @ref segment_manager_segment_reader_unlock once it finishes working with
311 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
313 clib_rwlock_reader_lock (&sm->segments_rwlock);
314 return pool_elt_at_index (sm->segments, segment_index);
318 segment_manager_segment_reader_lock (segment_manager_t * sm)
320 clib_rwlock_reader_lock (&sm->segments_rwlock);
324 segment_manager_segment_reader_unlock (segment_manager_t * sm)
326 clib_rwlock_reader_unlock (&sm->segments_rwlock);
330 segment_manager_segment_writer_unlock (segment_manager_t * sm)
332 clib_rwlock_writer_unlock (&sm->segments_rwlock);
336 segment_manager_alloc (void)
338 segment_manager_main_t *smm = &sm_main;
339 segment_manager_t *sm;
341 pool_get_zero (smm->segment_managers, sm);
342 clib_rwlock_init (&sm->segments_rwlock);
347 segment_manager_init (segment_manager_t * sm)
349 segment_manager_props_t *props;
351 props = segment_manager_properties_get (sm);
353 sm->max_fifo_size = props->max_fifo_size ?
354 props->max_fifo_size : sm_main.default_max_fifo_size;
355 sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
357 segment_manager_set_watermarks (sm,
358 props->high_watermark,
359 props->low_watermark);
364 * Initializes segment manager based on options provided.
365 * Returns error if ssvm segment(s) allocation fails.
368 segment_manager_init_first (segment_manager_t * sm)
370 segment_manager_props_t *props;
371 uword first_seg_size;
375 segment_manager_init (sm);
376 props = segment_manager_properties_get (sm);
377 first_seg_size = clib_max (props->segment_size,
378 sm_main.default_segment_size);
380 if (props->prealloc_fifos)
382 u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
383 u32 rx_rounded_data_size, tx_rounded_data_size;
384 u32 prealloc_fifo_pairs = props->prealloc_fifos;
385 u32 rx_fifo_size, tx_fifo_size, pair_size;
386 u32 approx_segment_count;
388 /* Figure out how many segments should be preallocated */
389 rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
390 tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
392 rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
393 tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
394 pair_size = rx_fifo_size + tx_fifo_size;
396 approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
397 if (first_seg_size > approx_total_size)
398 max_seg_size = first_seg_size;
399 approx_segment_count = (approx_total_size + (max_seg_size - 1))
402 /* Allocate the segments */
403 for (i = 0; i < approx_segment_count + 1; i++)
405 fs_index = segment_manager_add_segment (sm, max_seg_size, 0);
408 clib_warning ("Failed to preallocate segment %d", i);
412 fs = segment_manager_get_segment (sm, fs_index);
414 sm->event_queue = segment_manager_alloc_queue (fs, props);
416 fifo_segment_preallocate_fifo_pairs (fs,
419 &prealloc_fifo_pairs);
420 fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
421 if (prealloc_fifo_pairs == 0)
427 fs_index = segment_manager_add_segment (sm, first_seg_size, 0);
430 clib_warning ("Failed to allocate segment");
434 fs = segment_manager_get_segment (sm, fs_index);
435 sm->event_queue = segment_manager_alloc_queue (fs, props);
437 if (props->prealloc_fifo_hdrs)
441 /* Do not preallocate on slice associated to main thread */
442 i = (vlib_num_workers ()? 1 : 0);
443 hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
445 for (; i < fs->n_slices; i++)
447 if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
448 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
456 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
458 app_worker_t *app_wrk;
460 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
464 app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
468 * Cleanup segment manager.
471 segment_manager_free (segment_manager_t * sm)
473 segment_manager_main_t *smm = &sm_main;
474 fifo_segment_t *fifo_segment;
476 ASSERT (vlib_get_thread_index () == 0
477 && !segment_manager_has_fifos (sm)
478 && segment_manager_app_detached (sm));
480 if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
481 segment_manager_cleanup_detached_listener (sm);
483 /* If we have empty preallocated segments that haven't been removed, remove
484 * them now. Apart from that, the first segment in the first segment manager
485 * is not removed when all fifos are removed. It can only be removed when
486 * the manager is explicitly deleted/detached by the app. */
487 clib_rwlock_writer_lock (&sm->segments_rwlock);
490 pool_foreach (fifo_segment, sm->segments) {
491 segment_manager_del_segment (sm, fifo_segment);
495 pool_free (sm->segments);
496 clib_rwlock_writer_unlock (&sm->segments_rwlock);
498 clib_rwlock_free (&sm->segments_rwlock);
500 clib_memset (sm, 0xfe, sizeof (*sm));
501 pool_put (smm->segment_managers, sm);
505 sm_free_w_index_helper (void *arg)
507 u32 sm_index = *(u32 *) arg;
508 segment_manager_t *sm;
510 ASSERT (vlib_get_thread_index () == 0);
512 if ((sm = segment_manager_get_if_valid (sm_index)))
513 segment_manager_free (sm);
517 segment_manager_free_safe (segment_manager_t *sm)
519 if (!vlib_thread_is_main_w_barrier ())
521 u32 sm_index = segment_manager_index (sm);
522 vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
527 segment_manager_free (sm);
532 segment_manager_init_free (segment_manager_t * sm)
534 ASSERT (vlib_get_thread_index () == 0);
536 segment_manager_app_detach (sm);
537 if (segment_manager_has_fifos (sm))
538 segment_manager_del_sessions (sm);
541 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
542 segment_manager_free (sm);
547 segment_manager_get (u32 index)
549 return pool_elt_at_index (sm_main.segment_managers, index);
553 segment_manager_get_if_valid (u32 index)
555 if (pool_is_free_index (sm_main.segment_managers, index))
557 return pool_elt_at_index (sm_main.segment_managers, index);
561 segment_manager_index (segment_manager_t * sm)
563 return sm - sm_main.segment_managers;
567 segment_manager_has_fifos (segment_manager_t * sm)
573 segment_manager_foreach_segment_w_lock (seg, sm, ({
574 if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
575 && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
577 clib_warning ("segment %d has no fifos!",
578 segment_manager_segment_index (sm, seg));
581 if (fifo_segment_has_fifos (seg))
583 segment_manager_segment_reader_unlock (sm);
593 * Initiate disconnects for all sessions 'owned' by a segment manager
596 segment_manager_del_sessions (segment_manager_t * sm)
598 session_handle_t *handles = 0, *handle;
604 ASSERT (pool_elts (sm->segments) != 0);
606 /* Across all fifo segments used by the server */
608 segment_manager_foreach_segment_w_lock (fs, sm, ({
609 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
611 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
614 * Remove any residual sessions from the session lookup table
615 * Don't bother deleting the individual fifos, we're going to
616 * throw away the fifo segment in a minute.
620 session = session_get_if_valid (f->shr->master_session_index,
621 f->master_thread_index);
623 vec_add1 (handles, session_handle (session));
628 /* Instead of removing the segment, test when cleaning up disconnected
629 * sessions if the segment can be removed.
634 vec_foreach (handle, handles)
636 session = session_get_from_handle (*handle);
637 session_close (session);
638 /* Avoid propagating notifications back to the app */
639 session->app_wrk_index = APP_INVALID_INDEX;
645 * Initiate disconnects for sessions in specified state 'owned' by a segment
649 segment_manager_del_sessions_filter (segment_manager_t *sm,
650 session_state_t *states)
652 session_handle_t *handles = 0, *handle;
658 ASSERT (pool_elts (sm->segments) != 0);
660 /* Across all fifo segments used by the server */
661 segment_manager_foreach_segment_w_lock (
663 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
665 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
668 session = session_get_if_valid (f->shr->master_session_index,
669 f->master_thread_index);
672 session_state_t *state;
673 vec_foreach (state, states)
675 if (session->session_state == *state)
677 vec_add1 (handles, session_handle (session));
687 vec_foreach (handle, handles)
689 session = session_get_from_handle (*handle);
690 session_close (session);
691 /* Avoid propagating notifications back to the app */
692 session->app_wrk_index = APP_INVALID_INDEX;
698 segment_manager_try_alloc_fifos (fifo_segment_t * fifo_segment,
700 u32 rx_fifo_size, u32 tx_fifo_size,
701 svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
703 rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
704 *rx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
706 FIFO_SEGMENT_RX_FIFO);
708 tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
709 *tx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
711 FIFO_SEGMENT_TX_FIFO);
715 /* This would be very odd, but handle it... */
718 fifo_segment_free_fifo (fifo_segment, *tx_fifo);
727 fifo_segment_free_fifo (fifo_segment, *rx_fifo);
737 segment_manager_alloc_session_fifos (segment_manager_t * sm,
739 svm_fifo_t ** rx_fifo,
740 svm_fifo_t ** tx_fifo)
742 int alloc_fail = 1, rv = 0, new_fs_index;
743 uword free_bytes, max_free_bytes = 0;
744 segment_manager_props_t *props;
745 fifo_segment_t *fs = 0, *cur;
746 u32 sm_index, fs_index;
748 props = segment_manager_properties_get (sm);
751 * Find the first free segment to allocate the fifos in
754 segment_manager_segment_reader_lock (sm);
756 pool_foreach (cur, sm->segments) {
757 if (fifo_segment_flags (cur) & FIFO_SEGMENT_F_CUSTOM_USE)
759 free_bytes = fifo_segment_available_bytes (cur);
760 if (free_bytes > max_free_bytes)
762 max_free_bytes = free_bytes;
769 alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
773 /* On success, keep lock until fifos are initialized */
778 segment_manager_segment_reader_unlock (sm);
781 * Allocation failed, see if we can add a new segment
783 if (props->add_segment)
785 if ((new_fs_index = segment_manager_add_segment (sm, 0, 1)) < 0)
787 clib_warning ("Failed to add new segment");
788 return SESSION_E_SEG_CREATE;
790 fs = segment_manager_get_segment_w_lock (sm, new_fs_index);
791 alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
797 clib_warning ("Added a segment, still can't allocate a fifo");
798 segment_manager_segment_reader_unlock (sm);
799 return SESSION_E_SEG_NO_SPACE2;
804 SESSION_DBG ("Can't add new seg and no space to allocate fifos!");
805 return SESSION_E_SEG_NO_SPACE;
809 ASSERT (rx_fifo && tx_fifo);
811 sm_index = segment_manager_index (sm);
812 fs_index = segment_manager_segment_index (sm, fs);
813 (*tx_fifo)->segment_manager = sm_index;
814 (*rx_fifo)->segment_manager = sm_index;
815 (*tx_fifo)->segment_index = fs_index;
816 (*rx_fifo)->segment_index = fs_index;
818 /* Drop the lock after app is notified */
819 segment_manager_segment_reader_unlock (sm);
825 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
827 segment_manager_t *sm;
831 if (!rx_fifo || !tx_fifo)
834 /* It's possible to have no segment manager if the session was removed
835 * as result of a detach. */
836 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
839 segment_index = rx_fifo->segment_index;
840 fs = segment_manager_get_segment_w_lock (sm, segment_index);
841 fifo_segment_free_fifo (fs, rx_fifo);
842 fifo_segment_free_fifo (fs, tx_fifo);
845 * Try to remove svm segment if it has no fifos. This can be done only if
846 * the segment is not the first in the segment manager or if it is first
847 * and it is not protected. Moreover, if the segment is first and the app
848 * has detached from the segment manager, remove the segment manager.
850 if (!fifo_segment_has_fifos (fs))
852 segment_manager_segment_reader_unlock (sm);
854 /* Remove segment if it holds no fifos or first but not protected */
855 if (segment_index != 0 || !sm->first_is_protected)
856 sm_lock_and_del_segment_inline (sm, segment_index);
858 /* Remove segment manager if no sessions and detached from app */
859 if (segment_manager_app_detached (sm)
860 && !segment_manager_has_fifos (sm))
861 segment_manager_free_safe (sm);
864 segment_manager_segment_reader_unlock (sm);
868 segment_manager_detach_fifo (segment_manager_t *sm, svm_fifo_t **f)
872 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
873 fifo_segment_detach_fifo (fs, f);
874 segment_manager_segment_reader_unlock (sm);
878 segment_manager_attach_fifo (segment_manager_t *sm, svm_fifo_t **f,
883 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
884 fifo_segment_attach_fifo (fs, f, s->thread_index);
885 segment_manager_segment_reader_unlock (sm);
887 (*f)->shr->master_session_index = s->session_index;
888 (*f)->master_thread_index = s->thread_index;
892 segment_manager_evt_q_expected_size (u32 q_len)
894 u32 fifo_evt_size, notif_q_size, q_hdrs;
895 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
897 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
898 notif_q_size = clib_max (16, q_len >> 4);
900 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
901 fifo_evt_ring_sz = q_len * fifo_evt_size;
902 session_ntf_ring_sz = notif_q_size * 256;
903 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
905 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
909 * Allocates shm queue in the first segment
911 * Must be called with lock held
914 segment_manager_alloc_queue (fifo_segment_t * segment,
915 segment_manager_props_t * props)
917 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
918 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
921 fifo_evt_size = sizeof (session_event_t);
922 notif_q_size = clib_max (16, props->evt_q_size >> 4);
924 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
925 {props->evt_q_size, fifo_evt_size, 0},
926 {notif_q_size, session_evt_size, 0}
929 cfg->consumer_pid = 0;
931 cfg->q_nitems = props->evt_q_size;
934 q = fifo_segment_msg_q_alloc (segment, 0, cfg);
936 if (props->use_mq_eventfd)
938 if (svm_msg_q_alloc_eventfd (q))
939 clib_warning ("failed to alloc eventfd");
945 segment_manager_event_queue (segment_manager_t * sm)
947 return sm->event_queue;
951 * Frees shm queue allocated in the first segment
954 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
956 fifo_segment_t *segment;
957 ssvm_shared_header_t *sh;
960 ASSERT (!pool_is_free_index (sm->segments, 0));
962 segment = segment_manager_get_segment_w_lock (sm, 0);
963 sh = segment->ssvm.sh;
965 oldheap = ssvm_push_heap (sh);
967 ssvm_pop_heap (oldheap);
968 segment_manager_segment_reader_unlock (sm);
972 * Init segment vm address allocator
975 segment_manager_main_init (void)
977 segment_manager_main_t *sm = &sm_main;
979 sm->default_fifo_size = 1 << 12;
980 sm->default_segment_size = 1 << 20;
981 sm->default_app_mq_size = 128;
982 sm->default_max_fifo_size = 4 << 20;
983 sm->default_high_watermark = 80;
984 sm->default_low_watermark = 50;
987 static clib_error_t *
988 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
989 vlib_cli_command_t * cmd)
991 segment_manager_main_t *smm = &sm_main;
992 u8 show_segments = 0, verbose = 0;
994 segment_manager_t *sm;
996 app_worker_t *app_wrk;
1000 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1002 if (unformat (input, "segments"))
1004 else if (unformat (input, "verbose"))
1007 return clib_error_return (0, "unknown input `%U'",
1008 format_unformat_error, input);
1010 vlib_cli_output (vm, "%d segment managers allocated",
1011 pool_elts (smm->segment_managers));
1012 if (verbose && pool_elts (smm->segment_managers))
1014 vlib_cli_output (vm, "%-6s%=10s%=10s%=13s%=11s%=11s%=12s",
1015 "Index", "AppIndex", "Segments", "MaxFifoSize",
1016 "HighWater", "LowWater", "FifoTuning");
1019 pool_foreach (sm, smm->segment_managers) {
1020 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
1021 app = app_wrk ? application_get (app_wrk->app_index) : 0;
1022 custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
1023 max_fifo_size = sm->max_fifo_size;
1025 vlib_cli_output (vm, "%-6d%=10d%=10d%=13U%=11d%=11d%=12s",
1026 segment_manager_index (sm),
1027 sm->app_wrk_index, pool_elts (sm->segments),
1028 format_memory_size, max_fifo_size,
1029 sm->high_watermark, sm->low_watermark,
1030 custom_logic ? "custom" : "none");
1034 vlib_cli_output (vm, "\n");
1038 vlib_cli_output (vm, "%U", format_fifo_segment, 0, verbose);
1041 pool_foreach (sm, smm->segment_managers) {
1042 segment_manager_foreach_segment_w_lock (seg, sm, ({
1043 vlib_cli_output (vm, "%U", format_fifo_segment, seg, verbose);
1053 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
1055 .path = "show segment-manager",
1056 .short_help = "show segment-manager [segments][verbose]",
1057 .function = segment_manager_show_fn,
1062 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1064 vlib_main_t *vm = vlib_get_main ();
1065 app_worker_t *app_wrk;
1075 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s%-15s%-10s",
1076 "Connection", "App", "API Client", "SegManager");
1078 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s", "Connection",
1083 app_wrk = app_worker_get (sm->app_wrk_index);
1084 app_name = application_name_from_index (app_wrk->app_index);
1086 clib_rwlock_reader_lock (&sm->segments_rwlock);
1089 pool_foreach (fs, sm->segments) {
1090 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1092 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1095 u32 session_index, thread_index;
1098 session_index = f->shr->master_session_index;
1099 thread_index = f->master_thread_index;
1101 session = session_get (session_index, thread_index);
1102 str = format (0, "%U", format_session, session, verbose);
1105 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v%-15u%-10u", str,
1106 app_name, app_wrk->api_client_index,
1107 app_wrk->connects_seg_manager);
1109 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v", str, app_name);
1111 vlib_cli_output (vm, "%v", s);
1112 vec_reset_length (s);
1122 clib_rwlock_reader_unlock (&sm->segments_rwlock);
1126 segment_manager_set_watermarks (segment_manager_t * sm,
1127 u8 high_watermark, u8 low_watermark)
1129 ASSERT (high_watermark <= 100 && low_watermark <= 100 &&
1130 low_watermark <= high_watermark);
1132 sm->high_watermark = high_watermark;
1133 sm->low_watermark = low_watermark;
1137 * fd.io coding-style-patch-verification: ON
1140 * eval: (c-set-style "gnu")