vppinfra: support main heap with different page sizes
[vpp.git] / src / vppinfra / mem.h
index 0f8bd48..e6f019c 100644 (file)
 #include <vppinfra/clib.h>     /* uword, etc */
 #include <vppinfra/clib_error.h>
 
-#if USE_DLMALLOC == 0
-#include <vppinfra/mheap_bootstrap.h>
-#else
 #include <vppinfra/dlmalloc.h>
-#endif
 
 #include <vppinfra/os.h>
 #include <vppinfra/string.h>   /* memcpy, clib_memset */
 #include <vppinfra/sanitizer.h>
 
 #define CLIB_MAX_MHEAPS 256
-#define CLIB_MAX_NUMAS 8
+#define CLIB_MAX_NUMAS 16
+#define CLIB_MEM_VM_MAP_FAILED ((void *) ~0)
+
+typedef enum
+{
+  CLIB_MEM_PAGE_SZ_UNKNOWN = 0,
+  CLIB_MEM_PAGE_SZ_DEFAULT = 1,
+  CLIB_MEM_PAGE_SZ_DEFAULT_HUGE = 2,
+  CLIB_MEM_PAGE_SZ_4K = 12,
+  CLIB_MEM_PAGE_SZ_16K = 14,
+  CLIB_MEM_PAGE_SZ_64K = 16,
+  CLIB_MEM_PAGE_SZ_1M = 20,
+  CLIB_MEM_PAGE_SZ_2M = 21,
+  CLIB_MEM_PAGE_SZ_16M = 24,
+  CLIB_MEM_PAGE_SZ_32M = 25,
+  CLIB_MEM_PAGE_SZ_512M = 29,
+  CLIB_MEM_PAGE_SZ_1G = 30,
+  CLIB_MEM_PAGE_SZ_16G = 34,
+} clib_mem_page_sz_t;
+
+typedef struct _clib_mem_vm_map_hdr
+{
+  /* base address */
+  uword base_addr;
+
+  /* number of pages */
+  uword num_pages;
+
+  /* page size (log2) */
+  clib_mem_page_sz_t log2_page_sz;
+
+  /* allocation mame */
+#define CLIB_VM_MAP_HDR_NAME_MAX_LEN 64
+  char name[CLIB_VM_MAP_HDR_NAME_MAX_LEN];
+
+  /* linked list */
+  struct _clib_mem_vm_map_hdr *prev, *next;
+} clib_mem_vm_map_hdr_t;
+
+typedef struct
+{
+  /* log2 system page size */
+  clib_mem_page_sz_t log2_page_sz;
+
+  /* log2 system default hugepage size */
+  clib_mem_page_sz_t log2_default_hugepage_sz;
+
+  /* bitmap of available numa nodes */
+  u32 numa_node_bitmap;
+
+  /* per CPU heaps */
+  void *per_cpu_mheaps[CLIB_MAX_MHEAPS];
+
+  /* per NUMA heaps */
+  void *per_numa_mheaps[CLIB_MAX_NUMAS];
+
+  /* memory maps */
+  clib_mem_vm_map_hdr_t *first_map, *last_map;
+} clib_mem_main_t;
+
+extern clib_mem_main_t clib_mem_main;
 
 /* Unspecified NUMA socket */
 #define VEC_NUMA_UNSPECIFIED (0xFF)
 
-/* Per CPU heaps. */
-extern void *clib_per_cpu_mheaps[CLIB_MAX_MHEAPS];
-extern void *clib_per_numa_mheaps[CLIB_MAX_NUMAS];
-
 always_inline void *
 clib_mem_get_per_cpu_heap (void)
 {
   int cpu = os_get_thread_index ();
-  return clib_per_cpu_mheaps[cpu];
+  return clib_mem_main.per_cpu_mheaps[cpu];
 }
 
 always_inline void *
 clib_mem_set_per_cpu_heap (u8 * new_heap)
 {
   int cpu = os_get_thread_index ();
-  void *old = clib_per_cpu_mheaps[cpu];
-  clib_per_cpu_mheaps[cpu] = new_heap;
+  void *old = clib_mem_main.per_cpu_mheaps[cpu];
+  clib_mem_main.per_cpu_mheaps[cpu] = new_heap;
   return old;
 }
 
 always_inline void *
 clib_mem_get_per_numa_heap (u32 numa_id)
 {
-  ASSERT (numa_id < ARRAY_LEN (clib_per_numa_mheaps));
-  return clib_per_numa_mheaps[numa_id];
+  ASSERT (numa_id < ARRAY_LEN (clib_mem_main.per_numa_mheaps));
+  return clib_mem_main.per_numa_mheaps[numa_id];
 }
 
 always_inline void *
 clib_mem_set_per_numa_heap (u8 * new_heap)
 {
   int numa = os_get_numa_index ();
-  void *old = clib_per_numa_mheaps[numa];
-  clib_per_numa_mheaps[numa] = new_heap;
+  void *old = clib_mem_main.per_numa_mheaps[numa];
+  clib_mem_main.per_numa_mheaps[numa] = new_heap;
   return old;
 }
 
@@ -108,9 +160,9 @@ clib_mem_set_thread_index (void)
   int i;
   if (__os_thread_index != 0)
     return;
-  for (i = 0; i < ARRAY_LEN (clib_per_cpu_mheaps); i++)
-    if (clib_atomic_bool_cmp_and_swap (&clib_per_cpu_mheaps[i],
-                                      0, clib_per_cpu_mheaps[0]))
+  for (i = 0; i < ARRAY_LEN (clib_mem_main.per_cpu_mheaps); i++)
+    if (clib_atomic_bool_cmp_and_swap (&clib_mem_main.per_cpu_mheaps[i],
+                                      0, clib_mem_main.per_cpu_mheaps[0]))
       {
        os_set_thread_index (i);
        break;
@@ -121,12 +173,7 @@ clib_mem_set_thread_index (void)
 always_inline uword
 clib_mem_size_nocheck (void *p)
 {
-#if USE_DLMALLOC == 0
-  mheap_elt_t *e = mheap_user_pointer_to_elt (p);
-  return mheap_elt_data_bytes (e);
-#else
   return mspace_usable_size_with_delta (p);
-#endif
 }
 
 /* Memory allocator which may call os_out_of_memory() if it fails */
@@ -146,17 +193,9 @@ clib_mem_alloc_aligned_at_offset (uword size, uword align, uword align_offset,
     }
 
   cpu = os_get_thread_index ();
-  heap = clib_per_cpu_mheaps[cpu];
-
-#if USE_DLMALLOC == 0
-  uword offset;
-  heap = mheap_get_aligned (heap, size, align, align_offset, &offset);
-  clib_per_cpu_mheaps[cpu] = heap;
-  if (PREDICT_TRUE (offset != ~0))
-    p = heap + offset;
-#else
+  heap = clib_mem_main.per_cpu_mheaps[cpu];
+
   p = mspace_get_aligned (heap, size, align, align_offset);
-#endif /* USE_DLMALLOC */
 
   if (PREDICT_FALSE (0 == p))
     {
@@ -223,24 +262,9 @@ clib_mem_alloc_aligned_or_null (uword size, uword align)
 always_inline uword
 clib_mem_is_heap_object (void *p)
 {
-#if USE_DLMALLOC == 0
-  void *heap = clib_mem_get_per_cpu_heap ();
-  uword offset = (uword) p - (uword) heap;
-  mheap_elt_t *e, *n;
-
-  if (offset >= vec_len (heap))
-    return 0;
-
-  e = mheap_elt_at_uoffset (heap, offset);
-  n = mheap_next_elt (e);
-
-  /* Check that heap forward and reverse pointers agree. */
-  return e->n_user_data == n->prev_n_user_data;
-#else
   void *heap = clib_mem_get_per_cpu_heap ();
 
   return mspace_is_heap_object (heap, p);
-#endif /* USE_DLMALLOC */
 }
 
 always_inline void
@@ -253,11 +277,7 @@ clib_mem_free (void *p)
 
   CLIB_MEM_POISON (p, clib_mem_size_nocheck (p));
 
-#if USE_DLMALLOC == 0
-  mheap_put (heap, (u8 *) p - heap);
-#else
   mspace_put (heap, p);
-#endif
 }
 
 always_inline void *
@@ -306,15 +326,16 @@ clib_mem_set_heap (void *heap)
   return clib_mem_set_per_cpu_heap (heap);
 }
 
+void clib_mem_main_init ();
 void *clib_mem_init (void *heap, uword size);
+void *clib_mem_init_with_page_size (uword memory_size,
+                                   clib_mem_page_sz_t log2_page_sz);
 void *clib_mem_init_thread_safe (void *memory, uword memory_size);
 void *clib_mem_init_thread_safe_numa (void *memory, uword memory_size,
                                      u8 numa);
 
 void clib_mem_exit (void);
 
-uword clib_mem_get_page_size (void);
-
 void clib_mem_validate (void);
 
 void clib_mem_trace (int enable);
@@ -374,42 +395,20 @@ always_inline void
 clib_mem_vm_free (void *addr, uword size)
 {
   munmap (addr, size);
-  CLIB_MEM_POISON (addr, size);
-}
-
-always_inline void *
-clib_mem_vm_unmap (void *addr, uword size)
-{
-  void *mmap_addr;
-  uword flags = MAP_PRIVATE | MAP_FIXED;
-
-  /* To unmap we "map" with no protection.  If we actually called
-     munmap then other callers could steal the address space.  By
-     changing to PROT_NONE the kernel can free up the pages which is
-     really what we want "unmap" to mean. */
-  mmap_addr = mmap (addr, size, PROT_NONE, flags, -1, 0);
-  if (mmap_addr == (void *) -1)
-    mmap_addr = 0;
-  else
-    CLIB_MEM_UNPOISON (mmap_addr, size);
-
-  return mmap_addr;
 }
 
-always_inline void *
-clib_mem_vm_map (void *addr, uword size)
-{
-  void *mmap_addr;
-  uword flags = MAP_PRIVATE | MAP_FIXED | MAP_ANONYMOUS;
-
-  mmap_addr = mmap (addr, size, (PROT_READ | PROT_WRITE), flags, -1, 0);
-  if (mmap_addr == (void *) -1)
-    mmap_addr = 0;
-  else
-    CLIB_MEM_UNPOISON (mmap_addr, size);
+void *clib_mem_vm_map_internal (void *base, clib_mem_page_sz_t log2_page_sz,
+                               uword size, int fd, uword offset, char *name);
 
-  return mmap_addr;
-}
+void *clib_mem_vm_map (void *start, uword size,
+                      clib_mem_page_sz_t log2_page_size, char *fmt, ...);
+void *clib_mem_vm_map_stack (uword size, clib_mem_page_sz_t log2_page_size,
+                            char *fmt, ...);
+void *clib_mem_vm_map_shared (void *start, uword size, int fd, uword offset,
+                             char *fmt, ...);
+int clib_mem_vm_unmap (void *base);
+clib_mem_vm_map_hdr_t *clib_mem_vm_get_next_map_hdr (clib_mem_vm_map_hdr_t *
+                                                    hdr);
 
 typedef struct
 {
@@ -440,14 +439,38 @@ typedef struct
   uword requested_va;          /**< Request fixed position mapping */
 } clib_mem_vm_alloc_t;
 
+
+static_always_inline clib_mem_page_sz_t
+clib_mem_get_log2_page_size (void)
+{
+  return clib_mem_main.log2_page_sz;
+}
+
+static_always_inline uword
+clib_mem_get_page_size (void)
+{
+  return 1ULL << clib_mem_main.log2_page_sz;
+}
+
+static_always_inline clib_mem_page_sz_t
+clib_mem_get_log2_default_hugepage_size ()
+{
+  return clib_mem_main.log2_default_hugepage_sz;
+}
+
 clib_error_t *clib_mem_create_fd (char *name, int *fdp);
 clib_error_t *clib_mem_create_hugetlb_fd (char *name, int *fdp);
 clib_error_t *clib_mem_vm_ext_alloc (clib_mem_vm_alloc_t * a);
 void clib_mem_vm_ext_free (clib_mem_vm_alloc_t * a);
-u64 clib_mem_get_fd_page_size (int fd);
+uword clib_mem_get_fd_page_size (int fd);
 uword clib_mem_get_default_hugepage_size (void);
-int clib_mem_get_fd_log2_page_size (int fd);
-u64 *clib_mem_vm_get_paddr (void *mem, int log2_page_size, int n_pages);
+clib_mem_page_sz_t clib_mem_get_fd_log2_page_size (int fd);
+uword clib_mem_vm_reserve (uword start, uword size,
+                          clib_mem_page_sz_t log2_page_sz);
+u64 *clib_mem_vm_get_paddr (void *mem, clib_mem_page_sz_t log2_page_size,
+                           int n_pages);
+void clib_mem_destroy_mspace (void *mspace);
+void clib_mem_destroy (void);
 
 typedef struct
 {
@@ -459,11 +482,67 @@ typedef struct
 } clib_mem_vm_map_t;
 
 clib_error_t *clib_mem_vm_ext_map (clib_mem_vm_map_t * a);
-void clib_mem_vm_randomize_va (uword * requested_va, u32 log2_page_size);
+void clib_mem_vm_randomize_va (uword * requested_va,
+                              clib_mem_page_sz_t log2_page_size);
 void mheap_trace (void *v, int enable);
 uword clib_mem_trace_enable_disable (uword enable);
 void clib_mem_trace (int enable);
 
+always_inline uword
+clib_mem_round_to_page_size (uword size, clib_mem_page_sz_t log2_page_size)
+{
+  ASSERT (log2_page_size != CLIB_MEM_PAGE_SZ_UNKNOWN);
+
+  if (log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT)
+    log2_page_size = clib_mem_get_log2_page_size ();
+  else if (log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
+    log2_page_size = clib_mem_get_log2_default_hugepage_size ();
+
+  return round_pow2 (size, 1ULL << log2_page_size);
+}
+
+typedef struct
+{
+  uword mapped;
+  uword not_mapped;
+  uword per_numa[CLIB_MAX_NUMAS];
+  uword unknown;
+} clib_mem_page_stats_t;
+
+void clib_mem_get_page_stats (void *start, clib_mem_page_sz_t log2_page_size,
+                             uword n_pages, clib_mem_page_stats_t * stats);
+
+static_always_inline int
+vlib_mem_get_next_numa_node (int numa)
+{
+  clib_mem_main_t *mm = &clib_mem_main;
+  u32 bitmap = mm->numa_node_bitmap;
+
+  if (numa >= 0)
+    bitmap &= ~pow2_mask (numa + 1);
+  if (bitmap == 0)
+    return -1;
+
+  return count_trailing_zeros (bitmap);
+}
+
+static_always_inline clib_mem_page_sz_t
+clib_mem_log2_page_size_validate (clib_mem_page_sz_t log2_page_size)
+{
+  if (log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT)
+    return clib_mem_get_log2_page_size ();
+  if (log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
+    return clib_mem_get_log2_default_hugepage_size ();
+  return log2_page_size;
+}
+
+static_always_inline uword
+clib_mem_page_bytes (clib_mem_page_sz_t log2_page_size)
+{
+  return 1 << clib_mem_log2_page_size_validate (log2_page_size);
+}
+
+
 #include <vppinfra/error.h>    /* clib_panic */
 
 #endif /* _included_clib_mem_h */