src/vlibmemory/memory_shared.c

   1 /*
   2  *------------------------------------------------------------------
   3  * memclnt_shared.c - API message handling, common code for both clients
   4  * and the vlib process itself.
   5  *
   6  *
   7  * Copyright (c) 2009 Cisco and/or its affiliates.
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at:
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *------------------------------------------------------------------
  20  */
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <stddef.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include <signal.h>
  28 #include <vppinfra/format.h>
  29 #include <vppinfra/byte_order.h>
  30 #include <vppinfra/error.h>
  31 #include <vlib/vlib.h>
  32 #include <vlib/unix/unix.h>
  33 #include <vlibmemory/api.h>
  34 #include <vlibmemory/unix_shared_memory_queue.h>
  35
  36 #include <vlibmemory/vl_memory_msg_enum.h>
  37
  38 #define vl_typedefs
  39 #include <vlibmemory/vl_memory_api_h.h>
  40 #undef vl_typedefs
  41
  42 static inline void *
  43 vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
  44 {
  45   int i;
  46   msgbuf_t *rv;
  47   ring_alloc_t *ap;
  48   unix_shared_memory_queue_t *q;
  49   void *oldheap;
  50   vl_shmem_hdr_t *shmem_hdr;
  51   api_main_t *am = &api_main;
  52
  53   shmem_hdr = am->shmem_hdr;
  54
  55   if (shmem_hdr == 0)
  56     {
  57       clib_warning ("shared memory header NULL");
  58       return 0;
  59     }
  60
  61   /* account for the msgbuf_t header */
  62   nbytes += sizeof (msgbuf_t);
  63
  64   if (shmem_hdr->vl_rings == 0)
  65     {
  66       clib_warning ("vl_rings NULL");
  67       ASSERT (0);
  68       abort ();
  69     }
  70
  71   if (shmem_hdr->client_rings == 0)
  72     {
  73       clib_warning ("client_rings NULL");
  74       ASSERT (0);
  75       abort ();
  76     }
  77
  78   ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
  79   for (i = 0; i < vec_len (ap); i++)
  80     {
  81       /* Too big? */
  82       if (nbytes > ap[i].size)
  83         {
  84           continue;
  85         }
  86
  87       q = ap[i].rp;
  88       if (pool == 0)
  89         {
  90           pthread_mutex_lock (&q->mutex);
  91         }
  92       rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
  93       /*
  94        * Is this item still in use?
  95        */
  96       if (rv->q)
  97         {
  98           u32 now = (u32) time (0);
  99
 100           if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
 101             rv->gc_mark_timestamp = now;
 102           else
 103             {
 104               if (now - rv->gc_mark_timestamp > 10)
 105                 {
 106                   if (CLIB_DEBUG > 0)
 107                     clib_warning ("garbage collect pool %d ring %d index %d",
 108                                   pool, i, q->head);
 109                   shmem_hdr->garbage_collects++;
 110                   goto collected;
 111                 }
 112             }
 113
 114
 115           /* yes, loser; try next larger pool */
 116           ap[i].misses++;
 117           if (pool == 0)
 118             pthread_mutex_unlock (&q->mutex);
 119           continue;
 120         }
 121     collected:
 122
 123       /* OK, we have a winner */
 124       ap[i].hits++;
 125       /*
 126        * Remember the source queue, although we
 127        * don't need to know the queue to free the item.
 128        */
 129       rv->q = q;
 130       rv->gc_mark_timestamp = 0;
 131       q->head++;
 132       if (q->head == q->maxsize)
 133         q->head = 0;
 134
 135       if (pool == 0)
 136         pthread_mutex_unlock (&q->mutex);
 137       goto out;
 138     }
 139
 140   /*
 141    * Request too big, or head element of all size-compatible rings
 142    * still in use. Fall back to shared-memory malloc.
 143    */
 144   am->ring_misses++;
 145
 146   pthread_mutex_lock (&am->vlib_rp->mutex);
 147   oldheap = svm_push_data_heap (am->vlib_rp);
 148   if (may_return_null)
 149     {
 150       rv = clib_mem_alloc_or_null (nbytes);
 151       if (PREDICT_FALSE (rv == 0))
 152         {
 153           svm_pop_heap (oldheap);
 154           pthread_mutex_unlock (&am->vlib_rp->mutex);
 155           return 0;
 156         }
 157     }
 158   else
 159     rv = clib_mem_alloc (nbytes);
 160
 161   rv->q = 0;
 162   svm_pop_heap (oldheap);
 163   pthread_mutex_unlock (&am->vlib_rp->mutex);
 164
 165 out:
 166   rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
 167   return (rv->data);
 168 }
 169
 170 void *
 171 vl_msg_api_alloc (int nbytes)
 172 {
 173   int pool;
 174   api_main_t *am = &api_main;
 175   vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
 176
 177   /*
 178    * Clients use pool-0, vlib proc uses pool 1
 179    */
 180   pool = (am->our_pid == shmem_hdr->vl_pid);
 181   return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
 182 }
 183
 184 void *
 185 vl_msg_api_alloc_or_null (int nbytes)
 186 {
 187   int pool;
 188   api_main_t *am = &api_main;
 189   vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
 190
 191   pool = (am->our_pid == shmem_hdr->vl_pid);
 192   return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
 193 }
 194
 195 void *
 196 vl_msg_api_alloc_as_if_client (int nbytes)
 197 {
 198   return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
 199 }
 200
 201 void *
 202 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
 203 {
 204   return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
 205 }
 206
 207 void
 208 vl_msg_api_free (void *a)
 209 {
 210   msgbuf_t *rv;
 211   void *oldheap;
 212   api_main_t *am = &api_main;
 213
 214   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
 215
 216   /*
 217    * Here's the beauty of the scheme.  Only one proc/thread has
 218    * control of a given message buffer. To free a buffer, we just clear the
 219    * queue field, and leave. No locks, no hits, no errors...
 220    */
 221   if (rv->q)
 222     {
 223       rv->q = 0;
 224       rv->gc_mark_timestamp = 0;
 225       return;
 226     }
 227
 228   pthread_mutex_lock (&am->vlib_rp->mutex);
 229   oldheap = svm_push_data_heap (am->vlib_rp);
 230   clib_mem_free (rv);
 231   svm_pop_heap (oldheap);
 232   pthread_mutex_unlock (&am->vlib_rp->mutex);
 233 }
 234
 235 static void
 236 vl_msg_api_free_nolock (void *a)
 237 {
 238   msgbuf_t *rv;
 239   void *oldheap;
 240   api_main_t *am = &api_main;
 241
 242   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
 243   /*
 244    * Here's the beauty of the scheme.  Only one proc/thread has
 245    * control of a given message buffer. To free a buffer, we just clear the
 246    * queue field, and leave. No locks, no hits, no errors...
 247    */
 248   if (rv->q)
 249     {
 250       rv->q = 0;
 251       return;
 252     }
 253
 254   oldheap = svm_push_data_heap (am->vlib_rp);
 255   clib_mem_free (rv);
 256   svm_pop_heap (oldheap);
 257 }
 258
 259 void
 260 vl_set_memory_root_path (const char *name)
 261 {
 262   api_main_t *am = &api_main;
 263
 264   am->root_path = name;
 265 }
 266
 267 void
 268 vl_set_memory_uid (int uid)
 269 {
 270   api_main_t *am = &api_main;
 271
 272   am->api_uid = uid;
 273 }
 274
 275 void
 276 vl_set_memory_gid (int gid)
 277 {
 278   api_main_t *am = &api_main;
 279
 280   am->api_gid = gid;
 281 }
 282
 283 void
 284 vl_set_global_memory_baseva (u64 baseva)
 285 {
 286   api_main_t *am = &api_main;
 287
 288   am->global_baseva = baseva;
 289 }
 290
 291 void
 292 vl_set_global_memory_size (u64 size)
 293 {
 294   api_main_t *am = &api_main;
 295
 296   am->global_size = size;
 297 }
 298
 299 void
 300 vl_set_api_memory_size (u64 size)
 301 {
 302   api_main_t *am = &api_main;
 303
 304   am->api_size = size;
 305 }
 306
 307 void
 308 vl_set_global_pvt_heap_size (u64 size)
 309 {
 310   api_main_t *am = &api_main;
 311
 312   am->global_pvt_heap_size = size;
 313 }
 314
 315 void
 316 vl_set_api_pvt_heap_size (u64 size)
 317 {
 318   api_main_t *am = &api_main;
 319
 320   am->api_pvt_heap_size = size;
 321 }
 322
 323 int
 324 vl_map_shmem (const char *region_name, int is_vlib)
 325 {
 326   svm_map_region_args_t _a, *a = &_a;
 327   svm_region_t *vlib_rp, *root_rp;
 328   void *oldheap;
 329   vl_shmem_hdr_t *shmem_hdr = 0;
 330   api_main_t *am = &api_main;
 331   int i;
 332   struct timespec ts, tsrem;
 333
 334   if (is_vlib == 0)
 335     svm_region_init_chroot (am->root_path);
 336
 337   memset (a, 0, sizeof (*a));
 338
 339   a->name = region_name;
 340   a->size = am->api_size ? am->api_size : (16 << 20);
 341   a->flags = SVM_FLAGS_MHEAP;
 342   a->uid = am->api_uid;
 343   a->gid = am->api_gid;
 344   a->pvt_heap_size = am->api_pvt_heap_size;
 345
 346   vlib_rp = svm_region_find_or_create (a);
 347
 348   if (vlib_rp == 0)
 349     return (-2);
 350
 351   pthread_mutex_lock (&vlib_rp->mutex);
 352   /* Has someone else set up the shared-memory variable table? */
 353   if (vlib_rp->user_ctx)
 354     {
 355       am->shmem_hdr = (void *) vlib_rp->user_ctx;
 356       am->our_pid = getpid ();
 357       if (is_vlib)
 358         {
 359           unix_shared_memory_queue_t *q;
 360           uword old_msg;
 361           /*
 362            * application restart. Reset cached pids, API message
 363            * rings, list of clients; otherwise, various things
 364            * fail. (e.g. queue non-empty notification)
 365            */
 366
 367           /* ghosts keep the region from disappearing properly */
 368           svm_client_scan_this_region_nolock (vlib_rp);
 369           am->shmem_hdr->application_restarts++;
 370           q = am->shmem_hdr->vl_input_queue;
 371           am->shmem_hdr->vl_pid = getpid ();
 372           q->consumer_pid = am->shmem_hdr->vl_pid;
 373           /* Drain the input queue, freeing msgs */
 374           for (i = 0; i < 10; i++)
 375             {
 376               if (pthread_mutex_trylock (&q->mutex) == 0)
 377                 {
 378                   pthread_mutex_unlock (&q->mutex);
 379                   goto mutex_ok;
 380                 }
 381               ts.tv_sec = 0;
 382               ts.tv_nsec = 10000 * 1000;        /* 10 ms */
 383               while (nanosleep (&ts, &tsrem) < 0)
 384                 ts = tsrem;
 385             }
 386           /* Mutex buggered, "fix" it */
 387           memset (&q->mutex, 0, sizeof (q->mutex));
 388           clib_warning ("forcibly release main input queue mutex");
 389
 390         mutex_ok:
 391           am->vlib_rp = vlib_rp;
 392           while (unix_shared_memory_queue_sub (q,
 393                                                (u8 *) & old_msg,
 394                                                1 /* nowait */ )
 395                  != -2 /* queue underflow */ )
 396             {
 397               vl_msg_api_free_nolock ((void *) old_msg);
 398               am->shmem_hdr->restart_reclaims++;
 399             }
 400           pthread_mutex_unlock (&vlib_rp->mutex);
 401           root_rp = svm_get_root_rp ();
 402           ASSERT (root_rp);
 403           /* Clean up the root region client list */
 404           pthread_mutex_lock (&root_rp->mutex);
 405           svm_client_scan_this_region_nolock (root_rp);
 406           pthread_mutex_unlock (&root_rp->mutex);
 407         }
 408       else
 409         {
 410           pthread_mutex_unlock (&vlib_rp->mutex);
 411         }
 412       am->vlib_rp = vlib_rp;
 413       vec_add1 (am->mapped_shmem_regions, vlib_rp);
 414       return 0;
 415     }
 416   /* Clients simply have to wait... */
 417   if (!is_vlib)
 418     {
 419       pthread_mutex_unlock (&vlib_rp->mutex);
 420
 421       /* Wait up to 100 seconds... */
 422       for (i = 0; i < 10000; i++)
 423         {
 424           ts.tv_sec = 0;
 425           ts.tv_nsec = 10000 * 1000;    /* 10 ms */
 426           while (nanosleep (&ts, &tsrem) < 0)
 427             ts = tsrem;
 428           if (vlib_rp->user_ctx)
 429             goto ready;
 430         }
 431       /* Clean up and leave... */
 432       svm_region_unmap (vlib_rp);
 433       clib_warning ("region init fail");
 434       return (-2);
 435
 436     ready:
 437       am->shmem_hdr = (void *) vlib_rp->user_ctx;
 438       am->our_pid = getpid ();
 439       am->vlib_rp = vlib_rp;
 440       vec_add1 (am->mapped_shmem_regions, vlib_rp);
 441       return 0;
 442     }
 443
 444   /* Nope, it's our problem... */
 445
 446   oldheap = svm_push_data_heap (vlib_rp);
 447
 448   vec_validate (shmem_hdr, 0);
 449   shmem_hdr->version = VL_SHM_VERSION;
 450
 451   /* vlib main input queue */
 452   shmem_hdr->vl_input_queue =
 453     unix_shared_memory_queue_init (1024, sizeof (uword), getpid (),
 454                                    am->vlib_signal);
 455
 456   /* Set up the msg ring allocator */
 457 #define _(sz,n)                                                 \
 458     do {                                                        \
 459         ring_alloc_t _rp;                                       \
 460         _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
 461         _rp.size = (sz);                                        \
 462         _rp.nitems = n;                                         \
 463         _rp.hits = 0;                                           \
 464         _rp.misses = 0;                                         \
 465         vec_add1(shmem_hdr->vl_rings, _rp);                     \
 466     } while (0);
 467
 468   foreach_vl_aring_size;
 469 #undef _
 470
 471 #define _(sz,n)                                                 \
 472     do {                                                        \
 473         ring_alloc_t _rp;                                       \
 474         _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
 475         _rp.size = (sz);                                        \
 476         _rp.nitems = n;                                         \
 477         _rp.hits = 0;                                           \
 478         _rp.misses = 0;                                         \
 479         vec_add1(shmem_hdr->client_rings, _rp);                 \
 480     } while (0);
 481
 482   foreach_clnt_aring_size;
 483 #undef _
 484
 485   am->shmem_hdr = shmem_hdr;
 486   am->vlib_rp = vlib_rp;
 487   am->our_pid = getpid ();
 488   if (is_vlib)
 489     am->shmem_hdr->vl_pid = am->our_pid;
 490
 491   svm_pop_heap (oldheap);
 492
 493   /*
 494    * After absolutely everything that a client might see is set up,
 495    * declare the shmem region valid
 496    */
 497   vlib_rp->user_ctx = shmem_hdr;
 498
 499   pthread_mutex_unlock (&vlib_rp->mutex);
 500   vec_add1 (am->mapped_shmem_regions, vlib_rp);
 501   return 0;
 502 }
 503
 504 void
 505 vl_register_mapped_shmem_region (svm_region_t * rp)
 506 {
 507   api_main_t *am = &api_main;
 508
 509   vec_add1 (am->mapped_shmem_regions, rp);
 510 }
 511
 512 void
 513 vl_unmap_shmem (void)
 514 {
 515   svm_region_t *rp;
 516   int i;
 517   api_main_t *am = &api_main;
 518
 519   if (!svm_get_root_rp ())
 520     return;
 521
 522   for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
 523     {
 524       rp = am->mapped_shmem_regions[i];
 525       svm_region_unmap (rp);
 526     }
 527
 528   vec_free (am->mapped_shmem_regions);
 529   am->shmem_hdr = 0;
 530
 531   svm_region_exit ();
 532   /* $$$ more careful cleanup, valgrind run... */
 533   vec_free (am->msg_handlers);
 534   vec_free (am->msg_endian_handlers);
 535   vec_free (am->msg_print_handlers);
 536 }
 537
 538 void
 539 vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem)
 540 {
 541   api_main_t *am = &api_main;
 542   uword *trace = (uword *) elem;
 543
 544   if (am->tx_trace && am->tx_trace->enabled)
 545     vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
 546
 547   (void) unix_shared_memory_queue_add (q, elem, 0 /* nowait */ );
 548 }
 549
 550 void
 551 vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem)
 552 {
 553   api_main_t *am = &api_main;
 554   uword *trace = (uword *) elem;
 555
 556   if (am->tx_trace && am->tx_trace->enabled)
 557     vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
 558
 559   (void) unix_shared_memory_queue_add_nolock (q, elem);
 560 }
 561
 562 u32
 563 vl_api_get_msg_index (u8 * name_and_crc)
 564 {
 565   api_main_t *am = &api_main;
 566   uword *p;
 567
 568   if (am->msg_index_by_name_and_crc)
 569     {
 570       p = hash_get_mem (am->msg_index_by_name_and_crc, name_and_crc);
 571       if (p)
 572         return p[0];
 573     }
 574   return ~0;
 575 }
 576
 577 static inline vl_api_registration_t *
 578 vl_api_client_index_to_registration_internal (u32 handle)
 579 {
 580   vl_api_registration_t **regpp;
 581   vl_api_registration_t *regp;
 582   api_main_t *am = &api_main;
 583   u32 index;
 584
 585   index = vl_msg_api_handle_get_index (handle);
 586   if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK)
 587       != vl_msg_api_handle_get_epoch (handle))
 588     {
 589       vl_msg_api_increment_missing_client_counter ();
 590       return 0;
 591     }
 592
 593   regpp = am->vl_clients + index;
 594
 595   if (pool_is_free (am->vl_clients, regpp))
 596     {
 597       vl_msg_api_increment_missing_client_counter ();
 598       return 0;
 599     }
 600   regp = *regpp;
 601   return (regp);
 602 }
 603
 604 vl_api_registration_t *
 605 vl_api_client_index_to_registration (u32 index)
 606 {
 607   return (vl_api_client_index_to_registration_internal (index));
 608 }
 609
 610 unix_shared_memory_queue_t *
 611 vl_api_client_index_to_input_queue (u32 index)
 612 {
 613   vl_api_registration_t *regp;
 614   api_main_t *am = &api_main;
 615
 616   /* Special case: vlib trying to send itself a message */
 617   if (index == (u32) ~ 0)
 618     return (am->shmem_hdr->vl_input_queue);
 619
 620   regp = vl_api_client_index_to_registration_internal (index);
 621   if (!regp)
 622     return 0;
 623   return (regp->vl_input_queue);
 624 }
 625
 626 /*
 627  * fd.io coding-style-patch-verification: ON
 628  *
 629  * Local Variables:
 630  * eval: (c-set-style "gnu")
 631  * End:
 632  */