annotate lld/COFF/SymbolTable.h @ 173:0572611fdcc8 llvm10 llvm12

reorgnization done
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 11:55:54 +0900
parents 1d019706d866
children 5f17cb93ff66
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===- SymbolTable.h --------------------------------------------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #ifndef LLD_COFF_SYMBOL_TABLE_H
anatofuz
parents:
diff changeset
10 #define LLD_COFF_SYMBOL_TABLE_H
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 #include "InputFiles.h"
anatofuz
parents:
diff changeset
13 #include "LTO.h"
anatofuz
parents:
diff changeset
14 #include "llvm/ADT/CachedHashString.h"
anatofuz
parents:
diff changeset
15 #include "llvm/ADT/DenseMap.h"
anatofuz
parents:
diff changeset
16 #include "llvm/ADT/DenseMapInfo.h"
anatofuz
parents:
diff changeset
17 #include "llvm/Support/raw_ostream.h"
anatofuz
parents:
diff changeset
18
anatofuz
parents:
diff changeset
19 namespace llvm {
anatofuz
parents:
diff changeset
20 struct LTOCodeGenerator;
anatofuz
parents:
diff changeset
21 }
anatofuz
parents:
diff changeset
22
anatofuz
parents:
diff changeset
23 namespace lld {
anatofuz
parents:
diff changeset
24 namespace coff {
anatofuz
parents:
diff changeset
25
anatofuz
parents:
diff changeset
26 class Chunk;
anatofuz
parents:
diff changeset
27 class CommonChunk;
anatofuz
parents:
diff changeset
28 class Defined;
anatofuz
parents:
diff changeset
29 class DefinedAbsolute;
anatofuz
parents:
diff changeset
30 class DefinedRegular;
anatofuz
parents:
diff changeset
31 class DefinedRelative;
anatofuz
parents:
diff changeset
32 class LazyArchive;
anatofuz
parents:
diff changeset
33 class SectionChunk;
anatofuz
parents:
diff changeset
34 class Symbol;
anatofuz
parents:
diff changeset
35
anatofuz
parents:
diff changeset
36 // SymbolTable is a bucket of all known symbols, including defined,
anatofuz
parents:
diff changeset
37 // undefined, or lazy symbols (the last one is symbols in archive
anatofuz
parents:
diff changeset
38 // files whose archive members are not yet loaded).
anatofuz
parents:
diff changeset
39 //
anatofuz
parents:
diff changeset
40 // We put all symbols of all files to a SymbolTable, and the
anatofuz
parents:
diff changeset
41 // SymbolTable selects the "best" symbols if there are name
anatofuz
parents:
diff changeset
42 // conflicts. For example, obviously, a defined symbol is better than
anatofuz
parents:
diff changeset
43 // an undefined symbol. Or, if there's a conflict between a lazy and a
anatofuz
parents:
diff changeset
44 // undefined, it'll read an archive member to read a real definition
anatofuz
parents:
diff changeset
45 // to replace the lazy symbol. The logic is implemented in the
anatofuz
parents:
diff changeset
46 // add*() functions, which are called by input files as they are parsed.
anatofuz
parents:
diff changeset
47 // There is one add* function per symbol type.
anatofuz
parents:
diff changeset
48 class SymbolTable {
anatofuz
parents:
diff changeset
49 public:
anatofuz
parents:
diff changeset
50 void addFile(InputFile *file);
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 // Emit errors for symbols that cannot be resolved.
anatofuz
parents:
diff changeset
53 void reportUnresolvable();
anatofuz
parents:
diff changeset
54
anatofuz
parents:
diff changeset
55 // Try to resolve any undefined symbols and update the symbol table
anatofuz
parents:
diff changeset
56 // accordingly, then print an error message for any remaining undefined
anatofuz
parents:
diff changeset
57 // symbols and warn about imported local symbols.
anatofuz
parents:
diff changeset
58 void resolveRemainingUndefines();
anatofuz
parents:
diff changeset
59
anatofuz
parents:
diff changeset
60 void loadMinGWAutomaticImports();
anatofuz
parents:
diff changeset
61 bool handleMinGWAutomaticImport(Symbol *sym, StringRef name);
anatofuz
parents:
diff changeset
62
anatofuz
parents:
diff changeset
63 // Returns a list of chunks of selected symbols.
anatofuz
parents:
diff changeset
64 std::vector<Chunk *> getChunks();
anatofuz
parents:
diff changeset
65
anatofuz
parents:
diff changeset
66 // Returns a symbol for a given name. Returns a nullptr if not found.
anatofuz
parents:
diff changeset
67 Symbol *find(StringRef name);
anatofuz
parents:
diff changeset
68 Symbol *findUnderscore(StringRef name);
anatofuz
parents:
diff changeset
69
anatofuz
parents:
diff changeset
70 // Occasionally we have to resolve an undefined symbol to its
anatofuz
parents:
diff changeset
71 // mangled symbol. This function tries to find a mangled name
anatofuz
parents:
diff changeset
72 // for U from the symbol table, and if found, set the symbol as
anatofuz
parents:
diff changeset
73 // a weak alias for U.
anatofuz
parents:
diff changeset
74 Symbol *findMangle(StringRef name);
anatofuz
parents:
diff changeset
75
anatofuz
parents:
diff changeset
76 // Build a set of COFF objects representing the combined contents of
anatofuz
parents:
diff changeset
77 // BitcodeFiles and add them to the symbol table. Called after all files are
anatofuz
parents:
diff changeset
78 // added and before the writer writes results to a file.
anatofuz
parents:
diff changeset
79 void addCombinedLTOObjects();
anatofuz
parents:
diff changeset
80
anatofuz
parents:
diff changeset
81 // Creates an Undefined symbol for a given name.
anatofuz
parents:
diff changeset
82 Symbol *addUndefined(StringRef name);
anatofuz
parents:
diff changeset
83
anatofuz
parents:
diff changeset
84 Symbol *addSynthetic(StringRef n, Chunk *c);
anatofuz
parents:
diff changeset
85 Symbol *addAbsolute(StringRef n, uint64_t va);
anatofuz
parents:
diff changeset
86
anatofuz
parents:
diff changeset
87 Symbol *addUndefined(StringRef name, InputFile *f, bool isWeakAlias);
anatofuz
parents:
diff changeset
88 void addLazyArchive(ArchiveFile *f, const Archive::Symbol &sym);
anatofuz
parents:
diff changeset
89 void addLazyObject(LazyObjFile *f, StringRef n);
anatofuz
parents:
diff changeset
90 Symbol *addAbsolute(StringRef n, COFFSymbolRef s);
anatofuz
parents:
diff changeset
91 Symbol *addRegular(InputFile *f, StringRef n,
anatofuz
parents:
diff changeset
92 const llvm::object::coff_symbol_generic *s = nullptr,
anatofuz
parents:
diff changeset
93 SectionChunk *c = nullptr, uint32_t sectionOffset = 0);
anatofuz
parents:
diff changeset
94 std::pair<DefinedRegular *, bool>
anatofuz
parents:
diff changeset
95 addComdat(InputFile *f, StringRef n,
anatofuz
parents:
diff changeset
96 const llvm::object::coff_symbol_generic *s = nullptr);
anatofuz
parents:
diff changeset
97 Symbol *addCommon(InputFile *f, StringRef n, uint64_t size,
anatofuz
parents:
diff changeset
98 const llvm::object::coff_symbol_generic *s = nullptr,
anatofuz
parents:
diff changeset
99 CommonChunk *c = nullptr);
anatofuz
parents:
diff changeset
100 Symbol *addImportData(StringRef n, ImportFile *f);
anatofuz
parents:
diff changeset
101 Symbol *addImportThunk(StringRef name, DefinedImportData *s,
anatofuz
parents:
diff changeset
102 uint16_t machine);
anatofuz
parents:
diff changeset
103 void addLibcall(StringRef name);
anatofuz
parents:
diff changeset
104
anatofuz
parents:
diff changeset
105 void reportDuplicate(Symbol *existing, InputFile *newFile,
anatofuz
parents:
diff changeset
106 SectionChunk *newSc = nullptr,
anatofuz
parents:
diff changeset
107 uint32_t newSectionOffset = 0);
anatofuz
parents:
diff changeset
108
anatofuz
parents:
diff changeset
109 // A list of chunks which to be added to .rdata.
anatofuz
parents:
diff changeset
110 std::vector<Chunk *> localImportChunks;
anatofuz
parents:
diff changeset
111
anatofuz
parents:
diff changeset
112 // Iterates symbols in non-determinstic hash table order.
anatofuz
parents:
diff changeset
113 template <typename T> void forEachSymbol(T callback) {
anatofuz
parents:
diff changeset
114 for (auto &pair : symMap)
anatofuz
parents:
diff changeset
115 callback(pair.second);
anatofuz
parents:
diff changeset
116 }
anatofuz
parents:
diff changeset
117
anatofuz
parents:
diff changeset
118 private:
anatofuz
parents:
diff changeset
119 /// Given a name without "__imp_" prefix, returns a defined symbol
anatofuz
parents:
diff changeset
120 /// with the "__imp_" prefix, if it exists.
anatofuz
parents:
diff changeset
121 Defined *impSymbol(StringRef name);
anatofuz
parents:
diff changeset
122 /// Inserts symbol if not already present.
anatofuz
parents:
diff changeset
123 std::pair<Symbol *, bool> insert(StringRef name);
anatofuz
parents:
diff changeset
124 /// Same as insert(Name), but also sets isUsedInRegularObj.
anatofuz
parents:
diff changeset
125 std::pair<Symbol *, bool> insert(StringRef name, InputFile *f);
anatofuz
parents:
diff changeset
126
anatofuz
parents:
diff changeset
127 std::vector<Symbol *> getSymsWithPrefix(StringRef prefix);
anatofuz
parents:
diff changeset
128
anatofuz
parents:
diff changeset
129 llvm::DenseMap<llvm::CachedHashStringRef, Symbol *> symMap;
anatofuz
parents:
diff changeset
130 std::unique_ptr<BitcodeCompiler> lto;
anatofuz
parents:
diff changeset
131 };
anatofuz
parents:
diff changeset
132
anatofuz
parents:
diff changeset
133 extern SymbolTable *symtab;
anatofuz
parents:
diff changeset
134
anatofuz
parents:
diff changeset
135 std::vector<std::string> getSymbolLocations(ObjFile *file, uint32_t symIndex);
anatofuz
parents:
diff changeset
136
anatofuz
parents:
diff changeset
137 } // namespace coff
anatofuz
parents:
diff changeset
138 } // namespace lld
anatofuz
parents:
diff changeset
139
anatofuz
parents:
diff changeset
140 #endif