drivers/crypto/scheduler/scheduler_pmd_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _SCHEDULER_PMD_PRIVATE_H
  35 #define _SCHEDULER_PMD_PRIVATE_H
  36
  37 #include "rte_cryptodev_scheduler.h"
  38
  39 /**< Maximum number of bonded devices per devices */
  40 #ifndef MAX_SLAVES_NUM
  41 #define MAX_SLAVES_NUM                          (8)
  42 #endif
  43
  44 #define PER_SLAVE_BUFF_SIZE                     (256)
  45
  46 #define CS_LOG_ERR(fmt, args...)                                        \
  47         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",         \
  48                 RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD),                  \
  49                 __func__, __LINE__, ## args)
  50
  51 #ifdef RTE_LIBRTE_CRYPTO_SCHEDULER_DEBUG
  52 #define CS_LOG_INFO(fmt, args...)                                       \
  53         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",        \
  54                 RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD),                  \
  55                 __func__, __LINE__, ## args)
  56
  57 #define CS_LOG_DBG(fmt, args...)                                        \
  58         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",       \
  59                 RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD),                  \
  60                 __func__, __LINE__, ## args)
  61 #else
  62 #define CS_LOG_INFO(fmt, args...)
  63 #define CS_LOG_DBG(fmt, args...)
  64 #endif
  65
  66 struct scheduler_slave {
  67         uint8_t dev_id;
  68         uint16_t qp_id;
  69         uint32_t nb_inflight_cops;
  70
  71         enum rte_cryptodev_type dev_type;
  72 };
  73
  74 struct scheduler_ctx {
  75         void *private_ctx;
  76         /**< private scheduler context pointer */
  77
  78         struct rte_cryptodev_capabilities *capabilities;
  79         uint32_t nb_capabilities;
  80
  81         uint32_t max_nb_queue_pairs;
  82
  83         struct scheduler_slave slaves[MAX_SLAVES_NUM];
  84         uint32_t nb_slaves;
  85
  86         enum rte_cryptodev_scheduler_mode mode;
  87
  88         struct rte_cryptodev_scheduler_ops ops;
  89
  90         uint8_t reordering_enabled;
  91
  92         char name[RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN];
  93         char description[RTE_CRYPTODEV_SCHEDULER_DESC_MAX_LEN];
  94 } __rte_cache_aligned;
  95
  96 struct scheduler_qp_ctx {
  97         void *private_qp_ctx;
  98
  99         struct rte_ring *order_ring;
 100         uint32_t seqn;
 101 } __rte_cache_aligned;
 102
 103 struct scheduler_session {
 104         struct rte_cryptodev_sym_session *sessions[MAX_SLAVES_NUM];
 105 };
 106
 107 static inline uint16_t __attribute__((always_inline))
 108 get_max_enqueue_order_count(struct rte_ring *order_ring, uint16_t nb_ops)
 109 {
 110         uint32_t count = rte_ring_free_count(order_ring);
 111
 112         return count > nb_ops ? nb_ops : count;
 113 }
 114
 115 static inline void __attribute__((always_inline))
 116 scheduler_order_insert(struct rte_ring *order_ring,
 117                 struct rte_crypto_op **ops, uint16_t nb_ops)
 118 {
 119         rte_ring_sp_enqueue_burst(order_ring, (void **)ops, nb_ops, NULL);
 120 }
 121
 122 #define SCHEDULER_GET_RING_OBJ(order_ring, pos, op) do {            \
 123         struct rte_crypto_op **ring = (void *)&order_ring[1];     \
 124         op = ring[(order_ring->cons.head + pos) & order_ring->mask]; \
 125 } while (0)
 126
 127 static inline uint16_t __attribute__((always_inline))
 128 scheduler_order_drain(struct rte_ring *order_ring,
 129                 struct rte_crypto_op **ops, uint16_t nb_ops)
 130 {
 131         struct rte_crypto_op *op;
 132         uint32_t nb_objs = rte_ring_count(order_ring);
 133         uint32_t nb_ops_to_deq = 0;
 134         int status = -1;
 135
 136         if (nb_objs > nb_ops)
 137                 nb_objs = nb_ops;
 138
 139         while (nb_ops_to_deq < nb_objs) {
 140                 SCHEDULER_GET_RING_OBJ(order_ring, nb_ops_to_deq, op);
 141                 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
 142                         break;
 143                 nb_ops_to_deq++;
 144         }
 145
 146         if (nb_ops_to_deq)
 147                 status = rte_ring_sc_dequeue_bulk(order_ring, (void **)ops,
 148                                 nb_ops_to_deq, NULL);
 149
 150         return (status == 0) ? nb_ops_to_deq : 0;
 151 }
 152 /** device specific operations function pointer structure */
 153 extern struct rte_cryptodev_ops *rte_crypto_scheduler_pmd_ops;
 154
 155 #endif /* _SCHEDULER_PMD_PRIVATE_H */