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