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