/usr/share/dpdk/x86_64-default-linuxapp-gcc/include/rte_cryptodev_scheduler.h is in dpdk-dev 17.11.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | /*-
* BSD LICENSE
*
* Copyright(c) 2017 Intel Corporation. All rights reserved.
* 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_CRYPTO_SCHEDULER_H
#define _RTE_CRYPTO_SCHEDULER_H
/**
* @file rte_cryptodev_scheduler.h
*
* RTE Cryptodev Scheduler Device
*
* The RTE Cryptodev Scheduler Device allows the aggregation of multiple (slave)
* Cryptodevs into a single logical crypto device, and the scheduling the
* crypto operations to the slaves based on the mode of the specified mode of
* operation specified and supported. This implementation supports 3 modes of
* operation: round robin, packet-size based, and fail-over.
*/
#include <stdint.h>
#include "rte_cryptodev_scheduler_operations.h"
#ifdef __cplusplus
extern "C" {
#endif
/** Maximum number of bonded devices per device */
#ifndef RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES
#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES (8)
#endif
/** Maximum number of multi-core worker cores */
#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKER_CORES (64)
/** Round-robin scheduling mode string */
#define SCHEDULER_MODE_NAME_ROUND_ROBIN round-robin
/** Packet-size based distribution scheduling mode string */
#define SCHEDULER_MODE_NAME_PKT_SIZE_DISTR packet-size-distr
/** Fail-over scheduling mode string */
#define SCHEDULER_MODE_NAME_FAIL_OVER fail-over
/** multi-core scheduling mode string */
#define SCHEDULER_MODE_NAME_MULTI_CORE multi-core
/**
* Crypto scheduler PMD operation modes
*/
enum rte_cryptodev_scheduler_mode {
CDEV_SCHED_MODE_NOT_SET = 0,
/** User defined mode */
CDEV_SCHED_MODE_USERDEFINED,
/** Round-robin mode */
CDEV_SCHED_MODE_ROUNDROBIN,
/** Packet-size based distribution mode */
CDEV_SCHED_MODE_PKT_SIZE_DISTR,
/** Fail-over mode */
CDEV_SCHED_MODE_FAILOVER,
/** multi-core mode */
CDEV_SCHED_MODE_MULTICORE,
CDEV_SCHED_MODE_COUNT /**< number of modes */
};
#define RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN (64)
#define RTE_CRYPTODEV_SCHEDULER_DESC_MAX_LEN (256)
/**
* Crypto scheduler option types
*/
enum rte_cryptodev_schedule_option_type {
CDEV_SCHED_OPTION_NOT_SET = 0,
CDEV_SCHED_OPTION_THRESHOLD,
CDEV_SCHED_OPTION_COUNT
};
/**
* Threshold option structure
*/
struct rte_cryptodev_scheduler_threshold_option {
uint32_t threshold; /**< Threshold for packet-size mode */
};
struct rte_cryptodev_scheduler;
/**
* Load a user defined scheduler
*
* @param scheduler_id
* The target scheduler device ID
* @param scheduler
* Pointer to the user defined scheduler
*
* @return
* - 0 if the scheduler is successfully loaded
* - -ENOTSUP if the operation is not supported.
* - -EBUSY if device is started.
* - -EINVAL if input values are invalid.
*/
int
rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id,
struct rte_cryptodev_scheduler *scheduler);
/**
* Attach a crypto device to the scheduler
*
* @param scheduler_id
* The target scheduler device ID
* @param slave_id
* Crypto device ID to be attached
*
* @return
* - 0 if the slave is attached.
* - -ENOTSUP if the operation is not supported.
* - -EBUSY if device is started.
* - -ENOMEM if the scheduler's slave list is full.
*/
int
rte_cryptodev_scheduler_slave_attach(uint8_t scheduler_id, uint8_t slave_id);
/**
* Detach a crypto device from the scheduler
*
* @param scheduler_id
* The target scheduler device ID
* @param slave_id
* Crypto device ID to be detached
*
* @return
* - 0 if the slave is detached.
* - -ENOTSUP if the operation is not supported.
* - -EBUSY if device is started.
*/
int
rte_cryptodev_scheduler_slave_detach(uint8_t scheduler_id, uint8_t slave_id);
/**
* Set the scheduling mode
*
* @param scheduler_id
* The target scheduler device ID
* @param mode
* The scheduling mode
*
* @return
* - 0 if the mode is set.
* - -ENOTSUP if the operation is not supported.
* - -EBUSY if device is started.
*/
int
rte_cryptodev_scheduler_mode_set(uint8_t scheduler_id,
enum rte_cryptodev_scheduler_mode mode);
/**
* Get the current scheduling mode
*
* @param scheduler_id
* The target scheduler device ID
*
* @return mode
* - non-negative enumerate value: the scheduling mode
* - -ENOTSUP if the operation is not supported.
*/
enum rte_cryptodev_scheduler_mode
rte_cryptodev_scheduler_mode_get(uint8_t scheduler_id);
/**
* Set the crypto ops reordering feature on/off
*
* @param scheduler_id
* The target scheduler device ID
* @param enable_reorder
* Set the crypto op reordering feature
* - 0: disable reordering
* - 1: enable reordering
*
* @return
* - 0 if the ordering is set.
* - -ENOTSUP if the operation is not supported.
* - -EBUSY if device is started.
*/
int
rte_cryptodev_scheduler_ordering_set(uint8_t scheduler_id,
uint32_t enable_reorder);
/**
* Get the current crypto ops reordering feature
*
* @param scheduler_id
* The target scheduler device ID
*
* @return
* - 0 if reordering is disabled
* - 1 if reordering is enabled
* - -ENOTSUP if the operation is not supported.
*/
int
rte_cryptodev_scheduler_ordering_get(uint8_t scheduler_id);
/**
* Get the the attached slaves' count and/or ID
*
* @param scheduler_id
* The target scheduler device ID
* @param slaves
* If successful, the function will write back all slaves' device IDs to it.
* This parameter will either be an uint8_t array of
* RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES elements or NULL.
*
* @return
* - non-negative number: the number of slaves attached
* - -ENOTSUP if the operation is not supported.
*/
int
rte_cryptodev_scheduler_slaves_get(uint8_t scheduler_id, uint8_t *slaves);
/**
* Set the mode specific option
*
* @param scheduler_id
* The target scheduler device ID
* @param option_type
* The option type enumerate
* @param option
* The specific mode's option structure
*
* @return
* - 0 if successful
* - negative integer if otherwise.
*/
int
rte_cryptodev_scheduler_option_set(uint8_t scheduler_id,
enum rte_cryptodev_schedule_option_type option_type,
void *option);
/**
* Set the mode specific option
*
* @param scheduler_id
* The target scheduler device ID
* @param option_type
* The option type enumerate
* @param option
* If successful, the function will write back the current
*
* @return
* - 0 if successful
* - negative integer if otherwise.
*/
int
rte_cryptodev_scheduler_option_get(uint8_t scheduler_id,
enum rte_cryptodev_schedule_option_type option_type,
void *option);
typedef uint16_t (*rte_cryptodev_scheduler_burst_enqueue_t)(void *qp_ctx,
struct rte_crypto_op **ops, uint16_t nb_ops);
typedef uint16_t (*rte_cryptodev_scheduler_burst_dequeue_t)(void *qp_ctx,
struct rte_crypto_op **ops, uint16_t nb_ops);
/** The data structure associated with each mode of scheduler. */
struct rte_cryptodev_scheduler {
const char *name; /**< Scheduler name */
const char *description; /**< Scheduler description */
enum rte_cryptodev_scheduler_mode mode; /**< Scheduling mode */
/** Pointer to scheduler operation structure */
struct rte_cryptodev_scheduler_ops *ops;
};
/** Round-robin mode scheduler */
extern struct rte_cryptodev_scheduler *roundrobin_scheduler;
/** Packet-size based distribution mode scheduler */
extern struct rte_cryptodev_scheduler *pkt_size_based_distr_scheduler;
/** Fail-over mode scheduler */
extern struct rte_cryptodev_scheduler *failover_scheduler;
/** multi-core mode scheduler */
extern struct rte_cryptodev_scheduler *multicore_scheduler;
#ifdef __cplusplus
}
#endif
#endif /* _RTE_CRYPTO_SCHEDULER_H */
|