-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prefix Compression feature addition to SAI
Signed-off-by: nshinoud <nshinoud@cisco.com> Change BINCODE to META - PR change request Signed-off-by: nshinoud <nshinoud@cisco.com> Additional changes based on requests from git review - Removed default meta attribute - Added stage for table creation - updated docs Signed-off-by: nshinoud <nshinoud@cisco.com> Fix typo: Changes SAI_ACL_TABLE_ATTR_PREFIX_COMPRESSION_STAGE to SAI_TABLE_ATTR_PREFIX_COMPRESSION_STAGE Signed-off-by: nshinoud <nshinoud@cisco.com> Fix metadata script error Signed-off-by: nshinoud <nshinoud@cisco.com> Another attempt to fix metadata issue. For some reason this passes on my local build Signed-off-by: nshinoud <nshinoud@cisco.com> Add support for Prefix Compression Table type: SRC, DST, BOTH Signed-off-by: nshinoud <nshinoud@cisco.com> Minor fix (change bincode to meta) Signed-off-by: nshinoud <nshinoud@cisco.com> Update comment Signed-off-by: nshinoud <nshinoud@cisco.com>
- Loading branch information
1 parent
7455ddf
commit a862dc8
Showing
6 changed files
with
726 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,308 @@ | ||
| # Prefix Compression # | ||
| ------------------------------------------------------------------------------- | ||
| Title | Prefix Compression | ||
| -------------|----------------------------------------------------------------- | ||
| Authors | Nader Shinouda, Cisco | ||
| Status | In review | ||
| Type | Standards track | ||
| Created | 2024-07-1 - Initial Draft | ||
| SAI-Version | 1.14 | ||
| ------------------------------------------------------------------------------- | ||
|
|
||
|
|
||
| ## 1.0 Introduction ## | ||
|
|
||
| This spec adds Prefix Compression. Prefix Compression allows mapping an IP prefix/mask (longest prefix) to a meta data value. These prefix/meta-data mapping can be grouped together to form a prefix compression table. Tables can have both IPV4 and IPV6 entries. | ||
|
|
||
| Prefix Compression tables can be used in features such as ACL to match on a specific meta field. This allows additional functionality to ACL or any feature that can take advantage of such groupings. | ||
|
|
||
| ## 1.1.0 Function Requirement of Prefix Compression | ||
| - Enable the creation of a prefix compresison table as a SAI object | ||
| - Enable adding IPV4/IPV6 Prefix mapping to a META value | ||
|
|
||
| ## 2.0 Specification ## | ||
|
|
||
| A prefix compression tables is represented by an object of SAI_PREFIX_COMPRESSION_TABLE. The creation of this object will allocate an empty table that can be used later to add specific entries to it. Table creation requires a stage to be associated with the table and also requires the type of table that is getting created: source addresses, destionation addresses or both. | ||
|
|
||
| ### sai.h ### | ||
| New type SAI_API_PREFIX_COMPRESSION is added into sai_api_t | ||
|
|
||
| ### saiobject.h ### | ||
| New entry sai_prefix_compression_entry_t prefix_compression_entry. | ||
|
|
||
|
|
||
| ### saitypes.h ### | ||
| Two new types: SAI_OBJECT_TYPE_PREFIX_COMPRESSION_TABLE and SAI_OBJECT_TYPE_PREFIX_COMPRESSION_ENTRY | ||
|
|
||
| ### New Header saiprefixcompression.h ### | ||
|
|
||
| #### sai_prefix_compression_table_attr_t #### | ||
| This defines the prefix compression attributes table | ||
|
|
||
| Tables are composed of prefix compression entries. These entries map a specific IP prefix to a meta data value. Both IPV4 and IPV6 entries can be added to the same table. During table creation a stage must be set to the table (Ingress/Egress) | ||
|
|
||
| ```c | ||
| typedef enum _sai_prefix_compression_table_attr_t | ||
| { | ||
| /** | ||
| * @brief Start of attributes | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_TABLE_ATTR_START, | ||
|
|
||
| /** | ||
| * @brief Label attribute used to unique identify Table. | ||
| * | ||
| * @type char | ||
| * @flags CREATE_AND_SET | ||
| * @default "" | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_TABLE_ATTR_LABEL = SAI_PREFIX_COMPRESSION_TABLE_ATTR_START, | ||
|
|
||
| /** | ||
| * @brief Prefix Compression table stage | ||
| * | ||
| * @type sai_prefix_compression_stage_t | ||
| * @flags MANDATORY_ON_CREATE | CREATE_ONLY | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_TABLE_ATTR_PREFIX_COMPRESSION_STAGE, | ||
|
|
||
| /** | ||
| * @brief Prefix Compression table type | ||
| * | ||
| * @type sai_prefix_compression_type_t | ||
| * @flags MANDATORY_ON_CREATE | CREATE_ONLY | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_TABLE_ATTR_PREFIX_COMPRESSION_TYPE, | ||
|
|
||
| ``` | ||
| #### sai_prefix_compression_entry_attr_t #### | ||
| Attributes structure for prefix compression entries | ||
| ```c | ||
| /** | ||
| * @brief Attribute Id for SAI prefix compression object | ||
| */ | ||
| typedef enum _sai_prefix_compression_entry_attr_t | ||
| { | ||
| /** | ||
| * @brief Start of attributes | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_ENTRY_ATTR_START, | ||
| /** | ||
| * @brief Prefix Compression entry META data | ||
| * | ||
| * @type sai_uint32_t | ||
| * @flags MANDATORY_ON_CREATE | CREATE_AND_SET | ||
| */ | ||
| SAI_PREFIX_COMPRESSION_ENTRY_ATTR_META = SAI_PREFIX_COMPRESSION_ENTRY_ATTR_START, | ||
| ``` | ||
|
|
||
| #### sai_prefix_compression_entry_t #### | ||
|
|
||
| This structure defines a prefix compression entry. A prefix compression entry is composed of switch ID, a table ID that the entry will be added to and a IP prefix | ||
|
|
||
| ```c | ||
| typedef struct _sai_prefix_compression_entry_t | ||
| { | ||
| /** | ||
| * @brief Switch ID | ||
| * | ||
| * @objects SAI_OBJECT_TYPE_SWITCH | ||
| */ | ||
| sai_object_id_t switch_id; | ||
|
|
||
| /** | ||
| * @brief Prefix Compression Table ID | ||
| * | ||
| * @objects SAI_OBJECT_TYPE_PREFIX_COMPRESSION_TABLE | ||
| */ | ||
| sai_object_id_t prefix_table_id; | ||
|
|
||
| /** | ||
| * @brief IP Prefix Destination | ||
| */ | ||
| sai_ip_prefix_t prefix; | ||
| ``` | ||
| #### sai_create_prefix_compression_table_fn #### | ||
| This defines the interface to create prefix compression table | ||
| - prefix_compression_table_id (Out): Prefix Compression table object ID | ||
| - switch_id (In): The ID of the switch on which the ICMP ECHO session is to be created. | ||
| - attr_count (In): The number of attributes provided in the attr_list. | ||
| - attr_list (In): An array of sai_attribute_t structures containing the attribute key-value pairs to configure the ICMP ECHO session. | ||
| #### sai_remove_prefix_compression_table_fn #### | ||
| The function takes a Prefix Compression object ID as a parameter. The function returns SAI_STATUS_SUCCESS if the operation is successful; otherwise, it returns a different error code indicating the nature of the failure. | ||
| #### sai_set_prefix_compression_table_attribute_fn #### | ||
| This defines the interfaces to update prefix compression table. It requires the unique identifier prefix_compression_table_id, and the attr parameter represents the attribute to be set along with its value. The function returns SAI_STATUS_SUCCESS if the operation is successful; otherwise, it returns an error code, indicating the nature of the failure. | ||
| #### sai_get_prefix_compression_table_attribute_fn #### | ||
| It takes the unique identifier prefix_compression_table_id to specify the Prefix Compression table for which attributes are to be retrieved. The attr_count parameter indicates the number of attributes in the attr_list, and the attr_list itself holds the values of the requested attributes. | ||
| #### sai_create_prefix_compression_entry_fn #### | ||
| This defines the interface to create prefix compression entry | ||
| - prefix_compression_entry (In): Prefix Compression table object ID | ||
| - attr_count (In): The number of attributes provided in the attr_list. | ||
| - attr_list (In): An array of sai_attribute_t structures containing the attribute key-value pairs to configure the ICMP ECHO session. | ||
| #### sai_set_prefix_compression_entry_attribute_fn #### | ||
| This defines the interfaces to update prefix compression entry. It takes the entry to be modified, and the attr parameter represents the attribute to be set along with its value. The function returns SAI_STATUS_SUCCESS if the operation is successful; otherwise, it returns an error code, indicating the nature of the failure. | ||
| #### sai_get_prefix_compression_entry_attribute_fn #### | ||
| It takes a specific entry that will be used to reterive information about the entry. The attr_count parameter indicates the number of attributes in the attr_list, and the attr_list itself holds the values of the requested attributes. | ||
| #### sai_bulk_create_prefix_compression_entry_fn #### | ||
| This defines a bulk entry create API that is used to create multiple entries at once. This API takes: | ||
| - object_count (In): Number of objects to create | ||
| - prefix_compression_entry (In): List of object to create | ||
| - attr_count (In): List of attr_count. Caller passes the number of attribute for each object to create. | ||
| - attr_list (In): List of attributes for every object. | ||
| - mode (In): Bulk operation error handling mode. | ||
| - object_statuses (Out): List of status for every object. Caller needs to allocate the buffer | ||
| #### sai_bulk_remove_prefix_compression_entry_fn #### | ||
| This defines a bulk remove of entries in a prefix compression table: | ||
| - object_count (In): Number of objects to remove | ||
| - prefix_compression_entry (In): List of objects to remove | ||
| - mode (In): Bulk operation error handling mode. | ||
| - object_statuses (Out): List of status for every object. Caller needs to allocate the buffer | ||
| #### sai_prefix_compression_api_t #### | ||
| ```c | ||
| typedef struct _sai_prefix_compression_api_t | ||
| { | ||
| sai_create_prefix_compression_table_fn create_prefix_compression_table; | ||
| sai_remove_prefix_compression_table_fn remove_prefix_compression_table; | ||
| sai_set_prefix_compression_table_attribute_fn set_prefix_compression_table_attribute; | ||
| sai_get_prefix_compression_table_attribute_fn get_prefix_compression_table_attribute; | ||
| sai_create_prefix_compression_entry_fn create_prefix_compression_entry; | ||
| sai_remove_prefix_compression_entry_fn remove_prefix_compression_entry; | ||
| sai_set_prefix_compression_entry_attribute_fn set_prefix_compression_entry_attribute; | ||
| sai_get_prefix_compression_entry_attribute_fn get_prefix_compression_entry_attribute; | ||
| sai_bulk_create_prefix_compression_entry_fn create_prefix_compression_entries; | ||
| sai_bulk_remove_prefix_compression_entry_fn remove_prefix_compression_entries; | ||
| } sai_prefix_compression_api_t; | ||
| ``` | ||
|
|
||
| ## 3 Examples | ||
|
|
||
| ## 3.0.1 Create Prefix Compression Table with entries | ||
|
|
||
| ```c | ||
| sai_attr_table_list[]; | ||
| sai_attr_table_list[0].id = SAI_ACL_TABLE_ATTR_PREFIX_COMPRESSION_STAGE; | ||
| sai_attr_table_list[0].value.s32 = SAI_PREFIX_COMPRESSION_STAGE_INGRESS; | ||
| attr_table_count = 0; | ||
| sai_create_prefix_compression_table_fn( | ||
| &src_prefix_compression_table_id, | ||
| switch_id, | ||
| attr_table_count, | ||
| sai_attr_table_list); | ||
|
|
||
| // Example: Create Prefix Compression Entries | ||
| // IPV4 First Entry | ||
| sai_prefix_compression_entry_t entry_v4_1; | ||
| entry_v4_1.switch_id = switch_id; | ||
| entry_v4_1.prefix_table_id = src_prefix_compression_table_id; | ||
| entry_v4_1.prefix.addr_family = SAI_IP_ADDR_FAMILY_IPV4; | ||
| entry_v4_1.prefix.addr.ipv4 = "1.1.1.1"; | ||
| entry_v4_1.prefix_mask.ipv4 = "255.255.255.0"; | ||
| sai_entry_list[0].id = SAI_PREFIX_COMPRESSION_ENTRY_ATTR_META; | ||
| sai_entry_list[0].value.u32 = 2; | ||
|
|
||
| // IPV4 Second Entry | ||
| sai_prefix_compression_entry_t entry_v4_1; | ||
| entry_v4_1.switch_id = switch_id; | ||
| entry_v4_1.prefix_table_id = src_prefix_compression_table_id; | ||
| entry_v4_1.prefix.addr_family = SAI_IP_ADDR_FAMILY_IPV4; | ||
| entry_v4_1.prefix.addr.ipv4 = "2.2.2.1"; | ||
| entry_v4_1.prefix_mask.ipv4 = "255.255.255.0"; | ||
| sai_entries_attribute_list[0].id = SAI_PREFIX_COMPRESSION_ENTRY_ATTR_META; | ||
| sai_entries_attribute_list[0].value.u32 = 800; | ||
|
|
||
| // IPV6 Entry | ||
| sai_prefix_compression_entry_t entry_v6_1; | ||
| entry_v6_1.switch_id = switch_id; | ||
| entry_v6_1.prefix_table_id = src_prefix_compression_table_id; | ||
| entry_v6_1.prefix.addr_family = SAI_IP_ADDR_FAMILY_IPV6; | ||
| entry_v6_1.prefix.addr.ipv4 ="2001:1::4"; | ||
| entry_v6_1.prefix_mask = "ffff:ffff:ffff:ffff:ffff:ffff:ffff:fffc"; | ||
| sai_entries_attribute_list[1].id = SAI_PREFIX_COMPRESSION_ENTRY_ATTR_META; | ||
| sai_entries_attribute_list[1].value.u32 = 4; | ||
|
|
||
| entries_list = [entry_v4_2, entry_v6_1]; | ||
| entries_list_size = 2; | ||
| sai_status_t bulk_status; | ||
|
|
||
| // Adding a single entry to a table | ||
| sai_attr_list_count = 1; | ||
| sai_create_prefix_compression_entry_fn( | ||
| entry_v4_1, | ||
| sai_attr_list, | ||
| sai_attr_list_count); | ||
|
|
||
| // Adding using bulk add | ||
| attr_entries_count = 2; | ||
| sai_bulk_create_prefix_compression_entry_fn( | ||
| entries_list_size, | ||
| entries_list, | ||
| attr_entries_count, | ||
| sai_entries_attribute_list, | ||
| SAI_BULK_OP_ERROR_MODE_STOP_ON_ERROR, | ||
| bulk_status); | ||
|
|
||
| // Example of using Prefix Compression with ACL | ||
| // Create ACL table | ||
| sai_table_attr_list[0].id = SAI_ACL_TABLE_ATTR_SRC_PREFIX_COMPRESSION_TABLE; | ||
| sai_table_attr_list[0].value.oid = src_prefix_compression_table_id; | ||
| sai_table_attr_count = 1; | ||
|
|
||
| sai_create_acl_table_fn( | ||
| &acl_table_id, | ||
| switch_id, | ||
| sai_table_attr_count, | ||
| sai_table_attr_list); | ||
|
|
||
| sai_entry_attr_list[0].id = SAI_ACL_ENTRY_ATTR_FIELD_SRC_PREFIX_META; | ||
| sai_attr_list[1].value.aclfield.enable = true; | ||
| sai_attr_list[1].value.aclfield.mask = 0xFFFFFF; | ||
| sai_attr_list[1].value.aclfield.data = 800; | ||
| sai_entry_attr_count = 1; | ||
|
|
||
| // Create an Entry to match on META data | ||
| sai_create_acl_entry_fn( | ||
| &acl_entry_id, | ||
| switch_id, | ||
| sai_entry_attr_count, | ||
| sai_entry_attr_list); | ||
|
|
||
| // Remove ACL entry | ||
| sai_create_acl_entry_fn( | ||
| acl_entry_id); | ||
|
|
||
| // Remove ACL Table | ||
| sai_create_acl_entry_fn( | ||
| acl_table_id); | ||
|
|
||
| // Remove Single Entry | ||
| sai_remove_prefix_compression_entry_fn( | ||
| entry_v4_1); | ||
|
|
||
| // Remove Bulk Entries | ||
| sai_bulk_remove_prefix_compression_entry_fn( | ||
| entries_list_size, | ||
| entries_list, | ||
| SAI_BULK_OP_ERROR_MODE_STOP_ON_ERROR, | ||
| bulk_status); | ||
|
|
||
| // Remove Prefix Compression Table | ||
| sai_remove_prefix_compression_table_fn( | ||
| src_prefix_compression_table_id); | ||
|
|
||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.