lib/eal/common/malloc_heap.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef MALLOC_HEAP_H_
   6 #define MALLOC_HEAP_H_
   7
   8 #include <stdbool.h>
   9 #include <sys/queue.h>
  10
  11 #include <rte_malloc.h>
  12 #include <rte_spinlock.h>
  13
  14 /* Number of free lists per heap, grouped by size. */
  15 #define RTE_HEAP_NUM_FREELISTS  13
  16 #define RTE_HEAP_NAME_MAX_LEN 32
  17
  18 /* dummy definition, for pointers */
  19 struct malloc_elem;
  20
  21 /**
  22  * Structure to hold malloc heap
  23  */
  24 struct malloc_heap {
  25         rte_spinlock_t lock;
  26         LIST_HEAD(, malloc_elem) free_head[RTE_HEAP_NUM_FREELISTS];
  27         struct malloc_elem *volatile first;
  28         struct malloc_elem *volatile last;
  29
  30         unsigned int alloc_count;
  31         unsigned int socket_id;
  32         size_t total_size;
  33         char name[RTE_HEAP_NAME_MAX_LEN];
  34 } __rte_cache_aligned;
  35
  36 static inline unsigned
  37 malloc_get_numa_socket(void)
  38 {
  39         unsigned socket_id = rte_socket_id();
  40
  41         if (socket_id == (unsigned)SOCKET_ID_ANY)
  42                 return 0;
  43
  44         return socket_id;
  45 }
  46
  47 void *
  48 malloc_heap_alloc(const char *type, size_t size, int socket, unsigned int flags,
  49                 size_t align, size_t bound, bool contig);
  50
  51 void *
  52 malloc_heap_alloc_biggest(const char *type, int socket, unsigned int flags,
  53                 size_t align, bool contig);
  54
  55 int
  56 malloc_heap_create(struct malloc_heap *heap, const char *heap_name);
  57
  58 int
  59 malloc_heap_destroy(struct malloc_heap *heap);
  60
  61 struct rte_memseg_list *
  62 malloc_heap_create_external_seg(void *va_addr, rte_iova_t iova_addrs[],
  63                 unsigned int n_pages, size_t page_sz, const char *seg_name,
  64                 unsigned int socket_id);
  65
  66 struct rte_memseg_list *
  67 malloc_heap_find_external_seg(void *va_addr, size_t len);
  68
  69 int
  70 malloc_heap_destroy_external_seg(struct rte_memseg_list *msl);
  71
  72 int
  73 malloc_heap_add_external_memory(struct malloc_heap *heap,
  74                 struct rte_memseg_list *msl);
  75
  76 int
  77 malloc_heap_remove_external_memory(struct malloc_heap *heap, void *va_addr,
  78                 size_t len);
  79
  80 int
  81 malloc_heap_free(struct malloc_elem *elem);
  82
  83 int
  84 malloc_heap_resize(struct malloc_elem *elem, size_t size);
  85
  86 int
  87 malloc_heap_get_stats(struct malloc_heap *heap,
  88                 struct rte_malloc_socket_stats *socket_stats);
  89
  90 void
  91 malloc_heap_dump(struct malloc_heap *heap, FILE *f);
  92
  93 int
  94 malloc_socket_to_heap_id(unsigned int socket_id);
  95
  96 int
  97 rte_eal_malloc_heap_init(void);
  98
  99 #endif /* MALLOC_HEAP_H_ */