svm/svm.c

   1 /*
   2  *------------------------------------------------------------------
   3  * svm.c - shared VM allocation, mmap(...MAP_FIXED...)
   4  * library
   5  *
   6  * Copyright (c) 2009 Cisco and/or its affiliates.
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at:
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *------------------------------------------------------------------
  19  */
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <sys/types.h>
  24 #include <sys/mman.h>
  25 #include <sys/stat.h>
  26 #include <netinet/in.h>
  27 #include <signal.h>
  28 #include <pthread.h>
  29 #include <unistd.h>
  30 #include <time.h>
  31 #include <fcntl.h>
  32 #include <string.h>
  33 #include <vppinfra/clib.h>
  34 #include <vppinfra/vec.h>
  35 #include <vppinfra/hash.h>
  36 #include <vppinfra/bitmap.h>
  37 #include <vppinfra/fifo.h>
  38 #include <vppinfra/time.h>
  39 #include <vppinfra/mheap.h>
  40 #include <vppinfra/heap.h>
  41 #include <vppinfra/pool.h>
  42 #include <vppinfra/format.h>
  43
  44 #include "svm.h"
  45
  46 static svm_region_t *root_rp;
  47 static int root_rp_refcount;
  48
  49 #define MAXLOCK 2
  50 static pthread_mutex_t *mutexes_held[MAXLOCK];
  51 static int nheld;
  52
  53 svm_region_t *
  54 svm_get_root_rp (void)
  55 {
  56   return root_rp;
  57 }
  58
  59 #define MUTEX_DEBUG
  60
  61 static void
  62 region_lock (svm_region_t * rp, int tag)
  63 {
  64   pthread_mutex_lock (&rp->mutex);
  65 #ifdef MUTEX_DEBUG
  66   rp->mutex_owner_pid = getpid ();
  67   rp->mutex_owner_tag = tag;
  68 #endif
  69   ASSERT (nheld < MAXLOCK);
  70   /*
  71    * Keep score of held mutexes so we can try to exit
  72    * cleanly if the world comes to an end at the worst possible
  73    * moment
  74    */
  75   mutexes_held[nheld++] = &rp->mutex;
  76 }
  77
  78 static void
  79 region_unlock (svm_region_t * rp)
  80 {
  81   int i, j;
  82 #ifdef MUTEX_DEBUG
  83   rp->mutex_owner_pid = 0;
  84   rp->mutex_owner_tag = 0;
  85 #endif
  86
  87   for (i = nheld - 1; i >= 0; i--)
  88     {
  89       if (mutexes_held[i] == &rp->mutex)
  90         {
  91           for (j = i; j < MAXLOCK - 1; j++)
  92             mutexes_held[j] = mutexes_held[j + 1];
  93           nheld--;
  94           goto found;
  95         }
  96     }
  97   ASSERT (0);
  98
  99 found:
 100   CLIB_MEMORY_BARRIER ();
 101   pthread_mutex_unlock (&rp->mutex);
 102 }
 103
 104
 105 static u8 *
 106 format_svm_flags (u8 * s, va_list * args)
 107 {
 108   uword f = va_arg (*args, uword);
 109
 110   if (f & SVM_FLAGS_MHEAP)
 111     s = format (s, "MHEAP ");
 112   if (f & SVM_FLAGS_FILE)
 113     s = format (s, "FILE ");
 114   if (f & SVM_FLAGS_NODATA)
 115     s = format (s, "NODATA ");
 116   if (f & SVM_FLAGS_NEED_DATA_INIT)
 117     s = format (s, "INIT ");
 118
 119   return (s);
 120 }
 121
 122 static u8 *
 123 format_svm_size (u8 * s, va_list * args)
 124 {
 125   uword size = va_arg (*args, uword);
 126
 127   if (size >= (1 << 20))
 128     {
 129       s = format (s, "(%d mb)", size >> 20);
 130     }
 131   else if (size >= (1 << 10))
 132     {
 133       s = format (s, "(%d kb)", size >> 10);
 134     }
 135   else
 136     {
 137       s = format (s, "(%d bytes)", size);
 138     }
 139   return (s);
 140 }
 141
 142 u8 *
 143 format_svm_region (u8 * s, va_list * args)
 144 {
 145   svm_region_t *rp = va_arg (*args, svm_region_t *);
 146   int verbose = va_arg (*args, int);
 147   int i;
 148   uword lo, hi;
 149
 150   s = format (s, "%s: base va 0x%x size 0x%x %U\n",
 151               rp->region_name, rp->virtual_base,
 152               rp->virtual_size, format_svm_size, rp->virtual_size);
 153   s = format (s, "  user_ctx 0x%x, bitmap_size %d\n",
 154               rp->user_ctx, rp->bitmap_size);
 155
 156   if (verbose)
 157     {
 158       s = format (s, "  flags: 0x%x %U\n", rp->flags,
 159                   format_svm_flags, rp->flags);
 160       s = format (s,
 161                   "  region_heap 0x%x data_base 0x%x data_heap 0x%x\n",
 162                   rp->region_heap, rp->data_base, rp->data_heap);
 163     }
 164
 165   s = format (s, "  %d clients, pids: ", vec_len (rp->client_pids));
 166
 167   for (i = 0; i < vec_len (rp->client_pids); i++)
 168     s = format (s, "%d ", rp->client_pids[i]);
 169
 170   s = format (s, "\n");
 171
 172   if (verbose)
 173     {
 174       lo = hi = ~0;
 175
 176       s = format (s, "  VM in use: ");
 177
 178       for (i = 0; i < rp->bitmap_size; i++)
 179         {
 180           if (clib_bitmap_get_no_check (rp->bitmap, i) != 0)
 181             {
 182               if (lo == ~0)
 183                 {
 184                   hi = lo = rp->virtual_base + i * MMAP_PAGESIZE;
 185                 }
 186               else
 187                 {
 188                   hi = rp->virtual_base + i * MMAP_PAGESIZE;
 189                 }
 190             }
 191           else
 192             {
 193               if (lo != ~0)
 194                 {
 195                   hi = rp->virtual_base + i * MMAP_PAGESIZE - 1;
 196                   s = format (s, "   0x%x - 0x%x (%dk)\n", lo, hi,
 197                               (hi - lo) >> 10);
 198                   lo = hi = ~0;
 199                 }
 200             }
 201         }
 202       s = format (s, "  rgn heap stats: %U", format_mheap,
 203                   rp->region_heap, 0);
 204       if ((rp->flags & SVM_FLAGS_MHEAP) && rp->data_heap)
 205         {
 206           s = format (s, "\n  data heap stats: %U", format_mheap,
 207                       rp->data_heap, 1);
 208         }
 209       s = format (s, "\n");
 210     }
 211
 212   return (s);
 213 }
 214
 215 /*
 216  * rnd_pagesize
 217  * Round to a pagesize multiple, presumably 4k works
 218  */
 219 static unsigned int
 220 rnd_pagesize (unsigned int size)
 221 {
 222   unsigned int rv;
 223
 224   rv = (size + (MMAP_PAGESIZE - 1)) & ~(MMAP_PAGESIZE - 1);
 225   return (rv);
 226 }
 227
 228 /*
 229  * svm_data_region_setup
 230  */
 231 static int
 232 svm_data_region_create (svm_map_region_args_t * a, svm_region_t * rp)
 233 {
 234   int fd;
 235   u8 junk = 0;
 236   uword map_size;
 237
 238   map_size = rp->virtual_size - (MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE);
 239
 240   if (a->flags & SVM_FLAGS_FILE)
 241     {
 242       struct stat statb;
 243
 244       fd = open (a->backing_file, O_RDWR | O_CREAT, 0777);
 245
 246       if (fd < 0)
 247         {
 248           clib_unix_warning ("open");
 249           return -1;
 250         }
 251
 252       if (fstat (fd, &statb) < 0)
 253         {
 254           clib_unix_warning ("fstat");
 255           close (fd);
 256           return -2;
 257         }
 258
 259       if (statb.st_mode & S_IFREG)
 260         {
 261           if (statb.st_size == 0)
 262             {
 263               if (lseek (fd, map_size, SEEK_SET) == (off_t) - 1)
 264                 {
 265                   clib_unix_warning ("seek region size");
 266                   close (fd);
 267                   return -3;
 268                 }
 269               if (write (fd, &junk, 1) != 1)
 270                 {
 271                   clib_unix_warning ("set region size");
 272                   close (fd);
 273                   return -3;
 274                 }
 275             }
 276           else
 277             {
 278               map_size = rnd_pagesize (statb.st_size);
 279             }
 280         }
 281       else
 282         {
 283           map_size = a->backing_mmap_size;
 284         }
 285
 286       ASSERT (map_size <= rp->virtual_size -
 287               (MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE));
 288
 289       if (mmap (rp->data_base, map_size, PROT_READ | PROT_WRITE,
 290                 MAP_SHARED | MAP_FIXED, fd, 0) == MAP_FAILED)
 291         {
 292           clib_unix_warning ("mmap");
 293           close (fd);
 294           return -3;
 295         }
 296       close (fd);
 297       rp->backing_file = (char *) format (0, "%s\0", a->backing_file);
 298       rp->flags |= SVM_FLAGS_FILE;
 299     }
 300
 301   if (a->flags & SVM_FLAGS_MHEAP)
 302     {
 303       rp->data_heap =
 304         mheap_alloc_with_flags ((void *) (rp->data_base), map_size,
 305                                 MHEAP_FLAG_DISABLE_VM);
 306       rp->flags |= SVM_FLAGS_MHEAP;
 307     }
 308   return 0;
 309 }
 310
 311 static int
 312 svm_data_region_map (svm_map_region_args_t * a, svm_region_t * rp)
 313 {
 314   int fd;
 315   u8 junk = 0;
 316   uword map_size;
 317   struct stat statb;
 318
 319   map_size = rp->virtual_size - (MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE);
 320
 321   if (a->flags & SVM_FLAGS_FILE)
 322     {
 323
 324       fd = open (a->backing_file, O_RDWR, 0777);
 325
 326       if (fd < 0)
 327         {
 328           clib_unix_warning ("open");
 329           return -1;
 330         }
 331
 332       if (fstat (fd, &statb) < 0)
 333         {
 334           clib_unix_warning ("fstat");
 335           close (fd);
 336           return -2;
 337         }
 338
 339       if (statb.st_mode & S_IFREG)
 340         {
 341           if (statb.st_size == 0)
 342             {
 343               if (lseek (fd, map_size, SEEK_SET) == (off_t) - 1)
 344                 {
 345                   clib_unix_warning ("seek region size");
 346                   close (fd);
 347                   return -3;
 348                 }
 349               if (write (fd, &junk, 1) != 1)
 350                 {
 351                   clib_unix_warning ("set region size");
 352                   close (fd);
 353                   return -3;
 354                 }
 355             }
 356           else
 357             {
 358               map_size = rnd_pagesize (statb.st_size);
 359             }
 360         }
 361       else
 362         {
 363           map_size = a->backing_mmap_size;
 364         }
 365
 366       ASSERT (map_size <= rp->virtual_size
 367               - (MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE));
 368
 369       if (mmap (rp->data_base, map_size, PROT_READ | PROT_WRITE,
 370                 MAP_SHARED | MAP_FIXED, fd, 0) == MAP_FAILED)
 371         {
 372           clib_unix_warning ("mmap");
 373           close (fd);
 374           return -3;
 375         }
 376       close (fd);
 377     }
 378   return 0;
 379 }
 380
 381 u8 *
 382 shm_name_from_svm_map_region_args (svm_map_region_args_t * a)
 383 {
 384   u8 *path;
 385   u8 *shm_name;
 386   u8 *split_point;
 387   u8 *mkdir_arg = 0;
 388   int root_path_offset = 0;
 389   int name_offset = 0;
 390
 391   if (a->root_path)
 392     {
 393       /* Tolerate present or absent slashes */
 394       if (a->root_path[0] == '/')
 395         root_path_offset++;
 396
 397       /* create the root_path under /dev/shm
 398          iterate through path creating directories */
 399
 400       path = format (0, "/dev/shm/%s%c", &a->root_path[root_path_offset], 0);
 401       split_point = path + 1;
 402       vec_add1 (mkdir_arg, '-');
 403
 404       while (*split_point)
 405         {
 406           while (*split_point && *split_point != '/')
 407             {
 408               vec_add1 (mkdir_arg, *split_point);
 409               split_point++;
 410             }
 411           vec_add1 (mkdir_arg, 0);
 412
 413           /* ready to descend another level */
 414           mkdir_arg[vec_len (mkdir_arg) - 1] = '-';
 415           split_point++;
 416         }
 417       vec_free (mkdir_arg);
 418       vec_free (path);
 419
 420       if (a->name[0] == '/')
 421         name_offset = 1;
 422
 423       shm_name = format (0, "/%s-%s%c", a->root_path,
 424                          &a->name[name_offset], 0);
 425     }
 426   else
 427     shm_name = format (0, "%s%c", a->name, 0);
 428   return (shm_name);
 429 }
 430
 431 /*
 432  * svm_map_region
 433  */
 434 void *
 435 svm_map_region (svm_map_region_args_t * a)
 436 {
 437   int svm_fd;
 438   svm_region_t *rp;
 439   pthread_mutexattr_t attr;
 440   pthread_condattr_t cattr;
 441   int deadman = 0;
 442   u8 junk = 0;
 443   void *oldheap;
 444   int overhead_space;
 445   int rv;
 446   uword data_base;
 447   int nbits, words, bit;
 448   int pid_holding_region_lock;
 449   u8 *shm_name;
 450   int dead_region_recovery = 0;
 451   int time_left;
 452   struct stat stat;
 453   struct timespec ts, tsrem;
 454
 455   if (CLIB_DEBUG > 1)
 456     clib_warning ("[%d] map region %s", getpid (), a->name);
 457
 458   ASSERT ((a->size & ~(MMAP_PAGESIZE - 1)) == a->size);
 459   ASSERT (a->name);
 460
 461   shm_name = shm_name_from_svm_map_region_args (a);
 462
 463   svm_fd = shm_open ((char *) shm_name, O_RDWR | O_CREAT | O_EXCL, 0777);
 464
 465   if (svm_fd >= 0)
 466     {
 467       if (fchmod (svm_fd, 0770) < 0)
 468         clib_unix_warning ("segment chmod");
 469       /* This turns out to fail harmlessly if the client starts first */
 470       if (fchown (svm_fd, a->uid, a->gid) < 0)
 471         clib_unix_warning ("segment chown [ok if client starts first]");
 472
 473       vec_free (shm_name);
 474
 475       if (lseek (svm_fd, a->size, SEEK_SET) == (off_t) - 1)
 476         {
 477           clib_warning ("seek region size");
 478           close (svm_fd);
 479           return (0);
 480         }
 481       if (write (svm_fd, &junk, 1) != 1)
 482         {
 483           clib_warning ("set region size");
 484           close (svm_fd);
 485           return (0);
 486         }
 487
 488       rp = mmap ((void *) a->baseva, a->size,
 489                  PROT_READ | PROT_WRITE, MAP_SHARED | MAP_FIXED, svm_fd, 0);
 490
 491       if (rp == (svm_region_t *) MAP_FAILED)
 492         {
 493           clib_unix_warning ("mmap create");
 494           close (svm_fd);
 495           return (0);
 496         }
 497       close (svm_fd);
 498       memset (rp, 0, sizeof (*rp));
 499
 500       if (pthread_mutexattr_init (&attr))
 501         clib_unix_warning ("mutexattr_init");
 502
 503       if (pthread_mutexattr_setpshared (&attr, PTHREAD_PROCESS_SHARED))
 504         clib_unix_warning ("mutexattr_setpshared");
 505
 506       if (pthread_mutex_init (&rp->mutex, &attr))
 507         clib_unix_warning ("mutex_init");
 508
 509       if (pthread_mutexattr_destroy (&attr))
 510         clib_unix_warning ("mutexattr_destroy");
 511
 512       if (pthread_condattr_init (&cattr))
 513         clib_unix_warning ("condattr_init");
 514
 515       if (pthread_condattr_setpshared (&cattr, PTHREAD_PROCESS_SHARED))
 516         clib_unix_warning ("condattr_setpshared");
 517
 518       if (pthread_cond_init (&rp->condvar, &cattr))
 519         clib_unix_warning ("cond_init");
 520
 521       if (pthread_condattr_destroy (&cattr))
 522         clib_unix_warning ("condattr_destroy");
 523
 524       region_lock (rp, 1);
 525
 526       rp->virtual_base = a->baseva;
 527       rp->virtual_size = a->size;
 528
 529       rp->region_heap =
 530         mheap_alloc_with_flags ((void *) (a->baseva + MMAP_PAGESIZE),
 531                                 SVM_PVT_MHEAP_SIZE, MHEAP_FLAG_DISABLE_VM);
 532       oldheap = svm_push_pvt_heap (rp);
 533
 534       rp->region_name = (char *) format (0, "%s%c", a->name, 0);
 535       vec_add1 (rp->client_pids, getpid ());
 536
 537       nbits = rp->virtual_size / MMAP_PAGESIZE;
 538
 539       ASSERT (nbits > 0);
 540       rp->bitmap_size = nbits;
 541       words = (nbits + BITS (uword) - 1) / BITS (uword);
 542       vec_validate (rp->bitmap, words - 1);
 543
 544       overhead_space = MMAP_PAGESIZE /* header */  +
 545         SVM_PVT_MHEAP_SIZE;
 546
 547       bit = 0;
 548       data_base = (uword) rp->virtual_base;
 549
 550       if (a->flags & SVM_FLAGS_NODATA)
 551         rp->flags |= SVM_FLAGS_NEED_DATA_INIT;
 552
 553       do
 554         {
 555           clib_bitmap_set_no_check (rp->bitmap, bit, 1);
 556           bit++;
 557           overhead_space -= MMAP_PAGESIZE;
 558           data_base += MMAP_PAGESIZE;
 559         }
 560       while (overhead_space > 0);
 561
 562       rp->data_base = (void *) data_base;
 563
 564       /*
 565        * Note: although the POSIX spec guarantees that only one
 566        * process enters this block, we have to play games
 567        * to hold off clients until e.g. the mutex is ready
 568        */
 569       rp->version = SVM_VERSION;
 570
 571       /* setup the data portion of the region */
 572
 573       rv = svm_data_region_create (a, rp);
 574       if (rv)
 575         {
 576           clib_warning ("data_region_create: %d", rv);
 577         }
 578
 579       region_unlock (rp);
 580
 581       svm_pop_heap (oldheap);
 582
 583       return ((void *) rp);
 584     }
 585   else
 586     {
 587       svm_fd = shm_open ((char *) shm_name, O_RDWR, 0777);
 588
 589       vec_free (shm_name);
 590
 591       if (svm_fd < 0)
 592         {
 593           perror ("svm_region_map(mmap open)");
 594           return (0);
 595         }
 596
 597       time_left = 20;
 598       while (1)
 599         {
 600           if (0 != fstat (svm_fd, &stat))
 601             {
 602               clib_warning ("fstat failed: %d", errno);
 603               close (svm_fd);
 604               return (0);
 605             }
 606           if (stat.st_size > 0)
 607             {
 608               break;
 609             }
 610           if (0 == time_left)
 611             {
 612               clib_warning ("waiting for resize of shm file timed out");
 613               close (svm_fd);
 614               return (0);
 615             }
 616           ts.tv_sec = 0;
 617           ts.tv_nsec = 100000000;
 618           while (nanosleep (&ts, &tsrem) < 0)
 619             ts = tsrem;
 620           time_left--;
 621         }
 622
 623       rp = mmap (0, MMAP_PAGESIZE,
 624                  PROT_READ | PROT_WRITE, MAP_SHARED, svm_fd, 0);
 625
 626       if (rp == (svm_region_t *) MAP_FAILED)
 627         {
 628           close (svm_fd);
 629           clib_warning ("mmap");
 630           return (0);
 631         }
 632       /*
 633        * We lost the footrace to create this region; make sure
 634        * the winner has crossed the finish line.
 635        */
 636       while (rp->version == 0 && deadman++ < 5)
 637         {
 638           sleep (1);
 639         }
 640
 641       /*
 642        * <bleep>-ed?
 643        */
 644       if (rp->version == 0)
 645         {
 646           clib_warning ("rp->version %d not %d", rp->version, SVM_VERSION);
 647           close (svm_fd);
 648           munmap (rp, a->size);
 649           return (0);
 650         }
 651       /* Remap now that the region has been placed */
 652       a->baseva = rp->virtual_base;
 653       a->size = rp->virtual_size;
 654       munmap (rp, MMAP_PAGESIZE);
 655
 656       rp = (void *) mmap ((void *) a->baseva, a->size,
 657                           PROT_READ | PROT_WRITE,
 658                           MAP_SHARED | MAP_FIXED, svm_fd, 0);
 659       if ((uword) rp == (uword) MAP_FAILED)
 660         {
 661           clib_unix_warning ("mmap");
 662           close (svm_fd);
 663           return (0);
 664         }
 665
 666       if ((uword) rp != rp->virtual_base)
 667         {
 668           clib_warning ("mmap botch");
 669         }
 670
 671       /*
 672        * Try to fix the region mutex if it is held by
 673        * a dead process
 674        */
 675       pid_holding_region_lock = rp->mutex_owner_pid;
 676       if (pid_holding_region_lock && kill (pid_holding_region_lock, 0) < 0)
 677         {
 678           clib_warning
 679             ("region %s mutex held by dead pid %d, tag %d, force unlock",
 680              rp->region_name, pid_holding_region_lock, rp->mutex_owner_tag);
 681           /* owner pid is nonexistent */
 682           rp->mutex.__data.__owner = 0;
 683           rp->mutex.__data.__lock = 0;
 684           dead_region_recovery = 1;
 685         }
 686
 687       if (dead_region_recovery)
 688         clib_warning ("recovery: attempt to re-lock region");
 689
 690       region_lock (rp, 2);
 691       oldheap = svm_push_pvt_heap (rp);
 692       vec_add1 (rp->client_pids, getpid ());
 693
 694       if (dead_region_recovery)
 695         clib_warning ("recovery: attempt svm_data_region_map");
 696
 697       rv = svm_data_region_map (a, rp);
 698       if (rv)
 699         {
 700           clib_warning ("data_region_map: %d", rv);
 701         }
 702
 703       if (dead_region_recovery)
 704         clib_warning ("unlock and continue");
 705
 706       region_unlock (rp);
 707
 708       svm_pop_heap (oldheap);
 709
 710       return ((void *) rp);
 711
 712     }
 713   return 0;                     /* NOTREACHED */
 714 }
 715
 716 static void
 717 svm_mutex_cleanup (void)
 718 {
 719   int i;
 720   for (i = 0; i < nheld; i++)
 721     {
 722       pthread_mutex_unlock (mutexes_held[i]);
 723     }
 724 }
 725
 726 static void
 727 svm_region_init_internal (char *root_path, int uid, int gid)
 728 {
 729   svm_region_t *rp;
 730   svm_map_region_args_t _a, *a = &_a;
 731   u64 ticks = clib_cpu_time_now ();
 732   uword randomize_baseva;
 733
 734   /* guard against klutz calls */
 735   if (root_rp)
 736     return;
 737
 738   root_rp_refcount++;
 739
 740   atexit (svm_mutex_cleanup);
 741
 742   /* Randomize the shared-VM base at init time */
 743   if (MMAP_PAGESIZE <= (4 << 10))
 744     randomize_baseva = (ticks & 15) * MMAP_PAGESIZE;
 745   else
 746     randomize_baseva = (ticks & 3) * MMAP_PAGESIZE;
 747
 748   memset (a, 0, sizeof (*a));
 749   a->root_path = root_path;
 750   a->name = SVM_GLOBAL_REGION_NAME;
 751   a->baseva = SVM_GLOBAL_REGION_BASEVA + randomize_baseva;
 752   a->size = SVM_GLOBAL_REGION_SIZE;
 753   a->flags = SVM_FLAGS_NODATA;
 754   a->uid = uid;
 755   a->gid = gid;
 756
 757   rp = svm_map_region (a);
 758   ASSERT (rp);
 759
 760   region_lock (rp, 3);
 761
 762   /* Set up the main region data structures */
 763   if (rp->flags & SVM_FLAGS_NEED_DATA_INIT)
 764     {
 765       svm_main_region_t *mp = 0;
 766       void *oldheap;
 767
 768       rp->flags &= ~(SVM_FLAGS_NEED_DATA_INIT);
 769
 770       oldheap = svm_push_pvt_heap (rp);
 771       vec_validate (mp, 0);
 772       mp->name_hash = hash_create_string (0, sizeof (uword));
 773       mp->root_path = root_path ? format (0, "%s%c", root_path, 0) : 0;
 774       rp->data_base = mp;
 775       svm_pop_heap (oldheap);
 776     }
 777   region_unlock (rp);
 778   root_rp = rp;
 779 }
 780
 781 void
 782 svm_region_init (void)
 783 {
 784   svm_region_init_internal (0, 0 /* uid */ , 0 /* gid */ );
 785 }
 786
 787 void
 788 svm_region_init_chroot (char *root_path)
 789 {
 790   svm_region_init_internal (root_path, 0 /* uid */ , 0 /* gid */ );
 791 }
 792
 793 void
 794 svm_region_init_chroot_uid_gid (char *root_path, int uid, int gid)
 795 {
 796   svm_region_init_internal (root_path, uid, gid);
 797 }
 798
 799 void *
 800 svm_region_find_or_create (svm_map_region_args_t * a)
 801 {
 802   svm_main_region_t *mp;
 803   svm_region_t *rp;
 804   uword need_nbits;
 805   int index, i;
 806   void *oldheap;
 807   uword *p;
 808   u8 *name;
 809   svm_subregion_t *subp;
 810
 811   ASSERT (root_rp);
 812
 813   a->size += MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE;
 814   a->size = rnd_pagesize (a->size);
 815
 816   region_lock (root_rp, 4);
 817   oldheap = svm_push_pvt_heap (root_rp);
 818   mp = root_rp->data_base;
 819
 820   ASSERT (mp);
 821
 822   /* Map the named region from the correct chroot environment */
 823   a->root_path = (char *) mp->root_path;
 824
 825   /*
 826    * See if this region is already known. If it is, we're
 827    * almost done...
 828    */
 829   p = hash_get_mem (mp->name_hash, a->name);
 830
 831   if (p)
 832     {
 833       rp = svm_map_region (a);
 834       region_unlock (root_rp);
 835       svm_pop_heap (oldheap);
 836       return rp;
 837     }
 838
 839   /* Create the region. */
 840   ASSERT ((a->size & ~(MMAP_PAGESIZE - 1)) == a->size);
 841
 842   need_nbits = a->size / MMAP_PAGESIZE;
 843
 844   index = 1;                    /* $$$ fixme, figure out how many bit to really skip */
 845
 846   /*
 847    * Scan the virtual space allocation bitmap, looking for a large
 848    * enough chunk
 849    */
 850   do
 851     {
 852       if (clib_bitmap_get_no_check (root_rp->bitmap, index) == 0)
 853         {
 854           for (i = 0; i < (need_nbits - 1); i++)
 855             {
 856               if (clib_bitmap_get_no_check (root_rp->bitmap, index + i) == 1)
 857                 {
 858                   index = index + i;
 859                   goto next;
 860                 }
 861             }
 862           break;
 863         }
 864       index++;
 865     next:;
 866     }
 867   while (index < root_rp->bitmap_size);
 868
 869   /* Completely out of VM? */
 870   if (index >= root_rp->bitmap_size)
 871     {
 872       clib_warning ("region %s: not enough VM to allocate 0x%x",
 873                     root_rp->region_name, a->size);
 874       svm_pop_heap (oldheap);
 875       region_unlock (root_rp);
 876       return 0;
 877     }
 878
 879   /*
 880    * Mark virtual space allocated
 881    */
 882 #if CLIB_DEBUG > 1
 883   clib_warning ("set %d bits at index %d", need_nbits, index);
 884 #endif
 885
 886   for (i = 0; i < need_nbits; i++)
 887     {
 888       clib_bitmap_set_no_check (root_rp->bitmap, index + i, 1);
 889     }
 890
 891   /* Place this region where it goes... */
 892   a->baseva = root_rp->virtual_base + index * MMAP_PAGESIZE;
 893
 894   rp = svm_map_region (a);
 895
 896   pool_get (mp->subregions, subp);
 897   name = format (0, "%s%c", a->name, 0);
 898   subp->subregion_name = name;
 899
 900   hash_set_mem (mp->name_hash, name, subp - mp->subregions);
 901
 902   svm_pop_heap (oldheap);
 903
 904   region_unlock (root_rp);
 905
 906   return (rp);
 907 }
 908
 909 /*
 910  * svm_region_unmap
 911  *
 912  * Let go of the indicated region. If the calling process
 913  * is the last customer, throw it away completely.
 914  * The root region mutex guarantees atomicity with respect to
 915  * a new region client showing up at the wrong moment.
 916  */
 917 void
 918 svm_region_unmap (void *rp_arg)
 919 {
 920   int i, mypid = getpid ();
 921   int nclients_left;
 922   void *oldheap;
 923   uword virtual_base, virtual_size;
 924   svm_region_t *rp = rp_arg;
 925   char *name;
 926
 927   /*
 928    * If we take a signal while holding one or more shared-memory
 929    * mutexes, we may end up back here from an otherwise
 930    * benign exit handler. Bail out to avoid a recursive
 931    * mutex screw-up.
 932    */
 933   if (nheld)
 934     return;
 935
 936   ASSERT (rp);
 937   ASSERT (root_rp);
 938
 939   if (CLIB_DEBUG > 1)
 940     clib_warning ("[%d] unmap region %s", getpid (), rp->region_name);
 941
 942   region_lock (root_rp, 5);
 943   region_lock (rp, 6);
 944
 945   oldheap = svm_push_pvt_heap (rp);     /* nb vec_delete() in the loop */
 946
 947   /* Remove the caller from the list of mappers */
 948   for (i = 0; i < vec_len (rp->client_pids); i++)
 949     {
 950       if (rp->client_pids[i] == mypid)
 951         {
 952           vec_delete (rp->client_pids, 1, i);
 953           goto found;
 954         }
 955     }
 956   clib_warning ("pid %d AWOL", mypid);
 957
 958 found:
 959
 960   svm_pop_heap (oldheap);
 961
 962   nclients_left = vec_len (rp->client_pids);
 963   virtual_base = rp->virtual_base;
 964   virtual_size = rp->virtual_size;
 965
 966   if (nclients_left == 0)
 967     {
 968       int index, nbits, i;
 969       svm_main_region_t *mp;
 970       uword *p;
 971       svm_subregion_t *subp;
 972
 973       /* Kill the region, last guy on his way out */
 974
 975       oldheap = svm_push_pvt_heap (root_rp);
 976       name = vec_dup (rp->region_name);
 977
 978       virtual_base = rp->virtual_base;
 979       virtual_size = rp->virtual_size;
 980
 981       /* Figure out which bits to clear in the root region bitmap */
 982       index = (virtual_base - root_rp->virtual_base) / MMAP_PAGESIZE;
 983
 984       nbits = (virtual_size + MMAP_PAGESIZE - 1) / MMAP_PAGESIZE;
 985
 986 #if CLIB_DEBUG > 1
 987       clib_warning ("clear %d bits at index %d", nbits, index);
 988 #endif
 989       /* Give back the allocated VM */
 990       for (i = 0; i < nbits; i++)
 991         {
 992           clib_bitmap_set_no_check (root_rp->bitmap, index + i, 0);
 993         }
 994
 995       mp = root_rp->data_base;
 996
 997       p = hash_get_mem (mp->name_hash, name);
 998
 999       /* Better never happen ... */
1000       if (p == NULL)
1001         {
1002           region_unlock (rp);
1003           region_unlock (root_rp);
1004           svm_pop_heap (oldheap);
1005           clib_warning ("Region name '%s' not found?", name);
1006           return;
1007         }
1008
1009       /* Remove from the root region subregion pool */
1010       subp = mp->subregions + p[0];
1011       pool_put (mp->subregions, subp);
1012
1013       hash_unset_mem (mp->name_hash, name);
1014
1015       vec_free (name);
1016
1017       region_unlock (rp);
1018       shm_unlink (rp->region_name);
1019       munmap ((void *) virtual_base, virtual_size);
1020       region_unlock (root_rp);
1021       svm_pop_heap (oldheap);
1022       return;
1023     }
1024
1025   region_unlock (rp);
1026   region_unlock (root_rp);
1027
1028   munmap ((void *) virtual_base, virtual_size);
1029 }
1030
1031 /*
1032  * svm_region_exit
1033  * There is no clean way to unlink the
1034  * root region when all clients go away,
1035  * so remove the pid entry and call it a day.
1036  */
1037 void
1038 svm_region_exit ()
1039 {
1040   void *oldheap;
1041   int i, mypid = getpid ();
1042   uword virtual_base, virtual_size;
1043
1044   /* It felt so nice we did it twice... */
1045   if (root_rp == 0)
1046     return;
1047
1048   if (--root_rp_refcount > 0)
1049     return;
1050
1051   /*
1052    * If we take a signal while holding one or more shared-memory
1053    * mutexes, we may end up back here from an otherwise
1054    * benign exit handler. Bail out to avoid a recursive
1055    * mutex screw-up.
1056    */
1057   if (nheld)
1058     return;
1059
1060   region_lock (root_rp, 7);
1061   oldheap = svm_push_pvt_heap (root_rp);
1062
1063   virtual_base = root_rp->virtual_base;
1064   virtual_size = root_rp->virtual_size;
1065
1066   for (i = 0; i < vec_len (root_rp->client_pids); i++)
1067     {
1068       if (root_rp->client_pids[i] == mypid)
1069         {
1070           vec_delete (root_rp->client_pids, 1, i);
1071           goto found;
1072         }
1073     }
1074   clib_warning ("pid %d AWOL", mypid);
1075
1076 found:
1077
1078   region_unlock (root_rp);
1079   svm_pop_heap (oldheap);
1080
1081   root_rp = 0;
1082   munmap ((void *) virtual_base, virtual_size);
1083 }
1084
1085 void
1086 svm_client_scan_this_region_nolock (svm_region_t * rp)
1087 {
1088   int j;
1089   int mypid = getpid ();
1090   void *oldheap;
1091
1092   for (j = 0; j < vec_len (rp->client_pids); j++)
1093     {
1094       if (mypid == rp->client_pids[j])
1095         continue;
1096       if (rp->client_pids[j] && (kill (rp->client_pids[j], 0) < 0))
1097         {
1098           clib_warning ("%s: cleanup ghost pid %d",
1099                         rp->region_name, rp->client_pids[j]);
1100           /* nb: client vec in rp->region_heap */
1101           oldheap = svm_push_pvt_heap (rp);
1102           vec_delete (rp->client_pids, 1, j);
1103           j--;
1104           svm_pop_heap (oldheap);
1105         }
1106     }
1107 }
1108
1109
1110 /*
1111  * Scan svm regions for dead clients
1112  */
1113 void
1114 svm_client_scan (char *root_path)
1115 {
1116   int i, j;
1117   svm_main_region_t *mp;
1118   svm_map_region_args_t *a = 0;
1119   svm_region_t *root_rp;
1120   svm_region_t *rp;
1121   svm_subregion_t *subp;
1122   u8 *name = 0;
1123   u8 **svm_names = 0;
1124   void *oldheap;
1125   int mypid = getpid ();
1126
1127   vec_validate (a, 0);
1128
1129   svm_region_init_chroot (root_path);
1130
1131   root_rp = svm_get_root_rp ();
1132
1133   pthread_mutex_lock (&root_rp->mutex);
1134
1135   mp = root_rp->data_base;
1136
1137   for (j = 0; j < vec_len (root_rp->client_pids); j++)
1138     {
1139       if (mypid == root_rp->client_pids[j])
1140         continue;
1141       if (root_rp->client_pids[j] && (kill (root_rp->client_pids[j], 0) < 0))
1142         {
1143           clib_warning ("%s: cleanup ghost pid %d",
1144                         root_rp->region_name, root_rp->client_pids[j]);
1145           /* nb: client vec in root_rp->region_heap */
1146           oldheap = svm_push_pvt_heap (root_rp);
1147           vec_delete (root_rp->client_pids, 1, j);
1148           j--;
1149           svm_pop_heap (oldheap);
1150         }
1151     }
1152
1153   /*
1154    * Snapshoot names, can't hold root rp mutex across
1155    * find_or_create.
1156    */
1157   /* *INDENT-OFF* */
1158   pool_foreach (subp, mp->subregions, ({
1159         name = vec_dup (subp->subregion_name);
1160         vec_add1(svm_names, name);
1161       }));
1162   /* *INDENT-ON* */
1163
1164   pthread_mutex_unlock (&root_rp->mutex);
1165
1166   for (i = 0; i < vec_len (svm_names); i++)
1167     {
1168       vec_validate (a, 0);
1169       a->root_path = root_path;
1170       a->name = (char *) svm_names[i];
1171       rp = svm_region_find_or_create (a);
1172       if (rp)
1173         {
1174           pthread_mutex_lock (&rp->mutex);
1175
1176           svm_client_scan_this_region_nolock (rp);
1177
1178           pthread_mutex_unlock (&rp->mutex);
1179           svm_region_unmap (rp);
1180           vec_free (svm_names[i]);
1181         }
1182       vec_free (a);
1183     }
1184   vec_free (svm_names);
1185
1186   svm_region_exit ();
1187
1188   vec_free (a);
1189 }
1190
1191 /*
1192  * fd.io coding-style-patch-verification: ON
1193  *
1194  * Local Variables:
1195  * eval: (c-set-style "gnu")
1196  * End:
1197  */