src/vppinfra/linux/mem.c

   1 /*
   2  * Copyright (c) 2017 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 #define _GNU_SOURCE
  17 #include <stdlib.h>
  18 #include <sys/types.h>
  19 #include <sys/stat.h>
  20 #include <unistd.h>
  21 #include <sys/mount.h>
  22 #include <sys/mman.h>
  23 #include <fcntl.h>
  24 #include <linux/mempolicy.h>
  25 #include <linux/memfd.h>
  26
  27 #include <vppinfra/clib.h>
  28 #include <vppinfra/mem.h>
  29 #include <vppinfra/time.h>
  30 #include <vppinfra/format.h>
  31 #include <vppinfra/clib_error.h>
  32 #include <vppinfra/linux/syscall.h>
  33 #include <vppinfra/linux/sysfs.h>
  34
  35 #ifndef F_LINUX_SPECIFIC_BASE
  36 #define F_LINUX_SPECIFIC_BASE 1024
  37 #endif
  38
  39 #ifndef F_ADD_SEALS
  40 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
  41 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
  42
  43 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
  44 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
  45 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
  46 #define F_SEAL_WRITE    0x0008  /* prevent writes */
  47 #endif
  48
  49 u64
  50 clib_mem_vm_get_page_size (int fd)
  51 {
  52   struct stat st = { 0 };
  53   if (fstat (fd, &st) == -1)
  54     return 0;
  55   return st.st_blksize;
  56 }
  57
  58 int
  59 clib_mem_vm_get_log2_page_size (int fd)
  60 {
  61   return min_log2 (clib_mem_vm_get_page_size (fd));
  62 }
  63
  64 void
  65 clib_mem_vm_randomize_va (uword * requested_va, u32 log2_page_size)
  66 {
  67   u8 bit_mask = 15;
  68
  69   if (log2_page_size <= 12)
  70     bit_mask = 15;
  71   else if (log2_page_size > 12 && log2_page_size <= 16)
  72     bit_mask = 3;
  73   else
  74     bit_mask = 0;
  75
  76   *requested_va +=
  77     (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
  78 }
  79
  80 #ifndef MFD_HUGETLB
  81 #define MFD_HUGETLB 0x0004U
  82 #endif
  83
  84 clib_error_t *
  85 clib_mem_create_hugetlb_fd (char *name, int *fdp)
  86 {
  87   clib_error_t *err = 0;
  88   int fd = -1;
  89   static int memfd_hugetlb_supported = 1;
  90   char *mount_dir;
  91   char template[] = "/tmp/hugepage_mount.XXXXXX";
  92   u8 *filename;
  93
  94   ASSERT (name);
  95
  96   if (memfd_hugetlb_supported)
  97     {
  98       if ((fd = memfd_create (name, MFD_HUGETLB)) != -1)
  99         goto done;
 100
 101       /* avoid further tries if memfd MFD_HUGETLB is not supported */
 102       if (errno == EINVAL && strnlen (name, 256) <= 249)
 103         memfd_hugetlb_supported = 0;
 104     }
 105
 106   mount_dir = mkdtemp (template);
 107   if (mount_dir == 0)
 108     return clib_error_return_unix (0, "mkdtemp \'%s\'", template);
 109
 110   if (mount ("none", (char *) mount_dir, "hugetlbfs", 0, NULL))
 111     {
 112       rmdir ((char *) mount_dir);
 113       err = clib_error_return_unix (0, "mount hugetlb directory '%s'",
 114                                     mount_dir);
 115     }
 116
 117   filename = format (0, "%s/%s%c", mount_dir, name, 0);
 118   fd = open ((char *) filename, O_CREAT | O_RDWR, 0755);
 119   umount2 ((char *) mount_dir, MNT_DETACH);
 120   rmdir ((char *) mount_dir);
 121
 122   if (fd == -1)
 123     err = clib_error_return_unix (0, "open");
 124
 125 done:
 126   if (fd != -1)
 127     fdp[0] = fd;
 128   return err;
 129 }
 130
 131 clib_error_t *
 132 clib_mem_vm_ext_alloc (clib_mem_vm_alloc_t * a)
 133 {
 134   int fd = -1;
 135   clib_error_t *err = 0;
 136   void *addr = 0;
 137   u8 *filename = 0;
 138   int mmap_flags = 0;
 139   int log2_page_size;
 140   int n_pages;
 141   int old_mpol = -1;
 142   long unsigned int old_mask[16] = { 0 };
 143
 144   /* save old numa mem policy if needed */
 145   if (a->flags & (CLIB_MEM_VM_F_NUMA_PREFER | CLIB_MEM_VM_F_NUMA_FORCE))
 146     {
 147       int rv;
 148       rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1,
 149                           0, 0);
 150
 151       if (rv == -1)
 152         {
 153           if (a->numa_node != 0 && (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
 154             {
 155               err = clib_error_return_unix (0, "get_mempolicy");
 156               goto error;
 157             }
 158           else
 159             old_mpol = -1;
 160         }
 161     }
 162
 163   if (a->flags & CLIB_MEM_VM_F_LOCKED)
 164     mmap_flags |= MAP_LOCKED;
 165
 166   /* if we are creating shared segment, we need file descriptor */
 167   if (a->flags & CLIB_MEM_VM_F_SHARED)
 168     {
 169       mmap_flags |= MAP_SHARED;
 170       /* if hugepages are needed we need to create mount point */
 171       if (a->flags & CLIB_MEM_VM_F_HUGETLB)
 172         {
 173           if ((err = clib_mem_create_hugetlb_fd (a->name, &fd)))
 174             goto error;
 175
 176           mmap_flags |= MAP_LOCKED;
 177         }
 178       else
 179         {
 180           if ((fd = memfd_create (a->name, MFD_ALLOW_SEALING)) == -1)
 181             {
 182               err = clib_error_return_unix (0, "memfd_create");
 183               goto error;
 184             }
 185
 186           if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
 187             {
 188               err = clib_error_return_unix (0, "fcntl (F_ADD_SEALS)");
 189               goto error;
 190             }
 191         }
 192
 193       log2_page_size = clib_mem_vm_get_log2_page_size (fd);
 194       if (log2_page_size == 0)
 195         {
 196           err = clib_error_return_unix (0, "cannot determine page size");
 197           goto error;
 198         }
 199
 200       if (a->requested_va)
 201         {
 202           clib_mem_vm_randomize_va (&a->requested_va, log2_page_size);
 203           mmap_flags |= MAP_FIXED;
 204         }
 205     }
 206   else                          /* not CLIB_MEM_VM_F_SHARED */
 207     {
 208       mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
 209       if (a->flags & CLIB_MEM_VM_F_HUGETLB)
 210         {
 211           mmap_flags |= MAP_HUGETLB;
 212           log2_page_size = 21;
 213         }
 214       else
 215         {
 216           log2_page_size = min_log2 (sysconf (_SC_PAGESIZE));
 217         }
 218     }
 219
 220   n_pages = ((a->size - 1) >> log2_page_size) + 1;
 221
 222   if (a->flags & CLIB_MEM_VM_F_HUGETLB_PREALLOC)
 223     {
 224       err = clib_sysfs_prealloc_hugepages (a->numa_node, log2_page_size,
 225                                            n_pages);
 226       if (err)
 227         goto error;
 228
 229     }
 230
 231   if (fd != -1)
 232     if ((ftruncate (fd, (u64) n_pages * (1 << log2_page_size))) == -1)
 233       {
 234         err = clib_error_return_unix (0, "ftruncate");
 235         goto error;
 236       }
 237
 238   if (old_mpol != -1)
 239     {
 240       int rv;
 241       long unsigned int mask[16] = { 0 };
 242       mask[0] = 1 << a->numa_node;
 243       rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
 244       if (rv == -1 && a->numa_node != 0 &&
 245           (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
 246         {
 247           err = clib_error_return_unix (0, "set_mempolicy");
 248           goto error;
 249         }
 250     }
 251
 252   addr = mmap (uword_to_pointer (a->requested_va, void *), a->size,
 253                (PROT_READ | PROT_WRITE), mmap_flags, fd, 0);
 254   if (addr == MAP_FAILED)
 255     {
 256       err = clib_error_return_unix (0, "mmap");
 257       goto error;
 258     }
 259
 260   /* re-apply old numa memory policy */
 261   if (old_mpol != -1 &&
 262       set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1) == -1)
 263     {
 264       err = clib_error_return_unix (0, "set_mempolicy");
 265       goto error;
 266     }
 267
 268   a->log2_page_size = log2_page_size;
 269   a->n_pages = n_pages;
 270   a->addr = addr;
 271   a->fd = fd;
 272   goto done;
 273
 274 error:
 275   if (fd != -1)
 276     close (fd);
 277
 278 done:
 279   vec_free (filename);
 280   return err;
 281 }
 282
 283 void
 284 clib_mem_vm_ext_free (clib_mem_vm_alloc_t * a)
 285 {
 286   if (a != 0)
 287     {
 288       clib_mem_vm_free (a->addr, 1ull << a->log2_page_size);
 289       if (a->fd != -1)
 290         close (a->fd);
 291     }
 292 }
 293
 294 u64 *
 295 clib_mem_vm_get_paddr (void *mem, int log2_page_size, int n_pages)
 296 {
 297   int pagesize = sysconf (_SC_PAGESIZE);
 298   int fd;
 299   int i;
 300   u64 *r = 0;
 301
 302   if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
 303     return 0;
 304
 305   for (i = 0; i < n_pages; i++)
 306     {
 307       u64 seek, pagemap = 0;
 308       uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
 309       seek = ((u64) vaddr / pagesize) * sizeof (u64);
 310       if (lseek (fd, seek, SEEK_SET) != seek)
 311         goto done;
 312
 313       if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
 314         goto done;
 315
 316       if ((pagemap & (1ULL << 63)) == 0)
 317         goto done;
 318
 319       pagemap &= pow2_mask (55);
 320       vec_add1 (r, pagemap * pagesize);
 321     }
 322
 323 done:
 324   close (fd);
 325   if (vec_len (r) != n_pages)
 326     {
 327       vec_free (r);
 328       return 0;
 329     }
 330   return r;
 331 }
 332
 333 clib_error_t *
 334 clib_mem_vm_ext_map (clib_mem_vm_map_t * a)
 335 {
 336   int mmap_flags = MAP_SHARED;
 337   void *addr;
 338
 339   if (a->requested_va)
 340     mmap_flags |= MAP_FIXED;
 341
 342   addr = (void *) mmap (uword_to_pointer (a->requested_va, void *), a->size,
 343                         PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0);
 344
 345   if (addr == MAP_FAILED)
 346     return clib_error_return_unix (0, "mmap");
 347
 348   a->addr = addr;
 349   return 0;
 350 }
 351
 352 /*
 353  * fd.io coding-style-patch-verification: ON
 354  *
 355  * Local Variables:
 356  * eval: (c-set-style "gnu")
 357  * End:
 358  */