rte_swx_pipeline.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

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

#include <rte_compat.h>

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

#ifndef RTE_SWX_NAME_SIZE
#define RTE_SWX_NAME_SIZE 64
#endif

#ifndef RTE_SWX_INSTRUCTION_SIZE
#define RTE_SWX_INSTRUCTION_SIZE 256
#endif

#ifndef RTE_SWX_INSTRUCTION_TOKENS_MAX
#define RTE_SWX_INSTRUCTION_TOKENS_MAX 16
#endif

/*
 * Pipeline setup and operation
 */

struct rte_swx_pipeline;

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

/*
 * Pipeline input ports
 */

__rte_experimental
int
rte_swx_pipeline_port_in_type_register(struct rte_swx_pipeline *p,
                       const char *name,
                       struct rte_swx_port_in_ops *ops);

__rte_experimental
int
rte_swx_pipeline_port_in_config(struct rte_swx_pipeline *p,
                uint32_t port_id,
                const char *port_type_name,
                void *args);

/*
 * Pipeline output ports
 */

__rte_experimental
int
rte_swx_pipeline_port_out_type_register(struct rte_swx_pipeline *p,
                    const char *name,
                    struct rte_swx_port_out_ops *ops);

__rte_experimental
int
rte_swx_pipeline_port_out_config(struct rte_swx_pipeline *p,
                 uint32_t port_id,
                 const char *port_type_name,
                 void *args);
/*
 * Packet mirroring
 */

#ifndef RTE_SWX_PACKET_MIRRORING_SLOTS_DEFAULT
#define RTE_SWX_PACKET_MIRRORING_SLOTS_DEFAULT 4
#endif

#ifndef RTE_SWX_PACKET_MIRRORING_SESSIONS_DEFAULT
#define RTE_SWX_PACKET_MIRRORING_SESSIONS_DEFAULT 64
#endif

struct rte_swx_pipeline_mirroring_params {
    uint32_t n_slots;

    uint32_t n_sessions;
};

__rte_experimental
int
rte_swx_pipeline_mirroring_config(struct rte_swx_pipeline *p,
                  struct rte_swx_pipeline_mirroring_params *params);

/*
 * Extern objects and functions
 */

__rte_experimental
int
rte_swx_pipeline_extern_type_register(struct rte_swx_pipeline *p,
    const char *name,
    const char *mailbox_struct_type_name,
    rte_swx_extern_type_constructor_t constructor,
    rte_swx_extern_type_destructor_t destructor);

__rte_experimental
int
rte_swx_pipeline_extern_type_member_func_register(struct rte_swx_pipeline *p,
    const char *extern_type_name,
    const char *name,
    rte_swx_extern_type_member_func_t member_func);

__rte_experimental
int
rte_swx_pipeline_extern_object_config(struct rte_swx_pipeline *p,
                      const char *extern_type_name,
                      const char *name,
                      const char *args);

__rte_experimental
int
rte_swx_pipeline_extern_func_register(struct rte_swx_pipeline *p,
                      const char *name,
                      const char *mailbox_struct_type_name,
                      rte_swx_extern_func_t func);
/*
 * Hash function.
 */

typedef uint32_t
(*rte_swx_hash_func_t)(const void *key,
               uint32_t length,
               uint32_t seed);

__rte_experimental
int
rte_swx_pipeline_hash_func_register(struct rte_swx_pipeline *p,
                    const char *name,
                    rte_swx_hash_func_t func);

/*
 * Packet headers and meta-data
 */

struct rte_swx_field_params {
    const char *name;

    uint32_t n_bits;
};

__rte_experimental
int
rte_swx_pipeline_struct_type_register(struct rte_swx_pipeline *p,
                      const char *name,
                      struct rte_swx_field_params *fields,
                      uint32_t n_fields,
                      int last_field_has_variable_size);

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

__rte_experimental
int
rte_swx_pipeline_packet_metadata_register(struct rte_swx_pipeline *p,
                      const char *struct_type_name);

/*
 * Instructions
 */

/*
 * Pipeline action
 */

__rte_experimental
int
rte_swx_pipeline_action_config(struct rte_swx_pipeline *p,
                   const char *name,
                   const char *args_struct_type_name,
                   const char **instructions,
                   uint32_t n_instructions);

/*
 * Pipeline table
 */

__rte_experimental
int
rte_swx_pipeline_table_type_register(struct rte_swx_pipeline *p,
                     const char *name,
                     enum rte_swx_table_match_type match_type,
                     struct rte_swx_table_ops *ops);

struct rte_swx_match_field_params {
    const char *name;

    enum rte_swx_table_match_type match_type;
};

struct rte_swx_pipeline_table_params {
    struct rte_swx_match_field_params *fields;

    uint32_t n_fields;

    const char **action_names;

    int *action_is_for_table_entries;

    int *action_is_for_default_entry;

    uint32_t n_actions;

    const char *default_action_name;

    const char *default_action_args;

    int default_action_is_const;
};

__rte_experimental
int
rte_swx_pipeline_table_config(struct rte_swx_pipeline *p,
                  const char *name,
                  struct rte_swx_pipeline_table_params *params,
                  const char *recommended_table_type_name,
                  const char *args,
                  uint32_t size);

struct rte_swx_pipeline_selector_params {
    const char *group_id_field_name;

    const char **selector_field_names;

    uint32_t n_selector_fields;

    const char *member_id_field_name;

    uint32_t n_groups_max;

    uint32_t n_members_per_group_max;
};

__rte_experimental
int
rte_swx_pipeline_selector_config(struct rte_swx_pipeline *p,
                 const char *name,
                 struct rte_swx_pipeline_selector_params *params);

struct rte_swx_pipeline_learner_params {
    const char **field_names;

    uint32_t n_fields;

    const char **action_names;

    int *action_is_for_table_entries;

    int *action_is_for_default_entry;

    uint32_t n_actions;

    const char *default_action_name;

    const char *default_action_args;

    int default_action_is_const;
};

__rte_experimental
int
rte_swx_pipeline_learner_config(struct rte_swx_pipeline *p,
                const char *name,
                struct rte_swx_pipeline_learner_params *params,
                uint32_t size,
                uint32_t *timeout,
                uint32_t n_timeouts);

__rte_experimental
int
rte_swx_pipeline_regarray_config(struct rte_swx_pipeline *p,
                 const char *name,
                 uint32_t size,
                 uint64_t init_val);

__rte_experimental
int
rte_swx_pipeline_metarray_config(struct rte_swx_pipeline *p,
                 const char *name,
                 uint32_t size);

__rte_experimental
int
rte_swx_pipeline_instructions_config(struct rte_swx_pipeline *p,
                     const char **instructions,
                     uint32_t n_instructions);

__rte_experimental
int
rte_swx_pipeline_build(struct rte_swx_pipeline *p);

__rte_experimental
int
rte_swx_pipeline_build_from_spec(struct rte_swx_pipeline *p,
                 FILE *spec,
                 uint32_t *err_line,
                 const char **err_msg);

__rte_experimental
void
rte_swx_pipeline_run(struct rte_swx_pipeline *p,
             uint32_t n_instructions);

__rte_experimental
void
rte_swx_pipeline_flush(struct rte_swx_pipeline *p);

__rte_experimental
void
rte_swx_pipeline_free(struct rte_swx_pipeline *p);

#ifdef __cplusplus
}
#endif

#endif