1 include "llvm/Option/OptParser.td"
3 // For options whose names are multiple letters, either one dash or
4 // two can precede the option name except those that start with 'o'.
5 class F<string name>: Flag<["--", "-"], name>;
6 class J<string name>: Joined<["--", "-"], name>;
8 multiclass Eq<string name, string help> {
9 def NAME: Separate<["--", "-"], name>;
10 def NAME # _eq: Joined<["--", "-"], name # "=">, Alias<!cast<Separate>(NAME)>,
14 multiclass B<string name, string help1, string help2> {
15 def NAME: Flag<["--", "-"], name>, HelpText<help1>;
16 def no_ # NAME: Flag<["--", "-"], "no-" # name>, HelpText<help2>;
19 defm auxiliary: Eq<"auxiliary", "Set DT_AUXILIARY field to the specified name">;
21 def Bsymbolic: F<"Bsymbolic">, HelpText<"Bind defined symbols locally">;
23 def Bsymbolic_functions: F<"Bsymbolic-functions">,
24 HelpText<"Bind defined function symbols locally">;
26 def Bdynamic: F<"Bdynamic">, HelpText<"Link against shared libraries (default)">;
28 def Bstatic: F<"Bstatic">, HelpText<"Do not link against shared libraries">;
30 def build_id: F<"build-id">, HelpText<"Alias for --build-id=fast">;
32 def build_id_eq: J<"build-id=">, HelpText<"Generate build ID note">,
33 MetaVarName<"[fast,md5,sha,uuid,0x<hexstring>]">;
35 defm check_sections: B<"check-sections",
36 "Check section addresses for overlaps (default)",
37 "Do not check section addresses for overlaps">;
39 defm compress_debug_sections:
40 Eq<"compress-debug-sections", "Compress DWARF debug sections">,
41 MetaVarName<"[none,zlib]">;
43 defm defsym: Eq<"defsym", "Define a symbol alias">, MetaVarName<"<symbol>=<value>">;
46 Eq<"library-path", "Add a directory to the library search path">, MetaVarName<"<dir>">;
48 def O: JoinedOrSeparate<["-"], "O">, HelpText<"Optimize output file size">;
50 defm Tbss: Eq<"Tbss", "Same as --section-start with .bss as the sectionname">;
52 defm Tdata: Eq<"Tdata", "Same as --section-start with .data as the sectionname">;
54 defm Ttext: Eq<"Ttext", "Same as --section-start with .text as the sectionname">;
56 defm allow_multiple_definition: B<"allow-multiple-definition",
57 "Allow multiple definitions",
58 "Do not allow multiple definitions (default)">;
60 defm apply_dynamic_relocs: B<"apply-dynamic-relocs",
61 "Apply dynamic relocations to place",
62 "Do not apply dynamic relocations to place">;
64 defm as_needed: B<"as-needed",
65 "Only set DT_NEEDED for shared libraries if used",
66 "Always set DT_NEEDED for shared libraries (default)">;
68 defm call_graph_ordering_file:
69 Eq<"call-graph-ordering-file", "Layout sections to optimize the given callgraph">;
71 // -chroot doesn't have a help text because it is an internal option.
72 def chroot: Separate<["--", "-"], "chroot">;
74 def color_diagnostics: F<"color-diagnostics">,
75 HelpText<"Alias for --color-diagnostics=always">;
77 def color_diagnostics_eq: J<"color-diagnostics=">,
78 HelpText<"Use colors in diagnostics">,
79 MetaVarName<"[auto,always,never]">;
82 "Output cross reference table",
83 "Do not output cross reference table">;
85 defm define_common: B<"define-common",
86 "Assign space to common symbols",
87 "Do not assign space to common symbols">;
89 defm demangle: B<"demangle",
90 "Demangle symbol names (default)",
91 "Do not demangle symbol names">;
93 def disable_new_dtags: F<"disable-new-dtags">,
94 HelpText<"Disable new dynamic tags">;
96 def discard_all: F<"discard-all">, HelpText<"Delete all local symbols">;
98 def discard_locals: F<"discard-locals">,
99 HelpText<"Delete temporary local symbols">;
101 def discard_none: F<"discard-none">,
102 HelpText<"Keep all symbols in the symbol table">;
104 defm dynamic_linker: Eq<"dynamic-linker", "Which dynamic linker to use">;
106 defm dynamic_list: Eq<"dynamic-list", "Read a list of dynamic symbols">;
108 defm eh_frame_hdr: B<"eh-frame-hdr",
109 "Request creation of .eh_frame_hdr section and PT_GNU_EH_FRAME segment header",
110 "Do not create .eh_frame_hdr section">;
112 def emit_relocs: F<"emit-relocs">, HelpText<"Generate relocations in output">;
114 def enable_new_dtags: F<"enable-new-dtags">,
115 HelpText<"Enable new dynamic tags (default)">;
117 def end_group: F<"end-group">,
118 HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
120 def end_lib: F<"end-lib">,
121 HelpText<"End a grouping of objects that should be treated as if they were together in an archive">;
123 defm entry: Eq<"entry", "Name of entry point symbol">,
124 MetaVarName<"<entry>">;
127 Eq<"error-limit", "Maximum number of errors to emit before stopping (0 = no limit)">;
129 def error_unresolved_symbols: F<"error-unresolved-symbols">,
130 HelpText<"Report unresolved symbols as errors">;
132 defm exclude_libs: Eq<"exclude-libs", "Exclude static libraries from automatic export">;
134 defm export_dynamic: B<"export-dynamic",
135 "Put symbols in the dynamic symbol table",
136 "Do not put symbols in the dynamic symbol table (default)">;
138 defm export_dynamic_symbol:
139 Eq<"export-dynamic-symbol", "Put a symbol in the dynamic symbol table">;
141 defm fatal_warnings: B<"fatal-warnings",
142 "Treat warnings as errors",
143 "Do not treat warnings as errors (default)">;
145 defm filter: Eq<"filter", "Set DT_FILTER field to the specified name">;
147 defm fini: Eq<"fini", "Specify a finalizer function">, MetaVarName<"<symbol>">;
149 def fix_cortex_a53_843419: F<"fix-cortex-a53-843419">,
150 HelpText<"Apply fixes for AArch64 Cortex-A53 erratum 843419">;
152 defm format: Eq<"format", "Change the input format of the inputs following this option">,
153 MetaVarName<"[default,elf,binary]">;
155 defm gc_sections: B<"gc-sections",
156 "Enable garbage collection of unused sections",
157 "Disable garbage collection of unused sections (default)">;
159 defm gdb_index: B<"gdb-index",
160 "Generate .gdb_index section",
161 "Do not generate .gdb_index section (default)">;
163 defm gnu_unique: B<"gnu-unique",
164 "Enable STB_GNU_UNIQUE symbol binding (default)",
165 "Disable STB_GNU_UNIQUE symbol binding">;
167 defm hash_style: Eq<"hash-style", "Specify hash style (sysv, gnu or both)">;
169 def help: F<"help">, HelpText<"Print option help">;
171 def icf_all: F<"icf=all">, HelpText<"Enable identical code folding">;
173 def icf_safe: F<"icf=safe">, HelpText<"Enable safe identical code folding">;
175 def icf_none: F<"icf=none">, HelpText<"Disable identical code folding (default)">;
177 def ignore_function_address_equality: F<"ignore-function-address-equality">,
178 HelpText<"lld can break the address equality of functions">;
180 def ignore_data_address_equality: F<"ignore-data-address-equality">,
181 HelpText<"lld can break the address equality of data">;
183 defm image_base: Eq<"image-base", "Set the base address">;
185 defm init: Eq<"init", "Specify an initializer function">,
186 MetaVarName<"<symbol>">;
188 defm just_symbols: Eq<"just-symbols", "Just link symbols">;
190 defm keep_unique: Eq<"keep-unique", "Do not fold this symbol during ICF">;
192 defm library: Eq<"library", "Root name of library to use">,
193 MetaVarName<"<libName>">;
195 def m: JoinedOrSeparate<["-"], "m">, HelpText<"Set target emulation">;
197 defm Map: Eq<"Map", "Print a link map to the specified file">;
199 defm merge_exidx_entries: B<"merge-exidx-entries",
200 "Enable merging .ARM.exidx entries (default)",
201 "Disable merging .ARM.exidx entries">;
203 def nostdlib: F<"nostdlib">,
204 HelpText<"Only search directories specified on the command line">;
206 def no_color_diagnostics: F<"no-color-diagnostics">,
207 HelpText<"Do not use colors in diagnostics">;
209 def no_dynamic_linker: F<"no-dynamic-linker">,
210 HelpText<"Inhibit output of .interp section">;
212 def noinhibit_exec: F<"noinhibit-exec">,
213 HelpText<"Retain the executable output file whenever it is still usable">;
215 def no_omagic: F<"no-omagic">, MetaVarName<"<magic>">,
216 HelpText<"Do not set the text data sections to be writable">;
218 def no_rosegment: F<"no-rosegment">,
219 HelpText<"Do not put read-only non-executable sections in their own segment">;
221 def no_undefined: F<"no-undefined">,
222 HelpText<"Report unresolved symbols even if the linker is creating a shared library">;
224 def o: JoinedOrSeparate<["-"], "o">, MetaVarName<"<path>">,
225 HelpText<"Path to file to write output">;
227 def oformat: Separate<["--"], "oformat">, MetaVarName<"<format>">,
228 HelpText<"Specify the binary format for the output object file">;
230 def omagic: Flag<["--"], "omagic">, MetaVarName<"<magic>">,
231 HelpText<"Set the text and data sections to be readable and writable">;
233 defm orphan_handling:
234 Eq<"orphan-handling", "Control how orphan sections are handled when linker script used">;
236 defm pack_dyn_relocs:
237 Eq<"pack-dyn-relocs", "Pack dynamic relocations in the given format">,
238 MetaVarName<"[none,android,relr,android+relr]">;
240 defm use_android_relr_tags: B<"use-android-relr-tags",
241 "Use SHT_ANDROID_RELR / DT_ANDROID_RELR* tags instead of SHT_RELR / DT_RELR*",
242 "Use SHT_RELR / DT_RELR* tags (default)">;
245 "Create a position independent executable",
246 "Do not create a position independent executable (default)">;
248 defm print_gc_sections: B<"print-gc-sections",
249 "List removed unused sections",
250 "Do not list removed unused sections (default)">;
252 defm print_icf_sections: B<"print-icf-sections",
253 "List identical folded sections",
254 "Do not list identical folded sections (default)">;
256 def pop_state: F<"pop-state">,
257 HelpText<"Undo the effect of -push-state">;
259 def push_state: F<"push-state">,
260 HelpText<"Save the current state of -as-needed, -static and -whole-archive">;
262 def print_map: F<"print-map">,
263 HelpText<"Print a link map to the standard output">;
265 defm reproduce: Eq<"reproduce", "Dump linker invocation and input files for debugging">;
267 defm rpath: Eq<"rpath", "Add a DT_RUNPATH to the output">;
269 def relocatable: F<"relocatable">, HelpText<"Create relocatable object file">;
271 defm retain_symbols_file:
272 Eq<"retain-symbols-file", "Retain only the symbols listed in the file">,
273 MetaVarName<"<file>">;
275 defm script: Eq<"script", "Read linker script">;
277 defm section_start: Eq<"section-start", "Set address of section">,
278 MetaVarName<"<address>">;
280 def shared: F<"shared">, HelpText<"Build a shared object">;
282 defm soname: Eq<"soname", "Set DT_SONAME">;
285 Eq<"sort-section", "Specifies sections sorting rule when linkerscript is used">;
287 def start_group: F<"start-group">,
288 HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
290 def start_lib: F<"start-lib">,
291 HelpText<"Start a grouping of objects that should be treated as if they were together in an archive">;
293 def strip_all: F<"strip-all">, HelpText<"Strip all symbols">;
295 def strip_debug: F<"strip-debug">, HelpText<"Strip debugging information">;
297 defm symbol_ordering_file:
298 Eq<"symbol-ordering-file", "Layout sections to place symbols in the order specified by symbol ordering file">;
300 defm sysroot: Eq<"sysroot", "Set the system root">;
302 def target1_rel: F<"target1-rel">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_REL32">;
304 def target1_abs: F<"target1-abs">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_ABS32 (default)">;
307 Eq<"target2", "Interpret R_ARM_TARGET2 as <type>, where <type> is one of rel, abs, or got-rel">,
308 MetaVarName<"<type>">;
310 defm threads: B<"threads",
311 "Run the linker multi-threaded (default)",
312 "Do not run the linker multi-threaded">;
314 def trace: F<"trace">, HelpText<"Print the names of the input files">;
316 defm trace_symbol: Eq<"trace-symbol", "Trace references to symbols">;
318 defm undefined: Eq<"undefined", "Force undefined symbol during linking">,
319 MetaVarName<"<symbol>">;
321 defm unresolved_symbols:
322 Eq<"unresolved-symbols", "Determine how to handle unresolved symbols">;
324 defm undefined_version: B<"undefined-version",
325 "Allow unused version in version script (default)",
326 "Report version scripts that refer undefined symbols">;
328 defm rsp_quoting: Eq<"rsp-quoting", "Quoting style for response files">,
329 MetaVarName<"[posix,windows]">;
331 def v: Flag<["-"], "v">, HelpText<"Display the version number">;
333 def verbose: F<"verbose">, HelpText<"Verbose mode">;
335 def version: F<"version">, HelpText<"Display the version number and exit">;
337 defm version_script: Eq<"version-script", "Read a version script">;
339 defm warn_backrefs: B<"warn-backrefs",
340 "Warn about backward symbol references to fetch archive members",
341 "Do not warn about backward symbol references to fetch archive members (default)">;
343 defm warn_common: B<"warn-common",
344 "Warn about duplicate common symbols",
345 "Do not warn about duplicate common symbols (default)">;
347 defm warn_symbol_ordering: B<"warn-symbol-ordering",
348 "Warn about problems with the symbol ordering file (default)",
349 "Do not warn about problems with the symbol ordering file">;
351 def warn_unresolved_symbols: F<"warn-unresolved-symbols">,
352 HelpText<"Report unresolved symbols as warnings">;
354 defm whole_archive: B<"whole-archive",
355 "Force load of all members in a static library",
356 "Do not force load of all members in a static library (default)">;
358 defm wrap: Eq<"wrap", "Use wrapper functions for symbol">,
359 MetaVarName<"<symbol>=<symbol>">;
361 def z: JoinedOrSeparate<["-"], "z">, MetaVarName<"<option>">,
362 HelpText<"Linker option extensions">;
365 def: Separate<["-"], "f">, Alias<auxiliary>, HelpText<"Alias for --auxiliary">;
366 def: F<"call_shared">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
367 def: F<"dy">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
368 def: F<"dn">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
369 def: F<"non_shared">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
370 def: F<"static">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
371 def: Flag<["-"], "d">, Alias<define_common>, HelpText<"Alias for --define-common">;
372 def: F<"dc">, Alias<define_common>, HelpText<"Alias for --define-common">;
373 def: F<"dp">, Alias<define_common>, HelpText<"Alias for --define-common">;
374 def: Flag<["-"], "x">, Alias<discard_all>, HelpText<"Alias for --discard-all">;
375 def: Flag<["-"], "X">, Alias<discard_locals>, HelpText<"Alias for --discard-locals">;
376 def: Flag<["-"], "q">, Alias<emit_relocs>, HelpText<"Alias for --emit-relocs">;
377 def: Flag<["-"], ")">, Alias<end_group>, HelpText<"Alias for --end-group">;
378 def: JoinedOrSeparate<["-"], "e">, Alias<entry>, HelpText<"Alias for --entry">;
379 def: Flag<["-"], "E">, Alias<export_dynamic>, HelpText<"Alias for --export-dynamic">;
380 def: Separate<["-"], "F">, Alias<filter>, HelpText<"Alias for --filter">;
381 def: Separate<["-"], "b">, Alias<format>, HelpText<"Alias for --format">;
382 def: JoinedOrSeparate<["-"], "l">, Alias<library>, HelpText<"Alias for --library">;
383 def: JoinedOrSeparate<["-"], "L">, Alias<library_path>, HelpText<"Alias for --library-path">;
384 def: F<"no-pic-executable">, Alias<no_pie>, HelpText<"Alias for --no-pie">;
385 def: Flag<["-"], "N">, Alias<omagic>, HelpText<"Alias for --omagic">;
386 def: Joined<["--"], "output=">, Alias<o>, HelpText<"Alias for -o">;
387 def: Separate<["--"], "output">, Alias<o>, HelpText<"Alias for -o">;
388 def: F<"pic-executable">, Alias<pie>, HelpText<"Alias for --pie">;
389 def: Flag<["-"], "M">, Alias<print_map>, HelpText<"Alias for --print-map">;
390 def: Flag<["-"], "r">, Alias<relocatable>, HelpText<"Alias for --relocatable">;
391 def: JoinedOrSeparate<["-"], "R">, Alias<rpath>, HelpText<"Alias for --rpath">;
392 def: JoinedOrSeparate<["-"], "T">, Alias<script>, HelpText<"Alias for --script">;
393 def: F<"Bshareable">, Alias<shared>, HelpText<"Alias for --shared">;
394 def: JoinedOrSeparate<["-"], "h">, Alias<soname>, HelpText<"Alias for --soname">;
395 def: Flag<["-"], "(">, Alias<start_group>, HelpText<"Alias for --start-group">;
396 def: Flag<["-"], "s">, Alias<strip_all>, HelpText<"Alias for --strip-all">;
397 def: Flag<["-"], "S">, Alias<strip_debug>, HelpText<"Alias for --strip-debug">;
398 def: Flag<["-"], "t">, Alias<trace>, HelpText<"Alias for --trace">;
399 def: JoinedOrSeparate<["-"], "y">, Alias<trace_symbol>, HelpText<"Alias for --trace-symbol">;
400 def: Separate<["-", "--"], "Ttext-segment">, Alias<Ttext>, HelpText<"Alias for --Ttext">;
401 def: Joined<["-", "--"], "Ttext-segment=">, Alias<Ttext>, HelpText<"Alias for --Ttext">;
402 def: JoinedOrSeparate<["-"], "u">, Alias<undefined>, HelpText<"Alias for --undefined">;
403 def: Flag<["-"], "V">, Alias<version>, HelpText<"Alias for --version">;
405 // LTO-related options.
406 def lto_aa_pipeline: J<"lto-aa-pipeline=">,
407 HelpText<"AA pipeline to run during LTO. Used in conjunction with -lto-newpm-passes">;
408 def lto_debug_pass_manager: F<"lto-debug-pass-manager">,
409 HelpText<"Debug new pass manager">;
410 def lto_new_pass_manager: F<"lto-new-pass-manager">,
411 HelpText<"Use new pass manager">;
412 def lto_newpm_passes: J<"lto-newpm-passes=">,
413 HelpText<"Passes to run during LTO">;
414 def lto_O: J<"lto-O">, MetaVarName<"<opt-level>">,
415 HelpText<"Optimization level for LTO">;
416 def lto_partitions: J<"lto-partitions=">,
417 HelpText<"Number of LTO codegen partitions">;
418 def lto_sample_profile: J<"lto-sample-profile=">,
419 HelpText<"Sample profile file path">;
420 def disable_verify: F<"disable-verify">;
421 defm mllvm: Eq<"mllvm", "Additional arguments to forward to LLVM's option processing">;
422 def opt_remarks_filename: Separate<["--"], "opt-remarks-filename">,
423 HelpText<"YAML output file for optimization remarks">;
424 def opt_remarks_with_hotness: Flag<["--"], "opt-remarks-with-hotness">,
425 HelpText<"Include hotness information in the optimization remarks file">;
426 defm plugin_opt: Eq<"plugin-opt", "specifies LTO options for compatibility with GNU linkers">;
427 def save_temps: F<"save-temps">;
428 def thinlto_cache_dir: J<"thinlto-cache-dir=">,
429 HelpText<"Path to ThinLTO cached object file directory">;
430 defm thinlto_cache_policy: Eq<"thinlto-cache-policy", "Pruning policy for the ThinLTO cache">;
431 def thinlto_jobs: J<"thinlto-jobs=">, HelpText<"Number of ThinLTO jobs">;
433 def: J<"plugin-opt=O">, Alias<lto_O>, HelpText<"Alias for -lto-O">;
434 def: F<"plugin-opt=debug-pass-manager">,
435 Alias<lto_debug_pass_manager>, HelpText<"Alias for -lto-debug-pass-manager">;
436 def: F<"plugin-opt=disable-verify">, Alias<disable_verify>, HelpText<"Alias for -disable-verify">;
437 def plugin_opt_dwo_dir_eq: J<"plugin-opt=dwo_dir=">,
438 HelpText<"Directory to store .dwo files when LTO and debug fission are used">;
439 def: J<"plugin-opt=jobs=">, Alias<thinlto_jobs>, HelpText<"Alias for -thinlto-jobs">;
440 def: J<"plugin-opt=lto-partitions=">, Alias<lto_partitions>, HelpText<"Alias for -lto-partitions">;
441 def plugin_opt_mcpu_eq: J<"plugin-opt=mcpu=">;
442 def: F<"plugin-opt=new-pass-manager">,
443 Alias<lto_new_pass_manager>, HelpText<"Alias for -lto-new-pass-manager">;
444 def plugin_opt_obj_path_eq: J<"plugin-opt=obj-path=">;
445 def: J<"plugin-opt=sample-profile=">,
446 Alias<lto_sample_profile>, HelpText<"Alias for -lto-sample-profile">;
447 def: F<"plugin-opt=save-temps">, Alias<save_temps>, HelpText<"Alias for -save-temps">;
448 def plugin_opt_thinlto_emit_imports_files: F<"plugin-opt=thinlto-emit-imports-files">;
449 def plugin_opt_thinlto_index_only: F<"plugin-opt=thinlto-index-only">;
450 def plugin_opt_thinlto_index_only_eq: J<"plugin-opt=thinlto-index-only=">;
451 def plugin_opt_thinlto_object_suffix_replace_eq: J<"plugin-opt=thinlto-object-suffix-replace=">;
452 def plugin_opt_thinlto_prefix_replace_eq: J<"plugin-opt=thinlto-prefix-replace=">;
454 // Ignore LTO plugin-related options.
455 // clang -flto passes -plugin and -plugin-opt to the linker. This is required
456 // for ld.gold and ld.bfd to get LTO working. But it's not for lld which doesn't
457 // rely on a plugin. Instead of detecting which linker is used on clang side we
458 // just ignore the option on lld side as it's easier. In fact, the linker could
459 // be called 'ld' and understanding which linker is used would require parsing of
461 defm plugin: Eq<"plugin", "Ignored for compatibility with GNU linkers">;
463 def plugin_opt_fresolution_eq: J<"plugin-opt=-fresolution=">;
464 def plugin_opt_pass_through_eq: J<"plugin-opt=-pass-through=">;
465 def plugin_opt_thinlto: J<"plugin-opt=thinlto">;
466 def plugin_opt_slash: J<"plugin-opt=/">;
468 // Options listed below are silently ignored for now for compatibility.
469 def: F<"allow-shlib-undefined">;
470 def: F<"detect-odr-violations">;
471 def: Flag<["-"], "g">;
473 def: F<"no-add-needed">;
474 def: F<"no-allow-shlib-undefined">;
475 def: F<"no-copy-dt-needed-entries">;
476 def: F<"no-ctors-in-init-array">;
477 def: F<"no-keep-memory">;
478 def: F<"no-mmap-output-file">;
479 def: F<"no-warn-mismatch">;
480 def: Separate<["--", "-"], "rpath-link">;
481 def: J<"rpath-link=">;
482 def: F<"sort-common">;
484 def: F<"warn-execstack">;
486 def: F<"warn-shared-textrel">;
489 def: JoinedOrSeparate<["-"], "G">;
492 // Hidden option used for testing MIPS multi-GOT implementation.
494 Eq<"mips-got-size", "Max size of a single MIPS GOT. 0x10000 by default.">,