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