rte_swx_ctl.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2020 Intel Corporation
 */
#ifndef __INCLUDE_RTE_SWX_CTL_H__
#define __INCLUDE_RTE_SWX_CTL_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>

#include <rte_compat.h>
#include <rte_meter.h>

#include "rte_swx_port.h"
#include "rte_swx_table.h"

struct rte_swx_pipeline;

#ifndef RTE_SWX_CTL_NAME_SIZE
#define RTE_SWX_CTL_NAME_SIZE 64
#endif

/*
 * Pipeline Query API.
 */

struct rte_swx_ctl_pipeline_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_ports_in;

    uint32_t n_ports_out;

    uint32_t n_mirroring_slots;

    uint32_t n_mirroring_sessions;

    uint32_t n_actions;

    uint32_t n_tables;

    uint32_t n_selectors;

    uint32_t n_learners;

    uint32_t n_regarrays;

    uint32_t n_metarrays;
};

__rte_experimental
int
rte_swx_ctl_pipeline_info_get(struct rte_swx_pipeline *p,
                  struct rte_swx_ctl_pipeline_info *pipeline);

__rte_experimental
int
rte_swx_ctl_pipeline_numa_node_get(struct rte_swx_pipeline *p,
                   int *numa_node);

/*
 * Ports Query API.
 */

__rte_experimental
int
rte_swx_ctl_pipeline_port_in_stats_read(struct rte_swx_pipeline *p,
                    uint32_t port_id,
                    struct rte_swx_port_in_stats *stats);

__rte_experimental
int
rte_swx_ctl_pipeline_port_out_stats_read(struct rte_swx_pipeline *p,
                     uint32_t port_id,
                     struct rte_swx_port_out_stats *stats);

/*
 * Action Query API.
 */

struct rte_swx_ctl_action_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_args;
};

__rte_experimental
int
rte_swx_ctl_action_info_get(struct rte_swx_pipeline *p,
                uint32_t action_id,
                struct rte_swx_ctl_action_info *action);

struct rte_swx_ctl_action_arg_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_bits;

    int is_network_byte_order;
};

__rte_experimental
int
rte_swx_ctl_action_arg_info_get(struct rte_swx_pipeline *p,
                uint32_t action_id,
                uint32_t action_arg_id,
                struct rte_swx_ctl_action_arg_info *action_arg);

/*
 * Table Query API.
 */

struct rte_swx_ctl_table_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    char args[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_match_fields;

    uint32_t n_actions;

    int default_action_is_const;

    rte_swx_hash_func_t hash_func;

    uint32_t size;
};

__rte_experimental
int
rte_swx_ctl_table_info_get(struct rte_swx_pipeline *p,
               uint32_t table_id,
               struct rte_swx_ctl_table_info *table);

struct rte_swx_ctl_table_match_field_info {
    enum rte_swx_table_match_type match_type;

    int is_header;

    uint32_t n_bits;

    uint32_t offset;
};

__rte_experimental
int
rte_swx_ctl_table_match_field_info_get(struct rte_swx_pipeline *p,
    uint32_t table_id,
    uint32_t match_field_id,
    struct rte_swx_ctl_table_match_field_info *match_field);

struct rte_swx_ctl_table_action_info {
    uint32_t action_id;

    int action_is_for_table_entries;

    int action_is_for_default_entry;
};

__rte_experimental
int
rte_swx_ctl_table_action_info_get(struct rte_swx_pipeline *p,
    uint32_t table_id,
    uint32_t table_action_id,
    struct rte_swx_ctl_table_action_info *table_action);

__rte_experimental
int
rte_swx_ctl_table_ops_get(struct rte_swx_pipeline *p,
              uint32_t table_id,
              struct rte_swx_table_ops *table_ops,
              int *is_stub);

struct rte_swx_table_stats {
    uint64_t n_pkts_hit;

    uint64_t n_pkts_miss;

    uint64_t *n_pkts_action;
};

__rte_experimental
int
rte_swx_ctl_pipeline_table_stats_read(struct rte_swx_pipeline *p,
                      const char *table_name,
                      struct rte_swx_table_stats *stats);

/*
 * Selector Table Query API.
 */

struct rte_swx_ctl_selector_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_selector_fields;

    uint32_t n_groups_max;

    uint32_t n_members_per_group_max;
};

__rte_experimental
int
rte_swx_ctl_selector_info_get(struct rte_swx_pipeline *p,
                  uint32_t selector_id,
                  struct rte_swx_ctl_selector_info *selector);

__rte_experimental
int
rte_swx_ctl_selector_group_id_field_info_get(struct rte_swx_pipeline *p,
                         uint32_t selector_id,
                         struct rte_swx_ctl_table_match_field_info *field);

__rte_experimental
int
rte_swx_ctl_selector_field_info_get(struct rte_swx_pipeline *p,
                    uint32_t selector_id,
                    uint32_t selector_field_id,
                    struct rte_swx_ctl_table_match_field_info *field);

__rte_experimental
int
rte_swx_ctl_selector_member_id_field_info_get(struct rte_swx_pipeline *p,
                          uint32_t selector_id,
                          struct rte_swx_ctl_table_match_field_info *field);

struct rte_swx_pipeline_selector_stats {
    uint64_t n_pkts;
};

__rte_experimental
int
rte_swx_ctl_pipeline_selector_stats_read(struct rte_swx_pipeline *p,
                     const char *selector_name,
                     struct rte_swx_pipeline_selector_stats *stats);

/*
 * Learner Table Query API.
 */

struct rte_swx_ctl_learner_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t n_match_fields;

    uint32_t n_actions;

    int default_action_is_const;

    uint32_t size;

    uint32_t n_key_timeouts;
};

__rte_experimental
int
rte_swx_ctl_learner_info_get(struct rte_swx_pipeline *p,
                 uint32_t learner_id,
                 struct rte_swx_ctl_learner_info *learner);

__rte_experimental
int
rte_swx_ctl_learner_match_field_info_get(struct rte_swx_pipeline *p,
                     uint32_t learner_id,
                     uint32_t match_field_id,
                     struct rte_swx_ctl_table_match_field_info *match_field);

__rte_experimental
int
rte_swx_ctl_learner_action_info_get(struct rte_swx_pipeline *p,
                    uint32_t learner_id,
                    uint32_t learner_action_id,
                    struct rte_swx_ctl_table_action_info *learner_action);

__rte_experimental
int
rte_swx_ctl_pipeline_learner_timeout_get(struct rte_swx_pipeline *p,
                     uint32_t learner_id,
                     uint32_t timeout_id,
                     uint32_t *timeout);

__rte_experimental
int
rte_swx_ctl_pipeline_learner_timeout_set(struct rte_swx_pipeline *p,
                     uint32_t learner_id,
                     uint32_t timeout_id,
                     uint32_t timeout);

struct rte_swx_learner_stats {
    uint64_t n_pkts_hit;

    uint64_t n_pkts_miss;

    uint64_t n_pkts_learn_ok;

    uint64_t n_pkts_learn_err;

    uint64_t n_pkts_rearm;

    uint64_t n_pkts_forget;

    uint64_t *n_pkts_action;
};

__rte_experimental
int
rte_swx_ctl_pipeline_learner_stats_read(struct rte_swx_pipeline *p,
                      const char *learner_name,
                      struct rte_swx_learner_stats *stats);

/*
 * Packet mirroring API.
 */

struct rte_swx_pipeline_mirroring_session_params {
    uint32_t port_id;

    int fast_clone;

    uint32_t truncation_length;
};

__rte_experimental
int
rte_swx_ctl_pipeline_mirroring_session_set(struct rte_swx_pipeline *p,
    uint32_t session_id,
    struct rte_swx_pipeline_mirroring_session_params *params);

/*
 * Table Update API.
 */

struct rte_swx_table_state {
    void *obj;

    uint64_t default_action_id;

    uint8_t *default_action_data;
};

__rte_experimental
int
rte_swx_pipeline_table_state_get(struct rte_swx_pipeline *p,
                 struct rte_swx_table_state **table_state);

__rte_experimental
int
rte_swx_pipeline_table_state_set(struct rte_swx_pipeline *p,
                 struct rte_swx_table_state *table_state);

/*
 * High Level Reference Table Update API.
 */

struct rte_swx_ctl_pipeline;

__rte_experimental
struct rte_swx_ctl_pipeline *
rte_swx_ctl_pipeline_find(const char *name);

__rte_experimental
struct rte_swx_ctl_pipeline *
rte_swx_ctl_pipeline_create(struct rte_swx_pipeline *p);

__rte_experimental
int
rte_swx_ctl_pipeline_table_entry_add(struct rte_swx_ctl_pipeline *ctl,
                     const char *table_name,
                     struct rte_swx_table_entry *entry);

__rte_experimental
int
rte_swx_ctl_pipeline_table_default_entry_add(struct rte_swx_ctl_pipeline *ctl,
                         const char *table_name,
                         struct rte_swx_table_entry *entry);

__rte_experimental
int
rte_swx_ctl_pipeline_table_entry_delete(struct rte_swx_ctl_pipeline *ctl,
                    const char *table_name,
                    struct rte_swx_table_entry *entry);

__rte_experimental
int
rte_swx_ctl_pipeline_selector_group_add(struct rte_swx_ctl_pipeline *ctl,
                    const char *selector_name,
                    uint32_t *group_id);

__rte_experimental
int
rte_swx_ctl_pipeline_selector_group_delete(struct rte_swx_ctl_pipeline *ctl,
                       const char *selector_name,
                       uint32_t group_id);

__rte_experimental
int
rte_swx_ctl_pipeline_selector_group_member_add(struct rte_swx_ctl_pipeline *ctl,
                           const char *selector_name,
                           uint32_t group_id,
                           uint32_t member_id,
                           uint32_t member_weight);

__rte_experimental
int
rte_swx_ctl_pipeline_selector_group_member_delete(struct rte_swx_ctl_pipeline *ctl,
                          const char *selector_name,
                          uint32_t group_id,
                          uint32_t member_id);

__rte_experimental
int
rte_swx_ctl_pipeline_learner_default_entry_add(struct rte_swx_ctl_pipeline *ctl,
                           const char *learner_name,
                           struct rte_swx_table_entry *entry);

__rte_experimental
int
rte_swx_ctl_pipeline_commit(struct rte_swx_ctl_pipeline *ctl,
                int abort_on_fail);

__rte_experimental
void
rte_swx_ctl_pipeline_abort(struct rte_swx_ctl_pipeline *ctl);

__rte_experimental
struct rte_swx_table_entry *
rte_swx_ctl_pipeline_table_entry_read(struct rte_swx_ctl_pipeline *ctl,
                      const char *table_name,
                      const char *string,
                      int *is_blank_or_comment);

__rte_experimental
struct rte_swx_table_entry *
rte_swx_ctl_pipeline_learner_default_entry_read(struct rte_swx_ctl_pipeline *ctl,
                        const char *learner_name,
                        const char *string,
                        int *is_blank_or_comment);

__rte_experimental
int
rte_swx_ctl_pipeline_table_fprintf(FILE *f,
                   struct rte_swx_ctl_pipeline *ctl,
                   const char *table_name);

__rte_experimental
int
rte_swx_ctl_pipeline_selector_fprintf(FILE *f,
                      struct rte_swx_ctl_pipeline *ctl,
                      const char *selector_name);

/*
 * Register Array Query API.
 */

struct rte_swx_ctl_regarray_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t size;
};

__rte_experimental
int
rte_swx_ctl_regarray_info_get(struct rte_swx_pipeline *p,
                  uint32_t regarray_id,
                  struct rte_swx_ctl_regarray_info *regarray);

__rte_experimental
int
rte_swx_ctl_pipeline_regarray_read(struct rte_swx_pipeline *p,
                   const char *regarray_name,
                   uint32_t regarray_index,
                   uint64_t *value);

__rte_experimental
int
rte_swx_ctl_pipeline_regarray_write(struct rte_swx_pipeline *p,
                   const char *regarray_name,
                   uint32_t regarray_index,
                   uint64_t value);

__rte_experimental
int
rte_swx_ctl_pipeline_regarray_read_with_key(struct rte_swx_pipeline *p,
                        const char *regarray_name,
                        const char *table_name,
                        uint8_t *table_key,
                        uint64_t *value);

__rte_experimental
int
rte_swx_ctl_pipeline_regarray_write_with_key(struct rte_swx_pipeline *p,
                         const char *regarray_name,
                         const char *table_name,
                         uint8_t *table_key,
                         uint64_t value);

/*
 * Meter Array Query and Configuration API.
 */

struct rte_swx_ctl_metarray_info {
    char name[RTE_SWX_CTL_NAME_SIZE];

    uint32_t size;
};

__rte_experimental
int
rte_swx_ctl_metarray_info_get(struct rte_swx_pipeline *p,
                  uint32_t metarray_id,
                  struct rte_swx_ctl_metarray_info *metarray);

__rte_experimental
int
rte_swx_ctl_meter_profile_add(struct rte_swx_pipeline *p,
                  const char *name,
                  struct rte_meter_trtcm_params *params);

__rte_experimental
int
rte_swx_ctl_meter_profile_delete(struct rte_swx_pipeline *p,
                 const char *name);

__rte_experimental
int
rte_swx_ctl_meter_reset(struct rte_swx_pipeline *p,
            const char *metarray_name,
            uint32_t metarray_index);

__rte_experimental
int
rte_swx_ctl_meter_set(struct rte_swx_pipeline *p,
              const char *metarray_name,
              uint32_t metarray_index,
              const char *profile_name);

struct rte_swx_ctl_meter_stats {
    uint64_t n_pkts[RTE_COLORS];

    uint64_t n_bytes[RTE_COLORS];
};

__rte_experimental
int
rte_swx_ctl_meter_stats_read(struct rte_swx_pipeline *p,
                 const char *metarray_name,
                 uint32_t metarray_index,
                 struct rte_swx_ctl_meter_stats *stats);

__rte_experimental
int
rte_swx_ctl_meter_reset_with_key(struct rte_swx_pipeline *p,
                 const char *metarray_name,
                 const char *table_name,
                 uint8_t *table_key);

__rte_experimental
int
rte_swx_ctl_meter_set_with_key(struct rte_swx_pipeline *p,
                   const char *metarray_name,
                   const char *table_name,
                   uint8_t *table_key,
                   const char *profile_name);

__rte_experimental
int
rte_swx_ctl_meter_stats_read_with_key(struct rte_swx_pipeline *p,
                      const char *metarray_name,
                      const char *table_name,
                      uint8_t *table_key,
                      struct rte_swx_ctl_meter_stats *stats);

__rte_experimental
void
rte_swx_ctl_pipeline_free(struct rte_swx_ctl_pipeline *ctl);

#ifdef __cplusplus
}
#endif

#endif