SAI Metadata
|
Classes | |
struct | _sai_queue_deadlock_notification_data_t |
Notification data format received from SAI queue deadlock event callback. More... | |
struct | _sai_queue_api_t |
QOS methods table retrieved with sai_api_query() More... | |
Typedefs | |
typedef enum _sai_queue_type_t | sai_queue_type_t |
Enum defining Queue types. | |
typedef enum _sai_queue_pfc_continuous_deadlock_state_t | sai_queue_pfc_continuous_deadlock_state_t |
Enum defining queue PFC continuous deadlock state. | |
typedef enum _sai_queue_attr_t | sai_queue_attr_t |
Enum defining queue attributes. | |
typedef enum _sai_queue_stat_t | sai_queue_stat_t |
Enum defining statistics for Queue. | |
typedef enum _sai_queue_pfc_deadlock_event_type_t | sai_queue_pfc_deadlock_event_type_t |
Enum defining Queue deadlock event state. | |
typedef struct _sai_queue_deadlock_notification_data_t | sai_queue_deadlock_notification_data_t |
Notification data format received from SAI queue deadlock event callback. | |
typedef sai_status_t(* | sai_create_queue_fn) (_Out_ sai_object_id_t *queue_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create queue. | |
typedef sai_status_t(* | sai_remove_queue_fn) (_In_ sai_object_id_t queue_id) |
Remove queue. | |
typedef sai_status_t(* | sai_set_queue_attribute_fn) (_In_ sai_object_id_t queue_id, _In_ const sai_attribute_t *attr) |
Set attribute to Queue. | |
typedef sai_status_t(* | sai_get_queue_attribute_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get attribute to Queue. | |
typedef sai_status_t(* | sai_get_queue_stats_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _Out_ uint64_t *counters) |
Get queue statistics counters. Deprecated for backward compatibility. | |
typedef sai_status_t(* | sai_get_queue_stats_ext_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t *counters) |
Get queue statistics counters extended. | |
typedef sai_status_t(* | sai_clear_queue_stats_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids) |
Clear queue statistics counters. | |
typedef void(* | sai_queue_pfc_deadlock_notification_fn) (_In_ uint32_t count, _In_ const sai_queue_deadlock_notification_data_t *data) |
Queue PFC deadlock event notification. | |
typedef struct _sai_queue_api_t | sai_queue_api_t |
QOS methods table retrieved with sai_api_query() | |
typedef sai_status_t(* sai_clear_queue_stats_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids) |
Clear queue statistics counters.
[in] | queue_id | Queue id |
[in] | number_of_counters | Number of counters in the array |
[in] | counter_ids | Specifies the array of counter ids |
Definition at line 537 of file saiqueue.h.
typedef sai_status_t(* sai_create_queue_fn) (_Out_ sai_object_id_t *queue_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create queue.
[out] | queue_id | Queue id |
[in] | switch_id | Switch id |
[in] | attr_count | Number of attributes |
[in] | attr_list | Array of attributes |
Definition at line 452 of file saiqueue.h.
typedef sai_status_t(* sai_get_queue_attribute_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get attribute to Queue.
[in] | queue_id | Queue id to set the attribute |
[in] | attr_count | Number of attributes |
[in,out] | attr_list | Array of attributes |
Definition at line 489 of file saiqueue.h.
typedef sai_status_t(* sai_get_queue_stats_ext_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t *counters) |
Get queue statistics counters extended.
[in] | queue_id | Queue id |
[in] | number_of_counters | Number of counters in the array |
[in] | counter_ids | Specifies the array of counter ids |
[in] | mode | Statistics mode |
[out] | counters | Array of resulting counter values. |
Definition at line 521 of file saiqueue.h.
typedef sai_status_t(* sai_get_queue_stats_fn) (_In_ sai_object_id_t queue_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _Out_ uint64_t *counters) |
Get queue statistics counters. Deprecated for backward compatibility.
[in] | queue_id | Queue id |
[in] | number_of_counters | Number of counters in the array |
[in] | counter_ids | Specifies the array of counter ids |
[out] | counters | Array of resulting counter values. |
Definition at line 504 of file saiqueue.h.
typedef void(* sai_queue_pfc_deadlock_notification_fn) (_In_ uint32_t count, _In_ const sai_queue_deadlock_notification_data_t *data) |
Queue PFC deadlock event notification.
Passed as a parameter into sai_initialize_switch()
[in] | count | Number of notifications |
[in] | data | Array of queue event types |
Definition at line 552 of file saiqueue.h.
typedef sai_status_t(* sai_remove_queue_fn) (_In_ sai_object_id_t queue_id) |
Remove queue.
[in] | queue_id | Queue id |
Definition at line 465 of file saiqueue.h.
typedef sai_status_t(* sai_set_queue_attribute_fn) (_In_ sai_object_id_t queue_id, _In_ const sai_attribute_t *attr) |
Set attribute to Queue.
[in] | queue_id | Queue ID to set the attribute |
[in] | attr | Attribute to set |
Definition at line 476 of file saiqueue.h.
enum _sai_queue_attr_t |
Enum defining queue attributes.
Enumerator | |
---|---|
SAI_QUEUE_ATTR_START | Start of attributes. |
SAI_QUEUE_ATTR_TYPE | Queue type.
|
SAI_QUEUE_ATTR_PORT | Port id.
|
SAI_QUEUE_ATTR_INDEX | Queue index.
|
SAI_QUEUE_ATTR_PARENT_SCHEDULER_NODE | Parent scheduler node. In case of Hierarchical QOS not supported, the parent node is the port. Condition on whether Hierarchical QOS is supported or not, need to remove the MANDATORY_ON_CREATE FLAG when HQoS is introduced.
|
SAI_QUEUE_ATTR_WRED_PROFILE_ID | Attach WRED ID to queue. ID = SAI_NULL_OBJECT_ID to disable WRED
|
SAI_QUEUE_ATTR_BUFFER_PROFILE_ID | Attach buffer profile to queue.
|
SAI_QUEUE_ATTR_SCHEDULER_PROFILE_ID | Attach scheduler to queue.
|
SAI_QUEUE_ATTR_PAUSE_STATUS | Queue pause status. This attribute represents the queue internal hardware state and is updated upon receiving PFC frames. True indicates the queue is paused.
|
SAI_QUEUE_ATTR_ENABLE_PFC_DLDR | Enable PFC Deadlock Detection and Recovery (DLDR) on a lossless queue. A deadlock is assumed to have occurred when a queue is in a XOFF state for more than a configurable (SAI_SWITCH_ATTR_PFC_TC_DLD_INTERVAL) amount of time.
|
SAI_QUEUE_ATTR_PFC_DLR_INIT | Start PFC deadlock recovery on a lossless queue. If the attribute is true, start the recovery and ignore if recovery has been started. If the attribute is false, stop the recovery and ignore if recovery hasn't been started.
|
SAI_QUEUE_ATTR_TAM_OBJECT | Queue bind point for TAM object.
|
SAI_QUEUE_ATTR_PFC_DLR_PACKET_ACTION | Control for buffered and incoming packets on a queue undergoing PFC Deadlock Recovery. This control applies to all packets on the queue.
|
SAI_QUEUE_ATTR_PFC_CONTINUOUS_DEADLOCK_STATE | Queue PFC continuous deadlock state. This attribute represents the queue's internal hardware PFC continuous deadlock state. It is an aggregation of all HW state used to determine if a queue is in PFC deadlock based on state cached/maintained by the SDK. Consecutive queries of this attribute provide the PFC state for the queue for the interval period between the queries. This attribute should only be queried as part of the PFC deadlock and recovery detection processing.
|
SAI_QUEUE_ATTR_END | End of attributes. |
SAI_QUEUE_ATTR_CUSTOM_RANGE_START | Custom range base value |
SAI_QUEUE_ATTR_CUSTOM_RANGE_END | End of custom range base |
Definition at line 102 of file saiqueue.h.
Enum defining queue PFC continuous deadlock state.
Definition at line 67 of file saiqueue.h.
Enum defining Queue deadlock event state.
Enumerator | |
---|---|
SAI_QUEUE_PFC_DEADLOCK_EVENT_TYPE_DETECTED | PFC deadlock detected |
SAI_QUEUE_PFC_DEADLOCK_EVENT_TYPE_RECOVERED | PFC deadlock recovery ended |
Definition at line 404 of file saiqueue.h.
enum _sai_queue_stat_t |
Enum defining statistics for Queue.
Definition at line 277 of file saiqueue.h.
enum _sai_queue_type_t |
Enum defining Queue types.
Definition at line 39 of file saiqueue.h.