1f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot//===- IRSymtab.h - data definitions for IR symbol tables -------*- C++ -*-===// 2f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 3f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// The LLVM Compiler Infrastructure 4f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 5f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// This file is distributed under the University of Illinois Open Source 6f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// License. See LICENSE.TXT for details. 7f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 8f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot//===----------------------------------------------------------------------===// 9f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 10f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// This file contains data definitions and a reader and builder for a symbol 11f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// table for LLVM IR. Its purpose is to allow linkers and other consumers of 12f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// bitcode files to efficiently read the symbol table for symbol resolution 13f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// purposes without needing to construct a module in memory. 14f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 15f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// As with most object files the symbol table has two parts: the symbol table 16f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// itself and a string table which is referenced by the symbol table. 17f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 18f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// A symbol table corresponds to a single bitcode file, which may consist of 19f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// multiple modules, so symbol tables may likewise contain symbols for multiple 20f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// modules. 21f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 22f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot//===----------------------------------------------------------------------===// 23f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 24f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#ifndef LLVM_OBJECT_IRSYMTAB_H 25f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#define LLVM_OBJECT_IRSYMTAB_H 26f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 27f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/ADT/ArrayRef.h" 28f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/ADT/StringRef.h" 29f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/ADT/iterator_range.h" 30f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/IR/GlobalValue.h" 31f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/Object/SymbolicFile.h" 32f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/Support/Endian.h" 33f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include "llvm/Support/Error.h" 34f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include <cassert> 35f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include <cstdint> 36f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#include <vector> 37f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 38f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotnamespace llvm { 39f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 40f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct BitcodeFileContents; 41f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotclass StringTableBuilder; 42f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 43f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotnamespace irsymtab { 44f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 45f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotnamespace storage { 46f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 47f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// The data structures in this namespace define the low-level serialization 48f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// format. Clients that just want to read a symbol table should use the 49f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// irsymtab::Reader class. 50f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 51f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotusing Word = support::ulittle32_t; 52f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 53f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// A reference to a string in the string table. 54f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Str { 55f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word Offset, Size; 56f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 57f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef get(StringRef Strtab) const { 58f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return {Strtab.data() + Offset, Size}; 59f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 60f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 61f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 62f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// A reference to a range of objects in the symbol table. 63f3014761c955345d6e05491608e73228d014afbandroid-build-team Robottemplate <typename T> struct Range { 64f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word Offset, Size; 65f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 66f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ArrayRef<T> get(StringRef Symtab) const { 67f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return {reinterpret_cast<const T *>(Symtab.data() + Offset), Size}; 68f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 69f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 70f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 71f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Describes the range of a particular module's symbols within the symbol 72f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// table. 73f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Module { 74f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word Begin, End; 75f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 76f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The index of the first Uncommon for this Module. 77f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word UncBegin; 78f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 79f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 80f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// This is equivalent to an IR comdat. 81f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Comdat { 82f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str Name; 83f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 84f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 85f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Contains the information needed by linkers for symbol resolution, as well as 86f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// by the LTO implementation itself. 87f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Symbol { 88f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The mangled symbol name. 89f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str Name; 90f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 91f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The unmangled symbol name, or the empty string if this is not an IR 92f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// symbol. 93f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str IRName; 94f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 95f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The index into Header::Comdats, or -1 if not a comdat member. 96f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word ComdatIndex; 97f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 98f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word Flags; 99f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot enum FlagBits { 100f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_visibility, // 2 bits 101f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_has_uncommon = FB_visibility + 2, 102f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_undefined, 103f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_weak, 104f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_common, 105f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_indirect, 106f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_used, 107f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_tls, 108f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_may_omit, 109f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_global, 110f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_format_specific, 111f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_unnamed_addr, 112f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot FB_executable, 113f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot }; 114f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 115f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 116f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// This data structure contains rarely used symbol fields and is optionally 117f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// referenced by a Symbol. 118f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Uncommon { 119f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word CommonSize, CommonAlign; 120f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 121f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// COFF-specific: the name of the symbol that a weak external resolves to 122f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// if not defined. 123f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str COFFWeakExternFallbackName; 124f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 125f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Specified section name, if any. 126f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str SectionName; 127f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 128f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 129f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Header { 130f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Version number of the symtab format. This number should be incremented 131f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// when the format changes, but it does not need to be incremented if a 132f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// change to LLVM would cause it to create a different symbol table. 133f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Word Version; 134f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot enum { kCurrentVersion = 1 }; 135f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 136f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The producer's version string (LLVM_VERSION_STRING " " LLVM_REVISION). 137f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Consumers should rebuild the symbol table from IR if the producer's 138f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// version does not match the consumer's version due to potential differences 139f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// in symbol table format, symbol enumeration order and so on. 140f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str Producer; 141f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 142f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Range<Module> Modules; 143f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Range<Comdat> Comdats; 144f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Range<Symbol> Symbols; 145f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Range<Uncommon> Uncommons; 146f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 147f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str TargetTriple, SourceFileName; 148f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 149f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// COFF-specific: linker directives. 150f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Str COFFLinkerOpts; 151f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 152f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 153f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} // end namespace storage 154f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 155f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Fills in Symtab and StrtabBuilder with a valid symbol and string table for 156f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Mods. 157f3014761c955345d6e05491608e73228d014afbandroid-build-team RobotError build(ArrayRef<Module *> Mods, SmallVector<char, 0> &Symtab, 158f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringTableBuilder &StrtabBuilder, BumpPtrAllocator &Alloc); 159f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 160f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// This represents a symbol that has been read from a storage::Symbol and 161f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// possibly a storage::Uncommon. 162f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct Symbol { 163f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot // Copied from storage::Symbol. 164f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef Name, IRName; 165f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot int ComdatIndex; 166f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot uint32_t Flags; 167f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 168f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot // Copied from storage::Uncommon. 169f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot uint32_t CommonSize, CommonAlign; 170f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef COFFWeakExternFallbackName; 171f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef SectionName; 172f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 173f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns the mangled symbol name. 174f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getName() const { return Name; } 175f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 176f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns the unmangled symbol name, or the empty string if this is not an 177f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// IR symbol. 178f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getIRName() const { return IRName; } 179f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 180f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns the index into the comdat table (see Reader::getComdatTable()), or 181f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// -1 if not a comdat member. 182f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot int getComdatIndex() const { return ComdatIndex; } 183f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 184f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot using S = storage::Symbol; 185f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 186f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot GlobalValue::VisibilityTypes getVisibility() const { 187f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return GlobalValue::VisibilityTypes((Flags >> S::FB_visibility) & 3); 188f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 189f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 190f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isUndefined() const { return (Flags >> S::FB_undefined) & 1; } 191f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isWeak() const { return (Flags >> S::FB_weak) & 1; } 192f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isCommon() const { return (Flags >> S::FB_common) & 1; } 193f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isIndirect() const { return (Flags >> S::FB_indirect) & 1; } 194f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isUsed() const { return (Flags >> S::FB_used) & 1; } 195f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isTLS() const { return (Flags >> S::FB_tls) & 1; } 196f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 197f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool canBeOmittedFromSymbolTable() const { 198f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return (Flags >> S::FB_may_omit) & 1; 199f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 200f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 201f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isGlobal() const { return (Flags >> S::FB_global) & 1; } 202f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isFormatSpecific() const { return (Flags >> S::FB_format_specific) & 1; } 203f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isUnnamedAddr() const { return (Flags >> S::FB_unnamed_addr) & 1; } 204f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isExecutable() const { return (Flags >> S::FB_executable) & 1; } 205f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 206f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot uint64_t getCommonSize() const { 207f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot assert(isCommon()); 208f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return CommonSize; 209f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 210f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 211f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot uint32_t getCommonAlignment() const { 212f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot assert(isCommon()); 213f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return CommonAlign; 214f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 215f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 216f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// COFF-specific: for weak externals, returns the name of the symbol that is 217f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// used as a fallback if the weak external remains undefined. 218f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getCOFFWeakExternalFallback() const { 219f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot assert(isWeak() && isIndirect()); 220f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return COFFWeakExternFallbackName; 221f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 222f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 223f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getSectionName() const { return SectionName; } 224f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 225f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 226f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// This class can be used to read a Symtab and Strtab produced by 227f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// irsymtab::build. 228f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotclass Reader { 229f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef Symtab, Strtab; 230f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 231f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ArrayRef<storage::Module> Modules; 232f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ArrayRef<storage::Comdat> Comdats; 233f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ArrayRef<storage::Symbol> Symbols; 234f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ArrayRef<storage::Uncommon> Uncommons; 235f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 236f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef str(storage::Str S) const { return S.get(Strtab); } 237f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 238f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot template <typename T> ArrayRef<T> range(storage::Range<T> R) const { 239f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return R.get(Symtab); 240f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 241f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 242f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Header &header() const { 243f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return *reinterpret_cast<const storage::Header *>(Symtab.data()); 244f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 245f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 246f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotpublic: 247f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot class SymbolRef; 248f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 249f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Reader() = default; 250f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Reader(StringRef Symtab, StringRef Strtab) : Symtab(Symtab), Strtab(Strtab) { 251f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Modules = range(header().Modules); 252f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Comdats = range(header().Comdats); 253f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Symbols = range(header().Symbols); 254f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Uncommons = range(header().Uncommons); 255f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 256f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 257f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot using symbol_range = iterator_range<object::content_iterator<SymbolRef>>; 258f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 259f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns the symbol table for the entire bitcode file. 260f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The symbols enumerated by this method are ephemeral, but they can be 261f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// copied into an irsymtab::Symbol object. 262f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot symbol_range symbols() const; 263f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 264f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot size_t getNumModules() const { return Modules.size(); } 265f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 266f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns a slice of the symbol table for the I'th module in the file. 267f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// The symbols enumerated by this method are ephemeral, but they can be 268f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// copied into an irsymtab::Symbol object. 269f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot symbol_range module_symbols(unsigned I) const; 270f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 271f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getTargetTriple() const { return str(header().TargetTriple); } 272f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 273f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns the source file path specified at compile time. 274f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getSourceFileName() const { return str(header().SourceFileName); } 275f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 276f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Returns a table with all the comdats used by this file. 277f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot std::vector<StringRef> getComdatTable() const { 278f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot std::vector<StringRef> ComdatTable; 279f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ComdatTable.reserve(Comdats.size()); 280f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot for (auto C : Comdats) 281f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ComdatTable.push_back(str(C.Name)); 282f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return ComdatTable; 283f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 284f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 285f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// COFF-specific: returns linker options specified in the input file. 286f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot StringRef getCOFFLinkerOpts() const { return str(header().COFFLinkerOpts); } 287f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 288f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 289f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Ephemeral symbols produced by Reader::symbols() and 290f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Reader::module_symbols(). 291f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotclass Reader::SymbolRef : public Symbol { 292f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Symbol *SymI, *SymE; 293f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Uncommon *UncI; 294f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const Reader *R; 295f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 296f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot void read() { 297f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot if (SymI == SymE) 298f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return; 299f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 300f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Name = R->str(SymI->Name); 301f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot IRName = R->str(SymI->IRName); 302f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ComdatIndex = SymI->ComdatIndex; 303f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Flags = SymI->Flags; 304f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 305f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot if (Flags & (1 << storage::Symbol::FB_has_uncommon)) { 306f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot CommonSize = UncI->CommonSize; 307f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot CommonAlign = UncI->CommonAlign; 308f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot COFFWeakExternFallbackName = R->str(UncI->COFFWeakExternFallbackName); 309f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SectionName = R->str(UncI->SectionName); 310f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } else 311f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot // Reset this field so it can be queried unconditionally for all symbols. 312f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SectionName = ""; 313f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 314f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 315f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotpublic: 316f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SymbolRef(const storage::Symbol *SymI, const storage::Symbol *SymE, 317f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Uncommon *UncI, const Reader *R) 318f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot : SymI(SymI), SymE(SymE), UncI(UncI), R(R) { 319f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot read(); 320f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 321f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 322f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot void moveNext() { 323f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ++SymI; 324f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot if (Flags & (1 << storage::Symbol::FB_has_uncommon)) 325f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ++UncI; 326f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot read(); 327f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 328f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 329f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool operator==(const SymbolRef &Other) const { return SymI == Other.SymI; } 330f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 331f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 332f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotinline Reader::symbol_range Reader::symbols() const { 333f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return {SymbolRef(Symbols.begin(), Symbols.end(), Uncommons.begin(), this), 334f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SymbolRef(Symbols.end(), Symbols.end(), nullptr, this)}; 335f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} 336f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 337f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotinline Reader::symbol_range Reader::module_symbols(unsigned I) const { 338f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Module &M = Modules[I]; 339f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot const storage::Symbol *MBegin = Symbols.begin() + M.Begin, 340f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot *MEnd = Symbols.begin() + M.End; 341f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return {SymbolRef(MBegin, MEnd, Uncommons.begin() + M.UncBegin, this), 342f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SymbolRef(MEnd, MEnd, nullptr, this)}; 343f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} 344f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 345f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// The contents of the irsymtab in a bitcode file. Any underlying data for the 346f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// irsymtab are owned by Symtab and Strtab. 347f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotstruct FileContents { 348f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SmallVector<char, 0> Symtab, Strtab; 349f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Reader TheReader; 350f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 351f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 352f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// Reads the contents of a bitcode file, creating its irsymtab if necessary. 353f3014761c955345d6e05491608e73228d014afbandroid-build-team RobotExpected<FileContents> readBitcode(const BitcodeFileContents &BFC); 354f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 355f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} // end namespace irsymtab 356f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} // end namespace llvm 357f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 358f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#endif // LLVM_OBJECT_IRSYMTAB_H 359