/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h

Bug Summary

File:	include/llvm/Support/Error.h
Warning:	line 201, column 5 Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name lli.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-8/lib/clang/8.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/lli -I /build/llvm-toolchain-snapshot-8~svn345461/tools/lli -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn345461/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/8.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-8/lib/clang/8.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/lli -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-10-27-211344-32123-1 -x c++ /build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp -faddrsig

/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp

→

1//===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This utility provides a simple wrapper around the LLVM Execution Engines,
11// which allow the direct execution of LLVM programs through a Just-In-Time
12// compiler, or through an interpreter if no JIT is available for this platform.
13//
14//===----------------------------------------------------------------------===//

16#include "RemoteJITUtils.h"
17#include "llvm/ADT/StringExtras.h"
18#include "llvm/ADT/Triple.h"
19#include "llvm/Bitcode/BitcodeReader.h"
20#include "llvm/CodeGen/CommandFlags.inc"
21#include "llvm/CodeGen/LinkAllCodegenComponents.h"
22#include "llvm/Config/llvm-config.h"
23#include "llvm/ExecutionEngine/GenericValue.h"
24#include "llvm/ExecutionEngine/Interpreter.h"
25#include "llvm/ExecutionEngine/JITEventListener.h"
26#include "llvm/ExecutionEngine/MCJIT.h"
27#include "llvm/ExecutionEngine/ObjectCache.h"
28#include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
29#include "llvm/ExecutionEngine/Orc/JITTargetMachineBuilder.h"
30#include "llvm/ExecutionEngine/Orc/LLJIT.h"
31#include "llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
32#include "llvm/ExecutionEngine/OrcMCJITReplacement.h"
33#include "llvm/ExecutionEngine/SectionMemoryManager.h"
34#include "llvm/IR/IRBuilder.h"
35#include "llvm/IR/LLVMContext.h"
36#include "llvm/IR/Module.h"
37#include "llvm/IR/Type.h"
38#include "llvm/IR/TypeBuilder.h"
39#include "llvm/IR/Verifier.h"
40#include "llvm/IRReader/IRReader.h"
41#include "llvm/Object/Archive.h"
42#include "llvm/Object/ObjectFile.h"
43#include "llvm/Support/CommandLine.h"
44#include "llvm/Support/Debug.h"
45#include "llvm/Support/DynamicLibrary.h"
46#include "llvm/Support/Format.h"
47#include "llvm/Support/InitLLVM.h"
48#include "llvm/Support/ManagedStatic.h"
49#include "llvm/Support/MathExtras.h"
50#include "llvm/Support/Memory.h"
51#include "llvm/Support/MemoryBuffer.h"
52#include "llvm/Support/Path.h"
53#include "llvm/Support/PluginLoader.h"
54#include "llvm/Support/Process.h"
55#include "llvm/Support/Program.h"
56#include "llvm/Support/SourceMgr.h"
57#include "llvm/Support/TargetSelect.h"
58#include "llvm/Support/WithColor.h"
59#include "llvm/Support/raw_ostream.h"
60#include "llvm/Transforms/Instrumentation.h"
61#include <cerrno>

63#ifdef __CYGWIN__
64#include <cygwin/version.h>
65#if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
66#define DO_NOTHING_ATEXIT 1
67#endif
68#endif

70using namespace llvm;

72#define DEBUG_TYPE"lli" "lli"

74namespace {

enum class JITKind { MCJIT, OrcMCJITReplacement, OrcLazy };

cl::opt<std::string>
InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));

cl::list<std::string>
InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));

cl::opt<bool> ForceInterpreter("force-interpreter",
                               cl::desc("Force interpretation: disable JIT"),
                               cl::init(false));

cl::opt<JITKind> UseJITKind("jit-kind",
                            cl::desc("Choose underlying JIT kind."),
                            cl::init(JITKind::MCJIT),
                            cl::values(
                              clEnumValN(JITKind::MCJIT, "mcjit",llvm::cl::OptionEnumValue { "mcjit", int(JITKind::MCJIT), "MCJIT"
 }
                                         "MCJIT")llvm::cl::OptionEnumValue { "mcjit", int(JITKind::MCJIT), "MCJIT"
 },
                              clEnumValN(JITKind::OrcMCJITReplacement,llvm::cl::OptionEnumValue { "orc-mcjit", int(JITKind::OrcMCJITReplacement
), "Orc-based MCJIT replacement" }
                                         "orc-mcjit",llvm::cl::OptionEnumValue { "orc-mcjit", int(JITKind::OrcMCJITReplacement
), "Orc-based MCJIT replacement" }
                                         "Orc-based MCJIT replacement")llvm::cl::OptionEnumValue { "orc-mcjit", int(JITKind::OrcMCJITReplacement
), "Orc-based MCJIT replacement" },
                              clEnumValN(JITKind::OrcLazy,llvm::cl::OptionEnumValue { "orc-lazy", int(JITKind::OrcLazy)
, "Orc-based lazy JIT." }
                                         "orc-lazy",llvm::cl::OptionEnumValue { "orc-lazy", int(JITKind::OrcLazy)
, "Orc-based lazy JIT." }
                                         "Orc-based lazy JIT.")llvm::cl::OptionEnumValue { "orc-lazy", int(JITKind::OrcLazy)
, "Orc-based lazy JIT." }));

cl::opt<unsigned>
LazyJITCompileThreads("compile-threads",
                      cl::desc("Choose the number of compile threads "
                               "(jit-kind=orc-lazy only)"),
                      cl::init(0));

cl::list<std::string>
ThreadEntryPoints("thread-entry",
                  cl::desc("calls the given entry-point on a new thread "
                           "(jit-kind=orc-lazy only)"));

cl::opt<bool> PerModuleLazy(
    "per-module-lazy",
    cl::desc("Performs lazy compilation on whole module boundaries "
             "rather than individual functions"),
    cl::init(false));

cl::list<std::string>
    JITDylibs("jd",
              cl::desc("Specifies the JITDylib to be used for any subsequent "
                       "-extra-module arguments."));

// The MCJIT supports building for a target address space separate from
// the JIT compilation process. Use a forked process and a copying
// memory manager with IPC to execute using this functionality.
cl::opt<bool> RemoteMCJIT("remote-mcjit",
  cl::desc("Execute MCJIT'ed code in a separate process."),
  cl::init(false));

// Manually specify the child process for remote execution. This overrides
// the simulated remote execution that allocates address space for child
// execution. The child process will be executed and will communicate with
// lli via stdin/stdout pipes.
cl::opt<std::string>
ChildExecPath("mcjit-remote-process",
              cl::desc("Specify the filename of the process to launch "
                       "for remote MCJIT execution.  If none is specified,"
                       "\n\tremote execution will be simulated in-process."),
              cl::value_desc("filename"), cl::init(""));

// Determine optimization level.
cl::opt<char>
OptLevel("O",
         cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
                  "(default = '-O2')"),
         cl::Prefix,
         cl::ZeroOrMore,
         cl::init(' '));

cl::opt<std::string>
TargetTriple("mtriple", cl::desc("Override target triple for module"));

cl::opt<std::string>
EntryFunc("entry-function",
          cl::desc("Specify the entry function (default = 'main') "
                   "of the executable"),
          cl::value_desc("function"),
          cl::init("main"));

cl::list<std::string>
ExtraModules("extra-module",
       cl::desc("Extra modules to be loaded"),
       cl::value_desc("input bitcode"));

cl::list<std::string>
ExtraObjects("extra-object",
       cl::desc("Extra object files to be loaded"),
       cl::value_desc("input object"));

cl::list<std::string>
ExtraArchives("extra-archive",
       cl::desc("Extra archive files to be loaded"),
       cl::value_desc("input archive"));

cl::opt<bool>
EnableCacheManager("enable-cache-manager",
      cl::desc("Use cache manager to save/load mdoules"),
      cl::init(false));

cl::opt<std::string>
ObjectCacheDir("object-cache-dir",
                cl::desc("Directory to store cached object files "
                         "(must be user writable)"),
                cl::init(""));

cl::opt<std::string>
FakeArgv0("fake-argv0",
          cl::desc("Override the 'argv[0]' value passed into the executing"
                   " program"), cl::value_desc("executable"));

cl::opt<bool>
DisableCoreFiles("disable-core-files", cl::Hidden,
                 cl::desc("Disable emission of core files if possible"));

cl::opt<bool>
NoLazyCompilation("disable-lazy-compilation",
                cl::desc("Disable JIT lazy compilation"),
                cl::init(false));

cl::opt<bool>
GenerateSoftFloatCalls("soft-float",
  cl::desc("Generate software floating point library calls"),
  cl::init(false));

enum class DumpKind {
  NoDump,
  DumpFuncsToStdOut,
  DumpModsToStdOut,
  DumpModsToDisk
};

cl::opt<DumpKind> OrcDumpKind(
    "orc-lazy-debug", cl::desc("Debug dumping for the orc-lazy JIT."),
    cl::init(DumpKind::NoDump),
    cl::values(clEnumValN(DumpKind::NoDump, "no-dump",llvm::cl::OptionEnumValue { "no-dump", int(DumpKind::NoDump),
 "Don't dump anything." }
                          "Don't dump anything.")llvm::cl::OptionEnumValue { "no-dump", int(DumpKind::NoDump),
 "Don't dump anything." },
               clEnumValN(DumpKind::DumpFuncsToStdOut, "funcs-to-stdout",llvm::cl::OptionEnumValue { "funcs-to-stdout", int(DumpKind::
DumpFuncsToStdOut), "Dump function names to stdout." }
                          "Dump function names to stdout.")llvm::cl::OptionEnumValue { "funcs-to-stdout", int(DumpKind::
DumpFuncsToStdOut), "Dump function names to stdout." },
               clEnumValN(DumpKind::DumpModsToStdOut, "mods-to-stdout",llvm::cl::OptionEnumValue { "mods-to-stdout", int(DumpKind::DumpModsToStdOut
), "Dump modules to stdout." }
                          "Dump modules to stdout.")llvm::cl::OptionEnumValue { "mods-to-stdout", int(DumpKind::DumpModsToStdOut
), "Dump modules to stdout." },
               clEnumValN(DumpKind::DumpModsToDisk, "mods-to-disk",llvm::cl::OptionEnumValue { "mods-to-disk", int(DumpKind::DumpModsToDisk
), "Dump modules to the current " "working directory. (WARNING: "
 "will overwrite existing files)." }
                          "Dump modules to the current "llvm::cl::OptionEnumValue { "mods-to-disk", int(DumpKind::DumpModsToDisk
), "Dump modules to the current " "working directory. (WARNING: "
 "will overwrite existing files)." }
                          "working directory. (WARNING: "llvm::cl::OptionEnumValue { "mods-to-disk", int(DumpKind::DumpModsToDisk
), "Dump modules to the current " "working directory. (WARNING: "
 "will overwrite existing files)." }
                          "will overwrite existing files).")llvm::cl::OptionEnumValue { "mods-to-disk", int(DumpKind::DumpModsToDisk
), "Dump modules to the current " "working directory. (WARNING: "
 "will overwrite existing files)." }),
    cl::Hidden);

ExitOnError ExitOnErr;
228}

230//===----------------------------------------------------------------------===//
231// Object cache
232//
233// This object cache implementation writes cached objects to disk to the
234// directory specified by CacheDir, using a filename provided in the module
235// descriptor. The cache tries to load a saved object using that path if the
236// file exists. CacheDir defaults to "", in which case objects are cached
237// alongside their originating bitcodes.
238//
239class LLIObjectCache : public ObjectCache {
240public:
LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
  // Add trailing '/' to cache dir if necessary.
  if (!this->CacheDir.empty() &&
      this->CacheDir[this->CacheDir.size() - 1] != '/')
    this->CacheDir += '/';
}
~LLIObjectCache() override {}

void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override {
  const std::string &ModuleID = M->getModuleIdentifier();
  std::string CacheName;
  if (!getCacheFilename(ModuleID, CacheName))
    return;
  if (!CacheDir.empty()) { // Create user-defined cache dir.
    SmallString<128> dir(sys::path::parent_path(CacheName));
    sys::fs::create_directories(Twine(dir));
  }
  std::error_code EC;
  raw_fd_ostream outfile(CacheName, EC, sys::fs::F_None);
  outfile.write(Obj.getBufferStart(), Obj.getBufferSize());
  outfile.close();
}

std::unique_ptr<MemoryBuffer> getObject(const Module* M) override {
  const std::string &ModuleID = M->getModuleIdentifier();
  std::string CacheName;
  if (!getCacheFilename(ModuleID, CacheName))
    return nullptr;
  // Load the object from the cache filename
  ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer =
      MemoryBuffer::getFile(CacheName, -1, false);
  // If the file isn't there, that's OK.
  if (!IRObjectBuffer)
    return nullptr;
  // MCJIT will want to write into this buffer, and we don't want that
  // because the file has probably just been mmapped.  Instead we make
  // a copy.  The filed-based buffer will be released when it goes
  // out of scope.
  return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer());
}

282private:
std::string CacheDir;

bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
  std::string Prefix("file:");
  size_t PrefixLength = Prefix.length();
  if (ModID.substr(0, PrefixLength) != Prefix)
    return false;
      std::string CacheSubdir = ModID.substr(PrefixLength);
291#if defined(_WIN32)
      // Transform "X:\foo" => "/X\foo" for convenience.
      if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
        CacheSubdir[1] = CacheSubdir[0];
        CacheSubdir[0] = '/';
      }
297#endif
  CacheName = CacheDir + CacheSubdir;
  size_t pos = CacheName.rfind('.');
  CacheName.replace(pos, CacheName.length() - pos, ".o");
  return true;
}
303};

305// On Mingw and Cygwin, an external symbol named '__main' is called from the
306// generated 'main' function to allow static initialization.  To avoid linking
307// problems with remote targets (because lli's remote target support does not
308// currently handle external linking) we add a secondary module which defines
309// an empty '__main' function.
310static void addCygMingExtraModule(ExecutionEngine &EE, LLVMContext &Context,
                                StringRef TargetTripleStr) {
IRBuilder<> Builder(Context);
Triple TargetTriple(TargetTripleStr);

// Create a new module.
std::unique_ptr<Module> M = make_unique<Module>("CygMingHelper", Context);
M->setTargetTriple(TargetTripleStr);

// Create an empty function named "__main".
Function *Result;
if (TargetTriple.isArch64Bit()) {
  Result = Function::Create(
    TypeBuilder<int64_t(void), false>::get(Context),
    GlobalValue::ExternalLinkage, "__main", M.get());
} else {
  Result = Function::Create(
    TypeBuilder<int32_t(void), false>::get(Context),
    GlobalValue::ExternalLinkage, "__main", M.get());
}
BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
Builder.SetInsertPoint(BB);
Value *ReturnVal;
if (TargetTriple.isArch64Bit())
  ReturnVal = ConstantInt::get(Context, APInt(64, 0));
else
  ReturnVal = ConstantInt::get(Context, APInt(32, 0));
Builder.CreateRet(ReturnVal);

// Add this new module to the ExecutionEngine.
EE.addModule(std::move(M));
341}

343CodeGenOpt::Level getOptLevel() {
switch (OptLevel) {
default:
  WithColor::error(errs(), "lli") << "invalid optimization level.\n";
  exit(1);
case '0': return CodeGenOpt::None;
case '1': return CodeGenOpt::Less;
case ' ':
case '2': return CodeGenOpt::Default;
case '3': return CodeGenOpt::Aggressive;
}
llvm_unreachable("Unrecognized opt level.")::llvm::llvm_unreachable_internal("Unrecognized opt level.", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp"
, 354);
355}

357LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
358static void reportError(SMDiagnostic Err, const char *ProgName) {
Err.print(ProgName, errs());
exit(1);
361}

363int runOrcLazyJIT(const char *ProgName);
364void disallowOrcOptions();

366//===----------------------------------------------------------------------===//
367// main Driver function
368//
369int main(int argc, char **argv, char * const *envp) {
InitLLVM X(argc, argv);

if (argc > 1)
  ExitOnErr.setBanner(std::string(argv[0]) + ": ");

// If we have a native target, initialize it to ensure it is linked in and
// usable by the JIT.
InitializeNativeTarget();
InitializeNativeTargetAsmPrinter();
InitializeNativeTargetAsmParser();

cl::ParseCommandLineOptions(argc, argv,
                            "llvm interpreter & dynamic compiler\n");

// If the user doesn't want core files, disable them.
if (DisableCoreFiles)
  sys::Process::PreventCoreFiles();

if (UseJITKind == JITKind::OrcLazy)
  return runOrcLazyJIT(argv[0]);
else
  disallowOrcOptions();

LLVMContext Context;

// Load the bitcode...
SMDiagnostic Err;
std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context);
Module *Mod = Owner.get();
if (!Mod)
  reportError(Err, argv[0]);

if (EnableCacheManager) {
  std::string CacheName("file:");
  CacheName.append(InputFile);
  Mod->setModuleIdentifier(CacheName);
}

// If not jitting lazily, load the whole bitcode file eagerly too.
if (NoLazyCompilation) {
  // Use *argv instead of argv[0] to work around a wrong GCC warning.
  ExitOnError ExitOnErr(std::string(*argv) +
                        ": bitcode didn't read correctly: ");
  ExitOnErr(Mod->materializeAll());
}

std::string ErrorMsg;
EngineBuilder builder(std::move(Owner));
builder.setMArch(MArch);
builder.setMCPU(getCPUStr());
builder.setMAttrs(getFeatureList());
if (RelocModel.getNumOccurrences())
  builder.setRelocationModel(RelocModel);
if (CMModel.getNumOccurrences())
  builder.setCodeModel(CMModel);
builder.setErrorStr(&ErrorMsg);
builder.setEngineKind(ForceInterpreter
                      ? EngineKind::Interpreter
                      : EngineKind::JIT);
builder.setUseOrcMCJITReplacement(UseJITKind == JITKind::OrcMCJITReplacement);

// If we are supposed to override the target triple, do so now.
if (!TargetTriple.empty())
  Mod->setTargetTriple(Triple::normalize(TargetTriple));

// Enable MCJIT if desired.
RTDyldMemoryManager *RTDyldMM = nullptr;
if (!ForceInterpreter) {
  if (RemoteMCJIT)
    RTDyldMM = new ForwardingMemoryManager();
  else
    RTDyldMM = new SectionMemoryManager();

  // Deliberately construct a temp std::unique_ptr to pass in. Do not null out
  // RTDyldMM: We still use it below, even though we don't own it.
  builder.setMCJITMemoryManager(
    std::unique_ptr<RTDyldMemoryManager>(RTDyldMM));
} else if (RemoteMCJIT) {
  WithColor::error(errs(), argv[0])
      << "remote process execution does not work with the interpreter.\n";
  exit(1);
}

builder.setOptLevel(getOptLevel());

TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
if (FloatABIForCalls != FloatABI::Default)
  Options.FloatABIType = FloatABIForCalls;

builder.setTargetOptions(Options);

std::unique_ptr<ExecutionEngine> EE(builder.create());
if (!EE) {
  if (!ErrorMsg.empty())
    WithColor::error(errs(), argv[0])
        << "error creating EE: " << ErrorMsg << "\n";
  else
    WithColor::error(errs(), argv[0]) << "unknown error creating EE!\n";
  exit(1);
}

std::unique_ptr<LLIObjectCache> CacheManager;
if (EnableCacheManager) {
  CacheManager.reset(new LLIObjectCache(ObjectCacheDir));
  EE->setObjectCache(CacheManager.get());
}

// Load any additional modules specified on the command line.
for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
  std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context);
  if (!XMod)
    reportError(Err, argv[0]);
  if (EnableCacheManager) {
    std::string CacheName("file:");
    CacheName.append(ExtraModules[i]);
    XMod->setModuleIdentifier(CacheName);
  }
  EE->addModule(std::move(XMod));
}

for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) {
  Expected<object::OwningBinary<object::ObjectFile>> Obj =
      object::ObjectFile::createObjectFile(ExtraObjects[i]);
  if (!Obj) {
    // TODO: Actually report errors helpfully.
    consumeError(Obj.takeError());
    reportError(Err, argv[0]);
  }
  object::OwningBinary<object::ObjectFile> &O = Obj.get();
  EE->addObjectFile(std::move(O));
}

for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
  ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr =
      MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]);
  if (!ArBufOrErr)
    reportError(Err, argv[0]);
  std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get();

  Expected<std::unique_ptr<object::Archive>> ArOrErr =
      object::Archive::create(ArBuf->getMemBufferRef());
  if (!ArOrErr) {
    std::string Buf;
    raw_string_ostream OS(Buf);
    logAllUnhandledErrors(ArOrErr.takeError(), OS, "");
    OS.flush();
    errs() << Buf;
    exit(1);
  }
  std::unique_ptr<object::Archive> &Ar = ArOrErr.get();

  object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf));

  EE->addArchive(std::move(OB));
}

// If the target is Cygwin/MingW and we are generating remote code, we
// need an extra module to help out with linking.
if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
  addCygMingExtraModule(*EE, Context, Mod->getTargetTriple());
}

// The following functions have no effect if their respective profiling
// support wasn't enabled in the build configuration.
EE->RegisterJITEventListener(
              JITEventListener::createOProfileJITEventListener());
EE->RegisterJITEventListener(
              JITEventListener::createIntelJITEventListener());
if (!RemoteMCJIT)
  EE->RegisterJITEventListener(
              JITEventListener::createPerfJITEventListener());

if (!NoLazyCompilation && RemoteMCJIT) {
  WithColor::warning(errs(), argv[0])
      << "remote mcjit does not support lazy compilation\n";
  NoLazyCompilation = true;
}
EE->DisableLazyCompilation(NoLazyCompilation);

// If the user specifically requested an argv[0] to pass into the program,
// do it now.
if (!FakeArgv0.empty()) {
  InputFile = static_cast<std::string>(FakeArgv0);
} else {
  // Otherwise, if there is a .bc suffix on the executable strip it off, it
  // might confuse the program.
  if (StringRef(InputFile).endswith(".bc"))
    InputFile.erase(InputFile.length() - 3);
}

// Add the module's name to the start of the vector of arguments to main().
InputArgv.insert(InputArgv.begin(), InputFile);

// Call the main function from M as if its signature were:
//   int main (int argc, char **argv, const char **envp)
// using the contents of Args to determine argc & argv, and the contents of
// EnvVars to determine envp.
//
Function *EntryFn = Mod->getFunction(EntryFunc);
if (!EntryFn) {
  WithColor::error(errs(), argv[0])
      << '\'' << EntryFunc << "\' function not found in module.\n";
  return -1;
}

// Reset errno to zero on entry to main.
errno(*__errno_location ()) = 0;

int Result = -1;

// Sanity check use of remote-jit: LLI currently only supports use of the
// remote JIT on Unix platforms.
if (RemoteMCJIT) {
583#ifndef LLVM_ON_UNIX1
  WithColor::warning(errs(), argv[0])
      << "host does not support external remote targets.\n";
  WithColor::note() << "defaulting to local execution\n";
  return -1;
588#else
  if (ChildExecPath.empty()) {
    WithColor::error(errs(), argv[0])
        << "-remote-mcjit requires -mcjit-remote-process.\n";
    exit(1);
  } else if (!sys::fs::can_execute(ChildExecPath)) {
    WithColor::error(errs(), argv[0])
        << "unable to find usable child executable: '" << ChildExecPath
        << "'\n";
    return -1;
  }
599#endif
}

if (!RemoteMCJIT) {
  // If the program doesn't explicitly call exit, we will need the Exit
  // function later on to make an explicit call, so get the function now.
  Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
                                                    Type::getInt32Ty(Context));

  // Run static constructors.
  if (!ForceInterpreter) {
    // Give MCJIT a chance to apply relocations and set page permissions.
    EE->finalizeObject();
  }
  EE->runStaticConstructorsDestructors(false);

  // Trigger compilation separately so code regions that need to be
  // invalidated will be known.
  (void)EE->getPointerToFunction(EntryFn);
  // Clear instruction cache before code will be executed.
  if (RTDyldMM)
    static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();

  // Run main.
  Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);

  // Run static destructors.
  EE->runStaticConstructorsDestructors(true);

  // If the program didn't call exit explicitly, we should call it now.
  // This ensures that any atexit handlers get called correctly.
  if (Function *ExitF = dyn_cast<Function>(Exit)) {
    std::vector<GenericValue> Args;
    GenericValue ResultGV;
    ResultGV.IntVal = APInt(32, Result);
    Args.push_back(ResultGV);
    EE->runFunction(ExitF, Args);
    WithColor::error(errs(), argv[0]) << "exit(" << Result << ") returned!\n";
    abort();
  } else {
    WithColor::error(errs(), argv[0])
        << "exit defined with wrong prototype!\n";
    abort();
  }
} else {
  // else == "if (RemoteMCJIT)"

  // Remote target MCJIT doesn't (yet) support static constructors. No reason
  // it couldn't. This is a limitation of the LLI implementation, not the
  // MCJIT itself. FIXME.

  // Lanch the remote process and get a channel to it.
  std::unique_ptr<FDRawChannel> C = launchRemote();
  if (!C) {
    WithColor::error(errs(), argv[0]) << "failed to launch remote JIT.\n";
    exit(1);
  }

  // Create a remote target client running over the channel.
  llvm::orc::ExecutionSession ES;
  ES.setErrorReporter([&](Error Err) { ExitOnErr(std::move(Err)); });
  typedef orc::remote::OrcRemoteTargetClient MyRemote;
  auto R = ExitOnErr(MyRemote::Create(*C, ES));

  // Create a remote memory manager.
  auto RemoteMM = ExitOnErr(R->createRemoteMemoryManager());

  // Forward MCJIT's memory manager calls to the remote memory manager.
  static_cast<ForwardingMemoryManager*>(RTDyldMM)->setMemMgr(
    std::move(RemoteMM));

  // Forward MCJIT's symbol resolution calls to the remote.
  static_cast<ForwardingMemoryManager *>(RTDyldMM)->setResolver(
      orc::createLambdaResolver(
          [](const std::string &Name) { return nullptr; },
          [&](const std::string &Name) {
            if (auto Addr = ExitOnErr(R->getSymbolAddress(Name)))
1
Calling 'OrcRemoteTargetClient::getSymbolAddress'→
              return JITSymbol(Addr, JITSymbolFlags::Exported);
            return JITSymbol(nullptr);
          }));

  // Grab the target address of the JIT'd main function on the remote and call
  // it.
  // FIXME: argv and envp handling.
  JITTargetAddress Entry = EE->getFunctionAddress(EntryFn->getName().str());
  EE->finalizeObject();
  LLVM_DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Executing '" << EntryFn->
getName() << "' at 0x" << format("%llx", Entry) <<
 "\n"; } } while (false)
                    << format("%llx", Entry) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Executing '" << EntryFn->
getName() << "' at 0x" << format("%llx", Entry) <<
 "\n"; } } while (false);
  Result = ExitOnErr(R->callIntVoid(Entry));

  // Like static constructors, the remote target MCJIT support doesn't handle
  // this yet. It could. FIXME.

  // Delete the EE - we need to tear it down *before* we terminate the session
  // with the remote, otherwise it'll crash when it tries to release resources
  // on a remote that has already been disconnected.
  EE.reset();

  // Signal the remote target that we're done JITing.
  ExitOnErr(R->terminateSession());
}

return Result;
702}

704static orc::IRTransformLayer::TransformFunction createDebugDumper() {
switch (OrcDumpKind) {
case DumpKind::NoDump:
  return [](orc::ThreadSafeModule TSM,
            const orc::MaterializationResponsibility &R) { return TSM; };

case DumpKind::DumpFuncsToStdOut:
  return [](orc::ThreadSafeModule TSM,
            const orc::MaterializationResponsibility &R) {
    printf("[ ");

    for (const auto &F : *TSM.getModule()) {
      if (F.isDeclaration())
        continue;

      if (F.hasName()) {
        std::string Name(F.getName());
        printf("%s ", Name.c_str());
      } else
        printf("<anon> ");
    }

    printf("]\n");
    return TSM;
  };

case DumpKind::DumpModsToStdOut:
  return [](orc::ThreadSafeModule TSM,
            const orc::MaterializationResponsibility &R) {
    outs() << "----- Module Start -----\n"
           << *TSM.getModule() << "----- Module End -----\n";

    return TSM;
  };

case DumpKind::DumpModsToDisk:
  return [](orc::ThreadSafeModule TSM,
            const orc::MaterializationResponsibility &R) {
    std::error_code EC;
    raw_fd_ostream Out(TSM.getModule()->getModuleIdentifier() + ".ll", EC,
                       sys::fs::F_Text);
    if (EC) {
      errs() << "Couldn't open " << TSM.getModule()->getModuleIdentifier()
             << " for dumping.\nError:" << EC.message() << "\n";
      exit(1);
    }
    Out << *TSM.getModule();
    return TSM;
  };
}
llvm_unreachable("Unknown DumpKind")::llvm::llvm_unreachable_internal("Unknown DumpKind", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp"
, 754);
755}

757static void exitOnLazyCallThroughFailure() { exit(1); }

759int runOrcLazyJIT(const char *ProgName) {
// Start setting up the JIT environment.

// Parse the main module.
orc::ThreadSafeContext TSCtx(llvm::make_unique<LLVMContext>());
SMDiagnostic Err;
auto MainModule = orc::ThreadSafeModule(
    parseIRFile(InputFile, Err, *TSCtx.getContext()), TSCtx);
if (!MainModule)
  reportError(Err, ProgName);

const auto &TT = MainModule.getModule()->getTargetTriple();
orc::JITTargetMachineBuilder JTMB =
    TT.empty() ? ExitOnErr(orc::JITTargetMachineBuilder::detectHost())
               : orc::JITTargetMachineBuilder(Triple(TT));

if (!MArch.empty())
  JTMB.getTargetTriple().setArchName(MArch);

JTMB.setCPU(getCPUStr())
    .addFeatures(getFeatureList())
    .setRelocationModel(RelocModel.getNumOccurrences()
                            ? Optional<Reloc::Model>(RelocModel)
                            : None)
    .setCodeModel(CMModel.getNumOccurrences()
                      ? Optional<CodeModel::Model>(CMModel)
                      : None);

DataLayout DL = ExitOnErr(JTMB.getDefaultDataLayoutForTarget());

auto J = ExitOnErr(orc::LLLazyJIT::Create(
    std::move(JTMB), DL,
    pointerToJITTargetAddress(exitOnLazyCallThroughFailure),
    LazyJITCompileThreads));

if (PerModuleLazy)
  J->setPartitionFunction(orc::CompileOnDemandLayer::compileWholeModule);

auto Dump = createDebugDumper();

J->setLazyCompileTransform([&](orc::ThreadSafeModule TSM,
                               const orc::MaterializationResponsibility &R) {
  if (verifyModule(*TSM.getModule(), &dbgs())) {
    dbgs() << "Bad module: " << *TSM.getModule() << "\n";
    exit(1);
  }
  return Dump(std::move(TSM), R);
});
J->getMainJITDylib().setGenerator(
    ExitOnErr(orc::DynamicLibrarySearchGenerator::GetForCurrentProcess(DL)));

orc::MangleAndInterner Mangle(J->getExecutionSession(), DL);
orc::LocalCXXRuntimeOverrides CXXRuntimeOverrides;
ExitOnErr(CXXRuntimeOverrides.enable(J->getMainJITDylib(), Mangle));

// Add the main module.
ExitOnErr(J->addLazyIRModule(std::move(MainModule)));

// Create JITDylibs and add any extra modules.
{
  // Create JITDylibs, keep a map from argument index to dylib. We will use
  // -extra-module argument indexes to determine what dylib to use for each
  // -extra-module.
  std::map<unsigned, orc::JITDylib *> IdxToDylib;
  IdxToDylib[0] = &J->getMainJITDylib();
  for (auto JDItr = JITDylibs.begin(), JDEnd = JITDylibs.end();
       JDItr != JDEnd; ++JDItr) {
    IdxToDylib[JITDylibs.getPosition(JDItr - JITDylibs.begin())] =
        &J->createJITDylib(*JDItr);
  }

  for (auto EMItr = ExtraModules.begin(), EMEnd = ExtraModules.end();
       EMItr != EMEnd; ++EMItr) {
    auto M = parseIRFile(*EMItr, Err, *TSCtx.getContext());
    if (!M)
      reportError(Err, ProgName);

    auto EMIdx = ExtraModules.getPosition(EMItr - ExtraModules.begin());
    assert(EMIdx != 0 && "ExtraModule should have index > 0")((EMIdx != 0 && "ExtraModule should have index > 0"
) ? static_cast<void> (0) : __assert_fail ("EMIdx != 0 && \"ExtraModule should have index > 0\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp"
, 837, __PRETTY_FUNCTION__));
    auto JDItr = std::prev(IdxToDylib.lower_bound(EMIdx));
    auto &JD = *JDItr->second;
    ExitOnErr(
        J->addLazyIRModule(JD, orc::ThreadSafeModule(std::move(M), TSCtx)));
  }
}

// Add the objects.
for (auto &ObjPath : ExtraObjects) {
  auto Obj = ExitOnErr(errorOrToExpected(MemoryBuffer::getFile(ObjPath)));
  ExitOnErr(J->addObjectFile(std::move(Obj)));
}

// Generate a argument string.
std::vector<std::string> Args;
Args.push_back(InputFile);
for (auto &Arg : InputArgv)
  Args.push_back(Arg);

// Run any static constructors.
ExitOnErr(J->runConstructors());

// Run any -thread-entry points.
std::vector<std::thread> AltEntryThreads;
for (auto &ThreadEntryPoint : ThreadEntryPoints) {
  auto EntryPointSym = ExitOnErr(J->lookup(ThreadEntryPoint));
  typedef void (*EntryPointPtr)();
  auto EntryPoint =
    reinterpret_cast<EntryPointPtr>(static_cast<uintptr_t>(EntryPointSym.getAddress()));
  AltEntryThreads.push_back(std::thread([EntryPoint]() { EntryPoint(); }));
}

J->getExecutionSession().dump(llvm::dbgs());

// Run main.
auto MainSym = ExitOnErr(J->lookup("main"));
typedef int (*MainFnPtr)(int, const char *[]);
std::vector<const char *> ArgV;
for (auto &Arg : Args)
  ArgV.push_back(Arg.c_str());
ArgV.push_back(nullptr);

int ArgC = ArgV.size() - 1;
auto Main =
    reinterpret_cast<MainFnPtr>(static_cast<uintptr_t>(MainSym.getAddress()));
auto Result = Main(ArgC, (const char **)ArgV.data());

// Wait for -entry-point threads.
for (auto &AltEntryThread : AltEntryThreads)
  AltEntryThread.join();

// Run destructors.
ExitOnErr(J->runDestructors());
CXXRuntimeOverrides.runDestructors();

return Result;
894}

896void disallowOrcOptions() {
// Make sure nobody used an orc-lazy specific option accidentally.

if (LazyJITCompileThreads != 0) {
  errs() << "-compile-threads requires -jit-kind=orc-lazy\n";
  exit(1);
}

if (!ThreadEntryPoints.empty()) {
  errs() << "-thread-entry requires -jit-kind=orc-lazy\n";
  exit(1);
}

if (PerModuleLazy) {
  errs() << "-per-module-lazy requires -jit-kind=orc-lazy\n";
  exit(1);
}
913}

915std::unique_ptr<FDRawChannel> launchRemote() {
916#ifndef LLVM_ON_UNIX1
llvm_unreachable("launchRemote not supported on non-Unix platforms")::llvm::llvm_unreachable_internal("launchRemote not supported on non-Unix platforms"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp"
, 917);
918#else
int PipeFD[2][2];
pid_t ChildPID;

// Create two pipes.
if (pipe(PipeFD[0]) != 0 || pipe(PipeFD[1]) != 0)
  perror("Error creating pipe: ");

ChildPID = fork();

if (ChildPID == 0) {
  // In the child...

  // Close the parent ends of the pipes
  close(PipeFD[0][1]);
  close(PipeFD[1][0]);


  // Execute the child process.
  std::unique_ptr<char[]> ChildPath, ChildIn, ChildOut;
  {
    ChildPath.reset(new char[ChildExecPath.size() + 1]);
    std::copy(ChildExecPath.begin(), ChildExecPath.end(), &ChildPath[0]);
    ChildPath[ChildExecPath.size()] = '\0';
    std::string ChildInStr = utostr(PipeFD[0][0]);
    ChildIn.reset(new char[ChildInStr.size() + 1]);
    std::copy(ChildInStr.begin(), ChildInStr.end(), &ChildIn[0]);
    ChildIn[ChildInStr.size()] = '\0';
    std::string ChildOutStr = utostr(PipeFD[1][1]);
    ChildOut.reset(new char[ChildOutStr.size() + 1]);
    std::copy(ChildOutStr.begin(), ChildOutStr.end(), &ChildOut[0]);
    ChildOut[ChildOutStr.size()] = '\0';
  }

  char * const args[] = { &ChildPath[0], &ChildIn[0], &ChildOut[0], nullptr };
  int rc = execv(ChildExecPath.c_str(), args);
  if (rc != 0)
    perror("Error executing child process: ");
  llvm_unreachable("Error executing child process")::llvm::llvm_unreachable_internal("Error executing child process"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lli/lli.cpp"
, 956);
}
// else we're the parent...

// Close the child ends of the pipes
close(PipeFD[0][0]);
close(PipeFD[1][1]);

// Return an RPC channel connected to our end of the pipes.
return llvm::make_unique<FDRawChannel>(PipeFD[1][0], PipeFD[0][1]);
966#endif
967}

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h

→

1//===- OrcRemoteTargetClient.h - Orc Remote-target Client -------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the OrcRemoteTargetClient class and helpers. This class
11// can be used to communicate over an RawByteChannel with an
12// OrcRemoteTargetServer instance to support remote-JITing.
13//
14//===----------------------------------------------------------------------===//

16#ifndef LLVM_EXECUTIONENGINE_ORC_ORCREMOTETARGETCLIENT_H
17#define LLVM_EXECUTIONENGINE_ORC_ORCREMOTETARGETCLIENT_H

19#include "llvm/ADT/Optional.h"
20#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/StringMap.h"
22#include "llvm/ADT/StringRef.h"
23#include "llvm/ExecutionEngine/JITSymbol.h"
24#include "llvm/ExecutionEngine/Orc/IndirectionUtils.h"
25#include "llvm/ExecutionEngine/Orc/OrcRemoteTargetRPCAPI.h"
26#include "llvm/ExecutionEngine/RuntimeDyld.h"
27#include "llvm/Support/Debug.h"
28#include "llvm/Support/Error.h"
29#include "llvm/Support/ErrorHandling.h"
30#include "llvm/Support/Format.h"
31#include "llvm/Support/MathExtras.h"
32#include "llvm/Support/Memory.h"
33#include "llvm/Support/raw_ostream.h"
34#include <algorithm>
35#include <cassert>
36#include <cstdint>
37#include <memory>
38#include <string>
39#include <tuple>
40#include <utility>
41#include <vector>

43#define DEBUG_TYPE"lli" "orc-remote"

45namespace llvm {
46namespace orc {
47namespace remote {

49/// This class provides utilities (including memory manager, indirect stubs
50/// manager, and compile callback manager types) that support remote JITing
51/// in ORC.
52///
53/// Each of the utility classes talks to a JIT server (an instance of the
54/// OrcRemoteTargetServer class) via an RPC system (see RPCUtils.h) to carry out
55/// its actions.
56class OrcRemoteTargetClient
  : public rpc::SingleThreadedRPCEndpoint<rpc::RawByteChannel> {
58public:
/// Remote-mapped RuntimeDyld-compatible memory manager.
class RemoteRTDyldMemoryManager : public RuntimeDyld::MemoryManager {
  friend class OrcRemoteTargetClient;

public:
  ~RemoteRTDyldMemoryManager() {
    Client.destroyRemoteAllocator(Id);
    LLVM_DEBUG(dbgs() << "Destroyed remote allocator " << Id << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Destroyed remote allocator " <<
 Id << "\n"; } } while (false);
  }

  RemoteRTDyldMemoryManager(const RemoteRTDyldMemoryManager &) = delete;
  RemoteRTDyldMemoryManager &
  operator=(const RemoteRTDyldMemoryManager &) = delete;
  RemoteRTDyldMemoryManager(RemoteRTDyldMemoryManager &&) = default;
  RemoteRTDyldMemoryManager &operator=(RemoteRTDyldMemoryManager &&) = delete;

  uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
                               unsigned SectionID,
                               StringRef SectionName) override {
    Unmapped.back().CodeAllocs.emplace_back(Size, Alignment);
    uint8_t *Alloc = reinterpret_cast<uint8_t *>(
        Unmapped.back().CodeAllocs.back().getLocalAddress());
    LLVM_DEBUG(dbgs() << "Allocator " << Id << " allocated code for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated code for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                      << SectionName << ": " << Alloc << " (" << Sizedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated code for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                      << " bytes, alignment " << Alignment << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated code for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false);
    return Alloc;
  }

  uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
                               unsigned SectionID, StringRef SectionName,
                               bool IsReadOnly) override {
    if (IsReadOnly) {
      Unmapped.back().RODataAllocs.emplace_back(Size, Alignment);
      uint8_t *Alloc = reinterpret_cast<uint8_t *>(
          Unmapped.back().RODataAllocs.back().getLocalAddress());
      LLVM_DEBUG(dbgs() << "Allocator " << Id << " allocated ro-data for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated ro-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                        << SectionName << ": " << Alloc << " (" << Sizedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated ro-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                        << " bytes, alignment " << Alignment << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated ro-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false);
      return Alloc;
    } // else...

    Unmapped.back().RWDataAllocs.emplace_back(Size, Alignment);
    uint8_t *Alloc = reinterpret_cast<uint8_t *>(
        Unmapped.back().RWDataAllocs.back().getLocalAddress());
    LLVM_DEBUG(dbgs() << "Allocator " << Id << " allocated rw-data for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated rw-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                      << SectionName << ": " << Alloc << " (" << Sizedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated rw-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false)
                      << " bytes, alignment " << Alignment << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " allocated rw-data for "
 << SectionName << ": " << Alloc << " ("
 << Size << " bytes, alignment " << Alignment
 << ")\n"; } } while (false);
    return Alloc;
  }

  void reserveAllocationSpace(uintptr_t CodeSize, uint32_t CodeAlign,
                              uintptr_t RODataSize, uint32_t RODataAlign,
                              uintptr_t RWDataSize,
                              uint32_t RWDataAlign) override {
    Unmapped.push_back(ObjectAllocs());

    LLVM_DEBUG(dbgs() << "Allocator " << Id << " reserved:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " reserved:\n"
; } } while (false);

    if (CodeSize != 0) {
      Unmapped.back().RemoteCodeAddr =
          Client.reserveMem(Id, CodeSize, CodeAlign);

      LLVM_DEBUG(dbgs() << "  code: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  code: " << format("0x%016x"
, Unmapped.back().RemoteCodeAddr) << " (" << CodeSize
 << " bytes, alignment " << CodeAlign << ")\n"
; } } while (false)
                        << format("0x%016x", Unmapped.back().RemoteCodeAddr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  code: " << format("0x%016x"
, Unmapped.back().RemoteCodeAddr) << " (" << CodeSize
 << " bytes, alignment " << CodeAlign << ")\n"
; } } while (false)
                        << " (" << CodeSize << " bytes, alignment "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  code: " << format("0x%016x"
, Unmapped.back().RemoteCodeAddr) << " (" << CodeSize
 << " bytes, alignment " << CodeAlign << ")\n"
; } } while (false)
                        << CodeAlign << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  code: " << format("0x%016x"
, Unmapped.back().RemoteCodeAddr) << " (" << CodeSize
 << " bytes, alignment " << CodeAlign << ")\n"
; } } while (false);
    }

    if (RODataSize != 0) {
      Unmapped.back().RemoteRODataAddr =
          Client.reserveMem(Id, RODataSize, RODataAlign);

      LLVM_DEBUG(dbgs() << "  ro-data: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  ro-data: " << format("0x%016x"
, Unmapped.back().RemoteRODataAddr) << " (" << RODataSize
 << " bytes, alignment " << RODataAlign << ")\n"
; } } while (false)
                        << format("0x%016x", Unmapped.back().RemoteRODataAddr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  ro-data: " << format("0x%016x"
, Unmapped.back().RemoteRODataAddr) << " (" << RODataSize
 << " bytes, alignment " << RODataAlign << ")\n"
; } } while (false)
                        << " (" << RODataSize << " bytes, alignment "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  ro-data: " << format("0x%016x"
, Unmapped.back().RemoteRODataAddr) << " (" << RODataSize
 << " bytes, alignment " << RODataAlign << ")\n"
; } } while (false)
                        << RODataAlign << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  ro-data: " << format("0x%016x"
, Unmapped.back().RemoteRODataAddr) << " (" << RODataSize
 << " bytes, alignment " << RODataAlign << ")\n"
; } } while (false);
    }

    if (RWDataSize != 0) {
      Unmapped.back().RemoteRWDataAddr =
          Client.reserveMem(Id, RWDataSize, RWDataAlign);

      LLVM_DEBUG(dbgs() << "  rw-data: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  rw-data: " << format("0x%016x"
, Unmapped.back().RemoteRWDataAddr) << " (" << RWDataSize
 << " bytes, alignment " << RWDataAlign << ")\n"
; } } while (false)
                        << format("0x%016x", Unmapped.back().RemoteRWDataAddr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  rw-data: " << format("0x%016x"
, Unmapped.back().RemoteRWDataAddr) << " (" << RWDataSize
 << " bytes, alignment " << RWDataAlign << ")\n"
; } } while (false)
                        << " (" << RWDataSize << " bytes, alignment "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  rw-data: " << format("0x%016x"
, Unmapped.back().RemoteRWDataAddr) << " (" << RWDataSize
 << " bytes, alignment " << RWDataAlign << ")\n"
; } } while (false)
                        << RWDataAlign << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  rw-data: " << format("0x%016x"
, Unmapped.back().RemoteRWDataAddr) << " (" << RWDataSize
 << " bytes, alignment " << RWDataAlign << ")\n"
; } } while (false);
    }
  }

  bool needsToReserveAllocationSpace() override { return true; }

  void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
                        size_t Size) override {
    UnfinalizedEHFrames.push_back({LoadAddr, Size});
  }

  void deregisterEHFrames() override {
    for (auto &Frame : RegisteredEHFrames) {
      // FIXME: Add error poll.
      Client.deregisterEHFrames(Frame.Addr, Frame.Size);
    }
  }

  void notifyObjectLoaded(RuntimeDyld &Dyld,
                          const object::ObjectFile &Obj) override {
    LLVM_DEBUG(dbgs() << "Allocator " << Id << " applied mappings:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " applied mappings:\n"
; } } while (false);
    for (auto &ObjAllocs : Unmapped) {
      mapAllocsToRemoteAddrs(Dyld, ObjAllocs.CodeAllocs,
                             ObjAllocs.RemoteCodeAddr);
      mapAllocsToRemoteAddrs(Dyld, ObjAllocs.RODataAllocs,
                             ObjAllocs.RemoteRODataAddr);
      mapAllocsToRemoteAddrs(Dyld, ObjAllocs.RWDataAllocs,
                             ObjAllocs.RemoteRWDataAddr);
      Unfinalized.push_back(std::move(ObjAllocs));
    }
    Unmapped.clear();
  }

  bool finalizeMemory(std::string *ErrMsg = nullptr) override {
    LLVM_DEBUG(dbgs() << "Allocator " << Id << " finalizing:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Allocator " << Id << " finalizing:\n"
; } } while (false);

    for (auto &ObjAllocs : Unfinalized) {
      if (copyAndProtect(ObjAllocs.CodeAllocs, ObjAllocs.RemoteCodeAddr,
                         sys::Memory::MF_READ | sys::Memory::MF_EXEC))
        return true;

      if (copyAndProtect(ObjAllocs.RODataAllocs, ObjAllocs.RemoteRODataAddr,
                         sys::Memory::MF_READ))
        return true;

      if (copyAndProtect(ObjAllocs.RWDataAllocs, ObjAllocs.RemoteRWDataAddr,
                         sys::Memory::MF_READ | sys::Memory::MF_WRITE))
        return true;
    }
    Unfinalized.clear();

    for (auto &EHFrame : UnfinalizedEHFrames) {
      if (auto Err = Client.registerEHFrames(EHFrame.Addr, EHFrame.Size)) {
        // FIXME: Replace this once finalizeMemory can return an Error.
        handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) {
          if (ErrMsg) {
            raw_string_ostream ErrOut(*ErrMsg);
            EIB.log(ErrOut);
          }
        });
        return false;
      }
    }
    RegisteredEHFrames = std::move(UnfinalizedEHFrames);
    UnfinalizedEHFrames = {};

    return false;
  }

private:
  class Alloc {
  public:
    Alloc(uint64_t Size, unsigned Align)
        : Size(Size), Align(Align), Contents(new char[Size + Align - 1]) {}

    Alloc(const Alloc &) = delete;
    Alloc &operator=(const Alloc &) = delete;
    Alloc(Alloc &&) = default;
    Alloc &operator=(Alloc &&) = default;

    uint64_t getSize() const { return Size; }

    unsigned getAlign() const { return Align; }

    char *getLocalAddress() const {
      uintptr_t LocalAddr = reinterpret_cast<uintptr_t>(Contents.get());
      LocalAddr = alignTo(LocalAddr, Align);
      return reinterpret_cast<char *>(LocalAddr);
    }

    void setRemoteAddress(JITTargetAddress RemoteAddr) {
      this->RemoteAddr = RemoteAddr;
    }

    JITTargetAddress getRemoteAddress() const { return RemoteAddr; }

  private:
    uint64_t Size;
    unsigned Align;
    std::unique_ptr<char[]> Contents;
    JITTargetAddress RemoteAddr = 0;
  };

  struct ObjectAllocs {
    ObjectAllocs() = default;
    ObjectAllocs(const ObjectAllocs &) = delete;
    ObjectAllocs &operator=(const ObjectAllocs &) = delete;
    ObjectAllocs(ObjectAllocs &&) = default;
    ObjectAllocs &operator=(ObjectAllocs &&) = default;

    JITTargetAddress RemoteCodeAddr = 0;
    JITTargetAddress RemoteRODataAddr = 0;
    JITTargetAddress RemoteRWDataAddr = 0;
    std::vector<Alloc> CodeAllocs, RODataAllocs, RWDataAllocs;
  };

  RemoteRTDyldMemoryManager(OrcRemoteTargetClient &Client,
                            ResourceIdMgr::ResourceId Id)
      : Client(Client), Id(Id) {
    LLVM_DEBUG(dbgs() << "Created remote allocator " << Id << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Created remote allocator " <<
 Id << "\n"; } } while (false);
  }

  // Maps all allocations in Allocs to aligned blocks
  void mapAllocsToRemoteAddrs(RuntimeDyld &Dyld, std::vector<Alloc> &Allocs,
                              JITTargetAddress NextAddr) {
    for (auto &Alloc : Allocs) {
      NextAddr = alignTo(NextAddr, Alloc.getAlign());
      Dyld.mapSectionAddress(Alloc.getLocalAddress(), NextAddr);
      LLVM_DEBUG(dbgs() << "     "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "     " << static_cast<void
 *>(Alloc.getLocalAddress()) << " -> " << format
("0x%016x", NextAddr) << "\n"; } } while (false)
                        << static_cast<void *>(Alloc.getLocalAddress())do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "     " << static_cast<void
 *>(Alloc.getLocalAddress()) << " -> " << format
("0x%016x", NextAddr) << "\n"; } } while (false)
                        << " -> " << format("0x%016x", NextAddr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "     " << static_cast<void
 *>(Alloc.getLocalAddress()) << " -> " << format
("0x%016x", NextAddr) << "\n"; } } while (false);
      Alloc.setRemoteAddress(NextAddr);

      // Only advance NextAddr if it was non-null to begin with,
      // otherwise leave it as null.
      if (NextAddr)
        NextAddr += Alloc.getSize();
    }
  }

  // Copies data for each alloc in the list, then set permissions on the
  // segment.
  bool copyAndProtect(const std::vector<Alloc> &Allocs,
                      JITTargetAddress RemoteSegmentAddr,
                      unsigned Permissions) {
    if (RemoteSegmentAddr) {
      assert(!Allocs.empty() && "No sections in allocated segment")((!Allocs.empty() && "No sections in allocated segment"
) ? static_cast<void> (0) : __assert_fail ("!Allocs.empty() && \"No sections in allocated segment\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 290, __PRETTY_FUNCTION__));

      for (auto &Alloc : Allocs) {
        LLVM_DEBUG(dbgs() << "  copying section: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  copying section: " << static_cast
<void *>(Alloc.getLocalAddress()) << " -> " <<
 format("0x%016x", Alloc.getRemoteAddress()) << " (" <<
 Alloc.getSize() << " bytes)\n";; } } while (false)
                          << static_cast<void *>(Alloc.getLocalAddress())do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  copying section: " << static_cast
<void *>(Alloc.getLocalAddress()) << " -> " <<
 format("0x%016x", Alloc.getRemoteAddress()) << " (" <<
 Alloc.getSize() << " bytes)\n";; } } while (false)
                          << " -> "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  copying section: " << static_cast
<void *>(Alloc.getLocalAddress()) << " -> " <<
 format("0x%016x", Alloc.getRemoteAddress()) << " (" <<
 Alloc.getSize() << " bytes)\n";; } } while (false)
                          << format("0x%016x", Alloc.getRemoteAddress())do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  copying section: " << static_cast
<void *>(Alloc.getLocalAddress()) << " -> " <<
 format("0x%016x", Alloc.getRemoteAddress()) << " (" <<
 Alloc.getSize() << " bytes)\n";; } } while (false)
                          << " (" << Alloc.getSize() << " bytes)\n";)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  copying section: " << static_cast
<void *>(Alloc.getLocalAddress()) << " -> " <<
 format("0x%016x", Alloc.getRemoteAddress()) << " (" <<
 Alloc.getSize() << " bytes)\n";; } } while (false);

        if (Client.writeMem(Alloc.getRemoteAddress(), Alloc.getLocalAddress(),
                            Alloc.getSize()))
          return true;
      }

      LLVM_DEBUG(dbgs() << "  setting "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false)
                        << (Permissions & sys::Memory::MF_READ ? 'R' : '-')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false)
                        << (Permissions & sys::Memory::MF_WRITE ? 'W' : '-')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false)
                        << (Permissions & sys::Memory::MF_EXEC ? 'X' : '-')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false)
                        << " permissions on block: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false)
                        << format("0x%016x", RemoteSegmentAddr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "  setting " << (Permissions
 & sys::Memory::MF_READ ? 'R' : '-') << (Permissions
 & sys::Memory::MF_WRITE ? 'W' : '-') << (Permissions
 & sys::Memory::MF_EXEC ? 'X' : '-') << " permissions on block: "
 << format("0x%016x", RemoteSegmentAddr) << "\n";
 } } while (false);
      if (Client.setProtections(Id, RemoteSegmentAddr, Permissions))
        return true;
    }
    return false;
  }

  OrcRemoteTargetClient &Client;
  ResourceIdMgr::ResourceId Id;
  std::vector<ObjectAllocs> Unmapped;
  std::vector<ObjectAllocs> Unfinalized;

  struct EHFrame {
    JITTargetAddress Addr;
    uint64_t Size;
  };
  std::vector<EHFrame> UnfinalizedEHFrames;
  std::vector<EHFrame> RegisteredEHFrames;
};

/// Remote indirect stubs manager.
class RemoteIndirectStubsManager : public IndirectStubsManager {
public:
  RemoteIndirectStubsManager(OrcRemoteTargetClient &Client,
                             ResourceIdMgr::ResourceId Id)
      : Client(Client), Id(Id) {}

  ~RemoteIndirectStubsManager() override {
    Client.destroyIndirectStubsManager(Id);
  }

  Error createStub(StringRef StubName, JITTargetAddress StubAddr,
                   JITSymbolFlags StubFlags) override {
    if (auto Err = reserveStubs(1))
      return Err;

    return createStubInternal(StubName, StubAddr, StubFlags);
  }

  Error createStubs(const StubInitsMap &StubInits) override {
    if (auto Err = reserveStubs(StubInits.size()))
      return Err;

    for (auto &Entry : StubInits)
      if (auto Err = createStubInternal(Entry.first(), Entry.second.first,
                                        Entry.second.second))
        return Err;

    return Error::success();
  }

  JITEvaluatedSymbol findStub(StringRef Name, bool ExportedStubsOnly) override {
    auto I = StubIndexes.find(Name);
    if (I == StubIndexes.end())
      return nullptr;
    auto Key = I->second.first;
    auto Flags = I->second.second;
    auto StubSymbol = JITEvaluatedSymbol(getStubAddr(Key), Flags);
    if (ExportedStubsOnly && !StubSymbol.getFlags().isExported())
      return nullptr;
    return StubSymbol;
  }

  JITEvaluatedSymbol findPointer(StringRef Name) override {
    auto I = StubIndexes.find(Name);
    if (I == StubIndexes.end())
      return nullptr;
    auto Key = I->second.first;
    auto Flags = I->second.second;
    return JITEvaluatedSymbol(getPtrAddr(Key), Flags);
  }

  Error updatePointer(StringRef Name, JITTargetAddress NewAddr) override {
    auto I = StubIndexes.find(Name);
    assert(I != StubIndexes.end() && "No stub pointer for symbol")((I != StubIndexes.end() && "No stub pointer for symbol"
) ? static_cast<void> (0) : __assert_fail ("I != StubIndexes.end() && \"No stub pointer for symbol\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 383, __PRETTY_FUNCTION__));
    auto Key = I->second.first;
    return Client.writePointer(getPtrAddr(Key), NewAddr);
  }

private:
  struct RemoteIndirectStubsInfo {
    JITTargetAddress StubBase;
    JITTargetAddress PtrBase;
    unsigned NumStubs;
  };

  using StubKey = std::pair<uint16_t, uint16_t>;

  Error reserveStubs(unsigned NumStubs) {
    if (NumStubs <= FreeStubs.size())
      return Error::success();

    unsigned NewStubsRequired = NumStubs - FreeStubs.size();
    JITTargetAddress StubBase;
    JITTargetAddress PtrBase;
    unsigned NumStubsEmitted;

    if (auto StubInfoOrErr = Client.emitIndirectStubs(Id, NewStubsRequired))
      std::tie(StubBase, PtrBase, NumStubsEmitted) = *StubInfoOrErr;
    else
      return StubInfoOrErr.takeError();

    unsigned NewBlockId = RemoteIndirectStubsInfos.size();
    RemoteIndirectStubsInfos.push_back({StubBase, PtrBase, NumStubsEmitted});

    for (unsigned I = 0; I < NumStubsEmitted; ++I)
      FreeStubs.push_back(std::make_pair(NewBlockId, I));

    return Error::success();
  }

  Error createStubInternal(StringRef StubName, JITTargetAddress InitAddr,
                           JITSymbolFlags StubFlags) {
    auto Key = FreeStubs.back();
    FreeStubs.pop_back();
    StubIndexes[StubName] = std::make_pair(Key, StubFlags);
    return Client.writePointer(getPtrAddr(Key), InitAddr);
  }

  JITTargetAddress getStubAddr(StubKey K) {
    assert(RemoteIndirectStubsInfos[K.first].StubBase != 0 &&((RemoteIndirectStubsInfos[K.first].StubBase != 0 && "Missing stub address"
) ? static_cast<void> (0) : __assert_fail ("RemoteIndirectStubsInfos[K.first].StubBase != 0 && \"Missing stub address\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 430, __PRETTY_FUNCTION__))
           "Missing stub address")((RemoteIndirectStubsInfos[K.first].StubBase != 0 && "Missing stub address"
) ? static_cast<void> (0) : __assert_fail ("RemoteIndirectStubsInfos[K.first].StubBase != 0 && \"Missing stub address\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 430, __PRETTY_FUNCTION__));
    return RemoteIndirectStubsInfos[K.first].StubBase +
           K.second * Client.getIndirectStubSize();
  }

  JITTargetAddress getPtrAddr(StubKey K) {
    assert(RemoteIndirectStubsInfos[K.first].PtrBase != 0 &&((RemoteIndirectStubsInfos[K.first].PtrBase != 0 && "Missing pointer address"
) ? static_cast<void> (0) : __assert_fail ("RemoteIndirectStubsInfos[K.first].PtrBase != 0 && \"Missing pointer address\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 437, __PRETTY_FUNCTION__))
           "Missing pointer address")((RemoteIndirectStubsInfos[K.first].PtrBase != 0 && "Missing pointer address"
) ? static_cast<void> (0) : __assert_fail ("RemoteIndirectStubsInfos[K.first].PtrBase != 0 && \"Missing pointer address\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 437, __PRETTY_FUNCTION__));
    return RemoteIndirectStubsInfos[K.first].PtrBase +
           K.second * Client.getPointerSize();
  }

  OrcRemoteTargetClient &Client;
  ResourceIdMgr::ResourceId Id;
  std::vector<RemoteIndirectStubsInfo> RemoteIndirectStubsInfos;
  std::vector<StubKey> FreeStubs;
  StringMap<std::pair<StubKey, JITSymbolFlags>> StubIndexes;
};

class RemoteTrampolinePool : public TrampolinePool {
public:
  RemoteTrampolinePool(OrcRemoteTargetClient &Client) : Client(Client) {}

  Expected<JITTargetAddress> getTrampoline() override {
    std::lock_guard<std::mutex> Lock(RTPMutex);
    if (AvailableTrampolines.empty()) {
      if (auto Err = grow())
        return std::move(Err);
    }
    assert(!AvailableTrampolines.empty() && "Failed to grow trampoline pool")((!AvailableTrampolines.empty() && "Failed to grow trampoline pool"
) ? static_cast<void> (0) : __assert_fail ("!AvailableTrampolines.empty() && \"Failed to grow trampoline pool\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 459, __PRETTY_FUNCTION__));
    auto TrampolineAddr = AvailableTrampolines.back();
    AvailableTrampolines.pop_back();
    return TrampolineAddr;
  }

private:
  Error grow() {
    JITTargetAddress BlockAddr = 0;
    uint32_t NumTrampolines = 0;
    if (auto TrampolineInfoOrErr = Client.emitTrampolineBlock())
      std::tie(BlockAddr, NumTrampolines) = *TrampolineInfoOrErr;
    else
      return TrampolineInfoOrErr.takeError();

    uint32_t TrampolineSize = Client.getTrampolineSize();
    for (unsigned I = 0; I < NumTrampolines; ++I)
      this->AvailableTrampolines.push_back(BlockAddr + (I * TrampolineSize));

    return Error::success();
  }

  std::mutex RTPMutex;
  OrcRemoteTargetClient &Client;
  std::vector<JITTargetAddress> AvailableTrampolines;
};

/// Remote compile callback manager.
class RemoteCompileCallbackManager : public JITCompileCallbackManager {
public:
  RemoteCompileCallbackManager(OrcRemoteTargetClient &Client,
                               ExecutionSession &ES,
                               JITTargetAddress ErrorHandlerAddress)
      : JITCompileCallbackManager(
            llvm::make_unique<RemoteTrampolinePool>(Client), ES,
            ErrorHandlerAddress) {}
};

/// Create an OrcRemoteTargetClient.
/// Channel is the ChannelT instance to communicate on. It is assumed that
/// the channel is ready to be read from and written to.
static Expected<std::unique_ptr<OrcRemoteTargetClient>>
Create(rpc::RawByteChannel &Channel, ExecutionSession &ES) {
  Error Err = Error::success();
  auto Client = std::unique_ptr<OrcRemoteTargetClient>(
      new OrcRemoteTargetClient(Channel, ES, Err));
  if (Err)
    return std::move(Err);
  return std::move(Client);
}

/// Call the int(void) function at the given address in the target and return
/// its result.
Expected<int> callIntVoid(JITTargetAddress Addr) {
  LLVM_DEBUG(dbgs() << "Calling int(*)(void) " << format("0x%016x", Addr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling int(*)(void) " << format
("0x%016x", Addr) << "\n"; } } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling int(*)(void) " << format
("0x%016x", Addr) << "\n"; } } while (false);
  return callB<exec::CallIntVoid>(Addr);
}

/// Call the int(int, char*[]) function at the given address in the target and
/// return its result.
Expected<int> callMain(JITTargetAddress Addr,
                       const std::vector<std::string> &Args) {
  LLVM_DEBUG(dbgs() << "Calling int(*)(int, char*[]) "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling int(*)(int, char*[]) " <<
 format("0x%016x", Addr) << "\n"; } } while (false)
                    << format("0x%016x", Addr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling int(*)(int, char*[]) " <<
 format("0x%016x", Addr) << "\n"; } } while (false);
  return callB<exec::CallMain>(Addr, Args);
}

/// Call the void() function at the given address in the target and wait for
/// it to finish.
Error callVoidVoid(JITTargetAddress Addr) {
  LLVM_DEBUG(dbgs() << "Calling void(*)(void) " << format("0x%016x", Addr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling void(*)(void) " << format
("0x%016x", Addr) << "\n"; } } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("lli")) { dbgs() << "Calling void(*)(void) " << format
("0x%016x", Addr) << "\n"; } } while (false);
  return callB<exec::CallVoidVoid>(Addr);
}

/// Create an RCMemoryManager which will allocate its memory on the remote
/// target.
Expected<std::unique_ptr<RemoteRTDyldMemoryManager>>
createRemoteMemoryManager() {
  auto Id = AllocatorIds.getNext();
  if (auto Err = callB<mem::CreateRemoteAllocator>(Id))
    return std::move(Err);
  return std::unique_ptr<RemoteRTDyldMemoryManager>(
      new RemoteRTDyldMemoryManager(*this, Id));
}

/// Create an RCIndirectStubsManager that will allocate stubs on the remote
/// target.
Expected<std::unique_ptr<RemoteIndirectStubsManager>>
createIndirectStubsManager() {
  auto Id = IndirectStubOwnerIds.getNext();
  if (auto Err = callB<stubs::CreateIndirectStubsOwner>(Id))
    return std::move(Err);
  return llvm::make_unique<RemoteIndirectStubsManager>(*this, Id);
}

Expected<RemoteCompileCallbackManager &>
enableCompileCallbacks(JITTargetAddress ErrorHandlerAddress) {
  assert(!CallbackManager && "CallbackManager already obtained")((!CallbackManager && "CallbackManager already obtained"
) ? static_cast<void> (0) : __assert_fail ("!CallbackManager && \"CallbackManager already obtained\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 558, __PRETTY_FUNCTION__));

  // Emit the resolver block on the JIT server.
  if (auto Err = callB<stubs::EmitResolverBlock>())
    return std::move(Err);

  // Create the callback manager.
  CallbackManager.emplace(*this, ES, ErrorHandlerAddress);
  RemoteCompileCallbackManager &Mgr = *CallbackManager;
  return Mgr;
}

/// Search for symbols in the remote process. Note: This should be used by
/// symbol resolvers *after* they've searched the local symbol table in the
/// JIT stack.
Expected<JITTargetAddress> getSymbolAddress(StringRef Name) {
  return callB<utils::GetSymbolAddress>(Name);
2
←
Calling 'SingleThreadedRPCEndpoint::callB'→
}

/// Get the triple for the remote target.
const std::string &getTargetTriple() const { return RemoteTargetTriple; }

Error terminateSession() { return callB<utils::TerminateSession>(); }

582private:
OrcRemoteTargetClient(rpc::RawByteChannel &Channel, ExecutionSession &ES,
                      Error &Err)
    : rpc::SingleThreadedRPCEndpoint<rpc::RawByteChannel>(Channel, true),
      ES(ES) {
  ErrorAsOutParameter EAO(&Err);

  addHandler<utils::RequestCompile>(
      [this](JITTargetAddress Addr) -> JITTargetAddress {
        if (CallbackManager)
          return CallbackManager->executeCompileCallback(Addr);
        return 0;
      });

  if (auto RIOrErr = callB<utils::GetRemoteInfo>()) {
    std::tie(RemoteTargetTriple, RemotePointerSize, RemotePageSize,
             RemoteTrampolineSize, RemoteIndirectStubSize) = *RIOrErr;
    Err = Error::success();
  } else
    Err = RIOrErr.takeError();
}

void deregisterEHFrames(JITTargetAddress Addr, uint32_t Size) {
  if (auto Err = callB<eh::RegisterEHFrames>(Addr, Size))
    ES.reportError(std::move(Err));
}

void destroyRemoteAllocator(ResourceIdMgr::ResourceId Id) {
  if (auto Err = callB<mem::DestroyRemoteAllocator>(Id)) {
    // FIXME: This will be triggered by a removeModuleSet call: Propagate
    //        error return up through that.
    llvm_unreachable("Failed to destroy remote allocator.")::llvm::llvm_unreachable_internal("Failed to destroy remote allocator."
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
, 613);
    AllocatorIds.release(Id);
  }
}

void destroyIndirectStubsManager(ResourceIdMgr::ResourceId Id) {
  IndirectStubOwnerIds.release(Id);
  if (auto Err = callB<stubs::DestroyIndirectStubsOwner>(Id))
    ES.reportError(std::move(Err));
}

Expected<std::tuple<JITTargetAddress, JITTargetAddress, uint32_t>>
emitIndirectStubs(ResourceIdMgr::ResourceId Id, uint32_t NumStubsRequired) {
  return callB<stubs::EmitIndirectStubs>(Id, NumStubsRequired);
}

Expected<std::tuple<JITTargetAddress, uint32_t>> emitTrampolineBlock() {
  return callB<stubs::EmitTrampolineBlock>();
}

uint32_t getIndirectStubSize() const { return RemoteIndirectStubSize; }
uint32_t getPageSize() const { return RemotePageSize; }
uint32_t getPointerSize() const { return RemotePointerSize; }

uint32_t getTrampolineSize() const { return RemoteTrampolineSize; }

Expected<std::vector<uint8_t>> readMem(char *Dst, JITTargetAddress Src,
                                       uint64_t Size) {
  return callB<mem::ReadMem>(Src, Size);
}

Error registerEHFrames(JITTargetAddress &RAddr, uint32_t Size) {
  // FIXME: Duplicate error and report it via ReportError too?
  return callB<eh::RegisterEHFrames>(RAddr, Size);
}

JITTargetAddress reserveMem(ResourceIdMgr::ResourceId Id, uint64_t Size,
                            uint32_t Align) {
  if (auto AddrOrErr = callB<mem::ReserveMem>(Id, Size, Align))
    return *AddrOrErr;
  else {
    ES.reportError(AddrOrErr.takeError());
    return 0;
  }
}

bool setProtections(ResourceIdMgr::ResourceId Id,
                    JITTargetAddress RemoteSegAddr, unsigned ProtFlags) {
  if (auto Err = callB<mem::SetProtections>(Id, RemoteSegAddr, ProtFlags)) {
    ES.reportError(std::move(Err));
    return true;
  } else
    return false;
}

bool writeMem(JITTargetAddress Addr, const char *Src, uint64_t Size) {
  if (auto Err = callB<mem::WriteMem>(DirectBufferWriter(Src, Addr, Size))) {
    ES.reportError(std::move(Err));
    return true;
  } else
    return false;
}

Error writePointer(JITTargetAddress Addr, JITTargetAddress PtrVal) {
  return callB<mem::WritePtr>(Addr, PtrVal);
}

static Error doNothing() { return Error::success(); }

ExecutionSession &ES;
std::function<void(Error)> ReportError;
std::string RemoteTargetTriple;
uint32_t RemotePointerSize = 0;
uint32_t RemotePageSize = 0;
uint32_t RemoteTrampolineSize = 0;
uint32_t RemoteIndirectStubSize = 0;
ResourceIdMgr AllocatorIds, IndirectStubOwnerIds;
Optional<RemoteCompileCallbackManager> CallbackManager;
691};

693} // end namespace remote
694} // end namespace orc
695} // end namespace llvm

697#undef DEBUG_TYPE"lli"

699#endif // LLVM_EXECUTIONENGINE_ORC_ORCREMOTETARGETCLIENT_H

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h

→

1//===------- RPCUTils.h - Utilities for building RPC APIs -------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Utilities to support construction of simple RPC APIs.
11//
12// The RPC utilities aim for ease of use (minimal conceptual overhead) for C++
13// programmers, high performance, low memory overhead, and efficient use of the
14// communications channel.
15//
16//===----------------------------------------------------------------------===//

18#ifndef LLVM_EXECUTIONENGINE_ORC_RPCUTILS_H
19#define LLVM_EXECUTIONENGINE_ORC_RPCUTILS_H

21#include <map>
22#include <thread>
23#include <vector>

25#include "llvm/ADT/STLExtras.h"
26#include "llvm/ExecutionEngine/Orc/OrcError.h"
27#include "llvm/ExecutionEngine/Orc/RPCSerialization.h"
28#include "llvm/Support/MSVCErrorWorkarounds.h"

30#include <future>

32namespace llvm {
33namespace orc {
34namespace rpc {

36/// Base class of all fatal RPC errors (those that necessarily result in the
37/// termination of the RPC session).
38class RPCFatalError : public ErrorInfo<RPCFatalError> {
39public:
static char ID;
41};

43/// RPCConnectionClosed is returned from RPC operations if the RPC connection
44/// has already been closed due to either an error or graceful disconnection.
45class ConnectionClosed : public ErrorInfo<ConnectionClosed> {
46public:
static char ID;
std::error_code convertToErrorCode() const override;
void log(raw_ostream &OS) const override;
50};

52/// BadFunctionCall is returned from handleOne when the remote makes a call with
53/// an unrecognized function id.
54///
55/// This error is fatal because Orc RPC needs to know how to parse a function
56/// call to know where the next call starts, and if it doesn't recognize the
57/// function id it cannot parse the call.
58template <typename FnIdT, typename SeqNoT>
59class BadFunctionCall
: public ErrorInfo<BadFunctionCall<FnIdT, SeqNoT>, RPCFatalError> {
61public:
static char ID;

BadFunctionCall(FnIdT FnId, SeqNoT SeqNo)
    : FnId(std::move(FnId)), SeqNo(std::move(SeqNo)) {}

std::error_code convertToErrorCode() const override {
  return orcError(OrcErrorCode::UnexpectedRPCCall);
}

void log(raw_ostream &OS) const override {
  OS << "Call to invalid RPC function id '" << FnId << "' with "
        "sequence number " << SeqNo;
}

76private:
FnIdT FnId;
SeqNoT SeqNo;
79};

81template <typename FnIdT, typename SeqNoT>
82char BadFunctionCall<FnIdT, SeqNoT>::ID = 0;

84/// InvalidSequenceNumberForResponse is returned from handleOne when a response
85/// call arrives with a sequence number that doesn't correspond to any in-flight
86/// function call.
87///
88/// This error is fatal because Orc RPC needs to know how to parse the rest of
89/// the response call to know where the next call starts, and if it doesn't have
90/// a result parser for this sequence number it can't do that.
91template <typename SeqNoT>
92class InvalidSequenceNumberForResponse
  : public ErrorInfo<InvalidSequenceNumberForResponse<SeqNoT>, RPCFatalError> {
94public:
static char ID;

InvalidSequenceNumberForResponse(SeqNoT SeqNo)
    : SeqNo(std::move(SeqNo)) {}

std::error_code convertToErrorCode() const override {
  return orcError(OrcErrorCode::UnexpectedRPCCall);
};

void log(raw_ostream &OS) const override {
  OS << "Response has unknown sequence number " << SeqNo;
}
107private:
SeqNoT SeqNo;
109};

111template <typename SeqNoT>
112char InvalidSequenceNumberForResponse<SeqNoT>::ID = 0;

114/// This non-fatal error will be passed to asynchronous result handlers in place
115/// of a result if the connection goes down before a result returns, or if the
116/// function to be called cannot be negotiated with the remote.
117class ResponseAbandoned : public ErrorInfo<ResponseAbandoned> {
118public:
static char ID;

std::error_code convertToErrorCode() const override;
void log(raw_ostream &OS) const override;
123};

125/// This error is returned if the remote does not have a handler installed for
126/// the given RPC function.
127class CouldNotNegotiate : public ErrorInfo<CouldNotNegotiate> {
128public:
static char ID;

CouldNotNegotiate(std::string Signature);
std::error_code convertToErrorCode() const override;
void log(raw_ostream &OS) const override;
const std::string &getSignature() const { return Signature; }
135private:
std::string Signature;
137};

139template <typename DerivedFunc, typename FnT> class Function;

141// RPC Function class.
142// DerivedFunc should be a user defined class with a static 'getName()' method
143// returning a const char* representing the function's name.
144template <typename DerivedFunc, typename RetT, typename... ArgTs>
145class Function<DerivedFunc, RetT(ArgTs...)> {
146public:
/// User defined function type.
using Type = RetT(ArgTs...);

/// Return type.
using ReturnType = RetT;

/// Returns the full function prototype as a string.
static const char *getPrototype() {
  std::lock_guard<std::mutex> Lock(NameMutex);
  if (Name.empty())
    raw_string_ostream(Name)
        << RPCTypeName<RetT>::getName() << " " << DerivedFunc::getName()
        << "(" << llvm::orc::rpc::RPCTypeNameSequence<ArgTs...>() << ")";
  return Name.data();
}

163private:
static std::mutex NameMutex;
static std::string Name;
166};

168template <typename DerivedFunc, typename RetT, typename... ArgTs>
169std::mutex Function<DerivedFunc, RetT(ArgTs...)>::NameMutex;

171template <typename DerivedFunc, typename RetT, typename... ArgTs>
172std::string Function<DerivedFunc, RetT(ArgTs...)>::Name;

174/// Allocates RPC function ids during autonegotiation.
175/// Specializations of this class must provide four members:
176///
177/// static T getInvalidId():
178///   Should return a reserved id that will be used to represent missing
179/// functions during autonegotiation.
180///
181/// static T getResponseId():
182///   Should return a reserved id that will be used to send function responses
183/// (return values).
184///
185/// static T getNegotiateId():
186///   Should return a reserved id for the negotiate function, which will be used
187/// to negotiate ids for user defined functions.
188///
189/// template <typename Func> T allocate():
190///   Allocate a unique id for function Func.
191template <typename T, typename = void> class RPCFunctionIdAllocator;

193/// This specialization of RPCFunctionIdAllocator provides a default
194/// implementation for integral types.
195template <typename T>
196class RPCFunctionIdAllocator<
  T, typename std::enable_if<std::is_integral<T>::value>::type> {
198public:
static T getInvalidId() { return T(0); }
static T getResponseId() { return T(1); }
static T getNegotiateId() { return T(2); }

template <typename Func> T allocate() { return NextId++; }

205private:
T NextId = 3;
207};

209namespace detail {

211/// Provides a typedef for a tuple containing the decayed argument types.
212template <typename T> class FunctionArgsTuple;

214template <typename RetT, typename... ArgTs>
215class FunctionArgsTuple<RetT(ArgTs...)> {
216public:
using Type = std::tuple<typename std::decay<
    typename std::remove_reference<ArgTs>::type>::type...>;
219};

221// ResultTraits provides typedefs and utilities specific to the return type
222// of functions.
223template <typename RetT> class ResultTraits {
224public:
// The return type wrapped in llvm::Expected.
using ErrorReturnType = Expected<RetT>;

228#ifdef _MSC_VER
// The ErrorReturnType wrapped in a std::promise.
using ReturnPromiseType = std::promise<MSVCPExpected<RetT>>;

// The ErrorReturnType wrapped in a std::future.
using ReturnFutureType = std::future<MSVCPExpected<RetT>>;
234#else
// The ErrorReturnType wrapped in a std::promise.
using ReturnPromiseType = std::promise<ErrorReturnType>;

// The ErrorReturnType wrapped in a std::future.
using ReturnFutureType = std::future<ErrorReturnType>;
240#endif

// Create a 'blank' value of the ErrorReturnType, ready and safe to
// overwrite.
static ErrorReturnType createBlankErrorReturnValue() {
  return ErrorReturnType(RetT());
}

// Consume an abandoned ErrorReturnType.
static void consumeAbandoned(ErrorReturnType RetOrErr) {
  consumeError(RetOrErr.takeError());
}
252};

254// ResultTraits specialization for void functions.
255template <> class ResultTraits<void> {
256public:
// For void functions, ErrorReturnType is llvm::Error.
using ErrorReturnType = Error;

260#ifdef _MSC_VER
// The ErrorReturnType wrapped in a std::promise.
using ReturnPromiseType = std::promise<MSVCPError>;

// The ErrorReturnType wrapped in a std::future.
using ReturnFutureType = std::future<MSVCPError>;
266#else
// The ErrorReturnType wrapped in a std::promise.
using ReturnPromiseType = std::promise<ErrorReturnType>;

// The ErrorReturnType wrapped in a std::future.
using ReturnFutureType = std::future<ErrorReturnType>;
272#endif

// Create a 'blank' value of the ErrorReturnType, ready and safe to
// overwrite.
static ErrorReturnType createBlankErrorReturnValue() {
  return ErrorReturnType::success();
}

// Consume an abandoned ErrorReturnType.
static void consumeAbandoned(ErrorReturnType Err) {
  consumeError(std::move(Err));
}
284};

286// ResultTraits<Error> is equivalent to ResultTraits<void>. This allows
287// handlers for void RPC functions to return either void (in which case they
288// implicitly succeed) or Error (in which case their error return is
289// propagated). See usage in HandlerTraits::runHandlerHelper.
290template <> class ResultTraits<Error> : public ResultTraits<void> {};

292// ResultTraits<Expected<T>> is equivalent to ResultTraits<T>. This allows
293// handlers for RPC functions returning a T to return either a T (in which
294// case they implicitly succeed) or Expected<T> (in which case their error
295// return is propagated). See usage in HandlerTraits::runHandlerHelper.
296template <typename RetT>
297class ResultTraits<Expected<RetT>> : public ResultTraits<RetT> {};

299// Determines whether an RPC function's defined error return type supports
300// error return value.
301template <typename T>
302class SupportsErrorReturn {
303public:
static const bool value = false;
305};

307template <>
308class SupportsErrorReturn<Error> {
309public:
static const bool value = true;
311};

313template <typename T>
314class SupportsErrorReturn<Expected<T>> {
315public:
static const bool value = true;
317};

319// RespondHelper packages return values based on whether or not the declared
320// RPC function return type supports error returns.
321template <bool FuncSupportsErrorReturn>
322class RespondHelper;

324// RespondHelper specialization for functions that support error returns.
325template <>
326class RespondHelper<true> {
327public:

// Send Expected<T>.
template <typename WireRetT, typename HandlerRetT, typename ChannelT,
          typename FunctionIdT, typename SequenceNumberT>
static Error sendResult(ChannelT &C, const FunctionIdT &ResponseId,
                        SequenceNumberT SeqNo,
                        Expected<HandlerRetT> ResultOrErr) {
  if (!ResultOrErr && ResultOrErr.template errorIsA<RPCFatalError>())
    return ResultOrErr.takeError();

  // Open the response message.
  if (auto Err = C.startSendMessage(ResponseId, SeqNo))
    return Err;

  // Serialize the result.
  if (auto Err =
      SerializationTraits<ChannelT, WireRetT,
                          Expected<HandlerRetT>>::serialize(
                                                   C, std::move(ResultOrErr)))
    return Err;

  // Close the response message.
  return C.endSendMessage();
}

template <typename ChannelT, typename FunctionIdT, typename SequenceNumberT>
static Error sendResult(ChannelT &C, const FunctionIdT &ResponseId,
                        SequenceNumberT SeqNo, Error Err) {
  if (Err && Err.isA<RPCFatalError>())
    return Err;
  if (auto Err2 = C.startSendMessage(ResponseId, SeqNo))
    return Err2;
  if (auto Err2 = serializeSeq(C, std::move(Err)))
    return Err2;
  return C.endSendMessage();
}

365};

367// RespondHelper specialization for functions that do not support error returns.
368template <>
369class RespondHelper<false> {
370public:

template <typename WireRetT, typename HandlerRetT, typename ChannelT,
          typename FunctionIdT, typename SequenceNumberT>
static Error sendResult(ChannelT &C, const FunctionIdT &ResponseId,
                        SequenceNumberT SeqNo,
                        Expected<HandlerRetT> ResultOrErr) {
  if (auto Err = ResultOrErr.takeError())
    return Err;

  // Open the response message.
  if (auto Err = C.startSendMessage(ResponseId, SeqNo))
    return Err;

  // Serialize the result.
  if (auto Err =
      SerializationTraits<ChannelT, WireRetT, HandlerRetT>::serialize(
                                                             C, *ResultOrErr))
    return Err;

  // Close the response message.
  return C.endSendMessage();
}

template <typename ChannelT, typename FunctionIdT, typename SequenceNumberT>
static Error sendResult(ChannelT &C, const FunctionIdT &ResponseId,
                        SequenceNumberT SeqNo, Error Err) {
  if (Err)
    return Err;
  if (auto Err2 = C.startSendMessage(ResponseId, SeqNo))
    return Err2;
  return C.endSendMessage();
}

404};


407// Send a response of the given wire return type (WireRetT) over the
408// channel, with the given sequence number.
409template <typename WireRetT, typename HandlerRetT, typename ChannelT,
        typename FunctionIdT, typename SequenceNumberT>
411Error respond(ChannelT &C, const FunctionIdT &ResponseId,
            SequenceNumberT SeqNo, Expected<HandlerRetT> ResultOrErr) {
return RespondHelper<SupportsErrorReturn<WireRetT>::value>::
  template sendResult<WireRetT>(C, ResponseId, SeqNo, std::move(ResultOrErr));
415}

417// Send an empty response message on the given channel to indicate that
418// the handler ran.
419template <typename WireRetT, typename ChannelT, typename FunctionIdT,
        typename SequenceNumberT>
421Error respond(ChannelT &C, const FunctionIdT &ResponseId, SequenceNumberT SeqNo,
            Error Err) {
return RespondHelper<SupportsErrorReturn<WireRetT>::value>::
  sendResult(C, ResponseId, SeqNo, std::move(Err));
425}

427// Converts a given type to the equivalent error return type.
428template <typename T> class WrappedHandlerReturn {
429public:
using Type = Expected<T>;
431};

433template <typename T> class WrappedHandlerReturn<Expected<T>> {
434public:
using Type = Expected<T>;
436};

438template <> class WrappedHandlerReturn<void> {
439public:
using Type = Error;
441};

443template <> class WrappedHandlerReturn<Error> {
444public:
using Type = Error;
446};

448template <> class WrappedHandlerReturn<ErrorSuccess> {
449public:
using Type = Error;
451};

453// Traits class that strips the response function from the list of handler
454// arguments.
455template <typename FnT> class AsyncHandlerTraits;

457template <typename ResultT, typename... ArgTs>
458class AsyncHandlerTraits<Error(std::function<Error(Expected<ResultT>)>, ArgTs...)> {
459public:
using Type = Error(ArgTs...);
using ResultType = Expected<ResultT>;
462};

464template <typename... ArgTs>
465class AsyncHandlerTraits<Error(std::function<Error(Error)>, ArgTs...)> {
466public:
using Type = Error(ArgTs...);
using ResultType = Error;
469};

471template <typename... ArgTs>
472class AsyncHandlerTraits<ErrorSuccess(std::function<Error(Error)>, ArgTs...)> {
473public:
using Type = Error(ArgTs...);
using ResultType = Error;
476};

478template <typename... ArgTs>
479class AsyncHandlerTraits<void(std::function<Error(Error)>, ArgTs...)> {
480public:
using Type = Error(ArgTs...);
using ResultType = Error;
483};

485template <typename ResponseHandlerT, typename... ArgTs>
486class AsyncHandlerTraits<Error(ResponseHandlerT, ArgTs...)> :
  public AsyncHandlerTraits<Error(typename std::decay<ResponseHandlerT>::type,
                                  ArgTs...)> {};

490// This template class provides utilities related to RPC function handlers.
491// The base case applies to non-function types (the template class is
492// specialized for function types) and inherits from the appropriate
493// speciilization for the given non-function type's call operator.
494template <typename HandlerT>
495class HandlerTraits : public HandlerTraits<decltype(
                        &std::remove_reference<HandlerT>::type::operator())> {
497};

499// Traits for handlers with a given function type.
500template <typename RetT, typename... ArgTs>
501class HandlerTraits<RetT(ArgTs...)> {
502public:
// Function type of the handler.
using Type = RetT(ArgTs...);

// Return type of the handler.
using ReturnType = RetT;

// Call the given handler with the given arguments.
template <typename HandlerT, typename... TArgTs>
static typename WrappedHandlerReturn<RetT>::Type
unpackAndRun(HandlerT &Handler, std::tuple<TArgTs...> &Args) {
  return unpackAndRunHelper(Handler, Args,
                            llvm::index_sequence_for<TArgTs...>());
}

// Call the given handler with the given arguments.
template <typename HandlerT, typename ResponderT, typename... TArgTs>
static Error unpackAndRunAsync(HandlerT &Handler, ResponderT &Responder,
                               std::tuple<TArgTs...> &Args) {
  return unpackAndRunAsyncHelper(Handler, Responder, Args,
                                 llvm::index_sequence_for<TArgTs...>());
}

// Call the given handler with the given arguments.
template <typename HandlerT>
static typename std::enable_if<
    std::is_void<typename HandlerTraits<HandlerT>::ReturnType>::value,
    Error>::type
run(HandlerT &Handler, ArgTs &&... Args) {
  Handler(std::move(Args)...);
  return Error::success();
}

template <typename HandlerT, typename... TArgTs>
static typename std::enable_if<
    !std::is_void<typename HandlerTraits<HandlerT>::ReturnType>::value,
    typename HandlerTraits<HandlerT>::ReturnType>::type
run(HandlerT &Handler, TArgTs... Args) {
  return Handler(std::move(Args)...);
}

// Serialize arguments to the channel.
template <typename ChannelT, typename... CArgTs>
static Error serializeArgs(ChannelT &C, const CArgTs... CArgs) {
  return SequenceSerialization<ChannelT, ArgTs...>::serialize(C, CArgs...);
}

// Deserialize arguments from the channel.
template <typename ChannelT, typename... CArgTs>
static Error deserializeArgs(ChannelT &C, std::tuple<CArgTs...> &Args) {
  return deserializeArgsHelper(C, Args,
                               llvm::index_sequence_for<CArgTs...>());
}

556private:
template <typename ChannelT, typename... CArgTs, size_t... Indexes>
static Error deserializeArgsHelper(ChannelT &C, std::tuple<CArgTs...> &Args,
                                   llvm::index_sequence<Indexes...> _) {
  return SequenceSerialization<ChannelT, ArgTs...>::deserialize(
      C, std::get<Indexes>(Args)...);
}

template <typename HandlerT, typename ArgTuple, size_t... Indexes>
static typename WrappedHandlerReturn<
    typename HandlerTraits<HandlerT>::ReturnType>::Type
unpackAndRunHelper(HandlerT &Handler, ArgTuple &Args,
                   llvm::index_sequence<Indexes...>) {
  return run(Handler, std::move(std::get<Indexes>(Args))...);
}


template <typename HandlerT, typename ResponderT, typename ArgTuple,
          size_t... Indexes>
static typename WrappedHandlerReturn<
    typename HandlerTraits<HandlerT>::ReturnType>::Type
unpackAndRunAsyncHelper(HandlerT &Handler, ResponderT &Responder,
                        ArgTuple &Args,
                        llvm::index_sequence<Indexes...>) {
  return run(Handler, Responder, std::move(std::get<Indexes>(Args))...);
}
582};

584// Handler traits for free functions.
585template <typename RetT, typename... ArgTs>
586class HandlerTraits<RetT(*)(ArgTs...)>
: public HandlerTraits<RetT(ArgTs...)> {};

589// Handler traits for class methods (especially call operators for lambdas).
590template <typename Class, typename RetT, typename... ArgTs>
591class HandlerTraits<RetT (Class::*)(ArgTs...)>
  : public HandlerTraits<RetT(ArgTs...)> {};

594// Handler traits for const class methods (especially call operators for
595// lambdas).
596template <typename Class, typename RetT, typename... ArgTs>
597class HandlerTraits<RetT (Class::*)(ArgTs...) const>
  : public HandlerTraits<RetT(ArgTs...)> {};

600// Utility to peel the Expected wrapper off a response handler error type.
601template <typename HandlerT> class ResponseHandlerArg;

603template <typename ArgT> class ResponseHandlerArg<Error(Expected<ArgT>)> {
604public:
using ArgType = Expected<ArgT>;
using UnwrappedArgType = ArgT;
607};

609template <typename ArgT>
610class ResponseHandlerArg<ErrorSuccess(Expected<ArgT>)> {
611public:
using ArgType = Expected<ArgT>;
using UnwrappedArgType = ArgT;
614};

616template <> class ResponseHandlerArg<Error(Error)> {
617public:
using ArgType = Error;
619};

621template <> class ResponseHandlerArg<ErrorSuccess(Error)> {
622public:
using ArgType = Error;
624};

626// ResponseHandler represents a handler for a not-yet-received function call
627// result.
628template <typename ChannelT> class ResponseHandler {
629public:
virtual ~ResponseHandler() {}

// Reads the function result off the wire and acts on it. The meaning of
// "act" will depend on how this method is implemented in any given
// ResponseHandler subclass but could, for example, mean running a
// user-specified handler or setting a promise value.
virtual Error handleResponse(ChannelT &C) = 0;

// Abandons this outstanding result.
virtual void abandon() = 0;

// Create an error instance representing an abandoned response.
static Error createAbandonedResponseError() {
  return make_error<ResponseAbandoned>();
}
645};

647// ResponseHandler subclass for RPC functions with non-void returns.
648template <typename ChannelT, typename FuncRetT, typename HandlerT>
649class ResponseHandlerImpl : public ResponseHandler<ChannelT> {
650public:
ResponseHandlerImpl(HandlerT Handler) : Handler(std::move(Handler)) {}

// Handle the result by deserializing it from the channel then passing it
// to the user defined handler.
Error handleResponse(ChannelT &C) override {
  using UnwrappedArgType = typename ResponseHandlerArg<
      typename HandlerTraits<HandlerT>::Type>::UnwrappedArgType;
  UnwrappedArgType Result;
  if (auto Err =
          SerializationTraits<ChannelT, FuncRetT,
                              UnwrappedArgType>::deserialize(C, Result))
    return Err;
  if (auto Err = C.endReceiveMessage())
    return Err;
  return Handler(std::move(Result));
}

// Abandon this response by calling the handler with an 'abandoned response'
// error.
void abandon() override {
  if (auto Err = Handler(this->createAbandonedResponseError())) {
    // Handlers should not fail when passed an abandoned response error.
    report_fatal_error(std::move(Err));
  }
}

677private:
HandlerT Handler;
679};

681// ResponseHandler subclass for RPC functions with void returns.
682template <typename ChannelT, typename HandlerT>
683class ResponseHandlerImpl<ChannelT, void, HandlerT>
  : public ResponseHandler<ChannelT> {
685public:
ResponseHandlerImpl(HandlerT Handler) : Handler(std::move(Handler)) {}

// Handle the result (no actual value, just a notification that the function
// has completed on the remote end) by calling the user-defined handler with
// Error::success().
Error handleResponse(ChannelT &C) override {
  if (auto Err = C.endReceiveMessage())
    return Err;
  return Handler(Error::success());
}

// Abandon this response by calling the handler with an 'abandoned response'
// error.
void abandon() override {
  if (auto Err = Handler(this->createAbandonedResponseError())) {
    // Handlers should not fail when passed an abandoned response error.
    report_fatal_error(std::move(Err));
  }
}

706private:
HandlerT Handler;
708};

710template <typename ChannelT, typename FuncRetT, typename HandlerT>
711class ResponseHandlerImpl<ChannelT, Expected<FuncRetT>, HandlerT>
  : public ResponseHandler<ChannelT> {
713public:
ResponseHandlerImpl(HandlerT Handler) : Handler(std::move(Handler)) {}

// Handle the result by deserializing it from the channel then passing it
// to the user defined handler.
Error handleResponse(ChannelT &C) override {
  using HandlerArgType = typename ResponseHandlerArg<
      typename HandlerTraits<HandlerT>::Type>::ArgType;
  HandlerArgType Result((typename HandlerArgType::value_type()));

  if (auto Err =
          SerializationTraits<ChannelT, Expected<FuncRetT>,
                              HandlerArgType>::deserialize(C, Result))
    return Err;
  if (auto Err = C.endReceiveMessage())
    return Err;
  return Handler(std::move(Result));
}

// Abandon this response by calling the handler with an 'abandoned response'
// error.
void abandon() override {
  if (auto Err = Handler(this->createAbandonedResponseError())) {
    // Handlers should not fail when passed an abandoned response error.
    report_fatal_error(std::move(Err));
  }
}

741private:
HandlerT Handler;
743};

745template <typename ChannelT, typename HandlerT>
746class ResponseHandlerImpl<ChannelT, Error, HandlerT>
  : public ResponseHandler<ChannelT> {
748public:
ResponseHandlerImpl(HandlerT Handler) : Handler(std::move(Handler)) {}

// Handle the result by deserializing it from the channel then passing it
// to the user defined handler.
Error handleResponse(ChannelT &C) override {
  Error Result = Error::success();
  if (auto Err =
          SerializationTraits<ChannelT, Error, Error>::deserialize(C, Result))
    return Err;
  if (auto Err = C.endReceiveMessage())
    return Err;
  return Handler(std::move(Result));
}

// Abandon this response by calling the handler with an 'abandoned response'
// error.
void abandon() override {
  if (auto Err = Handler(this->createAbandonedResponseError())) {
    // Handlers should not fail when passed an abandoned response error.
    report_fatal_error(std::move(Err));
  }
}

772private:
HandlerT Handler;
774};

776// Create a ResponseHandler from a given user handler.
777template <typename ChannelT, typename FuncRetT, typename HandlerT>
778std::unique_ptr<ResponseHandler<ChannelT>> createResponseHandler(HandlerT H) {
return llvm::make_unique<ResponseHandlerImpl<ChannelT, FuncRetT, HandlerT>>(
    std::move(H));
781}

783// Helper for wrapping member functions up as functors. This is useful for
784// installing methods as result handlers.
785template <typename ClassT, typename RetT, typename... ArgTs>
786class MemberFnWrapper {
787public:
using MethodT = RetT (ClassT::*)(ArgTs...);
MemberFnWrapper(ClassT &Instance, MethodT Method)
    : Instance(Instance), Method(Method) {}
RetT operator()(ArgTs &&... Args) {
  return (Instance.*Method)(std::move(Args)...);
}

795private:
ClassT &Instance;
MethodT Method;
798};

800// Helper that provides a Functor for deserializing arguments.
801template <typename... ArgTs> class ReadArgs {
802public:
Error operator()() { return Error::success(); }
804};

806template <typename ArgT, typename... ArgTs>
807class ReadArgs<ArgT, ArgTs...> : public ReadArgs<ArgTs...> {
808public:
ReadArgs(ArgT &Arg, ArgTs &... Args)
    : ReadArgs<ArgTs...>(Args...), Arg(Arg) {}

Error operator()(ArgT &ArgVal, ArgTs &... ArgVals) {
  this->Arg = std::move(ArgVal);
  return ReadArgs<ArgTs...>::operator()(ArgVals...);
}

817private:
ArgT &Arg;
819};

821// Manage sequence numbers.
822template <typename SequenceNumberT> class SequenceNumberManager {
823public:
// Reset, making all sequence numbers available.
void reset() {
  std::lock_guard<std::mutex> Lock(SeqNoLock);
  NextSequenceNumber = 0;
  FreeSequenceNumbers.clear();
}

// Get the next available sequence number. Will re-use numbers that have
// been released.
SequenceNumberT getSequenceNumber() {
  std::lock_guard<std::mutex> Lock(SeqNoLock);
  if (FreeSequenceNumbers.empty())
    return NextSequenceNumber++;
  auto SequenceNumber = FreeSequenceNumbers.back();
  FreeSequenceNumbers.pop_back();
  return SequenceNumber;
}

// Release a sequence number, making it available for re-use.
void releaseSequenceNumber(SequenceNumberT SequenceNumber) {
  std::lock_guard<std::mutex> Lock(SeqNoLock);
  FreeSequenceNumbers.push_back(SequenceNumber);
}

848private:
std::mutex SeqNoLock;
SequenceNumberT NextSequenceNumber = 0;
std::vector<SequenceNumberT> FreeSequenceNumbers;
852};

854// Checks that predicate P holds for each corresponding pair of type arguments
855// from T1 and T2 tuple.
856template <template <class, class> class P, typename T1Tuple, typename T2Tuple>
857class RPCArgTypeCheckHelper;

859template <template <class, class> class P>
860class RPCArgTypeCheckHelper<P, std::tuple<>, std::tuple<>> {
861public:
static const bool value = true;
863};

865template <template <class, class> class P, typename T, typename... Ts,
        typename U, typename... Us>
867class RPCArgTypeCheckHelper<P, std::tuple<T, Ts...>, std::tuple<U, Us...>> {
868public:
static const bool value =
    P<T, U>::value &&
    RPCArgTypeCheckHelper<P, std::tuple<Ts...>, std::tuple<Us...>>::value;
872};

874template <template <class, class> class P, typename T1Sig, typename T2Sig>
875class RPCArgTypeCheck {
876public:
using T1Tuple = typename FunctionArgsTuple<T1Sig>::Type;
using T2Tuple = typename FunctionArgsTuple<T2Sig>::Type;

static_assert(std::tuple_size<T1Tuple>::value >=
                  std::tuple_size<T2Tuple>::value,
              "Too many arguments to RPC call");
static_assert(std::tuple_size<T1Tuple>::value <=
                  std::tuple_size<T2Tuple>::value,
              "Too few arguments to RPC call");

static const bool value = RPCArgTypeCheckHelper<P, T1Tuple, T2Tuple>::value;
888};

890template <typename ChannelT, typename WireT, typename ConcreteT>
891class CanSerialize {
892private:
using S = SerializationTraits<ChannelT, WireT, ConcreteT>;

template <typename T>
static std::true_type
check(typename std::enable_if<
      std::is_same<decltype(T::serialize(std::declval<ChannelT &>(),
                                         std::declval<const ConcreteT &>())),
                   Error>::value,
      void *>::type);

template <typename> static std::false_type check(...);

905public:
static const bool value = decltype(check<S>(0))::value;
907};

909template <typename ChannelT, typename WireT, typename ConcreteT>
910class CanDeserialize {
911private:
using S = SerializationTraits<ChannelT, WireT, ConcreteT>;

template <typename T>
static std::true_type
check(typename std::enable_if<
      std::is_same<decltype(T::deserialize(std::declval<ChannelT &>(),
                                           std::declval<ConcreteT &>())),
                   Error>::value,
      void *>::type);

template <typename> static std::false_type check(...);

924public:
static const bool value = decltype(check<S>(0))::value;
926};

928/// Contains primitive utilities for defining, calling and handling calls to
929/// remote procedures. ChannelT is a bidirectional stream conforming to the
930/// RPCChannel interface (see RPCChannel.h), FunctionIdT is a procedure
931/// identifier type that must be serializable on ChannelT, and SequenceNumberT
932/// is an integral type that will be used to number in-flight function calls.
933///
934/// These utilities support the construction of very primitive RPC utilities.
935/// Their intent is to ensure correct serialization and deserialization of
936/// procedure arguments, and to keep the client and server's view of the API in
937/// sync.
938template <typename ImplT, typename ChannelT, typename FunctionIdT,
        typename SequenceNumberT>
940class RPCEndpointBase {
941protected:
class OrcRPCInvalid : public Function<OrcRPCInvalid, void()> {
public:
  static const char *getName() { return "__orc_rpc$invalid"; }
};

class OrcRPCResponse : public Function<OrcRPCResponse, void()> {
public:
  static const char *getName() { return "__orc_rpc$response"; }
};

class OrcRPCNegotiate
    : public Function<OrcRPCNegotiate, FunctionIdT(std::string)> {
public:
  static const char *getName() { return "__orc_rpc$negotiate"; }
};

// Helper predicate for testing for the presence of SerializeTraits
// serializers.
template <typename WireT, typename ConcreteT>
class CanSerializeCheck : detail::CanSerialize<ChannelT, WireT, ConcreteT> {
public:
  using detail::CanSerialize<ChannelT, WireT, ConcreteT>::value;

  static_assert(value, "Missing serializer for argument (Can't serialize the "
                       "first template type argument of CanSerializeCheck "
                       "from the second)");
};

// Helper predicate for testing for the presence of SerializeTraits
// deserializers.
template <typename WireT, typename ConcreteT>
class CanDeserializeCheck
    : detail::CanDeserialize<ChannelT, WireT, ConcreteT> {
public:
  using detail::CanDeserialize<ChannelT, WireT, ConcreteT>::value;

  static_assert(value, "Missing deserializer for argument (Can't deserialize "
                       "the second template type argument of "
                       "CanDeserializeCheck from the first)");
};

983public:
/// Construct an RPC instance on a channel.
RPCEndpointBase(ChannelT &C, bool LazyAutoNegotiation)
    : C(C), LazyAutoNegotiation(LazyAutoNegotiation) {
  // Hold ResponseId in a special variable, since we expect Response to be
  // called relatively frequently, and want to avoid the map lookup.
  ResponseId = FnIdAllocator.getResponseId();
  RemoteFunctionIds[OrcRPCResponse::getPrototype()] = ResponseId;

  // Register the negotiate function id and handler.
  auto NegotiateId = FnIdAllocator.getNegotiateId();
  RemoteFunctionIds[OrcRPCNegotiate::getPrototype()] = NegotiateId;
  Handlers[NegotiateId] = wrapHandler<OrcRPCNegotiate>(
      [this](const std::string &Name) { return handleNegotiate(Name); });
}


/// Negotiate a function id for Func with the other end of the channel.
template <typename Func> Error negotiateFunction(bool Retry = false) {
  return getRemoteFunctionId<Func>(true, Retry).takeError();
}

/// Append a call Func, does not call send on the channel.
/// The first argument specifies a user-defined handler to be run when the
/// function returns. The handler should take an Expected<Func::ReturnType>,
/// or an Error (if Func::ReturnType is void). The handler will be called
/// with an error if the return value is abandoned due to a channel error.
template <typename Func, typename HandlerT, typename... ArgTs>
Error appendCallAsync(HandlerT Handler, const ArgTs &... Args) {

  static_assert(
      detail::RPCArgTypeCheck<CanSerializeCheck, typename Func::Type,
                              void(ArgTs...)>::value,
      "");

  // Look up the function ID.
  FunctionIdT FnId;
  if (auto FnIdOrErr = getRemoteFunctionId<Func>(LazyAutoNegotiation, false))
4
←
Calling 'RPCEndpointBase::getRemoteFunctionId'→
    FnId = *FnIdOrErr;
  else {
    // Negotiation failed. Notify the handler then return the negotiate-failed
    // error.
    cantFail(Handler(make_error<ResponseAbandoned>()));
    return FnIdOrErr.takeError();
  }

  SequenceNumberT SeqNo; // initialized in locked scope below.
  {
    // Lock the pending responses map and sequence number manager.
    std::lock_guard<std::mutex> Lock(ResponsesMutex);

    // Allocate a sequence number.
    SeqNo = SequenceNumberMgr.getSequenceNumber();
    assert(!PendingResponses.count(SeqNo) &&((!PendingResponses.count(SeqNo) && "Sequence number already allocated"
) ? static_cast<void> (0) : __assert_fail ("!PendingResponses.count(SeqNo) && \"Sequence number already allocated\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1037, __PRETTY_FUNCTION__))
           "Sequence number already allocated")((!PendingResponses.count(SeqNo) && "Sequence number already allocated"
) ? static_cast<void> (0) : __assert_fail ("!PendingResponses.count(SeqNo) && \"Sequence number already allocated\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1037, __PRETTY_FUNCTION__));

    // Install the user handler.
    PendingResponses[SeqNo] =
      detail::createResponseHandler<ChannelT, typename Func::ReturnType>(
          std::move(Handler));
  }

  // Open the function call message.
  if (auto Err = C.startSendMessage(FnId, SeqNo)) {
    abandonPendingResponses();
    return Err;
  }

  // Serialize the call arguments.
  if (auto Err = detail::HandlerTraits<typename Func::Type>::serializeArgs(
          C, Args...)) {
    abandonPendingResponses();
    return Err;
  }

  // Close the function call messagee.
  if (auto Err = C.endSendMessage()) {
    abandonPendingResponses();
    return Err;
  }

  return Error::success();
}

Error sendAppendedCalls() { return C.send(); };

template <typename Func, typename HandlerT, typename... ArgTs>
Error callAsync(HandlerT Handler, const ArgTs &... Args) {
  if (auto Err = appendCallAsync<Func>(std::move(Handler), Args...))
    return Err;
  return C.send();
}

/// Handle one incoming call.
Error handleOne() {
  FunctionIdT FnId;
  SequenceNumberT SeqNo;
  if (auto Err = C.startReceiveMessage(FnId, SeqNo)) {
    abandonPendingResponses();
    return Err;
  }
  if (FnId == ResponseId)
    return handleResponse(SeqNo);
  auto I = Handlers.find(FnId);
  if (I != Handlers.end())
    return I->second(C, SeqNo);

  // else: No handler found. Report error to client?
  return make_error<BadFunctionCall<FunctionIdT, SequenceNumberT>>(FnId,
                                                                   SeqNo);
}

/// Helper for handling setter procedures - this method returns a functor that
/// sets the variables referred to by Args... to values deserialized from the
/// channel.
/// E.g.
///
///   typedef Function<0, bool, int> Func1;
///
///   ...
///   bool B;
///   int I;
///   if (auto Err = expect<Func1>(Channel, readArgs(B, I)))
///     /* Handle Args */ ;
///
template <typename... ArgTs>
static detail::ReadArgs<ArgTs...> readArgs(ArgTs &... Args) {
  return detail::ReadArgs<ArgTs...>(Args...);
}

/// Abandon all outstanding result handlers.
///
/// This will call all currently registered result handlers to receive an
/// "abandoned" error as their argument. This is used internally by the RPC
/// in error situations, but can also be called directly by clients who are
/// disconnecting from the remote and don't or can't expect responses to their
/// outstanding calls. (Especially for outstanding blocking calls, calling
/// this function may be necessary to avoid dead threads).
void abandonPendingResponses() {
  // Lock the pending responses map and sequence number manager.
  std::lock_guard<std::mutex> Lock(ResponsesMutex);

  for (auto &KV : PendingResponses)
    KV.second->abandon();
  PendingResponses.clear();
  SequenceNumberMgr.reset();
}

/// Remove the handler for the given function.
/// A handler must currently be registered for this function.
template <typename Func>
void removeHandler() {
  auto IdItr = LocalFunctionIds.find(Func::getPrototype());
  assert(IdItr != LocalFunctionIds.end() &&((IdItr != LocalFunctionIds.end() && "Function does not have a registered handler"
) ? static_cast<void> (0) : __assert_fail ("IdItr != LocalFunctionIds.end() && \"Function does not have a registered handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1137, __PRETTY_FUNCTION__))
         "Function does not have a registered handler")((IdItr != LocalFunctionIds.end() && "Function does not have a registered handler"
) ? static_cast<void> (0) : __assert_fail ("IdItr != LocalFunctionIds.end() && \"Function does not have a registered handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1137, __PRETTY_FUNCTION__));
  auto HandlerItr = Handlers.find(IdItr->second);
  assert(HandlerItr != Handlers.end() &&((HandlerItr != Handlers.end() && "Function does not have a registered handler"
) ? static_cast<void> (0) : __assert_fail ("HandlerItr != Handlers.end() && \"Function does not have a registered handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1140, __PRETTY_FUNCTION__))
         "Function does not have a registered handler")((HandlerItr != Handlers.end() && "Function does not have a registered handler"
) ? static_cast<void> (0) : __assert_fail ("HandlerItr != Handlers.end() && \"Function does not have a registered handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1140, __PRETTY_FUNCTION__));
  Handlers.erase(HandlerItr);
}

/// Clear all handlers.
void clearHandlers() {
  Handlers.clear();
}

1149protected:

FunctionIdT getInvalidFunctionId() const {
  return FnIdAllocator.getInvalidId();
}

/// Add the given handler to the handler map and make it available for
/// autonegotiation and execution.
template <typename Func, typename HandlerT>
void addHandlerImpl(HandlerT Handler) {

  static_assert(detail::RPCArgTypeCheck<
                    CanDeserializeCheck, typename Func::Type,
                    typename detail::HandlerTraits<HandlerT>::Type>::value,
                "");

  FunctionIdT NewFnId = FnIdAllocator.template allocate<Func>();
  LocalFunctionIds[Func::getPrototype()] = NewFnId;
  Handlers[NewFnId] = wrapHandler<Func>(std::move(Handler));
}

template <typename Func, typename HandlerT>
void addAsyncHandlerImpl(HandlerT Handler) {

  static_assert(detail::RPCArgTypeCheck<
                    CanDeserializeCheck, typename Func::Type,
                    typename detail::AsyncHandlerTraits<
                      typename detail::HandlerTraits<HandlerT>::Type
                    >::Type>::value,
                "");

  FunctionIdT NewFnId = FnIdAllocator.template allocate<Func>();
  LocalFunctionIds[Func::getPrototype()] = NewFnId;
  Handlers[NewFnId] = wrapAsyncHandler<Func>(std::move(Handler));
}

Error handleResponse(SequenceNumberT SeqNo) {
  using Handler = typename decltype(PendingResponses)::mapped_type;
  Handler PRHandler;

  {
    // Lock the pending responses map and sequence number manager.
    std::unique_lock<std::mutex> Lock(ResponsesMutex);
    auto I = PendingResponses.find(SeqNo);

    if (I != PendingResponses.end()) {
      PRHandler = std::move(I->second);
      PendingResponses.erase(I);
      SequenceNumberMgr.releaseSequenceNumber(SeqNo);
    } else {
      // Unlock the pending results map to prevent recursive lock.
      Lock.unlock();
      abandonPendingResponses();
      return make_error<
               InvalidSequenceNumberForResponse<SequenceNumberT>>(SeqNo);
    }
  }

  assert(PRHandler &&((PRHandler && "If we didn't find a response handler we should have bailed out"
) ? static_cast<void> (0) : __assert_fail ("PRHandler && \"If we didn't find a response handler we should have bailed out\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1208, __PRETTY_FUNCTION__))
         "If we didn't find a response handler we should have bailed out")((PRHandler && "If we didn't find a response handler we should have bailed out"
) ? static_cast<void> (0) : __assert_fail ("PRHandler && \"If we didn't find a response handler we should have bailed out\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ExecutionEngine/Orc/RPCUtils.h"
, 1208, __PRETTY_FUNCTION__));

  if (auto Err = PRHandler->handleResponse(C)) {
    abandonPendingResponses();
    return Err;
  }

  return Error::success();
}

FunctionIdT handleNegotiate(const std::string &Name) {
  auto I = LocalFunctionIds.find(Name);
  if (I == LocalFunctionIds.end())
    return getInvalidFunctionId();
  return I->second;
}

// Find the remote FunctionId for the given function.
template <typename Func>
Expected<FunctionIdT> getRemoteFunctionId(bool NegotiateIfNotInMap,
                                          bool NegotiateIfInvalid) {
  bool DoNegotiate;

  // Check if we already have a function id...
  auto I = RemoteFunctionIds.find(Func::getPrototype());
  if (I != RemoteFunctionIds.end()) {
5
←
Assuming the condition is false→
6
←
Taking false branch→
    // If it's valid there's nothing left to do.
    if (I->second != getInvalidFunctionId())
      return I->second;
    DoNegotiate = NegotiateIfInvalid;
  } else
    DoNegotiate = NegotiateIfNotInMap;

  // We don't have a function id for Func yet, but we're allowed to try to
  // negotiate one.
  if (DoNegotiate) {
7
←
Assuming 'DoNegotiate' is 0→
8
←
Taking false branch→
    auto &Impl = static_cast<ImplT &>(*this);
    if (auto RemoteIdOrErr =
        Impl.template callB<OrcRPCNegotiate>(Func::getPrototype())) {
      RemoteFunctionIds[Func::getPrototype()] = *RemoteIdOrErr;
      if (*RemoteIdOrErr == getInvalidFunctionId())
        return make_error<CouldNotNegotiate>(Func::getPrototype());
      return *RemoteIdOrErr;
    } else
      return RemoteIdOrErr.takeError();
  }

  // No key was available in the map and we weren't allowed to try to
  // negotiate one, so return an unknown function error.
  return make_error<CouldNotNegotiate>(Func::getPrototype());
9
←
Calling 'make_error<llvm::orc::rpc::CouldNotNegotiate, const char *>'→
}

using WrappedHandlerFn = std::function<Error(ChannelT &, SequenceNumberT)>;

// Wrap the given user handler in the necessary argument-deserialization code,
// result-serialization code, and call to the launch policy (if present).
template <typename Func, typename HandlerT>
WrappedHandlerFn wrapHandler(HandlerT Handler) {
  return [this, Handler](ChannelT &Channel,
                         SequenceNumberT SeqNo) mutable -> Error {
    // Start by deserializing the arguments.
    using ArgsTuple =
        typename detail::FunctionArgsTuple<
          typename detail::HandlerTraits<HandlerT>::Type>::Type;
    auto Args = std::make_shared<ArgsTuple>();

    if (auto Err =
            detail::HandlerTraits<typename Func::Type>::deserializeArgs(
                Channel, *Args))
      return Err;

    // GCC 4.7 and 4.8 incorrectly issue a -Wunused-but-set-variable warning
    // for RPCArgs. Void cast RPCArgs to work around this for now.
    // FIXME: Remove this workaround once we can assume a working GCC version.
    (void)Args;

    // End receieve message, unlocking the channel for reading.
    if (auto Err = Channel.endReceiveMessage())
      return Err;

    using HTraits = detail::HandlerTraits<HandlerT>;
    using FuncReturn = typename Func::ReturnType;
    return detail::respond<FuncReturn>(Channel, ResponseId, SeqNo,
                                       HTraits::unpackAndRun(Handler, *Args));
  };
}

// Wrap the given user handler in the necessary argument-deserialization code,
// result-serialization code, and call to the launch policy (if present).
template <typename Func, typename HandlerT>
WrappedHandlerFn wrapAsyncHandler(HandlerT Handler) {
  return [this, Handler](ChannelT &Channel,
                         SequenceNumberT SeqNo) mutable -> Error {
    // Start by deserializing the arguments.
    using AHTraits = detail::AsyncHandlerTraits<
                       typename detail::HandlerTraits<HandlerT>::Type>;
    using ArgsTuple =
        typename detail::FunctionArgsTuple<typename AHTraits::Type>::Type;
    auto Args = std::make_shared<ArgsTuple>();

    if (auto Err =
            detail::HandlerTraits<typename Func::Type>::deserializeArgs(
                Channel, *Args))
      return Err;

    // GCC 4.7 and 4.8 incorrectly issue a -Wunused-but-set-variable warning
    // for RPCArgs. Void cast RPCArgs to work around this for now.
    // FIXME: Remove this workaround once we can assume a working GCC version.
    (void)Args;

    // End receieve message, unlocking the channel for reading.
    if (auto Err = Channel.endReceiveMessage())
      return Err;

    using HTraits = detail::HandlerTraits<HandlerT>;
    using FuncReturn = typename Func::ReturnType;
    auto Responder =
      [this, SeqNo](typename AHTraits::ResultType RetVal) -> Error {
        return detail::respond<FuncReturn>(C, ResponseId, SeqNo,
                                           std::move(RetVal));
      };

    return HTraits::unpackAndRunAsync(Handler, Responder, *Args);
  };
}

ChannelT &C;

bool LazyAutoNegotiation;

RPCFunctionIdAllocator<FunctionIdT> FnIdAllocator;

FunctionIdT ResponseId;
std::map<std::string, FunctionIdT> LocalFunctionIds;
std::map<const char *, FunctionIdT> RemoteFunctionIds;

std::map<FunctionIdT, WrappedHandlerFn> Handlers;

std::mutex ResponsesMutex;
detail::SequenceNumberManager<SequenceNumberT> SequenceNumberMgr;
std::map<SequenceNumberT, std::unique_ptr<detail::ResponseHandler<ChannelT>>>
    PendingResponses;
1350};

1352} // end namespace detail

1354template <typename ChannelT, typename FunctionIdT = uint32_t,
        typename SequenceNumberT = uint32_t>
1356class MultiThreadedRPCEndpoint
  : public detail::RPCEndpointBase<
        MultiThreadedRPCEndpoint<ChannelT, FunctionIdT, SequenceNumberT>,
        ChannelT, FunctionIdT, SequenceNumberT> {
1360private:
using BaseClass =
    detail::RPCEndpointBase<
      MultiThreadedRPCEndpoint<ChannelT, FunctionIdT, SequenceNumberT>,
      ChannelT, FunctionIdT, SequenceNumberT>;

1366public:
MultiThreadedRPCEndpoint(ChannelT &C, bool LazyAutoNegotiation)
    : BaseClass(C, LazyAutoNegotiation) {}

/// Add a handler for the given RPC function.
/// This installs the given handler functor for the given RPC Function, and
/// makes the RPC function available for negotiation/calling from the remote.
template <typename Func, typename HandlerT>
void addHandler(HandlerT Handler) {
  return this->template addHandlerImpl<Func>(std::move(Handler));
}

/// Add a class-method as a handler.
template <typename Func, typename ClassT, typename RetT, typename... ArgTs>
void addHandler(ClassT &Object, RetT (ClassT::*Method)(ArgTs...)) {
  addHandler<Func>(
    detail::MemberFnWrapper<ClassT, RetT, ArgTs...>(Object, Method));
}

template <typename Func, typename HandlerT>
void addAsyncHandler(HandlerT Handler) {
  return this->template addAsyncHandlerImpl<Func>(std::move(Handler));
}

/// Add a class-method as a handler.
template <typename Func, typename ClassT, typename RetT, typename... ArgTs>
void addAsyncHandler(ClassT &Object, RetT (ClassT::*Method)(ArgTs...)) {
  addAsyncHandler<Func>(
    detail::MemberFnWrapper<ClassT, RetT, ArgTs...>(Object, Method));
}

/// Return type for non-blocking call primitives.
template <typename Func>
using NonBlockingCallResult = typename detail::ResultTraits<
    typename Func::ReturnType>::ReturnFutureType;

/// Call Func on Channel C. Does not block, does not call send. Returns a pair
/// of a future result and the sequence number assigned to the result.
///
/// This utility function is primarily used for single-threaded mode support,
/// where the sequence number can be used to wait for the corresponding
/// result. In multi-threaded mode the appendCallNB method, which does not
/// return the sequence numeber, should be preferred.
template <typename Func, typename... ArgTs>
Expected<NonBlockingCallResult<Func>> appendCallNB(const ArgTs &... Args) {
  using RTraits = detail::ResultTraits<typename Func::ReturnType>;
  using ErrorReturn = typename RTraits::ErrorReturnType;
  using ErrorReturnPromise = typename RTraits::ReturnPromiseType;

  // FIXME: Stack allocate and move this into the handler once LLVM builds
  //        with C++14.
  auto Promise = std::make_shared<ErrorReturnPromise>();
  auto FutureResult = Promise->get_future();

  if (auto Err = this->template appendCallAsync<Func>(
          [Promise](ErrorReturn RetOrErr) {
            Promise->set_value(std::move(RetOrErr));
            return Error::success();
          },
          Args...)) {
    RTraits::consumeAbandoned(FutureResult.get());
    return std::move(Err);
  }
  return std::move(FutureResult);
}

/// The same as appendCallNBWithSeq, except that it calls C.send() to
/// flush the channel after serializing the call.
template <typename Func, typename... ArgTs>
Expected<NonBlockingCallResult<Func>> callNB(const ArgTs &... Args) {
  auto Result = appendCallNB<Func>(Args...);
  if (!Result)
    return Result;
  if (auto Err = this->C.send()) {
    this->abandonPendingResponses();
    detail::ResultTraits<typename Func::ReturnType>::consumeAbandoned(
        std::move(Result->get()));
    return std::move(Err);
  }
  return Result;
}

/// Call Func on Channel C. Blocks waiting for a result. Returns an Error
/// for void functions or an Expected<T> for functions returning a T.
///
/// This function is for use in threaded code where another thread is
/// handling responses and incoming calls.
template <typename Func, typename... ArgTs,
          typename AltRetT = typename Func::ReturnType>
typename detail::ResultTraits<AltRetT>::ErrorReturnType
callB(const ArgTs &... Args) {
  if (auto FutureResOrErr = callNB<Func>(Args...))
    return FutureResOrErr->get();
  else
    return FutureResOrErr.takeError();
}

/// Handle incoming RPC calls.
Error handlerLoop() {
  while (true)
    if (auto Err = this->handleOne())
      return Err;
  return Error::success();
}
1470};

1472template <typename ChannelT, typename FunctionIdT = uint32_t,
        typename SequenceNumberT = uint32_t>
1474class SingleThreadedRPCEndpoint
  : public detail::RPCEndpointBase<
        SingleThreadedRPCEndpoint<ChannelT, FunctionIdT, SequenceNumberT>,
        ChannelT, FunctionIdT, SequenceNumberT> {
1478private:
using BaseClass =
    detail::RPCEndpointBase<
      SingleThreadedRPCEndpoint<ChannelT, FunctionIdT, SequenceNumberT>,
      ChannelT, FunctionIdT, SequenceNumberT>;

1484public:
SingleThreadedRPCEndpoint(ChannelT &C, bool LazyAutoNegotiation)
    : BaseClass(C, LazyAutoNegotiation) {}

template <typename Func, typename HandlerT>
void addHandler(HandlerT Handler) {
  return this->template addHandlerImpl<Func>(std::move(Handler));
}

template <typename Func, typename ClassT, typename RetT, typename... ArgTs>
void addHandler(ClassT &Object, RetT (ClassT::*Method)(ArgTs...)) {
  addHandler<Func>(
      detail::MemberFnWrapper<ClassT, RetT, ArgTs...>(Object, Method));
}

template <typename Func, typename HandlerT>
void addAsyncHandler(HandlerT Handler) {
  return this->template addAsyncHandlerImpl<Func>(std::move(Handler));
}

/// Add a class-method as a handler.
template <typename Func, typename ClassT, typename RetT, typename... ArgTs>
void addAsyncHandler(ClassT &Object, RetT (ClassT::*Method)(ArgTs...)) {
  addAsyncHandler<Func>(
    detail::MemberFnWrapper<ClassT, RetT, ArgTs...>(Object, Method));
}

template <typename Func, typename... ArgTs,
          typename AltRetT = typename Func::ReturnType>
typename detail::ResultTraits<AltRetT>::ErrorReturnType
callB(const ArgTs &... Args) {
  bool ReceivedResponse = false;
  using ResultType = typename detail::ResultTraits<AltRetT>::ErrorReturnType;
  auto Result = detail::ResultTraits<AltRetT>::createBlankErrorReturnValue();

  // We have to 'Check' result (which we know is in a success state at this
  // point) so that it can be overwritten in the async handler.
  (void)!!Result;

  if (auto Err = this->template appendCallAsync<Func>(
3
←
Calling 'RPCEndpointBase::appendCallAsync'→
          [&](ResultType R) {
            Result = std::move(R);
            ReceivedResponse = true;
            return Error::success();
          },
          Args...)) {
    detail::ResultTraits<typename Func::ReturnType>::consumeAbandoned(
        std::move(Result));
    return std::move(Err);
  }

  while (!ReceivedResponse) {
    if (auto Err = this->handleOne()) {
      detail::ResultTraits<typename Func::ReturnType>::consumeAbandoned(
          std::move(Result));
      return std::move(Err);
    }
  }

  return Result;
}
1545};

1547/// Asynchronous dispatch for a function on an RPC endpoint.
1548template <typename RPCClass, typename Func>
1549class RPCAsyncDispatch {
1550public:
RPCAsyncDispatch(RPCClass &Endpoint) : Endpoint(Endpoint) {}

template <typename HandlerT, typename... ArgTs>
Error operator()(HandlerT Handler, const ArgTs &... Args) const {
  return Endpoint.template appendCallAsync<Func>(std::move(Handler), Args...);
}

1558private:
RPCClass &Endpoint;
1560};

1562/// Construct an asynchronous dispatcher from an RPC endpoint and a Func.
1563template <typename Func, typename RPCEndpointT>
1564RPCAsyncDispatch<RPCEndpointT, Func> rpcAsyncDispatch(RPCEndpointT &Endpoint) {
return RPCAsyncDispatch<RPCEndpointT, Func>(Endpoint);
1566}

1568/// Allows a set of asynchrounous calls to be dispatched, and then
1569///        waited on as a group.
1570class ParallelCallGroup {
1571public:

ParallelCallGroup() = default;
ParallelCallGroup(const ParallelCallGroup &) = delete;
ParallelCallGroup &operator=(const ParallelCallGroup &) = delete;

/// Make as asynchronous call.
template <typename AsyncDispatcher, typename HandlerT, typename... ArgTs>
Error call(const AsyncDispatcher &AsyncDispatch, HandlerT Handler,
           const ArgTs &... Args) {
  // Increment the count of outstanding calls. This has to happen before
  // we invoke the call, as the handler may (depending on scheduling)
  // be run immediately on another thread, and we don't want the decrement
  // in the wrapped handler below to run before the increment.
  {
    std::unique_lock<std::mutex> Lock(M);
    ++NumOutstandingCalls;
  }

  // Wrap the user handler in a lambda that will decrement the
  // outstanding calls count, then poke the condition variable.
  using ArgType = typename detail::ResponseHandlerArg<
      typename detail::HandlerTraits<HandlerT>::Type>::ArgType;
  // FIXME: Move handler into wrapped handler once we have C++14.
  auto WrappedHandler = [this, Handler](ArgType Arg) {
    auto Err = Handler(std::move(Arg));
    std::unique_lock<std::mutex> Lock(M);
    --NumOutstandingCalls;
    CV.notify_all();
    return Err;
  };

  return AsyncDispatch(std::move(WrappedHandler), Args...);
}

/// Blocks until all calls have been completed and their return value
///        handlers run.
void wait() {
  std::unique_lock<std::mutex> Lock(M);
  while (NumOutstandingCalls > 0)
    CV.wait(Lock);
}

1614private:
std::mutex M;
std::condition_variable CV;
uint32_t NumOutstandingCalls = 0;
1618};

1620/// Convenience class for grouping RPC Functions into APIs that can be
1621///        negotiated as a block.
1622///
1623template <typename... Funcs>
1624class APICalls {
1625public:

/// Test whether this API contains Function F.
template <typename F>
class Contains {
public:
  static const bool value = false;
};

/// Negotiate all functions in this API.
template <typename RPCEndpoint>
static Error negotiate(RPCEndpoint &R) {
  return Error::success();
}
1639};

1641template <typename Func, typename... Funcs>
1642class APICalls<Func, Funcs...> {
1643public:

template <typename F>
class Contains {
public:
  static const bool value = std::is_same<F, Func>::value |
                            APICalls<Funcs...>::template Contains<F>::value;
};

template <typename RPCEndpoint>
static Error negotiate(RPCEndpoint &R) {
  if (auto Err = R.template negotiateFunction<Func>())
    return Err;
  return APICalls<Funcs...>::negotiate(R);
}

1659};

1661template <typename... InnerFuncs, typename... Funcs>
1662class APICalls<APICalls<InnerFuncs...>, Funcs...> {
1663public:

template <typename F>
class Contains {
public:
  static const bool value =
    APICalls<InnerFuncs...>::template Contains<F>::value |
    APICalls<Funcs...>::template Contains<F>::value;
};

template <typename RPCEndpoint>
static Error negotiate(RPCEndpoint &R) {
  if (auto Err = APICalls<InnerFuncs...>::negotiate(R))
    return Err;
  return APICalls<Funcs...>::negotiate(R);
}

1680};

1682} // end namespace rpc
1683} // end namespace orc
1684} // end namespace llvm

1686#endif

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h

→

1//===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines an API used to report recoverable errors.
11//
12//===----------------------------------------------------------------------===//
13 
14#ifndef LLVM_SUPPORT_ERROR_H
15#define LLVM_SUPPORT_ERROR_H
16 
17#include "llvm-c/Error.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/ADT/StringExtras.h"
21#include "llvm/ADT/Twine.h"
22#include "llvm/Config/abi-breaking.h"
23#include "llvm/Support/AlignOf.h"
24#include "llvm/Support/Compiler.h"
25#include "llvm/Support/Debug.h"
26#include "llvm/Support/ErrorHandling.h"
27#include "llvm/Support/ErrorOr.h"
28#include "llvm/Support/Format.h"
29#include "llvm/Support/raw_ostream.h"
30#include <algorithm>
31#include <cassert>
32#include <cstdint>
33#include <cstdlib>
34#include <functional>
35#include <memory>
36#include <new>
37#include <string>
38#include <system_error>
39#include <type_traits>
40#include <utility>
41#include <vector>
42 
43namespace llvm {
44 
45class ErrorSuccess;
46 
47/// Base class for error info classes. Do not extend this directly: Extend
48/// the ErrorInfo template subclass instead.
49class ErrorInfoBase {
50public:
51  virtual ~ErrorInfoBase() = default;
52 
53  /// Print an error message to an output stream.
54  virtual void log(raw_ostream &OS) const = 0;
55 
56  /// Return the error message as a string.
57  virtual std::string message() const {
58    std::string Msg;
59    raw_string_ostream OS(Msg);
60    log(OS);
61    return OS.str();
62  }
63 
64  /// Convert this error to a std::error_code.
65  ///
66  /// This is a temporary crutch to enable interaction with code still
67  /// using std::error_code. It will be removed in the future.
68  virtual std::error_code convertToErrorCode() const = 0;
69 
70  // Returns the class ID for this type.
71  static const void *classID() { return &ID; }
72 
73  // Returns the class ID for the dynamic type of this ErrorInfoBase instance.
74  virtual const void *dynamicClassID() const = 0;
75 
76  // Check whether this instance is a subclass of the class identified by
77  // ClassID.
78  virtual bool isA(const void *const ClassID) const {
79    return ClassID == classID();
80  }
81 
82  // Check whether this instance is a subclass of ErrorInfoT.
83  template <typename ErrorInfoT> bool isA() const {
84    return isA(ErrorInfoT::classID());
85  }
86 
87private:
88  virtual void anchor();
89 
90  static char ID;
91};
92 
93/// Lightweight error class with error context and mandatory checking.
94///
95/// Instances of this class wrap a ErrorInfoBase pointer. Failure states
96/// are represented by setting the pointer to a ErrorInfoBase subclass
97/// instance containing information describing the failure. Success is
98/// represented by a null pointer value.
99///
100/// Instances of Error also contains a 'Checked' flag, which must be set
101/// before the destructor is called, otherwise the destructor will trigger a
102/// runtime error. This enforces at runtime the requirement that all Error
103/// instances be checked or returned to the caller.
104///
105/// There are two ways to set the checked flag, depending on what state the
106/// Error instance is in. For Error instances indicating success, it
107/// is sufficient to invoke the boolean conversion operator. E.g.:
108///
109///   @code{.cpp}
110///   Error foo(<...>);
111///
112///   if (auto E = foo(<...>))
113///     return E; // <- Return E if it is in the error state.
114///   // We have verified that E was in the success state. It can now be safely
115///   // destroyed.
116///   @endcode
117///
118/// A success value *can not* be dropped. For example, just calling 'foo(<...>)'
119/// without testing the return value will raise a runtime error, even if foo
120/// returns success.
121///
122/// For Error instances representing failure, you must use either the
123/// handleErrors or handleAllErrors function with a typed handler. E.g.:
124///
125///   @code{.cpp}
126///   class MyErrorInfo : public ErrorInfo<MyErrorInfo> {
127///     // Custom error info.
128///   };
129///
130///   Error foo(<...>) { return make_error<MyErrorInfo>(...); }
131///
132///   auto E = foo(<...>); // <- foo returns failure with MyErrorInfo.
133///   auto NewE =
134///     handleErrors(E,
135///       [](const MyErrorInfo &M) {
136///         // Deal with the error.
137///       },
138///       [](std::unique_ptr<OtherError> M) -> Error {
139///         if (canHandle(*M)) {
140///           // handle error.
141///           return Error::success();
142///         }
143///         // Couldn't handle this error instance. Pass it up the stack.
144///         return Error(std::move(M));
145///       );
146///   // Note - we must check or return NewE in case any of the handlers
147///   // returned a new error.
148///   @endcode
149///
150/// The handleAllErrors function is identical to handleErrors, except
151/// that it has a void return type, and requires all errors to be handled and
152/// no new errors be returned. It prevents errors (assuming they can all be
153/// handled) from having to be bubbled all the way to the top-level.
154///
155/// *All* Error instances must be checked before destruction, even if
156/// they're moved-assigned or constructed from Success values that have already
157/// been checked. This enforces checking through all levels of the call stack.
158class LLVM_NODISCARD[[clang::warn_unused_result]] Error {
159  // Both ErrorList and FileError need to be able to yank ErrorInfoBase
160  // pointers out of this class to add to the error list.
161  friend class ErrorList;
162  friend class FileError;
163 
164  // handleErrors needs to be able to set the Checked flag.
165  template <typename... HandlerTs>
166  friend Error handleErrors(Error E, HandlerTs &&... Handlers);
167 
168  // Expected<T> needs to be able to steal the payload when constructed from an
169  // error.
170  template <typename T> friend class Expected;
171 
172  // wrap needs to be able to steal the payload.
173  friend LLVMErrorRef wrap(Error);
174 
175protected:
176  /// Create a success value. Prefer using 'Error::success()' for readability
177  Error() {
178    setPtr(nullptr);
179    setChecked(false);
180  }
181 
182public:
183  /// Create a success value.
184  static ErrorSuccess success();
185 
186  // Errors are not copy-constructable.
187  Error(const Error &Other) = delete;
188 
189  /// Move-construct an error value. The newly constructed error is considered
190  /// unchecked, even if the source error had been checked. The original error
191  /// becomes a checked Success value, regardless of its original state.
192  Error(Error &&Other) {
193    setChecked(true);
194    *this = std::move(Other);
195  }
196 
197  /// Create an error value. Prefer using the 'make_error' function, but
198  /// this constructor can be useful when "re-throwing" errors from handlers.
199  Error(std::unique_ptr<ErrorInfoBase> Payload) {
200    setPtr(Payload.release());
201    setChecked(false);
14
←
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'
202  }
203 
204  // Errors are not copy-assignable.
205  Error &operator=(const Error &Other) = delete;
206 
207  /// Move-assign an error value. The current error must represent success, you
208  /// you cannot overwrite an unhandled error. The current error is then
209  /// considered unchecked. The source error becomes a checked success value,
210  /// regardless of its original state.
211  Error &operator=(Error &&Other) {
212    // Don't allow overwriting of unchecked values.
213    assertIsChecked();
214    setPtr(Other.getPtr());
215 
216    // This Error is unchecked, even if the source error was checked.
217    setChecked(false);
218 
219    // Null out Other's payload and set its checked bit.
220    Other.setPtr(nullptr);
221    Other.setChecked(true);
222 
223    return *this;
224  }
225 
226  /// Destroy a Error. Fails with a call to abort() if the error is
227  /// unchecked.
228  ~Error() {
229    assertIsChecked();
230    delete getPtr();
231  }
232 
233  /// Bool conversion. Returns true if this Error is in a failure state,
234  /// and false if it is in an accept state. If the error is in a Success state
235  /// it will be considered checked.
236  explicit operator bool() {
237    setChecked(getPtr() == nullptr);
238    return getPtr() != nullptr;
239  }
240 
241  /// Check whether one error is a subclass of another.
242  template <typename ErrT> bool isA() const {
243    return getPtr() && getPtr()->isA(ErrT::classID());
244  }
245 
246  /// Returns the dynamic class id of this error, or null if this is a success
247  /// value.
248  const void* dynamicClassID() const {
249    if (!getPtr())
250      return nullptr;
251    return getPtr()->dynamicClassID();
252  }
253 
254private:
255#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
256  // assertIsChecked() happens very frequently, but under normal circumstances
257  // is supposed to be a no-op.  So we want it to be inlined, but having a bunch
258  // of debug prints can cause the function to be too large for inlining.  So
259  // it's important that we define this function out of line so that it can't be
260  // inlined.
261  LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
262  void fatalUncheckedError() const;
263#endif
264 
265  void assertIsChecked() {
266#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
267    if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
268      fatalUncheckedError();
269#endif
270  }
271 
272  ErrorInfoBase *getPtr() const {
273    return reinterpret_cast<ErrorInfoBase*>(
274             reinterpret_cast<uintptr_t>(Payload) &
275             ~static_cast<uintptr_t>(0x1));
276  }
277 
278  void setPtr(ErrorInfoBase *EI) {
279#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
280    Payload = reinterpret_cast<ErrorInfoBase*>(
281                (reinterpret_cast<uintptr_t>(EI) &
282                 ~static_cast<uintptr_t>(0x1)) |
283                (reinterpret_cast<uintptr_t>(Payload) & 0x1));
284#else
285    Payload = EI;
286#endif
287  }
288 
289  bool getChecked() const {
290#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
291    return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
292#else
293    return true;
294#endif
295  }
296 
297  void setChecked(bool V) {
298    Payload = reinterpret_cast<ErrorInfoBase*>(
299                (reinterpret_cast<uintptr_t>(Payload) &
300                  ~static_cast<uintptr_t>(0x1)) |
301                  (V ? 0 : 1));
302  }
303 
304  std::unique_ptr<ErrorInfoBase> takePayload() {
305    std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
306    setPtr(nullptr);
307    setChecked(true);
308    return Tmp;
309  }
310 
311  friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
312    if (auto P = E.getPtr())
313      P->log(OS);
314    else
315      OS << "success";
316    return OS;
317  }
318 
319  ErrorInfoBase *Payload = nullptr;
320};
321 
322/// Subclass of Error for the sole purpose of identifying the success path in
323/// the type system. This allows to catch invalid conversion to Expected<T> at
324/// compile time.
325class ErrorSuccess final : public Error {};
326 
327inline ErrorSuccess Error::success() { return ErrorSuccess(); }
328 
329/// Make a Error instance representing failure using the given error info
330/// type.
331template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
332  return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
10
←
Calling 'make_unique<llvm::orc::rpc::CouldNotNegotiate, const char *>'→
12
←
Returned allocated memory→
13
←
Calling constructor for 'Error'→
333}
334 
335/// Base class for user error types. Users should declare their error types
336/// like:
337///
338/// class MyError : public ErrorInfo<MyError> {
339///   ....
340/// };
341///
342/// This class provides an implementation of the ErrorInfoBase::kind
343/// method, which is used by the Error RTTI system.
344template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
345class ErrorInfo : public ParentErrT {
346public:
347  using ParentErrT::ParentErrT; // inherit constructors
348 
349  static const void *classID() { return &ThisErrT::ID; }
350 
351  const void *dynamicClassID() const override { return &ThisErrT::ID; }
352 
353  bool isA(const void *const ClassID) const override {
354    return ClassID == classID() || ParentErrT::isA(ClassID);
355  }
356};
357 
358/// Special ErrorInfo subclass representing a list of ErrorInfos.
359/// Instances of this class are constructed by joinError.
360class ErrorList final : public ErrorInfo<ErrorList> {
361  // handleErrors needs to be able to iterate the payload list of an
362  // ErrorList.
363  template <typename... HandlerTs>
364  friend Error handleErrors(Error E, HandlerTs &&... Handlers);
365 
366  // joinErrors is implemented in terms of join.
367  friend Error joinErrors(Error, Error);
368 
369public:
370  void log(raw_ostream &OS) const override {
371    OS << "Multiple errors:\n";
372    for (auto &ErrPayload : Payloads) {
373      ErrPayload->log(OS);
374      OS << "\n";
375    }
376  }
377 
378  std::error_code convertToErrorCode() const override;
379 
380  // Used by ErrorInfo::classID.
381  static char ID;
382 
383private:
384  ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
385            std::unique_ptr<ErrorInfoBase> Payload2) {
386    assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 387, __PRETTY_FUNCTION__))
387           "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 387, __PRETTY_FUNCTION__));
388    Payloads.push_back(std::move(Payload1));
389    Payloads.push_back(std::move(Payload2));
390  }
391 
392  static Error join(Error E1, Error E2) {
393    if (!E1)
394      return E2;
395    if (!E2)
396      return E1;
397    if (E1.isA<ErrorList>()) {
398      auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
399      if (E2.isA<ErrorList>()) {
400        auto E2Payload = E2.takePayload();
401        auto &E2List = static_cast<ErrorList &>(*E2Payload);
402        for (auto &Payload : E2List.Payloads)
403          E1List.Payloads.push_back(std::move(Payload));
404      } else
405        E1List.Payloads.push_back(E2.takePayload());
406 
407      return E1;
408    }
409    if (E2.isA<ErrorList>()) {
410      auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
411      E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
412      return E2;
413    }
414    return Error(std::unique_ptr<ErrorList>(
415        new ErrorList(E1.takePayload(), E2.takePayload())));
416  }
417 
418  std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
419};
420 
421/// Concatenate errors. The resulting Error is unchecked, and contains the
422/// ErrorInfo(s), if any, contained in E1, followed by the
423/// ErrorInfo(s), if any, contained in E2.
424inline Error joinErrors(Error E1, Error E2) {
425  return ErrorList::join(std::move(E1), std::move(E2));
426}
427 
428/// Tagged union holding either a T or a Error.
429///
430/// This class parallels ErrorOr, but replaces error_code with Error. Since
431/// Error cannot be copied, this class replaces getError() with
432/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
433/// error class type.
434template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
435  template <class T1> friend class ExpectedAsOutParameter;
436  template <class OtherT> friend class Expected;
437 
438  static const bool isRef = std::is_reference<T>::value;
439 
440  using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>;
441 
442  using error_type = std::unique_ptr<ErrorInfoBase>;
443 
444public:
445  using storage_type = typename std::conditional<isRef, wrap, T>::type;
446  using value_type = T;
447 
448private:
449  using reference = typename std::remove_reference<T>::type &;
450  using const_reference = const typename std::remove_reference<T>::type &;
451  using pointer = typename std::remove_reference<T>::type *;
452  using const_pointer = const typename std::remove_reference<T>::type *;
453 
454public:
455  /// Create an Expected<T> error value from the given Error.
456  Expected(Error Err)
457      : HasError(true)
458#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
459        // Expected is unchecked upon construction in Debug builds.
460        , Unchecked(true)
461#endif
462  {
463    assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value."
) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 463, __PRETTY_FUNCTION__));
464    new (getErrorStorage()) error_type(Err.takePayload());
465  }
466 
467  /// Forbid to convert from Error::success() implicitly, this avoids having
468  /// Expected<T> foo() { return Error::success(); } which compiles otherwise
469  /// but triggers the assertion above.
470  Expected(ErrorSuccess) = delete;
471 
472  /// Create an Expected<T> success value from the given OtherT value, which
473  /// must be convertible to T.
474  template <typename OtherT>
475  Expected(OtherT &&Val,
476           typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
477               * = nullptr)
478      : HasError(false)
479#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
480        // Expected is unchecked upon construction in Debug builds.
481        , Unchecked(true)
482#endif
483  {
484    new (getStorage()) storage_type(std::forward<OtherT>(Val));
485  }
486 
487  /// Move construct an Expected<T> value.
488  Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
489 
490  /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
491  /// must be convertible to T.
492  template <class OtherT>
493  Expected(Expected<OtherT> &&Other,
494           typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
495               * = nullptr) {
496    moveConstruct(std::move(Other));
497  }
498 
499  /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
500  /// isn't convertible to T.
501  template <class OtherT>
502  explicit Expected(
503      Expected<OtherT> &&Other,
504      typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * =
505          nullptr) {
506    moveConstruct(std::move(Other));
507  }
508 
509  /// Move-assign from another Expected<T>.
510  Expected &operator=(Expected &&Other) {
511    moveAssign(std::move(Other));
512    return *this;
513  }
514 
515  /// Destroy an Expected<T>.
516  ~Expected() {
517    assertIsChecked();
518    if (!HasError)
519      getStorage()->~storage_type();
520    else
521      getErrorStorage()->~error_type();
522  }
523 
524  /// Return false if there is an error.
525  explicit operator bool() {
526#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
527    Unchecked = HasError;
528#endif
529    return !HasError;
530  }
531 
532  /// Returns a reference to the stored T value.
533  reference get() {
534    assertIsChecked();
535    return *getStorage();
536  }
537 
538  /// Returns a const reference to the stored T value.
539  const_reference get() const {
540    assertIsChecked();
541    return const_cast<Expected<T> *>(this)->get();
542  }
543 
544  /// Check that this Expected<T> is an error of type ErrT.
545  template <typename ErrT> bool errorIsA() const {
546    return HasError && (*getErrorStorage())->template isA<ErrT>();
547  }
548 
549  /// Take ownership of the stored error.
550  /// After calling this the Expected<T> is in an indeterminate state that can
551  /// only be safely destructed. No further calls (beside the destructor) should
552  /// be made on the Expected<T> vaule.
553  Error takeError() {
554#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
555    Unchecked = false;
556#endif
557    return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
558  }
559 
560  /// Returns a pointer to the stored T value.
561  pointer operator->() {
562    assertIsChecked();
563    return toPointer(getStorage());
564  }
565 
566  /// Returns a const pointer to the stored T value.
567  const_pointer operator->() const {
568    assertIsChecked();
569    return toPointer(getStorage());
570  }
571 
572  /// Returns a reference to the stored T value.
573  reference operator*() {
574    assertIsChecked();
575    return *getStorage();
576  }
577 
578  /// Returns a const reference to the stored T value.
579  const_reference operator*() const {
580    assertIsChecked();
581    return *getStorage();
582  }
583 
584private:
585  template <class T1>
586  static bool compareThisIfSameType(const T1 &a, const T1 &b) {
587    return &a == &b;
588  }
589 
590  template <class T1, class T2>
591  static bool compareThisIfSameType(const T1 &a, const T2 &b) {
592    return false;
593  }
594 
595  template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
596    HasError = Other.HasError;
597#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
598    Unchecked = true;
599    Other.Unchecked = false;
600#endif
601 
602    if (!HasError)
603      new (getStorage()) storage_type(std::move(*Other.getStorage()));
604    else
605      new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
606  }
607 
608  template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
609    assertIsChecked();
610 
611    if (compareThisIfSameType(*this, Other))
612      return;
613 
614    this->~Expected();
615    new (this) Expected(std::move(Other));
616  }
617 
618  pointer toPointer(pointer Val) { return Val; }
619 
620  const_pointer toPointer(const_pointer Val) const { return Val; }
621 
622  pointer toPointer(wrap *Val) { return &Val->get(); }
623 
624  const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
625 
626  storage_type *getStorage() {
627    assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 627, __PRETTY_FUNCTION__));
628    return reinterpret_cast<storage_type *>(TStorage.buffer);
629  }
630 
631  const storage_type *getStorage() const {
632    assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 632, __PRETTY_FUNCTION__));
633    return reinterpret_cast<const storage_type *>(TStorage.buffer);
634  }
635 
636  error_type *getErrorStorage() {
637    assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 637, __PRETTY_FUNCTION__));
638    return reinterpret_cast<error_type *>(ErrorStorage.buffer);
639  }
640 
641  const error_type *getErrorStorage() const {
642    assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 642, __PRETTY_FUNCTION__));
643    return reinterpret_cast<const error_type *>(ErrorStorage.buffer);
644  }
645 
646  // Used by ExpectedAsOutParameter to reset the checked flag.
647  void setUnchecked() {
648#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
649    Unchecked = true;
650#endif
651  }
652 
653#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
654  LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
655  LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline))
656  void fatalUncheckedExpected() const {
657    dbgs() << "Expected<T> must be checked before access or destruction.\n";
658    if (HasError) {
659      dbgs() << "Unchecked Expected<T> contained error:\n";
660      (*getErrorStorage())->log(dbgs());
661    } else
662      dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
663                "values in success mode must still be checked prior to being "
664                "destroyed).\n";
665    abort();
666  }
667#endif
668 
669  void assertIsChecked() {
670#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
671    if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
672      fatalUncheckedExpected();
673#endif
674  }
675 
676  union {
677    AlignedCharArrayUnion<storage_type> TStorage;
678    AlignedCharArrayUnion<error_type> ErrorStorage;
679  };
680  bool HasError : 1;
681#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
682  bool Unchecked : 1;
683#endif
684};
685 
686/// Report a serious error, calling any installed error handler. See
687/// ErrorHandling.h.
688LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err,
689                                                bool gen_crash_diag = true);
690 
691/// Report a fatal error if Err is a failure value.
692///
693/// This function can be used to wrap calls to fallible functions ONLY when it
694/// is known that the Error will always be a success value. E.g.
695///
696///   @code{.cpp}
697///   // foo only attempts the fallible operation if DoFallibleOperation is
698///   // true. If DoFallibleOperation is false then foo always returns
699///   // Error::success().
700///   Error foo(bool DoFallibleOperation);
701///
702///   cantFail(foo(false));
703///   @endcode
704inline void cantFail(Error Err, const char *Msg = nullptr) {
705  if (Err) {
706    if (!Msg)
707      Msg = "Failure value returned from cantFail wrapped call";
708    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 708);
709  }
710}
711 
712/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
713/// returns the contained value.
714///
715/// This function can be used to wrap calls to fallible functions ONLY when it
716/// is known that the Error will always be a success value. E.g.
717///
718///   @code{.cpp}
719///   // foo only attempts the fallible operation if DoFallibleOperation is
720///   // true. If DoFallibleOperation is false then foo always returns an int.
721///   Expected<int> foo(bool DoFallibleOperation);
722///
723///   int X = cantFail(foo(false));
724///   @endcode
725template <typename T>
726T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
727  if (ValOrErr)
728    return std::move(*ValOrErr);
729  else {
730    if (!Msg)
731      Msg = "Failure value returned from cantFail wrapped call";
732    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 732);
733  }
734}
735 
736/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
737/// returns the contained reference.
738///
739/// This function can be used to wrap calls to fallible functions ONLY when it
740/// is known that the Error will always be a success value. E.g.
741///
742///   @code{.cpp}
743///   // foo only attempts the fallible operation if DoFallibleOperation is
744///   // true. If DoFallibleOperation is false then foo always returns a Bar&.
745///   Expected<Bar&> foo(bool DoFallibleOperation);
746///
747///   Bar &X = cantFail(foo(false));
748///   @endcode
749template <typename T>
750T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
751  if (ValOrErr)
752    return *ValOrErr;
753  else {
754    if (!Msg)
755      Msg = "Failure value returned from cantFail wrapped call";
756    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 756);
757  }
758}
759 
760/// Helper for testing applicability of, and applying, handlers for
761/// ErrorInfo types.
762template <typename HandlerT>
763class ErrorHandlerTraits
764    : public ErrorHandlerTraits<decltype(
765          &std::remove_reference<HandlerT>::type::operator())> {};
766 
767// Specialization functions of the form 'Error (const ErrT&)'.
768template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
769public:
770  static bool appliesTo(const ErrorInfoBase &E) {
771    return E.template isA<ErrT>();
772  }
773 
774  template <typename HandlerT>
775  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
776    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 776, __PRETTY_FUNCTION__));
777    return H(static_cast<ErrT &>(*E));
778  }
779};
780 
781// Specialization functions of the form 'void (const ErrT&)'.
782template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
783public:
784  static bool appliesTo(const ErrorInfoBase &E) {
785    return E.template isA<ErrT>();
786  }
787 
788  template <typename HandlerT>
789  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
790    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 790, __PRETTY_FUNCTION__));
791    H(static_cast<ErrT &>(*E));
792    return Error::success();
793  }
794};
795 
796/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
797template <typename ErrT>
798class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
799public:
800  static bool appliesTo(const ErrorInfoBase &E) {
801    return E.template isA<ErrT>();
802  }
803 
804  template <typename HandlerT>
805  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
806    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 806, __PRETTY_FUNCTION__));
807    std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
808    return H(std::move(SubE));
809  }
810};
811 
812/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
813template <typename ErrT>
814class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
815public:
816  static bool appliesTo(const ErrorInfoBase &E) {
817    return E.template isA<ErrT>();
818  }
819 
820  template <typename HandlerT>
821  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
822    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 822, __PRETTY_FUNCTION__));
823    std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
824    H(std::move(SubE));
825    return Error::success();
826  }
827};
828 
829// Specialization for member functions of the form 'RetT (const ErrT&)'.
830template <typename C, typename RetT, typename ErrT>
831class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
832    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
833 
834// Specialization for member functions of the form 'RetT (const ErrT&) const'.
835template <typename C, typename RetT, typename ErrT>
836class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
837    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
838 
839// Specialization for member functions of the form 'RetT (const ErrT&)'.
840template <typename C, typename RetT, typename ErrT>
841class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
842    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
843 
844// Specialization for member functions of the form 'RetT (const ErrT&) const'.
845template <typename C, typename RetT, typename ErrT>
846class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
847    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
848 
849/// Specialization for member functions of the form
850/// 'RetT (std::unique_ptr<ErrT>)'.
851template <typename C, typename RetT, typename ErrT>
852class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
853    : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
854 
855/// Specialization for member functions of the form
856/// 'RetT (std::unique_ptr<ErrT>) const'.
857template <typename C, typename RetT, typename ErrT>
858class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
859    : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
860 
861inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
862  return Error(std::move(Payload));
863}
864 
865template <typename HandlerT, typename... HandlerTs>
866Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
867                      HandlerT &&Handler, HandlerTs &&... Handlers) {
868  if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
869    return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
870                                               std::move(Payload));
871  return handleErrorImpl(std::move(Payload),
872                         std::forward<HandlerTs>(Handlers)...);
873}
874 
875/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
876/// unhandled errors (or Errors returned by handlers) are re-concatenated and
877/// returned.
878/// Because this function returns an error, its result must also be checked
879/// or returned. If you intend to handle all errors use handleAllErrors
880/// (which returns void, and will abort() on unhandled errors) instead.
881template <typename... HandlerTs>
882Error handleErrors(Error E, HandlerTs &&... Hs) {
883  if (!E)
884    return Error::success();
885 
886  std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
887 
888  if (Payload->isA<ErrorList>()) {
889    ErrorList &List = static_cast<ErrorList &>(*Payload);
890    Error R;
891    for (auto &P : List.Payloads)
892      R = ErrorList::join(
893          std::move(R),
894          handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
895    return R;
896  }
897 
898  return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
899}
900 
901/// Behaves the same as handleErrors, except that by contract all errors
902/// *must* be handled by the given handlers (i.e. there must be no remaining
903/// errors after running the handlers, or llvm_unreachable is called).
904template <typename... HandlerTs>
905void handleAllErrors(Error E, HandlerTs &&... Handlers) {
906  cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
907}
908 
909/// Check that E is a non-error, then drop it.
910/// If E is an error, llvm_unreachable will be called.
911inline void handleAllErrors(Error E) {
912  cantFail(std::move(E));
913}
914 
915/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
916///
917/// If the incoming value is a success value it is returned unmodified. If it
918/// is a failure value then it the contained error is passed to handleErrors.
919/// If handleErrors is able to handle the error then the RecoveryPath functor
920/// is called to supply the final result. If handleErrors is not able to
921/// handle all errors then the unhandled errors are returned.
922///
923/// This utility enables the follow pattern:
924///
925///   @code{.cpp}
926///   enum FooStrategy { Aggressive, Conservative };
927///   Expected<Foo> foo(FooStrategy S);
928///
929///   auto ResultOrErr =
930///     handleExpected(
931///       foo(Aggressive),
932///       []() { return foo(Conservative); },
933///       [](AggressiveStrategyError&) {
934///         // Implicitly conusme this - we'll recover by using a conservative
935///         // strategy.
936///       });
937///
938///   @endcode
939template <typename T, typename RecoveryFtor, typename... HandlerTs>
940Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
941                           HandlerTs &&... Handlers) {
942  if (ValOrErr)
943    return ValOrErr;
944 
945  if (auto Err = handleErrors(ValOrErr.takeError(),
946                              std::forward<HandlerTs>(Handlers)...))
947    return std::move(Err);
948 
949  return RecoveryPath();
950}
951 
952/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
953/// will be printed before the first one is logged. A newline will be printed
954/// after each error.
955///
956/// This is useful in the base level of your program to allow clean termination
957/// (allowing clean deallocation of resources, etc.), while reporting error
958/// information to the user.
959void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner);
960 
961/// Write all error messages (if any) in E to a string. The newline character
962/// is used to separate error messages.
963inline std::string toString(Error E) {
964  SmallVector<std::string, 2> Errors;
965  handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
966    Errors.push_back(EI.message());
967  });
968  return join(Errors.begin(), Errors.end(), "\n");
969}
970 
971/// Consume a Error without doing anything. This method should be used
972/// only where an error can be considered a reasonable and expected return
973/// value.
974///
975/// Uses of this method are potentially indicative of design problems: If it's
976/// legitimate to do nothing while processing an "error", the error-producer
977/// might be more clearly refactored to return an Optional<T>.
978inline void consumeError(Error Err) {
979  handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
980}
981 
982/// Helper for converting an Error to a bool.
983///
984/// This method returns true if Err is in an error state, or false if it is
985/// in a success state.  Puts Err in a checked state in both cases (unlike
986/// Error::operator bool(), which only does this for success states).
987inline bool errorToBool(Error Err) {
988  bool IsError = static_cast<bool>(Err);
989  if (IsError)
990    consumeError(std::move(Err));
991  return IsError;
992}
993 
994/// Helper for Errors used as out-parameters.
995///
996/// This helper is for use with the Error-as-out-parameter idiom, where an error
997/// is passed to a function or method by reference, rather than being returned.
998/// In such cases it is helpful to set the checked bit on entry to the function
999/// so that the error can be written to (unchecked Errors abort on assignment)
1000/// and clear the checked bit on exit so that clients cannot accidentally forget
1001/// to check the result. This helper performs these actions automatically using
1002/// RAII:
1003///
1004///   @code{.cpp}
1005///   Result foo(Error &Err) {
1006///     ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1007///     // <body of foo>
1008///     // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1009///   }
1010///   @endcode
1011///
1012/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1013/// used with optional Errors (Error pointers that are allowed to be null). If
1014/// ErrorAsOutParameter took an Error reference, an instance would have to be
1015/// created inside every condition that verified that Error was non-null. By
1016/// taking an Error pointer we can just create one instance at the top of the
1017/// function.
1018class ErrorAsOutParameter {
1019public:
1020  ErrorAsOutParameter(Error *Err) : Err(Err) {
1021    // Raise the checked bit if Err is success.
1022    if (Err)
1023      (void)!!*Err;
1024  }
1025 
1026  ~ErrorAsOutParameter() {
1027    // Clear the checked bit.
1028    if (Err && !*Err)
1029      *Err = Error::success();
1030  }
1031 
1032private:
1033  Error *Err;
1034};
1035 
1036/// Helper for Expected<T>s used as out-parameters.
1037///
1038/// See ErrorAsOutParameter.
1039template <typename T>
1040class ExpectedAsOutParameter {
1041public:
1042  ExpectedAsOutParameter(Expected<T> *ValOrErr)
1043    : ValOrErr(ValOrErr) {
1044    if (ValOrErr)
1045      (void)!!*ValOrErr;
1046  }
1047 
1048  ~ExpectedAsOutParameter() {
1049    if (ValOrErr)
1050      ValOrErr->setUnchecked();
1051  }
1052 
1053private:
1054  Expected<T> *ValOrErr;
1055};
1056 
1057/// This class wraps a std::error_code in a Error.
1058///
1059/// This is useful if you're writing an interface that returns a Error
1060/// (or Expected) and you want to call code that still returns
1061/// std::error_codes.
1062class ECError : public ErrorInfo<ECError> {
1063  friend Error errorCodeToError(std::error_code);
1064 
1065public:
1066  void setErrorCode(std::error_code EC) { this->EC = EC; }
1067  std::error_code convertToErrorCode() const override { return EC; }
1068  void log(raw_ostream &OS) const override { OS << EC.message(); }
1069 
1070  // Used by ErrorInfo::classID.
1071  static char ID;
1072 
1073protected:
1074  ECError() = default;
1075  ECError(std::error_code EC) : EC(EC) {}
1076 
1077  std::error_code EC;
1078};
1079 
1080/// The value returned by this function can be returned from convertToErrorCode
1081/// for Error values where no sensible translation to std::error_code exists.
1082/// It should only be used in this situation, and should never be used where a
1083/// sensible conversion to std::error_code is available, as attempts to convert
1084/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1085///error to try to convert such a value).
1086std::error_code inconvertibleErrorCode();
1087 
1088/// Helper for converting an std::error_code to a Error.
1089Error errorCodeToError(std::error_code EC);
1090 
1091/// Helper for converting an ECError to a std::error_code.
1092///
1093/// This method requires that Err be Error() or an ECError, otherwise it
1094/// will trigger a call to abort().
1095std::error_code errorToErrorCode(Error Err);
1096 
1097/// Convert an ErrorOr<T> to an Expected<T>.
1098template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1099  if (auto EC = EO.getError())
1100    return errorCodeToError(EC);
1101  return std::move(*EO);
1102}
1103 
1104/// Convert an Expected<T> to an ErrorOr<T>.
1105template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1106  if (auto Err = E.takeError())
1107    return errorToErrorCode(std::move(Err));
1108  return std::move(*E);
1109}
1110 
1111/// This class wraps a string in an Error.
1112///
1113/// StringError is useful in cases where the client is not expected to be able
1114/// to consume the specific error message programmatically (for example, if the
1115/// error message is to be presented to the user).
1116///
1117/// StringError can also be used when additional information is to be printed
1118/// along with a error_code message. Depending on the constructor called, this
1119/// class can either display:
1120///    1. the error_code message (ECError behavior)
1121///    2. a string
1122///    3. the error_code message and a string
1123///
1124/// These behaviors are useful when subtyping is required; for example, when a
1125/// specific library needs an explicit error type. In the example below,
1126/// PDBError is derived from StringError:
1127///
1128///   @code{.cpp}
1129///   Expected<int> foo() {
1130///      return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1131///                                        "Additional information");
1132///   }
1133///   @endcode
1134///
1135class StringError : public ErrorInfo<StringError> {
1136public:
1137  static char ID;
1138 
1139  // Prints EC + S and converts to EC
1140  StringError(std::error_code EC, const Twine &S = Twine());
1141 
1142  // Prints S and converts to EC
1143  StringError(const Twine &S, std::error_code EC);
1144 
1145  void log(raw_ostream &OS) const override;
1146  std::error_code convertToErrorCode() const override;
1147 
1148  const std::string &getMessage() const { return Msg; }
1149 
1150private:
1151  std::string Msg;
1152  std::error_code EC;
1153  const bool PrintMsgOnly = false;
1154};
1155 
1156/// Create formatted StringError object.
1157template <typename... Ts>
1158Error createStringError(std::error_code EC, char const *Fmt,
1159                        const Ts &... Vals) {
1160  std::string Buffer;
1161  raw_string_ostream Stream(Buffer);
1162  Stream << format(Fmt, Vals...);
1163  return make_error<StringError>(Stream.str(), EC);
1164}
1165 
1166Error createStringError(std::error_code EC, char const *Msg);
1167 
1168/// This class wraps a filename and another Error.
1169///
1170/// In some cases, an error needs to live along a 'source' name, in order to
1171/// show more detailed information to the user.
1172class FileError final : public ErrorInfo<FileError> {
1173 
1174  friend Error createFileError(std::string, Error);
1175 
1176public:
1177  void log(raw_ostream &OS) const override {
1178    assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()."
) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1178, __PRETTY_FUNCTION__));
1179    OS << "'" << FileName << "': ";
1180    Err->log(OS);
1181  }
1182 
1183  Error takeError() { return Error(std::move(Err)); }
1184 
1185  std::error_code convertToErrorCode() const override;
1186 
1187  // Used by ErrorInfo::classID.
1188  static char ID;
1189 
1190private:
1191  FileError(std::string F, std::unique_ptr<ErrorInfoBase> E) {
1192    assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value."
) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1192, __PRETTY_FUNCTION__));
1193    assert(!F.empty() &&((!F.empty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1194, __PRETTY_FUNCTION__))
1194           "The file name provided to FileError must not be empty.")((!F.empty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1194, __PRETTY_FUNCTION__));
1195    FileName = F;
1196    Err = std::move(E);
1197  }
1198 
1199  static Error build(std::string F, Error E) {
1200    return Error(std::unique_ptr<FileError>(new FileError(F, E.takePayload())));
1201  }
1202 
1203  std::string FileName;
1204  std::unique_ptr<ErrorInfoBase> Err;
1205};
1206 
1207/// Concatenate a source file path and/or name with an Error. The resulting
1208/// Error is unchecked.
1209inline Error createFileError(std::string F, Error E) {
1210  return FileError::build(F, std::move(E));
1211}
1212 
1213Error createFileError(std::string F, ErrorSuccess) = delete;
1214 
1215/// Helper for check-and-exit error handling.
1216///
1217/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1218///
1219class ExitOnError {
1220public:
1221  /// Create an error on exit helper.
1222  ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1223      : Banner(std::move(Banner)),
1224        GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1225 
1226  /// Set the banner string for any errors caught by operator().
1227  void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1228 
1229  /// Set the exit-code mapper function.
1230  void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1231    this->GetExitCode = std::move(GetExitCode);
1232  }
1233 
1234  /// Check Err. If it's in a failure state log the error(s) and exit.
1235  void operator()(Error Err) const { checkError(std::move(Err)); }
1236 
1237  /// Check E. If it's in a success state then return the contained value. If
1238  /// it's in a failure state log the error(s) and exit.
1239  template <typename T> T operator()(Expected<T> &&E) const {
1240    checkError(E.takeError());
1241    return std::move(*E);
1242  }
1243 
1244  /// Check E. If it's in a success state then return the contained reference. If
1245  /// it's in a failure state log the error(s) and exit.
1246  template <typename T> T& operator()(Expected<T&> &&E) const {
1247    checkError(E.takeError());
1248    return *E;
1249  }
1250 
1251private:
1252  void checkError(Error Err) const {
1253    if (Err) {
1254      int ExitCode = GetExitCode(Err);
1255      logAllUnhandledErrors(std::move(Err), errs(), Banner);
1256      exit(ExitCode);
1257    }
1258  }
1259 
1260  std::string Banner;
1261  std::function<int(const Error &)> GetExitCode;
1262};
1263 
1264/// Conversion from Error to LLVMErrorRef for C error bindings.
1265inline LLVMErrorRef wrap(Error Err) {
1266  return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1267}
1268 
1269/// Conversion from LLVMErrorRef to Error for C error bindings.
1270inline Error unwrap(LLVMErrorRef ErrRef) {
1271  return Error(std::unique_ptr<ErrorInfoBase>(
1272      reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1273}
1274 
1275} // end namespace llvm
1276 
1277#endif // LLVM_SUPPORT_ERROR_H

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h

1//===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains some templates that are useful if you are working with the
11// STL at all.
12//
13// No library is required when using these functions.
14//
15//===----------------------------------------------------------------------===//
16 
17#ifndef LLVM_ADT_STLEXTRAS_H
18#define LLVM_ADT_STLEXTRAS_H
19 
20#include "llvm/ADT/Optional.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/iterator.h"
23#include "llvm/ADT/iterator_range.h"
24#include "llvm/Config/abi-breaking.h"
25#include "llvm/Support/ErrorHandling.h"
26#include <algorithm>
27#include <cassert>
28#include <cstddef>
29#include <cstdint>
30#include <cstdlib>
31#include <functional>
32#include <initializer_list>
33#include <iterator>
34#include <limits>
35#include <memory>
36#include <tuple>
37#include <type_traits>
38#include <utility>
39 
40#ifdef EXPENSIVE_CHECKS
41#include <random> // for std::mt19937
42#endif
43 
44namespace llvm {
45 
46// Only used by compiler if both template types are the same.  Useful when
47// using SFINAE to test for the existence of member functions.
48template <typename T, T> struct SameType;
49 
50namespace detail {
51 
52template <typename RangeT>
53using IterOfRange = decltype(std::begin(std::declval<RangeT &>()));
54 
55template <typename RangeT>
56using ValueOfRange = typename std::remove_reference<decltype(
57    *std::begin(std::declval<RangeT &>()))>::type;
58 
59} // end namespace detail
60 
61//===----------------------------------------------------------------------===//
62//     Extra additions to <type_traits>
63//===----------------------------------------------------------------------===//
64 
65template <typename T>
66struct negation : std::integral_constant<bool, !bool(T::value)> {};
67 
68template <typename...> struct conjunction : std::true_type {};
69template <typename B1> struct conjunction<B1> : B1 {};
70template <typename B1, typename... Bn>
71struct conjunction<B1, Bn...>
72    : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
73 
74//===----------------------------------------------------------------------===//
75//     Extra additions to <functional>
76//===----------------------------------------------------------------------===//
77 
78template <class Ty> struct identity {
79  using argument_type = Ty;
80 
81  Ty &operator()(Ty &self) const {
82    return self;
83  }
84  const Ty &operator()(const Ty &self) const {
85    return self;
86  }
87};
88 
89template <class Ty> struct less_ptr {
90  bool operator()(const Ty* left, const Ty* right) const {
91    return *left < *right;
92  }
93};
94 
95template <class Ty> struct greater_ptr {
96  bool operator()(const Ty* left, const Ty* right) const {
97    return *right < *left;
98  }
99};
100 
101/// An efficient, type-erasing, non-owning reference to a callable. This is
102/// intended for use as the type of a function parameter that is not used
103/// after the function in question returns.
104///
105/// This class does not own the callable, so it is not in general safe to store
106/// a function_ref.
107template<typename Fn> class function_ref;
108 
109template<typename Ret, typename ...Params>
110class function_ref<Ret(Params...)> {
111  Ret (*callback)(intptr_t callable, Params ...params) = nullptr;
112  intptr_t callable;
113 
114  template<typename Callable>
115  static Ret callback_fn(intptr_t callable, Params ...params) {
116    return (*reinterpret_cast<Callable*>(callable))(
117        std::forward<Params>(params)...);
118  }
119 
120public:
121  function_ref() = default;
122  function_ref(std::nullptr_t) {}
123 
124  template <typename Callable>
125  function_ref(Callable &&callable,
126               typename std::enable_if<
127                   !std::is_same<typename std::remove_reference<Callable>::type,
128                                 function_ref>::value>::type * = nullptr)
129      : callback(callback_fn<typename std::remove_reference<Callable>::type>),
130        callable(reinterpret_cast<intptr_t>(&callable)) {}
131 
132  Ret operator()(Params ...params) const {
133    return callback(callable, std::forward<Params>(params)...);
134  }
135 
136  operator bool() const { return callback; }
137};
138 
139// deleter - Very very very simple method that is used to invoke operator
140// delete on something.  It is used like this:
141//
142//   for_each(V.begin(), B.end(), deleter<Interval>);
143template <class T>
144inline void deleter(T *Ptr) {
145  delete Ptr;
146}
147 
148//===----------------------------------------------------------------------===//
149//     Extra additions to <iterator>
150//===----------------------------------------------------------------------===//
151 
152namespace adl_detail {
153 
154using std::begin;
155 
156template <typename ContainerTy>
157auto adl_begin(ContainerTy &&container)
158    -> decltype(begin(std::forward<ContainerTy>(container))) {
159  return begin(std::forward<ContainerTy>(container));
160}
161 
162using std::end;
163 
164template <typename ContainerTy>
165auto adl_end(ContainerTy &&container)
166    -> decltype(end(std::forward<ContainerTy>(container))) {
167  return end(std::forward<ContainerTy>(container));
168}
169 
170using std::swap;
171 
172template <typename T>
173void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(),
174                                                       std::declval<T>()))) {
175  swap(std::forward<T>(lhs), std::forward<T>(rhs));
176}
177 
178} // end namespace adl_detail
179 
180template <typename ContainerTy>
181auto adl_begin(ContainerTy &&container)
182    -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) {
183  return adl_detail::adl_begin(std::forward<ContainerTy>(container));
184}
185 
186template <typename ContainerTy>
187auto adl_end(ContainerTy &&container)
188    -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) {
189  return adl_detail::adl_end(std::forward<ContainerTy>(container));
190}
191 
192template <typename T>
193void adl_swap(T &&lhs, T &&rhs) noexcept(
194    noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) {
195  adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs));
196}
197 
198// mapped_iterator - This is a simple iterator adapter that causes a function to
199// be applied whenever operator* is invoked on the iterator.
200 
201template <typename ItTy, typename FuncTy,
202          typename FuncReturnTy =
203            decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))>
204class mapped_iterator
205    : public iterator_adaptor_base<
206             mapped_iterator<ItTy, FuncTy>, ItTy,
207             typename std::iterator_traits<ItTy>::iterator_category,
208             typename std::remove_reference<FuncReturnTy>::type> {
209public:
210  mapped_iterator(ItTy U, FuncTy F)
211    : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {}
212 
213  ItTy getCurrent() { return this->I; }
214 
215  FuncReturnTy operator*() { return F(*this->I); }
216 
217private:
218  FuncTy F;
219};
220 
221// map_iterator - Provide a convenient way to create mapped_iterators, just like
222// make_pair is useful for creating pairs...
223template <class ItTy, class FuncTy>
224inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) {
225  return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F));
226}
227 
228/// Helper to determine if type T has a member called rbegin().
229template <typename Ty> class has_rbegin_impl {
230  using yes = char[1];
231  using no = char[2];
232 
233  template <typename Inner>
234  static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr);
235 
236  template <typename>
237  static no& test(...);
238 
239public:
240  static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes);
241};
242 
243/// Metafunction to determine if T& or T has a member called rbegin().
244template <typename Ty>
245struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> {
246};
247 
248// Returns an iterator_range over the given container which iterates in reverse.
249// Note that the container must have rbegin()/rend() methods for this to work.
250template <typename ContainerTy>
251auto reverse(ContainerTy &&C,
252             typename std::enable_if<has_rbegin<ContainerTy>::value>::type * =
253                 nullptr) -> decltype(make_range(C.rbegin(), C.rend())) {
254  return make_range(C.rbegin(), C.rend());
255}
256 
257// Returns a std::reverse_iterator wrapped around the given iterator.
258template <typename IteratorTy>
259std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) {
260  return std::reverse_iterator<IteratorTy>(It);
261}
262 
263// Returns an iterator_range over the given container which iterates in reverse.
264// Note that the container must have begin()/end() methods which return
265// bidirectional iterators for this to work.
266template <typename ContainerTy>
267auto reverse(
268    ContainerTy &&C,
269    typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr)
270    -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)),
271                           llvm::make_reverse_iterator(std::begin(C)))) {
272  return make_range(llvm::make_reverse_iterator(std::end(C)),
273                    llvm::make_reverse_iterator(std::begin(C)));
274}
275 
276/// An iterator adaptor that filters the elements of given inner iterators.
277///
278/// The predicate parameter should be a callable object that accepts the wrapped
279/// iterator's reference type and returns a bool. When incrementing or
280/// decrementing the iterator, it will call the predicate on each element and
281/// skip any where it returns false.
282///
283/// \code
284///   int A[] = { 1, 2, 3, 4 };
285///   auto R = make_filter_range(A, [](int N) { return N % 2 == 1; });
286///   // R contains { 1, 3 }.
287/// \endcode
288///
289/// Note: filter_iterator_base implements support for forward iteration.
290/// filter_iterator_impl exists to provide support for bidirectional iteration,
291/// conditional on whether the wrapped iterator supports it.
292template <typename WrappedIteratorT, typename PredicateT, typename IterTag>
293class filter_iterator_base
294    : public iterator_adaptor_base<
295          filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
296          WrappedIteratorT,
297          typename std::common_type<
298              IterTag, typename std::iterator_traits<
299                           WrappedIteratorT>::iterator_category>::type> {
300  using BaseT = iterator_adaptor_base<
301      filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
302      WrappedIteratorT,
303      typename std::common_type<
304          IterTag, typename std::iterator_traits<
305                       WrappedIteratorT>::iterator_category>::type>;
306 
307protected:
308  WrappedIteratorT End;
309  PredicateT Pred;
310 
311  void findNextValid() {
312    while (this->I != End && !Pred(*this->I))
313      BaseT::operator++();
314  }
315 
316  // Construct the iterator. The begin iterator needs to know where the end
317  // is, so that it can properly stop when it gets there. The end iterator only
318  // needs the predicate to support bidirectional iteration.
319  filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End,
320                       PredicateT Pred)
321      : BaseT(Begin), End(End), Pred(Pred) {
322    findNextValid();
323  }
324 
325public:
326  using BaseT::operator++;
327 
328  filter_iterator_base &operator++() {
329    BaseT::operator++();
330    findNextValid();
331    return *this;
332  }
333};
334 
335/// Specialization of filter_iterator_base for forward iteration only.
336template <typename WrappedIteratorT, typename PredicateT,
337          typename IterTag = std::forward_iterator_tag>
338class filter_iterator_impl
339    : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> {
340  using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>;
341 
342public:
343  filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
344                       PredicateT Pred)
345      : BaseT(Begin, End, Pred) {}
346};
347 
348/// Specialization of filter_iterator_base for bidirectional iteration.
349template <typename WrappedIteratorT, typename PredicateT>
350class filter_iterator_impl<WrappedIteratorT, PredicateT,
351                           std::bidirectional_iterator_tag>
352    : public filter_iterator_base<WrappedIteratorT, PredicateT,
353                                  std::bidirectional_iterator_tag> {
354  using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT,
355                                     std::bidirectional_iterator_tag>;
356  void findPrevValid() {
357    while (!this->Pred(*this->I))
358      BaseT::operator--();
359  }
360 
361public:
362  using BaseT::operator--;
363 
364  filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
365                       PredicateT Pred)
366      : BaseT(Begin, End, Pred) {}
367 
368  filter_iterator_impl &operator--() {
369    BaseT::operator--();
370    findPrevValid();
371    return *this;
372  }
373};
374 
375namespace detail {
376 
377template <bool is_bidirectional> struct fwd_or_bidi_tag_impl {
378  using type = std::forward_iterator_tag;
379};
380 
381template <> struct fwd_or_bidi_tag_impl<true> {
382  using type = std::bidirectional_iterator_tag;
383};
384 
385/// Helper which sets its type member to forward_iterator_tag if the category
386/// of \p IterT does not derive from bidirectional_iterator_tag, and to
387/// bidirectional_iterator_tag otherwise.
388template <typename IterT> struct fwd_or_bidi_tag {
389  using type = typename fwd_or_bidi_tag_impl<std::is_base_of<
390      std::bidirectional_iterator_tag,
391      typename std::iterator_traits<IterT>::iterator_category>::value>::type;
392};
393 
394} // namespace detail
395 
396/// Defines filter_iterator to a suitable specialization of
397/// filter_iterator_impl, based on the underlying iterator's category.
398template <typename WrappedIteratorT, typename PredicateT>
399using filter_iterator = filter_iterator_impl<
400    WrappedIteratorT, PredicateT,
401    typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>;
402 
403/// Convenience function that takes a range of elements and a predicate,
404/// and return a new filter_iterator range.
405///
406/// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the
407/// lifetime of that temporary is not kept by the returned range object, and the
408/// temporary is going to be dropped on the floor after the make_iterator_range
409/// full expression that contains this function call.
410template <typename RangeT, typename PredicateT>
411iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>>
412make_filter_range(RangeT &&Range, PredicateT Pred) {
413  using FilterIteratorT =
414      filter_iterator<detail::IterOfRange<RangeT>, PredicateT>;
415  return make_range(
416      FilterIteratorT(std::begin(std::forward<RangeT>(Range)),
417                      std::end(std::forward<RangeT>(Range)), Pred),
418      FilterIteratorT(std::end(std::forward<RangeT>(Range)),
419                      std::end(std::forward<RangeT>(Range)), Pred));
420}
421 
422/// A pseudo-iterator adaptor that is designed to implement "early increment"
423/// style loops.
424///
425/// This is *not a normal iterator* and should almost never be used directly. It
426/// is intended primarily to be used with range based for loops and some range
427/// algorithms.
428///
429/// The iterator isn't quite an `OutputIterator` or an `InputIterator` but
430/// somewhere between them. The constraints of these iterators are:
431///
432/// - On construction or after being incremented, it is comparable and
433///   dereferencable. It is *not* incrementable.
434/// - After being dereferenced, it is neither comparable nor dereferencable, it
435///   is only incrementable.
436///
437/// This means you can only dereference the iterator once, and you can only
438/// increment it once between dereferences.
439template <typename WrappedIteratorT>
440class early_inc_iterator_impl
441    : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
442                                   WrappedIteratorT, std::input_iterator_tag> {
443  using BaseT =
444      iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
445                            WrappedIteratorT, std::input_iterator_tag>;
446 
447  using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer;
448 
449protected:
450#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
451  bool IsEarlyIncremented = false;
452#endif
453 
454public:
455  early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {}
456 
457  using BaseT::operator*;
458  typename BaseT::reference operator*() {
459#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
460    assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!")
 ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 460, __PRETTY_FUNCTION__));
461    IsEarlyIncremented = true;
462#endif
463    return *(this->I)++;
464  }
465 
466  using BaseT::operator++;
467  early_inc_iterator_impl &operator++() {
468#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
469    assert(IsEarlyIncremented && "Cannot increment before dereferencing!")((IsEarlyIncremented && "Cannot increment before dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("IsEarlyIncremented && \"Cannot increment before dereferencing!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 469, __PRETTY_FUNCTION__));
470    IsEarlyIncremented = false;
471#endif
472    return *this;
473  }
474 
475  using BaseT::operator==;
476  bool operator==(const early_inc_iterator_impl &RHS) const {
477#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
478    assert(!IsEarlyIncremented && "Cannot compare after dereferencing!")((!IsEarlyIncremented && "Cannot compare after dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot compare after dereferencing!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 478, __PRETTY_FUNCTION__));
479#endif
480    return BaseT::operator==(RHS);
481  }
482};
483 
484/// Make a range that does early increment to allow mutation of the underlying
485/// range without disrupting iteration.
486///
487/// The underlying iterator will be incremented immediately after it is
488/// dereferenced, allowing deletion of the current node or insertion of nodes to
489/// not disrupt iteration provided they do not invalidate the *next* iterator --
490/// the current iterator can be invalidated.
491///
492/// This requires a very exact pattern of use that is only really suitable to
493/// range based for loops and other range algorithms that explicitly guarantee
494/// to dereference exactly once each element, and to increment exactly once each
495/// element.
496template <typename RangeT>
497iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>>
498make_early_inc_range(RangeT &&Range) {
499  using EarlyIncIteratorT =
500      early_inc_iterator_impl<detail::IterOfRange<RangeT>>;
501  return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))),
502                    EarlyIncIteratorT(std::end(std::forward<RangeT>(Range))));
503}
504 
505// forward declarations required by zip_shortest/zip_first
506template <typename R, typename UnaryPredicate>
507bool all_of(R &&range, UnaryPredicate P);
508 
509template <size_t... I> struct index_sequence;
510 
511template <class... Ts> struct index_sequence_for;
512 
513namespace detail {
514 
515using std::declval;
516 
517// We have to alias this since inlining the actual type at the usage site
518// in the parameter list of iterator_facade_base<> below ICEs MSVC 2017.
519template<typename... Iters> struct ZipTupleType {
520  using type = std::tuple<decltype(*declval<Iters>())...>;
521};
522 
523template <typename ZipType, typename... Iters>
524using zip_traits = iterator_facade_base<
525    ZipType, typename std::common_type<std::bidirectional_iterator_tag,
526                                       typename std::iterator_traits<
527                                           Iters>::iterator_category...>::type,
528    // ^ TODO: Implement random access methods.
529    typename ZipTupleType<Iters...>::type,
530    typename std::iterator_traits<typename std::tuple_element<
531        0, std::tuple<Iters...>>::type>::difference_type,
532    // ^ FIXME: This follows boost::make_zip_iterator's assumption that all
533    // inner iterators have the same difference_type. It would fail if, for
534    // instance, the second field's difference_type were non-numeric while the
535    // first is.
536    typename ZipTupleType<Iters...>::type *,
537    typename ZipTupleType<Iters...>::type>;
538 
539template <typename ZipType, typename... Iters>
540struct zip_common : public zip_traits<ZipType, Iters...> {
541  using Base = zip_traits<ZipType, Iters...>;
542  using value_type = typename Base::value_type;
543 
544  std::tuple<Iters...> iterators;
545 
546protected:
547  template <size_t... Ns> value_type deref(index_sequence<Ns...>) const {
548    return value_type(*std::get<Ns>(iterators)...);
549  }
550 
551  template <size_t... Ns>
552  decltype(iterators) tup_inc(index_sequence<Ns...>) const {
553    return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...);
554  }
555 
556  template <size_t... Ns>
557  decltype(iterators) tup_dec(index_sequence<Ns...>) const {
558    return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...);
559  }
560 
561public:
562  zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {}
563 
564  value_type operator*() { return deref(index_sequence_for<Iters...>{}); }
565 
566  const value_type operator*() const {
567    return deref(index_sequence_for<Iters...>{});
568  }
569 
570  ZipType &operator++() {
571    iterators = tup_inc(index_sequence_for<Iters...>{});
572    return *reinterpret_cast<ZipType *>(this);
573  }
574 
575  ZipType &operator--() {
576    static_assert(Base::IsBidirectional,
577                  "All inner iterators must be at least bidirectional.");
578    iterators = tup_dec(index_sequence_for<Iters...>{});
579    return *reinterpret_cast<ZipType *>(this);
580  }
581};
582 
583template <typename... Iters>
584struct zip_first : public zip_common<zip_first<Iters...>, Iters...> {
585  using Base = zip_common<zip_first<Iters...>, Iters...>;
586 
587  bool operator==(const zip_first<Iters...> &other) const {
588    return std::get<0>(this->iterators) == std::get<0>(other.iterators);
589  }
590 
591  zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
592};
593 
594template <typename... Iters>
595class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> {
596  template <size_t... Ns>
597  bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const {
598    return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) !=
599                                              std::get<Ns>(other.iterators)...},
600                  identity<bool>{});
601  }
602 
603public:
604  using Base = zip_common<zip_shortest<Iters...>, Iters...>;
605 
606  zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
607 
608  bool operator==(const zip_shortest<Iters...> &other) const {
609    return !test(other, index_sequence_for<Iters...>{});
610  }
611};
612 
613template <template <typename...> class ItType, typename... Args> class zippy {
614public:
615  using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>;
616  using iterator_category = typename iterator::iterator_category;
617  using value_type = typename iterator::value_type;
618  using difference_type = typename iterator::difference_type;
619  using pointer = typename iterator::pointer;
620  using reference = typename iterator::reference;
621 
622private:
623  std::tuple<Args...> ts;
624 
625  template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const {
626    return iterator(std::begin(std::get<Ns>(ts))...);
627  }
628  template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const {
629    return iterator(std::end(std::get<Ns>(ts))...);
630  }
631 
632public:
633  zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {}
634 
635  iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); }
636  iterator end() const { return end_impl(index_sequence_for<Args...>{}); }
637};
638 
639} // end namespace detail
640 
641/// zip iterator for two or more iteratable types.
642template <typename T, typename U, typename... Args>
643detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u,
644                                                       Args &&... args) {
645  return detail::zippy<detail::zip_shortest, T, U, Args...>(
646      std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
647}
648 
649/// zip iterator that, for the sake of efficiency, assumes the first iteratee to
650/// be the shortest.
651template <typename T, typename U, typename... Args>
652detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u,
653                                                          Args &&... args) {
654  return detail::zippy<detail::zip_first, T, U, Args...>(
655      std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
656}
657 
658/// Iterator wrapper that concatenates sequences together.
659///
660/// This can concatenate different iterators, even with different types, into
661/// a single iterator provided the value types of all the concatenated
662/// iterators expose `reference` and `pointer` types that can be converted to
663/// `ValueT &` and `ValueT *` respectively. It doesn't support more
664/// interesting/customized pointer or reference types.
665///
666/// Currently this only supports forward or higher iterator categories as
667/// inputs and always exposes a forward iterator interface.
668template <typename ValueT, typename... IterTs>
669class concat_iterator
670    : public iterator_facade_base<concat_iterator<ValueT, IterTs...>,
671                                  std::forward_iterator_tag, ValueT> {
672  using BaseT = typename concat_iterator::iterator_facade_base;
673 
674  /// We store both the current and end iterators for each concatenated
675  /// sequence in a tuple of pairs.
676  ///
677  /// Note that something like iterator_range seems nice at first here, but the
678  /// range properties are of little benefit and end up getting in the way
679  /// because we need to do mutation on the current iterators.
680  std::tuple<IterTs...> Begins;
681  std::tuple<IterTs...> Ends;
682 
683  /// Attempts to increment a specific iterator.
684  ///
685  /// Returns true if it was able to increment the iterator. Returns false if
686  /// the iterator is already at the end iterator.
687  template <size_t Index> bool incrementHelper() {
688    auto &Begin = std::get<Index>(Begins);
689    auto &End = std::get<Index>(Ends);
690    if (Begin == End)
691      return false;
692 
693    ++Begin;
694    return true;
695  }
696 
697  /// Increments the first non-end iterator.
698  ///
699  /// It is an error to call this with all iterators at the end.
700  template <size_t... Ns> void increment(index_sequence<Ns...>) {
701    // Build a sequence of functions to increment each iterator if possible.
702    bool (concat_iterator::*IncrementHelperFns[])() = {
703        &concat_iterator::incrementHelper<Ns>...};
704 
705    // Loop over them, and stop as soon as we succeed at incrementing one.
706    for (auto &IncrementHelperFn : IncrementHelperFns)
707      if ((this->*IncrementHelperFn)())
708        return;
709 
710    llvm_unreachable("Attempted to increment an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to increment an end concat iterator!"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 710);
711  }
712 
713  /// Returns null if the specified iterator is at the end. Otherwise,
714  /// dereferences the iterator and returns the address of the resulting
715  /// reference.
716  template <size_t Index> ValueT *getHelper() const {
717    auto &Begin = std::get<Index>(Begins);
718    auto &End = std::get<Index>(Ends);
719    if (Begin == End)
720      return nullptr;
721 
722    return &*Begin;
723  }
724 
725  /// Finds the first non-end iterator, dereferences, and returns the resulting
726  /// reference.
727  ///
728  /// It is an error to call this with all iterators at the end.
729  template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const {
730    // Build a sequence of functions to get from iterator if possible.
731    ValueT *(concat_iterator::*GetHelperFns[])() const = {
732        &concat_iterator::getHelper<Ns>...};
733 
734    // Loop over them, and return the first result we find.
735    for (auto &GetHelperFn : GetHelperFns)
736      if (ValueT *P = (this->*GetHelperFn)())
737        return *P;
738 
739    llvm_unreachable("Attempted to get a pointer from an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to get a pointer from an end concat iterator!"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 739);
740  }
741 
742public:
743  /// Constructs an iterator from a squence of ranges.
744  ///
745  /// We need the full range to know how to switch between each of the
746  /// iterators.
747  template <typename... RangeTs>
748  explicit concat_iterator(RangeTs &&... Ranges)
749      : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {}
750 
751  using BaseT::operator++;
752 
753  concat_iterator &operator++() {
754    increment(index_sequence_for<IterTs...>());
755    return *this;
756  }
757 
758  ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); }
759 
760  bool operator==(const concat_iterator &RHS) const {
761    return Begins == RHS.Begins && Ends == RHS.Ends;
762  }
763};
764 
765namespace detail {
766 
767/// Helper to store a sequence of ranges being concatenated and access them.
768///
769/// This is designed to facilitate providing actual storage when temporaries
770/// are passed into the constructor such that we can use it as part of range
771/// based for loops.
772template <typename ValueT, typename... RangeTs> class concat_range {
773public:
774  using iterator =
775      concat_iterator<ValueT,
776                      decltype(std::begin(std::declval<RangeTs &>()))...>;
777 
778private:
779  std::tuple<RangeTs...> Ranges;
780 
781  template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) {
782    return iterator(std::get<Ns>(Ranges)...);
783  }
784  template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) {
785    return iterator(make_range(std::end(std::get<Ns>(Ranges)),
786                               std::end(std::get<Ns>(Ranges)))...);
787  }
788 
789public:
790  concat_range(RangeTs &&... Ranges)
791      : Ranges(std::forward<RangeTs>(Ranges)...) {}
792 
793  iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); }
794  iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); }
795};
796 
797} // end namespace detail
798 
799/// Concatenated range across two or more ranges.
800///
801/// The desired value type must be explicitly specified.
802template <typename ValueT, typename... RangeTs>
803detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) {
804  static_assert(sizeof...(RangeTs) > 1,
805                "Need more than one range to concatenate!");
806  return detail::concat_range<ValueT, RangeTs...>(
807      std::forward<RangeTs>(Ranges)...);
808}
809 
810//===----------------------------------------------------------------------===//
811//     Extra additions to <utility>
812//===----------------------------------------------------------------------===//
813 
814/// Function object to check whether the first component of a std::pair
815/// compares less than the first component of another std::pair.
816struct less_first {
817  template <typename T> bool operator()(const T &lhs, const T &rhs) const {
818    return lhs.first < rhs.first;
819  }
820};
821 
822/// Function object to check whether the second component of a std::pair
823/// compares less than the second component of another std::pair.
824struct less_second {
825  template <typename T> bool operator()(const T &lhs, const T &rhs) const {
826    return lhs.second < rhs.second;
827  }
828};
829 
830/// \brief Function object to apply a binary function to the first component of
831/// a std::pair.
832template<typename FuncTy>
833struct on_first {
834  FuncTy func;
835 
836  template <typename T>
837  auto operator()(const T &lhs, const T &rhs) const
838      -> decltype(func(lhs.first, rhs.first)) {
839    return func(lhs.first, rhs.first);
840  }
841};
842 
843// A subset of N3658. More stuff can be added as-needed.
844 
845/// Represents a compile-time sequence of integers.
846template <class T, T... I> struct integer_sequence {
847  using value_type = T;
848 
849  static constexpr size_t size() { return sizeof...(I); }
850};
851 
852/// Alias for the common case of a sequence of size_ts.
853template <size_t... I>
854struct index_sequence : integer_sequence<std::size_t, I...> {};
855 
856template <std::size_t N, std::size_t... I>
857struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {};
858template <std::size_t... I>
859struct build_index_impl<0, I...> : index_sequence<I...> {};
860 
861/// Creates a compile-time integer sequence for a parameter pack.
862template <class... Ts>
863struct index_sequence_for : build_index_impl<sizeof...(Ts)> {};
864 
865/// Utility type to build an inheritance chain that makes it easy to rank
866/// overload candidates.
867template <int N> struct rank : rank<N - 1> {};
868template <> struct rank<0> {};
869 
870/// traits class for checking whether type T is one of any of the given
871/// types in the variadic list.
872template <typename T, typename... Ts> struct is_one_of {
873  static const bool value = false;
874};
875 
876template <typename T, typename U, typename... Ts>
877struct is_one_of<T, U, Ts...> {
878  static const bool value =
879      std::is_same<T, U>::value || is_one_of<T, Ts...>::value;
880};
881 
882/// traits class for checking whether type T is a base class for all
883///  the given types in the variadic list.
884template <typename T, typename... Ts> struct are_base_of {
885  static const bool value = true;
886};
887 
888template <typename T, typename U, typename... Ts>
889struct are_base_of<T, U, Ts...> {
890  static const bool value =
891      std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value;
892};
893 
894//===----------------------------------------------------------------------===//
895//     Extra additions for arrays
896//===----------------------------------------------------------------------===//
897 
898/// Find the length of an array.
899template <class T, std::size_t N>
900constexpr inline size_t array_lengthof(T (&)[N]) {
901  return N;
902}
903 
904/// Adapt std::less<T> for array_pod_sort.
905template<typename T>
906inline int array_pod_sort_comparator(const void *P1, const void *P2) {
907  if (std::less<T>()(*reinterpret_cast<const T*>(P1),
908                     *reinterpret_cast<const T*>(P2)))
909    return -1;
910  if (std::less<T>()(*reinterpret_cast<const T*>(P2),
911                     *reinterpret_cast<const T*>(P1)))
912    return 1;
913  return 0;
914}
915 
916/// get_array_pod_sort_comparator - This is an internal helper function used to
917/// get type deduction of T right.
918template<typename T>
919inline int (*get_array_pod_sort_comparator(const T &))
920             (const void*, const void*) {
921  return array_pod_sort_comparator<T>;
922}
923 
924/// array_pod_sort - This sorts an array with the specified start and end
925/// extent.  This is just like std::sort, except that it calls qsort instead of
926/// using an inlined template.  qsort is slightly slower than std::sort, but
927/// most sorts are not performance critical in LLVM and std::sort has to be
928/// template instantiated for each type, leading to significant measured code
929/// bloat.  This function should generally be used instead of std::sort where
930/// possible.
931///
932/// This function assumes that you have simple POD-like types that can be
933/// compared with std::less and can be moved with memcpy.  If this isn't true,
934/// you should use std::sort.
935///
936/// NOTE: If qsort_r were portable, we could allow a custom comparator and
937/// default to std::less.
938template<class IteratorTy>
939inline void array_pod_sort(IteratorTy Start, IteratorTy End) {
940  // Don't inefficiently call qsort with one element or trigger undefined
941  // behavior with an empty sequence.
942  auto NElts = End - Start;
943  if (NElts <= 1) return;
944#ifdef EXPENSIVE_CHECKS
945  std::mt19937 Generator(std::random_device{}());
946  std::shuffle(Start, End, Generator);
947#endif
948  qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start));
949}
950 
951template <class IteratorTy>
952inline void array_pod_sort(
953    IteratorTy Start, IteratorTy End,
954    int (*Compare)(
955        const typename std::iterator_traits<IteratorTy>::value_type *,
956        const typename std::iterator_traits<IteratorTy>::value_type *)) {
957  // Don't inefficiently call qsort with one element or trigger undefined
958  // behavior with an empty sequence.
959  auto NElts = End - Start;
960  if (NElts <= 1) return;
961#ifdef EXPENSIVE_CHECKS
962  std::mt19937 Generator(std::random_device{}());
963  std::shuffle(Start, End, Generator);
964#endif
965  qsort(&*Start, NElts, sizeof(*Start),
966        reinterpret_cast<int (*)(const void *, const void *)>(Compare));
967}
968 
969// Provide wrappers to std::sort which shuffle the elements before sorting
970// to help uncover non-deterministic behavior (PR35135).
971template <typename IteratorTy>
972inline void sort(IteratorTy Start, IteratorTy End) {
973#ifdef EXPENSIVE_CHECKS
974  std::mt19937 Generator(std::random_device{}());
975  std::shuffle(Start, End, Generator);
976#endif
977  std::sort(Start, End);
978}
979 
980template <typename Container> inline void sort(Container &&C) {
981  llvm::sort(adl_begin(C), adl_end(C));
982}
983 
984template <typename IteratorTy, typename Compare>
985inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) {
986#ifdef EXPENSIVE_CHECKS
987  std::mt19937 Generator(std::random_device{}());
988  std::shuffle(Start, End, Generator);
989#endif
990  std::sort(Start, End, Comp);
991}
992 
993template <typename Container, typename Compare>
994inline void sort(Container &&C, Compare Comp) {
995  llvm::sort(adl_begin(C), adl_end(C), Comp);
996}
997 
998//===----------------------------------------------------------------------===//
999//     Extra additions to <algorithm>
1000//===----------------------------------------------------------------------===//
1001 
1002/// For a container of pointers, deletes the pointers and then clears the
1003/// container.
1004template<typename Container>
1005void DeleteContainerPointers(Container &C) {
1006  for (auto V : C)
1007    delete V;
1008  C.clear();
1009}
1010 
1011/// In a container of pairs (usually a map) whose second element is a pointer,
1012/// deletes the second elements and then clears the container.
1013template<typename Container>
1014void DeleteContainerSeconds(Container &C) {
1015  for (auto &V : C)
1016    delete V.second;
1017  C.clear();
1018}
1019 
1020/// Get the size of a range. This is a wrapper function around std::distance
1021/// which is only enabled when the operation is O(1).
1022template <typename R>
1023auto size(R &&Range, typename std::enable_if<
1024                         std::is_same<typename std::iterator_traits<decltype(
1025                                          Range.begin())>::iterator_category,
1026                                      std::random_access_iterator_tag>::value,
1027                         void>::type * = nullptr)
1028    -> decltype(std::distance(Range.begin(), Range.end())) {
1029  return std::distance(Range.begin(), Range.end());
1030}
1031 
1032/// Provide wrappers to std::for_each which take ranges instead of having to
1033/// pass begin/end explicitly.
1034template <typename R, typename UnaryPredicate>
1035UnaryPredicate for_each(R &&Range, UnaryPredicate P) {
1036  return std::for_each(adl_begin(Range), adl_end(Range), P);
1037}
1038 
1039/// Provide wrappers to std::all_of which take ranges instead of having to pass
1040/// begin/end explicitly.
1041template <typename R, typename UnaryPredicate>
1042bool all_of(R &&Range, UnaryPredicate P) {
1043  return std::all_of(adl_begin(Range), adl_end(Range), P);
1044}
1045 
1046/// Provide wrappers to std::any_of which take ranges instead of having to pass
1047/// begin/end explicitly.
1048template <typename R, typename UnaryPredicate>
1049bool any_of(R &&Range, UnaryPredicate P) {
1050  return std::any_of(adl_begin(Range), adl_end(Range), P);
1051}
1052 
1053/// Provide wrappers to std::none_of which take ranges instead of having to pass
1054/// begin/end explicitly.
1055template <typename R, typename UnaryPredicate>
1056bool none_of(R &&Range, UnaryPredicate P) {
1057  return std::none_of(adl_begin(Range), adl_end(Range), P);
1058}
1059 
1060/// Provide wrappers to std::find which take ranges instead of having to pass
1061/// begin/end explicitly.
1062template <typename R, typename T>
1063auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) {
1064  return std::find(adl_begin(Range), adl_end(Range), Val);
1065}
1066 
1067/// Provide wrappers to std::find_if which take ranges instead of having to pass
1068/// begin/end explicitly.
1069template <typename R, typename UnaryPredicate>
1070auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1071  return std::find_if(adl_begin(Range), adl_end(Range), P);
1072}
1073 
1074template <typename R, typename UnaryPredicate>
1075auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1076  return std::find_if_not(adl_begin(Range), adl_end(Range), P);
1077}
1078 
1079/// Provide wrappers to std::remove_if which take ranges instead of having to
1080/// pass begin/end explicitly.
1081template <typename R, typename UnaryPredicate>
1082auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1083  return std::remove_if(adl_begin(Range), adl_end(Range), P);
1084}
1085 
1086/// Provide wrappers to std::copy_if which take ranges instead of having to
1087/// pass begin/end explicitly.
1088template <typename R, typename OutputIt, typename UnaryPredicate>
1089OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) {
1090  return std::copy_if(adl_begin(Range), adl_end(Range), Out, P);
1091}
1092 
1093template <typename R, typename OutputIt>
1094OutputIt copy(R &&Range, OutputIt Out) {
1095  return std::copy(adl_begin(Range), adl_end(Range), Out);
1096}
1097 
1098/// Wrapper function around std::find to detect if an element exists
1099/// in a container.
1100template <typename R, typename E>
1101bool is_contained(R &&Range, const E &Element) {
1102  return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range);
1103}
1104 
1105/// Wrapper function around std::count to count the number of times an element
1106/// \p Element occurs in the given range \p Range.
1107template <typename R, typename E>
1108auto count(R &&Range, const E &Element) ->
1109    typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1110  return std::count(adl_begin(Range), adl_end(Range), Element);
1111}
1112 
1113/// Wrapper function around std::count_if to count the number of times an
1114/// element satisfying a given predicate occurs in a range.
1115template <typename R, typename UnaryPredicate>
1116auto count_if(R &&Range, UnaryPredicate P) ->
1117    typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1118  return std::count_if(adl_begin(Range), adl_end(Range), P);
1119}
1120 
1121/// Wrapper function around std::transform to apply a function to a range and
1122/// store the result elsewhere.
1123template <typename R, typename OutputIt, typename UnaryPredicate>
1124OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) {
1125  return std::transform(adl_begin(Range), adl_end(Range), d_first, P);
1126}
1127 
1128/// Provide wrappers to std::partition which take ranges instead of having to
1129/// pass begin/end explicitly.
1130template <typename R, typename UnaryPredicate>
1131auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1132  return std::partition(adl_begin(Range), adl_end(Range), P);
1133}
1134 
1135/// Provide wrappers to std::lower_bound which take ranges instead of having to
1136/// pass begin/end explicitly.
1137template <typename R, typename ForwardIt>
1138auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1139  return std::lower_bound(adl_begin(Range), adl_end(Range), I);
1140}
1141 
1142template <typename R, typename ForwardIt, typename Compare>
1143auto lower_bound(R &&Range, ForwardIt I, Compare C)
1144    -> decltype(adl_begin(Range)) {
1145  return std::lower_bound(adl_begin(Range), adl_end(Range), I, C);
1146}
1147 
1148/// Provide wrappers to std::upper_bound which take ranges instead of having to
1149/// pass begin/end explicitly.
1150template <typename R, typename ForwardIt>
1151auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1152  return std::upper_bound(adl_begin(Range), adl_end(Range), I);
1153}
1154 
1155template <typename R, typename ForwardIt, typename Compare>
1156auto upper_bound(R &&Range, ForwardIt I, Compare C)
1157    -> decltype(adl_begin(Range)) {
1158  return std::upper_bound(adl_begin(Range), adl_end(Range), I, C);
1159}
1160/// Wrapper function around std::equal to detect if all elements
1161/// in a container are same.
1162template <typename R>
1163bool is_splat(R &&Range) {
1164  size_t range_size = size(Range);
1165  return range_size != 0 && (range_size == 1 ||
1166         std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range)));
1167}
1168 
1169/// Given a range of type R, iterate the entire range and return a
1170/// SmallVector with elements of the vector.  This is useful, for example,
1171/// when you want to iterate a range and then sort the results.
1172template <unsigned Size, typename R>
1173SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size>
1174to_vector(R &&Range) {
1175  return {adl_begin(Range), adl_end(Range)};
1176}
1177 
1178/// Provide a container algorithm similar to C++ Library Fundamentals v2's
1179/// `erase_if` which is equivalent to:
1180///
1181///   C.erase(remove_if(C, pred), C.end());
1182///
1183/// This version works for any container with an erase method call accepting
1184/// two iterators.
1185template <typename Container, typename UnaryPredicate>
1186void erase_if(Container &C, UnaryPredicate P) {
1187  C.erase(remove_if(C, P), C.end());
1188}
1189 
1190//===----------------------------------------------------------------------===//
1191//     Extra additions to <memory>
1192//===----------------------------------------------------------------------===//
1193 
1194// Implement make_unique according to N3656.
1195 
1196/// Constructs a `new T()` with the given args and returns a
1197///        `unique_ptr<T>` which owns the object.
1198///
1199/// Example:
1200///
1201///     auto p = make_unique<int>();
1202///     auto p = make_unique<std::tuple<int, int>>(0, 1);
1203template <class T, class... Args>
1204typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
1205make_unique(Args &&... args) {
1206  return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
11
←
Memory is allocated→
1207}
1208 
1209/// Constructs a `new T[n]` with the given args and returns a
1210///        `unique_ptr<T[]>` which owns the object.
1211///
1212/// \param n size of the new array.
1213///
1214/// Example:
1215///
1216///     auto p = make_unique<int[]>(2); // value-initializes the array with 0's.
1217template <class T>
1218typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0,
1219                        std::unique_ptr<T>>::type
1220make_unique(size_t n) {
1221  return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]());
1222}
1223 
1224/// This function isn't used and is only here to provide better compile errors.
1225template <class T, class... Args>
1226typename std::enable_if<std::extent<T>::value != 0>::type
1227make_unique(Args &&...) = delete;
1228 
1229struct FreeDeleter {
1230  void operator()(void* v) {
1231    ::free(v);
1232  }
1233};
1234 
1235template<typename First, typename Second>
1236struct pair_hash {
1237  size_t operator()(const std::pair<First, Second> &P) const {
1238    return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second);
1239  }
1240};
1241 
1242/// A functor like C++14's std::less<void> in its absence.
1243struct less {
1244  template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1245    return std::forward<A>(a) < std::forward<B>(b);
1246  }
1247};
1248 
1249/// A functor like C++14's std::equal<void> in its absence.
1250struct equal {
1251  template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1252    return std::forward<A>(a) == std::forward<B>(b);
1253  }
1254};
1255 
1256/// Binary functor that adapts to any other binary functor after dereferencing
1257/// operands.
1258template <typename T> struct deref {
1259  T func;
1260 
1261  // Could be further improved to cope with non-derivable functors and
1262  // non-binary functors (should be a variadic template member function
1263  // operator()).
1264  template <typename A, typename B>
1265  auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) {
1266    assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1266, __PRETTY_FUNCTION__));
1267    assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1267, __PRETTY_FUNCTION__));
1268    return func(*lhs, *rhs);
1269  }
1270};
1271 
1272namespace detail {
1273 
1274template <typename R> class enumerator_iter;
1275 
1276template <typename R> struct result_pair {
1277  friend class enumerator_iter<R>;
1278 
1279  result_pair() = default;
1280  result_pair(std::size_t Index, IterOfRange<R> Iter)
1281      : Index(Index), Iter(Iter) {}
1282 
1283  result_pair<R> &operator=(const result_pair<R> &Other) {
1284    Index = Other.Index;
1285    Iter = Other.Iter;
1286    return *this;
1287  }
1288 
1289  std::size_t index() const { return Index; }
1290  const ValueOfRange<R> &value() const { return *Iter; }
1291  ValueOfRange<R> &value() { return *Iter; }
1292 
1293private:
1294  std::size_t Index = std::numeric_limits<std::size_t>::max();
1295  IterOfRange<R> Iter;
1296};
1297 
1298template <typename R>
1299class enumerator_iter
1300    : public iterator_facade_base<
1301          enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>,
1302          typename std::iterator_traits<IterOfRange<R>>::difference_type,
1303          typename std::iterator_traits<IterOfRange<R>>::pointer,
1304          typename std::iterator_traits<IterOfRange<R>>::reference> {
1305  using result_type = result_pair<R>;
1306 
1307public:
1308  explicit enumerator_iter(IterOfRange<R> EndIter)
1309      : Result(std::numeric_limits<size_t>::max(), EndIter) {}
1310 
1311  enumerator_iter(std::size_t Index, IterOfRange<R> Iter)
1312      : Result(Index, Iter) {}
1313 
1314  result_type &operator*() { return Result; }
1315  const result_type &operator*() const { return Result; }
1316 
1317  enumerator_iter<R> &operator++() {
1318    assert(Result.Index != std::numeric_limits<size_t>::max())((Result.Index != std::numeric_limits<size_t>::max()) ?
 static_cast<void> (0) : __assert_fail ("Result.Index != std::numeric_limits<size_t>::max()"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1318, __PRETTY_FUNCTION__));
1319    ++Result.Iter;
1320    ++Result.Index;
1321    return *this;
1322  }
1323 
1324  bool operator==(const enumerator_iter<R> &RHS) const {
1325    // Don't compare indices here, only iterators.  It's possible for an end
1326    // iterator to have different indices depending on whether it was created
1327    // by calling std::end() versus incrementing a valid iterator.
1328    return Result.Iter == RHS.Result.Iter;
1329  }
1330 
1331  enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) {
1332    Result = Other.Result;
1333    return *this;
1334  }
1335 
1336private:
1337  result_type Result;
1338};
1339 
1340template <typename R> class enumerator {
1341public:
1342  explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {}
1343 
1344  enumerator_iter<R> begin() {
1345    return enumerator_iter<R>(0, std::begin(TheRange));
1346  }
1347 
1348  enumerator_iter<R> end() {
1349    return enumerator_iter<R>(std::end(TheRange));
1350  }
1351 
1352private:
1353  R TheRange;
1354};
1355 
1356} // end namespace detail
1357 
1358/// Given an input range, returns a new range whose values are are pair (A,B)
1359/// such that A is the 0-based index of the item in the sequence, and B is
1360/// the value from the original sequence.  Example:
1361///
1362/// std::vector<char> Items = {'A', 'B', 'C', 'D'};
1363/// for (auto X : enumerate(Items)) {
1364///   printf("Item %d - %c\n", X.index(), X.value());
1365/// }
1366///
1367/// Output:
1368///   Item 0 - A
1369///   Item 1 - B
1370///   Item 2 - C
1371///   Item 3 - D
1372///
1373template <typename R> detail::enumerator<R> enumerate(R &&TheRange) {
1374  return detail::enumerator<R>(std::forward<R>(TheRange));
1375}
1376 
1377namespace detail {
1378 
1379template <typename F, typename Tuple, std::size_t... I>
1380auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>)
1381    -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) {
1382  return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...);
1383}
1384 
1385} // end namespace detail
1386 
1387/// Given an input tuple (a1, a2, ..., an), pass the arguments of the
1388/// tuple variadically to f as if by calling f(a1, a2, ..., an) and
1389/// return the result.
1390template <typename F, typename Tuple>
1391auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl(
1392    std::forward<F>(f), std::forward<Tuple>(t),
1393    build_index_impl<
1394        std::tuple_size<typename std::decay<Tuple>::type>::value>{})) {
1395  using Indices = build_index_impl<
1396      std::tuple_size<typename std::decay<Tuple>::type>::value>;
1397 
1398  return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t),
1399                                  Indices{});
1400}
1401 
1402} // end namespace llvm
1403 
1404#endif // LLVM_ADT_STLEXTRAS_H