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 SESSION_DBG ("cannot allocate new segment");
109 return SESSION_E_INVALID;
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;
131 if (props->huge_page)
133 uword hugepage_size = clib_mem_get_default_hugepage_size ();
134 segment_size = round_pow2 (segment_size, hugepage_size);
135 fs->ssvm.huge_page = 1;
138 segment_size = round_pow2 (segment_size, clib_mem_get_page_size ());
140 seg_name = format (0, "seg-%u-%u-%u%c", app_wrk->app_index,
141 app_wrk->wrk_index, smm->seg_name_counter++, 0);
143 fs->ssvm.ssvm_size = segment_size;
144 fs->ssvm.name = seg_name;
145 fs->ssvm.requested_va = 0;
147 if ((rv = ssvm_server_init (&fs->ssvm, props->segment_type)))
149 clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
151 pool_put (sm->segments, fs);
156 * Initialize fifo segment
158 fs->n_slices = props->n_slices;
159 fifo_segment_init (fs);
162 * Save segment index before dropping lock, if any held
164 fs_index = fs - sm->segments;
165 fs->fs_index = fs_index;
166 fs->sm_index = segment_manager_index (sm);
169 * Set watermarks in segment
171 fs->high_watermark = sm->high_watermark;
172 fs->low_watermark = sm->low_watermark;
174 fs->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
175 fs->h->pct_first_alloc = props->pct_first_alloc;
179 app_worker_t *app_wrk;
181 fs_handle = segment_manager_segment_handle (sm, fs);
182 app_wrk = app_worker_get (sm->app_wrk_index);
183 rv = app_worker_add_segment_notify (app_wrk, fs_handle);
193 clib_rwlock_writer_unlock (&sm->segments_rwlock);
199 segment_manager_add_segment (segment_manager_t *sm, uword segment_size,
202 return segment_manager_add_segment_inline (sm, segment_size, notify_app,
203 0 /* flags */, 0 /* need_lock */);
207 segment_manager_add_segment2 (segment_manager_t *sm, uword segment_size,
210 return segment_manager_add_segment_inline (sm, segment_size, 0, flags,
211 vlib_num_workers ());
215 * Remove segment without lock
218 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
220 if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
222 if (!segment_manager_app_detached (sm))
224 app_worker_t *app_wrk;
226 app_wrk = app_worker_get (sm->app_wrk_index);
227 segment_handle = segment_manager_segment_handle (sm, fs);
228 app_worker_del_segment_notify (app_wrk, segment_handle);
232 fifo_segment_cleanup (fs);
233 ssvm_delete (&fs->ssvm);
236 clib_memset (fs, 0xfb, sizeof (*fs));
237 pool_put (sm->segments, fs);
240 static fifo_segment_t *
241 segment_manager_get_segment_if_valid (segment_manager_t * sm,
244 if (pool_is_free_index (sm->segments, segment_index))
246 return pool_elt_at_index (sm->segments, segment_index);
250 * Removes segment after acquiring writer lock
253 sm_lock_and_del_segment_inline (segment_manager_t *sm, u32 fs_index,
259 clib_rwlock_writer_lock (&sm->segments_rwlock);
261 fs = segment_manager_get_segment_if_valid (sm, fs_index);
265 if (check_if_empty && fifo_segment_has_fifos (fs))
268 is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
269 if (is_prealloc && !segment_manager_app_detached (sm))
272 segment_manager_del_segment (sm, fs);
275 clib_rwlock_writer_unlock (&sm->segments_rwlock);
279 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
281 sm_lock_and_del_segment_inline (sm, fs_index, 0 /* check_if_empty */);
285 * Reads a segment from the segment manager's pool without lock
288 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
290 return pool_elt_at_index (sm->segments, segment_index);
294 segment_manager_segment_handle (segment_manager_t * sm,
295 fifo_segment_t * segment)
297 u32 segment_index = segment_manager_segment_index (sm, segment);
298 return (((u64) segment_manager_index (sm) << 32) | segment_index);
302 segment_manager_make_segment_handle (u32 segment_manager_index,
305 return (((u64) segment_manager_index << 32) | segment_index);
309 segment_manager_get_segment_w_handle (u64 segment_handle)
311 u32 sm_index, segment_index;
312 segment_manager_t *sm;
314 segment_manager_parse_segment_handle (segment_handle, &sm_index,
316 sm = segment_manager_get (sm_index);
317 if (!sm || pool_is_free_index (sm->segments, segment_index))
319 return pool_elt_at_index (sm->segments, segment_index);
323 * Reads a segment from the segment manager's pool and acquires reader lock
325 * Caller must drop the reader's lock by calling
326 * @ref segment_manager_segment_reader_unlock once it finishes working with
330 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
332 clib_rwlock_reader_lock (&sm->segments_rwlock);
333 return pool_elt_at_index (sm->segments, segment_index);
337 segment_manager_segment_reader_lock (segment_manager_t * sm)
339 clib_rwlock_reader_lock (&sm->segments_rwlock);
343 segment_manager_segment_reader_unlock (segment_manager_t * sm)
345 clib_rwlock_reader_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 SESSION_DBG ("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 SESSION_DBG ("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 SESSION_E_SEG_CREATE;
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);
502 pool_foreach (fifo_segment, sm->segments) {
503 segment_manager_del_segment (sm, fifo_segment);
506 pool_free (sm->segments);
507 clib_rwlock_writer_unlock (&sm->segments_rwlock);
509 clib_rwlock_free (&sm->segments_rwlock);
511 clib_memset (sm, 0xfe, sizeof (*sm));
512 pool_put (smm->segment_managers, sm);
516 sm_free_w_index_helper (void *arg)
518 u32 sm_index = *(u32 *) arg;
519 segment_manager_t *sm;
521 ASSERT (vlib_get_thread_index () == 0);
523 if ((sm = segment_manager_get_if_valid (sm_index)))
524 segment_manager_free (sm);
528 segment_manager_free_safe (segment_manager_t *sm)
530 if (!vlib_thread_is_main_w_barrier ())
532 u32 sm_index = segment_manager_index (sm);
533 vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
538 segment_manager_free (sm);
543 segment_manager_init_free (segment_manager_t * sm)
545 ASSERT (vlib_get_thread_index () == 0);
547 segment_manager_app_detach (sm);
548 if (segment_manager_has_fifos (sm))
549 segment_manager_del_sessions (sm);
552 ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
553 segment_manager_free (sm);
558 segment_manager_get (u32 index)
560 return pool_elt_at_index (sm_main.segment_managers, index);
564 segment_manager_get_if_valid (u32 index)
566 if (pool_is_free_index (sm_main.segment_managers, index))
568 return pool_elt_at_index (sm_main.segment_managers, index);
572 segment_manager_index (segment_manager_t * sm)
574 return sm - sm_main.segment_managers;
578 segment_manager_has_fifos (segment_manager_t * sm)
583 segment_manager_foreach_segment_w_lock (seg, sm, ({
584 if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
585 && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
587 clib_warning ("segment %d has no fifos!",
588 segment_manager_segment_index (sm, seg));
591 if (fifo_segment_has_fifos (seg))
593 segment_manager_segment_reader_unlock (sm);
602 * Initiate disconnects for all sessions 'owned' by a segment manager
605 segment_manager_del_sessions (segment_manager_t * sm)
607 session_handle_t *handles = 0, *handle;
613 ASSERT (pool_elts (sm->segments) != 0);
615 /* Across all fifo segments used by the server */
616 segment_manager_foreach_segment_w_lock (fs, sm, ({
617 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
619 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
622 * Remove any residual sessions from the session lookup table
623 * Don't bother deleting the individual fifos, we're going to
624 * throw away the fifo segment in a minute.
628 session = session_get_if_valid (f->shr->master_session_index,
629 f->master_thread_index);
631 vec_add1 (handles, session_handle (session));
636 /* Instead of removing the segment, test when cleaning up disconnected
637 * sessions if the segment can be removed.
641 vec_foreach (handle, handles)
643 session = session_get_from_handle (*handle);
644 session_close (session);
645 /* Avoid propagating notifications back to the app */
646 session->app_wrk_index = APP_INVALID_INDEX;
652 * Initiate disconnects for sessions in specified state 'owned' by a segment
656 segment_manager_del_sessions_filter (segment_manager_t *sm,
657 session_state_t *states)
659 session_handle_t *handles = 0, *handle;
665 ASSERT (pool_elts (sm->segments) != 0);
667 /* Across all fifo segments used by the server */
668 segment_manager_foreach_segment_w_lock (
670 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
672 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
675 session = session_get_if_valid (f->shr->master_session_index,
676 f->master_thread_index);
679 session_state_t *state;
680 vec_foreach (state, states)
682 if (session->session_state == *state)
684 vec_add1 (handles, session_handle (session));
694 vec_foreach (handle, handles)
696 session = session_get_from_handle (*handle);
697 session_close (session);
698 /* Avoid propagating notifications back to the app */
699 session->app_wrk_index = APP_INVALID_INDEX;
705 segment_manager_try_alloc_fifos (fifo_segment_t *fs, u32 thread_index,
706 u32 rx_fifo_size, u32 tx_fifo_size,
707 svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
709 rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
710 *rx_fifo = fifo_segment_alloc_fifo_w_slice (fs, thread_index, rx_fifo_size,
711 FIFO_SEGMENT_RX_FIFO);
713 tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
714 *tx_fifo = fifo_segment_alloc_fifo_w_slice (fs, thread_index, tx_fifo_size,
715 FIFO_SEGMENT_TX_FIFO);
719 /* This would be very odd, but handle it... */
722 fifo_segment_free_fifo (fs, *tx_fifo);
725 return SESSION_E_SEG_NO_SPACE;
731 fifo_segment_free_fifo (fs, *rx_fifo);
734 return SESSION_E_SEG_NO_SPACE;
741 sm_lookup_segment_and_alloc_fifos (segment_manager_t *sm,
742 segment_manager_props_t *props,
743 u32 thread_index, svm_fifo_t **rx_fifo,
744 svm_fifo_t **tx_fifo)
746 uword free_bytes, max_free_bytes;
747 fifo_segment_t *cur, *fs = 0;
749 max_free_bytes = props->rx_fifo_size + props->tx_fifo_size - 1;
751 pool_foreach (cur, sm->segments)
753 if (fifo_segment_flags (cur) & FIFO_SEGMENT_F_CUSTOM_USE)
755 free_bytes = fifo_segment_available_bytes (cur);
756 if (free_bytes > max_free_bytes)
758 max_free_bytes = free_bytes;
763 if (PREDICT_FALSE (!fs))
764 return SESSION_E_SEG_NO_SPACE;
766 return segment_manager_try_alloc_fifos (
767 fs, thread_index, props->rx_fifo_size, props->tx_fifo_size, rx_fifo,
772 sm_lock_and_alloc_segment_and_fifos (segment_manager_t *sm,
773 segment_manager_props_t *props,
774 u32 thread_index, svm_fifo_t **rx_fifo,
775 svm_fifo_t **tx_fifo)
777 int new_fs_index, rv;
780 if (!props->add_segment)
781 return SESSION_E_SEG_NO_SPACE;
783 clib_rwlock_writer_lock (&sm->segments_rwlock);
785 /* Make sure there really is no free space. Another worker might've freed
786 * some fifos or allocated a segment */
787 rv = sm_lookup_segment_and_alloc_fifos (sm, props, thread_index, rx_fifo,
793 segment_manager_add_segment (sm, 0 /* segment_size*/, 1 /* notify_app */);
794 if (new_fs_index < 0)
796 rv = SESSION_E_SEG_CREATE;
799 fs = segment_manager_get_segment (sm, new_fs_index);
800 rv = segment_manager_try_alloc_fifos (fs, thread_index, props->rx_fifo_size,
801 props->tx_fifo_size, rx_fifo, tx_fifo);
804 SESSION_DBG ("Added a segment, still can't allocate a fifo");
805 rv = SESSION_E_SEG_NO_SPACE2;
811 clib_rwlock_writer_unlock (&sm->segments_rwlock);
817 segment_manager_alloc_session_fifos (segment_manager_t * sm,
819 svm_fifo_t ** rx_fifo,
820 svm_fifo_t ** tx_fifo)
822 segment_manager_props_t *props;
825 props = segment_manager_properties_get (sm);
828 * Fast path: find the first segment with enough free space and
829 * try to allocate the fifos. Done with reader lock
832 segment_manager_segment_reader_lock (sm);
834 rv = sm_lookup_segment_and_alloc_fifos (sm, props, thread_index, rx_fifo,
837 segment_manager_segment_reader_unlock (sm);
840 * Slow path: if no fifo segment or alloc fail grab writer lock and try
841 * to allocate new segment
843 if (PREDICT_FALSE (rv < 0))
844 return sm_lock_and_alloc_segment_and_fifos (sm, props, thread_index,
851 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
853 segment_manager_t *sm;
858 if (!rx_fifo || !tx_fifo)
861 /* Thread that allocated the fifos must be the one to clean them up */
862 ASSERT (rx_fifo->master_thread_index == vlib_get_thread_index () ||
863 rx_fifo->refcnt > 1 || vlib_thread_is_main_w_barrier ());
865 /* It's possible to have no segment manager if the session was removed
866 * as result of a detach. */
867 if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
870 segment_index = rx_fifo->segment_index;
871 fs = segment_manager_get_segment_w_lock (sm, segment_index);
872 fifo_segment_free_fifo (fs, rx_fifo);
873 fifo_segment_free_fifo (fs, tx_fifo);
876 * Try to remove fifo segment if it has no fifos. This can be done only if
877 * the segment is not the first in the segment manager or if it is first
878 * and it is not protected. Moreover, if the segment is first and the app
879 * has detached from the segment manager, remove the segment manager.
881 if (!fifo_segment_has_fifos (fs))
883 /* If first, remove only if not protected */
884 try_delete = segment_index != 0 || !sm->first_is_protected;
887 segment_manager_segment_reader_unlock (sm);
889 if (PREDICT_FALSE (try_delete))
891 /* Only remove if empty after writer lock acquired */
892 sm_lock_and_del_segment_inline (sm, segment_index,
893 1 /* check_if_empty */);
895 /* Remove segment manager if no sessions and detached from app */
896 if (segment_manager_app_detached (sm)
897 && !segment_manager_has_fifos (sm))
898 segment_manager_free_safe (sm);
903 segment_manager_detach_fifo (segment_manager_t *sm, svm_fifo_t **f)
907 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
908 fifo_segment_detach_fifo (fs, f);
909 segment_manager_segment_reader_unlock (sm);
913 segment_manager_attach_fifo (segment_manager_t *sm, svm_fifo_t **f,
918 fs = segment_manager_get_segment_w_lock (sm, (*f)->segment_index);
919 fifo_segment_attach_fifo (fs, f, s->thread_index);
920 segment_manager_segment_reader_unlock (sm);
922 (*f)->shr->master_session_index = s->session_index;
923 (*f)->master_thread_index = s->thread_index;
927 segment_manager_evt_q_expected_size (u32 q_len)
929 u32 fifo_evt_size, notif_q_size, q_hdrs;
930 u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
932 fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
933 notif_q_size = clib_max (16, q_len >> 4);
935 msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
936 fifo_evt_ring_sz = q_len * fifo_evt_size;
937 session_ntf_ring_sz = notif_q_size * 256;
938 q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
940 return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
944 * Allocates shm queue in the first segment
946 * Must be called with lock held
949 segment_manager_alloc_queue (fifo_segment_t * segment,
950 segment_manager_props_t * props)
952 u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
953 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
956 fifo_evt_size = sizeof (session_event_t);
957 notif_q_size = clib_max (16, props->evt_q_size >> 4);
958 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
959 {props->evt_q_size, fifo_evt_size, 0},
960 {notif_q_size, session_evt_size, 0}
962 cfg->consumer_pid = 0;
964 cfg->q_nitems = props->evt_q_size;
967 q = fifo_segment_msg_q_alloc (segment, 0, cfg);
969 if (props->use_mq_eventfd)
971 if (svm_msg_q_alloc_eventfd (q))
972 clib_warning ("failed to alloc eventfd");
978 segment_manager_event_queue (segment_manager_t * sm)
980 return sm->event_queue;
984 * Frees shm queue allocated in the first segment
987 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
989 fifo_segment_t *segment;
990 ssvm_shared_header_t *sh;
993 ASSERT (!pool_is_free_index (sm->segments, 0));
995 segment = segment_manager_get_segment_w_lock (sm, 0);
996 sh = segment->ssvm.sh;
998 oldheap = ssvm_push_heap (sh);
1000 ssvm_pop_heap (oldheap);
1001 segment_manager_segment_reader_unlock (sm);
1005 * Init segment vm address allocator
1008 segment_manager_main_init (void)
1010 segment_manager_main_t *sm = &sm_main;
1012 sm->default_fifo_size = 1 << 12;
1013 sm->default_segment_size = 1 << 20;
1014 sm->default_app_mq_size = 128;
1015 sm->default_max_fifo_size = 4 << 20;
1016 sm->default_high_watermark = 80;
1017 sm->default_low_watermark = 50;
1021 format_segment_manager (u8 *s, va_list *args)
1023 segment_manager_t *sm = va_arg (*args, segment_manager_t *);
1024 int verbose = va_arg (*args, int);
1025 app_worker_t *app_wrk;
1026 uword max_fifo_size;
1027 fifo_segment_t *seg;
1031 app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
1032 app = app_wrk ? application_get (app_wrk->app_index) : 0;
1033 custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
1034 max_fifo_size = sm->max_fifo_size;
1037 "[%u] %v app-wrk: %u segs: %u max-fifo-sz: %U "
1038 "wmarks: %u %u %s flags: 0x%x",
1039 segment_manager_index (sm), app ? app->name : 0,
1040 sm->app_wrk_index, pool_elts (sm->segments), format_memory_size,
1041 max_fifo_size, sm->high_watermark, sm->low_watermark,
1042 custom_logic ? "custom-tuning" : "no-tuning", sm->flags);
1044 if (!verbose || !pool_elts (sm->segments))
1047 s = format (s, "\n\n");
1049 segment_manager_foreach_segment_w_lock (
1050 seg, sm, ({ s = format (s, " *%U", format_fifo_segment, seg, verbose); }));
1055 static clib_error_t *
1056 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
1057 vlib_cli_command_t * cmd)
1059 unformat_input_t _line_input, *line_input = &_line_input;
1060 segment_manager_main_t *smm = &sm_main;
1061 u8 show_segments = 0, verbose = 0;
1062 segment_manager_t *sm;
1065 if (!unformat_user (input, unformat_line_input, line_input))
1067 vlib_cli_output (vm, "%d segment managers allocated",
1068 pool_elts (smm->segment_managers));
1072 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1074 if (unformat (line_input, "segments"))
1076 else if (unformat (line_input, "verbose"))
1078 else if (unformat (line_input, "index %u", &sm_index))
1082 vlib_cli_output (vm, "unknown input [%U]", format_unformat_error,
1088 if (!pool_elts (smm->segment_managers))
1093 sm = segment_manager_get_if_valid (sm_index);
1096 vlib_cli_output (vm, "segment manager %u not allocated", sm_index);
1099 vlib_cli_output (vm, "%U", format_segment_manager, sm, 1 /* verbose */);
1103 if (verbose || show_segments)
1105 pool_foreach (sm, smm->segment_managers) {
1106 vlib_cli_output (vm, "%U", format_segment_manager, sm,
1110 vlib_cli_output (vm, "\n");
1115 unformat_free (line_input);
1120 VLIB_CLI_COMMAND (segment_manager_show_command, static) = {
1121 .path = "show segment-manager",
1122 .short_help = "show segment-manager [segments][verbose][index <nn>]",
1123 .function = segment_manager_show_fn,
1127 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1129 vlib_main_t *vm = vlib_get_main ();
1130 app_worker_t *app_wrk;
1140 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s%-15s%-10s",
1141 "Connection", "App", "API Client", "SegManager");
1143 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-20s", "Connection",
1148 app_wrk = app_worker_get (sm->app_wrk_index);
1149 app_name = application_name_from_index (app_wrk->app_index);
1151 clib_rwlock_reader_lock (&sm->segments_rwlock);
1153 pool_foreach (fs, sm->segments) {
1154 for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1156 f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1159 u32 session_index, thread_index;
1162 session_index = f->shr->master_session_index;
1163 thread_index = f->master_thread_index;
1165 session = session_get (session_index, thread_index);
1166 str = format (0, "%U", format_session, session, verbose);
1169 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v%-15u%-10u", str,
1170 app_name, app_wrk->api_client_index,
1171 app_wrk->connects_seg_manager);
1173 s = format (s, "%-" SESSION_CLI_ID_LEN "v%-20v", str, app_name);
1175 vlib_cli_output (vm, "%v", s);
1176 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")