-
Notifications
You must be signed in to change notification settings - Fork 485
/
saitam.h
2188 lines (1920 loc) · 56.4 KB
/
saitam.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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 saitam.h
*
* @brief This module defines SAI TAM (Telemetry And Monitoring) spec
*/
#if !defined (__SAITAM_H_)
#define __SAITAM_H_
#include <saitypes.h>
/**
* @defgroup SAITAM SAI - Telemetry and monitoring specific API definitions
*
* @{
*/
/**
* @brief TAM Attributes.
*/
typedef enum _sai_tam_attr_t
{
/**
* @brief Start of Attributes
*/
SAI_TAM_ATTR_START,
/**
* @brief Tam telemetry objects associated with this tam
*
* @type sai_object_list_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_TAM_TELEMETRY
* @default empty
*/
SAI_TAM_ATTR_TELEMETRY_OBJECTS_LIST = SAI_TAM_ATTR_START,
/**
* @brief Tam event objects associated with this tam
*
* @type sai_object_list_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_TAM_EVENT
* @default empty
*/
SAI_TAM_ATTR_EVENT_OBJECTS_LIST,
/**
* @brief Tam INT objects associated with this tam
*
* @type sai_object_list_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_TAM_INT
* @default empty
*/
SAI_TAM_ATTR_INT_OBJECTS_LIST,
/**
* @brief List of TAM bind points where this object will be applied.
*
* TAM group bind point list - create only attribute required for TAM
* object to let the user specify his intention to allow the
* source to generate data.
*
* @type sai_s32_list_t sai_tam_bind_point_type_t
* @flags CREATE_ONLY
* @default empty
*/
SAI_TAM_ATTR_TAM_BIND_POINT_TYPE_LIST,
/**
* @brief End of Attributes
*/
SAI_TAM_ATTR_END,
/** Custom range base value */
SAI_TAM_ATTR_CUSTOM_RANGE_START = 0x10000000,
/** End of custom range base */
SAI_TAM_ATTR_CUSTOM_RANGE_END
} sai_tam_attr_t;
/**
* @brief Create and return a TAM object
*
* This creates a TAM object in the driver for tracking the buffer usage.
* Via the attributes, caller may indicate a preference for tracking of a
* specific set of statistics/groups.
*
* @param[out] tam_id TAM object
* @param[in] switch_id Switch object id
* @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_tam_fn)(
_Out_ sai_object_id_t *tam_id,
_In_ sai_object_id_t switch_id,
_In_ uint32_t attr_count,
_In_ const sai_attribute_t *attr_list);
/**
* @brief Deletes a specified tam object.
*
* Deleting a TAM object also deletes all associated report and threshold objects.
*
* @param[in] tam_id TAM object to be removed.
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_remove_tam_fn)(
_In_ sai_object_id_t tam_id);
/**
* @brief Set TAM attribute value(s).
*
* @param[in] tam_id TAM id
* @param[in] attr Attribute to set
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_set_tam_attribute_fn)(
_In_ sai_object_id_t tam_id,
_In_ const sai_attribute_t *attr);
/**
* @brief Get values for specified TAM attributes.
*
* @param[in] tam_id TAM object id
* @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_tam_attribute_fn)(
_In_ sai_object_id_t tam_id,
_In_ uint32_t attr_count,
_Inout_ sai_attribute_t *attr_list);
/**
* @brief TAM Telemetry Math Function types
*/
typedef enum _sai_tam_tel_math_func_type_t
{
/** None */
SAI_TAM_TEL_MATH_FUNC_TYPE_NONE,
/** Geometric mean */
SAI_TAM_TEL_MATH_FUNC_TYPE_GEO_MEAN,
/** Algebraic mean */
SAI_TAM_TEL_MATH_FUNC_TYPE_ALGEBRAIC_MEAN,
/** Average */
SAI_TAM_TEL_MATH_FUNC_TYPE_AVERAGE,
/** Statistical function Mode */
SAI_TAM_TEL_MATH_FUNC_TYPE_MODE,
/** Packet Rate computation */
SAI_TAM_TEL_MATH_FUNC_TYPE_RATE,
} sai_tam_tel_math_func_type_t;
/**
* @brief Attributes for Math function
*/
typedef enum _sai_tam_math_func_attr_t
{
/**
* @brief Start of Attributes
*/
SAI_TAM_MATH_FUNC_ATTR_START,
/**
* @brief Type of math function
*
* @type sai_tam_tel_math_func_type_t
* @flags CREATE_AND_SET
* @default SAI_TAM_TEL_MATH_FUNC_TYPE_NONE
*/
SAI_TAM_MATH_FUNC_ATTR_TAM_TEL_MATH_FUNC_TYPE = SAI_TAM_MATH_FUNC_ATTR_START,
/**
* @brief End of Attributes
*/
SAI_TAM_MATH_FUNC_ATTR_END,
/** Custom range base value */
SAI_TAM_MATH_FUNC_ATTR_CUSTOM_RANGE_START = 0x10000000,
/** End of custom range base */
SAI_TAM_MATH_FUNC_ATTR_CUSTOM_RANGE_END
} sai_tam_math_func_attr_t;
/**
* @brief Create and return a math function object
*
* @param[out] tam_math_func_id Object id for math function
* @param[in] switch_id Switch object id
* @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_tam_math_func_fn)(
_Out_ sai_object_id_t *tam_math_func_id,
_In_ sai_object_id_t switch_id,
_In_ uint32_t attr_count,
_In_ const sai_attribute_t *attr_list);
/**
* @brief Deletes a specified Match function object
*
* @param[in] tam_math_func_id Object id for math function
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_remove_tam_math_func_fn)(
_In_ sai_object_id_t tam_math_func_id);
/**
* @brief Get values for specified Math function attributes
*
* @param[in] tam_math_func_id Object id for math function
* @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_tam_math_func_attribute_fn)(
_In_ sai_object_id_t tam_math_func_id,
_In_ uint32_t attr_count,
_Inout_ sai_attribute_t *attr_list);
/**
* @brief Set value for specified Math function attribute
*
* @param[in] tam_math_func_id Object id for math function
* @param[in] attr Attribute
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_set_tam_math_func_attribute_fn)(
_In_ sai_object_id_t tam_math_func_id,
_In_ const sai_attribute_t *attr);
/**
* @brief TAM event threshold unit
*/
typedef enum _sai_tam_event_threshold_unit_t
{
/**
* @brief Event threshold unit nanosecond
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_NANOSEC,
/**
* @brief Event threshold unit micro second
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_USEC,
/**
* @brief Event threshold unit millisecond
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_MSEC,
/**
* @brief Event threshold unit percent
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_PERCENT,
/**
* @brief Event threshold unit byte count
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_BYTES,
/**
* @brief Event threshold unit packet count
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_PACKETS,
/**
* @brief Event threshold unit cells
*/
SAI_TAM_EVENT_THRESHOLD_UNIT_CELLS
} sai_tam_event_threshold_unit_t;
/**
* @brief Event Threshold Attributes
*/
typedef enum _sai_tam_event_threshold_attr_t
{
/**
* @brief Start of Attributes
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_START,
/**
* @brief High water mark
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 90
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_HIGH_WATERMARK = SAI_TAM_EVENT_THRESHOLD_ATTR_START,
/**
* @brief Low Water Mark
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 10
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_LOW_WATERMARK,
/**
* @brief Latency in nanoseconds
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 10
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_LATENCY,
/**
* @brief Rate for specified event type
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_RATE,
/**
* @brief Abs Value for specified Event
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_ABS_VALUE,
/**
* @brief Tam event threshold unit
*
* @type sai_tam_event_threshold_unit_t
* @flags CREATE_AND_SET
* @default SAI_TAM_EVENT_THRESHOLD_UNIT_MSEC
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_UNIT,
/**
* @brief End of Attributes
*/
SAI_TAM_EVENT_THRESHOLD_ATTR_END,
/** Custom range base value */
SAI_TAM_EVENT_THRESHOLD_ATTR_CUSTOM_RANGE_START = 0x10000000,
/** End of custom range base */
SAI_TAM_EVENT_THRESHOLD_ATTR_CUSTOM_RANGE_END
} sai_tam_event_threshold_attr_t;
/**
* @brief Create and return a threshold object
*
* @param[out] tam_event_threshold_id Event Threshold object
* @param[in] switch_id Switch object id
* @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_tam_event_threshold_fn)(
_Out_ sai_object_id_t *tam_event_threshold_id,
_In_ sai_object_id_t switch_id,
_In_ uint32_t attr_count,
_In_ const sai_attribute_t *attr_list);
/**
* @brief Deletes a specified threshold object
*
* @param[in] tam_event_threshold_id Event Threshold object
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_remove_tam_event_threshold_fn)(
_In_ sai_object_id_t tam_event_threshold_id);
/**
* @brief Get values for specified threshold object attributes
*
* @param[in] tam_event_threshold_id Event Threshold object
* @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_tam_event_threshold_attribute_fn)(
_In_ sai_object_id_t tam_event_threshold_id,
_In_ uint32_t attr_count,
_Inout_ sai_attribute_t *attr_list);
/**
* @brief Set value for a specified threshold object attribute
*
* @param[in] tam_event_threshold_id Event Threshold object
* @param[in] attr Attribute
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_set_tam_event_threshold_attribute_fn)(
_In_ sai_object_id_t tam_event_threshold_id,
_In_ const sai_attribute_t *attr);
/**
* @brief TAM INT types
*/
typedef enum _sai_tam_int_type_t
{
/**
* @brief INT type IOAM
*/
SAI_TAM_INT_TYPE_IOAM,
/**
* @brief INT type IFA1
*/
SAI_TAM_INT_TYPE_IFA1,
/**
* @brief INT type IFA2
*/
SAI_TAM_INT_TYPE_IFA2,
/**
* @brief INT type P4 INT v1
*/
SAI_TAM_INT_TYPE_P4_INT_1,
/**
* @brief INT type P4 INT v2
*/
SAI_TAM_INT_TYPE_P4_INT_2,
/**
* @brief Direct Export (aka postcard)
*/
SAI_TAM_INT_TYPE_DIRECT_EXPORT,
/**
* @brief Telemetry data at the end of the packet
*/
SAI_TAM_INT_TYPE_IFA1_TAILSTAMP,
/**
* @brief INT type Path Tracing
*/
SAI_TAM_INT_TYPE_PATH_TRACING,
} sai_tam_int_type_t;
/**
* @brief Type of indication of INT presence in a packet
*/
typedef enum _sai_tam_int_presence_type_t
{
/**
* @brief Indication of INT presence in a packet is undefined
*
* This type can be used when all indications of INT presence
* in a packet are defined in well known specifications
*/
SAI_TAM_INT_PRESENCE_TYPE_UNDEFINED,
/**
* @brief INT presence type probe marker
*/
SAI_TAM_INT_PRESENCE_TYPE_PB,
/**
* @brief INT presence type L3 protocol
*/
SAI_TAM_INT_PRESENCE_TYPE_L3_PROTOCOL,
/**
* @brief INT presence type DSCP
*/
SAI_TAM_INT_PRESENCE_TYPE_DSCP
} sai_tam_int_presence_type_t;
/**
* @brief Attributes for TAM INT
*/
typedef enum _sai_tam_int_attr_t
{
/**
* @brief Start of Attributes
*/
SAI_TAM_INT_ATTR_START,
/**
* @brief Type of INT method
*
* @type sai_tam_int_type_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
*/
SAI_TAM_INT_ATTR_TYPE = SAI_TAM_INT_ATTR_START,
/**
* @brief Device Identifier
*
* @type sai_uint32_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
*/
SAI_TAM_INT_ATTR_DEVICE_ID,
/**
* @brief IOAM trace type
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 0
* @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IOAM
*/
SAI_TAM_INT_ATTR_IOAM_TRACE_TYPE,
/**
* @brief Type of indication of INT presence in a packet
*
* @type sai_tam_int_presence_type_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
*/
SAI_TAM_INT_ATTR_INT_PRESENCE_TYPE,
/**
* @brief First 4 octets of Probe Marker value that indicates INT presence
*
* @type sai_uint32_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
* @condition SAI_TAM_INT_ATTR_INT_PRESENCE_TYPE == SAI_TAM_INT_PRESENCE_TYPE_PB
*/
SAI_TAM_INT_ATTR_INT_PRESENCE_PB1,
/**
* @brief Second 4 octets of Probe Marker value that indicates INT presence
*
* @type sai_uint32_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
* @condition SAI_TAM_INT_ATTR_INT_PRESENCE_TYPE == SAI_TAM_INT_PRESENCE_TYPE_PB
*/
SAI_TAM_INT_ATTR_INT_PRESENCE_PB2,
/**
* @brief DSCP value that indicates presence of INT in a packet
*
* @type sai_uint8_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
* @condition SAI_TAM_INT_ATTR_INT_PRESENCE_TYPE == SAI_TAM_INT_PRESENCE_TYPE_DSCP
*/
SAI_TAM_INT_ATTR_INT_PRESENCE_DSCP_VALUE,
/**
* @brief Inline or Clone mode
* Inline mode will insert header and metadata in live packet
* Clone mode will insert header and metadata in cloned packet
*
* @type bool
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
*/
SAI_TAM_INT_ATTR_INLINE,
/**
* @brief L3 protocol value that indicates presence of INT in a packet
*
* @type sai_uint8_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
* @condition SAI_TAM_INT_ATTR_INT_PRESENCE_TYPE == SAI_TAM_INT_PRESENCE_TYPE_L3_PROTOCOL
*/
SAI_TAM_INT_ATTR_INT_PRESENCE_L3_PROTOCOL,
/**
* @brief Trace vector value
* trace vector is used to specified the fields
* of interest in metadata header
*
* @type sai_uint16_t
* @flags CREATE_AND_SET
* @isvlan false
* @default 0
* @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IFA1 or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IFA2
*/
SAI_TAM_INT_ATTR_TRACE_VECTOR,
/**
* @brief Action vector value
* action vector is used to specified the actions
* of interest on metadata header
* value of 0 means no actions of interest
*
* @type sai_uint16_t
* @flags CREATE_AND_SET
* @isvlan false
* @default 0
* @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IFA1 or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IFA2
*/
SAI_TAM_INT_ATTR_ACTION_VECTOR,
/**
* @brief P4 INT instruction bitmap
*
* @type sai_uint16_t
* @flags CREATE_AND_SET
* @isvlan false
* @default 0
* @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_P4_INT_1 or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_P4_INT_2
*/
SAI_TAM_INT_ATTR_P4_INT_INSTRUCTION_BITMAP,
/**
* @brief Enable metadata fragmentation
*
* When there is insufficient space in the packet to add INT
* metadata for this hop (e.g. MTU would be exceeded), the device
* may remove the metadata from the packet, send a report to the
* collector, and insert its metadata before forwarding the packet.
*
* Note: Applicable only when SAI_TAM_INT_ATTR_TYPE != SAI_TAM_INT_TYPE_DIRECT_EXPORT
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_INT_ATTR_METADATA_FRAGMENT_ENABLE,
/**
* @brief Enable checksum
*
* Enable checksum for metadata stack
*
* @type bool
* @flags CREATE_AND_SET
* @default false
* @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_IFA2
*/
SAI_TAM_INT_ATTR_METADATA_CHECKSUM_ENABLE,
/**
* @brief TAM INT should report all packets without filtering
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_INT_ATTR_REPORT_ALL_PACKETS,
/**
* @brief TAM INT flow liveliness period in seconds
*
* @type sai_uint16_t
* @flags CREATE_AND_SET
* @isvlan false
* @default 0
*/
SAI_TAM_INT_ATTR_FLOW_LIVENESS_PERIOD,
/**
* @brief Latency sensitivity for flow state change detection
* in units of 2^n nanoseconds
*
* @type sai_uint8_t
* @flags CREATE_AND_SET
* @default 20
*/
SAI_TAM_INT_ATTR_LATENCY_SENSITIVITY,
/**
* @brief INT bind point for ACL object
*
* Bind (or unbind) an ACL table or ACL group. Enable/Update
* ACL table or ACL group filtering for INT insertion.
* Disable ingress filtering by assigning SAI_NULL_OBJECT_ID
* in the attribute value.
*
* @type sai_object_id_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_ACL_TABLE, SAI_OBJECT_TYPE_ACL_TABLE_GROUP
* @allownull true
* @default SAI_NULL_OBJECT_ID
*/
SAI_TAM_INT_ATTR_ACL_GROUP,
/**
* @brief Maximum number of hops allowed in the path
*
* @type sai_uint8_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_INT_ATTR_MAX_HOP_COUNT,
/**
* @brief Maximum length of metadata stack, in units of 4 octet words
*
* @type sai_uint8_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_INT_ATTR_MAX_LENGTH,
/**
* @brief Metadata name space ID
* name space id defines the applicable format of metadata header
*
* @type sai_uint8_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_INT_ATTR_NAME_SPACE_ID,
/**
* @brief Metadata name space ID scope
* name space id scope is global or local
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_INT_ATTR_NAME_SPACE_ID_GLOBAL,
/**
* @brief Enable/Disable Samplepacket session
*
* Enable ingress sampling by assigning samplepacket object id Disable
* ingress sampling by assigning #SAI_NULL_OBJECT_ID as attribute value.
*
* @type sai_object_id_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_SAMPLEPACKET
* @allownull true
* @default SAI_NULL_OBJECT_ID
*/
SAI_TAM_INT_ATTR_INGRESS_SAMPLEPACKET_ENABLE,
/**
* @brief Collector object list
*
* @type sai_object_list_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_TAM_COLLECTOR
* @default empty
*/
SAI_TAM_INT_ATTR_COLLECTOR_LIST,
/**
* @brief Math function attached
*
* @type sai_object_id_t
* @flags CREATE_AND_SET
* @objects SAI_OBJECT_TYPE_TAM_MATH_FUNC
* @allownull true
* @default SAI_NULL_OBJECT_ID
*/
SAI_TAM_INT_ATTR_MATH_FUNC,
/**
* @brief Tam report type
*
* @type sai_object_id_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
* @objects SAI_OBJECT_TYPE_TAM_REPORT
*/
SAI_TAM_INT_ATTR_REPORT_ID,
/**
* @brief End of Attributes
*/
SAI_TAM_INT_ATTR_END,
/** Custom range base value */
SAI_TAM_INT_ATTR_CUSTOM_RANGE_START = 0x10000000,
/** End of custom range base */
SAI_TAM_INT_ATTR_CUSTOM_RANGE_END
} sai_tam_int_attr_t;
/**
* @brief Create and return a INT type object
*
* @param[out] tam_int_id INT object
* @param[in] switch_id Switch object id
* @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_tam_int_fn)(
_Out_ sai_object_id_t *tam_int_id,
_In_ sai_object_id_t switch_id,
_In_ uint32_t attr_count,
_In_ const sai_attribute_t *attr_list);
/**
* @brief Deletes a specified INT object
*
* @param[in] tam_int_id INT type object id
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_remove_tam_int_fn)(
_In_ sai_object_id_t tam_int_id);
/**
* @brief Get values for specified INT object attributes
*
* @param[in] tam_int_id INT object id
* @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_tam_int_attribute_fn)(
_In_ sai_object_id_t tam_int_id,
_In_ uint32_t attr_count,
_Inout_ sai_attribute_t *attr_list);
/**
* @brief Set value for a specified INT object attribute
*
* @param[in] tam_int_id INT object id
* @param[in] attr Attribute
*
* @return #SAI_STATUS_SUCCESS on success, failure status code on error
*/
typedef sai_status_t (*sai_set_tam_int_attribute_fn)(
_In_ sai_object_id_t tam_int_id,
_In_ const sai_attribute_t *attr);
/**
* @brief TAM telemetry types supported
*/
typedef enum _sai_tam_telemetry_type_t
{
/**
* @brief Networking element TAM
* All the data relevant to networking element
* e.g. thermal, optics, switch interconnect
*/
SAI_TAM_TELEMETRY_TYPE_NE,
/**
* @brief Switch silicon TAM
* All the data relevant to switch
* e.g. route, port, queue statistics
*/
SAI_TAM_TELEMETRY_TYPE_SWITCH,
/**
* @brief Fabric TAM
* All the data relevant to switch fabric
*/
SAI_TAM_TELEMETRY_TYPE_FABRIC,
/**
* @brief Flow TAM
* All the data relevant to a given flow
*/
SAI_TAM_TELEMETRY_TYPE_FLOW,
/**
* @brief INT TAM
* All the data relevant on a per packet basis
*/
SAI_TAM_TELEMETRY_TYPE_INT
} sai_tam_telemetry_type_t;
/**
* @brief Telemetry type attributes
*/
typedef enum _sai_tam_tel_type_attr_t
{
/**
* @brief Start of Attributes
*/
SAI_TAM_TEL_TYPE_ATTR_START,
/**
* @brief Telemetry type
*
* @type sai_tam_telemetry_type_t
* @flags MANDATORY_ON_CREATE | CREATE_ONLY
*/
SAI_TAM_TEL_TYPE_ATTR_TAM_TELEMETRY_TYPE = SAI_TAM_TEL_TYPE_ATTR_START,
/**
* @brief INT - Switch Identifier
*
* Switch Identifier can be an encoded number or an IP address
*
* @type sai_uint32_t
* @flags CREATE_AND_SET
* @default 0
*/
SAI_TAM_TEL_TYPE_ATTR_INT_SWITCH_IDENTIFIER,
/**
* @brief Switch - Collect Port stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_PORT_STATS,
/**
* @brief Switch - Collect Port stats ingress
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_PORT_STATS_INGRESS,
/**
* @brief Switch - Collect Port stats egress
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_PORT_STATS_EGRESS,
/**
* @brief Switch - Collect virtual queue stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_VIRTUAL_QUEUE_STATS,
/**
* @brief Switch - Collect output queue stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_OUTPUT_QUEUE_STATS,
/**
* @brief Switch - Collect MMU stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_MMU_STATS,
/**
* @brief Switch - Collect fabric stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false
*/
SAI_TAM_TEL_TYPE_ATTR_SWITCH_ENABLE_FABRIC_STATS,
/**
* @brief Switch - Collect filter stats
*
* @type bool
* @flags CREATE_AND_SET
* @default false