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 return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
73 vec_add1 (sm->segment_indices, ca->new_segment_index);
79 session_manager_add_segment (segment_manager_t * sm)
82 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
86 memset (ca, 0, sizeof (*ca));
87 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
88 add_segment_size = sm->properties->add_segment_size ?
89 sm->properties->add_segment_size : default_segment_size;
91 rv = session_manager_add_segment_i (sm, add_segment_size, segment_name);
92 vec_free (segment_name);
97 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size)
102 segment_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
103 rv = session_manager_add_segment_i (sm, segment_size, segment_name);
104 vec_free (segment_name);
109 segment_manager_alloc_process_private_segment
110 (segment_manager_properties_t * props)
112 svm_fifo_segment_create_args_t _a, *a = &_a;
114 if (private_segment_index != ~0)
117 memset (a, 0, sizeof (*a));
118 a->segment_name = "process-private-segment";
119 a->segment_size = ~0;
120 a->new_segment_index = ~0;
121 a->rx_fifo_size = props->rx_fifo_size;
122 a->tx_fifo_size = props->tx_fifo_size;
123 a->preallocated_fifo_pairs = props->preallocated_fifo_pairs;
125 if (svm_fifo_segment_create_process_private (a))
126 clib_warning ("Failed to create process private segment");
128 private_segment_index = a->new_segment_index;
129 ASSERT (private_segment_index != ~0);
133 * Initializes segment manager based on options provided.
134 * Returns error if svm segment allocation fails.
137 segment_manager_init (segment_manager_t * sm,
138 segment_manager_properties_t * properties,
143 /* app allocates these */
144 sm->properties = properties;
146 first_seg_size = first_seg_size > 0 ? first_seg_size : default_segment_size;
148 if (sm->properties->use_private_segment == 0)
150 rv = session_manager_add_first_segment (sm, first_seg_size);
153 clib_warning ("Failed to allocate segment");
159 if (private_segment_index == ~0)
160 segment_manager_alloc_process_private_segment (properties);
161 ASSERT (private_segment_index != ~0);
162 vec_add1 (sm->segment_indices, private_segment_index);
165 clib_spinlock_init (&sm->lockp);
170 segment_manager_first_segment_maybe_del (segment_manager_t * sm)
172 svm_fifo_segment_private_t *fifo_segment;
174 /* If the first semgment has no fifos, then delete the 1st segment
176 fifo_segment = svm_fifo_get_segment (sm->segment_indices[0]);
177 if (!svm_fifo_segment_has_fifos (fifo_segment))
179 clib_spinlock_lock (&sm->lockp);
180 svm_fifo_segment_delete (fifo_segment);
181 vec_del1 (sm->segment_indices, 0);
182 clib_spinlock_unlock (&sm->lockp);
187 * Removes segment manager.
189 * Since the fifos allocated in the segment keep backpointers to the sessions
190 * prior to removing the segment, we call session disconnect. This
191 * subsequently propages into transport.
194 segment_manager_del (segment_manager_t * sm)
197 svm_fifo_segment_private_t *fifo_segment;
198 ASSERT (vec_len (sm->segment_indices));
200 /* Across all fifo segments used by the server */
201 for (j = 0; j < vec_len (sm->segment_indices); j++)
205 /* Vector of fifos allocated in the segment */
206 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
207 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
210 * Remove any residual sessions from the session lookup table
211 * Don't bother deleting the individual fifos, we're going to
212 * throw away the fifo segment in a minute.
216 u32 session_index, thread_index;
217 stream_session_t *session;
219 session_index = fifo->master_session_index;
220 thread_index = fifo->master_thread_index;
222 session = stream_session_get (session_index, thread_index);
224 /* Instead of directly removing the session call disconnect */
225 session_send_session_evt_to_thread (stream_session_handle (session),
226 FIFO_EVENT_DISCONNECT,
231 /* Instead of removing the segment, test when cleaning up disconnected
232 * sessions if the segment can be removed.
236 segment_manager_first_segment_maybe_del (sm);
238 clib_spinlock_free (&sm->lockp);
239 pool_put (segment_managers, sm);
243 segment_manager_notify_app_seg_add (segment_manager_t * sm,
244 u32 fifo_segment_index)
246 application_t *app = application_get (sm->app_index);
250 /* Send an API message to the external app, to map new segment */
251 ASSERT (app->cb_fns.add_segment_callback);
253 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
254 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
259 segment_manager_alloc_session_fifos (segment_manager_t * sm,
260 svm_fifo_t ** server_rx_fifo,
261 svm_fifo_t ** server_tx_fifo,
262 u32 * fifo_segment_index)
264 svm_fifo_segment_private_t *fifo_segment;
265 u32 fifo_size, sm_index;
266 u8 added_a_segment = 0;
269 ASSERT (vec_len (sm->segment_indices));
271 /* Make sure we don't have multiple threads trying to allocate segments
272 * at the same time. */
273 clib_spinlock_lock (&sm->lockp);
275 /* Allocate svm fifos */
277 for (i = 0; i < vec_len (sm->segment_indices); i++)
279 *fifo_segment_index = sm->segment_indices[i];
280 fifo_segment = svm_fifo_get_segment (*fifo_segment_index);
282 /* FC: cleanup, make sure sm->properties->xxx_fifo_size always set */
283 fifo_size = sm->properties->rx_fifo_size;
284 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
286 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
287 FIFO_SEGMENT_RX_FREELIST);
289 /* FC: cleanup, make sure sm->properties->xxx_fifo_size always set */
290 fifo_size = sm->properties->tx_fifo_size;
291 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
293 svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size,
294 FIFO_SEGMENT_TX_FREELIST);
296 if (*server_rx_fifo == 0)
298 /* This would be very odd, but handle it... */
299 if (*server_tx_fifo != 0)
301 svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo,
302 FIFO_SEGMENT_TX_FREELIST);
307 if (*server_tx_fifo == 0)
309 if (*server_rx_fifo != 0)
311 svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo,
312 FIFO_SEGMENT_RX_FREELIST);
320 /* See if we're supposed to create another segment */
321 if (*server_rx_fifo == 0)
323 if (sm->properties->add_segment)
327 clib_warning ("added a segment, still cant allocate a fifo");
328 clib_spinlock_unlock (&sm->lockp);
329 return SESSION_ERROR_NEW_SEG_NO_SPACE;
332 if (session_manager_add_segment (sm))
334 clib_spinlock_unlock (&sm->lockp);
335 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
343 clib_warning ("No space to allocate fifos!");
344 clib_spinlock_unlock (&sm->lockp);
345 return SESSION_ERROR_NO_SPACE;
349 /* Backpointers to segment manager */
350 sm_index = segment_manager_index (sm);
351 (*server_tx_fifo)->segment_manager = sm_index;
352 (*server_rx_fifo)->segment_manager = sm_index;
354 clib_spinlock_unlock (&sm->lockp);
357 return segment_manager_notify_app_seg_add (sm, *fifo_segment_index);
363 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
364 svm_fifo_t * tx_fifo)
366 segment_manager_t *sm;
367 svm_fifo_segment_private_t *fifo_segment;
369 sm = segment_manager_get_if_valid (rx_fifo->segment_manager);
371 /* It's possible to have no segment manager if the session was removed
372 * as result of a detach */
376 fifo_segment = svm_fifo_get_segment (svm_segment_index);
377 svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
378 FIFO_SEGMENT_RX_FREELIST);
379 svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
380 FIFO_SEGMENT_TX_FREELIST);
382 /* Remove segment only if it holds no fifos and not the first */
383 if (sm->segment_indices[0] != svm_segment_index
384 && !svm_fifo_segment_has_fifos (fifo_segment))
386 clib_spinlock_lock (&sm->lockp);
387 svm_fifo_segment_delete (fifo_segment);
388 vec_del1 (sm->segment_indices, svm_segment_index);
389 clib_spinlock_unlock (&sm->lockp);
394 * Allocates shm queue in the first segment
396 unix_shared_memory_queue_t *
397 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
399 ssvm_shared_header_t *sh;
400 svm_fifo_segment_private_t *segment;
401 unix_shared_memory_queue_t *q;
404 ASSERT (sm->segment_indices != 0);
406 segment = svm_fifo_get_segment (sm->segment_indices[0]);
407 sh = segment->ssvm.sh;
409 oldheap = ssvm_push_heap (sh);
411 unix_shared_memory_queue_init (queue_size, sizeof (session_fifo_event_t),
412 0 /* consumer pid */ , 0
413 /* signal when queue non-empty */ );
414 ssvm_pop_heap (oldheap);
419 * Frees shm queue allocated in the first segment
422 segment_manager_dealloc_queue (segment_manager_t * sm,
423 unix_shared_memory_queue_t * q)
425 ssvm_shared_header_t *sh;
426 svm_fifo_segment_private_t *segment;
429 ASSERT (sm->segment_indices != 0);
431 segment = svm_fifo_get_segment (sm->segment_indices[0]);
432 sh = segment->ssvm.sh;
434 oldheap = ssvm_push_heap (sh);
435 unix_shared_memory_queue_free (q);
436 ssvm_pop_heap (oldheap);
440 * fd.io coding-style-patch-verification: ON
443 * eval: (c-set-style "gnu")