1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2018 Intel Corporation
5 #include <rte_common.h>
6 #include <rte_hexdump.h>
7 #include <rte_cryptodev.h>
8 #include <rte_cryptodev_pmd.h>
9 #include <rte_bus_vdev.h>
10 #include <rte_malloc.h>
11 #include <rte_cpuflags.h>
13 #include "rte_zuc_pmd_private.h"
14 #define ZUC_MAX_BURST 4
17 static uint8_t cryptodev_driver_id;
19 /** Get xform chain order. */
20 static enum zuc_operation
21 zuc_get_mode(const struct rte_crypto_sym_xform *xform)
24 return ZUC_OP_NOT_SUPPORTED;
27 if (xform->next->next != NULL)
28 return ZUC_OP_NOT_SUPPORTED;
30 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
31 if (xform->next == NULL)
32 return ZUC_OP_ONLY_AUTH;
33 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
34 return ZUC_OP_AUTH_CIPHER;
36 return ZUC_OP_NOT_SUPPORTED;
39 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
40 if (xform->next == NULL)
41 return ZUC_OP_ONLY_CIPHER;
42 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
43 return ZUC_OP_CIPHER_AUTH;
45 return ZUC_OP_NOT_SUPPORTED;
48 return ZUC_OP_NOT_SUPPORTED;
52 /** Parse crypto xform chain and set private session parameters. */
54 zuc_set_session_parameters(struct zuc_session *sess,
55 const struct rte_crypto_sym_xform *xform)
57 const struct rte_crypto_sym_xform *auth_xform = NULL;
58 const struct rte_crypto_sym_xform *cipher_xform = NULL;
59 enum zuc_operation mode;
61 /* Select Crypto operation - hash then cipher / cipher then hash */
62 mode = zuc_get_mode(xform);
65 case ZUC_OP_CIPHER_AUTH:
66 auth_xform = xform->next;
69 case ZUC_OP_ONLY_CIPHER:
72 case ZUC_OP_AUTH_CIPHER:
73 cipher_xform = xform->next;
75 case ZUC_OP_ONLY_AUTH:
78 case ZUC_OP_NOT_SUPPORTED:
80 ZUC_LOG(ERR, "Unsupported operation chain order parameter");
85 /* Only ZUC EEA3 supported */
86 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_ZUC_EEA3)
89 if (cipher_xform->cipher.iv.length != ZUC_IV_KEY_LENGTH) {
90 ZUC_LOG(ERR, "Wrong IV length");
93 sess->cipher_iv_offset = cipher_xform->cipher.iv.offset;
96 memcpy(sess->pKey_cipher, cipher_xform->cipher.key.data,
101 /* Only ZUC EIA3 supported */
102 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_ZUC_EIA3)
105 if (auth_xform->auth.digest_length != ZUC_DIGEST_LENGTH) {
106 ZUC_LOG(ERR, "Wrong digest length");
110 sess->auth_op = auth_xform->auth.op;
112 if (auth_xform->auth.iv.length != ZUC_IV_KEY_LENGTH) {
113 ZUC_LOG(ERR, "Wrong IV length");
116 sess->auth_iv_offset = auth_xform->auth.iv.offset;
119 memcpy(sess->pKey_hash, auth_xform->auth.key.data,
129 /** Get ZUC session. */
130 static struct zuc_session *
131 zuc_get_session(struct zuc_qp *qp, struct rte_crypto_op *op)
133 struct zuc_session *sess = NULL;
135 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
136 if (likely(op->sym->session != NULL))
137 sess = (struct zuc_session *)get_sym_session_private_data(
139 cryptodev_driver_id);
142 void *_sess_private_data = NULL;
144 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
147 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
150 sess = (struct zuc_session *)_sess_private_data;
152 if (unlikely(zuc_set_session_parameters(sess,
153 op->sym->xform) != 0)) {
154 rte_mempool_put(qp->sess_mp, _sess);
155 rte_mempool_put(qp->sess_mp, _sess_private_data);
158 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
159 set_sym_session_private_data(op->sym->session,
160 cryptodev_driver_id, _sess_private_data);
163 if (unlikely(sess == NULL))
164 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
170 /** Encrypt/decrypt mbufs. */
172 process_zuc_cipher_op(struct rte_crypto_op **ops,
173 struct zuc_session **sessions,
177 uint8_t processed_ops = 0;
178 uint8_t *src[ZUC_MAX_BURST], *dst[ZUC_MAX_BURST];
179 uint8_t *iv[ZUC_MAX_BURST];
180 uint32_t num_bytes[ZUC_MAX_BURST];
181 uint8_t *cipher_keys[ZUC_MAX_BURST];
182 struct zuc_session *sess;
184 for (i = 0; i < num_ops; i++) {
185 if (((ops[i]->sym->cipher.data.length % BYTE_LEN) != 0)
186 || ((ops[i]->sym->cipher.data.offset
188 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
189 ZUC_LOG(ERR, "Data Length or offset");
195 #ifdef RTE_LIBRTE_PMD_ZUC_DEBUG
196 if (!rte_pktmbuf_is_contiguous(ops[i]->sym->m_src) ||
197 (ops[i]->sym->m_dst != NULL &&
198 !rte_pktmbuf_is_contiguous(
199 ops[i]->sym->m_dst))) {
200 ZUC_LOG(ERR, "PMD supports only contiguous mbufs, "
201 "op (%p) provides noncontiguous mbuf as "
202 "source/destination buffer.\n", ops[i]);
203 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
208 src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
209 (ops[i]->sym->cipher.data.offset >> 3);
210 dst[i] = ops[i]->sym->m_dst ?
211 rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
212 (ops[i]->sym->cipher.data.offset >> 3) :
213 rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
214 (ops[i]->sym->cipher.data.offset >> 3);
215 iv[i] = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
216 sess->cipher_iv_offset);
217 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
219 cipher_keys[i] = sess->pKey_cipher;
224 sso_zuc_eea3_n_buffer(cipher_keys, iv, src, dst,
225 num_bytes, processed_ops);
227 return processed_ops;
230 /** Generate/verify hash from mbufs. */
232 process_zuc_hash_op(struct zuc_qp *qp, struct rte_crypto_op **ops,
233 struct zuc_session **sessions,
237 uint8_t processed_ops = 0;
240 uint32_t length_in_bits;
242 struct zuc_session *sess;
244 for (i = 0; i < num_ops; i++) {
245 /* Data must be byte aligned */
246 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
247 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
248 ZUC_LOG(ERR, "Offset");
254 length_in_bits = ops[i]->sym->auth.data.length;
256 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
257 (ops[i]->sym->auth.data.offset >> 3);
258 iv = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
259 sess->auth_iv_offset);
261 if (sess->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
262 dst = (uint32_t *)qp->temp_digest;
264 sso_zuc_eia3_1_buffer(sess->pKey_hash,
266 length_in_bits, dst);
268 if (memcmp(dst, ops[i]->sym->auth.digest.data,
269 ZUC_DIGEST_LENGTH) != 0)
270 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
272 dst = (uint32_t *)ops[i]->sym->auth.digest.data;
274 sso_zuc_eia3_1_buffer(sess->pKey_hash,
276 length_in_bits, dst);
281 return processed_ops;
284 /** Process a batch of crypto ops which shares the same operation type. */
286 process_ops(struct rte_crypto_op **ops, enum zuc_operation op_type,
287 struct zuc_session **sessions,
288 struct zuc_qp *qp, uint8_t num_ops,
289 uint16_t *accumulated_enqueued_ops)
292 unsigned enqueued_ops, processed_ops;
295 case ZUC_OP_ONLY_CIPHER:
296 processed_ops = process_zuc_cipher_op(ops,
299 case ZUC_OP_ONLY_AUTH:
300 processed_ops = process_zuc_hash_op(qp, ops, sessions,
303 case ZUC_OP_CIPHER_AUTH:
304 processed_ops = process_zuc_cipher_op(ops, sessions,
306 process_zuc_hash_op(qp, ops, sessions, processed_ops);
308 case ZUC_OP_AUTH_CIPHER:
309 processed_ops = process_zuc_hash_op(qp, ops, sessions,
311 process_zuc_cipher_op(ops, sessions, processed_ops);
314 /* Operation not supported. */
318 for (i = 0; i < num_ops; i++) {
320 * If there was no error/authentication failure,
321 * change status to successful.
323 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
324 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
325 /* Free session if a session-less crypto op. */
326 if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
327 memset(sessions[i], 0, sizeof(struct zuc_session));
328 memset(ops[i]->sym->session, 0,
329 rte_cryptodev_sym_get_header_session_size());
330 rte_mempool_put(qp->sess_mp, sessions[i]);
331 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
332 ops[i]->sym->session = NULL;
336 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
337 (void **)ops, processed_ops, NULL);
338 qp->qp_stats.enqueued_count += enqueued_ops;
339 *accumulated_enqueued_ops += enqueued_ops;
345 zuc_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
348 struct rte_crypto_op *c_ops[ZUC_MAX_BURST];
349 struct rte_crypto_op *curr_c_op;
351 struct zuc_session *curr_sess;
352 struct zuc_session *sessions[ZUC_MAX_BURST];
353 enum zuc_operation prev_zuc_op = ZUC_OP_NOT_SUPPORTED;
354 enum zuc_operation curr_zuc_op;
355 struct zuc_qp *qp = queue_pair;
357 uint8_t burst_size = 0;
358 uint16_t enqueued_ops = 0;
359 uint8_t processed_ops;
361 for (i = 0; i < nb_ops; i++) {
364 curr_sess = zuc_get_session(qp, curr_c_op);
365 if (unlikely(curr_sess == NULL)) {
367 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
371 curr_zuc_op = curr_sess->op;
374 * Batch ops that share the same operation type
375 * (cipher only, auth only...).
377 if (burst_size == 0) {
378 prev_zuc_op = curr_zuc_op;
379 c_ops[0] = curr_c_op;
380 sessions[0] = curr_sess;
382 } else if (curr_zuc_op == prev_zuc_op) {
383 c_ops[burst_size] = curr_c_op;
384 sessions[burst_size] = curr_sess;
387 * When there are enough ops to process in a batch,
388 * process them, and start a new batch.
390 if (burst_size == ZUC_MAX_BURST) {
391 processed_ops = process_ops(c_ops, curr_zuc_op,
392 sessions, qp, burst_size,
394 if (processed_ops < burst_size) {
403 * Different operation type, process the ops
404 * of the previous type.
406 processed_ops = process_ops(c_ops, prev_zuc_op,
407 sessions, qp, burst_size,
409 if (processed_ops < burst_size) {
415 prev_zuc_op = curr_zuc_op;
417 c_ops[0] = curr_c_op;
418 sessions[0] = curr_sess;
423 if (burst_size != 0) {
424 /* Process the crypto ops of the last operation type. */
425 processed_ops = process_ops(c_ops, prev_zuc_op,
426 sessions, qp, burst_size,
430 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
435 zuc_pmd_dequeue_burst(void *queue_pair,
436 struct rte_crypto_op **c_ops, uint16_t nb_ops)
438 struct zuc_qp *qp = queue_pair;
440 unsigned nb_dequeued;
442 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
443 (void **)c_ops, nb_ops, NULL);
444 qp->qp_stats.dequeued_count += nb_dequeued;
449 static int cryptodev_zuc_remove(struct rte_vdev_device *vdev);
452 cryptodev_zuc_create(const char *name,
453 struct rte_vdev_device *vdev,
454 struct rte_cryptodev_pmd_init_params *init_params)
456 struct rte_cryptodev *dev;
457 struct zuc_private *internals;
458 uint64_t cpu_flags = RTE_CRYPTODEV_FF_CPU_SSE;
461 dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
463 ZUC_LOG(ERR, "failed to create cryptodev vdev");
467 dev->driver_id = cryptodev_driver_id;
468 dev->dev_ops = rte_zuc_pmd_ops;
470 /* Register RX/TX burst functions for data path. */
471 dev->dequeue_burst = zuc_pmd_dequeue_burst;
472 dev->enqueue_burst = zuc_pmd_enqueue_burst;
474 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
475 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
478 internals = dev->data->dev_private;
480 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
484 ZUC_LOG(ERR, "driver %s: failed",
487 cryptodev_zuc_remove(vdev);
492 cryptodev_zuc_probe(struct rte_vdev_device *vdev)
494 struct rte_cryptodev_pmd_init_params init_params = {
496 sizeof(struct zuc_private),
498 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
501 const char *input_args;
503 name = rte_vdev_device_name(vdev);
506 input_args = rte_vdev_device_args(vdev);
508 rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
510 return cryptodev_zuc_create(name, vdev, &init_params);
514 cryptodev_zuc_remove(struct rte_vdev_device *vdev)
517 struct rte_cryptodev *cryptodev;
520 name = rte_vdev_device_name(vdev);
524 cryptodev = rte_cryptodev_pmd_get_named_dev(name);
525 if (cryptodev == NULL)
528 return rte_cryptodev_pmd_destroy(cryptodev);
531 static struct rte_vdev_driver cryptodev_zuc_pmd_drv = {
532 .probe = cryptodev_zuc_probe,
533 .remove = cryptodev_zuc_remove
536 static struct cryptodev_driver zuc_crypto_drv;
538 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_ZUC_PMD, cryptodev_zuc_pmd_drv);
539 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_ZUC_PMD,
540 "max_nb_queue_pairs=<int> "
542 RTE_PMD_REGISTER_CRYPTO_DRIVER(zuc_crypto_drv, cryptodev_zuc_pmd_drv.driver,
543 cryptodev_driver_id);
545 RTE_INIT(zuc_init_log)
547 zuc_logtype_driver = rte_log_register("pmd.crypto.zuc");