Skip to content

Add wide label attribute for objects with a label attribute #2327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zechengh09 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add wide label attribute for objects with a label attribute #2327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions inc/saiacl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3625,9 +3625,23 @@ typedef enum _sai_acl_counter_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_ACL_COUNTER_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify ACL counter.
*
* Replaces #SAI_ACL_COUNTER_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_ACL_COUNTER_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saicounter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ typedef enum _sai_counter_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_COUNTER_ATTR_LABEL,

Expand Down Expand Up @@ -120,6 +121,19 @@ typedef enum _sai_counter_attr_t
*/
SAI_COUNTER_ATTR_STAT_ID_LIST,

/**
* @brief Wide label attribute used to uniquely identify counter.
*
* Replaces #SAI_COUNTER_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_COUNTER_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/sailag.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ typedef enum _sai_lag_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_LAG_ATTR_LABEL,

Expand Down Expand Up @@ -213,6 +214,19 @@ typedef enum _sai_lag_attr_t
*/
SAI_LAG_ATTR_HASH_ALGORITHM,

/**
* @brief Wide label attribute used to uniquely identify empty LAG.
*
* Replaces #SAI_LAG_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_LAG_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saimirror.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,9 +400,23 @@ typedef enum _sai_mirror_session_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_MIRROR_SESSION_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify mirror session.
*
* Replaces #SAI_MIRROR_SESSION_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_MIRROR_SESSION_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/sainexthopgroup.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ typedef enum _sai_next_hop_group_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_NEXT_HOP_GROUP_ATTR_LABEL,

Expand All @@ -359,6 +360,19 @@ typedef enum _sai_next_hop_group_attr_t
*/
SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE,

/**
* @brief Wide label attribute used to uniquely identify next-hop-group.
*
* Replaces #SAI_NEXT_HOP_GROUP_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_NEXT_HOP_GROUP_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saipolicer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,23 @@ typedef enum _sai_policer_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_POLICER_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify identical policers.
*
* Replaces #SAI_POLICER_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_POLICER_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
15 changes: 15 additions & 0 deletions inc/saiprefixcompression.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ typedef enum _sai_prefix_compression_table_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_PREFIX_COMPRESSION_TABLE_ATTR_LABEL = SAI_PREFIX_COMPRESSION_TABLE_ATTR_START,

Expand All @@ -69,6 +70,20 @@ typedef enum _sai_prefix_compression_table_attr_t
*/
SAI_PREFIX_COMPRESSION_TABLE_ATTR_PREFIX_COMPRESSION_TYPE,

/**
* @brief Wide label attribute used to uniquely identify Table.
*
* Replaces #SAI_PREFIX_COMPRESSION_TABLE_ATTR_LABEL, which is limited
* to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_PREFIX_COMPRESSION_TABLE_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/sairouterinterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,7 @@ typedef enum _sai_router_interface_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_ROUTER_INTERFACE_ATTR_LABEL,

Expand Down Expand Up @@ -436,6 +437,19 @@ typedef enum _sai_router_interface_attr_t
*/
SAI_ROUTER_INTERFACE_ATTR_QOS_TC_AND_COLOR_TO_DOT1P_MAP,

/**
* @brief Wide label attribute used to uniquely identify router interface.
*
* Replaces #SAI_ROUTER_INTERFACE_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.

@kcudnik kcudnik Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from my perspective it could be valid, and more over they could be even different at the same time

@zechengh09 zechengh09 Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review - the wide label attribute is added to replace the current label attribute, which is marked as deprecated. It is kept for backward compatibility, but our goal is for both NOS and SDK starting using the new attribute in the new spec.

Therefore, only one attribute should be set at a given time. They could be different only if NOS starting to use the wide label with more than 32 characters.

*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_ROUTER_INTERFACE_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saischeduler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,23 @@ typedef enum _sai_scheduler_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_SCHEDULER_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify scheduler.
*
* Replaces #SAI_SCHEDULER_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_SCHEDULER_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saiudf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,23 @@ typedef enum _sai_udf_group_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_UDF_GROUP_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify UDF group.
*
* Replaces #SAI_UDF_GROUP_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_UDF_GROUP_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down
14 changes: 14 additions & 0 deletions inc/saivirtualrouter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,23 @@ typedef enum _sai_virtual_router_attr_t
* @type char
* @flags CREATE_AND_SET
* @default ""
* @deprecated true
*/
SAI_VIRTUAL_ROUTER_ATTR_LABEL,

/**
* @brief Wide label attribute used to uniquely identify empty VR.
*
* Replaces #SAI_VIRTUAL_ROUTER_ATTR_LABEL, which is limited to 32 bytes.
* Exactly one of the two attributes may be set to a non-default
* value; setting both is invalid.
*
* @type sai_s8_list_t
* @flags CREATE_AND_SET
* @default empty
*/
SAI_VIRTUAL_ROUTER_ATTR_LABEL_WIDE,

/**
* @brief End of attributes
*/
Expand Down