src/vlibmemory/memory_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17 #include <signal.h>
  18
  19 #include <vlib/vlib.h>
  20 #include <vlibapi/api.h>
  21 #include <vlibmemory/api.h>
  22 #include <vlibmemory/memory_api.h>
  23
  24 #include <vlibmemory/vl_memory_msg_enum.h>      /* enumerate all vlib messages */
  25
  26 #define vl_typedefs             /* define message structures */
  27 #include <vlibmemory/vl_memory_api_h.h>
  28 #undef vl_typedefs
  29
  30 /* instantiate all the print functions we know about */
  31 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  32 #define vl_printfun
  33 #include <vlibmemory/vl_memory_api_h.h>
  34 #undef vl_printfun
  35
  36 /* instantiate all the endian swap functions we know about */
  37 #define vl_endianfun
  38 #include <vlibmemory/vl_memory_api_h.h>
  39 #undef vl_endianfun
  40
  41 static inline void *
  42 vl_api_memclnt_create_t_print (vl_api_memclnt_create_t * a, void *handle)
  43 {
  44   vl_print (handle, "vl_api_memclnt_create_t:\n");
  45   vl_print (handle, "name: %s\n", a->name);
  46   vl_print (handle, "input_queue: 0x%wx\n", a->input_queue);
  47   vl_print (handle, "context: %u\n", (unsigned) a->context);
  48   vl_print (handle, "ctx_quota: %ld\n", (long) a->ctx_quota);
  49   return handle;
  50 }
  51
  52 static inline void *
  53 vl_api_memclnt_delete_t_print (vl_api_memclnt_delete_t * a, void *handle)
  54 {
  55   vl_print (handle, "vl_api_memclnt_delete_t:\n");
  56   vl_print (handle, "index: %u\n", (unsigned) a->index);
  57   vl_print (handle, "handle: 0x%wx\n", a->handle);
  58   return handle;
  59 }
  60
  61 volatile int **vl_api_queue_cursizes;
  62
  63 static void
  64 memclnt_queue_callback (vlib_main_t * vm)
  65 {
  66   int i;
  67   api_main_t *am = &api_main;
  68
  69   if (PREDICT_FALSE (vec_len (vl_api_queue_cursizes) !=
  70                      1 + vec_len (am->vlib_private_rps)))
  71     {
  72       vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
  73       svm_queue_t *q;
  74
  75       if (shmem_hdr == 0)
  76         return;
  77
  78       q = shmem_hdr->vl_input_queue;
  79       if (q == 0)
  80         return;
  81
  82       vec_add1 (vl_api_queue_cursizes, &q->cursize);
  83
  84       for (i = 0; i < vec_len (am->vlib_private_rps); i++)
  85         {
  86           svm_region_t *vlib_rp = am->vlib_private_rps[i];
  87
  88           shmem_hdr = (void *) vlib_rp->user_ctx;
  89           q = shmem_hdr->vl_input_queue;
  90           vec_add1 (vl_api_queue_cursizes, &q->cursize);
  91         }
  92     }
  93
  94   for (i = 0; i < vec_len (vl_api_queue_cursizes); i++)
  95     {
  96       if (*vl_api_queue_cursizes[i])
  97         {
  98           vm->queue_signal_pending = 1;
  99           vm->api_queue_nonempty = 1;
 100           vlib_process_signal_event (vm, vl_api_clnt_node.index,
 101                                      /* event_type */ QUEUE_SIGNAL_EVENT,
 102                                      /* event_data */ 0);
 103           break;
 104         }
 105     }
 106   if (vec_len (vm->pending_rpc_requests))
 107     {
 108       vm->queue_signal_pending = 1;
 109       vm->api_queue_nonempty = 1;
 110       vlib_process_signal_event (vm, vl_api_clnt_node.index,
 111                                  /* event_type */ QUEUE_SIGNAL_EVENT,
 112                                  /* event_data */ 0);
 113     }
 114 }
 115
 116 /*
 117  * vl_api_memclnt_create_internal
 118  */
 119 u32
 120 vl_api_memclnt_create_internal (char *name, svm_queue_t * q)
 121 {
 122   vl_api_registration_t **regpp;
 123   vl_api_registration_t *regp;
 124   svm_region_t *svm;
 125   void *oldheap;
 126   api_main_t *am = &api_main;
 127
 128   ASSERT (vlib_get_thread_index () == 0);
 129   pool_get (am->vl_clients, regpp);
 130
 131   svm = am->vlib_rp;
 132
 133   pthread_mutex_lock (&svm->mutex);
 134   oldheap = svm_push_data_heap (svm);
 135   *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
 136
 137   regp = *regpp;
 138   clib_memset (regp, 0, sizeof (*regp));
 139   regp->registration_type = REGISTRATION_TYPE_SHMEM;
 140   regp->vl_api_registration_pool_index = regpp - am->vl_clients;
 141   regp->vlib_rp = svm;
 142   regp->shmem_hdr = am->shmem_hdr;
 143
 144   regp->vl_input_queue = q;
 145   regp->name = format (0, "%s%c", name, 0);
 146
 147   pthread_mutex_unlock (&svm->mutex);
 148   svm_pop_heap (oldheap);
 149   return vl_msg_api_handle_from_index_and_epoch
 150     (regp->vl_api_registration_pool_index,
 151      am->shmem_hdr->application_restarts);
 152 }
 153
 154 /*
 155  * vl_api_memclnt_create_t_handler
 156  */
 157 void
 158 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
 159 {
 160   vl_api_registration_t **regpp;
 161   vl_api_registration_t *regp;
 162   vl_api_memclnt_create_reply_t *rp;
 163   svm_region_t *svm;
 164   svm_queue_t *q;
 165   int rv = 0;
 166   void *oldheap;
 167   api_main_t *am = &api_main;
 168   u8 *msg_table;
 169
 170   /*
 171    * This is tortured. Maintain a vlib-address-space private
 172    * pool of client registrations. We use the shared-memory virtual
 173    * address of client structure as a handle, to allow direct
 174    * manipulation of context quota vbls from the client library.
 175    *
 176    * This scheme causes trouble w/ API message trace replay, since
 177    * some random VA from clib_mem_alloc() certainly won't
 178    * occur in the Linux sim. The (very) few places
 179    * that care need to use the pool index.
 180    *
 181    * Putting the registration object(s) into a pool in shared memory and
 182    * using the pool index as a handle seems like a great idea.
 183    * Unfortunately, each and every reference to that pool would need
 184    * to be protected by a mutex:
 185    *
 186    *     Client                      VLIB
 187    *     ------                      ----
 188    *     convert pool index to
 189    *     pointer.
 190    *     <deschedule>
 191    *                                 expand pool
 192    *                                 <deschedule>
 193    *     kaboom!
 194    */
 195
 196   pool_get (am->vl_clients, regpp);
 197
 198   svm = am->vlib_rp;
 199
 200   pthread_mutex_lock (&svm->mutex);
 201   oldheap = svm_push_data_heap (svm);
 202   *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
 203
 204   regp = *regpp;
 205   clib_memset (regp, 0, sizeof (*regp));
 206   regp->registration_type = REGISTRATION_TYPE_SHMEM;
 207   regp->vl_api_registration_pool_index = regpp - am->vl_clients;
 208   regp->vlib_rp = svm;
 209   regp->shmem_hdr = am->shmem_hdr;
 210   regp->clib_file_index = am->shmem_hdr->clib_file_index;
 211
 212   q = regp->vl_input_queue = (svm_queue_t *) (uword) mp->input_queue;
 213
 214   regp->name = format (0, "%s", mp->name);
 215   vec_add1 (regp->name, 0);
 216
 217   if (am->serialized_message_table_in_shmem == 0)
 218     am->serialized_message_table_in_shmem =
 219       vl_api_serialize_message_table (am, 0);
 220
 221   if (am->vlib_rp != am->vlib_primary_rp)
 222     msg_table = vl_api_serialize_message_table (am, 0);
 223   else
 224     msg_table = am->serialized_message_table_in_shmem;
 225
 226   pthread_mutex_unlock (&svm->mutex);
 227   svm_pop_heap (oldheap);
 228
 229   rp = vl_msg_api_alloc (sizeof (*rp));
 230   rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
 231   rp->handle = (uword) regp;
 232   rp->index = vl_msg_api_handle_from_index_and_epoch
 233     (regp->vl_api_registration_pool_index,
 234      am->shmem_hdr->application_restarts);
 235   rp->context = mp->context;
 236   rp->response = ntohl (rv);
 237   rp->message_table = pointer_to_uword (msg_table);
 238
 239   vl_msg_api_send_shmem (q, (u8 *) & rp);
 240 }
 241
 242 int
 243 vl_api_call_reaper_functions (u32 client_index)
 244 {
 245   clib_error_t *error = 0;
 246   _vl_msg_api_function_list_elt_t *i;
 247
 248   i = api_main.reaper_function_registrations;
 249   while (i)
 250     {
 251       error = i->f (client_index);
 252       if (error)
 253         clib_error_report (error);
 254       i = i->next_init_function;
 255     }
 256   return 0;
 257 }
 258
 259 /*
 260  * vl_api_memclnt_delete_t_handler
 261  */
 262 void
 263 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
 264 {
 265   vl_api_registration_t **regpp;
 266   vl_api_registration_t *regp;
 267   vl_api_memclnt_delete_reply_t *rp;
 268   svm_region_t *svm;
 269   void *oldheap;
 270   api_main_t *am = &api_main;
 271   u32 handle, client_index, epoch;
 272
 273   handle = mp->index;
 274
 275   if (vl_api_call_reaper_functions (handle))
 276     return;
 277
 278   epoch = vl_msg_api_handle_get_epoch (handle);
 279   client_index = vl_msg_api_handle_get_index (handle);
 280
 281   if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
 282     {
 283       clib_warning
 284         ("Stale clnt delete index %d old epoch %d cur epoch %d",
 285          client_index, epoch,
 286          (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
 287       return;
 288     }
 289
 290   regpp = pool_elt_at_index (am->vl_clients, client_index);
 291
 292   if (!pool_is_free (am->vl_clients, regpp))
 293     {
 294       int i;
 295       regp = *regpp;
 296       svm = am->vlib_rp;
 297       int private_registration = 0;
 298
 299       /* Send reply unless client asked us to do the cleanup */
 300       if (!mp->do_cleanup)
 301         {
 302           /*
 303            * Note: the API message handling path will set am->vlib_rp
 304            * as appropriate for pairwise / private memory segments
 305            */
 306           rp = vl_msg_api_alloc (sizeof (*rp));
 307           rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
 308           rp->handle = mp->handle;
 309           rp->response = 1;
 310
 311           vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
 312           if (client_index != regp->vl_api_registration_pool_index)
 313             {
 314               clib_warning ("mismatch client_index %d pool_index %d",
 315                             client_index,
 316                             regp->vl_api_registration_pool_index);
 317               vl_msg_api_free (rp);
 318               return;
 319             }
 320         }
 321
 322       /* No dangling references, please */
 323       *regpp = 0;
 324
 325       /* For horizontal scaling, add a hash table... */
 326       for (i = 0; i < vec_len (am->vlib_private_rps); i++)
 327         {
 328           /* Is this a pairwise / private API segment? */
 329           if (am->vlib_private_rps[i] == svm)
 330             {
 331               /* Note: account for the memfd header page */
 332               uword virtual_base = svm->virtual_base - MMAP_PAGESIZE;
 333               uword virtual_size = svm->virtual_size + MMAP_PAGESIZE;
 334
 335               /*
 336                * Kill the registration pool element before we make
 337                * the index vanish forever
 338                */
 339               pool_put_index (am->vl_clients,
 340                               regp->vl_api_registration_pool_index);
 341
 342               vec_delete (am->vlib_private_rps, 1, i);
 343               /* Kill it, accounting for the memfd header page */
 344               if (munmap ((void *) virtual_base, virtual_size) < 0)
 345                 clib_unix_warning ("munmap");
 346               /* Reset the queue-length-address cache */
 347               vec_reset_length (vl_api_queue_cursizes);
 348               private_registration = 1;
 349               break;
 350             }
 351         }
 352
 353       if (private_registration == 0)
 354         {
 355           pool_put_index (am->vl_clients,
 356                           regp->vl_api_registration_pool_index);
 357           pthread_mutex_lock (&svm->mutex);
 358           oldheap = svm_push_data_heap (svm);
 359           if (mp->do_cleanup)
 360             svm_queue_free (regp->vl_input_queue);
 361           vec_free (regp->name);
 362           /* Poison the old registration */
 363           clib_memset (regp, 0xF1, sizeof (*regp));
 364           clib_mem_free (regp);
 365           pthread_mutex_unlock (&svm->mutex);
 366           svm_pop_heap (oldheap);
 367           /*
 368            * These messages must be freed manually, since they're set up
 369            * as "bounce" messages. In the private_registration == 1 case,
 370            * we kill the shared-memory segment which contains the message
 371            * with munmap.
 372            */
 373           vl_msg_api_free (mp);
 374         }
 375     }
 376   else
 377     {
 378       clib_warning ("unknown client ID %d", mp->index);
 379     }
 380 }
 381
 382 /**
 383  * client answered a ping, stave off the grim reaper...
 384  */
 385 void
 386   vl_api_memclnt_keepalive_reply_t_handler
 387   (vl_api_memclnt_keepalive_reply_t * mp)
 388 {
 389   vl_api_registration_t *regp;
 390   vlib_main_t *vm = vlib_get_main ();
 391
 392   regp = vl_api_client_index_to_registration (mp->context);
 393   if (regp)
 394     {
 395       regp->last_heard = vlib_time_now (vm);
 396       regp->unanswered_pings = 0;
 397     }
 398   else
 399     clib_warning ("BUG: anonymous memclnt_keepalive_reply");
 400 }
 401
 402 /**
 403  * We can send ourselves these messages if someone uses the
 404  * builtin binary api test tool...
 405  */
 406 static void
 407 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
 408 {
 409   vl_api_memclnt_keepalive_reply_t *rmp;
 410   api_main_t *am;
 411   vl_shmem_hdr_t *shmem_hdr;
 412
 413   am = &api_main;
 414   shmem_hdr = am->shmem_hdr;
 415
 416   rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
 417   clib_memset (rmp, 0, sizeof (*rmp));
 418   rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
 419   rmp->context = mp->context;
 420   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
 421 }
 422
 423 /*
 424  * To avoid filling the API trace buffer with boring messages,
 425  * don't trace memclnt_keepalive[_reply] msgs
 426  */
 427
 428 #define foreach_vlib_api_msg                            \
 429 _(MEMCLNT_CREATE, memclnt_create, 1)                    \
 430 _(MEMCLNT_DELETE, memclnt_delete, 1)                    \
 431 _(MEMCLNT_KEEPALIVE, memclnt_keepalive, 0)              \
 432 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply, 0)
 433
 434 /*
 435  * memory_api_init
 436  */
 437 int
 438 vl_mem_api_init (const char *region_name)
 439 {
 440   int rv;
 441   api_main_t *am = &api_main;
 442   vl_msg_api_msg_config_t cfg;
 443   vl_msg_api_msg_config_t *c = &cfg;
 444   vl_shmem_hdr_t *shm;
 445   vlib_main_t *vm = vlib_get_main ();
 446
 447   clib_memset (c, 0, sizeof (*c));
 448
 449   if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
 450     return rv;
 451
 452 #define _(N,n,t) do {                                            \
 453     c->id = VL_API_##N;                                         \
 454     c->name = #n;                                               \
 455     c->handler = vl_api_##n##_t_handler;                        \
 456     c->cleanup = vl_noop_handler;                               \
 457     c->endian = vl_api_##n##_t_endian;                          \
 458     c->print = vl_api_##n##_t_print;                            \
 459     c->size = sizeof(vl_api_##n##_t);                           \
 460     c->traced = t; /* trace, so these msgs print */             \
 461     c->replay = 0; /* don't replay client create/delete msgs */ \
 462     c->message_bounce = 0; /* don't bounce this message */      \
 463     vl_msg_api_config(c);} while (0);
 464
 465   foreach_vlib_api_msg;
 466 #undef _
 467
 468   /*
 469    * special-case freeing of memclnt_delete messages, so we can
 470    * simply munmap pairwise / private API segments...
 471    */
 472   am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
 473   am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
 474   am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE] = 1;
 475
 476   vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
 477
 478   shm = am->shmem_hdr;
 479   ASSERT (shm && shm->vl_input_queue);
 480
 481   /* Make a note so we can always find the primary region easily */
 482   am->vlib_primary_rp = am->vlib_rp;
 483
 484   return 0;
 485 }
 486
 487 clib_error_t *
 488 map_api_segment_init (vlib_main_t * vm)
 489 {
 490   api_main_t *am = &api_main;
 491   int rv;
 492
 493   if ((rv = vl_mem_api_init (am->region_name)) < 0)
 494     {
 495       return clib_error_return (0, "vl_mem_api_init (%s) failed",
 496                                 am->region_name);
 497     }
 498   return 0;
 499 }
 500
 501 static void
 502 send_memclnt_keepalive (vl_api_registration_t * regp, f64 now)
 503 {
 504   vl_api_memclnt_keepalive_t *mp;
 505   svm_queue_t *q;
 506   api_main_t *am = &api_main;
 507   svm_region_t *save_vlib_rp = am->vlib_rp;
 508   vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
 509
 510   q = regp->vl_input_queue;
 511
 512   /*
 513    * If the queue head is moving, assume that the client is processing
 514    * messages and skip the ping. This heuristic may fail if the queue
 515    * is in the same position as last time, net of wrapping; in which
 516    * case, the client will receive a keepalive.
 517    */
 518   if (regp->last_queue_head != q->head)
 519     {
 520       regp->last_heard = now;
 521       regp->unanswered_pings = 0;
 522       regp->last_queue_head = q->head;
 523       return;
 524     }
 525
 526   /*
 527    * push/pop shared memory segment, so this routine
 528    * will work with "normal" as well as "private segment"
 529    * memory clients..
 530    */
 531
 532   am->vlib_rp = regp->vlib_rp;
 533   am->shmem_hdr = regp->shmem_hdr;
 534
 535   mp = vl_msg_api_alloc (sizeof (*mp));
 536   clib_memset (mp, 0, sizeof (*mp));
 537   mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
 538   mp->context = mp->client_index =
 539     vl_msg_api_handle_from_index_and_epoch
 540     (regp->vl_api_registration_pool_index,
 541      am->shmem_hdr->application_restarts);
 542
 543   regp->unanswered_pings++;
 544
 545   /* Failure-to-send due to a stuffed queue is absolutely expected */
 546   if (svm_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
 547     vl_msg_api_free (mp);
 548
 549   am->vlib_rp = save_vlib_rp;
 550   am->shmem_hdr = save_shmem_hdr;
 551 }
 552
 553 static void
 554 vl_mem_send_client_keepalive_w_reg (api_main_t * am, f64 now,
 555                                     vl_api_registration_t ** regpp,
 556                                     u32 ** dead_indices,
 557                                     u32 ** confused_indices)
 558 {
 559   vl_api_registration_t *regp = *regpp;
 560   if (regp)
 561     {
 562       /* If we haven't heard from this client recently... */
 563       if (regp->last_heard < (now - 10.0))
 564         {
 565           if (regp->unanswered_pings == 2)
 566             {
 567               svm_queue_t *q;
 568               q = regp->vl_input_queue;
 569               if (kill (q->consumer_pid, 0) >= 0)
 570                 {
 571                   clib_warning ("REAPER: lazy binary API client '%s'",
 572                                 regp->name);
 573                   regp->unanswered_pings = 0;
 574                   regp->last_heard = now;
 575                 }
 576               else
 577                 {
 578                   clib_warning ("REAPER: binary API client '%s' died",
 579                                 regp->name);
 580                   vec_add1 (*dead_indices, regpp - am->vl_clients);
 581                 }
 582             }
 583           else
 584             send_memclnt_keepalive (regp, now);
 585         }
 586       else
 587         regp->unanswered_pings = 0;
 588     }
 589   else
 590     {
 591       clib_warning ("NULL client registration index %d",
 592                     regpp - am->vl_clients);
 593       vec_add1 (*confused_indices, regpp - am->vl_clients);
 594     }
 595 }
 596
 597 void
 598 vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
 599 {
 600   vl_api_registration_t **regpp;
 601   static u32 *dead_indices;
 602   static u32 *confused_indices;
 603
 604   vec_reset_length (dead_indices);
 605   vec_reset_length (confused_indices);
 606
 607   /* *INDENT-OFF* */
 608   pool_foreach (regpp, am->vl_clients, ({
 609       vl_mem_send_client_keepalive_w_reg (am, now, regpp, &dead_indices,
 610                                           &confused_indices);
 611   }));
 612   /* *INDENT-ON* */
 613
 614   /* This should "never happen," but if it does, fix it... */
 615   if (PREDICT_FALSE (vec_len (confused_indices) > 0))
 616     {
 617       int i;
 618       for (i = 0; i < vec_len (confused_indices); i++)
 619         {
 620           pool_put_index (am->vl_clients, confused_indices[i]);
 621         }
 622     }
 623
 624   if (PREDICT_FALSE (vec_len (dead_indices) > 0))
 625     {
 626       int i;
 627       svm_region_t *svm;
 628       void *oldheap;
 629
 630       /* Allow the application to clean up its registrations */
 631       for (i = 0; i < vec_len (dead_indices); i++)
 632         {
 633           regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
 634           if (regpp)
 635             {
 636               u32 handle;
 637
 638               handle = vl_msg_api_handle_from_index_and_epoch
 639                 (dead_indices[i], shm->application_restarts);
 640               (void) vl_api_call_reaper_functions (handle);
 641             }
 642         }
 643
 644       svm = am->vlib_rp;
 645       pthread_mutex_lock (&svm->mutex);
 646       oldheap = svm_push_data_heap (svm);
 647
 648       for (i = 0; i < vec_len (dead_indices); i++)
 649         {
 650           regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
 651           if (regpp)
 652             {
 653               /* Is this a pairwise SVM segment? */
 654               if ((*regpp)->vlib_rp != svm)
 655                 {
 656                   int i;
 657                   svm_region_t *dead_rp = (*regpp)->vlib_rp;
 658                   /* Note: account for the memfd header page */
 659                   uword virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
 660                   uword virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
 661
 662                   /* For horizontal scaling, add a hash table... */
 663                   for (i = 0; i < vec_len (am->vlib_private_rps); i++)
 664                     if (am->vlib_private_rps[i] == dead_rp)
 665                       {
 666                         vec_delete (am->vlib_private_rps, 1, i);
 667                         goto found;
 668                       }
 669                   svm_pop_heap (oldheap);
 670                   clib_warning ("private rp %llx AWOL", dead_rp);
 671                   oldheap = svm_push_data_heap (svm);
 672
 673                 found:
 674                   /* Kill it, accounting for the memfd header page */
 675                   svm_pop_heap (oldheap);
 676                   if (munmap ((void *) virtual_base, virtual_size) < 0)
 677                     clib_unix_warning ("munmap");
 678                   /* Reset the queue-length-address cache */
 679                   vec_reset_length (vl_api_queue_cursizes);
 680                   oldheap = svm_push_data_heap (svm);
 681                 }
 682               else
 683                 {
 684                   /* Poison the old registration */
 685                   clib_memset (*regpp, 0xF3, sizeof (**regpp));
 686                   clib_mem_free (*regpp);
 687                 }
 688               /* no dangling references, please */
 689               *regpp = 0;
 690             }
 691           else
 692             {
 693               svm_pop_heap (oldheap);
 694               clib_warning ("Duplicate free, client index %d",
 695                             regpp - am->vl_clients);
 696               oldheap = svm_push_data_heap (svm);
 697             }
 698         }
 699
 700       svm_client_scan_this_region_nolock (am->vlib_rp);
 701
 702       pthread_mutex_unlock (&svm->mutex);
 703       svm_pop_heap (oldheap);
 704       for (i = 0; i < vec_len (dead_indices); i++)
 705         pool_put_index (am->vl_clients, dead_indices[i]);
 706     }
 707 }
 708
 709 static inline int
 710 void_mem_api_handle_msg_i (api_main_t * am, vlib_main_t * vm,
 711                            vlib_node_runtime_t * node, svm_queue_t * q)
 712 {
 713   uword mp;
 714   if (!svm_queue_sub2 (q, (u8 *) & mp))
 715     {
 716       vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
 717       return 0;
 718     }
 719   return -1;
 720 }
 721
 722 int
 723 vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node)
 724 {
 725   api_main_t *am = &api_main;
 726   return void_mem_api_handle_msg_i (am, vm, node,
 727                                     am->shmem_hdr->vl_input_queue);
 728 }
 729
 730 int
 731 vl_mem_api_handle_rpc (vlib_main_t * vm, vlib_node_runtime_t * node)
 732 {
 733   api_main_t *am = &api_main;
 734   int i;
 735   uword *tmp, mp;
 736
 737   /*
 738    * Swap pending and processing vectors, then process the RPCs
 739    * Avoid deadlock conditions by construction.
 740    */
 741   clib_spinlock_lock_if_init (&vm->pending_rpc_lock);
 742   tmp = vm->processing_rpc_requests;
 743   vec_reset_length (tmp);
 744   vm->processing_rpc_requests = vm->pending_rpc_requests;
 745   vm->pending_rpc_requests = tmp;
 746   clib_spinlock_unlock_if_init (&vm->pending_rpc_lock);
 747
 748   /*
 749    * RPCs are used to reflect function calls to thread 0
 750    * when the underlying code is not thread-safe.
 751    *
 752    * Grabbing the thread barrier across a set of RPCs
 753    * greatly increases efficiency, and avoids
 754    * running afoul of the barrier sync holddown timer.
 755    * The barrier sync code supports recursive locking.
 756    *
 757    * We really need to rewrite RPC-based code...
 758    */
 759   if (PREDICT_TRUE (vec_len (vm->processing_rpc_requests)))
 760     {
 761       vl_msg_api_barrier_sync ();
 762       for (i = 0; i < vec_len (vm->processing_rpc_requests); i++)
 763         {
 764           mp = vm->processing_rpc_requests[i];
 765           vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
 766         }
 767       vl_msg_api_barrier_release ();
 768     }
 769
 770   return 0;
 771 }
 772
 773 int
 774 vl_mem_api_handle_msg_private (vlib_main_t * vm, vlib_node_runtime_t * node,
 775                                u32 reg_index)
 776 {
 777   api_main_t *am = &api_main;
 778   vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
 779   svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
 780   svm_queue_t *q;
 781   int rv;
 782
 783   vlib_rp = am->vlib_rp = am->vlib_private_rps[reg_index];
 784
 785   am->shmem_hdr = (void *) vlib_rp->user_ctx;
 786   q = am->shmem_hdr->vl_input_queue;
 787
 788   rv = void_mem_api_handle_msg_i (am, vm, node, q);
 789
 790   am->shmem_hdr = save_shmem_hdr;
 791   am->vlib_rp = save_vlib_rp;
 792
 793   return rv;
 794 }
 795
 796 vl_api_registration_t *
 797 vl_mem_api_client_index_to_registration (u32 handle)
 798 {
 799   vl_api_registration_t **regpp;
 800   vl_api_registration_t *regp;
 801   api_main_t *am = &api_main;
 802   vl_shmem_hdr_t *shmem_hdr;
 803   u32 index;
 804
 805   index = vl_msg_api_handle_get_index (handle);
 806   regpp = am->vl_clients + index;
 807
 808   if (pool_is_free (am->vl_clients, regpp))
 809     {
 810       vl_msg_api_increment_missing_client_counter ();
 811       return 0;
 812     }
 813   regp = *regpp;
 814
 815   shmem_hdr = (vl_shmem_hdr_t *) regp->shmem_hdr;
 816   if (!vl_msg_api_handle_is_valid (handle, shmem_hdr->application_restarts))
 817     {
 818       vl_msg_api_increment_missing_client_counter ();
 819       return 0;
 820     }
 821
 822   return (regp);
 823 }
 824
 825 svm_queue_t *
 826 vl_api_client_index_to_input_queue (u32 index)
 827 {
 828   vl_api_registration_t *regp;
 829   api_main_t *am = &api_main;
 830
 831   /* Special case: vlib trying to send itself a message */
 832   if (index == (u32) ~ 0)
 833     return (am->shmem_hdr->vl_input_queue);
 834
 835   regp = vl_mem_api_client_index_to_registration (index);
 836   if (!regp)
 837     return 0;
 838   return (regp->vl_input_queue);
 839 }
 840
 841 static clib_error_t *
 842 setup_memclnt_exit (vlib_main_t * vm)
 843 {
 844   atexit (vl_unmap_shmem);
 845   return 0;
 846 }
 847
 848 VLIB_INIT_FUNCTION (setup_memclnt_exit);
 849
 850 u8 *
 851 format_api_message_rings (u8 * s, va_list * args)
 852 {
 853   api_main_t *am = va_arg (*args, api_main_t *);
 854   vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
 855   int main_segment = va_arg (*args, int);
 856   ring_alloc_t *ap;
 857   int i;
 858
 859   if (shmem_hdr == 0)
 860     return format (s, "%8s %8s %8s %8s %8s\n",
 861                    "Owner", "Size", "Nitems", "Hits", "Misses");
 862
 863   ap = shmem_hdr->vl_rings;
 864
 865   for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
 866     {
 867       s = format (s, "%8s %8d %8d %8d %8d\n",
 868                   "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
 869       ap++;
 870     }
 871
 872   ap = shmem_hdr->client_rings;
 873
 874   for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
 875     {
 876       s = format (s, "%8s %8d %8d %8d %8d\n",
 877                   "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
 878       ap++;
 879     }
 880
 881   if (main_segment)
 882     {
 883       s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
 884       s = format
 885         (s,
 886          "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
 887          shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
 888          shmem_hdr->garbage_collects);
 889     }
 890   return s;
 891 }
 892
 893 static clib_error_t *
 894 vl_api_ring_command (vlib_main_t * vm,
 895                      unformat_input_t * input, vlib_cli_command_t * cli_cmd)
 896 {
 897   int i;
 898   vl_shmem_hdr_t *shmem_hdr;
 899   api_main_t *am = &api_main;
 900
 901   /* First, dump the primary region rings.. */
 902
 903   if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
 904     {
 905       vlib_cli_output (vm, "Shared memory segment not initialized...\n");
 906       return 0;
 907     }
 908
 909   shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
 910
 911   vlib_cli_output (vm, "Main API segment rings:");
 912
 913   vlib_cli_output (vm, "%U", format_api_message_rings, am,
 914                    0 /* print header */ , 0 /* notused */ );
 915
 916   vlib_cli_output (vm, "%U", format_api_message_rings, am,
 917                    shmem_hdr, 1 /* main segment */ );
 918
 919   for (i = 0; i < vec_len (am->vlib_private_rps); i++)
 920     {
 921       svm_region_t *vlib_rp = am->vlib_private_rps[i];
 922       shmem_hdr = (void *) vlib_rp->user_ctx;
 923       vl_api_registration_t **regpp;
 924       vl_api_registration_t *regp = 0;
 925
 926       /* For horizontal scaling, add a hash table... */
 927       /* *INDENT-OFF* */
 928       pool_foreach (regpp, am->vl_clients,
 929       ({
 930         regp = *regpp;
 931         if (regp && regp->vlib_rp == vlib_rp)
 932           {
 933             vlib_cli_output (vm, "%s segment rings:", regp->name);
 934             goto found;
 935           }
 936       }));
 937       vlib_cli_output (vm, "regp %llx not found?", regp);
 938       continue;
 939       /* *INDENT-ON* */
 940     found:
 941       vlib_cli_output (vm, "%U", format_api_message_rings, am,
 942                        0 /* print header */ , 0 /* notused */ );
 943       vlib_cli_output (vm, "%U", format_api_message_rings, am,
 944                        shmem_hdr, 0 /* main segment */ );
 945     }
 946
 947   return 0;
 948 }
 949
 950 /*?
 951  * Display binary api message allocation ring statistics
 952 ?*/
 953 /* *INDENT-OFF* */
 954 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
 955 {
 956   .path = "show api ring-stats",
 957   .short_help = "Message ring statistics",
 958   .function = vl_api_ring_command,
 959 };
 960 /* *INDENT-ON* */
 961
 962 clib_error_t *
 963 vlibmemory_init (vlib_main_t * vm)
 964 {
 965   api_main_t *am = &api_main;
 966   svm_map_region_args_t _a, *a = &_a;
 967   u8 *remove_path1, *remove_path2;
 968   void vlibsocket_reference (void);
 969
 970   vlibsocket_reference ();
 971
 972   /*
 973    * By popular request / to avoid support fires, remove any old api segment
 974    * files Right Here.
 975    */
 976   if (am->root_path == 0)
 977     {
 978       remove_path1 = format (0, "/dev/shm/global_vm%c", 0);
 979       remove_path2 = format (0, "/dev/shm/vpe-api%c", 0);
 980     }
 981   else
 982     {
 983       remove_path1 = format (0, "/dev/shm/%s-global_vm%c", am->root_path, 0);
 984       remove_path2 = format (0, "/dev/shm/%s-vpe-api%c", am->root_path, 0);
 985     }
 986
 987   (void) unlink ((char *) remove_path1);
 988   (void) unlink ((char *) remove_path2);
 989
 990   vec_free (remove_path1);
 991   vec_free (remove_path2);
 992
 993   clib_memset (a, 0, sizeof (*a));
 994   a->root_path = am->root_path;
 995   a->name = SVM_GLOBAL_REGION_NAME;
 996   a->baseva = (am->global_baseva != 0) ?
 997     am->global_baseva : +svm_get_global_region_base_va ();
 998   a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
 999   a->flags = SVM_FLAGS_NODATA;
1000   a->uid = am->api_uid;
1001   a->gid = am->api_gid;
1002   a->pvt_heap_size =
1003     (am->global_pvt_heap_size !=
1004      0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
1005
1006   svm_region_init_args (a);
1007
1008   return 0;
1009 }
1010
1011 void
1012 vl_set_memory_region_name (const char *name)
1013 {
1014   api_main_t *am = &api_main;
1015   am->region_name = name;
1016 }
1017
1018 /*
1019  * fd.io coding-style-patch-verification: ON
1020  *
1021  * Local Variables:
1022  * eval: (c-set-style "gnu")
1023  * End:
1024  */