2 * Copyright (c) 2017 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>
21 * Counter used to build segment names
23 u32 segment_name_counter = 0;
26 * Pool of segment managers
28 segment_manager_t *segment_managers = 0;
31 * Process private segment index
33 u32 private_segment_index = ~0;
36 * Default fifo and segment size. TODO config.
38 u32 default_fifo_size = 1 << 16;
39 u32 default_segment_size = 1 << 20;
42 segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size)
44 svm_fifo_segment_private_t *s;
45 s = svm_fifo_get_segment (index);
46 *name = s->h->segment_name;
47 *size = s->ssvm.ssvm_size;
51 session_manager_add_segment_i (segment_manager_t * sm, u32 segment_size,
54 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
57 memset (ca, 0, sizeof (*ca));
59 ca->segment_name = (char *) segment_name;
60 ca->segment_size = segment_size;
61 ca->rx_fifo_size = sm->properties->rx_fifo_size;
62 ca->tx_fifo_size = sm->properties->tx_fifo_size;
63 ca->preallocated_fifo_pairs = sm->properties->preallocated_fifo_pairs;
65 rv = svm_fifo_segment_create (ca);
68 clib_warning ("svm_fifo_segment_create ('%s', %d) failed",
69 ca->segment_name, ca->segment_size);
70 vec_free (segment_name);
71 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
74 vec_add1 (sm->segment_indices, ca->new_segment_index);
80 session_manager_add_segment (segment_manager_t * sm)
83 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
87 memset (ca, 0, sizeof (*ca));
88 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
89 add_segment_size = sm->properties->add_segment_size ?
90 sm->properties->add_segment_size : default_segment_size;
92 rv = session_manager_add_segment_i (sm, add_segment_size, segment_name);
93 vec_free (segment_name);
98 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size)
103 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
104 rv = session_manager_add_segment_i (sm, segment_size, segment_name);
105 vec_free (segment_name);
110 segment_manager_alloc_process_private_segment
111 (segment_manager_properties_t * props)
113 svm_fifo_segment_create_args_t _a, *a = &_a;
115 if (private_segment_index != ~0)
118 memset (a, 0, sizeof (*a));
119 a->segment_name = "process-private-segment";
120 a->segment_size = ~0;
121 a->new_segment_index = ~0;
122 a->rx_fifo_size = props->rx_fifo_size;
123 a->tx_fifo_size = props->tx_fifo_size;
124 a->preallocated_fifo_pairs = props->preallocated_fifo_pairs;
126 if (svm_fifo_segment_create_process_private (a))
127 clib_warning ("Failed to create process private segment");
129 private_segment_index = a->new_segment_index;
130 ASSERT (private_segment_index != ~0);
134 * Initializes segment manager based on options provided.
135 * Returns error if svm segment allocation fails.
138 segment_manager_init (segment_manager_t * sm,
139 segment_manager_properties_t * properties,
144 /* app allocates these */
145 sm->properties = properties;
147 first_seg_size = first_seg_size > 0 ? first_seg_size : default_segment_size;
149 if (sm->properties->use_private_segment == 0)
151 rv = session_manager_add_first_segment (sm, first_seg_size);
154 clib_warning ("Failed to allocate segment");
160 if (private_segment_index == ~0)
161 segment_manager_alloc_process_private_segment (properties);
162 ASSERT (private_segment_index != ~0);
163 vec_add1 (sm->segment_indices, private_segment_index);
166 clib_spinlock_init (&sm->lockp);
171 * Removes segment manager.
173 * Since the fifos allocated in the segment keep backpointers to the sessions
174 * prior to removing the segment, we call session disconnect. This
175 * subsequently propages into transport.
178 segment_manager_del (segment_manager_t * sm)
182 /* Across all fifo segments used by the server */
183 for (j = 0; j < vec_len (sm->segment_indices); j++)
185 svm_fifo_segment_private_t *fifo_segment;
188 /* Vector of fifos allocated in the segment */
189 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
190 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
193 * Remove any residual sessions from the session lookup table
194 * Don't bother deleting the individual fifos, we're going to
195 * throw away the fifo segment in a minute.
199 u32 session_index, thread_index;
200 stream_session_t *session;
202 session_index = fifo->master_session_index;
203 thread_index = fifo->master_thread_index;
205 session = stream_session_get (session_index, thread_index);
207 /* Instead of directly removing the session call disconnect */
208 session_send_session_evt_to_thread (stream_session_handle (session),
209 FIFO_EVENT_DISCONNECT,
214 /* Instead of removing the segment, test when cleaning up disconnected
215 * sessions if the segment can be removed.
219 clib_spinlock_free (&sm->lockp);
220 pool_put (segment_managers, sm);
224 segment_manager_notify_app_seg_add (segment_manager_t * sm,
225 u32 fifo_segment_index)
227 application_t *app = application_get (sm->app_index);
231 /* Send an API message to the external app, to map new segment */
232 ASSERT (app->cb_fns.add_segment_callback);
234 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
235 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
240 segment_manager_alloc_session_fifos (segment_manager_t * sm,
241 svm_fifo_t ** server_rx_fifo,
242 svm_fifo_t ** server_tx_fifo,
243 u32 * fifo_segment_index)
245 svm_fifo_segment_private_t *fifo_segment;
246 u32 fifo_size, sm_index;
247 u8 added_a_segment = 0;
250 ASSERT (vec_len (sm->segment_indices));
252 /* Make sure we don't have multiple threads trying to allocate segments
253 * at the same time. */
254 clib_spinlock_lock (&sm->lockp);
256 /* Allocate svm fifos */
258 for (i = 0; i < vec_len (sm->segment_indices); i++)
260 *fifo_segment_index = sm->segment_indices[i];
261 fifo_segment = svm_fifo_get_segment (*fifo_segment_index);
263 /* FC: cleanup, make sure sm->properties->xxx_fifo_size always set */
264 fifo_size = sm->properties->rx_fifo_size;
265 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
267 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
268 FIFO_SEGMENT_RX_FREELIST);
270 /* FC: cleanup, make sure sm->properties->xxx_fifo_size always set */
271 fifo_size = sm->properties->tx_fifo_size;
272 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
274 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
275 FIFO_SEGMENT_TX_FREELIST);
277 if (*server_rx_fifo == 0)
279 /* This would be very odd, but handle it... */
280 if (*server_tx_fifo != 0)
282 svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo,
283 FIFO_SEGMENT_TX_FREELIST);
288 if (*server_tx_fifo == 0)
290 if (*server_rx_fifo != 0)
292 svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo,
293 FIFO_SEGMENT_RX_FREELIST);
301 /* See if we're supposed to create another segment */
302 if (*server_rx_fifo == 0)
304 if (sm->properties->add_segment)
308 clib_warning ("added a segment, still cant allocate a fifo");
309 clib_spinlock_unlock (&sm->lockp);
310 return SESSION_ERROR_NEW_SEG_NO_SPACE;
313 if (session_manager_add_segment (sm))
315 clib_spinlock_unlock (&sm->lockp);
316 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
324 clib_warning ("No space to allocate fifos!");
325 clib_spinlock_unlock (&sm->lockp);
326 return SESSION_ERROR_NO_SPACE;
330 /* Backpointers to segment manager */
331 sm_index = segment_manager_index (sm);
332 (*server_tx_fifo)->segment_manager = sm_index;
333 (*server_rx_fifo)->segment_manager = sm_index;
335 clib_spinlock_unlock (&sm->lockp);
338 return segment_manager_notify_app_seg_add (sm, *fifo_segment_index);
344 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
345 svm_fifo_t * tx_fifo)
347 segment_manager_t *sm;
348 svm_fifo_segment_private_t *fifo_segment;
350 sm = segment_manager_get_if_valid (rx_fifo->segment_manager);
352 /* It's possible to have no segment manager if the session was removed
353 * as result of a detach */
357 fifo_segment = svm_fifo_get_segment (svm_segment_index);
358 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
359 FIFO_SEGMENT_RX_FREELIST);
360 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
361 FIFO_SEGMENT_TX_FREELIST);
363 /* Remove segment only if it holds no fifos and not the first */
364 if (sm->segment_indices[0] != svm_segment_index
365 && !svm_fifo_segment_has_fifos (fifo_segment))
367 clib_spinlock_lock (&sm->lockp);
368 svm_fifo_segment_delete (fifo_segment);
369 vec_del1 (sm->segment_indices, svm_segment_index);
370 clib_spinlock_unlock (&sm->lockp);
375 * Allocates shm queue in the first segment
377 unix_shared_memory_queue_t *
378 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
380 ssvm_shared_header_t *sh;
381 svm_fifo_segment_private_t *segment;
382 unix_shared_memory_queue_t *q;
385 ASSERT (sm->segment_indices != 0);
387 segment = svm_fifo_get_segment (sm->segment_indices[0]);
388 sh = segment->ssvm.sh;
390 oldheap = ssvm_push_heap (sh);
392 unix_shared_memory_queue_init (queue_size, sizeof (session_fifo_event_t),
393 0 /* consumer pid */ , 0
394 /* signal when queue non-empty */ );
395 ssvm_pop_heap (oldheap);
400 * Frees shm queue allocated in the first segment
403 segment_manager_dealloc_queue (segment_manager_t * sm,
404 unix_shared_memory_queue_t * q)
406 ssvm_shared_header_t *sh;
407 svm_fifo_segment_private_t *segment;
410 ASSERT (sm->segment_indices != 0);
412 segment = svm_fifo_get_segment (sm->segment_indices[0]);
413 sh = segment->ssvm.sh;
415 oldheap = ssvm_push_heap (sh);
416 unix_shared_memory_queue_free (q);
417 ssvm_pop_heap (oldheap);
421 * fd.io coding-style-patch-verification: ON
424 * eval: (c-set-style "gnu")