forked from sonic-net/sonic-pins
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathir.cc
3162 lines (2934 loc) · 122 KB
/
ir.cc
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 2020 Google LLC
//
// 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
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "p4_pdpi/ir.h"
#include <ctype.h>
#include <stdint.h>
#include <algorithm>
#include <cctype>
#include <string>
#include <utility>
#include <vector>
#include "absl/algorithm/container.h"
#include "absl/base/attributes.h"
#include "absl/container/flat_hash_map.h"
#include "absl/container/flat_hash_set.h"
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/escaping.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/str_join.h"
#include "absl/strings/string_view.h"
#include "absl/strings/strip.h"
#include "absl/types/optional.h"
#include "absl/types/span.h"
#include "google/protobuf/any.pb.h"
#include "google/protobuf/map.h"
#include "google/protobuf/message.h"
#include "google/protobuf/repeated_ptr_field.h"
#include "google/rpc/code.pb.h"
#include "google/rpc/status.pb.h"
#include "grpcpp/support/status.h"
#include "gutil/collections.h"
#include "gutil/proto.h"
#include "gutil/status.h"
#include "p4/config/v1/p4info.pb.h"
#include "p4/config/v1/p4types.pb.h"
#include "p4/v1/p4runtime.pb.h"
#include "p4_pdpi/built_ins.h"
#include "p4_pdpi/ir.pb.h"
#include "p4_pdpi/reference_annotations.h"
#include "p4_pdpi/translation_options.h"
#include "p4_pdpi/utils/ir.h"
namespace pdpi {
using ::absl::StatusOr;
using ::gutil::InvalidArgumentErrorBuilder;
using ::gutil::PrintShortTextProto;
using ::gutil::PrintTextProto;
using ::gutil::UnimplementedErrorBuilder;
using ::p4::config::v1::MatchField;
using ::p4::config::v1::P4TypeInfo;
using ::pdpi::Format;
using ::pdpi::IrActionDefinition;
using ::pdpi::IrActionInvocation;
using ::pdpi::IrMatchFieldDefinition;
using ::pdpi::IrP4Info;
using ::pdpi::IrTableDefinition;
using ::pdpi::IrTableReference;
using ::pdpi::ParsedRefersToAnnotation;
namespace {
// -- IrP4Info utilities -------------------------------------------------------
template <class Value>
bool IsSupported(const Value &value) {
return !value.is_unsupported();
}
bool IsSupported(const IrActionReference &action_ref) {
return !action_ref.action().is_unsupported();
}
template <class Key, class Value>
void RemoveUnsupportedValues(google::protobuf::Map<Key, Value> &map) {
google::protobuf::Map<Key, Value> tmp;
for (auto &[key, value] : map) {
if (IsSupported(value)) tmp.insert({key, std::move(value)});
}
map = std::move(tmp);
}
template <class Value>
void RemoveUnsupportedValues(
google::protobuf::RepeatedPtrField<Value> &values) {
google::protobuf::RepeatedPtrField<Value> tmp;
for (auto &value : values) {
if (IsSupported(value)) tmp.Add(std::move(value));
}
values = std::move(tmp);
}
void RemoveUnsupportedTables(IrP4Info &p4_info) {
RemoveUnsupportedValues(*p4_info.mutable_tables_by_id());
RemoveUnsupportedValues(*p4_info.mutable_tables_by_name());
}
void RemoveUnsupportedActions(IrP4Info &p4_info) {
RemoveUnsupportedValues(*p4_info.mutable_actions_by_id());
RemoveUnsupportedValues(*p4_info.mutable_actions_by_name());
for (auto &[id, table] : *p4_info.mutable_tables_by_id()) {
RemoveUnsupportedValues(*table.mutable_entry_actions());
RemoveUnsupportedValues(*table.mutable_default_only_actions());
}
for (auto &[name, table] : *p4_info.mutable_tables_by_name()) {
RemoveUnsupportedValues(*table.mutable_entry_actions());
RemoveUnsupportedValues(*table.mutable_default_only_actions());
}
}
void RemoveUnsupportedMatchFields(IrP4Info &p4_info) {
for (auto &[id, table] : *p4_info.mutable_tables_by_id()) {
RemoveUnsupportedValues(*table.mutable_match_fields_by_id());
RemoveUnsupportedValues(*table.mutable_match_fields_by_name());
}
for (auto &[name, table] : *p4_info.mutable_tables_by_name()) {
RemoveUnsupportedValues(*table.mutable_match_fields_by_id());
RemoveUnsupportedValues(*table.mutable_match_fields_by_name());
}
}
bool IsPresentInP4Info(const IrTable &table, const IrP4Info &p4_info) {
switch (table.table_case()) {
case IrTable::kP4Table:
return p4_info.tables_by_id().contains(table.p4_table().table_id());
case IrTable::kBuiltInTable:
// Built-in tables are always present.
return true;
case IrTable::TABLE_NOT_SET:
// This should never happen, but isn't dealt with in this function to
// avoid introducing complexity or masking errors (by returning false).
return true;
}
return true;
}
bool IsPresentInP4Info(const IrActionField &action_field,
const IrP4Info &p4_info) {
switch (action_field.action_field_case()) {
case IrActionField::kP4ActionField:
return p4_info.actions_by_id().contains(
action_field.p4_action_field().action_id());
case IrActionField::kBuiltInActionField:
// Built-in actions are always present.
return true;
case IrActionField::ACTION_FIELD_NOT_SET:
// This should never happen, but isn't dealt with in this function to
// avoid introducing complexity or masking errors (by returning false).
return true;
}
return true;
}
// If a reference is from an unsupported table or any of the action field
// references are from unsupported actions, then the reference is dangling.
bool IsDanglingReference(const IrTableReference &reference,
const IrP4Info &p4_info) {
// Check if the source table is present.
if (!IsPresentInP4Info(reference.source_table(), p4_info)) return true;
// Check if the source action (if there is one) is present.
for (const IrTableReference::FieldReference &field_reference :
reference.field_references()) {
if (field_reference.source().has_action_field() &&
!IsPresentInP4Info(field_reference.source().action_field(), p4_info)) {
return true;
}
}
return false;
}
void RemoveDanglingReferences(
const IrP4Info &p4_info,
google::protobuf::RepeatedPtrField<IrTableReference> &references) {
google::protobuf::RepeatedPtrField<IrTableReference> tmp;
for (auto &reference : references) {
if (!IsDanglingReference(reference, p4_info)) tmp.Add(std::move(reference));
}
references = std::move(tmp);
}
// Only deletes references FROM unsupported tables and FROM unsupported actions.
// Note: Unsupported fields must be optional and optional fields do not yet
// support references to or from them. If that changes, this should also remove
// references FROM unsupported fields and references TO an unsupported field
// from a supported field.
void RemoveDanglingReferences(IrP4Info &p4_info) {
for (auto &[id, table] : *p4_info.mutable_tables_by_id()) {
RemoveDanglingReferences(p4_info, *table.mutable_incoming_references());
RemoveDanglingReferences(p4_info, *table.mutable_outgoing_references());
}
for (auto &[name, table] : *p4_info.mutable_tables_by_name()) {
RemoveDanglingReferences(p4_info, *table.mutable_incoming_references());
RemoveDanglingReferences(p4_info, *table.mutable_outgoing_references());
}
for (auto &[name, table] : *p4_info.mutable_built_in_tables()) {
RemoveDanglingReferences(p4_info, *table.mutable_incoming_references());
RemoveDanglingReferences(p4_info, *table.mutable_outgoing_references());
}
google::protobuf::Map<std::string, int32_t> new_dependency_rank_by_table_name;
for (auto &[name, value] : *p4_info.mutable_dependency_rank_by_table_name()) {
if (IsBuiltInTable(name) || p4_info.tables_by_name().contains(name)) {
new_dependency_rank_by_table_name.insert({name, value});
}
}
*p4_info.mutable_dependency_rank_by_table_name() =
std::move(new_dependency_rank_by_table_name);
}
} // namespace
void RemoveUnsupportedEntities(IrP4Info &p4_info) {
RemoveUnsupportedTables(p4_info);
RemoveUnsupportedActions(p4_info);
RemoveUnsupportedMatchFields(p4_info);
// This must be called after the above functions since it uses their results.
RemoveDanglingReferences(p4_info);
}
// -- Conversions from PI to IR ------------------------------------------------
namespace {
// Helper for GetFormat that extracts the necessary info from a P4Info
// element. T could be p4::config::v1::ControllerPacketMetadata::Metadata,
// p4::config::v1::MatchField, or p4::config::v1::Action::Param (basically
// anything that has a set of annotations, a bitwidth and named type
// information).
template <typename T>
StatusOr<Format> GetFormatForP4InfoElement(const T &element,
const P4TypeInfo &type_info) {
bool is_sdn_string = false;
if (element.has_type_name()) {
const auto &name = element.type_name().name();
ASSIGN_OR_RETURN(const auto *named_type,
gutil::FindPtrOrStatus(type_info.new_types(), name),
_ << "Type definition for \"" << name << "\" not found");
if (named_type->has_translated_type()) {
if (named_type->translated_type().sdn_type_case() ==
p4::config::v1::P4NewTypeTranslation::kSdnString) {
is_sdn_string = true;
}
}
}
std::vector<std::string> annotations;
for (const auto &annotation : element.annotations()) {
annotations.push_back(annotation);
}
return GetFormat(annotations, element.bitwidth(), is_sdn_string);
}
// Add a single packet-io metadata to the IR.
absl::Status ProcessPacketIoMetadataDefinition(
const p4::config::v1::ControllerPacketMetadata &data,
google::protobuf::Map<uint32_t, IrPacketIoMetadataDefinition> *by_id,
google::protobuf::Map<std::string, IrPacketIoMetadataDefinition> *by_name,
const P4TypeInfo &type_info) {
const std::string &kind = data.preamble().name();
if (!by_id->empty()) {
// Only checking by_id, since by_id->size() == by_name->size()
return InvalidArgumentErrorBuilder()
<< "Found duplicate \"" << kind << "\" controller packet metadata";
}
for (const auto &metadata : data.metadata()) {
IrPacketIoMetadataDefinition ir_metadata;
*ir_metadata.mutable_metadata() = metadata;
ASSIGN_OR_RETURN(const auto &format,
GetFormatForP4InfoElement(metadata, type_info));
ir_metadata.set_format(format);
if (absl::c_any_of(metadata.annotations(),
[](absl::string_view annotation) {
return annotation == "@padding";
})) {
ir_metadata.set_is_padding(true);
}
RETURN_IF_ERROR(gutil::InsertIfUnique(
by_id, metadata.id(), ir_metadata,
absl::StrCat("Found several \"", kind,
"\" metadata with the same ID: ", metadata.id())));
RETURN_IF_ERROR(gutil::InsertIfUnique(
by_name, metadata.name(), ir_metadata,
absl::StrCat("Found several \"", kind,
"\" metadata with the same name: ", metadata.name())));
}
return absl::OkStatus();
}
// Searches for an annotation with the given name and extract a single uint32_t
// number from the argument. Fails if the annotation appears multiple times.
StatusOr<uint32_t> GetNumberInAnnotation(
const google::protobuf::RepeatedPtrField<std::string> &annotations,
const std::string &annotation_name) {
absl::optional<uint32_t> result;
for (const std::string &annotation : annotations) {
absl::string_view view = annotation;
if (absl::ConsumePrefix(&view, absl::StrCat("@", annotation_name, "("))) {
if (result.has_value()) {
return InvalidArgumentErrorBuilder()
<< "Cannot have multiple annotations with the name \""
<< annotation_name << "\"";
}
const std::string number = std::string(absl::StripSuffix(view, ")"));
for (const char c : number) {
if (!isdigit(c)) {
return InvalidArgumentErrorBuilder()
<< "Expected the argument to @" << annotation_name
<< " to be a number, but found non-number character";
}
}
result = std::stoi(number);
}
}
if (!result.has_value()) {
return InvalidArgumentErrorBuilder()
<< "No annotation found with name \"" << annotation_name << "\"";
}
return result.value();
}
absl::flat_hash_set<std::string> GetMandatoryMatches(
const IrTableDefinition &table) {
absl::flat_hash_set<std::string> mandatory_matches;
for (const auto &iter : table.match_fields_by_name()) {
if (iter.second.match_field().match_type() == MatchField::EXACT) {
mandatory_matches.insert(iter.second.match_field().name());
}
}
return mandatory_matches;
}
absl::Status ValidateMatchFieldDefinition(const IrMatchFieldDefinition &match) {
switch (match.match_field().match_type()) {
case p4::config::v1::MatchField::LPM:
case p4::config::v1::MatchField::TERNARY:
if (match.format() == Format::STRING) {
return InvalidArgumentErrorBuilder()
<< "Only EXACT and OPTIONAL match fields can use "
"Format::STRING: "
<< PrintShortTextProto(match.match_field());
}
return absl::OkStatus();
case p4::config::v1::MatchField::EXACT:
case p4::config::v1::MatchField::OPTIONAL:
return absl::OkStatus();
default:
return InvalidArgumentErrorBuilder()
<< "Match field match type not supported: "
<< PrintShortTextProto(match.match_field());
}
}
absl::StatusOr<uint32_t> TableAliasToId(const p4::config::v1::P4Info &p4_info,
absl::string_view table_alias) {
absl::flat_hash_map<std::string, uint32_t> table_alias_to_table_id;
for (const p4::config::v1::Table &table : p4_info.tables()) {
if (table.preamble().alias() == table_alias) {
return table.preamble().id();
}
}
return absl::NotFoundError(
absl::StrCat("Can't find table id for alias `", table_alias, "`"));
}
absl::StatusOr<uint32_t> MatchFieldNameToId(
const p4::config::v1::P4Info &p4_info, uint32_t table_id,
absl::string_view match_field_name) {
for (const p4::config::v1::Table &table : p4_info.tables()) {
if (table.preamble().id() != table_id) {
continue;
}
for (const p4::config::v1::MatchField &match_field : table.match_fields()) {
if (match_field.name() == match_field_name) {
return match_field.id();
}
}
}
return absl::NotFoundError(
absl::StrCat("Can't find match field id for match field name `",
match_field_name, "` in table `", table_id, "`"));
}
// Returns the set of references for a given set of annotations. Does not
// validate the table or match field yet.
// TODO: b/306016407 - Remove this function once all p4 infrastructure has been
// moved to IrTableEntryReference.
ABSL_DEPRECATED("Use ParseRefersToAnnotations instead")
absl::StatusOr<std::vector<IrMatchFieldReference>> GetRefersToAnnotations(
const p4::config::v1::P4Info &p4info,
const ::google::protobuf::RepeatedPtrField<std::string> &annotations) {
std::vector<IrMatchFieldReference> result;
ASSIGN_OR_RETURN(
const std::vector<ParsedRefersToAnnotation> refers_to_annotations,
ParseAllRefersToAnnotations(annotations));
for (const auto &refers_to_annotation : refers_to_annotations) {
absl::string_view table = refers_to_annotation.table;
absl::string_view match_field = refers_to_annotation.field;
// Deprecated function should ignore new functionality.
if (IsBuiltInTable(table)) continue;
ASSIGN_OR_RETURN(uint32_t table_id, TableAliasToId(p4info, table));
ASSIGN_OR_RETURN(uint32_t match_field_id,
MatchFieldNameToId(p4info, table_id, match_field));
IrMatchFieldReference reference;
reference.set_table(std::string(table));
reference.set_match_field(std::string(match_field));
reference.set_table_id(table_id);
reference.set_match_field_id(match_field_id);
result.push_back(reference);
}
return result;
}
std::vector<std::string> GetMissingFields(
const absl::flat_hash_set<std::string> &actual_fields,
absl::flat_hash_set<std::string> expected_fields) {
// Erase actual fields from expected_fields.
// Whatever remains are the missing fields.
absl::erase_if(expected_fields,
[&](const auto &k) { return actual_fields.contains(k); });
// Convert to a vector so we can sort the fields to ensure stability.
std::vector<std::string> missing_fields(expected_fields.begin(),
expected_fields.end());
std::sort(missing_fields.begin(), missing_fields.end());
return missing_fields;
}
absl::Status CheckMandatoryMatches(
const absl::flat_hash_set<std::string> &actual_matches,
const IrTableDefinition &table) {
auto expected_matches = GetMandatoryMatches(table);
if (actual_matches.size() != expected_matches.size()) {
auto missing_matches = GetMissingFields(actual_matches, expected_matches);
return InvalidArgumentErrorBuilder()
<< "Missing matches: "
<< absl::StrCat("'", absl::StrJoin(missing_matches, "', '"), "'")
<< ". Expected " << expected_matches.size()
<< " mandatory match conditions, but found " << actual_matches.size()
<< " instead.";
}
return absl::OkStatus();
}
absl::Status CheckParams(const absl::flat_hash_set<std::string> &actual_params,
const IrActionDefinition &action) {
absl::flat_hash_set<std::string> expected_params;
for (const auto &[name, _] : action.params_by_name()) {
expected_params.insert(name);
}
if (actual_params.size() != expected_params.size()) {
auto missing_params = GetMissingFields(actual_params, expected_params);
return InvalidArgumentErrorBuilder()
<< "Missing parameters: "
<< absl::StrCat("'", absl::StrJoin(missing_params, "'. '"), "'")
<< ". Expected " << expected_params.size()
<< " parameters, but found " << actual_params.size() << " instead.";
}
return absl::OkStatus();
}
// Verifies the contents of the PI representation and translates to the IR
// message
StatusOr<IrMatch> PiMatchFieldToIr(
const IrP4Info &info, const TranslationOptions &options,
const IrMatchFieldDefinition &ir_match_definition,
const p4::v1::FieldMatch &pi_match) {
IrMatch match_entry;
const MatchField &match_field = ir_match_definition.match_field();
uint32_t bitwidth = match_field.bitwidth();
absl::string_view match_name = match_field.name();
std::vector<std::string> invalid_reasons;
if (ir_match_definition.is_unsupported() && !options.allow_unsupported) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Match field has @unsupported annotation."));
}
switch (match_field.match_type()) {
case MatchField::EXACT: {
if (!pi_match.has_exact()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be an exact match type."));
break;
}
match_entry.set_name(match_field.name());
const absl::StatusOr<IrValue> &exact = ArbitraryByteStringToIrValue(
ir_match_definition.format(), bitwidth, pi_match.exact().value());
if (!exact.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, exact.status().message()));
break;
}
*match_entry.mutable_exact() = *exact;
break;
}
case MatchField::LPM: {
if (!pi_match.has_lpm()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be an LPM match type."));
break;
}
uint32_t prefix_len = pi_match.lpm().prefix_len();
if (prefix_len == 0) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet,
"A wild-card LPM match (i.e., prefix length of 0) must be "
"represented by omitting the match altogether."));
}
match_entry.set_name(match_field.name());
const absl::StatusOr<std::string> &mask =
PrefixLenToMask(prefix_len, bitwidth);
if (!mask.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, mask.status().message()));
break;
}
const absl::StatusOr<std::string> &value =
ArbitraryToNormalizedByteString(pi_match.lpm().value(), bitwidth);
if (!value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, value.status().message()));
break;
}
const absl::StatusOr<std::string> &intersection =
Intersection(*value, *mask);
if (!intersection.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, intersection.status().message()));
break;
}
if (*value != *intersection) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Lpm value has masked bits that are set. Value: '",
absl::CEscape(*value), "' Prefix Length: ", prefix_len));
break;
}
match_entry.mutable_lpm()->set_prefix_length(prefix_len);
const absl::StatusOr<IrValue> &ir_value = ArbitraryByteStringToIrValue(
ir_match_definition.format(), bitwidth, *value);
if (!ir_value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, ir_value.status().message()));
break;
}
*match_entry.mutable_lpm()->mutable_value() = *ir_value;
break;
}
case MatchField::TERNARY: {
if (!pi_match.has_ternary()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be a ternary match type."));
break;
}
const absl::StatusOr<std::string> &value =
ArbitraryToNormalizedByteString(pi_match.ternary().value(), bitwidth);
if (!value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, value.status().message()));
break;
}
const absl::StatusOr<std::string> &mask =
ArbitraryToNormalizedByteString(pi_match.ternary().mask(), bitwidth);
if (!mask.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, mask.status().message()));
break;
}
if (IsAllZeros(*mask)) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet,
"A wild-card ternary match (i.e., mask of 0) must "
"be represented by omitting the match altogether."));
break;
}
match_entry.set_name(match_field.name());
const absl::StatusOr<std::string> &intersection =
Intersection(*value, *mask);
if (!intersection.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, intersection.status().message()));
break;
}
if (*value != *intersection) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Ternary value has masked bits that are set. Value: ",
absl::CEscape(*value), " Mask: ", absl::CEscape(*mask)));
break;
}
const absl::StatusOr<IrValue> &ir_value = ArbitraryByteStringToIrValue(
ir_match_definition.format(), bitwidth, *value);
if (!ir_value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, ir_value.status().message()));
break;
}
*match_entry.mutable_ternary()->mutable_value() = *ir_value;
const absl::StatusOr<IrValue> &ir_mask = ArbitraryByteStringToIrValue(
ir_match_definition.format(), bitwidth, *mask);
if (!ir_mask.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, ir_mask.status().message()));
break;
}
*match_entry.mutable_ternary()->mutable_mask() = *ir_mask;
break;
}
case MatchField::OPTIONAL: {
if (!pi_match.has_optional()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be an optional match type."));
break;
}
match_entry.set_name(match_field.name());
const absl::StatusOr<IrValue> &ir_value = ArbitraryByteStringToIrValue(
ir_match_definition.format(), bitwidth, pi_match.optional().value());
if (!ir_value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, ir_value.status().message()));
break;
}
*match_entry.mutable_optional()->mutable_value() = *ir_value;
break;
}
default:
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Unsupported match type '",
MatchField_MatchType_Name(match_field.match_type()), "'."));
}
if (!invalid_reasons.empty()) {
return absl::InvalidArgumentError(GenerateFormattedError(
MatchFieldName(match_name), absl::StrJoin(invalid_reasons, "\n")));
}
return match_entry;
}
// Translates the action invocation from its PI form to IR.
StatusOr<IrActionInvocation> PiActionToIr(
const IrP4Info &info, const TranslationOptions &options,
const p4::v1::Action &pi_action,
const google::protobuf::RepeatedPtrField<IrActionReference>
&valid_actions) {
IrActionInvocation action_entry;
uint32_t action_id = pi_action.action_id();
const auto &status_or_ir_action_definition =
gutil::FindPtrOrStatus(info.actions_by_id(), action_id);
if (!status_or_ir_action_definition.ok()) {
return absl::InvalidArgumentError(absl::StrCat(
kNewBullet, "Action ID ", action_id, " does not exist in the P4Info."));
}
const auto *ir_action_definition = *status_or_ir_action_definition;
if (absl::c_find_if(valid_actions,
[action_id](const IrActionReference &action) {
return action.action().preamble().id() == action_id;
}) == valid_actions.end()) {
return absl::InvalidArgumentError(
GenerateFormattedError(absl::StrCat("Action ID ", action_id),
"It is not a valid action for this table."));
}
action_entry.set_name(ir_action_definition->preamble().alias());
absl::flat_hash_set<uint32_t> used_params;
std::vector<std::string> invalid_reasons;
absl::flat_hash_set<std::string> actual_params;
if (ir_action_definition->is_unsupported() && !options.allow_unsupported) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Action has @unsupported annotation."));
}
for (const auto ¶m : pi_action.params()) {
const absl::Status duplicate = gutil::InsertIfUnique(
used_params, param.param_id(),
absl::StrCat("Duplicate param field with ID ", param.param_id(), "."));
if (!duplicate.ok()) {
invalid_reasons.push_back(absl::StrCat(kNewBullet, duplicate.message()));
continue;
}
const auto status_or_ir_param_definition = gutil::FindPtrOrStatus(
ir_action_definition->params_by_id(), param.param_id());
if (!status_or_ir_param_definition.ok()) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Unable to find param ID ", param.param_id(), "."));
continue;
}
const auto *ir_param_definition = *status_or_ir_param_definition;
IrActionInvocation::IrActionParam *param_entry = action_entry.add_params();
param_entry->set_name(ir_param_definition->param().name());
const absl::StatusOr<IrValue> &ir_value = ArbitraryByteStringToIrValue(
ir_param_definition->format(), ir_param_definition->param().bitwidth(),
param.value());
if (!ir_value.ok()) {
invalid_reasons.push_back(
GenerateReason(ParamName(ir_param_definition->param().name()),
ir_value.status().message()));
continue;
}
actual_params.insert(param_entry->name());
*param_entry->mutable_value() = *ir_value;
}
const auto &num_params_status =
CheckParams(actual_params, *ir_action_definition);
if (!num_params_status.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, num_params_status.message()));
}
if (!invalid_reasons.empty()) {
return absl::InvalidArgumentError(GenerateFormattedError(
ActionName(action_entry.name()), absl::StrJoin(invalid_reasons, "\n")));
}
return action_entry;
}
// Translates the action set from its PI form to IR.
StatusOr<IrActionSet> PiActionSetToIr(
const IrP4Info &info, const TranslationOptions &options,
const p4::v1::ActionProfileActionSet &pi_action_set,
const google::protobuf::RepeatedPtrField<IrActionReference>
&valid_actions) {
IrActionSet ir_action_set;
std::vector<std::string> invalid_reasons;
for (const auto &pi_profile_action : pi_action_set.action_profile_actions()) {
auto *ir_action = ir_action_set.add_actions();
const absl::StatusOr<IrActionInvocation> &action =
PiActionToIr(info, options, pi_profile_action.action(), valid_actions);
// On failure check the returned status as well as the invalid reasons
// field.
if (!action.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, action.status().message()));
continue;
}
*ir_action->mutable_action() = *action;
// A action set weight that is not positive does not make sense on a switch.
if (pi_profile_action.weight() < 1) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Expected positive action set weight, but got ",
pi_profile_action.weight(), " instead."));
continue;
}
ir_action->set_weight(pi_profile_action.weight());
if (!pi_profile_action.watch_port().empty()) {
ir_action->set_watch_port(pi_profile_action.watch_port());
}
}
if (!invalid_reasons.empty()) {
return absl::InvalidArgumentError(GenerateFormattedError(
"Action Set", absl::StrJoin(invalid_reasons, "\n")));
}
return ir_action_set;
}
// Generic helper that works for both packet-in and packet-out. For both, I is
// one of p4::v1::{PacketIn, PacketOut} and O is one of {IrPacketIn,
// IrPacketOut}.
template <typename I, typename O>
StatusOr<O> PiPacketIoToIr(const IrP4Info &info, const std::string &kind,
const I &packet, const TranslationOptions &options) {
O result;
result.set_payload(packet.payload());
absl::flat_hash_set<uint32_t> used_metadata_ids;
const std::string &packet_description = absl::StrCat("'", kind, "' message");
google::protobuf::Map<uint32_t, IrPacketIoMetadataDefinition> metadata_by_id;
if (kind == "packet-in") {
metadata_by_id = info.packet_in_metadata_by_id();
} else if (kind == "packet-out") {
metadata_by_id = info.packet_out_metadata_by_id();
} else {
return absl::InvalidArgumentError(GenerateFormattedError(
packet_description,
absl::StrCat(kNewBullet, "Invalid PacketIo type.")));
}
std::vector<std::string> invalid_reasons;
for (const auto &metadata : packet.metadata()) {
uint32_t id = metadata.metadata_id();
const absl::Status &duplicate = gutil::InsertIfUnique(
used_metadata_ids, id,
absl::StrCat("Duplicate metadata found with ID ", id, "."));
if (!duplicate.ok()) {
invalid_reasons.push_back(absl::StrCat(kNewBullet, duplicate.message()));
continue;
}
const auto &status_or_metadata_definition_ptr =
gutil::FindPtrOrStatus(metadata_by_id, id);
if (!status_or_metadata_definition_ptr.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, " Metadata with ID ", id, " not defined."));
continue;
}
const pdpi::IrPacketIoMetadataDefinition metadata_definition =
**status_or_metadata_definition_ptr;
// Metadata with @padding annotation must be all zeros and must not be
// included in IR representation (go/pdpi-padding).
if (metadata_definition.is_padding()) {
if (!IsAllZeros(metadata.value())) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, " Metadata with ID ", id,
" has @padding annotation, so bytestring must be all zeros."));
}
continue;
}
IrPacketMetadata ir_metadata;
const std::string &metadata_name = metadata_definition.metadata().name();
ir_metadata.set_name(metadata_name);
const absl::StatusOr<IrValue> ir_value = ArbitraryByteStringToIrValue(
metadata_definition.format(), metadata_definition.metadata().bitwidth(),
metadata.value());
if (!ir_value.ok()) {
invalid_reasons.push_back(GenerateReason(MetadataName(metadata_name),
ir_value.status().message()));
continue;
}
*ir_metadata.mutable_value() = *ir_value;
*result.add_metadata() = ir_metadata;
}
// Check for missing metadata
for (const auto &item : metadata_by_id) {
const auto &id = item.first;
const auto &meta = item.second;
if (!used_metadata_ids.contains(id)) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Metadata '", meta.metadata().name(),
"' with id ", meta.metadata().id(), " is missing."));
continue;
}
}
if (!invalid_reasons.empty()) {
return absl::InvalidArgumentError(GenerateFormattedError(
packet_description, absl::StrJoin(invalid_reasons, "\n")));
}
return result;
}
// Verifies the contents of the IR representation and translates to the PI
// message.
StatusOr<p4::v1::FieldMatch> IrMatchFieldToPi(
const IrP4Info &info, const TranslationOptions &options,
const IrMatchFieldDefinition &ir_match_definition,
const IrMatch &ir_match) {
p4::v1::FieldMatch match_entry;
const MatchField &match_field = ir_match_definition.match_field();
uint32_t bitwidth = match_field.bitwidth();
absl::string_view match_name = match_field.name();
std::vector<std::string> invalid_reasons;
if (ir_match_definition.is_unsupported() && !options.allow_unsupported) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Match field has @unsupported annotation."));
}
switch (match_field.match_type()) {
case MatchField::EXACT: {
if (!ir_match.has_exact()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be an exact match type."));
break;
}
match_entry.set_field_id(match_field.id());
const absl::Status &valid =
ValidateIrValueFormat(ir_match.exact(), ir_match_definition.format());
if (!valid.ok()) {
invalid_reasons.push_back(absl::StrCat(kNewBullet, valid.message()));
break;
}
const absl::StatusOr<std::string> &value = IrValueToNormalizedByteString(
ir_match.exact(), ir_match_definition.match_field().bitwidth());
if (!value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, value.status().message()));
break;
}
if (ir_match_definition.format() == STRING) {
match_entry.mutable_exact()->set_value(*value);
} else {
match_entry.mutable_exact()->set_value(
ArbitraryToCanonicalByteString(*value));
}
break;
}
case MatchField::LPM: {
if (!ir_match.has_lpm()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be an LPM match type."));
break;
}
uint32_t prefix_len = ir_match.lpm().prefix_length();
if (prefix_len > bitwidth) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Prefix length ", prefix_len,
" is greater than bitwidth ", bitwidth, " in LPM."));
break;
}
const absl::Status &valid = ValidateIrValueFormat(
ir_match.lpm().value(), ir_match_definition.format());
if (!valid.ok()) {
invalid_reasons.push_back(absl::StrCat(kNewBullet, valid.message()));
break;
}
const absl::StatusOr<std::string> &value = IrValueToNormalizedByteString(
ir_match.lpm().value(), ir_match_definition.match_field().bitwidth());
if (!value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, value.status().message()));
break;
}
if (prefix_len == 0) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet,
"A wild-card LPM match (i.e., prefix length of 0) must be "
"represented by omitting the match altogether."));
break;
}
match_entry.set_field_id(match_field.id());
const absl::StatusOr<std::string> &mask =
PrefixLenToMask(prefix_len, bitwidth);
if (!mask.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, mask.status().message()));
break;
}
const absl::StatusOr<std::string> &intersection =
Intersection(*value, *mask);
if (!intersection.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, intersection.status().message()));
break;
}
if (*value != *intersection) {
invalid_reasons.push_back(absl::StrCat(
kNewBullet, "Lpm value has masked bits that are set. Value: ",
PrintTextProto(ir_match.lpm().value()),
"Prefix Length: ", prefix_len));
break;
}
match_entry.mutable_lpm()->set_prefix_len(prefix_len);
match_entry.mutable_lpm()->set_value(
ArbitraryToCanonicalByteString(*value));
break;
}
case MatchField::TERNARY: {
if (!ir_match.has_ternary()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, "Must be a ternary match type."));
break;
}
const absl::Status &valid_value = ValidateIrValueFormat(
ir_match.ternary().value(), ir_match_definition.format());
if (!valid_value.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, valid_value.message()));
break;
}
const absl::Status &valid_mask = ValidateIrValueFormat(
ir_match.ternary().mask(), ir_match_definition.format());
if (!valid_mask.ok()) {
invalid_reasons.push_back(
absl::StrCat(kNewBullet, valid_mask.message()));
break;
}
const absl::StatusOr<std::string> &value = IrValueToNormalizedByteString(
ir_match.ternary().value(),