4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <rte_common.h>
34 #include <rte_config.h>
35 #include <rte_hexdump.h>
36 #include <rte_cryptodev.h>
37 #include <rte_cryptodev_pmd.h>
38 #include <rte_cryptodev_vdev.h>
40 #include <rte_malloc.h>
41 #include <rte_cpuflags.h>
43 #include "rte_zuc_pmd_private.h"
45 #define ZUC_DIGEST_LENGTH 4
46 #define ZUC_MAX_BURST 8
49 static uint8_t cryptodev_driver_id;
51 /** Get xform chain order. */
52 static enum zuc_operation
53 zuc_get_mode(const struct rte_crypto_sym_xform *xform)
56 return ZUC_OP_NOT_SUPPORTED;
59 if (xform->next->next != NULL)
60 return ZUC_OP_NOT_SUPPORTED;
62 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
63 if (xform->next == NULL)
64 return ZUC_OP_ONLY_AUTH;
65 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
66 return ZUC_OP_AUTH_CIPHER;
68 return ZUC_OP_NOT_SUPPORTED;
71 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
72 if (xform->next == NULL)
73 return ZUC_OP_ONLY_CIPHER;
74 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
75 return ZUC_OP_CIPHER_AUTH;
77 return ZUC_OP_NOT_SUPPORTED;
80 return ZUC_OP_NOT_SUPPORTED;
84 /** Parse crypto xform chain and set private session parameters. */
86 zuc_set_session_parameters(struct zuc_session *sess,
87 const struct rte_crypto_sym_xform *xform)
89 const struct rte_crypto_sym_xform *auth_xform = NULL;
90 const struct rte_crypto_sym_xform *cipher_xform = NULL;
91 enum zuc_operation mode;
93 /* Select Crypto operation - hash then cipher / cipher then hash */
94 mode = zuc_get_mode(xform);
97 case ZUC_OP_CIPHER_AUTH:
98 auth_xform = xform->next;
101 case ZUC_OP_ONLY_CIPHER:
102 cipher_xform = xform;
104 case ZUC_OP_AUTH_CIPHER:
105 cipher_xform = xform->next;
107 case ZUC_OP_ONLY_AUTH:
110 case ZUC_OP_NOT_SUPPORTED:
112 ZUC_LOG_ERR("Unsupported operation chain order parameter");
117 /* Only ZUC EEA3 supported */
118 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_ZUC_EEA3)
121 if (cipher_xform->cipher.iv.length != ZUC_IV_KEY_LENGTH) {
122 ZUC_LOG_ERR("Wrong IV length");
125 sess->cipher_iv_offset = cipher_xform->cipher.iv.offset;
128 memcpy(sess->pKey_cipher, cipher_xform->cipher.key.data,
133 /* Only ZUC EIA3 supported */
134 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_ZUC_EIA3)
137 if (auth_xform->auth.digest_length != ZUC_DIGEST_LENGTH) {
138 ZUC_LOG_ERR("Wrong digest length");
142 sess->auth_op = auth_xform->auth.op;
144 if (auth_xform->auth.iv.length != ZUC_IV_KEY_LENGTH) {
145 ZUC_LOG_ERR("Wrong IV length");
148 sess->auth_iv_offset = auth_xform->auth.iv.offset;
151 memcpy(sess->pKey_hash, auth_xform->auth.key.data,
161 /** Get ZUC session. */
162 static struct zuc_session *
163 zuc_get_session(struct zuc_qp *qp, struct rte_crypto_op *op)
165 struct zuc_session *sess;
167 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
168 sess = (struct zuc_session *)op->sym->session->_private;
170 struct rte_cryptodev_sym_session *c_sess = NULL;
172 if (rte_mempool_get(qp->sess_mp, (void **)&c_sess))
175 sess = (struct zuc_session *)c_sess->_private;
177 if (unlikely(zuc_set_session_parameters(sess,
178 op->sym->xform) != 0))
185 /** Encrypt/decrypt mbufs with same cipher key. */
187 process_zuc_cipher_op(struct rte_crypto_op **ops,
188 struct zuc_session *session,
192 uint8_t processed_ops = 0;
193 uint8_t *src[ZUC_MAX_BURST], *dst[ZUC_MAX_BURST];
194 uint8_t *iv[ZUC_MAX_BURST];
195 uint32_t num_bytes[ZUC_MAX_BURST];
196 uint8_t *cipher_keys[ZUC_MAX_BURST];
198 for (i = 0; i < num_ops; i++) {
199 if (((ops[i]->sym->cipher.data.length % BYTE_LEN) != 0)
200 || ((ops[i]->sym->cipher.data.offset
202 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
203 ZUC_LOG_ERR("Data Length or offset");
207 #ifdef RTE_LIBRTE_PMD_ZUC_DEBUG
208 if (!rte_pktmbuf_is_contiguous(ops[i]->sym->m_src) ||
209 (ops[i]->sym->m_dst != NULL &&
210 !rte_pktmbuf_is_contiguous(
211 ops[i]->sym->m_dst))) {
212 ZUC_LOG_ERR("PMD supports only contiguous mbufs, "
213 "op (%p) provides noncontiguous mbuf as "
214 "source/destination buffer.\n", ops[i]);
215 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
220 src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
221 (ops[i]->sym->cipher.data.offset >> 3);
222 dst[i] = ops[i]->sym->m_dst ?
223 rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
224 (ops[i]->sym->cipher.data.offset >> 3) :
225 rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
226 (ops[i]->sym->cipher.data.offset >> 3);
227 iv[i] = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
228 session->cipher_iv_offset);
229 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
231 cipher_keys[i] = session->pKey_cipher;
236 sso_zuc_eea3_n_buffer(cipher_keys, iv, src, dst,
237 num_bytes, processed_ops);
239 return processed_ops;
242 /** Generate/verify hash from mbufs with same hash key. */
244 process_zuc_hash_op(struct rte_crypto_op **ops,
245 struct zuc_session *session,
249 uint8_t processed_ops = 0;
252 uint32_t length_in_bits;
255 for (i = 0; i < num_ops; i++) {
256 /* Data must be byte aligned */
257 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
258 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
259 ZUC_LOG_ERR("Offset");
263 length_in_bits = ops[i]->sym->auth.data.length;
265 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
266 (ops[i]->sym->auth.data.offset >> 3);
267 iv = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
268 session->auth_iv_offset);
270 if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
271 dst = (uint32_t *)rte_pktmbuf_append(ops[i]->sym->m_src,
274 sso_zuc_eia3_1_buffer(session->pKey_hash,
276 length_in_bits, dst);
278 if (memcmp(dst, ops[i]->sym->auth.digest.data,
279 ZUC_DIGEST_LENGTH) != 0)
280 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
282 /* Trim area used for digest from mbuf. */
283 rte_pktmbuf_trim(ops[i]->sym->m_src,
286 dst = (uint32_t *)ops[i]->sym->auth.digest.data;
288 sso_zuc_eia3_1_buffer(session->pKey_hash,
290 length_in_bits, dst);
295 return processed_ops;
298 /** Process a batch of crypto ops which shares the same session. */
300 process_ops(struct rte_crypto_op **ops, struct zuc_session *session,
301 struct zuc_qp *qp, uint8_t num_ops,
302 uint16_t *accumulated_enqueued_ops)
305 unsigned enqueued_ops, processed_ops;
307 switch (session->op) {
308 case ZUC_OP_ONLY_CIPHER:
309 processed_ops = process_zuc_cipher_op(ops,
312 case ZUC_OP_ONLY_AUTH:
313 processed_ops = process_zuc_hash_op(ops, session,
316 case ZUC_OP_CIPHER_AUTH:
317 processed_ops = process_zuc_cipher_op(ops, session,
319 process_zuc_hash_op(ops, session, processed_ops);
321 case ZUC_OP_AUTH_CIPHER:
322 processed_ops = process_zuc_hash_op(ops, session,
324 process_zuc_cipher_op(ops, session, processed_ops);
327 /* Operation not supported. */
331 for (i = 0; i < num_ops; i++) {
333 * If there was no error/authentication failure,
334 * change status to successful.
336 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
337 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
338 /* Free session if a session-less crypto op. */
339 if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
340 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
341 ops[i]->sym->session = NULL;
345 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
346 (void **)ops, processed_ops, NULL);
347 qp->qp_stats.enqueued_count += enqueued_ops;
348 *accumulated_enqueued_ops += enqueued_ops;
354 zuc_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
357 struct rte_crypto_op *c_ops[ZUC_MAX_BURST];
358 struct rte_crypto_op *curr_c_op;
360 struct zuc_session *prev_sess = NULL, *curr_sess = NULL;
361 struct zuc_qp *qp = queue_pair;
363 uint8_t burst_size = 0;
364 uint16_t enqueued_ops = 0;
365 uint8_t processed_ops;
367 for (i = 0; i < nb_ops; i++) {
370 /* Set status as enqueued (not processed yet) by default. */
371 curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
373 curr_sess = zuc_get_session(qp, curr_c_op);
374 if (unlikely(curr_sess == NULL ||
375 curr_sess->op == ZUC_OP_NOT_SUPPORTED)) {
377 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
381 /* Batch ops that share the same session. */
382 if (prev_sess == NULL) {
383 prev_sess = curr_sess;
384 c_ops[burst_size++] = curr_c_op;
385 } else if (curr_sess == prev_sess) {
386 c_ops[burst_size++] = curr_c_op;
388 * When there are enough ops to process in a batch,
389 * process them, and start a new batch.
391 if (burst_size == ZUC_MAX_BURST) {
392 processed_ops = process_ops(c_ops, prev_sess,
393 qp, burst_size, &enqueued_ops);
394 if (processed_ops < burst_size) {
404 * Different session, process the ops
405 * of the previous session.
407 processed_ops = process_ops(c_ops, prev_sess,
408 qp, burst_size, &enqueued_ops);
409 if (processed_ops < burst_size) {
415 prev_sess = curr_sess;
417 c_ops[burst_size++] = curr_c_op;
421 if (burst_size != 0) {
422 /* Process the crypto ops of the last session. */
423 processed_ops = process_ops(c_ops, prev_sess,
424 qp, burst_size, &enqueued_ops);
427 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
432 zuc_pmd_dequeue_burst(void *queue_pair,
433 struct rte_crypto_op **c_ops, uint16_t nb_ops)
435 struct zuc_qp *qp = queue_pair;
437 unsigned nb_dequeued;
439 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
440 (void **)c_ops, nb_ops, NULL);
441 qp->qp_stats.dequeued_count += nb_dequeued;
446 static int cryptodev_zuc_remove(struct rte_vdev_device *vdev);
449 cryptodev_zuc_create(const char *name,
450 struct rte_vdev_device *vdev,
451 struct rte_crypto_vdev_init_params *init_params)
453 struct rte_cryptodev *dev;
454 struct zuc_private *internals;
455 uint64_t cpu_flags = RTE_CRYPTODEV_FF_CPU_SSE;
457 if (init_params->name[0] == '\0')
458 snprintf(init_params->name, sizeof(init_params->name),
461 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
462 sizeof(struct zuc_private), init_params->socket_id,
465 ZUC_LOG_ERR("failed to create cryptodev vdev");
469 dev->driver_id = cryptodev_driver_id;
470 dev->dev_ops = rte_zuc_pmd_ops;
472 /* Register RX/TX burst functions for data path. */
473 dev->dequeue_burst = zuc_pmd_dequeue_burst;
474 dev->enqueue_burst = zuc_pmd_enqueue_burst;
476 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
477 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
480 internals = dev->data->dev_private;
482 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
483 internals->max_nb_sessions = init_params->max_nb_sessions;
487 ZUC_LOG_ERR("driver %s: cryptodev_zuc_create failed",
490 cryptodev_zuc_remove(vdev);
495 cryptodev_zuc_probe(struct rte_vdev_device *vdev)
497 struct rte_crypto_vdev_init_params init_params = {
498 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
499 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
504 const char *input_args;
506 name = rte_vdev_device_name(vdev);
509 input_args = rte_vdev_device_args(vdev);
511 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
513 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
514 init_params.socket_id);
515 if (init_params.name[0] != '\0')
516 RTE_LOG(INFO, PMD, " User defined name = %s\n",
518 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
519 init_params.max_nb_queue_pairs);
520 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
521 init_params.max_nb_sessions);
523 return cryptodev_zuc_create(name, vdev, &init_params);
527 cryptodev_zuc_remove(struct rte_vdev_device *vdev)
531 name = rte_vdev_device_name(vdev);
535 RTE_LOG(INFO, PMD, "Closing ZUC crypto device %s"
536 " on numa socket %u\n",
537 name, rte_socket_id());
542 static struct rte_vdev_driver cryptodev_zuc_pmd_drv = {
543 .probe = cryptodev_zuc_probe,
544 .remove = cryptodev_zuc_remove
547 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_ZUC_PMD, cryptodev_zuc_pmd_drv);
548 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_ZUC_PMD,
549 "max_nb_queue_pairs=<int> "
550 "max_nb_sessions=<int> "
552 RTE_PMD_REGISTER_CRYPTO_DRIVER(cryptodev_zuc_pmd_drv, cryptodev_driver_id);