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