4 * Copyright(c) 2016-2017 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 #ifndef _RTE_CRYPTO_H_
34 #define _RTE_CRYPTO_H_
39 * RTE Cryptography Common Definitions
49 #include <rte_memory.h>
50 #include <rte_mempool.h>
51 #include <rte_common.h>
53 #include "rte_crypto_sym.h"
55 /** Crypto operation types */
56 enum rte_crypto_op_type {
57 RTE_CRYPTO_OP_TYPE_UNDEFINED,
58 /**< Undefined operation type */
59 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
60 /**< Symmetric operation */
63 /** Status of crypto operation */
64 enum rte_crypto_op_status {
65 RTE_CRYPTO_OP_STATUS_SUCCESS,
66 /**< Operation completed successfully */
67 RTE_CRYPTO_OP_STATUS_NOT_PROCESSED,
68 /**< Operation has not yet been processed by a crypto device */
69 RTE_CRYPTO_OP_STATUS_AUTH_FAILED,
70 /**< Authentication verification failed */
71 RTE_CRYPTO_OP_STATUS_INVALID_SESSION,
73 * Symmetric operation failed due to invalid session arguments, or if
74 * in session-less mode, failed to allocate private operation material.
76 RTE_CRYPTO_OP_STATUS_INVALID_ARGS,
77 /**< Operation failed due to invalid arguments in request */
78 RTE_CRYPTO_OP_STATUS_ERROR,
79 /**< Error handling operation */
83 * Crypto operation session type. This is used to specify whether a crypto
84 * operation has session structure attached for immutable parameters or if all
85 * operation information is included in the operation data structure.
87 enum rte_crypto_op_sess_type {
88 RTE_CRYPTO_OP_WITH_SESSION, /**< Session based crypto operation */
89 RTE_CRYPTO_OP_SESSIONLESS /**< Session-less crypto operation */
93 * Cryptographic Operation.
95 * This structure contains data relating to performing cryptographic
96 * operations. This operation structure is used to contain any operation which
97 * is supported by the cryptodev API, PMDs should check the type parameter to
98 * verify that the operation is a support function of the device. Crypto
99 * operations are enqueued and dequeued in crypto PMDs using the
100 * rte_cryptodev_enqueue_burst() / rte_cryptodev_dequeue_burst() .
102 struct rte_crypto_op {
104 /**< operation type */
107 * operation status - this is reset to
108 * RTE_CRYPTO_OP_STATUS_NOT_PROCESSED on allocation from mempool and
109 * will be set to RTE_CRYPTO_OP_STATUS_SUCCESS after crypto operation
110 * is successfully processed by a crypto PMD
113 /**< operation session type */
116 /**< Reserved bytes to fill 64 bits for future additions */
117 struct rte_mempool *mempool;
118 /**< crypto operation mempool which operation is allocated from */
120 phys_addr_t phys_addr;
121 /**< physical address of crypto operation */
125 struct rte_crypto_sym_op sym[0];
126 /**< Symmetric operation parameters */
127 }; /**< operation specific parameters */
131 * Reset the fields of a crypto operation to their default values.
133 * @param op The crypto operation to be reset.
134 * @param type The crypto operation type.
137 __rte_crypto_op_reset(struct rte_crypto_op *op, enum rte_crypto_op_type type)
140 op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
141 op->sess_type = RTE_CRYPTO_OP_SESSIONLESS;
144 case RTE_CRYPTO_OP_TYPE_SYMMETRIC:
145 __rte_crypto_sym_op_reset(op->sym);
153 * Private data structure belonging to a crypto symmetric operation pool.
155 struct rte_crypto_op_pool_private {
156 enum rte_crypto_op_type type;
157 /**< Crypto op pool type operation. */
159 /**< Size of private area in each crypto operation. */
164 * Returns the size of private data allocated with each rte_crypto_op object by
167 * @param mempool rte_crypto_op mempool
169 * @return private data size
171 static inline uint16_t
172 __rte_crypto_op_get_priv_data_size(struct rte_mempool *mempool)
174 struct rte_crypto_op_pool_private *priv =
175 (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
177 return priv->priv_size;
182 * Creates a crypto operation pool
184 * @param name pool name
185 * @param type crypto operation type, use
186 * RTE_CRYPTO_OP_TYPE_UNDEFINED for a pool which
187 * supports all operation types
188 * @param nb_elts number of elements in pool
189 * @param cache_size Number of elements to cache on lcore, see
190 * *rte_mempool_create* for further details about
192 * @param priv_size Size of private data to allocate with each
194 * @param socket_id Socket to allocate memory on
197 * - On success pointer to mempool
200 extern struct rte_mempool *
201 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
202 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
206 * Bulk allocate raw element from mempool and return as crypto operations
208 * @param mempool crypto operation mempool.
209 * @param type crypto operation type.
210 * @param ops Array to place allocated crypto operations
211 * @param nb_ops Number of crypto operations to allocate
214 * - On success returns number of ops allocated
217 __rte_crypto_op_raw_bulk_alloc(struct rte_mempool *mempool,
218 enum rte_crypto_op_type type,
219 struct rte_crypto_op **ops, uint16_t nb_ops)
221 struct rte_crypto_op_pool_private *priv;
223 priv = (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
224 if (unlikely(priv->type != type &&
225 priv->type != RTE_CRYPTO_OP_TYPE_UNDEFINED))
228 if (rte_mempool_get_bulk(mempool, (void **)ops, nb_ops) == 0)
235 * Allocate a crypto operation from a mempool with default parameters set
237 * @param mempool crypto operation mempool
238 * @param type operation type to allocate
241 * - On success returns a valid rte_crypto_op structure
242 * - On failure returns NULL
244 static inline struct rte_crypto_op *
245 rte_crypto_op_alloc(struct rte_mempool *mempool, enum rte_crypto_op_type type)
247 struct rte_crypto_op *op = NULL;
250 retval = __rte_crypto_op_raw_bulk_alloc(mempool, type, &op, 1);
251 if (unlikely(retval != 1))
254 __rte_crypto_op_reset(op, type);
261 * Bulk allocate crypto operations from a mempool with default parameters set
263 * @param mempool crypto operation mempool
264 * @param type operation type to allocate
265 * @param ops Array to place allocated crypto operations
266 * @param nb_ops Number of crypto operations to allocate
269 * - nb_ops if the number of operations requested were allocated.
270 * - 0 if the requested number of ops are not available.
271 * None are allocated in this case.
274 static inline unsigned
275 rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
276 enum rte_crypto_op_type type,
277 struct rte_crypto_op **ops, uint16_t nb_ops)
281 if (unlikely(__rte_crypto_op_raw_bulk_alloc(mempool, type, ops, nb_ops)
285 for (i = 0; i < nb_ops; i++)
286 __rte_crypto_op_reset(ops[i], type);
294 * Returns a pointer to the private data of a crypto operation if
295 * that operation has enough capacity for requested size.
297 * @param op crypto operation.
298 * @param size size of space requested in private data.
301 * - if sufficient space available returns pointer to start of private data
302 * - if insufficient space returns NULL
305 __rte_crypto_op_get_priv_data(struct rte_crypto_op *op, uint32_t size)
309 if (likely(op->mempool != NULL)) {
310 priv_size = __rte_crypto_op_get_priv_data_size(op->mempool);
312 if (likely(priv_size >= size))
313 return (void *)((uint8_t *)(op + 1) +
314 sizeof(struct rte_crypto_sym_op));
321 * free crypto operation structure
322 * If operation has been allocate from a rte_mempool, then the operation will
323 * be returned to the mempool.
325 * @param op symmetric crypto operation
328 rte_crypto_op_free(struct rte_crypto_op *op)
330 if (op != NULL && op->mempool != NULL)
331 rte_mempool_put(op->mempool, op);
335 * Allocate a symmetric crypto operation in the private data of an mbuf.
337 * @param m mbuf which is associated with the crypto operation, the
338 * operation will be allocated in the private data of that
342 * - On success returns a pointer to the crypto operation.
343 * - On failure returns NULL.
345 static inline struct rte_crypto_op *
346 rte_crypto_sym_op_alloc_from_mbuf_priv_data(struct rte_mbuf *m)
348 if (unlikely(m == NULL))
352 * check that the mbuf's private data size is sufficient to contain a
355 if (unlikely(m->priv_size < (sizeof(struct rte_crypto_op) +
356 sizeof(struct rte_crypto_sym_op))))
359 /* private data starts immediately after the mbuf header in the mbuf. */
360 struct rte_crypto_op *op = (struct rte_crypto_op *)(m + 1);
362 __rte_crypto_op_reset(op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
371 * Allocate space for symmetric crypto xforms in the private data space of the
372 * crypto operation. This also defaults the crypto xform type and configures
373 * the chaining of the xforms in the crypto operation
376 * - On success returns pointer to first crypto xform in crypto operations chain
377 * - On failure returns NULL
379 static inline struct rte_crypto_sym_xform *
380 rte_crypto_op_sym_xforms_alloc(struct rte_crypto_op *op, uint8_t nb_xforms)
385 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
388 size = sizeof(struct rte_crypto_sym_xform) * nb_xforms;
390 priv_data = __rte_crypto_op_get_priv_data(op, size);
391 if (priv_data == NULL)
394 return __rte_crypto_sym_op_sym_xforms_alloc(op->sym, priv_data,
400 * Attach a session to a crypto operation
402 * @param op crypto operation, must be of type symmetric
403 * @param sess cryptodev session
406 rte_crypto_op_attach_sym_session(struct rte_crypto_op *op,
407 struct rte_cryptodev_sym_session *sess)
409 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
412 op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;
414 return __rte_crypto_sym_op_attach_sym_session(op->sym, sess);
421 #endif /* _RTE_CRYPTO_H_ */