saidtel.h File Reference

This module defines SAI data plane telemetry (DTEL) interface. More...

#include <saitypes.h>

Go to the source code of this file.

Classes
struct	_sai_dtel_api_t

Typedefs
typedef enum _sai_dtel_attr_t	sai_dtel_attr_t
	DTEL attributes for the switch.
typedef enum _sai_dtel_queue_report_attr_t	sai_dtel_queue_report_attr_t
	Queue report trigger attributes.
typedef enum _sai_dtel_int_session_attr_t	sai_dtel_int_session_attr_t
	INT session attributes.
typedef enum _sai_dtel_report_session_attr_t	sai_dtel_report_session_attr_t
	DTEL report session attributes.
typedef enum _sai_dtel_event_type_t	sai_dtel_event_type_t
	Enum defining DTEL event types.
typedef enum _sai_dtel_event_attr_t	sai_dtel_event_attr_t
	DTEL events attributes.
typedef sai_status_t(*	sai_create_dtel_fn) (_Out_ sai_object_id_t *dtel_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create and return a DTEL object.
typedef sai_status_t(*	sai_remove_dtel_fn) (_In_ sai_object_id_t dtel_id)
	Delete a DTEL object.
typedef sai_status_t(*	sai_set_dtel_attribute_fn) (_In_ sai_object_id_t dtel_id, _In_ const sai_attribute_t *attr)
	Set DTEL attribute.
typedef sai_status_t(*	sai_get_dtel_attribute_fn) (_In_ sai_object_id_t dtel_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get DTEL attribute.
typedef sai_status_t(*	sai_create_dtel_queue_report_fn) (_Out_ sai_object_id_t *dtel_queue_report_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create and return a DTEL queue report object.
typedef sai_status_t(*	sai_remove_dtel_queue_report_fn) (_In_ sai_object_id_t dtel_queue_report_id)
	Delete a DTEL queue report.
typedef sai_status_t(*	sai_set_dtel_queue_report_attribute_fn) (_In_ sai_object_id_t dtel_queue_report_id, _In_ const sai_attribute_t *attr)
	Set DTEL queue report attribute.
typedef sai_status_t(*	sai_get_dtel_queue_report_attribute_fn) (_In_ sai_object_id_t dtel_queue_report_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get DTEL queue report attribute.
typedef sai_status_t(*	sai_create_dtel_int_session_fn) (_Out_ sai_object_id_t *dtel_int_session_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create and return a DTEL INT session object.
typedef sai_status_t(*	sai_remove_dtel_int_session_fn) (_In_ sai_object_id_t dtel_int_session_id)
	Delete a DTEL INT session.
typedef sai_status_t(*	sai_set_dtel_int_session_attribute_fn) (_In_ sai_object_id_t dtel_int_session_id, _In_ const sai_attribute_t *attr)
	Set DTEL INT session attribute.
typedef sai_status_t(*	sai_get_dtel_int_session_attribute_fn) (_In_ sai_object_id_t dtel_int_session_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get DTEL INT session attribute.
typedef sai_status_t(*	sai_create_dtel_report_session_fn) (_Out_ sai_object_id_t *dtel_report_session_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create and return a DTEL report session object.
typedef sai_status_t(*	sai_remove_dtel_report_session_fn) (_In_ sai_object_id_t dtel_report_session_id)
	Delete a DTEL report session.
typedef sai_status_t(*	sai_set_dtel_report_session_attribute_fn) (_In_ sai_object_id_t dtel_report_session_id, _In_ const sai_attribute_t *attr)
	Set DTEL report session attribute.
typedef sai_status_t(*	sai_get_dtel_report_session_attribute_fn) (_In_ sai_object_id_t dtel_report_session_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get DTEL report session attribute.
typedef sai_status_t(*	sai_create_dtel_event_fn) (_Out_ sai_object_id_t *dtel_event_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create and return a DTEL event object.
typedef sai_status_t(*	sai_remove_dtel_event_fn) (_In_ sai_object_id_t dtel_event_id)
	Delete a DTEL event.
typedef sai_status_t(*	sai_set_dtel_event_attribute_fn) (_In_ sai_object_id_t dtel_event_id, _In_ const sai_attribute_t *attr)
	Set DTEL event attribute.
typedef sai_status_t(*	sai_get_dtel_event_attribute_fn) (_In_ sai_object_id_t dtel_event_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get DTEL event attribute.
typedef struct _sai_dtel_api_t	sai_dtel_api_t

Enumerations
enum	_sai_dtel_attr_t {   SAI_DTEL_ATTR_START , SAI_DTEL_ATTR_INT_ENDPOINT_ENABLE = SAI_DTEL_ATTR_START , SAI_DTEL_ATTR_INT_TRANSIT_ENABLE , SAI_DTEL_ATTR_POSTCARD_ENABLE ,   SAI_DTEL_ATTR_DROP_REPORT_ENABLE , SAI_DTEL_ATTR_QUEUE_REPORT_ENABLE , SAI_DTEL_ATTR_SWITCH_ID , SAI_DTEL_ATTR_FLOW_STATE_CLEAR_CYCLE ,   SAI_DTEL_ATTR_LATENCY_SENSITIVITY , SAI_DTEL_ATTR_SINK_PORT_LIST , SAI_DTEL_ATTR_INT_L4_DSCP , SAI_DTEL_ATTR_END ,   SAI_DTEL_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_DTEL_ATTR_CUSTOM_RANGE_END }
	DTEL attributes for the switch. More...
enum	_sai_dtel_queue_report_attr_t {   SAI_DTEL_QUEUE_REPORT_ATTR_START , SAI_DTEL_QUEUE_REPORT_ATTR_QUEUE_ID = SAI_DTEL_QUEUE_REPORT_ATTR_START , SAI_DTEL_QUEUE_REPORT_ATTR_DEPTH_THRESHOLD , SAI_DTEL_QUEUE_REPORT_ATTR_LATENCY_THRESHOLD ,   SAI_DTEL_QUEUE_REPORT_ATTR_BREACH_QUOTA , SAI_DTEL_QUEUE_REPORT_ATTR_TAIL_DROP , SAI_DTEL_QUEUE_REPORT_ATTR_END , SAI_DTEL_QUEUE_REPORT_ATTR_CUSTOM_RANGE_START = 0x10000000 ,   SAI_DTEL_QUEUE_REPORT_ATTR_CUSTOM_RANGE_END }
	Queue report trigger attributes. More...
enum	_sai_dtel_int_session_attr_t {   SAI_DTEL_INT_SESSION_ATTR_START , SAI_DTEL_INT_SESSION_ATTR_MAX_HOP_COUNT = SAI_DTEL_INT_SESSION_ATTR_START , SAI_DTEL_INT_SESSION_ATTR_COLLECT_SWITCH_ID , SAI_DTEL_INT_SESSION_ATTR_COLLECT_SWITCH_PORTS ,   SAI_DTEL_INT_SESSION_ATTR_COLLECT_INGRESS_TIMESTAMP , SAI_DTEL_INT_SESSION_ATTR_COLLECT_EGRESS_TIMESTAMP , SAI_DTEL_INT_SESSION_ATTR_COLLECT_QUEUE_INFO , SAI_DTEL_INT_SESSION_ATTR_END ,   SAI_DTEL_INT_SESSION_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_DTEL_INT_SESSION_ATTR_CUSTOM_RANGE_END }
	INT session attributes. More...
enum	_sai_dtel_report_session_attr_t {   SAI_DTEL_REPORT_SESSION_ATTR_START , SAI_DTEL_REPORT_SESSION_ATTR_SRC_IP = SAI_DTEL_REPORT_SESSION_ATTR_START , SAI_DTEL_REPORT_SESSION_ATTR_DST_IP_LIST , SAI_DTEL_REPORT_SESSION_ATTR_VIRTUAL_ROUTER_ID ,   SAI_DTEL_REPORT_SESSION_ATTR_TRUNCATE_SIZE , SAI_DTEL_REPORT_SESSION_ATTR_UDP_DST_PORT , SAI_DTEL_REPORT_SESSION_ATTR_END , SAI_DTEL_REPORT_SESSION_ATTR_CUSTOM_RANGE_START = 0x10000000 ,   SAI_DTEL_REPORT_SESSION_ATTR_CUSTOM_RANGE_END }
	DTEL report session attributes. More...
enum	_sai_dtel_event_type_t {   SAI_DTEL_EVENT_TYPE_FLOW_STATE , SAI_DTEL_EVENT_TYPE_FLOW_REPORT_ALL_PACKETS , SAI_DTEL_EVENT_TYPE_FLOW_TCPFLAG , SAI_DTEL_EVENT_TYPE_QUEUE_REPORT_THRESHOLD_BREACH ,   SAI_DTEL_EVENT_TYPE_QUEUE_REPORT_TAIL_DROP , SAI_DTEL_EVENT_TYPE_DROP_REPORT , SAI_DTEL_EVENT_TYPE_MAX }
	Enum defining DTEL event types. More...
enum	_sai_dtel_event_attr_t {   SAI_DTEL_EVENT_ATTR_START , SAI_DTEL_EVENT_ATTR_TYPE = SAI_DTEL_EVENT_ATTR_START , SAI_DTEL_EVENT_ATTR_REPORT_SESSION , SAI_DTEL_EVENT_ATTR_DSCP_VALUE ,   SAI_DTEL_EVENT_ATTR_END , SAI_DTEL_EVENT_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_DTEL_EVENT_ATTR_CUSTOM_RANGE_END }
	DTEL events attributes. More...

Detailed Description

This module defines SAI data plane telemetry (DTEL) interface.

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.

Warning

This is a SAI experimental module

Definition in file saidtel.h.