[ms] [llvm-ml] Support command-line defines

[epastor]

Summary

Enable command-line defines as textmacros

[epastor]

Rebase on HEAD

[epastor]

Rebase on parent

[thakis]

lg with tweaks:

llvm/lib/MC/MCParser/MasmParser.cpp

6917

masm doesn't do it, but I think we should diag on redefinitions in -D flags, at least if the redefinition has a different value. that's likely always a bug in the build system invoking us.

llvm/test/tools/llvm-ml/command_line_defines.asm

16

Can you test ifdef elseifdef too?

[epastor]

Add ifdef testing, and fix a minor StringRef vs. std::string issue.

[epastor]

Rebase on parent

[epastor]

Rebase on parent

[epastor]

llvm/lib/MC/MCParser/MasmParser.cpp

6917

I'm not sure there's a clean way to do this that isn't an error, and I'd like to maintain compatibility with ml64.exe on this. If you think it's worth special-casing this to plumb a warning through, we can do that... but I'm not convinced it's a good idea.

[epastor]

Rebase on parent

[epastor]

Rebase on parent

[epastor]

Rebase on HEAD

[thakis]

llvm/lib/MC/MCParser/MasmParser.cpp

6917

It'd match clang, which would be good, no?

llvm/include/llvm/MC/MCParser/MCAsmParser.h

public:
   /// Run the parser on the input source buffer.
   virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0;
 
   virtual void setParsingMSInlineAsm(bool V) = 0;
   virtual bool isParsingMSInlineAsm() = 0;
 
   virtual bool isParsingMasm() const { return false; }
 
+  virtual bool defineMacro(StringRef Name, StringRef Value) { return true; }
+
   virtual bool lookUpField(StringRef Name, AsmFieldInfo &Info) const {
     return true;
   }
   virtual bool lookUpField(StringRef Base, StringRef Member,
                            AsmFieldInfo &Info) const {
     return true;
   }
 

llvm/lib/MC/MCParser/MasmParser.cpp

void setParsingMSInlineAsm(bool V) override {
     // When parsing MS inline asm, we must lex 0b1101 and 0ABCH as binary and
     // hex integer literals.
     Lexer.setLexMasmIntegers(V);
   }
   bool isParsingMSInlineAsm() override { return ParsingMSInlineAsm; }
 
   bool isParsingMasm() const override { return true; }
 
+  bool defineMacro(StringRef Name, StringRef Value) override;
+
   bool lookUpField(StringRef Name, AsmFieldInfo &Info) const override;
   bool lookUpField(StringRef Base, StringRef Member,
                    AsmFieldInfo &Info) const override;
 
   bool lookUpType(StringRef Name, AsmTypeInfo &Info) const override;
 
   bool parseMSInlineAsm(void *AsmLoc, std::string &AsmString,
                         unsigned &NumOutputs, unsigned &NumInputs,
if (AsmRewritePrecedence[AsmRewriteA->Kind] >
     return -1;
 
   if (AsmRewritePrecedence[AsmRewriteA->Kind] <
       AsmRewritePrecedence[AsmRewriteB->Kind])
     return 1;
   llvm_unreachable("Unstable rewrite sort.");
 }
 
+bool MasmParser::defineMacro(StringRef Name, StringRef Value) {
+  Variable &Var = Variables[Name.lower()];
+  if (Var.Name.empty()) {
+    Var.Name = Name;
+  } else if (!Var.Redefinable) {
+    return TokError("invalid variable redefinition");
+  }
+  Var.Redefinable = true;
+  Var.IsText = true;
+  Var.TextValue = Value.str();
+  return false;
+}
+
 bool MasmParser::lookUpField(StringRef Name, AsmFieldInfo &Info) const {
   const std::pair<StringRef, StringRef> BaseMember = Name.split('.');
   const StringRef Base = BaseMember.first, Member = BaseMember.second;
   return lookUpField(Base, Member, Info);
 }
 
 bool MasmParser::lookUpField(StringRef Base, StringRef Member,
                              AsmFieldInfo &Info) const {

llvm/test/tools/llvm-ml/command_line_defines.asm

+; RUN: llvm-ml -filetype=s %s /Fo - /DT1=test1 /D T2=test2 | FileCheck %s
+
+.code
+
+t1:
+  ret
+; CHECK-NOT: t1:
+; CHECK-LABEL: test1:
+; CHECK-NOT: t1:
+
+t2:
+  ret
+; CHECK-NOT: t2:
+; CHECK-LABEL: test2:
+; CHECK-NOT: t2:
+
+t3:
+ifdef t1
+  xor eax, eax
+endif
+  ret
+; CHECK-LABEL: t3:
+; CHECK: xor eax, eax
+; CHECK: ret
+
+t4:
+ifdef undefined
+  xor eax, eax
+elseifdef t2
+  xor ebx, ebx
+endif
+  ret
+; CHECK-LABEL: t4:
+; CHECK-NOT: xor eax, eax
+; CHECK: xor ebx, ebx
+; CHECK: ret
+
+end

llvm/tools/llvm-ml/Opts.td

class UnsupportedJoinedOrSeparate<string name> :
         JoinedOrSeparate<["/", "-"], name>, Group<unsupported_Group>;
 class UnsupportedSeparate<string name> : Separate<["/", "-"], name>,
                                          Group<unsupported_Group>;
 
 def help : MLFlag<"?">,
            HelpText<"Display available options">;
 def help_long : MLFlag<"help">, Alias<help>;
 def assemble_only : MLFlag<"c">, HelpText<"Assemble only; do not link">;
+def define : MLJoinedOrSeparate<"D">, MetaVarName<"<macro>=<value>">,
+             HelpText<"Define <macro> to <value> (or blank if <value> "
+                      "omitted)">;
 def output_file : MLJoinedOrSeparate<"Fo">, HelpText<"Names the output file">;
 def include_path : MLJoinedOrSeparate<"I">,
                    HelpText<"Sets path for include files">;
 def safeseh : MLFlag<"safeseh">,
               HelpText<"Mark resulting object files as either containing no "
                        "exception handlers or containing exception handlers "
                        "that are all declared with .SAFESEH. Only available in "
                        "32-bit.">;
def save_temp_labels : LLVMFlag<"save-temp-labels">,
                        HelpText<"Don't discard temporary labels">;
 
 def tiny_model_support : UnsupportedFlag<"AT">, HelpText<"">;
 def alternate_linker : UnsupportedJoined<"Bl">, HelpText<"">;
 def coff_object_file : UnsupportedFlag<"coff">, HelpText<"">;
 def preserve_identifier_case : UnsupportedFlag<"Cp">, HelpText<"">;
 def uppercase_identifiers : UnsupportedFlag<"Cu">, HelpText<"">;
 def preserve_extern_case : UnsupportedFlag<"Cx">, HelpText<"">;
-def define : UnsupportedJoinedOrSeparate<"D">, HelpText<"">;
 def output_preprocessed : UnsupportedFlag<"EP">, HelpText<"">;
 def errorreport : UnsupportedJoined<"ERRORREPORT">, HelpText<"">;
 def stacksize : UnsupportedSeparate<"F">, HelpText<"">;
 def executable_file : UnsupportedSeparate<"Fe">, HelpText<"">;
 def code_listing_file : UnsupportedJoined<"FI">, HelpText<"">;
 def linker_map_file : UnsupportedJoined<"Fm">, HelpText<"">;
 def fp_emulator_fixups : UnsupportedFlag<"FPi">, HelpText<"">;
 def source_browser_file : UnsupportedJoined<"Fr">, HelpText<"">;

llvm/tools/llvm-ml/llvm-ml.cpp

static int AssembleInput(StringRef ProgName, const Target *TheTarget,
 
   Parser->setShowParsedOperands(InputArgs.hasArg(OPT_show_inst_operands));
   Parser->setTargetParser(*TAP);
   Parser->getLexer().setLexMasmIntegers(true);
   Parser->getLexer().useMasmDefaultRadix(true);
   Parser->getLexer().setLexMasmHexFloats(true);
   Parser->getLexer().setLexMasmStrings(true);
 
+  auto Defines = InputArgs.getAllArgValues(OPT_define);
+  for (StringRef Define : Defines) {
+    const auto NameValue = Define.split('=');
+    StringRef Name = NameValue.first, Value = NameValue.second;
+    if (Parser->defineMacro(Name, Value)) {
+      WithColor::error(errs(), ProgName)
+          << "can't define macro '" << Name << "' = '" << Value << "'\n";
+      return 1;
+    }
+  }
+
   int Res = Parser->Run(/*NoInitialTextSection=*/true);
 
   return Res;
 }
 
 int main(int Argc, char **Argv) {
   InitLLVM X(Argc, Argv);
   StringRef ProgName = sys::path::filename(Argv[0]);