rte_mldev_core.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2022 Marvell.
 */

#ifndef RTE_MLDEV_INTERNAL_H
#define RTE_MLDEV_INTERNAL_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <dev_driver.h>
#include <rte_common.h>
#include <rte_log.h>
#include <rte_mldev.h>

/* Device state */
#define ML_DEV_DETACHED (0)
#define ML_DEV_ATTACHED (1)

struct rte_ml_dev;

typedef uint16_t (*mldev_enqueue_t)(struct rte_ml_dev *dev, uint16_t qp_id, struct rte_ml_op **ops,
                    uint16_t nb_ops);

typedef uint16_t (*mldev_dequeue_t)(struct rte_ml_dev *dev, uint16_t qp_id, struct rte_ml_op **ops,
                    uint16_t nb_ops);

typedef int (*mldev_op_error_get_t)(struct rte_ml_dev *dev, struct rte_ml_op *op,
                    struct rte_ml_op_error *error);

typedef int (*mldev_info_get_t)(struct rte_ml_dev *dev, struct rte_ml_dev_info *dev_info);

typedef int (*mldev_configure_t)(struct rte_ml_dev *dev, const struct rte_ml_dev_config *config);

typedef int (*mldev_close_t)(struct rte_ml_dev *dev);

typedef int (*mldev_start_t)(struct rte_ml_dev *dev);

typedef int (*mldev_stop_t)(struct rte_ml_dev *dev);

typedef int (*mldev_queue_pair_setup_t)(struct rte_ml_dev *dev, uint16_t queue_pair_id,
                    const struct rte_ml_dev_qp_conf *queue_pair_conf,
                    int socket_id);

typedef int (*mldev_queue_pair_release_t)(struct rte_ml_dev *dev, uint16_t queue_pair_id);

typedef int (*mldev_stats_get_t)(struct rte_ml_dev *dev, struct rte_ml_dev_stats *stats);

typedef void (*mldev_stats_reset_t)(struct rte_ml_dev *dev);

typedef int (*mldev_xstats_names_get_t)(struct rte_ml_dev *dev,
                    struct rte_ml_dev_xstats_map *xstats_map, uint32_t size);

typedef int (*mldev_xstats_by_name_get_t)(struct rte_ml_dev *dev, const char *name,
                      uint16_t *stat_id, uint64_t *value);

typedef int (*mldev_xstats_get_t)(struct rte_ml_dev *dev, const uint16_t *stat_ids,
                  uint64_t *values, uint16_t nb_ids);

typedef int (*mldev_xstats_reset_t)(struct rte_ml_dev *dev, const uint16_t *stat_ids,
                    uint16_t nb_ids);

typedef int (*mldev_dump_t)(struct rte_ml_dev *dev, FILE *fd);

typedef int (*mldev_selftest_t)(struct rte_ml_dev *dev);

typedef int (*mldev_model_load_t)(struct rte_ml_dev *dev, struct rte_ml_model_params *params,
                  uint16_t *model_id);

typedef int (*mldev_model_unload_t)(struct rte_ml_dev *dev, uint16_t model_id);

typedef int (*mldev_model_start_t)(struct rte_ml_dev *dev, uint16_t model_id);

typedef int (*mldev_model_stop_t)(struct rte_ml_dev *dev, uint16_t model_id);

typedef int (*mldev_model_info_get_t)(struct rte_ml_dev *dev, uint16_t model_id,
                      struct rte_ml_model_info *model_info);

typedef int (*mldev_model_params_update_t)(struct rte_ml_dev *dev, uint16_t model_id, void *buffer);

typedef int (*mldev_io_input_size_get_t)(struct rte_ml_dev *dev, uint16_t model_id,
                     uint32_t nb_batches, uint64_t *input_qsize,
                     uint64_t *input_dsize);

typedef int (*mldev_io_output_size_get_t)(struct rte_ml_dev *dev, uint16_t model_id,
                      uint32_t nb_batches, uint64_t *output_qsize,
                      uint64_t *output_dsize);

typedef int (*mldev_io_quantize_t)(struct rte_ml_dev *dev, uint16_t model_id, uint16_t nb_batches,
                   void *dbuffer, void *qbuffer);

typedef int (*mldev_io_dequantize_t)(struct rte_ml_dev *dev, uint16_t model_id, uint16_t nb_batches,
                     void *qbuffer, void *dbuffer);

struct rte_ml_dev_ops {
    mldev_info_get_t dev_info_get;

    mldev_configure_t dev_configure;

    mldev_close_t dev_close;

    mldev_start_t dev_start;

    mldev_stop_t dev_stop;

    mldev_queue_pair_setup_t dev_queue_pair_setup;

    mldev_queue_pair_release_t dev_queue_pair_release;

    mldev_stats_get_t dev_stats_get;

    mldev_stats_reset_t dev_stats_reset;

    mldev_xstats_names_get_t dev_xstats_names_get;

    mldev_xstats_by_name_get_t dev_xstats_by_name_get;

    mldev_xstats_get_t dev_xstats_get;

    mldev_xstats_reset_t dev_xstats_reset;

    mldev_dump_t dev_dump;

    mldev_selftest_t dev_selftest;

    mldev_model_load_t model_load;

    mldev_model_unload_t model_unload;

    mldev_model_start_t model_start;

    mldev_model_stop_t model_stop;

    mldev_model_info_get_t model_info_get;

    mldev_model_params_update_t model_params_update;

    mldev_io_input_size_get_t io_input_size_get;

    mldev_io_output_size_get_t io_output_size_get;

    mldev_io_quantize_t io_quantize;

    mldev_io_dequantize_t io_dequantize;
};

struct rte_ml_dev_data {
    int16_t dev_id;

    int16_t socket_id;

    __extension__ uint8_t dev_started : 1;

    uint16_t nb_queue_pairs;

    uint16_t nb_models;

    void **queue_pairs;

    void **models;

    void *dev_private;

    char name[RTE_ML_STR_MAX];
};

struct rte_ml_dev {
    mldev_enqueue_t enqueue_burst;

    mldev_dequeue_t dequeue_burst;

    mldev_op_error_get_t op_error_get;

    struct rte_ml_dev_data *data;

    struct rte_ml_dev_ops *dev_ops;

    struct rte_device *device;

    __extension__ uint8_t attached : 1;
} __rte_cache_aligned;

struct rte_ml_dev_global {
    struct rte_ml_dev *devs;

    struct rte_ml_dev_data **data;

    uint8_t nb_devs;

    uint8_t max_devs;
};

#ifdef __cplusplus
}
#endif

#endif /* RTE_MLDEV_INTERNAL_H */