lib/librte_cryptodev/rte_crypto.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 Intel Corporation. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  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
  15  *       distribution.
  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.
  19  *
  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.
  31  */
  32
  33 #ifndef _RTE_CRYPTO_H_
  34 #define _RTE_CRYPTO_H_
  35
  36 /**
  37  * @file rte_crypto.h
  38  *
  39  * RTE Cryptography Common Definitions
  40  *
  41  */
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 #include <rte_mbuf.h>
  49 #include <rte_memory.h>
  50 #include <rte_mempool.h>
  51 #include <rte_common.h>
  52
  53 #include "rte_crypto_sym.h"
  54
  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 */
  61 };
  62
  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_ENQUEUED,
  70         /**< Operation is enqueued on device */
  71         RTE_CRYPTO_OP_STATUS_AUTH_FAILED,
  72         /**< Authentication verification failed */
  73         RTE_CRYPTO_OP_STATUS_INVALID_SESSION,
  74         /**<
  75          * Symmetric operation failed due to invalid session arguments, or if
  76          * in session-less mode, failed to allocate private operation material.
  77          */
  78         RTE_CRYPTO_OP_STATUS_INVALID_ARGS,
  79         /**< Operation failed due to invalid arguments in request */
  80         RTE_CRYPTO_OP_STATUS_ERROR,
  81         /**< Error handling operation */
  82 };
  83
  84 /**
  85  * Cryptographic Operation.
  86  *
  87  * This structure contains data relating to performing cryptographic
  88  * operations. This operation structure is used to contain any operation which
  89  * is supported by the cryptodev API, PMDs should check the type parameter to
  90  * verify that the operation is a support function of the device. Crypto
  91  * operations are enqueued and dequeued in crypto PMDs using the
  92  * rte_cryptodev_enqueue_burst() / rte_cryptodev_dequeue_burst() .
  93  */
  94 struct rte_crypto_op {
  95         enum rte_crypto_op_type type;
  96         /**< operation type */
  97
  98         enum rte_crypto_op_status status;
  99         /**<
 100          * operation status - this is reset to
 101          * RTE_CRYPTO_OP_STATUS_NOT_PROCESSED on allocation from mempool and
 102          * will be set to RTE_CRYPTO_OP_STATUS_SUCCESS after crypto operation
 103          * is successfully processed by a crypto PMD
 104          */
 105
 106         struct rte_mempool *mempool;
 107         /**< crypto operation mempool which operation is allocated from */
 108
 109         phys_addr_t phys_addr;
 110         /**< physical address of crypto operation */
 111
 112         void *opaque_data;
 113         /**< Opaque pointer for user data */
 114
 115         RTE_STD_C11
 116         union {
 117                 struct rte_crypto_sym_op *sym;
 118                 /**< Symmetric operation parameters */
 119         }; /**< operation specific parameters */
 120 } __rte_cache_aligned;
 121
 122 /**
 123  * Reset the fields of a crypto operation to their default values.
 124  *
 125  * @param       op      The crypto operation to be reset.
 126  * @param       type    The crypto operation type.
 127  */
 128 static inline void
 129 __rte_crypto_op_reset(struct rte_crypto_op *op, enum rte_crypto_op_type type)
 130 {
 131         op->type = type;
 132         op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
 133
 134         switch (type) {
 135         case RTE_CRYPTO_OP_TYPE_SYMMETRIC:
 136                 /** Symmetric operation structure starts after the end of the
 137                  * rte_crypto_op structure.
 138                  */
 139                 op->sym = (struct rte_crypto_sym_op *)(op + 1);
 140                 op->type = type;
 141
 142                 __rte_crypto_sym_op_reset(op->sym);
 143                 break;
 144         case RTE_CRYPTO_OP_TYPE_UNDEFINED:
 145         default:
 146                 break;
 147         }
 148
 149         op->opaque_data = NULL;
 150 }
 151
 152 /**
 153  * Private data structure belonging to a crypto symmetric operation pool.
 154  */
 155 struct rte_crypto_op_pool_private {
 156         enum rte_crypto_op_type type;
 157         /**< Crypto op pool type operation. */
 158         uint16_t priv_size;
 159         /**< Size of private area in each crypto operation. */
 160 };
 161
 162
 163 /**
 164  * Returns the size of private data allocated with each rte_crypto_op object by
 165  * the mempool
 166  *
 167  * @param       mempool rte_crypto_op mempool
 168  *
 169  * @return      private data size
 170  */
 171 static inline uint16_t
 172 __rte_crypto_op_get_priv_data_size(struct rte_mempool *mempool)
 173 {
 174         struct rte_crypto_op_pool_private *priv =
 175                 (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
 176
 177         return priv->priv_size;
 178 }
 179
 180
 181 /**
 182  * Creates a crypto operation pool
 183  *
 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
 191  *                              cache size
 192  * @param       priv_size       Size of private data to allocate with each
 193  *                              operation
 194  * @param       socket_id       Socket to allocate memory on
 195  *
 196  * @return
 197  *  - On success pointer to mempool
 198  *  - On failure NULL
 199  */
 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,
 203                 int socket_id);
 204
 205 /**
 206  * Bulk allocate raw element from mempool and return as crypto operations
 207  *
 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
 212  *
 213  * @returns
 214  * - On success returns  number of ops allocated
 215  */
 216 static inline int
 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)
 220 {
 221         struct rte_crypto_op_pool_private *priv;
 222
 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))
 226                 return -EINVAL;
 227
 228         if (rte_mempool_get_bulk(mempool, (void **)ops, nb_ops) == 0)
 229                 return nb_ops;
 230
 231         return 0;
 232 }
 233
 234 /**
 235  * Allocate a crypto operation from a mempool with default parameters set
 236  *
 237  * @param       mempool crypto operation mempool
 238  * @param       type    operation type to allocate
 239  *
 240  * @returns
 241  * - On success returns a valid rte_crypto_op structure
 242  * - On failure returns NULL
 243  */
 244 static inline struct rte_crypto_op *
 245 rte_crypto_op_alloc(struct rte_mempool *mempool, enum rte_crypto_op_type type)
 246 {
 247         struct rte_crypto_op *op = NULL;
 248         int retval;
 249
 250         retval = __rte_crypto_op_raw_bulk_alloc(mempool, type, &op, 1);
 251         if (unlikely(retval != 1))
 252                 return NULL;
 253
 254         __rte_crypto_op_reset(op, type);
 255
 256         return op;
 257 }
 258
 259
 260 /**
 261  * Bulk allocate crypto operations from a mempool with default parameters set
 262  *
 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
 267  *
 268  * @returns
 269  * - On success returns a valid rte_crypto_op structure
 270  * - On failure returns NULL
 271  */
 272
 273 static inline unsigned
 274 rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
 275                 enum rte_crypto_op_type type,
 276                 struct rte_crypto_op **ops, uint16_t nb_ops)
 277 {
 278         int i;
 279
 280         if (unlikely(__rte_crypto_op_raw_bulk_alloc(mempool, type, ops, nb_ops)
 281                         != nb_ops))
 282                 return 0;
 283
 284         for (i = 0; i < nb_ops; i++)
 285                 __rte_crypto_op_reset(ops[i], type);
 286
 287         return nb_ops;
 288 }
 289
 290
 291
 292 /**
 293  * Returns a pointer to the private data of a crypto operation if
 294  * that operation has enough capacity for requested size.
 295  *
 296  * @param       op      crypto operation.
 297  * @param       size    size of space requested in private data.
 298  *
 299  * @returns
 300  * - if sufficient space available returns pointer to start of private data
 301  * - if insufficient space returns NULL
 302  */
 303 static inline void *
 304 __rte_crypto_op_get_priv_data(struct rte_crypto_op *op, uint32_t size)
 305 {
 306         uint32_t priv_size;
 307
 308         if (likely(op->mempool != NULL)) {
 309                 priv_size = __rte_crypto_op_get_priv_data_size(op->mempool);
 310
 311                 if (likely(priv_size >= size))
 312                         return (void *)((uint8_t *)(op + 1) +
 313                                         sizeof(struct rte_crypto_sym_op));
 314         }
 315
 316         return NULL;
 317 }
 318
 319 /**
 320  * free crypto operation structure
 321  * If operation has been allocate from a rte_mempool, then the operation will
 322  * be returned to the mempool.
 323  *
 324  * @param       op      symmetric crypto operation
 325  */
 326 static inline void
 327 rte_crypto_op_free(struct rte_crypto_op *op)
 328 {
 329         if (op != NULL && op->mempool != NULL)
 330                 rte_mempool_put(op->mempool, op);
 331 }
 332
 333 /**
 334  * Allocate a symmetric crypto operation in the private data of an mbuf.
 335  *
 336  * @param       m       mbuf which is associated with the crypto operation, the
 337  *                      operation will be allocated in the private data of that
 338  *                      mbuf.
 339  *
 340  * @returns
 341  * - On success returns a pointer to the crypto operation.
 342  * - On failure returns NULL.
 343  */
 344 static inline struct rte_crypto_op *
 345 rte_crypto_sym_op_alloc_from_mbuf_priv_data(struct rte_mbuf *m)
 346 {
 347         if (unlikely(m == NULL))
 348                 return NULL;
 349
 350         /*
 351          * check that the mbuf's private data size is sufficient to contain a
 352          * crypto operation
 353          */
 354         if (unlikely(m->priv_size < (sizeof(struct rte_crypto_op) +
 355                         sizeof(struct rte_crypto_sym_op))))
 356                 return NULL;
 357
 358         /* private data starts immediately after the mbuf header in the mbuf. */
 359         struct rte_crypto_op *op = (struct rte_crypto_op *)(m + 1);
 360
 361         __rte_crypto_op_reset(op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
 362
 363         op->mempool = NULL;
 364         op->sym->m_src = m;
 365
 366         return op;
 367 }
 368
 369 /**
 370  * Allocate space for symmetric crypto xforms in the private data space of the
 371  * crypto operation. This also defaults the crypto xform type and configures
 372  * the chaining of the xforms in the crypto operation
 373  *
 374  * @return
 375  * - On success returns pointer to first crypto xform in crypto operations chain
 376  * - On failure returns NULL
 377  */
 378 static inline struct rte_crypto_sym_xform *
 379 rte_crypto_op_sym_xforms_alloc(struct rte_crypto_op *op, uint8_t nb_xforms)
 380 {
 381         void *priv_data;
 382         uint32_t size;
 383
 384         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 385                 return NULL;
 386
 387         size = sizeof(struct rte_crypto_sym_xform) * nb_xforms;
 388
 389         priv_data = __rte_crypto_op_get_priv_data(op, size);
 390         if (priv_data == NULL)
 391                 return NULL;
 392
 393         return __rte_crypto_sym_op_sym_xforms_alloc(op->sym, priv_data,
 394                         nb_xforms);
 395 }
 396
 397
 398 /**
 399  * Attach a session to a crypto operation
 400  *
 401  * @param       op      crypto operation, must be of type symmetric
 402  * @param       sess    cryptodev session
 403  */
 404 static inline int
 405 rte_crypto_op_attach_sym_session(struct rte_crypto_op *op,
 406                 struct rte_cryptodev_sym_session *sess)
 407 {
 408         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 409                 return -1;
 410
 411         return __rte_crypto_sym_op_attach_sym_session(op->sym, sess);
 412 }
 413
 414 #ifdef __cplusplus
 415 }
 416 #endif
 417
 418 #endif /* _RTE_CRYPTO_H_ */