d04fb3b55c
Currently, meter object supports only DSCP based on input color table, The patch enhance that to support VLAN based input color table, color table based on inner field for the tunnel use case, and support for fallback color per meter if packet based on a different field. All of the above features are exposed through capability and added additional capability to specify the implementation supports more than one input color table per ethdev port. Suggested-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Signed-off-by: Jerin Jacob <jerinj@marvell.com> Acked-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
256 lines
7.0 KiB
C
256 lines
7.0 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2017 Intel Corporation
|
|
*/
|
|
|
|
#ifndef __INCLUDE_RTE_MTR_DRIVER_H__
|
|
#define __INCLUDE_RTE_MTR_DRIVER_H__
|
|
|
|
/**
|
|
* @file
|
|
* RTE Generic Traffic Metering and Policing API (Driver Side)
|
|
*
|
|
* This file provides implementation helpers for internal use by PMDs, they
|
|
* are not intended to be exposed to applications and are not subject to ABI
|
|
* versioning.
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <rte_errno.h>
|
|
#include "rte_ethdev.h"
|
|
#include "ethdev_driver.h"
|
|
#include "rte_mtr.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @internal MTR capabilities get. */
|
|
typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
|
|
struct rte_mtr_capabilities *cap,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR meter profile add. */
|
|
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);
|
|
|
|
/** @internal MTR meter profile delete. */
|
|
typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
|
|
uint32_t meter_profile_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR meter policy validate. */
|
|
typedef int (*rte_mtr_meter_policy_validate_t)(struct rte_eth_dev *dev,
|
|
struct rte_mtr_meter_policy_params *policy,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR meter policy add. */
|
|
typedef int (*rte_mtr_meter_policy_add_t)(struct rte_eth_dev *dev,
|
|
uint32_t policy_id,
|
|
struct rte_mtr_meter_policy_params *policy,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR meter policy delete. */
|
|
typedef int (*rte_mtr_meter_policy_delete_t)(struct rte_eth_dev *dev,
|
|
uint32_t policy_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object create. */
|
|
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);
|
|
|
|
/** @internal MTR object destroy. */
|
|
typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object meter enable. */
|
|
typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object meter disable. */
|
|
typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object meter profile update. */
|
|
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);
|
|
|
|
/** @internal MTR object meter policy update. */
|
|
typedef int (*rte_mtr_meter_policy_update_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
uint32_t meter_policy_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object meter DSCP table update. */
|
|
typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
enum rte_color *dscp_table,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal mtr object meter vlan table update. */
|
|
typedef int (*rte_mtr_meter_vlan_table_update_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
enum rte_color *vlan_table,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal Set the input color protocol on MTR object. */
|
|
typedef int (*rte_mtr_meter_color_in_proto_set_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
enum rte_mtr_color_in_protocol proto,
|
|
uint32_t priority,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal Get the input color protocols of MTR object. */
|
|
typedef int (*rte_mtr_meter_color_in_proto_get_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
uint64_t *proto_mask,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal Get the input color protocol priority of MTR object. */
|
|
typedef int (*rte_mtr_meter_color_in_proto_prio_get_t)(struct rte_eth_dev *dev,
|
|
uint32_t mtr_id,
|
|
enum rte_mtr_color_in_protocol proto,
|
|
uint32_t *priority,
|
|
struct rte_mtr_error *error);
|
|
|
|
/** @internal MTR object enabled stats update. */
|
|
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);
|
|
|
|
/** @internal MTR object stats read. */
|
|
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 {
|
|
/** MTR capabilities get */
|
|
rte_mtr_capabilities_get_t capabilities_get;
|
|
|
|
/** MTR meter profile add */
|
|
rte_mtr_meter_profile_add_t meter_profile_add;
|
|
|
|
/** MTR meter profile delete */
|
|
rte_mtr_meter_profile_delete_t meter_profile_delete;
|
|
|
|
/** MTR object create */
|
|
rte_mtr_create_t create;
|
|
|
|
/** MTR object destroy */
|
|
rte_mtr_destroy_t destroy;
|
|
|
|
/** MTR object meter enable */
|
|
rte_mtr_meter_enable_t meter_enable;
|
|
|
|
/** MTR object meter disable */
|
|
rte_mtr_meter_disable_t meter_disable;
|
|
|
|
/** MTR object meter profile update */
|
|
rte_mtr_meter_profile_update_t meter_profile_update;
|
|
|
|
/** MTR object meter DSCP table update */
|
|
rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;
|
|
|
|
/** MTR object meter VLAN table update */
|
|
rte_mtr_meter_vlan_table_update_t meter_vlan_table_update;
|
|
|
|
/** Set the input color protocol on MTR object. */
|
|
rte_mtr_meter_color_in_proto_set_t in_proto_set;
|
|
|
|
/** Get the input color protocol of MTR object. */
|
|
rte_mtr_meter_color_in_proto_get_t in_proto_get;
|
|
|
|
/** Get the input color protocol priority of MTR object. */
|
|
rte_mtr_meter_color_in_proto_prio_get_t in_proto_prio_get;
|
|
|
|
/** MTR object enabled stats update */
|
|
rte_mtr_stats_update_t stats_update;
|
|
|
|
/** MTR object stats read */
|
|
rte_mtr_stats_read_t stats_read;
|
|
|
|
/** MTR meter policy validate */
|
|
rte_mtr_meter_policy_validate_t meter_policy_validate;
|
|
|
|
/** MTR meter policy add */
|
|
rte_mtr_meter_policy_add_t meter_policy_add;
|
|
|
|
/** MTR meter policy delete */
|
|
rte_mtr_meter_policy_delete_t meter_policy_delete;
|
|
|
|
/** MTR object meter policy update */
|
|
rte_mtr_meter_policy_update_t meter_policy_update;
|
|
};
|
|
|
|
/**
|
|
* Initialize generic error structure.
|
|
*
|
|
* This function also sets rte_errno to a given value.
|
|
*
|
|
* @param[out] error
|
|
* Pointer to error structure (may be NULL).
|
|
* @param[in] code
|
|
* Related error code (rte_errno).
|
|
* @param[in] type
|
|
* Cause field and error type.
|
|
* @param[in] cause
|
|
* Object responsible for the error.
|
|
* @param[in] message
|
|
* Human-readable error message.
|
|
*
|
|
* @return
|
|
* Error code.
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Get generic traffic metering and policing operations structure from a port
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[out] error
|
|
* Error details
|
|
*
|
|
* @return
|
|
* The traffic metering and policing operations structure associated with
|
|
* port_id on success, NULL otherwise.
|
|
*/
|
|
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__ */
|