Provide a hook to customize missing library error handling
[lldb.git] / lld / ELF / Options.td
1 include "llvm/Option/OptParser.td"
2
3 // Convenience classes for long options which only accept two dashes. For lld
4 // specific or newer long options, we prefer two dashes to avoid collision with
5 // short options. For many others, we have to accept both forms to be compatible
6 // with GNU ld.
7 class FF<string name> : Flag<["--"], name>;
8 class JJ<string name>: Joined<["--"], name>;
9
10 multiclass EEq<string name, string help> {
11   def NAME: Separate<["--"], name>;
12   def NAME # _eq: Joined<["--"], name # "=">, Alias<!cast<Separate>(NAME)>,
13     HelpText<help>;
14 }
15
16 multiclass BB<string name, string help1, string help2> {
17   def NAME: Flag<["--"], name>, HelpText<help1>;
18   def no_ # NAME: Flag<["--"], "no-" # name>, HelpText<help2>;
19 }
20
21 // For options whose names are multiple letters, either one dash or
22 // two can precede the option name except those that start with 'o'.
23 class F<string name>: Flag<["--", "-"], name>;
24 class J<string name>: Joined<["--", "-"], name>;
25
26 multiclass Eq<string name, string help> {
27   def NAME: Separate<["--", "-"], name>;
28   def NAME # _eq: Joined<["--", "-"], name # "=">, Alias<!cast<Separate>(NAME)>,
29     HelpText<help>;
30 }
31
32 multiclass B<string name, string help1, string help2> {
33   def NAME: Flag<["--", "-"], name>, HelpText<help1>;
34   def no_ # NAME: Flag<["--", "-"], "no-" # name>, HelpText<help2>;
35 }
36
37 defm auxiliary: Eq<"auxiliary", "Set DT_AUXILIARY field to the specified name">;
38
39 def Bsymbolic: F<"Bsymbolic">, HelpText<"Bind defined symbols locally">;
40
41 def Bsymbolic_functions: F<"Bsymbolic-functions">,
42   HelpText<"Bind defined function symbols locally">;
43
44 def Bdynamic: F<"Bdynamic">, HelpText<"Link against shared libraries (default)">;
45
46 def Bstatic: F<"Bstatic">, HelpText<"Do not link against shared libraries">;
47
48 def build_id: F<"build-id">, HelpText<"Alias for --build-id=fast">;
49
50 def build_id_eq: J<"build-id=">, HelpText<"Generate build ID note">,
51   MetaVarName<"[fast,md5,sha1,uuid,0x<hexstring>]">;
52
53 defm check_sections: B<"check-sections",
54     "Check section addresses for overlaps (default)",
55     "Do not check section addresses for overlaps">;
56
57 defm compress_debug_sections:
58   Eq<"compress-debug-sections", "Compress DWARF debug sections">,
59   MetaVarName<"[none,zlib]">;
60
61 defm defsym: Eq<"defsym", "Define a symbol alias">, MetaVarName<"<symbol>=<value>">;
62
63 defm optimize_bb_jumps: BB<"optimize-bb-jumps",
64     "Remove direct jumps at the end to the next basic block",
65     "Do not remove any direct jumps at the end to the next basic block (default)">;
66
67 defm split_stack_adjust_size
68     : Eq<"split-stack-adjust-size",
69          "Specify adjustment to stack size when a split-stack function calls a "
70          "non-split-stack function">,
71       MetaVarName<"<value>">;
72
73 defm library_path:
74   Eq<"library-path", "Add a directory to the library search path">, MetaVarName<"<dir>">;
75
76 def O: JoinedOrSeparate<["-"], "O">, HelpText<"Optimize output file size">;
77
78 defm Tbss: Eq<"Tbss", "Same as --section-start with .bss as the sectionname">;
79
80 defm Tdata: Eq<"Tdata", "Same as --section-start with .data as the sectionname">;
81
82 defm Ttext: Eq<"Ttext", "Same as --section-start with .text as the sectionname">;
83
84 def Ttext_segment: Separate<["-", "--"], "Ttext-segment">;
85
86 defm allow_multiple_definition: B<"allow-multiple-definition",
87     "Allow multiple definitions",
88     "Do not allow multiple definitions (default)">;
89
90 defm allow_shlib_undefined: B<"allow-shlib-undefined",
91     "Allow unresolved references in shared libraries (default when linking a shared library)",
92     "Do not allow unresolved references in shared libraries (default when linking an executable)">;
93
94 defm apply_dynamic_relocs: BB<"apply-dynamic-relocs",
95     "Apply link-time values for dynamic relocations",
96     "Do not apply link-time values for dynamic relocations (default)">;
97
98 defm dependent_libraries: BB<"dependent-libraries",
99     "Process dependent library specifiers from input files (default)",
100     "Ignore dependent library specifiers from input files">;
101
102 defm as_needed: B<"as-needed",
103     "Only set DT_NEEDED for shared libraries if used",
104     "Always set DT_NEEDED for shared libraries (default)">;
105
106 defm call_graph_ordering_file:
107   Eq<"call-graph-ordering-file", "Layout sections to optimize the given callgraph">;
108
109 defm call_graph_profile_sort: BB<"call-graph-profile-sort",
110     "Reorder sections with call graph profile (default)",
111     "Do not reorder sections with call graph profile">;
112
113 // -chroot doesn't have a help text because it is an internal option.
114 def chroot: Separate<["--", "-"], "chroot">;
115
116 def color_diagnostics: F<"color-diagnostics">,
117   HelpText<"Alias for --color-diagnostics=always">;
118
119 def color_diagnostics_eq: J<"color-diagnostics=">,
120   HelpText<"Use colors in diagnostics">,
121   MetaVarName<"[auto,always,never]">;
122
123 defm cref: B<"cref",
124     "Output cross reference table",
125     "Do not output cross reference table">;
126
127 defm define_common: B<"define-common",
128     "Assign space to common symbols",
129     "Do not assign space to common symbols">;
130
131 defm demangle: B<"demangle",
132     "Demangle symbol names (default)",
133     "Do not demangle symbol names">;
134
135 defm dependency_file: EEq<"dependency-file", "Write a dependency file">,
136   MetaVarName<"<file>">;
137
138 def disable_new_dtags: F<"disable-new-dtags">,
139   HelpText<"Disable new dynamic tags">;
140
141 def discard_all: F<"discard-all">, HelpText<"Delete all local symbols">;
142
143 def discard_locals: F<"discard-locals">,
144   HelpText<"Delete temporary local symbols">;
145
146 def discard_none: F<"discard-none">,
147   HelpText<"Keep all symbols in the symbol table">;
148
149 defm dynamic_linker: Eq<"dynamic-linker", "Which dynamic linker to use">;
150
151 defm dynamic_list : Eq<"dynamic-list",
152    "Read a list of dynamic symbols. (executable) Put matched non-local defined"
153    "symbols to the dynamic symbol table. (shared object) References to matched"
154    "non-local STV_DEFAULT symbols shouldn't be bound to definitions within the "
155    "shared object. Implies -Bsymbolic but does not set DF_SYMBOLIC">,
156    MetaVarName<"<file>">;
157
158 defm eh_frame_hdr: B<"eh-frame-hdr",
159     "Request creation of .eh_frame_hdr section and PT_GNU_EH_FRAME segment header",
160     "Do not create .eh_frame_hdr section">;
161
162 def emit_relocs: F<"emit-relocs">, HelpText<"Generate relocations in output">;
163
164 def enable_new_dtags: F<"enable-new-dtags">,
165   HelpText<"Enable new dynamic tags (default)">;
166
167 def end_group: F<"end-group">,
168   HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
169
170 def end_lib: F<"end-lib">,
171   HelpText<"End a grouping of objects that should be treated as if they were together in an archive">;
172
173 defm entry: Eq<"entry", "Name of entry point symbol">,
174   MetaVarName<"<entry>">;
175
176 defm error_limit:
177   Eq<"error-limit", "Maximum number of errors to emit before stopping (0 = no limit)">;
178
179 def error_unresolved_symbols: F<"error-unresolved-symbols">,
180   HelpText<"Report unresolved symbols as errors">;
181
182 defm error_handling_script: EEq<"error-handling-script",
183     "Specify an error handling script">;
184
185 defm exclude_libs: Eq<"exclude-libs", "Exclude static libraries from automatic export">;
186
187 defm execute_only: BB<"execute-only",
188     "Mark executable sections unreadable",
189     "Mark executable sections readable (default)">;
190
191 defm export_dynamic: B<"export-dynamic",
192     "Put symbols in the dynamic symbol table",
193     "Do not put symbols in the dynamic symbol table (default)">;
194
195 defm export_dynamic_symbol : EEq<"export-dynamic-symbol",
196     "(executable) Put matched symbols in the dynamic symbol table. "
197     "(shared object) References to matched non-local STV_DEFAULT symbols "
198     "shouldn't be bound to definitions within the shared object. "
199     "Does not imply -Bsymbolic.">,
200     MetaVarName<"glob">;
201
202 defm fatal_warnings: B<"fatal-warnings",
203     "Treat warnings as errors",
204     "Do not treat warnings as errors (default)">;
205
206 defm filter: Eq<"filter", "Set DT_FILTER field to the specified name">;
207
208 defm fini: Eq<"fini", "Specify a finalizer function">, MetaVarName<"<symbol>">;
209
210 def fix_cortex_a53_843419: F<"fix-cortex-a53-843419">,
211   HelpText<"Apply fixes for AArch64 Cortex-A53 erratum 843419">;
212
213 def fix_cortex_a8: F<"fix-cortex-a8">,
214   HelpText<"Apply fixes for ARM Cortex-A8 erratum 657417">;
215
216 defm format: Eq<"format", "Change the input format of the inputs following this option">,
217   MetaVarName<"[default,elf,binary]">;
218
219 defm gc_sections: B<"gc-sections",
220     "Enable garbage collection of unused sections",
221     "Disable garbage collection of unused sections (default)">;
222
223 defm gdb_index: BB<"gdb-index",
224     "Generate .gdb_index section",
225     "Do not generate .gdb_index section (default)">;
226
227 defm gnu_unique: BB<"gnu-unique",
228   "Enable STB_GNU_UNIQUE symbol binding (default)",
229   "Disable STB_GNU_UNIQUE symbol binding">;
230
231 defm hash_style: Eq<"hash-style", "Specify hash style (sysv, gnu or both)">;
232
233 def help: F<"help">, HelpText<"Print option help">;
234
235 def icf_all: F<"icf=all">, HelpText<"Enable identical code folding">;
236
237 def icf_safe: F<"icf=safe">, HelpText<"Enable safe identical code folding">;
238
239 def icf_none: F<"icf=none">, HelpText<"Disable identical code folding (default)">;
240
241 def ignore_function_address_equality: F<"ignore-function-address-equality">,
242   HelpText<"lld can break the address equality of functions">;
243
244 def ignore_data_address_equality: F<"ignore-data-address-equality">,
245   HelpText<"lld can break the address equality of data">;
246
247 defm image_base: Eq<"image-base", "Set the base address">;
248
249 defm init: Eq<"init", "Specify an initializer function">,
250   MetaVarName<"<symbol>">;
251
252 defm just_symbols: Eq<"just-symbols", "Just link symbols">;
253
254 defm keep_unique: Eq<"keep-unique", "Do not fold this symbol during ICF">;
255
256 defm library: Eq<"library", "Root name of library to use">,
257   MetaVarName<"<libName>">;
258
259 def m: JoinedOrSeparate<["-"], "m">, HelpText<"Set target emulation">;
260
261 defm Map: Eq<"Map", "Print a link map to the specified file">;
262
263 defm merge_exidx_entries: B<"merge-exidx-entries",
264     "Enable merging .ARM.exidx entries (default)",
265     "Disable merging .ARM.exidx entries">;
266
267 defm mmap_output_file: BB<"mmap-output-file",
268     "Mmap the output file for writing (default)",
269     "Do not mmap the output file for writing">;
270
271 def nmagic: F<"nmagic">, MetaVarName<"<magic>">,
272   HelpText<"Do not page align sections, link against static libraries.">;
273
274 def nostdlib: F<"nostdlib">,
275   HelpText<"Only search directories specified on the command line">;
276
277 def no_color_diagnostics: F<"no-color-diagnostics">,
278   HelpText<"Do not use colors in diagnostics">;
279
280 def no_dynamic_linker: F<"no-dynamic-linker">,
281   HelpText<"Inhibit output of .interp section">;
282
283 def noinhibit_exec: F<"noinhibit-exec">,
284   HelpText<"Retain the executable output file whenever it is still usable">;
285
286 def no_nmagic: F<"no-nmagic">, MetaVarName<"<magic>">,
287   HelpText<"Page align sections (default)">;
288
289 def no_omagic: F<"no-omagic">, MetaVarName<"<magic>">,
290   HelpText<"Do not set the text data sections to be writable, page align sections (default)">;
291
292 def no_undefined: F<"no-undefined">,
293   HelpText<"Report unresolved symbols even if the linker is creating a shared library">;
294
295 def o: JoinedOrSeparate<["-"], "o">, MetaVarName<"<path>">,
296   HelpText<"Path to file to write output">;
297
298 def oformat: Separate<["--"], "oformat">, MetaVarName<"<format>">,
299   HelpText<"Specify the binary format for the output object file">;
300
301 def omagic: FF<"omagic">, MetaVarName<"<magic>">,
302   HelpText<"Set the text and data sections to be readable and writable, do not page align sections, link against static libraries">;
303
304 defm orphan_handling:
305   Eq<"orphan-handling", "Control how orphan sections are handled when linker script used">;
306
307 defm pack_dyn_relocs:
308   Eq<"pack-dyn-relocs", "Pack dynamic relocations in the given format">,
309   MetaVarName<"[none,android,relr,android+relr]">;
310
311 defm use_android_relr_tags: BB<"use-android-relr-tags",
312     "Use SHT_ANDROID_RELR / DT_ANDROID_RELR* tags instead of SHT_RELR / DT_RELR*",
313     "Use SHT_RELR / DT_RELR* tags (default)">;
314
315 def pic_veneer: F<"pic-veneer">,
316   HelpText<"Always generate position independent thunks (veneers)">;
317
318 defm pie: B<"pie",
319     "Create a position independent executable",
320     "Do not create a position independent executable (default)">;
321
322 defm print_gc_sections: B<"print-gc-sections",
323     "List removed unused sections",
324     "Do not list removed unused sections (default)">;
325
326 defm print_icf_sections: B<"print-icf-sections",
327     "List identical folded sections",
328     "Do not list identical folded sections (default)">;
329
330 def print_archive_stats: J<"print-archive-stats=">,
331   HelpText<"Write archive usage statistics to the specified file. "
332            "Print the numbers of members and fetched members for each archive">;
333
334 defm print_symbol_order: Eq<"print-symbol-order",
335   "Print a symbol order specified by --call-graph-ordering-file into the specified file">;
336
337 def pop_state: F<"pop-state">,
338   HelpText<"Undo the effect of -push-state">;
339
340 def push_state: F<"push-state">,
341   HelpText<"Save the current state of -as-needed, -static and -whole-archive">;
342
343 def print_map: F<"print-map">,
344   HelpText<"Print a link map to the standard output">;
345
346 defm reproduce: Eq<"reproduce", "Write a tar file containing input files and command line options to reproduce link">;
347
348 defm rosegment: BB<"rosegment",
349   "Put read-only non-executable sections in their own segment (default)",
350   "Do not put read-only non-executable sections in their own segment">;
351
352 defm rpath: Eq<"rpath", "Add a DT_RUNPATH to the output">;
353
354 def relocatable: F<"relocatable">, HelpText<"Create relocatable object file">;
355
356 defm retain_symbols_file:
357   Eq<"retain-symbols-file", "Retain only the symbols listed in the file">,
358   MetaVarName<"<file>">;
359
360 defm script: Eq<"script", "Read linker script">;
361
362 defm section_start: Eq<"section-start", "Set address of section">,
363   MetaVarName<"<address>">;
364
365 def shared: F<"shared">, HelpText<"Build a shared object">;
366
367 defm soname: Eq<"soname", "Set DT_SONAME">;
368
369 defm sort_section:
370   Eq<"sort-section", "Specifies sections sorting rule when linkerscript is used">;
371
372 def start_group: F<"start-group">,
373   HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
374
375 def start_lib: F<"start-lib">,
376   HelpText<"Start a grouping of objects that should be treated as if they were together in an archive">;
377
378 def strip_all: F<"strip-all">, HelpText<"Strip all symbols">;
379
380 def strip_debug: F<"strip-debug">, HelpText<"Strip debugging information">;
381
382 defm symbol_ordering_file:
383   Eq<"symbol-ordering-file", "Layout sections to place symbols in the order specified by symbol ordering file">;
384
385 defm sysroot: Eq<"sysroot", "Set the system root">;
386
387 def target1_rel: F<"target1-rel">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_REL32">;
388
389 def target1_abs: F<"target1-abs">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_ABS32 (default)">;
390
391 defm target2:
392   Eq<"target2", "Interpret R_ARM_TARGET2 as <type>, where <type> is one of rel, abs, or got-rel">,
393   MetaVarName<"<type>">;
394
395 defm threads
396     : Eq<"threads",
397          "Number of threads. '1' disables multi-threading. By default all "
398          "available hardware threads are used">;
399
400 def time_trace: FF<"time-trace">, HelpText<"Record time trace">;
401 def time_trace_file_eq: JJ<"time-trace-file=">, HelpText<"Specify time trace output file">;
402
403 defm time_trace_granularity: EEq<"time-trace-granularity",
404   "Minimum time granularity (in microseconds) traced by time profiler">;
405
406 defm toc_optimize : BB<"toc-optimize",
407     "(PowerPC64) Enable TOC related optimizations (default)",
408     "(PowerPC64) Disable TOC related optimizations">;
409
410 defm pcrel_optimize : BB<"pcrel-optimize",
411     "(PowerPC64) Enable PC-relative optimizations (default)",
412     "(PowerPC64) Disable PC-relative optimizations">;
413
414 def trace: F<"trace">, HelpText<"Print the names of the input files">;
415
416 defm trace_symbol: Eq<"trace-symbol", "Trace references to symbols">;
417
418 defm undefined: Eq<"undefined", "Force undefined symbol during linking">,
419   MetaVarName<"<symbol>">;
420
421 defm undefined_glob: EEq<"undefined-glob", "Force undefined symbol during linking">,
422   MetaVarName<"<pattern>">;
423
424 def unique: F<"unique">, HelpText<"Creates a separate output section for every orphan input section">;
425
426 defm unresolved_symbols:
427   Eq<"unresolved-symbols", "Determine how to handle unresolved symbols">;
428
429 defm undefined_version: B<"undefined-version",
430   "Allow unused version in version script (default)",
431   "Report version scripts that refer undefined symbols">;
432
433 defm rsp_quoting: Eq<"rsp-quoting", "Quoting style for response files">,
434   MetaVarName<"[posix,windows]">;
435
436 def v: Flag<["-"], "v">, HelpText<"Display the version number">;
437
438 def verbose: F<"verbose">, HelpText<"Verbose mode">;
439
440 def version: F<"version">, HelpText<"Display the version number and exit">;
441
442 defm version_script: Eq<"version-script", "Read a version script">;
443
444 defm warn_backrefs: BB<"warn-backrefs",
445     "Warn about backward symbol references to fetch archive members",
446     "Do not warn about backward symbol references to fetch archive members (default)">;
447
448 defm warn_backrefs_exclude
449     : EEq<"warn-backrefs-exclude",
450          "Glob describing an archive (or an object file within --start-lib) "
451          "which should be ignored for --warn-backrefs.">,
452       MetaVarName<"<glob>">;
453
454 defm warn_common: B<"warn-common",
455     "Warn about duplicate common symbols",
456     "Do not warn about duplicate common symbols (default)">;
457
458 defm warn_ifunc_textrel: BB<"warn-ifunc-textrel",
459     "Warn about using ifunc symbols with text relocations",
460     "Do not warn about using ifunc symbols with text relocations (default)">;
461
462 defm warn_symbol_ordering: BB<"warn-symbol-ordering",
463     "Warn about problems with the symbol ordering file (default)",
464     "Do not warn about problems with the symbol ordering file">;
465
466 def warn_unresolved_symbols: F<"warn-unresolved-symbols">,
467   HelpText<"Report unresolved symbols as warnings">;
468
469 defm whole_archive: B<"whole-archive",
470     "Force load of all members in a static library",
471     "Do not force load of all members in a static library (default)">;
472
473 defm wrap: Eq<"wrap", "Use wrapper functions for symbol">,
474   MetaVarName<"<symbol>">;
475
476 def z: JoinedOrSeparate<["-"], "z">, MetaVarName<"<option>">,
477   HelpText<"Linker option extensions">;
478
479 def visual_studio_diagnostics_format : F<"vs-diagnostics">,
480 HelpText<"Format diagnostics for Visual Studio compatibility">;
481
482 // Aliases
483 def: Separate<["-"], "f">, Alias<auxiliary>, HelpText<"Alias for --auxiliary">;
484 def: F<"call_shared">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
485 def: F<"dy">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
486 def: F<"dn">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
487 def: F<"non_shared">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
488 def: F<"static">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
489 def: Flag<["-"], "d">, Alias<define_common>, HelpText<"Alias for --define-common">;
490 def: F<"dc">, Alias<define_common>, HelpText<"Alias for --define-common">;
491 def: F<"dp">, Alias<define_common>, HelpText<"Alias for --define-common">;
492 def: Flag<["-"], "x">, Alias<discard_all>, HelpText<"Alias for --discard-all">;
493 def: Flag<["-"], "X">, Alias<discard_locals>, HelpText<"Alias for --discard-locals">;
494 def: Flag<["-"], "q">, Alias<emit_relocs>, HelpText<"Alias for --emit-relocs">;
495 def: Flag<["-"], ")">, Alias<end_group>, HelpText<"Alias for --end-group">;
496 def: JoinedOrSeparate<["-"], "e">, Alias<entry>, HelpText<"Alias for --entry">;
497 def: Flag<["-"], "E">, Alias<export_dynamic>, HelpText<"Alias for --export-dynamic">;
498 def: Separate<["-"], "F">, Alias<filter>, HelpText<"Alias for --filter">;
499 def: Separate<["-"], "b">, Alias<format>, HelpText<"Alias for --format">;
500 def: JoinedOrSeparate<["-"], "l">, Alias<library>, HelpText<"Alias for --library">;
501 def: JoinedOrSeparate<["-"], "L">, Alias<library_path>, HelpText<"Alias for --library-path">;
502 def: F<"no-pic-executable">, Alias<no_pie>, HelpText<"Alias for --no-pie">;
503 def: Flag<["-"], "n">, Alias<nmagic>, HelpText<"Alias for --nmagic">;
504 def: Flag<["-"], "N">, Alias<omagic>, HelpText<"Alias for --omagic">;
505 def: Joined<["--"], "output=">, Alias<o>, HelpText<"Alias for -o">;
506 def: Separate<["--"], "output">, Alias<o>, HelpText<"Alias for -o">;
507 def: F<"pic-executable">, Alias<pie>, HelpText<"Alias for --pie">;
508 def: Flag<["-"], "M">, Alias<print_map>, HelpText<"Alias for --print-map">;
509 def: Flag<["-"], "r">, Alias<relocatable>, HelpText<"Alias for --relocatable">;
510 def: JoinedOrSeparate<["-"], "R">, Alias<rpath>, HelpText<"Alias for --rpath">;
511 def: JoinedOrSeparate<["-"], "T">, Alias<script>, HelpText<"Alias for --script">;
512 def: F<"Bshareable">, Alias<shared>, HelpText<"Alias for --shared">;
513 def: JoinedOrSeparate<["-"], "h">, Alias<soname>, HelpText<"Alias for --soname">;
514 def: Flag<["-"], "(">, Alias<start_group>, HelpText<"Alias for --start-group">;
515 def: Flag<["-"], "s">, Alias<strip_all>, HelpText<"Alias for --strip-all">;
516 def: Flag<["-"], "S">, Alias<strip_debug>, HelpText<"Alias for --strip-debug">;
517 def: Flag<["-"], "t">, Alias<trace>, HelpText<"Alias for --trace">;
518 def: Joined<["-", "--"], "Ttext-segment=">, Alias<Ttext_segment>;
519 def: JoinedOrSeparate<["-"], "y">, Alias<trace_symbol>, HelpText<"Alias for --trace-symbol">;
520 def: JoinedOrSeparate<["-"], "u">, Alias<undefined>, HelpText<"Alias for --undefined">;
521 def: Flag<["-"], "V">, Alias<version>, HelpText<"Alias for --version">;
522
523 // LTO-related options.
524 def lto_aa_pipeline: JJ<"lto-aa-pipeline=">,
525   HelpText<"AA pipeline to run during LTO. Used in conjunction with -lto-newpm-passes">;
526 def lto_debug_pass_manager: FF<"lto-debug-pass-manager">,
527   HelpText<"Debug new pass manager">;
528 def lto_emit_asm: FF<"lto-emit-asm">,
529   HelpText<"Emit assembly code">;
530 def lto_new_pass_manager: FF<"lto-new-pass-manager">,
531   HelpText<"Use new pass manager">;
532 def lto_newpm_passes: JJ<"lto-newpm-passes=">,
533   HelpText<"Passes to run during LTO">;
534 def lto_O: JJ<"lto-O">, MetaVarName<"<opt-level>">,
535   HelpText<"Optimization level for LTO">;
536 def lto_partitions: JJ<"lto-partitions=">,
537   HelpText<"Number of LTO codegen partitions">;
538 def lto_cs_profile_generate: FF<"lto-cs-profile-generate">,
539   HelpText<"Perform context sensitive PGO instrumentation">;
540 def lto_cs_profile_file: JJ<"lto-cs-profile-file=">,
541   HelpText<"Context sensitive profile file path">;
542 def lto_obj_path_eq: JJ<"lto-obj-path=">;
543 def lto_sample_profile: JJ<"lto-sample-profile=">,
544   HelpText<"Sample profile file path">;
545 def lto_whole_program_visibility: FF<"lto-whole-program-visibility">,
546   HelpText<"Asserts that the LTO link has whole program visibility">;
547 def disable_verify: F<"disable-verify">;
548 defm mllvm: Eq<"mllvm", "Additional arguments to forward to LLVM's option processing">;
549 def opt_remarks_filename: Separate<["--"], "opt-remarks-filename">,
550   HelpText<"YAML output file for optimization remarks">;
551 def opt_remarks_passes: Separate<["--"], "opt-remarks-passes">,
552   HelpText<"Regex for the passes that need to be serialized to the output file">;
553 def opt_remarks_with_hotness: FF<"opt-remarks-with-hotness">,
554   HelpText<"Include hotness information in the optimization remarks file">;
555 def opt_remarks_format: Separate<["--"], "opt-remarks-format">,
556   HelpText<"The format used for serializing remarks (default: YAML)">;
557 def save_temps: F<"save-temps">;
558 def lto_basic_block_sections: JJ<"lto-basic-block-sections=">,
559   HelpText<"Enable basic block sections for LTO">;
560 defm lto_unique_basic_block_section_names: BB<"lto-unique-basic-block-section-names",
561     "Give unique names to every basic block section for LTO",
562     "Do not give unique names to every basic block section for LTO (default)">;
563 def shuffle_sections: JJ<"shuffle-sections=">, MetaVarName<"<seed>">,
564   HelpText<"Shuffle input sections using the given seed. If 0, use a random seed">;
565 def thinlto_cache_dir: JJ<"thinlto-cache-dir=">,
566   HelpText<"Path to ThinLTO cached object file directory">;
567 defm thinlto_cache_policy: EEq<"thinlto-cache-policy", "Pruning policy for the ThinLTO cache">;
568 def thinlto_emit_imports_files: FF<"thinlto-emit-imports-files">;
569 def thinlto_index_only: FF<"thinlto-index-only">;
570 def thinlto_index_only_eq: JJ<"thinlto-index-only=">;
571 def thinlto_jobs: JJ<"thinlto-jobs=">,
572   HelpText<"Number of ThinLTO jobs. Default to --threads=">;
573 def thinlto_object_suffix_replace_eq: JJ<"thinlto-object-suffix-replace=">;
574 def thinlto_prefix_replace_eq: JJ<"thinlto-prefix-replace=">;
575 def thinlto_single_module_eq: JJ<"thinlto-single-module=">,
576   HelpText<"Specific a single module to compile in ThinLTO mode, for debugging only">;
577
578 def: J<"plugin-opt=O">, Alias<lto_O>, HelpText<"Alias for --lto-O">;
579 def: F<"plugin-opt=debug-pass-manager">,
580   Alias<lto_debug_pass_manager>, HelpText<"Alias for --lto-debug-pass-manager">;
581 def: F<"plugin-opt=disable-verify">, Alias<disable_verify>, HelpText<"Alias for --disable-verify">;
582 def plugin_opt_dwo_dir_eq: J<"plugin-opt=dwo_dir=">,
583   HelpText<"Directory to store .dwo files when LTO and debug fission are used">;
584 def plugin_opt_emit_asm: F<"plugin-opt=emit-asm">,
585   Alias<lto_emit_asm>, HelpText<"Alias for --lto-emit-asm">;
586 def plugin_opt_emit_llvm: F<"plugin-opt=emit-llvm">;
587 def: J<"plugin-opt=jobs=">, Alias<thinlto_jobs>, HelpText<"Alias for --thinlto-jobs">;
588 def: J<"plugin-opt=lto-partitions=">, Alias<lto_partitions>, HelpText<"Alias for --lto-partitions">;
589 def plugin_opt_mcpu_eq: J<"plugin-opt=mcpu=">;
590 def: F<"plugin-opt=new-pass-manager">,
591   Alias<lto_new_pass_manager>, HelpText<"Alias for --lto-new-pass-manager">;
592 def: F<"plugin-opt=cs-profile-generate">,
593   Alias<lto_cs_profile_generate>, HelpText<"Alias for --lto-cs-profile-generate">;
594 def: J<"plugin-opt=cs-profile-path=">,
595   Alias<lto_cs_profile_file>, HelpText<"Alias for --lto-cs-profile-file">;
596 def: J<"plugin-opt=obj-path=">,
597   Alias<lto_obj_path_eq>,
598   HelpText<"Alias for --lto-obj-path=">;
599 def: J<"plugin-opt=sample-profile=">,
600   Alias<lto_sample_profile>, HelpText<"Alias for --lto-sample-profile">;
601 def: F<"plugin-opt=save-temps">, Alias<save_temps>, HelpText<"Alias for --save-temps">;
602 def: F<"plugin-opt=thinlto-emit-imports-files">,
603   Alias<thinlto_emit_imports_files>,
604   HelpText<"Alias for --thinlto-emit-imports-files">;
605 def: F<"plugin-opt=thinlto-index-only">,
606   Alias<thinlto_index_only>,
607   HelpText<"Alias for --thinlto-index-only">;
608 def: J<"plugin-opt=thinlto-index-only=">,
609   Alias<thinlto_index_only_eq>,
610   HelpText<"Alias for --thinlto-index-only=">;
611 def: J<"plugin-opt=thinlto-object-suffix-replace=">,
612  Alias<thinlto_object_suffix_replace_eq>,
613  HelpText<"Alias for --thinlto-object-suffix-replace=">;
614 def: J<"plugin-opt=thinlto-prefix-replace=">,
615   Alias<thinlto_prefix_replace_eq>,
616   HelpText<"Alias for --thinlto-prefix-replace=">;
617
618 // Ignore LTO plugin-related options.
619 // clang -flto passes -plugin and -plugin-opt to the linker. This is required
620 // for ld.gold and ld.bfd to get LTO working. But it's not for lld which doesn't
621 // rely on a plugin. Instead of detecting which linker is used on clang side we
622 // just ignore the option on lld side as it's easier. In fact, the linker could
623 // be called 'ld' and understanding which linker is used would require parsing of
624 // --version output.
625 defm plugin: Eq<"plugin", "Ignored for compatibility with GNU linkers">;
626
627 def plugin_opt_eq_minus: J<"plugin-opt=-">,
628   HelpText<"Specify an LLVM option for compatibility with LLVMgold.so">;
629 def: J<"plugin-opt=thinlto">;
630
631 // Ignore GCC collect2 LTO plugin related options. Note that we don't support
632 // GCC LTO, but GCC collect2 passes these options even in non-LTO mode.
633 def: J<"plugin-opt=-fresolution=">;
634 def: J<"plugin-opt=-pass-through=">;
635 // This may be either an unhandled LLVMgold.so feature or GCC passed
636 // -plugin-opt=path/to/{liblto_plugin.so,lto-wrapper}
637 def plugin_opt_eq : J<"plugin-opt=">;
638
639 // Options listed below are silently ignored for now for compatibility.
640 def: F<"detect-odr-violations">;
641 def: Flag<["-"], "g">;
642 def: F<"long-plt">;
643 def: F<"no-add-needed">;
644 def: F<"no-copy-dt-needed-entries">;
645 def: F<"no-ctors-in-init-array">;
646 def: F<"no-keep-memory">;
647 def: F<"no-pipeline-knowledge">;
648 def: F<"no-relax">;
649 def: F<"no-warn-mismatch">;
650 def: Flag<["-"], "p">;
651 def: Separate<["--", "-"], "rpath-link">;
652 def: J<"rpath-link=">;
653 def: F<"secure-plt">;
654 def: F<"sort-common">;
655 def: F<"stats">;
656 def: F<"warn-execstack">;
657 def: F<"warn-once">;
658 def: F<"warn-shared-textrel">;
659 def: F<"EB">;
660 def: F<"EL">;
661 def: JoinedOrSeparate<["-"], "G">;
662 def: F<"Qy">;
663
664 // Hidden option used for testing MIPS multi-GOT implementation.
665 defm mips_got_size:
666   Eq<"mips-got-size", "Max size of a single MIPS GOT. 0x10000 by default.">,
667   Flags<[HelpHidden]>;