9f1fbd15caf7f216877cf67174be691fa263b5d7
[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 exclude_libs: Eq<"exclude-libs", "Exclude static libraries from automatic export">;
183
184 defm execute_only: BB<"execute-only",
185     "Mark executable sections unreadable",
186     "Mark executable sections readable (default)">;
187
188 defm export_dynamic: B<"export-dynamic",
189     "Put symbols in the dynamic symbol table",
190     "Do not put symbols in the dynamic symbol table (default)">;
191
192 defm export_dynamic_symbol : EEq<"export-dynamic-symbol",
193     "(executable) Put matched symbols in the dynamic symbol table. "
194     "(shared object) References to matched non-local STV_DEFAULT symbols "
195     "shouldn't be bound to definitions within the shared object. "
196     "Does not imply -Bsymbolic.">,
197     MetaVarName<"glob">;
198
199 defm fatal_warnings: B<"fatal-warnings",
200     "Treat warnings as errors",
201     "Do not treat warnings as errors (default)">;
202
203 defm filter: Eq<"filter", "Set DT_FILTER field to the specified name">;
204
205 defm fini: Eq<"fini", "Specify a finalizer function">, MetaVarName<"<symbol>">;
206
207 def fix_cortex_a53_843419: F<"fix-cortex-a53-843419">,
208   HelpText<"Apply fixes for AArch64 Cortex-A53 erratum 843419">;
209
210 def fix_cortex_a8: F<"fix-cortex-a8">,
211   HelpText<"Apply fixes for ARM Cortex-A8 erratum 657417">;
212
213 defm format: Eq<"format", "Change the input format of the inputs following this option">,
214   MetaVarName<"[default,elf,binary]">;
215
216 defm gc_sections: B<"gc-sections",
217     "Enable garbage collection of unused sections",
218     "Disable garbage collection of unused sections (default)">;
219
220 defm gdb_index: BB<"gdb-index",
221     "Generate .gdb_index section",
222     "Do not generate .gdb_index section (default)">;
223
224 defm gnu_unique: BB<"gnu-unique",
225   "Enable STB_GNU_UNIQUE symbol binding (default)",
226   "Disable STB_GNU_UNIQUE symbol binding">;
227
228 defm hash_style: Eq<"hash-style", "Specify hash style (sysv, gnu or both)">;
229
230 def help: F<"help">, HelpText<"Print option help">;
231
232 def icf_all: F<"icf=all">, HelpText<"Enable identical code folding">;
233
234 def icf_safe: F<"icf=safe">, HelpText<"Enable safe identical code folding">;
235
236 def icf_none: F<"icf=none">, HelpText<"Disable identical code folding (default)">;
237
238 def ignore_function_address_equality: F<"ignore-function-address-equality">,
239   HelpText<"lld can break the address equality of functions">;
240
241 def ignore_data_address_equality: F<"ignore-data-address-equality">,
242   HelpText<"lld can break the address equality of data">;
243
244 defm image_base: Eq<"image-base", "Set the base address">;
245
246 defm init: Eq<"init", "Specify an initializer function">,
247   MetaVarName<"<symbol>">;
248
249 defm just_symbols: Eq<"just-symbols", "Just link symbols">;
250
251 defm keep_unique: Eq<"keep-unique", "Do not fold this symbol during ICF">;
252
253 defm library: Eq<"library", "Root name of library to use">,
254   MetaVarName<"<libName>">;
255
256 def m: JoinedOrSeparate<["-"], "m">, HelpText<"Set target emulation">;
257
258 defm Map: Eq<"Map", "Print a link map to the specified file">;
259
260 defm merge_exidx_entries: B<"merge-exidx-entries",
261     "Enable merging .ARM.exidx entries (default)",
262     "Disable merging .ARM.exidx entries">;
263
264 defm mmap_output_file: BB<"mmap-output-file",
265     "Mmap the output file for writing (default)",
266     "Do not mmap the output file for writing">;
267
268 def nmagic: F<"nmagic">, MetaVarName<"<magic>">,
269   HelpText<"Do not page align sections, link against static libraries.">;
270
271 def nostdlib: F<"nostdlib">,
272   HelpText<"Only search directories specified on the command line">;
273
274 def no_color_diagnostics: F<"no-color-diagnostics">,
275   HelpText<"Do not use colors in diagnostics">;
276
277 def no_dynamic_linker: F<"no-dynamic-linker">,
278   HelpText<"Inhibit output of .interp section">;
279
280 def noinhibit_exec: F<"noinhibit-exec">,
281   HelpText<"Retain the executable output file whenever it is still usable">;
282
283 def no_nmagic: F<"no-nmagic">, MetaVarName<"<magic>">,
284   HelpText<"Page align sections (default)">;
285
286 def no_omagic: F<"no-omagic">, MetaVarName<"<magic>">,
287   HelpText<"Do not set the text data sections to be writable, page align sections (default)">;
288
289 def no_undefined: F<"no-undefined">,
290   HelpText<"Report unresolved symbols even if the linker is creating a shared library">;
291
292 def o: JoinedOrSeparate<["-"], "o">, MetaVarName<"<path>">,
293   HelpText<"Path to file to write output">;
294
295 def oformat: Separate<["--"], "oformat">, MetaVarName<"<format>">,
296   HelpText<"Specify the binary format for the output object file">;
297
298 def omagic: FF<"omagic">, MetaVarName<"<magic>">,
299   HelpText<"Set the text and data sections to be readable and writable, do not page align sections, link against static libraries">;
300
301 defm orphan_handling:
302   Eq<"orphan-handling", "Control how orphan sections are handled when linker script used">;
303
304 defm pack_dyn_relocs:
305   Eq<"pack-dyn-relocs", "Pack dynamic relocations in the given format">,
306   MetaVarName<"[none,android,relr,android+relr]">;
307
308 defm use_android_relr_tags: BB<"use-android-relr-tags",
309     "Use SHT_ANDROID_RELR / DT_ANDROID_RELR* tags instead of SHT_RELR / DT_RELR*",
310     "Use SHT_RELR / DT_RELR* tags (default)">;
311
312 def pic_veneer: F<"pic-veneer">,
313   HelpText<"Always generate position independent thunks (veneers)">;
314
315 defm pie: B<"pie",
316     "Create a position independent executable",
317     "Do not create a position independent executable (default)">;
318
319 defm print_gc_sections: B<"print-gc-sections",
320     "List removed unused sections",
321     "Do not list removed unused sections (default)">;
322
323 defm print_icf_sections: B<"print-icf-sections",
324     "List identical folded sections",
325     "Do not list identical folded sections (default)">;
326
327 def print_archive_stats: J<"print-archive-stats=">,
328   HelpText<"Write archive usage statistics to the specified file. "
329            "Print the numbers of members and fetched members for each archive">;
330
331 defm print_symbol_order: Eq<"print-symbol-order",
332   "Print a symbol order specified by --call-graph-ordering-file into the specified file">;
333
334 def pop_state: F<"pop-state">,
335   HelpText<"Undo the effect of -push-state">;
336
337 def push_state: F<"push-state">,
338   HelpText<"Save the current state of -as-needed, -static and -whole-archive">;
339
340 def print_map: F<"print-map">,
341   HelpText<"Print a link map to the standard output">;
342
343 defm reproduce: Eq<"reproduce", "Write a tar file containing input files and command line options to reproduce link">;
344
345 defm rosegment: BB<"rosegment",
346   "Put read-only non-executable sections in their own segment (default)",
347   "Do not put read-only non-executable sections in their own segment">;
348
349 defm rpath: Eq<"rpath", "Add a DT_RUNPATH to the output">;
350
351 def relocatable: F<"relocatable">, HelpText<"Create relocatable object file">;
352
353 defm retain_symbols_file:
354   Eq<"retain-symbols-file", "Retain only the symbols listed in the file">,
355   MetaVarName<"<file>">;
356
357 defm script: Eq<"script", "Read linker script">;
358
359 defm section_start: Eq<"section-start", "Set address of section">,
360   MetaVarName<"<address>">;
361
362 def shared: F<"shared">, HelpText<"Build a shared object">;
363
364 defm soname: Eq<"soname", "Set DT_SONAME">;
365
366 defm sort_section:
367   Eq<"sort-section", "Specifies sections sorting rule when linkerscript is used">;
368
369 def start_group: F<"start-group">,
370   HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
371
372 def start_lib: F<"start-lib">,
373   HelpText<"Start a grouping of objects that should be treated as if they were together in an archive">;
374
375 def strip_all: F<"strip-all">, HelpText<"Strip all symbols">;
376
377 def strip_debug: F<"strip-debug">, HelpText<"Strip debugging information">;
378
379 defm symbol_ordering_file:
380   Eq<"symbol-ordering-file", "Layout sections to place symbols in the order specified by symbol ordering file">;
381
382 defm sysroot: Eq<"sysroot", "Set the system root">;
383
384 def target1_rel: F<"target1-rel">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_REL32">;
385
386 def target1_abs: F<"target1-abs">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_ABS32 (default)">;
387
388 defm target2:
389   Eq<"target2", "Interpret R_ARM_TARGET2 as <type>, where <type> is one of rel, abs, or got-rel">,
390   MetaVarName<"<type>">;
391
392 defm threads
393     : Eq<"threads",
394          "Number of threads. '1' disables multi-threading. By default all "
395          "available hardware threads are used">;
396
397 def time_trace: FF<"time-trace">, HelpText<"Record time trace">;
398 def time_trace_file_eq: JJ<"time-trace-file=">, HelpText<"Specify time trace output file">;
399
400 defm time_trace_granularity: EEq<"time-trace-granularity",
401   "Minimum time granularity (in microseconds) traced by time profiler">;
402
403 defm toc_optimize : BB<"toc-optimize",
404     "(PowerPC64) Enable TOC related optimizations (default)",
405     "(PowerPC64) Disable TOC related optimizations">;
406
407 defm pcrel_optimize : BB<"pcrel-optimize",
408     "(PowerPC64) Enable PC-relative optimizations (default)",
409     "(PowerPC64) Disable PC-relative optimizations">;
410
411 def trace: F<"trace">, HelpText<"Print the names of the input files">;
412
413 defm trace_symbol: Eq<"trace-symbol", "Trace references to symbols">;
414
415 defm undefined: Eq<"undefined", "Force undefined symbol during linking">,
416   MetaVarName<"<symbol>">;
417
418 defm undefined_glob: EEq<"undefined-glob", "Force undefined symbol during linking">,
419   MetaVarName<"<pattern>">;
420
421 def unique: F<"unique">, HelpText<"Creates a separate output section for every orphan input section">;
422
423 defm unresolved_symbols:
424   Eq<"unresolved-symbols", "Determine how to handle unresolved symbols">;
425
426 defm undefined_version: B<"undefined-version",
427   "Allow unused version in version script (default)",
428   "Report version scripts that refer undefined symbols">;
429
430 defm rsp_quoting: Eq<"rsp-quoting", "Quoting style for response files">,
431   MetaVarName<"[posix,windows]">;
432
433 def v: Flag<["-"], "v">, HelpText<"Display the version number">;
434
435 def verbose: F<"verbose">, HelpText<"Verbose mode">;
436
437 def version: F<"version">, HelpText<"Display the version number and exit">;
438
439 defm version_script: Eq<"version-script", "Read a version script">;
440
441 defm warn_backrefs: BB<"warn-backrefs",
442     "Warn about backward symbol references to fetch archive members",
443     "Do not warn about backward symbol references to fetch archive members (default)">;
444
445 defm warn_backrefs_exclude
446     : EEq<"warn-backrefs-exclude",
447          "Glob describing an archive (or an object file within --start-lib) "
448          "which should be ignored for --warn-backrefs.">,
449       MetaVarName<"<glob>">;
450
451 defm warn_common: B<"warn-common",
452     "Warn about duplicate common symbols",
453     "Do not warn about duplicate common symbols (default)">;
454
455 defm warn_ifunc_textrel: BB<"warn-ifunc-textrel",
456     "Warn about using ifunc symbols with text relocations",
457     "Do not warn about using ifunc symbols with text relocations (default)">;
458
459 defm warn_symbol_ordering: BB<"warn-symbol-ordering",
460     "Warn about problems with the symbol ordering file (default)",
461     "Do not warn about problems with the symbol ordering file">;
462
463 def warn_unresolved_symbols: F<"warn-unresolved-symbols">,
464   HelpText<"Report unresolved symbols as warnings">;
465
466 defm whole_archive: B<"whole-archive",
467     "Force load of all members in a static library",
468     "Do not force load of all members in a static library (default)">;
469
470 defm wrap: Eq<"wrap", "Use wrapper functions for symbol">,
471   MetaVarName<"<symbol>">;
472
473 def z: JoinedOrSeparate<["-"], "z">, MetaVarName<"<option>">,
474   HelpText<"Linker option extensions">;
475
476 def visual_studio_diagnostics_format : F<"vs-diagnostics">,
477 HelpText<"Format diagnostics for Visual Studio compatibility">;
478
479 // Aliases
480 def: Separate<["-"], "f">, Alias<auxiliary>, HelpText<"Alias for --auxiliary">;
481 def: F<"call_shared">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
482 def: F<"dy">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
483 def: F<"dn">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
484 def: F<"non_shared">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
485 def: F<"static">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
486 def: Flag<["-"], "d">, Alias<define_common>, HelpText<"Alias for --define-common">;
487 def: F<"dc">, Alias<define_common>, HelpText<"Alias for --define-common">;
488 def: F<"dp">, Alias<define_common>, HelpText<"Alias for --define-common">;
489 def: Flag<["-"], "x">, Alias<discard_all>, HelpText<"Alias for --discard-all">;
490 def: Flag<["-"], "X">, Alias<discard_locals>, HelpText<"Alias for --discard-locals">;
491 def: Flag<["-"], "q">, Alias<emit_relocs>, HelpText<"Alias for --emit-relocs">;
492 def: Flag<["-"], ")">, Alias<end_group>, HelpText<"Alias for --end-group">;
493 def: JoinedOrSeparate<["-"], "e">, Alias<entry>, HelpText<"Alias for --entry">;
494 def: Flag<["-"], "E">, Alias<export_dynamic>, HelpText<"Alias for --export-dynamic">;
495 def: Separate<["-"], "F">, Alias<filter>, HelpText<"Alias for --filter">;
496 def: Separate<["-"], "b">, Alias<format>, HelpText<"Alias for --format">;
497 def: JoinedOrSeparate<["-"], "l">, Alias<library>, HelpText<"Alias for --library">;
498 def: JoinedOrSeparate<["-"], "L">, Alias<library_path>, HelpText<"Alias for --library-path">;
499 def: F<"no-pic-executable">, Alias<no_pie>, HelpText<"Alias for --no-pie">;
500 def: Flag<["-"], "n">, Alias<nmagic>, HelpText<"Alias for --nmagic">;
501 def: Flag<["-"], "N">, Alias<omagic>, HelpText<"Alias for --omagic">;
502 def: Joined<["--"], "output=">, Alias<o>, HelpText<"Alias for -o">;
503 def: Separate<["--"], "output">, Alias<o>, HelpText<"Alias for -o">;
504 def: F<"pic-executable">, Alias<pie>, HelpText<"Alias for --pie">;
505 def: Flag<["-"], "M">, Alias<print_map>, HelpText<"Alias for --print-map">;
506 def: Flag<["-"], "r">, Alias<relocatable>, HelpText<"Alias for --relocatable">;
507 def: JoinedOrSeparate<["-"], "R">, Alias<rpath>, HelpText<"Alias for --rpath">;
508 def: JoinedOrSeparate<["-"], "T">, Alias<script>, HelpText<"Alias for --script">;
509 def: F<"Bshareable">, Alias<shared>, HelpText<"Alias for --shared">;
510 def: JoinedOrSeparate<["-"], "h">, Alias<soname>, HelpText<"Alias for --soname">;
511 def: Flag<["-"], "(">, Alias<start_group>, HelpText<"Alias for --start-group">;
512 def: Flag<["-"], "s">, Alias<strip_all>, HelpText<"Alias for --strip-all">;
513 def: Flag<["-"], "S">, Alias<strip_debug>, HelpText<"Alias for --strip-debug">;
514 def: Flag<["-"], "t">, Alias<trace>, HelpText<"Alias for --trace">;
515 def: Joined<["-", "--"], "Ttext-segment=">, Alias<Ttext_segment>;
516 def: JoinedOrSeparate<["-"], "y">, Alias<trace_symbol>, HelpText<"Alias for --trace-symbol">;
517 def: JoinedOrSeparate<["-"], "u">, Alias<undefined>, HelpText<"Alias for --undefined">;
518 def: Flag<["-"], "V">, Alias<version>, HelpText<"Alias for --version">;
519
520 // LTO-related options.
521 def lto_aa_pipeline: JJ<"lto-aa-pipeline=">,
522   HelpText<"AA pipeline to run during LTO. Used in conjunction with -lto-newpm-passes">;
523 def lto_debug_pass_manager: FF<"lto-debug-pass-manager">,
524   HelpText<"Debug new pass manager">;
525 def lto_emit_asm: FF<"lto-emit-asm">,
526   HelpText<"Emit assembly code">;
527 def lto_new_pass_manager: FF<"lto-new-pass-manager">,
528   HelpText<"Use new pass manager">;
529 def lto_newpm_passes: JJ<"lto-newpm-passes=">,
530   HelpText<"Passes to run during LTO">;
531 def lto_O: JJ<"lto-O">, MetaVarName<"<opt-level>">,
532   HelpText<"Optimization level for LTO">;
533 def lto_partitions: JJ<"lto-partitions=">,
534   HelpText<"Number of LTO codegen partitions">;
535 def lto_cs_profile_generate: FF<"lto-cs-profile-generate">,
536   HelpText<"Perform context sensitive PGO instrumentation">;
537 def lto_cs_profile_file: JJ<"lto-cs-profile-file=">,
538   HelpText<"Context sensitive profile file path">;
539 def lto_obj_path_eq: JJ<"lto-obj-path=">;
540 def lto_sample_profile: JJ<"lto-sample-profile=">,
541   HelpText<"Sample profile file path">;
542 def lto_whole_program_visibility: FF<"lto-whole-program-visibility">,
543   HelpText<"Asserts that the LTO link has whole program visibility">;
544 def disable_verify: F<"disable-verify">;
545 defm mllvm: Eq<"mllvm", "Additional arguments to forward to LLVM's option processing">;
546 def opt_remarks_filename: Separate<["--"], "opt-remarks-filename">,
547   HelpText<"YAML output file for optimization remarks">;
548 def opt_remarks_passes: Separate<["--"], "opt-remarks-passes">,
549   HelpText<"Regex for the passes that need to be serialized to the output file">;
550 def opt_remarks_with_hotness: FF<"opt-remarks-with-hotness">,
551   HelpText<"Include hotness information in the optimization remarks file">;
552 def opt_remarks_format: Separate<["--"], "opt-remarks-format">,
553   HelpText<"The format used for serializing remarks (default: YAML)">;
554 def save_temps: F<"save-temps">;
555 def lto_basic_block_sections: JJ<"lto-basic-block-sections=">,
556   HelpText<"Enable basic block sections for LTO">;
557 defm lto_unique_basic_block_section_names: BB<"lto-unique-basic-block-section-names",
558     "Give unique names to every basic block section for LTO",
559     "Do not give unique names to every basic block section for LTO (default)">;
560 def shuffle_sections: JJ<"shuffle-sections=">, MetaVarName<"<seed>">,
561   HelpText<"Shuffle input sections using the given seed. If 0, use a random seed">;
562 def thinlto_cache_dir: JJ<"thinlto-cache-dir=">,
563   HelpText<"Path to ThinLTO cached object file directory">;
564 defm thinlto_cache_policy: EEq<"thinlto-cache-policy", "Pruning policy for the ThinLTO cache">;
565 def thinlto_emit_imports_files: FF<"thinlto-emit-imports-files">;
566 def thinlto_index_only: FF<"thinlto-index-only">;
567 def thinlto_index_only_eq: JJ<"thinlto-index-only=">;
568 def thinlto_jobs: JJ<"thinlto-jobs=">,
569   HelpText<"Number of ThinLTO jobs. Default to --threads=">;
570 def thinlto_object_suffix_replace_eq: JJ<"thinlto-object-suffix-replace=">;
571 def thinlto_prefix_replace_eq: JJ<"thinlto-prefix-replace=">;
572 def thinlto_single_module_eq: JJ<"thinlto-single-module=">,
573   HelpText<"Specific a single module to compile in ThinLTO mode, for debugging only">;
574
575 def: J<"plugin-opt=O">, Alias<lto_O>, HelpText<"Alias for --lto-O">;
576 def: F<"plugin-opt=debug-pass-manager">,
577   Alias<lto_debug_pass_manager>, HelpText<"Alias for --lto-debug-pass-manager">;
578 def: F<"plugin-opt=disable-verify">, Alias<disable_verify>, HelpText<"Alias for --disable-verify">;
579 def plugin_opt_dwo_dir_eq: J<"plugin-opt=dwo_dir=">,
580   HelpText<"Directory to store .dwo files when LTO and debug fission are used">;
581 def plugin_opt_emit_asm: F<"plugin-opt=emit-asm">,
582   Alias<lto_emit_asm>, HelpText<"Alias for --lto-emit-asm">;
583 def plugin_opt_emit_llvm: F<"plugin-opt=emit-llvm">;
584 def: J<"plugin-opt=jobs=">, Alias<thinlto_jobs>, HelpText<"Alias for --thinlto-jobs">;
585 def: J<"plugin-opt=lto-partitions=">, Alias<lto_partitions>, HelpText<"Alias for --lto-partitions">;
586 def plugin_opt_mcpu_eq: J<"plugin-opt=mcpu=">;
587 def: F<"plugin-opt=new-pass-manager">,
588   Alias<lto_new_pass_manager>, HelpText<"Alias for --lto-new-pass-manager">;
589 def: F<"plugin-opt=cs-profile-generate">,
590   Alias<lto_cs_profile_generate>, HelpText<"Alias for --lto-cs-profile-generate">;
591 def: J<"plugin-opt=cs-profile-path=">,
592   Alias<lto_cs_profile_file>, HelpText<"Alias for --lto-cs-profile-file">;
593 def: J<"plugin-opt=obj-path=">,
594   Alias<lto_obj_path_eq>,
595   HelpText<"Alias for --lto-obj-path=">;
596 def: J<"plugin-opt=sample-profile=">,
597   Alias<lto_sample_profile>, HelpText<"Alias for --lto-sample-profile">;
598 def: F<"plugin-opt=save-temps">, Alias<save_temps>, HelpText<"Alias for --save-temps">;
599 def: F<"plugin-opt=thinlto-emit-imports-files">,
600   Alias<thinlto_emit_imports_files>,
601   HelpText<"Alias for --thinlto-emit-imports-files">;
602 def: F<"plugin-opt=thinlto-index-only">,
603   Alias<thinlto_index_only>,
604   HelpText<"Alias for --thinlto-index-only">;
605 def: J<"plugin-opt=thinlto-index-only=">,
606   Alias<thinlto_index_only_eq>,
607   HelpText<"Alias for --thinlto-index-only=">;
608 def: J<"plugin-opt=thinlto-object-suffix-replace=">,
609  Alias<thinlto_object_suffix_replace_eq>,
610  HelpText<"Alias for --thinlto-object-suffix-replace=">;
611 def: J<"plugin-opt=thinlto-prefix-replace=">,
612   Alias<thinlto_prefix_replace_eq>,
613   HelpText<"Alias for --thinlto-prefix-replace=">;
614
615 // Ignore LTO plugin-related options.
616 // clang -flto passes -plugin and -plugin-opt to the linker. This is required
617 // for ld.gold and ld.bfd to get LTO working. But it's not for lld which doesn't
618 // rely on a plugin. Instead of detecting which linker is used on clang side we
619 // just ignore the option on lld side as it's easier. In fact, the linker could
620 // be called 'ld' and understanding which linker is used would require parsing of
621 // --version output.
622 defm plugin: Eq<"plugin", "Ignored for compatibility with GNU linkers">;
623
624 def plugin_opt_eq_minus: J<"plugin-opt=-">,
625   HelpText<"Specify an LLVM option for compatibility with LLVMgold.so">;
626 def: J<"plugin-opt=thinlto">;
627
628 // Ignore GCC collect2 LTO plugin related options. Note that we don't support
629 // GCC LTO, but GCC collect2 passes these options even in non-LTO mode.
630 def: J<"plugin-opt=-fresolution=">;
631 def: J<"plugin-opt=-pass-through=">;
632 // This may be either an unhandled LLVMgold.so feature or GCC passed
633 // -plugin-opt=path/to/{liblto_plugin.so,lto-wrapper}
634 def plugin_opt_eq : J<"plugin-opt=">;
635
636 // Options listed below are silently ignored for now for compatibility.
637 def: F<"detect-odr-violations">;
638 def: Flag<["-"], "g">;
639 def: F<"long-plt">;
640 def: F<"no-add-needed">;
641 def: F<"no-copy-dt-needed-entries">;
642 def: F<"no-ctors-in-init-array">;
643 def: F<"no-keep-memory">;
644 def: F<"no-pipeline-knowledge">;
645 def: F<"no-relax">;
646 def: F<"no-warn-mismatch">;
647 def: Flag<["-"], "p">;
648 def: Separate<["--", "-"], "rpath-link">;
649 def: J<"rpath-link=">;
650 def: F<"secure-plt">;
651 def: F<"sort-common">;
652 def: F<"stats">;
653 def: F<"warn-execstack">;
654 def: F<"warn-once">;
655 def: F<"warn-shared-textrel">;
656 def: F<"EB">;
657 def: F<"EL">;
658 def: JoinedOrSeparate<["-"], "G">;
659 def: F<"Qy">;
660
661 // Hidden option used for testing MIPS multi-GOT implementation.
662 defm mips_got_size:
663   Eq<"mips-got-size", "Max size of a single MIPS GOT. 0x10000 by default.">,
664   Flags<[HelpHidden]>;