2 *------------------------------------------------------------------
3 * Copyright (c) 2019 - 2021 Intel and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
17 #ifndef included_cryptodev_h
18 #define included_cryptodev_h
20 #include <vnet/crypto/crypto.h>
22 #include <rte_cryptodev.h>
24 #define CRYPTODEV_NB_CRYPTO_OPS 1024
25 #define CRYPTODEV_CACHE_QUEUE_SIZE VNET_CRYPTO_FRAME_POOL_SIZE
26 #define CRYPTODEV_CACHE_QUEUE_MASK (VNET_CRYPTO_FRAME_POOL_SIZE - 1)
27 #define CRYPTODEV_MAX_INFLIGHT (CRYPTODEV_NB_CRYPTO_OPS - 1)
28 #define CRYPTODEV_AAD_MASK (CRYPTODEV_NB_CRYPTO_OPS - 1)
29 #define CRYPTODE_ENQ_MAX 64
30 #define CRYPTODE_DEQ_MAX 64
31 #define CRYPTODEV_NB_SESSION 4096
32 #define CRYPTODEV_MAX_IV_SIZE 16
33 #define CRYPTODEV_MAX_AAD_SIZE 16
34 #define CRYPTODEV_MAX_N_SGL 8 /**< maximum number of segments */
36 #define CRYPTODEV_IV_OFFSET (offsetof (cryptodev_op_t, iv))
37 #define CRYPTODEV_AAD_OFFSET (offsetof (cryptodev_op_t, aad))
39 /* VNET_CRYPTO_ALGO, TYPE, DPDK_CRYPTO_ALGO, IV_LEN, TAG_LEN, AAD_LEN, KEY_LEN
41 #define foreach_vnet_aead_crypto_conversion \
42 _ (AES_128_GCM, AEAD, AES_GCM, 12, 16, 8, 16) \
43 _ (AES_128_GCM, AEAD, AES_GCM, 12, 16, 12, 16) \
44 _ (AES_192_GCM, AEAD, AES_GCM, 12, 16, 8, 24) \
45 _ (AES_192_GCM, AEAD, AES_GCM, 12, 16, 12, 24) \
46 _ (AES_256_GCM, AEAD, AES_GCM, 12, 16, 8, 32) \
47 _ (AES_256_GCM, AEAD, AES_GCM, 12, 16, 12, 32) \
48 _ (CHACHA20_POLY1305, AEAD, CHACHA20_POLY1305, 12, 16, 0, 32) \
49 _ (CHACHA20_POLY1305, AEAD, CHACHA20_POLY1305, 12, 16, 8, 32) \
50 _ (CHACHA20_POLY1305, AEAD, CHACHA20_POLY1305, 12, 16, 12, 32)
53 * crypto (alg, cryptodev_alg, key_size), hash (alg, digest-size)
55 #define foreach_cryptodev_link_async_alg \
56 _ (AES_128_CBC, AES_CBC, 16, MD5, 12) \
57 _ (AES_192_CBC, AES_CBC, 24, MD5, 12) \
58 _ (AES_256_CBC, AES_CBC, 32, MD5, 12) \
59 _ (AES_128_CBC, AES_CBC, 16, SHA1, 12) \
60 _ (AES_192_CBC, AES_CBC, 24, SHA1, 12) \
61 _ (AES_256_CBC, AES_CBC, 32, SHA1, 12) \
62 _ (AES_128_CBC, AES_CBC, 16, SHA224, 14) \
63 _ (AES_192_CBC, AES_CBC, 24, SHA224, 14) \
64 _ (AES_256_CBC, AES_CBC, 32, SHA224, 14) \
65 _ (AES_128_CBC, AES_CBC, 16, SHA256, 16) \
66 _ (AES_192_CBC, AES_CBC, 24, SHA256, 16) \
67 _ (AES_256_CBC, AES_CBC, 32, SHA256, 16) \
68 _ (AES_128_CBC, AES_CBC, 16, SHA384, 24) \
69 _ (AES_192_CBC, AES_CBC, 24, SHA384, 24) \
70 _ (AES_256_CBC, AES_CBC, 32, SHA384, 24) \
71 _ (AES_128_CBC, AES_CBC, 16, SHA512, 32) \
72 _ (AES_192_CBC, AES_CBC, 24, SHA512, 32) \
73 _ (AES_256_CBC, AES_CBC, 32, SHA512, 32) \
74 _ (AES_128_CTR, AES_CTR, 16, SHA1, 12) \
75 _ (AES_192_CTR, AES_CTR, 24, SHA1, 12) \
76 _ (AES_256_CTR, AES_CTR, 32, SHA1, 12)
80 CRYPTODEV_OP_TYPE_ENCRYPT = 0,
81 CRYPTODEV_OP_TYPE_DECRYPT,
83 } cryptodev_op_type_t;
85 #if RTE_VERSION >= RTE_VERSION_NUM(22, 11, 0, 0)
86 typedef void cryptodev_session_t;
88 typedef struct rte_cryptodev_sym_session cryptodev_session_t;
91 /* Cryptodev session data, one data per direction per numa */
94 cryptodev_session_t ***keys;
97 /* Replicate DPDK rte_cryptodev_sym_capability structure with key size ranges
98 * in favor of vpp vector */
101 enum rte_crypto_sym_xform_type xform_type;
106 enum rte_crypto_auth_algorithm algo; /*auth algo */
107 u32 *digest_sizes; /* vector of auth digest sizes */
111 enum rte_crypto_cipher_algorithm algo; /* cipher algo */
112 u32 *key_sizes; /* vector of cipher key sizes */
116 enum rte_crypto_aead_algorithm algo; /* aead algo */
117 u32 *key_sizes; /*vector of aead key sizes */
118 u32 *aad_sizes; /*vector of aad sizes */
119 u32 *digest_sizes; /* vector of aead digest sizes */
122 } cryptodev_capability_t;
124 /* Cryptodev instance data */
134 struct rte_mempool *sess_pool;
135 #if RTE_VERSION < RTE_VERSION_NUM(22, 11, 0, 0)
136 struct rte_mempool *sess_priv_pool;
138 } cryptodev_session_pool_t;
142 cryptodev_session_pool_t *sess_pools;
143 } cryptodev_numa_data_t;
147 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
148 struct rte_crypto_op op;
149 struct rte_crypto_sym_op sop;
150 u8 iv[CRYPTODEV_MAX_IV_SIZE];
151 u8 aad[CRYPTODEV_MAX_AAD_SIZE];
152 vnet_crypto_async_frame_t *frame;
158 vnet_crypto_async_frame_t *f;
163 /* index of frame elt where enque to
164 * the crypto engine is happening */
166 /* index of the frame elt where dequeue
167 * from the crypto engine is happening */
179 u64 frame_elts_errs_mask;
180 } cryptodev_cache_ring_elt_t;
184 cryptodev_cache_ring_elt_t frames[VNET_CRYPTO_FRAME_POOL_SIZE];
190 /* head of the cache ring */
192 /* tail of the cache ring */
194 /* index of the frame where enqueue
195 * to the crypto engine is happening */
197 /* index of the frame where dequeue
198 * from the crypto engine is happening */
203 } cryptodev_cache_ring_t;
207 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
208 vlib_buffer_t *b[VNET_CRYPTO_FRAME_SIZE];
211 struct rte_mempool *cop_pool;
214 struct rte_crypto_raw_dp_ctx *ctx;
218 cryptodev_session_t *reset_sess;
222 cryptodev_cache_ring_t cache_ring;
226 } cryptodev_engine_thread_t;
230 cryptodev_numa_data_t *per_numa_data;
231 cryptodev_key_t *keys;
232 cryptodev_engine_thread_t *per_thread_data;
233 enum rte_iova_mode iova_mode;
234 cryptodev_inst_t *cryptodev_inst;
235 clib_bitmap_t *active_cdev_inst_mask;
236 clib_spinlock_t tlock;
237 cryptodev_capability_t *supported_caps;
241 #if RTE_VERSION >= RTE_VERSION_NUM(22, 11, 0, 0)
246 extern cryptodev_main_t cryptodev_main;
248 #define CRYPTODEV_CACHE_RING_GET_FRAME(r, i) \
249 ((r)->frames[(i) &CRYPTODEV_CACHE_QUEUE_MASK].f)
251 #define CRYPTODEV_CACHE_RING_GET_ERR_MASK(r, i) \
252 ((r)->frames[(i) &CRYPTODEV_CACHE_QUEUE_MASK].frame_elts_errs_mask)
254 #define CRYPTODEV_CACHE_RING_GET_FRAME_ELTS_INFLIGHT(r, i) \
255 (((r)->frames[(i) &CRYPTODEV_CACHE_QUEUE_MASK].enq_elts_head) - \
256 ((r)->frames[(i) &CRYPTODEV_CACHE_QUEUE_MASK].deq_elts_tail))
258 static_always_inline void
259 cryptodev_cache_ring_update_enq_head (cryptodev_cache_ring_t *r,
260 vnet_crypto_async_frame_t *f)
262 if (r->frames[r->enq_head].enq_elts_head == f->n_elts)
265 r->enq_head &= CRYPTODEV_CACHE_QUEUE_MASK;
266 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
270 static_always_inline bool
271 cryptodev_cache_ring_update_deq_tail (cryptodev_cache_ring_t *r,
274 if (r->frames[*deq].deq_elts_tail == r->frames[*deq].n_elts)
277 *deq &= CRYPTODEV_CACHE_QUEUE_MASK;
283 static_always_inline u64
284 cryptodev_mark_frame_fill_err (vnet_crypto_async_frame_t *f, u64 current_err,
285 u16 index, u16 n, vnet_crypto_op_status_t op_s)
287 u64 err = current_err;
290 ERROR_ASSERT (index + n <= VNET_CRYPTO_FRAME_SIZE);
291 ERROR_ASSERT (op_s != VNET_CRYPTO_OP_STATUS_COMPLETED);
293 for (i = index; i < (index + n); i++)
294 f->elts[i].status = op_s;
296 err |= (~(~(0u) << n) << index);
301 static_always_inline cryptodev_cache_ring_elt_t *
302 cryptodev_cache_ring_push (cryptodev_cache_ring_t *r,
303 vnet_crypto_async_frame_t *f)
306 cryptodev_cache_ring_elt_t *ring_elt = &r->frames[head];
308 * in debug mode we do the ring sanity test when a frame is enqueued to
313 u16 n_cached = (head >= tail) ? (head - tail) :
314 (CRYPTODEV_CACHE_QUEUE_MASK - tail + head);
315 ERROR_ASSERT (n_cached < VNET_CRYPTO_FRAME_POOL_SIZE);
316 ERROR_ASSERT (r->raw == 0 && r->frames[head].raw == 0 &&
317 r->frames[head].f == 0);
320 ring_elt->n_elts = f->n_elts;
323 r->head &= CRYPTODEV_CACHE_QUEUE_MASK;
327 static_always_inline vnet_crypto_async_frame_t *
328 cryptodev_cache_ring_pop (cryptodev_cache_ring_t *r)
330 vnet_crypto_async_frame_t *f;
332 cryptodev_cache_ring_elt_t *ring_elt = &r->frames[tail];
334 ERROR_ASSERT (r->frames[r->head].raw == 0 ? r->head != tail : 1);
335 ERROR_ASSERT (r->frames[tail].raw != 0);
336 ERROR_ASSERT (ring_elt->deq_elts_tail == ring_elt->enq_elts_head &&
337 ring_elt->deq_elts_tail == ring_elt->n_elts);
339 f = CRYPTODEV_CACHE_RING_GET_FRAME (r, tail);
340 f->state = CRYPTODEV_CACHE_RING_GET_ERR_MASK (r, r->tail) == 0 ?
341 VNET_CRYPTO_FRAME_STATE_SUCCESS :
342 VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
344 clib_memset (ring_elt, 0, sizeof (*ring_elt));
346 r->tail &= CRYPTODEV_CACHE_QUEUE_MASK;
351 int cryptodev_session_create (vlib_main_t *vm, vnet_crypto_key_index_t idx,
354 void cryptodev_sess_handler (vlib_main_t *vm, vnet_crypto_key_op_t kop,
355 vnet_crypto_key_index_t idx, u32 aad_len);
357 int cryptodev_check_cap_support (struct rte_cryptodev_sym_capability_idx *idx,
358 u32 key_size, u32 digest_size, u32 aad_size);
360 clib_error_t *cryptodev_register_cop_hdl (vlib_main_t *vm, u32 eidx);
362 clib_error_t *__clib_weak cryptodev_register_raw_hdl (vlib_main_t *vm,
365 clib_error_t *__clib_weak dpdk_cryptodev_init (vlib_main_t *vm);