/
saisanitycheck.c
5768 lines (4474 loc) · 178 KB
/
saisanitycheck.c
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 saisanitycheck.c
*
* @brief Defines SAI metadata sanity check
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <alloca.h>
#include <sai.h>
#include <saiversion.h>
#include "saimetadatautils.h"
#include "saimetadata.h"
#include "saimetadatalogger.h"
typedef struct _defined_attr_t {
const sai_attr_metadata_t* metadata;
const struct _defined_attr_t* next;
} defined_attr_t;
bool debug = false;
defined_attr_t* defined_attributes = NULL;
#define META_LOG_DEBUG(format, ...)\
if (debug) { printf("DEBUG: " format "\n", ##__VA_ARGS__); }
#define META_LOG_WARN(format, ...)\
fprintf(stderr, "WARN: " format "\n", ##__VA_ARGS__);
#define META_LOG_INFO(format, ...)\
fprintf(stderr, "INFO: " format "\n", ##__VA_ARGS__);
#define META_LOG_ENTER() \
META_LOG_DEBUG(":> %s", __FUNCTION__);
#define META_ENUM_LOG_WARN(emd, format, ...)\
META_LOG_WARN("%s: " format, emd->name, ##__VA_ARGS__);
#define META_MD_LOG_DEBUG(md, format, ...)\
META_LOG_DEBUG("%s: " format, md->attridname, ##__VA_ARGS__);
#define META_MD_LOG_WARN(md, format, ...)\
META_LOG_WARN("%s: " format, md->attridname, ##__VA_ARGS__);
#define META_ASSERT_FAIL(format, ...) \
{ \
fprintf(stderr, \
" ASSERT FAILED (on line %d): " format "\n", \
__LINE__, ##__VA_ARGS__); \
exit(1); \
}
#define META_MD_ASSERT_FAIL(md, format, ...)\
META_ASSERT_FAIL("%s: " format, md->attridname, ##__VA_ARGS__);
#define META_ENUM_ASSERT_FAIL(emd, format, ...)\
META_ASSERT_FAIL("%s: " format, emd->name, ##__VA_ARGS__);
#define META_ASSERT_NOT_NULL(x)\
if ((x) == NULL) { META_ASSERT_FAIL("not expected NULL: " #x); }
#define META_ASSERT_NULL(x)\
if ((x) != NULL) { META_ASSERT_FAIL("expected NULL: " #x); }
#define META_ASSERT_TRUE(x, format, ...)\
if ((x) == false) { META_ASSERT_FAIL("expected true '" #x "': " format, ##__VA_ARGS__); }
#define META_ASSERT_FALSE(x, format, ...)\
if ((x) == true) { META_ASSERT_FAIL("expected false '" #x "': " format, ##__VA_ARGS__); }
/* custom ranges start are the same for all objects */
#define CUSTOM_ATTR_RANGE_START SAI_PORT_ATTR_CUSTOM_RANGE_START
bool is_extensions_enum(
_In_ const sai_enum_metadata_t* emd)
{
META_LOG_ENTER();
return strstr(emd->name, "_extensions_t") != NULL;
}
void check_all_enums_name_pointers()
{
META_LOG_ENTER();
size_t i = 0;
META_ASSERT_TRUE(sai_metadata_all_enums_count > 100, "we need to have some enums");
for (; i < sai_metadata_all_enums_count; ++i)
{
const sai_enum_metadata_t* emd = sai_metadata_all_enums[i];
META_ASSERT_NOT_NULL(emd);
META_LOG_DEBUG("enum: %s", emd->name);
META_ASSERT_NOT_NULL(emd->name);
META_ASSERT_NOT_NULL(emd->values);
META_ASSERT_NOT_NULL(emd->valuesnames);
META_ASSERT_NOT_NULL(emd->valuesshortnames);
if (is_extensions_enum(emd))
{
/* allow empty extensions enums */
if (emd->valuescount == 0)
META_LOG_WARN("enum %s has no values", emd->name);
}
else
{
META_ASSERT_TRUE(emd->valuescount > 0, "enum must have some values");
}
size_t j = 0;
for (; j < emd->valuescount; ++j)
{
META_LOG_DEBUG(" value: %s", emd->valuesnames[j]);
META_ASSERT_NOT_NULL(emd->valuesnames[j]);
META_ASSERT_NOT_NULL(emd->valuesshortnames[j]);
}
META_ASSERT_TRUE(emd->valuesnames[j] == NULL, "missing null pointer after enum names");
META_ASSERT_TRUE(emd->valuesshortnames[j] == NULL, "missing null pointer after enum short names");
}
}
bool is_flag_enum(const sai_enum_metadata_t* emd)
{
META_LOG_ENTER();
return emd->containsflags;
}
void check_all_enums_values()
{
META_LOG_ENTER();
size_t i = 0;
for (; i < sai_metadata_all_enums_count; ++i)
{
const sai_enum_metadata_t* emd = sai_metadata_all_enums[i];
META_LOG_DEBUG("enum: %s", emd->name);
bool flags = false;
size_t j = 0;
int last = -1;
if (strcmp(emd->name, "sai_status_t") == 0)
{
/* status values are negative */
continue;
}
for (; j < emd->valuescount; ++j)
{
META_LOG_DEBUG(" value: %s", emd->valuesnames[j]);
int value = emd->values[j];
META_ASSERT_FALSE(value < 0, "enum values are negative");
META_ASSERT_TRUE(last < value, "enum values are not increasing");
if (j == 0)
{
if (value != 0)
{
flags = true;
if (is_flag_enum(emd))
{
/* ok, flags not need zero enum */
}
else
{
META_ENUM_ASSERT_FAIL(emd, "first enum should start with zero");
}
}
}
if (value != last + 1)
{
flags = true;
if (is_flag_enum(emd))
{
/* flags, ok */
}
else
{
META_ENUM_ASSERT_FAIL(emd, "values are not increasing by 1: last: %d current: %d, should be marked as @flags?", last, value);
}
}
last = emd->values[j];
if (value >= CUSTOM_ATTR_RANGE_START && value < (2 * CUSTOM_ATTR_RANGE_START))
{
/* value is in custom range */
}
else
{
META_ASSERT_TRUE(value < 0x10000, "enum value is too big, range?");
}
}
META_ASSERT_TRUE(emd->values[j] == -1, "missing guard at the end of enum");
if (emd->valuescount > 0 && flags != emd->containsflags)
{
META_ENUM_ASSERT_FAIL(emd, "enum flags: %d but declared as %d", flags, emd->containsflags);
}
}
}
void check_enums_ignore_values()
{
META_LOG_ENTER();
size_t i = 0;
for (; i < sai_metadata_all_enums_count; ++i)
{
const sai_enum_metadata_t* emd = sai_metadata_all_enums[i];
META_LOG_DEBUG("enum: %s", emd->name);
if (emd->ignorevalues == NULL)
{
META_ASSERT_TRUE(emd->ignorevaluesnames == NULL, "names must be NULL when values are NULL");
continue;
}
META_ASSERT_TRUE(emd->ignorevaluesnames != NULL, "names must be NOT NULL when values are defined");
size_t j = 0;
for (; emd->ignorevalues[j] != -1; ++j)
{
META_LOG_DEBUG(" value: %s", emd->ignorevaluesnames[j]);
META_ASSERT_TRUE(emd->ignorevaluesnames[j] != NULL, "names must be NOT NULL when values are defined");
int value = emd->ignorevalues[j];
META_ASSERT_FALSE(value < 0, "enum values are negative");
bool contains = false;
size_t k = 0;
for (; k < emd->valuescount; k++)
{
if (emd->values[k] == value)
{
contains = true;
break;
}
}
META_ASSERT_TRUE(contains, "ignored enum value must be defined in enum values");
}
META_ASSERT_TRUE(emd->ignorevalues[j] == -1, "missing guard at the end of enum");
META_ASSERT_TRUE(emd->ignorevaluesnames[j] == NULL, "missing guard at the end of enum");
}
}
void check_sai_status()
{
META_LOG_ENTER();
META_ASSERT_TRUE(SAI_STATUS_SUCCESS == 0, "success must be zero");
META_ASSERT_TRUE(sai_metadata_enum_sai_status_t.valuescount > 1, "there must be error codes");
size_t i = 0;
int last = 1;
for (; i < sai_metadata_enum_sai_status_t.valuescount; ++i)
{
META_LOG_DEBUG("status: %s", sai_metadata_enum_sai_status_t.valuesnames[i]);
int value = sai_metadata_enum_sai_status_t.values[i];
if (i == 0)
{
META_ASSERT_TRUE(value == 0, "first must be status success");
}
else
{
META_ASSERT_TRUE(last > value, "status codes are not decreasing");
}
last = value;
}
META_ASSERT_TRUE(sai_metadata_enum_sai_status_t.containsflags, "sai_status_t must be marked as containsflags");
}
void check_object_type()
{
META_LOG_ENTER();
META_ASSERT_TRUE(SAI_OBJECT_TYPE_NULL == 0, "sai object type null must be zero");
size_t i = 0;
int last = -1; /* will enforce NULL be first */
for (; i < sai_metadata_enum_sai_object_type_t.valuescount; ++i)
{
META_LOG_DEBUG("object_type: %s", sai_metadata_enum_sai_object_type_t.valuesnames[i]);
int value = sai_metadata_enum_sai_object_type_t.values[i];
META_ASSERT_TRUE(value == last + 1, "object type values must be consecutive numbers");
last = value;
}
}
void check_attr_by_object_type()
{
META_LOG_ENTER();
META_ASSERT_TRUE(SAI_OBJECT_TYPE_EXTENSIONS_MAX - SAI_OBJECT_TYPE_MAX < 50, "too many experimental object types");
META_ASSERT_TRUE(SAI_OBJECT_TYPE_MAX <= SAI_OBJECT_TYPE_EXTENSIONS_MAX, "invalid object type count in metadata");
META_ASSERT_TRUE(sai_metadata_attr_by_object_type_count == SAI_OBJECT_TYPE_EXTENSIONS_MAX, "invalid object type count in metadata");
size_t i = 0;
for (; i < sai_metadata_attr_by_object_type_count; ++i)
{
META_LOG_DEBUG("processing %zu, %s", i, sai_metadata_get_object_type_name((sai_object_type_t)i));
META_ASSERT_NOT_NULL(sai_metadata_attr_by_object_type[i]);
const sai_attr_metadata_t * const* const ot = sai_metadata_attr_by_object_type[i];
size_t index = 0;
while (ot[index] != NULL)
{
sai_object_type_t current = ot[index]->objecttype;
META_ASSERT_TRUE(current == i, "object type must be equal on object type list");
/*
* For Switch Attribute we have crossed > 300 with Vendor extension
* for SAI v1.8.0 so increasing threshold.
*/
META_ASSERT_TRUE(index < 300, "object defines > 300 attributes, metadata bug?");
META_ASSERT_TRUE(current > SAI_OBJECT_TYPE_NULL, "object type must be > NULL");
META_ASSERT_TRUE(current < SAI_OBJECT_TYPE_EXTENSIONS_MAX, "object type must be < MAX");
/* META_LOG_DEBUG("processing indexer %lu", index); */
index++;
}
META_LOG_DEBUG("attr index %zu for %s", index, sai_metadata_get_object_type_name((sai_object_type_t)i));
}
META_ASSERT_NULL(sai_metadata_attr_by_object_type[i]);
}
bool is_valid_object_type(
_In_ sai_object_type_t ot)
{
META_LOG_ENTER();
return (ot > SAI_OBJECT_TYPE_NULL) && (ot < SAI_OBJECT_TYPE_EXTENSIONS_MAX);
}
void check_attr_object_type(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
if (!is_valid_object_type(md->objecttype))
{
META_MD_ASSERT_FAIL(md, "invalid object type value %d", md->objecttype);
}
}
void check_attr_value_type_range(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
META_ASSERT_NOT_NULL(sai_metadata_get_enum_value_name(&sai_metadata_enum_sai_attr_value_type_t, md->attrvaluetype));
}
bool sai_metadata_is_acl_field_or_action(
_In_ const sai_attr_metadata_t* metadata)
{
if (metadata == NULL)
{
return false;
}
if (metadata->objecttype == SAI_OBJECT_TYPE_ACL_ENTRY)
{
if (metadata->attrid >= SAI_ACL_ENTRY_ATTR_FIELD_START &&
metadata->attrid <= SAI_ACL_ENTRY_ATTR_FIELD_END)
{
return true;
}
if (metadata->attrid >= SAI_ACL_ENTRY_ATTR_ACTION_START &&
metadata->attrid <= SAI_ACL_ENTRY_ATTR_ACTION_END)
{
return true;
}
if (metadata->isextensionattr)
{
return true;
}
}
if (metadata->objecttype == SAI_OBJECT_TYPE_UDF_MATCH)
{
if (metadata->attrid <= SAI_UDF_MATCH_ATTR_GRE_TYPE)
{
return true;
}
if (metadata->attrid == SAI_UDF_MATCH_ATTR_L4_DST_PORT_TYPE)
{
return true;
}
}
return false;
}
void check_attr_flags(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
switch ((int)md->flags)
{
case SAI_ATTR_FLAGS_MANDATORY_ON_CREATE | SAI_ATTR_FLAGS_CREATE_ONLY | SAI_ATTR_FLAGS_KEY:
case SAI_ATTR_FLAGS_MANDATORY_ON_CREATE | SAI_ATTR_FLAGS_CREATE_ONLY:
case SAI_ATTR_FLAGS_MANDATORY_ON_CREATE | SAI_ATTR_FLAGS_CREATE_AND_SET:
if (md->validonlytype != SAI_ATTR_CONDITION_TYPE_NONE)
{
META_MD_ASSERT_FAIL(md, "valid only attribute can't be mandatory on create, use condition");
}
/*
* Currently we don't use RANGE type so this check can be disabled.
* Range idea was introduces so attribute can be in specific range
* of other MIN/MAX attributes. This is not supported yet.
*
* if (md->attrvaluetype == SAI_ATTR_VALUE_TYPE_UINT32 &&
* md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_ATTR_RANGE)
* {
* break;
* }
*/
if (md->defaultvaluetype != SAI_DEFAULT_VALUE_TYPE_NONE)
{
META_MD_ASSERT_FAIL(md, "no default value expected, but type provided: %s",
sai_metadata_get_default_value_type_name(md->defaultvaluetype));
}
break;
case SAI_ATTR_FLAGS_CREATE_ONLY:
case SAI_ATTR_FLAGS_CREATE_AND_SET:
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_NONE)
{
/*
* Default value of object id can be internal or NULL and it
* needs to be specified explicitly.
*/
/*
* Default value for pointer must be specified and must be NULL.
*/
/*
* Default value for acl field or action is provided and is
* disabled by default.
*/
META_MD_ASSERT_FAIL(md, "expected default value, but none provided");
}
break;
case SAI_ATTR_FLAGS_READ_ONLY:
if (md->conditiontype != SAI_ATTR_CONDITION_TYPE_NONE)
{
META_MD_ASSERT_FAIL(md, "read only attribute can't be conditional");
}
if (md->validonlytype != SAI_ATTR_CONDITION_TYPE_NONE)
{
META_MD_ASSERT_FAIL(md, "read only attribute can't be valid only");
}
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_SWITCH_INTERNAL)
{
if (md->attrvaluetype == SAI_ATTR_VALUE_TYPE_OBJECT_ID ||
md->attrvaluetype == SAI_ATTR_VALUE_TYPE_OBJECT_LIST)
{
/*
* Read only object id/list can be marked as internal like
* default virtual router, cpu port id, default queues on
* ports, etc.
*/
break;
}
}
if (md->defaultvaluetype != SAI_DEFAULT_VALUE_TYPE_NONE)
{
META_MD_ASSERT_FAIL(md, "no default value expected, but type provided: %s",
sai_metadata_get_default_value_type_name(md->defaultvaluetype));
}
break;
default:
META_MD_ASSERT_FAIL(md, "invalid creation flags: 0x%x", md->flags);
}
META_ASSERT_TRUE(SAI_HAS_FLAG_MANDATORY_ON_CREATE(md->flags) == md->ismandatoryoncreate, "wrong ismandatoryoncreate");
META_ASSERT_TRUE(SAI_HAS_FLAG_CREATE_ONLY(md->flags) == md->iscreateonly, "wrong iscreateonly");
META_ASSERT_TRUE(SAI_HAS_FLAG_CREATE_AND_SET(md->flags) == md->iscreateandset, "wrong iscreateandset");
META_ASSERT_TRUE(SAI_HAS_FLAG_READ_ONLY(md->flags) == md->isreadonly, "wrong isreadonly");
META_ASSERT_TRUE(SAI_HAS_FLAG_KEY(md->flags) == md->iskey, "wrong iskey");
}
void check_attr_object_id_allownull(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
if (md->attrvaluetype != SAI_ATTR_VALUE_TYPE_OBJECT_ID)
{
/*
* We don't care about ACL entry data/field, in that when we set NULL
* as object id on acl data/field it should mean as disable, or it
* should be not allowed at all.
*/
return;
}
/* attribute is object id type */
switch ((int)md->flags)
{
case SAI_ATTR_FLAGS_CREATE_ONLY:
case SAI_ATTR_FLAGS_CREATE_AND_SET:
/* default value is required */
switch (md->defaultvaluetype)
{
case SAI_DEFAULT_VALUE_TYPE_CONST:
if (md->allownullobjectid == false)
{
/*
* since attribute require default value and default value is
* set to SAI_NULL_OBJECT_ID then allownull should be true
*/
META_MD_ASSERT_FAIL(md, "allow null object id should be set to true since default value is required");
}
break;
case SAI_DEFAULT_VALUE_TYPE_ATTR_VALUE:
/* default attr value from another attr may not support null */
break;
default:
META_MD_ASSERT_FAIL(md, "invalid default value type on object id when default is required");
break;
}
break;
default:
break;
}
}
void check_attr_object_type_provided(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
switch (md->attrvaluetype)
{
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_OBJECT_ID:
if (md->allowedobjecttypes == NULL)
{
META_MD_ASSERT_FAIL(md, "object types list is required but it's empty");
}
break;
case SAI_ATTR_VALUE_TYPE_BOOL:
case SAI_ATTR_VALUE_TYPE_INT8:
case SAI_ATTR_VALUE_TYPE_INT32:
case SAI_ATTR_VALUE_TYPE_INT8_LIST:
case SAI_ATTR_VALUE_TYPE_UINT8_LIST:
case SAI_ATTR_VALUE_TYPE_UINT16_LIST:
case SAI_ATTR_VALUE_TYPE_INT32_LIST:
case SAI_ATTR_VALUE_TYPE_UINT8:
case SAI_ATTR_VALUE_TYPE_UINT16:
case SAI_ATTR_VALUE_TYPE_INT16:
case SAI_ATTR_VALUE_TYPE_VLAN_LIST:
case SAI_ATTR_VALUE_TYPE_UINT32:
case SAI_ATTR_VALUE_TYPE_UINT64:
case SAI_ATTR_VALUE_TYPE_MAC:
case SAI_ATTR_VALUE_TYPE_POINTER:
case SAI_ATTR_VALUE_TYPE_IP_ADDRESS:
case SAI_ATTR_VALUE_TYPE_IP_PREFIX:
case SAI_ATTR_VALUE_TYPE_PRBS_RX_STATE:
case SAI_ATTR_VALUE_TYPE_CHARDATA:
case SAI_ATTR_VALUE_TYPE_UINT32_RANGE:
case SAI_ATTR_VALUE_TYPE_UINT16_RANGE_LIST:
case SAI_ATTR_VALUE_TYPE_UINT32_LIST:
case SAI_ATTR_VALUE_TYPE_QOS_MAP_LIST:
case SAI_ATTR_VALUE_TYPE_MAP_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_CAPABILITY:
case SAI_ATTR_VALUE_TYPE_ACL_RESOURCE_LIST:
case SAI_ATTR_VALUE_TYPE_TLV_LIST:
case SAI_ATTR_VALUE_TYPE_SEGMENT_LIST:
case SAI_ATTR_VALUE_TYPE_IP_ADDRESS_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_EYE_VALUES_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_FREQUENCY_OFFSET_PPM_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_SNR_LIST:
case SAI_ATTR_VALUE_TYPE_LATCH_STATUS:
case SAI_ATTR_VALUE_TYPE_PORT_LANE_LATCH_STATUS_LIST:
case SAI_ATTR_VALUE_TYPE_TIMESPEC:
case SAI_ATTR_VALUE_TYPE_JSON:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_BOOL:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT8:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT16:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT16:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT32:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT32:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT64:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_MAC:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV4:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV6:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_BOOL:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT8:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT8:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT16:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT16:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT32:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT32:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_MAC:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV4:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV6:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IP_ADDRESS:
case SAI_ATTR_VALUE_TYPE_IPV4:
case SAI_ATTR_VALUE_TYPE_IPV6:
case SAI_ATTR_VALUE_TYPE_ENCRYPT_KEY:
case SAI_ATTR_VALUE_TYPE_AUTH_KEY:
case SAI_ATTR_VALUE_TYPE_MACSEC_SAK:
case SAI_ATTR_VALUE_TYPE_MACSEC_AUTH_KEY:
case SAI_ATTR_VALUE_TYPE_MACSEC_SALT:
case SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG:
case SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG_LIST:
case SAI_ATTR_VALUE_TYPE_FABRIC_PORT_REACHABILITY:
case SAI_ATTR_VALUE_TYPE_PORT_ERR_STATUS_LIST:
case SAI_ATTR_VALUE_TYPE_IP_PREFIX_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_CHAIN_LIST:
case SAI_ATTR_VALUE_TYPE_POE_PORT_POWER_CONSUMPTION:
if (md->allowedobjecttypes != NULL)
{
META_MD_ASSERT_FAIL(md, "allowed object types defined for non object type");
}
break;
default:
META_MD_ASSERT_FAIL(md, "attr value type is not supported, FIXME");
}
}
void check_attr_allowed_object_types(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
if (md->allowedobjecttypeslength != 0 && md->allowedobjecttypes == NULL)
{
META_MD_ASSERT_FAIL(md, "allowed object type len is specified but pointer is NULL");
}
if (md->allowedobjecttypeslength == 0 && md->allowedobjecttypes != NULL)
{
META_MD_ASSERT_FAIL(md, "allowed object type len zero, but but pointer to objects is specified");
}
if (md->allowedobjecttypes == NULL)
{
return;
}
if (md->isoidattribute)
{
META_ASSERT_TRUE(md->allowedobjecttypeslength > 0, "object len should be at least 1");
}
else
{
META_ASSERT_TRUE(md->allowedobjecttypeslength == 0, "object len should be 0");
}
switch (md->attrvaluetype)
{
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_OBJECT_ID:
break;
default:
META_MD_ASSERT_FAIL(md, "allowed object types should be empty on this attr value type");
}
/*
* check if allowed object types are in range
* they may repeat, but we can also check that
*/
size_t i = 0;
for (; i < md->allowedobjecttypeslength; ++i)
{
sai_object_type_t ot = md->allowedobjecttypes[i];
if (!is_valid_object_type(ot))
{
META_MD_ASSERT_FAIL(md, "invalid allowed object type: %d", ot);
}
const sai_object_type_info_t* info = sai_metadata_all_object_type_infos[ot];
META_ASSERT_NOT_NULL(info);
if (info->isnonobjectid)
{
META_MD_ASSERT_FAIL(md, "non object id can't be used as object id: %d", ot);
}
if (ot == SAI_OBJECT_TYPE_SWITCH ||
ot == SAI_OBJECT_TYPE_FDB_FLUSH ||
ot == SAI_OBJECT_TYPE_HOSTIF_PACKET)
{
/* switch object type is meant to be used only in non object id struct types */
META_MD_ASSERT_FAIL(md, "switch object type can't be used as object type in any attribute");
}
}
}
void check_attr_default_required(
_In_ const sai_attr_metadata_t* md)
{
META_LOG_ENTER();
bool requiredefault = (!SAI_HAS_FLAG_MANDATORY_ON_CREATE(md->flags)) &&
(SAI_HAS_FLAG_CREATE_ONLY(md->flags) || SAI_HAS_FLAG_CREATE_AND_SET(md->flags));
if (requiredefault == false)
{
return;
}
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_NONE)
{
/*
* If default value type is NONE, then default value must be NULL.
*/
META_ASSERT_NULL(md->defaultvalue);
/*
* By default we assume that default acl field or action is
* disabled and default value is not provided.
*/
META_MD_ASSERT_FAIL(md, "expected default value, but none provided");
}
switch (md->defaultvaluetype)
{
case SAI_DEFAULT_VALUE_TYPE_CONST:
if (md->objecttype == SAI_OBJECT_TYPE_UDF && md->attrid == SAI_UDF_ATTR_HASH_MASK)
{
if (md->attrvaluetype == SAI_ATTR_VALUE_TYPE_UINT8_LIST)
{
/*
* Const on list, this is exception for UDF object since
* it's default value is 2 bytes 0xFF,0xFF and it's special
* case.
*/
break;
}
}
if ((md->objecttype == SAI_OBJECT_TYPE_PORT) || (md->objecttype == SAI_OBJECT_TYPE_PORT_SERDES))
{
/*
* Allow PORT non object list attributes to be set to internal switch values.
*/
break;
}
if (md->defaultvalue == NULL)
{
META_MD_ASSERT_FAIL(md, "default value type is provided, but default value pointer is NULL");
}
break;
case SAI_DEFAULT_VALUE_TYPE_ATTR_VALUE:
case SAI_DEFAULT_VALUE_TYPE_ATTR_RANGE:
case SAI_DEFAULT_VALUE_TYPE_SWITCH_INTERNAL:
case SAI_DEFAULT_VALUE_TYPE_VENDOR_SPECIFIC:
case SAI_DEFAULT_VALUE_TYPE_EMPTY_LIST:
if (md->defaultvalue != NULL)
{
META_MD_ASSERT_FAIL(md, "default value type is provided, but default value pointer is not NULL");
}
break;
default:
META_MD_ASSERT_FAIL(md, "unknown default value type %d", md->defaultvaluetype);
}
/* default value is required */
switch (md->attrvaluetype)
{
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_BOOL:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT8:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT16:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT16:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT32:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT32:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT64:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_MAC:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV4:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV6:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_BOOL:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT8:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT8:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT16:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT16:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT32:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT32:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_MAC:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV4:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV6:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IP_ADDRESS:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_ID:
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_CONST)
{
break;
}
META_MD_ASSERT_FAIL(md, "default value on acl field/action must be const/disabled");
case SAI_ATTR_VALUE_TYPE_OBJECT_ID:
case SAI_ATTR_VALUE_TYPE_BOOL:
case SAI_ATTR_VALUE_TYPE_INT32:
case SAI_ATTR_VALUE_TYPE_UINT8:
case SAI_ATTR_VALUE_TYPE_UINT16:
case SAI_ATTR_VALUE_TYPE_UINT32:
case SAI_ATTR_VALUE_TYPE_UINT64:
case SAI_ATTR_VALUE_TYPE_MAC:
case SAI_ATTR_VALUE_TYPE_IP_ADDRESS:
case SAI_ATTR_VALUE_TYPE_IP_PREFIX:
case SAI_ATTR_VALUE_TYPE_PRBS_RX_STATE:
case SAI_ATTR_VALUE_TYPE_TIMESPEC:
case SAI_ATTR_VALUE_TYPE_IPV4:
case SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG:
case SAI_ATTR_VALUE_TYPE_IPV6:
break;
case SAI_ATTR_VALUE_TYPE_CHARDATA:
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_CONST)
{
break;
}
META_MD_ASSERT_FAIL(md, "default value on chardata const");
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8_LIST:
/* even if this is list, on acl field/action we require disabled */
if (md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_CONST)
{
break;
}
META_MD_ASSERT_FAIL(md, "default value on acl field/action must be const/disabled");
case SAI_ATTR_VALUE_TYPE_INT8_LIST:
case SAI_ATTR_VALUE_TYPE_UINT32_LIST:
case SAI_ATTR_VALUE_TYPE_INT32_LIST:
case SAI_ATTR_VALUE_TYPE_OBJECT_LIST:
case SAI_ATTR_VALUE_TYPE_TLV_LIST:
case SAI_ATTR_VALUE_TYPE_SEGMENT_LIST:
case SAI_ATTR_VALUE_TYPE_MAP_LIST:
case SAI_ATTR_VALUE_TYPE_IP_ADDRESS_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_EYE_VALUES_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_FREQUENCY_OFFSET_PPM_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_SNR_LIST:
case SAI_ATTR_VALUE_TYPE_PORT_LANE_LATCH_STATUS_LIST:
case SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG_LIST:
case SAI_ATTR_VALUE_TYPE_IP_PREFIX_LIST:
case SAI_ATTR_VALUE_TYPE_ACL_CHAIN_LIST:
if (((md->objecttype == SAI_OBJECT_TYPE_PORT) || (md->objecttype == SAI_OBJECT_TYPE_PORT_SERDES))
&& md->defaultvaluetype == SAI_DEFAULT_VALUE_TYPE_SWITCH_INTERNAL)