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