DPDK: Data Plane Development Kit

18.02.0-rc0
rte_malloc.h File Reference
#include <stdio.h>
#include <stddef.h>
#include <rte_memory.h>

Go to the source code of this file.

Data Structures

struct  rte_malloc_socket_stats

Functions

void * rte_malloc (const char *type, size_t size, unsigned align)
void * rte_zmalloc (const char *type, size_t size, unsigned align)
void * rte_calloc (const char *type, size_t num, size_t size, unsigned align)
void * rte_realloc (void *ptr, size_t size, unsigned align)
void * rte_malloc_socket (const char *type, size_t size, unsigned align, int socket)
void * rte_zmalloc_socket (const char *type, size_t size, unsigned align, int socket)
void * rte_calloc_socket (const char *type, size_t num, size_t size, unsigned align, int socket)
void rte_free (void *ptr)
int rte_malloc_validate (const void *ptr, size_t *size)
int rte_malloc_get_socket_stats (int socket, struct rte_malloc_socket_stats *socket_stats)
void rte_malloc_dump_stats (FILE *f, const char *type)
int rte_malloc_set_limit (const char *type, size_t max)
rte_iova_t rte_malloc_virt2iova (const void *addr)

Detailed Description

RTE Malloc. This library provides methods for dynamically allocating memory from hugepages.

Definition in file rte_malloc.h.

Function Documentation

void* rte_malloc ( const char *  type,
size_t  size,
unsigned  align 
)

This function allocates memory from the huge-page area of memory. The memory is not cleared. In NUMA systems, the memory allocated resides on the same NUMA socket as the core that calls this function.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
sizeSize (in bytes) to be allocated.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
Examples:
examples/distributor/main.c, examples/eventdev_pipeline_sw_pmd/main.c, examples/ip_pipeline/pipeline/pipeline_firewall.c, examples/ip_pipeline/pipeline/pipeline_flow_actions.c, examples/ip_pipeline/pipeline/pipeline_flow_classification.c, examples/ip_pipeline/pipeline/pipeline_routing.c, examples/l2fwd-crypto/main.c, examples/multi_process/client_server_mp/mp_server/init.c, examples/multi_process/l2fwd_fork/main.c, examples/qos_sched/main.c, examples/server_node_efd/server/init.c, examples/vm_power_manager/channel_manager.c, and examples/vm_power_manager/channel_monitor.c.
void* rte_zmalloc ( const char *  type,
size_t  size,
unsigned  align 
)

Allocate zero'ed memory from the heap.

Equivalent to rte_malloc() except that the memory zone is initialised with zeros. In NUMA systems, the memory allocated resides on the same NUMA socket as the core that calls this function.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
sizeSize (in bytes) to be allocated.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must obviously be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
Examples:
examples/flow_classify/flow_classify.c, examples/ip_pipeline/pipeline/pipeline_firewall.c, examples/ip_pipeline/pipeline/pipeline_firewall_be.c, examples/ip_pipeline/pipeline/pipeline_flow_actions.c, examples/ip_pipeline/pipeline/pipeline_flow_actions_be.c, examples/ip_pipeline/pipeline/pipeline_flow_classification.c, examples/ip_pipeline/pipeline/pipeline_flow_classification_be.c, examples/ip_pipeline/pipeline/pipeline_master_be.c, examples/ip_pipeline/pipeline/pipeline_passthrough_be.c, examples/ip_pipeline/pipeline/pipeline_routing.c, examples/ip_pipeline/pipeline/pipeline_routing_be.c, examples/kni/main.c, examples/multi_process/l2fwd_fork/flib.c, examples/multi_process/l2fwd_fork/main.c, examples/tep_termination/main.c, examples/vhost/main.c, examples/vhost_scsi/vhost_scsi.c, and examples/vm_power_manager/channel_manager.c.
void* rte_calloc ( const char *  type,
size_t  num,
size_t  size,
unsigned  align 
)

Replacement function for calloc(), using huge-page memory. Memory area is initialised with zeros. In NUMA systems, the memory allocated resides on the same NUMA socket as the core that calls this function.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
numNumber of elements to be allocated.
sizeSize (in bytes) of a single element.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must obviously be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
Examples:
examples/eventdev_pipeline_sw_pmd/main.c.
void* rte_realloc ( void *  ptr,
size_t  size,
unsigned  align 
)

Replacement function for realloc(), using huge-page memory. Reserved area memory is resized, preserving contents. In NUMA systems, the new area resides on the same NUMA socket as the old area.

Parameters
ptrPointer to already allocated memory
sizeSize (in bytes) of new area. If this is 0, memory is freed.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must obviously be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the reallocated memory.
void* rte_malloc_socket ( const char *  type,
size_t  size,
unsigned  align,
int  socket 
)

This function allocates memory from the huge-page area of memory. The memory is not cleared.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
sizeSize (in bytes) to be allocated.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
socketNUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function will behave the same as rte_malloc().
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
void* rte_zmalloc_socket ( const char *  type,
size_t  size,
unsigned  align,
int  socket 
)

Allocate zero'ed memory from the heap.

Equivalent to rte_malloc() except that the memory zone is initialised with zeros.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
sizeSize (in bytes) to be allocated.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must obviously be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
socketNUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function will behave the same as rte_zmalloc().
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
Examples:
examples/ip_reassembly/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/link_status_interrupt/main.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/l2fwd_fork/main.c, examples/netmap_compat/lib/compat_netmap.c, examples/packet_ordering/main.c, examples/qos_meter/main.c, and examples/server_node_efd/node/node.c.
void* rte_calloc_socket ( const char *  type,
size_t  num,
size_t  size,
unsigned  align,
int  socket 
)

Replacement function for calloc(), using huge-page memory. Memory area is initialised with zeros.

Parameters
typeA string identifying the type of allocated objects (useful for debug purposes, such as identifying the cause of a memory leak). Can be NULL.
numNumber of elements to be allocated.
sizeSize (in bytes) of a single element.
alignIf 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of align. In this case, it must obviously be a power of two. (Minimum alignment is the cacheline size, i.e. 64-bytes)
socketNUMA socket to allocate memory on. If SOCKET_ID_ANY is used, this function will behave the same as rte_calloc().
Returns
  • NULL on error. Not enough memory, or invalid arguments (size is 0, align is not a power of two).
  • Otherwise, the pointer to the allocated object.
Examples:
examples/performance-thread/common/lthread_sched.c.
int rte_malloc_validate ( const void *  ptr,
size_t *  size 
)

If malloc debug is enabled, check a memory block for header and trailer markers to indicate that all is well with the block. If size is non-null, also return the size of the block.

Parameters
ptrpointer to the start of a data block, must have been returned by a previous call to rte_malloc(), rte_zmalloc(), rte_calloc() or rte_realloc()
sizeif non-null, and memory block pointer is valid, returns the size of the memory block
Returns
-1 on error, invalid pointer passed or header and trailer markers are missing or corrupted 0 on success
int rte_malloc_get_socket_stats ( int  socket,
struct rte_malloc_socket_stats socket_stats 
)

Get heap statistics for the specified heap.

Parameters
socketAn unsigned integer specifying the socket to get heap statistics for
socket_statsA structure which provides memory to store statistics
Returns
Null on error Pointer to structure storing statistics on success
void rte_malloc_dump_stats ( FILE *  f,
const char *  type 
)

Dump statistics.

Dump for the specified type to a file. If the type argument is NULL, all memory types will be dumped.

Parameters
fA pointer to a file for output
typeA string identifying the type of objects to dump, or NULL to dump all objects.
int rte_malloc_set_limit ( const char *  type,
size_t  max 
)

Set the maximum amount of allocated memory for this type.

This is not yet implemented

Parameters
typeA string identifying the type of allocated objects.
maxThe maximum amount of allocated bytes for this type.
Returns
  • 0: Success.
  • (-1): Error.
rte_iova_t rte_malloc_virt2iova ( const void *  addr)

Return the IO address of a virtual address obtained through rte_malloc

Parameters
addrAddress obtained from a previous rte_malloc call
Returns
RTE_BAD_IOVA on error otherwise return an address suitable for IO
Examples:
examples/l2fwd-crypto/main.c.