xref: /llvm-project-15.0.7/lld/wasm/Driver.cpp (revision 954014a0)
1 //===- Driver.cpp ---------------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lld/Common/Driver.h"
10 #include "Config.h"
11 #include "InputChunks.h"
12 #include "InputGlobal.h"
13 #include "MarkLive.h"
14 #include "SymbolTable.h"
15 #include "Writer.h"
16 #include "lld/Common/Args.h"
17 #include "lld/Common/ErrorHandler.h"
18 #include "lld/Common/Memory.h"
19 #include "lld/Common/Reproduce.h"
20 #include "lld/Common/Strings.h"
21 #include "lld/Common/Threads.h"
22 #include "lld/Common/Version.h"
23 #include "llvm/ADT/Twine.h"
24 #include "llvm/Object/Wasm.h"
25 #include "llvm/Option/Arg.h"
26 #include "llvm/Option/ArgList.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/Process.h"
30 #include "llvm/Support/TarWriter.h"
31 #include "llvm/Support/TargetSelect.h"
32 
33 #define DEBUG_TYPE "lld"
34 
35 using namespace llvm;
36 using namespace llvm::object;
37 using namespace llvm::sys;
38 using namespace llvm::wasm;
39 
40 using namespace lld;
41 using namespace lld::wasm;
42 
43 Configuration *lld::wasm::Config;
44 
45 namespace {
46 
47 // Create enum with OPT_xxx values for each option in Options.td
48 enum {
49   OPT_INVALID = 0,
50 #define OPTION(_1, _2, ID, _4, _5, _6, _7, _8, _9, _10, _11, _12) OPT_##ID,
51 #include "Options.inc"
52 #undef OPTION
53 };
54 
55 // This function is called on startup. We need this for LTO since
56 // LTO calls LLVM functions to compile bitcode files to native code.
57 // Technically this can be delayed until we read bitcode files, but
58 // we don't bother to do lazily because the initialization is fast.
59 static void initLLVM() {
60   InitializeAllTargets();
61   InitializeAllTargetMCs();
62   InitializeAllAsmPrinters();
63   InitializeAllAsmParsers();
64 }
65 
66 class LinkerDriver {
67 public:
68   void link(ArrayRef<const char *> ArgsArr);
69 
70 private:
71   void createFiles(opt::InputArgList &Args);
72   void addFile(StringRef Path);
73   void addLibrary(StringRef Name);
74 
75   // True if we are in --whole-archive and --no-whole-archive.
76   bool InWholeArchive = false;
77 
78   std::vector<InputFile *> Files;
79 };
80 } // anonymous namespace
81 
82 bool lld::wasm::link(ArrayRef<const char *> Args, bool CanExitEarly,
83                      raw_ostream &Error) {
84   errorHandler().LogName = args::getFilenameWithoutExe(Args[0]);
85   errorHandler().ErrorOS = &Error;
86   errorHandler().ColorDiagnostics = Error.has_colors();
87   errorHandler().ErrorLimitExceededMsg =
88       "too many errors emitted, stopping now (use "
89       "-error-limit=0 to see all errors)";
90 
91   Config = make<Configuration>();
92   Symtab = make<SymbolTable>();
93 
94   initLLVM();
95   LinkerDriver().link(Args);
96 
97   // Exit immediately if we don't need to return to the caller.
98   // This saves time because the overhead of calling destructors
99   // for all globally-allocated objects is not negligible.
100   if (CanExitEarly)
101     exitLld(errorCount() ? 1 : 0);
102 
103   freeArena();
104   return !errorCount();
105 }
106 
107 // Create prefix string literals used in Options.td
108 #define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE;
109 #include "Options.inc"
110 #undef PREFIX
111 
112 // Create table mapping all options defined in Options.td
113 static const opt::OptTable::Info OptInfo[] = {
114 #define OPTION(X1, X2, ID, KIND, GROUP, ALIAS, X7, X8, X9, X10, X11, X12)      \
115   {X1, X2, X10,         X11,         OPT_##ID, opt::Option::KIND##Class,       \
116    X9, X8, OPT_##GROUP, OPT_##ALIAS, X7,       X12},
117 #include "Options.inc"
118 #undef OPTION
119 };
120 
121 namespace {
122 class WasmOptTable : public llvm::opt::OptTable {
123 public:
124   WasmOptTable() : OptTable(OptInfo) {}
125   opt::InputArgList parse(ArrayRef<const char *> Argv);
126 };
127 } // namespace
128 
129 // Set color diagnostics according to -color-diagnostics={auto,always,never}
130 // or -no-color-diagnostics flags.
131 static void handleColorDiagnostics(opt::InputArgList &Args) {
132   auto *Arg = Args.getLastArg(OPT_color_diagnostics, OPT_color_diagnostics_eq,
133                               OPT_no_color_diagnostics);
134   if (!Arg)
135     return;
136   if (Arg->getOption().getID() == OPT_color_diagnostics) {
137     errorHandler().ColorDiagnostics = true;
138   } else if (Arg->getOption().getID() == OPT_no_color_diagnostics) {
139     errorHandler().ColorDiagnostics = false;
140   } else {
141     StringRef S = Arg->getValue();
142     if (S == "always")
143       errorHandler().ColorDiagnostics = true;
144     else if (S == "never")
145       errorHandler().ColorDiagnostics = false;
146     else if (S != "auto")
147       error("unknown option: --color-diagnostics=" + S);
148   }
149 }
150 
151 // Find a file by concatenating given paths.
152 static Optional<std::string> findFile(StringRef Path1, const Twine &Path2) {
153   SmallString<128> S;
154   path::append(S, Path1, Path2);
155   if (fs::exists(S))
156     return S.str().str();
157   return None;
158 }
159 
160 opt::InputArgList WasmOptTable::parse(ArrayRef<const char *> Argv) {
161   SmallVector<const char *, 256> Vec(Argv.data(), Argv.data() + Argv.size());
162 
163   unsigned MissingIndex;
164   unsigned MissingCount;
165 
166   // Expand response files (arguments in the form of @<filename>)
167   cl::ExpandResponseFiles(Saver, cl::TokenizeGNUCommandLine, Vec);
168 
169   opt::InputArgList Args = this->ParseArgs(Vec, MissingIndex, MissingCount);
170 
171   handleColorDiagnostics(Args);
172   for (auto *Arg : Args.filtered(OPT_UNKNOWN))
173     error("unknown argument: " + Arg->getSpelling());
174   return Args;
175 }
176 
177 // Currently we allow a ".imports" to live alongside a library. This can
178 // be used to specify a list of symbols which can be undefined at link
179 // time (imported from the environment.  For example libc.a include an
180 // import file that lists the syscall functions it relies on at runtime.
181 // In the long run this information would be better stored as a symbol
182 // attribute/flag in the object file itself.
183 // See: https://github.com/WebAssembly/tool-conventions/issues/35
184 static void readImportFile(StringRef Filename) {
185   if (Optional<MemoryBufferRef> Buf = readFile(Filename))
186     for (StringRef Sym : args::getLines(*Buf))
187       Config->AllowUndefinedSymbols.insert(Sym);
188 }
189 
190 // Returns slices of MB by parsing MB as an archive file.
191 // Each slice consists of a member file in the archive.
192 std::vector<MemoryBufferRef> static getArchiveMembers(MemoryBufferRef MB) {
193   std::unique_ptr<Archive> File =
194       CHECK(Archive::create(MB),
195             MB.getBufferIdentifier() + ": failed to parse archive");
196 
197   std::vector<MemoryBufferRef> V;
198   Error Err = Error::success();
199   for (const ErrorOr<Archive::Child> &COrErr : File->children(Err)) {
200     Archive::Child C =
201         CHECK(COrErr, MB.getBufferIdentifier() +
202                           ": could not get the child of the archive");
203     MemoryBufferRef MBRef =
204         CHECK(C.getMemoryBufferRef(),
205               MB.getBufferIdentifier() +
206                   ": could not get the buffer for a child of the archive");
207     V.push_back(MBRef);
208   }
209   if (Err)
210     fatal(MB.getBufferIdentifier() +
211           ": Archive::children failed: " + toString(std::move(Err)));
212 
213   // Take ownership of memory buffers created for members of thin archives.
214   for (std::unique_ptr<MemoryBuffer> &MB : File->takeThinBuffers())
215     make<std::unique_ptr<MemoryBuffer>>(std::move(MB));
216 
217   return V;
218 }
219 
220 void LinkerDriver::addFile(StringRef Path) {
221   Optional<MemoryBufferRef> Buffer = readFile(Path);
222   if (!Buffer.hasValue())
223     return;
224   MemoryBufferRef MBRef = *Buffer;
225 
226   switch (identify_magic(MBRef.getBuffer())) {
227   case file_magic::archive: {
228     SmallString<128> ImportFile = Path;
229     path::replace_extension(ImportFile, ".imports");
230     if (fs::exists(ImportFile))
231       readImportFile(ImportFile.str());
232 
233     // Handle -whole-archive.
234     if (InWholeArchive) {
235       for (MemoryBufferRef &M : getArchiveMembers(MBRef))
236         Files.push_back(createObjectFile(M, Path));
237       return;
238     }
239 
240     std::unique_ptr<Archive> File =
241         CHECK(Archive::create(MBRef), Path + ": failed to parse archive");
242 
243     if (!File->isEmpty() && !File->hasSymbolTable()) {
244       error(MBRef.getBufferIdentifier() +
245             ": archive has no index; run ranlib to add one");
246     }
247 
248     Files.push_back(make<ArchiveFile>(MBRef));
249     return;
250   }
251   case file_magic::bitcode:
252   case file_magic::wasm_object:
253     Files.push_back(createObjectFile(MBRef));
254     break;
255   default:
256     error("unknown file type: " + MBRef.getBufferIdentifier());
257   }
258 }
259 
260 // Add a given library by searching it from input search paths.
261 void LinkerDriver::addLibrary(StringRef Name) {
262   for (StringRef Dir : Config->SearchPaths) {
263     if (Optional<std::string> S = findFile(Dir, "lib" + Name + ".a")) {
264       addFile(*S);
265       return;
266     }
267   }
268 
269   error("unable to find library -l" + Name);
270 }
271 
272 void LinkerDriver::createFiles(opt::InputArgList &Args) {
273   for (auto *Arg : Args) {
274     switch (Arg->getOption().getUnaliasedOption().getID()) {
275     case OPT_l:
276       addLibrary(Arg->getValue());
277       break;
278     case OPT_INPUT:
279       addFile(Arg->getValue());
280       break;
281     case OPT_whole_archive:
282       InWholeArchive = true;
283       break;
284     case OPT_no_whole_archive:
285       InWholeArchive = false;
286       break;
287     }
288   }
289 }
290 
291 static StringRef getEntry(opt::InputArgList &Args) {
292   auto *Arg = Args.getLastArg(OPT_entry, OPT_no_entry);
293   if (!Arg) {
294     if (Args.hasArg(OPT_relocatable))
295       return "";
296     if (Args.hasArg(OPT_shared))
297       return "__wasm_call_ctors";
298     return "_start";
299   }
300   if (Arg->getOption().getID() == OPT_no_entry)
301     return "";
302   return Arg->getValue();
303 }
304 
305 // Initializes Config members by the command line options.
306 static void readConfigs(opt::InputArgList &Args) {
307   Config->AllowUndefined = Args.hasArg(OPT_allow_undefined);
308   Config->CheckFeatures =
309       Args.hasFlag(OPT_check_features, OPT_no_check_features, true);
310   Config->CompressRelocations = Args.hasArg(OPT_compress_relocations);
311   Config->Demangle = Args.hasFlag(OPT_demangle, OPT_no_demangle, true);
312   Config->DisableVerify = Args.hasArg(OPT_disable_verify);
313   Config->EmitRelocs = Args.hasArg(OPT_emit_relocs);
314   Config->Entry = getEntry(Args);
315   Config->ExportAll = Args.hasArg(OPT_export_all);
316   Config->ExportDynamic = Args.hasFlag(OPT_export_dynamic,
317       OPT_no_export_dynamic, false);
318   Config->ExportTable = Args.hasArg(OPT_export_table);
319   errorHandler().FatalWarnings =
320       Args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false);
321   Config->ImportMemory = Args.hasArg(OPT_import_memory);
322   Config->SharedMemory = Args.hasArg(OPT_shared_memory);
323   Config->ImportTable = Args.hasArg(OPT_import_table);
324   Config->LTOO = args::getInteger(Args, OPT_lto_O, 2);
325   Config->LTOPartitions = args::getInteger(Args, OPT_lto_partitions, 1);
326   Config->Optimize = args::getInteger(Args, OPT_O, 0);
327   Config->OutputFile = Args.getLastArgValue(OPT_o);
328   Config->Relocatable = Args.hasArg(OPT_relocatable);
329   Config->GcSections =
330       Args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, !Config->Relocatable);
331   Config->MergeDataSegments =
332       Args.hasFlag(OPT_merge_data_segments, OPT_no_merge_data_segments,
333                    !Config->Relocatable);
334   Config->Pie = Args.hasFlag(OPT_pie, OPT_no_pie, false);
335   Config->PrintGcSections =
336       Args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false);
337   Config->SaveTemps = Args.hasArg(OPT_save_temps);
338   Config->SearchPaths = args::getStrings(Args, OPT_L);
339   Config->Shared = Args.hasArg(OPT_shared);
340   Config->StripAll = Args.hasArg(OPT_strip_all);
341   Config->StripDebug = Args.hasArg(OPT_strip_debug);
342   Config->StackFirst = Args.hasArg(OPT_stack_first);
343   Config->Trace = Args.hasArg(OPT_trace);
344   Config->ThinLTOCacheDir = Args.getLastArgValue(OPT_thinlto_cache_dir);
345   Config->ThinLTOCachePolicy = CHECK(
346       parseCachePruningPolicy(Args.getLastArgValue(OPT_thinlto_cache_policy)),
347       "--thinlto-cache-policy: invalid cache policy");
348   Config->ThinLTOJobs = args::getInteger(Args, OPT_thinlto_jobs, -1u);
349   errorHandler().Verbose = Args.hasArg(OPT_verbose);
350   LLVM_DEBUG(errorHandler().Verbose = true);
351   ThreadsEnabled = Args.hasFlag(OPT_threads, OPT_no_threads, true);
352 
353   Config->InitialMemory = args::getInteger(Args, OPT_initial_memory, 0);
354   Config->GlobalBase = args::getInteger(Args, OPT_global_base, 1024);
355   Config->MaxMemory = args::getInteger(Args, OPT_max_memory, 0);
356   Config->ZStackSize =
357       args::getZOptionValue(Args, OPT_z, "stack-size", WasmPageSize);
358 
359   if (auto *Arg = Args.getLastArg(OPT_features)) {
360     Config->Features =
361         llvm::Optional<std::vector<std::string>>(std::vector<std::string>());
362     for (StringRef S : Arg->getValues())
363       Config->Features->push_back(S);
364   }
365 }
366 
367 // Some Config members do not directly correspond to any particular
368 // command line options, but computed based on other Config values.
369 // This function initialize such members. See Config.h for the details
370 // of these values.
371 static void setConfigs() {
372   Config->Pic = Config->Pie || Config->Shared;
373 
374   if (Config->Pic) {
375     if (Config->ExportTable)
376       error("-shared/-pie is incompatible with --export-table");
377     Config->ImportTable = true;
378   }
379 
380   if (Config->Shared) {
381     Config->ImportMemory = true;
382     Config->ExportDynamic = true;
383     Config->AllowUndefined = true;
384   }
385 }
386 
387 // Some command line options or some combinations of them are not allowed.
388 // This function checks for such errors.
389 static void checkOptions(opt::InputArgList &Args) {
390   if (!Config->StripDebug && !Config->StripAll && Config->CompressRelocations)
391     error("--compress-relocations is incompatible with output debug"
392           " information. Please pass --strip-debug or --strip-all");
393 
394   if (Config->LTOO > 3)
395     error("invalid optimization level for LTO: " + Twine(Config->LTOO));
396   if (Config->LTOPartitions == 0)
397     error("--lto-partitions: number of threads must be > 0");
398   if (Config->ThinLTOJobs == 0)
399     error("--thinlto-jobs: number of threads must be > 0");
400 
401   if (Config->Pie && Config->Shared)
402     error("-shared and -pie may not be used together");
403 
404   if (Config->OutputFile.empty())
405     error("no output file specified");
406 
407   if (Config->ImportTable && Config->ExportTable)
408     error("--import-table and --export-table may not be used together");
409 
410   if (Config->Relocatable) {
411     if (!Config->Entry.empty())
412       error("entry point specified for relocatable output file");
413     if (Config->GcSections)
414       error("-r and --gc-sections may not be used together");
415     if (Config->CompressRelocations)
416       error("-r -and --compress-relocations may not be used together");
417     if (Args.hasArg(OPT_undefined))
418       error("-r -and --undefined may not be used together");
419     if (Config->Pie)
420       error("-r and -pie may not be used together");
421   }
422 }
423 
424 // Force Sym to be entered in the output. Used for -u or equivalent.
425 static Symbol *handleUndefined(StringRef Name) {
426   Symbol *Sym = Symtab->find(Name);
427   if (!Sym)
428     return nullptr;
429 
430   // Since symbol S may not be used inside the program, LTO may
431   // eliminate it. Mark the symbol as "used" to prevent it.
432   Sym->IsUsedInRegularObj = true;
433 
434   if (auto *LazySym = dyn_cast<LazySymbol>(Sym))
435     LazySym->fetch();
436 
437   return Sym;
438 }
439 
440 static UndefinedGlobal *
441 createUndefinedGlobal(StringRef Name, llvm::wasm::WasmGlobalType *Type) {
442   auto *Sym =
443       cast<UndefinedGlobal>(Symtab->addUndefinedGlobal(Name, Name,
444                                                        DefaultModule, 0,
445                                                        nullptr, Type));
446   Config->AllowUndefinedSymbols.insert(Sym->getName());
447   Sym->IsUsedInRegularObj = true;
448   return Sym;
449 }
450 
451 // Create ABI-defined synthetic symbols
452 static void createSyntheticSymbols() {
453   static WasmSignature NullSignature = {{}, {}};
454   static llvm::wasm::WasmGlobalType GlobalTypeI32 = {WASM_TYPE_I32, false};
455   static llvm::wasm::WasmGlobalType MutableGlobalTypeI32 = {WASM_TYPE_I32,
456                                                             true};
457 
458   if (!Config->Relocatable) {
459     WasmSym::CallCtors = Symtab->addSyntheticFunction(
460         "__wasm_call_ctors", WASM_SYMBOL_VISIBILITY_HIDDEN,
461         make<SyntheticFunction>(NullSignature, "__wasm_call_ctors"));
462 
463     if (Config->Pic) {
464       // For PIC code we create a synthetic function call __wasm_apply_relocs
465       // and add this as the first call in __wasm_call_ctors.
466       // We also unconditionally export
467       WasmSym::ApplyRelocs = Symtab->addSyntheticFunction(
468           "__wasm_apply_relocs", WASM_SYMBOL_VISIBILITY_HIDDEN,
469           make<SyntheticFunction>(NullSignature, "__wasm_apply_relocs"));
470     }
471   }
472 
473   // The __stack_pointer is imported in the shared library case, and exported
474   // in the non-shared (executable) case.
475   if (Config->Shared) {
476     WasmSym::StackPointer =
477         createUndefinedGlobal("__stack_pointer", &MutableGlobalTypeI32);
478   } else {
479     llvm::wasm::WasmGlobal Global;
480     Global.Type = {WASM_TYPE_I32, true};
481     Global.InitExpr.Value.Int32 = 0;
482     Global.InitExpr.Opcode = WASM_OPCODE_I32_CONST;
483     Global.SymbolName = "__stack_pointer";
484     auto *StackPointer = make<InputGlobal>(Global, nullptr);
485     StackPointer->Live = true;
486     // For non-PIC code
487     // TODO(sbc): Remove WASM_SYMBOL_VISIBILITY_HIDDEN when the mutable global
488     // spec proposal is implemented in all major browsers.
489     // See: https://github.com/WebAssembly/mutable-global
490     WasmSym::StackPointer = Symtab->addSyntheticGlobal(
491         "__stack_pointer", WASM_SYMBOL_VISIBILITY_HIDDEN, StackPointer);
492     WasmSym::DataEnd = Symtab->addOptionalDataSymbol("__data_end");
493     WasmSym::GlobalBase = Symtab->addOptionalDataSymbol("__global_base");
494     WasmSym::HeapBase = Symtab->addOptionalDataSymbol("__heap_base");
495   }
496 
497   if (Config->Pic) {
498     // For PIC code, we import two global variables (__memory_base and
499     // __table_base) from the environment and use these as the offset at
500     // which to load our static data and function table.
501     // See:
502     // https://github.com/WebAssembly/tool-conventions/blob/master/DynamicLinking.md
503     WasmSym::MemoryBase =
504         createUndefinedGlobal("__memory_base", &GlobalTypeI32);
505     WasmSym::TableBase = createUndefinedGlobal("__table_base", &GlobalTypeI32);
506     WasmSym::MemoryBase->markLive();
507     WasmSym::TableBase->markLive();
508   }
509 
510   WasmSym::DsoHandle = Symtab->addSyntheticDataSymbol(
511       "__dso_handle", WASM_SYMBOL_VISIBILITY_HIDDEN);
512 }
513 
514 // Reconstructs command line arguments so that so that you can re-run
515 // the same command with the same inputs. This is for --reproduce.
516 static std::string createResponseFile(const opt::InputArgList &Args) {
517   SmallString<0> Data;
518   raw_svector_ostream OS(Data);
519 
520   // Copy the command line to the output while rewriting paths.
521   for (auto *Arg : Args) {
522     switch (Arg->getOption().getUnaliasedOption().getID()) {
523     case OPT_reproduce:
524       break;
525     case OPT_INPUT:
526       OS << quote(relativeToRoot(Arg->getValue())) << "\n";
527       break;
528     case OPT_o:
529       // If -o path contains directories, "lld @response.txt" will likely
530       // fail because the archive we are creating doesn't contain empty
531       // directories for the output path (-o doesn't create directories).
532       // Strip directories to prevent the issue.
533       OS << "-o " << quote(sys::path::filename(Arg->getValue())) << "\n";
534       break;
535     default:
536       OS << toString(*Arg) << "\n";
537     }
538   }
539   return Data.str();
540 }
541 
542 // The --wrap option is a feature to rename symbols so that you can write
543 // wrappers for existing functions. If you pass `-wrap=foo`, all
544 // occurrences of symbol `foo` are resolved to `wrap_foo` (so, you are
545 // expected to write `wrap_foo` function as a wrapper). The original
546 // symbol becomes accessible as `real_foo`, so you can call that from your
547 // wrapper.
548 //
549 // This data structure is instantiated for each -wrap option.
550 struct WrappedSymbol {
551   Symbol *Sym;
552   Symbol *Real;
553   Symbol *Wrap;
554 };
555 
556 static Symbol *addUndefined(StringRef Name) {
557   return Symtab->addUndefinedFunction(Name, "", "", 0, nullptr, nullptr, false);
558 }
559 
560 // Handles -wrap option.
561 //
562 // This function instantiates wrapper symbols. At this point, they seem
563 // like they are not being used at all, so we explicitly set some flags so
564 // that LTO won't eliminate them.
565 static std::vector<WrappedSymbol> addWrappedSymbols(opt::InputArgList &Args) {
566   std::vector<WrappedSymbol> V;
567   DenseSet<StringRef> Seen;
568 
569   for (auto *Arg : Args.filtered(OPT_wrap)) {
570     StringRef Name = Arg->getValue();
571     if (!Seen.insert(Name).second)
572       continue;
573 
574     Symbol *Sym = Symtab->find(Name);
575     if (!Sym)
576       continue;
577 
578     Symbol *Real = addUndefined(Saver.save("__real_" + Name));
579     Symbol *Wrap = addUndefined(Saver.save("__wrap_" + Name));
580     V.push_back({Sym, Real, Wrap});
581 
582     // We want to tell LTO not to inline symbols to be overwritten
583     // because LTO doesn't know the final symbol contents after renaming.
584     Real->CanInline = false;
585     Sym->CanInline = false;
586 
587     // Tell LTO not to eliminate these symbols.
588     Sym->IsUsedInRegularObj = true;
589     Wrap->IsUsedInRegularObj = true;
590     Real->IsUsedInRegularObj = false;
591   }
592   return V;
593 }
594 
595 // Do renaming for -wrap by updating pointers to symbols.
596 //
597 // When this function is executed, only InputFiles and symbol table
598 // contain pointers to symbol objects. We visit them to replace pointers,
599 // so that wrapped symbols are swapped as instructed by the command line.
600 static void wrapSymbols(ArrayRef<WrappedSymbol> Wrapped) {
601   DenseMap<Symbol *, Symbol *> Map;
602   for (const WrappedSymbol &W : Wrapped) {
603     Map[W.Sym] = W.Wrap;
604     Map[W.Real] = W.Sym;
605   }
606 
607   // Update pointers in input files.
608   parallelForEach(Symtab->ObjectFiles, [&](InputFile *File) {
609     MutableArrayRef<Symbol *> Syms = File->getMutableSymbols();
610     for (size_t I = 0, E = Syms.size(); I != E; ++I)
611       if (Symbol *S = Map.lookup(Syms[I]))
612         Syms[I] = S;
613   });
614 
615   // Update pointers in the symbol table.
616   for (const WrappedSymbol &W : Wrapped)
617     Symtab->wrap(W.Sym, W.Real, W.Wrap);
618 }
619 
620 void LinkerDriver::link(ArrayRef<const char *> ArgsArr) {
621   WasmOptTable Parser;
622   opt::InputArgList Args = Parser.parse(ArgsArr.slice(1));
623 
624   // Handle --help
625   if (Args.hasArg(OPT_help)) {
626     Parser.PrintHelp(outs(),
627                      (std::string(ArgsArr[0]) + " [options] file...").c_str(),
628                      "LLVM Linker", false);
629     return;
630   }
631 
632   // Handle --version
633   if (Args.hasArg(OPT_version) || Args.hasArg(OPT_v)) {
634     outs() << getLLDVersion() << "\n";
635     return;
636   }
637 
638   // Handle --reproduce
639   if (auto *Arg = Args.getLastArg(OPT_reproduce)) {
640     StringRef Path = Arg->getValue();
641     Expected<std::unique_ptr<TarWriter>> ErrOrWriter =
642         TarWriter::create(Path, path::stem(Path));
643     if (ErrOrWriter) {
644       Tar = std::move(*ErrOrWriter);
645       Tar->append("response.txt", createResponseFile(Args));
646       Tar->append("version.txt", getLLDVersion() + "\n");
647     } else {
648       error("--reproduce: " + toString(ErrOrWriter.takeError()));
649     }
650   }
651 
652   // Parse and evaluate -mllvm options.
653   std::vector<const char *> V;
654   V.push_back("wasm-ld (LLVM option parsing)");
655   for (auto *Arg : Args.filtered(OPT_mllvm))
656     V.push_back(Arg->getValue());
657   cl::ParseCommandLineOptions(V.size(), V.data());
658 
659   errorHandler().ErrorLimit = args::getInteger(Args, OPT_error_limit, 20);
660 
661   readConfigs(Args);
662   setConfigs();
663   checkOptions(Args);
664 
665   if (auto *Arg = Args.getLastArg(OPT_allow_undefined_file))
666     readImportFile(Arg->getValue());
667 
668   if (!Args.hasArg(OPT_INPUT)) {
669     error("no input files");
670     return;
671   }
672 
673   // Handle --trace-symbol.
674   for (auto *Arg : Args.filtered(OPT_trace_symbol))
675     Symtab->trace(Arg->getValue());
676 
677   for (auto *Arg : Args.filtered(OPT_export))
678     Config->ExportedSymbols.insert(Arg->getValue());
679 
680   if (!Config->Relocatable)
681     createSyntheticSymbols();
682 
683   createFiles(Args);
684   if (errorCount())
685     return;
686 
687   // Add all files to the symbol table. This will add almost all
688   // symbols that we need to the symbol table.
689   for (InputFile *F : Files)
690     Symtab->addFile(F);
691   if (errorCount())
692     return;
693 
694   // Handle the `--undefined <sym>` options.
695   for (auto *Arg : Args.filtered(OPT_undefined))
696     handleUndefined(Arg->getValue());
697 
698   // Handle the `--export <sym>` options
699   // This works like --undefined but also exports the symbol if its found
700   for (auto *Arg : Args.filtered(OPT_export))
701     handleUndefined(Arg->getValue());
702 
703   Symbol *EntrySym = nullptr;
704   if (!Config->Relocatable && !Config->Entry.empty()) {
705     EntrySym = handleUndefined(Config->Entry);
706     if (EntrySym && EntrySym->isDefined())
707       EntrySym->ForceExport = true;
708     else
709       error("entry symbol not defined (pass --no-entry to supress): " +
710             Config->Entry);
711   }
712 
713   if (errorCount())
714     return;
715 
716   // Create wrapped symbols for -wrap option.
717   std::vector<WrappedSymbol> Wrapped = addWrappedSymbols(Args);
718 
719   // Do link-time optimization if given files are LLVM bitcode files.
720   // This compiles bitcode files into real object files.
721   Symtab->addCombinedLTOObject();
722   if (errorCount())
723     return;
724 
725   // Resolve any variant symbols that were created due to signature
726   // mismatchs.
727   Symtab->handleSymbolVariants();
728   if (errorCount())
729     return;
730 
731   // Apply symbol renames for -wrap.
732   if (!Wrapped.empty())
733     wrapSymbols(Wrapped);
734 
735   for (auto *Arg : Args.filtered(OPT_export)) {
736     Symbol *Sym = Symtab->find(Arg->getValue());
737     if (Sym && Sym->isDefined())
738       Sym->ForceExport = true;
739     else if (!Config->AllowUndefined)
740       error(Twine("symbol exported via --export not found: ") +
741             Arg->getValue());
742   }
743 
744   if (!Config->Relocatable) {
745     // Add synthetic dummies for weak undefined functions.  Must happen
746     // after LTO otherwise functions may not yet have signatures.
747     Symtab->handleWeakUndefines();
748   }
749 
750   if (EntrySym)
751     EntrySym->setHidden(false);
752 
753   if (errorCount())
754     return;
755 
756   // Do size optimizations: garbage collection
757   markLive();
758 
759   // Write the result to the file.
760   writeResult();
761 }
762