src/vnet/session/segment_manager.c

   1 /*
   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:
   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 typedef struct segment_manager_main_
  21 {
  22   segment_manager_t *segment_managers;  /**< Pool of segment managers */
  23   clib_valloc_main_t va_allocator;      /**< Virtual address allocator */
  24   u32 seg_name_counter;                 /**< Counter for segment names */
  25
  26   /*
  27    * Configuration
  28    */
  29   u32 default_fifo_size;        /**< default rx/tx fifo size */
  30   u32 default_segment_size;     /**< default fifo segment size */
  31   u32 default_app_mq_size;      /**< default app msg q size */
  32   u32 default_max_fifo_size;    /**< default max fifo size */
  33   u8 default_high_watermark;    /**< default high watermark % */
  34   u8 default_low_watermark;     /**< default low watermark % */
  35 } segment_manager_main_t;
  36
  37 static segment_manager_main_t sm_main;
  38
  39 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY)           \
  40 do {                                                                    \
  41     clib_rwlock_reader_lock (&(SM)->segments_rwlock);                   \
  42     pool_foreach((VAR), ((SM)->segments), (BODY));                      \
  43     clib_rwlock_reader_unlock (&(SM)->segments_rwlock);                 \
  44 } while (0)
  45
  46 static segment_manager_props_t *
  47 segment_manager_properties_get (segment_manager_t * sm)
  48 {
  49   app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
  50   return application_get_segment_manager_properties (app_wrk->app_index);
  51 }
  52
  53 segment_manager_props_t *
  54 segment_manager_props_init (segment_manager_props_t * props)
  55 {
  56   props->add_segment_size = sm_main.default_segment_size;
  57   props->rx_fifo_size = sm_main.default_fifo_size;
  58   props->tx_fifo_size = sm_main.default_fifo_size;
  59   props->evt_q_size = sm_main.default_app_mq_size;
  60   props->max_fifo_size = sm_main.default_max_fifo_size;
  61   props->high_watermark = sm_main.default_high_watermark;
  62   props->low_watermark = sm_main.default_low_watermark;
  63   props->n_slices = vlib_num_workers () + 1;
  64   return props;
  65 }
  66
  67 u8
  68 segment_manager_app_detached (segment_manager_t * sm)
  69 {
  70   return (sm->flags & SEG_MANAGER_F_DETACHED);
  71 }
  72
  73 void
  74 segment_manager_app_detach (segment_manager_t * sm)
  75 {
  76   sm->flags |= SEG_MANAGER_F_DETACHED;
  77 }
  78
  79 always_inline u32
  80 segment_manager_segment_index (segment_manager_t * sm, fifo_segment_t * seg)
  81 {
  82   return (seg - sm->segments);
  83 }
  84
  85 /**
  86  * Adds segment to segment manager's pool
  87  *
  88  * If needed a writer's lock is acquired before allocating a new segment
  89  * to avoid affecting any of the segments pool readers.
  90  */
  91 int
  92 segment_manager_add_segment (segment_manager_t * sm, uword segment_size)
  93 {
  94   uword baseva = (uword) ~ 0ULL, alloc_size, page_size;
  95   u32 rnd_margin = 128 << 10, fs_index = ~0;
  96   segment_manager_main_t *smm = &sm_main;
  97   segment_manager_props_t *props;
  98   fifo_segment_t *fs;
  99   u8 *seg_name;
 100   int rv;
 101
 102   props = segment_manager_properties_get (sm);
 103
 104   /* Not configured for addition of new segments and not first */
 105   if (!props->add_segment && !segment_size)
 106     {
 107       clib_warning ("cannot allocate new segment");
 108       return VNET_API_ERROR_INVALID_VALUE;
 109     }
 110
 111   /*
 112    * Allocate fifo segment and grab lock if needed
 113    */
 114   if (vlib_num_workers ())
 115     clib_rwlock_writer_lock (&sm->segments_rwlock);
 116
 117   pool_get_zero (sm->segments, fs);
 118
 119   /*
 120    * Allocate ssvm segment
 121    */
 122   segment_size = segment_size ? segment_size : props->add_segment_size;
 123   page_size = clib_mem_get_page_size ();
 124   /* Protect against segment size u32 wrap */
 125   segment_size = clib_max (segment_size + page_size - 1, segment_size);
 126   segment_size = segment_size & ~(page_size - 1);
 127
 128   if (props->segment_type != SSVM_SEGMENT_PRIVATE)
 129     {
 130       seg_name = format (0, "%d-%d%c", getpid (), smm->seg_name_counter++, 0);
 131       alloc_size = (uword) segment_size + rnd_margin;
 132       baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
 133       if (!baseva)
 134         {
 135           clib_warning ("out of space for segments");
 136           pool_put (sm->segments, fs);
 137           goto done;
 138         }
 139     }
 140   else
 141     {
 142       app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
 143       application_t *app = application_get (app_wrk->app_index);
 144       seg_name = format (0, "%v segment%c", app->name, 0);
 145     }
 146
 147   fs->ssvm.ssvm_size = segment_size;
 148   fs->ssvm.name = seg_name;
 149   /* clib_mem_vm_map_shared consumes first page before requested_va */
 150   fs->ssvm.requested_va = baseva + page_size;
 151
 152   if ((rv = ssvm_master_init (&fs->ssvm, props->segment_type)))
 153     {
 154       clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
 155                     segment_size);
 156
 157       if (props->segment_type != SSVM_SEGMENT_PRIVATE)
 158         clib_valloc_free (&smm->va_allocator, baseva);
 159       pool_put (sm->segments, fs);
 160       goto done;
 161     }
 162
 163   /*
 164    * Initialize fifo segment
 165    */
 166   fs->n_slices = props->n_slices;
 167   fifo_segment_init (fs);
 168
 169   /*
 170    * Save segment index before dropping lock, if any held
 171    */
 172   fs_index = fs - sm->segments;
 173
 174   /*
 175    * Set watermarks in segment
 176    */
 177   fs->h->high_watermark = sm->high_watermark;
 178   fs->h->low_watermark = sm->low_watermark;
 179   fs->h->pct_first_alloc = props->pct_first_alloc;
 180   fs->h->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
 181
 182 done:
 183
 184   if (vlib_num_workers ())
 185     clib_rwlock_writer_unlock (&sm->segments_rwlock);
 186
 187   return fs_index;
 188 }
 189
 190 /**
 191  * Remove segment without lock
 192  */
 193 void
 194 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
 195 {
 196   segment_manager_main_t *smm = &sm_main;
 197
 198   if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
 199     {
 200       /* clib_mem_vm_map_shared consumes first page before requested_va */
 201       clib_valloc_free (&smm->va_allocator,
 202                         fs->ssvm.requested_va - clib_mem_get_page_size ());
 203
 204       if (!segment_manager_app_detached (sm))
 205         {
 206           app_worker_t *app_wrk;
 207           u64 segment_handle;
 208           app_wrk = app_worker_get (sm->app_wrk_index);
 209           segment_handle = segment_manager_segment_handle (sm, fs);
 210           app_worker_del_segment_notify (app_wrk, segment_handle);
 211         }
 212     }
 213
 214   ssvm_delete (&fs->ssvm);
 215
 216   if (CLIB_DEBUG)
 217     clib_memset (fs, 0xfb, sizeof (*fs));
 218   pool_put (sm->segments, fs);
 219 }
 220
 221 static fifo_segment_t *
 222 segment_manager_get_segment_if_valid (segment_manager_t * sm,
 223                                       u32 segment_index)
 224 {
 225   if (pool_is_free_index (sm->segments, segment_index))
 226     return 0;
 227   return pool_elt_at_index (sm->segments, segment_index);
 228 }
 229
 230 /**
 231  * Removes segment after acquiring writer lock
 232  */
 233 static inline void
 234 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
 235 {
 236   fifo_segment_t *fs;
 237   u8 is_prealloc;
 238
 239   clib_rwlock_writer_lock (&sm->segments_rwlock);
 240
 241   fs = segment_manager_get_segment_if_valid (sm, fs_index);
 242   if (!fs)
 243     goto done;
 244
 245   is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
 246   if (is_prealloc && !segment_manager_app_detached (sm))
 247     goto done;
 248
 249   segment_manager_del_segment (sm, fs);
 250
 251 done:
 252   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 253 }
 254
 255 /**
 256  * Reads a segment from the segment manager's pool without lock
 257  */
 258 fifo_segment_t *
 259 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
 260 {
 261   return pool_elt_at_index (sm->segments, segment_index);
 262 }
 263
 264 u64
 265 segment_manager_segment_handle (segment_manager_t * sm,
 266                                 fifo_segment_t * segment)
 267 {
 268   u32 segment_index = segment_manager_segment_index (sm, segment);
 269   return (((u64) segment_manager_index (sm) << 32) | segment_index);
 270 }
 271
 272 u64
 273 segment_manager_make_segment_handle (u32 segment_manager_index,
 274                                      u32 segment_index)
 275 {
 276   return (((u64) segment_manager_index << 32) | segment_index);
 277 }
 278
 279 fifo_segment_t *
 280 segment_manager_get_segment_w_handle (u64 segment_handle)
 281 {
 282   u32 sm_index, segment_index;
 283   segment_manager_t *sm;
 284
 285   segment_manager_parse_segment_handle (segment_handle, &sm_index,
 286                                         &segment_index);
 287   sm = segment_manager_get (sm_index);
 288   if (!sm || pool_is_free_index (sm->segments, segment_index))
 289     return 0;
 290   return pool_elt_at_index (sm->segments, segment_index);
 291 }
 292
 293 /**
 294  * Reads a segment from the segment manager's pool and acquires reader lock
 295  *
 296  * Caller must drop the reader's lock by calling
 297  * @ref segment_manager_segment_reader_unlock once it finishes working with
 298  * the segment.
 299  */
 300 fifo_segment_t *
 301 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
 302 {
 303   clib_rwlock_reader_lock (&sm->segments_rwlock);
 304   return pool_elt_at_index (sm->segments, segment_index);
 305 }
 306
 307 void
 308 segment_manager_segment_reader_lock (segment_manager_t * sm)
 309 {
 310   clib_rwlock_reader_lock (&sm->segments_rwlock);
 311 }
 312
 313 void
 314 segment_manager_segment_reader_unlock (segment_manager_t * sm)
 315 {
 316   clib_rwlock_reader_unlock (&sm->segments_rwlock);
 317 }
 318
 319 void
 320 segment_manager_segment_writer_unlock (segment_manager_t * sm)
 321 {
 322   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 323 }
 324
 325 segment_manager_t *
 326 segment_manager_alloc (void)
 327 {
 328   segment_manager_main_t *smm = &sm_main;
 329   segment_manager_t *sm;
 330
 331   pool_get_zero (smm->segment_managers, sm);
 332   clib_rwlock_init (&sm->segments_rwlock);
 333   return sm;
 334 }
 335
 336 /**
 337  * Initializes segment manager based on options provided.
 338  * Returns error if ssvm segment(s) allocation fails.
 339  */
 340 int
 341 segment_manager_init (segment_manager_t * sm)
 342 {
 343   segment_manager_props_t *props;
 344   uword first_seg_size;
 345   fifo_segment_t *fs;
 346   int fs_index, i;
 347
 348   props = segment_manager_properties_get (sm);
 349   first_seg_size = clib_max (props->segment_size,
 350                              sm_main.default_segment_size);
 351
 352   sm->max_fifo_size = props->max_fifo_size ?
 353     props->max_fifo_size : sm_main.default_max_fifo_size;
 354   sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
 355
 356   segment_manager_set_watermarks (sm,
 357                                   props->high_watermark,
 358                                   props->low_watermark);
 359
 360   if (props->prealloc_fifos)
 361     {
 362       u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
 363       u32 rx_rounded_data_size, tx_rounded_data_size;
 364       u32 prealloc_fifo_pairs = props->prealloc_fifos;
 365       u32 rx_fifo_size, tx_fifo_size, pair_size;
 366       u32 approx_segment_count;
 367
 368       /* Figure out how many segments should be preallocated */
 369       rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
 370       tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
 371
 372       rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
 373       tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
 374       pair_size = rx_fifo_size + tx_fifo_size;
 375
 376       approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
 377       if (first_seg_size > approx_total_size)
 378         max_seg_size = first_seg_size;
 379       approx_segment_count = (approx_total_size + (max_seg_size - 1))
 380         / max_seg_size;
 381
 382       /* Allocate the segments */
 383       for (i = 0; i < approx_segment_count + 1; i++)
 384         {
 385           fs_index = segment_manager_add_segment (sm, max_seg_size);
 386           if (fs_index < 0)
 387             {
 388               clib_warning ("Failed to preallocate segment %d", i);
 389               return fs_index;
 390             }
 391
 392           fs = segment_manager_get_segment (sm, fs_index);
 393           if (i == 0)
 394             sm->event_queue = segment_manager_alloc_queue (fs, props);
 395
 396           fifo_segment_preallocate_fifo_pairs (fs,
 397                                                props->rx_fifo_size,
 398                                                props->tx_fifo_size,
 399                                                &prealloc_fifo_pairs);
 400           fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
 401           if (prealloc_fifo_pairs == 0)
 402             break;
 403         }
 404       return 0;
 405     }
 406
 407   fs_index = segment_manager_add_segment (sm, first_seg_size);
 408   if (fs_index < 0)
 409     {
 410       clib_warning ("Failed to allocate segment");
 411       return fs_index;
 412     }
 413
 414   fs = segment_manager_get_segment (sm, fs_index);
 415   sm->event_queue = segment_manager_alloc_queue (fs, props);
 416
 417   if (props->prealloc_fifo_hdrs)
 418     {
 419       u32 hdrs_per_slice;
 420
 421       /* Do not preallocate on slice associated to main thread */
 422       i = (vlib_num_workers ()? 1 : 0);
 423       hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
 424
 425       for (; i < fs->n_slices; i++)
 426         {
 427           if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
 428             return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
 429         }
 430     }
 431
 432   return 0;
 433 }
 434
 435 void
 436 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
 437 {
 438   app_worker_t *app_wrk;
 439
 440   app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 441   if (!app_wrk)
 442     return;
 443
 444   app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
 445 }
 446
 447 /**
 448  * Cleanup segment manager.
 449  */
 450 void
 451 segment_manager_free (segment_manager_t * sm)
 452 {
 453   segment_manager_main_t *smm = &sm_main;
 454   fifo_segment_t *fifo_segment;
 455
 456   ASSERT (!segment_manager_has_fifos (sm)
 457           && segment_manager_app_detached (sm));
 458
 459   if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
 460     segment_manager_cleanup_detached_listener (sm);
 461
 462   /* If we have empty preallocated segments that haven't been removed, remove
 463    * them now. Apart from that, the first segment in the first segment manager
 464    * is not removed when all fifos are removed. It can only be removed when
 465    * the manager is explicitly deleted/detached by the app. */
 466   clib_rwlock_writer_lock (&sm->segments_rwlock);
 467
 468   /* *INDENT-OFF* */
 469   pool_foreach (fifo_segment, sm->segments, ({
 470     segment_manager_del_segment (sm, fifo_segment);
 471   }));
 472   /* *INDENT-ON* */
 473
 474   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 475
 476   clib_rwlock_free (&sm->segments_rwlock);
 477   if (CLIB_DEBUG)
 478     clib_memset (sm, 0xfe, sizeof (*sm));
 479   pool_put (smm->segment_managers, sm);
 480 }
 481
 482 void
 483 segment_manager_init_free (segment_manager_t * sm)
 484 {
 485   segment_manager_app_detach (sm);
 486   if (segment_manager_has_fifos (sm))
 487     segment_manager_del_sessions (sm);
 488   else
 489     {
 490       ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
 491       segment_manager_free (sm);
 492     }
 493 }
 494
 495 segment_manager_t *
 496 segment_manager_get (u32 index)
 497 {
 498   return pool_elt_at_index (sm_main.segment_managers, index);
 499 }
 500
 501 segment_manager_t *
 502 segment_manager_get_if_valid (u32 index)
 503 {
 504   if (pool_is_free_index (sm_main.segment_managers, index))
 505     return 0;
 506   return pool_elt_at_index (sm_main.segment_managers, index);
 507 }
 508
 509 u32
 510 segment_manager_index (segment_manager_t * sm)
 511 {
 512   return sm - sm_main.segment_managers;
 513 }
 514
 515 u8
 516 segment_manager_has_fifos (segment_manager_t * sm)
 517 {
 518   fifo_segment_t *seg;
 519   u8 first = 1;
 520
 521   /* *INDENT-OFF* */
 522   segment_manager_foreach_segment_w_lock (seg, sm, ({
 523     if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
 524         && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
 525       {
 526         clib_warning ("segment %d has no fifos!",
 527                       segment_manager_segment_index (sm, seg));
 528         first = 0;
 529       }
 530     if (fifo_segment_has_fifos (seg))
 531       {
 532         segment_manager_segment_reader_unlock (sm);
 533         return 1;
 534       }
 535   }));
 536   /* *INDENT-ON* */
 537
 538   return 0;
 539 }
 540
 541 /**
 542  * Initiate disconnects for all sessions 'owned' by a segment manager
 543  */
 544 void
 545 segment_manager_del_sessions (segment_manager_t * sm)
 546 {
 547   session_handle_t *handles = 0, *handle;
 548   fifo_segment_t *fs;
 549   session_t *session;
 550   int slice_index;
 551   svm_fifo_t *f;
 552
 553   ASSERT (pool_elts (sm->segments) != 0);
 554
 555   /* Across all fifo segments used by the server */
 556   /* *INDENT-OFF* */
 557   segment_manager_foreach_segment_w_lock (fs, sm, ({
 558     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 559       {
 560         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
 561
 562         /*
 563          * Remove any residual sessions from the session lookup table
 564          * Don't bother deleting the individual fifos, we're going to
 565          * throw away the fifo segment in a minute.
 566          */
 567         while (f)
 568           {
 569             session = session_get_if_valid (f->master_session_index,
 570                                             f->master_thread_index);
 571             if (session)
 572               vec_add1 (handles, session_handle (session));
 573             f = f->next;
 574           }
 575       }
 576
 577     /* Instead of removing the segment, test when cleaning up disconnected
 578      * sessions if the segment can be removed.
 579      */
 580   }));
 581   /* *INDENT-ON* */
 582
 583   vec_foreach (handle, handles)
 584   {
 585     session = session_get_from_handle (*handle);
 586     session_close (session);
 587     /* Avoid propagating notifications back to the app */
 588     session->app_wrk_index = APP_INVALID_INDEX;
 589   }
 590 }
 591
 592 int
 593 segment_manager_try_alloc_fifos (fifo_segment_t * fifo_segment,
 594                                  u32 thread_index,
 595                                  u32 rx_fifo_size, u32 tx_fifo_size,
 596                                  svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
 597 {
 598   rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
 599   *rx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 600                                               rx_fifo_size,
 601                                               FIFO_SEGMENT_RX_FIFO);
 602
 603   tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
 604   *tx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 605                                               tx_fifo_size,
 606                                               FIFO_SEGMENT_TX_FIFO);
 607
 608   if (*rx_fifo == 0)
 609     {
 610       /* This would be very odd, but handle it... */
 611       if (*tx_fifo != 0)
 612         {
 613           fifo_segment_free_fifo (fifo_segment, *tx_fifo);
 614           *tx_fifo = 0;
 615         }
 616       return -1;
 617     }
 618   if (*tx_fifo == 0)
 619     {
 620       if (*rx_fifo != 0)
 621         {
 622           fifo_segment_free_fifo (fifo_segment, *rx_fifo);
 623           *rx_fifo = 0;
 624         }
 625       return -1;
 626     }
 627
 628   return 0;
 629 }
 630
 631 int
 632 segment_manager_alloc_session_fifos (segment_manager_t * sm,
 633                                      u32 thread_index,
 634                                      svm_fifo_t ** rx_fifo,
 635                                      svm_fifo_t ** tx_fifo)
 636 {
 637   int alloc_fail = 1, rv = 0, new_fs_index;
 638   uword free_bytes, max_free_bytes = 0;
 639   segment_manager_props_t *props;
 640   fifo_segment_t *fs = 0, *cur;
 641   u32 sm_index, fs_index;
 642   u8 added_a_segment = 0;
 643   u64 fs_handle;
 644
 645   props = segment_manager_properties_get (sm);
 646
 647   /*
 648    * Find the first free segment to allocate the fifos in
 649    */
 650
 651   segment_manager_segment_reader_lock (sm);
 652
 653   /* *INDENT-OFF* */
 654   pool_foreach (cur, sm->segments, ({
 655     free_bytes = fifo_segment_available_bytes (cur);
 656     if (free_bytes > max_free_bytes)
 657       {
 658         max_free_bytes = free_bytes;
 659         fs = cur;
 660       }
 661   }));
 662   /* *INDENT-ON* */
 663
 664   if (fs)
 665     {
 666       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 667                                                     props->rx_fifo_size,
 668                                                     props->tx_fifo_size,
 669                                                     rx_fifo, tx_fifo);
 670       /* On success, keep lock until fifos are initialized */
 671       if (!alloc_fail)
 672         goto alloc_success;
 673     }
 674
 675   segment_manager_segment_reader_unlock (sm);
 676
 677 alloc_check:
 678
 679   if (!alloc_fail)
 680     {
 681
 682     alloc_success:
 683
 684       ASSERT (rx_fifo && tx_fifo);
 685       sm_index = segment_manager_index (sm);
 686       fs_index = segment_manager_segment_index (sm, fs);
 687       (*tx_fifo)->segment_manager = sm_index;
 688       (*rx_fifo)->segment_manager = sm_index;
 689       (*tx_fifo)->segment_index = fs_index;
 690       (*rx_fifo)->segment_index = fs_index;
 691
 692       if (added_a_segment)
 693         {
 694           app_worker_t *app_wrk;
 695           fs_handle = segment_manager_segment_handle (sm, fs);
 696           app_wrk = app_worker_get (sm->app_wrk_index);
 697           rv = app_worker_add_segment_notify (app_wrk, fs_handle);
 698         }
 699       /* Drop the lock after app is notified */
 700       segment_manager_segment_reader_unlock (sm);
 701       return rv;
 702     }
 703
 704   /*
 705    * Allocation failed, see if we can add a new segment
 706    */
 707   if (props->add_segment)
 708     {
 709       if (added_a_segment)
 710         {
 711           clib_warning ("Added a segment, still can't allocate a fifo");
 712           segment_manager_segment_reader_unlock (sm);
 713           return SESSION_E_SEG_NO_SPACE2;
 714         }
 715       if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
 716         {
 717           clib_warning ("Failed to add new segment");
 718           return SESSION_E_SEG_CREATE;
 719         }
 720       fs = segment_manager_get_segment_w_lock (sm, new_fs_index);
 721       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 722                                                     props->rx_fifo_size,
 723                                                     props->tx_fifo_size,
 724                                                     rx_fifo, tx_fifo);
 725       added_a_segment = 1;
 726       goto alloc_check;
 727     }
 728   else
 729     {
 730       SESSION_DBG ("Can't add new seg and no space to allocate fifos!");
 731       return SESSION_E_SEG_NO_SPACE;
 732     }
 733 }
 734
 735 void
 736 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
 737 {
 738   segment_manager_t *sm;
 739   fifo_segment_t *fs;
 740   u32 segment_index;
 741
 742   if (!rx_fifo || !tx_fifo)
 743     return;
 744
 745   /* It's possible to have no segment manager if the session was removed
 746    * as result of a detach. */
 747   if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
 748     return;
 749
 750   segment_index = rx_fifo->segment_index;
 751   fs = segment_manager_get_segment_w_lock (sm, segment_index);
 752   fifo_segment_free_fifo (fs, rx_fifo);
 753   fifo_segment_free_fifo (fs, tx_fifo);
 754
 755   /*
 756    * Try to remove svm segment if it has no fifos. This can be done only if
 757    * the segment is not the first in the segment manager or if it is first
 758    * and it is not protected. Moreover, if the segment is first and the app
 759    * has detached from the segment manager, remove the segment manager.
 760    */
 761   if (!fifo_segment_has_fifos (fs))
 762     {
 763       segment_manager_segment_reader_unlock (sm);
 764
 765       /* Remove segment if it holds no fifos or first but not protected */
 766       if (segment_index != 0 || !sm->first_is_protected)
 767         segment_manager_lock_and_del_segment (sm, segment_index);
 768
 769       /* Remove segment manager if no sessions and detached from app */
 770       if (segment_manager_app_detached (sm)
 771           && !segment_manager_has_fifos (sm))
 772         {
 773           segment_manager_free (sm);
 774         }
 775     }
 776   else
 777     segment_manager_segment_reader_unlock (sm);
 778 }
 779
 780 void
 781 segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f)
 782 {
 783   fifo_segment_t *fs;
 784
 785   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 786   fifo_segment_detach_fifo (fs, f);
 787   segment_manager_segment_reader_unlock (sm);
 788 }
 789
 790 void
 791 segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
 792                              session_t * s)
 793 {
 794   fifo_segment_t *fs;
 795
 796   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 797   fifo_segment_attach_fifo (fs, f, s->thread_index);
 798   segment_manager_segment_reader_unlock (sm);
 799
 800   f->master_session_index = s->session_index;
 801   f->master_thread_index = s->thread_index;
 802 }
 803
 804 u32
 805 segment_manager_evt_q_expected_size (u32 q_len)
 806 {
 807   u32 fifo_evt_size, notif_q_size, q_hdrs;
 808   u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
 809
 810   fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
 811   notif_q_size = clib_max (16, q_len >> 4);
 812
 813   msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
 814   fifo_evt_ring_sz = q_len * fifo_evt_size;
 815   session_ntf_ring_sz = notif_q_size * 256;
 816   q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
 817
 818   return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
 819 }
 820
 821 /**
 822  * Allocates shm queue in the first segment
 823  *
 824  * Must be called with lock held
 825  */
 826 svm_msg_q_t *
 827 segment_manager_alloc_queue (fifo_segment_t * segment,
 828                              segment_manager_props_t * props)
 829 {
 830   u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
 831   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
 832   svm_msg_q_t *q;
 833   void *oldheap;
 834
 835   fifo_evt_size = sizeof (session_event_t);
 836   notif_q_size = clib_max (16, props->evt_q_size >> 4);
 837   /* *INDENT-OFF* */
 838   svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
 839     {props->evt_q_size, fifo_evt_size, 0},
 840     {notif_q_size, session_evt_size, 0}
 841   };
 842   /* *INDENT-ON* */
 843   cfg->consumer_pid = 0;
 844   cfg->n_rings = 2;
 845   cfg->q_nitems = props->evt_q_size;
 846   cfg->ring_cfgs = rc;
 847
 848   oldheap = ssvm_push_heap (segment->ssvm.sh);
 849   q = svm_msg_q_alloc (cfg);
 850   fifo_segment_update_free_bytes (segment);
 851   ssvm_pop_heap (oldheap);
 852
 853   if (props->use_mq_eventfd)
 854     {
 855       if (svm_msg_q_alloc_producer_eventfd (q))
 856         clib_warning ("failed to alloc eventfd");
 857     }
 858   return q;
 859 }
 860
 861 svm_msg_q_t *
 862 segment_manager_event_queue (segment_manager_t * sm)
 863 {
 864   return sm->event_queue;
 865 }
 866
 867 /**
 868  * Frees shm queue allocated in the first segment
 869  */
 870 void
 871 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
 872 {
 873   fifo_segment_t *segment;
 874   ssvm_shared_header_t *sh;
 875   void *oldheap;
 876
 877   ASSERT (!pool_is_free_index (sm->segments, 0));
 878
 879   segment = segment_manager_get_segment_w_lock (sm, 0);
 880   sh = segment->ssvm.sh;
 881
 882   oldheap = ssvm_push_heap (sh);
 883   svm_queue_free (q);
 884   ssvm_pop_heap (oldheap);
 885   segment_manager_segment_reader_unlock (sm);
 886 }
 887
 888 /*
 889  * Init segment vm address allocator
 890  */
 891 void
 892 segment_manager_main_init (segment_manager_main_init_args_t * a)
 893 {
 894   segment_manager_main_t *sm = &sm_main;
 895   clib_valloc_chunk_t _ip, *ip = &_ip;
 896
 897   ip->baseva = a->baseva;
 898   ip->size = a->size;
 899
 900   clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
 901
 902   sm->default_fifo_size = 1 << 12;
 903   sm->default_segment_size = 1 << 20;
 904   sm->default_app_mq_size = 128;
 905   sm->default_max_fifo_size = 4 << 20;
 906   sm->default_high_watermark = 80;
 907   sm->default_low_watermark = 50;
 908 }
 909
 910 static clib_error_t *
 911 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
 912                          vlib_cli_command_t * cmd)
 913 {
 914   segment_manager_main_t *smm = &sm_main;
 915   u8 show_segments = 0, verbose = 0;
 916   uword max_fifo_size;
 917   segment_manager_t *sm;
 918   fifo_segment_t *seg;
 919   app_worker_t *app_wrk;
 920   application_t *app;
 921   u8 custom_logic;
 922
 923   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 924     {
 925       if (unformat (input, "segments"))
 926         show_segments = 1;
 927       else if (unformat (input, "verbose"))
 928         verbose = 1;
 929       else
 930         return clib_error_return (0, "unknown input `%U'",
 931                                   format_unformat_error, input);
 932     }
 933   vlib_cli_output (vm, "%d segment managers allocated",
 934                    pool_elts (smm->segment_managers));
 935   if (verbose && pool_elts (smm->segment_managers))
 936     {
 937       vlib_cli_output (vm, "%-6s%=10s%=10s%=13s%=11s%=11s%=12s",
 938                        "Index", "AppIndex", "Segments", "MaxFifoSize",
 939                        "HighWater", "LowWater", "FifoTuning");
 940
 941       /* *INDENT-OFF* */
 942       pool_foreach (sm, smm->segment_managers, ({
 943         app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 944         app = app_wrk ? application_get (app_wrk->app_index) : 0;
 945         custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
 946         max_fifo_size = sm->max_fifo_size;
 947
 948         vlib_cli_output (vm, "%-6d%=10d%=10d%=13U%=11d%=11d%=12s",
 949                          segment_manager_index (sm),
 950                          sm->app_wrk_index, pool_elts (sm->segments),
 951                          format_memory_size, max_fifo_size,
 952                          sm->high_watermark, sm->low_watermark,
 953                          custom_logic ? "custom" : "none");
 954       }));
 955       /* *INDENT-ON* */
 956
 957       vlib_cli_output (vm, "\n");
 958     }
 959   if (show_segments)
 960     {
 961       vlib_cli_output (vm, "%U", format_fifo_segment, 0, verbose);
 962
 963       /* *INDENT-OFF* */
 964       pool_foreach (sm, smm->segment_managers, ({
 965           segment_manager_foreach_segment_w_lock (seg, sm, ({
 966             vlib_cli_output (vm, "%U", format_fifo_segment, seg, verbose);
 967           }));
 968       }));
 969       /* *INDENT-ON* */
 970
 971     }
 972   return 0;
 973 }
 974
 975 /* *INDENT-OFF* */
 976 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
 977 {
 978   .path = "show segment-manager",
 979   .short_help = "show segment-manager [segments][verbose]",
 980   .function = segment_manager_show_fn,
 981 };
 982 /* *INDENT-ON* */
 983
 984 void
 985 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
 986 {
 987   vlib_main_t *vm = vlib_get_main ();
 988   app_worker_t *app_wrk;
 989   fifo_segment_t *fs;
 990   const u8 *app_name;
 991   int slice_index;
 992   u8 *s = 0, *str;
 993   svm_fifo_t *f;
 994
 995   if (!sm)
 996     {
 997       if (verbose)
 998         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
 999                          "API Client", "SegManager");
1000       else
1001         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1002       return;
1003     }
1004
1005   app_wrk = app_worker_get (sm->app_wrk_index);
1006   app_name = application_name_from_index (app_wrk->app_index);
1007
1008   clib_rwlock_reader_lock (&sm->segments_rwlock);
1009
1010   /* *INDENT-OFF* */
1011   pool_foreach (fs, sm->segments, ({
1012     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1013       {
1014         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1015         while (f)
1016           {
1017             u32 session_index, thread_index;
1018             session_t *session;
1019
1020             session_index = f->master_session_index;
1021             thread_index = f->master_thread_index;
1022
1023             session = session_get (session_index, thread_index);
1024             str = format (0, "%U", format_session, session, verbose);
1025
1026             if (verbose)
1027               s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1028                           app_wrk->api_client_index, app_wrk->connects_seg_manager);
1029             else
1030               s = format (s, "%-40s%-20s", str, app_name);
1031
1032             vlib_cli_output (vm, "%v", s);
1033             vec_reset_length (s);
1034             vec_free (str);
1035
1036             f = f->next;
1037           }
1038         vec_free (s);
1039       }
1040   }));
1041   /* *INDENT-ON* */
1042
1043   clib_rwlock_reader_unlock (&sm->segments_rwlock);
1044 }
1045
1046 void
1047 segment_manager_set_watermarks (segment_manager_t * sm,
1048                                 u8 high_watermark, u8 low_watermark)
1049 {
1050   ASSERT (high_watermark <= 100 && low_watermark <= 100 &&
1051           low_watermark <= high_watermark);
1052
1053   sm->high_watermark = high_watermark;
1054   sm->low_watermark = low_watermark;
1055 }
1056
1057 /*
1058  * fd.io coding-style-patch-verification: ON
1059  *
1060  * Local Variables:
1061  * eval: (c-set-style "gnu")
1062  * End:
1063  */