src/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 u64
 220 rnd_pagesize (u64 size)
 221 {
 222   u64 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 +
 239                                  (a->pvt_heap_size ? a->pvt_heap_size :
 240                                   SVM_PVT_MHEAP_SIZE));
 241
 242   if (a->flags & SVM_FLAGS_FILE)
 243     {
 244       struct stat statb;
 245
 246       fd = open (a->backing_file, O_RDWR | O_CREAT, 0777);
 247
 248       if (fd < 0)
 249         {
 250           clib_unix_warning ("open");
 251           return -1;
 252         }
 253
 254       if (fstat (fd, &statb) < 0)
 255         {
 256           clib_unix_warning ("fstat");
 257           close (fd);
 258           return -2;
 259         }
 260
 261       if (statb.st_mode & S_IFREG)
 262         {
 263           if (statb.st_size == 0)
 264             {
 265               if (lseek (fd, map_size, SEEK_SET) == (off_t) - 1)
 266                 {
 267                   clib_unix_warning ("seek region size");
 268                   close (fd);
 269                   return -3;
 270                 }
 271               if (write (fd, &junk, 1) != 1)
 272                 {
 273                   clib_unix_warning ("set region size");
 274                   close (fd);
 275                   return -3;
 276                 }
 277             }
 278           else
 279             {
 280               map_size = rnd_pagesize (statb.st_size);
 281             }
 282         }
 283       else
 284         {
 285           map_size = a->backing_mmap_size;
 286         }
 287
 288       ASSERT (map_size <= rp->virtual_size -
 289               (MMAP_PAGESIZE + SVM_PVT_MHEAP_SIZE));
 290
 291       if (mmap (rp->data_base, map_size, PROT_READ | PROT_WRITE,
 292                 MAP_SHARED | MAP_FIXED, fd, 0) == MAP_FAILED)
 293         {
 294           clib_unix_warning ("mmap");
 295           close (fd);
 296           return -3;
 297         }
 298       close (fd);
 299       rp->backing_file = (char *) format (0, "%s\0", a->backing_file);
 300       rp->flags |= SVM_FLAGS_FILE;
 301     }
 302
 303   if (a->flags & SVM_FLAGS_MHEAP)
 304     {
 305       rp->data_heap =
 306         mheap_alloc_with_flags ((void *) (rp->data_base), map_size,
 307                                 MHEAP_FLAG_DISABLE_VM);
 308       rp->flags |= SVM_FLAGS_MHEAP;
 309     }
 310   return 0;
 311 }
 312
 313 static int
 314 svm_data_region_map (svm_map_region_args_t * a, svm_region_t * rp)
 315 {
 316   int fd;
 317   u8 junk = 0;
 318   uword map_size;
 319   struct stat statb;
 320
 321   map_size = rp->virtual_size -
 322     (MMAP_PAGESIZE
 323      + (a->pvt_heap_size ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE));
 324
 325   if (a->flags & SVM_FLAGS_FILE)
 326     {
 327
 328       fd = open (a->backing_file, O_RDWR, 0777);
 329
 330       if (fd < 0)
 331         {
 332           clib_unix_warning ("open");
 333           return -1;
 334         }
 335
 336       if (fstat (fd, &statb) < 0)
 337         {
 338           clib_unix_warning ("fstat");
 339           close (fd);
 340           return -2;
 341         }
 342
 343       if (statb.st_mode & S_IFREG)
 344         {
 345           if (statb.st_size == 0)
 346             {
 347               if (lseek (fd, map_size, SEEK_SET) == (off_t) - 1)
 348                 {
 349                   clib_unix_warning ("seek region size");
 350                   close (fd);
 351                   return -3;
 352                 }
 353               if (write (fd, &junk, 1) != 1)
 354                 {
 355                   clib_unix_warning ("set region size");
 356                   close (fd);
 357                   return -3;
 358                 }
 359             }
 360           else
 361             {
 362               map_size = rnd_pagesize (statb.st_size);
 363             }
 364         }
 365       else
 366         {
 367           map_size = a->backing_mmap_size;
 368         }
 369
 370       ASSERT (map_size <= rp->virtual_size
 371               - (MMAP_PAGESIZE
 372                  +
 373                  (a->pvt_heap_size ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE)));
 374
 375       if (mmap (rp->data_base, map_size, PROT_READ | PROT_WRITE,
 376                 MAP_SHARED | MAP_FIXED, fd, 0) == MAP_FAILED)
 377         {
 378           clib_unix_warning ("mmap");
 379           close (fd);
 380           return -3;
 381         }
 382       close (fd);
 383     }
 384   return 0;
 385 }
 386
 387 u8 *
 388 shm_name_from_svm_map_region_args (svm_map_region_args_t * a)
 389 {
 390   u8 *path;
 391   u8 *shm_name;
 392   u8 *split_point;
 393   u8 *mkdir_arg = 0;
 394   int root_path_offset = 0;
 395   int name_offset = 0;
 396
 397   if (a->root_path)
 398     {
 399       /* Tolerate present or absent slashes */
 400       if (a->root_path[0] == '/')
 401         root_path_offset++;
 402
 403       /* create the root_path under /dev/shm
 404          iterate through path creating directories */
 405
 406       path = format (0, "/dev/shm/%s%c", &a->root_path[root_path_offset], 0);
 407       split_point = path + 1;
 408       vec_add1 (mkdir_arg, '-');
 409
 410       while (*split_point)
 411         {
 412           while (*split_point && *split_point != '/')
 413             {
 414               vec_add1 (mkdir_arg, *split_point);
 415               split_point++;
 416             }
 417           vec_add1 (mkdir_arg, 0);
 418
 419           /* ready to descend another level */
 420           mkdir_arg[vec_len (mkdir_arg) - 1] = '-';
 421           split_point++;
 422         }
 423       vec_free (mkdir_arg);
 424       vec_free (path);
 425
 426       if (a->name[0] == '/')
 427         name_offset = 1;
 428
 429       shm_name = format (0, "/%s-%s%c", a->root_path,
 430                          &a->name[name_offset], 0);
 431     }
 432   else
 433     shm_name = format (0, "%s%c", a->name, 0);
 434   return (shm_name);
 435 }
 436
 437 /*
 438  * svm_map_region
 439  */
 440 void *
 441 svm_map_region (svm_map_region_args_t * a)
 442 {
 443   int svm_fd;
 444   svm_region_t *rp;
 445   pthread_mutexattr_t attr;
 446   pthread_condattr_t cattr;
 447   int deadman = 0;
 448   u8 junk = 0;
 449   void *oldheap;
 450   int overhead_space;
 451   int rv;
 452   uword data_base;
 453   int nbits, words, bit;
 454   int pid_holding_region_lock;
 455   u8 *shm_name;
 456   int dead_region_recovery = 0;
 457   int time_left;
 458   struct stat stat;
 459   struct timespec ts, tsrem;
 460
 461   if (CLIB_DEBUG > 1)
 462     clib_warning ("[%d] map region %s", getpid (), a->name);
 463
 464   ASSERT ((a->size & ~(MMAP_PAGESIZE - 1)) == a->size);
 465   ASSERT (a->name);
 466
 467   shm_name = shm_name_from_svm_map_region_args (a);
 468
 469   svm_fd = shm_open ((char *) shm_name, O_RDWR | O_CREAT | O_EXCL, 0777);
 470
 471   if (svm_fd >= 0)
 472     {
 473       if (fchmod (svm_fd, 0770) < 0)
 474         clib_unix_warning ("segment chmod");
 475       /* This turns out to fail harmlessly if the client starts first */
 476       if (fchown (svm_fd, a->uid, a->gid) < 0)
 477         clib_unix_warning ("segment chown [ok if client starts first]");
 478
 479       vec_free (shm_name);
 480
 481       if (lseek (svm_fd, a->size, SEEK_SET) == (off_t) - 1)
 482         {
 483           clib_warning ("seek region size");
 484           close (svm_fd);
 485           return (0);
 486         }
 487       if (write (svm_fd, &junk, 1) != 1)
 488         {
 489           clib_warning ("set region size");
 490           close (svm_fd);
 491           return (0);
 492         }
 493
 494       rp = mmap (uword_to_pointer (a->baseva, void *), a->size,
 495                  PROT_READ | PROT_WRITE, MAP_SHARED | MAP_FIXED, svm_fd, 0);
 496
 497       if (rp == (svm_region_t *) MAP_FAILED)
 498         {
 499           clib_unix_warning ("mmap create");
 500           close (svm_fd);
 501           return (0);
 502         }
 503       close (svm_fd);
 504       memset (rp, 0, sizeof (*rp));
 505
 506       if (pthread_mutexattr_init (&attr))
 507         clib_unix_warning ("mutexattr_init");
 508
 509       if (pthread_mutexattr_setpshared (&attr, PTHREAD_PROCESS_SHARED))
 510         clib_unix_warning ("mutexattr_setpshared");
 511
 512       if (pthread_mutex_init (&rp->mutex, &attr))
 513         clib_unix_warning ("mutex_init");
 514
 515       if (pthread_mutexattr_destroy (&attr))
 516         clib_unix_warning ("mutexattr_destroy");
 517
 518       if (pthread_condattr_init (&cattr))
 519         clib_unix_warning ("condattr_init");
 520
 521       if (pthread_condattr_setpshared (&cattr, PTHREAD_PROCESS_SHARED))
 522         clib_unix_warning ("condattr_setpshared");
 523
 524       if (pthread_cond_init (&rp->condvar, &cattr))
 525         clib_unix_warning ("cond_init");
 526
 527       if (pthread_condattr_destroy (&cattr))
 528         clib_unix_warning ("condattr_destroy");
 529
 530       region_lock (rp, 1);
 531
 532       rp->virtual_base = a->baseva;
 533       rp->virtual_size = a->size;
 534
 535       rp->region_heap =
 536         mheap_alloc_with_flags (uword_to_pointer
 537                                 (a->baseva + MMAP_PAGESIZE, void *),
 538                                 (a->pvt_heap_size !=
 539                                  0) ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE,
 540                                 MHEAP_FLAG_DISABLE_VM);
 541       oldheap = svm_push_pvt_heap (rp);
 542
 543       rp->region_name = (char *) format (0, "%s%c", a->name, 0);
 544       vec_add1 (rp->client_pids, getpid ());
 545
 546       nbits = rp->virtual_size / MMAP_PAGESIZE;
 547
 548       ASSERT (nbits > 0);
 549       rp->bitmap_size = nbits;
 550       words = (nbits + BITS (uword) - 1) / BITS (uword);
 551       vec_validate (rp->bitmap, words - 1);
 552
 553       overhead_space = MMAP_PAGESIZE /* header */  +
 554         ((a->pvt_heap_size != 0) ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE);
 555
 556       bit = 0;
 557       data_base = (uword) rp->virtual_base;
 558
 559       if (a->flags & SVM_FLAGS_NODATA)
 560         rp->flags |= SVM_FLAGS_NEED_DATA_INIT;
 561
 562       do
 563         {
 564           clib_bitmap_set_no_check (rp->bitmap, bit, 1);
 565           bit++;
 566           overhead_space -= MMAP_PAGESIZE;
 567           data_base += MMAP_PAGESIZE;
 568         }
 569       while (overhead_space > 0);
 570
 571       rp->data_base = (void *) data_base;
 572
 573       /*
 574        * Note: although the POSIX spec guarantees that only one
 575        * process enters this block, we have to play games
 576        * to hold off clients until e.g. the mutex is ready
 577        */
 578       rp->version = SVM_VERSION;
 579
 580       /* setup the data portion of the region */
 581
 582       rv = svm_data_region_create (a, rp);
 583       if (rv)
 584         {
 585           clib_warning ("data_region_create: %d", rv);
 586         }
 587
 588       region_unlock (rp);
 589
 590       svm_pop_heap (oldheap);
 591
 592       return ((void *) rp);
 593     }
 594   else
 595     {
 596       svm_fd = shm_open ((char *) shm_name, O_RDWR, 0777);
 597
 598       vec_free (shm_name);
 599
 600       if (svm_fd < 0)
 601         {
 602           perror ("svm_region_map(mmap open)");
 603           return (0);
 604         }
 605
 606       time_left = 20;
 607       while (1)
 608         {
 609           if (0 != fstat (svm_fd, &stat))
 610             {
 611               clib_warning ("fstat failed: %d", errno);
 612               close (svm_fd);
 613               return (0);
 614             }
 615           if (stat.st_size > 0)
 616             {
 617               break;
 618             }
 619           if (0 == time_left)
 620             {
 621               clib_warning ("waiting for resize of shm file timed out");
 622               close (svm_fd);
 623               return (0);
 624             }
 625           ts.tv_sec = 0;
 626           ts.tv_nsec = 100000000;
 627           while (nanosleep (&ts, &tsrem) < 0)
 628             ts = tsrem;
 629           time_left--;
 630         }
 631
 632       rp = mmap (0, MMAP_PAGESIZE,
 633                  PROT_READ | PROT_WRITE, MAP_SHARED, svm_fd, 0);
 634
 635       if (rp == (svm_region_t *) MAP_FAILED)
 636         {
 637           close (svm_fd);
 638           clib_warning ("mmap");
 639           return (0);
 640         }
 641       /*
 642        * We lost the footrace to create this region; make sure
 643        * the winner has crossed the finish line.
 644        */
 645       while (rp->version == 0 && deadman++ < 5)
 646         {
 647           sleep (1);
 648         }
 649
 650       /*
 651        * <bleep>-ed?
 652        */
 653       if (rp->version == 0)
 654         {
 655           clib_warning ("rp->version %d not %d", rp->version, SVM_VERSION);
 656           close (svm_fd);
 657           munmap (rp, a->size);
 658           return (0);
 659         }
 660       /* Remap now that the region has been placed */
 661       a->baseva = rp->virtual_base;
 662       a->size = rp->virtual_size;
 663       munmap (rp, MMAP_PAGESIZE);
 664
 665       rp = (void *) mmap (uword_to_pointer (a->baseva, void *), a->size,
 666                           PROT_READ | PROT_WRITE,
 667                           MAP_SHARED | MAP_FIXED, svm_fd, 0);
 668       if ((uword) rp == (uword) MAP_FAILED)
 669         {
 670           clib_unix_warning ("mmap");
 671           close (svm_fd);
 672           return (0);
 673         }
 674
 675       if ((uword) rp != rp->virtual_base)
 676         {
 677           clib_warning ("mmap botch");
 678         }
 679
 680       /*
 681        * Try to fix the region mutex if it is held by
 682        * a dead process
 683        */
 684       pid_holding_region_lock = rp->mutex_owner_pid;
 685       if (pid_holding_region_lock && kill (pid_holding_region_lock, 0) < 0)
 686         {
 687           clib_warning
 688             ("region %s mutex held by dead pid %d, tag %d, force unlock",
 689              rp->region_name, pid_holding_region_lock, rp->mutex_owner_tag);
 690           /* owner pid is nonexistent */
 691           rp->mutex.__data.__owner = 0;
 692           rp->mutex.__data.__lock = 0;
 693           dead_region_recovery = 1;
 694         }
 695
 696       if (dead_region_recovery)
 697         clib_warning ("recovery: attempt to re-lock region");
 698
 699       region_lock (rp, 2);
 700       oldheap = svm_push_pvt_heap (rp);
 701       vec_add1 (rp->client_pids, getpid ());
 702
 703       if (dead_region_recovery)
 704         clib_warning ("recovery: attempt svm_data_region_map");
 705
 706       rv = svm_data_region_map (a, rp);
 707       if (rv)
 708         {
 709           clib_warning ("data_region_map: %d", rv);
 710         }
 711
 712       if (dead_region_recovery)
 713         clib_warning ("unlock and continue");
 714
 715       region_unlock (rp);
 716
 717       svm_pop_heap (oldheap);
 718
 719       return ((void *) rp);
 720
 721     }
 722   return 0;                     /* NOTREACHED */
 723 }
 724
 725 static void
 726 svm_mutex_cleanup (void)
 727 {
 728   int i;
 729   for (i = 0; i < nheld; i++)
 730     {
 731       pthread_mutex_unlock (mutexes_held[i]);
 732     }
 733 }
 734
 735 static void
 736 svm_region_init_internal (svm_map_region_args_t * a)
 737 {
 738   svm_region_t *rp;
 739   u64 ticks = clib_cpu_time_now ();
 740   uword randomize_baseva;
 741
 742   /* guard against klutz calls */
 743   if (root_rp)
 744     return;
 745
 746   root_rp_refcount++;
 747
 748   atexit (svm_mutex_cleanup);
 749
 750   /* Randomize the shared-VM base at init time */
 751   if (MMAP_PAGESIZE <= (4 << 10))
 752     randomize_baseva = (ticks & 15) * MMAP_PAGESIZE;
 753   else
 754     randomize_baseva = (ticks & 3) * MMAP_PAGESIZE;
 755
 756   a->baseva += randomize_baseva;
 757
 758   rp = svm_map_region (a);
 759   ASSERT (rp);
 760
 761   region_lock (rp, 3);
 762
 763   /* Set up the main region data structures */
 764   if (rp->flags & SVM_FLAGS_NEED_DATA_INIT)
 765     {
 766       svm_main_region_t *mp = 0;
 767       void *oldheap;
 768
 769       rp->flags &= ~(SVM_FLAGS_NEED_DATA_INIT);
 770
 771       oldheap = svm_push_pvt_heap (rp);
 772       vec_validate (mp, 0);
 773       mp->name_hash = hash_create_string (0, sizeof (uword));
 774       mp->root_path = a->root_path ? format (0, "%s%c", a->root_path, 0) : 0;
 775       rp->data_base = mp;
 776       svm_pop_heap (oldheap);
 777     }
 778   region_unlock (rp);
 779   root_rp = rp;
 780 }
 781
 782 void
 783 svm_region_init (void)
 784 {
 785   svm_map_region_args_t _a, *a = &_a;
 786
 787   memset (a, 0, sizeof (*a));
 788   a->root_path = 0;
 789   a->name = SVM_GLOBAL_REGION_NAME;
 790   a->baseva = SVM_GLOBAL_REGION_BASEVA;
 791   a->size = SVM_GLOBAL_REGION_SIZE;
 792   a->flags = SVM_FLAGS_NODATA;
 793   a->uid = 0;
 794   a->gid = 0;
 795
 796   svm_region_init_internal (a);
 797 }
 798
 799 void
 800 svm_region_init_chroot (const char *root_path)
 801 {
 802   svm_map_region_args_t _a, *a = &_a;
 803
 804   memset (a, 0, sizeof (*a));
 805   a->root_path = root_path;
 806   a->name = SVM_GLOBAL_REGION_NAME;
 807   a->baseva = SVM_GLOBAL_REGION_BASEVA;
 808   a->size = SVM_GLOBAL_REGION_SIZE;
 809   a->flags = SVM_FLAGS_NODATA;
 810   a->uid = 0;
 811   a->gid = 0;
 812
 813   svm_region_init_internal (a);
 814 }
 815
 816 void
 817 svm_region_init_chroot_uid_gid (const char *root_path, int uid, int gid)
 818 {
 819   svm_map_region_args_t _a, *a = &_a;
 820
 821   memset (a, 0, sizeof (*a));
 822   a->root_path = root_path;
 823   a->name = SVM_GLOBAL_REGION_NAME;
 824   a->baseva = SVM_GLOBAL_REGION_BASEVA;
 825   a->size = SVM_GLOBAL_REGION_SIZE;
 826   a->flags = SVM_FLAGS_NODATA;
 827   a->uid = uid;
 828   a->gid = gid;
 829
 830   svm_region_init_internal (a);
 831 }
 832
 833 void
 834 svm_region_init_args (svm_map_region_args_t * a)
 835 {
 836   svm_region_init_internal (a);
 837 }
 838
 839 void *
 840 svm_region_find_or_create (svm_map_region_args_t * a)
 841 {
 842   svm_main_region_t *mp;
 843   svm_region_t *rp;
 844   uword need_nbits;
 845   int index, i;
 846   void *oldheap;
 847   uword *p;
 848   u8 *name;
 849   svm_subregion_t *subp;
 850
 851   ASSERT (root_rp);
 852
 853   a->size += MMAP_PAGESIZE +
 854     ((a->pvt_heap_size != 0) ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE);
 855   a->size = rnd_pagesize (a->size);
 856
 857   region_lock (root_rp, 4);
 858   oldheap = svm_push_pvt_heap (root_rp);
 859   mp = root_rp->data_base;
 860
 861   ASSERT (mp);
 862
 863   /* Map the named region from the correct chroot environment */
 864   a->root_path = (char *) mp->root_path;
 865
 866   /*
 867    * See if this region is already known. If it is, we're
 868    * almost done...
 869    */
 870   p = hash_get_mem (mp->name_hash, a->name);
 871
 872   if (p)
 873     {
 874       rp = svm_map_region (a);
 875       region_unlock (root_rp);
 876       svm_pop_heap (oldheap);
 877       return rp;
 878     }
 879
 880   /* Create the region. */
 881   ASSERT ((a->size & ~(MMAP_PAGESIZE - 1)) == a->size);
 882
 883   need_nbits = a->size / MMAP_PAGESIZE;
 884
 885   index = 1;                    /* $$$ fixme, figure out how many bit to really skip */
 886
 887   /*
 888    * Scan the virtual space allocation bitmap, looking for a large
 889    * enough chunk
 890    */
 891   do
 892     {
 893       if (clib_bitmap_get_no_check (root_rp->bitmap, index) == 0)
 894         {
 895           for (i = 0; i < (need_nbits - 1); i++)
 896             {
 897               if (clib_bitmap_get_no_check (root_rp->bitmap, index + i) == 1)
 898                 {
 899                   index = index + i;
 900                   goto next;
 901                 }
 902             }
 903           break;
 904         }
 905       index++;
 906     next:;
 907     }
 908   while (index < root_rp->bitmap_size);
 909
 910   /* Completely out of VM? */
 911   if (index >= root_rp->bitmap_size)
 912     {
 913       clib_warning ("region %s: not enough VM to allocate 0x%llx (%lld)",
 914                     root_rp->region_name, a->size, a->size);
 915       svm_pop_heap (oldheap);
 916       region_unlock (root_rp);
 917       return 0;
 918     }
 919
 920   /*
 921    * Mark virtual space allocated
 922    */
 923 #if CLIB_DEBUG > 1
 924   clib_warning ("set %d bits at index %d", need_nbits, index);
 925 #endif
 926
 927   for (i = 0; i < need_nbits; i++)
 928     {
 929       clib_bitmap_set_no_check (root_rp->bitmap, index + i, 1);
 930     }
 931
 932   /* Place this region where it goes... */
 933   a->baseva = root_rp->virtual_base + index * MMAP_PAGESIZE;
 934
 935   rp = svm_map_region (a);
 936
 937   pool_get (mp->subregions, subp);
 938   name = format (0, "%s%c", a->name, 0);
 939   subp->subregion_name = name;
 940
 941   hash_set_mem (mp->name_hash, name, subp - mp->subregions);
 942
 943   svm_pop_heap (oldheap);
 944
 945   region_unlock (root_rp);
 946
 947   return (rp);
 948 }
 949
 950 /*
 951  * svm_region_unmap
 952  *
 953  * Let go of the indicated region. If the calling process
 954  * is the last customer, throw it away completely.
 955  * The root region mutex guarantees atomicity with respect to
 956  * a new region client showing up at the wrong moment.
 957  */
 958 void
 959 svm_region_unmap (void *rp_arg)
 960 {
 961   int i, mypid = getpid ();
 962   int nclients_left;
 963   void *oldheap;
 964   uword virtual_base, virtual_size;
 965   svm_region_t *rp = rp_arg;
 966   char *name;
 967
 968   /*
 969    * If we take a signal while holding one or more shared-memory
 970    * mutexes, we may end up back here from an otherwise
 971    * benign exit handler. Bail out to avoid a recursive
 972    * mutex screw-up.
 973    */
 974   if (nheld)
 975     return;
 976
 977   ASSERT (rp);
 978   ASSERT (root_rp);
 979
 980   if (CLIB_DEBUG > 1)
 981     clib_warning ("[%d] unmap region %s", getpid (), rp->region_name);
 982
 983   region_lock (root_rp, 5);
 984   region_lock (rp, 6);
 985
 986   oldheap = svm_push_pvt_heap (rp);     /* nb vec_delete() in the loop */
 987
 988   /* Remove the caller from the list of mappers */
 989   for (i = 0; i < vec_len (rp->client_pids); i++)
 990     {
 991       if (rp->client_pids[i] == mypid)
 992         {
 993           vec_delete (rp->client_pids, 1, i);
 994           goto found;
 995         }
 996     }
 997   clib_warning ("pid %d AWOL", mypid);
 998
 999 found:
1000
1001   svm_pop_heap (oldheap);
1002
1003   nclients_left = vec_len (rp->client_pids);
1004   virtual_base = rp->virtual_base;
1005   virtual_size = rp->virtual_size;
1006
1007   if (nclients_left == 0)
1008     {
1009       int index, nbits, i;
1010       svm_main_region_t *mp;
1011       uword *p;
1012       svm_subregion_t *subp;
1013
1014       /* Kill the region, last guy on his way out */
1015
1016       oldheap = svm_push_pvt_heap (root_rp);
1017       name = vec_dup (rp->region_name);
1018
1019       virtual_base = rp->virtual_base;
1020       virtual_size = rp->virtual_size;
1021
1022       /* Figure out which bits to clear in the root region bitmap */
1023       index = (virtual_base - root_rp->virtual_base) / MMAP_PAGESIZE;
1024
1025       nbits = (virtual_size + MMAP_PAGESIZE - 1) / MMAP_PAGESIZE;
1026
1027 #if CLIB_DEBUG > 1
1028       clib_warning ("clear %d bits at index %d", nbits, index);
1029 #endif
1030       /* Give back the allocated VM */
1031       for (i = 0; i < nbits; i++)
1032         {
1033           clib_bitmap_set_no_check (root_rp->bitmap, index + i, 0);
1034         }
1035
1036       mp = root_rp->data_base;
1037
1038       p = hash_get_mem (mp->name_hash, name);
1039
1040       /* Better never happen ... */
1041       if (p == NULL)
1042         {
1043           region_unlock (rp);
1044           region_unlock (root_rp);
1045           svm_pop_heap (oldheap);
1046           clib_warning ("Region name '%s' not found?", name);
1047           return;
1048         }
1049
1050       /* Remove from the root region subregion pool */
1051       subp = mp->subregions + p[0];
1052       pool_put (mp->subregions, subp);
1053
1054       hash_unset_mem (mp->name_hash, name);
1055
1056       vec_free (name);
1057
1058       region_unlock (rp);
1059       shm_unlink (rp->region_name);
1060       munmap ((void *) virtual_base, virtual_size);
1061       region_unlock (root_rp);
1062       svm_pop_heap (oldheap);
1063       return;
1064     }
1065
1066   region_unlock (rp);
1067   region_unlock (root_rp);
1068
1069   munmap ((void *) virtual_base, virtual_size);
1070 }
1071
1072 /*
1073  * svm_region_exit
1074  * There is no clean way to unlink the
1075  * root region when all clients go away,
1076  * so remove the pid entry and call it a day.
1077  */
1078 void
1079 svm_region_exit ()
1080 {
1081   void *oldheap;
1082   int i, mypid = getpid ();
1083   uword virtual_base, virtual_size;
1084
1085   /* It felt so nice we did it twice... */
1086   if (root_rp == 0)
1087     return;
1088
1089   if (--root_rp_refcount > 0)
1090     return;
1091
1092   /*
1093    * If we take a signal while holding one or more shared-memory
1094    * mutexes, we may end up back here from an otherwise
1095    * benign exit handler. Bail out to avoid a recursive
1096    * mutex screw-up.
1097    */
1098   if (nheld)
1099     return;
1100
1101   region_lock (root_rp, 7);
1102   oldheap = svm_push_pvt_heap (root_rp);
1103
1104   virtual_base = root_rp->virtual_base;
1105   virtual_size = root_rp->virtual_size;
1106
1107   for (i = 0; i < vec_len (root_rp->client_pids); i++)
1108     {
1109       if (root_rp->client_pids[i] == mypid)
1110         {
1111           vec_delete (root_rp->client_pids, 1, i);
1112           goto found;
1113         }
1114     }
1115   clib_warning ("pid %d AWOL", mypid);
1116
1117 found:
1118
1119   region_unlock (root_rp);
1120   svm_pop_heap (oldheap);
1121
1122   root_rp = 0;
1123   munmap ((void *) virtual_base, virtual_size);
1124 }
1125
1126 void
1127 svm_client_scan_this_region_nolock (svm_region_t * rp)
1128 {
1129   int j;
1130   int mypid = getpid ();
1131   void *oldheap;
1132
1133   for (j = 0; j < vec_len (rp->client_pids); j++)
1134     {
1135       if (mypid == rp->client_pids[j])
1136         continue;
1137       if (rp->client_pids[j] && (kill (rp->client_pids[j], 0) < 0))
1138         {
1139           clib_warning ("%s: cleanup ghost pid %d",
1140                         rp->region_name, rp->client_pids[j]);
1141           /* nb: client vec in rp->region_heap */
1142           oldheap = svm_push_pvt_heap (rp);
1143           vec_delete (rp->client_pids, 1, j);
1144           j--;
1145           svm_pop_heap (oldheap);
1146         }
1147     }
1148 }
1149
1150
1151 /*
1152  * Scan svm regions for dead clients
1153  */
1154 void
1155 svm_client_scan (const char *root_path)
1156 {
1157   int i, j;
1158   svm_main_region_t *mp;
1159   svm_map_region_args_t *a = 0;
1160   svm_region_t *root_rp;
1161   svm_region_t *rp;
1162   svm_subregion_t *subp;
1163   u8 *name = 0;
1164   u8 **svm_names = 0;
1165   void *oldheap;
1166   int mypid = getpid ();
1167
1168   vec_validate (a, 0);
1169
1170   svm_region_init_chroot (root_path);
1171
1172   root_rp = svm_get_root_rp ();
1173
1174   pthread_mutex_lock (&root_rp->mutex);
1175
1176   mp = root_rp->data_base;
1177
1178   for (j = 0; j < vec_len (root_rp->client_pids); j++)
1179     {
1180       if (mypid == root_rp->client_pids[j])
1181         continue;
1182       if (root_rp->client_pids[j] && (kill (root_rp->client_pids[j], 0) < 0))
1183         {
1184           clib_warning ("%s: cleanup ghost pid %d",
1185                         root_rp->region_name, root_rp->client_pids[j]);
1186           /* nb: client vec in root_rp->region_heap */
1187           oldheap = svm_push_pvt_heap (root_rp);
1188           vec_delete (root_rp->client_pids, 1, j);
1189           j--;
1190           svm_pop_heap (oldheap);
1191         }
1192     }
1193
1194   /*
1195    * Snapshoot names, can't hold root rp mutex across
1196    * find_or_create.
1197    */
1198   /* *INDENT-OFF* */
1199   pool_foreach (subp, mp->subregions, ({
1200         name = vec_dup (subp->subregion_name);
1201         vec_add1(svm_names, name);
1202       }));
1203   /* *INDENT-ON* */
1204
1205   pthread_mutex_unlock (&root_rp->mutex);
1206
1207   for (i = 0; i < vec_len (svm_names); i++)
1208     {
1209       vec_validate (a, 0);
1210       a->root_path = root_path;
1211       a->name = (char *) svm_names[i];
1212       rp = svm_region_find_or_create (a);
1213       if (rp)
1214         {
1215           pthread_mutex_lock (&rp->mutex);
1216
1217           svm_client_scan_this_region_nolock (rp);
1218
1219           pthread_mutex_unlock (&rp->mutex);
1220           svm_region_unmap (rp);
1221           vec_free (svm_names[i]);
1222         }
1223       vec_free (a);
1224     }
1225   vec_free (svm_names);
1226
1227   svm_region_exit ();
1228
1229   vec_free (a);
1230 }
1231
1232 /*
1233  * fd.io coding-style-patch-verification: ON
1234  *
1235  * Local Variables:
1236  * eval: (c-set-style "gnu")
1237  * End:
1238  */