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