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