From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 02A6DA0524; Sun, 14 Mar 2021 13:18:37 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6FAC3160795; Sun, 14 Mar 2021 13:18:37 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 7A7BC40138 for ; Sun, 14 Mar 2021 13:18:35 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from matan@nvidia.com) with SMTP; 14 Mar 2021 14:18:31 +0200 Received: from pegasus25.mtr.labs.mlnx. (pegasus25.mtr.labs.mlnx [10.210.16.10]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 12ECIVsI004492; Sun, 14 Mar 2021 14:18:31 +0200 From: Matan Azrad To: dev@dpdk.org Cc: akhil.goyal@nxp.com, Declan Doherty , Somalapuram Amaranath , Ruifeng Wang , Ajit Khaparde , Anoob Joseph , Fan Zhang , John Griffin , Pablo de Lara , Michael Shamis , Nagadheeraj Rottela , Ankur Dwivedi , Gagandeep Singh , Jay Zhou , ArkadiuszX Kusztal , sashakot@nvidia.com, oren@nvidia.com, Shiri Kuzin Date: Sun, 14 Mar 2021 12:18:03 +0000 Message-Id: <1615724283-26149-1-git-send-email-matan@nvidia.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1612449252-395208-1-git-send-email-matan@nvidia.com> References: <1612449252-395208-1-git-send-email-matan@nvidia.com> Subject: [dpdk-dev] [PATCH] cryptodev: support multiple cipher data-units X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" In cryptography, a block cipher is a deterministic algorithm operating on fixed-length groups of bits, called blocks. A block cipher consists of two paired algorithms, one for encryption and the other for decryption. Both algorithms accept two inputs: an input block of size n bits and a key of size k bits; and both yield an n-bit output block. The decryption algorithm is defined to be the inverse function of the encryption. For AES standard the block size is 16 bytes. For AES in XTS mode, the data to be encrypted\decrypted does not have to be multiple of 16B size, the unit of data is called data-unit. The data-unit size can be any size in range [16B, 2^24B], so, in this case, a data stream is divided into N amount of equal data-units and must be encrypted\decrypted in the same data-unit resolution. The current cryptodev API doesn't allow the user to select a specific data-unit length supported by the devices. In addition, there is no definition how the IV is detected per data-unit when single operation includes more than one data-unit. That causes applications to use single operation per data-unit even though all the data is continuous in memory what reduces datapath performance. Add a new feature flag to support multiple data-unit sizes, called RTE_CRYPTODEV_FF_CIPHER_MULITPLE_DATA_UNITS. Add a new field in cipher capability, called dataunit_set, where the devices can report the range of the supported data-unit sizes. Add a new cipher transformation field, called dataunit_len, where the user can select the data-unit length for all the operations. All the new fields do not change the size of their structures. Using a bitmap to report the supported data-unit sizes capability allows the devices to report a range simply as same as the user to read it simply. also, thus sizes are usually common and probably will be shared among different devices. Signed-off-by: Matan Azrad --- First patch on it was sent as RFC. This is first formal version, I updated according to comments on RFC discussions: - Use data-unit term instead of block. - Update cipher length description in OP. - Improve descriptions on xform and capability. - Improve commit log. You welcome to comment more. Please pay attention that a new fields was added in non-experimental structures but thier sizes hasn't changed. doc/guides/cryptodevs/features/default.ini | 1 + doc/guides/cryptodevs/overview.rst | 3 +++ doc/guides/rel_notes/release_21_05.rst | 6 ++++++ lib/librte_cryptodev/rte_crypto_sym.h | 17 +++++++++++++++-- lib/librte_cryptodev/rte_cryptodev.c | 2 ++ lib/librte_cryptodev/rte_cryptodev.h | 18 ++++++++++++++++++ 6 files changed, 45 insertions(+), 2 deletions(-) diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini index 17b177f..978bb30 100644 --- a/doc/guides/cryptodevs/features/default.ini +++ b/doc/guides/cryptodevs/features/default.ini @@ -31,6 +31,7 @@ CPU crypto = Symmetric sessionless = Non-Byte aligned data = Sym raw data path API = +Cipher multiple data units = ; ; Supported crypto algorithms of a default crypto driver. diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst index e2a1e08..0597d25 100644 --- a/doc/guides/cryptodevs/overview.rst +++ b/doc/guides/cryptodevs/overview.rst @@ -46,6 +46,9 @@ Supported Feature Flags - "Digest encrypted" feature flag means PMD support hash-cipher cases, where generated digest is appended to and encrypted with the data. + - "CIPHER_MULITPLE_DATA_UNITS" feature flag means PMD support operations + on multiple data-units message. + Supported Cipher Algorithms --------------------------- diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst index 88e7607..e4e41df 100644 --- a/doc/guides/rel_notes/release_21_05.rst +++ b/doc/guides/rel_notes/release_21_05.rst @@ -91,6 +91,12 @@ New Features * Added a command line option to configure forced speed for Ethernet port. ``dpdk-testpmd -c 0xff -- -i --eth-link-speed N`` +* **Added feature to support multiple data-units on cryptodev library API.** + + The Cryptodev library has been enhanced to allow operations on multiple + data-units for AES-XTS algorithm, the data-unit length should be set in the + transformation. A capability for it was added too. + Removed Items ------------- diff --git a/lib/librte_cryptodev/rte_crypto_sym.h b/lib/librte_cryptodev/rte_crypto_sym.h index 9d572ec..6a07666 100644 --- a/lib/librte_cryptodev/rte_crypto_sym.h +++ b/lib/librte_cryptodev/rte_crypto_sym.h @@ -265,6 +265,18 @@ struct rte_crypto_cipher_xform { * which can be in the range 7 to 13 inclusive. */ } iv; /**< Initialisation vector parameters */ + + uint32_t dataunit_len; + /**< When RTE_CRYPTODEV_FF_CIPHER_MULITPLE_DATA_UNITS is enabled, + * this is the data-unit length of the algorithm, otherwise or when the + * value is 0, use the operation length. + * The value should be in the range defined by the dataunit_set field + * in the cipher capability. + * + * - For AES-XTS it is the size of data-unit, from IEEE Std 1619-2007. + * For-each data-unit in the operation, the tweak(IV) value is + * assigned consecutively starting from the operation assigned IV. + */ }; /** Symmetric Authentication / Hash Algorithms @@ -701,9 +713,10 @@ struct rte_crypto_sym_op { /**< The message length, in bytes, of the * source buffer on which the cryptographic * operation will be computed. + * This is also the same as the result length. * This must be a multiple of the block size - * if a block cipher is being used. This is - * also the same as the result length. + * or a multiple of data-unit length as + * described in xform. * * @note * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2, diff --git a/lib/librte_cryptodev/rte_cryptodev.c b/lib/librte_cryptodev/rte_cryptodev.c index 40f55a3..51f8448 100644 --- a/lib/librte_cryptodev/rte_cryptodev.c +++ b/lib/librte_cryptodev/rte_cryptodev.c @@ -617,6 +617,8 @@ struct rte_cryptodev_sym_session_pool_private_data { return "SYM_SESSIONLESS"; case RTE_CRYPTODEV_FF_NON_BYTE_ALIGNED_DATA: return "NON_BYTE_ALIGNED_DATA"; + case RTE_CRYPTODEV_FF_CIPHER_MULITPLE_DATA_UNITS: + return "CIPHER_MULITPLE_DATA_UNITS"; default: return NULL; } diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h index ae34f33..cd914ff 100644 --- a/lib/librte_cryptodev/rte_cryptodev.h +++ b/lib/librte_cryptodev/rte_cryptodev.h @@ -96,6 +96,17 @@ struct rte_crypto_param_range { }; /** + * Data-unit lengths of cipher algorithms, each bit represents single or + * range of data-unit lengths + */ +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_512_BYTES (1 << 0) +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_520_BYTES (1 << 1) +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4048_BYTES (1 << 2) +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4096_BYTES (1 << 3) +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4160_BYTES (1 << 4) +#define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_1M_BYTES (1 << 5) + +/** * Symmetric Crypto Capability */ struct rte_cryptodev_symmetric_capability { @@ -127,6 +138,11 @@ struct rte_cryptodev_symmetric_capability { /**< cipher key size range */ struct rte_crypto_param_range iv_size; /**< Initialisation vector data size range */ + uint32_t dataunit_set; + /**< + * A bitmap for a set of the supported data-unit lengths + * 0 for any defined length in the algorithm standard + */ } cipher; /**< Symmetric Cipher transform capabilities */ struct { @@ -461,6 +477,8 @@ struct rte_cryptodev_asym_capability_idx { /**< Support operations on data which is not byte aligned */ #define RTE_CRYPTODEV_FF_SYM_RAW_DP (1ULL << 24) /**< Support accelerator specific symmetric raw data-path APIs */ +#define RTE_CRYPTODEV_FF_CIPHER_MULITPLE_DATA_UNITS (1ULL << 25) +/**< Support operations on multiple data-units data */ /** * Get the name of a crypto device feature flag -- 1.8.3.1