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