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