/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 llvm-objdump.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/llvm-objdump -I /build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump -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/llvm-objdump -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/llvm-objdump/llvm-objdump.cpp -faddrsig

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

→

1//===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
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 program is a utility that works like binutils "objdump", that is, it
11// dumps out a plethora of information about an object file depending on the
12// flags.
13//
14// The flags and output of this program should be near identical to those of
15// binutils objdump.
16//
17//===----------------------------------------------------------------------===//

19#include "llvm-objdump.h"
20#include "llvm/ADT/Optional.h"
21#include "llvm/ADT/STLExtras.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/StringSet.h"
24#include "llvm/ADT/Triple.h"
25#include "llvm/CodeGen/FaultMaps.h"
26#include "llvm/DebugInfo/DWARF/DWARFContext.h"
27#include "llvm/DebugInfo/Symbolize/Symbolize.h"
28#include "llvm/Demangle/Demangle.h"
29#include "llvm/MC/MCAsmInfo.h"
30#include "llvm/MC/MCContext.h"
31#include "llvm/MC/MCDisassembler/MCDisassembler.h"
32#include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
33#include "llvm/MC/MCInst.h"
34#include "llvm/MC/MCInstPrinter.h"
35#include "llvm/MC/MCInstrAnalysis.h"
36#include "llvm/MC/MCInstrInfo.h"
37#include "llvm/MC/MCObjectFileInfo.h"
38#include "llvm/MC/MCRegisterInfo.h"
39#include "llvm/MC/MCSubtargetInfo.h"
40#include "llvm/Object/Archive.h"
41#include "llvm/Object/COFF.h"
42#include "llvm/Object/COFFImportFile.h"
43#include "llvm/Object/ELFObjectFile.h"
44#include "llvm/Object/MachO.h"
45#include "llvm/Object/MachOUniversal.h"
46#include "llvm/Object/ObjectFile.h"
47#include "llvm/Object/Wasm.h"
48#include "llvm/Support/Casting.h"
49#include "llvm/Support/CommandLine.h"
50#include "llvm/Support/Debug.h"
51#include "llvm/Support/Errc.h"
52#include "llvm/Support/FileSystem.h"
53#include "llvm/Support/Format.h"
54#include "llvm/Support/GraphWriter.h"
55#include "llvm/Support/Host.h"
56#include "llvm/Support/InitLLVM.h"
57#include "llvm/Support/MemoryBuffer.h"
58#include "llvm/Support/SourceMgr.h"
59#include "llvm/Support/StringSaver.h"
60#include "llvm/Support/TargetRegistry.h"
61#include "llvm/Support/TargetSelect.h"
62#include "llvm/Support/raw_ostream.h"
63#include <algorithm>
64#include <cctype>
65#include <cstring>
66#include <system_error>
67#include <unordered_map>
68#include <utility>

70using namespace llvm;
71using namespace object;

73cl::opt<bool>
  llvm::AllHeaders("all-headers",
                   cl::desc("Display all available header information"));
76static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
                               cl::aliasopt(AllHeaders));

79static cl::list<std::string>
80InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);

82cl::opt<bool>
83llvm::Disassemble("disassemble",
cl::desc("Display assembler mnemonics for the machine instructions"));
85static cl::alias
86Disassembled("d", cl::desc("Alias for --disassemble"),
           cl::aliasopt(Disassemble));

89cl::opt<bool>
90llvm::DisassembleAll("disassemble-all",
cl::desc("Display assembler mnemonics for the machine instructions"));
92static cl::alias
93DisassembleAlld("D", cl::desc("Alias for --disassemble-all"),
           cl::aliasopt(DisassembleAll));

96cl::opt<bool> llvm::Demangle("demangle", cl::desc("Demangle symbols names"),
                           cl::init(false));

99static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
                             cl::aliasopt(llvm::Demangle));

102static cl::list<std::string>
103DisassembleFunctions("df",
                   cl::CommaSeparated,
                   cl::desc("List of functions to disassemble"));
106static StringSet<> DisasmFuncsSet;

108cl::opt<bool>
109llvm::Relocations("r", cl::desc("Display the relocation entries in the file"));

111cl::opt<bool>
112llvm::DynamicRelocations("dynamic-reloc",
cl::desc("Display the dynamic relocation entries in the file"));
114static cl::alias
115DynamicRelocationsd("R", cl::desc("Alias for --dynamic-reloc"),
           cl::aliasopt(DynamicRelocations));

118cl::opt<bool>
119llvm::SectionContents("s", cl::desc("Display the content of each section"));

121cl::opt<bool>
122llvm::SymbolTable("t", cl::desc("Display the symbol table"));

124cl::opt<bool>
125llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));

127cl::opt<bool>
128llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));

130cl::opt<bool>
131llvm::Bind("bind", cl::desc("Display mach-o binding info"));

133cl::opt<bool>
134llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));

136cl::opt<bool>
137llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));

139cl::opt<bool>
140llvm::RawClangAST("raw-clang-ast",
  cl::desc("Dump the raw binary contents of the clang AST section"));

143static cl::opt<bool>
144MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
145static cl::alias
146MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));

148cl::opt<std::string>
149llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
                                  "see -version for available targets"));

152cl::opt<std::string>
153llvm::MCPU("mcpu",
   cl::desc("Target a specific cpu type (-mcpu=help for details)"),
   cl::value_desc("cpu-name"),
   cl::init(""));

158cl::opt<std::string>
159llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
                              "see -version for available targets"));

162cl::opt<bool>
163llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
                                               "headers for each section."));
165static cl::alias
166SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
                  cl::aliasopt(SectionHeaders));
168static cl::alias
169SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
                    cl::aliasopt(SectionHeaders));

172cl::list<std::string>
173llvm::FilterSections("section", cl::desc("Operate on the specified sections only. "
                                       "With -macho dump segment,section"));
175cl::alias
176static FilterSectionsj("j", cl::desc("Alias for --section"),
               cl::aliasopt(llvm::FilterSections));

179cl::list<std::string>
180llvm::MAttrs("mattr",
cl::CommaSeparated,
cl::desc("Target specific attributes"),
cl::value_desc("a1,+a2,-a3,..."));

185cl::opt<bool>
186llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
                                               "instructions, do not print "
                                               "the instruction bytes."));
189cl::opt<bool>
190llvm::NoLeadingAddr("no-leading-addr", cl::desc("Print no leading address"));

192cl::opt<bool>
193llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));

195static cl::alias
196UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
              cl::aliasopt(UnwindInfo));

199cl::opt<bool>
200llvm::PrivateHeaders("private-headers",
                   cl::desc("Display format specific file headers"));

203cl::opt<bool>
204llvm::FirstPrivateHeader("private-header",
                       cl::desc("Display only the first format specific file "
                                "header"));

208static cl::alias
209PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
                  cl::aliasopt(PrivateHeaders));

212cl::opt<bool> llvm::FileHeaders(
  "file-headers",
  cl::desc("Display the contents of the overall file header"));

216static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
                                cl::aliasopt(FileHeaders));

219cl::opt<bool>
  llvm::ArchiveHeaders("archive-headers",
                       cl::desc("Display archive header information"));

223cl::alias
224ArchiveHeadersShort("a", cl::desc("Alias for --archive-headers"),
                  cl::aliasopt(ArchiveHeaders));

227cl::opt<bool>
  llvm::PrintImmHex("print-imm-hex",
                    cl::desc("Use hex format for immediate values"));

231cl::opt<bool> PrintFaultMaps("fault-map-section",
                           cl::desc("Display contents of faultmap section"));

234cl::opt<DIDumpType> llvm::DwarfDumpType(
  "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
  cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")llvm::cl::OptionEnumValue { "frames", int(DIDT_DebugFrame), ".debug_frame"
 }));

238cl::opt<bool> PrintSource(
  "source",
  cl::desc(
      "Display source inlined with disassembly. Implies disassemble object"));

243cl::alias PrintSourceShort("S", cl::desc("Alias for -source"),
                         cl::aliasopt(PrintSource));

246cl::opt<bool> PrintLines("line-numbers",
                       cl::desc("Display source line numbers with "
                                "disassembly. Implies disassemble object"));

250cl::alias PrintLinesShort("l", cl::desc("Alias for -line-numbers"),
                        cl::aliasopt(PrintLines));

253cl::opt<unsigned long long>
  StartAddress("start-address", cl::desc("Disassemble beginning at address"),
               cl::value_desc("address"), cl::init(0));
256cl::opt<unsigned long long>
  StopAddress("stop-address", cl::desc("Stop disassembly at address"),
              cl::value_desc("address"), cl::init(UINT64_MAX(18446744073709551615UL)));
259static StringRef ToolName;

261typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;

263namespace {
264typedef std::function<bool(llvm::object::SectionRef const &)> FilterPredicate;

266class SectionFilterIterator {
267public:
SectionFilterIterator(FilterPredicate P,
                      llvm::object::section_iterator const &I,
                      llvm::object::section_iterator const &E)
    : Predicate(std::move(P)), Iterator(I), End(E) {
  ScanPredicate();
}
const llvm::object::SectionRef &operator*() const { return *Iterator; }
SectionFilterIterator &operator++() {
  ++Iterator;
  ScanPredicate();
  return *this;
}
bool operator!=(SectionFilterIterator const &Other) const {
  return Iterator != Other.Iterator;
}

284private:
void ScanPredicate() {
  while (Iterator != End && !Predicate(*Iterator)) {
    ++Iterator;
  }
}
FilterPredicate Predicate;
llvm::object::section_iterator Iterator;
llvm::object::section_iterator End;
293};

295class SectionFilter {
296public:
SectionFilter(FilterPredicate P, llvm::object::ObjectFile const &O)
    : Predicate(std::move(P)), Object(O) {}
SectionFilterIterator begin() {
  return SectionFilterIterator(Predicate, Object.section_begin(),
                               Object.section_end());
}
SectionFilterIterator end() {
  return SectionFilterIterator(Predicate, Object.section_end(),
                               Object.section_end());
}

308private:
FilterPredicate Predicate;
llvm::object::ObjectFile const &Object;
311};
312SectionFilter ToolSectionFilter(llvm::object::ObjectFile const &O) {
return SectionFilter(
    [](llvm::object::SectionRef const &S) {
      if (FilterSections.empty())
        return true;
      llvm::StringRef String;
      std::error_code error = S.getName(String);
      if (error)
        return false;
      return is_contained(FilterSections, String);
    },
    O);
324}
325}

327void llvm::error(std::error_code EC) {
if (!EC)
  return;

errs() << ToolName << ": error reading file: " << EC.message() << ".\n";
errs().flush();
exit(1);
334}

336LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::error(Twine Message) {
errs() << ToolName << ": " << Message << ".\n";
errs().flush();
exit(1);
340}

342void llvm::warn(StringRef Message) {
errs() << ToolName << ": warning: " << Message << ".\n";
errs().flush();
345}

347LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::report_error(StringRef File,
                                              Twine Message) {
errs() << ToolName << ": '" << File << "': " << Message << ".\n";
exit(1);
351}

353LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::report_error(StringRef File,
                                              std::error_code EC) {
assert(EC)((EC) ? static_cast<void> (0) : __assert_fail ("EC", "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 355, __PRETTY_FUNCTION__));
errs() << ToolName << ": '" << File << "': " << EC.message() << ".\n";
exit(1);
358}

360LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::report_error(StringRef File,
                                              llvm::Error E) {
assert(E)((E) ? static_cast<void> (0) : __assert_fail ("E", "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 362, __PRETTY_FUNCTION__));
std::string Buf;
raw_string_ostream OS(Buf);
logAllUnhandledErrors(std::move(E), OS, "");
OS.flush();
errs() << ToolName << ": '" << File << "': " << Buf;
exit(1);
369}

371LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::report_error(StringRef ArchiveName,
                                              StringRef FileName,
                                              llvm::Error E,
                                              StringRef ArchitectureName) {
assert(E)((E) ? static_cast<void> (0) : __assert_fail ("E", "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 375, __PRETTY_FUNCTION__));
errs() << ToolName << ": ";
if (ArchiveName != "")
  errs() << ArchiveName << "(" << FileName << ")";
else
  errs() << "'" << FileName << "'";
if (!ArchitectureName.empty())
  errs() << " (for architecture " << ArchitectureName << ")";
std::string Buf;
raw_string_ostream OS(Buf);
logAllUnhandledErrors(std::move(E), OS, "");
OS.flush();
errs() << ": " << Buf;
exit(1);
389}

391LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void llvm::report_error(StringRef ArchiveName,
                                              const object::Archive::Child &C,
                                              llvm::Error E,
                                              StringRef ArchitectureName) {
Expected<StringRef> NameOrErr = C.getName();
// TODO: if we have a error getting the name then it would be nice to print
// the index of which archive member this is and or its offset in the
// archive instead of "???" as the name.
if (!NameOrErr) {
  consumeError(NameOrErr.takeError());
  llvm::report_error(ArchiveName, "???", std::move(E), ArchitectureName);
} else
  llvm::report_error(ArchiveName, NameOrErr.get(), std::move(E),
                     ArchitectureName);
405}

407static const Target *getTarget(const ObjectFile *Obj = nullptr) {
// Figure out the target triple.
llvm::Triple TheTriple("unknown-unknown-unknown");
if (TripleName.empty()) {
  if (Obj) {
    TheTriple = Obj->makeTriple();
  }
} else {
  TheTriple.setTriple(Triple::normalize(TripleName));

  // Use the triple, but also try to combine with ARM build attributes.
  if (Obj) {
    auto Arch = Obj->getArch();
    if (Arch == Triple::arm || Arch == Triple::armeb) {
      Obj->setARMSubArch(TheTriple);
    }
  }
}

// Get the target specific parser.
std::string Error;
const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
                                                       Error);
if (!TheTarget) {
  if (Obj)
    report_error(Obj->getFileName(), "can't find target: " + Error);
  else
    error("can't find target: " + Error);
}

// Update the triple name and return the found target.
TripleName = TheTriple.getTriple();
return TheTarget;
440}

442bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
return a.getOffset() < b.getOffset();
444}

446template <class ELFT>
447static std::error_code getRelocationValueString(const ELFObjectFile<ELFT> *Obj,
                                              const RelocationRef &RelRef,
                                              SmallVectorImpl<char> &Result) {
DataRefImpl Rel = RelRef.getRawDataRefImpl();

typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
typedef typename ELFObjectFile<ELFT>::Elf_Rela Elf_Rela;

const ELFFile<ELFT> &EF = *Obj->getELFFile();

auto SecOrErr = EF.getSection(Rel.d.a);
if (!SecOrErr)
  return errorToErrorCode(SecOrErr.takeError());
const Elf_Shdr *Sec = *SecOrErr;
auto SymTabOrErr = EF.getSection(Sec->sh_link);
if (!SymTabOrErr)
  return errorToErrorCode(SymTabOrErr.takeError());
const Elf_Shdr *SymTab = *SymTabOrErr;
assert(SymTab->sh_type == ELF::SHT_SYMTAB ||((SymTab->sh_type == ELF::SHT_SYMTAB || SymTab->sh_type
 == ELF::SHT_DYNSYM) ? static_cast<void> (0) : __assert_fail
 ("SymTab->sh_type == ELF::SHT_SYMTAB || SymTab->sh_type == ELF::SHT_DYNSYM"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 467, __PRETTY_FUNCTION__))
       SymTab->sh_type == ELF::SHT_DYNSYM)((SymTab->sh_type == ELF::SHT_SYMTAB || SymTab->sh_type
 == ELF::SHT_DYNSYM) ? static_cast<void> (0) : __assert_fail
 ("SymTab->sh_type == ELF::SHT_SYMTAB || SymTab->sh_type == ELF::SHT_DYNSYM"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 467, __PRETTY_FUNCTION__));
auto StrTabSec = EF.getSection(SymTab->sh_link);
if (!StrTabSec)
  return errorToErrorCode(StrTabSec.takeError());
auto StrTabOrErr = EF.getStringTable(*StrTabSec);
if (!StrTabOrErr)
  return errorToErrorCode(StrTabOrErr.takeError());
StringRef StrTab = *StrTabOrErr;
int64_t addend = 0;
// If there is no Symbol associated with the relocation, we set the undef
// boolean value to 'true'. This will prevent us from calling functions that
// requires the relocation to be associated with a symbol.
bool undef = false;
switch (Sec->sh_type) {
default:
  return object_error::parse_failed;
case ELF::SHT_REL: {
  // TODO: Read implicit addend from section data.
  break;
}
case ELF::SHT_RELA: {
  const Elf_Rela *ERela = Obj->getRela(Rel);
  addend = ERela->r_addend;
  undef = ERela->getSymbol(false) == 0;
  break;
}
}
StringRef Target;
if (!undef) {
  symbol_iterator SI = RelRef.getSymbol();
  const Elf_Sym *symb = Obj->getSymbol(SI->getRawDataRefImpl());
  if (symb->getType() == ELF::STT_SECTION) {
    Expected<section_iterator> SymSI = SI->getSection();
    if (!SymSI)
      return errorToErrorCode(SymSI.takeError());
    const Elf_Shdr *SymSec = Obj->getSection((*SymSI)->getRawDataRefImpl());
    auto SecName = EF.getSectionName(SymSec);
    if (!SecName)
      return errorToErrorCode(SecName.takeError());
    Target = *SecName;
  } else {
    Expected<StringRef> SymName = symb->getName(StrTab);
    if (!SymName)
      return errorToErrorCode(SymName.takeError());
    Target = *SymName;
  }
} else
  Target = "*ABS*";

// Default scheme is to print Target, as well as "+ <addend>" for nonzero
// addend. Should be acceptable for all normal purposes.
std::string fmtbuf;
raw_string_ostream fmt(fmtbuf);
fmt << Target;
if (addend != 0)
  fmt << (addend < 0 ? "" : "+") << addend;
fmt.flush();
Result.append(fmtbuf.begin(), fmtbuf.end());
return std::error_code();
526}

528static std::error_code getRelocationValueString(const ELFObjectFileBase *Obj,
                                              const RelocationRef &Rel,
                                              SmallVectorImpl<char> &Result) {
if (auto *ELF32LE = dyn_cast<ELF32LEObjectFile>(Obj))
  return getRelocationValueString(ELF32LE, Rel, Result);
if (auto *ELF64LE = dyn_cast<ELF64LEObjectFile>(Obj))
  return getRelocationValueString(ELF64LE, Rel, Result);
if (auto *ELF32BE = dyn_cast<ELF32BEObjectFile>(Obj))
  return getRelocationValueString(ELF32BE, Rel, Result);
auto *ELF64BE = cast<ELF64BEObjectFile>(Obj);
return getRelocationValueString(ELF64BE, Rel, Result);
539}

541static std::error_code getRelocationValueString(const COFFObjectFile *Obj,
                                              const RelocationRef &Rel,
                                              SmallVectorImpl<char> &Result) {
symbol_iterator SymI = Rel.getSymbol();
Expected<StringRef> SymNameOrErr = SymI->getName();
if (!SymNameOrErr)
  return errorToErrorCode(SymNameOrErr.takeError());
StringRef SymName = *SymNameOrErr;
Result.append(SymName.begin(), SymName.end());
return std::error_code();
551}

553static void printRelocationTargetName(const MachOObjectFile *O,
                                    const MachO::any_relocation_info &RE,
                                    raw_string_ostream &fmt) {
bool IsScattered = O->isRelocationScattered(RE);

// Target of a scattered relocation is an address.  In the interest of
// generating pretty output, scan through the symbol table looking for a
// symbol that aligns with that address.  If we find one, print it.
// Otherwise, we just print the hex address of the target.
if (IsScattered) {
  uint32_t Val = O->getPlainRelocationSymbolNum(RE);

  for (const SymbolRef &Symbol : O->symbols()) {
    std::error_code ec;
    Expected<uint64_t> Addr = Symbol.getAddress();
    if (!Addr)
      report_error(O->getFileName(), Addr.takeError());
    if (*Addr != Val)
      continue;
    Expected<StringRef> Name = Symbol.getName();
    if (!Name)
      report_error(O->getFileName(), Name.takeError());
    fmt << *Name;
    return;
  }

  // If we couldn't find a symbol that this relocation refers to, try
  // to find a section beginning instead.
  for (const SectionRef &Section : ToolSectionFilter(*O)) {
    std::error_code ec;

    StringRef Name;
    uint64_t Addr = Section.getAddress();
    if (Addr != Val)
      continue;
    if ((ec = Section.getName(Name)))
      report_error(O->getFileName(), ec);
    fmt << Name;
    return;
  }

  fmt << format("0x%x", Val);
  return;
}

StringRef S;
bool isExtern = O->getPlainRelocationExternal(RE);
uint64_t Val = O->getPlainRelocationSymbolNum(RE);

if (O->getAnyRelocationType(RE) == MachO::ARM64_RELOC_ADDEND) {
  fmt << format("0x%0" PRIx64"l" "x", Val);
  return;
} else if (isExtern) {
  symbol_iterator SI = O->symbol_begin();
  advance(SI, Val);
  Expected<StringRef> SOrErr = SI->getName();
  if (!SOrErr)
    report_error(O->getFileName(), SOrErr.takeError());
  S = *SOrErr;
} else {
  section_iterator SI = O->section_begin();
  // Adjust for the fact that sections are 1-indexed.
  if (Val == 0) {
    fmt << "0 (?,?)";
    return;
  }
  uint32_t i = Val - 1;
  while (i != 0 && SI != O->section_end()) {
    i--;
    advance(SI, 1);
  }
  if (SI == O->section_end())
    fmt << Val << " (?,?)";
  else
    SI->getName(S);
}

fmt << S;
631}

633static std::error_code getRelocationValueString(const WasmObjectFile *Obj,
                                              const RelocationRef &RelRef,
                                              SmallVectorImpl<char> &Result) {
const wasm::WasmRelocation& Rel = Obj->getWasmRelocation(RelRef);
symbol_iterator SI = RelRef.getSymbol();
std::string fmtbuf;
raw_string_ostream fmt(fmtbuf);
if (SI == Obj->symbol_end()) {
  // Not all wasm relocations have symbols associated with them.
  // In particular R_WEBASSEMBLY_TYPE_INDEX_LEB.
  fmt << Rel.Index;
} else {
  Expected<StringRef> SymNameOrErr = SI->getName();
  if (!SymNameOrErr)
    return errorToErrorCode(SymNameOrErr.takeError());
  StringRef SymName = *SymNameOrErr;
  Result.append(SymName.begin(), SymName.end());
}
fmt << (Rel.Addend < 0 ? "" : "+") << Rel.Addend;
fmt.flush();
Result.append(fmtbuf.begin(), fmtbuf.end());
return std::error_code();
655}

657static std::error_code getRelocationValueString(const MachOObjectFile *Obj,
                                              const RelocationRef &RelRef,
                                              SmallVectorImpl<char> &Result) {
DataRefImpl Rel = RelRef.getRawDataRefImpl();
MachO::any_relocation_info RE = Obj->getRelocation(Rel);

unsigned Arch = Obj->getArch();

std::string fmtbuf;
raw_string_ostream fmt(fmtbuf);
unsigned Type = Obj->getAnyRelocationType(RE);
bool IsPCRel = Obj->getAnyRelocationPCRel(RE);

// Determine any addends that should be displayed with the relocation.
// These require decoding the relocation type, which is triple-specific.

// X86_64 has entirely custom relocation types.
if (Arch == Triple::x86_64) {
  bool isPCRel = Obj->getAnyRelocationPCRel(RE);

  switch (Type) {
  case MachO::X86_64_RELOC_GOT_LOAD:
  case MachO::X86_64_RELOC_GOT: {
    printRelocationTargetName(Obj, RE, fmt);
    fmt << "@GOT";
    if (isPCRel)
      fmt << "PCREL";
    break;
  }
  case MachO::X86_64_RELOC_SUBTRACTOR: {
    DataRefImpl RelNext = Rel;
    Obj->moveRelocationNext(RelNext);
    MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);

    // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
    // X86_64_RELOC_UNSIGNED.
    // NOTE: Scattered relocations don't exist on x86_64.
    unsigned RType = Obj->getAnyRelocationType(RENext);
    if (RType != MachO::X86_64_RELOC_UNSIGNED)
      report_error(Obj->getFileName(), "Expected X86_64_RELOC_UNSIGNED after "
                   "X86_64_RELOC_SUBTRACTOR.");

    // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
    // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
    printRelocationTargetName(Obj, RENext, fmt);
    fmt << "-";
    printRelocationTargetName(Obj, RE, fmt);
    break;
  }
  case MachO::X86_64_RELOC_TLV:
    printRelocationTargetName(Obj, RE, fmt);
    fmt << "@TLV";
    if (isPCRel)
      fmt << "P";
    break;
  case MachO::X86_64_RELOC_SIGNED_1:
    printRelocationTargetName(Obj, RE, fmt);
    fmt << "-1";
    break;
  case MachO::X86_64_RELOC_SIGNED_2:
    printRelocationTargetName(Obj, RE, fmt);
    fmt << "-2";
    break;
  case MachO::X86_64_RELOC_SIGNED_4:
    printRelocationTargetName(Obj, RE, fmt);
    fmt << "-4";
    break;
  default:
    printRelocationTargetName(Obj, RE, fmt);
    break;
  }
  // X86 and ARM share some relocation types in common.
} else if (Arch == Triple::x86 || Arch == Triple::arm ||
           Arch == Triple::ppc) {
  // Generic relocation types...
  switch (Type) {
  case MachO::GENERIC_RELOC_PAIR: // prints no info
    return std::error_code();
  case MachO::GENERIC_RELOC_SECTDIFF: {
    DataRefImpl RelNext = Rel;
    Obj->moveRelocationNext(RelNext);
    MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);

    // X86 sect diff's must be followed by a relocation of type
    // GENERIC_RELOC_PAIR.
    unsigned RType = Obj->getAnyRelocationType(RENext);

    if (RType != MachO::GENERIC_RELOC_PAIR)
      report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
                   "GENERIC_RELOC_SECTDIFF.");

    printRelocationTargetName(Obj, RE, fmt);
    fmt << "-";
    printRelocationTargetName(Obj, RENext, fmt);
    break;
  }
  }

  if (Arch == Triple::x86 || Arch == Triple::ppc) {
    switch (Type) {
    case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
      DataRefImpl RelNext = Rel;
      Obj->moveRelocationNext(RelNext);
      MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);

      // X86 sect diff's must be followed by a relocation of type
      // GENERIC_RELOC_PAIR.
      unsigned RType = Obj->getAnyRelocationType(RENext);
      if (RType != MachO::GENERIC_RELOC_PAIR)
        report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
                     "GENERIC_RELOC_LOCAL_SECTDIFF.");

      printRelocationTargetName(Obj, RE, fmt);
      fmt << "-";
      printRelocationTargetName(Obj, RENext, fmt);
      break;
    }
    case MachO::GENERIC_RELOC_TLV: {
      printRelocationTargetName(Obj, RE, fmt);
      fmt << "@TLV";
      if (IsPCRel)
        fmt << "P";
      break;
    }
    default:
      printRelocationTargetName(Obj, RE, fmt);
    }
  } else { // ARM-specific relocations
    switch (Type) {
    case MachO::ARM_RELOC_HALF:
    case MachO::ARM_RELOC_HALF_SECTDIFF: {
      // Half relocations steal a bit from the length field to encode
      // whether this is an upper16 or a lower16 relocation.
      bool isUpper = (Obj->getAnyRelocationLength(RE) & 0x1) == 1;

      if (isUpper)
        fmt << ":upper16:(";
      else
        fmt << ":lower16:(";
      printRelocationTargetName(Obj, RE, fmt);

      DataRefImpl RelNext = Rel;
      Obj->moveRelocationNext(RelNext);
      MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);

      // ARM half relocs must be followed by a relocation of type
      // ARM_RELOC_PAIR.
      unsigned RType = Obj->getAnyRelocationType(RENext);
      if (RType != MachO::ARM_RELOC_PAIR)
        report_error(Obj->getFileName(), "Expected ARM_RELOC_PAIR after "
                     "ARM_RELOC_HALF");

      // NOTE: The half of the target virtual address is stashed in the
      // address field of the secondary relocation, but we can't reverse
      // engineer the constant offset from it without decoding the movw/movt
      // instruction to find the other half in its immediate field.

      // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
      // symbol/section pointer of the follow-on relocation.
      if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
        fmt << "-";
        printRelocationTargetName(Obj, RENext, fmt);
      }

      fmt << ")";
      break;
    }
    default: { printRelocationTargetName(Obj, RE, fmt); }
    }
  }
} else
  printRelocationTargetName(Obj, RE, fmt);

fmt.flush();
Result.append(fmtbuf.begin(), fmtbuf.end());
return std::error_code();
833}

835static std::error_code getRelocationValueString(const RelocationRef &Rel,
                                              SmallVectorImpl<char> &Result) {
const ObjectFile *Obj = Rel.getObject();
if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
  return getRelocationValueString(ELF, Rel, Result);
if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
  return getRelocationValueString(COFF, Rel, Result);
if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
  return getRelocationValueString(Wasm, Rel, Result);
if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
  return getRelocationValueString(MachO, Rel, Result);
llvm_unreachable("unknown object file format")::llvm::llvm_unreachable_internal("unknown object file format"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 846);
847}

849/// Indicates whether this relocation should hidden when listing
850/// relocations, usually because it is the trailing part of a multipart
851/// relocation that will be printed as part of the leading relocation.
852static bool getHidden(RelocationRef RelRef) {
const ObjectFile *Obj = RelRef.getObject();
auto *MachO = dyn_cast<MachOObjectFile>(Obj);
if (!MachO)
  return false;

unsigned Arch = MachO->getArch();
DataRefImpl Rel = RelRef.getRawDataRefImpl();
uint64_t Type = MachO->getRelocationType(Rel);

// On arches that use the generic relocations, GENERIC_RELOC_PAIR
// is always hidden.
if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
  if (Type == MachO::GENERIC_RELOC_PAIR)
    return true;
} else if (Arch == Triple::x86_64) {
  // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
  // an X86_64_RELOC_SUBTRACTOR.
  if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
    DataRefImpl RelPrev = Rel;
    RelPrev.d.a--;
    uint64_t PrevType = MachO->getRelocationType(RelPrev);
    if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
      return true;
  }
}

return false;
880}

882namespace {
883class SourcePrinter {
884protected:
DILineInfo OldLineInfo;
const ObjectFile *Obj = nullptr;
std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
// File name to file contents of source
std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
// Mark the line endings of the cached source
std::unordered_map<std::string, std::vector<StringRef>> LineCache;

893private:
bool cacheSource(const DILineInfo& LineInfoFile);

896public:
SourcePrinter() = default;
SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
  symbolize::LLVMSymbolizer::Options SymbolizerOpts(
      DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
      DefaultArch);
  Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
}
virtual ~SourcePrinter() = default;
virtual void printSourceLine(raw_ostream &OS, uint64_t Address,
                             StringRef Delimiter = "; ");
907};

909bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
std::unique_ptr<MemoryBuffer> Buffer;
if (LineInfo.Source) {
  Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
} else {
  auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
  if (!BufferOrError)
    return false;
  Buffer = std::move(*BufferOrError);
}
// Chomp the file to get lines
size_t BufferSize = Buffer->getBufferSize();
const char *BufferStart = Buffer->getBufferStart();
for (const char *Start = BufferStart, *End = BufferStart;
     End < BufferStart + BufferSize; End++)
  if (*End == '\n' || End == BufferStart + BufferSize - 1 ||
      (*End == '\r' && *(End + 1) == '\n')) {
    LineCache[LineInfo.FileName].push_back(StringRef(Start, End - Start));
    if (*End == '\r')
      End++;
    Start = End + 1;
  }
SourceCache[LineInfo.FileName] = std::move(Buffer);
return true;
933}

935void SourcePrinter::printSourceLine(raw_ostream &OS, uint64_t Address,
                                  StringRef Delimiter) {
if (!Symbolizer)
  return;
DILineInfo LineInfo = DILineInfo();
auto ExpectecLineInfo =
    Symbolizer->symbolizeCode(Obj->getFileName(), Address);
if (!ExpectecLineInfo)
  consumeError(ExpectecLineInfo.takeError());
else
  LineInfo = *ExpectecLineInfo;

if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
    LineInfo.Line == 0)
  return;

if (PrintLines)
  OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
if (PrintSource) {
  if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
    if (!cacheSource(LineInfo))
      return;
  auto FileBuffer = SourceCache.find(LineInfo.FileName);
  if (FileBuffer != SourceCache.end()) {
    auto LineBuffer = LineCache.find(LineInfo.FileName);
    if (LineBuffer != LineCache.end()) {
      if (LineInfo.Line > LineBuffer->second.size())
        return;
      // Vector begins at 0, line numbers are non-zero
      OS << Delimiter << LineBuffer->second[LineInfo.Line - 1].ltrim()
         << "\n";
    }
  }
}
OldLineInfo = LineInfo;
970}

972static bool isArmElf(const ObjectFile *Obj) {
return (Obj->isELF() &&
        (Obj->getArch() == Triple::aarch64 ||
         Obj->getArch() == Triple::aarch64_be ||
         Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
         Obj->getArch() == Triple::thumb ||
         Obj->getArch() == Triple::thumbeb));
979}

981class PrettyPrinter {
982public:
virtual ~PrettyPrinter() = default;
virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
                       ArrayRef<uint8_t> Bytes, uint64_t Address,
                       raw_ostream &OS, StringRef Annot,
                       MCSubtargetInfo const &STI, SourcePrinter *SP,
                       std::vector<RelocationRef> *Rels = nullptr) {
  if (SP && (PrintSource || PrintLines))
    SP->printSourceLine(OS, Address);
  if (!NoLeadingAddr)
    OS << format("%8" PRIx64"l" "x" ":", Address);
  if (!NoShowRawInsn) {
    OS << "\t";
    dumpBytes(Bytes, OS);
  }
  if (MI)
    IP.printInst(MI, OS, "", STI);
  else
    OS << " <unknown>";
}
1002};
1003PrettyPrinter PrettyPrinterInst;
1004class HexagonPrettyPrinter : public PrettyPrinter {
1005public:
void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
               raw_ostream &OS) {
  uint32_t opcode =
    (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
  if (!NoLeadingAddr)
    OS << format("%8" PRIx64"l" "x" ":", Address);
  if (!NoShowRawInsn) {
    OS << "\t";
    dumpBytes(Bytes.slice(0, 4), OS);
    OS << format("%08" PRIx32"x", opcode);
  }
}
void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
               uint64_t Address, raw_ostream &OS, StringRef Annot,
               MCSubtargetInfo const &STI, SourcePrinter *SP,
               std::vector<RelocationRef> *Rels) override {
  if (SP && (PrintSource || PrintLines))
    SP->printSourceLine(OS, Address, "");
  if (!MI) {
    printLead(Bytes, Address, OS);
    OS << " <unknown>";
    return;
  }
  std::string Buffer;
  {
    raw_string_ostream TempStream(Buffer);
    IP.printInst(MI, TempStream, "", STI);
  }
  StringRef Contents(Buffer);
  // Split off bundle attributes
  auto PacketBundle = Contents.rsplit('\n');
  // Split off first instruction from the rest
  auto HeadTail = PacketBundle.first.split('\n');
  auto Preamble = " { ";
  auto Separator = "";
  StringRef Fmt = "\t\t\t%08" PRIx64"l" "x" ":  ";
  std::vector<RelocationRef>::const_iterator rel_cur = Rels->begin();
  std::vector<RelocationRef>::const_iterator rel_end = Rels->end();

  // Hexagon's packets require relocations to be inline rather than
  // clustered at the end of the packet.
  auto PrintReloc = [&]() -> void {
    while ((rel_cur != rel_end) && (rel_cur->getOffset() <= Address)) {
      if (rel_cur->getOffset() == Address) {
        SmallString<16> name;
        SmallString<32> val;
        rel_cur->getTypeName(name);
        error(getRelocationValueString(*rel_cur, val));
        OS << Separator << format(Fmt.data(), Address) << name << "\t" << val
              << "\n";
        return;
      }
      rel_cur++;
    }
  };

  while(!HeadTail.first.empty()) {
    OS << Separator;
    Separator = "\n";
    if (SP && (PrintSource || PrintLines))
      SP->printSourceLine(OS, Address, "");
    printLead(Bytes, Address, OS);
    OS << Preamble;
    Preamble = "   ";
    StringRef Inst;
    auto Duplex = HeadTail.first.split('\v');
    if(!Duplex.second.empty()){
      OS << Duplex.first;
      OS << "; ";
      Inst = Duplex.second;
    }
    else
      Inst = HeadTail.first;
    OS << Inst;
    HeadTail = HeadTail.second.split('\n');
    if (HeadTail.first.empty())
      OS << " } " << PacketBundle.second;
    PrintReloc();
    Bytes = Bytes.slice(4);
    Address += 4;
  }
}
1088};
1089HexagonPrettyPrinter HexagonPrettyPrinterInst;

1091class AMDGCNPrettyPrinter : public PrettyPrinter {
1092public:
void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
               uint64_t Address, raw_ostream &OS, StringRef Annot,
               MCSubtargetInfo const &STI, SourcePrinter *SP,
               std::vector<RelocationRef> *Rels) override {
  if (SP && (PrintSource || PrintLines))
    SP->printSourceLine(OS, Address);

  typedef support::ulittle32_t U32;

  if (MI) {
    SmallString<40> InstStr;
    raw_svector_ostream IS(InstStr);

    IP.printInst(MI, IS, "", STI);

    OS << left_justify(IS.str(), 60);
  } else {
    // an unrecognized encoding - this is probably data so represent it
    // using the .long directive, or .byte directive if fewer than 4 bytes
    // remaining
    if (Bytes.size() >= 4) {
      OS << format("\t.long 0x%08" PRIx32"x" " ",
                   static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
      OS.indent(42);
    } else {
        OS << format("\t.byte 0x%02" PRIx8"x", Bytes[0]);
        for (unsigned int i = 1; i < Bytes.size(); i++)
          OS << format(", 0x%02" PRIx8"x", Bytes[i]);
        OS.indent(55 - (6 * Bytes.size()));
    }
  }

  OS << format("// %012" PRIX64"l" "X" ": ", Address);
  if (Bytes.size() >=4) {
    for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
                               Bytes.size() / sizeof(U32)))
      // D should be explicitly casted to uint32_t here as it is passed
      // by format to snprintf as vararg.
      OS << format("%08" PRIX32"X" " ", static_cast<uint32_t>(D));
  } else {
    for (unsigned int i = 0; i < Bytes.size(); i++)
      OS << format("%02" PRIX8"X" " ", Bytes[i]);
  }

  if (!Annot.empty())
    OS << "// " << Annot;
}
1140};
1141AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;

1143class BPFPrettyPrinter : public PrettyPrinter {
1144public:
void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
               uint64_t Address, raw_ostream &OS, StringRef Annot,
               MCSubtargetInfo const &STI, SourcePrinter *SP,
               std::vector<RelocationRef> *Rels) override {
  if (SP && (PrintSource || PrintLines))
    SP->printSourceLine(OS, Address);
  if (!NoLeadingAddr)
    OS << format("%8" PRId64"l" "d" ":", Address / 8);
  if (!NoShowRawInsn) {
    OS << "\t";
    dumpBytes(Bytes, OS);
  }
  if (MI)
    IP.printInst(MI, OS, "", STI);
  else
    OS << " <unknown>";
}
1162};
1163BPFPrettyPrinter BPFPrettyPrinterInst;

1165PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
switch(Triple.getArch()) {
default:
  return PrettyPrinterInst;
case Triple::hexagon:
  return HexagonPrettyPrinterInst;
case Triple::amdgcn:
  return AMDGCNPrettyPrinterInst;
case Triple::bpfel:
case Triple::bpfeb:
  return BPFPrettyPrinterInst;
}
1177}
1178}

1180static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
assert(Obj->isELF())((Obj->isELF()) ? static_cast<void> (0) : __assert_fail
 ("Obj->isELF()", "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 1181, __PRETTY_FUNCTION__));
if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
1
Taking true branch→
  return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
2
←
Calling 'ELFObjectFile::getSymbol'→
if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
  return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
  return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
  return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
llvm_unreachable("Unsupported binary format")::llvm::llvm_unreachable_internal("Unsupported binary format"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 1190);
1191}

1193template <class ELFT> static void
1194addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
                   std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
for (auto Symbol : Obj->getDynamicSymbolIterators()) {
  uint8_t SymbolType = Symbol.getELFType();
  if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
    continue;

  Expected<uint64_t> AddressOrErr = Symbol.getAddress();
  if (!AddressOrErr)
    report_error(Obj->getFileName(), AddressOrErr.takeError());
  uint64_t Address = *AddressOrErr;

  Expected<StringRef> Name = Symbol.getName();
  if (!Name)
    report_error(Obj->getFileName(), Name.takeError());
  if (Name->empty())
    continue;

  Expected<section_iterator> SectionOrErr = Symbol.getSection();
  if (!SectionOrErr)
    report_error(Obj->getFileName(), SectionOrErr.takeError());
  section_iterator SecI = *SectionOrErr;
  if (SecI == Obj->section_end())
    continue;

  AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
}
1221}

1223static void
1224addDynamicElfSymbols(const ObjectFile *Obj,
                   std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
assert(Obj->isELF())((Obj->isELF()) ? static_cast<void> (0) : __assert_fail
 ("Obj->isELF()", "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 1226, __PRETTY_FUNCTION__));
if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
  addDynamicElfSymbols(Elf32LEObj, AllSymbols);
else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
  addDynamicElfSymbols(Elf64LEObj, AllSymbols);
else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
  addDynamicElfSymbols(Elf32BEObj, AllSymbols);
else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
  addDynamicElfSymbols(Elf64BEObj, AllSymbols);
else
  llvm_unreachable("Unsupported binary format")::llvm::llvm_unreachable_internal("Unsupported binary format"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-objdump/llvm-objdump.cpp"
, 1236);
1237}

1239static void addPltEntries(const ObjectFile *Obj,
                        std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
                        StringSaver &Saver) {
Optional<SectionRef> Plt = None;
for (const SectionRef &Section : Obj->sections()) {
  StringRef Name;
  if (Section.getName(Name))
    continue;
  if (Name == ".plt")
    Plt = Section;
}
if (!Plt)
  return;
if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
  for (auto PltEntry : ElfObj->getPltAddresses()) {
    SymbolRef Symbol(PltEntry.first, ElfObj);

    uint8_t SymbolType = getElfSymbolType(Obj, Symbol);

    Expected<StringRef> NameOrErr = Symbol.getName();
    if (!NameOrErr)
      report_error(Obj->getFileName(), NameOrErr.takeError());
    if (NameOrErr->empty())
      continue;
    StringRef Name = Saver.save((*NameOrErr + "@plt").str());

    AllSymbols[*Plt].emplace_back(PltEntry.second, Name, SymbolType);
  }
}
1268}

1270static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
if (StartAddress > StopAddress)
  error("Start address should be less than stop address");

const Target *TheTarget = getTarget(Obj);

// Package up features to be passed to target/subtarget
SubtargetFeatures Features = Obj->getFeatures();
if (MAttrs.size()) {
  for (unsigned i = 0; i != MAttrs.size(); ++i)
    Features.AddFeature(MAttrs[i]);
}

std::unique_ptr<const MCRegisterInfo> MRI(
    TheTarget->createMCRegInfo(TripleName));
if (!MRI)
  report_error(Obj->getFileName(), "no register info for target " +
               TripleName);

// Set up disassembler.
std::unique_ptr<const MCAsmInfo> AsmInfo(
    TheTarget->createMCAsmInfo(*MRI, TripleName));
if (!AsmInfo)
  report_error(Obj->getFileName(), "no assembly info for target " +
               TripleName);
std::unique_ptr<const MCSubtargetInfo> STI(
    TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
if (!STI)
  report_error(Obj->getFileName(), "no subtarget info for target " +
               TripleName);
std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
if (!MII)
  report_error(Obj->getFileName(), "no instruction info for target " +
               TripleName);
MCObjectFileInfo MOFI;
MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
// FIXME: for now initialize MCObjectFileInfo with default values
MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);

std::unique_ptr<MCDisassembler> DisAsm(
  TheTarget->createMCDisassembler(*STI, Ctx));
if (!DisAsm)
  report_error(Obj->getFileName(), "no disassembler for target " +
               TripleName);

std::unique_ptr<const MCInstrAnalysis> MIA(
    TheTarget->createMCInstrAnalysis(MII.get()));

int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
    Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
if (!IP)
  report_error(Obj->getFileName(), "no instruction printer for target " +
               TripleName);
IP->setPrintImmHex(PrintImmHex);
PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));

StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64"l" "x" ":  " :
                                               "\t\t\t%08" PRIx64"l" "x" ":  ";

SourcePrinter SP(Obj, TheTarget->getName());

// Create a mapping, RelocSecs = SectionRelocMap[S], where sections
// in RelocSecs contain the relocations for section S.
std::error_code EC;
std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
  section_iterator Sec2 = Section.getRelocatedSection();
  if (Sec2 != Obj->section_end())
    SectionRelocMap[*Sec2].push_back(Section);
}

// Create a mapping from virtual address to symbol name.  This is used to
// pretty print the symbols while disassembling.
std::map<SectionRef, SectionSymbolsTy> AllSymbols;
SectionSymbolsTy AbsoluteSymbols;
for (const SymbolRef &Symbol : Obj->symbols()) {
  Expected<uint64_t> AddressOrErr = Symbol.getAddress();
  if (!AddressOrErr)
    report_error(Obj->getFileName(), AddressOrErr.takeError());
  uint64_t Address = *AddressOrErr;

  Expected<StringRef> Name = Symbol.getName();
  if (!Name)
    report_error(Obj->getFileName(), Name.takeError());
  if (Name->empty())
    continue;

  Expected<section_iterator> SectionOrErr = Symbol.getSection();
  if (!SectionOrErr)
    report_error(Obj->getFileName(), SectionOrErr.takeError());

  uint8_t SymbolType = ELF::STT_NOTYPE;
  if (Obj->isELF())
    SymbolType = getElfSymbolType(Obj, Symbol);

  section_iterator SecI = *SectionOrErr;
  if (SecI != Obj->section_end())
    AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
  else
    AbsoluteSymbols.emplace_back(Address, *Name, SymbolType);


}
if (AllSymbols.empty() && Obj->isELF())
  addDynamicElfSymbols(Obj, AllSymbols);

BumpPtrAllocator A;
StringSaver Saver(A);
addPltEntries(Obj, AllSymbols, Saver);

// Create a mapping from virtual address to section.
std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
for (SectionRef Sec : Obj->sections())
  SectionAddresses.emplace_back(Sec.getAddress(), Sec);
array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());

// Linked executables (.exe and .dll files) typically don't include a real
// symbol table but they might contain an export table.
if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
  for (const auto &ExportEntry : COFFObj->export_directories()) {
    StringRef Name;
    error(ExportEntry.getSymbolName(Name));
    if (Name.empty())
      continue;
    uint32_t RVA;
    error(ExportEntry.getExportRVA(RVA));

    uint64_t VA = COFFObj->getImageBase() + RVA;
    auto Sec = std::upper_bound(
        SectionAddresses.begin(), SectionAddresses.end(), VA,
        [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
          return LHS < RHS.first;
        });
    if (Sec != SectionAddresses.begin())
      --Sec;
    else
      Sec = SectionAddresses.end();

    if (Sec != SectionAddresses.end())
      AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
    else
      AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
  }
}

// Sort all the symbols, this allows us to use a simple binary search to find
// a symbol near an address.
for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
  array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());

for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
  if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
    continue;

  uint64_t SectionAddr = Section.getAddress();
  uint64_t SectSize = Section.getSize();
  if (!SectSize)
    continue;

  // Get the list of all the symbols in this section.
  SectionSymbolsTy &Symbols = AllSymbols[Section];
  std::vector<uint64_t> DataMappingSymsAddr;
  std::vector<uint64_t> TextMappingSymsAddr;
  if (isArmElf(Obj)) {
    for (const auto &Symb : Symbols) {
      uint64_t Address = std::get<0>(Symb);
      StringRef Name = std::get<1>(Symb);
      if (Name.startswith("$d"))
        DataMappingSymsAddr.push_back(Address - SectionAddr);
      if (Name.startswith("$x"))
        TextMappingSymsAddr.push_back(Address - SectionAddr);
      if (Name.startswith("$a"))
        TextMappingSymsAddr.push_back(Address - SectionAddr);
      if (Name.startswith("$t"))
        TextMappingSymsAddr.push_back(Address - SectionAddr);
    }
  }

  llvm::sort(DataMappingSymsAddr);
  llvm::sort(TextMappingSymsAddr);

  if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
    // AMDGPU disassembler uses symbolizer for printing labels
    std::unique_ptr<MCRelocationInfo> RelInfo(
      TheTarget->createMCRelocationInfo(TripleName, Ctx));
    if (RelInfo) {
      std::unique_ptr<MCSymbolizer> Symbolizer(
        TheTarget->createMCSymbolizer(
          TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
      DisAsm->setSymbolizer(std::move(Symbolizer));
    }
  }

  // Make a list of all the relocations for this section.
  std::vector<RelocationRef> Rels;
  if (InlineRelocs) {
    for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
      for (const RelocationRef &Reloc : RelocSec.relocations()) {
        Rels.push_back(Reloc);
      }
    }
  }

  // Sort relocations by address.
  llvm::sort(Rels, RelocAddressLess);

  StringRef SegmentName = "";
  if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
    DataRefImpl DR = Section.getRawDataRefImpl();
    SegmentName = MachO->getSectionFinalSegmentName(DR);
  }
  StringRef SectionName;
  error(Section.getName(SectionName));

  // If the section has no symbol at the start, just insert a dummy one.
  if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
    Symbols.insert(
        Symbols.begin(),
        std::make_tuple(SectionAddr, SectionName,
                        Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
  }

  SmallString<40> Comments;
  raw_svector_ostream CommentStream(Comments);

  StringRef BytesStr;
  error(Section.getContents(BytesStr));
  ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
                          BytesStr.size());

  uint64_t Size;
  uint64_t Index;
  bool PrintedSection = false;

  std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
  std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
  // Disassemble symbol by symbol.
  for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
    uint64_t Start = std::get<0>(Symbols[si]) - SectionAddr;
    // The end is either the section end or the beginning of the next
    // symbol.
    uint64_t End =
        (si == se - 1) ? SectSize : std::get<0>(Symbols[si + 1]) - SectionAddr;
    // Don't try to disassemble beyond the end of section contents.
    if (End > SectSize)
      End = SectSize;
    // If this symbol has the same address as the next symbol, then skip it.
    if (Start >= End)
      continue;

    // Check if we need to skip symbol
    // Skip if the symbol's data is not between StartAddress and StopAddress
    if (End + SectionAddr < StartAddress ||
        Start + SectionAddr > StopAddress) {
      continue;
    }

    /// Skip if user requested specific symbols and this is not in the list
    if (!DisasmFuncsSet.empty() &&
        !DisasmFuncsSet.count(std::get<1>(Symbols[si])))
      continue;

    if (!PrintedSection) {
      PrintedSection = true;
      outs() << "Disassembly of section ";
      if (!SegmentName.empty())
        outs() << SegmentName << ",";
      outs() << SectionName << ':';
    }

    // Stop disassembly at the stop address specified
    if (End + SectionAddr > StopAddress)
      End = StopAddress - SectionAddr;

    if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
      if (std::get<2>(Symbols[si]) == ELF::STT_AMDGPU_HSA_KERNEL) {
        // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
        Start += 256;
      }
      if (si == se - 1 ||
          std::get<2>(Symbols[si + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
        // cut trailing zeroes at the end of kernel
        // cut up to 256 bytes
        const uint64_t EndAlign = 256;
        const auto Limit = End - (std::min)(EndAlign, End - Start);
        while (End > Limit &&
          *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
          End -= 4;
      }
    }

    auto PrintSymbol = [](StringRef Name) {
      outs() << '\n' << Name << ":\n";
    };
    StringRef SymbolName = std::get<1>(Symbols[si]);
    if (Demangle) {
      char *DemangledSymbol = nullptr;
      size_t Size = 0;
      int Status = -1;
      if (SymbolName.startswith("_Z"))
        DemangledSymbol = itaniumDemangle(SymbolName.data(), DemangledSymbol,
                                          &Size, &Status);
      else if (SymbolName.startswith("?"))
        DemangledSymbol = microsoftDemangle(SymbolName.data(),
                                            DemangledSymbol, &Size, &Status);

      if (Status == 0 && DemangledSymbol)
        PrintSymbol(StringRef(DemangledSymbol));
      else
        PrintSymbol(SymbolName);

      if (DemangledSymbol)
        free(DemangledSymbol);
    } else
      PrintSymbol(SymbolName);

    // Don't print raw contents of a virtual section. A virtual section
    // doesn't have any contents in the file.
    if (Section.isVirtual()) {
      outs() << "...\n";
      continue;
    }

1595#ifndef NDEBUG
    raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
1597#else
    raw_ostream &DebugOut = nulls();
1599#endif

    for (Index = Start; Index < End; Index += Size) {
      MCInst Inst;

      if (Index + SectionAddr < StartAddress ||
          Index + SectionAddr > StopAddress) {
        // skip byte by byte till StartAddress is reached
        Size = 1;
        continue;
      }
      // AArch64 ELF binaries can interleave data and text in the
      // same section. We rely on the markers introduced to
      // understand what we need to dump. If the data marker is within a
      // function, it is denoted as a word/short etc
      if (isArmElf(Obj) && std::get<2>(Symbols[si]) != ELF::STT_OBJECT &&
          !DisassembleAll) {
        uint64_t Stride = 0;

        auto DAI = std::lower_bound(DataMappingSymsAddr.begin(),
                                    DataMappingSymsAddr.end(), Index);
        if (DAI != DataMappingSymsAddr.end() && *DAI == Index) {
          // Switch to data.
          while (Index < End) {
            outs() << format("%8" PRIx64"l" "x" ":", SectionAddr + Index);
            outs() << "\t";
            if (Index + 4 <= End) {
              Stride = 4;
              dumpBytes(Bytes.slice(Index, 4), outs());
              outs() << "\t.word\t";
              uint32_t Data = 0;
              if (Obj->isLittleEndian()) {
                const auto Word =
                    reinterpret_cast<const support::ulittle32_t *>(
                        Bytes.data() + Index);
                Data = *Word;
              } else {
                const auto Word = reinterpret_cast<const support::ubig32_t *>(
                    Bytes.data() + Index);
                Data = *Word;
              }
              outs() << "0x" << format("%08" PRIx32"x", Data);
            } else if (Index + 2 <= End) {
              Stride = 2;
              dumpBytes(Bytes.slice(Index, 2), outs());
              outs() << "\t\t.short\t";
              uint16_t Data = 0;
              if (Obj->isLittleEndian()) {
                const auto Short =
                    reinterpret_cast<const support::ulittle16_t *>(
                        Bytes.data() + Index);
                Data = *Short;
              } else {
                const auto Short =
                    reinterpret_cast<const support::ubig16_t *>(Bytes.data() +
                                                                Index);
                Data = *Short;
              }
              outs() << "0x" << format("%04" PRIx16"x", Data);
            } else {
              Stride = 1;
              dumpBytes(Bytes.slice(Index, 1), outs());
              outs() << "\t\t.byte\t";
              outs() << "0x" << format("%02" PRIx8"x", Bytes.slice(Index, 1)[0]);
            }
            Index += Stride;
            outs() << "\n";
            auto TAI = std::lower_bound(TextMappingSymsAddr.begin(),
                                        TextMappingSymsAddr.end(), Index);
            if (TAI != TextMappingSymsAddr.end() && *TAI == Index)
              break;
          }
        }
      }

      // If there is a data symbol inside an ELF text section and we are only
      // disassembling text (applicable all architectures),
      // we are in a situation where we must print the data and not
      // disassemble it.
      if (Obj->isELF() && std::get<2>(Symbols[si]) == ELF::STT_OBJECT &&
          !DisassembleAll && Section.isText()) {
        // print out data up to 8 bytes at a time in hex and ascii
        uint8_t AsciiData[9] = {'\0'};
        uint8_t Byte;
        int NumBytes = 0;

        for (Index = Start; Index < End; Index += 1) {
          if (((SectionAddr + Index) < StartAddress) ||
              ((SectionAddr + Index) > StopAddress))
            continue;
          if (NumBytes == 0) {
            outs() << format("%8" PRIx64"l" "x" ":", SectionAddr + Index);
            outs() << "\t";
          }
          Byte = Bytes.slice(Index)[0];
          outs() << format(" %02x", Byte);
          AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';

          uint8_t IndentOffset = 0;
          NumBytes++;
          if (Index == End - 1 || NumBytes > 8) {
            // Indent the space for less than 8 bytes data.
            // 2 spaces for byte and one for space between bytes
            IndentOffset = 3 * (8 - NumBytes);
            for (int Excess = 8 - NumBytes; Excess < 8; Excess++)
              AsciiData[Excess] = '\0';
            NumBytes = 8;
          }
          if (NumBytes == 8) {
            AsciiData[8] = '\0';
            outs() << std::string(IndentOffset, ' ') << "         ";
            outs() << reinterpret_cast<char *>(AsciiData);
            outs() << '\n';
            NumBytes = 0;
          }
        }
      }
      if (Index >= End)
        break;

      // Disassemble a real instruction or a data when disassemble all is
      // provided
      bool Disassembled = DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
                                                 SectionAddr + Index, DebugOut,
                                                 CommentStream);
      if (Size == 0)
        Size = 1;

      PIP.printInst(*IP, Disassembled ? &Inst : nullptr,
                    Bytes.slice(Index, Size), SectionAddr + Index, outs(), "",
                    *STI, &SP, &Rels);
      outs() << CommentStream.str();
      Comments.clear();

      // Try to resolve the target of a call, tail call, etc. to a specific
      // symbol.
      if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
                  MIA->isConditionalBranch(Inst))) {
        uint64_t Target;
        if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
          // In a relocatable object, the target's section must reside in
          // the same section as the call instruction or it is accessed
          // through a relocation.
          //
          // In a non-relocatable object, the target may be in any section.
          //
          // N.B. We don't walk the relocations in the relocatable case yet.
          auto *TargetSectionSymbols = &Symbols;
          if (!Obj->isRelocatableObject()) {
            auto SectionAddress = std::upper_bound(
                SectionAddresses.begin(), SectionAddresses.end(), Target,
                [](uint64_t LHS,
                    const std::pair<uint64_t, SectionRef> &RHS) {
                  return LHS < RHS.first;
                });
            if (SectionAddress != SectionAddresses.begin()) {
              --SectionAddress;
              TargetSectionSymbols = &AllSymbols[SectionAddress->second];
            } else {
              TargetSectionSymbols = &AbsoluteSymbols;
            }
          }

          // Find the first symbol in the section whose offset is less than
          // or equal to the target. If there isn't a section that contains
          // the target, find the nearest preceding absolute symbol.
          auto TargetSym = std::upper_bound(
              TargetSectionSymbols->begin(), TargetSectionSymbols->end(),
              Target, [](uint64_t LHS,
                         const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
                return LHS < std::get<0>(RHS);
              });
          if (TargetSym == TargetSectionSymbols->begin()) {
            TargetSectionSymbols = &AbsoluteSymbols;
            TargetSym = std::upper_bound(
                AbsoluteSymbols.begin(), AbsoluteSymbols.end(),
                Target, [](uint64_t LHS,
                           const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
                          return LHS < std::get<0>(RHS);
                        });
          }
          if (TargetSym != TargetSectionSymbols->begin()) {
            --TargetSym;
            uint64_t TargetAddress = std::get<0>(*TargetSym);
            StringRef TargetName = std::get<1>(*TargetSym);
            outs() << " <" << TargetName;
            uint64_t Disp = Target - TargetAddress;
            if (Disp)
              outs() << "+0x" << Twine::utohexstr(Disp);
            outs() << '>';
          }
        }
      }
      outs() << "\n";

      // Hexagon does this in pretty printer
      if (Obj->getArch() != Triple::hexagon)
        // Print relocation for instruction.
        while (rel_cur != rel_end) {
          bool hidden = getHidden(*rel_cur);
          uint64_t addr = rel_cur->getOffset();
          SmallString<16> name;
          SmallString<32> val;

          // If this relocation is hidden, skip it.
          if (hidden || ((SectionAddr + addr) < StartAddress)) {
            ++rel_cur;
            continue;
          }

          // Stop when rel_cur's address is past the current instruction.
          if (addr >= Index + Size) break;
          rel_cur->getTypeName(name);
          error(getRelocationValueString(*rel_cur, val));
          outs() << format(Fmt.data(), SectionAddr + addr) << name
                 << "\t" << val << "\n";
          ++rel_cur;
        }
    }
  }
}
1820}

1822void llvm::PrintRelocations(const ObjectFile *Obj) {
StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64"l" "x" :
                                               "%08" PRIx64"l" "x";
// Regular objdump doesn't print relocations in non-relocatable object
// files.
if (!Obj->isRelocatableObject())
  return;

for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
  if (Section.relocation_begin() == Section.relocation_end())
    continue;
  StringRef secname;
  error(Section.getName(secname));
  outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
  for (const RelocationRef &Reloc : Section.relocations()) {
    bool hidden = getHidden(Reloc);
    uint64_t address = Reloc.getOffset();
    SmallString<32> relocname;
    SmallString<32> valuestr;
    if (address < StartAddress || address > StopAddress || hidden)
      continue;
    Reloc.getTypeName(relocname);
    error(getRelocationValueString(Reloc, valuestr));
    outs() << format(Fmt.data(), address) << " " << relocname << " "
           << valuestr << "\n";
  }
  outs() << "\n";
}
1850}

1852void llvm::PrintDynamicRelocations(const ObjectFile *Obj) {

// For the moment, this option is for ELF only
if (!Obj->isELF())
  return;

const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);

if (!Elf || Elf->getEType() != ELF::ET_DYN) {
  error("not a dynamic object");
  return;
}

StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64"l" "x" : "%08" PRIx64"l" "x";

std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
if (DynRelSec.empty())
  return;

outs() << "DYNAMIC RELOCATION RECORDS\n";
for (const SectionRef &Section : DynRelSec) {
  if (Section.relocation_begin() == Section.relocation_end())
    continue;
  for (const RelocationRef &Reloc : Section.relocations()) {
    uint64_t address = Reloc.getOffset();
    SmallString<32> relocname;
    SmallString<32> valuestr;
    Reloc.getTypeName(relocname);
    error(getRelocationValueString(Reloc, valuestr));
    outs() << format(Fmt.data(), address) << " " << relocname << " "
           << valuestr << "\n";
  }
}
1885}

1887void llvm::PrintSectionHeaders(const ObjectFile *Obj) {
outs() << "Sections:\n"
          "Idx Name          Size      Address          Type\n";
for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
  StringRef Name;
  error(Section.getName(Name));
  uint64_t Address = Section.getAddress();
  uint64_t Size = Section.getSize();
  bool Text = Section.isText();
  bool Data = Section.isData();
  bool BSS = Section.isBSS();
  std::string Type = (std::string(Text ? "TEXT " : "") +
                      (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
  outs() << format("%3d %-13s %08" PRIx64"l" "x" " %016" PRIx64"l" "x" " %s\n",
                   (unsigned)Section.getIndex(), Name.str().c_str(), Size,
                   Address, Type.c_str());
}
1904}

1906void llvm::PrintSectionContents(const ObjectFile *Obj) {
std::error_code EC;
for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
  StringRef Name;
  StringRef Contents;
  error(Section.getName(Name));
  uint64_t BaseAddr = Section.getAddress();
  uint64_t Size = Section.getSize();
  if (!Size)
    continue;

  outs() << "Contents of section " << Name << ":\n";
  if (Section.isBSS()) {
    outs() << format("<skipping contents of bss section at [%04" PRIx64"l" "x"
                     ", %04" PRIx64"l" "x" ")>\n",
                     BaseAddr, BaseAddr + Size);
    continue;
  }

  error(Section.getContents(Contents));

  // Dump out the content as hex and printable ascii characters.
  for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
    outs() << format(" %04" PRIx64"l" "x" " ", BaseAddr + addr);
    // Dump line of hex.
    for (std::size_t i = 0; i < 16; ++i) {
      if (i != 0 && i % 4 == 0)
        outs() << ' ';
      if (addr + i < end)
        outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
               << hexdigit(Contents[addr + i] & 0xF, true);
      else
        outs() << "  ";
    }
    // Print ascii.
    outs() << "  ";
    for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
      if (isPrint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
        outs() << Contents[addr + i];
      else
        outs() << ".";
    }
    outs() << "\n";
  }
}
1951}

1953void llvm::PrintSymbolTable(const ObjectFile *o, StringRef ArchiveName,
                          StringRef ArchitectureName) {
outs() << "SYMBOL TABLE:\n";

if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
  printCOFFSymbolTable(coff);
  return;
}
for (const SymbolRef &Symbol : o->symbols()) {
  Expected<uint64_t> AddressOrError = Symbol.getAddress();
  if (!AddressOrError)
    report_error(ArchiveName, o->getFileName(), AddressOrError.takeError(),
                 ArchitectureName);
  uint64_t Address = *AddressOrError;
  if ((Address < StartAddress) || (Address > StopAddress))
    continue;
  Expected<SymbolRef::Type> TypeOrError = Symbol.getType();
  if (!TypeOrError)
    report_error(ArchiveName, o->getFileName(), TypeOrError.takeError(),
                 ArchitectureName);
  SymbolRef::Type Type = *TypeOrError;
  uint32_t Flags = Symbol.getFlags();
  Expected<section_iterator> SectionOrErr = Symbol.getSection();
  if (!SectionOrErr)
    report_error(ArchiveName, o->getFileName(), SectionOrErr.takeError(),
                 ArchitectureName);
  section_iterator Section = *SectionOrErr;
  StringRef Name;
  if (Type == SymbolRef::ST_Debug && Section != o->section_end()) {
    Section->getName(Name);
  } else {
    Expected<StringRef> NameOrErr = Symbol.getName();
    if (!NameOrErr)
      report_error(ArchiveName, o->getFileName(), NameOrErr.takeError(),
                   ArchitectureName);
    Name = *NameOrErr;
  }

  bool Global = Flags & SymbolRef::SF_Global;
  bool Weak = Flags & SymbolRef::SF_Weak;
  bool Absolute = Flags & SymbolRef::SF_Absolute;
  bool Common = Flags & SymbolRef::SF_Common;
  bool Hidden = Flags & SymbolRef::SF_Hidden;

  char GlobLoc = ' ';
  if (Type != SymbolRef::ST_Unknown)
    GlobLoc = Global ? 'g' : 'l';
  char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
               ? 'd' : ' ';
  char FileFunc = ' ';
  if (Type == SymbolRef::ST_File)
    FileFunc = 'f';
  else if (Type == SymbolRef::ST_Function)
    FileFunc = 'F';

  const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64"l" "x" :
                                                 "%08" PRIx64"l" "x";

  outs() << format(Fmt, Address) << " "
         << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
         << (Weak ? 'w' : ' ') // Weak?
         << ' ' // Constructor. Not supported yet.
         << ' ' // Warning. Not supported yet.
         << ' ' // Indirect reference to another symbol.
         << Debug // Debugging (d) or dynamic (D) symbol.
         << FileFunc // Name of function (F), file (f) or object (O).
         << ' ';
  if (Absolute) {
    outs() << "*ABS*";
  } else if (Common) {
    outs() << "*COM*";
  } else if (Section == o->section_end()) {
    outs() << "*UND*";
  } else {
    if (const MachOObjectFile *MachO =
        dyn_cast<const MachOObjectFile>(o)) {
      DataRefImpl DR = Section->getRawDataRefImpl();
      StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
      outs() << SegmentName << ",";
    }
    StringRef SectionName;
    error(Section->getName(SectionName));
    outs() << SectionName;
  }

  outs() << '\t';
  if (Common || isa<ELFObjectFileBase>(o)) {
    uint64_t Val =
        Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
    outs() << format("\t %08" PRIx64"l" "x" " ", Val);
  }

  if (Hidden) {
    outs() << ".hidden ";
  }
  outs() << Name
         << '\n';
}
2051}

2053static void PrintUnwindInfo(const ObjectFile *o) {
outs() << "Unwind info:\n\n";

if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
  printCOFFUnwindInfo(coff);
} else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachOUnwindInfo(MachO);
else {
  // TODO: Extract DWARF dump tool to objdump.
  errs() << "This operation is only currently supported "
            "for COFF and MachO object files.\n";
  return;
}
2066}

2068void llvm::printExportsTrie(const ObjectFile *o) {
outs() << "Exports trie:\n";
if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachOExportsTrie(MachO);
else {
  errs() << "This operation is only currently supported "
            "for Mach-O executable files.\n";
  return;
}
2077}

2079void llvm::printRebaseTable(ObjectFile *o) {
outs() << "Rebase table:\n";
if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachORebaseTable(MachO);
else {
  errs() << "This operation is only currently supported "
            "for Mach-O executable files.\n";
  return;
}
2088}

2090void llvm::printBindTable(ObjectFile *o) {
outs() << "Bind table:\n";
if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachOBindTable(MachO);
else {
  errs() << "This operation is only currently supported "
            "for Mach-O executable files.\n";
  return;
}
2099}

2101void llvm::printLazyBindTable(ObjectFile *o) {
outs() << "Lazy bind table:\n";
if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachOLazyBindTable(MachO);
else {
  errs() << "This operation is only currently supported "
            "for Mach-O executable files.\n";
  return;
}
2110}

2112void llvm::printWeakBindTable(ObjectFile *o) {
outs() << "Weak bind table:\n";
if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
  printMachOWeakBindTable(MachO);
else {
  errs() << "This operation is only currently supported "
            "for Mach-O executable files.\n";
  return;
}
2121}

2123/// Dump the raw contents of the __clangast section so the output can be piped
2124/// into llvm-bcanalyzer.
2125void llvm::printRawClangAST(const ObjectFile *Obj) {
if (outs().is_displayed()) {
  errs() << "The -raw-clang-ast option will dump the raw binary contents of "
            "the clang ast section.\n"
            "Please redirect the output to a file or another program such as "
            "llvm-bcanalyzer.\n";
  return;
}

StringRef ClangASTSectionName("__clangast");
if (isa<COFFObjectFile>(Obj)) {
  ClangASTSectionName = "clangast";
}

Optional<object::SectionRef> ClangASTSection;
for (auto Sec : ToolSectionFilter(*Obj)) {
  StringRef Name;
  Sec.getName(Name);
  if (Name == ClangASTSectionName) {
    ClangASTSection = Sec;
    break;
  }
}
if (!ClangASTSection)
  return;

StringRef ClangASTContents;
error(ClangASTSection.getValue().getContents(ClangASTContents));
outs().write(ClangASTContents.data(), ClangASTContents.size());
2154}

2156static void printFaultMaps(const ObjectFile *Obj) {
const char *FaultMapSectionName = nullptr;

if (isa<ELFObjectFileBase>(Obj)) {
  FaultMapSectionName = ".llvm_faultmaps";
} else if (isa<MachOObjectFile>(Obj)) {
  FaultMapSectionName = "__llvm_faultmaps";
} else {
  errs() << "This operation is only currently supported "
            "for ELF and Mach-O executable files.\n";
  return;
}

Optional<object::SectionRef> FaultMapSection;

for (auto Sec : ToolSectionFilter(*Obj)) {
  StringRef Name;
  Sec.getName(Name);
  if (Name == FaultMapSectionName) {
    FaultMapSection = Sec;
    break;
  }
}

outs() << "FaultMap table:\n";

if (!FaultMapSection.hasValue()) {
  outs() << "<not found>\n";
  return;
}

StringRef FaultMapContents;
error(FaultMapSection.getValue().getContents(FaultMapContents));

FaultMapParser FMP(FaultMapContents.bytes_begin(),
                   FaultMapContents.bytes_end());

outs() << FMP;
2194}

2196static void printPrivateFileHeaders(const ObjectFile *o, bool onlyFirst) {
if (o->isELF()) {
  printELFFileHeader(o);
  return printELFDynamicSection(o);
}
if (o->isCOFF())
  return printCOFFFileHeader(o);
if (o->isWasm())
  return printWasmFileHeader(o);
if (o->isMachO()) {
  printMachOFileHeader(o);
  if (!onlyFirst)
    printMachOLoadCommands(o);
  return;
}
report_error(o->getFileName(), "Invalid/Unsupported object file format");
2212}

2214static void printFileHeaders(const ObjectFile *o) {
if (!o->isELF() && !o->isCOFF())
  report_error(o->getFileName(), "Invalid/Unsupported object file format");

Triple::ArchType AT = o->getArch();
outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
Expected<uint64_t> StartAddrOrErr = o->getStartAddress();
if (!StartAddrOrErr)
  report_error(o->getFileName(), StartAddrOrErr.takeError());

StringRef Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64"l" "x" : "%08" PRIx64"l" "x";
uint64_t Address = StartAddrOrErr.get();
outs() << "start address: "
       << "0x" << format(Fmt.data(), Address)
       << "\n";
2229}

2231static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
if (!ModeOrErr) {
  errs() << "ill-formed archive entry.\n";
  consumeError(ModeOrErr.takeError());
  return;
}
sys::fs::perms Mode = ModeOrErr.get();
outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");

outs() << " ";

Expected<unsigned> UIDOrErr = C.getUID();
if (!UIDOrErr)
  report_error(Filename, UIDOrErr.takeError());
unsigned UID = UIDOrErr.get();
outs() << format("%d/", UID);

Expected<unsigned> GIDOrErr = C.getGID();
if (!GIDOrErr)
  report_error(Filename, GIDOrErr.takeError());
unsigned GID = GIDOrErr.get();
outs() << format("%-d ", GID);

Expected<uint64_t> Size = C.getRawSize();
if (!Size)
  report_error(Filename, Size.takeError());
outs() << format("%6" PRId64"l" "d", Size.get()) << " ";

StringRef RawLastModified = C.getRawLastModified();
unsigned Seconds;
if (RawLastModified.getAsInteger(10, Seconds))
  outs() << "(date: \"" << RawLastModified
         << "\" contains non-decimal chars) ";
else {
  // Since ctime(3) returns a 26 character string of the form:
  // "Sun Sep 16 01:03:52 1973\n\0"
  // just print 24 characters.
  time_t t = Seconds;
  outs() << format("%.24s ", ctime(&t));
}

StringRef Name = "";
Expected<StringRef> NameOrErr = C.getName();
if (!NameOrErr) {
  consumeError(NameOrErr.takeError());
  Expected<StringRef> RawNameOrErr = C.getRawName();
  if (!RawNameOrErr)
    report_error(Filename, NameOrErr.takeError());
  Name = RawNameOrErr.get();
} else {
  Name = NameOrErr.get();
}
outs() << Name << "\n";
2293}

2295static void DumpObject(ObjectFile *o, const Archive *a = nullptr,
                     const Archive::Child *c = nullptr) {
StringRef ArchiveName = a != nullptr ? a->getFileName() : "";
// Avoid other output when using a raw option.
if (!RawClangAST) {
  outs() << '\n';
  if (a)
    outs() << a->getFileName() << "(" << o->getFileName() << ")";
  else
    outs() << o->getFileName();
  outs() << ":\tfile format " << o->getFileFormatName() << "\n\n";
}

if (ArchiveHeaders && !MachOOpt)
  printArchiveChild(a->getFileName(), *c);
if (Disassemble)
  DisassembleObject(o, Relocations);
if (Relocations && !Disassemble)
  PrintRelocations(o);
if (DynamicRelocations)
  PrintDynamicRelocations(o);
if (SectionHeaders)
  PrintSectionHeaders(o);
if (SectionContents)
  PrintSectionContents(o);
if (SymbolTable)
  PrintSymbolTable(o, ArchiveName);
if (UnwindInfo)
  PrintUnwindInfo(o);
if (PrivateHeaders || FirstPrivateHeader)
  printPrivateFileHeaders(o, FirstPrivateHeader);
if (FileHeaders)
  printFileHeaders(o);
if (ExportsTrie)
  printExportsTrie(o);
if (Rebase)
  printRebaseTable(o);
if (Bind)
  printBindTable(o);
if (LazyBind)
  printLazyBindTable(o);
if (WeakBind)
  printWeakBindTable(o);
if (RawClangAST)
  printRawClangAST(o);
if (PrintFaultMaps)
  printFaultMaps(o);
if (DwarfDumpType != DIDT_Null) {
  std::unique_ptr<DIContext> DICtx = DWARFContext::create(*o);
  // Dump the complete DWARF structure.
  DIDumpOptions DumpOpts;
  DumpOpts.DumpType = DwarfDumpType;
  DICtx->dump(outs(), DumpOpts);
}
2349}

2351static void DumpObject(const COFFImportFile *I, const Archive *A,
                     const Archive::Child *C = nullptr) {
StringRef ArchiveName = A ? A->getFileName() : "";

// Avoid other output when using a raw option.
if (!RawClangAST)
  outs() << '\n'
         << ArchiveName << "(" << I->getFileName() << ")"
         << ":\tfile format COFF-import-file"
         << "\n\n";

if (ArchiveHeaders && !MachOOpt)
  printArchiveChild(A->getFileName(), *C);
if (SymbolTable)
  printCOFFSymbolTable(I);
2366}

2368/// Dump each object file in \a a;
2369static void DumpArchive(const Archive *a) {
Error Err = Error::success();
for (auto &C : a->children(Err)) {
  Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
  if (!ChildOrErr) {
    if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
      report_error(a->getFileName(), C, std::move(E));
    continue;
  }
  if (ObjectFile *o = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
    DumpObject(o, a, &C);
  else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
    DumpObject(I, a, &C);
  else
    report_error(a->getFileName(), object_error::invalid_file_type);
}
if (Err)
  report_error(a->getFileName(), std::move(Err));
2387}

2389/// Open file and figure out how to dump it.
2390static void DumpInput(StringRef file) {

// If we are using the Mach-O specific object file parser, then let it parse
// the file and process the command line options.  So the -arch flags can
// be used to select specific slices, etc.
if (MachOOpt) {
  ParseInputMachO(file);
  return;
}

// Attempt to open the binary.
Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
if (!BinaryOrErr)
  report_error(file, BinaryOrErr.takeError());
Binary &Binary = *BinaryOrErr.get().getBinary();

if (Archive *a = dyn_cast<Archive>(&Binary))
  DumpArchive(a);
else if (ObjectFile *o = dyn_cast<ObjectFile>(&Binary))
  DumpObject(o);
else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
  ParseInputMachO(UB);
else
  report_error(file, object_error::invalid_file_type);
2414}

2416int main(int argc, char **argv) {
InitLLVM X(argc, argv);

// Initialize targets and assembly printers/parsers.
llvm::InitializeAllTargetInfos();
llvm::InitializeAllTargetMCs();
llvm::InitializeAllDisassemblers();

// Register the target printer for --version.
cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);

cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");

ToolName = argv[0];

// Defaults to a.out if no filenames specified.
if (InputFilenames.size() == 0)
  InputFilenames.push_back("a.out");

if (AllHeaders)
  PrivateHeaders = Relocations = SectionHeaders = SymbolTable = true;

if (DisassembleAll || PrintSource || PrintLines)
  Disassemble = true;

if (!Disassemble
    && !Relocations
    && !DynamicRelocations
    && !SectionHeaders
    && !SectionContents
    && !SymbolTable
    && !UnwindInfo
    && !PrivateHeaders
    && !FileHeaders
    && !FirstPrivateHeader
    && !ExportsTrie
    && !Rebase
    && !Bind
    && !LazyBind
    && !WeakBind
    && !RawClangAST
    && !(UniversalHeaders && MachOOpt)
    && !ArchiveHeaders
    && !(IndirectSymbols && MachOOpt)
    && !(DataInCode && MachOOpt)
    && !(LinkOptHints && MachOOpt)
    && !(InfoPlist && MachOOpt)
    && !(DylibsUsed && MachOOpt)
    && !(DylibId && MachOOpt)
    && !(ObjcMetaData && MachOOpt)
    && !(FilterSections.size() != 0 && MachOOpt)
    && !PrintFaultMaps
    && DwarfDumpType == DIDT_Null) {
  cl::PrintHelpMessage();
  return 2;
}

DisasmFuncsSet.insert(DisassembleFunctions.begin(),
                      DisassembleFunctions.end());

llvm::for_each(InputFilenames, DumpInput);

return EXIT_SUCCESS0;
2479}

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h

→

1//===- ELFObjectFile.h - ELF object file implementation ---------*- 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 declares the ELFObjectFile template class.
11//
12//===----------------------------------------------------------------------===//

14#ifndef LLVM_OBJECT_ELFOBJECTFILE_H
15#define LLVM_OBJECT_ELFOBJECTFILE_H

17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/ADT/StringRef.h"
21#include "llvm/ADT/Triple.h"
22#include "llvm/ADT/iterator_range.h"
23#include "llvm/BinaryFormat/ELF.h"
24#include "llvm/MC/SubtargetFeature.h"
25#include "llvm/Object/Binary.h"
26#include "llvm/Object/ELF.h"
27#include "llvm/Object/ELFTypes.h"
28#include "llvm/Object/Error.h"
29#include "llvm/Object/ObjectFile.h"
30#include "llvm/Object/SymbolicFile.h"
31#include "llvm/Support/ARMAttributeParser.h"
32#include "llvm/Support/ARMBuildAttributes.h"
33#include "llvm/Support/Casting.h"
34#include "llvm/Support/Endian.h"
35#include "llvm/Support/Error.h"
36#include "llvm/Support/ErrorHandling.h"
37#include "llvm/Support/MemoryBuffer.h"
38#include <cassert>
39#include <cstdint>
40#include <system_error>

42namespace llvm {
43namespace object {

45class elf_symbol_iterator;

47class ELFObjectFileBase : public ObjectFile {
friend class ELFRelocationRef;
friend class ELFSectionRef;
friend class ELFSymbolRef;

52protected:
ELFObjectFileBase(unsigned int Type, MemoryBufferRef Source);

virtual uint16_t getEMachine() const = 0;
virtual uint64_t getSymbolSize(DataRefImpl Symb) const = 0;
virtual uint8_t getSymbolOther(DataRefImpl Symb) const = 0;
virtual uint8_t getSymbolELFType(DataRefImpl Symb) const = 0;

virtual uint32_t getSectionType(DataRefImpl Sec) const = 0;
virtual uint64_t getSectionFlags(DataRefImpl Sec) const = 0;
virtual uint64_t getSectionOffset(DataRefImpl Sec) const = 0;

virtual Expected<int64_t> getRelocationAddend(DataRefImpl Rel) const = 0;

66public:
using elf_symbol_iterator_range = iterator_range<elf_symbol_iterator>;

virtual elf_symbol_iterator_range getDynamicSymbolIterators() const = 0;

/// Returns platform-specific object flags, if any.
virtual unsigned getPlatformFlags() const = 0;

elf_symbol_iterator_range symbols() const;

static bool classof(const Binary *v) { return v->isELF(); }

SubtargetFeatures getFeatures() const override;

SubtargetFeatures getMIPSFeatures() const;

SubtargetFeatures getARMFeatures() const;

SubtargetFeatures getRISCVFeatures() const;

void setARMSubArch(Triple &TheTriple) const override;

virtual uint16_t getEType() const = 0;

std::vector<std::pair<DataRefImpl, uint64_t>> getPltAddresses() const;
91};

93class ELFSectionRef : public SectionRef {
94public:
ELFSectionRef(const SectionRef &B) : SectionRef(B) {
  assert(isa<ELFObjectFileBase>(SectionRef::getObject()))((isa<ELFObjectFileBase>(SectionRef::getObject())) ? static_cast
<void> (0) : __assert_fail ("isa<ELFObjectFileBase>(SectionRef::getObject())"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 96, __PRETTY_FUNCTION__));
}

const ELFObjectFileBase *getObject() const {
  return cast<ELFObjectFileBase>(SectionRef::getObject());
}

uint32_t getType() const {
  return getObject()->getSectionType(getRawDataRefImpl());
}

uint64_t getFlags() const {
  return getObject()->getSectionFlags(getRawDataRefImpl());
}

uint64_t getOffset() const {
  return getObject()->getSectionOffset(getRawDataRefImpl());
}
114};

116class elf_section_iterator : public section_iterator {
117public:
elf_section_iterator(const section_iterator &B) : section_iterator(B) {
  assert(isa<ELFObjectFileBase>(B->getObject()))((isa<ELFObjectFileBase>(B->getObject())) ? static_cast
<void> (0) : __assert_fail ("isa<ELFObjectFileBase>(B->getObject())"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 119, __PRETTY_FUNCTION__));
}

const ELFSectionRef *operator->() const {
  return static_cast<const ELFSectionRef *>(section_iterator::operator->());
}

const ELFSectionRef &operator*() const {
  return static_cast<const ELFSectionRef &>(section_iterator::operator*());
}
129};

131class ELFSymbolRef : public SymbolRef {
132public:
ELFSymbolRef(const SymbolRef &B) : SymbolRef(B) {
  assert(isa<ELFObjectFileBase>(SymbolRef::getObject()))((isa<ELFObjectFileBase>(SymbolRef::getObject())) ? static_cast
<void> (0) : __assert_fail ("isa<ELFObjectFileBase>(SymbolRef::getObject())"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 134, __PRETTY_FUNCTION__));
}

const ELFObjectFileBase *getObject() const {
  return cast<ELFObjectFileBase>(BasicSymbolRef::getObject());
}

uint64_t getSize() const {
  return getObject()->getSymbolSize(getRawDataRefImpl());
}

uint8_t getOther() const {
  return getObject()->getSymbolOther(getRawDataRefImpl());
}

uint8_t getELFType() const {
  return getObject()->getSymbolELFType(getRawDataRefImpl());
}
152};

154class elf_symbol_iterator : public symbol_iterator {
155public:
elf_symbol_iterator(const basic_symbol_iterator &B)
    : symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
                                cast<ELFObjectFileBase>(B->getObject()))) {}

const ELFSymbolRef *operator->() const {
  return static_cast<const ELFSymbolRef *>(symbol_iterator::operator->());
}

const ELFSymbolRef &operator*() const {
  return static_cast<const ELFSymbolRef &>(symbol_iterator::operator*());
}
167};

169class ELFRelocationRef : public RelocationRef {
170public:
ELFRelocationRef(const RelocationRef &B) : RelocationRef(B) {
  assert(isa<ELFObjectFileBase>(RelocationRef::getObject()))((isa<ELFObjectFileBase>(RelocationRef::getObject())) ?
 static_cast<void> (0) : __assert_fail ("isa<ELFObjectFileBase>(RelocationRef::getObject())"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 172, __PRETTY_FUNCTION__));
}

const ELFObjectFileBase *getObject() const {
  return cast<ELFObjectFileBase>(RelocationRef::getObject());
}

Expected<int64_t> getAddend() const {
  return getObject()->getRelocationAddend(getRawDataRefImpl());
}
182};

184class elf_relocation_iterator : public relocation_iterator {
185public:
elf_relocation_iterator(const relocation_iterator &B)
    : relocation_iterator(RelocationRef(
          B->getRawDataRefImpl(), cast<ELFObjectFileBase>(B->getObject()))) {}

const ELFRelocationRef *operator->() const {
  return static_cast<const ELFRelocationRef *>(
      relocation_iterator::operator->());
}

const ELFRelocationRef &operator*() const {
  return static_cast<const ELFRelocationRef &>(
      relocation_iterator::operator*());
}
199};

201inline ELFObjectFileBase::elf_symbol_iterator_range
202ELFObjectFileBase::symbols() const {
return elf_symbol_iterator_range(symbol_begin(), symbol_end());
204}

206template <class ELFT> class ELFObjectFile : public ELFObjectFileBase {
uint16_t getEMachine() const override;
uint16_t getEType() const override;
uint64_t getSymbolSize(DataRefImpl Sym) const override;

211public:
LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)using Elf_Addr = typename ELFT::Addr; using Elf_Off = typename
 ELFT::Off; using Elf_Half = typename ELFT::Half; using Elf_Word
 = typename ELFT::Word; using Elf_Sword = typename ELFT::Sword
; using Elf_Xword = typename ELFT::Xword; using Elf_Sxword = typename
 ELFT::Sxword;

using uintX_t = typename ELFT::uint;

using Elf_Sym = typename ELFT::Sym;
using Elf_Shdr = typename ELFT::Shdr;
using Elf_Ehdr = typename ELFT::Ehdr;
using Elf_Rel = typename ELFT::Rel;
using Elf_Rela = typename ELFT::Rela;
using Elf_Dyn = typename ELFT::Dyn;

223private:
ELFObjectFile(MemoryBufferRef Object, ELFFile<ELFT> EF,
              const Elf_Shdr *DotDynSymSec, const Elf_Shdr *DotSymtabSec,
              ArrayRef<Elf_Word> ShndxTable);

228protected:
ELFFile<ELFT> EF;

const Elf_Shdr *DotDynSymSec = nullptr; // Dynamic symbol table section.
const Elf_Shdr *DotSymtabSec = nullptr; // Symbol table section.
ArrayRef<Elf_Word> ShndxTable;

void moveSymbolNext(DataRefImpl &Symb) const override;
Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;
uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
uint32_t getSymbolFlags(DataRefImpl Symb) const override;
uint8_t getSymbolOther(DataRefImpl Symb) const override;
uint8_t getSymbolELFType(DataRefImpl Symb) const override;
Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override;
Expected<section_iterator> getSymbolSection(const Elf_Sym *Symb,
                                            const Elf_Shdr *SymTab) const;
Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;

void moveSectionNext(DataRefImpl &Sec) const override;
std::error_code getSectionName(DataRefImpl Sec,
                               StringRef &Res) const override;
uint64_t getSectionAddress(DataRefImpl Sec) const override;
uint64_t getSectionIndex(DataRefImpl Sec) const override;
uint64_t getSectionSize(DataRefImpl Sec) const override;
std::error_code getSectionContents(DataRefImpl Sec,
                                   StringRef &Res) const override;
uint64_t getSectionAlignment(DataRefImpl Sec) const override;
bool isSectionCompressed(DataRefImpl Sec) const override;
bool isSectionText(DataRefImpl Sec) const override;
bool isSectionData(DataRefImpl Sec) const override;
bool isSectionBSS(DataRefImpl Sec) const override;
bool isSectionVirtual(DataRefImpl Sec) const override;
relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
relocation_iterator section_rel_end(DataRefImpl Sec) const override;
std::vector<SectionRef> dynamic_relocation_sections() const override;
section_iterator getRelocatedSection(DataRefImpl Sec) const override;

void moveRelocationNext(DataRefImpl &Rel) const override;
uint64_t getRelocationOffset(DataRefImpl Rel) const override;
symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
uint64_t getRelocationType(DataRefImpl Rel) const override;
void getRelocationTypeName(DataRefImpl Rel,
                           SmallVectorImpl<char> &Result) const override;

uint32_t getSectionType(DataRefImpl Sec) const override;
uint64_t getSectionFlags(DataRefImpl Sec) const override;
uint64_t getSectionOffset(DataRefImpl Sec) const override;
StringRef getRelocationTypeName(uint32_t Type) const;

/// Get the relocation section that contains \a Rel.
const Elf_Shdr *getRelSection(DataRefImpl Rel) const {
  auto RelSecOrErr = EF.getSection(Rel.d.a);
  if (!RelSecOrErr)
    report_fatal_error(errorToErrorCode(RelSecOrErr.takeError()).message());
  return *RelSecOrErr;
}

DataRefImpl toDRI(const Elf_Shdr *SymTable, unsigned SymbolNum) const {
  DataRefImpl DRI;
  if (!SymTable) {
    DRI.d.a = 0;
    DRI.d.b = 0;
    return DRI;
  }
  assert(SymTable->sh_type == ELF::SHT_SYMTAB ||((SymTable->sh_type == ELF::SHT_SYMTAB || SymTable->sh_type
 == ELF::SHT_DYNSYM) ? static_cast<void> (0) : __assert_fail
 ("SymTable->sh_type == ELF::SHT_SYMTAB || SymTable->sh_type == ELF::SHT_DYNSYM"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 296, __PRETTY_FUNCTION__))
         SymTable->sh_type == ELF::SHT_DYNSYM)((SymTable->sh_type == ELF::SHT_SYMTAB || SymTable->sh_type
 == ELF::SHT_DYNSYM) ? static_cast<void> (0) : __assert_fail
 ("SymTable->sh_type == ELF::SHT_SYMTAB || SymTable->sh_type == ELF::SHT_DYNSYM"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 296, __PRETTY_FUNCTION__));

  auto SectionsOrErr = EF.sections();
  if (!SectionsOrErr) {
    DRI.d.a = 0;
    DRI.d.b = 0;
    return DRI;
  }
  uintptr_t SHT = reinterpret_cast<uintptr_t>((*SectionsOrErr).begin());
  unsigned SymTableIndex =
      (reinterpret_cast<uintptr_t>(SymTable) - SHT) / sizeof(Elf_Shdr);

  DRI.d.a = SymTableIndex;
  DRI.d.b = SymbolNum;
  return DRI;
}

const Elf_Shdr *toELFShdrIter(DataRefImpl Sec) const {
  return reinterpret_cast<const Elf_Shdr *>(Sec.p);
}

DataRefImpl toDRI(const Elf_Shdr *Sec) const {
  DataRefImpl DRI;
  DRI.p = reinterpret_cast<uintptr_t>(Sec);
  return DRI;
}

DataRefImpl toDRI(const Elf_Dyn *Dyn) const {
  DataRefImpl DRI;
  DRI.p = reinterpret_cast<uintptr_t>(Dyn);
  return DRI;
}

bool isExportedToOtherDSO(const Elf_Sym *ESym) const {
  unsigned char Binding = ESym->getBinding();
  unsigned char Visibility = ESym->getVisibility();

  // A symbol is exported if its binding is either GLOBAL or WEAK, and its
  // visibility is either DEFAULT or PROTECTED. All other symbols are not
  // exported.
  return ((Binding == ELF::STB_GLOBAL || Binding == ELF::STB_WEAK) &&
          (Visibility == ELF::STV_DEFAULT ||
           Visibility == ELF::STV_PROTECTED));
}

// This flag is used for classof, to distinguish ELFObjectFile from
// its subclass. If more subclasses will be created, this flag will
// have to become an enum.
bool isDyldELFObject;

346public:
ELFObjectFile(ELFObjectFile<ELFT> &&Other);
static Expected<ELFObjectFile<ELFT>> create(MemoryBufferRef Object);

const Elf_Rel *getRel(DataRefImpl Rel) const;
const Elf_Rela *getRela(DataRefImpl Rela) const;

const Elf_Sym *getSymbol(DataRefImpl Sym) const {
  auto Ret = EF.template getEntry<Elf_Sym>(Sym.d.a, Sym.d.b);
3
←
Calling 'ELFFile::getEntry'→
  if (!Ret)
    report_fatal_error(errorToErrorCode(Ret.takeError()).message());
  return *Ret;
}

const Elf_Shdr *getSection(DataRefImpl Sec) const {
  return reinterpret_cast<const Elf_Shdr *>(Sec.p);
}

basic_symbol_iterator symbol_begin() const override;
basic_symbol_iterator symbol_end() const override;

elf_symbol_iterator dynamic_symbol_begin() const;
elf_symbol_iterator dynamic_symbol_end() const;

section_iterator section_begin() const override;
section_iterator section_end() const override;

Expected<int64_t> getRelocationAddend(DataRefImpl Rel) const override;

uint8_t getBytesInAddress() const override;
StringRef getFileFormatName() const override;
Triple::ArchType getArch() const override;
Expected<uint64_t> getStartAddress() const override;

unsigned getPlatformFlags() const override { return EF.getHeader()->e_flags; }

std::error_code getBuildAttributes(ARMAttributeParser &Attributes) const override {
  auto SectionsOrErr = EF.sections();
  if (!SectionsOrErr)
    return errorToErrorCode(SectionsOrErr.takeError());

  for (const Elf_Shdr &Sec : *SectionsOrErr) {
    if (Sec.sh_type == ELF::SHT_ARM_ATTRIBUTES) {
      auto ErrorOrContents = EF.getSectionContents(&Sec);
      if (!ErrorOrContents)
        return errorToErrorCode(ErrorOrContents.takeError());

      auto Contents = ErrorOrContents.get();
      if (Contents[0] != ARMBuildAttrs::Format_Version || Contents.size() == 1)
        return std::error_code();

      Attributes.Parse(Contents, ELFT::TargetEndianness == support::little);
      break;
    }
  }
  return std::error_code();
}

const ELFFile<ELFT> *getELFFile() const { return &EF; }

bool isDyldType() const { return isDyldELFObject; }
static bool classof(const Binary *v) {
  return v->getType() == getELFType(ELFT::TargetEndianness == support::little,
                                    ELFT::Is64Bits);
}

elf_symbol_iterator_range getDynamicSymbolIterators() const override;

bool isRelocatableObject() const override;
415};

417using ELF32LEObjectFile = ELFObjectFile<ELF32LE>;
418using ELF64LEObjectFile = ELFObjectFile<ELF64LE>;
419using ELF32BEObjectFile = ELFObjectFile<ELF32BE>;
420using ELF64BEObjectFile = ELFObjectFile<ELF64BE>;

422template <class ELFT>
423void ELFObjectFile<ELFT>::moveSymbolNext(DataRefImpl &Sym) const {
++Sym.d.b;
425}

427template <class ELFT>
428Expected<StringRef> ELFObjectFile<ELFT>::getSymbolName(DataRefImpl Sym) const {
const Elf_Sym *ESym = getSymbol(Sym);
auto SymTabOrErr = EF.getSection(Sym.d.a);
if (!SymTabOrErr)
  return SymTabOrErr.takeError();
const Elf_Shdr *SymTableSec = *SymTabOrErr;
auto StrTabOrErr = EF.getSection(SymTableSec->sh_link);
if (!StrTabOrErr)
  return StrTabOrErr.takeError();
const Elf_Shdr *StringTableSec = *StrTabOrErr;
auto SymStrTabOrErr = EF.getStringTable(StringTableSec);
if (!SymStrTabOrErr)
  return SymStrTabOrErr.takeError();
return ESym->getName(*SymStrTabOrErr);
442}

444template <class ELFT>
445uint64_t ELFObjectFile<ELFT>::getSectionFlags(DataRefImpl Sec) const {
return getSection(Sec)->sh_flags;
447}

449template <class ELFT>
450uint32_t ELFObjectFile<ELFT>::getSectionType(DataRefImpl Sec) const {
return getSection(Sec)->sh_type;
452}

454template <class ELFT>
455uint64_t ELFObjectFile<ELFT>::getSectionOffset(DataRefImpl Sec) const {
return getSection(Sec)->sh_offset;
457}

459template <class ELFT>
460uint64_t ELFObjectFile<ELFT>::getSymbolValueImpl(DataRefImpl Symb) const {
const Elf_Sym *ESym = getSymbol(Symb);
uint64_t Ret = ESym->st_value;
if (ESym->st_shndx == ELF::SHN_ABS)
  return Ret;

const Elf_Ehdr *Header = EF.getHeader();
// Clear the ARM/Thumb or microMIPS indicator flag.
if ((Header->e_machine == ELF::EM_ARM || Header->e_machine == ELF::EM_MIPS) &&
    ESym->getType() == ELF::STT_FUNC)
  Ret &= ~1;

return Ret;
473}

475template <class ELFT>
476Expected<uint64_t>
477ELFObjectFile<ELFT>::getSymbolAddress(DataRefImpl Symb) const {
uint64_t Result = getSymbolValue(Symb);
const Elf_Sym *ESym = getSymbol(Symb);
switch (ESym->st_shndx) {
case ELF::SHN_COMMON:
case ELF::SHN_UNDEF:
case ELF::SHN_ABS:
  return Result;
}

const Elf_Ehdr *Header = EF.getHeader();
auto SymTabOrErr = EF.getSection(Symb.d.a);
if (!SymTabOrErr)
  return SymTabOrErr.takeError();
const Elf_Shdr *SymTab = *SymTabOrErr;

if (Header->e_type == ELF::ET_REL) {
  auto SectionOrErr = EF.getSection(ESym, SymTab, ShndxTable);
  if (!SectionOrErr)
    return SectionOrErr.takeError();
  const Elf_Shdr *Section = *SectionOrErr;
  if (Section)
    Result += Section->sh_addr;
}

return Result;
503}

505template <class ELFT>
506uint32_t ELFObjectFile<ELFT>::getSymbolAlignment(DataRefImpl Symb) const {
const Elf_Sym *Sym = getSymbol(Symb);
if (Sym->st_shndx == ELF::SHN_COMMON)
  return Sym->st_value;
return 0;
511}

513template <class ELFT>
514uint16_t ELFObjectFile<ELFT>::getEMachine() const {
return EF.getHeader()->e_machine;
516}

518template <class ELFT> uint16_t ELFObjectFile<ELFT>::getEType() const {
return EF.getHeader()->e_type;
520}

522template <class ELFT>
523uint64_t ELFObjectFile<ELFT>::getSymbolSize(DataRefImpl Sym) const {
return getSymbol(Sym)->st_size;
525}

527template <class ELFT>
528uint64_t ELFObjectFile<ELFT>::getCommonSymbolSizeImpl(DataRefImpl Symb) const {
return getSymbol(Symb)->st_size;
530}

532template <class ELFT>
533uint8_t ELFObjectFile<ELFT>::getSymbolOther(DataRefImpl Symb) const {
return getSymbol(Symb)->st_other;
535}

537template <class ELFT>
538uint8_t ELFObjectFile<ELFT>::getSymbolELFType(DataRefImpl Symb) const {
return getSymbol(Symb)->getType();
540}

542template <class ELFT>
543Expected<SymbolRef::Type>
544ELFObjectFile<ELFT>::getSymbolType(DataRefImpl Symb) const {
const Elf_Sym *ESym = getSymbol(Symb);

switch (ESym->getType()) {
case ELF::STT_NOTYPE:
  return SymbolRef::ST_Unknown;
case ELF::STT_SECTION:
  return SymbolRef::ST_Debug;
case ELF::STT_FILE:
  return SymbolRef::ST_File;
case ELF::STT_FUNC:
  return SymbolRef::ST_Function;
case ELF::STT_OBJECT:
case ELF::STT_COMMON:
case ELF::STT_TLS:
  return SymbolRef::ST_Data;
default:
  return SymbolRef::ST_Other;
}
563}

565template <class ELFT>
566uint32_t ELFObjectFile<ELFT>::getSymbolFlags(DataRefImpl Sym) const {
const Elf_Sym *ESym = getSymbol(Sym);

uint32_t Result = SymbolRef::SF_None;

if (ESym->getBinding() != ELF::STB_LOCAL)
  Result |= SymbolRef::SF_Global;

if (ESym->getBinding() == ELF::STB_WEAK)
  Result |= SymbolRef::SF_Weak;

if (ESym->st_shndx == ELF::SHN_ABS)
  Result |= SymbolRef::SF_Absolute;

if (ESym->getType() == ELF::STT_FILE || ESym->getType() == ELF::STT_SECTION)
  Result |= SymbolRef::SF_FormatSpecific;

auto DotSymtabSecSyms = EF.symbols(DotSymtabSec);
if (DotSymtabSecSyms && ESym == (*DotSymtabSecSyms).begin())
  Result |= SymbolRef::SF_FormatSpecific;
auto DotDynSymSecSyms = EF.symbols(DotDynSymSec);
if (DotDynSymSecSyms && ESym == (*DotDynSymSecSyms).begin())
  Result |= SymbolRef::SF_FormatSpecific;

if (EF.getHeader()->e_machine == ELF::EM_ARM) {
  if (Expected<StringRef> NameOrErr = getSymbolName(Sym)) {
    StringRef Name = *NameOrErr;
    if (Name.startswith("$d") || Name.startswith("$t") ||
        Name.startswith("$a"))
      Result |= SymbolRef::SF_FormatSpecific;
  } else {
    // TODO: Actually report errors helpfully.
    consumeError(NameOrErr.takeError());
  }
  if (ESym->getType() == ELF::STT_FUNC && (ESym->st_value & 1) == 1)
    Result |= SymbolRef::SF_Thumb;
}

if (ESym->st_shndx == ELF::SHN_UNDEF)
  Result |= SymbolRef::SF_Undefined;

if (ESym->getType() == ELF::STT_COMMON || ESym->st_shndx == ELF::SHN_COMMON)
  Result |= SymbolRef::SF_Common;

if (isExportedToOtherDSO(ESym))
  Result |= SymbolRef::SF_Exported;

if (ESym->getVisibility() == ELF::STV_HIDDEN)
  Result |= SymbolRef::SF_Hidden;

return Result;
617}

619template <class ELFT>
620Expected<section_iterator>
621ELFObjectFile<ELFT>::getSymbolSection(const Elf_Sym *ESym,
                                    const Elf_Shdr *SymTab) const {
auto ESecOrErr = EF.getSection(ESym, SymTab, ShndxTable);
if (!ESecOrErr)
  return ESecOrErr.takeError();

const Elf_Shdr *ESec = *ESecOrErr;
if (!ESec)
  return section_end();

DataRefImpl Sec;
Sec.p = reinterpret_cast<intptr_t>(ESec);
return section_iterator(SectionRef(Sec, this));
634}

636template <class ELFT>
637Expected<section_iterator>
638ELFObjectFile<ELFT>::getSymbolSection(DataRefImpl Symb) const {
const Elf_Sym *Sym = getSymbol(Symb);
auto SymTabOrErr = EF.getSection(Symb.d.a);
if (!SymTabOrErr)
  return SymTabOrErr.takeError();
const Elf_Shdr *SymTab = *SymTabOrErr;
return getSymbolSection(Sym, SymTab);
645}

647template <class ELFT>
648void ELFObjectFile<ELFT>::moveSectionNext(DataRefImpl &Sec) const {
const Elf_Shdr *ESec = getSection(Sec);
Sec = toDRI(++ESec);
651}

653template <class ELFT>
654std::error_code ELFObjectFile<ELFT>::getSectionName(DataRefImpl Sec,
                                                  StringRef &Result) const {
auto Name = EF.getSectionName(&*getSection(Sec));
if (!Name)
  return errorToErrorCode(Name.takeError());
Result = *Name;
return std::error_code();
661}

663template <class ELFT>
664uint64_t ELFObjectFile<ELFT>::getSectionAddress(DataRefImpl Sec) const {
return getSection(Sec)->sh_addr;
666}

668template <class ELFT>
669uint64_t ELFObjectFile<ELFT>::getSectionIndex(DataRefImpl Sec) const {
auto SectionsOrErr = EF.sections();
handleAllErrors(std::move(SectionsOrErr.takeError()),
                [](const ErrorInfoBase &) {
                  llvm_unreachable("unable to get section index")::llvm::llvm_unreachable_internal("unable to get section index"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 673);
                });
const Elf_Shdr *First = SectionsOrErr->begin();
return getSection(Sec) - First;
677}

679template <class ELFT>
680uint64_t ELFObjectFile<ELFT>::getSectionSize(DataRefImpl Sec) const {
return getSection(Sec)->sh_size;
682}

684template <class ELFT>
685std::error_code
686ELFObjectFile<ELFT>::getSectionContents(DataRefImpl Sec,
                                      StringRef &Result) const {
const Elf_Shdr *EShdr = getSection(Sec);
if (std::error_code EC =
        checkOffset(getMemoryBufferRef(),
                    (uintptr_t)base() + EShdr->sh_offset, EShdr->sh_size))
  return EC;
Result = StringRef((const char *)base() + EShdr->sh_offset, EShdr->sh_size);
return std::error_code();
695}

697template <class ELFT>
698uint64_t ELFObjectFile<ELFT>::getSectionAlignment(DataRefImpl Sec) const {
return getSection(Sec)->sh_addralign;
700}

702template <class ELFT>
703bool ELFObjectFile<ELFT>::isSectionCompressed(DataRefImpl Sec) const {
return getSection(Sec)->sh_flags & ELF::SHF_COMPRESSED;
705}

707template <class ELFT>
708bool ELFObjectFile<ELFT>::isSectionText(DataRefImpl Sec) const {
return getSection(Sec)->sh_flags & ELF::SHF_EXECINSTR;
710}

712template <class ELFT>
713bool ELFObjectFile<ELFT>::isSectionData(DataRefImpl Sec) const {
const Elf_Shdr *EShdr = getSection(Sec);
return EShdr->sh_type == ELF::SHT_PROGBITS &&
       EShdr->sh_flags & ELF::SHF_ALLOC &&
       !(EShdr->sh_flags & ELF::SHF_EXECINSTR);
718}

720template <class ELFT>
721bool ELFObjectFile<ELFT>::isSectionBSS(DataRefImpl Sec) const {
const Elf_Shdr *EShdr = getSection(Sec);
return EShdr->sh_flags & (ELF::SHF_ALLOC | ELF::SHF_WRITE) &&
       EShdr->sh_type == ELF::SHT_NOBITS;
725}

727template <class ELFT>
728std::vector<SectionRef>
729ELFObjectFile<ELFT>::dynamic_relocation_sections() const {
std::vector<SectionRef> Res;
std::vector<uintptr_t> Offsets;

auto SectionsOrErr = EF.sections();
if (!SectionsOrErr)
  return Res;

for (const Elf_Shdr &Sec : *SectionsOrErr) {
  if (Sec.sh_type != ELF::SHT_DYNAMIC)
    continue;
  Elf_Dyn *Dynamic =
      reinterpret_cast<Elf_Dyn *>((uintptr_t)base() + Sec.sh_offset);
  for (; Dynamic->d_tag != ELF::DT_NULL; Dynamic++) {
    if (Dynamic->d_tag == ELF::DT_REL || Dynamic->d_tag == ELF::DT_RELA ||
        Dynamic->d_tag == ELF::DT_JMPREL) {
      Offsets.push_back(Dynamic->d_un.d_val);
    }
  }
}
for (const Elf_Shdr &Sec : *SectionsOrErr) {
  if (is_contained(Offsets, Sec.sh_offset))
    Res.emplace_back(toDRI(&Sec), this);
}
return Res;
754}

756template <class ELFT>
757bool ELFObjectFile<ELFT>::isSectionVirtual(DataRefImpl Sec) const {
return getSection(Sec)->sh_type == ELF::SHT_NOBITS;
759}

761template <class ELFT>
762relocation_iterator
763ELFObjectFile<ELFT>::section_rel_begin(DataRefImpl Sec) const {
DataRefImpl RelData;
auto SectionsOrErr = EF.sections();
if (!SectionsOrErr)
  return relocation_iterator(RelocationRef());
uintptr_t SHT = reinterpret_cast<uintptr_t>((*SectionsOrErr).begin());
RelData.d.a = (Sec.p - SHT) / EF.getHeader()->e_shentsize;
RelData.d.b = 0;
return relocation_iterator(RelocationRef(RelData, this));
772}

774template <class ELFT>
775relocation_iterator
776ELFObjectFile<ELFT>::section_rel_end(DataRefImpl Sec) const {
const Elf_Shdr *S = reinterpret_cast<const Elf_Shdr *>(Sec.p);
relocation_iterator Begin = section_rel_begin(Sec);
if (S->sh_type != ELF::SHT_RELA && S->sh_type != ELF::SHT_REL)
  return Begin;
DataRefImpl RelData = Begin->getRawDataRefImpl();
const Elf_Shdr *RelSec = getRelSection(RelData);

// Error check sh_link here so that getRelocationSymbol can just use it.
auto SymSecOrErr = EF.getSection(RelSec->sh_link);
if (!SymSecOrErr)
  report_fatal_error(errorToErrorCode(SymSecOrErr.takeError()).message());

RelData.d.b += S->sh_size / S->sh_entsize;
return relocation_iterator(RelocationRef(RelData, this));
791}

793template <class ELFT>
794section_iterator
795ELFObjectFile<ELFT>::getRelocatedSection(DataRefImpl Sec) const {
if (EF.getHeader()->e_type != ELF::ET_REL)
  return section_end();

const Elf_Shdr *EShdr = getSection(Sec);
uintX_t Type = EShdr->sh_type;
if (Type != ELF::SHT_REL && Type != ELF::SHT_RELA)
  return section_end();

auto R = EF.getSection(EShdr->sh_info);
if (!R)
  report_fatal_error(errorToErrorCode(R.takeError()).message());
return section_iterator(SectionRef(toDRI(*R), this));
808}

810// Relocations
811template <class ELFT>
812void ELFObjectFile<ELFT>::moveRelocationNext(DataRefImpl &Rel) const {
++Rel.d.b;
814}

816template <class ELFT>
817symbol_iterator
818ELFObjectFile<ELFT>::getRelocationSymbol(DataRefImpl Rel) const {
uint32_t symbolIdx;
const Elf_Shdr *sec = getRelSection(Rel);
if (sec->sh_type == ELF::SHT_REL)
  symbolIdx = getRel(Rel)->getSymbol(EF.isMips64EL());
else
  symbolIdx = getRela(Rel)->getSymbol(EF.isMips64EL());
if (!symbolIdx)
  return symbol_end();

// FIXME: error check symbolIdx
DataRefImpl SymbolData;
SymbolData.d.a = sec->sh_link;
SymbolData.d.b = symbolIdx;
return symbol_iterator(SymbolRef(SymbolData, this));
833}

835template <class ELFT>
836uint64_t ELFObjectFile<ELFT>::getRelocationOffset(DataRefImpl Rel) const {
const Elf_Shdr *sec = getRelSection(Rel);
if (sec->sh_type == ELF::SHT_REL)
  return getRel(Rel)->r_offset;

return getRela(Rel)->r_offset;
842}

844template <class ELFT>
845uint64_t ELFObjectFile<ELFT>::getRelocationType(DataRefImpl Rel) const {
const Elf_Shdr *sec = getRelSection(Rel);
if (sec->sh_type == ELF::SHT_REL)
  return getRel(Rel)->getType(EF.isMips64EL());
else
  return getRela(Rel)->getType(EF.isMips64EL());
851}

853template <class ELFT>
854StringRef ELFObjectFile<ELFT>::getRelocationTypeName(uint32_t Type) const {
return getELFRelocationTypeName(EF.getHeader()->e_machine, Type);
856}

858template <class ELFT>
859void ELFObjectFile<ELFT>::getRelocationTypeName(
  DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
uint32_t type = getRelocationType(Rel);
EF.getRelocationTypeName(type, Result);
863}

865template <class ELFT>
866Expected<int64_t>
867ELFObjectFile<ELFT>::getRelocationAddend(DataRefImpl Rel) const {
if (getRelSection(Rel)->sh_type != ELF::SHT_RELA)
  return createError("Section is not SHT_RELA");
return (int64_t)getRela(Rel)->r_addend;
871}

873template <class ELFT>
874const typename ELFObjectFile<ELFT>::Elf_Rel *
875ELFObjectFile<ELFT>::getRel(DataRefImpl Rel) const {
assert(getRelSection(Rel)->sh_type == ELF::SHT_REL)((getRelSection(Rel)->sh_type == ELF::SHT_REL) ? static_cast
<void> (0) : __assert_fail ("getRelSection(Rel)->sh_type == ELF::SHT_REL"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 876, __PRETTY_FUNCTION__));
auto Ret = EF.template getEntry<Elf_Rel>(Rel.d.a, Rel.d.b);
if (!Ret)
  report_fatal_error(errorToErrorCode(Ret.takeError()).message());
return *Ret;
881}

883template <class ELFT>
884const typename ELFObjectFile<ELFT>::Elf_Rela *
885ELFObjectFile<ELFT>::getRela(DataRefImpl Rela) const {
assert(getRelSection(Rela)->sh_type == ELF::SHT_RELA)((getRelSection(Rela)->sh_type == ELF::SHT_RELA) ? static_cast
<void> (0) : __assert_fail ("getRelSection(Rela)->sh_type == ELF::SHT_RELA"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELFObjectFile.h"
, 886, __PRETTY_FUNCTION__));
auto Ret = EF.template getEntry<Elf_Rela>(Rela.d.a, Rela.d.b);
if (!Ret)
  report_fatal_error(errorToErrorCode(Ret.takeError()).message());
return *Ret;
891}

893template <class ELFT>
894Expected<ELFObjectFile<ELFT>>
895ELFObjectFile<ELFT>::create(MemoryBufferRef Object) {
auto EFOrErr = ELFFile<ELFT>::create(Object.getBuffer());
if (Error E = EFOrErr.takeError())
  return std::move(E);
auto EF = std::move(*EFOrErr);

auto SectionsOrErr = EF.sections();
if (!SectionsOrErr)
  return SectionsOrErr.takeError();

const Elf_Shdr *DotDynSymSec = nullptr;
const Elf_Shdr *DotSymtabSec = nullptr;
ArrayRef<Elf_Word> ShndxTable;
for (const Elf_Shdr &Sec : *SectionsOrErr) {
  switch (Sec.sh_type) {
  case ELF::SHT_DYNSYM: {
    if (DotDynSymSec)
      return createError("More than one dynamic symbol table!");
    DotDynSymSec = &Sec;
    break;
  }
  case ELF::SHT_SYMTAB: {
    if (DotSymtabSec)
      return createError("More than one static symbol table!");
    DotSymtabSec = &Sec;
    break;
  }
  case ELF::SHT_SYMTAB_SHNDX: {
    auto TableOrErr = EF.getSHNDXTable(Sec);
    if (!TableOrErr)
      return TableOrErr.takeError();
    ShndxTable = *TableOrErr;
    break;
  }
  }
}
return ELFObjectFile<ELFT>(Object, EF, DotDynSymSec, DotSymtabSec,
                           ShndxTable);
933}

935template <class ELFT>
936ELFObjectFile<ELFT>::ELFObjectFile(MemoryBufferRef Object, ELFFile<ELFT> EF,
                                 const Elf_Shdr *DotDynSymSec,
                                 const Elf_Shdr *DotSymtabSec,
                                 ArrayRef<Elf_Word> ShndxTable)
  : ELFObjectFileBase(
        getELFType(ELFT::TargetEndianness == support::little, ELFT::Is64Bits),
        Object),
    EF(EF), DotDynSymSec(DotDynSymSec), DotSymtabSec(DotSymtabSec),
    ShndxTable(ShndxTable) {}

946template <class ELFT>
947ELFObjectFile<ELFT>::ELFObjectFile(ELFObjectFile<ELFT> &&Other)
  : ELFObjectFile(Other.Data, Other.EF, Other.DotDynSymSec,
                  Other.DotSymtabSec, Other.ShndxTable) {}

951template <class ELFT>
952basic_symbol_iterator ELFObjectFile<ELFT>::symbol_begin() const {
DataRefImpl Sym = toDRI(DotSymtabSec, 0);
return basic_symbol_iterator(SymbolRef(Sym, this));
955}

957template <class ELFT>
958basic_symbol_iterator ELFObjectFile<ELFT>::symbol_end() const {
const Elf_Shdr *SymTab = DotSymtabSec;
if (!SymTab)
  return symbol_begin();
DataRefImpl Sym = toDRI(SymTab, SymTab->sh_size / sizeof(Elf_Sym));
return basic_symbol_iterator(SymbolRef(Sym, this));
964}

966template <class ELFT>
967elf_symbol_iterator ELFObjectFile<ELFT>::dynamic_symbol_begin() const {
DataRefImpl Sym = toDRI(DotDynSymSec, 0);
return symbol_iterator(SymbolRef(Sym, this));
970}

972template <class ELFT>
973elf_symbol_iterator ELFObjectFile<ELFT>::dynamic_symbol_end() const {
const Elf_Shdr *SymTab = DotDynSymSec;
if (!SymTab)
  return dynamic_symbol_begin();
DataRefImpl Sym = toDRI(SymTab, SymTab->sh_size / sizeof(Elf_Sym));
return basic_symbol_iterator(SymbolRef(Sym, this));
979}

981template <class ELFT>
982section_iterator ELFObjectFile<ELFT>::section_begin() const {
auto SectionsOrErr = EF.sections();
if (!SectionsOrErr)
  return section_iterator(SectionRef());
return section_iterator(SectionRef(toDRI((*SectionsOrErr).begin()), this));
987}

989template <class ELFT>
990section_iterator ELFObjectFile<ELFT>::section_end() const {
auto SectionsOrErr = EF.sections();
if (!SectionsOrErr)
  return section_iterator(SectionRef());
return section_iterator(SectionRef(toDRI((*SectionsOrErr).end()), this));
995}

997template <class ELFT>
998uint8_t ELFObjectFile<ELFT>::getBytesInAddress() const {
return ELFT::Is64Bits ? 8 : 4;
1000}

1002template <class ELFT>
1003StringRef ELFObjectFile<ELFT>::getFileFormatName() const {
bool IsLittleEndian = ELFT::TargetEndianness == support::little;
switch (EF.getHeader()->e_ident[ELF::EI_CLASS]) {
case ELF::ELFCLASS32:
  switch (EF.getHeader()->e_machine) {
  case ELF::EM_386:
    return "ELF32-i386";
  case ELF::EM_IAMCU:
    return "ELF32-iamcu";
  case ELF::EM_X86_64:
    return "ELF32-x86-64";
  case ELF::EM_ARM:
    return (IsLittleEndian ? "ELF32-arm-little" : "ELF32-arm-big");
  case ELF::EM_AVR:
    return "ELF32-avr";
  case ELF::EM_HEXAGON:
    return "ELF32-hexagon";
  case ELF::EM_LANAI:
    return "ELF32-lanai";
  case ELF::EM_MIPS:
    return "ELF32-mips";
  case ELF::EM_PPC:
    return "ELF32-ppc";
  case ELF::EM_RISCV:
    return "ELF32-riscv";
  case ELF::EM_SPARC:
  case ELF::EM_SPARC32PLUS:
    return "ELF32-sparc";
  case ELF::EM_AMDGPU:
    return "ELF32-amdgpu";
  default:
    return "ELF32-unknown";
  }
case ELF::ELFCLASS64:
  switch (EF.getHeader()->e_machine) {
  case ELF::EM_386:
    return "ELF64-i386";
  case ELF::EM_X86_64:
    return "ELF64-x86-64";
  case ELF::EM_AARCH64:
    return (IsLittleEndian ? "ELF64-aarch64-little" : "ELF64-aarch64-big");
  case ELF::EM_PPC64:
    return "ELF64-ppc64";
  case ELF::EM_RISCV:
    return "ELF64-riscv";
  case ELF::EM_S390:
    return "ELF64-s390";
  case ELF::EM_SPARCV9:
    return "ELF64-sparc";
  case ELF::EM_MIPS:
    return "ELF64-mips";
  case ELF::EM_AMDGPU:
    return "ELF64-amdgpu";
  case ELF::EM_BPF:
    return "ELF64-BPF";
  default:
    return "ELF64-unknown";
  }
default:
  // FIXME: Proper error handling.
  report_fatal_error("Invalid ELFCLASS!");
}
1065}

1067template <class ELFT> Triple::ArchType ELFObjectFile<ELFT>::getArch() const {
bool IsLittleEndian = ELFT::TargetEndianness == support::little;
switch (EF.getHeader()->e_machine) {
case ELF::EM_386:
case ELF::EM_IAMCU:
  return Triple::x86;
case ELF::EM_X86_64:
  return Triple::x86_64;
case ELF::EM_AARCH64:
  return IsLittleEndian ? Triple::aarch64 : Triple::aarch64_be;
case ELF::EM_ARM:
  return Triple::arm;
case ELF::EM_AVR:
  return Triple::avr;
case ELF::EM_HEXAGON:
  return Triple::hexagon;
case ELF::EM_LANAI:
  return Triple::lanai;
case ELF::EM_MIPS:
  switch (EF.getHeader()->e_ident[ELF::EI_CLASS]) {
  case ELF::ELFCLASS32:
    return IsLittleEndian ? Triple::mipsel : Triple::mips;
  case ELF::ELFCLASS64:
    return IsLittleEndian ? Triple::mips64el : Triple::mips64;
  default:
    report_fatal_error("Invalid ELFCLASS!");
  }
case ELF::EM_PPC:
  return Triple::ppc;
case ELF::EM_PPC64:
  return IsLittleEndian ? Triple::ppc64le : Triple::ppc64;
case ELF::EM_RISCV:
  switch (EF.getHeader()->e_ident[ELF::EI_CLASS]) {
  case ELF::ELFCLASS32:
    return Triple::riscv32;
  case ELF::ELFCLASS64:
    return Triple::riscv64;
  default:
    report_fatal_error("Invalid ELFCLASS!");
  }
case ELF::EM_S390:
  return Triple::systemz;

case ELF::EM_SPARC:
case ELF::EM_SPARC32PLUS:
  return IsLittleEndian ? Triple::sparcel : Triple::sparc;
case ELF::EM_SPARCV9:
  return Triple::sparcv9;

case ELF::EM_AMDGPU: {
  if (!IsLittleEndian)
    return Triple::UnknownArch;

  unsigned MACH = EF.getHeader()->e_flags & ELF::EF_AMDGPU_MACH;
  if (MACH >= ELF::EF_AMDGPU_MACH_R600_FIRST &&
      MACH <= ELF::EF_AMDGPU_MACH_R600_LAST)
    return Triple::r600;
  if (MACH >= ELF::EF_AMDGPU_MACH_AMDGCN_FIRST &&
      MACH <= ELF::EF_AMDGPU_MACH_AMDGCN_LAST)
    return Triple::amdgcn;

  return Triple::UnknownArch;
}

case ELF::EM_BPF:
  return IsLittleEndian ? Triple::bpfel : Triple::bpfeb;

default:
  return Triple::UnknownArch;
}
1137}

1139template <class ELFT>
1140Expected<uint64_t> ELFObjectFile<ELFT>::getStartAddress() const {
return EF.getHeader()->e_entry;
1142}

1144template <class ELFT>
1145ELFObjectFileBase::elf_symbol_iterator_range
1146ELFObjectFile<ELFT>::getDynamicSymbolIterators() const {
return make_range(dynamic_symbol_begin(), dynamic_symbol_end());
1148}

1150template <class ELFT> bool ELFObjectFile<ELFT>::isRelocatableObject() const {
return EF.getHeader()->e_type == ELF::ET_REL;
1152}

1154} // end namespace object
1155} // end namespace llvm

1157#endif // LLVM_OBJECT_ELFOBJECTFILE_H

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELF.h

→

1//===- ELF.h - ELF object file implementation -------------------*- 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 declares the ELFFile template class.
11//
12//===----------------------------------------------------------------------===//

14#ifndef LLVM_OBJECT_ELF_H
15#define LLVM_OBJECT_ELF_H

17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/BinaryFormat/ELF.h"
21#include "llvm/Object/ELFTypes.h"
22#include "llvm/Object/Error.h"
23#include "llvm/Support/Endian.h"
24#include "llvm/Support/Error.h"
25#include <cassert>
26#include <cstddef>
27#include <cstdint>
28#include <limits>
29#include <utility>

31namespace llvm {
32namespace object {

34StringRef getELFRelocationTypeName(uint32_t Machine, uint32_t Type);
35uint32_t getELFRelrRelocationType(uint32_t Machine);
36StringRef getELFSectionTypeName(uint32_t Machine, uint32_t Type);

38// Subclasses of ELFFile may need this for template instantiation
39inline std::pair<unsigned char, unsigned char>
40getElfArchType(StringRef Object) {
if (Object.size() < ELF::EI_NIDENT)
  return std::make_pair((uint8_t)ELF::ELFCLASSNONE,
                        (uint8_t)ELF::ELFDATANONE);
return std::make_pair((uint8_t)Object[ELF::EI_CLASS],
                      (uint8_t)Object[ELF::EI_DATA]);
46}

48static inline Error createError(StringRef Err) {
return make_error<StringError>(Err, object_error::parse_failed);
11
←
Calling 'make_error<llvm::StringError, llvm::StringRef &, llvm::object::object_error>'→
50}

52template <class ELFT>
53class ELFFile {
54public:
LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)using Elf_Addr = typename ELFT::Addr; using Elf_Off = typename
 ELFT::Off; using Elf_Half = typename ELFT::Half; using Elf_Word
 = typename ELFT::Word; using Elf_Sword = typename ELFT::Sword
; using Elf_Xword = typename ELFT::Xword; using Elf_Sxword = typename
 ELFT::Sxword;
using uintX_t = typename ELFT::uint;
using Elf_Ehdr = typename ELFT::Ehdr;
using Elf_Shdr = typename ELFT::Shdr;
using Elf_Sym = typename ELFT::Sym;
using Elf_Dyn = typename ELFT::Dyn;
using Elf_Phdr = typename ELFT::Phdr;
using Elf_Rel = typename ELFT::Rel;
using Elf_Rela = typename ELFT::Rela;
using Elf_Relr = typename ELFT::Relr;
using Elf_Verdef = typename ELFT::Verdef;
using Elf_Verdaux = typename ELFT::Verdaux;
using Elf_Verneed = typename ELFT::Verneed;
using Elf_Vernaux = typename ELFT::Vernaux;
using Elf_Versym = typename ELFT::Versym;
using Elf_Hash = typename ELFT::Hash;
using Elf_GnuHash = typename ELFT::GnuHash;
using Elf_Nhdr = typename ELFT::Nhdr;
using Elf_Note = typename ELFT::Note;
using Elf_Note_Iterator = typename ELFT::NoteIterator;
using Elf_Dyn_Range = typename ELFT::DynRange;
using Elf_Shdr_Range = typename ELFT::ShdrRange;
using Elf_Sym_Range = typename ELFT::SymRange;
using Elf_Rel_Range = typename ELFT::RelRange;
using Elf_Rela_Range = typename ELFT::RelaRange;
using Elf_Relr_Range = typename ELFT::RelrRange;
using Elf_Phdr_Range = typename ELFT::PhdrRange;

const uint8_t *base() const {
  return reinterpret_cast<const uint8_t *>(Buf.data());
}

size_t getBufSize() const { return Buf.size(); }

89private:
StringRef Buf;

ELFFile(StringRef Object);

94public:
const Elf_Ehdr *getHeader() const {
  return reinterpret_cast<const Elf_Ehdr *>(base());
}

template <typename T>
Expected<const T *> getEntry(uint32_t Section, uint32_t Entry) const;
template <typename T>
Expected<const T *> getEntry(const Elf_Shdr *Section, uint32_t Entry) const;

Expected<StringRef> getStringTable(const Elf_Shdr *Section) const;
Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section) const;
Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section,
                                            Elf_Shdr_Range Sections) const;

Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section) const;
Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section,
                                           Elf_Shdr_Range Sections) const;

StringRef getRelocationTypeName(uint32_t Type) const;
void getRelocationTypeName(uint32_t Type,
                           SmallVectorImpl<char> &Result) const;
uint32_t getRelrRelocationType() const;

const char *getDynamicTagAsString(unsigned Arch, uint64_t Type) const;
const char *getDynamicTagAsString(uint64_t Type) const;

/// Get the symbol for a given relocation.
Expected<const Elf_Sym *> getRelocationSymbol(const Elf_Rel *Rel,
                                              const Elf_Shdr *SymTab) const;

static Expected<ELFFile> create(StringRef Object);

bool isMipsELF64() const {
  return getHeader()->e_machine == ELF::EM_MIPS &&
         getHeader()->getFileClass() == ELF::ELFCLASS64;
}

bool isMips64EL() const {
  return isMipsELF64() &&
         getHeader()->getDataEncoding() == ELF::ELFDATA2LSB;
}

Expected<Elf_Shdr_Range> sections() const;

Expected<Elf_Dyn_Range> dynamicEntries() const;

Expected<const uint8_t *> toMappedAddr(uint64_t VAddr) const;

Expected<Elf_Sym_Range> symbols(const Elf_Shdr *Sec) const {
  if (!Sec)
    return makeArrayRef<Elf_Sym>(nullptr, nullptr);
  return getSectionContentsAsArray<Elf_Sym>(Sec);
}

Expected<Elf_Rela_Range> relas(const Elf_Shdr *Sec) const {
  return getSectionContentsAsArray<Elf_Rela>(Sec);
}

Expected<Elf_Rel_Range> rels(const Elf_Shdr *Sec) const {
  return getSectionContentsAsArray<Elf_Rel>(Sec);
}

Expected<Elf_Relr_Range> relrs(const Elf_Shdr *Sec) const {
  return getSectionContentsAsArray<Elf_Relr>(Sec);
}

Expected<std::vector<Elf_Rela>> decode_relrs(Elf_Relr_Range relrs) const;

Expected<std::vector<Elf_Rela>> android_relas(const Elf_Shdr *Sec) const;

/// Iterate over program header table.
Expected<Elf_Phdr_Range> program_headers() const {
  if (getHeader()->e_phnum && getHeader()->e_phentsize != sizeof(Elf_Phdr))
    return createError("invalid e_phentsize");
  if (getHeader()->e_phoff +
          (getHeader()->e_phnum * getHeader()->e_phentsize) >
      getBufSize())
    return createError("program headers longer than binary");
  auto *Begin =
      reinterpret_cast<const Elf_Phdr *>(base() + getHeader()->e_phoff);
  return makeArrayRef(Begin, Begin + getHeader()->e_phnum);
}

/// Get an iterator over notes in a program header.
///
/// The program header must be of type \c PT_NOTE.
///
/// \param Phdr the program header to iterate over.
/// \param Err [out] an error to support fallible iteration, which should
///  be checked after iteration ends.
Elf_Note_Iterator notes_begin(const Elf_Phdr &Phdr, Error &Err) const {
  if (Phdr.p_type != ELF::PT_NOTE) {
    Err = createError("attempt to iterate notes of non-note program header");
    return Elf_Note_Iterator(Err);
  }
  if (Phdr.p_offset + Phdr.p_filesz > getBufSize()) {
    Err = createError("invalid program header offset/size");
    return Elf_Note_Iterator(Err);
  }
  return Elf_Note_Iterator(base() + Phdr.p_offset, Phdr.p_filesz, Err);
}

/// Get an iterator over notes in a section.
///
/// The section must be of type \c SHT_NOTE.
///
/// \param Shdr the section to iterate over.
/// \param Err [out] an error to support fallible iteration, which should
///  be checked after iteration ends.
Elf_Note_Iterator notes_begin(const Elf_Shdr &Shdr, Error &Err) const {
  if (Shdr.sh_type != ELF::SHT_NOTE) {
    Err = createError("attempt to iterate notes of non-note section");
    return Elf_Note_Iterator(Err);
  }
  if (Shdr.sh_offset + Shdr.sh_size > getBufSize()) {
    Err = createError("invalid section offset/size");
    return Elf_Note_Iterator(Err);
  }
  return Elf_Note_Iterator(base() + Shdr.sh_offset, Shdr.sh_size, Err);
}

/// Get the end iterator for notes.
Elf_Note_Iterator notes_end() const {
  return Elf_Note_Iterator();
}

/// Get an iterator range over notes of a program header.
///
/// The program header must be of type \c PT_NOTE.
///
/// \param Phdr the program header to iterate over.
/// \param Err [out] an error to support fallible iteration, which should
///  be checked after iteration ends.
iterator_range<Elf_Note_Iterator> notes(const Elf_Phdr &Phdr,
                                        Error &Err) const {
  return make_range(notes_begin(Phdr, Err), notes_end());
}

/// Get an iterator range over notes of a section.
///
/// The section must be of type \c SHT_NOTE.
///
/// \param Shdr the section to iterate over.
/// \param Err [out] an error to support fallible iteration, which should
///  be checked after iteration ends.
iterator_range<Elf_Note_Iterator> notes(const Elf_Shdr &Shdr,
                                        Error &Err) const {
  return make_range(notes_begin(Shdr, Err), notes_end());
}

Expected<StringRef> getSectionStringTable(Elf_Shdr_Range Sections) const;
Expected<uint32_t> getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms,
                                   ArrayRef<Elf_Word> ShndxTable) const;
Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym,
                                      const Elf_Shdr *SymTab,
                                      ArrayRef<Elf_Word> ShndxTable) const;
Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym,
                                      Elf_Sym_Range Symtab,
                                      ArrayRef<Elf_Word> ShndxTable) const;
Expected<const Elf_Shdr *> getSection(uint32_t Index) const;
Expected<const Elf_Shdr *> getSection(const StringRef SectionName) const;

Expected<const Elf_Sym *> getSymbol(const Elf_Shdr *Sec,
                                    uint32_t Index) const;

Expected<StringRef> getSectionName(const Elf_Shdr *Section) const;
Expected<StringRef> getSectionName(const Elf_Shdr *Section,
                                   StringRef DotShstrtab) const;
template <typename T>
Expected<ArrayRef<T>> getSectionContentsAsArray(const Elf_Shdr *Sec) const;
Expected<ArrayRef<uint8_t>> getSectionContents(const Elf_Shdr *Sec) const;
266};

268using ELF32LEFile = ELFFile<ELF32LE>;
269using ELF64LEFile = ELFFile<ELF64LE>;
270using ELF32BEFile = ELFFile<ELF32BE>;
271using ELF64BEFile = ELFFile<ELF64BE>;

273template <class ELFT>
274inline Expected<const typename ELFT::Shdr *>
275getSection(typename ELFT::ShdrRange Sections, uint32_t Index) {
if (Index >= Sections.size())
  return createError("invalid section index");
return &Sections[Index];
279}

281template <class ELFT>
282inline Expected<uint32_t>
283getExtendedSymbolTableIndex(const typename ELFT::Sym *Sym,
                          const typename ELFT::Sym *FirstSym,
                          ArrayRef<typename ELFT::Word> ShndxTable) {
assert(Sym->st_shndx == ELF::SHN_XINDEX)((Sym->st_shndx == ELF::SHN_XINDEX) ? static_cast<void>
 (0) : __assert_fail ("Sym->st_shndx == ELF::SHN_XINDEX", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELF.h"
, 286, __PRETTY_FUNCTION__));
unsigned Index = Sym - FirstSym;
if (Index >= ShndxTable.size())
  return createError("index past the end of the symbol table");

// The size of the table was checked in getSHNDXTable.
return ShndxTable[Index];
293}

295template <class ELFT>
296Expected<uint32_t>
297ELFFile<ELFT>::getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms,
                             ArrayRef<Elf_Word> ShndxTable) const {
uint32_t Index = Sym->st_shndx;
if (Index == ELF::SHN_XINDEX) {
  auto ErrorOrIndex = getExtendedSymbolTableIndex<ELFT>(
      Sym, Syms.begin(), ShndxTable);
  if (!ErrorOrIndex)
    return ErrorOrIndex.takeError();
  return *ErrorOrIndex;
}
if (Index == ELF::SHN_UNDEF || Index >= ELF::SHN_LORESERVE)
  return 0;
return Index;
310}

312template <class ELFT>
313Expected<const typename ELFT::Shdr *>
314ELFFile<ELFT>::getSection(const Elf_Sym *Sym, const Elf_Shdr *SymTab,
                        ArrayRef<Elf_Word> ShndxTable) const {
auto SymsOrErr = symbols(SymTab);
if (!SymsOrErr)
  return SymsOrErr.takeError();
return getSection(Sym, *SymsOrErr, ShndxTable);
320}

322template <class ELFT>
323Expected<const typename ELFT::Shdr *>
324ELFFile<ELFT>::getSection(const Elf_Sym *Sym, Elf_Sym_Range Symbols,
                        ArrayRef<Elf_Word> ShndxTable) const {
auto IndexOrErr = getSectionIndex(Sym, Symbols, ShndxTable);
if (!IndexOrErr)
  return IndexOrErr.takeError();
uint32_t Index = *IndexOrErr;
if (Index == 0)
  return nullptr;
return getSection(Index);
333}

335template <class ELFT>
336inline Expected<const typename ELFT::Sym *>
337getSymbol(typename ELFT::SymRange Symbols, uint32_t Index) {
if (Index >= Symbols.size())
  return createError("invalid symbol index");
return &Symbols[Index];
341}

343template <class ELFT>
344Expected<const typename ELFT::Sym *>
345ELFFile<ELFT>::getSymbol(const Elf_Shdr *Sec, uint32_t Index) const {
auto SymtabOrErr = symbols(Sec);
if (!SymtabOrErr)
  return SymtabOrErr.takeError();
return object::getSymbol<ELFT>(*SymtabOrErr, Index);
350}

352template <class ELFT>
353template <typename T>
354Expected<ArrayRef<T>>
355ELFFile<ELFT>::getSectionContentsAsArray(const Elf_Shdr *Sec) const {
if (Sec->sh_entsize != sizeof(T) && sizeof(T) != 1)
  return createError("invalid sh_entsize");

uintX_t Offset = Sec->sh_offset;
uintX_t Size = Sec->sh_size;

if (Size % sizeof(T))
  return createError("size is not a multiple of sh_entsize");
if ((std::numeric_limits<uintX_t>::max() - Offset < Size) ||
    Offset + Size > Buf.size())
  return createError("invalid section offset");

if (Offset % alignof(T))
  return createError("unaligned data");

const T *Start = reinterpret_cast<const T *>(base() + Offset);
return makeArrayRef(Start, Size / sizeof(T));
373}

375template <class ELFT>
376Expected<ArrayRef<uint8_t>>
377ELFFile<ELFT>::getSectionContents(const Elf_Shdr *Sec) const {
return getSectionContentsAsArray<uint8_t>(Sec);
379}

381template <class ELFT>
382StringRef ELFFile<ELFT>::getRelocationTypeName(uint32_t Type) const {
return getELFRelocationTypeName(getHeader()->e_machine, Type);
384}

386template <class ELFT>
387void ELFFile<ELFT>::getRelocationTypeName(uint32_t Type,
                                        SmallVectorImpl<char> &Result) const {
if (!isMipsELF64()) {
  StringRef Name = getRelocationTypeName(Type);
  Result.append(Name.begin(), Name.end());
} else {
  // The Mips N64 ABI allows up to three operations to be specified per
  // relocation record. Unfortunately there's no easy way to test for the
  // presence of N64 ELFs as they have no special flag that identifies them
  // as being N64. We can safely assume at the moment that all Mips
  // ELFCLASS64 ELFs are N64. New Mips64 ABIs should provide enough
  // information to disambiguate between old vs new ABIs.
  uint8_t Type1 = (Type >> 0) & 0xFF;
  uint8_t Type2 = (Type >> 8) & 0xFF;
  uint8_t Type3 = (Type >> 16) & 0xFF;

  // Concat all three relocation type names.
  StringRef Name = getRelocationTypeName(Type1);
  Result.append(Name.begin(), Name.end());

  Name = getRelocationTypeName(Type2);
  Result.append(1, '/');
  Result.append(Name.begin(), Name.end());

  Name = getRelocationTypeName(Type3);
  Result.append(1, '/');
  Result.append(Name.begin(), Name.end());
}
415}

417template <class ELFT>
418uint32_t ELFFile<ELFT>::getRelrRelocationType() const {
return getELFRelrRelocationType(getHeader()->e_machine);
420}

422template <class ELFT>
423Expected<const typename ELFT::Sym *>
424ELFFile<ELFT>::getRelocationSymbol(const Elf_Rel *Rel,
                                 const Elf_Shdr *SymTab) const {
uint32_t Index = Rel->getSymbol(isMips64EL());
if (Index == 0)
  return nullptr;
return getEntry<Elf_Sym>(SymTab, Index);
430}

432template <class ELFT>
433Expected<StringRef>
434ELFFile<ELFT>::getSectionStringTable(Elf_Shdr_Range Sections) const {
uint32_t Index = getHeader()->e_shstrndx;
if (Index == ELF::SHN_XINDEX)
  Index = Sections[0].sh_link;

if (!Index) // no section string table.
  return "";
if (Index >= Sections.size())
  return createError("invalid section index");
return getStringTable(&Sections[Index]);
444}

446template <class ELFT> ELFFile<ELFT>::ELFFile(StringRef Object) : Buf(Object) {}

448template <class ELFT>
449Expected<ELFFile<ELFT>> ELFFile<ELFT>::create(StringRef Object) {
if (sizeof(Elf_Ehdr) > Object.size())
  return createError("Invalid buffer");
return ELFFile(Object);
453}

455template <class ELFT>
456Expected<typename ELFT::ShdrRange> ELFFile<ELFT>::sections() const {
const uintX_t SectionTableOffset = getHeader()->e_shoff;
if (SectionTableOffset == 0)
6
←
Assuming 'SectionTableOffset' is not equal to 0→
7
←
Taking false branch→
  return ArrayRef<Elf_Shdr>();

if (getHeader()->e_shentsize != sizeof(Elf_Shdr))
8
←
Assuming the condition is true→
9
←
Taking true branch→
  return createError(
10
←
Calling 'createError'→
      "invalid section header entry size (e_shentsize) in ELF header");

const uint64_t FileSize = Buf.size();

if (SectionTableOffset + sizeof(Elf_Shdr) > FileSize)
  return createError("section header table goes past the end of the file");

// Invalid address alignment of section headers
if (SectionTableOffset & (alignof(Elf_Shdr) - 1))
  return createError("invalid alignment of section headers");

const Elf_Shdr *First =
    reinterpret_cast<const Elf_Shdr *>(base() + SectionTableOffset);

uintX_t NumSections = getHeader()->e_shnum;
if (NumSections == 0)
  NumSections = First->sh_size;

if (NumSections > UINT64_MAX(18446744073709551615UL) / sizeof(Elf_Shdr))
  return createError("section table goes past the end of file");

const uint64_t SectionTableSize = NumSections * sizeof(Elf_Shdr);

// Section table goes past end of file!
if (SectionTableOffset + SectionTableSize > FileSize)
  return createError("section table goes past the end of file");

return makeArrayRef(First, NumSections);
491}

493template <class ELFT>
494template <typename T>
495Expected<const T *> ELFFile<ELFT>::getEntry(uint32_t Section,
                                          uint32_t Entry) const {
auto SecOrErr = getSection(Section);
4
←
Calling 'ELFFile::getSection'→
if (!SecOrErr)
  return SecOrErr.takeError();
return getEntry<T>(*SecOrErr, Entry);
501}

503template <class ELFT>
504template <typename T>
505Expected<const T *> ELFFile<ELFT>::getEntry(const Elf_Shdr *Section,
                                          uint32_t Entry) const {
if (sizeof(T) != Section->sh_entsize)
  return createError("invalid sh_entsize");
size_t Pos = Section->sh_offset + Entry * sizeof(T);
if (Pos + sizeof(T) > Buf.size())
  return createError("invalid section offset");
return reinterpret_cast<const T *>(base() + Pos);
513}

515template <class ELFT>
516Expected<const typename ELFT::Shdr *>
517ELFFile<ELFT>::getSection(uint32_t Index) const {
auto TableOrErr = sections();
5
←
Calling 'ELFFile::sections'→
if (!TableOrErr)
  return TableOrErr.takeError();
return object::getSection<ELFT>(*TableOrErr, Index);
522}

524template <class ELFT>
525Expected<const typename ELFT::Shdr *>
526ELFFile<ELFT>::getSection(const StringRef SectionName) const {
auto TableOrErr = sections();
if (!TableOrErr)
  return TableOrErr.takeError();
for (auto &Sec : *TableOrErr) {
  auto SecNameOrErr = getSectionName(&Sec);
  if (!SecNameOrErr)
    return SecNameOrErr.takeError();
  if (*SecNameOrErr == SectionName)
    return &Sec;
}
return createError("invalid section name");
538}

540template <class ELFT>
541Expected<StringRef>
542ELFFile<ELFT>::getStringTable(const Elf_Shdr *Section) const {
if (Section->sh_type != ELF::SHT_STRTAB)
  return createError("invalid sh_type for string table, expected SHT_STRTAB");
auto V = getSectionContentsAsArray<char>(Section);
if (!V)
  return V.takeError();
ArrayRef<char> Data = *V;
if (Data.empty())
  return createError("empty string table");
if (Data.back() != '\0')
  return createError("string table non-null terminated");
return StringRef(Data.begin(), Data.size());
554}

556template <class ELFT>
557Expected<ArrayRef<typename ELFT::Word>>
558ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section) const {
auto SectionsOrErr = sections();
if (!SectionsOrErr)
  return SectionsOrErr.takeError();
return getSHNDXTable(Section, *SectionsOrErr);
563}

565template <class ELFT>
566Expected<ArrayRef<typename ELFT::Word>>
567ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section,
                           Elf_Shdr_Range Sections) const {
assert(Section.sh_type == ELF::SHT_SYMTAB_SHNDX)((Section.sh_type == ELF::SHT_SYMTAB_SHNDX) ? static_cast<
void> (0) : __assert_fail ("Section.sh_type == ELF::SHT_SYMTAB_SHNDX"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELF.h"
, 569, __PRETTY_FUNCTION__));
auto VOrErr = getSectionContentsAsArray<Elf_Word>(&Section);
if (!VOrErr)
  return VOrErr.takeError();
ArrayRef<Elf_Word> V = *VOrErr;
auto SymTableOrErr = object::getSection<ELFT>(Sections, Section.sh_link);
if (!SymTableOrErr)
  return SymTableOrErr.takeError();
const Elf_Shdr &SymTable = **SymTableOrErr;
if (SymTable.sh_type != ELF::SHT_SYMTAB &&
    SymTable.sh_type != ELF::SHT_DYNSYM)
  return createError("invalid sh_type");
if (V.size() != (SymTable.sh_size / sizeof(Elf_Sym)))
  return createError("invalid section contents size");
return V;
584}

586template <class ELFT>
587Expected<StringRef>
588ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec) const {
auto SectionsOrErr = sections();
if (!SectionsOrErr)
  return SectionsOrErr.takeError();
return getStringTableForSymtab(Sec, *SectionsOrErr);
593}

595template <class ELFT>
596Expected<StringRef>
597ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec,
                                     Elf_Shdr_Range Sections) const {

if (Sec.sh_type != ELF::SHT_SYMTAB && Sec.sh_type != ELF::SHT_DYNSYM)
  return createError(
      "invalid sh_type for symbol table, expected SHT_SYMTAB or SHT_DYNSYM");
auto SectionOrErr = object::getSection<ELFT>(Sections, Sec.sh_link);
if (!SectionOrErr)
  return SectionOrErr.takeError();
return getStringTable(*SectionOrErr);
607}

609template <class ELFT>
610Expected<StringRef>
611ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section) const {
auto SectionsOrErr = sections();
if (!SectionsOrErr)
  return SectionsOrErr.takeError();
auto Table = getSectionStringTable(*SectionsOrErr);
if (!Table)
  return Table.takeError();
return getSectionName(Section, *Table);
619}

621template <class ELFT>
622Expected<StringRef> ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section,
                                                StringRef DotShstrtab) const {
uint32_t Offset = Section->sh_name;
if (Offset == 0)
  return StringRef();
if (Offset >= DotShstrtab.size())
  return createError("invalid string offset");
return StringRef(DotShstrtab.data() + Offset);
630}

632/// This function returns the hash value for a symbol in the .dynsym section
633/// Name of the API remains consistent as specified in the libelf
634/// REF : http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#hash
635inline unsigned hashSysV(StringRef SymbolName) {
unsigned h = 0, g;
for (char C : SymbolName) {
  h = (h << 4) + C;
  g = h & 0xf0000000L;
  if (g != 0)
    h ^= g >> 24;
  h &= ~g;
}
return h;
645}

647} // end namespace object
648} // end namespace llvm

650#endif // LLVM_OBJECT_ELF_H

←

/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);
16
←
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)...));
12
←
Calling 'make_unique<llvm::StringError, llvm::StringRef &, llvm::object::object_error>'→
14
←
Returned allocated memory→
15
←
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)...));
13
←
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