src/vnet/session/segment_manager.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <vnet/session/segment_manager.h>
  17 #include <vnet/session/session.h>
  18 #include <vnet/session/application.h>
  19
  20 /**
  21  * Counter used to build segment names
  22  */
  23 u32 segment_name_counter = 0;
  24
  25 /**
  26  * Pool of segment managers
  27  */
  28 segment_manager_t *segment_managers = 0;
  29
  30 /**
  31  * Process private segment index
  32  */
  33 u32 private_segment_index = ~0;
  34
  35 /**
  36  * Default fifo and segment size. TODO config.
  37  */
  38 u32 default_fifo_size = 1 << 16;
  39 u32 default_segment_size = 1 << 20;
  40
  41 void
  42 segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size)
  43 {
  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;
  48 }
  49
  50 always_inline int
  51 session_manager_add_segment_i (segment_manager_t * sm, u32 segment_size,
  52                                u8 * segment_name)
  53 {
  54   svm_fifo_segment_create_args_t _ca, *ca = &_ca;
  55   int rv;
  56
  57   memset (ca, 0, sizeof (*ca));
  58
  59   ca->segment_name = (char *) segment_name;
  60   ca->segment_size = segment_size;
  61
  62   rv = svm_fifo_segment_create (ca);
  63   if (rv)
  64     {
  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;
  69     }
  70
  71   vec_add1 (sm->segment_indices, ca->new_segment_index);
  72
  73   return 0;
  74 }
  75
  76 int
  77 session_manager_add_segment (segment_manager_t * sm)
  78 {
  79   u8 *segment_name;
  80   svm_fifo_segment_create_args_t _ca, *ca = &_ca;
  81   u32 add_segment_size;
  82   int rv;
  83
  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;
  88
  89   rv = session_manager_add_segment_i (sm, add_segment_size, segment_name);
  90   vec_free (segment_name);
  91   return rv;
  92 }
  93
  94 int
  95 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size)
  96 {
  97   u8 *segment_name;
  98   int rv;
  99
 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);
 103   return rv;
 104 }
 105
 106 static void
 107 segment_manager_alloc_process_private_segment ()
 108 {
 109   svm_fifo_segment_create_args_t _a, *a = &_a;
 110
 111   if (private_segment_index != ~0)
 112     return;
 113
 114   memset (a, 0, sizeof (*a));
 115   a->segment_name = "process-private-segment";
 116   a->segment_size = ~0;
 117   a->new_segment_index = ~0;
 118
 119   if (svm_fifo_segment_create_process_private (a))
 120     clib_warning ("Failed to create process private segment");
 121
 122   private_segment_index = a->new_segment_index;
 123   ASSERT (private_segment_index != ~0);
 124 }
 125
 126 /**
 127  * Initializes segment manager based on options provided.
 128  * Returns error if svm segment allocation fails.
 129  */
 130 int
 131 segment_manager_init (segment_manager_t * sm,
 132                       segment_manager_properties_t * properties,
 133                       u32 first_seg_size)
 134 {
 135   int rv;
 136
 137   /* app allocates these */
 138   sm->properties = properties;
 139
 140   first_seg_size = first_seg_size > 0 ? first_seg_size : default_segment_size;
 141
 142   if (sm->properties->use_private_segment == 0)
 143     {
 144       rv = session_manager_add_first_segment (sm, first_seg_size);
 145       if (rv)
 146         {
 147           clib_warning ("Failed to allocate segment");
 148           return rv;
 149         }
 150     }
 151   else
 152     {
 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);
 157     }
 158
 159   clib_spinlock_init (&sm->lockp);
 160   return 0;
 161 }
 162
 163 /**
 164  * Removes segment manager.
 165  *
 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.
 169  */
 170 void
 171 segment_manager_del (segment_manager_t * sm)
 172 {
 173   u32 *deleted_sessions = 0;
 174   u32 *deleted_thread_indices = 0;
 175   int i, j;
 176
 177   /* Across all fifo segments used by the server */
 178   for (j = 0; j < vec_len (sm->segment_indices); j++)
 179     {
 180       svm_fifo_segment_private_t *fifo_segment;
 181       svm_fifo_t **fifos;
 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);
 185
 186       /*
 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.
 190        */
 191       for (i = 0; i < vec_len (fifos); i++)
 192         {
 193           svm_fifo_t *fifo;
 194           u32 session_index, thread_index;
 195           stream_session_t *session;
 196
 197           fifo = fifos[i];
 198           session_index = fifo->master_session_index;
 199           thread_index = fifo->master_thread_index;
 200
 201           session = stream_session_get (session_index, thread_index);
 202
 203           /* Add to the deleted_sessions vector (once!) */
 204           if (!session->is_deleted)
 205             {
 206               session->is_deleted = 1;
 207               vec_add1 (deleted_sessions, session_index);
 208               vec_add1 (deleted_thread_indices, thread_index);
 209             }
 210         }
 211
 212       for (i = 0; i < vec_len (deleted_sessions); i++)
 213         {
 214           stream_session_t *session;
 215           session = stream_session_get (deleted_sessions[i],
 216                                         deleted_thread_indices[i]);
 217
 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]);
 222
 223           /*
 224              stream_session_table_del (smm, session);
 225              pool_put(smm->sessions[deleted_thread_indices[i]], session);
 226            */
 227         }
 228
 229       vec_reset_length (deleted_sessions);
 230       vec_reset_length (deleted_thread_indices);
 231
 232       /* Instead of removing the segment, test when removing the session if
 233        * the segment can be removed
 234        */
 235       /* svm_fifo_segment_delete (fifo_segment); */
 236     }
 237
 238   clib_spinlock_free (&sm->lockp);
 239   vec_free (deleted_sessions);
 240   vec_free (deleted_thread_indices);
 241   pool_put (segment_managers, sm);
 242 }
 243
 244 static int
 245 segment_manager_notify_app_seg_add (segment_manager_t * sm,
 246                                     u32 fifo_segment_index)
 247 {
 248   application_t *app = application_get (sm->app_index);
 249   u32 seg_size = 0;
 250   u8 *seg_name;
 251
 252   /* Send an API message to the external app, to map new segment */
 253   ASSERT (app->cb_fns.add_segment_callback);
 254
 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,
 257                                            seg_size);
 258 }
 259
 260 int
 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)
 265 {
 266   svm_fifo_segment_private_t *fifo_segment;
 267   u32 fifo_size, sm_index;
 268   u8 added_a_segment = 0;
 269   int i;
 270
 271   ASSERT (vec_len (sm->segment_indices));
 272
 273   /* Make sure we don't have multiple threads trying to allocate segments
 274    * at the same time. */
 275   clib_spinlock_lock (&sm->lockp);
 276
 277   /* Allocate svm fifos */
 278 again:
 279   for (i = 0; i < vec_len (sm->segment_indices); i++)
 280     {
 281       *fifo_segment_index = sm->segment_indices[i];
 282       fifo_segment = svm_fifo_get_segment (*fifo_segment_index);
 283
 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);
 287
 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);
 291
 292       if (*server_rx_fifo == 0)
 293         {
 294           /* This would be very odd, but handle it... */
 295           if (*server_tx_fifo != 0)
 296             {
 297               svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo);
 298               *server_tx_fifo = 0;
 299             }
 300           continue;
 301         }
 302       if (*server_tx_fifo == 0)
 303         {
 304           if (*server_rx_fifo != 0)
 305             {
 306               svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo);
 307               *server_rx_fifo = 0;
 308             }
 309           continue;
 310         }
 311       break;
 312     }
 313
 314   /* See if we're supposed to create another segment */
 315   if (*server_rx_fifo == 0)
 316     {
 317       if (sm->properties->add_segment)
 318         {
 319           if (added_a_segment)
 320             {
 321               clib_warning ("added a segment, still cant allocate a fifo");
 322               return SESSION_ERROR_NEW_SEG_NO_SPACE;
 323             }
 324
 325           if (session_manager_add_segment (sm))
 326             {
 327               return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
 328             }
 329
 330           added_a_segment = 1;
 331           goto again;
 332         }
 333       else
 334         {
 335           clib_warning ("No space to allocate fifos!");
 336           return SESSION_ERROR_NO_SPACE;
 337         }
 338     }
 339
 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;
 344
 345   clib_spinlock_unlock (&sm->lockp);
 346
 347   if (added_a_segment)
 348     return segment_manager_notify_app_seg_add (sm, *fifo_segment_index);
 349
 350   return 0;
 351 }
 352
 353 void
 354 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
 355                                svm_fifo_t * tx_fifo)
 356 {
 357   segment_manager_t *sm;
 358   svm_fifo_segment_private_t *fifo_segment;
 359
 360   sm = segment_manager_get_if_valid (rx_fifo->segment_manager);
 361
 362   /* It's possible to have no segment manager if the session was removed
 363    * as result of a detach */
 364   if (!sm)
 365     return;
 366
 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);
 370
 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))
 374     {
 375       svm_fifo_segment_delete (fifo_segment);
 376       vec_del1 (sm->segment_indices, svm_segment_index);
 377     }
 378 }
 379
 380 /**
 381  * Allocates shm queue in the first segment
 382  */
 383 unix_shared_memory_queue_t *
 384 segment_manager_alloc_queue (segment_manager_t * sm, u32 queue_size)
 385 {
 386   ssvm_shared_header_t *sh;
 387   svm_fifo_segment_private_t *segment;
 388   unix_shared_memory_queue_t *q;
 389   void *oldheap;
 390
 391   ASSERT (sm->segment_indices != 0);
 392
 393   segment = svm_fifo_get_segment (sm->segment_indices[0]);
 394   sh = segment->ssvm.sh;
 395
 396   oldheap = ssvm_push_heap (sh);
 397   q =
 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);
 402   return q;
 403 }
 404
 405 /**
 406  * Frees shm queue allocated in the first segment
 407  */
 408 void
 409 segment_manager_dealloc_queue (segment_manager_t * sm,
 410                                unix_shared_memory_queue_t * q)
 411 {
 412   ssvm_shared_header_t *sh;
 413   svm_fifo_segment_private_t *segment;
 414   void *oldheap;
 415
 416   ASSERT (sm->segment_indices != 0);
 417
 418   segment = svm_fifo_get_segment (sm->segment_indices[0]);
 419   sh = segment->ssvm.sh;
 420
 421   oldheap = ssvm_push_heap (sh);
 422   unix_shared_memory_queue_free (q);
 423   ssvm_pop_heap (oldheap);
 424 }
 425
 426 /*
 427  * fd.io coding-style-patch-verification: ON
 428  *
 429  * Local Variables:
 430  * eval: (c-set-style "gnu")
 431  * End:
 432  */