rte_security_driver.h File Reference

#include "rte_security.h"

Go to the source code of this file.

Data Structures
struct	rte_security_ops

Typedefs
typedef int(*	security_session_create_t )(void *device, struct rte_security_session_conf *conf, struct rte_security_session *sess, struct rte_mempool *mp)
typedef int(*	security_session_destroy_t )(void *device, struct rte_security_session *sess)
typedef int(*	security_session_update_t )(void *device, struct rte_security_session *sess, struct rte_security_session_conf *conf)
typedef unsigned int(*	security_session_get_size )(void *device)
typedef int(*	security_session_stats_get_t )(void *device, struct rte_security_session *sess, struct rte_security_stats *stats)
typedef int(*	security_set_pkt_metadata_t )(void *device, struct rte_security_session *sess, struct rte_mbuf *m, void *params)
typedef int(*	security_get_userdata_t )(void *device, uint64_t md, void **userdata)
typedef struct rte_security_capability *(*	security_capabilities_get_t )(void *device)

Detailed Description

EXPERIMENTAL: this API may change without prior notice

RTE Security Common Definitions

Definition in file rte_security_driver.h.

Typedef Documentation

typedef int(* security_session_create_t)(void *device, struct rte_security_session_conf *conf, struct rte_security_session *sess, struct rte_mempool *mp)

Configure a security session on a device.

Parameters

device	Crypto/eth device pointer
conf	Security session configuration
sess	Pointer to Security private session structure
mp	Mempool where the private session is allocated

Returns

• Returns 0 if private session structure have been created successfully.
• Returns -EINVAL if input parameters are invalid.
• Returns -ENOTSUP if crypto device does not support the crypto transform.
• Returns -ENOMEM if the private session could not be allocated.

Definition at line 65 of file rte_security_driver.h.

typedef int(* security_session_destroy_t)(void *device, struct rte_security_session *sess)

Free driver private session data.

Parameters

dev	Crypto/eth device pointer
sess	Security session structure

Definition at line 76 of file rte_security_driver.h.

typedef int(* security_session_update_t)(void *device, struct rte_security_session *sess, struct rte_security_session_conf *conf)

Update driver private session data.

Parameters

device	Crypto/eth device pointer
sess	Pointer to Security private session structure
conf	Security session configuration

Returns

• Returns 0 if private session structure have been updated successfully.
• Returns -EINVAL if input parameters are invalid.
• Returns -ENOTSUP if crypto device does not support the crypto transform.

Definition at line 91 of file rte_security_driver.h.

typedef unsigned int(* security_session_get_size)(void *device)

Get the size of a security session

Parameters

device

Crypto/eth device pointer

Returns

• On success returns the size of the session structure for device
• On failure returns 0

Definition at line 104 of file rte_security_driver.h.

typedef int(* security_session_stats_get_t)(void *device, struct rte_security_session *sess, struct rte_security_stats *stats)

Get stats from the PMD.

Parameters

device	Crypto/eth device pointer
sess	Pointer to Security private session structure
stats	Security stats of the driver

Returns

• Returns 0 if private session structure have been updated successfully.
• Returns -EINVAL if session parameters are invalid.

Definition at line 117 of file rte_security_driver.h.

typedef int(* security_set_pkt_metadata_t)(void *device, struct rte_security_session *sess, struct rte_mbuf *m, void *params)

Update the mbuf with provided metadata.

Parameters

sess	Security session structure
mb	Packet buffer
mt	Metadata

Returns

• Returns 0 if metadata updated successfully.
• Returns -ve value for errors.

Definition at line 132 of file rte_security_driver.h.

typedef int(* security_get_userdata_t)(void *device, uint64_t md, void **userdata)

Get application specific userdata associated with the security session. Device specific metadata provided would be used to uniquely identify the security session being referred to.

Parameters

device	Crypto/eth device pointer
md	Metadata
userdata	Pointer to receive userdata

Returns

• Returns 0 if userdata is retrieved successfully.
• Returns -ve value for errors.

Definition at line 149 of file rte_security_driver.h.

typedef struct rte_security_capability*(* security_capabilities_get_t)(void *device)

Get security capabilities of the device.

Parameters

device

crypto/eth device pointer

Returns

• Returns rte_security_capability pointer on success.
• Returns NULL on error.

Definition at line 161 of file rte_security_driver.h.