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