crypto/zuc: add driver for ZUC library
authorPablo de Lara <pablo.de.lara.guarch@intel.com>
Thu, 29 Sep 2016 02:59:47 +0000 (03:59 +0100)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Sat, 8 Oct 2016 15:53:10 +0000 (17:53 +0200)
Added new SW PMD which makes use of the libsso SW library,
which provides wireless algorithms ZUC EEA3 and EIA3
in software.

This PMD supports cipher-only, hash-only and chained operations
("cipher then hash" and "hash then cipher") of the following
algorithms:
- RTE_CRYPTO_SYM_CIPHER_ZUC_EEA3
- RTE_CRYPTO_SYM_AUTH_ZUC_EIA3

The ZUC hash and cipher algorithms, which are enabled
by this crypto PMD are implemented by Intel's libsso software
library.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>
16 files changed:
MAINTAINERS
config/common_base
config/defconfig_i686-native-linuxapp-gcc
config/defconfig_i686-native-linuxapp-icc
doc/guides/cryptodevs/index.rst
doc/guides/cryptodevs/zuc.rst [new file with mode: 0644]
drivers/crypto/Makefile
drivers/crypto/zuc/Makefile [new file with mode: 0644]
drivers/crypto/zuc/rte_pmd_zuc_version.map [new file with mode: 0644]
drivers/crypto/zuc/rte_zuc_pmd.c [new file with mode: 0644]
drivers/crypto/zuc/rte_zuc_pmd_ops.c [new file with mode: 0644]
drivers/crypto/zuc/rte_zuc_pmd_private.h [new file with mode: 0644]
lib/librte_cryptodev/rte_crypto_sym.h
lib/librte_cryptodev/rte_cryptodev.h
mk/rte.app.mk
scripts/test-build.sh

index 6a2527c..5196e78 100644 (file)
@@ -431,6 +431,11 @@ M: Pablo de Lara <pablo.de.lara.guarch@intel.com>
 F: drivers/crypto/kasumi/
 F: doc/guides/cryptodevs/kasumi.rst
 
+ZUC PMD
+M: Pablo de Lara <pablo.de.lara.guarch@intel.com>
+F: drivers/crypto/zuc/
+F: doc/guides/cryptodevs/zuc.rst
+
 Null Crypto PMD
 M: Declan Doherty <declan.doherty@intel.com>
 F: drivers/crypto/null/
index c703908..9b134ab 100644 (file)
@@ -393,6 +393,12 @@ CONFIG_RTE_LIBRTE_PMD_SNOW3G_DEBUG=n
 CONFIG_RTE_LIBRTE_PMD_KASUMI=n
 CONFIG_RTE_LIBRTE_PMD_KASUMI_DEBUG=n
 
+#
+# Compile PMD for ZUC device
+#
+CONFIG_RTE_LIBRTE_PMD_ZUC=n
+CONFIG_RTE_LIBRTE_PMD_ZUC_DEBUG=n
+
 #
 # Compile PMD for NULL Crypto device
 #
index ba07259..576d543 100644 (file)
@@ -65,3 +65,8 @@ CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=n
 # KASUMI PMD is not supported on 32-bit
 #
 CONFIG_RTE_LIBRTE_PMD_KASUMI=n
+
+#
+# ZUC PMD is not supported on 32-bit
+#
+CONFIG_RTE_LIBRTE_PMD_ZUC=n
index 850e536..6c902a3 100644 (file)
@@ -65,3 +65,8 @@ CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=n
 # KASUMI PMD is not supported on 32-bit
 #
 CONFIG_RTE_LIBRTE_PMD_KASUMI=n
+
+#
+# ZUC PMD is not supported on 32-bit
+#
+CONFIG_RTE_LIBRTE_PMD_ZUC=n
index 9616de1..906f1b4 100644 (file)
@@ -42,3 +42,4 @@ Crypto Device Drivers
     null
     snow3g
     qat
+    zuc
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
new file mode 100644 (file)
index 0000000..7267120
--- /dev/null
@@ -0,0 +1,108 @@
+..  BSD LICENSE
+    Copyright(c) 2016 Intel Corporation. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ZUC Crypto Poll Mode Driver
+===========================
+
+The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver
+support for utilizing Intel Libsso library, which implements F8 and F9 functions
+for ZUC EEA3 cipher and EIA3 hash algorithms.
+
+Features
+--------
+
+ZUC PMD has support for:
+
+Cipher algorithm:
+
+* RTE_CRYPTO_CIPHER_ZUC_EEA3
+
+Authentication algorithm:
+
+* RTE_CRYPTO_AUTH_ZUC_EIA3
+
+Limitations
+-----------
+
+* Chained mbufs are not supported.
+* ZUC (EIA3) supported only if hash offset field is byte-aligned.
+* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.
+
+Installation
+------------
+
+To build DPDK with the ZUC_PMD the user is required to download
+the export controlled ``libsso_zuc`` library, by requesting it from
+`<https://networkbuilders.intel.com/network-technologies/dpdk>`_.
+Once approval has been granted, the user needs to log in
+`<https://networkbuilders.intel.com/dpdklogin>`_
+and click on "ZUC Library" link, to download the library.
+After downloading the library, the user needs to unpack and compile it
+on their system before building DPDK::
+
+   make
+
+Initialization
+--------------
+
+In order to enable this virtual crypto PMD, user must:
+
+* Export the environmental variable LIBSSO_ZUC_PATH with the path where
+  the library was extracted (zuc folder).
+
+* Build the LIBSSO_ZUC library (explained in Installation section).
+
+* Build DPDK as follows:
+
+.. code-block:: console
+
+       make config T=x86_64-native-linuxapp-gcc
+       sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config
+       make
+
+To use the PMD in an application, user must:
+
+* Call rte_eal_vdev_init("crypto_zuc") within the application.
+
+* Use --vdev="crypto_zuc" in the EAL options, which will call rte_eal_vdev_init() internally.
+
+The following parameters (all optional) can be provided in the previous two calls:
+
+* socket_id: Specify the socket where the memory for the device is going to be allocated
+  (by default, socket_id will be the socket where the core that is creating the PMD is running on).
+
+* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
+
+* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
+
+Example:
+
+.. code-block:: console
+
+    ./l2fwd-crypto -c 40 -n 4 --vdev="crypto_zuc,socket_id=1,max_nb_sessions=128"
index dc4ef7f..17d74fc 100644 (file)
@@ -36,6 +36,7 @@ DIRS-$(CONFIG_RTE_LIBRTE_PMD_AESNI_MB) += aesni_mb
 DIRS-$(CONFIG_RTE_LIBRTE_PMD_QAT) += qat
 DIRS-$(CONFIG_RTE_LIBRTE_PMD_SNOW3G) += snow3g
 DIRS-$(CONFIG_RTE_LIBRTE_PMD_KASUMI) += kasumi
+DIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += zuc
 DIRS-$(CONFIG_RTE_LIBRTE_PMD_NULL_CRYPTO) += null
 
 include $(RTE_SDK)/mk/rte.subdir.mk
diff --git a/drivers/crypto/zuc/Makefile b/drivers/crypto/zuc/Makefile
new file mode 100644 (file)
index 0000000..b15eb0f
--- /dev/null
@@ -0,0 +1,69 @@
+#   BSD LICENSE
+#
+#   Copyright(c) 2016 Intel Corporation. All rights reserved.
+#
+#   Redistribution and use in source and binary forms, with or without
+#   modification, are permitted provided that the following conditions
+#   are met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in
+#       the documentation and/or other materials provided with the
+#       distribution.
+#     * Neither the name of Intel Corporation nor the names of its
+#       contributors may be used to endorse or promote products derived
+#       from this software without specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+include $(RTE_SDK)/mk/rte.vars.mk
+
+ifneq ($(MAKECMDGOALS),clean)
+ifeq ($(LIBSSO_ZUC_PATH),)
+$(error "Please define LIBSSO_ZUC_PATH environment variable")
+endif
+endif
+
+# library name
+LIB = librte_pmd_zuc.a
+
+# build flags
+CFLAGS += -O3
+CFLAGS += $(WERROR_FLAGS)
+
+# library version
+LIBABIVER := 1
+
+# versioning export map
+EXPORT_MAP := rte_pmd_zuc_version.map
+
+# external library dependencies
+CFLAGS += -I$(LIBSSO_ZUC_PATH)
+CFLAGS += -I$(LIBSSO_ZUC_PATH)/include
+CFLAGS += -I$(LIBSSO_ZUC_PATH)/build
+LDLIBS += -L$(LIBSSO_ZUC_PATH)/build -lsso_zuc
+
+# library source files
+SRCS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += rte_zuc_pmd.c
+SRCS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += rte_zuc_pmd_ops.c
+
+# library dependencies
+DEPDIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += lib/librte_eal
+DEPDIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += lib/librte_mbuf
+DEPDIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += lib/librte_mempool
+DEPDIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += lib/librte_ring
+DEPDIRS-$(CONFIG_RTE_LIBRTE_PMD_ZUC) += lib/librte_cryptodev
+
+include $(RTE_SDK)/mk/rte.lib.mk
diff --git a/drivers/crypto/zuc/rte_pmd_zuc_version.map b/drivers/crypto/zuc/rte_pmd_zuc_version.map
new file mode 100644 (file)
index 0000000..cc5829e
--- /dev/null
@@ -0,0 +1,3 @@
+DPDK_16.11 {
+       local: *;
+};
diff --git a/drivers/crypto/zuc/rte_zuc_pmd.c b/drivers/crypto/zuc/rte_zuc_pmd.c
new file mode 100644 (file)
index 0000000..457f3ca
--- /dev/null
@@ -0,0 +1,550 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2016 Intel Corporation. All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <rte_common.h>
+#include <rte_config.h>
+#include <rte_hexdump.h>
+#include <rte_cryptodev.h>
+#include <rte_cryptodev_pmd.h>
+#include <rte_vdev.h>
+#include <rte_malloc.h>
+#include <rte_cpuflags.h>
+
+#include "rte_zuc_pmd_private.h"
+
+#define ZUC_DIGEST_LENGTH 4
+#define ZUC_MAX_BURST 8
+#define BYTE_LEN 8
+
+/**
+ * Global static parameter used to create a unique name for each ZUC
+ * crypto device.
+ */
+static unsigned unique_name_id;
+
+static inline int
+create_unique_device_name(char *name, size_t size)
+{
+       int ret;
+
+       if (name == NULL)
+               return -EINVAL;
+
+       ret = snprintf(name, size, "%s_%u", RTE_STR(CRYPTODEV_NAME_ZUC_PMD),
+                       unique_name_id++);
+       if (ret < 0)
+               return ret;
+       return 0;
+}
+
+/** Get xform chain order. */
+static enum zuc_operation
+zuc_get_mode(const struct rte_crypto_sym_xform *xform)
+{
+       if (xform == NULL)
+               return ZUC_OP_NOT_SUPPORTED;
+
+       if (xform->next)
+               if (xform->next->next != NULL)
+                       return ZUC_OP_NOT_SUPPORTED;
+
+       if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
+               if (xform->next == NULL)
+                       return ZUC_OP_ONLY_AUTH;
+               else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
+                       return ZUC_OP_AUTH_CIPHER;
+               else
+                       return ZUC_OP_NOT_SUPPORTED;
+       }
+
+       if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
+               if (xform->next == NULL)
+                       return ZUC_OP_ONLY_CIPHER;
+               else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
+                       return ZUC_OP_CIPHER_AUTH;
+               else
+                       return ZUC_OP_NOT_SUPPORTED;
+       }
+
+       return ZUC_OP_NOT_SUPPORTED;
+}
+
+
+/** Parse crypto xform chain and set private session parameters. */
+int
+zuc_set_session_parameters(struct zuc_session *sess,
+               const struct rte_crypto_sym_xform *xform)
+{
+       const struct rte_crypto_sym_xform *auth_xform = NULL;
+       const struct rte_crypto_sym_xform *cipher_xform = NULL;
+       enum zuc_operation mode;
+
+       /* Select Crypto operation - hash then cipher / cipher then hash */
+       mode = zuc_get_mode(xform);
+
+       switch (mode) {
+       case ZUC_OP_CIPHER_AUTH:
+               auth_xform = xform->next;
+
+               /* Fall-through */
+       case ZUC_OP_ONLY_CIPHER:
+               cipher_xform = xform;
+               break;
+       case ZUC_OP_AUTH_CIPHER:
+               cipher_xform = xform->next;
+               /* Fall-through */
+       case ZUC_OP_ONLY_AUTH:
+               auth_xform = xform;
+               break;
+       case ZUC_OP_NOT_SUPPORTED:
+       default:
+               ZUC_LOG_ERR("Unsupported operation chain order parameter");
+               return -EINVAL;
+       }
+
+       if (cipher_xform) {
+               /* Only ZUC EEA3 supported */
+               if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_ZUC_EEA3)
+                       return -EINVAL;
+               /* Copy the key */
+               memcpy(sess->pKey_cipher, xform->cipher.key.data, ZUC_IV_KEY_LENGTH);
+       }
+
+       if (auth_xform) {
+               /* Only ZUC EIA3 supported */
+               if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_ZUC_EIA3)
+                       return -EINVAL;
+               sess->auth_op = auth_xform->auth.op;
+               /* Copy the key */
+               memcpy(sess->pKey_hash, xform->auth.key.data, ZUC_IV_KEY_LENGTH);
+       }
+
+
+       sess->op = mode;
+
+       return 0;
+}
+
+/** Get ZUC session. */
+static struct zuc_session *
+zuc_get_session(struct zuc_qp *qp, struct rte_crypto_op *op)
+{
+       struct zuc_session *sess;
+
+       if (op->sym->sess_type == RTE_CRYPTO_SYM_OP_WITH_SESSION) {
+               if (unlikely(op->sym->session->dev_type !=
+                               RTE_CRYPTODEV_ZUC_PMD))
+                       return NULL;
+
+               sess = (struct zuc_session *)op->sym->session->_private;
+       } else  {
+               struct rte_cryptodev_session *c_sess = NULL;
+
+               if (rte_mempool_get(qp->sess_mp, (void **)&c_sess))
+                       return NULL;
+
+               sess = (struct zuc_session *)c_sess->_private;
+
+               if (unlikely(zuc_set_session_parameters(sess,
+                               op->sym->xform) != 0))
+                       return NULL;
+       }
+
+       return sess;
+}
+
+/** Encrypt/decrypt mbufs with same cipher key. */
+static uint8_t
+process_zuc_cipher_op(struct rte_crypto_op **ops,
+               struct zuc_session *session,
+               uint8_t num_ops)
+{
+       unsigned i;
+       uint8_t processed_ops = 0;
+       uint8_t *src[ZUC_MAX_BURST], *dst[ZUC_MAX_BURST];
+       uint8_t *IV[ZUC_MAX_BURST];
+       uint32_t num_bytes[ZUC_MAX_BURST];
+       uint8_t *cipher_keys[ZUC_MAX_BURST];
+
+       for (i = 0; i < num_ops; i++) {
+               /* Sanity checks. */
+               if (unlikely(ops[i]->sym->cipher.iv.length != ZUC_IV_KEY_LENGTH)) {
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
+                       ZUC_LOG_ERR("iv");
+                       break;
+               }
+
+               if (((ops[i]->sym->cipher.data.length % BYTE_LEN) != 0)
+                               || ((ops[i]->sym->cipher.data.offset
+                                       % BYTE_LEN) != 0)) {
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
+                       ZUC_LOG_ERR("Data Length or offset");
+                       break;
+               }
+
+               src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
+                               (ops[i]->sym->cipher.data.offset >> 3);
+               dst[i] = ops[i]->sym->m_dst ?
+                       rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
+                               (ops[i]->sym->cipher.data.offset >> 3) :
+                       rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
+                               (ops[i]->sym->cipher.data.offset >> 3);
+               IV[i] = ops[i]->sym->cipher.iv.data;
+               num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
+
+               cipher_keys[i] = session->pKey_cipher;
+
+               processed_ops++;
+       }
+
+       sso_zuc_eea3_n_buffer(cipher_keys, IV, src, dst,
+                       num_bytes, processed_ops);
+
+       return processed_ops;
+}
+
+/** Generate/verify hash from mbufs with same hash key. */
+static int
+process_zuc_hash_op(struct rte_crypto_op **ops,
+               struct zuc_session *session,
+               uint8_t num_ops)
+{
+       unsigned i;
+       uint8_t processed_ops = 0;
+       uint8_t *src;
+       uint32_t *dst;
+       uint32_t length_in_bits;
+
+       for (i = 0; i < num_ops; i++) {
+               if (unlikely(ops[i]->sym->auth.aad.length != ZUC_IV_KEY_LENGTH)) {
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
+                       ZUC_LOG_ERR("aad");
+                       break;
+               }
+
+               if (unlikely(ops[i]->sym->auth.digest.length != ZUC_DIGEST_LENGTH)) {
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
+                       ZUC_LOG_ERR("digest");
+                       break;
+               }
+
+               /* Data must be byte aligned */
+               if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
+                       ZUC_LOG_ERR("Offset");
+                       break;
+               }
+
+               length_in_bits = ops[i]->sym->auth.data.length;
+
+               src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
+                               (ops[i]->sym->auth.data.offset >> 3);
+
+               if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
+                       dst = (uint32_t *)rte_pktmbuf_append(ops[i]->sym->m_src,
+                                       ops[i]->sym->auth.digest.length);
+
+                       sso_zuc_eia3_1_buffer(session->pKey_hash,
+                                       ops[i]->sym->auth.aad.data, src,
+                                       length_in_bits, dst);
+                       /* Verify digest. */
+                       if (memcmp(dst, ops[i]->sym->auth.digest.data,
+                                       ops[i]->sym->auth.digest.length) != 0)
+                               ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
+
+                       /* Trim area used for digest from mbuf. */
+                       rte_pktmbuf_trim(ops[i]->sym->m_src,
+                                       ops[i]->sym->auth.digest.length);
+               } else  {
+                       dst = (uint32_t *)ops[i]->sym->auth.digest.data;
+
+                       sso_zuc_eia3_1_buffer(session->pKey_hash,
+                                       ops[i]->sym->auth.aad.data, src,
+                                       length_in_bits, dst);
+               }
+               processed_ops++;
+       }
+
+       return processed_ops;
+}
+
+/** Process a batch of crypto ops which shares the same session. */
+static int
+process_ops(struct rte_crypto_op **ops, struct zuc_session *session,
+               struct zuc_qp *qp, uint8_t num_ops,
+               uint16_t *accumulated_enqueued_ops)
+{
+       unsigned i;
+       unsigned enqueued_ops, processed_ops;
+
+       switch (session->op) {
+       case ZUC_OP_ONLY_CIPHER:
+               processed_ops = process_zuc_cipher_op(ops,
+                               session, num_ops);
+               break;
+       case ZUC_OP_ONLY_AUTH:
+               processed_ops = process_zuc_hash_op(ops, session,
+                               num_ops);
+               break;
+       case ZUC_OP_CIPHER_AUTH:
+               processed_ops = process_zuc_cipher_op(ops, session,
+                               num_ops);
+               process_zuc_hash_op(ops, session, processed_ops);
+               break;
+       case ZUC_OP_AUTH_CIPHER:
+               processed_ops = process_zuc_hash_op(ops, session,
+                               num_ops);
+               process_zuc_cipher_op(ops, session, processed_ops);
+               break;
+       default:
+               /* Operation not supported. */
+               processed_ops = 0;
+       }
+
+       for (i = 0; i < num_ops; i++) {
+               /*
+                * If there was no error/authentication failure,
+                * change status to successful.
+                */
+               if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
+                       ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
+               /* Free session if a session-less crypto op. */
+               if (ops[i]->sym->sess_type == RTE_CRYPTO_SYM_OP_SESSIONLESS) {
+                       rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
+                       ops[i]->sym->session = NULL;
+               }
+       }
+
+       enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
+                       (void **)ops, processed_ops);
+       qp->qp_stats.enqueued_count += enqueued_ops;
+       *accumulated_enqueued_ops += enqueued_ops;
+
+       return enqueued_ops;
+}
+
+static uint16_t
+zuc_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
+               uint16_t nb_ops)
+{
+       struct rte_crypto_op *c_ops[ZUC_MAX_BURST];
+       struct rte_crypto_op *curr_c_op;
+
+       struct zuc_session *prev_sess = NULL, *curr_sess = NULL;
+       struct zuc_qp *qp = queue_pair;
+       unsigned i;
+       uint8_t burst_size = 0;
+       uint16_t enqueued_ops = 0;
+       uint8_t processed_ops;
+
+       for (i = 0; i < nb_ops; i++) {
+               curr_c_op = ops[i];
+
+               /* Set status as enqueued (not processed yet) by default. */
+               curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
+
+               curr_sess = zuc_get_session(qp, curr_c_op);
+               if (unlikely(curr_sess == NULL ||
+                               curr_sess->op == ZUC_OP_NOT_SUPPORTED)) {
+                       curr_c_op->status =
+                                       RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
+                       break;
+               }
+
+               /* Batch ops that share the same session. */
+               if (prev_sess == NULL) {
+                       prev_sess = curr_sess;
+                       c_ops[burst_size++] = curr_c_op;
+               } else if (curr_sess == prev_sess) {
+                       c_ops[burst_size++] = curr_c_op;
+                       /*
+                        * When there are enough ops to process in a batch,
+                        * process them, and start a new batch.
+                        */
+                       if (burst_size == ZUC_MAX_BURST) {
+                               processed_ops = process_ops(c_ops, prev_sess,
+                                               qp, burst_size, &enqueued_ops);
+                               if (processed_ops < burst_size) {
+                                       burst_size = 0;
+                                       break;
+                               }
+
+                               burst_size = 0;
+                               prev_sess = NULL;
+                       }
+               } else {
+                       /*
+                        * Different session, process the ops
+                        * of the previous session.
+                        */
+                       processed_ops = process_ops(c_ops, prev_sess,
+                                       qp, burst_size, &enqueued_ops);
+                       if (processed_ops < burst_size) {
+                               burst_size = 0;
+                               break;
+                       }
+
+                       burst_size = 0;
+                       prev_sess = curr_sess;
+
+                       c_ops[burst_size++] = curr_c_op;
+               }
+       }
+
+       if (burst_size != 0) {
+               /* Process the crypto ops of the last session. */
+               processed_ops = process_ops(c_ops, prev_sess,
+                               qp, burst_size, &enqueued_ops);
+       }
+
+       qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
+       return enqueued_ops;
+}
+
+static uint16_t
+zuc_pmd_dequeue_burst(void *queue_pair,
+               struct rte_crypto_op **c_ops, uint16_t nb_ops)
+{
+       struct zuc_qp *qp = queue_pair;
+
+       unsigned nb_dequeued;
+
+       nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
+                       (void **)c_ops, nb_ops);
+       qp->qp_stats.dequeued_count += nb_dequeued;
+
+       return nb_dequeued;
+}
+
+static int cryptodev_zuc_uninit(const char *name);
+
+static int
+cryptodev_zuc_create(const char *name,
+               struct rte_crypto_vdev_init_params *init_params)
+{
+       struct rte_cryptodev *dev;
+       char crypto_dev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
+       struct zuc_private *internals;
+       uint64_t cpu_flags = 0;
+
+       /* Check CPU for supported vector instruction set */
+       if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
+               cpu_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
+       else {
+               ZUC_LOG_ERR("Vector instructions are not supported by CPU");
+               return -EFAULT;
+       }
+
+
+       /* Create a unique device name. */
+       if (create_unique_device_name(crypto_dev_name,
+                       RTE_CRYPTODEV_NAME_MAX_LEN) != 0) {
+               ZUC_LOG_ERR("failed to create unique cryptodev name");
+               return -EINVAL;
+       }
+
+       dev = rte_cryptodev_pmd_virtual_dev_init(crypto_dev_name,
+                       sizeof(struct zuc_private), init_params->socket_id);
+       if (dev == NULL) {
+               ZUC_LOG_ERR("failed to create cryptodev vdev");
+               goto init_error;
+       }
+
+       dev->dev_type = RTE_CRYPTODEV_ZUC_PMD;
+       dev->dev_ops = rte_zuc_pmd_ops;
+
+       /* Register RX/TX burst functions for data path. */
+       dev->dequeue_burst = zuc_pmd_dequeue_burst;
+       dev->enqueue_burst = zuc_pmd_enqueue_burst;
+
+       dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
+                       RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
+                       cpu_flags;
+
+       internals = dev->data->dev_private;
+
+       internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
+       internals->max_nb_sessions = init_params->max_nb_sessions;
+
+       return 0;
+init_error:
+       ZUC_LOG_ERR("driver %s: cryptodev_zuc_create failed", name);
+
+       cryptodev_zuc_uninit(crypto_dev_name);
+       return -EFAULT;
+}
+
+static int
+cryptodev_zuc_init(const char *name,
+               const char *input_args)
+{
+       struct rte_crypto_vdev_init_params init_params = {
+               RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
+               RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
+               rte_socket_id()
+       };
+
+       rte_cryptodev_parse_vdev_init_params(&init_params, input_args);
+
+       RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
+                       init_params.socket_id);
+       RTE_LOG(INFO, PMD, "  Max number of queue pairs = %d\n",
+                       init_params.max_nb_queue_pairs);
+       RTE_LOG(INFO, PMD, "  Max number of sessions = %d\n",
+                       init_params.max_nb_sessions);
+
+       return cryptodev_zuc_create(name, &init_params);
+}
+
+static int
+cryptodev_zuc_uninit(const char *name)
+{
+       if (name == NULL)
+               return -EINVAL;
+
+       RTE_LOG(INFO, PMD, "Closing ZUC crypto device %s"
+                       " on numa socket %u\n",
+                       name, rte_socket_id());
+
+       return 0;
+}
+
+static struct rte_vdev_driver cryptodev_zuc_pmd_drv = {
+       .probe = cryptodev_zuc_init,
+       .remove = cryptodev_zuc_uninit
+};
+
+DRIVER_REGISTER_VDEV(CRYPTODEV_NAME_ZUC_PMD, cryptodev_zuc_pmd_drv);
+DRIVER_REGISTER_PARAM_STRING(CRYPTODEV_NAME_ZUC_PMD,
+       "max_nb_queue_pairs=<int> "
+       "max_nb_sessions=<int> "
+       "socket_id=<int>");
diff --git a/drivers/crypto/zuc/rte_zuc_pmd_ops.c b/drivers/crypto/zuc/rte_zuc_pmd_ops.c
new file mode 100644 (file)
index 0000000..2c886d5
--- /dev/null
@@ -0,0 +1,342 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2016 Intel Corporation. All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <string.h>
+
+#include <rte_common.h>
+#include <rte_malloc.h>
+#include <rte_cryptodev_pmd.h>
+
+#include "rte_zuc_pmd_private.h"
+
+static const struct rte_cryptodev_capabilities zuc_pmd_capabilities[] = {
+       {       /* ZUC (EIA3) */
+               .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
+               {.sym = {
+                       .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
+                       {.auth = {
+                               .algo = RTE_CRYPTO_AUTH_ZUC_EIA3,
+                               .block_size = 16,
+                               .key_size = {
+                                       .min = 16,
+                                       .max = 16,
+                                       .increment = 0
+                               },
+                               .digest_size = {
+                                       .min = 4,
+                                       .max = 4,
+                                       .increment = 0
+                               },
+                               .aad_size = {
+                                       .min = 16,
+                                       .max = 16,
+                                       .increment = 0
+                               }
+                       }, }
+               }, }
+       },
+       {       /* ZUC (EEA3) */
+               .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
+               {.sym = {
+                       .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
+                       {.cipher = {
+                               .algo = RTE_CRYPTO_CIPHER_ZUC_EEA3,
+                               .block_size = 16,
+                               .key_size = {
+                                       .min = 16,
+                                       .max = 16,
+                                       .increment = 0
+                               },
+                               .iv_size = {
+                                       .min = 16,
+                                       .max = 16,
+                                       .increment = 0
+                               }
+                       }, }
+               }, }
+       },
+       RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
+};
+
+/** Configure device */
+static int
+zuc_pmd_config(__rte_unused struct rte_cryptodev *dev)
+{
+       return 0;
+}
+
+/** Start device */
+static int
+zuc_pmd_start(__rte_unused struct rte_cryptodev *dev)
+{
+       return 0;
+}
+
+/** Stop device */
+static void
+zuc_pmd_stop(__rte_unused struct rte_cryptodev *dev)
+{
+}
+
+/** Close device */
+static int
+zuc_pmd_close(__rte_unused struct rte_cryptodev *dev)
+{
+       return 0;
+}
+
+
+/** Get device statistics */
+static void
+zuc_pmd_stats_get(struct rte_cryptodev *dev,
+               struct rte_cryptodev_stats *stats)
+{
+       int qp_id;
+
+       for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
+               struct zuc_qp *qp = dev->data->queue_pairs[qp_id];
+
+               stats->enqueued_count += qp->qp_stats.enqueued_count;
+               stats->dequeued_count += qp->qp_stats.dequeued_count;
+
+               stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
+               stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
+       }
+}
+
+/** Reset device statistics */
+static void
+zuc_pmd_stats_reset(struct rte_cryptodev *dev)
+{
+       int qp_id;
+
+       for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
+               struct zuc_qp *qp = dev->data->queue_pairs[qp_id];
+
+               memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
+       }
+}
+
+
+/** Get device info */
+static void
+zuc_pmd_info_get(struct rte_cryptodev *dev,
+               struct rte_cryptodev_info *dev_info)
+{
+       struct zuc_private *internals = dev->data->dev_private;
+
+       if (dev_info != NULL) {
+               dev_info->dev_type = dev->dev_type;
+               dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
+               dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
+               dev_info->feature_flags = dev->feature_flags;
+               dev_info->capabilities = zuc_pmd_capabilities;
+       }
+}
+
+/** Release queue pair */
+static int
+zuc_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
+{
+       if (dev->data->queue_pairs[qp_id] != NULL) {
+               rte_free(dev->data->queue_pairs[qp_id]);
+               dev->data->queue_pairs[qp_id] = NULL;
+       }
+       return 0;
+}
+
+/** set a unique name for the queue pair based on its name, dev_id and qp_id */
+static int
+zuc_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
+               struct zuc_qp *qp)
+{
+       unsigned n = snprintf(qp->name, sizeof(qp->name),
+                       "zuc_pmd_%u_qp_%u",
+                       dev->data->dev_id, qp->id);
+
+       if (n > sizeof(qp->name))
+               return -1;
+
+       return 0;
+}
+
+/** Create a ring to place processed ops on */
+static struct rte_ring *
+zuc_pmd_qp_create_processed_ops_ring(struct zuc_qp *qp,
+               unsigned ring_size, int socket_id)
+{
+       struct rte_ring *r;
+
+       r = rte_ring_lookup(qp->name);
+       if (r) {
+               if (r->prod.size >= ring_size) {
+                       ZUC_LOG_INFO("Reusing existing ring %s"
+                                       " for processed packets",
+                                        qp->name);
+                       return r;
+               }
+
+               ZUC_LOG_ERR("Unable to reuse existing ring %s"
+                               " for processed packets",
+                                qp->name);
+               return NULL;
+       }
+
+       return rte_ring_create(qp->name, ring_size, socket_id,
+                       RING_F_SP_ENQ | RING_F_SC_DEQ);
+}
+
+/** Setup a queue pair */
+static int
+zuc_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
+               const struct rte_cryptodev_qp_conf *qp_conf,
+                int socket_id)
+{
+       struct zuc_qp *qp = NULL;
+
+       /* Free memory prior to re-allocation if needed. */
+       if (dev->data->queue_pairs[qp_id] != NULL)
+               zuc_pmd_qp_release(dev, qp_id);
+
+       /* Allocate the queue pair data structure. */
+       qp = rte_zmalloc_socket("ZUC PMD Queue Pair", sizeof(*qp),
+                                       RTE_CACHE_LINE_SIZE, socket_id);
+       if (qp == NULL)
+               return (-ENOMEM);
+
+       qp->id = qp_id;
+       dev->data->queue_pairs[qp_id] = qp;
+
+       if (zuc_pmd_qp_set_unique_name(dev, qp))
+               goto qp_setup_cleanup;
+
+       qp->processed_ops = zuc_pmd_qp_create_processed_ops_ring(qp,
+                       qp_conf->nb_descriptors, socket_id);
+       if (qp->processed_ops == NULL)
+               goto qp_setup_cleanup;
+
+       qp->sess_mp = dev->data->session_pool;
+
+       memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
+
+       return 0;
+
+qp_setup_cleanup:
+       if (qp)
+               rte_free(qp);
+
+       return -1;
+}
+
+/** Start queue pair */
+static int
+zuc_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
+               __rte_unused uint16_t queue_pair_id)
+{
+       return -ENOTSUP;
+}
+
+/** Stop queue pair */
+static int
+zuc_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
+               __rte_unused uint16_t queue_pair_id)
+{
+       return -ENOTSUP;
+}
+
+/** Return the number of allocated queue pairs */
+static uint32_t
+zuc_pmd_qp_count(struct rte_cryptodev *dev)
+{
+       return dev->data->nb_queue_pairs;
+}
+
+/** Returns the size of the ZUC session structure */
+static unsigned
+zuc_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
+{
+       return sizeof(struct zuc_session);
+}
+
+/** Configure a ZUC session from a crypto xform chain */
+static void *
+zuc_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
+               struct rte_crypto_sym_xform *xform,     void *sess)
+{
+       if (unlikely(sess == NULL)) {
+               ZUC_LOG_ERR("invalid session struct");
+               return NULL;
+       }
+
+       if (zuc_set_session_parameters(sess, xform) != 0) {
+               ZUC_LOG_ERR("failed configure session parameters");
+               return NULL;
+       }
+
+       return sess;
+}
+
+/** Clear the memory of session so it doesn't leave key material behind */
+static void
+zuc_pmd_session_clear(struct rte_cryptodev *dev __rte_unused, void *sess)
+{
+       /*
+        * Current just resetting the whole data structure, need to investigate
+        * whether a more selective reset of key would be more performant
+        */
+       if (sess)
+               memset(sess, 0, sizeof(struct zuc_session));
+}
+
+struct rte_cryptodev_ops zuc_pmd_ops = {
+               .dev_configure      = zuc_pmd_config,
+               .dev_start          = zuc_pmd_start,
+               .dev_stop           = zuc_pmd_stop,
+               .dev_close          = zuc_pmd_close,
+
+               .stats_get          = zuc_pmd_stats_get,
+               .stats_reset        = zuc_pmd_stats_reset,
+
+               .dev_infos_get      = zuc_pmd_info_get,
+
+               .queue_pair_setup   = zuc_pmd_qp_setup,
+               .queue_pair_release = zuc_pmd_qp_release,
+               .queue_pair_start   = zuc_pmd_qp_start,
+               .queue_pair_stop    = zuc_pmd_qp_stop,
+               .queue_pair_count   = zuc_pmd_qp_count,
+
+               .session_get_size   = zuc_pmd_session_get_size,
+               .session_configure  = zuc_pmd_session_configure,
+               .session_clear      = zuc_pmd_session_clear
+};
+
+struct rte_cryptodev_ops *rte_zuc_pmd_ops = &zuc_pmd_ops;
diff --git a/drivers/crypto/zuc/rte_zuc_pmd_private.h b/drivers/crypto/zuc/rte_zuc_pmd_private.h
new file mode 100644 (file)
index 0000000..030f120
--- /dev/null
@@ -0,0 +1,108 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2016 Intel Corporation. All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _RTE_ZUC_PMD_PRIVATE_H_
+#define _RTE_ZUC_PMD_PRIVATE_H_
+
+#include <sso_zuc.h>
+
+#define ZUC_LOG_ERR(fmt, args...) \
+       RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
+                       RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
+                       __func__, __LINE__, ## args)
+
+#ifdef RTE_LIBRTE_ZUC_DEBUG
+#define ZUC_LOG_INFO(fmt, args...) \
+       RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
+                       RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
+                       __func__, __LINE__, ## args)
+
+#define ZUC_LOG_DBG(fmt, args...) \
+       RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
+                       RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
+                       __func__, __LINE__, ## args)
+#else
+#define ZUC_LOG_INFO(fmt, args...)
+#define ZUC_LOG_DBG(fmt, args...)
+#endif
+
+#define ZUC_IV_KEY_LENGTH 16
+/** private data structure for each virtual ZUC device */
+struct zuc_private {
+       unsigned max_nb_queue_pairs;
+       /**< Max number of queue pairs supported by device */
+       unsigned max_nb_sessions;
+       /**< Max number of sessions supported by device */
+};
+
+/** ZUC buffer queue pair */
+struct zuc_qp {
+       uint16_t id;
+       /**< Queue Pair Identifier */
+       char name[RTE_CRYPTODEV_NAME_LEN];
+       /**< Unique Queue Pair Name */
+       struct rte_ring *processed_ops;
+       /**< Ring for placing processed ops */
+       struct rte_mempool *sess_mp;
+       /**< Session Mempool */
+       struct rte_cryptodev_stats qp_stats;
+       /**< Queue pair statistics */
+} __rte_cache_aligned;
+
+enum zuc_operation {
+       ZUC_OP_ONLY_CIPHER,
+       ZUC_OP_ONLY_AUTH,
+       ZUC_OP_CIPHER_AUTH,
+       ZUC_OP_AUTH_CIPHER,
+       ZUC_OP_NOT_SUPPORTED
+};
+
+/** ZUC private session structure */
+struct zuc_session {
+       enum zuc_operation op;
+       enum rte_crypto_auth_operation auth_op;
+       uint8_t pKey_cipher[ZUC_IV_KEY_LENGTH];
+       uint8_t pKey_hash[ZUC_IV_KEY_LENGTH];
+} __rte_cache_aligned;
+
+
+extern int
+zuc_set_session_parameters(struct zuc_session *sess,
+               const struct rte_crypto_sym_xform *xform);
+
+
+/** device specific operations function pointer structure */
+extern struct rte_cryptodev_ops *rte_zuc_pmd_ops;
+
+
+
+#endif /* _RTE_ZUC_PMD_PRIVATE_H_ */
index 9d678b2..693774e 100644 (file)
@@ -391,8 +391,9 @@ struct rte_crypto_sym_op {
                          * this location.
                          *
                          * @note
-                         * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2
-                         * and KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8,
+                         * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
+                         * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
+                         * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
                          * this field should be in bits.
                          */
 
@@ -416,8 +417,9 @@ struct rte_crypto_sym_op {
                          * field should be set to 0.
                          *
                          * @note
-                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2
-                         * and KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8,
+                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
+                         * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
+                         * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
                          * this field should be in bits.
                          */
                } data; /**< Data offsets and length for ciphering */
@@ -490,8 +492,9 @@ struct rte_crypto_sym_op {
                          * used instead
                          *
                          * @note
-                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2
-                         * and KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
+                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
+                         * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
+                         * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
                          * this field should be in bits.
                          */
 
@@ -510,8 +513,9 @@ struct rte_crypto_sym_op {
                          * Auth.aad.length is used instead.
                          *
                          * @note
-                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2
-                         * and KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
+                         * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
+                         * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
+                         * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
                          * this field should be in bits.
                          */
                } data; /**< Data offsets and length for authentication */
index 417e3f9..2d447e3 100644 (file)
@@ -62,6 +62,8 @@ extern "C" {
 /**< SNOW 3G PMD device name */
 #define CRYPTODEV_NAME_KASUMI_PMD      crypto_kasumi
 /**< KASUMI PMD device name */
+#define CRYPTODEV_NAME_ZUC_PMD         crypto_zuc
+/**< KASUMI PMD device name */
 
 /** Crypto device type */
 enum rte_cryptodev_type {
@@ -71,6 +73,7 @@ enum rte_cryptodev_type {
        RTE_CRYPTODEV_QAT_SYM_PMD,      /**< QAT PMD Symmetric Crypto */
        RTE_CRYPTODEV_SNOW3G_PMD,       /**< SNOW 3G PMD */
        RTE_CRYPTODEV_KASUMI_PMD,       /**< KASUMI PMD */
+       RTE_CRYPTODEV_ZUC_PMD           /**< ZUC PMD */
 };
 
 extern const char **rte_cyptodev_names;
index 56103c5..1de4ca6 100644 (file)
@@ -141,6 +141,8 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_SNOW3G)     += -lrte_pmd_snow3g
 _LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_SNOW3G)     += -L$(LIBSSO_SNOW3G_PATH)/build -lsso_snow3g
 _LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_KASUMI)     += -lrte_pmd_kasumi
 _LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_KASUMI)     += -L$(LIBSSO_KASUMI_PATH)/build -lsso_kasumi
+_LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_ZUC)        += -lrte_pmd_zuc
+_LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_ZUC)        += -L$(LIBSSO_ZUC_PATH)/build -lsso_zuc
 endif # CONFIG_RTE_LIBRTE_CRYPTODEV
 
 endif # !CONFIG_RTE_BUILD_SHARED_LIBS
index e8971fe..381d94f 100755 (executable)
@@ -48,6 +48,7 @@ default_path=$PATH
 # - DPDK_NOTIFY (notify-send)
 # - LIBSSO_SNOW3G_PATH
 # - LIBSSO_KASUMI_PATH
+# - LIBSSO_ZUC_PATH
 . $(dirname $(readlink -e $0))/load-devel-config
 
 print_usage () {
@@ -128,6 +129,7 @@ reset_env ()
        unset AESNI_MULTI_BUFFER_LIB_PATH
        unset LIBSSO_SNOW3G_PATH
        unset LIBSSO_KASUMI_PATH
+       unset LIBSSO_ZUC_PATH
        unset PQOS_INSTALL_PATH
 }
 
@@ -182,6 +184,8 @@ config () # <directory> <target> <options>
                sed -ri         's,(PMD_SNOW3G=)n,\1y,' $1/.config
                test -z "$LIBSSO_KASUMI_PATH" || \
                sed -ri         's,(PMD_KASUMI=)n,\1y,' $1/.config
+               test -z "$LIBSSO_ZUC_PATH" || \
+               sed -ri            's,(PMD_ZUC=)n,\1y,' $1/.config
                test "$DPDK_DEP_SSL" != y || \
                sed -ri            's,(PMD_QAT=)n,\1y,' $1/.config
                sed -ri        's,(KNI_VHOST.*=)n,\1y,' $1/.config