lib/librte_eal/common/include/rte_malloc.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_MALLOC_H_
   6 #define _RTE_MALLOC_H_
   7
   8 /**
   9  * @file
  10  * RTE Malloc. This library provides methods for dynamically allocating memory
  11  * from hugepages.
  12  */
  13
  14 #include <stdio.h>
  15 #include <stddef.h>
  16 #include <rte_compat.h>
  17 #include <rte_memory.h>
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 /**
  24  *  Structure to hold heap statistics obtained from rte_malloc_get_socket_stats function.
  25  */
  26 struct rte_malloc_socket_stats {
  27         size_t heap_totalsz_bytes; /**< Total bytes on heap */
  28         size_t heap_freesz_bytes;  /**< Total free bytes on heap */
  29         size_t greatest_free_size; /**< Size in bytes of largest free block */
  30         unsigned free_count;       /**< Number of free elements on heap */
  31         unsigned alloc_count;      /**< Number of allocated elements on heap */
  32         size_t heap_allocsz_bytes; /**< Total allocated bytes on heap */
  33 };
  34
  35 /**
  36  * This function allocates memory from the huge-page area of memory. The memory
  37  * is not cleared. In NUMA systems, the memory allocated resides on the same
  38  * NUMA socket as the core that calls this function.
  39  *
  40  * @param type
  41  *   A string identifying the type of allocated objects (useful for debug
  42  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
  43  * @param size
  44  *   Size (in bytes) to be allocated.
  45  * @param align
  46  *   If 0, the return is a pointer that is suitably aligned for any kind of
  47  *   variable (in the same manner as malloc()).
  48  *   Otherwise, the return is a pointer that is a multiple of *align*. In
  49  *   this case, it must be a power of two. (Minimum alignment is the
  50  *   cacheline size, i.e. 64-bytes)
  51  * @return
  52  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
  53  *     align is not a power of two).
  54  *   - Otherwise, the pointer to the allocated object.
  55  */
  56 void *
  57 rte_malloc(const char *type, size_t size, unsigned align);
  58
  59 /**
  60  * Allocate zero'ed memory from the heap.
  61  *
  62  * Equivalent to rte_malloc() except that the memory zone is
  63  * initialised with zeros. In NUMA systems, the memory allocated resides on the
  64  * same NUMA socket as the core that calls this function.
  65  *
  66  * @param type
  67  *   A string identifying the type of allocated objects (useful for debug
  68  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
  69  * @param size
  70  *   Size (in bytes) to be allocated.
  71  * @param align
  72  *   If 0, the return is a pointer that is suitably aligned for any kind of
  73  *   variable (in the same manner as malloc()).
  74  *   Otherwise, the return is a pointer that is a multiple of *align*. In
  75  *   this case, it must obviously be a power of two. (Minimum alignment is the
  76  *   cacheline size, i.e. 64-bytes)
  77  * @return
  78  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
  79  *     align is not a power of two).
  80  *   - Otherwise, the pointer to the allocated object.
  81  */
  82 void *
  83 rte_zmalloc(const char *type, size_t size, unsigned align);
  84
  85 /**
  86  * Replacement function for calloc(), using huge-page memory. Memory area is
  87  * initialised with zeros. In NUMA systems, the memory allocated resides on the
  88  * same NUMA socket as the core that calls this function.
  89  *
  90  * @param type
  91  *   A string identifying the type of allocated objects (useful for debug
  92  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
  93  * @param num
  94  *   Number of elements to be allocated.
  95  * @param size
  96  *   Size (in bytes) of a single element.
  97  * @param align
  98  *   If 0, the return is a pointer that is suitably aligned for any kind of
  99  *   variable (in the same manner as malloc()).
 100  *   Otherwise, the return is a pointer that is a multiple of *align*. In
 101  *   this case, it must obviously be a power of two. (Minimum alignment is the
 102  *   cacheline size, i.e. 64-bytes)
 103  * @return
 104  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
 105  *     align is not a power of two).
 106  *   - Otherwise, the pointer to the allocated object.
 107  */
 108 void *
 109 rte_calloc(const char *type, size_t num, size_t size, unsigned align);
 110
 111 /**
 112  * Replacement function for realloc(), using huge-page memory. Reserved area
 113  * memory is resized, preserving contents. In NUMA systems, the new area
 114  * resides on the same NUMA socket as the old area.
 115  *
 116  * @param ptr
 117  *   Pointer to already allocated memory
 118  * @param size
 119  *   Size (in bytes) of new area. If this is 0, memory is freed.
 120  * @param align
 121  *   If 0, the return is a pointer that is suitably aligned for any kind of
 122  *   variable (in the same manner as malloc()).
 123  *   Otherwise, the return is a pointer that is a multiple of *align*. In
 124  *   this case, it must obviously be a power of two. (Minimum alignment is the
 125  *   cacheline size, i.e. 64-bytes)
 126  * @return
 127  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
 128  *     align is not a power of two).
 129  *   - Otherwise, the pointer to the reallocated memory.
 130  */
 131 void *
 132 rte_realloc(void *ptr, size_t size, unsigned align);
 133
 134 /**
 135  * This function allocates memory from the huge-page area of memory. The memory
 136  * is not cleared.
 137  *
 138  * @param type
 139  *   A string identifying the type of allocated objects (useful for debug
 140  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
 141  * @param size
 142  *   Size (in bytes) to be allocated.
 143  * @param align
 144  *   If 0, the return is a pointer that is suitably aligned for any kind of
 145  *   variable (in the same manner as malloc()).
 146  *   Otherwise, the return is a pointer that is a multiple of *align*. In
 147  *   this case, it must be a power of two. (Minimum alignment is the
 148  *   cacheline size, i.e. 64-bytes)
 149  * @param socket
 150  *   NUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function
 151  *   will behave the same as rte_malloc().
 152  * @return
 153  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
 154  *     align is not a power of two).
 155  *   - Otherwise, the pointer to the allocated object.
 156  */
 157 void *
 158 rte_malloc_socket(const char *type, size_t size, unsigned align, int socket);
 159
 160 /**
 161  * Allocate zero'ed memory from the heap.
 162  *
 163  * Equivalent to rte_malloc() except that the memory zone is
 164  * initialised with zeros.
 165  *
 166  * @param type
 167  *   A string identifying the type of allocated objects (useful for debug
 168  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
 169  * @param size
 170  *   Size (in bytes) to be allocated.
 171  * @param align
 172  *   If 0, the return is a pointer that is suitably aligned for any kind of
 173  *   variable (in the same manner as malloc()).
 174  *   Otherwise, the return is a pointer that is a multiple of *align*. In
 175  *   this case, it must obviously be a power of two. (Minimum alignment is the
 176  *   cacheline size, i.e. 64-bytes)
 177  * @param socket
 178  *   NUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function
 179  *   will behave the same as rte_zmalloc().
 180  * @return
 181  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
 182  *     align is not a power of two).
 183  *   - Otherwise, the pointer to the allocated object.
 184  */
 185 void *
 186 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket);
 187
 188 /**
 189  * Replacement function for calloc(), using huge-page memory. Memory area is
 190  * initialised with zeros.
 191  *
 192  * @param type
 193  *   A string identifying the type of allocated objects (useful for debug
 194  *   purposes, such as identifying the cause of a memory leak). Can be NULL.
 195  * @param num
 196  *   Number of elements to be allocated.
 197  * @param size
 198  *   Size (in bytes) of a single element.
 199  * @param align
 200  *   If 0, the return is a pointer that is suitably aligned for any kind of
 201  *   variable (in the same manner as malloc()).
 202  *   Otherwise, the return is a pointer that is a multiple of *align*. In
 203  *   this case, it must obviously be a power of two. (Minimum alignment is the
 204  *   cacheline size, i.e. 64-bytes)
 205  * @param socket
 206  *   NUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function
 207  *   will behave the same as rte_calloc().
 208  * @return
 209  *   - NULL on error. Not enough memory, or invalid arguments (size is 0,
 210  *     align is not a power of two).
 211  *   - Otherwise, the pointer to the allocated object.
 212  */
 213 void *
 214 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket);
 215
 216 /**
 217  * Frees the memory space pointed to by the provided pointer.
 218  *
 219  * This pointer must have been returned by a previous call to
 220  * rte_malloc(), rte_zmalloc(), rte_calloc() or rte_realloc(). The behaviour of
 221  * rte_free() is undefined if the pointer does not match this requirement.
 222  *
 223  * If the pointer is NULL, the function does nothing.
 224  *
 225  * @param ptr
 226  *   The pointer to memory to be freed.
 227  */
 228 void
 229 rte_free(void *ptr);
 230
 231 /**
 232  * If malloc debug is enabled, check a memory block for header
 233  * and trailer markers to indicate that all is well with the block.
 234  * If size is non-null, also return the size of the block.
 235  *
 236  * @param ptr
 237  *   pointer to the start of a data block, must have been returned
 238  *   by a previous call to rte_malloc(), rte_zmalloc(), rte_calloc()
 239  *   or rte_realloc()
 240  * @param size
 241  *   if non-null, and memory block pointer is valid, returns the size
 242  *   of the memory block
 243  * @return
 244  *   -1 on error, invalid pointer passed or header and trailer markers
 245  *   are missing or corrupted
 246  *   0 on success
 247  */
 248 int
 249 rte_malloc_validate(const void *ptr, size_t *size);
 250
 251 /**
 252  * Get heap statistics for the specified heap.
 253  *
 254  * @note This function is not thread-safe with respect to
 255  *    ``rte_malloc_heap_create()``/``rte_malloc_heap_destroy()`` functions.
 256  *
 257  * @param socket
 258  *   An unsigned integer specifying the socket to get heap statistics for
 259  * @param socket_stats
 260  *   A structure which provides memory to store statistics
 261  * @return
 262  *   Null on error
 263  *   Pointer to structure storing statistics on success
 264  */
 265 int
 266 rte_malloc_get_socket_stats(int socket,
 267                 struct rte_malloc_socket_stats *socket_stats);
 268
 269 /**
 270  * Add memory chunk to a heap with specified name.
 271  *
 272  * @note Multiple memory chunks can be added to the same heap
 273  *
 274  * @note Before accessing this memory in other processes, it needs to be
 275  *   attached in each of those processes by calling
 276  *   ``rte_malloc_heap_memory_attach`` in each other process.
 277  *
 278  * @note Memory must be previously allocated for DPDK to be able to use it as a
 279  *   malloc heap. Failing to do so will result in undefined behavior, up to and
 280  *   including segmentation faults.
 281  *
 282  * @note Calling this function will erase any contents already present at the
 283  *   supplied memory address.
 284  *
 285  * @param heap_name
 286  *   Name of the heap to add memory chunk to
 287  * @param va_addr
 288  *   Start of virtual area to add to the heap. Must be aligned by ``page_sz``.
 289  * @param len
 290  *   Length of virtual area to add to the heap. Must be aligned by ``page_sz``.
 291  * @param iova_addrs
 292  *   Array of page IOVA addresses corresponding to each page in this memory
 293  *   area. Can be NULL, in which case page IOVA addresses will be set to
 294  *   RTE_BAD_IOVA.
 295  * @param n_pages
 296  *   Number of elements in the iova_addrs array. Ignored if  ``iova_addrs``
 297  *   is NULL.
 298  * @param page_sz
 299  *   Page size of the underlying memory
 300  *
 301  * @return
 302  *   - 0 on success
 303  *   - -1 in case of error, with rte_errno set to one of the following:
 304  *     EINVAL - one of the parameters was invalid
 305  *     EPERM  - attempted to add memory to a reserved heap
 306  *     ENOSPC - no more space in internal config to store a new memory chunk
 307  */
 308 int __rte_experimental
 309 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
 310                 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz);
 311
 312 /**
 313  * Remove memory chunk from heap with specified name.
 314  *
 315  * @note Memory chunk being removed must be the same as one that was added;
 316  *   partially removing memory chunks is not supported
 317  *
 318  * @note Memory area must not contain any allocated elements to allow its
 319  *   removal from the heap
 320  *
 321  * @note All other processes must detach from the memory chunk prior to it being
 322  *   removed from the heap.
 323  *
 324  * @param heap_name
 325  *   Name of the heap to remove memory from
 326  * @param va_addr
 327  *   Virtual address to remove from the heap
 328  * @param len
 329  *   Length of virtual area to remove from the heap
 330  *
 331  * @return
 332  *   - 0 on success
 333  *   - -1 in case of error, with rte_errno set to one of the following:
 334  *     EINVAL - one of the parameters was invalid
 335  *     EPERM  - attempted to remove memory from a reserved heap
 336  *     ENOENT - heap or memory chunk was not found
 337  *     EBUSY  - memory chunk still contains data
 338  */
 339 int __rte_experimental
 340 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len);
 341
 342 /**
 343  * Attach to an already existing chunk of external memory in another process.
 344  *
 345  * @note This function must be called before any attempt is made to use an
 346  *   already existing external memory chunk. This function does *not* need to
 347  *   be called if a call to ``rte_malloc_heap_memory_add`` was made in the
 348  *   current process.
 349  *
 350  * @param heap_name
 351  *   Heap name to which this chunk of memory belongs
 352  * @param va_addr
 353  *   Start address of memory chunk to attach to
 354  * @param len
 355  *   Length of memory chunk to attach to
 356  * @return
 357  *   0 on successful attach
 358  *   -1 on unsuccessful attach, with rte_errno set to indicate cause for error:
 359  *     EINVAL - one of the parameters was invalid
 360  *     EPERM  - attempted to attach memory to a reserved heap
 361  *     ENOENT - heap or memory chunk was not found
 362  */
 363 int __rte_experimental
 364 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len);
 365
 366 /**
 367  * Detach from a chunk of external memory in secondary process.
 368  *
 369  * @note This function must be called in before any attempt is made to remove
 370  *   external memory from the heap in another process. This function does *not*
 371  *   need to be called if a call to ``rte_malloc_heap_memory_remove`` will be
 372  *   called in current process.
 373  *
 374  * @param heap_name
 375  *   Heap name to which this chunk of memory belongs
 376  * @param va_addr
 377  *   Start address of memory chunk to attach to
 378  * @param len
 379  *   Length of memory chunk to attach to
 380  * @return
 381  *   0 on successful detach
 382  *   -1 on unsuccessful detach, with rte_errno set to indicate cause for error:
 383  *     EINVAL - one of the parameters was invalid
 384  *     EPERM  - attempted to detach memory from a reserved heap
 385  *     ENOENT - heap or memory chunk was not found
 386  */
 387 int __rte_experimental
 388 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len);
 389
 390 /**
 391  * Creates a new empty malloc heap with a specified name.
 392  *
 393  * @note Heaps created via this call will automatically get assigned a unique
 394  *   socket ID, which can be found using ``rte_malloc_heap_get_socket()``
 395  *
 396  * @param heap_name
 397  *   Name of the heap to create.
 398  *
 399  * @return
 400  *   - 0 on successful creation
 401  *   - -1 in case of error, with rte_errno set to one of the following:
 402  *     EINVAL - ``heap_name`` was NULL, empty or too long
 403  *     EEXIST - heap by name of ``heap_name`` already exists
 404  *     ENOSPC - no more space in internal config to store a new heap
 405  */
 406 int __rte_experimental
 407 rte_malloc_heap_create(const char *heap_name);
 408
 409 /**
 410  * Destroys a previously created malloc heap with specified name.
 411  *
 412  * @note This function will return a failure result if not all memory allocated
 413  *   from the heap has been freed back to the heap
 414  *
 415  * @note This function will return a failure result if not all memory segments
 416  *   were removed from the heap prior to its destruction
 417  *
 418  * @param heap_name
 419  *   Name of the heap to create.
 420  *
 421  * @return
 422  *   - 0 on success
 423  *   - -1 in case of error, with rte_errno set to one of the following:
 424  *     EINVAL - ``heap_name`` was NULL, empty or too long
 425  *     ENOENT - heap by the name of ``heap_name`` was not found
 426  *     EPERM  - attempting to destroy reserved heap
 427  *     EBUSY  - heap still contains data
 428  */
 429 int __rte_experimental
 430 rte_malloc_heap_destroy(const char *heap_name);
 431
 432 /**
 433  * Find socket ID corresponding to a named heap.
 434  *
 435  * @param name
 436  *   Heap name to find socket ID for
 437  * @return
 438  *   Socket ID in case of success (a non-negative number)
 439  *   -1 in case of error, with rte_errno set to one of the following:
 440  *     EINVAL - ``name`` was NULL
 441  *     ENOENT - heap identified by the name ``name`` was not found
 442  */
 443 int __rte_experimental
 444 rte_malloc_heap_get_socket(const char *name);
 445
 446 /**
 447  * Check if a given socket ID refers to externally allocated memory.
 448  *
 449  * @note Passing SOCKET_ID_ANY will return 0.
 450  *
 451  * @param socket_id
 452  *   Socket ID to check
 453  * @return
 454  *   1 if socket ID refers to externally allocated memory
 455  *   0 if socket ID refers to internal DPDK memory
 456  *   -1 if socket ID is invalid
 457  */
 458 int __rte_experimental
 459 rte_malloc_heap_socket_is_external(int socket_id);
 460
 461 /**
 462  * Dump statistics.
 463  *
 464  * Dump for the specified type to a file. If the type argument is
 465  * NULL, all memory types will be dumped.
 466  *
 467  * @note This function is not thread-safe with respect to
 468  *    ``rte_malloc_heap_create()``/``rte_malloc_heap_destroy()`` functions.
 469  *
 470  * @param f
 471  *   A pointer to a file for output
 472  * @param type
 473  *   A string identifying the type of objects to dump, or NULL
 474  *   to dump all objects.
 475  */
 476 void
 477 rte_malloc_dump_stats(FILE *f, const char *type);
 478
 479 /**
 480  * Dump contents of all malloc heaps to a file.
 481  *
 482  * @note This function is not thread-safe with respect to
 483  *    ``rte_malloc_heap_create()``/``rte_malloc_heap_destroy()`` functions.
 484  *
 485  * @param f
 486  *   A pointer to a file for output
 487  */
 488 void __rte_experimental
 489 rte_malloc_dump_heaps(FILE *f);
 490
 491 /**
 492  * Set the maximum amount of allocated memory for this type.
 493  *
 494  * This is not yet implemented
 495  *
 496  * @param type
 497  *   A string identifying the type of allocated objects.
 498  * @param max
 499  *   The maximum amount of allocated bytes for this type.
 500  * @return
 501  *   - 0: Success.
 502  *   - (-1): Error.
 503  */
 504 int
 505 rte_malloc_set_limit(const char *type, size_t max);
 506
 507 /**
 508  * Return the IO address of a virtual address obtained through
 509  * rte_malloc
 510  *
 511  * @param addr
 512  *   Address obtained from a previous rte_malloc call
 513  * @return
 514  *   RTE_BAD_IOVA on error
 515  *   otherwise return an address suitable for IO
 516  */
 517 rte_iova_t
 518 rte_malloc_virt2iova(const void *addr);
 519
 520 __rte_deprecated
 521 static inline phys_addr_t
 522 rte_malloc_virt2phy(const void *addr)
 523 {
 524         return rte_malloc_virt2iova(addr);
 525 }
 526
 527 #ifdef __cplusplus
 528 }
 529 #endif
 530
 531 #endif /* _RTE_MALLOC_H_ */