#include "rte_kvargs.h"
#include "rte_crypto.h"
#include "rte_dev.h"

Data Structures
struct	rte_cryptodev_symmetric_capability
struct	rte_cryptodev_capabilities
struct	rte_cryptodev_info
struct	rte_cryptodev_qp_conf
struct	rte_cryptodev_stats
struct	rte_cryptodev_config
struct	rte_cryptodev
struct	rte_cryptodev_data
struct	rte_cryptodev_sym_session

Macros
#define	CRYPTODEV_NAME_NULL_PMD ("cryptodev_null_pmd")
#define	CRYPTODEV_NAME_AESNI_MB_PMD ("cryptodev_aesni_mb_pmd")
#define	CRYPTODEV_NAME_AESNI_GCM_PMD ("cryptodev_aesni_gcm_pmd")
#define	CRYPTODEV_NAME_QAT_SYM_PMD ("cryptodev_qat_sym_pmd")
#define	CRYPTODEV_NAME_SNOW3G_PMD ("cryptodev_snow3g_pmd")
#define	RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() { RTE_CRYPTO_OP_TYPE_UNDEFINED }
#define	RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
#define	RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
#define	RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
#define	RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
#define	RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
#define	RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
#define	RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
#define	RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
#define	RTE_CRYPTODEV_NAME_MAX_LEN (64)

Typedefs
typedef void(*	rte_cryptodev_cb_fn )(uint8_t dev_id, enum rte_cryptodev_event_type event, void *cb_arg)
typedef uint16_t(*	dequeue_pkt_burst_t )(void qp, struct rte_crypto_op *ops, uint16_t nb_ops)
typedef uint16_t(*	enqueue_pkt_burst_t )(void qp, struct rte_crypto_op *ops, uint16_t nb_ops)

Enumerations
enum	rte_cryptodev_type { RTE_CRYPTODEV_NULL_PMD = 1, RTE_CRYPTODEV_AESNI_GCM_PMD, RTE_CRYPTODEV_AESNI_MB_PMD, RTE_CRYPTODEV_QAT_SYM_PMD, RTE_CRYPTODEV_SNOW3G_PMD }
enum	rte_cryptodev_event_type { RTE_CRYPTODEV_EVENT_UNKNOWN, RTE_CRYPTODEV_EVENT_ERROR, RTE_CRYPTODEV_EVENT_MAX }

Functions
const char *	rte_cryptodev_get_feature_name (uint64_t flag)
static int	__rte_cryptodev_parse_integer_arg (const char key __rte_unused, const char value, void *extra_args)
static int	rte_cryptodev_parse_vdev_init_params (struct rte_crypto_vdev_init_params params, const char input_args)
int	rte_cryptodev_create_vdev (const char name, const char args)
int	rte_cryptodev_get_dev_id (const char *name)
uint8_t	rte_cryptodev_count (void)
int	rte_cryptodev_configure (uint8_t dev_id, struct rte_cryptodev_config *config)
int	rte_cryptodev_start (uint8_t dev_id)
void	rte_cryptodev_stop (uint8_t dev_id)
int	rte_cryptodev_close (uint8_t dev_id)
int	rte_cryptodev_queue_pair_setup (uint8_t dev_id, uint16_t queue_pair_id, const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
int	rte_cryptodev_queue_pair_start (uint8_t dev_id, uint16_t queue_pair_id)
int	rte_cryptodev_queue_pair_stop (uint8_t dev_id, uint16_t queue_pair_id)
uint16_t	rte_cryptodev_queue_pair_count (uint8_t dev_id)
int	rte_cryptodev_stats_get (uint8_t dev_id, struct rte_cryptodev_stats *stats)
void	rte_cryptodev_stats_reset (uint8_t dev_id)
void	rte_cryptodev_info_get (uint8_t dev_id, struct rte_cryptodev_info *dev_info)
int	rte_cryptodev_callback_register (uint8_t dev_id, enum rte_cryptodev_event_type event, rte_cryptodev_cb_fn cb_fn, void *cb_arg)
int	rte_cryptodev_callback_unregister (uint8_t dev_id, enum rte_cryptodev_event_type event, rte_cryptodev_cb_fn cb_fn, void *cb_arg)
	TAILQ_HEAD (rte_cryptodev_cb_list, rte_cryptodev_callback)
static uint16_t	rte_cryptodev_dequeue_burst (uint8_t dev_id, uint16_t qp_id, struct rte_crypto_op **ops, uint16_t nb_ops)
static uint16_t	rte_cryptodev_enqueue_burst (uint8_t dev_id, uint16_t qp_id, struct rte_crypto_op **ops, uint16_t nb_ops)
struct rte_cryptodev_sym_session *	rte_cryptodev_sym_session_create (uint8_t dev_id, struct rte_crypto_sym_xform *xform)
struct rte_cryptodev_sym_session *	rte_cryptodev_sym_session_free (uint8_t dev_id, struct rte_cryptodev_sym_session *session)

Variables
uint8_t	dev_id
struct rte_mempool *	mp

Detailed Description

RTE Cryptographic Device APIs

Defines RTE Crypto Device APIs for the provisioning of cipher and authentication operations.

Definition in file rte_cryptodev.h.

Macro Definition Documentation

#define CRYPTODEV_NAME_NULL_PMD ("cryptodev_null_pmd")

Null crypto PMD device name

Definition at line 52 of file rte_cryptodev.h.

#define CRYPTODEV_NAME_AESNI_MB_PMD ("cryptodev_aesni_mb_pmd")

AES-NI Multi buffer PMD device name

Definition at line 54 of file rte_cryptodev.h.

#define CRYPTODEV_NAME_AESNI_GCM_PMD ("cryptodev_aesni_gcm_pmd")

AES-NI GCM PMD device name

Definition at line 56 of file rte_cryptodev.h.

#define CRYPTODEV_NAME_QAT_SYM_PMD ("cryptodev_qat_sym_pmd")

Intel QAT Symmetric Crypto PMD device name

Definition at line 58 of file rte_cryptodev.h.

#define CRYPTODEV_NAME_SNOW3G_PMD ("cryptodev_snow3g_pmd")

SNOW 3G PMD device name

Definition at line 60 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST ( ) { RTE_CRYPTO_OP_TYPE_UNDEFINED }

Macro used at end of crypto PMD list

Definition at line 184 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)

Crypto device supported feature flags

Note: New features flags should be added to the end of the list

Keep these flags synchronised with rte_cryptodev_get_feature_name()Symmetric crypto operations are supported

Definition at line 196 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)

Asymmetric crypto operations are supported

Definition at line 198 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)

Chaining symmetric crypto operations are supported

Definition at line 200 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)

Utilises CPU SIMD SSE instructions

Definition at line 202 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)

Utilises CPU SIMD AVX instructions

Definition at line 204 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)

Utilises CPU SIMD AVX2 instructions

Definition at line 206 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)

Utilises CPU AES-NI instructions

Definition at line 208 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)

Operations are off-loaded to an external hardware accelerator

Examples:: l2fwd-crypto/main.c.

Definition at line 210 of file rte_cryptodev.h.

#define RTE_CRYPTODEV_NAME_MAX_LEN (64)

Max length of name of crypto PMD

Definition at line 711 of file rte_cryptodev.h.

Typedef Documentation

typedef void(* rte_cryptodev_cb_fn)(uint8_t dev_id, enum rte_cryptodev_event_type event, void *cb_arg)

Typedef for application callback function to be registered by application software for notification of device events

Parameters

dev_id	Crypto device identifier
event	Crypto device event to register for notification of.
cb_arg	User specified parameter to be passed as to passed to users callback function.

Definition at line 270 of file rte_cryptodev.h.

typedef uint16_t(* dequeue_pkt_burst_t)(void *qp, struct rte_crypto_op **ops, uint16_t nb_ops)

Dequeue processed packets from queue pair of a device.

Definition at line 664 of file rte_cryptodev.h.

typedef uint16_t(* enqueue_pkt_burst_t)(void *qp, struct rte_crypto_op **ops, uint16_t nb_ops)

Enqueue packets for processing on queue pair of a device.

Definition at line 668 of file rte_cryptodev.h.

Enumeration Type Documentation

enum rte_cryptodev_type

Crypto device type

Enumerator:

RTE_CRYPTODEV_NULL_PMD	Null crypto PMD
RTE_CRYPTODEV_AESNI_GCM_PMD	AES-NI GCM PMD
RTE_CRYPTODEV_AESNI_MB_PMD	AES-NI multi buffer PMD
RTE_CRYPTODEV_QAT_SYM_PMD	QAT PMD Symmetric Crypto
RTE_CRYPTODEV_SNOW3G_PMD	SNOW 3G PMD

Definition at line 64 of file rte_cryptodev.h.

enum rte_cryptodev_event_type

Definitions of Crypto device event types

Enumerator:

RTE_CRYPTODEV_EVENT_UNKNOWN	unknown event type
RTE_CRYPTODEV_EVENT_ERROR	error interrupt event
RTE_CRYPTODEV_EVENT_MAX	max value of this enum

Definition at line 250 of file rte_cryptodev.h.

Function Documentation

const char* rte_cryptodev_get_feature_name ( uint64_t flag )

Get the name of a crypto device feature flag

Parameters

flag	The mask describing the flag.

Returns: The name of this flag, or NULL if it's not a valid feature flag.

static int __rte_cryptodev_parse_integer_arg	(	const char *key	__rte_unused,
		const char *	value,
		void *	extra_args
	)

inlinestatic

Parse integer from integer argument

Definition at line 328 of file rte_cryptodev.h.

static int rte_cryptodev_parse_vdev_init_params	(	struct rte_crypto_vdev_init_params *	params,
		const char *	input_args
	)

inlinestatic

Parse virtual device initialisation parameters input arguments

Definition at line 354 of file rte_cryptodev.h.

int rte_cryptodev_create_vdev	(	const char *	name,
		const char *	args
	)

Create a virtual crypto device

Parameters

name	Cryptodev PMD name of device to be created.
args	Options arguments for device.

Returns

On successful creation of the cryptodev the device index is returned, which will be between 0 and rte_cryptodev_count().
In the case of a failure, returns -1.

int rte_cryptodev_get_dev_id ( const char * name )

Get the device identifier for the named crypto device.

Parameters

name	device name to select the device structure.

Returns

Returns crypto device identifier on success.
Return -1 on failure to find named crypto device.

uint8_t rte_cryptodev_count ( void )

Get the total number of crypto devices that have been successfully initialised.

Returns

The total number of usable crypto devices.

Examples:: l2fwd-crypto/main.c.

int rte_cryptodev_configure	(	uint8_t	dev_id,
		struct rte_cryptodev_config *	config
	)

Configure a device.

This function must be invoked first before any other function in the API. This function can also be re-invoked when a device is in the stopped state.

Parameters

dev_id	The identifier of the device to configure.
config	The crypto device configuration structure.

Returns

0: Success, device configured.
<0: Error code returned by the driver configuration function.

Examples:: l2fwd-crypto/main.c.

int rte_cryptodev_start ( uint8_t dev_id )

Start an device.

The device start step is the last one and consists of setting the configured offload features and in starting the transmit and the receive units of the device. On success, all basic functions exported by the API (link status, receive/transmit, and so on) can be invoked.

Parameters

dev_id The identifier of the device.

Returns

0: Success, device started.
<0: Error code of the driver device start function.

void rte_cryptodev_stop ( uint8_t dev_id )

Stop an device. The device can be restarted with a call to rte_cryptodev_start()

Parameters

dev_id The identifier of the device.

int rte_cryptodev_close ( uint8_t dev_id )

Close an device. The device cannot be restarted!

Parameters

dev_id The identifier of the device.

Returns

0 on successfully closing device
<0 on failure to close device

int rte_cryptodev_queue_pair_setup	(	uint8_t	dev_id,
		uint16_t	queue_pair_id,
		const struct rte_cryptodev_qp_conf *	qp_conf,
		int	socket_id
	)

Allocate and set up a receive queue pair for a device.

Parameters

dev_id	The identifier of the device.
queue_pair_id	The index of the queue pairs to set up. The value must be in the range [0, nb_queue_pair 1] previously supplied to rte_cryptodev_configure().
qp_conf	The pointer to the configuration data to be used for the queue pair. NULL value is allowed, in which case default configuration will be used.
socket_id	The socket_id argument is the socket identifier in case of NUMA. The value can be SOCKET_ID_ANY if there is no NUMA constraint for the DMA memory allocated for the receive queue pair.

Returns

0: Success, queue pair correctly set up.
<0: Queue pair configuration failed

Examples:: l2fwd-crypto/main.c.

int rte_cryptodev_queue_pair_start	(	uint8_t	dev_id,
		uint16_t	queue_pair_id
	)

Start a specified queue pair of a device. It is used when deferred_start flag of the specified queue is true.

Parameters

dev_id	The identifier of the device
queue_pair_id	The index of the queue pair to start. The value must be in the range [0, nb_queue_pair - 1] previously supplied to rte_crypto_dev_configure().

Returns

0: Success, the transmit queue is correctly set up.
-EINVAL: The dev_id or the queue_id out of range.
-ENOTSUP: The function not supported in PMD driver.

int rte_cryptodev_queue_pair_stop	(	uint8_t	dev_id,
		uint16_t	queue_pair_id
	)

Stop specified queue pair of a device

Parameters

dev_id	The identifier of the device
queue_pair_id	The index of the queue pair to stop. The value must be in the range [0, nb_queue_pair - 1] previously supplied to rte_cryptodev_configure().

Returns

0: Success, the transmit queue is correctly set up.
-EINVAL: The dev_id or the queue_id out of range.
-ENOTSUP: The function not supported in PMD driver.

uint16_t rte_cryptodev_queue_pair_count ( uint8_t dev_id )

Get the number of queue pairs on a specific crypto device

Parameters

dev_id Crypto device identifier.

Returns

The number of configured queue pairs.

int rte_cryptodev_stats_get	(	uint8_t	dev_id,
		struct rte_cryptodev_stats *	stats
	)

Retrieve the general I/O statistics of a device.

Parameters

dev_id	The identifier of the device.
stats	A pointer to a structure of type rte_cryptodev_stats to be filled with the values of device counters.

Returns

Zero if successful.
Non-zero otherwise.

void rte_cryptodev_stats_reset ( uint8_t dev_id )

Reset the general I/O statistics of a device.

Parameters

dev_id The identifier of the device.

void rte_cryptodev_info_get	(	uint8_t	dev_id,
		struct rte_cryptodev_info *	dev_info
	)

Retrieve the contextual information of a device.

Parameters

dev_id	The identifier of the device.
dev_info	A pointer to a structure of type rte_cryptodev_info to be filled with the contextual information of the device.

Examples:: l2fwd-crypto/main.c.

int rte_cryptodev_callback_register	(	uint8_t	dev_id,
		enum rte_cryptodev_event_type	event,
		rte_cryptodev_cb_fn	cb_fn,
		void *	cb_arg
	)

Register a callback function for specific device id.

Parameters

dev_id	Device id.
event	Event interested.
cb_fn	User supplied callback function to be called.
cb_arg	Pointer to the parameters for the registered callback.

Returns

On success, zero.
On failure, a negative value.

int rte_cryptodev_callback_unregister	(	uint8_t	dev_id,
		enum rte_cryptodev_event_type	event,
		rte_cryptodev_cb_fn	cb_fn,
		void *	cb_arg
	)

Unregister a callback function for specific device id.

Parameters

dev_id	The device identifier.
event	Event interested.
cb_fn	User supplied callback function to be called.
cb_arg	Pointer to the parameters for the registered callback.

Returns

On success, zero.
On failure, a negative value.

TAILQ_HEAD	(	rte_cryptodev_cb_list	,
		rte_cryptodev_callback
	)

Structure to keep track of registered callbacks

static uint16_t rte_cryptodev_dequeue_burst	(	uint8_t	dev_id,
		uint16_t	qp_id,
		struct rte_crypto_op **	ops,
		uint16_t	nb_ops
	)

inlinestatic

Dequeue a burst of processed crypto operations from a queue on the crypto device. The dequeued operation are stored in rte_crypto_op structures whose pointers are supplied in the ops array.

The rte_cryptodev_dequeue_burst() function returns the number of ops actually dequeued, which is the number of rte_crypto_op data structures effectively supplied into the ops array.

A return value equal to nb_ops indicates that the queue contained at least nb_ops operations, and this is likely to signify that other processed operations remain in the devices output queue. Applications implementing a "retrieve as many processed operations as possible" policy can check this specific case and keep invoking the rte_cryptodev_dequeue_burst() function until a value less than nb_ops is returned.

The rte_cryptodev_dequeue_burst() function does not provide any error notification to avoid the corresponding overhead.

Parameters

dev_id	The symmetric crypto device identifier
qp_id	The index of the queue pair from which to retrieve processed packets. The value must be in the range [0, nb_queue_pair - 1] previously supplied to rte_cryptodev_configure().
ops	The address of an array of pointers to rte_crypto_op structures that must be large enough to store nb_ops pointers in it.
nb_ops	The maximum number of operations to dequeue.

Returns

The number of operations actually dequeued, which is the number of pointers to rte_crypto_op structures effectively supplied to the ops array.

Examples:: l2fwd-crypto/main.c.

Definition at line 781 of file rte_cryptodev.h.

static uint16_t rte_cryptodev_enqueue_burst	(	uint8_t	dev_id,
		uint16_t	qp_id,
		struct rte_crypto_op **	ops,
		uint16_t	nb_ops
	)

inlinestatic

Enqueue a burst of operations for processing on a crypto device.

The rte_cryptodev_enqueue_burst() function is invoked to place crypto operations on the queue qp_id of the device designated by its dev_id.

The nb_ops parameter is the number of operations to process which are supplied in the ops array of rte_crypto_op structures.

The rte_cryptodev_enqueue_burst() function returns the number of operations it actually enqueued for processing. A return value equal to nb_ops means that all packets have been enqueued.

Parameters

dev_id	The identifier of the device.
qp_id	The index of the queue pair which packets are to be enqueued for processing. The value must be in the range [0, nb_queue_pairs - 1] previously supplied to rte_cryptodev_configure.
ops	The address of an array of nb_ops pointers to rte_crypto_op structures which contain the crypto operations to be processed.
nb_ops	The number of operations to process.

Returns: The number of operations actually enqueued on the crypto device. The return value can be less than the value of the nb_ops parameter when the crypto devices queue is full or if invalid parameters are specified in a rte_crypto_op.

Examples:: l2fwd-crypto/main.c.

Definition at line 824 of file rte_cryptodev.h.

struct rte_cryptodev_sym_session* rte_cryptodev_sym_session_create	(	uint8_t	dev_id,
		struct rte_crypto_sym_xform *	xform
	)

read

Initialise a session for symmetric cryptographic operations.

This function is used by the client to initialize immutable parameters of symmetric cryptographic operation. To perform the operation the rte_cryptodev_enqueue_burst function is used. Each mbuf should contain a reference to the session pointer returned from this function contained within it's crypto_op if a session-based operation is being provisioned. Memory to contain the session information is allocated from within mempool managed by the cryptodev.

The rte_cryptodev_session_free must be called to free allocated memory when the session is no longer required.

Parameters

dev_id	The device identifier.
xform	Crypto transform chain.

Returns: Pointer to the created session or NULL

Examples:: l2fwd-crypto/main.c.

struct rte_cryptodev_sym_session* rte_cryptodev_sym_session_free	(	uint8_t	dev_id,
		struct rte_cryptodev_sym_session *	session
	)

read

Free the memory associated with a previously allocated session.

Parameters

dev_id	The device identifier.
session	Session pointer previously allocated by rte_cryptodev_sym_session_create.

Returns: NULL on successful freeing of session. Session pointer on failure to free session.

Variable Documentation

uint8_t dev_id

Device Id

Examples:: l2fwd-crypto/main.c.

Definition at line 846 of file rte_cryptodev.h.

struct rte_mempool* mp

Crypto Device type session created on Mempool session allocated from

Examples:: ip_fragmentation/main.c, ip_pipeline/pipeline/pipeline_flow_actions_be.c, l3fwd-acl/main.c, multi_process/client_server_mp/mp_client/client.c, multi_process/symmetric_mp/main.c, netmap_compat/lib/compat_netmap.c, qos_sched/init.c, and vhost/main.c.

Definition at line 849 of file rte_cryptodev.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation