Refactor Subzero initialization and add a browser callback handler.

src/IceCompiler.cpp

-//===- subzero/src/main.cpp - Driver for bitcode translation --------------===//
+//===- subzero/src/IceCompiler.cpp - Driver for bitcode translation -------===//
 //
 //                        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 for translating PNaCl bitcode into native code.
 // It can either directly parse the binary bitcode file, or use LLVM routines to
 // parse a textual bitcode file into LLVM IR and then convert LLVM IR into ICE.
 // In either case, the high-level ICE is then compiled down to native code, as
 // either an ELF object file or a textual asm file.
 //
 //===----------------------------------------------------------------------===//
 
+#include "IceCompiler.h"
+
 #include <fstream>
 #include <iostream>
 
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IRReader/IRReader.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/raw_os_ostream.h"
 #include "llvm/Support/SourceMgr.h"
 #include "llvm/Support/StreamingMemoryObject.h"
 
 #include "IceCfg.h"
 #include "IceClFlags.h"
+#include "IceCompileServer.h"
 #include "IceConverter.h"
 #include "IceELFObjectWriter.h"
 #include "IceELFStreamer.h"
 #include "PNaClTranslator.h"
 
 using namespace llvm;
 
 static cl::list<Ice::VerboseItem> VerboseList(
     "verbose", cl::CommaSeparated,
     cl::desc("Verbose options (can be comma-separated):"),
     cl::values(
         clEnumValN(Ice::IceV_Instructions, "inst", "Print basic instructions"),
         clEnumValN(Ice::IceV_Deleted, "del", "Include deleted instructions"),
         clEnumValN(Ice::IceV_InstNumbers, "instnum",
                    "Print instruction numbers"),
         clEnumValN(Ice::IceV_Preds, "pred", "Show predecessors"),
         clEnumValN(Ice::IceV_Succs, "succ", "Show successors"),
         clEnumValN(Ice::IceV_Liveness, "live", "Liveness information"),
         clEnumValN(Ice::IceV_RegOrigins, "orig", "Physical register origins"),
         clEnumValN(Ice::IceV_LinearScan, "regalloc", "Linear scan details"),
         clEnumValN(Ice::IceV_Frame, "frame", "Stack frame layout details"),
         clEnumValN(Ice::IceV_AddrOpt, "addropt", "Address mode optimization"),
         clEnumValN(Ice::IceV_Random, "random", "Randomization details"),
         clEnumValN(Ice::IceV_All, "all", "Use all verbose options"),
         clEnumValN(Ice::IceV_Most, "most",
                    "Use all verbose options except 'regalloc' and 'time'"),
         clEnumValN(Ice::IceV_None, "none", "No verbosity"), clEnumValEnd));
-static cl::opt<Ice::TargetArch> TargetArch(
-    "target", cl::desc("Target architecture:"), cl::init(Ice::Target_X8632),
-    cl::values(
-        clEnumValN(Ice::Target_X8632, "x8632", "x86-32"),
-        clEnumValN(Ice::Target_X8632, "x86-32", "x86-32 (same as x8632)"),
-        clEnumValN(Ice::Target_X8632, "x86_32", "x86-32 (same as x8632)"),
-        clEnumValN(Ice::Target_X8664, "x8664", "x86-64"),
-        clEnumValN(Ice::Target_X8664, "x86-64", "x86-64 (same as x8664)"),
-        clEnumValN(Ice::Target_X8664, "x86_64", "x86-64 (same as x8664)"),
-        clEnumValN(Ice::Target_ARM32, "arm", "arm32"),
-        clEnumValN(Ice::Target_ARM32, "arm32", "arm32 (same as arm)"),
-        clEnumValN(Ice::Target_ARM64, "arm64", "arm64"), clEnumValEnd));
+static cl::opt<Ice::TargetArch>
+    TArch("target", cl::desc("Target architecture:"),
+          cl::init(Ice::Target_X8632),
+          cl::values(
+              clEnumValN(Ice::Target_X8632, "x8632", "x86-32"),
+              clEnumValN(Ice::Target_X8632, "x86-32", "x86-32 (same as x8632)"),
+              clEnumValN(Ice::Target_X8632, "x86_32", "x86-32 (same as x8632)"),
+              clEnumValN(Ice::Target_X8664, "x8664", "x86-64"),
+              clEnumValN(Ice::Target_X8664, "x86-64", "x86-64 (same as x8664)"),
+              clEnumValN(Ice::Target_X8664, "x86_64", "x86-64 (same as x8664)"),
+              clEnumValN(Ice::Target_ARM32, "arm", "arm32"),
+              clEnumValN(Ice::Target_ARM32, "arm32", "arm32 (same as arm)"),
+              clEnumValN(Ice::Target_ARM64, "arm64", "arm64"), clEnumValEnd));
 static cl::opt<bool> UseSandboxing("sandbox", cl::desc("Use sandboxing"));
 static cl::opt<bool>
     FunctionSections("ffunction-sections",
                      cl::desc("Emit functions into separate sections"));
 static cl::opt<bool>
     DataSections("fdata-sections",
                  cl::desc("Emit (global) data into separate sections"));
 static cl::opt<Ice::OptLevel>
-    OptLevel(cl::desc("Optimization level"), cl::init(Ice::Opt_m1),
-             cl::value_desc("level"),
-             cl::values(clEnumValN(Ice::Opt_m1, "Om1", "-1"),
-                        clEnumValN(Ice::Opt_m1, "O-1", "-1"),
-                        clEnumValN(Ice::Opt_0, "O0", "0"),
-                        clEnumValN(Ice::Opt_1, "O1", "1"),
-                        clEnumValN(Ice::Opt_2, "O2", "2"), clEnumValEnd));
+    OLevel(cl::desc("Optimization level"), cl::init(Ice::Opt_m1),
+           cl::value_desc("level"),
+           cl::values(clEnumValN(Ice::Opt_m1, "Om1", "-1"),
+                      clEnumValN(Ice::Opt_m1, "O-1", "-1"),
+                      clEnumValN(Ice::Opt_0, "O0", "0"),
+                      clEnumValN(Ice::Opt_1, "O1", "1"),
+                      clEnumValN(Ice::Opt_2, "O2", "2"), clEnumValEnd));
 static cl::opt<std::string> IRFilename(cl::Positional, cl::desc("<IR file>"),
                                        cl::init("-"));
 static cl::opt<std::string> OutputFilename("o",
                                            cl::desc("Override output filename"),
                                            cl::init("-"),
                                            cl::value_desc("filename"));
 static cl::opt<std::string> LogFilename("log", cl::desc("Set log filename"),
                                         cl::init("-"),
                                         cl::value_desc("filename"));
 static cl::opt<std::string>
@@ skipping 134 matching lines @@
                                   {"llvm_cl", ALLOW_LLVM_CL},
                                   {"llvm_ir", ALLOW_LLVM_IR},
                                   {"llvm_ir_as_input", ALLOW_LLVM_IR_AS_INPUT},
                                   {"minimal_build", ALLOW_MINIMAL_BUILD}};
 
 // Validates values of build attributes. Prints them to Stream if
 // Stream is non-null.
 static void ValidateAndGenerateBuildAttributes(Ice::Ostream *Stream) {
 
   if (Stream)
-    *Stream << TargetArch << "\n";
+    *Stream << TArch << "\n";
 
   for (size_t i = 0; i < array_lengthof(ConditionalBuildAttributes); ++i) {
     switch (ConditionalBuildAttributes[i].FlagValue) {
     case 0:
       if (Stream)
         *Stream << "no_" << ConditionalBuildAttributes[i].FlagName << "\n";
       break;
     case 1:
       if (Stream)
         *Stream << "allow_" << ConditionalBuildAttributes[i].FlagName << "\n";
       break;
     default: {
       std::string Buffer;
       raw_string_ostream StrBuf(Buffer);
       StrBuf << "Flag " << ConditionalBuildAttributes[i].FlagName
              << " must be defined as 0/1. Found: "
              << ConditionalBuildAttributes[i].FlagValue;
       report_fatal_error(StrBuf.str());
     }
     }
   }
 }
 
-int main(int argc, char **argv) {
+void Ice::Compiler::run(int argc, char **argv, Ice::CompileServer &Server) {
 
   cl::ParseCommandLineOptions(argc, argv);
 
   if (DisableIRGeneration)
     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 Lfs;
   std::unique_ptr<Ice::Ostream> Ls;
   if (LogFilename != "-") {
     Lfs.open(LogFilename.c_str(), std::ofstream::out);
     Ls.reset(new raw_os_ostream(Lfs));
   } else {
     Ls.reset(new raw_os_ostream(std::cout));
   }
   Ls->SetUnbuffered();
 
   ValidateAndGenerateBuildAttributes(GenerateBuildAtts ? Ls.get() : nullptr);
   if (GenerateBuildAtts)
-    return GetReturnValue(Ice::EC_None);
+    return setReturnValue(GetReturnValue(Ice::EC_None));
 
   if (!ALLOW_DISABLE_IR_GEN && DisableIRGeneration) {
     *Ls << "Error: Build doesn't allow --no-ir-gen when not "
         << "ALLOW_DISABLE_IR_GEN!\n";
-    return GetReturnValue(Ice::EC_Args);
+    return setReturnValue(GetReturnValue(Ice::EC_Args));
   }
 
   Ice::ClFlags Flags;
   Flags.setAllowErrorRecovery(AllowErrorRecovery);
   Flags.setAllowUninitializedGlobals(AllowUninitializedGlobals);
   Flags.setDataSections(DataSections);
   Flags.setDecorateAsm(DecorateAsm);
   Flags.setDefaultFunctionPrefix(DefaultFunctionPrefix);
   Flags.setDefaultGlobalPrefix(DefaultGlobalPrefix);
   Flags.setDisableInternal(DisableInternal);
   Flags.setDisableIRGeneration(DisableIRGeneration);
   Flags.setDisableTranslation(DisableTranslation);
   Flags.setDumpStats(DumpStats);
   Flags.setFunctionSections(FunctionSections);
   Flags.setNumTranslationThreads(NumThreads);
   Flags.setPhiEdgeSplit(EnablePhiEdgeSplit);
   Flags.setStubConstantCalls(StubConstantCalls);
   Flags.setSubzeroTimingEnabled(SubzeroTimingEnabled);
   Flags.setTimeEachFunction(TimeEachFunction);
   Flags.setTimingFocusOn(TimingFocusOn);
   Flags.setTranslateOnly(TranslateOnly);
   Flags.setUseSandboxing(UseSandboxing);
   Flags.setVerboseFocusOn(VerboseFocusOn);
   Flags.setOutFileType(OutFileType);
 
   // Force -build-on-read=0 for .ll files.
   const std::string LLSuffix = ".ll";
-  if (IRFilename.length() >= LLSuffix.length() &&
+  if (ALLOW_LLVM_IR_AS_INPUT && IRFilename.length() >= LLSuffix.length() &&
       IRFilename.compare(IRFilename.length() - LLSuffix.length(),
                          LLSuffix.length(), LLSuffix) == 0)
     BuildOnRead = false;
 
-  // With the ELF writer, use a raw_fd_ostream to allow seeking.
-  // Also don't buffer, otherwise it gets pretty slow.
   std::unique_ptr<Ice::Ostream> Os;
   std::unique_ptr<Ice::ELFStreamer> ELFStr;
-  std::ofstream Ofs;
   switch (OutFileType) {
   case Ice::FT_Elf: {
     if (OutputFilename == "-") {
       *Ls << "Error: writing binary ELF to stdout is unsupported\n";
-      return GetReturnValue(Ice::EC_Args);
+      return setReturnValue(GetReturnValue(Ice::EC_Args));
     }
     std::error_code EC;
-    raw_fd_ostream *FdOs =
-        new raw_fd_ostream(OutputFilename, EC, sys::fs::F_None);
-    // NaCl sets st_blksize to 0, and LLVM uses that to pick the
-    // default preferred buffer size. Set to something non-zero.
-    FdOs->SetBufferSize(1 << 14);
-    Os.reset(FdOs);
+    std::unique_ptr<llvm::raw_fd_ostream> FdOs =
+        Server.getOutputStream(OutputFilename, EC);
     if (EC) {
       *Ls << "Failed to open output file: " << OutputFilename << ":\n"
           << EC.message() << "\n";
-      return GetReturnValue(Ice::EC_Args);
+      return setReturnValue(GetReturnValue(Ice::EC_Args));
     }
-    ELFStr.reset(new Ice::ELFStreamer(*FdOs));
+    ELFStr.reset(new Ice::ELFStreamer(*FdOs.get()));
+    Os.reset(FdOs.release());
+    // NaCl sets st_blksize to 0, and LLVM uses that to pick the
+    // default preferred buffer size. Set to something non-zero.
+    Os->SetBufferSize(1 << 14);
   } break;
   case Ice::FT_Asm:
   case Ice::FT_Iasm: {
+    if (PNACL_BROWSER_TRANSLATOR) {
+      *Ls << "Asm/Iasm is not supported under PNACL_BROWSER_TRANSLATOR\n";
+      return setReturnValue(GetReturnValue(Ice::EC_Args));
+    }
+    // Use raw_os_ostream instead of raw_fd_ostream. If both the
+    // LogFilename and OutputFilename are stdout, then having
+    // Os be a raw_fd_ostream while Ls is a raw_os_ostream backed by
+    // a std::ofstream will confuse the buffering and have odd
+    // interleavings (even with explicit flushes, for some reason).
+    // So, make sure both are the same type of stream. In this case,
+    // choose ofstream + raw_os_ostream for both.
+    // This avoids asking the compiler server for the output file,
+    // which won't work in the PNACL_BROWSER_TRANSLATOR case.
+    // An alternative is to choose raw_fd_ostream for both, but then
+    // you have to explicitly tell raw_fd_ostream not to own the
+    // fd since it is shared by the two streams (you'll get a double-close).
+    std::ofstream Ofs;
     if (OutputFilename != "-") {
       Ofs.open(OutputFilename.c_str(), std::ofstream::out);
       Os.reset(new raw_os_ostream(Ofs));
     } else {
       Os.reset(new raw_os_ostream(std::cout));
     }
     Os->SetUnbuffered();
   } break;
   }
 
-  Ice::GlobalContext Ctx(Ls.get(), Os.get(), ELFStr.get(), VMask, TargetArch,
-                         OptLevel, TestPrefix, Flags);
+  Ice::GlobalContext Ctx(Ls.get(), Os.get(), ELFStr.get(), VMask, TArch, OLevel,
+                         TestPrefix, Flags);
 
   Ice::TimerMarker T(Ice::TimerStack::TT_szmain, &Ctx);
 
   if (OutFileType == Ice::FT_Elf) {
     Ice::TimerMarker T1(Ice::TimerStack::TT_emit, &Ctx);
     Ctx.getObjectWriter()->writeInitialELFHeader();
   }
 
   Ctx.startWorkerThreads();
 
   std::unique_ptr<Ice::Translator> Translator;
   if (BuildOnRead) {
     std::unique_ptr<Ice::PNaClTranslator> PTranslator(
         new Ice::PNaClTranslator(&Ctx));
     std::string StrError;
-    std::unique_ptr<DataStreamer> FileStreamer(
-        getDataFileStreamer(IRFilename, &StrError));
+    std::unique_ptr<DataStreamer> FileStreamer =
+        Server.getInputStream(IRFilename, StrError);
     if (!StrError.empty() || !FileStreamer) {
       SMDiagnostic Err(IRFilename, SourceMgr::DK_Error, StrError);
       Err.print(argv[0], errs());
-      return GetReturnValue(Ice::EC_Bitcode);
+      return setReturnValue(GetReturnValue(Ice::EC_Bitcode));
     }
     std::unique_ptr<StreamingMemoryObject> MemObj(
         new StreamingMemoryObjectImpl(FileStreamer.release()));
     PTranslator->translate(IRFilename, std::move(MemObj));
     Translator.reset(PTranslator.release());
   } else if (ALLOW_LLVM_IR) {
+    if (PNACL_BROWSER_TRANSLATOR) {
+      *Ls << "non BuildOnRead is not supported w/ PNACL_BROWSER_TRANSLATOR\n";
+      return setReturnValue(GetReturnValue(Ice::EC_Args));
+    }
     // Parse the input LLVM IR file into a module.
     SMDiagnostic Err;
     Ice::TimerMarker T1(Ice::TimerStack::TT_parse, &Ctx);
     raw_ostream *Verbose = LLVMVerboseErrors ? &errs() : nullptr;
     std::unique_ptr<Module> Mod = NaClParseIRFile(
         IRFilename, InputFileFormat, Err, Verbose, getGlobalContext());
     if (!Mod) {
       Err.print(argv[0], errs());
-      return GetReturnValue(Ice::EC_Bitcode);
+      return setReturnValue(GetReturnValue(Ice::EC_Bitcode));
     }
 
     std::unique_ptr<Ice::Converter> Converter(
         new Ice::Converter(Mod.get(), &Ctx));
     Converter->convertToIce();
     Translator.reset(Converter.release());
   } else {
     *Ls << "Error: Build doesn't allow LLVM IR, "
         << "--build-on-read=0 not allowed\n";
-    return GetReturnValue(Ice::EC_Args);
+    return setReturnValue(GetReturnValue(Ice::EC_Args));
   }
 
   Ctx.waitForWorkerThreads();
   Translator->transferErrorCode();
   Translator->emitConstants();
 
   if (OutFileType == Ice::FT_Elf) {
     Ice::TimerMarker T1(Ice::TimerStack::TT_emit, &Ctx);
     Ctx.getObjectWriter()->setUndefinedSyms(Ctx.getConstantExternSyms());
     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);
-  return GetReturnValue(Ctx.getErrorStatus()->value());
+  return setReturnValue(GetReturnValue(Ctx.getErrorStatus()->value()));
 }