sainat.h

Go to the documentation of this file.

 
#if !defined (__SAINAT_H_)
#define __SAINAT_H_
 
#include <saitypes.h>
 
typedef enum _sai_nat_type_t
{
    SAI_NAT_TYPE_NONE,
 
    SAI_NAT_TYPE_SOURCE_NAT,
 
    SAI_NAT_TYPE_DESTINATION_NAT,
 
    SAI_NAT_TYPE_DOUBLE_NAT,
 
    SAI_NAT_TYPE_DESTINATION_NAT_POOL,
 
} sai_nat_type_t;
 
typedef enum _sai_nat_entry_attr_t
{
    SAI_NAT_ENTRY_ATTR_START,
 
    SAI_NAT_ENTRY_ATTR_NAT_TYPE = SAI_NAT_ENTRY_ATTR_START,
 
    SAI_NAT_ENTRY_ATTR_SRC_IP,
 
    SAI_NAT_ENTRY_ATTR_SRC_IP_MASK,
 
    SAI_NAT_ENTRY_ATTR_VR_ID,
 
    SAI_NAT_ENTRY_ATTR_DST_IP,
 
    SAI_NAT_ENTRY_ATTR_DST_IP_MASK,
 
    SAI_NAT_ENTRY_ATTR_L4_SRC_PORT,
 
    SAI_NAT_ENTRY_ATTR_L4_DST_PORT,
 
    SAI_NAT_ENTRY_ATTR_ENABLE_PACKET_COUNT,
 
    SAI_NAT_ENTRY_ATTR_PACKET_COUNT,
 
    SAI_NAT_ENTRY_ATTR_ENABLE_BYTE_COUNT,
 
    SAI_NAT_ENTRY_ATTR_BYTE_COUNT,
 
    SAI_NAT_ENTRY_ATTR_HIT_BIT_COR,
 
    SAI_NAT_ENTRY_ATTR_HIT_BIT,
 
    SAI_NAT_ENTRY_ATTR_AGING_TIME,
 
    SAI_NAT_ENTRY_ATTR_END,
 
    SAI_NAT_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_NAT_ENTRY_ATTR_CUSTOM_RANGE_END
 
} sai_nat_entry_attr_t;
 
typedef struct _sai_nat_entry_key_t
{
    sai_ip4_t src_ip;
 
    sai_ip4_t dst_ip;
 
    sai_uint8_t proto;
 
    sai_uint16_t l4_src_port;
 
    sai_uint16_t l4_dst_port;
 
} sai_nat_entry_key_t;
 
typedef struct _sai_nat_entry_mask_t
{
    sai_ip4_t src_ip;
 
    sai_ip4_t dst_ip;
 
    sai_uint8_t proto;
 
    sai_uint16_t l4_src_port;
 
    sai_uint16_t l4_dst_port;
 
} sai_nat_entry_mask_t;
 
typedef struct _sai_nat_entry_data_t
{
    sai_nat_entry_key_t key;
 
    sai_nat_entry_mask_t mask;
 
} sai_nat_entry_data_t;
 
typedef struct _sai_nat_entry_t
{
    sai_object_id_t switch_id;
 
    sai_object_id_t vr_id;
 
    sai_nat_type_t nat_type;
 
    sai_nat_entry_data_t data;
 
} sai_nat_entry_t;
 
typedef enum _sai_nat_event_t
{
    SAI_NAT_EVENT_NONE,
 
    SAI_NAT_EVENT_AGED,
 
} sai_nat_event_t;
 
typedef struct _sai_nat_event_notification_data_t
{
    sai_nat_event_t event_type;
 
    sai_nat_entry_t nat_entry;
 
} sai_nat_event_notification_data_t;
 
typedef sai_status_t (*sai_create_nat_entry_fn)(
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_remove_nat_entry_fn)(
        _In_ const sai_nat_entry_t *nat_entry);
 
typedef sai_status_t (*sai_set_nat_entry_attribute_fn)(
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_nat_entry_attribute_fn)(
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef void (*sai_nat_event_notification_fn)(
        _In_ uint32_t count,
        _In_ const sai_nat_event_notification_data_t *data);
 
typedef sai_status_t (*sai_bulk_create_nat_entry_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ const uint32_t *attr_count,
        _In_ const sai_attribute_t **attr_list,
        _In_ sai_bulk_op_error_mode_t mode,
        _Out_ sai_status_t *object_statuses);
 
typedef sai_status_t (*sai_bulk_remove_nat_entry_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ sai_bulk_op_error_mode_t mode,
        _Out_ sai_status_t *object_statuses);
 
typedef sai_status_t (*sai_bulk_set_nat_entry_attribute_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ const sai_attribute_t *attr_list,
        _In_ sai_bulk_op_error_mode_t mode,
        _Out_ sai_status_t *object_statuses);
 
typedef sai_status_t (*sai_bulk_get_nat_entry_attribute_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_nat_entry_t *nat_entry,
        _In_ const uint32_t *attr_count,
        _Inout_ sai_attribute_t **attr_list,
        _In_ sai_bulk_op_error_mode_t mode,
        _Out_ sai_status_t *object_statuses);
 
typedef enum _sai_nat_zone_counter_attr_t
{
    SAI_NAT_ZONE_COUNTER_ATTR_START,
 
    SAI_NAT_ZONE_COUNTER_ATTR_NAT_TYPE = SAI_NAT_ZONE_COUNTER_ATTR_START,
 
    SAI_NAT_ZONE_COUNTER_ATTR_ZONE_ID,
 
    SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_DISCARD,
 
    SAI_NAT_ZONE_COUNTER_ATTR_DISCARD_PACKET_COUNT,
 
    SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_TRANSLATION_NEEDED,
 
    SAI_NAT_ZONE_COUNTER_ATTR_TRANSLATION_NEEDED_PACKET_COUNT,
 
    SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_TRANSLATIONS,
 
    SAI_NAT_ZONE_COUNTER_ATTR_TRANSLATIONS_PACKET_COUNT,
 
    SAI_NAT_ZONE_COUNTER_ATTR_END,
 
    SAI_NAT_ZONE_COUNTER_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_NAT_ZONE_COUNTER_ATTR_CUSTOM_RANGE_END
 
} sai_nat_zone_counter_attr_t;
 
typedef sai_status_t (*sai_create_nat_zone_counter_fn)(
        _Out_ sai_object_id_t *nat_zone_counter_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_remove_nat_zone_counter_fn)(
        _In_ sai_object_id_t nat_zone_counter_id);
 
typedef sai_status_t (*sai_set_nat_zone_counter_attribute_fn)(
        _In_ sai_object_id_t nat_zone_counter_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_nat_zone_counter_attribute_fn)(
        _In_ sai_object_id_t nat_zone_counter_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef struct _sai_nat_api_t
{
    sai_create_nat_entry_fn                   create_nat_entry;
    sai_remove_nat_entry_fn                   remove_nat_entry;
    sai_set_nat_entry_attribute_fn            set_nat_entry_attribute;
    sai_get_nat_entry_attribute_fn            get_nat_entry_attribute;
 
    sai_bulk_create_nat_entry_fn              create_nat_entries;
    sai_bulk_remove_nat_entry_fn              remove_nat_entries;
    sai_bulk_set_nat_entry_attribute_fn       set_nat_entries_attribute;
    sai_bulk_get_nat_entry_attribute_fn       get_nat_entries_attribute;
 
    sai_create_nat_zone_counter_fn            create_nat_zone_counter;
    sai_remove_nat_zone_counter_fn            remove_nat_zone_counter;
    sai_set_nat_zone_counter_attribute_fn     set_nat_zone_counter_attribute;
    sai_get_nat_zone_counter_attribute_fn     get_nat_zone_counter_attribute;
} sai_nat_api_t;
 
#endif