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>
39 #include <rte_malloc.h>
40 #include <rte_cpuflags.h>
42 #include "rte_kasumi_pmd_private.h"
44 #define KASUMI_KEY_LENGTH 16
45 #define KASUMI_IV_LENGTH 8
46 #define KASUMI_DIGEST_LENGTH 4
47 #define KASUMI_MAX_BURST 4
51 * Global static parameter used to create a unique name for each KASUMI
54 static unsigned unique_name_id;
57 create_unique_device_name(char *name, size_t size)
64 ret = snprintf(name, size, "%s_%u", RTE_STR(CRYPTODEV_NAME_KASUMI_PMD),
71 /** Get xform chain order. */
72 static enum kasumi_operation
73 kasumi_get_mode(const struct rte_crypto_sym_xform *xform)
76 return KASUMI_OP_NOT_SUPPORTED;
79 if (xform->next->next != NULL)
80 return KASUMI_OP_NOT_SUPPORTED;
82 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
83 if (xform->next == NULL)
84 return KASUMI_OP_ONLY_AUTH;
85 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
86 return KASUMI_OP_AUTH_CIPHER;
88 return KASUMI_OP_NOT_SUPPORTED;
91 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
92 if (xform->next == NULL)
93 return KASUMI_OP_ONLY_CIPHER;
94 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
95 return KASUMI_OP_CIPHER_AUTH;
97 return KASUMI_OP_NOT_SUPPORTED;
100 return KASUMI_OP_NOT_SUPPORTED;
104 /** Parse crypto xform chain and set private session parameters. */
106 kasumi_set_session_parameters(struct kasumi_session *sess,
107 const struct rte_crypto_sym_xform *xform)
109 const struct rte_crypto_sym_xform *auth_xform = NULL;
110 const struct rte_crypto_sym_xform *cipher_xform = NULL;
113 /* Select Crypto operation - hash then cipher / cipher then hash */
114 mode = kasumi_get_mode(xform);
117 case KASUMI_OP_CIPHER_AUTH:
118 auth_xform = xform->next;
120 case KASUMI_OP_ONLY_CIPHER:
121 cipher_xform = xform;
123 case KASUMI_OP_AUTH_CIPHER:
124 cipher_xform = xform->next;
126 case KASUMI_OP_ONLY_AUTH:
130 if (mode == KASUMI_OP_NOT_SUPPORTED) {
131 KASUMI_LOG_ERR("Unsupported operation chain order parameter");
136 /* Only KASUMI F8 supported */
137 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_KASUMI_F8)
140 sso_kasumi_init_f8_key_sched(xform->cipher.key.data,
141 &sess->pKeySched_cipher);
145 /* Only KASUMI F9 supported */
146 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_KASUMI_F9)
148 sess->auth_op = auth_xform->auth.op;
150 sso_kasumi_init_f9_key_sched(xform->auth.key.data,
151 &sess->pKeySched_hash);
160 /** Get KASUMI session. */
161 static struct kasumi_session *
162 kasumi_get_session(struct kasumi_qp *qp, struct rte_crypto_op *op)
164 struct kasumi_session *sess;
166 if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_WITH_SESSION) {
167 if (unlikely(op->sym->session->dev_type !=
168 RTE_CRYPTODEV_KASUMI_PMD))
171 sess = (struct kasumi_session *)op->sym->session->_private;
173 struct rte_cryptodev_session *c_sess = NULL;
175 if (rte_mempool_get(qp->sess_mp, (void **)&c_sess))
178 sess = (struct kasumi_session *)c_sess->_private;
180 if (unlikely(kasumi_set_session_parameters(sess,
181 op->sym->xform) != 0))
188 /** Encrypt/decrypt mbufs with same cipher key. */
190 process_kasumi_cipher_op(struct rte_crypto_op **ops,
191 struct kasumi_session *session,
195 uint8_t processed_ops = 0;
196 uint8_t *src[num_ops], *dst[num_ops];
197 uint64_t IV[num_ops];
198 uint32_t num_bytes[num_ops];
200 for (i = 0; i < num_ops; i++) {
202 if (ops[i]->sym->cipher.iv.length != KASUMI_IV_LENGTH) {
203 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
204 KASUMI_LOG_ERR("iv");
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] = *((uint64_t *)(ops[i]->sym->cipher.iv.data));
216 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
221 if (processed_ops != 0)
222 sso_kasumi_f8_n_buffer(&session->pKeySched_cipher, IV,
223 src, dst, num_bytes, processed_ops);
225 return processed_ops;
228 /** Encrypt/decrypt mbuf (bit level function). */
230 process_kasumi_cipher_op_bit(struct rte_crypto_op *op,
231 struct kasumi_session *session)
235 uint32_t length_in_bits, offset_in_bits;
238 if (unlikely(op->sym->cipher.iv.length != KASUMI_IV_LENGTH)) {
239 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
240 KASUMI_LOG_ERR("iv");
244 offset_in_bits = op->sym->cipher.data.offset;
245 src = rte_pktmbuf_mtod(op->sym->m_src, uint8_t *);
246 if (op->sym->m_dst == NULL) {
247 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
248 KASUMI_LOG_ERR("bit-level in-place not supported\n");
251 dst = rte_pktmbuf_mtod(op->sym->m_dst, uint8_t *);
252 IV = *((uint64_t *)(op->sym->cipher.iv.data));
253 length_in_bits = op->sym->cipher.data.length;
255 sso_kasumi_f8_1_buffer_bit(&session->pKeySched_cipher, IV,
256 src, dst, length_in_bits, offset_in_bits);
261 /** Generate/verify hash from mbufs with same hash key. */
263 process_kasumi_hash_op(struct rte_crypto_op **ops,
264 struct kasumi_session *session,
268 uint8_t processed_ops = 0;
270 uint32_t length_in_bits;
276 for (i = 0; i < num_ops; i++) {
277 if (unlikely(ops[i]->sym->auth.aad.length != KASUMI_IV_LENGTH)) {
278 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
279 KASUMI_LOG_ERR("aad");
283 if (unlikely(ops[i]->sym->auth.digest.length != KASUMI_DIGEST_LENGTH)) {
284 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
285 KASUMI_LOG_ERR("digest");
289 /* Data must be byte aligned */
290 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
291 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
292 KASUMI_LOG_ERR("offset");
296 length_in_bits = ops[i]->sym->auth.data.length;
298 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
299 (ops[i]->sym->auth.data.offset >> 3);
301 IV = *((uint64_t *)(ops[i]->sym->auth.aad.data));
302 /* Direction from next bit after end of message */
303 num_bytes = (length_in_bits >> 3) + 1;
304 shift_bits = (BYTE_LEN - 1 - length_in_bits) % BYTE_LEN;
305 direction = (src[num_bytes - 1] >> shift_bits) & 0x01;
307 if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
308 dst = (uint8_t *)rte_pktmbuf_append(ops[i]->sym->m_src,
309 ops[i]->sym->auth.digest.length);
311 sso_kasumi_f9_1_buffer_user(&session->pKeySched_hash,
313 length_in_bits, dst, direction);
315 if (memcmp(dst, ops[i]->sym->auth.digest.data,
316 ops[i]->sym->auth.digest.length) != 0)
317 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
319 /* Trim area used for digest from mbuf. */
320 rte_pktmbuf_trim(ops[i]->sym->m_src,
321 ops[i]->sym->auth.digest.length);
323 dst = ops[i]->sym->auth.digest.data;
325 sso_kasumi_f9_1_buffer_user(&session->pKeySched_hash,
327 length_in_bits, dst, direction);
332 return processed_ops;
335 /** Process a batch of crypto ops which shares the same session. */
337 process_ops(struct rte_crypto_op **ops, struct kasumi_session *session,
338 struct kasumi_qp *qp, uint8_t num_ops,
339 uint16_t *accumulated_enqueued_ops)
342 unsigned enqueued_ops, processed_ops;
344 switch (session->op) {
345 case KASUMI_OP_ONLY_CIPHER:
346 processed_ops = process_kasumi_cipher_op(ops,
349 case KASUMI_OP_ONLY_AUTH:
350 processed_ops = process_kasumi_hash_op(ops, session,
353 case KASUMI_OP_CIPHER_AUTH:
354 processed_ops = process_kasumi_cipher_op(ops, session,
356 process_kasumi_hash_op(ops, session, processed_ops);
358 case KASUMI_OP_AUTH_CIPHER:
359 processed_ops = process_kasumi_hash_op(ops, session,
361 process_kasumi_cipher_op(ops, session, processed_ops);
364 /* Operation not supported. */
368 for (i = 0; i < num_ops; i++) {
370 * If there was no error/authentication failure,
371 * change status to successful.
373 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
374 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
375 /* Free session if a session-less crypto op. */
376 if (ops[i]->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
377 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
378 ops[i]->sym->session = NULL;
382 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
383 (void **)ops, processed_ops);
384 qp->qp_stats.enqueued_count += enqueued_ops;
385 *accumulated_enqueued_ops += enqueued_ops;
390 /** Process a crypto op with length/offset in bits. */
392 process_op_bit(struct rte_crypto_op *op, struct kasumi_session *session,
393 struct kasumi_qp *qp, uint16_t *accumulated_enqueued_ops)
395 unsigned enqueued_op, processed_op;
397 switch (session->op) {
398 case KASUMI_OP_ONLY_CIPHER:
399 processed_op = process_kasumi_cipher_op_bit(op,
402 case KASUMI_OP_ONLY_AUTH:
403 processed_op = process_kasumi_hash_op(&op, session, 1);
405 case KASUMI_OP_CIPHER_AUTH:
406 processed_op = process_kasumi_cipher_op_bit(op, session);
407 if (processed_op == 1)
408 process_kasumi_hash_op(&op, session, 1);
410 case KASUMI_OP_AUTH_CIPHER:
411 processed_op = process_kasumi_hash_op(&op, session, 1);
412 if (processed_op == 1)
413 process_kasumi_cipher_op_bit(op, session);
416 /* Operation not supported. */
421 * If there was no error/authentication failure,
422 * change status to successful.
424 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
425 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
427 /* Free session if a session-less crypto op. */
428 if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
429 rte_mempool_put(qp->sess_mp, op->sym->session);
430 op->sym->session = NULL;
433 enqueued_op = rte_ring_enqueue_burst(qp->processed_ops, (void **)&op,
435 qp->qp_stats.enqueued_count += enqueued_op;
436 *accumulated_enqueued_ops += enqueued_op;
442 kasumi_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
445 struct rte_crypto_op *c_ops[nb_ops];
446 struct rte_crypto_op *curr_c_op;
448 struct kasumi_session *prev_sess = NULL, *curr_sess = NULL;
449 struct kasumi_qp *qp = queue_pair;
451 uint8_t burst_size = 0;
452 uint16_t enqueued_ops = 0;
453 uint8_t processed_ops;
455 for (i = 0; i < nb_ops; i++) {
458 /* Set status as enqueued (not processed yet) by default. */
459 curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
461 curr_sess = kasumi_get_session(qp, curr_c_op);
462 if (unlikely(curr_sess == NULL ||
463 curr_sess->op == KASUMI_OP_NOT_SUPPORTED)) {
465 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
469 /* If length/offset is at bit-level, process this buffer alone. */
470 if (((curr_c_op->sym->cipher.data.length % BYTE_LEN) != 0)
471 || ((ops[i]->sym->cipher.data.offset
473 /* Process the ops of the previous session. */
474 if (prev_sess != NULL) {
475 processed_ops = process_ops(c_ops, prev_sess,
476 qp, burst_size, &enqueued_ops);
477 if (processed_ops < burst_size) {
486 processed_ops = process_op_bit(curr_c_op, curr_sess,
488 if (processed_ops != 1)
494 /* Batch ops that share the same session. */
495 if (prev_sess == NULL) {
496 prev_sess = curr_sess;
497 c_ops[burst_size++] = curr_c_op;
498 } else if (curr_sess == prev_sess) {
499 c_ops[burst_size++] = curr_c_op;
501 * When there are enough ops to process in a batch,
502 * process them, and start a new batch.
504 if (burst_size == KASUMI_MAX_BURST) {
505 processed_ops = process_ops(c_ops, prev_sess,
506 qp, burst_size, &enqueued_ops);
507 if (processed_ops < burst_size) {
517 * Different session, process the ops
518 * of the previous session.
520 processed_ops = process_ops(c_ops, prev_sess,
521 qp, burst_size, &enqueued_ops);
522 if (processed_ops < burst_size) {
528 prev_sess = curr_sess;
530 c_ops[burst_size++] = curr_c_op;
534 if (burst_size != 0) {
535 /* Process the crypto ops of the last session. */
536 processed_ops = process_ops(c_ops, prev_sess,
537 qp, burst_size, &enqueued_ops);
540 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
545 kasumi_pmd_dequeue_burst(void *queue_pair,
546 struct rte_crypto_op **c_ops, uint16_t nb_ops)
548 struct kasumi_qp *qp = queue_pair;
550 unsigned nb_dequeued;
552 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
553 (void **)c_ops, nb_ops);
554 qp->qp_stats.dequeued_count += nb_dequeued;
559 static int cryptodev_kasumi_uninit(const char *name);
562 cryptodev_kasumi_create(const char *name,
563 struct rte_crypto_vdev_init_params *init_params)
565 struct rte_cryptodev *dev;
566 char crypto_dev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
567 struct kasumi_private *internals;
568 uint64_t cpu_flags = 0;
570 /* Check CPU for supported vector instruction set */
571 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
572 cpu_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
573 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
574 cpu_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
576 KASUMI_LOG_ERR("Vector instructions are not supported by CPU");
580 /* Create a unique device name. */
581 if (create_unique_device_name(crypto_dev_name,
582 RTE_CRYPTODEV_NAME_MAX_LEN) != 0) {
583 KASUMI_LOG_ERR("failed to create unique cryptodev name");
587 dev = rte_cryptodev_pmd_virtual_dev_init(crypto_dev_name,
588 sizeof(struct kasumi_private), init_params->socket_id);
590 KASUMI_LOG_ERR("failed to create cryptodev vdev");
594 dev->dev_type = RTE_CRYPTODEV_KASUMI_PMD;
595 dev->dev_ops = rte_kasumi_pmd_ops;
597 /* Register RX/TX burst functions for data path. */
598 dev->dequeue_burst = kasumi_pmd_dequeue_burst;
599 dev->enqueue_burst = kasumi_pmd_enqueue_burst;
601 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
602 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
605 internals = dev->data->dev_private;
607 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
608 internals->max_nb_sessions = init_params->max_nb_sessions;
612 KASUMI_LOG_ERR("driver %s: cryptodev_kasumi_create failed", name);
614 cryptodev_kasumi_uninit(crypto_dev_name);
619 cryptodev_kasumi_init(const char *name,
620 const char *input_args)
622 struct rte_crypto_vdev_init_params init_params = {
623 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
624 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
628 rte_cryptodev_parse_vdev_init_params(&init_params, input_args);
630 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
631 init_params.socket_id);
632 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
633 init_params.max_nb_queue_pairs);
634 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
635 init_params.max_nb_sessions);
637 return cryptodev_kasumi_create(name, &init_params);
641 cryptodev_kasumi_uninit(const char *name)
646 RTE_LOG(INFO, PMD, "Closing KASUMI crypto device %s"
647 " on numa socket %u\n",
648 name, rte_socket_id());
653 static struct rte_vdev_driver cryptodev_kasumi_pmd_drv = {
657 .init = cryptodev_kasumi_init,
658 .uninit = cryptodev_kasumi_uninit
661 DRIVER_REGISTER_VDEV(CRYPTODEV_NAME_KASUMI_PMD, cryptodev_kasumi_pmd_drv);
662 DRIVER_REGISTER_PARAM_STRING(CRYPTODEV_NAME_KASUMI_PMD,
663 "max_nb_queue_pairs=<int> "
664 "max_nb_sessions=<int> "