[ms] [llvm-ml] Create the @feat.00 symbol, and populate it appropriately

[epastor]

Summary

@feat.00 is a bitfield read by Microsoft-style linkers, and is required to signal (e.g.) /safeseh support on 32-bit systems.

[rnk]

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

372

This looks like the first instance of C++14 binary literals in LLVM non-test C++ source code. In theory, C++14 support is required, but if I were you I'd prefer not to be the guinea pig.

380–381

Can getOrCreateSymbol ever return null? The implementation suggests that it can't. Is this branch meant to avoid redefining @feat.00 if it is already set?

[epastor]

Address feedback: remove an unnecessary branch, and avoid using a C++14 binary literal just in case.

[epastor]

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

372

Switched, thanks.

380–381

I think I was assuming it could be null when I wrote this. Removed the unnecessary branch.

[rnk]

lgtm

[epastor]

Rebase on parent

llvm/test/tools/llvm-ml/feat00.test

+; RUN: llvm-ml -m32 -filetype=obj %s | llvm-readobj --syms - | FileCheck %s --check-prefix=CHECK-OBJ --check-prefix=CHECK-OBJ-NOSAFESEH
+; RUN: llvm-ml -m64 -filetype=obj %s | llvm-readobj --syms - | FileCheck %s --check-prefix=CHECK-OBJ --check-prefix=CHECK-OBJ-NOSAFESEH
+
+; RUN: llvm-ml -m32 -safeseh -filetype=obj %s | llvm-readobj --syms - | FileCheck %s --check-prefix=CHECK-OBJ --check-prefix=CHECK-OBJ-SAFESEH
+; RUN: llvm-ml -m64 -safeseh -filetype=obj %s -o %t.obj 2>&1 | FileCheck %s --check-prefix=CHECK-SAFESEH64
+; RUN: llvm-readobj --syms %t.obj | FileCheck %s --check-prefix=CHECK-OBJ --check-prefix=CHECK-OBJ-NOSAFESEH
+
+; CHECK-SAFESEH64: warning: /safeseh applies only to 32-bit X86 platforms; ignoring.
+
+.code
+noop:
+  ret
+end
+
+; CHECK-OBJ:       Symbol {
+; CHECK-OBJ:         Name: @feat.00
+; CHECK-OBJ-NOSAFESEH:  Value: 2
+; CHECK-OBJ-SAFESEH:    Value: 3
+; CHECK-OBJ-NEXT:    Section: IMAGE_SYM_ABSOLUTE
+; CHECK-OBJ-NEXT:    BaseType: Null
+; CHECK-OBJ-NEXT:    ComplexType: Null
+; CHECK-OBJ-NEXT:    StorageClass: External
+; CHECK-OBJ-NEXT:    AuxSymbolCount: 0
+; CHECK-OBJ-NEXT:  }

llvm/test/tools/llvm-ml/feat00_override.test

+; RUN: llvm-ml -m32 -filetype=obj %s | llvm-readobj --syms - | FileCheck %s
+; RUN: llvm-ml -m64 -filetype=obj %s | llvm-readobj --syms - | FileCheck %s
+; RUN: llvm-ml -m32 -safeseh -filetype=obj %s | llvm-readobj --syms - | FileCheck %s
+
+.code
+
+@feat.00 = 99
+
+noop:
+  ret
+end
+
+; CHECK:       Symbol {
+; CHECK:         Name: @feat.00
+; CHECK:         Value: 99
+; CHECK-NEXT:    Section: IMAGE_SYM_ABSOLUTE
+; CHECK-NEXT:    BaseType: Null
+; CHECK-NEXT:    ComplexType: Null
+; CHECK-NEXT:    StorageClass: Static
+; CHECK-NEXT:    AuxSymbolCount: 0
+; CHECK-NEXT:  }

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

 enum BitnessType {
   m32,
   m64,
 };
 cl::opt<BitnessType> Bitness(cl::desc("Choose bitness:"), cl::init(m64),
                              cl::values(clEnumVal(m32, "32-bit"),
                                         clEnumVal(m64, "64-bit (default)")));
 
+static cl::opt<bool> SafeSEH(
+    "safeseh",
+    cl::desc("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."));
+
 static cl::opt<std::string>
 TripleName("triple", cl::desc("Target triple to assemble for, "
                               "see -version for available targets"));
 
 static cl::opt<std::string>
 DebugCompilationDir("fdebug-compilation-dir",
                     cl::desc("Specifies the debug info's compilation dir"));
 
static int AsLexInput(SourceMgr &SrcMgr, MCAsmInfo &MAI, raw_ostream &OS) {
   return Error;
 }
 
 static int AssembleInput(const char *ProgName, const Target *TheTarget,
                          SourceMgr &SrcMgr, MCContext &Ctx, MCStreamer &Str,
                          MCAsmInfo &MAI, MCSubtargetInfo &STI,
                          MCInstrInfo &MCII, MCTargetOptions &MCOptions) {
   std::unique_ptr<MCAsmParser> Parser(
-      createMCMasmParser(SrcMgr, Ctx, Str, MAI));
+      createMCMasmParser(SrcMgr, Ctx, Str, MAI, 0));
   std::unique_ptr<MCTargetAsmParser> TAP(
       TheTarget->createMCAsmParser(STI, *Parser, MCII, MCOptions));
 
   if (!TAP) {
     WithColor::error(errs(), ProgName)
         << "this target does not support assembly parsing.\n";
     return 1;
   }
int main(int argc, char **argv) {
   const char *ProgName = argv[0];
   const Target *TheTarget = GetTarget(ProgName);
   if (!TheTarget)
     return 1;
   // Now that GetTarget() has (potentially) replaced TripleName, it's safe to
   // construct the Triple object.
   Triple TheTriple(TripleName);
 
+  if (SafeSEH && !(TheTriple.isArch32Bit() && TheTriple.isX86())) {
+    WithColor::warning()
+        << "/safeseh applies only to 32-bit X86 platforms; ignoring.\n";
+    SafeSEH = false;
+  }
+
   ErrorOr<std::unique_ptr<MemoryBuffer>> BufferPtr =
       MemoryBuffer::getFileOrSTDIN(InputFilename);
   if (std::error_code EC = BufferPtr.getError()) {
     WithColor::error(errs(), ProgName)
         << InputFilename << ": " << EC.message() << '\n';
     return 1;
   }
   MemoryBuffer *Buffer = BufferPtr->get();
if (FileType == OFT_AssemblyFile) {
     MCAsmBackend *MAB = TheTarget->createMCAsmBackend(*STI, *MRI, MCOptions);
     Str.reset(TheTarget->createMCObjectStreamer(
         TheTriple, Ctx, std::unique_ptr<MCAsmBackend>(MAB),
         MAB->createObjectWriter(*OS), std::unique_ptr<MCCodeEmitter>(CE), *STI,
         MCOptions.MCRelaxAll, MCOptions.MCIncrementalLinkerCompatible,
         /*DWARFMustBeAtTheEnd*/ false));
   }
 
+  if (TheTriple.isOSBinFormatCOFF()) {
+    // Emit an absolute @feat.00 symbol. This is a features bitfield read by
+    // link.exe.
+    int64_t Feat00Flags = 0b10;
+    if (SafeSEH) {
+      // According to the PE-COFF spec, the LSB of this value marks the object
+      // for "registered SEH".  This means that all SEH handler entry points
+      // must be registered in .sxdata.  Use of any unregistered handlers will
+      // cause the process to terminate immediately.
+      Feat00Flags |= 0b1;
+    }
+    MCSymbol *Feat00Sym = Ctx.getOrCreateSymbol("@feat.00");
+    if (Feat00Sym) {
+      Feat00Sym->setRedefinable(true);
+      Str->emitSymbolAttribute(Feat00Sym, MCSA_Global);
+      Str->emitAssignment(Feat00Sym, MCConstantExpr::create(Feat00Flags, Ctx));
+    }
+  }
+
   // Use Assembler information for parsing.
   Str->setUseAssemblerInfoForParsing(true);
 
   int Res = 1;
   bool disassemble = false;
   switch (Action) {
   case AC_AsLex:
     Res = AsLexInput(SrcMgr, *MAI, Out->os());