f51fd44d64
Removed unnecessary macro RTE_STD_C11, which is used
for unnamed structs.
Since there is no longer an unnamed structure in
rte_cryptodev_sym_session, this is not needed and
it is actually breaking compilation on icc:
lib/librte_cryptodev/rte_cryptodev.h(887): error: expected a declaration
__extension__ void *sess_private_data[0];
^
Fixes: 7c110ce7aa ("cryptodev: remove mempool from session")
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Declan Doherty <declan.doherty@intel.com>
1050 lines
31 KiB
C
1050 lines
31 KiB
C
/*-
|
|
*
|
|
* Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _RTE_CRYPTODEV_H_
|
|
#define _RTE_CRYPTODEV_H_
|
|
|
|
/**
|
|
* @file rte_cryptodev.h
|
|
*
|
|
* RTE Cryptographic Device APIs
|
|
*
|
|
* Defines RTE Crypto Device APIs for the provisioning of cipher and
|
|
* authentication operations.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "rte_kvargs.h"
|
|
#include "rte_crypto.h"
|
|
#include "rte_dev.h"
|
|
#include <rte_common.h>
|
|
#include <rte_vdev.h>
|
|
|
|
extern const char **rte_cyptodev_names;
|
|
|
|
/* Logging Macros */
|
|
|
|
#define CDEV_LOG_ERR(...) \
|
|
RTE_LOG(ERR, CRYPTODEV, \
|
|
RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
|
|
__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
|
|
|
|
#define CDEV_PMD_LOG_ERR(dev, ...) \
|
|
RTE_LOG(ERR, CRYPTODEV, \
|
|
RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
|
|
dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
|
|
|
|
#ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
|
|
#define CDEV_LOG_DEBUG(...) \
|
|
RTE_LOG(DEBUG, CRYPTODEV, \
|
|
RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
|
|
__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
|
|
|
|
#define CDEV_PMD_TRACE(...) \
|
|
RTE_LOG(DEBUG, CRYPTODEV, \
|
|
RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
|
|
dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
|
|
|
|
#else
|
|
#define CDEV_LOG_DEBUG(...) (void)0
|
|
#define CDEV_PMD_TRACE(...) (void)0
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
* A macro that points to an offset from the start
|
|
* of the crypto operation structure (rte_crypto_op)
|
|
*
|
|
* The returned pointer is cast to type t.
|
|
*
|
|
* @param c
|
|
* The crypto operation.
|
|
* @param o
|
|
* The offset from the start of the crypto operation.
|
|
* @param t
|
|
* The type to cast the result into.
|
|
*/
|
|
#define rte_crypto_op_ctod_offset(c, t, o) \
|
|
((t)((char *)(c) + (o)))
|
|
|
|
/**
|
|
* A macro that returns the physical address that points
|
|
* to an offset from the start of the crypto operation
|
|
* (rte_crypto_op)
|
|
*
|
|
* @param c
|
|
* The crypto operation.
|
|
* @param o
|
|
* The offset from the start of the crypto operation
|
|
* to calculate address from.
|
|
*/
|
|
#define rte_crypto_op_ctophys_offset(c, o) \
|
|
(phys_addr_t)((c)->phys_addr + (o))
|
|
|
|
/**
|
|
* Crypto parameters range description
|
|
*/
|
|
struct rte_crypto_param_range {
|
|
uint16_t min; /**< minimum size */
|
|
uint16_t max; /**< maximum size */
|
|
uint16_t increment;
|
|
/**< if a range of sizes are supported,
|
|
* this parameter is used to indicate
|
|
* increments in byte size that are supported
|
|
* between the minimum and maximum
|
|
*/
|
|
};
|
|
|
|
/**
|
|
* Symmetric Crypto Capability
|
|
*/
|
|
struct rte_cryptodev_symmetric_capability {
|
|
enum rte_crypto_sym_xform_type xform_type;
|
|
/**< Transform type : Authentication / Cipher / AEAD */
|
|
RTE_STD_C11
|
|
union {
|
|
struct {
|
|
enum rte_crypto_auth_algorithm algo;
|
|
/**< authentication algorithm */
|
|
uint16_t block_size;
|
|
/**< algorithm block size */
|
|
struct rte_crypto_param_range key_size;
|
|
/**< auth key size range */
|
|
struct rte_crypto_param_range digest_size;
|
|
/**< digest size range */
|
|
struct rte_crypto_param_range aad_size;
|
|
/**< Additional authentication data size range */
|
|
struct rte_crypto_param_range iv_size;
|
|
/**< Initialisation vector data size range */
|
|
} auth;
|
|
/**< Symmetric Authentication transform capabilities */
|
|
struct {
|
|
enum rte_crypto_cipher_algorithm algo;
|
|
/**< cipher algorithm */
|
|
uint16_t block_size;
|
|
/**< algorithm block size */
|
|
struct rte_crypto_param_range key_size;
|
|
/**< cipher key size range */
|
|
struct rte_crypto_param_range iv_size;
|
|
/**< Initialisation vector data size range */
|
|
} cipher;
|
|
/**< Symmetric Cipher transform capabilities */
|
|
struct {
|
|
enum rte_crypto_aead_algorithm algo;
|
|
/**< AEAD algorithm */
|
|
uint16_t block_size;
|
|
/**< algorithm block size */
|
|
struct rte_crypto_param_range key_size;
|
|
/**< AEAD key size range */
|
|
struct rte_crypto_param_range digest_size;
|
|
/**< digest size range */
|
|
struct rte_crypto_param_range aad_size;
|
|
/**< Additional authentication data size range */
|
|
struct rte_crypto_param_range iv_size;
|
|
/**< Initialisation vector data size range */
|
|
} aead;
|
|
};
|
|
};
|
|
|
|
/** Structure used to capture a capability of a crypto device */
|
|
struct rte_cryptodev_capabilities {
|
|
enum rte_crypto_op_type op;
|
|
/**< Operation type */
|
|
|
|
RTE_STD_C11
|
|
union {
|
|
struct rte_cryptodev_symmetric_capability sym;
|
|
/**< Symmetric operation capability parameters */
|
|
};
|
|
};
|
|
|
|
/** Structure used to describe crypto algorithms */
|
|
struct rte_cryptodev_sym_capability_idx {
|
|
enum rte_crypto_sym_xform_type type;
|
|
union {
|
|
enum rte_crypto_cipher_algorithm cipher;
|
|
enum rte_crypto_auth_algorithm auth;
|
|
enum rte_crypto_aead_algorithm aead;
|
|
} algo;
|
|
};
|
|
|
|
/**
|
|
* Provide capabilities available for defined device and algorithm
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
* @param idx Description of crypto algorithms.
|
|
*
|
|
* @return
|
|
* - Return description of the symmetric crypto capability if exist.
|
|
* - Return NULL if the capability not exist.
|
|
*/
|
|
const struct rte_cryptodev_symmetric_capability *
|
|
rte_cryptodev_sym_capability_get(uint8_t dev_id,
|
|
const struct rte_cryptodev_sym_capability_idx *idx);
|
|
|
|
/**
|
|
* Check if key size and initial vector are supported
|
|
* in crypto cipher capability
|
|
*
|
|
* @param capability Description of the symmetric crypto capability.
|
|
* @param key_size Cipher key size.
|
|
* @param iv_size Cipher initial vector size.
|
|
*
|
|
* @return
|
|
* - Return 0 if the parameters are in range of the capability.
|
|
* - Return -1 if the parameters are out of range of the capability.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_capability_check_cipher(
|
|
const struct rte_cryptodev_symmetric_capability *capability,
|
|
uint16_t key_size, uint16_t iv_size);
|
|
|
|
/**
|
|
* Check if key size and initial vector are supported
|
|
* in crypto auth capability
|
|
*
|
|
* @param capability Description of the symmetric crypto capability.
|
|
* @param key_size Auth key size.
|
|
* @param digest_size Auth digest size.
|
|
* @param aad_size Auth aad size.
|
|
* @param iv_size Auth initial vector size.
|
|
*
|
|
* @return
|
|
* - Return 0 if the parameters are in range of the capability.
|
|
* - Return -1 if the parameters are out of range of the capability.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_capability_check_auth(
|
|
const struct rte_cryptodev_symmetric_capability *capability,
|
|
uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
|
|
uint16_t iv_size);
|
|
|
|
/**
|
|
* Check if key, digest, AAD and initial vector sizes are supported
|
|
* in crypto AEAD capability
|
|
*
|
|
* @param capability Description of the symmetric crypto capability.
|
|
* @param key_size AEAD key size.
|
|
* @param digest_size AEAD digest size.
|
|
* @param aad_size AEAD AAD size.
|
|
* @param iv_size AEAD IV size.
|
|
*
|
|
* @return
|
|
* - Return 0 if the parameters are in range of the capability.
|
|
* - Return -1 if the parameters are out of range of the capability.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_capability_check_aead(
|
|
const struct rte_cryptodev_symmetric_capability *capability,
|
|
uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
|
|
uint16_t iv_size);
|
|
|
|
/**
|
|
* Provide the cipher algorithm enum, given an algorithm string
|
|
*
|
|
* @param algo_enum A pointer to the cipher algorithm
|
|
* enum to be filled
|
|
* @param algo_string Authentication algo string
|
|
*
|
|
* @return
|
|
* - Return -1 if string is not valid
|
|
* - Return 0 is the string is valid
|
|
*/
|
|
int
|
|
rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
|
|
const char *algo_string);
|
|
|
|
/**
|
|
* Provide the authentication algorithm enum, given an algorithm string
|
|
*
|
|
* @param algo_enum A pointer to the authentication algorithm
|
|
* enum to be filled
|
|
* @param algo_string Authentication algo string
|
|
*
|
|
* @return
|
|
* - Return -1 if string is not valid
|
|
* - Return 0 is the string is valid
|
|
*/
|
|
int
|
|
rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
|
|
const char *algo_string);
|
|
|
|
/**
|
|
* Provide the AEAD algorithm enum, given an algorithm string
|
|
*
|
|
* @param algo_enum A pointer to the AEAD algorithm
|
|
* enum to be filled
|
|
* @param algo_string AEAD algorithm string
|
|
*
|
|
* @return
|
|
* - Return -1 if string is not valid
|
|
* - Return 0 is the string is valid
|
|
*/
|
|
int
|
|
rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
|
|
const char *algo_string);
|
|
|
|
/** Macro used at end of crypto PMD list */
|
|
#define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
|
|
{ RTE_CRYPTO_OP_TYPE_UNDEFINED }
|
|
|
|
|
|
/**
|
|
* 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()
|
|
*/
|
|
#define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
|
|
/**< Symmetric crypto operations are supported */
|
|
#define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
|
|
/**< Asymmetric crypto operations are supported */
|
|
#define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
|
|
/**< Chaining symmetric crypto operations are supported */
|
|
#define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
|
|
/**< Utilises CPU SIMD SSE instructions */
|
|
#define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
|
|
/**< Utilises CPU SIMD AVX instructions */
|
|
#define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
|
|
/**< Utilises CPU SIMD AVX2 instructions */
|
|
#define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
|
|
/**< Utilises CPU AES-NI instructions */
|
|
#define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
|
|
/**< Operations are off-loaded to an external hardware accelerator */
|
|
#define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
|
|
/**< Utilises CPU SIMD AVX512 instructions */
|
|
#define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
|
|
/**< Scatter-gather mbufs are supported */
|
|
#define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
|
|
/**< Utilises CPU NEON instructions */
|
|
#define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
|
|
/**< Utilises ARM CPU Cryptographic Extensions */
|
|
|
|
|
|
/**
|
|
* Get the name of a crypto device feature flag
|
|
*
|
|
* @param flag The mask describing the flag.
|
|
*
|
|
* @return
|
|
* The name of this flag, or NULL if it's not a valid feature flag.
|
|
*/
|
|
|
|
extern const char *
|
|
rte_cryptodev_get_feature_name(uint64_t flag);
|
|
|
|
/** Crypto device information */
|
|
struct rte_cryptodev_info {
|
|
const char *driver_name; /**< Driver name. */
|
|
uint8_t driver_id; /**< Driver identifier */
|
|
struct rte_pci_device *pci_dev; /**< PCI information. */
|
|
|
|
uint64_t feature_flags; /**< Feature flags */
|
|
|
|
const struct rte_cryptodev_capabilities *capabilities;
|
|
/**< Array of devices supported capabilities */
|
|
|
|
unsigned max_nb_queue_pairs;
|
|
/**< Maximum number of queues pairs supported by device. */
|
|
|
|
struct {
|
|
unsigned max_nb_sessions;
|
|
/**< Maximum number of sessions supported by device. */
|
|
unsigned int max_nb_sessions_per_qp;
|
|
/**< Maximum number of sessions per queue pair.
|
|
* Default 0 for infinite sessions
|
|
*/
|
|
} sym;
|
|
};
|
|
|
|
#define RTE_CRYPTODEV_DETACHED (0)
|
|
#define RTE_CRYPTODEV_ATTACHED (1)
|
|
|
|
/** Definitions of Crypto device event types */
|
|
enum rte_cryptodev_event_type {
|
|
RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
|
|
RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
|
|
RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
|
|
};
|
|
|
|
/** Crypto device queue pair configuration structure. */
|
|
struct rte_cryptodev_qp_conf {
|
|
uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
|
|
};
|
|
|
|
/**
|
|
* Typedef for application callback function to be registered by application
|
|
* software for notification of device events
|
|
*
|
|
* @param dev_id Crypto device identifier
|
|
* @param event Crypto device event to register for notification of.
|
|
* @param cb_arg User specified parameter to be passed as to passed to
|
|
* users callback function.
|
|
*/
|
|
typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
|
|
enum rte_cryptodev_event_type event, void *cb_arg);
|
|
|
|
|
|
/** Crypto Device statistics */
|
|
struct rte_cryptodev_stats {
|
|
uint64_t enqueued_count;
|
|
/**< Count of all operations enqueued */
|
|
uint64_t dequeued_count;
|
|
/**< Count of all operations dequeued */
|
|
|
|
uint64_t enqueue_err_count;
|
|
/**< Total error count on operations enqueued */
|
|
uint64_t dequeue_err_count;
|
|
/**< Total error count on operations dequeued */
|
|
};
|
|
|
|
#define RTE_CRYPTODEV_NAME_MAX_LEN (64)
|
|
/**< Max length of name of crypto PMD */
|
|
|
|
/**
|
|
* Create a virtual crypto device
|
|
*
|
|
* @param name Cryptodev PMD name of device to be created.
|
|
* @param args Options arguments for device.
|
|
*
|
|
* @return
|
|
* - 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.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_create_vdev(const char *name, const char *args);
|
|
|
|
/**
|
|
* Get the device identifier for the named crypto device.
|
|
*
|
|
* @param name device name to select the device structure.
|
|
*
|
|
* @return
|
|
* - Returns crypto device identifier on success.
|
|
* - Return -1 on failure to find named crypto device.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_get_dev_id(const char *name);
|
|
|
|
/**
|
|
* Get the total number of crypto devices that have been successfully
|
|
* initialised.
|
|
*
|
|
* @return
|
|
* - The total number of usable crypto devices.
|
|
*/
|
|
extern uint8_t
|
|
rte_cryptodev_count(void);
|
|
|
|
/**
|
|
* Get number of crypto device defined type.
|
|
*
|
|
* @param driver_id driver identifier.
|
|
*
|
|
* @return
|
|
* Returns number of crypto device.
|
|
*/
|
|
extern uint8_t
|
|
rte_cryptodev_device_count_by_driver(uint8_t driver_id);
|
|
|
|
/**
|
|
* Get number and identifiers of attached crypto devices that
|
|
* use the same crypto driver.
|
|
*
|
|
* @param driver_name driver name.
|
|
* @param devices output devices identifiers.
|
|
* @param nb_devices maximal number of devices.
|
|
*
|
|
* @return
|
|
* Returns number of attached crypto device.
|
|
*/
|
|
uint8_t
|
|
rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
|
|
uint8_t nb_devices);
|
|
/*
|
|
* Return the NUMA socket to which a device is connected
|
|
*
|
|
* @param dev_id
|
|
* The identifier of the device
|
|
* @return
|
|
* The NUMA socket id to which the device is connected or
|
|
* a default of zero if the socket could not be determined.
|
|
* -1 if returned is the dev_id value is out of range.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_socket_id(uint8_t dev_id);
|
|
|
|
/** Crypto device configuration structure */
|
|
struct rte_cryptodev_config {
|
|
int socket_id; /**< Socket to allocate resources on */
|
|
uint16_t nb_queue_pairs;
|
|
/**< Number of queue pairs to configure on device */
|
|
};
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param dev_id The identifier of the device to configure.
|
|
* @param config The crypto device configuration structure.
|
|
*
|
|
* @return
|
|
* - 0: Success, device configured.
|
|
* - <0: Error code returned by the driver configuration function.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param dev_id
|
|
* The identifier of the device.
|
|
* @return
|
|
* - 0: Success, device started.
|
|
* - <0: Error code of the driver device start function.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_start(uint8_t dev_id);
|
|
|
|
/**
|
|
* Stop an device. The device can be restarted with a call to
|
|
* rte_cryptodev_start()
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
*/
|
|
extern void
|
|
rte_cryptodev_stop(uint8_t dev_id);
|
|
|
|
/**
|
|
* Close an device. The device cannot be restarted!
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
*
|
|
* @return
|
|
* - 0 on successfully closing device
|
|
* - <0 on failure to close device
|
|
*/
|
|
extern int
|
|
rte_cryptodev_close(uint8_t dev_id);
|
|
|
|
/**
|
|
* Allocate and set up a receive queue pair for a device.
|
|
*
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
* @param 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().
|
|
* @param 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.
|
|
* @param 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.
|
|
* @param session_pool Pointer to device session mempool, used
|
|
* for session-less operations.
|
|
*
|
|
* @return
|
|
* - 0: Success, queue pair correctly set up.
|
|
* - <0: Queue pair configuration failed
|
|
*/
|
|
extern 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,
|
|
struct rte_mempool *session_pool);
|
|
|
|
/**
|
|
* Start a specified queue pair of a device. It is used
|
|
* when deferred_start flag of the specified queue is true.
|
|
*
|
|
* @param dev_id The identifier of the device
|
|
* @param 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().
|
|
* @return
|
|
* - 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.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
|
|
|
|
/**
|
|
* Stop specified queue pair of a device
|
|
*
|
|
* @param dev_id The identifier of the device
|
|
* @param 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().
|
|
* @return
|
|
* - 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.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
|
|
|
|
/**
|
|
* Get the number of queue pairs on a specific crypto device
|
|
*
|
|
* @param dev_id Crypto device identifier.
|
|
* @return
|
|
* - The number of configured queue pairs.
|
|
*/
|
|
extern uint16_t
|
|
rte_cryptodev_queue_pair_count(uint8_t dev_id);
|
|
|
|
|
|
/**
|
|
* Retrieve the general I/O statistics of a device.
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
* @param stats A pointer to a structure of type
|
|
* *rte_cryptodev_stats* to be filled with the
|
|
* values of device counters.
|
|
* @return
|
|
* - Zero if successful.
|
|
* - Non-zero otherwise.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
|
|
|
|
/**
|
|
* Reset the general I/O statistics of a device.
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
*/
|
|
extern void
|
|
rte_cryptodev_stats_reset(uint8_t dev_id);
|
|
|
|
/**
|
|
* Retrieve the contextual information of a device.
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
* @param dev_info A pointer to a structure of type
|
|
* *rte_cryptodev_info* to be filled with the
|
|
* contextual information of the device.
|
|
*/
|
|
extern void
|
|
rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
|
|
|
|
|
|
/**
|
|
* Register a callback function for specific device id.
|
|
*
|
|
* @param dev_id Device id.
|
|
* @param event Event interested.
|
|
* @param cb_fn User supplied callback function to be called.
|
|
* @param cb_arg Pointer to the parameters for the registered
|
|
* callback.
|
|
*
|
|
* @return
|
|
* - On success, zero.
|
|
* - On failure, a negative value.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_callback_register(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.
|
|
*
|
|
* @param dev_id The device identifier.
|
|
* @param event Event interested.
|
|
* @param cb_fn User supplied callback function to be called.
|
|
* @param cb_arg Pointer to the parameters for the registered
|
|
* callback.
|
|
*
|
|
* @return
|
|
* - On success, zero.
|
|
* - On failure, a negative value.
|
|
*/
|
|
extern int
|
|
rte_cryptodev_callback_unregister(uint8_t dev_id,
|
|
enum rte_cryptodev_event_type event,
|
|
rte_cryptodev_cb_fn cb_fn, void *cb_arg);
|
|
|
|
|
|
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. */
|
|
|
|
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. */
|
|
|
|
|
|
|
|
|
|
struct rte_cryptodev_callback;
|
|
|
|
/** Structure to keep track of registered callbacks */
|
|
TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
|
|
|
|
/** The data structure associated with each crypto device. */
|
|
struct rte_cryptodev {
|
|
dequeue_pkt_burst_t dequeue_burst;
|
|
/**< Pointer to PMD receive function. */
|
|
enqueue_pkt_burst_t enqueue_burst;
|
|
/**< Pointer to PMD transmit function. */
|
|
|
|
struct rte_cryptodev_data *data;
|
|
/**< Pointer to device data */
|
|
struct rte_cryptodev_ops *dev_ops;
|
|
/**< Functions exported by PMD */
|
|
uint64_t feature_flags;
|
|
/**< Supported features */
|
|
struct rte_device *device;
|
|
/**< Backing device */
|
|
|
|
uint8_t driver_id;
|
|
/**< Crypto driver identifier*/
|
|
|
|
struct rte_cryptodev_cb_list link_intr_cbs;
|
|
/**< User application callback for interrupts if present */
|
|
|
|
__extension__
|
|
uint8_t attached : 1;
|
|
/**< Flag indicating the device is attached */
|
|
} __rte_cache_aligned;
|
|
|
|
/**
|
|
*
|
|
* The data part, with no function pointers, associated with each device.
|
|
*
|
|
* This structure is safe to place in shared memory to be common among
|
|
* different processes in a multi-process configuration.
|
|
*/
|
|
struct rte_cryptodev_data {
|
|
uint8_t dev_id;
|
|
/**< Device ID for this instance */
|
|
uint8_t socket_id;
|
|
/**< Socket ID where memory is allocated */
|
|
char name[RTE_CRYPTODEV_NAME_MAX_LEN];
|
|
/**< Unique identifier name */
|
|
|
|
__extension__
|
|
uint8_t dev_started : 1;
|
|
/**< Device state: STARTED(1)/STOPPED(0) */
|
|
|
|
struct rte_mempool *session_pool;
|
|
/**< Session memory pool */
|
|
void **queue_pairs;
|
|
/**< Array of pointers to queue pairs. */
|
|
uint16_t nb_queue_pairs;
|
|
/**< Number of device queue pairs. */
|
|
|
|
void *dev_private;
|
|
/**< PMD-specific private data */
|
|
} __rte_cache_aligned;
|
|
|
|
extern struct rte_cryptodev *rte_cryptodevs;
|
|
/**
|
|
*
|
|
* 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.
|
|
*
|
|
* @param dev_id The symmetric crypto device identifier
|
|
* @param 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().
|
|
* @param 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.
|
|
* @param nb_ops The maximum number of operations to dequeue.
|
|
*
|
|
* @return
|
|
* - The number of operations actually dequeued, which is the number
|
|
* of pointers to *rte_crypto_op* structures effectively supplied to the
|
|
* *ops* array.
|
|
*/
|
|
static inline uint16_t
|
|
rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
|
|
struct rte_crypto_op **ops, uint16_t nb_ops)
|
|
{
|
|
struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
|
|
|
|
nb_ops = (*dev->dequeue_burst)
|
|
(dev->data->queue_pairs[qp_id], ops, nb_ops);
|
|
|
|
return nb_ops;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param dev_id The identifier of the device.
|
|
* @param 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*.
|
|
* @param ops The address of an array of *nb_ops* pointers
|
|
* to *rte_crypto_op* structures which contain
|
|
* the crypto operations to be processed.
|
|
* @param nb_ops The number of operations to process.
|
|
*
|
|
* @return
|
|
* 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*.
|
|
*/
|
|
static inline 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 *dev = &rte_cryptodevs[dev_id];
|
|
|
|
return (*dev->enqueue_burst)(
|
|
dev->data->queue_pairs[qp_id], ops, nb_ops);
|
|
}
|
|
|
|
|
|
/** Cryptodev symmetric crypto session */
|
|
struct rte_cryptodev_sym_session {
|
|
__extension__ void *sess_private_data[0];
|
|
/**< Private session material */
|
|
};
|
|
|
|
|
|
/**
|
|
* Create symmetric crypto session header (generic with no private data)
|
|
*
|
|
* @param mempool Symmetric session mempool to allocate session
|
|
* objects from
|
|
* @return
|
|
* - On success return pointer to sym-session
|
|
* - On failure returns NULL
|
|
*/
|
|
struct rte_cryptodev_sym_session *
|
|
rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
|
|
|
|
/**
|
|
* Frees symmetric crypto session header, after checking that all
|
|
* the device private data has been freed, returning it
|
|
* to its original mempool.
|
|
*
|
|
* @param sess Session header to be freed.
|
|
*
|
|
* @return
|
|
* - 0 if successful.
|
|
* - -EINVAL if session is NULL.
|
|
* - -EBUSY if not all device private data has been freed.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
|
|
|
|
/**
|
|
* Fill out private data for the device id, based on its device type.
|
|
*
|
|
* @param dev_id ID of device that we want the session to be used on
|
|
* @param sess Session where the private data will be attached to
|
|
* @param xforms Symmetric crypto transform operations to apply on flow
|
|
* processed with this session
|
|
* @param mempool Mempool where the private data is allocated.
|
|
*
|
|
* @return
|
|
* - On success, zero.
|
|
* - On failure, a negative value.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_session_init(uint8_t dev_id,
|
|
struct rte_cryptodev_sym_session *sess,
|
|
struct rte_crypto_sym_xform *xforms,
|
|
struct rte_mempool *mempool);
|
|
|
|
/**
|
|
* Frees private data for the device id, based on its device type,
|
|
* returning it to its mempool.
|
|
*
|
|
* @param dev_id ID of device that uses the session.
|
|
* @param sess Session containing the reference to the private data
|
|
*
|
|
* @return
|
|
* - 0 if successful.
|
|
* - -EINVAL if device is invalid or session is NULL.
|
|
*/
|
|
int
|
|
rte_cryptodev_sym_session_clear(uint8_t dev_id,
|
|
struct rte_cryptodev_sym_session *sess);
|
|
|
|
/**
|
|
* Get the size of the header session, for all registered drivers.
|
|
*
|
|
* @return
|
|
* Size of the header session.
|
|
*/
|
|
unsigned int
|
|
rte_cryptodev_get_header_session_size(void);
|
|
|
|
/**
|
|
* Get the size of the private session data for a device.
|
|
*
|
|
* @param dev_id The device identifier.
|
|
*
|
|
* @return
|
|
* - Size of the private data, if successful
|
|
* - 0 if device is invalid or does not have private session
|
|
*/
|
|
unsigned int
|
|
rte_cryptodev_get_private_session_size(uint8_t dev_id);
|
|
|
|
/**
|
|
* Attach queue pair with sym session.
|
|
*
|
|
* @param dev_id Device to which the session will be attached.
|
|
* @param qp_id Queue pair to which the session will be attached.
|
|
* @param session Session pointer previously allocated by
|
|
* *rte_cryptodev_sym_session_create*.
|
|
*
|
|
* @return
|
|
* - On success, zero.
|
|
* - On failure, a negative value.
|
|
*/
|
|
int
|
|
rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
|
|
struct rte_cryptodev_sym_session *session);
|
|
|
|
/**
|
|
* Detach queue pair with sym session.
|
|
*
|
|
* @param dev_id Device to which the session is attached.
|
|
* @param qp_id Queue pair to which the session is attached.
|
|
* @param session Session pointer previously allocated by
|
|
* *rte_cryptodev_sym_session_create*.
|
|
*
|
|
* @return
|
|
* - On success, zero.
|
|
* - On failure, a negative value.
|
|
*/
|
|
int
|
|
rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
|
|
struct rte_cryptodev_sym_session *session);
|
|
|
|
/**
|
|
* Provide driver identifier.
|
|
*
|
|
* @param name
|
|
* The pointer to a driver name.
|
|
* @return
|
|
* The driver type identifier or -1 if no driver found
|
|
*/
|
|
int rte_cryptodev_driver_id_get(const char *name);
|
|
|
|
/**
|
|
* Provide driver name.
|
|
*
|
|
* @param driver_id
|
|
* The driver identifier.
|
|
* @return
|
|
* The driver name or null if no driver found
|
|
*/
|
|
const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
|
|
|
|
/**
|
|
* @internal
|
|
* Allocate Cryptodev driver.
|
|
*
|
|
* @param driver
|
|
* Pointer to rte_driver.
|
|
* @return
|
|
* The driver type identifier
|
|
*/
|
|
uint8_t rte_cryptodev_allocate_driver(const struct rte_driver *driver);
|
|
|
|
|
|
#define RTE_PMD_REGISTER_CRYPTO_DRIVER(drv, driver_id)\
|
|
RTE_INIT(init_ ##driver_id);\
|
|
static void init_ ##driver_id(void)\
|
|
{\
|
|
driver_id = rte_cryptodev_allocate_driver(&(drv).driver);\
|
|
}
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_CRYPTODEV_H_ */
|