rte_cryptodev_scheduler.h

Go to the documentation of this file.

/*-
 *   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

#include <stdint.h>
#include "rte_cryptodev_scheduler_operations.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES
#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES   (8)
#endif

#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKER_CORES (RTE_MAX_LCORE - 1)

#define SCHEDULER_MODE_NAME_ROUND_ROBIN     round-robin

#define SCHEDULER_MODE_NAME_PKT_SIZE_DISTR  packet-size-distr

#define SCHEDULER_MODE_NAME_FAIL_OVER       fail-over

#define SCHEDULER_MODE_NAME_MULTI_CORE      multi-core

enum rte_cryptodev_scheduler_mode {
    CDEV_SCHED_MODE_NOT_SET = 0,
    CDEV_SCHED_MODE_USERDEFINED,
    CDEV_SCHED_MODE_ROUNDROBIN,
    CDEV_SCHED_MODE_PKT_SIZE_DISTR,
    CDEV_SCHED_MODE_FAILOVER,
    CDEV_SCHED_MODE_MULTICORE,

    CDEV_SCHED_MODE_COUNT 
};

#define RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN    (64)
#define RTE_CRYPTODEV_SCHEDULER_DESC_MAX_LEN    (256)

enum rte_cryptodev_schedule_option_type {
    CDEV_SCHED_OPTION_NOT_SET = 0,
    CDEV_SCHED_OPTION_THRESHOLD,

    CDEV_SCHED_OPTION_COUNT
};

struct rte_cryptodev_scheduler_threshold_option {
    uint32_t threshold; 
};

struct rte_cryptodev_scheduler;

int
rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id,
        struct rte_cryptodev_scheduler *scheduler);

int
rte_cryptodev_scheduler_slave_attach(uint8_t scheduler_id, uint8_t slave_id);

int
rte_cryptodev_scheduler_slave_detach(uint8_t scheduler_id, uint8_t slave_id);


int
rte_cryptodev_scheduler_mode_set(uint8_t scheduler_id,
        enum rte_cryptodev_scheduler_mode mode);

enum rte_cryptodev_scheduler_mode
rte_cryptodev_scheduler_mode_get(uint8_t scheduler_id);

int
rte_cryptodev_scheduler_ordering_set(uint8_t scheduler_id,
        uint32_t enable_reorder);

int
rte_cryptodev_scheduler_ordering_get(uint8_t scheduler_id);

int
rte_cryptodev_scheduler_slaves_get(uint8_t scheduler_id, uint8_t *slaves);

int
rte_cryptodev_scheduler_option_set(uint8_t scheduler_id,
        enum rte_cryptodev_schedule_option_type option_type,
        void *option);

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);

struct rte_cryptodev_scheduler {
    const char *name;                        
    const char *description;                 
    enum rte_cryptodev_scheduler_mode mode;  
    struct rte_cryptodev_scheduler_ops *ops;
};

extern struct rte_cryptodev_scheduler *roundrobin_scheduler;
extern struct rte_cryptodev_scheduler *pkt_size_based_distr_scheduler;
extern struct rte_cryptodev_scheduler *failover_scheduler;
extern struct rte_cryptodev_scheduler *multicore_scheduler;

#ifdef __cplusplus
}
#endif
#endif /* _RTE_CRYPTO_SCHEDULER_H */