lib/librte_cryptodev/rte_crypto.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 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  * Crypto operation session type. This is used to specify whether a crypto
  86  * operation has session structure attached for immutable parameters or if all
  87  * operation information is included in the operation data structure.
  88  */
  89 enum rte_crypto_op_sess_type {
  90         RTE_CRYPTO_OP_WITH_SESSION,     /**< Session based crypto operation */
  91         RTE_CRYPTO_OP_SESSIONLESS       /**< Session-less crypto operation */
  92 };
  93
  94 /**
  95  * Cryptographic Operation.
  96  *
  97  * This structure contains data relating to performing cryptographic
  98  * operations. This operation structure is used to contain any operation which
  99  * is supported by the cryptodev API, PMDs should check the type parameter to
 100  * verify that the operation is a support function of the device. Crypto
 101  * operations are enqueued and dequeued in crypto PMDs using the
 102  * rte_cryptodev_enqueue_burst() / rte_cryptodev_dequeue_burst() .
 103  */
 104 struct rte_crypto_op {
 105         uint8_t type;
 106         /**< operation type */
 107         uint8_t status;
 108         /**<
 109          * operation status - this is reset to
 110          * RTE_CRYPTO_OP_STATUS_NOT_PROCESSED on allocation from mempool and
 111          * will be set to RTE_CRYPTO_OP_STATUS_SUCCESS after crypto operation
 112          * is successfully processed by a crypto PMD
 113          */
 114         uint8_t sess_type;
 115         /**< operation session type */
 116
 117         uint8_t reserved[5];
 118         /**< Reserved bytes to fill 64 bits for future additions */
 119         struct rte_mempool *mempool;
 120         /**< crypto operation mempool which operation is allocated from */
 121
 122         phys_addr_t phys_addr;
 123         /**< physical address of crypto operation */
 124
 125         RTE_STD_C11
 126         union {
 127                 struct rte_crypto_sym_op sym[0];
 128                 /**< Symmetric operation parameters */
 129         }; /**< operation specific parameters */
 130 };
 131
 132 /**
 133  * Reset the fields of a crypto operation to their default values.
 134  *
 135  * @param       op      The crypto operation to be reset.
 136  * @param       type    The crypto operation type.
 137  */
 138 static inline void
 139 __rte_crypto_op_reset(struct rte_crypto_op *op, enum rte_crypto_op_type type)
 140 {
 141         op->type = type;
 142         op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
 143         op->sess_type = RTE_CRYPTO_OP_SESSIONLESS;
 144
 145         switch (type) {
 146         case RTE_CRYPTO_OP_TYPE_SYMMETRIC:
 147                 __rte_crypto_sym_op_reset(op->sym);
 148                 break;
 149         default:
 150                 break;
 151         }
 152 }
 153
 154 /**
 155  * Private data structure belonging to a crypto symmetric operation pool.
 156  */
 157 struct rte_crypto_op_pool_private {
 158         enum rte_crypto_op_type type;
 159         /**< Crypto op pool type operation. */
 160         uint16_t priv_size;
 161         /**< Size of private area in each crypto operation. */
 162 };
 163
 164
 165 /**
 166  * Returns the size of private data allocated with each rte_crypto_op object by
 167  * the mempool
 168  *
 169  * @param       mempool rte_crypto_op mempool
 170  *
 171  * @return      private data size
 172  */
 173 static inline uint16_t
 174 __rte_crypto_op_get_priv_data_size(struct rte_mempool *mempool)
 175 {
 176         struct rte_crypto_op_pool_private *priv =
 177                 (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
 178
 179         return priv->priv_size;
 180 }
 181
 182
 183 /**
 184  * Creates a crypto operation pool
 185  *
 186  * @param       name            pool name
 187  * @param       type            crypto operation type, use
 188  *                              RTE_CRYPTO_OP_TYPE_UNDEFINED for a pool which
 189  *                              supports all operation types
 190  * @param       nb_elts         number of elements in pool
 191  * @param       cache_size      Number of elements to cache on lcore, see
 192  *                              *rte_mempool_create* for further details about
 193  *                              cache size
 194  * @param       priv_size       Size of private data to allocate with each
 195  *                              operation
 196  * @param       socket_id       Socket to allocate memory on
 197  *
 198  * @return
 199  *  - On success pointer to mempool
 200  *  - On failure NULL
 201  */
 202 extern struct rte_mempool *
 203 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
 204                 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
 205                 int socket_id);
 206
 207 /**
 208  * Bulk allocate raw element from mempool and return as crypto operations
 209  *
 210  * @param       mempool         crypto operation mempool.
 211  * @param       type            crypto operation type.
 212  * @param       ops             Array to place allocated crypto operations
 213  * @param       nb_ops          Number of crypto operations to allocate
 214  *
 215  * @returns
 216  * - On success returns  number of ops allocated
 217  */
 218 static inline int
 219 __rte_crypto_op_raw_bulk_alloc(struct rte_mempool *mempool,
 220                 enum rte_crypto_op_type type,
 221                 struct rte_crypto_op **ops, uint16_t nb_ops)
 222 {
 223         struct rte_crypto_op_pool_private *priv;
 224
 225         priv = (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
 226         if (unlikely(priv->type != type &&
 227                         priv->type != RTE_CRYPTO_OP_TYPE_UNDEFINED))
 228                 return -EINVAL;
 229
 230         if (rte_mempool_get_bulk(mempool, (void **)ops, nb_ops) == 0)
 231                 return nb_ops;
 232
 233         return 0;
 234 }
 235
 236 /**
 237  * Allocate a crypto operation from a mempool with default parameters set
 238  *
 239  * @param       mempool crypto operation mempool
 240  * @param       type    operation type to allocate
 241  *
 242  * @returns
 243  * - On success returns a valid rte_crypto_op structure
 244  * - On failure returns NULL
 245  */
 246 static inline struct rte_crypto_op *
 247 rte_crypto_op_alloc(struct rte_mempool *mempool, enum rte_crypto_op_type type)
 248 {
 249         struct rte_crypto_op *op = NULL;
 250         int retval;
 251
 252         retval = __rte_crypto_op_raw_bulk_alloc(mempool, type, &op, 1);
 253         if (unlikely(retval != 1))
 254                 return NULL;
 255
 256         __rte_crypto_op_reset(op, type);
 257
 258         return op;
 259 }
 260
 261
 262 /**
 263  * Bulk allocate crypto operations from a mempool with default parameters set
 264  *
 265  * @param       mempool crypto operation mempool
 266  * @param       type    operation type to allocate
 267  * @param       ops     Array to place allocated crypto operations
 268  * @param       nb_ops  Number of crypto operations to allocate
 269  *
 270  * @returns
 271  * - On success returns a valid rte_crypto_op structure
 272  * - On failure returns NULL
 273  */
 274
 275 static inline unsigned
 276 rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
 277                 enum rte_crypto_op_type type,
 278                 struct rte_crypto_op **ops, uint16_t nb_ops)
 279 {
 280         int i;
 281
 282         if (unlikely(__rte_crypto_op_raw_bulk_alloc(mempool, type, ops, nb_ops)
 283                         != nb_ops))
 284                 return 0;
 285
 286         for (i = 0; i < nb_ops; i++)
 287                 __rte_crypto_op_reset(ops[i], type);
 288
 289         return nb_ops;
 290 }
 291
 292
 293
 294 /**
 295  * Returns a pointer to the private data of a crypto operation if
 296  * that operation has enough capacity for requested size.
 297  *
 298  * @param       op      crypto operation.
 299  * @param       size    size of space requested in private data.
 300  *
 301  * @returns
 302  * - if sufficient space available returns pointer to start of private data
 303  * - if insufficient space returns NULL
 304  */
 305 static inline void *
 306 __rte_crypto_op_get_priv_data(struct rte_crypto_op *op, uint32_t size)
 307 {
 308         uint32_t priv_size;
 309
 310         if (likely(op->mempool != NULL)) {
 311                 priv_size = __rte_crypto_op_get_priv_data_size(op->mempool);
 312
 313                 if (likely(priv_size >= size))
 314                         return (void *)((uint8_t *)(op + 1) +
 315                                         sizeof(struct rte_crypto_sym_op));
 316         }
 317
 318         return NULL;
 319 }
 320
 321 /**
 322  * free crypto operation structure
 323  * If operation has been allocate from a rte_mempool, then the operation will
 324  * be returned to the mempool.
 325  *
 326  * @param       op      symmetric crypto operation
 327  */
 328 static inline void
 329 rte_crypto_op_free(struct rte_crypto_op *op)
 330 {
 331         if (op != NULL && op->mempool != NULL)
 332                 rte_mempool_put(op->mempool, op);
 333 }
 334
 335 /**
 336  * Allocate a symmetric crypto operation in the private data of an mbuf.
 337  *
 338  * @param       m       mbuf which is associated with the crypto operation, the
 339  *                      operation will be allocated in the private data of that
 340  *                      mbuf.
 341  *
 342  * @returns
 343  * - On success returns a pointer to the crypto operation.
 344  * - On failure returns NULL.
 345  */
 346 static inline struct rte_crypto_op *
 347 rte_crypto_sym_op_alloc_from_mbuf_priv_data(struct rte_mbuf *m)
 348 {
 349         if (unlikely(m == NULL))
 350                 return NULL;
 351
 352         /*
 353          * check that the mbuf's private data size is sufficient to contain a
 354          * crypto operation
 355          */
 356         if (unlikely(m->priv_size < (sizeof(struct rte_crypto_op) +
 357                         sizeof(struct rte_crypto_sym_op))))
 358                 return NULL;
 359
 360         /* private data starts immediately after the mbuf header in the mbuf. */
 361         struct rte_crypto_op *op = (struct rte_crypto_op *)(m + 1);
 362
 363         __rte_crypto_op_reset(op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
 364
 365         op->mempool = NULL;
 366         op->sym->m_src = m;
 367
 368         return op;
 369 }
 370
 371 /**
 372  * Allocate space for symmetric crypto xforms in the private data space of the
 373  * crypto operation. This also defaults the crypto xform type and configures
 374  * the chaining of the xforms in the crypto operation
 375  *
 376  * @return
 377  * - On success returns pointer to first crypto xform in crypto operations chain
 378  * - On failure returns NULL
 379  */
 380 static inline struct rte_crypto_sym_xform *
 381 rte_crypto_op_sym_xforms_alloc(struct rte_crypto_op *op, uint8_t nb_xforms)
 382 {
 383         void *priv_data;
 384         uint32_t size;
 385
 386         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 387                 return NULL;
 388
 389         size = sizeof(struct rte_crypto_sym_xform) * nb_xforms;
 390
 391         priv_data = __rte_crypto_op_get_priv_data(op, size);
 392         if (priv_data == NULL)
 393                 return NULL;
 394
 395         return __rte_crypto_sym_op_sym_xforms_alloc(op->sym, priv_data,
 396                         nb_xforms);
 397 }
 398
 399
 400 /**
 401  * Attach a session to a crypto operation
 402  *
 403  * @param       op      crypto operation, must be of type symmetric
 404  * @param       sess    cryptodev session
 405  */
 406 static inline int
 407 rte_crypto_op_attach_sym_session(struct rte_crypto_op *op,
 408                 struct rte_cryptodev_sym_session *sess)
 409 {
 410         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 411                 return -1;
 412
 413         op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;
 414
 415         return __rte_crypto_sym_op_attach_sym_session(op->sym, sess);
 416 }
 417
 418 #ifdef __cplusplus
 419 }
 420 #endif
 421
 422 #endif /* _RTE_CRYPTO_H_ */