@command_line annotation (#5123)

Signed-off-by: Chris Dodd <cdodd@nvidia.com>
p4lang · Feb 26, 2025 · 3ffac66 · 3ffac66
1 parent d4365f1
commit 3ffac66
Show file tree

Hide file tree

Showing 181 changed files with 447 additions and 5,294 deletions.
diff --git a/backends/bmv2/pna_nic/main.cpp b/backends/bmv2/pna_nic/main.cpp
@@ -65,7 +65,7 @@ int main(int argc, char *const argv[]) {
 
         if (program == nullptr || ::P4::errorCount() > 0) return 1;
         try {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(true);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
             P4::FrontEnd frontend;

diff --git a/backends/bmv2/psa_switch/main.cpp b/backends/bmv2/psa_switch/main.cpp
@@ -65,7 +65,7 @@ int main(int argc, char *const argv[]) {
 
         if (program == nullptr || ::P4::errorCount() > 0) return 1;
         try {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(true);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
             P4::FrontEnd frontend;

diff --git a/backends/bmv2/simple_switch/main.cpp b/backends/bmv2/simple_switch/main.cpp
@@ -68,7 +68,7 @@ int main(int argc, char *const argv[]) {
 
         if (program == nullptr || ::P4::errorCount() > 0) return 1;
         try {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(true);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
             P4::FrontEnd frontend;

diff --git a/backends/dpdk/main.cpp b/backends/dpdk/main.cpp
@@ -86,7 +86,7 @@ int main(int argc, char *const argv[]) {
 
         if (program == nullptr || ::P4::errorCount() > 0) return 1;
         try {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(true);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
             P4::FrontEnd frontend;

diff --git a/backends/ebpf/p4c-ebpf.cpp b/backends/ebpf/p4c-ebpf.cpp
@@ -66,7 +66,7 @@ void compile(EbpfOptions &options) {
         program = P4::parseP4File(options);
         if (::P4::errorCount() > 0) return;
 
-        P4::P4COptionPragmaParser optionsPragmaParser;
+        P4::P4COptionPragmaParser optionsPragmaParser(true);
         program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
         P4::FrontEnd frontend;

diff --git a/backends/graphs/p4c-graphs.cpp b/backends/graphs/p4c-graphs.cpp
@@ -162,7 +162,7 @@ int main(int argc, char *const argv[]) {
         if (program == nullptr || ::P4::errorCount() > 0) return 1;
 
         try {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(false);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
 
             P4::FrontEnd fe;

diff --git a/backends/p4test/CMakeLists.txt b/backends/p4test/CMakeLists.txt
@@ -113,10 +113,6 @@ set (P4_XFAIL_TESTS
 # will be no P4Info file.
 p4c_add_tests_w_p4runtime("p4" ${P4TEST_DRIVER} "${P4TEST_SUITES}" "${P4_XFAIL_TESTS}" "${P4RUNTIME_EXCLUDE}" "-a '--maxErrorCount 100'")
 
-set (P4TEST_PARSERUNROLL
-  "${P4C_SOURCE_DIR}/testdata/p4_16_samples/parser-unroll-*.p4")
-p4c_add_tests("p4unroll" ${P4TEST_DRIVER} "${P4TEST_PARSERUNROLL}" "" "-a '--maxErrorCount 100 --loopsUnroll'")
-
 set (P4TEST_PARSER_INLINE_TESTS "${P4C_SOURCE_DIR}/testdata/p4_16_samples/parser-inline/*.p4")
 p4c_add_tests("p4" ${P4TEST_DRIVER} "${P4TEST_PARSER_INLINE_TESTS}" "" "-a '--maxErrorCount 100 --parser-inline-opt'")
 

diff --git a/backends/p4test/p4test.cpp b/backends/p4test/p4test.cpp
@@ -135,7 +135,7 @@ int main(int argc, char *const argv[]) {
         info.emitInfo("PARSER");
 
         if (program != nullptr && ::P4::errorCount() == 0) {
-            P4::P4COptionPragmaParser optionsPragmaParser;
+            P4::P4COptionPragmaParser optionsPragmaParser(true);
             program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
             info.emitInfo("PASS P4COptionPragmaParser");
 

diff --git a/backends/p4tools/common/compiler/compiler_target.cpp b/backends/p4tools/common/compiler/compiler_target.cpp
@@ -65,7 +65,7 @@ const IR::P4Program *CompilerTarget::runParser(const ParserOptions &options) {
 
 const IR::P4Program *CompilerTarget::runFrontend(const CompilerOptions &options,
                                                  const IR::P4Program *program) const {
-    P4COptionPragmaParser optionsPragmaParser;
+    P4COptionPragmaParser optionsPragmaParser(false);
     program->apply(ApplyOptionsPragmas(optionsPragmaParser));
 
     auto frontEnd = mkFrontEnd();

diff --git a/backends/p4tools/modules/testgen/targets/bmv2/test/BMV2PTFXfail.cmake b/backends/p4tools/modules/testgen/targets/bmv2/test/BMV2PTFXfail.cmake
@@ -67,7 +67,6 @@ p4tools_add_xfail_reason(
   # Unexpected error in RPC handling
   issue3374.p4
   control-hs-index-test6.p4
-  parser-unroll-test1.p4
 )
 
 p4tools_add_xfail_reason(

diff --git a/backends/p4tools/modules/testgen/targets/bmv2/test/BMV2STFXfail.cmake b/backends/p4tools/modules/testgen/targets/bmv2/test/BMV2STFXfail.cmake
@@ -40,7 +40,6 @@ p4tools_add_xfail_reason(
   # terminate called after throwing an instance of 'std::runtime_error'
   # Type is not convertible to string
   control-hs-index-test3.p4
-  parser-unroll-test1.p4
   # terminate called after throwing an instance of 'std::out_of_range'
   control-hs-index-test2.p4
 )

diff --git a/backends/tc/tc.cpp b/backends/tc/tc.cpp
@@ -55,7 +55,7 @@ int main(int argc, char *const argv[]) {
         return 1;
     }
     try {
-        P4::P4COptionPragmaParser optionsPragmaParser;
+        P4::P4COptionPragmaParser optionsPragmaParser(true);
         program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
         P4::FrontEnd frontend;
         frontend.addDebugHook(hook);

diff --git a/backends/tofino/bf-p4c/bf-p4c-options.h b/backends/tofino/bf-p4c/bf-p4c-options.h
@@ -223,6 +223,9 @@ class BFNOptionPragmaParser : public P4::P4COptionPragmaParser {
  public:
     std::optional<CommandLineOptions> tryToParse(const IR::Annotation *annotation) override;
 
+    BFNOptionPragmaParser() : P4::P4COptionPragmaParser(false) {}
+    // FIXME -- should remove the tofino @command_line stuff and use the base class
+
  private:
     std::optional<CommandLineOptions> parseCompilerOption(const IR::Annotation *annotation);
 };

diff --git a/frontends/common/applyOptionsPragmas.cpp b/frontends/common/applyOptionsPragmas.cpp
@@ -51,6 +51,22 @@ std::optional<IOptionPragmaParser::CommandLineOptions> P4COptionPragmaParser::tr
     const IR::Annotation *annotation) {
     auto pragmaName = annotation->name.name;
     if (pragmaName == "diagnostic") return parseDiagnostic(annotation);
+    if (supportCommandLinePragma && pragmaName == "command_line") {
+        IOptionPragmaParser::CommandLineOptions options;
+        auto *args = annotation->needsParsing()
+                         ? P4ParserDriver::parseExpressionList(annotation->srcInfo,
+                                                               annotation->getUnparsed())
+                         : &annotation->getExpr();
+        for (auto *arg : *args) {
+            if (auto *a = arg->to<IR::StringLiteral>()) {
+                options.push_back(a->value.c_str());
+            } else {
+                // can this happen?  annotation parser should require only strings
+                warning("ignoring non-string %1% in @command_line", a);
+            }
+        }
+        return options;
+    }
     return std::nullopt;
 }
 

diff --git a/frontends/common/applyOptionsPragmas.h b/frontends/common/applyOptionsPragmas.h
@@ -76,9 +76,14 @@ class ApplyOptionsPragmas : public Inspector {
  * they're unable to parse a pragma.
  */
 class P4COptionPragmaParser : public IOptionPragmaParser {
+    bool supportCommandLinePragma;
+
  public:
     std::optional<CommandLineOptions> tryToParse(const IR::Annotation *annotation) override;
 
+    explicit P4COptionPragmaParser(bool supportCommandLinePragma)
+        : supportCommandLinePragma(supportCommandLinePragma) {}
+
  private:
     std::optional<CommandLineOptions> parseDiagnostic(const IR::Annotation *annotation);
 };

diff --git a/frontends/p4/parseAnnotations.cpp b/frontends/p4/parseAnnotations.cpp
@@ -51,6 +51,9 @@ ParseAnnotations::HandlerMap ParseAnnotations::standardHandlers() {
 
         // @match has an expression argument
         PARSE(IR::Annotation::matchAnnotation, Expression),
+
+        // @command_line to add to the command line
+        PARSE_STRING_LITERAL_LIST("command_line"_cs),
     };
 }
 

diff --git a/test/gtest/helpers.cpp b/test/gtest/helpers.cpp
@@ -178,7 +178,7 @@ namespace P4::Test {
         return std::nullopt;
     }
 
-    P4::P4COptionPragmaParser optionsPragmaParser;
+    P4::P4COptionPragmaParser optionsPragmaParser(true);
     program->apply(P4::ApplyOptionsPragmas(optionsPragmaParser));
     if (::P4::errorCount() > 0) {
         std::cerr << "Encountered " << ::P4::errorCount()

diff --git a/testdata/p4_16_samples/parser-unroll-issue3537-1.p4 b/testdata/p4_16_samples/parser-unroll-issue3537-1.p4
@@ -1,6 +1,8 @@
 #include <core.p4>
 #include <v1model.p4>
 
+@command_line("--loopsUnroll")
+
 struct H { }
 
 struct M { }
@@ -68,4 +70,4 @@ control ComputeChecksumI(inout H hdr, inout M meta) {
 
 
 V1Switch(ParserI(), VerifyChecksumI(), IngressI(), EgressI(),
-         ComputeChecksumI(), DeparserI()) main;
+         ComputeChecksumI(), DeparserI()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-issue3537.p4 b/testdata/p4_16_samples/parser-unroll-issue3537.p4
@@ -1,5 +1,6 @@
 #include <core.p4>
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header h1_t {}
 header h2_t {

diff --git a/testdata/p4_16_samples/parser-unroll-issue4006_twice_extracted_header.p4 b/testdata/p4_16_samples/parser-unroll-issue4006_twice_extracted_header.p4
@@ -1,5 +1,6 @@
 #include <core.p4>
 #include <dpdk/psa.p4>
+@command_line("--loopsUnroll")
 
 typedef bit<48> eth_addr_t;
 

diff --git a/testdata/p4_16_samples/parser-unroll-t1-cond.p4 b/testdata/p4_16_samples/parser-unroll-t1-cond.p4
@@ -1,6 +1,7 @@
 // examples for simple IP/tcp.
 #include <core.p4>
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 typedef bit<48>     MacAddress;
 typedef bit<32>     ip4Addr_t;

diff --git a/testdata/p4_16_samples/parser-unroll-test1.p4 b/testdata/p4_16_samples/parser-unroll-test1.p4
@@ -1,4 +1,5 @@
 #include "v1model.p4"
+@command_line("--loopsUnroll")
 
 const bit<16> TYPE_IPV4 = 0x800;
 const bit<16> TYPE_SRCROUTING = 0x1234;
@@ -102,4 +103,4 @@ control computeChecksum(inout headers hdr, inout metadata meta) {
 apply {}
 }
 V1Switch(MyParser(), verifyChecksum(), mau(), mau(), computeChecksum(),
-        deparse()) main;
+        deparse()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-test10.p4 b/testdata/p4_16_samples/parser-unroll-test10.p4
@@ -2,6 +2,7 @@
 
 #include <core.p4>
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header test_h {
     bit<8> field;

diff --git a/testdata/p4_16_samples/parser-unroll-test2.p4 b/testdata/p4_16_samples/parser-unroll-test2.p4
@@ -1,4 +1,5 @@
 #include "v1model.p4"
+@command_line("--loopsUnroll")
 
 const bit<16> TYPE_IPV4 = 0x800;
 const bit<16> TYPE_SRCROUTING = 0x1234;
@@ -99,4 +100,4 @@ control computeChecksum(inout headers hdr, inout metadata meta) {
 apply {}
 }
 V1Switch(MyParser(), verifyChecksum(), mau(), mau(), computeChecksum(),
-        deparse()) main;
+        deparse()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-test3.p4 b/testdata/p4_16_samples/parser-unroll-test3.p4
@@ -1,4 +1,5 @@
 #include "v1model.p4"
+@command_line("--loopsUnroll")
 
 const bit<16> TYPE_IPV4 = 0x800;
 const bit<16> TYPE_SRCROUTING = 0x1234;
@@ -114,4 +115,4 @@ control computeChecksum(inout headers hdr, inout metadata meta) {
 apply {}
 }
 V1Switch(MyParser(), verifyChecksum(), mau(), mau(), computeChecksum(),
-        deparse()) main;
+        deparse()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-test4.p4 b/testdata/p4_16_samples/parser-unroll-test4.p4
@@ -1,4 +1,5 @@
 #include "v1model.p4"
+@command_line("--loopsUnroll")
 
 const bit<16> TYPE_IPV4 = 0x800;
 const bit<16> TYPE_SRCROUTING = 0x1234;
@@ -107,4 +108,4 @@ control computeChecksum(inout headers hdr, inout metadata meta) {
 apply {}
 }
 V1Switch(MyParser(), verifyChecksum(), mau(), mau(), computeChecksum(),
-        deparse()) main;
+        deparse()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-test5.p4 b/testdata/p4_16_samples/parser-unroll-test5.p4
@@ -1,4 +1,5 @@
 #include "v1model.p4"
+@command_line("--loopsUnroll")
 
 const bit<16> TYPE_IPV4 = 0x800;
 const bit<16> TYPE_SRCROUTING = 0x1234;
@@ -109,4 +110,4 @@ control computeChecksum(inout headers hdr, inout metadata meta) {
 apply {}
 }
 V1Switch(MyParser(), verifyChecksum(), mau(), mau(), computeChecksum(),
-        deparse()) main;
+        deparse()) main;
diff --git a/testdata/p4_16_samples/parser-unroll-test6.p4 b/testdata/p4_16_samples/parser-unroll-test6.p4
@@ -1,5 +1,6 @@
 /* -*- Mode:C; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header test_header_t {
   bit<8> value;

diff --git a/testdata/p4_16_samples/parser-unroll-test7.p4 b/testdata/p4_16_samples/parser-unroll-test7.p4
@@ -1,5 +1,6 @@
 #include <core.p4>
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header S {
     bit<8> t;

diff --git a/testdata/p4_16_samples/parser-unroll-test8.p4 b/testdata/p4_16_samples/parser-unroll-test8.p4
@@ -1,6 +1,7 @@
 #include <core.p4>
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header h_index1 {
     bit<8> index;

diff --git a/testdata/p4_16_samples/parser-unroll-test9.p4 b/testdata/p4_16_samples/parser-unroll-test9.p4
@@ -1,6 +1,7 @@
 #include <core.p4>
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
+@command_line("--loopsUnroll")
 
 header h_stack {
     bit<8> i1;

diff --git a/testdata/p4_16_samples/parser-unroll-uninitialized-slice-read.p4 b/testdata/p4_16_samples/parser-unroll-uninitialized-slice-read.p4
@@ -1,4 +1,5 @@
 #include <core.p4>
+@command_line("--loopsUnroll")
 
 parser p(packet_in packet, out bit<8> f, out bit<4> g) {
     state start {

diff --git a/testdata/p4_16_samples/parser-unroll-uninitialized-slice-write.p4 b/testdata/p4_16_samples/parser-unroll-uninitialized-slice-write.p4
@@ -1,4 +1,5 @@
 #include <core.p4>
+@command_line("--loopsUnroll")
 
 struct S {
     bit<8> f;

diff --git a/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-first.p4 b/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-first.p4
@@ -2,7 +2,7 @@
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
 
-struct H {
+@command_line("--loopsUnroll") struct H {
 }
 
 struct M {

diff --git a/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-frontend.p4 b/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-frontend.p4
@@ -2,7 +2,7 @@
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
 
-struct H {
+@command_line("--loopsUnroll") struct H {
 }
 
 struct M {

diff --git a/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-midend.p4 b/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1-midend.p4
@@ -2,7 +2,7 @@
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
 
-struct H {
+@command_line("--loopsUnroll") struct H {
 }
 
 struct M {
@@ -11,9 +11,6 @@ struct M {
 parser ParserI(packet_in packet, out H hdr, inout M meta, inout standard_metadata_t smeta) {
     @name("ParserI.tmp_0") bit<16> tmp_0;
     @name("ParserI.tmp_2") bit<16> tmp_2;
-    state start {
-        transition s1;
-    }
     state s1 {
         packet.advance(32w16);
         tmp_0 = packet.lookahead<bit<16>>();
@@ -34,6 +31,9 @@ parser ParserI(packet_in packet, out H hdr, inout M meta, inout standard_metadat
     state s4 {
         transition accept;
     }
+    state start {
+        transition s1;
+    }
 }
 
 control IngressI(inout H hdr, inout M meta, inout standard_metadata_t smeta) {

diff --git a/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1.p4 b/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1.p4
@@ -2,7 +2,7 @@
 #define V1MODEL_VERSION 20180101
 #include <v1model.p4>
 
-struct H {
+@command_line("--loopsUnroll") struct H {
 }
 
 struct M {

diff --git a/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1.p4-stderr b/testdata/p4_16_samples_outputs/parser-unroll-issue3537-1.p4-stderr
@@ -1,3 +1,9 @@
-parser-unroll-issue3537-1.p4(43): [--Wwarn=unused] warning: Control Aux is not used; removing
+parser-unroll-issue3537-1.p4(45): [--Wwarn=unused] warning: Control Aux is not used; removing
 control Aux(inout M meta) {
         ^^^
+[--Wwarn=invalid] warning: Parser cycle can't be unrolled, because ParserUnroll can't detect the number of loop iterations:
+Parser ParserI state chain: start, s1, s2, s2
+[--Wwarn=invalid] warning: Parser cycle can't be unrolled, because ParserUnroll can't detect the number of loop iterations:
+Parser ParserI state chain: start, s1, s2, s1
+[--Wwarn=invalid] warning: Parser cycle can't be unrolled, because ParserUnroll can't detect the number of loop iterations:
+Parser ParserI state chain: start, s1, s1