experimental/saiexperimentaldashvip.h

/**
 * Copyright (c) 2014 Microsoft Open Technologies, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License"); you may
 *    not use this file except in compliance with the License. You may obtain
 *    a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
 *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
 *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
 *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
 *
 *    See the Apache Version 2.0 License for specific language governing
 *    permissions and limitations under the License.
 *
 *    Microsoft would like to thank the following companies for their review and
 *    assistance with these files: Intel Corporation, Mellanox Technologies Ltd,
 *    Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
 *
 * @file    saiexperimentaldashvip.h
 *
 * @brief   This module defines SAI extensions for DASH VIP
 *
 * @warning This module is a SAI experimental module
 */

#if !defined (__SAIEXPERIMENTALDASHVIP_H_)
#define __SAIEXPERIMENTALDASHVIP_H_

#include <saitypesextensions.h>

/**
 * @defgroup SAIEXPERIMENTALDASHVIP SAI - Experimental: DASH VIP specific API definitions
 *
 * @{
 */

/**
 * @brief Attribute data for #SAI_VIP_ENTRY_ATTR_ACTION
 */
typedef enum _sai_vip_entry_action_t
{
    SAI_VIP_ENTRY_ACTION_ACCEPT,

} sai_vip_entry_action_t;

/**
 * @brief Entry for vip_entry
 */
typedef struct _sai_vip_entry_t
{
    /**
     * @brief Switch ID
     *
     * @objects SAI_OBJECT_TYPE_SWITCH
     */
    sai_object_id_t switch_id;

    /**
     * @brief Exact matched key VIP
     */
    sai_ip_address_t vip;

} sai_vip_entry_t;

/**
 * @brief Attribute ID for VIP entry
 */
typedef enum _sai_vip_entry_attr_t
{
    /**
     * @brief Start of attributes
     */
    SAI_VIP_ENTRY_ATTR_START,

    /**
     * @brief Action
     *
     * @type sai_vip_entry_action_t
     * @flags CREATE_AND_SET
     * @default SAI_VIP_ENTRY_ACTION_ACCEPT
     */
    SAI_VIP_ENTRY_ATTR_ACTION = SAI_VIP_ENTRY_ATTR_START,

    /**
     * @brief IP address family for resource accounting
     *
     * @type sai_ip_addr_family_t
     * @flags READ_ONLY
     * @isresourcetype true
     */
    SAI_VIP_ENTRY_ATTR_IP_ADDR_FAMILY,

    /**
     * @brief End of attributes
     */
    SAI_VIP_ENTRY_ATTR_END,

    /** Custom range base value */
    SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000,

    /** End of custom range base */
    SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_END,

} sai_vip_entry_attr_t;

/**
 * @brief Create VIP entry
 *
 * @param[in] vip_entry Entry
 * @param[in] attr_count Number of attributes
 * @param[in] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success Failure status code on error
 */
typedef sai_status_t (*sai_create_vip_entry_fn)(
        _In_ const sai_vip_entry_t *vip_entry,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);

/**
 * @brief Remove VIP entry
 *
 * @param[in] vip_entry Entry
 *
 * @return #SAI_STATUS_SUCCESS on success Failure status code on error
 */
typedef sai_status_t (*sai_remove_vip_entry_fn)(
        _In_ const sai_vip_entry_t *vip_entry);

/**
 * @brief Set attribute for VIP entry
 *
 * @param[in] vip_entry Entry
 * @param[in] attr Attribute
 *
 * @return #SAI_STATUS_SUCCESS on success Failure status code on error
 */
typedef sai_status_t (*sai_set_vip_entry_attribute_fn)(
        _In_ const sai_vip_entry_t *vip_entry,
        _In_ const sai_attribute_t *attr);

/**
 * @brief Get attribute for VIP entry
 *
 * @param[in] vip_entry Entry
 * @param[in] attr_count Number of attributes
 * @param[inout] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success Failure status code on error
 */
typedef sai_status_t (*sai_get_vip_entry_attribute_fn)(
        _In_ const sai_vip_entry_t *vip_entry,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);

/**
 * @brief Bulk create VIP entry
 *
 * @param[in] object_count Number of objects to create
 * @param[in] vip_entry List of object to create
 * @param[in] attr_count List of attr_count. Caller passes the number
 *    of attribute for each object to create.
 * @param[in] attr_list List of attributes for every object.
 * @param[in] mode Bulk operation error handling mode.
 * @param[out] object_statuses List of status for every object. Caller needs to
 * allocate the buffer
 *
 * @return #SAI_STATUS_SUCCESS on success when all objects are created or
 * #SAI_STATUS_FAILURE when any of the objects fails to create. When there is
 * failure, Caller is expected to go through the list of returned statuses to
 * find out which fails and which succeeds.
 */
typedef sai_status_t (*sai_bulk_create_vip_entry_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_vip_entry_t *vip_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);

/**
 * @brief Bulk remove VIP entry
 *
 * @param[in] object_count Number of objects to remove
 * @param[in] vip_entry List of objects to remove
 * @param[in] mode Bulk operation error handling mode.
 * @param[out] object_statuses List of status for every object. Caller needs to
 * allocate the buffer
 *
 * @return #SAI_STATUS_SUCCESS on success when all objects are removed or
 * #SAI_STATUS_FAILURE when any of the objects fails to remove. When there is
 * failure, Caller is expected to go through the list of returned statuses to
 * find out which fails and which succeeds.
 */
typedef sai_status_t (*sai_bulk_remove_vip_entry_fn)(
        _In_ uint32_t object_count,
        _In_ const sai_vip_entry_t *vip_entry,
        _In_ sai_bulk_op_error_mode_t mode,
        _Out_ sai_status_t *object_statuses);

typedef struct _sai_dash_vip_api_t
{
    sai_create_vip_entry_fn           create_vip_entry;
    sai_remove_vip_entry_fn           remove_vip_entry;
    sai_set_vip_entry_attribute_fn    set_vip_entry_attribute;
    sai_get_vip_entry_attribute_fn    get_vip_entry_attribute;
    sai_bulk_create_vip_entry_fn      create_vip_entries;
    sai_bulk_remove_vip_entry_fn      remove_vip_entries;

} sai_dash_vip_api_t;

/**
 * @}
 */
#endif /** __SAIEXPERIMENTALDASHVIP_H_ */