vlib/vlib/unix/physmem.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * physmem.c: Unix physical memory
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vlib/unix/physmem.h>
  41
  42 static physmem_main_t physmem_main;
  43
  44 static void *
  45 unix_physmem_alloc_aligned (vlib_physmem_main_t * vpm, uword n_bytes, uword alignment)
  46 {
  47   physmem_main_t * pm = &physmem_main;
  48   uword lo_offset, hi_offset;
  49   uword * to_free = 0;
  50
  51 #if DPDK > 0
  52   clib_warning ("unsafe alloc!");
  53 #endif
  54
  55   /* IO memory is always at least cache aligned. */
  56   alignment = clib_max (alignment, CLIB_CACHE_LINE_BYTES);
  57
  58   while (1)
  59     {
  60       mheap_get_aligned (pm->heap, n_bytes,
  61                          /* align */ alignment,
  62                          /* align offset */ 0,
  63                          &lo_offset);
  64
  65       /* Allocation failed? */
  66       if (lo_offset == ~0)
  67         break;
  68
  69       /* Make sure allocation does not span DMA physical chunk boundary. */
  70       hi_offset = lo_offset + n_bytes - 1;
  71
  72       if ((lo_offset >> vpm->log2_n_bytes_per_page) ==
  73           (hi_offset >> vpm->log2_n_bytes_per_page))
  74         break;
  75
  76       /* Allocation would span chunk boundary, queue it to be freed as soon as
  77          we find suitable chunk. */
  78       vec_add1 (to_free, lo_offset);
  79     }
  80
  81   if (to_free != 0)
  82     {
  83       uword i;
  84       for (i = 0; i < vec_len (to_free); i++)
  85         mheap_put (pm->heap, to_free[i]);
  86       vec_free (to_free);
  87     }
  88
  89   return lo_offset != ~0 ? pm->heap + lo_offset : 0;
  90 }
  91
  92 static void unix_physmem_free (void * x)
  93 {
  94   physmem_main_t * pm = &physmem_main;
  95
  96   /* Return object to region's heap. */
  97   mheap_put (pm->heap, x - pm->heap);
  98 }
  99
 100 static void htlb_shutdown(void)
 101 {
 102   physmem_main_t * pm = &physmem_main;
 103
 104   if (! pm->shmid)
 105     return;
 106   shmctl (pm->shmid, IPC_RMID, 0);
 107   pm->shmid = 0;
 108 }
 109
 110 /* try to use huge TLB pgs if possible */
 111 static int htlb_init (vlib_main_t * vm)
 112 {
 113   vlib_physmem_main_t * vpm = &vm->physmem_main;
 114   physmem_main_t * pm = &physmem_main;
 115   u64 hugepagesize, pagesize;
 116   u64 pfn, seek_loc;
 117   u64 cur, physaddr, ptbits;
 118   int fd, i;
 119
 120   pm->shmid = shmget (11 /* key, my amp goes to 11 */, pm->mem_size,
 121                       IPC_CREAT | SHM_HUGETLB | SHM_R | SHM_W);
 122   if (pm->shmid < 0)
 123     {
 124       clib_unix_warning ("shmget");
 125       return 0;
 126     }
 127
 128   pm->mem = shmat (pm->shmid, NULL, 0 /* flags */);
 129   if (pm->mem == 0)
 130     {
 131       shmctl (pm->shmid, IPC_RMID, 0);
 132       return 0;
 133     }
 134
 135   memset (pm->mem, 0, pm->mem_size);
 136
 137   /* $$$ get page size info from /proc/meminfo */
 138   hugepagesize = 2<<20;
 139   pagesize = 4<<10;
 140   vpm->log2_n_bytes_per_page = min_log2 (hugepagesize);
 141   vec_resize (vpm->page_table, pm->mem_size / hugepagesize);
 142
 143   vpm->page_mask = pow2_mask (vpm->log2_n_bytes_per_page);
 144   vpm->virtual.start = pointer_to_uword (pm->mem);
 145   vpm->virtual.size = pm->mem_size;
 146   vpm->virtual.end = vpm->virtual.start + vpm->virtual.size;
 147
 148   fd = open("/proc/self/pagemap", O_RDONLY);
 149
 150   if (fd < 0)
 151     {
 152       (void) shmdt (pm->mem);
 153       return 0;
 154     }
 155
 156   pm->heap = mheap_alloc_with_flags
 157     (pm->mem, pm->mem_size,
 158      /* Don't want mheap mmap/munmap with IO memory. */
 159      MHEAP_FLAG_DISABLE_VM);
 160
 161   cur = (u64) pm->mem;
 162   i = 0;
 163
 164   while (cur < (u64) pm->mem + pm->mem_size)
 165     {
 166       pfn = (u64) cur / pagesize;
 167       seek_loc = pfn * sizeof (u64);
 168       if (lseek (fd, seek_loc, SEEK_SET) != seek_loc)
 169         {
 170           clib_unix_warning ("lseek to 0x%llx", seek_loc);
 171           shmctl (pm->shmid, IPC_RMID, 0);
 172           close(fd);
 173           return 0;
 174         }
 175       if (read (fd, &ptbits, sizeof (ptbits)) != (sizeof(ptbits)))
 176         {
 177           clib_unix_warning ("read ptbits");
 178           shmctl (pm->shmid, IPC_RMID, 0);
 179           close(fd);
 180           return 0;
 181         }
 182
 183       /* bits 0-54 are the physical page number */
 184       physaddr = (ptbits & 0x7fffffffffffffULL) * pagesize;
 185       if (CLIB_DEBUG > 1)
 186         fformat(stderr, "pm: virtual 0x%llx physical 0x%llx\n",
 187                 cur, physaddr);
 188       vpm->page_table[i++] = physaddr;
 189
 190       cur += hugepagesize;
 191     }
 192   close(fd);
 193   atexit (htlb_shutdown);
 194   return 1;
 195 }
 196
 197 int vlib_app_physmem_init (vlib_main_t * vm,
 198                            physmem_main_t * pm, int) __attribute__ ((weak));
 199 int vlib_app_physmem_init (vlib_main_t * vm, physmem_main_t * pm, int x)
 200 {
 201   return 0;
 202 }
 203
 204 clib_error_t * unix_physmem_init (vlib_main_t * vm, int physical_memory_required)
 205 {
 206   vlib_physmem_main_t * vpm = &vm->physmem_main;
 207   physmem_main_t * pm = &physmem_main;
 208   clib_error_t * error = 0;
 209   char * dev_uio_dma_file = "/dev/uio-dma";
 210   int using_fake_memory = 0;
 211
 212   /* Avoid multiple calls. */
 213   if (vm->os_physmem_alloc_aligned)
 214       return error;
 215
 216   vm->os_physmem_alloc_aligned = unix_physmem_alloc_aligned;
 217   vm->os_physmem_free = unix_physmem_free;
 218   pm->mem = MAP_FAILED;
 219
 220   if (pm->mem_size == 0)
 221     pm->mem_size = 16 << 20;
 222
 223   /* OK, Mr. App, you tell us */
 224   if (vlib_app_physmem_init (vm, pm, physical_memory_required))
 225       return 0;
 226
 227   if (physical_memory_required)
 228     {
 229       if (!pm->no_hugepages && htlb_init(vm))
 230         {
 231           fformat(stderr, "%s: use huge pages\n", __FUNCTION__);
 232           return 0;
 233         }
 234       pm->uio_dma_fd = open (dev_uio_dma_file, O_RDWR);
 235     }
 236   else
 237     pm->uio_dma_fd = -1;
 238
 239   if (pm->uio_dma_fd < 0)
 240     {
 241       if (physical_memory_required)
 242         {
 243           error = clib_error_return_unix (0, "open `%s'", dev_uio_dma_file);
 244           goto done;
 245         }
 246
 247       using_fake_memory = 1;
 248       pm->mem = mmap (0, pm->mem_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
 249       if (pm->mem == MAP_FAILED)
 250         {
 251           error = clib_error_return_unix (0, "mmap");
 252           goto done;
 253         }
 254
 255       pm->heap = mheap_alloc (pm->mem, pm->mem_size);
 256
 257       /* Identity map with a single page. */
 258       vpm->log2_n_bytes_per_page = min_log2 (pm->mem_size);
 259       vec_add1 (vpm->page_table, pointer_to_uword (pm->mem));
 260     }
 261   else
 262     error = clib_error_return (0, "uio_dma deprecated");
 263
 264   if (using_fake_memory)
 265       fformat(stderr, "%s: use fake dma pages\n", __FUNCTION__);
 266   else
 267       fformat(stderr, "%s: use uio dma pages\n", __FUNCTION__);
 268
 269  done:
 270   if (error)
 271     {
 272       if (pm->mem != MAP_FAILED)
 273         munmap (pm->mem, pm->mem_size);
 274       if (pm->uio_dma_fd >= 0)
 275         {
 276           close (pm->uio_dma_fd);
 277           pm->uio_dma_fd = -1;
 278         }
 279     }
 280   return error;
 281 }
 282
 283 static clib_error_t *
 284 show_physmem (vlib_main_t * vm,
 285               unformat_input_t * input,
 286               vlib_cli_command_t * cmd)
 287 {
 288 #if DPDK > 0
 289       vlib_cli_output (vm, "Not supported with DPDK drivers.");
 290 #else
 291   physmem_main_t * pm = &physmem_main;
 292
 293   if (pm->heap)
 294       vlib_cli_output (vm, "%U", format_mheap, pm->heap, /* verbose */ 0);
 295   else
 296       vlib_cli_output (vm, "No physmem allocated.");
 297 #endif
 298   return 0;
 299 }
 300
 301 VLIB_CLI_COMMAND (show_physmem_command, static) = {
 302   .path = "show physmem",
 303   .short_help = "Show physical memory allocation",
 304   .function = show_physmem,
 305 };
 306
 307 static clib_error_t *
 308 show_affinity (vlib_main_t * vm,
 309                    unformat_input_t * input,
 310                    vlib_cli_command_t * cmd)
 311 {
 312   cpu_set_t set;
 313   cpu_set_t *setp = &set;
 314   int i, rv;
 315   u8 *s = 0;
 316   int first_set_bit_in_run = -1;
 317   int last_set_bit_in_run = -1;
 318   int output_done = 0;
 319
 320   rv = sched_getaffinity (0 /* pid, 0 = this proc */,
 321                           sizeof (*setp), setp);
 322   if (rv < 0)
 323     {
 324       vlib_cli_output (vm, "Couldn't get affinity mask: %s\n",
 325                        strerror(errno));
 326       return 0;
 327     }
 328
 329   for (i = 0; i < 64; i++)
 330     {
 331       if (CPU_ISSET(i, setp))
 332         {
 333           if (first_set_bit_in_run == -1)
 334             {
 335               first_set_bit_in_run = i;
 336               last_set_bit_in_run = i;
 337               if (output_done)
 338                 s = format (s, ",");
 339               s = format (s, "%d-", i);
 340               output_done = 1;
 341             }
 342           else
 343             {
 344               if (i == (last_set_bit_in_run+1))
 345                 last_set_bit_in_run = i;
 346             }
 347         }
 348       else
 349         {
 350           if (first_set_bit_in_run != -1)
 351             {
 352               if (first_set_bit_in_run == (i-1))
 353                 {
 354                   _vec_len (s) -= 2 + ((first_set_bit_in_run/10));
 355                 }
 356               s = format (s, "%d", last_set_bit_in_run);
 357               first_set_bit_in_run = -1;
 358               last_set_bit_in_run = -1;
 359             }
 360         }
 361     }
 362
 363   if (first_set_bit_in_run != -1)
 364     s = format (s, "%d", first_set_bit_in_run);
 365
 366   vlib_cli_output (vm, "Process runs on: %v", s);
 367   return 0;
 368 }
 369
 370 VLIB_CLI_COMMAND (show_affinity_command, static) = {
 371   .path = "show affinity",
 372   .short_help = "Show process cpu affinity",
 373   .function = show_affinity,
 374 };
 375
 376 static clib_error_t *
 377 set_affinity (vlib_main_t * vm,
 378               unformat_input_t * input,
 379               vlib_cli_command_t * cmd)
 380 {
 381   cpu_set_t set;
 382   cpu_set_t *setp = &set;
 383   int i, rv;
 384   int another_round;
 385   u32 first, last;
 386
 387   memset (setp, 0, sizeof (*setp));
 388
 389   do {
 390     another_round = 0;
 391     if (unformat (input, "%d-%d,", &first, &last))
 392       {
 393         if (first > 64 || last > 64)
 394           {
 395           barf1:
 396             vlib_cli_output (vm, "range %d-%d invalid", first, last);
 397             return 0;
 398           }
 399
 400         for (i = first; i <= last; i++)
 401           CPU_SET(i, setp);
 402         another_round = 1;
 403       }
 404     else if (unformat (input, "%d-%d", &first, &last))
 405       {
 406         if (first > 64 || last > 64)
 407             goto barf1;
 408
 409         for (i = first; i <= last; i++)
 410           CPU_SET(i, setp);
 411       }
 412     else if (unformat (input, "%d,", &first))
 413       {
 414         if (first > 64)
 415           {
 416           barf2:
 417             vlib_cli_output (vm, "cpu %d invalid", first);
 418             return 0;
 419           }
 420         CPU_SET(first, setp);
 421         another_round = 1;
 422       }
 423     else if (unformat (input, "%d", &first))
 424       {
 425         if (first > 64)
 426           goto barf2;
 427
 428         CPU_SET(first, setp);
 429       }
 430   } while (another_round);
 431
 432   rv = sched_setaffinity (0 /* pid, 0 = this proc */,
 433                           sizeof (*setp), setp);
 434
 435   if (rv < 0)
 436     {
 437       vlib_cli_output (vm, "Couldn't get affinity mask: %s\n",
 438                        strerror(errno));
 439       return 0;
 440     }
 441   return show_affinity (vm, input, cmd);
 442 }
 443
 444 VLIB_CLI_COMMAND (set_affinity_command, static) = {
 445   .path = "set affinity",
 446   .short_help = "Set process cpu affinity",
 447   .function = set_affinity,
 448 };
 449
 450 static clib_error_t *
 451 vlib_physmem_configure (vlib_main_t * vm, unformat_input_t * input)
 452 {
 453   physmem_main_t * pm = &physmem_main;
 454   u32 size_in_mb;
 455
 456   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 457     {
 458       if (unformat (input, "no-huge") || unformat (input, "no-huge-pages"))
 459         pm->no_hugepages = 1;
 460
 461       else if (unformat(input, "size-in-mb %d", &size_in_mb) ||
 462                unformat(input, "size %d", &size_in_mb))
 463         pm->mem_size = size_in_mb << 20;
 464       else
 465         return unformat_parse_error (input);
 466     }
 467
 468   unformat_free (input);
 469   return 0;
 470 }
 471
 472 VLIB_EARLY_CONFIG_FUNCTION (vlib_physmem_configure, "physmem");