annotate lld/ELF/MapFile.cpp @ 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 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===- MapFile.cpp --------------------------------------------------------===//
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 // This file implements the -Map option. It shows lists in order and
anatofuz
parents:
diff changeset
10 // hierarchically the output sections, input sections, input files and
anatofuz
parents:
diff changeset
11 // symbol:
anatofuz
parents:
diff changeset
12 //
anatofuz
parents:
diff changeset
13 // Address Size Align Out In Symbol
anatofuz
parents:
diff changeset
14 // 00201000 00000015 4 .text
anatofuz
parents:
diff changeset
15 // 00201000 0000000e 4 test.o:(.text)
anatofuz
parents:
diff changeset
16 // 0020100e 00000000 0 local
anatofuz
parents:
diff changeset
17 // 00201005 00000000 0 f(int)
anatofuz
parents:
diff changeset
18 //
anatofuz
parents:
diff changeset
19 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
20
anatofuz
parents:
diff changeset
21 #include "MapFile.h"
anatofuz
parents:
diff changeset
22 #include "InputFiles.h"
anatofuz
parents:
diff changeset
23 #include "LinkerScript.h"
anatofuz
parents:
diff changeset
24 #include "OutputSections.h"
anatofuz
parents:
diff changeset
25 #include "SymbolTable.h"
anatofuz
parents:
diff changeset
26 #include "Symbols.h"
anatofuz
parents:
diff changeset
27 #include "SyntheticSections.h"
anatofuz
parents:
diff changeset
28 #include "lld/Common/Strings.h"
anatofuz
parents:
diff changeset
29 #include "llvm/ADT/MapVector.h"
anatofuz
parents:
diff changeset
30 #include "llvm/ADT/SetVector.h"
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
31 #include "llvm/Support/Parallel.h"
150
anatofuz
parents:
diff changeset
32 #include "llvm/Support/raw_ostream.h"
anatofuz
parents:
diff changeset
33
anatofuz
parents:
diff changeset
34 using namespace llvm;
anatofuz
parents:
diff changeset
35 using namespace llvm::object;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
36 using namespace lld;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
37 using namespace lld::elf;
150
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 using SymbolMapTy = DenseMap<const SectionBase *, SmallVector<Defined *, 4>>;
anatofuz
parents:
diff changeset
40
anatofuz
parents:
diff changeset
41 static constexpr char indent8[] = " "; // 8 spaces
anatofuz
parents:
diff changeset
42 static constexpr char indent16[] = " "; // 16 spaces
anatofuz
parents:
diff changeset
43
anatofuz
parents:
diff changeset
44 // Print out the first three columns of a line.
anatofuz
parents:
diff changeset
45 static void writeHeader(raw_ostream &os, uint64_t vma, uint64_t lma,
anatofuz
parents:
diff changeset
46 uint64_t size, uint64_t align) {
anatofuz
parents:
diff changeset
47 if (config->is64)
anatofuz
parents:
diff changeset
48 os << format("%16llx %16llx %8llx %5lld ", vma, lma, size, align);
anatofuz
parents:
diff changeset
49 else
anatofuz
parents:
diff changeset
50 os << format("%8llx %8llx %8llx %5lld ", vma, lma, size, align);
anatofuz
parents:
diff changeset
51 }
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 // Returns a list of all symbols that we want to print out.
anatofuz
parents:
diff changeset
54 static std::vector<Defined *> getSymbols() {
anatofuz
parents:
diff changeset
55 std::vector<Defined *> v;
anatofuz
parents:
diff changeset
56 for (InputFile *file : objectFiles)
anatofuz
parents:
diff changeset
57 for (Symbol *b : file->getSymbols())
anatofuz
parents:
diff changeset
58 if (auto *dr = dyn_cast<Defined>(b))
anatofuz
parents:
diff changeset
59 if (!dr->isSection() && dr->section && dr->section->isLive() &&
anatofuz
parents:
diff changeset
60 (dr->file == file || dr->needsPltAddr || dr->section->bss))
anatofuz
parents:
diff changeset
61 v.push_back(dr);
anatofuz
parents:
diff changeset
62 return v;
anatofuz
parents:
diff changeset
63 }
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 // Returns a map from sections to their symbols.
anatofuz
parents:
diff changeset
66 static SymbolMapTy getSectionSyms(ArrayRef<Defined *> syms) {
anatofuz
parents:
diff changeset
67 SymbolMapTy ret;
anatofuz
parents:
diff changeset
68 for (Defined *dr : syms)
anatofuz
parents:
diff changeset
69 ret[dr->section].push_back(dr);
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 // Sort symbols by address. We want to print out symbols in the
anatofuz
parents:
diff changeset
72 // order in the output file rather than the order they appeared
anatofuz
parents:
diff changeset
73 // in the input files.
anatofuz
parents:
diff changeset
74 for (auto &it : ret)
anatofuz
parents:
diff changeset
75 llvm::stable_sort(it.second, [](Defined *a, Defined *b) {
anatofuz
parents:
diff changeset
76 return a->getVA() < b->getVA();
anatofuz
parents:
diff changeset
77 });
anatofuz
parents:
diff changeset
78 return ret;
anatofuz
parents:
diff changeset
79 }
anatofuz
parents:
diff changeset
80
anatofuz
parents:
diff changeset
81 // Construct a map from symbols to their stringified representations.
anatofuz
parents:
diff changeset
82 // Demangling symbols (which is what toString() does) is slow, so
anatofuz
parents:
diff changeset
83 // we do that in batch using parallel-for.
anatofuz
parents:
diff changeset
84 static DenseMap<Symbol *, std::string>
anatofuz
parents:
diff changeset
85 getSymbolStrings(ArrayRef<Defined *> syms) {
anatofuz
parents:
diff changeset
86 std::vector<std::string> str(syms.size());
anatofuz
parents:
diff changeset
87 parallelForEachN(0, syms.size(), [&](size_t i) {
anatofuz
parents:
diff changeset
88 raw_string_ostream os(str[i]);
anatofuz
parents:
diff changeset
89 OutputSection *osec = syms[i]->getOutputSection();
anatofuz
parents:
diff changeset
90 uint64_t vma = syms[i]->getVA();
anatofuz
parents:
diff changeset
91 uint64_t lma = osec ? osec->getLMA() + vma - osec->getVA(0) : 0;
anatofuz
parents:
diff changeset
92 writeHeader(os, vma, lma, syms[i]->getSize(), 1);
anatofuz
parents:
diff changeset
93 os << indent16 << toString(*syms[i]);
anatofuz
parents:
diff changeset
94 });
anatofuz
parents:
diff changeset
95
anatofuz
parents:
diff changeset
96 DenseMap<Symbol *, std::string> ret;
anatofuz
parents:
diff changeset
97 for (size_t i = 0, e = syms.size(); i < e; ++i)
anatofuz
parents:
diff changeset
98 ret[syms[i]] = std::move(str[i]);
anatofuz
parents:
diff changeset
99 return ret;
anatofuz
parents:
diff changeset
100 }
anatofuz
parents:
diff changeset
101
anatofuz
parents:
diff changeset
102 // Print .eh_frame contents. Since the section consists of EhSectionPieces,
anatofuz
parents:
diff changeset
103 // we need a specialized printer for that section.
anatofuz
parents:
diff changeset
104 //
anatofuz
parents:
diff changeset
105 // .eh_frame tend to contain a lot of section pieces that are contiguous
anatofuz
parents:
diff changeset
106 // both in input file and output file. Such pieces are squashed before
anatofuz
parents:
diff changeset
107 // being displayed to make output compact.
anatofuz
parents:
diff changeset
108 static void printEhFrame(raw_ostream &os, const EhFrameSection *sec) {
anatofuz
parents:
diff changeset
109 std::vector<EhSectionPiece> pieces;
anatofuz
parents:
diff changeset
110
anatofuz
parents:
diff changeset
111 auto add = [&](const EhSectionPiece &p) {
anatofuz
parents:
diff changeset
112 // If P is adjacent to Last, squash the two.
anatofuz
parents:
diff changeset
113 if (!pieces.empty()) {
anatofuz
parents:
diff changeset
114 EhSectionPiece &last = pieces.back();
anatofuz
parents:
diff changeset
115 if (last.sec == p.sec && last.inputOff + last.size == p.inputOff &&
anatofuz
parents:
diff changeset
116 last.outputOff + last.size == p.outputOff) {
anatofuz
parents:
diff changeset
117 last.size += p.size;
anatofuz
parents:
diff changeset
118 return;
anatofuz
parents:
diff changeset
119 }
anatofuz
parents:
diff changeset
120 }
anatofuz
parents:
diff changeset
121 pieces.push_back(p);
anatofuz
parents:
diff changeset
122 };
anatofuz
parents:
diff changeset
123
anatofuz
parents:
diff changeset
124 // Gather section pieces.
anatofuz
parents:
diff changeset
125 for (const CieRecord *rec : sec->getCieRecords()) {
anatofuz
parents:
diff changeset
126 add(*rec->cie);
anatofuz
parents:
diff changeset
127 for (const EhSectionPiece *fde : rec->fdes)
anatofuz
parents:
diff changeset
128 add(*fde);
anatofuz
parents:
diff changeset
129 }
anatofuz
parents:
diff changeset
130
anatofuz
parents:
diff changeset
131 // Print out section pieces.
anatofuz
parents:
diff changeset
132 const OutputSection *osec = sec->getOutputSection();
anatofuz
parents:
diff changeset
133 for (EhSectionPiece &p : pieces) {
anatofuz
parents:
diff changeset
134 writeHeader(os, osec->addr + p.outputOff, osec->getLMA() + p.outputOff,
anatofuz
parents:
diff changeset
135 p.size, 1);
anatofuz
parents:
diff changeset
136 os << indent8 << toString(p.sec->file) << ":(" << p.sec->name << "+0x"
anatofuz
parents:
diff changeset
137 << Twine::utohexstr(p.inputOff) + ")\n";
anatofuz
parents:
diff changeset
138 }
anatofuz
parents:
diff changeset
139 }
anatofuz
parents:
diff changeset
140
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
141 void elf::writeMapFile() {
150
anatofuz
parents:
diff changeset
142 if (config->mapFile.empty())
anatofuz
parents:
diff changeset
143 return;
anatofuz
parents:
diff changeset
144
anatofuz
parents:
diff changeset
145 // Open a map file for writing.
anatofuz
parents:
diff changeset
146 std::error_code ec;
anatofuz
parents:
diff changeset
147 raw_fd_ostream os(config->mapFile, ec, sys::fs::OF_None);
anatofuz
parents:
diff changeset
148 if (ec) {
anatofuz
parents:
diff changeset
149 error("cannot open " + config->mapFile + ": " + ec.message());
anatofuz
parents:
diff changeset
150 return;
anatofuz
parents:
diff changeset
151 }
anatofuz
parents:
diff changeset
152
anatofuz
parents:
diff changeset
153 // Collect symbol info that we want to print out.
anatofuz
parents:
diff changeset
154 std::vector<Defined *> syms = getSymbols();
anatofuz
parents:
diff changeset
155 SymbolMapTy sectionSyms = getSectionSyms(syms);
anatofuz
parents:
diff changeset
156 DenseMap<Symbol *, std::string> symStr = getSymbolStrings(syms);
anatofuz
parents:
diff changeset
157
anatofuz
parents:
diff changeset
158 // Print out the header line.
anatofuz
parents:
diff changeset
159 int w = config->is64 ? 16 : 8;
anatofuz
parents:
diff changeset
160 os << right_justify("VMA", w) << ' ' << right_justify("LMA", w)
anatofuz
parents:
diff changeset
161 << " Size Align Out In Symbol\n";
anatofuz
parents:
diff changeset
162
anatofuz
parents:
diff changeset
163 OutputSection* osec = nullptr;
anatofuz
parents:
diff changeset
164 for (BaseCommand *base : script->sectionCommands) {
anatofuz
parents:
diff changeset
165 if (auto *cmd = dyn_cast<SymbolAssignment>(base)) {
anatofuz
parents:
diff changeset
166 if (cmd->provide && !cmd->sym)
anatofuz
parents:
diff changeset
167 continue;
anatofuz
parents:
diff changeset
168 uint64_t lma = osec ? osec->getLMA() + cmd->addr - osec->getVA(0) : 0;
anatofuz
parents:
diff changeset
169 writeHeader(os, cmd->addr, lma, cmd->size, 1);
anatofuz
parents:
diff changeset
170 os << cmd->commandString << '\n';
anatofuz
parents:
diff changeset
171 continue;
anatofuz
parents:
diff changeset
172 }
anatofuz
parents:
diff changeset
173
anatofuz
parents:
diff changeset
174 osec = cast<OutputSection>(base);
anatofuz
parents:
diff changeset
175 writeHeader(os, osec->addr, osec->getLMA(), osec->size, osec->alignment);
anatofuz
parents:
diff changeset
176 os << osec->name << '\n';
anatofuz
parents:
diff changeset
177
anatofuz
parents:
diff changeset
178 // Dump symbols for each input section.
anatofuz
parents:
diff changeset
179 for (BaseCommand *base : osec->sectionCommands) {
anatofuz
parents:
diff changeset
180 if (auto *isd = dyn_cast<InputSectionDescription>(base)) {
anatofuz
parents:
diff changeset
181 for (InputSection *isec : isd->sections) {
anatofuz
parents:
diff changeset
182 if (auto *ehSec = dyn_cast<EhFrameSection>(isec)) {
anatofuz
parents:
diff changeset
183 printEhFrame(os, ehSec);
anatofuz
parents:
diff changeset
184 continue;
anatofuz
parents:
diff changeset
185 }
anatofuz
parents:
diff changeset
186
anatofuz
parents:
diff changeset
187 writeHeader(os, isec->getVA(0), osec->getLMA() + isec->getOffset(0),
anatofuz
parents:
diff changeset
188 isec->getSize(), isec->alignment);
anatofuz
parents:
diff changeset
189 os << indent8 << toString(isec) << '\n';
anatofuz
parents:
diff changeset
190 for (Symbol *sym : sectionSyms[isec])
anatofuz
parents:
diff changeset
191 os << symStr[sym] << '\n';
anatofuz
parents:
diff changeset
192 }
anatofuz
parents:
diff changeset
193 continue;
anatofuz
parents:
diff changeset
194 }
anatofuz
parents:
diff changeset
195
anatofuz
parents:
diff changeset
196 if (auto *cmd = dyn_cast<ByteCommand>(base)) {
anatofuz
parents:
diff changeset
197 writeHeader(os, osec->addr + cmd->offset, osec->getLMA() + cmd->offset,
anatofuz
parents:
diff changeset
198 cmd->size, 1);
anatofuz
parents:
diff changeset
199 os << indent8 << cmd->commandString << '\n';
anatofuz
parents:
diff changeset
200 continue;
anatofuz
parents:
diff changeset
201 }
anatofuz
parents:
diff changeset
202
anatofuz
parents:
diff changeset
203 if (auto *cmd = dyn_cast<SymbolAssignment>(base)) {
anatofuz
parents:
diff changeset
204 if (cmd->provide && !cmd->sym)
anatofuz
parents:
diff changeset
205 continue;
anatofuz
parents:
diff changeset
206 writeHeader(os, cmd->addr, osec->getLMA() + cmd->addr - osec->getVA(0),
anatofuz
parents:
diff changeset
207 cmd->size, 1);
anatofuz
parents:
diff changeset
208 os << indent8 << cmd->commandString << '\n';
anatofuz
parents:
diff changeset
209 continue;
anatofuz
parents:
diff changeset
210 }
anatofuz
parents:
diff changeset
211 }
anatofuz
parents:
diff changeset
212 }
anatofuz
parents:
diff changeset
213 }
anatofuz
parents:
diff changeset
214
anatofuz
parents:
diff changeset
215 static void print(StringRef a, StringRef b) {
anatofuz
parents:
diff changeset
216 lld::outs() << left_justify(a, 49) << " " << b << "\n";
anatofuz
parents:
diff changeset
217 }
anatofuz
parents:
diff changeset
218
anatofuz
parents:
diff changeset
219 // Output a cross reference table to stdout. This is for --cref.
anatofuz
parents:
diff changeset
220 //
anatofuz
parents:
diff changeset
221 // For each global symbol, we print out a file that defines the symbol
anatofuz
parents:
diff changeset
222 // followed by files that uses that symbol. Here is an example.
anatofuz
parents:
diff changeset
223 //
anatofuz
parents:
diff changeset
224 // strlen /lib/x86_64-linux-gnu/libc.so.6
anatofuz
parents:
diff changeset
225 // tools/lld/tools/lld/CMakeFiles/lld.dir/lld.cpp.o
anatofuz
parents:
diff changeset
226 // lib/libLLVMSupport.a(PrettyStackTrace.cpp.o)
anatofuz
parents:
diff changeset
227 //
anatofuz
parents:
diff changeset
228 // In this case, strlen is defined by libc.so.6 and used by other two
anatofuz
parents:
diff changeset
229 // files.
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
230 void elf::writeCrossReferenceTable() {
150
anatofuz
parents:
diff changeset
231 if (!config->cref)
anatofuz
parents:
diff changeset
232 return;
anatofuz
parents:
diff changeset
233
anatofuz
parents:
diff changeset
234 // Collect symbols and files.
anatofuz
parents:
diff changeset
235 MapVector<Symbol *, SetVector<InputFile *>> map;
anatofuz
parents:
diff changeset
236 for (InputFile *file : objectFiles) {
anatofuz
parents:
diff changeset
237 for (Symbol *sym : file->getSymbols()) {
anatofuz
parents:
diff changeset
238 if (isa<SharedSymbol>(sym))
anatofuz
parents:
diff changeset
239 map[sym].insert(file);
anatofuz
parents:
diff changeset
240 if (auto *d = dyn_cast<Defined>(sym))
anatofuz
parents:
diff changeset
241 if (!d->isLocal() && (!d->section || d->section->isLive()))
anatofuz
parents:
diff changeset
242 map[d].insert(file);
anatofuz
parents:
diff changeset
243 }
anatofuz
parents:
diff changeset
244 }
anatofuz
parents:
diff changeset
245
anatofuz
parents:
diff changeset
246 // Print out a header.
anatofuz
parents:
diff changeset
247 lld::outs() << "Cross Reference Table\n\n";
anatofuz
parents:
diff changeset
248 print("Symbol", "File");
anatofuz
parents:
diff changeset
249
anatofuz
parents:
diff changeset
250 // Print out a table.
anatofuz
parents:
diff changeset
251 for (auto kv : map) {
anatofuz
parents:
diff changeset
252 Symbol *sym = kv.first;
anatofuz
parents:
diff changeset
253 SetVector<InputFile *> &files = kv.second;
anatofuz
parents:
diff changeset
254
anatofuz
parents:
diff changeset
255 print(toString(*sym), toString(sym->file));
anatofuz
parents:
diff changeset
256 for (InputFile *file : files)
anatofuz
parents:
diff changeset
257 if (file != sym->file)
anatofuz
parents:
diff changeset
258 print("", toString(file));
anatofuz
parents:
diff changeset
259 }
anatofuz
parents:
diff changeset
260 }
anatofuz
parents:
diff changeset
261
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
262 void elf::writeArchiveStats() {
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
263 if (config->printArchiveStats.empty())
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
264 return;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
265
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
266 std::error_code ec;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
267 raw_fd_ostream os(config->printArchiveStats, ec, sys::fs::OF_None);
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
268 if (ec) {
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
269 error("--print-archive-stats=: cannot open " + config->printArchiveStats +
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
270 ": " + ec.message());
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
271 return;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
272 }
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
273
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
274 os << "members\tfetched\tarchive\n";
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
275 for (const ArchiveFile *f : archiveFiles)
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
276 os << f->getMemberCount() << '\t' << f->getFetchedMemberCount() << '\t'
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
277 << f->getName() << '\n';
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
278 }