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.
15 #ifndef SRC_VNET_SESSION_SEGMENT_MANAGER_H_
16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
18 #include <svm/message_queue.h>
19 #include <vppinfra/lock.h>
20 #include <vppinfra/valloc.h>
21 #include <svm/fifo_segment.h>
22 #include <vnet/session/session_types.h>
24 typedef struct _segment_manager_props
26 u32 rx_fifo_size; /**< receive fifo size */
27 u32 tx_fifo_size; /**< transmit fifo size */
28 u32 evt_q_size; /**< event queue length */
29 u32 prealloc_fifos; /**< preallocated fifo pairs */
30 u32 prealloc_fifo_hdrs; /**< preallocated fifo hdrs */
31 uword segment_size; /**< first segment size */
32 uword add_segment_size; /**< additional segment size */
33 u8 add_segment:1; /**< can add new segments flag */
34 u8 use_mq_eventfd:1; /**< use eventfds for mqs flag */
35 u8 reserved:6; /**< reserved flags */
36 u8 n_slices; /**< number of fs slices/threads */
37 ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
38 private segments are used */
39 u32 max_fifo_size; /**< max fifo size */
40 u8 high_watermark; /**< memory usage high watermark % */
41 u8 low_watermark; /**< memory usage low watermark % */
42 u8 pct_first_alloc; /**< pct of fifo size to alloc */
43 } segment_manager_props_t;
45 typedef enum seg_manager_flag_
47 SEG_MANAGER_F_DETACHED = 1 << 0,
48 SEG_MANAGER_F_DETACHED_LISTENER = 1 << 1,
51 typedef struct _segment_manager
53 /** Pool of segments allocated by this manager */
54 fifo_segment_t *segments;
56 /** rwlock that protects the segments pool */
57 clib_rwlock_t segments_rwlock;
59 /** Owner app worker index */
63 * First segment should not be deleted unless segment manger is deleted.
64 * This also indicates that the segment manager is the first to have been
65 * allocated for the app.
67 u8 first_is_protected;
70 * App event queue allocated in first segment
72 svm_msg_q_t *event_queue;
81 typedef struct segment_manager_main_init_args_
85 } segment_manager_main_init_args_t;
87 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
89 segment_manager_t *segment_manager_alloc (void);
90 int segment_manager_init (segment_manager_t * sm);
91 int segment_manager_init_first (segment_manager_t * sm);
94 * Cleanup segment manager
96 * @param sm segment manager to be freed
98 void segment_manager_free (segment_manager_t * sm);
101 * Initiate segment manager cleanup
103 * @param sm segment manager to be freed
105 void segment_manager_init_free (segment_manager_t * sm);
106 segment_manager_t *segment_manager_get (u32 index);
107 segment_manager_t *segment_manager_get_if_valid (u32 index);
108 u32 segment_manager_index (segment_manager_t * sm);
110 int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
111 void segment_manager_del_segment (segment_manager_t * sm,
112 fifo_segment_t * fs);
113 void segment_manager_lock_and_del_segment (segment_manager_t * sm,
115 fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
117 fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
118 fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
120 int segment_manager_add_first_segment (segment_manager_t * sm,
122 u64 segment_manager_make_segment_handle (u32 segment_manager_index,
124 u64 segment_manager_segment_handle (segment_manager_t * sm,
125 fifo_segment_t * segment);
126 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
127 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
129 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
131 svm_fifo_t ** rx_fifo,
132 svm_fifo_t ** tx_fifo);
133 int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
135 u32 rx_fifo_size, u32 tx_fifo_size,
136 svm_fifo_t ** rx_fifo,
137 svm_fifo_t ** tx_fifo);
138 void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
139 svm_fifo_t * tx_fifo);
140 void segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f);
141 void segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
144 void segment_manager_set_watermarks (segment_manager_t * sm,
145 u8 high_watermark, u8 low_watermark);
147 u8 segment_manager_has_fifos (segment_manager_t * sm);
149 svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
150 segment_manager_props_t * props);
151 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
152 svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
153 u32 segment_manager_evt_q_expected_size (u32 q_size);
155 u8 segment_manager_app_detached (segment_manager_t * sm);
156 void segment_manager_app_detach (segment_manager_t * sm);
159 * Cleanup segment manager sessions
161 * Initiates disconnects for all sessions 'owned' by a segment manager by
162 * leveraging the backpointers that fifos keep.
164 * @param sm segment manager whose sessions are to be disconnected
166 void segment_manager_del_sessions (segment_manager_t * sm);
167 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
169 void segment_manager_main_init (segment_manager_main_init_args_t * a);
171 segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
175 segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
178 *sm_index = segment_handle >> 32;
179 *segment_index = segment_handle & 0xFFFFFFFF;
182 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
184 * fd.io coding-style-patch-verification: ON
187 * eval: (c-set-style "gnu")