4 * Copyright(c) 2016 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_kasumi_pmd_private.h"
45 #define KASUMI_KEY_LENGTH 16
46 #define KASUMI_IV_LENGTH 8
47 #define KASUMI_DIGEST_LENGTH 4
48 #define KASUMI_MAX_BURST 4
51 /** Get xform chain order. */
52 static enum kasumi_operation
53 kasumi_get_mode(const struct rte_crypto_sym_xform *xform)
56 return KASUMI_OP_NOT_SUPPORTED;
59 if (xform->next->next != NULL)
60 return KASUMI_OP_NOT_SUPPORTED;
62 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
63 if (xform->next == NULL)
64 return KASUMI_OP_ONLY_AUTH;
65 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
66 return KASUMI_OP_AUTH_CIPHER;
68 return KASUMI_OP_NOT_SUPPORTED;
71 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
72 if (xform->next == NULL)
73 return KASUMI_OP_ONLY_CIPHER;
74 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
75 return KASUMI_OP_CIPHER_AUTH;
77 return KASUMI_OP_NOT_SUPPORTED;
80 return KASUMI_OP_NOT_SUPPORTED;
84 /** Parse crypto xform chain and set private session parameters. */
86 kasumi_set_session_parameters(struct kasumi_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 kasumi_operation mode;
93 /* Select Crypto operation - hash then cipher / cipher then hash */
94 mode = kasumi_get_mode(xform);
97 case KASUMI_OP_CIPHER_AUTH:
98 auth_xform = xform->next;
100 case KASUMI_OP_ONLY_CIPHER:
101 cipher_xform = xform;
103 case KASUMI_OP_AUTH_CIPHER:
104 cipher_xform = xform->next;
106 case KASUMI_OP_ONLY_AUTH:
109 case KASUMI_OP_NOT_SUPPORTED:
111 KASUMI_LOG_ERR("Unsupported operation chain order parameter");
116 /* Only KASUMI F8 supported */
117 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_KASUMI_F8)
120 sso_kasumi_init_f8_key_sched(cipher_xform->cipher.key.data,
121 &sess->pKeySched_cipher);
125 /* Only KASUMI F9 supported */
126 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_KASUMI_F9)
128 sess->auth_op = auth_xform->auth.op;
130 sso_kasumi_init_f9_key_sched(auth_xform->auth.key.data,
131 &sess->pKeySched_hash);
140 /** Get KASUMI session. */
141 static struct kasumi_session *
142 kasumi_get_session(struct kasumi_qp *qp, struct rte_crypto_op *op)
144 struct kasumi_session *sess;
146 if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_WITH_SESSION) {
147 if (unlikely(op->sym->session->dev_type !=
148 RTE_CRYPTODEV_KASUMI_PMD))
151 sess = (struct kasumi_session *)op->sym->session->_private;
153 struct rte_cryptodev_session *c_sess = NULL;
155 if (rte_mempool_get(qp->sess_mp, (void **)&c_sess))
158 sess = (struct kasumi_session *)c_sess->_private;
160 if (unlikely(kasumi_set_session_parameters(sess,
161 op->sym->xform) != 0))
168 /** Encrypt/decrypt mbufs with same cipher key. */
170 process_kasumi_cipher_op(struct rte_crypto_op **ops,
171 struct kasumi_session *session,
175 uint8_t processed_ops = 0;
176 uint8_t *src[num_ops], *dst[num_ops];
177 uint64_t IV[num_ops];
178 uint32_t num_bytes[num_ops];
180 for (i = 0; i < num_ops; i++) {
182 if (ops[i]->sym->cipher.iv.length != KASUMI_IV_LENGTH) {
183 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
184 KASUMI_LOG_ERR("iv");
188 src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
189 (ops[i]->sym->cipher.data.offset >> 3);
190 dst[i] = ops[i]->sym->m_dst ?
191 rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
192 (ops[i]->sym->cipher.data.offset >> 3) :
193 rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
194 (ops[i]->sym->cipher.data.offset >> 3);
195 IV[i] = *((uint64_t *)(ops[i]->sym->cipher.iv.data));
196 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
201 if (processed_ops != 0)
202 sso_kasumi_f8_n_buffer(&session->pKeySched_cipher, IV,
203 src, dst, num_bytes, processed_ops);
205 return processed_ops;
208 /** Encrypt/decrypt mbuf (bit level function). */
210 process_kasumi_cipher_op_bit(struct rte_crypto_op *op,
211 struct kasumi_session *session)
215 uint32_t length_in_bits, offset_in_bits;
218 if (unlikely(op->sym->cipher.iv.length != KASUMI_IV_LENGTH)) {
219 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
220 KASUMI_LOG_ERR("iv");
224 offset_in_bits = op->sym->cipher.data.offset;
225 src = rte_pktmbuf_mtod(op->sym->m_src, uint8_t *);
226 if (op->sym->m_dst == NULL) {
227 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
228 KASUMI_LOG_ERR("bit-level in-place not supported\n");
231 dst = rte_pktmbuf_mtod(op->sym->m_dst, uint8_t *);
232 IV = *((uint64_t *)(op->sym->cipher.iv.data));
233 length_in_bits = op->sym->cipher.data.length;
235 sso_kasumi_f8_1_buffer_bit(&session->pKeySched_cipher, IV,
236 src, dst, length_in_bits, offset_in_bits);
241 /** Generate/verify hash from mbufs with same hash key. */
243 process_kasumi_hash_op(struct rte_crypto_op **ops,
244 struct kasumi_session *session,
248 uint8_t processed_ops = 0;
250 uint32_t length_in_bits;
256 for (i = 0; i < num_ops; i++) {
257 if (unlikely(ops[i]->sym->auth.aad.length != KASUMI_IV_LENGTH)) {
258 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
259 KASUMI_LOG_ERR("aad");
263 if (unlikely(ops[i]->sym->auth.digest.length != KASUMI_DIGEST_LENGTH)) {
264 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
265 KASUMI_LOG_ERR("digest");
269 /* Data must be byte aligned */
270 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
271 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
272 KASUMI_LOG_ERR("offset");
276 length_in_bits = ops[i]->sym->auth.data.length;
278 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
279 (ops[i]->sym->auth.data.offset >> 3);
281 IV = *((uint64_t *)(ops[i]->sym->auth.aad.data));
282 /* Direction from next bit after end of message */
283 num_bytes = (length_in_bits >> 3) + 1;
284 shift_bits = (BYTE_LEN - 1 - length_in_bits) % BYTE_LEN;
285 direction = (src[num_bytes - 1] >> shift_bits) & 0x01;
287 if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
288 dst = (uint8_t *)rte_pktmbuf_append(ops[i]->sym->m_src,
289 ops[i]->sym->auth.digest.length);
291 sso_kasumi_f9_1_buffer_user(&session->pKeySched_hash,
293 length_in_bits, dst, direction);
295 if (memcmp(dst, ops[i]->sym->auth.digest.data,
296 ops[i]->sym->auth.digest.length) != 0)
297 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
299 /* Trim area used for digest from mbuf. */
300 rte_pktmbuf_trim(ops[i]->sym->m_src,
301 ops[i]->sym->auth.digest.length);
303 dst = ops[i]->sym->auth.digest.data;
305 sso_kasumi_f9_1_buffer_user(&session->pKeySched_hash,
307 length_in_bits, dst, direction);
312 return processed_ops;
315 /** Process a batch of crypto ops which shares the same session. */
317 process_ops(struct rte_crypto_op **ops, struct kasumi_session *session,
318 struct kasumi_qp *qp, uint8_t num_ops,
319 uint16_t *accumulated_enqueued_ops)
322 unsigned enqueued_ops, processed_ops;
324 switch (session->op) {
325 case KASUMI_OP_ONLY_CIPHER:
326 processed_ops = process_kasumi_cipher_op(ops,
329 case KASUMI_OP_ONLY_AUTH:
330 processed_ops = process_kasumi_hash_op(ops, session,
333 case KASUMI_OP_CIPHER_AUTH:
334 processed_ops = process_kasumi_cipher_op(ops, session,
336 process_kasumi_hash_op(ops, session, processed_ops);
338 case KASUMI_OP_AUTH_CIPHER:
339 processed_ops = process_kasumi_hash_op(ops, session,
341 process_kasumi_cipher_op(ops, session, processed_ops);
344 /* Operation not supported. */
348 for (i = 0; i < num_ops; i++) {
350 * If there was no error/authentication failure,
351 * change status to successful.
353 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
354 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
355 /* Free session if a session-less crypto op. */
356 if (ops[i]->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
357 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
358 ops[i]->sym->session = NULL;
362 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
363 (void **)ops, processed_ops, NULL);
364 qp->qp_stats.enqueued_count += enqueued_ops;
365 *accumulated_enqueued_ops += enqueued_ops;
370 /** Process a crypto op with length/offset in bits. */
372 process_op_bit(struct rte_crypto_op *op, struct kasumi_session *session,
373 struct kasumi_qp *qp, uint16_t *accumulated_enqueued_ops)
375 unsigned enqueued_op, processed_op;
377 switch (session->op) {
378 case KASUMI_OP_ONLY_CIPHER:
379 processed_op = process_kasumi_cipher_op_bit(op,
382 case KASUMI_OP_ONLY_AUTH:
383 processed_op = process_kasumi_hash_op(&op, session, 1);
385 case KASUMI_OP_CIPHER_AUTH:
386 processed_op = process_kasumi_cipher_op_bit(op, session);
387 if (processed_op == 1)
388 process_kasumi_hash_op(&op, session, 1);
390 case KASUMI_OP_AUTH_CIPHER:
391 processed_op = process_kasumi_hash_op(&op, session, 1);
392 if (processed_op == 1)
393 process_kasumi_cipher_op_bit(op, session);
396 /* Operation not supported. */
401 * If there was no error/authentication failure,
402 * change status to successful.
404 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
405 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
407 /* Free session if a session-less crypto op. */
408 if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
409 rte_mempool_put(qp->sess_mp, op->sym->session);
410 op->sym->session = NULL;
413 enqueued_op = rte_ring_enqueue_burst(qp->processed_ops, (void **)&op,
415 qp->qp_stats.enqueued_count += enqueued_op;
416 *accumulated_enqueued_ops += enqueued_op;
422 kasumi_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
425 struct rte_crypto_op *c_ops[nb_ops];
426 struct rte_crypto_op *curr_c_op;
428 struct kasumi_session *prev_sess = NULL, *curr_sess = NULL;
429 struct kasumi_qp *qp = queue_pair;
431 uint8_t burst_size = 0;
432 uint16_t enqueued_ops = 0;
433 uint8_t processed_ops;
435 for (i = 0; i < nb_ops; i++) {
438 #ifdef RTE_LIBRTE_PMD_KASUMI_DEBUG
439 if (!rte_pktmbuf_is_contiguous(curr_c_op->sym->m_src) ||
440 (curr_c_op->sym->m_dst != NULL &&
441 !rte_pktmbuf_is_contiguous(
442 curr_c_op->sym->m_dst))) {
443 KASUMI_LOG_ERR("PMD supports only contiguous mbufs, "
444 "op (%p) provides noncontiguous mbuf as "
445 "source/destination buffer.\n", curr_c_op);
446 curr_c_op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
451 /* Set status as enqueued (not processed yet) by default. */
452 curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
454 curr_sess = kasumi_get_session(qp, curr_c_op);
455 if (unlikely(curr_sess == NULL ||
456 curr_sess->op == KASUMI_OP_NOT_SUPPORTED)) {
458 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
462 /* If length/offset is at bit-level, process this buffer alone. */
463 if (((curr_c_op->sym->cipher.data.length % BYTE_LEN) != 0)
464 || ((ops[i]->sym->cipher.data.offset
466 /* Process the ops of the previous session. */
467 if (prev_sess != NULL) {
468 processed_ops = process_ops(c_ops, prev_sess,
469 qp, burst_size, &enqueued_ops);
470 if (processed_ops < burst_size) {
479 processed_ops = process_op_bit(curr_c_op, curr_sess,
481 if (processed_ops != 1)
487 /* Batch ops that share the same session. */
488 if (prev_sess == NULL) {
489 prev_sess = curr_sess;
490 c_ops[burst_size++] = curr_c_op;
491 } else if (curr_sess == prev_sess) {
492 c_ops[burst_size++] = curr_c_op;
494 * When there are enough ops to process in a batch,
495 * process them, and start a new batch.
497 if (burst_size == KASUMI_MAX_BURST) {
498 processed_ops = process_ops(c_ops, prev_sess,
499 qp, burst_size, &enqueued_ops);
500 if (processed_ops < burst_size) {
510 * Different session, process the ops
511 * of the previous session.
513 processed_ops = process_ops(c_ops, prev_sess,
514 qp, burst_size, &enqueued_ops);
515 if (processed_ops < burst_size) {
521 prev_sess = curr_sess;
523 c_ops[burst_size++] = curr_c_op;
527 if (burst_size != 0) {
528 /* Process the crypto ops of the last session. */
529 processed_ops = process_ops(c_ops, prev_sess,
530 qp, burst_size, &enqueued_ops);
533 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
538 kasumi_pmd_dequeue_burst(void *queue_pair,
539 struct rte_crypto_op **c_ops, uint16_t nb_ops)
541 struct kasumi_qp *qp = queue_pair;
543 unsigned nb_dequeued;
545 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
546 (void **)c_ops, nb_ops, NULL);
547 qp->qp_stats.dequeued_count += nb_dequeued;
552 static int cryptodev_kasumi_remove(struct rte_vdev_device *vdev);
555 cryptodev_kasumi_create(const char *name,
556 struct rte_vdev_device *vdev,
557 struct rte_crypto_vdev_init_params *init_params)
559 struct rte_cryptodev *dev;
560 struct kasumi_private *internals;
561 uint64_t cpu_flags = 0;
563 if (init_params->name[0] == '\0')
564 snprintf(init_params->name, sizeof(init_params->name),
567 /* Check CPU for supported vector instruction set */
568 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
569 cpu_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
570 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
571 cpu_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
573 KASUMI_LOG_ERR("Vector instructions are not supported by CPU");
577 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
578 sizeof(struct kasumi_private), init_params->socket_id,
581 KASUMI_LOG_ERR("failed to create cryptodev vdev");
585 dev->dev_type = RTE_CRYPTODEV_KASUMI_PMD;
586 dev->dev_ops = rte_kasumi_pmd_ops;
588 /* Register RX/TX burst functions for data path. */
589 dev->dequeue_burst = kasumi_pmd_dequeue_burst;
590 dev->enqueue_burst = kasumi_pmd_enqueue_burst;
592 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
593 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
596 internals = dev->data->dev_private;
598 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
599 internals->max_nb_sessions = init_params->max_nb_sessions;
603 KASUMI_LOG_ERR("driver %s: cryptodev_kasumi_create failed",
606 cryptodev_kasumi_remove(vdev);
611 cryptodev_kasumi_probe(struct rte_vdev_device *vdev)
613 struct rte_crypto_vdev_init_params init_params = {
614 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
615 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
620 const char *input_args;
622 name = rte_vdev_device_name(vdev);
625 input_args = rte_vdev_device_args(vdev);
627 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
629 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
630 init_params.socket_id);
631 if (init_params.name[0] != '\0')
632 RTE_LOG(INFO, PMD, " User defined name = %s\n",
634 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
635 init_params.max_nb_queue_pairs);
636 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
637 init_params.max_nb_sessions);
639 return cryptodev_kasumi_create(name, vdev, &init_params);
643 cryptodev_kasumi_remove(struct rte_vdev_device *vdev)
647 name = rte_vdev_device_name(vdev);
651 RTE_LOG(INFO, PMD, "Closing KASUMI crypto device %s"
652 " on numa socket %u\n",
653 name, rte_socket_id());
658 static struct rte_vdev_driver cryptodev_kasumi_pmd_drv = {
659 .probe = cryptodev_kasumi_probe,
660 .remove = cryptodev_kasumi_remove
663 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_KASUMI_PMD, cryptodev_kasumi_pmd_drv);
664 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_KASUMI_PMD, cryptodev_kasumi_pmd);
665 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_KASUMI_PMD,
666 "max_nb_queue_pairs=<int> "
667 "max_nb_sessions=<int> "