lib/librte_eal/common/include/rte_memory.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_MEMORY_H_
   6 #define _RTE_MEMORY_H_
   7
   8 /**
   9  * @file
  10  *
  11  * Memory-related RTE API.
  12  */
  13
  14 #include <stdint.h>
  15 #include <stddef.h>
  16 #include <stdio.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 #include <rte_common.h>
  23 #include <rte_compat.h>
  24 #include <rte_config.h>
  25
  26 /* forward declaration for pointers */
  27 struct rte_memseg_list;
  28
  29 __extension__
  30 enum rte_page_sizes {
  31         RTE_PGSIZE_4K    = 1ULL << 12,
  32         RTE_PGSIZE_64K   = 1ULL << 16,
  33         RTE_PGSIZE_256K  = 1ULL << 18,
  34         RTE_PGSIZE_2M    = 1ULL << 21,
  35         RTE_PGSIZE_16M   = 1ULL << 24,
  36         RTE_PGSIZE_256M  = 1ULL << 28,
  37         RTE_PGSIZE_512M  = 1ULL << 29,
  38         RTE_PGSIZE_1G    = 1ULL << 30,
  39         RTE_PGSIZE_4G    = 1ULL << 32,
  40         RTE_PGSIZE_16G   = 1ULL << 34,
  41 };
  42
  43 #define SOCKET_ID_ANY -1                    /**< Any NUMA socket. */
  44 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */
  45
  46 #define RTE_CACHE_LINE_ROUNDUP(size) \
  47         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
  48 /**< Return the first cache-aligned value greater or equal to size. */
  49
  50 /**< Cache line size in terms of log2 */
  51 #if RTE_CACHE_LINE_SIZE == 64
  52 #define RTE_CACHE_LINE_SIZE_LOG2 6
  53 #elif RTE_CACHE_LINE_SIZE == 128
  54 #define RTE_CACHE_LINE_SIZE_LOG2 7
  55 #else
  56 #error "Unsupported cache line size"
  57 #endif
  58
  59 #define RTE_CACHE_LINE_MIN_SIZE 64      /**< Minimum Cache line size. */
  60
  61 /**
  62  * Force alignment to cache line.
  63  */
  64 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
  65
  66 /**
  67  * Force minimum cache line alignment.
  68  */
  69 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
  70
  71 typedef uint64_t phys_addr_t; /**< Physical address. */
  72 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
  73 /**
  74  * IO virtual address type.
  75  * When the physical addressing mode (IOVA as PA) is in use,
  76  * the translation from an IO virtual address (IOVA) to a physical address
  77  * is a direct mapping, i.e. the same value.
  78  * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
  79  */
  80 typedef uint64_t rte_iova_t;
  81 #define RTE_BAD_IOVA ((rte_iova_t)-1)
  82
  83 /**
  84  * Physical memory segment descriptor.
  85  */
  86 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
  87 /**< Prevent this segment from being freed back to the OS. */
  88 struct rte_memseg {
  89         RTE_STD_C11
  90         union {
  91                 phys_addr_t phys_addr;  /**< deprecated - Start physical address. */
  92                 rte_iova_t iova;        /**< Start IO address. */
  93         };
  94         RTE_STD_C11
  95         union {
  96                 void *addr;         /**< Start virtual address. */
  97                 uint64_t addr_64;   /**< Makes sure addr is always 64 bits */
  98         };
  99         size_t len;               /**< Length of the segment. */
 100         uint64_t hugepage_sz;       /**< The pagesize of underlying memory */
 101         int32_t socket_id;          /**< NUMA socket ID. */
 102         uint32_t nchannel;          /**< Number of channels. */
 103         uint32_t nrank;             /**< Number of ranks. */
 104         uint32_t flags;             /**< Memseg-specific flags */
 105 } __rte_packed;
 106
 107 /**
 108  * Lock page in physical memory and prevent from swapping.
 109  *
 110  * @param virt
 111  *   The virtual address.
 112  * @return
 113  *   0 on success, negative on error.
 114  */
 115 int rte_mem_lock_page(const void *virt);
 116
 117 /**
 118  * Get physical address of any mapped virtual address in the current process.
 119  * It is found by browsing the /proc/self/pagemap special file.
 120  * The page must be locked.
 121  *
 122  * @param virt
 123  *   The virtual address.
 124  * @return
 125  *   The physical address or RTE_BAD_IOVA on error.
 126  */
 127 phys_addr_t rte_mem_virt2phy(const void *virt);
 128
 129 /**
 130  * Get IO virtual address of any mapped virtual address in the current process.
 131  *
 132  * @param virt
 133  *   The virtual address.
 134  * @return
 135  *   The IO address or RTE_BAD_IOVA on error.
 136  */
 137 rte_iova_t rte_mem_virt2iova(const void *virt);
 138
 139 /**
 140  * Get virtual memory address corresponding to iova address.
 141  *
 142  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 143  *       be used within memory-related callback functions.
 144  *
 145  * @param iova
 146  *   The iova address.
 147  * @return
 148  *   Virtual address corresponding to iova address (or NULL if address does not
 149  *   exist within DPDK memory map).
 150  */
 151 __rte_experimental void *
 152 rte_mem_iova2virt(rte_iova_t iova);
 153
 154 /**
 155  * Get memseg to which a particular virtual address belongs.
 156  *
 157  * @param virt
 158  *   The virtual address.
 159  * @param msl
 160  *   The memseg list in which to look up based on ``virt`` address
 161  *   (can be NULL).
 162  * @return
 163  *   Memseg pointer on success, or NULL on error.
 164  */
 165 __rte_experimental struct rte_memseg *
 166 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
 167
 168 /**
 169  * Get memseg list corresponding to virtual memory address.
 170  *
 171  * @param virt
 172  *   The virtual address.
 173  * @return
 174  *   Memseg list to which this virtual address belongs to.
 175  */
 176 __rte_experimental struct rte_memseg_list *
 177 rte_mem_virt2memseg_list(const void *virt);
 178
 179 /**
 180  * Memseg walk function prototype.
 181  *
 182  * Returning 0 will continue walk
 183  * Returning 1 will stop the walk
 184  * Returning -1 will stop the walk and report error
 185  */
 186 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
 187                 const struct rte_memseg *ms, void *arg);
 188
 189 /**
 190  * Memseg contig walk function prototype. This will trigger a callback on every
 191  * VA-contiguous are starting at memseg ``ms``, so total valid VA space at each
 192  * callback call will be [``ms->addr``, ``ms->addr + len``).
 193  *
 194  * Returning 0 will continue walk
 195  * Returning 1 will stop the walk
 196  * Returning -1 will stop the walk and report error
 197  */
 198 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
 199                 const struct rte_memseg *ms, size_t len, void *arg);
 200
 201 /**
 202  * Memseg list walk function prototype. This will trigger a callback on every
 203  * allocated memseg list.
 204  *
 205  * Returning 0 will continue walk
 206  * Returning 1 will stop the walk
 207  * Returning -1 will stop the walk and report error
 208  */
 209 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
 210                 void *arg);
 211
 212 /**
 213  * Walk list of all memsegs.
 214  *
 215  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 216  *       be used within memory-related callback functions.
 217  *
 218  * @note This function will also walk through externally allocated segments. It
 219  *       is up to the user to decide whether to skip through these segments.
 220  *
 221  * @param func
 222  *   Iterator function
 223  * @param arg
 224  *   Argument passed to iterator
 225  * @return
 226  *   0 if walked over the entire list
 227  *   1 if stopped by the user
 228  *   -1 if user function reported error
 229  */
 230 int __rte_experimental
 231 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
 232
 233 /**
 234  * Walk each VA-contiguous area.
 235  *
 236  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 237  *       be used within memory-related callback functions.
 238  *
 239  * @note This function will also walk through externally allocated segments. It
 240  *       is up to the user to decide whether to skip through these segments.
 241  *
 242  * @param func
 243  *   Iterator function
 244  * @param arg
 245  *   Argument passed to iterator
 246  * @return
 247  *   0 if walked over the entire list
 248  *   1 if stopped by the user
 249  *   -1 if user function reported error
 250  */
 251 int __rte_experimental
 252 rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg);
 253
 254 /**
 255  * Walk each allocated memseg list.
 256  *
 257  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 258  *       be used within memory-related callback functions.
 259  *
 260  * @note This function will also walk through externally allocated segments. It
 261  *       is up to the user to decide whether to skip through these segments.
 262  *
 263  * @param func
 264  *   Iterator function
 265  * @param arg
 266  *   Argument passed to iterator
 267  * @return
 268  *   0 if walked over the entire list
 269  *   1 if stopped by the user
 270  *   -1 if user function reported error
 271  */
 272 int __rte_experimental
 273 rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg);
 274
 275 /**
 276  * Walk list of all memsegs without performing any locking.
 277  *
 278  * @note This function does not perform any locking, and is only safe to call
 279  *       from within memory-related callback functions.
 280  *
 281  * @param func
 282  *   Iterator function
 283  * @param arg
 284  *   Argument passed to iterator
 285  * @return
 286  *   0 if walked over the entire list
 287  *   1 if stopped by the user
 288  *   -1 if user function reported error
 289  */
 290 int __rte_experimental
 291 rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg);
 292
 293 /**
 294  * Walk each VA-contiguous area without performing any locking.
 295  *
 296  * @note This function does not perform any locking, and is only safe to call
 297  *       from within memory-related callback functions.
 298  *
 299  * @param func
 300  *   Iterator function
 301  * @param arg
 302  *   Argument passed to iterator
 303  * @return
 304  *   0 if walked over the entire list
 305  *   1 if stopped by the user
 306  *   -1 if user function reported error
 307  */
 308 int __rte_experimental
 309 rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg);
 310
 311 /**
 312  * Walk each allocated memseg list without performing any locking.
 313  *
 314  * @note This function does not perform any locking, and is only safe to call
 315  *       from within memory-related callback functions.
 316  *
 317  * @param func
 318  *   Iterator function
 319  * @param arg
 320  *   Argument passed to iterator
 321  * @return
 322  *   0 if walked over the entire list
 323  *   1 if stopped by the user
 324  *   -1 if user function reported error
 325  */
 326 int __rte_experimental
 327 rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg);
 328
 329 /**
 330  * Return file descriptor associated with a particular memseg (if available).
 331  *
 332  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 333  *       be used within memory-related callback functions.
 334  *
 335  * @note This returns an internal file descriptor. Performing any operations on
 336  *       this file descriptor is inherently dangerous, so it should be treated
 337  *       as read-only for all intents and purposes.
 338  *
 339  * @param ms
 340  *   A pointer to memseg for which to get file descriptor.
 341  *
 342  * @return
 343  *   Valid file descriptor in case of success.
 344  *   -1 in case of error, with ``rte_errno`` set to the following values:
 345  *     - EINVAL  - ``ms`` pointer was NULL or did not point to a valid memseg
 346  *     - ENODEV  - ``ms`` fd is not available
 347  *     - ENOENT  - ``ms`` is an unused segment
 348  *     - ENOTSUP - segment fd's are not supported
 349  */
 350 int __rte_experimental
 351 rte_memseg_get_fd(const struct rte_memseg *ms);
 352
 353 /**
 354  * Return file descriptor associated with a particular memseg (if available).
 355  *
 356  * @note This function does not perform any locking, and is only safe to call
 357  *       from within memory-related callback functions.
 358  *
 359  * @note This returns an internal file descriptor. Performing any operations on
 360  *       this file descriptor is inherently dangerous, so it should be treated
 361  *       as read-only for all intents and purposes.
 362  *
 363  * @param ms
 364  *   A pointer to memseg for which to get file descriptor.
 365  *
 366  * @return
 367  *   Valid file descriptor in case of success.
 368  *   -1 in case of error, with ``rte_errno`` set to the following values:
 369  *     - EINVAL  - ``ms`` pointer was NULL or did not point to a valid memseg
 370  *     - ENODEV  - ``ms`` fd is not available
 371  *     - ENOENT  - ``ms`` is an unused segment
 372  *     - ENOTSUP - segment fd's are not supported
 373  */
 374 int __rte_experimental
 375 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
 376
 377 /**
 378  * Get offset into segment file descriptor associated with a particular memseg
 379  * (if available).
 380  *
 381  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 382  *       be used within memory-related callback functions.
 383  *
 384  * @param ms
 385  *   A pointer to memseg for which to get file descriptor.
 386  * @param offset
 387  *   A pointer to offset value where the result will be stored.
 388  *
 389  * @return
 390  *   Valid file descriptor in case of success.
 391  *   -1 in case of error, with ``rte_errno`` set to the following values:
 392  *     - EINVAL  - ``ms`` pointer was NULL or did not point to a valid memseg
 393  *     - EINVAL  - ``offset`` pointer was NULL
 394  *     - ENODEV  - ``ms`` fd is not available
 395  *     - ENOENT  - ``ms`` is an unused segment
 396  *     - ENOTSUP - segment fd's are not supported
 397  */
 398 int __rte_experimental
 399 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
 400
 401 /**
 402  * Get offset into segment file descriptor associated with a particular memseg
 403  * (if available).
 404  *
 405  * @note This function does not perform any locking, and is only safe to call
 406  *       from within memory-related callback functions.
 407  *
 408  * @param ms
 409  *   A pointer to memseg for which to get file descriptor.
 410  * @param offset
 411  *   A pointer to offset value where the result will be stored.
 412  *
 413  * @return
 414  *   Valid file descriptor in case of success.
 415  *   -1 in case of error, with ``rte_errno`` set to the following values:
 416  *     - EINVAL  - ``ms`` pointer was NULL or did not point to a valid memseg
 417  *     - EINVAL  - ``offset`` pointer was NULL
 418  *     - ENODEV  - ``ms`` fd is not available
 419  *     - ENOENT  - ``ms`` is an unused segment
 420  *     - ENOTSUP - segment fd's are not supported
 421  */
 422 int __rte_experimental
 423 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
 424                 size_t *offset);
 425
 426 /**
 427  * Dump the physical memory layout to a file.
 428  *
 429  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 430  *       be used within memory-related callback functions.
 431  *
 432  * @param f
 433  *   A pointer to a file for output
 434  */
 435 void rte_dump_physmem_layout(FILE *f);
 436
 437 /**
 438  * Get the total amount of available physical memory.
 439  *
 440  * @note This function read-locks the memory hotplug subsystem, and thus cannot
 441  *       be used within memory-related callback functions.
 442  *
 443  * @return
 444  *    The total amount of available physical memory in bytes.
 445  */
 446 uint64_t rte_eal_get_physmem_size(void);
 447
 448 /**
 449  * Get the number of memory channels.
 450  *
 451  * @return
 452  *   The number of memory channels on the system. The value is 0 if unknown
 453  *   or not the same on all devices.
 454  */
 455 unsigned rte_memory_get_nchannel(void);
 456
 457 /**
 458  * Get the number of memory ranks.
 459  *
 460  * @return
 461  *   The number of memory ranks on the system. The value is 0 if unknown or
 462  *   not the same on all devices.
 463  */
 464 unsigned rte_memory_get_nrank(void);
 465
 466 /* check memsegs iovas are within a range based on dma mask */
 467 int __rte_experimental rte_eal_check_dma_mask(uint8_t maskbits);
 468
 469 /**
 470  * Drivers based on uio will not load unless physical
 471  * addresses are obtainable. It is only possible to get
 472  * physical addresses when running as a privileged user.
 473  *
 474  * @return
 475  *   1 if the system is able to obtain physical addresses.
 476  *   0 if using DMA addresses through an IOMMU.
 477  */
 478 int rte_eal_using_phys_addrs(void);
 479
 480
 481 /**
 482  * Enum indicating which kind of memory event has happened. Used by callbacks to
 483  * distinguish between memory allocations and deallocations.
 484  */
 485 enum rte_mem_event {
 486         RTE_MEM_EVENT_ALLOC = 0, /**< Allocation event. */
 487         RTE_MEM_EVENT_FREE,      /**< Deallocation event. */
 488 };
 489 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
 490 /**< maximum length of callback name */
 491
 492 /**
 493  * Function typedef used to register callbacks for memory events.
 494  */
 495 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
 496                 const void *addr, size_t len, void *arg);
 497
 498 /**
 499  * Function used to register callbacks for memory events.
 500  *
 501  * @note callbacks will happen while memory hotplug subsystem is write-locked,
 502  *       therefore some functions (e.g. `rte_memseg_walk()`) will cause a
 503  *       deadlock when called from within such callbacks.
 504  *
 505  * @note mem event callbacks not being supported is an expected error condition,
 506  *       so user code needs to handle this situation. In these cases, return
 507  *       value will be -1, and rte_errno will be set to ENOTSUP.
 508  *
 509  * @param name
 510  *   Name associated with specified callback to be added to the list.
 511  *
 512  * @param clb
 513  *   Callback function pointer.
 514  *
 515  * @param arg
 516  *   Argument to pass to the callback.
 517  *
 518  * @return
 519  *   0 on successful callback register
 520  *   -1 on unsuccessful callback register, with rte_errno value indicating
 521  *   reason for failure.
 522  */
 523 int __rte_experimental
 524 rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb,
 525                 void *arg);
 526
 527 /**
 528  * Function used to unregister callbacks for memory events.
 529  *
 530  * @param name
 531  *   Name associated with specified callback to be removed from the list.
 532  *
 533  * @param arg
 534  *   Argument to look for among callbacks with specified callback name.
 535  *
 536  * @return
 537  *   0 on successful callback unregister
 538  *   -1 on unsuccessful callback unregister, with rte_errno value indicating
 539  *   reason for failure.
 540  */
 541 int __rte_experimental
 542 rte_mem_event_callback_unregister(const char *name, void *arg);
 543
 544
 545 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
 546 /**< maximum length of alloc validator name */
 547 /**
 548  * Function typedef used to register memory allocation validation callbacks.
 549  *
 550  * Returning 0 will allow allocation attempt to continue. Returning -1 will
 551  * prevent allocation from succeeding.
 552  */
 553 typedef int (*rte_mem_alloc_validator_t)(int socket_id,
 554                 size_t cur_limit, size_t new_len);
 555
 556 /**
 557  * @brief Register validator callback for memory allocations.
 558  *
 559  * Callbacks registered by this function will be called right before memory
 560  * allocator is about to trigger allocation of more pages from the system if
 561  * said allocation will bring total memory usage above specified limit on
 562  * specified socket. User will be able to cancel pending allocation if callback
 563  * returns -1.
 564  *
 565  * @note callbacks will happen while memory hotplug subsystem is write-locked,
 566  *       therefore some functions (e.g. `rte_memseg_walk()`) will cause a
 567  *       deadlock when called from within such callbacks.
 568  *
 569  * @note validator callbacks not being supported is an expected error condition,
 570  *       so user code needs to handle this situation. In these cases, return
 571  *       value will be -1, and rte_errno will be set to ENOTSUP.
 572  *
 573  * @param name
 574  *   Name associated with specified callback to be added to the list.
 575  *
 576  * @param clb
 577  *   Callback function pointer.
 578  *
 579  * @param socket_id
 580  *   Socket ID on which to watch for allocations.
 581  *
 582  * @param limit
 583  *   Limit above which to trigger callbacks.
 584  *
 585  * @return
 586  *   0 on successful callback register
 587  *   -1 on unsuccessful callback register, with rte_errno value indicating
 588  *   reason for failure.
 589  */
 590 int __rte_experimental
 591 rte_mem_alloc_validator_register(const char *name,
 592                 rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
 593
 594 /**
 595  * @brief Unregister validator callback for memory allocations.
 596  *
 597  * @param name
 598  *   Name associated with specified callback to be removed from the list.
 599  *
 600  * @param socket_id
 601  *   Socket ID on which to watch for allocations.
 602  *
 603  * @return
 604  *   0 on successful callback unregister
 605  *   -1 on unsuccessful callback unregister, with rte_errno value indicating
 606  *   reason for failure.
 607  */
 608 int __rte_experimental
 609 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
 610
 611 #ifdef __cplusplus
 612 }
 613 #endif
 614
 615 #endif /* _RTE_MEMORY_H_ */