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