2 Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions
8 * Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 * Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in
12 the documentation and/or other materials provided with the
14 * Neither the name of Intel Corporation nor the names of its
15 contributors may be used to endorse or promote products derived
16 from this software without specific prior written permission.
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 Cryptography Device Library
32 ===========================
34 The cryptodev library provides a Crypto device framework for management and
35 provisioning of hardware and software Crypto poll mode drivers, defining generic
36 APIs which support a number of different Crypto operations. The framework
37 currently only supports cipher, authentication, chained cipher/authentication
38 and AEAD symmetric Crypto operations.
44 The cryptodev library follows the same basic principles as those used in DPDKs
45 Ethernet Device framework. The Crypto framework provides a generic Crypto device
46 framework which supports both physical (hardware) and virtual (software) Crypto
47 devices as well as a generic Crypto API which allows Crypto devices to be
48 managed and configured and supports Crypto operations to be provisioned on
49 Crypto poll mode driver.
58 Physical Crypto devices are discovered during the PCI probe/enumeration of the
59 EAL function which is executed at DPDK initialization, based on
60 their PCI device identifier, each unique PCI BDF (bus/bridge, device,
61 function). Specific physical Crypto devices, like other physical devices in DPDK
62 can be white-listed or black-listed using the EAL command line options.
64 Virtual devices can be created by two mechanisms, either using the EAL command
65 line options or from within the application using an EAL API directly.
67 From the command line using the --vdev EAL option
69 .. code-block:: console
71 --vdev 'crypto_aesni_mb0,max_nb_queue_pairs=2,max_nb_sessions=1024,socket_id=0'
73 Our using the rte_vdev_init API within the application code.
77 rte_vdev_init("crypto_aesni_mb",
78 "max_nb_queue_pairs=2,max_nb_sessions=1024,socket_id=0")
80 All virtual Crypto devices support the following initialization parameters:
82 * ``max_nb_queue_pairs`` - maximum number of queue pairs supported by the device.
83 * ``max_nb_sessions`` - maximum number of sessions supported by the device
84 * ``socket_id`` - socket on which to allocate the device resources on.
90 Each device, whether virtual or physical is uniquely designated by two
93 - A unique device index used to designate the Crypto device in all functions
94 exported by the cryptodev API.
96 - A device name used to designate the Crypto device in console messages, for
97 administration or debugging purposes. For ease of use, the port name includes
104 The configuration of each Crypto device includes the following operations:
106 - Allocation of resources, including hardware resources if a physical device.
107 - Resetting the device into a well-known default state.
108 - Initialization of statistics counters.
110 The rte_cryptodev_configure API is used to configure a Crypto device.
114 int rte_cryptodev_configure(uint8_t dev_id,
115 struct rte_cryptodev_config *config)
117 The ``rte_cryptodev_config`` structure is used to pass the configuration
118 parameters for socket selection and number of queue pairs.
122 struct rte_cryptodev_config {
124 /**< Socket to allocate resources on */
125 uint16_t nb_queue_pairs;
126 /**< Number of queue pairs to configure on device */
130 Configuration of Queue Pairs
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 Each Crypto devices queue pair is individually configured through the
134 ``rte_cryptodev_queue_pair_setup`` API.
135 Each queue pairs resources may be allocated on a specified socket.
139 int rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
140 const struct rte_cryptodev_qp_conf *qp_conf,
143 struct rte_cryptodev_qp_conf {
144 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
148 Logical Cores, Memory and Queues Pair Relationships
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 The Crypto device Library as the Poll Mode Driver library support NUMA for when
152 a processor’s logical cores and interfaces utilize its local memory. Therefore
153 Crypto operations, and in the case of symmetric Crypto operations, the session
154 and the mbuf being operated on, should be allocated from memory pools created
155 in the local memory. The buffers should, if possible, remain on the local
156 processor to obtain the best performance results and buffer descriptors should
157 be populated with mbufs allocated from a mempool allocated from local memory.
159 The run-to-completion model also performs better, especially in the case of
160 virtual Crypto devices, if the Crypto operation and session and data buffer is
161 in local memory instead of a remote processor's memory. This is also true for
162 the pipe-line model provided all logical cores used are located on the same
165 Multiple logical cores should never share the same queue pair for enqueuing
166 operations or dequeuing operations on the same Crypto device since this would
167 require global locks and hinder performance. It is however possible to use a
168 different logical core to dequeue an operation on a queue pair from the logical
169 core which it was enqueued on. This means that a crypto burst enqueue/dequeue
170 APIs are a logical place to transition from one logical core to another in a
171 packet processing pipeline.
174 Device Features and Capabilities
175 ---------------------------------
177 Crypto devices define their functionality through two mechanisms, global device
178 features and algorithm capabilities. Global devices features identify device
179 wide level features which are applicable to the whole device such as
180 the device having hardware acceleration or supporting symmetric Crypto
183 The capabilities mechanism defines the individual algorithms/functions which
184 the device supports, such as a specific symmetric Crypto cipher,
185 authentication operation or Authenticated Encryption with Associated Data
192 Currently the following Crypto device features are defined:
194 * Symmetric Crypto operations
195 * Asymmetric Crypto operations
196 * Chaining of symmetric Crypto operations
197 * SSE accelerated SIMD vector operations
198 * AVX accelerated SIMD vector operations
199 * AVX2 accelerated SIMD vector operations
200 * AESNI accelerated instructions
201 * Hardware off-load processing
204 Device Operation Capabilities
205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
207 Crypto capabilities which identify particular algorithm which the Crypto PMD
208 supports are defined by the operation type, the operation transform, the
209 transform identifier and then the particulars of the transform. For the full
210 scope of the Crypto capability see the definition of the structure in the
211 *DPDK API Reference*.
215 struct rte_cryptodev_capabilities;
217 Each Crypto poll mode driver defines its own private array of capabilities
218 for the operations it supports. Below is an example of the capabilities for a
219 PMD which supports the authentication algorithm SHA1_HMAC and the cipher
224 static const struct rte_cryptodev_capabilities pmd_capabilities[] = {
226 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
228 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
230 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
248 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
250 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
252 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
270 Capabilities Discovery
271 ~~~~~~~~~~~~~~~~~~~~~~
273 Discovering the features and capabilities of a Crypto device poll mode driver
274 is achieved through the ``rte_cryptodev_info_get`` function.
278 void rte_cryptodev_info_get(uint8_t dev_id,
279 struct rte_cryptodev_info *dev_info);
281 This allows the user to query a specific Crypto PMD and get all the device
282 features and capabilities. The ``rte_cryptodev_info`` structure contains all the
283 relevant information for the device.
287 struct rte_cryptodev_info {
288 const char *driver_name;
290 struct rte_pci_device *pci_dev;
292 uint64_t feature_flags;
294 const struct rte_cryptodev_capabilities *capabilities;
296 unsigned max_nb_queue_pairs;
299 unsigned max_nb_sessions;
307 Scheduling of Crypto operations on DPDK's application data path is
308 performed using a burst oriented asynchronous API set. A queue pair on a Crypto
309 device accepts a burst of Crypto operations using enqueue burst API. On physical
310 Crypto devices the enqueue burst API will place the operations to be processed
311 on the devices hardware input queue, for virtual devices the processing of the
312 Crypto operations is usually completed during the enqueue call to the Crypto
313 device. The dequeue burst API will retrieve any processed operations available
314 from the queue pair on the Crypto device, from physical devices this is usually
315 directly from the devices processed queue, and for virtual device's from a
316 ``rte_ring`` where processed operations are place after being processed on the
320 Enqueue / Dequeue Burst APIs
321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323 The burst enqueue API uses a Crypto device identifier and a queue pair
324 identifier to specify the Crypto device queue pair to schedule the processing on.
325 The ``nb_ops`` parameter is the number of operations to process which are
326 supplied in the ``ops`` array of ``rte_crypto_op`` structures.
327 The enqueue function returns the number of operations it actually enqueued for
328 processing, a return value equal to ``nb_ops`` means that all packets have been
333 uint16_t rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
334 struct rte_crypto_op **ops, uint16_t nb_ops)
336 The dequeue API uses the same format as the enqueue API of processed but
337 the ``nb_ops`` and ``ops`` parameters are now used to specify the max processed
338 operations the user wishes to retrieve and the location in which to store them.
339 The API call returns the actual number of processed operations returned, this
340 can never be larger than ``nb_ops``.
344 uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
345 struct rte_crypto_op **ops, uint16_t nb_ops)
348 Operation Representation
349 ~~~~~~~~~~~~~~~~~~~~~~~~
351 An Crypto operation is represented by an rte_crypto_op structure, which is a
352 generic metadata container for all necessary information required for the
353 Crypto operation to be processed on a particular Crypto device poll mode driver.
355 .. figure:: img/crypto_op.*
357 The operation structure includes the operation type, the operation status
358 and the session type (session-based/less), a reference to the operation
359 specific data, which can vary in size and content depending on the operation
360 being provisioned. It also contains the source mempool for the operation,
361 if it allocated from a mempool.
363 If Crypto operations are allocated from a Crypto operation mempool, see next
364 section, there is also the ability to allocate private memory with the
365 operation for applications purposes.
367 Application software is responsible for specifying all the operation specific
368 fields in the ``rte_crypto_op`` structure which are then used by the Crypto PMD
369 to process the requested operation.
372 Operation Management and Allocation
373 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
375 The cryptodev library provides an API set for managing Crypto operations which
376 utilize the Mempool Library to allocate operation buffers. Therefore, it ensures
377 that the crytpo operation is interleaved optimally across the channels and
378 ranks for optimal processing.
379 A ``rte_crypto_op`` contains a field indicating the pool that it originated from.
380 When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool.
384 extern struct rte_mempool *
385 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
386 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
389 During pool creation ``rte_crypto_op_init()`` is called as a constructor to
390 initialize each Crypto operation which subsequently calls
391 ``__rte_crypto_op_reset()`` to configure any operation type specific fields based
392 on the type parameter.
395 ``rte_crypto_op_alloc()`` and ``rte_crypto_op_bulk_alloc()`` are used to allocate
396 Crypto operations of a specific type from a given Crypto operation mempool.
397 ``__rte_crypto_op_reset()`` is called on each operation before being returned to
398 allocate to a user so the operation is always in a good known state before use
403 struct rte_crypto_op *rte_crypto_op_alloc(struct rte_mempool *mempool,
404 enum rte_crypto_op_type type)
406 unsigned rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
407 enum rte_crypto_op_type type,
408 struct rte_crypto_op **ops, uint16_t nb_ops)
410 ``rte_crypto_op_free()`` is called by the application to return an operation to
415 void rte_crypto_op_free(struct rte_crypto_op *op)
418 Symmetric Cryptography Support
419 ------------------------------
421 The cryptodev library currently provides support for the following symmetric
422 Crypto operations; cipher, authentication, including chaining of these
423 operations, as well as also supporting AEAD operations.
426 Session and Session Management
428 Sessions are used in symmetric cryptographic processing to store the immutable
429 data defined in a cryptographic transform which is used in the operation
430 processing of a packet flow. Sessions are used to manage information such as
431 expand cipher keys and HMAC IPADs and OPADs, which need to be calculated for a
432 particular Crypto operation, but are immutable on a packet to packet basis for
433 a flow. Crypto sessions cache this immutable data in a optimal way for the
434 underlying PMD and this allows further acceleration of the offload of
437 .. figure:: img/cryptodev_sym_sess.*
439 The Crypto device framework provides APIs to allocate and initizalize sessions
440 for crypto devices, where sessions are mempool objects.
441 It is the application's responsibility to create and manage the session mempools.
442 This approach allows for different scenarios such as having a single session
443 mempool for all crypto devices (where the mempool object size is big
444 enough to hold the private session of any crypto device), as well as having
445 multiple session mempools of different sizes for better memory usage.
447 An application can use ``rte_cryptodev_get_private_session_size()`` to
448 get the private session size of given crypto device. This function would allow
449 an application to calculate the max device session size of all crypto devices
450 to create a single session mempool.
451 If instead an application creates multiple session mempools, the Crypto device
452 framework also provides ``rte_cryptodev_get_header_session_size`` to get
453 the size of an uninitialized session.
455 Once the session mempools have been created, ``rte_cryptodev_sym_session_create()``
456 is used to allocate an uninitialized session from the given mempool.
457 The session then must be initialized using ``rte_cryptodev_sym_session_init()``
458 for each of the required crypto devices. A symmetric transform chain
459 is used to specify the operation and its parameters. See the section below for
460 details on transforms.
462 When a session is no longer used, user must call ``rte_cryptodev_sym_session_clear()``
463 for each of the crypto devices that are using the session, to free all driver
464 private session data. Once this is done, session should be freed using
465 ``rte_cryptodev_sym_session_free`` which returns them to their mempool.
468 Transforms and Transform Chaining
469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471 Symmetric Crypto transforms (``rte_crypto_sym_xform``) are the mechanism used
472 to specify the details of the Crypto operation. For chaining of symmetric
473 operations such as cipher encrypt and authentication generate, the next pointer
474 allows transform to be chained together. Crypto devices which support chaining
475 must publish the chaining of symmetric Crypto operations feature flag.
477 Currently there are three transforms types cipher, authentication and AEAD.
478 Also it is important to note that the order in which the
479 transforms are passed indicates the order of the chaining.
483 struct rte_crypto_sym_xform {
484 struct rte_crypto_sym_xform *next;
485 /**< next xform in chain */
486 enum rte_crypto_sym_xform_type type;
489 struct rte_crypto_auth_xform auth;
490 /**< Authentication / hash xform */
491 struct rte_crypto_cipher_xform cipher;
493 struct rte_crypto_aead_xform aead;
498 The API does not place a limit on the number of transforms that can be chained
499 together but this will be limited by the underlying Crypto device poll mode
500 driver which is processing the operation.
502 .. figure:: img/crypto_xform_chain.*
508 The symmetric Crypto operation structure contains all the mutable data relating
509 to performing symmetric cryptographic processing on a referenced mbuf data
510 buffer. It is used for either cipher, authentication, AEAD and chained
513 As a minimum the symmetric operation must have a source data buffer (``m_src``),
514 a valid session (or transform chain if in session-less mode) and the minimum
515 authentication/ cipher/ AEAD parameters required depending on the type of operation
516 specified in the session or the transform
521 struct rte_crypto_sym_op {
522 struct rte_mbuf *m_src;
523 struct rte_mbuf *m_dst;
526 struct rte_cryptodev_sym_session *session;
527 /**< Handle for the initialised session context */
528 struct rte_crypto_sym_xform *xform;
529 /**< Session-less API Crypto operation parameters */
537 } data; /**< Data offsets and length for AEAD */
541 phys_addr_t phys_addr;
542 } digest; /**< Digest parameters */
546 phys_addr_t phys_addr;
548 /**< Additional authentication parameters */
556 } data; /**< Data offsets and length for ciphering */
564 /**< Data offsets and length for authentication */
568 phys_addr_t phys_addr;
569 } digest; /**< Digest parameters */
576 Asymmetric Cryptography
577 -----------------------
579 Asymmetric functionality is currently not supported by the cryptodev API.
585 The cryptodev Library API is described in the *DPDK API Reference* document.