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;
62 rv = svm_fifo_segment_create (ca);
65 clib_warning ("svm_fifo_segment_create ('%s', %d) failed",
66 ca->segment_name, ca->segment_size);
67 vec_free (segment_name);
68 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
71 vec_add1 (sm->segment_indices, ca->new_segment_index);
77 session_manager_add_segment (segment_manager_t * sm)
80 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
84 memset (ca, 0, sizeof (*ca));
85 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
86 add_segment_size = sm->properties->add_segment_size ?
87 sm->properties->add_segment_size : default_segment_size;
89 rv = session_manager_add_segment_i (sm, add_segment_size, segment_name);
90 vec_free (segment_name);
95 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size)
100 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
101 rv = session_manager_add_segment_i (sm, segment_size, segment_name);
102 vec_free (segment_name);
107 segment_manager_alloc_process_private_segment ()
109 svm_fifo_segment_create_args_t _a, *a = &_a;
111 if (private_segment_index != ~0)
114 memset (a, 0, sizeof (*a));
115 a->segment_name = "process-private-segment";
116 a->segment_size = ~0;
117 a->new_segment_index = ~0;
119 if (svm_fifo_segment_create_process_private (a))
120 clib_warning ("Failed to create process private segment");
122 private_segment_index = a->new_segment_index;
123 ASSERT (private_segment_index != ~0);
127 * Initializes segment manager based on options provided.
128 * Returns error if svm segment allocation fails.
131 segment_manager_init (segment_manager_t * sm,
132 segment_manager_properties_t * properties,
137 /* app allocates these */
138 sm->properties = properties;
140 first_seg_size = first_seg_size > 0 ? first_seg_size : default_segment_size;
142 if (sm->properties->use_private_segment == 0)
144 rv = session_manager_add_first_segment (sm, first_seg_size);
147 clib_warning ("Failed to allocate segment");
153 if (private_segment_index == ~0)
154 segment_manager_alloc_process_private_segment ();
155 ASSERT (private_segment_index != ~0);
156 vec_add1 (sm->segment_indices, private_segment_index);
159 clib_spinlock_init (&sm->lockp);
164 * Removes segment manager.
166 * Since the fifos allocated in the segment keep backpointers to the sessions
167 * prior to removing the segment, we call session disconnect. This
168 * subsequently propages into transport.
171 segment_manager_del (segment_manager_t * sm)
173 u32 *deleted_sessions = 0;
174 u32 *deleted_thread_indices = 0;
177 /* Across all fifo segments used by the server */
178 for (j = 0; j < vec_len (sm->segment_indices); j++)
180 svm_fifo_segment_private_t *fifo_segment;
182 /* Vector of fifos allocated in the segment */
183 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
184 fifos = svm_fifo_segment_get_fifos (fifo_segment);
187 * Remove any residual sessions from the session lookup table
188 * Don't bother deleting the individual fifos, we're going to
189 * throw away the fifo segment in a minute.
191 for (i = 0; i < vec_len (fifos); i++)
194 u32 session_index, thread_index;
195 stream_session_t *session;
198 session_index = fifo->master_session_index;
199 thread_index = fifo->master_thread_index;
201 session = stream_session_get (session_index, thread_index);
203 /* Add to the deleted_sessions vector (once!) */
204 if (!session->is_deleted)
206 session->is_deleted = 1;
207 vec_add1 (deleted_sessions, session_index);
208 vec_add1 (deleted_thread_indices, thread_index);
212 for (i = 0; i < vec_len (deleted_sessions); i++)
214 stream_session_t *session;
215 session = stream_session_get (deleted_sessions[i],
216 deleted_thread_indices[i]);
218 /* Instead of directly removing the session call disconnect */
219 session_send_session_evt_to_thread (stream_session_handle (session),
220 FIFO_EVENT_DISCONNECT,
221 deleted_thread_indices[i]);
224 stream_session_table_del (smm, session);
225 pool_put(smm->sessions[deleted_thread_indices[i]], session);
229 vec_reset_length (deleted_sessions);
230 vec_reset_length (deleted_thread_indices);
232 /* Instead of removing the segment, test when removing the session if
233 * the segment can be removed
235 /* svm_fifo_segment_delete (fifo_segment); */
238 clib_spinlock_free (&sm->lockp);
239 vec_free (deleted_sessions);
240 vec_free (deleted_thread_indices);
241 pool_put (segment_managers, sm);
245 segment_manager_notify_app_seg_add (segment_manager_t * sm,
246 u32 fifo_segment_index)
248 application_t *app = application_get (sm->app_index);
252 /* Send an API message to the external app, to map new segment */
253 ASSERT (app->cb_fns.add_segment_callback);
255 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
256 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
261 segment_manager_alloc_session_fifos (segment_manager_t * sm,
262 svm_fifo_t ** server_rx_fifo,
263 svm_fifo_t ** server_tx_fifo,
264 u32 * fifo_segment_index)
266 svm_fifo_segment_private_t *fifo_segment;
267 u32 fifo_size, sm_index;
268 u8 added_a_segment = 0;
271 ASSERT (vec_len (sm->segment_indices));
273 /* Make sure we don't have multiple threads trying to allocate segments
274 * at the same time. */
275 clib_spinlock_lock (&sm->lockp);
277 /* Allocate svm fifos */
279 for (i = 0; i < vec_len (sm->segment_indices); i++)
281 *fifo_segment_index = sm->segment_indices[i];
282 fifo_segment = svm_fifo_get_segment (*fifo_segment_index);
284 fifo_size = sm->properties->rx_fifo_size;
285 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
286 *server_rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size);
288 fifo_size = sm->properties->tx_fifo_size;
289 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
290 *server_tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size);
292 if (*server_rx_fifo == 0)
294 /* This would be very odd, but handle it... */
295 if (*server_tx_fifo != 0)
297 svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo);
302 if (*server_tx_fifo == 0)
304 if (*server_rx_fifo != 0)
306 svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo);
314 /* See if we're supposed to create another segment */
315 if (*server_rx_fifo == 0)
317 if (sm->properties->add_segment)
321 clib_warning ("added a segment, still cant allocate a fifo");
322 return SESSION_ERROR_NEW_SEG_NO_SPACE;
325 if (session_manager_add_segment (sm))
327 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
335 clib_warning ("No space to allocate fifos!");
336 return SESSION_ERROR_NO_SPACE;
340 /* Backpointers to segment manager */
341 sm_index = segment_manager_index (sm);
342 (*server_tx_fifo)->segment_manager = sm_index;
343 (*server_rx_fifo)->segment_manager = sm_index;
345 clib_spinlock_unlock (&sm->lockp);
348 return segment_manager_notify_app_seg_add (sm, *fifo_segment_index);
354 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
355 svm_fifo_t * tx_fifo)
357 segment_manager_t *sm;
358 svm_fifo_segment_private_t *fifo_segment;
360 sm = segment_manager_get_if_valid (rx_fifo->segment_manager);
362 /* It's possible to have no segment manager if the session was removed
363 * as result of a detach */
367 fifo_segment = svm_fifo_get_segment (svm_segment_index);
368 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo);
369 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo);
371 /* Remove segment only if it holds no fifos and not the first */
372 if (sm->segment_indices[0] != svm_segment_index
373 && !svm_fifo_segment_has_fifos (fifo_segment))
375 svm_fifo_segment_delete (fifo_segment);
376 vec_del1 (sm->segment_indices, svm_segment_index);
381 * Allocates shm queue in the first segment
383 unix_shared_memory_queue_t *
384 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
386 ssvm_shared_header_t *sh;
387 svm_fifo_segment_private_t *segment;
388 unix_shared_memory_queue_t *q;
391 ASSERT (sm->segment_indices != 0);
393 segment = svm_fifo_get_segment (sm->segment_indices[0]);
394 sh = segment->ssvm.sh;
396 oldheap = ssvm_push_heap (sh);
398 unix_shared_memory_queue_init (queue_size, sizeof (session_fifo_event_t),
399 0 /* consumer pid */ , 0
400 /* signal when queue non-empty */ );
401 ssvm_pop_heap (oldheap);
406 * Frees shm queue allocated in the first segment
409 segment_manager_dealloc_queue (segment_manager_t * sm,
410 unix_shared_memory_queue_t * q)
412 ssvm_shared_header_t *sh;
413 svm_fifo_segment_private_t *segment;
416 ASSERT (sm->segment_indices != 0);
418 segment = svm_fifo_get_segment (sm->segment_indices[0]);
419 sh = segment->ssvm.sh;
421 oldheap = ssvm_push_heap (sh);
422 unix_shared_memory_queue_free (q);
423 ssvm_pop_heap (oldheap);
427 * fd.io coding-style-patch-verification: ON
430 * eval: (c-set-style "gnu")