Subzero: Add basic ELFObjectWriter (text section, symtab, strtab, headers)

src/llvm2ice.cpp

 //===- subzero/src/llvm2ice.cpp - Driver for testing ----------------------===//
 //
 //                        The Subzero Code Generator
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // This file defines a driver that uses LLVM capabilities to parse a
@@ skipping 155 matching lines @@
                 cl::init(true));
 
 static cl::opt<bool>
     UseIntegratedAssembler("integrated-as",
                            cl::desc("Use integrated assembler (default yes)"),
                            cl::init(true));
 
 static cl::alias UseIas("ias", cl::desc("Alias for -integrated-as"),
                         cl::NotHidden, cl::aliasopt(UseIntegratedAssembler));
 
+static cl::opt<bool>
+    UseELFWriter("elf-writer",
+                 cl::desc("Use ELF writer with the integrated assembler"),
+                 cl::init(false));
+
 static cl::opt<bool> AlwaysExitSuccess(
     "exit-success", cl::desc("Exit with success status, even if errors found"),
     cl::init(false));
 
 static cl::opt<bool>
 GenerateBuildAtts("build-atts",
                   cl::desc("Generate list of build attributes associated with "
                            "this executable."),
                   cl::init(false));
 
@@ skipping 49 matching lines @@
     DisableTranslation = true;
 
   Ice::VerboseMask VMask = Ice::IceV_None;
   // Don't generate verbose messages if routines
   // to dump messages are not available.
   if (ALLOW_DUMP) {
     for (unsigned i = 0; i != VerboseList.size(); ++i)
       VMask |= VerboseList[i];
   }
 
-  std::ofstream Ofs;
-  if (OutputFilename != "-") {
-    Ofs.open(OutputFilename.c_str(), std::ofstream::out);
-  }
-  raw_os_ostream *Os =
-      new raw_os_ostream(OutputFilename == "-" ? std::cout : Ofs);
-  Os->SetUnbuffered();
-
-  ValidateAndGenerateBuildAttributes(GenerateBuildAtts ? Os : nullptr);
-  if (GenerateBuildAtts)
-    return GetReturnValue(0);
-
   std::ofstream Lfs;
   if (LogFilename != "-") {
     Lfs.open(LogFilename.c_str(), std::ofstream::out);
   }
   raw_os_ostream *Ls = new raw_os_ostream(LogFilename == "-" ? std::cout : Lfs);
   Ls->SetUnbuffered();
 
+  ValidateAndGenerateBuildAttributes(GenerateBuildAtts ? Ls : nullptr);
+  if (GenerateBuildAtts)
+    return GetReturnValue(0);
+
   if (!ALLOW_DISABLE_IR_GEN && DisableIRGeneration) {
     *Ls << "Error: Build doesn't allow --no-ir-gen when not "
         << "ALLOW_DISABLE_IR_GEN!\n";
     return GetReturnValue(1);
   }
 
   Ice::ClFlags Flags;
   Flags.DisableInternal = DisableInternal;
   Flags.SubzeroTimingEnabled = SubzeroTimingEnabled;
   Flags.DisableTranslation = DisableTranslation;
   Flags.FunctionSections = FunctionSections;
   Flags.DataSections = DataSections;
   Flags.UseIntegratedAssembler = UseIntegratedAssembler;
+  Flags.UseELFWriter = UseELFWriter;
   Flags.UseSandboxing = UseSandboxing;
   Flags.PhiEdgeSplit = EnablePhiEdgeSplit;
   Flags.DecorateAsm = DecorateAsm;
   Flags.DumpStats = DumpStats;
   Flags.AllowUninitializedGlobals = AllowUninitializedGlobals;
   Flags.TimeEachFunction = TimeEachFunction;
   Flags.DefaultGlobalPrefix = DefaultGlobalPrefix;
   Flags.DefaultFunctionPrefix = DefaultFunctionPrefix;
   Flags.TimingFocusOn = TimingFocusOn;
   Flags.VerboseFocusOn = VerboseFocusOn;
   Flags.TranslateOnly = TranslateOnly;
   Flags.DisableIRGeneration = DisableIRGeneration;
 
   // Force -build-on-read=0 for .ll files.
   const std::string LLSuffix = ".ll";
   if (IRFilename.length() >= LLSuffix.length() &&
       IRFilename.compare(IRFilename.length() - LLSuffix.length(),
                          LLSuffix.length(), LLSuffix) == 0)
     BuildOnRead = false;
 
-  Ice::GlobalContext Ctx(Ls, Os, VMask, TargetArch, OptLevel, TestPrefix,
-                         Flags);
+  // With the ELF writer, use a raw_fd_ostream to allow seeking.
+  // Also don't buffer, otherwise it gets pretty slow.
+  Ice::Ostream *Os;
+  Ice::ELFStreamer *ELFStr = nullptr;
+  std::ofstream Ofs;
+  if (UseELFWriter) {
+    std::string ErrorInfo;
+    raw_fd_ostream *FdOs =
+        new raw_fd_ostream(OutputFilename.c_str(), ErrorInfo);

[Jim Stichnoth, 2014/11/21 21:32:23]

Should we disallow OutputFilename=="-" which is its default value?

The user can specify "./-" if they *really* want that filename. :)

[jvoung (off chromium), 2014/11/24 21:35:47]

Done -- streaming to stdout will have problems because of seeking back, so
disallowing this.

+    if (!ErrorInfo.empty()) {
+      *Ls << "Failed to open output file: " << OutputFilename << ":\n"
+          << ErrorInfo << "\n";
+      return GetReturnValue(1);
+    }
+    ELFStr = new Ice::ELFStreamer(*FdOs);
+    Os = FdOs;
+  } else {
+    if (OutputFilename != "-") {
+      Ofs.open(OutputFilename.c_str(), std::ofstream::out);
+    }
+    Os = new raw_os_ostream(OutputFilename == "-" ? std::cout : Ofs);

[Jim Stichnoth, 2014/11/21 21:32:23]

I know this was just copy/paste, but can we structure this with a single
comparison on OutputFilename=="-" in the !UseElfWriter branch, for clarity?

[jvoung (off chromium), 2014/11/24 21:35:46]

Done. Did something similar for the Ls stream.

+    Os->SetUnbuffered();
+  }
+
+  Ice::GlobalContext Ctx(Ls, Os, ELFStr, VMask, TargetArch, OptLevel,
+                         TestPrefix, Flags);
 
   Ice::TimerMarker T(Ice::TimerStack::TT_szmain, &Ctx);
 
+  if (UseELFWriter) {
+    Ctx.getObjectWriter()->writeInitialELFHeader();
+  }
+
   int ErrorStatus = 0;
   if (BuildOnRead) {
     Ice::PNaClTranslator Translator(&Ctx, Flags);
     Translator.translate(IRFilename);
     ErrorStatus = Translator.getErrorStatus();
   } else if (ALLOW_LLVM_IR) {
     // Parse the input LLVM IR file into a module.
     SMDiagnostic Err;
     Ice::TimerMarker T1(Ice::TimerStack::TT_parse, &Ctx);
     Module *Mod =
         NaClParseIRFile(IRFilename, InputFileFormat, Err, getGlobalContext());
 
     if (!Mod) {
       Err.print(argv[0], errs());
       return GetReturnValue(1);
     }
 
     Ice::Converter Converter(Mod, &Ctx, Flags);
     Converter.convertToIce();
     ErrorStatus = Converter.getErrorStatus();
   } else {
     *Ls << "Error: Build doesn't allow LLVM IR, "
         << "--build-on-read=0 not allowed\n";
     return GetReturnValue(1);
   }
+  if (UseELFWriter) {
+    Ctx.getObjectWriter()->writeNonUserSections();
+  }
   if (SubzeroTimingEnabled)
     Ctx.dumpTimers();
   if (TimeEachFunction) {
     const bool DumpCumulative = false;
     Ctx.dumpTimers(Ice::GlobalContext::TSK_Funcs, DumpCumulative);
   }
   const bool FinalStats = true;
   Ctx.dumpStats("_FINAL_", FinalStats);
+  Os->flush();

[Jim Stichnoth, 2014/11/21 21:32:23]

Is it enough to just flush Os?  Should it be closed and/or deleted?

[jvoung (off chromium), 2014/11/24 21:35:46]

Switch Os and Ls to a unique_ptr, so it gets deleted and its dtor is run (which
for raw_fd_ostream/raw_os_ostream will flush).

   return GetReturnValue(ErrorStatus);
 }