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