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_snow3g_pmd_private.h"
45 #define SNOW3G_IV_LENGTH 16
46 #define SNOW3G_DIGEST_LENGTH 4
47 #define SNOW3G_MAX_BURST 8
50 /** Get xform chain order. */
51 static enum snow3g_operation
52 snow3g_get_mode(const struct rte_crypto_sym_xform *xform)
55 return SNOW3G_OP_NOT_SUPPORTED;
58 if (xform->next->next != NULL)
59 return SNOW3G_OP_NOT_SUPPORTED;
61 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
62 if (xform->next == NULL)
63 return SNOW3G_OP_ONLY_AUTH;
64 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
65 return SNOW3G_OP_AUTH_CIPHER;
67 return SNOW3G_OP_NOT_SUPPORTED;
70 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
71 if (xform->next == NULL)
72 return SNOW3G_OP_ONLY_CIPHER;
73 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
74 return SNOW3G_OP_CIPHER_AUTH;
76 return SNOW3G_OP_NOT_SUPPORTED;
79 return SNOW3G_OP_NOT_SUPPORTED;
83 /** Parse crypto xform chain and set private session parameters. */
85 snow3g_set_session_parameters(struct snow3g_session *sess,
86 const struct rte_crypto_sym_xform *xform)
88 const struct rte_crypto_sym_xform *auth_xform = NULL;
89 const struct rte_crypto_sym_xform *cipher_xform = NULL;
90 enum snow3g_operation mode;
92 /* Select Crypto operation - hash then cipher / cipher then hash */
93 mode = snow3g_get_mode(xform);
96 case SNOW3G_OP_CIPHER_AUTH:
97 auth_xform = xform->next;
100 case SNOW3G_OP_ONLY_CIPHER:
101 cipher_xform = xform;
103 case SNOW3G_OP_AUTH_CIPHER:
104 cipher_xform = xform->next;
106 case SNOW3G_OP_ONLY_AUTH:
109 case SNOW3G_OP_NOT_SUPPORTED:
111 SNOW3G_LOG_ERR("Unsupported operation chain order parameter");
116 /* Only SNOW 3G UEA2 supported */
117 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_SNOW3G_UEA2)
120 sso_snow3g_init_key_sched(cipher_xform->cipher.key.data,
121 &sess->pKeySched_cipher);
125 /* Only SNOW 3G UIA2 supported */
126 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_SNOW3G_UIA2)
128 sess->auth_op = auth_xform->auth.op;
130 sso_snow3g_init_key_sched(auth_xform->auth.key.data,
131 &sess->pKeySched_hash);
140 /** Get SNOW 3G session. */
141 static struct snow3g_session *
142 snow3g_get_session(struct snow3g_qp *qp, struct rte_crypto_op *op)
144 struct snow3g_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_SNOW3G_PMD))
151 sess = (struct snow3g_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 snow3g_session *)c_sess->_private;
160 if (unlikely(snow3g_set_session_parameters(sess,
161 op->sym->xform) != 0))
168 /** Encrypt/decrypt mbufs with same cipher key. */
170 process_snow3g_cipher_op(struct rte_crypto_op **ops,
171 struct snow3g_session *session,
175 uint8_t processed_ops = 0;
176 uint8_t *src[SNOW3G_MAX_BURST], *dst[SNOW3G_MAX_BURST];
177 uint8_t *IV[SNOW3G_MAX_BURST];
178 uint32_t num_bytes[SNOW3G_MAX_BURST];
180 for (i = 0; i < num_ops; i++) {
182 if (unlikely(ops[i]->sym->cipher.iv.length != SNOW3G_IV_LENGTH)) {
183 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
184 SNOW3G_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] = ops[i]->sym->cipher.iv.data;
196 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
201 sso_snow3g_f8_n_buffer(&session->pKeySched_cipher, IV, src, dst,
202 num_bytes, processed_ops);
204 return processed_ops;
207 /** Encrypt/decrypt mbuf (bit level function). */
209 process_snow3g_cipher_op_bit(struct rte_crypto_op *op,
210 struct snow3g_session *session)
214 uint32_t length_in_bits, offset_in_bits;
217 if (unlikely(op->sym->cipher.iv.length != SNOW3G_IV_LENGTH)) {
218 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
219 SNOW3G_LOG_ERR("iv");
223 offset_in_bits = op->sym->cipher.data.offset;
224 src = rte_pktmbuf_mtod(op->sym->m_src, uint8_t *);
225 if (op->sym->m_dst == NULL) {
226 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
227 SNOW3G_LOG_ERR("bit-level in-place not supported\n");
230 dst = rte_pktmbuf_mtod(op->sym->m_dst, uint8_t *);
231 IV = op->sym->cipher.iv.data;
232 length_in_bits = op->sym->cipher.data.length;
234 sso_snow3g_f8_1_buffer_bit(&session->pKeySched_cipher, IV,
235 src, dst, length_in_bits, offset_in_bits);
240 /** Generate/verify hash from mbufs with same hash key. */
242 process_snow3g_hash_op(struct rte_crypto_op **ops,
243 struct snow3g_session *session,
247 uint8_t processed_ops = 0;
249 uint32_t length_in_bits;
251 for (i = 0; i < num_ops; i++) {
252 if (unlikely(ops[i]->sym->auth.aad.length != SNOW3G_IV_LENGTH)) {
253 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
254 SNOW3G_LOG_ERR("aad");
258 if (unlikely(ops[i]->sym->auth.digest.length != SNOW3G_DIGEST_LENGTH)) {
259 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
260 SNOW3G_LOG_ERR("digest");
264 /* Data must be byte aligned */
265 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
266 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
267 SNOW3G_LOG_ERR("Offset");
271 length_in_bits = ops[i]->sym->auth.data.length;
273 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
274 (ops[i]->sym->auth.data.offset >> 3);
276 if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
277 dst = (uint8_t *)rte_pktmbuf_append(ops[i]->sym->m_src,
278 ops[i]->sym->auth.digest.length);
280 sso_snow3g_f9_1_buffer(&session->pKeySched_hash,
281 ops[i]->sym->auth.aad.data, src,
282 length_in_bits, dst);
284 if (memcmp(dst, ops[i]->sym->auth.digest.data,
285 ops[i]->sym->auth.digest.length) != 0)
286 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
288 /* Trim area used for digest from mbuf. */
289 rte_pktmbuf_trim(ops[i]->sym->m_src,
290 ops[i]->sym->auth.digest.length);
292 dst = ops[i]->sym->auth.digest.data;
294 sso_snow3g_f9_1_buffer(&session->pKeySched_hash,
295 ops[i]->sym->auth.aad.data, src,
296 length_in_bits, dst);
301 return processed_ops;
304 /** Process a batch of crypto ops which shares the same session. */
306 process_ops(struct rte_crypto_op **ops, struct snow3g_session *session,
307 struct snow3g_qp *qp, uint8_t num_ops,
308 uint16_t *accumulated_enqueued_ops)
311 unsigned enqueued_ops, processed_ops;
313 #ifdef RTE_LIBRTE_PMD_SNOW3G_DEBUG
314 for (i = 0; i < num_ops; i++) {
315 if (!rte_pktmbuf_is_contiguous(ops[i]->sym->m_src) ||
316 (ops[i]->sym->m_dst != NULL &&
317 !rte_pktmbuf_is_contiguous(
318 ops[i]->sym->m_dst))) {
319 SNOW3G_LOG_ERR("PMD supports only contiguous mbufs, "
320 "op (%p) provides noncontiguous mbuf as "
321 "source/destination buffer.\n", ops[i]);
322 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
328 switch (session->op) {
329 case SNOW3G_OP_ONLY_CIPHER:
330 processed_ops = process_snow3g_cipher_op(ops,
333 case SNOW3G_OP_ONLY_AUTH:
334 processed_ops = process_snow3g_hash_op(ops, session,
337 case SNOW3G_OP_CIPHER_AUTH:
338 processed_ops = process_snow3g_cipher_op(ops, session,
340 process_snow3g_hash_op(ops, session, processed_ops);
342 case SNOW3G_OP_AUTH_CIPHER:
343 processed_ops = process_snow3g_hash_op(ops, session,
345 process_snow3g_cipher_op(ops, session, processed_ops);
348 /* Operation not supported. */
352 for (i = 0; i < num_ops; i++) {
354 * If there was no error/authentication failure,
355 * change status to successful.
357 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
358 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
359 /* Free session if a session-less crypto op. */
360 if (ops[i]->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
361 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
362 ops[i]->sym->session = NULL;
366 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
367 (void **)ops, processed_ops, NULL);
368 qp->qp_stats.enqueued_count += enqueued_ops;
369 *accumulated_enqueued_ops += enqueued_ops;
374 /** Process a crypto op with length/offset in bits. */
376 process_op_bit(struct rte_crypto_op *op, struct snow3g_session *session,
377 struct snow3g_qp *qp, uint16_t *accumulated_enqueued_ops)
379 unsigned enqueued_op, processed_op;
381 switch (session->op) {
382 case SNOW3G_OP_ONLY_CIPHER:
383 processed_op = process_snow3g_cipher_op_bit(op,
386 case SNOW3G_OP_ONLY_AUTH:
387 processed_op = process_snow3g_hash_op(&op, session, 1);
389 case SNOW3G_OP_CIPHER_AUTH:
390 processed_op = process_snow3g_cipher_op_bit(op, session);
391 if (processed_op == 1)
392 process_snow3g_hash_op(&op, session, 1);
394 case SNOW3G_OP_AUTH_CIPHER:
395 processed_op = process_snow3g_hash_op(&op, session, 1);
396 if (processed_op == 1)
397 process_snow3g_cipher_op_bit(op, session);
400 /* Operation not supported. */
405 * If there was no error/authentication failure,
406 * change status to successful.
408 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
409 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
411 /* Free session if a session-less crypto op. */
412 if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
413 rte_mempool_put(qp->sess_mp, op->sym->session);
414 op->sym->session = NULL;
417 enqueued_op = rte_ring_enqueue_burst(qp->processed_ops,
418 (void **)&op, processed_op, NULL);
419 qp->qp_stats.enqueued_count += enqueued_op;
420 *accumulated_enqueued_ops += enqueued_op;
426 snow3g_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
429 struct rte_crypto_op *c_ops[SNOW3G_MAX_BURST];
430 struct rte_crypto_op *curr_c_op;
432 struct snow3g_session *prev_sess = NULL, *curr_sess = NULL;
433 struct snow3g_qp *qp = queue_pair;
435 uint8_t burst_size = 0;
436 uint16_t enqueued_ops = 0;
437 uint8_t processed_ops;
439 for (i = 0; i < nb_ops; i++) {
442 /* Set status as enqueued (not processed yet) by default. */
443 curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
445 curr_sess = snow3g_get_session(qp, curr_c_op);
446 if (unlikely(curr_sess == NULL ||
447 curr_sess->op == SNOW3G_OP_NOT_SUPPORTED)) {
449 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
453 /* If length/offset is at bit-level, process this buffer alone. */
454 if (((curr_c_op->sym->cipher.data.length % BYTE_LEN) != 0)
455 || ((curr_c_op->sym->cipher.data.offset
457 /* Process the ops of the previous session. */
458 if (prev_sess != NULL) {
459 processed_ops = process_ops(c_ops, prev_sess,
460 qp, burst_size, &enqueued_ops);
461 if (processed_ops < burst_size) {
470 processed_ops = process_op_bit(curr_c_op, curr_sess,
472 if (processed_ops != 1)
478 /* Batch ops that share the same session. */
479 if (prev_sess == NULL) {
480 prev_sess = curr_sess;
481 c_ops[burst_size++] = curr_c_op;
482 } else if (curr_sess == prev_sess) {
483 c_ops[burst_size++] = curr_c_op;
485 * When there are enough ops to process in a batch,
486 * process them, and start a new batch.
488 if (burst_size == SNOW3G_MAX_BURST) {
489 processed_ops = process_ops(c_ops, prev_sess,
490 qp, burst_size, &enqueued_ops);
491 if (processed_ops < burst_size) {
501 * Different session, process the ops
502 * of the previous session.
504 processed_ops = process_ops(c_ops, prev_sess,
505 qp, burst_size, &enqueued_ops);
506 if (processed_ops < burst_size) {
512 prev_sess = curr_sess;
514 c_ops[burst_size++] = curr_c_op;
518 if (burst_size != 0) {
519 /* Process the crypto ops of the last session. */
520 processed_ops = process_ops(c_ops, prev_sess,
521 qp, burst_size, &enqueued_ops);
524 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
529 snow3g_pmd_dequeue_burst(void *queue_pair,
530 struct rte_crypto_op **c_ops, uint16_t nb_ops)
532 struct snow3g_qp *qp = queue_pair;
534 unsigned nb_dequeued;
536 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
537 (void **)c_ops, nb_ops, NULL);
538 qp->qp_stats.dequeued_count += nb_dequeued;
543 static int cryptodev_snow3g_remove(struct rte_vdev_device *vdev);
546 cryptodev_snow3g_create(const char *name,
547 struct rte_vdev_device *vdev,
548 struct rte_crypto_vdev_init_params *init_params)
550 struct rte_cryptodev *dev;
551 struct snow3g_private *internals;
552 uint64_t cpu_flags = 0;
554 if (init_params->name[0] == '\0')
555 snprintf(init_params->name, sizeof(init_params->name),
558 /* Check CPU for supported vector instruction set */
559 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
560 cpu_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
562 SNOW3G_LOG_ERR("Vector instructions are not supported by CPU");
566 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
567 sizeof(struct snow3g_private), init_params->socket_id,
570 SNOW3G_LOG_ERR("failed to create cryptodev vdev");
574 dev->dev_type = RTE_CRYPTODEV_SNOW3G_PMD;
575 dev->dev_ops = rte_snow3g_pmd_ops;
577 /* Register RX/TX burst functions for data path. */
578 dev->dequeue_burst = snow3g_pmd_dequeue_burst;
579 dev->enqueue_burst = snow3g_pmd_enqueue_burst;
581 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
582 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
585 internals = dev->data->dev_private;
587 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
588 internals->max_nb_sessions = init_params->max_nb_sessions;
592 SNOW3G_LOG_ERR("driver %s: cryptodev_snow3g_create failed",
595 cryptodev_snow3g_remove(vdev);
600 cryptodev_snow3g_probe(struct rte_vdev_device *vdev)
602 struct rte_crypto_vdev_init_params init_params = {
603 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
604 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
609 const char *input_args;
611 name = rte_vdev_device_name(vdev);
614 input_args = rte_vdev_device_args(vdev);
616 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
618 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
619 init_params.socket_id);
620 if (init_params.name[0] != '\0')
621 RTE_LOG(INFO, PMD, " User defined name = %s\n",
623 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
624 init_params.max_nb_queue_pairs);
625 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
626 init_params.max_nb_sessions);
628 return cryptodev_snow3g_create(name, vdev, &init_params);
632 cryptodev_snow3g_remove(struct rte_vdev_device *vdev)
636 name = rte_vdev_device_name(vdev);
640 RTE_LOG(INFO, PMD, "Closing SNOW 3G crypto device %s"
641 " on numa socket %u\n",
642 name, rte_socket_id());
647 static struct rte_vdev_driver cryptodev_snow3g_pmd_drv = {
648 .probe = cryptodev_snow3g_probe,
649 .remove = cryptodev_snow3g_remove
652 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SNOW3G_PMD, cryptodev_snow3g_pmd_drv);
653 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_SNOW3G_PMD, cryptodev_snow3g_pmd);
654 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SNOW3G_PMD,
655 "max_nb_queue_pairs=<int> "
656 "max_nb_sessions=<int> "