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