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