DPDK 22.11.5
rte_crypto_sym.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2020 Intel Corporation
3 */
4
5#ifndef _RTE_CRYPTO_SYM_H_
6#define _RTE_CRYPTO_SYM_H_
7
17#ifdef __cplusplus
18extern "C" {
19#endif
20
21#include <string.h>
22
23#include <rte_compat.h>
24#include <rte_mbuf.h>
25#include <rte_memory.h>
26#include <rte_mempool.h>
27#include <rte_common.h>
28
36 void *base;
40 uint32_t len;
42 uint32_t tot_len;
43};
44
53 uint32_t num;
54};
55
62 void *va;
63 rte_iova_t iova;
64};
65
73 uint32_t num;
82
83 __extension__
84 union {
89 };
90
96 int32_t *status;
97};
98
104 uint64_t raw;
105 struct {
106 struct {
107 uint16_t head;
108 uint16_t tail;
109 } auth, cipher;
110 } ofs;
111};
112
178
180extern const char *
182
190
192extern const char *
194
210 struct {
211 const uint8_t *data;
212 uint16_t length;
213 } key;
245 struct {
246 uint16_t offset;
272 uint16_t length;
287 } iv;
289 uint32_t dataunit_len;
300};
301
379
381extern const char *
383
389
391extern const char *
393
407 struct {
408 const uint8_t *data;
409 uint16_t length;
410 } key;
418 struct {
419 uint16_t offset;
435 uint16_t length;
453 } iv;
465};
466
467
483
485extern const char *
487
495
497extern const char *
499
500struct rte_crypto_aead_xform {
506 struct {
507 const uint8_t *data;
508 uint16_t length;
509 } key;
510
511 struct {
512 uint16_t offset;
532 uint16_t length;
548 } iv;
550 uint16_t digest_length;
551
552 uint16_t aad_length;
558};
559
567
577/* Structure rte_crypto_sym_xform 8< */
582 ;
584 union {
589 struct rte_crypto_aead_xform aead;
591 };
592};
593/* >8 End of structure rte_crypto_sym_xform. */
594
625/* Structure rte_crypto_sym_op 8< */
627 struct rte_mbuf *m_src;
628 struct rte_mbuf *m_dst;
631 union {
632 void *session;
636 };
637
639 union {
640 struct {
641 struct {
642 uint32_t offset;
647 uint32_t length;
653 struct {
654 uint8_t *data;
677 struct {
678 uint8_t *data;
710 } aad;
712 } aead;
713
714 struct {
715 struct {
716 struct {
717 uint32_t offset;
733 uint32_t length;
751 } cipher;
752
753 struct {
754 struct {
755 uint32_t offset;
781 uint32_t length;
805 } data;
808 struct {
809 uint8_t *data;
883 } auth;
884 };
885 };
886};
887/* >8 End of structure rte_crypto_sym_op. */
888
889
895static inline void
897{
898 memset(op, 0, sizeof(*op));
899}
900
901
912static inline struct rte_crypto_sym_xform *
914 void *priv_data, uint8_t nb_xforms)
915{
916 struct rte_crypto_sym_xform *xform;
917
918 sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
919
920 do {
922 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
923 } while (xform);
924
925 return sym_op->xform;
926}
927
928
935static inline int
937{
938 sym_op->session = sess;
939
940 return 0;
941}
942
961__rte_experimental
962static inline int
963rte_crypto_mbuf_to_vec(const struct rte_mbuf *mb, uint32_t ofs, uint32_t len,
964 struct rte_crypto_vec vec[], uint32_t num)
965{
966 uint32_t i;
967 struct rte_mbuf *nseg;
968 uint32_t left;
969 uint32_t seglen;
970
971 /* assuming that requested data starts in the first segment */
972 RTE_ASSERT(mb->data_len > ofs);
973
974 if (mb->nb_segs > num)
975 return -mb->nb_segs;
976
977 vec[0].base = rte_pktmbuf_mtod_offset(mb, void *, ofs);
978 vec[0].iova = rte_pktmbuf_iova_offset(mb, ofs);
979 vec[0].tot_len = mb->buf_len - rte_pktmbuf_headroom(mb) - ofs;
980
981 /* whole data lies in the first segment */
982 seglen = mb->data_len - ofs;
983 if (len <= seglen) {
984 vec[0].len = len;
985 return 1;
986 }
987
988 /* data spread across segments */
989 vec[0].len = seglen;
990 left = len - seglen;
991 for (i = 1, nseg = mb->next; nseg != NULL; nseg = nseg->next, i++) {
992
993 vec[i].base = rte_pktmbuf_mtod(nseg, void *);
994 vec[i].iova = rte_pktmbuf_iova(nseg);
995 vec[i].tot_len = mb->buf_len - rte_pktmbuf_headroom(mb) - ofs;
996
997 seglen = nseg->data_len;
998 if (left <= seglen) {
999 /* whole requested data is completed */
1000 vec[i].len = left;
1001 left = 0;
1002 i++;
1003 break;
1004 }
1005
1006 /* use whole segment */
1007 vec[i].len = seglen;
1008 left -= seglen;
1009 }
1010
1011 RTE_ASSERT(left == 0);
1012 return i;
1013}
1014
1015
1016#ifdef __cplusplus
1017}
1018#endif
1019
1020#endif /* _RTE_CRYPTO_SYM_H_ */
uint64_t rte_iova_t
Definition: rte_common.h:458
#define RTE_STD_C11
Definition: rte_common.h:39
static void __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
rte_crypto_auth_algorithm
@ RTE_CRYPTO_AUTH_SHA512_HMAC
@ RTE_CRYPTO_AUTH_ZUC_EIA3
@ RTE_CRYPTO_AUTH_SHA3_224
@ RTE_CRYPTO_AUTH_AES_CBC_MAC
@ RTE_CRYPTO_AUTH_SHA224_HMAC
@ RTE_CRYPTO_AUTH_AES_XCBC_MAC
@ RTE_CRYPTO_AUTH_SHA3_224_HMAC
@ RTE_CRYPTO_AUTH_SNOW3G_UIA2
@ RTE_CRYPTO_AUTH_SHA1
@ RTE_CRYPTO_AUTH_SHA3_384_HMAC
@ RTE_CRYPTO_AUTH_SHA512
@ RTE_CRYPTO_AUTH_SHA384_HMAC
@ RTE_CRYPTO_AUTH_KASUMI_F9
@ RTE_CRYPTO_AUTH_SM3
@ RTE_CRYPTO_AUTH_MD5
@ RTE_CRYPTO_AUTH_MD5_HMAC
@ RTE_CRYPTO_AUTH_SHA384
@ RTE_CRYPTO_AUTH_SHA224
@ RTE_CRYPTO_AUTH_SHA3_512
@ RTE_CRYPTO_AUTH_AES_CMAC
@ RTE_CRYPTO_AUTH_SHA3_256_HMAC
@ RTE_CRYPTO_AUTH_SHA1_HMAC
@ RTE_CRYPTO_AUTH_NULL
@ RTE_CRYPTO_AUTH_SHA3_384
@ RTE_CRYPTO_AUTH_SHA3_256
@ RTE_CRYPTO_AUTH_SHA256
@ RTE_CRYPTO_AUTH_SHA256_HMAC
@ RTE_CRYPTO_AUTH_AES_GMAC
@ RTE_CRYPTO_AUTH_SHA3_512_HMAC
const char * rte_crypto_auth_algorithm_strings[]
const char * rte_crypto_cipher_operation_strings[]
rte_crypto_cipher_operation
@ RTE_CRYPTO_CIPHER_OP_DECRYPT
@ RTE_CRYPTO_CIPHER_OP_ENCRYPT
rte_crypto_sym_xform_type
@ RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED
@ RTE_CRYPTO_SYM_XFORM_AUTH
@ RTE_CRYPTO_SYM_XFORM_AEAD
@ RTE_CRYPTO_SYM_XFORM_CIPHER
rte_crypto_aead_algorithm
@ RTE_CRYPTO_AEAD_AES_CCM
@ RTE_CRYPTO_AEAD_AES_GCM
@ RTE_CRYPTO_AEAD_CHACHA20_POLY1305
rte_crypto_cipher_algorithm
@ RTE_CRYPTO_CIPHER_DES_CBC
@ RTE_CRYPTO_CIPHER_SM4_ECB
@ RTE_CRYPTO_CIPHER_ARC4
@ RTE_CRYPTO_CIPHER_AES_XTS
@ RTE_CRYPTO_CIPHER_AES_CTR
@ RTE_CRYPTO_CIPHER_AES_DOCSISBPI
@ RTE_CRYPTO_CIPHER_SNOW3G_UEA2
@ RTE_CRYPTO_CIPHER_SM4_CBC
@ RTE_CRYPTO_CIPHER_3DES_ECB
@ RTE_CRYPTO_CIPHER_ZUC_EEA3
@ RTE_CRYPTO_CIPHER_DES_DOCSISBPI
@ RTE_CRYPTO_CIPHER_NULL
@ RTE_CRYPTO_CIPHER_SM4_CTR
@ RTE_CRYPTO_CIPHER_KASUMI_F8
@ RTE_CRYPTO_CIPHER_AES_CBC
@ RTE_CRYPTO_CIPHER_AES_F8
@ RTE_CRYPTO_CIPHER_3DES_CBC
@ RTE_CRYPTO_CIPHER_3DES_CTR
@ RTE_CRYPTO_CIPHER_AES_ECB
const char * rte_crypto_aead_operation_strings[]
rte_crypto_auth_operation
@ RTE_CRYPTO_AUTH_OP_VERIFY
@ RTE_CRYPTO_AUTH_OP_GENERATE
const char * rte_crypto_aead_algorithm_strings[]
static int __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op, void *sess)
rte_crypto_aead_operation
@ RTE_CRYPTO_AEAD_OP_DECRYPT
@ RTE_CRYPTO_AEAD_OP_ENCRYPT
const char * rte_crypto_auth_operation_strings[]
const char * rte_crypto_cipher_algorithm_strings[]
static struct rte_crypto_sym_xform * __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op, void *priv_data, uint8_t nb_xforms)
static __rte_experimental int rte_crypto_mbuf_to_vec(const struct rte_mbuf *mb, uint32_t ofs, uint32_t len, struct rte_crypto_vec vec[], uint32_t num)
static uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
Definition: rte_mbuf.h:1511
#define rte_pktmbuf_iova_offset(m, o)
#define rte_pktmbuf_iova(m)
#define rte_pktmbuf_mtod(m, t)
#define rte_pktmbuf_mtod_offset(m, t, o)
enum rte_crypto_auth_algorithm algo
struct rte_crypto_auth_xform::@76 key
const uint8_t * data
enum rte_crypto_auth_operation op
struct rte_crypto_auth_xform::@77 iv
struct rte_crypto_cipher_xform::@74 key
enum rte_crypto_cipher_algorithm algo
struct rte_crypto_cipher_xform::@75 iv
enum rte_crypto_cipher_operation op
struct rte_crypto_vec * vec
struct rte_crypto_sym_op::@84::@86::@89 data
struct rte_crypto_sym_op::@84::@86::@90 digest
struct rte_mbuf * m_dst
struct rte_crypto_sym_op::@84::@86::@91 aad
struct rte_crypto_sym_xform * xform
rte_iova_t phys_addr
struct rte_mbuf * m_src
struct rte_crypto_sgl * src_sgl
struct rte_crypto_sgl * dest_sgl
struct rte_crypto_va_iova_ptr * iv
struct rte_crypto_va_iova_ptr * auth_iv
struct rte_crypto_va_iova_ptr * digest
struct rte_crypto_va_iova_ptr * aad
struct rte_crypto_auth_xform auth
enum rte_crypto_sym_xform_type type
struct rte_crypto_sym_xform * next
struct rte_crypto_cipher_xform cipher
struct rte_crypto_aead_xform aead
rte_iova_t iova
uint32_t tot_len
uint16_t nb_segs
uint16_t buf_len
struct rte_mbuf * next
uint16_t data_len