xref: /llvm-project-15.0.7/lld/wasm/Driver.cpp (revision fe5eaab2)
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     // Handle -whole-archive.
229     if (InWholeArchive) {
230       for (MemoryBufferRef &M : getArchiveMembers(MBRef))
231         Files.push_back(createObjectFile(M, Path));
232       return;
233     }
234 
235     SmallString<128> ImportFile = Path;
236     path::replace_extension(ImportFile, ".imports");
237     if (fs::exists(ImportFile))
238       readImportFile(ImportFile.str());
239 
240     Files.push_back(make<ArchiveFile>(MBRef));
241     return;
242   }
243   case file_magic::bitcode:
244   case file_magic::wasm_object:
245     Files.push_back(createObjectFile(MBRef));
246     break;
247   default:
248     error("unknown file type: " + MBRef.getBufferIdentifier());
249   }
250 }
251 
252 // Add a given library by searching it from input search paths.
253 void LinkerDriver::addLibrary(StringRef Name) {
254   for (StringRef Dir : Config->SearchPaths) {
255     if (Optional<std::string> S = findFile(Dir, "lib" + Name + ".a")) {
256       addFile(*S);
257       return;
258     }
259   }
260 
261   error("unable to find library -l" + Name);
262 }
263 
264 void LinkerDriver::createFiles(opt::InputArgList &Args) {
265   for (auto *Arg : Args) {
266     switch (Arg->getOption().getUnaliasedOption().getID()) {
267     case OPT_l:
268       addLibrary(Arg->getValue());
269       break;
270     case OPT_INPUT:
271       addFile(Arg->getValue());
272       break;
273     case OPT_whole_archive:
274       InWholeArchive = true;
275       break;
276     case OPT_no_whole_archive:
277       InWholeArchive = false;
278       break;
279     }
280   }
281 }
282 
283 static StringRef getEntry(opt::InputArgList &Args) {
284   auto *Arg = Args.getLastArg(OPT_entry, OPT_no_entry);
285   if (!Arg) {
286     if (Args.hasArg(OPT_relocatable))
287       return "";
288     if (Args.hasArg(OPT_shared))
289       return "__wasm_call_ctors";
290     return "_start";
291   }
292   if (Arg->getOption().getID() == OPT_no_entry)
293     return "";
294   return Arg->getValue();
295 }
296 
297 // Initializes Config members by the command line options.
298 static void readConfigs(opt::InputArgList &Args) {
299   Config->AllowUndefined = Args.hasArg(OPT_allow_undefined);
300   Config->CheckFeatures =
301       Args.hasFlag(OPT_check_features, OPT_no_check_features, true);
302   Config->CompressRelocations = Args.hasArg(OPT_compress_relocations);
303   Config->Demangle = Args.hasFlag(OPT_demangle, OPT_no_demangle, true);
304   Config->DisableVerify = Args.hasArg(OPT_disable_verify);
305   Config->EmitRelocs = Args.hasArg(OPT_emit_relocs);
306   Config->Entry = getEntry(Args);
307   Config->ExportAll = Args.hasArg(OPT_export_all);
308   Config->ExportDynamic = Args.hasFlag(OPT_export_dynamic,
309       OPT_no_export_dynamic, false);
310   Config->ExportTable = Args.hasArg(OPT_export_table);
311   errorHandler().FatalWarnings =
312       Args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false);
313   Config->ImportMemory = Args.hasArg(OPT_import_memory);
314   Config->SharedMemory = Args.hasArg(OPT_shared_memory);
315   Config->ImportTable = Args.hasArg(OPT_import_table);
316   Config->LTOO = args::getInteger(Args, OPT_lto_O, 2);
317   Config->LTOPartitions = args::getInteger(Args, OPT_lto_partitions, 1);
318   Config->Optimize = args::getInteger(Args, OPT_O, 0);
319   Config->OutputFile = Args.getLastArgValue(OPT_o);
320   Config->Relocatable = Args.hasArg(OPT_relocatable);
321   Config->GcSections =
322       Args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, !Config->Relocatable);
323   Config->MergeDataSegments =
324       Args.hasFlag(OPT_merge_data_segments, OPT_no_merge_data_segments,
325                    !Config->Relocatable);
326   Config->Pie = Args.hasFlag(OPT_pie, OPT_no_pie, false);
327   Config->PrintGcSections =
328       Args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false);
329   Config->SaveTemps = Args.hasArg(OPT_save_temps);
330   Config->SearchPaths = args::getStrings(Args, OPT_L);
331   Config->Shared = Args.hasArg(OPT_shared);
332   Config->StripAll = Args.hasArg(OPT_strip_all);
333   Config->StripDebug = Args.hasArg(OPT_strip_debug);
334   Config->StackFirst = Args.hasArg(OPT_stack_first);
335   Config->Trace = Args.hasArg(OPT_trace);
336   Config->ThinLTOCacheDir = Args.getLastArgValue(OPT_thinlto_cache_dir);
337   Config->ThinLTOCachePolicy = CHECK(
338       parseCachePruningPolicy(Args.getLastArgValue(OPT_thinlto_cache_policy)),
339       "--thinlto-cache-policy: invalid cache policy");
340   Config->ThinLTOJobs = args::getInteger(Args, OPT_thinlto_jobs, -1u);
341   errorHandler().Verbose = Args.hasArg(OPT_verbose);
342   LLVM_DEBUG(errorHandler().Verbose = true);
343   ThreadsEnabled = Args.hasFlag(OPT_threads, OPT_no_threads, true);
344 
345   Config->InitialMemory = args::getInteger(Args, OPT_initial_memory, 0);
346   Config->GlobalBase = args::getInteger(Args, OPT_global_base, 1024);
347   Config->MaxMemory = args::getInteger(Args, OPT_max_memory, 0);
348   Config->ZStackSize =
349       args::getZOptionValue(Args, OPT_z, "stack-size", WasmPageSize);
350 
351   if (auto *Arg = Args.getLastArg(OPT_features)) {
352     Config->Features =
353         llvm::Optional<std::vector<std::string>>(std::vector<std::string>());
354     for (StringRef S : Arg->getValues())
355       Config->Features->push_back(S);
356   }
357 }
358 
359 // Some Config members do not directly correspond to any particular
360 // command line options, but computed based on other Config values.
361 // This function initialize such members. See Config.h for the details
362 // of these values.
363 static void setConfigs() {
364   Config->Pic = Config->Pie || Config->Shared;
365 
366   if (Config->Pic) {
367     if (Config->ExportTable)
368       error("-shared/-pie is incompatible with --export-table");
369     Config->ImportTable = true;
370   }
371 
372   if (Config->Shared) {
373     Config->ImportMemory = true;
374     Config->ExportDynamic = true;
375     Config->AllowUndefined = true;
376   }
377 }
378 
379 // Some command line options or some combinations of them are not allowed.
380 // This function checks for such errors.
381 static void checkOptions(opt::InputArgList &Args) {
382   if (!Config->StripDebug && !Config->StripAll && Config->CompressRelocations)
383     error("--compress-relocations is incompatible with output debug"
384           " information. Please pass --strip-debug or --strip-all");
385 
386   if (Config->LTOO > 3)
387     error("invalid optimization level for LTO: " + Twine(Config->LTOO));
388   if (Config->LTOPartitions == 0)
389     error("--lto-partitions: number of threads must be > 0");
390   if (Config->ThinLTOJobs == 0)
391     error("--thinlto-jobs: number of threads must be > 0");
392 
393   if (Config->Pie && Config->Shared)
394     error("-shared and -pie may not be used together");
395 
396   if (Config->OutputFile.empty())
397     error("no output file specified");
398 
399   if (Config->ImportTable && Config->ExportTable)
400     error("--import-table and --export-table may not be used together");
401 
402   if (Config->Relocatable) {
403     if (!Config->Entry.empty())
404       error("entry point specified for relocatable output file");
405     if (Config->GcSections)
406       error("-r and --gc-sections may not be used together");
407     if (Config->CompressRelocations)
408       error("-r -and --compress-relocations may not be used together");
409     if (Args.hasArg(OPT_undefined))
410       error("-r -and --undefined may not be used together");
411     if (Config->Pie)
412       error("-r and -pie may not be used together");
413   }
414 }
415 
416 // Force Sym to be entered in the output. Used for -u or equivalent.
417 static Symbol *handleUndefined(StringRef Name) {
418   Symbol *Sym = Symtab->find(Name);
419   if (!Sym)
420     return nullptr;
421 
422   // Since symbol S may not be used inside the program, LTO may
423   // eliminate it. Mark the symbol as "used" to prevent it.
424   Sym->IsUsedInRegularObj = true;
425 
426   if (auto *LazySym = dyn_cast<LazySymbol>(Sym))
427     LazySym->fetch();
428 
429   return Sym;
430 }
431 
432 static UndefinedGlobal *
433 createUndefinedGlobal(StringRef Name, llvm::wasm::WasmGlobalType *Type) {
434   auto *Sym =
435       cast<UndefinedGlobal>(Symtab->addUndefinedGlobal(Name, Name,
436                                                        DefaultModule, 0,
437                                                        nullptr, Type));
438   Config->AllowUndefinedSymbols.insert(Sym->getName());
439   Sym->IsUsedInRegularObj = true;
440   return Sym;
441 }
442 
443 // Create ABI-defined synthetic symbols
444 static void createSyntheticSymbols() {
445   static WasmSignature NullSignature = {{}, {}};
446   static llvm::wasm::WasmGlobalType GlobalTypeI32 = {WASM_TYPE_I32, false};
447   static llvm::wasm::WasmGlobalType MutableGlobalTypeI32 = {WASM_TYPE_I32,
448                                                             true};
449 
450   if (!Config->Relocatable) {
451     WasmSym::CallCtors = Symtab->addSyntheticFunction(
452         "__wasm_call_ctors", WASM_SYMBOL_VISIBILITY_HIDDEN,
453         make<SyntheticFunction>(NullSignature, "__wasm_call_ctors"));
454 
455     if (Config->Pic) {
456       // For PIC code we create a synthetic function call __wasm_apply_relocs
457       // and add this as the first call in __wasm_call_ctors.
458       // We also unconditionally export
459       WasmSym::ApplyRelocs = Symtab->addSyntheticFunction(
460           "__wasm_apply_relocs", WASM_SYMBOL_VISIBILITY_HIDDEN,
461           make<SyntheticFunction>(NullSignature, "__wasm_apply_relocs"));
462     }
463   }
464 
465   // The __stack_pointer is imported in the shared library case, and exported
466   // in the non-shared (executable) case.
467   if (Config->Shared) {
468     WasmSym::StackPointer =
469         createUndefinedGlobal("__stack_pointer", &MutableGlobalTypeI32);
470   } else {
471     llvm::wasm::WasmGlobal Global;
472     Global.Type = {WASM_TYPE_I32, true};
473     Global.InitExpr.Value.Int32 = 0;
474     Global.InitExpr.Opcode = WASM_OPCODE_I32_CONST;
475     Global.SymbolName = "__stack_pointer";
476     auto *StackPointer = make<InputGlobal>(Global, nullptr);
477     StackPointer->Live = true;
478     // For non-PIC code
479     // TODO(sbc): Remove WASM_SYMBOL_VISIBILITY_HIDDEN when the mutable global
480     // spec proposal is implemented in all major browsers.
481     // See: https://github.com/WebAssembly/mutable-global
482     WasmSym::StackPointer = Symtab->addSyntheticGlobal(
483         "__stack_pointer", WASM_SYMBOL_VISIBILITY_HIDDEN, StackPointer);
484     WasmSym::HeapBase = Symtab->addSyntheticDataSymbol("__heap_base", 0);
485     WasmSym::DataEnd = Symtab->addSyntheticDataSymbol("__data_end", 0);
486 
487     // These two synthetic symbols exist purely for the embedder so we always
488     // want to export them.
489     WasmSym::HeapBase->ForceExport = true;
490     WasmSym::DataEnd->ForceExport = true;
491   }
492 
493   if (Config->Pic) {
494     // For PIC code, we import two global variables (__memory_base and
495     // __table_base) from the environment and use these as the offset at
496     // which to load our static data and function table.
497     // See:
498     // https://github.com/WebAssembly/tool-conventions/blob/master/DynamicLinking.md
499     WasmSym::MemoryBase =
500         createUndefinedGlobal("__memory_base", &GlobalTypeI32);
501     WasmSym::TableBase = createUndefinedGlobal("__table_base", &GlobalTypeI32);
502     WasmSym::MemoryBase->markLive();
503     WasmSym::TableBase->markLive();
504   }
505 
506   WasmSym::DsoHandle = Symtab->addSyntheticDataSymbol(
507       "__dso_handle", WASM_SYMBOL_VISIBILITY_HIDDEN);
508 }
509 
510 // Reconstructs command line arguments so that so that you can re-run
511 // the same command with the same inputs. This is for --reproduce.
512 static std::string createResponseFile(const opt::InputArgList &Args) {
513   SmallString<0> Data;
514   raw_svector_ostream OS(Data);
515 
516   // Copy the command line to the output while rewriting paths.
517   for (auto *Arg : Args) {
518     switch (Arg->getOption().getUnaliasedOption().getID()) {
519     case OPT_reproduce:
520       break;
521     case OPT_INPUT:
522       OS << quote(relativeToRoot(Arg->getValue())) << "\n";
523       break;
524     case OPT_o:
525       // If -o path contains directories, "lld @response.txt" will likely
526       // fail because the archive we are creating doesn't contain empty
527       // directories for the output path (-o doesn't create directories).
528       // Strip directories to prevent the issue.
529       OS << "-o " << quote(sys::path::filename(Arg->getValue())) << "\n";
530       break;
531     default:
532       OS << toString(*Arg) << "\n";
533     }
534   }
535   return Data.str();
536 }
537 
538 // The --wrap option is a feature to rename symbols so that you can write
539 // wrappers for existing functions. If you pass `-wrap=foo`, all
540 // occurrences of symbol `foo` are resolved to `wrap_foo` (so, you are
541 // expected to write `wrap_foo` function as a wrapper). The original
542 // symbol becomes accessible as `real_foo`, so you can call that from your
543 // wrapper.
544 //
545 // This data structure is instantiated for each -wrap option.
546 struct WrappedSymbol {
547   Symbol *Sym;
548   Symbol *Real;
549   Symbol *Wrap;
550 };
551 
552 static Symbol *addUndefined(StringRef Name) {
553   return Symtab->addUndefinedFunction(Name, "", "", 0, nullptr, nullptr, false);
554 }
555 
556 // Handles -wrap option.
557 //
558 // This function instantiates wrapper symbols. At this point, they seem
559 // like they are not being used at all, so we explicitly set some flags so
560 // that LTO won't eliminate them.
561 static std::vector<WrappedSymbol> addWrappedSymbols(opt::InputArgList &Args) {
562   std::vector<WrappedSymbol> V;
563   DenseSet<StringRef> Seen;
564 
565   for (auto *Arg : Args.filtered(OPT_wrap)) {
566     StringRef Name = Arg->getValue();
567     if (!Seen.insert(Name).second)
568       continue;
569 
570     Symbol *Sym = Symtab->find(Name);
571     if (!Sym)
572       continue;
573 
574     Symbol *Real = addUndefined(Saver.save("__real_" + Name));
575     Symbol *Wrap = addUndefined(Saver.save("__wrap_" + Name));
576     V.push_back({Sym, Real, Wrap});
577 
578     // We want to tell LTO not to inline symbols to be overwritten
579     // because LTO doesn't know the final symbol contents after renaming.
580     Real->CanInline = false;
581     Sym->CanInline = false;
582 
583     // Tell LTO not to eliminate these symbols.
584     Sym->IsUsedInRegularObj = true;
585     Wrap->IsUsedInRegularObj = true;
586     Real->IsUsedInRegularObj = false;
587   }
588   return V;
589 }
590 
591 // Do renaming for -wrap by updating pointers to symbols.
592 //
593 // When this function is executed, only InputFiles and symbol table
594 // contain pointers to symbol objects. We visit them to replace pointers,
595 // so that wrapped symbols are swapped as instructed by the command line.
596 static void wrapSymbols(ArrayRef<WrappedSymbol> Wrapped) {
597   DenseMap<Symbol *, Symbol *> Map;
598   for (const WrappedSymbol &W : Wrapped) {
599     Map[W.Sym] = W.Wrap;
600     Map[W.Real] = W.Sym;
601   }
602 
603   // Update pointers in input files.
604   parallelForEach(Symtab->ObjectFiles, [&](InputFile *File) {
605     MutableArrayRef<Symbol *> Syms = File->getMutableSymbols();
606     for (size_t I = 0, E = Syms.size(); I != E; ++I)
607       if (Symbol *S = Map.lookup(Syms[I]))
608         Syms[I] = S;
609   });
610 
611   // Update pointers in the symbol table.
612   for (const WrappedSymbol &W : Wrapped)
613     Symtab->wrap(W.Sym, W.Real, W.Wrap);
614 }
615 
616 void LinkerDriver::link(ArrayRef<const char *> ArgsArr) {
617   WasmOptTable Parser;
618   opt::InputArgList Args = Parser.parse(ArgsArr.slice(1));
619 
620   // Handle --help
621   if (Args.hasArg(OPT_help)) {
622     Parser.PrintHelp(outs(),
623                      (std::string(ArgsArr[0]) + " [options] file...").c_str(),
624                      "LLVM Linker", false);
625     return;
626   }
627 
628   // Handle --version
629   if (Args.hasArg(OPT_version) || Args.hasArg(OPT_v)) {
630     outs() << getLLDVersion() << "\n";
631     return;
632   }
633 
634   // Handle --reproduce
635   if (auto *Arg = Args.getLastArg(OPT_reproduce)) {
636     StringRef Path = Arg->getValue();
637     Expected<std::unique_ptr<TarWriter>> ErrOrWriter =
638         TarWriter::create(Path, path::stem(Path));
639     if (ErrOrWriter) {
640       Tar = std::move(*ErrOrWriter);
641       Tar->append("response.txt", createResponseFile(Args));
642       Tar->append("version.txt", getLLDVersion() + "\n");
643     } else {
644       error("--reproduce: " + toString(ErrOrWriter.takeError()));
645     }
646   }
647 
648   // Parse and evaluate -mllvm options.
649   std::vector<const char *> V;
650   V.push_back("wasm-ld (LLVM option parsing)");
651   for (auto *Arg : Args.filtered(OPT_mllvm))
652     V.push_back(Arg->getValue());
653   cl::ParseCommandLineOptions(V.size(), V.data());
654 
655   errorHandler().ErrorLimit = args::getInteger(Args, OPT_error_limit, 20);
656 
657   readConfigs(Args);
658   setConfigs();
659   checkOptions(Args);
660 
661   if (auto *Arg = Args.getLastArg(OPT_allow_undefined_file))
662     readImportFile(Arg->getValue());
663 
664   if (!Args.hasArg(OPT_INPUT)) {
665     error("no input files");
666     return;
667   }
668 
669   // Handle --trace-symbol.
670   for (auto *Arg : Args.filtered(OPT_trace_symbol))
671     Symtab->trace(Arg->getValue());
672 
673   if (!Config->Relocatable)
674     createSyntheticSymbols();
675 
676   createFiles(Args);
677   if (errorCount())
678     return;
679 
680   // Add all files to the symbol table. This will add almost all
681   // symbols that we need to the symbol table.
682   for (InputFile *F : Files)
683     Symtab->addFile(F);
684   if (errorCount())
685     return;
686 
687   // Handle the `--undefined <sym>` options.
688   for (auto *Arg : Args.filtered(OPT_undefined))
689     handleUndefined(Arg->getValue());
690 
691   Symbol *EntrySym = nullptr;
692   if (!Config->Relocatable && !Config->Entry.empty()) {
693     EntrySym = handleUndefined(Config->Entry);
694     if (EntrySym && EntrySym->isDefined())
695       EntrySym->ForceExport = true;
696     else
697       error("entry symbol not defined (pass --no-entry to supress): " +
698             Config->Entry);
699   }
700 
701   if (errorCount())
702     return;
703 
704   // Handle the `--export <sym>` options
705   // This works like --undefined but also exports the symbol if its found
706   for (auto *Arg : Args.filtered(OPT_export))
707     handleUndefined(Arg->getValue());
708 
709   // Create wrapped symbols for -wrap option.
710   std::vector<WrappedSymbol> Wrapped = addWrappedSymbols(Args);
711 
712   // Do link-time optimization if given files are LLVM bitcode files.
713   // This compiles bitcode files into real object files.
714   Symtab->addCombinedLTOObject();
715   if (errorCount())
716     return;
717 
718   // Resolve any variant symbols that were created due to signature
719   // mismatchs.
720   Symtab->handleSymbolVariants();
721   if (errorCount())
722     return;
723 
724   // Apply symbol renames for -wrap.
725   if (!Wrapped.empty())
726     wrapSymbols(Wrapped);
727 
728   for (auto *Arg : Args.filtered(OPT_export)) {
729     Symbol *Sym = Symtab->find(Arg->getValue());
730     if (Sym && Sym->isDefined())
731       Sym->ForceExport = true;
732     else if (!Config->AllowUndefined)
733       error(Twine("symbol exported via --export not found: ") +
734             Arg->getValue());
735   }
736 
737   if (!Config->Relocatable) {
738     // Add synthetic dummies for weak undefined functions.  Must happen
739     // after LTO otherwise functions may not yet have signatures.
740     Symtab->handleWeakUndefines();
741   }
742 
743   if (EntrySym)
744     EntrySym->setHidden(false);
745 
746   if (errorCount())
747     return;
748 
749   // Do size optimizations: garbage collection
750   markLive();
751 
752   // Write the result to the file.
753   writeResult();
754 }
755