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