rte_crypto.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2016-2017 Intel Corporation
 */

#ifndef _RTE_CRYPTO_H_
#define _RTE_CRYPTO_H_

#ifdef __cplusplus
extern "C" {
#endif


#include <rte_mbuf.h>
#include <rte_memory.h>
#include <rte_mempool.h>
#include <rte_common.h>

#include "rte_crypto_sym.h"
#include "rte_crypto_asym.h"

enum rte_crypto_op_type {
    RTE_CRYPTO_OP_TYPE_UNDEFINED,
    RTE_CRYPTO_OP_TYPE_SYMMETRIC,
    RTE_CRYPTO_OP_TYPE_ASYMMETRIC
};

enum rte_crypto_op_status {
    RTE_CRYPTO_OP_STATUS_SUCCESS,
    RTE_CRYPTO_OP_STATUS_NOT_PROCESSED,
    RTE_CRYPTO_OP_STATUS_AUTH_FAILED,
    RTE_CRYPTO_OP_STATUS_INVALID_SESSION,
    RTE_CRYPTO_OP_STATUS_INVALID_ARGS,
    RTE_CRYPTO_OP_STATUS_ERROR,
};

enum rte_crypto_op_sess_type {
    RTE_CRYPTO_OP_WITH_SESSION, 
    RTE_CRYPTO_OP_SESSIONLESS,  
    RTE_CRYPTO_OP_SECURITY_SESSION  
};

/* Auxiliary flags related to crypto operation */
#define RTE_CRYPTO_OP_AUX_FLAGS_SESS_SOFT_EXPIRY (1 << 0)

/* Auxiliary flags related to IPsec offload with RTE_SECURITY */

#define RTE_CRYPTO_OP_AUX_FLAGS_IPSEC_SOFT_EXPIRY RTE_CRYPTO_OP_AUX_FLAGS_SESS_SOFT_EXPIRY

struct rte_crypto_op {
    __extension__
    union {
        uint64_t raw;
        __extension__
        struct {
            uint8_t type;
            uint8_t status;
            uint8_t sess_type;
            uint8_t aux_flags;
            union {
                struct {
                    uint8_t content_type;
                } tls_record;
            } param1;
            uint8_t reserved[1];
            uint16_t private_data_offset;
        };
    };
    struct rte_mempool *mempool;
    rte_iova_t phys_addr;
/* empty structures do not have zero size in C++ leading to compilation errors
 * with clang about structure/union having different sizes in C and C++.
 * While things are clearer with an explicit union, since each field is
 * zero-sized it's not actually needed, so omit it for C++
 */
#ifndef __cplusplus
    __extension__
    union {
#endif
        struct rte_crypto_sym_op sym[0];
        struct rte_crypto_asym_op asym[0];
#ifndef __cplusplus
    }; 
#endif
};

static inline void
__rte_crypto_op_reset(struct rte_crypto_op *op, enum rte_crypto_op_type type)
{
    op->type = type;
    op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
    op->sess_type = RTE_CRYPTO_OP_SESSIONLESS;

    switch (type) {
    case RTE_CRYPTO_OP_TYPE_SYMMETRIC:
        __rte_crypto_sym_op_reset(op->sym);
        break;
    case RTE_CRYPTO_OP_TYPE_ASYMMETRIC:
        memset(op->asym, 0, sizeof(struct rte_crypto_asym_op));
    break;
    case RTE_CRYPTO_OP_TYPE_UNDEFINED:
    default:
        break;
    }
}

struct rte_crypto_op_pool_private {
    enum rte_crypto_op_type type;
    uint16_t priv_size;
};


static inline uint16_t
__rte_crypto_op_get_priv_data_size(struct rte_mempool *mempool)
{
    struct rte_crypto_op_pool_private *priv =
        (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);

    return priv->priv_size;
}


struct rte_mempool *
rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
        unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
        int socket_id);

static inline int
__rte_crypto_op_raw_bulk_alloc(struct rte_mempool *mempool,
        enum rte_crypto_op_type type,
        struct rte_crypto_op **ops, uint16_t nb_ops)
{
    struct rte_crypto_op_pool_private *priv;

    priv = (struct rte_crypto_op_pool_private *) rte_mempool_get_priv(mempool);
    if (unlikely(priv->type != type &&
            priv->type != RTE_CRYPTO_OP_TYPE_UNDEFINED))
        return -EINVAL;

    if (rte_mempool_get_bulk(mempool, (void **)ops, nb_ops) == 0)
        return nb_ops;

    return 0;
}

static inline struct rte_crypto_op *
rte_crypto_op_alloc(struct rte_mempool *mempool, enum rte_crypto_op_type type)
{
    struct rte_crypto_op *op = NULL;
    int retval;

    retval = __rte_crypto_op_raw_bulk_alloc(mempool, type, &op, 1);
    if (unlikely(retval != 1))
        return NULL;

    __rte_crypto_op_reset(op, type);

    return op;
}


static inline unsigned
rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
        enum rte_crypto_op_type type,
        struct rte_crypto_op **ops, uint16_t nb_ops)
{
    int i;

    if (unlikely(__rte_crypto_op_raw_bulk_alloc(mempool, type, ops, nb_ops)
            != nb_ops))
        return 0;

    for (i = 0; i < nb_ops; i++)
        __rte_crypto_op_reset(ops[i], type);

    return nb_ops;
}



static inline void *
__rte_crypto_op_get_priv_data(struct rte_crypto_op *op, uint32_t size)
{
    uint32_t priv_size;

    if (likely(op->mempool != NULL)) {
        priv_size = __rte_crypto_op_get_priv_data_size(op->mempool);

        if (likely(priv_size >= size)) {
            if (op->type == RTE_CRYPTO_OP_TYPE_SYMMETRIC)
                return (void *)((uint8_t *)(op + 1) +
                    sizeof(struct rte_crypto_sym_op));
            if (op->type == RTE_CRYPTO_OP_TYPE_ASYMMETRIC)
                return (void *)((uint8_t *)(op + 1) +
                    sizeof(struct rte_crypto_asym_op));
        }
    }

    return NULL;
}

static inline void
rte_crypto_op_free(struct rte_crypto_op *op)
{
    if (op != NULL && op->mempool != NULL)
        rte_mempool_put(op->mempool, op);
}

static inline struct rte_crypto_op *
rte_crypto_sym_op_alloc_from_mbuf_priv_data(struct rte_mbuf *m)
{
    if (unlikely(m == NULL))
        return NULL;

    /*
     * check that the mbuf's private data size is sufficient to contain a
     * crypto operation
     */
    if (unlikely(m->priv_size < (sizeof(struct rte_crypto_op) +
            sizeof(struct rte_crypto_sym_op))))
        return NULL;

    /* private data starts immediately after the mbuf header in the mbuf. */
    struct rte_crypto_op *op = (struct rte_crypto_op *)(m + 1);

    __rte_crypto_op_reset(op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);

    op->mempool = NULL;
    op->sym->m_src = m;

    return op;
}

static inline struct rte_crypto_sym_xform *
rte_crypto_op_sym_xforms_alloc(struct rte_crypto_op *op, uint8_t nb_xforms)
{
    void *priv_data;
    uint32_t size;

    if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
        return NULL;

    size = sizeof(struct rte_crypto_sym_xform) * nb_xforms;

    priv_data = __rte_crypto_op_get_priv_data(op, size);
    if (priv_data == NULL)
        return NULL;

    return __rte_crypto_sym_op_sym_xforms_alloc(op->sym, priv_data,
            nb_xforms);
}


static inline int
rte_crypto_op_attach_sym_session(struct rte_crypto_op *op, void *sess)
{
    if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
        return -1;

    op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;

    return __rte_crypto_sym_op_attach_sym_session(op->sym, sess);
}

static inline int
rte_crypto_op_attach_asym_session(struct rte_crypto_op *op,
        struct rte_cryptodev_asym_session *sess)
{
    if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_ASYMMETRIC))
        return -1;

    op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;
    op->asym->session = sess;
    return 0;
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_CRYPTO_H_ */