5#ifndef _RTE_CRYPTODEV_H_
6#define _RTE_CRYPTODEV_H_
21#include <rte_compat.h>
27#include "rte_cryptodev_trace_fp.h"
31#define CDEV_LOG_ERR(...) \
32 RTE_LOG(ERR, CRYPTODEV, \
33 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
34 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
36#define CDEV_LOG_INFO(...) \
37 RTE_LOG(INFO, CRYPTODEV, \
38 RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
39 RTE_FMT_TAIL(__VA_ARGS__,)))
41#define CDEV_LOG_DEBUG(...) \
42 RTE_LOG(DEBUG, CRYPTODEV, \
43 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
44 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
46#define CDEV_PMD_TRACE(...) \
47 RTE_LOG(DEBUG, CRYPTODEV, \
48 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
49 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
64#define rte_crypto_op_ctod_offset(c, t, o) \
65 ((t)((char *)(c) + (o)))
78#define rte_crypto_op_ctophys_offset(c, o) \
79 (rte_iova_t)((c)->phys_addr + (o))
100#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_512_BYTES RTE_BIT32(0)
101#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4096_BYTES RTE_BIT32(1)
102#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_1_MEGABYTES RTE_BIT32(2)
274 uint16_t key_size, uint16_t iv_size);
292 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
311 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
359 const char *algo_string);
374 const char *algo_string);
389 const char *algo_string);
405 const char *xform_string);
409#define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
410 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
421#define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
423#define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
425#define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
427#define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
429#define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
431#define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
433#define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
435#define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
439#define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
441#define RTE_CRYPTODEV_FF_IN_PLACE_SGL (1ULL << 9)
445#define RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT (1ULL << 10)
449#define RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT (1ULL << 11)
454#define RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT (1ULL << 12)
458#define RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT (1ULL << 13)
460#define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 14)
462#define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 15)
464#define RTE_CRYPTODEV_FF_SECURITY (1ULL << 16)
466#define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_EXP (1ULL << 17)
468#define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_QT (1ULL << 18)
470#define RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED (1ULL << 19)
472#define RTE_CRYPTODEV_FF_ASYM_SESSIONLESS (1ULL << 20)
474#define RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO (1ULL << 21)
476#define RTE_CRYPTODEV_FF_SYM_SESSIONLESS (1ULL << 22)
478#define RTE_CRYPTODEV_FF_NON_BYTE_ALIGNED_DATA (1ULL << 23)
480#define RTE_CRYPTODEV_FF_SYM_RAW_DP (1ULL << 24)
482#define RTE_CRYPTODEV_FF_CIPHER_MULTIPLE_DATA_UNITS (1ULL << 25)
484#define RTE_CRYPTODEV_FF_CIPHER_WRAPPED_KEY (1ULL << 26)
486#define RTE_CRYPTODEV_FF_SECURITY_INNER_CSUM (1ULL << 27)
533#define RTE_CRYPTODEV_DETACHED (0)
534#define RTE_CRYPTODEV_ATTACHED (1)
574 struct rte_crypto_op **ops, uint16_t nb_ops,
void *user_param);
602#define RTE_CRYPTODEV_NAME_MAX_LEN (64)
676rte_cryptodev_socket_id(uint8_t dev_id);
878struct rte_cryptodev_callback;
900struct rte_cryptodev_cb_rcu {
903 struct rte_rcu_qsbr *qsbr;
1141#define CRYPTO_SESS_OPAQUE_DATA_OFF 0
1145static inline uint64_t
1148 return *((uint64_t *)sess + CRYPTO_SESS_OPAQUE_DATA_OFF);
1158 data = (((uint64_t *)sess) + CRYPTO_SESS_OPAQUE_DATA_OFF);
1258 void *ev_mdata, uint16_t
size);
1266 struct rte_security_session *sec_sess;
1361 uint32_t index, uint8_t is_op_success);
1407 uint32_t max_nb_to_dequeue,
1409 void **out_user_data, uint8_t is_user_data_array,
1410 uint32_t *n_success,
int *dequeue_status);
1435typedef void * (*cryptodev_sym_raw_dequeue_t)(
1436 void *qp, uint8_t *drv_ctx,
int *dequeue_status,
1455 __extension__ uint8_t drv_ctx_data[];
1517 void **user_data,
int *enqueue_status);
1549 return (*ctx->enqueue)(ctx->qp_data, ctx->drv_ctx_data, data_vec,
1550 n_data_vecs, ofs, iv, digest, aad_or_auth_iv, user_data);
1613 uint32_t max_nb_to_dequeue,
1615 void **out_user_data, uint8_t is_user_data_array,
1616 uint32_t *n_success,
int *dequeue_status);
1646 return (*ctx->dequeue)(ctx->qp_data, ctx->drv_ctx_data, dequeue_status,
1839static inline uint16_t
1843 const struct rte_crypto_fp_ops *fp_ops;
1846 rte_cryptodev_trace_dequeue_burst(dev_id, qp_id, (
void **)ops, nb_ops);
1848 fp_ops = &rte_crypto_fp_ops[dev_id];
1849 qp = fp_ops->qp.data[qp_id];
1851 nb_ops = fp_ops->dequeue_burst(qp, ops, nb_ops);
1853#ifdef RTE_CRYPTO_CALLBACKS
1854 if (
unlikely(fp_ops->qp.deq_cb != NULL)) {
1855 struct rte_cryptodev_cb_rcu *list;
1864 list = &fp_ops->qp.deq_cb[qp_id];
1866 cb = __atomic_load_n(&list->next, __ATOMIC_RELAXED);
1868 while (cb != NULL) {
1869 nb_ops = cb->
fn(dev_id, qp_id, ops, nb_ops,
1911static inline uint16_t
1915 const struct rte_crypto_fp_ops *fp_ops;
1918 fp_ops = &rte_crypto_fp_ops[dev_id];
1919 qp = fp_ops->qp.data[qp_id];
1920#ifdef RTE_CRYPTO_CALLBACKS
1921 if (
unlikely(fp_ops->qp.enq_cb != NULL)) {
1922 struct rte_cryptodev_cb_rcu *list;
1931 list = &fp_ops->qp.enq_cb[qp_id];
1933 cb = __atomic_load_n(&list->next, __ATOMIC_RELAXED);
1935 while (cb != NULL) {
1936 nb_ops = cb->
fn(dev_id, qp_id, ops, nb_ops,
1945 rte_cryptodev_trace_enqueue_burst(dev_id, qp_id, (
void **)ops, nb_ops);
1946 return fp_ops->enqueue_burst(qp, ops, nb_ops);
#define __rte_always_inline
rte_crypto_asym_xform_type
rte_crypto_auth_algorithm
rte_crypto_sym_xform_type
rte_crypto_aead_algorithm
rte_crypto_cipher_algorithm
static uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id, struct rte_crypto_op **ops, uint16_t nb_ops)
uint32_t(* cryptodev_sym_raw_dequeue_burst_t)(void *qp, uint8_t *drv_ctx, rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count, uint32_t max_nb_to_dequeue, rte_cryptodev_raw_post_dequeue_t post_dequeue, void **out_user_data, uint8_t is_user_data_array, uint32_t *n_success, int *dequeue_status)
int rte_cryptodev_close(uint8_t dev_id)
@ RTE_CRYPTODEV_EVENT_ERROR
@ RTE_CRYPTODEV_EVENT_UNKNOWN
@ RTE_CRYPTODEV_EVENT_MAX
uint8_t rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices, uint8_t nb_devices)
__rte_experimental int rte_cryptodev_get_raw_dp_ctx_size(uint8_t dev_id)
__rte_experimental struct rte_mempool * rte_cryptodev_asym_session_pool_create(const char *name, uint32_t nb_elts, uint32_t cache_size, uint16_t user_data_size, int socket_id)
uint8_t rte_cryptodev_count(void)
__rte_experimental int rte_cryptodev_remove_enq_callback(uint8_t dev_id, uint16_t qp_id, struct rte_cryptodev_cb *cb)
__rte_experimental uint32_t rte_cryptodev_raw_dequeue_burst(struct rte_crypto_raw_dp_ctx *ctx, rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count, uint32_t max_nb_to_dequeue, rte_cryptodev_raw_post_dequeue_t post_dequeue, void **out_user_data, uint8_t is_user_data_array, uint32_t *n_success, int *dequeue_status)
static uint16_t rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id, struct rte_crypto_op **ops, uint16_t nb_ops)
int rte_cryptodev_start(uint8_t dev_id)
const char * rte_cryptodev_driver_name_get(uint8_t driver_id)
void *(* cryptodev_sym_raw_dequeue_t)(void *qp, uint8_t *drv_ctx, int *dequeue_status, enum rte_crypto_op_status *op_status)
__rte_experimental unsigned int rte_cryptodev_asym_get_private_session_size(uint8_t dev_id)
static uint64_t rte_cryptodev_sym_session_opaque_data_get(void *sess)
__rte_experimental uint32_t rte_cryptodev_sym_cpu_crypto_process(uint8_t dev_id, void *sess, union rte_crypto_sym_ofs ofs, struct rte_crypto_sym_vec *vec)
unsigned int rte_cryptodev_is_valid_dev(uint8_t dev_id)
unsigned int rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
int rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum, const char *algo_string)
void rte_cryptodev_stop(uint8_t dev_id)
const char * rte_cryptodev_name_get(uint8_t dev_id)
RTE_TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback)
int rte_cryptodev_callback_unregister(uint8_t dev_id, enum rte_cryptodev_event_type event, rte_cryptodev_cb_fn cb_fn, void *cb_arg)
static void rte_cryptodev_sym_session_opaque_data_set(void *sess, uint64_t opaque)
__rte_experimental void * rte_cryptodev_asym_session_get_user_data(void *sess)
__rte_experimental int rte_cryptodev_asym_session_set_user_data(void *sess, void *data, uint16_t size)
int rte_cryptodev_sym_capability_check_auth(const struct rte_cryptodev_symmetric_capability *capability, uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
__rte_experimental int rte_cryptodev_remove_deq_callback(uint8_t dev_id, uint16_t qp_id, struct rte_cryptodev_cb *cb)
int rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
int rte_cryptodev_callback_register(uint8_t dev_id, enum rte_cryptodev_event_type event, rte_cryptodev_cb_fn cb_fn, void *cb_arg)
__rte_experimental uint32_t rte_cryptodev_raw_enqueue_burst(struct rte_crypto_raw_dp_ctx *ctx, struct rte_crypto_sym_vec *vec, union rte_crypto_sym_ofs ofs, void **user_data, int *enqueue_status)
uint16_t rte_cryptodev_queue_pair_count(uint8_t dev_id)
void(* rte_cryptodev_cb_fn)(uint8_t dev_id, enum rte_cryptodev_event_type event, void *cb_arg)
void * rte_cryptodev_sym_session_create(uint8_t dev_id, struct rte_crypto_sym_xform *xforms, struct rte_mempool *mp)
uint32_t(* cryptodev_sym_raw_enqueue_burst_t)(void *qp, uint8_t *drv_ctx, struct rte_crypto_sym_vec *vec, union rte_crypto_sym_ofs ofs, void *user_data[], int *enqueue_status)
void rte_cryptodev_stats_reset(uint8_t dev_id)
__rte_experimental int rte_cryptodev_asym_session_create(uint8_t dev_id, struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp, void **session)
__rte_experimental struct rte_cryptodev_cb * rte_cryptodev_add_deq_callback(uint8_t dev_id, uint16_t qp_id, rte_cryptodev_callback_fn cb_fn, void *cb_arg)
static __rte_experimental __rte_always_inline int rte_cryptodev_raw_enqueue(struct rte_crypto_raw_dp_ctx *ctx, struct rte_crypto_vec *data_vec, uint16_t n_data_vecs, union rte_crypto_sym_ofs ofs, struct rte_crypto_va_iova_ptr *iv, struct rte_crypto_va_iova_ptr *digest, struct rte_crypto_va_iova_ptr *aad_or_auth_iv, void *user_data)
__rte_experimental int rte_cryptodev_configure_raw_dp_ctx(uint8_t dev_id, uint16_t qp_id, struct rte_crypto_raw_dp_ctx *ctx, enum rte_crypto_op_sess_type sess_type, union rte_cryptodev_session_ctx session_ctx, uint8_t is_update)
__rte_experimental int rte_cryptodev_asym_session_free(uint8_t dev_id, void *sess)
__rte_experimental struct rte_cryptodev_cb * rte_cryptodev_add_enq_callback(uint8_t dev_id, uint16_t qp_id, rte_cryptodev_callback_fn cb_fn, void *cb_arg)
void(* rte_cryptodev_raw_post_dequeue_t)(void *user_data, uint32_t index, uint8_t is_op_success)
__rte_experimental unsigned int rte_cryptodev_asym_get_header_session_size(void)
int rte_cryptodev_driver_id_get(const char *name)
int rte_cryptodev_get_dev_id(const char *name)
void * rte_cryptodev_get_sec_ctx(uint8_t dev_id)
int rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
__rte_experimental int rte_cryptodev_session_event_mdata_set(uint8_t dev_id, void *sess, enum rte_crypto_op_type op_type, enum rte_crypto_op_sess_type sess_type, void *ev_mdata, uint16_t size)
int rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum, const char *algo_string)
uint32_t(* rte_cryptodev_raw_get_dequeue_count_t)(void *user_data)
__rte_experimental int rte_cryptodev_sym_session_set_user_data(void *sess, void *data, uint16_t size)
static __rte_experimental __rte_always_inline void * rte_cryptodev_raw_dequeue(struct rte_crypto_raw_dp_ctx *ctx, int *dequeue_status, enum rte_crypto_op_status *op_status)
int(* cryptodev_sym_raw_enqueue_t)(void *qp, uint8_t *drv_ctx, struct rte_crypto_vec *data_vec, uint16_t n_data_vecs, union rte_crypto_sym_ofs ofs, struct rte_crypto_va_iova_ptr *iv, struct rte_crypto_va_iova_ptr *digest, struct rte_crypto_va_iova_ptr *aad_or_auth_iv, void *user_data)
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)
__rte_experimental int rte_cryptodev_raw_enqueue_done(struct rte_crypto_raw_dp_ctx *ctx, uint32_t n)
__rte_experimental void * rte_cryptodev_sym_session_get_user_data(void *sess)
const char * rte_cryptodev_get_feature_name(uint64_t flag)
int rte_cryptodev_sym_capability_check_cipher(const struct rte_cryptodev_symmetric_capability *capability, uint16_t key_size, uint16_t iv_size)
uint8_t rte_cryptodev_device_count_by_driver(uint8_t driver_id)
__rte_experimental int rte_cryptodev_asym_xform_capability_check_optype(const struct rte_cryptodev_asymmetric_xform_capability *capability, enum rte_crypto_asym_op_type op_type)
int rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum, const char *algo_string)
__rte_experimental const struct rte_cryptodev_asymmetric_xform_capability * rte_cryptodev_asym_capability_get(uint8_t dev_id, const struct rte_cryptodev_asym_capability_idx *idx)
__rte_experimental int rte_cryptodev_get_qp_status(uint8_t dev_id, uint16_t queue_pair_id)
uint16_t(* rte_cryptodev_callback_fn)(uint16_t dev_id, uint16_t qp_id, struct rte_crypto_op **ops, uint16_t nb_ops, void *user_param)
__rte_experimental int rte_cryptodev_raw_dequeue_done(struct rte_crypto_raw_dp_ctx *ctx, uint32_t n)
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)
__rte_experimental int rte_cryptodev_asym_xform_capability_check_modlen(const struct rte_cryptodev_asymmetric_xform_capability *capability, uint16_t modlen)
int(* cryptodev_sym_raw_operation_done_t)(void *qp, uint8_t *drv_ctx, uint32_t n)
__rte_experimental struct rte_mempool * rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts, uint32_t elt_size, uint32_t cache_size, uint16_t priv_size, int socket_id)
void rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
__rte_experimental int rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum, const char *xform_string)
int rte_cryptodev_sym_session_free(uint8_t dev_id, void *sess)
const struct rte_cryptodev_symmetric_capability * rte_cryptodev_sym_capability_get(uint8_t dev_id, const struct rte_cryptodev_sym_capability_idx *idx)
static __rte_always_inline void rte_rcu_qsbr_thread_online(struct rte_rcu_qsbr *v, unsigned int thread_id)
static __rte_always_inline void rte_rcu_qsbr_thread_offline(struct rte_rcu_qsbr *v, unsigned int thread_id)
enum rte_crypto_asym_xform_type type
enum rte_crypto_op_type op
struct rte_cryptodev_symmetric_capability sym
struct rte_cryptodev_asymmetric_capability asym
struct rte_cryptodev_cb * next
rte_cryptodev_callback_fn fn
unsigned max_nb_queue_pairs
struct rte_device * device
uint16_t min_mbuf_headroom_req
const struct rte_cryptodev_capabilities * capabilities
uint16_t min_mbuf_tailroom_req
struct rte_mempool * mp_session
uint64_t enqueue_err_count
uint64_t dequeue_err_count
enum rte_crypto_auth_algorithm algo
enum rte_crypto_cipher_algorithm algo
enum rte_crypto_aead_algorithm algo
struct rte_crypto_param_range iv_size
struct rte_crypto_param_range digest_size
struct rte_crypto_param_range aad_size
struct rte_cryptodev_symmetric_capability::@97::@99 auth
struct rte_cryptodev_symmetric_capability::@97::@100 cipher
struct rte_crypto_param_range key_size
enum rte_crypto_sym_xform_type xform_type
char name[RTE_MEMPOOL_NAMESIZE]