rte_mtr_driver.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 __INCLUDE_RTE_MTR_DRIVER_H__
#define __INCLUDE_RTE_MTR_DRIVER_H__

#include <stdint.h>

#include <rte_errno.h>
#include "rte_ethdev.h"
#include "rte_mtr.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
    struct rte_mtr_capabilities *cap,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
    uint32_t meter_profile_id,
    struct rte_mtr_meter_profile *profile,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
    uint32_t meter_profile_id,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_params *params,
    int shared,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint32_t meter_profile_id,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    enum rte_mtr_color *dscp_table,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_policer_actions_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint32_t action_mask,
    enum rte_mtr_policer_action *actions,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint64_t stats_mask,
    struct rte_mtr_error *error);
typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_stats *stats,
    uint64_t *stats_mask,
    int clear,
    struct rte_mtr_error *error);
struct rte_mtr_ops {
    rte_mtr_capabilities_get_t capabilities_get;

    rte_mtr_meter_profile_add_t meter_profile_add;

    rte_mtr_meter_profile_delete_t meter_profile_delete;

    rte_mtr_create_t create;

    rte_mtr_destroy_t destroy;

    rte_mtr_meter_enable_t meter_enable;

    rte_mtr_meter_disable_t meter_disable;

    rte_mtr_meter_profile_update_t meter_profile_update;

    rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;

    rte_mtr_policer_actions_update_t policer_actions_update;

    rte_mtr_stats_update_t stats_update;

    rte_mtr_stats_read_t stats_read;
};

static inline int
rte_mtr_error_set(struct rte_mtr_error *error,
           int code,
           enum rte_mtr_error_type type,
           const void *cause,
           const char *message)
{
    if (error) {
        *error = (struct rte_mtr_error){
            .type = type,
            .cause = cause,
            .message = message,
        };
    }
    rte_errno = code;
    return code;
}

const struct rte_mtr_ops *
rte_mtr_ops_get(uint16_t port_id, struct rte_mtr_error *error);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_MTR_DRIVER_H__ */