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 <vnet/vnet.h>
19 #include <svm/svm_fifo_segment.h>
20 #include <svm/message_queue.h>
21 #include <vlibmemory/api.h>
22 #include <vppinfra/lock.h>
23 #include <vppinfra/valloc.h>
25 typedef struct _segment_manager_properties
27 u32 rx_fifo_size; /**< receive fifo size */
28 u32 tx_fifo_size; /**< transmit fifo size */
29 u32 evt_q_size; /**< event queue length */
30 u32 segment_size; /**< first segment size */
31 u32 prealloc_fifos; /**< preallocated fifo pairs */
32 u32 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 ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
37 private segments are used */
38 } segment_manager_properties_t;
40 typedef struct _segment_manager
42 /** Pool of segments allocated by this manager */
43 svm_fifo_segment_private_t *segments;
45 /** rwlock that protects the segments pool */
46 clib_rwlock_t segments_rwlock;
48 /** Owner app worker index */
52 * First segment should not be deleted unless segment manger is deleted.
53 * This also indicates that the segment manager is the first to have been
54 * allocated for the app.
56 u8 first_is_protected;
59 * App event queue allocated in first segment
61 svm_msg_q_t *event_queue;
64 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY) \
66 clib_rwlock_reader_lock (&(SM)->segments_rwlock); \
67 pool_foreach((VAR), ((SM)->segments), (BODY)); \
68 clib_rwlock_reader_unlock (&(SM)->segments_rwlock); \
71 typedef struct segment_manager_main_
73 /** Pool of segment managers */
74 segment_manager_t *segment_managers;
76 /** Virtual address allocator */
77 clib_valloc_main_t va_allocator;
79 } segment_manager_main_t;
81 extern segment_manager_main_t segment_manager_main;
83 typedef struct segment_manager_main_init_args_
87 } segment_manager_main_init_args_t;
89 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
91 /** Pool of segment managers */
92 extern segment_manager_t *segment_managers;
94 always_inline segment_manager_t *
95 segment_manager_get (u32 index)
97 return pool_elt_at_index (segment_manager_main.segment_managers, index);
100 always_inline segment_manager_t *
101 segment_manager_get_if_valid (u32 index)
103 if (pool_is_free_index (segment_manager_main.segment_managers, index))
105 return pool_elt_at_index (segment_manager_main.segment_managers, index);
109 segment_manager_index (segment_manager_t * sm)
111 return sm - segment_manager_main.segment_managers;
114 always_inline svm_msg_q_t *
115 segment_manager_event_queue (segment_manager_t * sm)
117 return sm->event_queue;
121 segment_manager_make_segment_handle (u32 segment_manager_index,
124 return (((u64) segment_manager_index << 32) | segment_index);
127 u64 segment_manager_segment_handle (segment_manager_t * sm,
128 svm_fifo_segment_private_t * segment);
130 segment_manager_t *segment_manager_new ();
131 int segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
132 u32 prealloc_fifo_pairs);
134 svm_fifo_segment_private_t *segment_manager_get_segment (segment_manager_t *,
136 svm_fifo_segment_private_t *segment_manager_get_segment_w_handle (u64);
137 svm_fifo_segment_private_t
138 * segment_manager_get_segment_w_lock (segment_manager_t * sm,
140 int segment_manager_add_segment (segment_manager_t * sm, u32 segment_size);
141 void segment_manager_del_segment (segment_manager_t * sm,
142 svm_fifo_segment_private_t * fs);
143 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
144 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
146 int segment_manager_add_first_segment (segment_manager_t * sm,
148 void segment_manager_del_sessions (segment_manager_t * sm);
149 void segment_manager_del (segment_manager_t * sm);
150 void segment_manager_init_del (segment_manager_t * sm);
151 u8 segment_manager_has_fifos (segment_manager_t * sm);
152 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
153 svm_fifo_t ** server_rx_fifo,
154 svm_fifo_t ** server_tx_fifo,
155 u32 * fifo_segment_index);
156 int segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fs,
157 u32 rx_fifo_size, u32 tx_fifo_size,
158 svm_fifo_t ** rx_fifo,
159 svm_fifo_t ** tx_fifo);
160 void segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
161 svm_fifo_t * tx_fifo);
162 u32 segment_manager_evt_q_expected_size (u32 q_size);
163 svm_msg_q_t *segment_manager_alloc_queue (svm_fifo_segment_private_t * fs,
164 segment_manager_properties_t *
166 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
167 void segment_manager_app_detach (segment_manager_t * sm);
169 void segment_manager_main_init (segment_manager_main_init_args_t * a);
170 segment_manager_properties_t
171 * segment_manager_properties_init (segment_manager_properties_t * sm);
173 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
175 * fd.io coding-style-patch-verification: ON
178 * eval: (c-set-style "gnu")