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 uword segment_size; /**< first segment size */
31 uword add_segment_size; /**< additional segment size */
32 u8 add_segment:1; /**< can add new segments flag */
33 u8 use_mq_eventfd:1; /**< use eventfds for mqs flag */
34 u8 reserved:6; /**< reserved flags */
35 u8 n_slices; /**< number of fs slices/threads */
36 ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
37 private segments are used */
38 u32 max_fifo_size; /**< max fifo size */
39 u8 high_watermark; /**< memory usage high watermark % */
40 u8 low_watermark; /**< memory usage low watermark % */
41 u8 pct_first_alloc; /**< pct of fifo size to alloc */
42 } segment_manager_props_t;
44 typedef struct _segment_manager
46 /** Pool of segments allocated by this manager */
47 fifo_segment_t *segments;
49 /** rwlock that protects the segments pool */
50 clib_rwlock_t segments_rwlock;
52 /** Owner app worker index */
56 * First segment should not be deleted unless segment manger is deleted.
57 * This also indicates that the segment manager is the first to have been
58 * allocated for the app.
60 u8 first_is_protected;
63 * App event queue allocated in first segment
65 svm_msg_q_t *event_queue;
72 typedef struct segment_manager_main_init_args_
76 } segment_manager_main_init_args_t;
78 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
80 segment_manager_t *segment_manager_alloc (void);
81 int segment_manager_init (segment_manager_t * sm);
84 * Cleanup segment manager
86 * @param sm segment manager to be freed
88 void segment_manager_free (segment_manager_t * sm);
91 * Initiate segment manager cleanup
93 * @param sm segment manager to be freed
95 void segment_manager_init_free (segment_manager_t * sm);
96 segment_manager_t *segment_manager_get (u32 index);
97 segment_manager_t *segment_manager_get_if_valid (u32 index);
98 u32 segment_manager_index (segment_manager_t * sm);
100 int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
101 void segment_manager_del_segment (segment_manager_t * sm,
102 fifo_segment_t * fs);
103 fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
105 fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
106 fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
108 int segment_manager_add_first_segment (segment_manager_t * sm,
110 u64 segment_manager_make_segment_handle (u32 segment_manager_index,
112 u64 segment_manager_segment_handle (segment_manager_t * sm,
113 fifo_segment_t * segment);
114 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
115 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
117 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
119 svm_fifo_t ** rx_fifo,
120 svm_fifo_t ** tx_fifo);
121 int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
123 u32 rx_fifo_size, u32 tx_fifo_size,
124 svm_fifo_t ** rx_fifo,
125 svm_fifo_t ** tx_fifo);
126 void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
127 svm_fifo_t * tx_fifo);
128 void segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f);
129 void segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
132 void segment_manager_set_watermarks (segment_manager_t * sm,
133 u8 high_watermark, u8 low_watermark);
135 u8 segment_manager_has_fifos (segment_manager_t * sm);
137 svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
138 segment_manager_props_t * props);
139 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
140 svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
141 u32 segment_manager_evt_q_expected_size (u32 q_size);
143 void segment_manager_app_detach (segment_manager_t * sm);
146 * Cleanup segment manager sessions
148 * Initiates disconnects for all sessions 'owned' by a segment manager by
149 * leveraging the backpointers that fifos keep.
151 * @param sm segment manager whose sessions are to be disconnected
153 void segment_manager_del_sessions (segment_manager_t * sm);
154 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
156 void segment_manager_main_init (segment_manager_main_init_args_t * a);
158 segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
161 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
163 * fd.io coding-style-patch-verification: ON
166 * eval: (c-set-style "gnu")