[MC] Add command-line option to choose the max nest level in asm macros

[• t83wCSLq]

Summary

This patch adds a command-line option (-asm-macro-max-nesting-depth <n>) to choose the maximum nesting level in assembly macros.

[• t83wCSLq]

Who should I add as reviewers?

[davide]

I think Rafael is in a good position to review this

[• t83wCSLq]

Thanks!

[• rafael]

In D22313#484719, @davide wrote:

I think Rafael is in a good position to review this

Unfortunately no. I am cutting down my involvement with LLVM.
Adding the code owner instead.

[• t83wCSLq]

Pinging this hoping someone can review the patch.
(code owner does not seem active)

[davide]

Sorry for the delay, this shouldn't happen. I think the code is correct, but you should come up with a testcase.
Eric, any thoughts on the limit?

[• t83wCSLq]

Added a testcase.

[• t83wCSLq]

Fixing space typo.

[davide]

Committed (r276842). Sorry if this took an unreasonable amount of time.

[echristo]

Out of curiosity, why? :)

-eric

lib/MC/MCParser/AsmParser.cpp

 #include "llvm/MC/MCStreamer.h"
 #include "llvm/MC/MCSymbol.h"
 #include "llvm/MC/MCValue.h"
+#include "llvm/Support/CommandLine.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/MathExtras.h"
 #include "llvm/Support/MemoryBuffer.h"

 #include "llvm/Support/raw_ostream.h"
 #include <cctype>
 #include <deque>
+#include <sstream>
 #include <string>
 #include <vector>
 using namespace llvm;
 
 MCAsmParserSemaCallback::~MCAsmParserSemaCallback() {}
 
+static cl::opt<unsigned> AsmMacroMaxNestingDepth(
+     "asm-macro-max-nesting-depth", cl::init(20), cl::Hidden,
+     cl::desc("The maximum nesting depth allowed for assembly macros."));
+
 namespace {
 /// \brief Helper types for tracking macro definitions.
 typedef std::vector<AsmToken> MCAsmMacroArgument;

 void AsmParser::undefineMacro(StringRef Name) { MacroMap.erase(Name); }
 
 bool AsmParser::handleMacroEntry(const MCAsmMacro *M, SMLoc NameLoc) {
-  // Arbitrarily limit macro nesting depth, to match 'as'. We can eliminate
-  // this, although we should protect against infinite loops.
-  if (ActiveMacros.size() == 20)
-    return TokError("macros cannot be nested more than 20 levels deep");
+  // Arbitrarily limit macro nesting depth (default matches 'as'). We can
+  // eliminate this, although we should protect against infinite loops.
+  unsigned MaxNestingDepth = AsmMacroMaxNestingDepth;
+  if (ActiveMacros.size() == MaxNestingDepth) {
+    std::ostringstream MaxNestingDepthError;
+    MaxNestingDepthError << "macros cannot be nested more than "
+                         << MaxNestingDepth << " levels deep."
+                         << " Use -asm-macro-max-nesting-depth to increase "
+                            "this limit.";
+    return TokError(MaxNestingDepthError.str());
+  }
 
   MCAsmMacroArguments A;
   if (parseMacroArguments(M, A))

test/MC/AsmParser/macro-max-depth.s

+// RUN: llvm-mc -triple x86_64-unknown-unknown -asm-macro-max-nesting-depth=42 %s | FileCheck %s -check-prefix=CHECK_PASS
+// RUN: not llvm-mc -triple x86_64-unknown-unknown %s 2> %t
+// RUN: FileCheck -check-prefix=CHECK_FAIL < %t %s
+
+.macro rec head, tail:vararg
+        .ifnb  \tail
+        rec \tail
+        .else
+  .long 42
+  .endif
+.endm
+
+.macro amplify macro, args:vararg
+  \macro \args \args \args \args
+.endm
+
+amplify rec 0 0 0 0 0 0 0 0 0 0
+
+
+// CHECK_PASS: .long  42
+// CHECK_FAIL: error: macros cannot be nested more than {{[0-9]+}} levels deep. Use -asm-macro-max-nesting-depth to increase this limit.
+