rte_cryptodev.h

Go to the documentation of this file.

/*-
 *
 *   Copyright(c) 2015 Intel Corporation. All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_CRYPTODEV_H_
#define _RTE_CRYPTODEV_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "stddef.h"

#include "rte_crypto.h"
#include "rte_dev.h"

#define CRYPTODEV_NAME_NULL_PMD         ("cryptodev_null_pmd")

#define CRYPTODEV_NAME_AESNI_MB_PMD     ("cryptodev_aesni_mb_pmd")

#define CRYPTODEV_NAME_QAT_PMD          ("cryptodev_qat_pmd")

enum rte_cryptodev_type {
        RTE_CRYPTODEV_NULL_PMD = 1,     
        RTE_CRYPTODEV_AESNI_MB_PMD,     
        RTE_CRYPTODEV_QAT_PMD,          
};

/* Logging Macros */

#define CDEV_LOG_ERR(fmt, args...)                                      \
                RTE_LOG(ERR, CRYPTODEV, "%s() line %u: " fmt "\n",      \
                                __func__, __LINE__, ## args)

#define CDEV_PMD_LOG_ERR(dev, fmt, args...)                             \
                RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
                                dev, __func__, __LINE__, ## args)

#ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
#define CDEV_LOG_DEBUG(fmt, args...)                                    \
                RTE_LOG(DEBUG, CRYPTODEV, "%s() line %u: " fmt "\n",    \
                                __func__, __LINE__, ## args)            \

#define CDEV_PMD_TRACE(fmt, args...)                                    \
                RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s: " fmt "\n",         \
                                dev, __func__, ## args)

#else
#define CDEV_LOG_DEBUG(fmt, args...)
#define CDEV_PMD_TRACE(fmt, args...)
#endif

struct rte_cryptodev_info {
        const char *driver_name;                
        enum rte_cryptodev_type dev_type;       
        struct rte_pci_device *pci_dev;         
        unsigned max_nb_queue_pairs;
        unsigned max_nb_sessions;
};

#define RTE_CRYPTODEV_DETACHED  (0)
#define RTE_CRYPTODEV_ATTACHED  (1)

enum rte_cryptodev_event_type {
        RTE_CRYPTODEV_EVENT_UNKNOWN,    
        RTE_CRYPTODEV_EVENT_ERROR,      
        RTE_CRYPTODEV_EVENT_MAX         
};

struct rte_cryptodev_qp_conf {
        uint32_t nb_descriptors; 
};

typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
                enum rte_cryptodev_event_type event, void *cb_arg);

#ifdef RTE_CRYPTODEV_PERF

struct rte_cryptodev_perf_stats {
        uint64_t t_accumlated;  
        uint64_t t_min;         
        uint64_t t_max;         
};
#endif

struct rte_cryptodev_stats {
        uint64_t enqueued_count;
        uint64_t dequeued_count;
        uint64_t enqueue_err_count;
        uint64_t dequeue_err_count;
#ifdef RTE_CRYPTODEV_DETAILED_STATS
        struct {
                uint64_t encrypt_ops;   
                uint64_t encrypt_bytes; 
                uint64_t decrypt_ops;   
                uint64_t decrypt_bytes; 
        } cipher; 
        struct {
                uint64_t generate_ops;  
                uint64_t bytes_hashed;  
                uint64_t verify_ops;    
                uint64_t bytes_verified;
        } hash;  
#endif

#ifdef RTE_CRYPTODEV_PERF
        struct rte_cryptodev_perf_stats op_perf; 
#endif
} __rte_cache_aligned;

extern int
rte_cryptodev_create_vdev(const char *name, const char *args);

extern int
rte_cryptodev_get_dev_id(const char *name);

extern uint8_t
rte_cryptodev_count(void);

extern uint8_t
rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
/*
 * Return the NUMA socket to which a device is connected
 *
 * @param dev_id
 *   The identifier of the device
 * @return
 *   The NUMA socket id to which the device is connected or
 *   a default of zero if the socket could not be determined.
 *   -1 if returned is the dev_id value is out of range.
 */
extern int
rte_cryptodev_socket_id(uint8_t dev_id);

struct rte_cryptodev_config {
        int socket_id;                  
        uint16_t nb_queue_pairs;
        struct {
                uint32_t nb_objs;       
                uint32_t cache_size;    
        } session_mp;           
};

extern int
rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);

extern int
rte_cryptodev_start(uint8_t dev_id);

extern void
rte_cryptodev_stop(uint8_t dev_id);

extern int
rte_cryptodev_close(uint8_t dev_id);

extern int
rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
                const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);

extern int
rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);

extern int
rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);

extern uint16_t
rte_cryptodev_queue_pair_count(uint8_t dev_id);


extern int
rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);

extern void
rte_cryptodev_stats_reset(uint8_t dev_id);

extern void
rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);


extern int
rte_cryptodev_callback_register(uint8_t dev_id,
                enum rte_cryptodev_event_type event,
                rte_cryptodev_cb_fn cb_fn, void *cb_arg);

extern int
rte_cryptodev_callback_unregister(uint8_t dev_id,
                enum rte_cryptodev_event_type event,
                rte_cryptodev_cb_fn cb_fn, void *cb_arg);


typedef uint16_t (*dequeue_pkt_burst_t)(void *qp, struct rte_mbuf **pkts,
                uint16_t nb_pkts);
typedef uint16_t (*enqueue_pkt_burst_t)(void *qp, struct rte_mbuf **pkts,
                uint16_t nb_pkts);
struct rte_cryptodev_callback;

TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);

struct rte_cryptodev {
        dequeue_pkt_burst_t dequeue_burst;
        enqueue_pkt_burst_t enqueue_burst;
        const struct rte_cryptodev_driver *driver;
        struct rte_cryptodev_data *data;
        struct rte_cryptodev_ops *dev_ops;
        struct rte_pci_device *pci_dev;
        enum rte_cryptodev_type dev_type;
        enum pmd_type pmd_type;
        struct rte_cryptodev_cb_list link_intr_cbs;
        uint8_t attached : 1;
} __rte_cache_aligned;


#define RTE_CRYPTODEV_NAME_MAX_LEN      (64)

struct rte_cryptodev_data {
        uint8_t dev_id;
        uint8_t socket_id;
        char name[RTE_CRYPTODEV_NAME_MAX_LEN];
        uint8_t dev_started : 1;
        struct rte_mempool *session_pool;
        void **queue_pairs;
        uint16_t nb_queue_pairs;
        void *dev_private;
} __rte_cache_aligned;

extern struct rte_cryptodev *rte_cryptodevs;
static inline uint16_t
rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
                struct rte_mbuf **pkts, uint16_t nb_pkts)
{
        struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];

        nb_pkts = (*dev->dequeue_burst)
                        (dev->data->queue_pairs[qp_id], pkts, nb_pkts);

        return nb_pkts;
}

static inline uint16_t
rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
                struct rte_mbuf **pkts, uint16_t nb_pkts)
{
        struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];

        return (*dev->enqueue_burst)(
                        dev->data->queue_pairs[qp_id], pkts, nb_pkts);
}


extern struct rte_cryptodev_session *
rte_cryptodev_session_create(uint8_t dev_id,
                struct rte_crypto_xform *xform);


extern struct rte_cryptodev_session *
rte_cryptodev_session_free(uint8_t dev_id,
                struct rte_cryptodev_session *session);


#ifdef __cplusplus
}
#endif

#endif /* _RTE_CRYPTODEV_H_ */