DPDK: Data Plane Development Kit

18.02.0-rc0
rte_memzone.h File Reference
#include <stdio.h>
#include <rte_memory.h>
#include <rte_common.h>

Go to the source code of this file.

Data Structures

struct  rte_memzone

Macros

#define RTE_MEMZONE_2MB   0x00000001
#define RTE_MEMZONE_1GB   0x00000002
#define RTE_MEMZONE_16MB   0x00000100
#define RTE_MEMZONE_16GB   0x00000200
#define RTE_MEMZONE_256KB   0x00010000
#define RTE_MEMZONE_256MB   0x00020000
#define RTE_MEMZONE_512MB   0x00040000
#define RTE_MEMZONE_4GB   0x00080000
#define RTE_MEMZONE_SIZE_HINT_ONLY   0x00000004
#define RTE_MEMZONE_NAMESIZE   32

Functions

struct rte_memzonerte_memzone_reserve (const char *name, size_t len, int socket_id, unsigned flags)
struct rte_memzonerte_memzone_reserve_aligned (const char *name, size_t len, int socket_id, unsigned flags, unsigned align)
struct rte_memzonerte_memzone_reserve_bounded (const char *name, size_t len, int socket_id, unsigned flags, unsigned align, unsigned bound)
int rte_memzone_free (const struct rte_memzone *mz)
struct rte_memzonerte_memzone_lookup (const char *name)
void rte_memzone_dump (FILE *f)
void rte_memzone_walk (void(*func)(const struct rte_memzone *, void *arg), void *arg)

Detailed Description

RTE Memzone

The goal of the memzone allocator is to reserve contiguous portions of physical memory. These zones are identified by a name.

The memzone descriptors are shared by all partitions and are located in a known place of physical memory. This zone is accessed using rte_eal_get_configuration(). The lookup (by name) of a memory zone can be done in any partition and returns the same physical address.

A reserved memory zone cannot be unreserved. The reservation shall be done at initialization time only.

Definition in file rte_memzone.h.

Macro Definition Documentation

#define RTE_MEMZONE_2MB   0x00000001

Use 2MB pages.

Definition at line 62 of file rte_memzone.h.

#define RTE_MEMZONE_1GB   0x00000002

Use 1GB pages.

Examples:
examples/ipsec-secgw/sa.c.

Definition at line 63 of file rte_memzone.h.

#define RTE_MEMZONE_16MB   0x00000100

Use 16MB pages.

Definition at line 64 of file rte_memzone.h.

#define RTE_MEMZONE_16GB   0x00000200

Use 16GB pages.

Definition at line 65 of file rte_memzone.h.

#define RTE_MEMZONE_256KB   0x00010000

Use 256KB pages.

Definition at line 66 of file rte_memzone.h.

#define RTE_MEMZONE_256MB   0x00020000

Use 256MB pages.

Definition at line 67 of file rte_memzone.h.

#define RTE_MEMZONE_512MB   0x00040000

Use 512MB pages.

Definition at line 68 of file rte_memzone.h.

#define RTE_MEMZONE_4GB   0x00080000

Use 4GB pages.

Definition at line 69 of file rte_memzone.h.

#define RTE_MEMZONE_SIZE_HINT_ONLY   0x00000004

Use available page size

Examples:
examples/ipsec-secgw/sa.c.

Definition at line 70 of file rte_memzone.h.

#define RTE_MEMZONE_NAMESIZE   32

Maximum length of memory zone name.

Definition at line 78 of file rte_memzone.h.

Function Documentation

struct rte_memzone* rte_memzone_reserve ( const char *  name,
size_t  len,
int  socket_id,
unsigned  flags 
)
read

Reserve a portion of physical memory.

This function reserves some memory and returns a pointer to a correctly filled memzone descriptor. If the allocation cannot be done, return NULL.

Parameters
nameThe name of the memzone. If it already exists, the function will fail and return NULL.
lenThe size of the memory to be reserved. If it is 0, the biggest contiguous zone will be reserved.
socket_idThe socket identifier in the case of NUMA. The value can be SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
flagsThe flags parameter is used to request memzones to be taken from specifically sized hugepages.
  • RTE_MEMZONE_2MB - Reserved from 2MB pages
  • RTE_MEMZONE_1GB - Reserved from 1GB pages
  • RTE_MEMZONE_16MB - Reserved from 16MB pages
  • RTE_MEMZONE_16GB - Reserved from 16GB pages
  • RTE_MEMZONE_256KB - Reserved from 256KB pages
  • RTE_MEMZONE_256MB - Reserved from 256MB pages
  • RTE_MEMZONE_512MB - Reserved from 512MB pages
  • RTE_MEMZONE_4GB - Reserved from 4GB pages
  • RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if the requested page size is unavailable. If this flag is not set, the function will return error on an unavailable size request.
Returns
A pointer to a correctly-filled read-only memzone descriptor, or NULL on error. On error case, rte_errno will be set appropriately:
  • E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
  • E_RTE_SECONDARY - function was called from a secondary process instance
  • ENOSPC - the maximum number of memzones has already been allocated
  • EEXIST - a memzone with the same name already exists
  • ENOMEM - no appropriate memory area found in which to create memzone
  • EINVAL - invalid parameters
Examples:
examples/ipsec-secgw/sa.c, examples/multi_process/client_server_mp/mp_server/init.c, examples/quota_watermark/qw/init.c, and examples/server_node_efd/server/init.c.
struct rte_memzone* rte_memzone_reserve_aligned ( const char *  name,
size_t  len,
int  socket_id,
unsigned  flags,
unsigned  align 
)
read

Reserve a portion of physical memory with alignment on a specified boundary.

This function reserves some memory with alignment on a specified boundary, and returns a pointer to a correctly filled memzone descriptor. If the allocation cannot be done or if the alignment is not a power of 2, returns NULL.

Parameters
nameThe name of the memzone. If it already exists, the function will fail and return NULL.
lenThe size of the memory to be reserved. If it is 0, the biggest contiguous zone will be reserved.
socket_idThe socket identifier in the case of NUMA. The value can be SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
flagsThe flags parameter is used to request memzones to be taken from specifically sized hugepages.
  • RTE_MEMZONE_2MB - Reserved from 2MB pages
  • RTE_MEMZONE_1GB - Reserved from 1GB pages
  • RTE_MEMZONE_16MB - Reserved from 16MB pages
  • RTE_MEMZONE_16GB - Reserved from 16GB pages
  • RTE_MEMZONE_256KB - Reserved from 256KB pages
  • RTE_MEMZONE_256MB - Reserved from 256MB pages
  • RTE_MEMZONE_512MB - Reserved from 512MB pages
  • RTE_MEMZONE_4GB - Reserved from 4GB pages
  • RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if the requested page size is unavailable. If this flag is not set, the function will return error on an unavailable size request.
alignAlignment for resulting memzone. Must be a power of 2.
Returns
A pointer to a correctly-filled read-only memzone descriptor, or NULL on error. On error case, rte_errno will be set appropriately:
  • E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
  • E_RTE_SECONDARY - function was called from a secondary process instance
  • ENOSPC - the maximum number of memzones has already been allocated
  • EEXIST - a memzone with the same name already exists
  • ENOMEM - no appropriate memory area found in which to create memzone
  • EINVAL - invalid parameters
struct rte_memzone* rte_memzone_reserve_bounded ( const char *  name,
size_t  len,
int  socket_id,
unsigned  flags,
unsigned  align,
unsigned  bound 
)
read

Reserve a portion of physical memory with specified alignment and boundary.

This function reserves some memory with specified alignment and boundary, and returns a pointer to a correctly filled memzone descriptor. If the allocation cannot be done or if the alignment or boundary are not a power of 2, returns NULL. Memory buffer is reserved in a way, that it wouldn't cross specified boundary. That implies that requested length should be less or equal then boundary.

Parameters
nameThe name of the memzone. If it already exists, the function will fail and return NULL.
lenThe size of the memory to be reserved. If it is 0, the biggest contiguous zone will be reserved.
socket_idThe socket identifier in the case of NUMA. The value can be SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
flagsThe flags parameter is used to request memzones to be taken from specifically sized hugepages.
  • RTE_MEMZONE_2MB - Reserved from 2MB pages
  • RTE_MEMZONE_1GB - Reserved from 1GB pages
  • RTE_MEMZONE_16MB - Reserved from 16MB pages
  • RTE_MEMZONE_16GB - Reserved from 16GB pages
  • RTE_MEMZONE_256KB - Reserved from 256KB pages
  • RTE_MEMZONE_256MB - Reserved from 256MB pages
  • RTE_MEMZONE_512MB - Reserved from 512MB pages
  • RTE_MEMZONE_4GB - Reserved from 4GB pages
  • RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if the requested page size is unavailable. If this flag is not set, the function will return error on an unavailable size request.
alignAlignment for resulting memzone. Must be a power of 2.
boundBoundary for resulting memzone. Must be a power of 2 or zero. Zero value implies no boundary condition.
Returns
A pointer to a correctly-filled read-only memzone descriptor, or NULL on error. On error case, rte_errno will be set appropriately:
  • E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
  • E_RTE_SECONDARY - function was called from a secondary process instance
  • ENOSPC - the maximum number of memzones has already been allocated
  • EEXIST - a memzone with the same name already exists
  • ENOMEM - no appropriate memory area found in which to create memzone
  • EINVAL - invalid parameters
int rte_memzone_free ( const struct rte_memzone mz)

Free a memzone.

Parameters
mzA pointer to the memzone
Returns
-EINVAL - invalid parameter. 0 - success
struct rte_memzone* rte_memzone_lookup ( const char *  name)
read

Lookup for a memzone.

Get a pointer to a descriptor of an already reserved memory zone identified by the name given as an argument.

Parameters
nameThe name of the memzone.
Returns
A pointer to a read-only memzone descriptor.
Examples:
examples/multi_process/client_server_mp/mp_client/client.c, examples/quota_watermark/qwctl/qwctl.c, and examples/server_node_efd/node/node.c.
void rte_memzone_dump ( FILE *  f)

Dump all reserved memzones to a file.

Parameters
fA pointer to a file for output
void rte_memzone_walk ( void(*)(const struct rte_memzone *, void *arg)  func,
void *  arg 
)

Walk list of all memzones

Parameters
funcIterator function
argArgument passed to iterator