PR #283: System calls such as $display and $sformat fail if encrypted

This patch recognizes a SystemTFIdentifier and turns off encryption for that token. Otherwise the obfuscated Verilog cannot be compiled if it contains such calls. GitHub PR #283 Copybara import of the project: - 095fae5 System calls such as and fail if encrypted by Jonathan Kimmitt <[email protected]> - 04a1b60 Correct testcases for unencrypted tasks (fixes #282) by Jonathan Kimmitt <[email protected]> Closes #283 fixes #282 PiperOrigin-RevId: 309820780
chipsalliance · May 4, 2020 · 2c98e20 · 2c98e20
1 parent dec5e6a
commit 2c98e20
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/verilog/transform/obfuscate.cc b/verilog/transform/obfuscate.cc
@@ -47,9 +47,13 @@ static void ObfuscateVerilogCodeInternal(absl::string_view content,
       case verilog_tokentype::PP_Identifier:
         *output << (*subst)(token.text);
         break;
+        // Preserve all $ID calls, including system task/function calls, and VPI
+        // calls
+      case verilog_tokentype::SystemTFIdentifier:
+        *output << token.text;
+        break;
         // The following identifier types start with a special character that
         // needs to be preserved.
-      case verilog_tokentype::SystemTFIdentifier:
       case verilog_tokentype::MacroIdentifier:
       case verilog_tokentype::MacroCallId:
         // TODO(fangism): verilog_tokentype::EscapedIdentifier

diff --git a/verilog/transform/obfuscate_test.cc b/verilog/transform/obfuscate_test.cc
@@ -53,10 +53,10 @@ TEST(ObfuscateVerilogCodeTest, PreloadedSubstitutions) {
        "`ifdef AAA\n`elsif CCC\n`else\n`endif\n"},
       {"`define ccc bbb+aaa\n", "`define CCC BBB+AAA\n"},
       {"`define ccc `bbb+`aaa\n", "`define CCC `BBB+`AAA\n"},
-      {"task bbb;\n  $aaa;\nendtask\n", "task BBB;\n  $AAA;\nendtask\n"},
-      {"task bbb;\n  $aaa();\nendtask\n", "task BBB;\n  $AAA();\nendtask\n"},
+      {"task bbb;\n  $aaa;\nendtask\n", "task BBB;\n  $aaa;\nendtask\n"},
+      {"task bbb;\n  $aaa();\nendtask\n", "task BBB;\n  $aaa();\nendtask\n"},
       {"task bbb;\n  $aaa($ccc());\nendtask\n",
-       "task BBB;\n  $AAA($CCC());\nendtask\n"},
+       "task BBB;\n  $aaa($ccc());\nendtask\n"},
       {"function aaa()\nreturn bbb^ccc;\nendfunction\n",
        "function AAA()\nreturn BBB^CCC;\nendfunction\n"},
       {"function aaa()\nreturn bbb(ccc);\nendfunction\n",