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 be8: F<"be8">, HelpText<"write a Big Endian ELF file using BE8 format (AArch32 only)">;
  40
  41 def Bno_symbolic: F<"Bno-symbolic">, HelpText<"Don't bind default visibility defined symbols locally for -shared (default)">;
  42
  43 def Bsymbolic: F<"Bsymbolic">, HelpText<"Bind default visibility defined symbols locally for -shared">;
  44
  45 def Bsymbolic_non_weak: F<"Bsymbolic-non-weak">,
  46   HelpText<"Bind default visibility defined STB_GLOBAL symbols locally for -shared">;
  47
  48 def Bsymbolic_functions: F<"Bsymbolic-functions">,
  49   HelpText<"Bind default visibility defined function symbols locally for -shared">;
  50
  51 def Bsymbolic_non_weak_functions: F<"Bsymbolic-non-weak-functions">,
  52   HelpText<"Bind default visibility defined STB_GLOBAL function symbols locally for -shared">;
  53
  54 def Bdynamic: F<"Bdynamic">, HelpText<"Link against shared libraries (default)">;
  55
  56 def Bstatic: F<"Bstatic">, HelpText<"Do not link against shared libraries">;
  57
  58 def build_id: J<"build-id=">, HelpText<"Generate build ID note">,
  59   MetaVarName<"[fast,md5,sha1,uuid,0x<hexstring>]">;
  60 def : F<"build-id">, Alias<build_id>, AliasArgs<["sha1"]>, HelpText<"Alias for --build-id=sha1">;
  61
  62 defm check_sections: B<"check-sections",
  63     "Check section addresses for overlaps (default)",
  64     "Do not check section addresses for overlaps">;
  65
  66 defm compress_debug_sections:
  67   Eq<"compress-debug-sections", "Compress DWARF debug sections">,
  68   MetaVarName<"[none,zlib,zstd]">;
  69
  70 defm compress_sections: EEq<"compress-sections",
  71   "Compress output sections that match the glob and do not have the SHF_ALLOC flag. "
  72   "The sections remain uncompressed if compressed content would be larger. "
  73   "The compression level is <level> (if specified) or a default speed-focused level">,
  74   MetaVarName<"<section-glob>={none,zlib,zstd}[:level]">;
  75
  76 defm defsym: Eq<"defsym", "Define a symbol alias">, MetaVarName<"<symbol>=<value>">;
  77
  78 defm optimize_bb_jumps: BB<"optimize-bb-jumps",
  79     "Remove direct jumps at the end to the next basic block",
  80     "Do not remove any direct jumps at the end to the next basic block (default)">;
  81
  82 defm fortran_common : BB<"fortran-common",
  83     "Search archive members for definitions to override COMMON symbols (default)",
  84     "Do not search archive members for definitions to override COMMON symbols">;
  85
  86 defm split_stack_adjust_size
  87     : Eq<"split-stack-adjust-size",
  88          "Specify adjustment to stack size when a split-stack function calls a "
  89          "non-split-stack function">,
  90       MetaVarName<"<value>">;
  91
  92 def O: JoinedOrSeparate<["-"], "O">, HelpText<"Optimize output file size">;
  93
  94 def cmse_implib: FF<"cmse-implib">,
  95   HelpText<"Make the output library to be a CMSE secure code import library">;
  96
  97 defm in_implib: EEq<"in-implib",
  98     "Read an existing CMSE secure code import library and preserve entry function addresses in the "
  99     "resulting new CMSE secure code import library (optional when creating a CMSE secure image)">,
 100   MetaVarName<"<file>">;
 101
 102 defm out_implib: EEq<"out-implib",
 103     "Output the CMSE secure code import library to <file> (required when creating a CMSE secure image)">,
 104   MetaVarName<"<file>">;
 105
 106 defm Tbss: Eq<"Tbss", "Same as --section-start with .bss as the sectionname">;
 107
 108 defm Tdata: Eq<"Tdata", "Same as --section-start with .data as the sectionname">;
 109
 110 defm Ttext: Eq<"Ttext", "Same as --section-start with .text as the sectionname">;
 111
 112 def Ttext_segment: Separate<["-", "--"], "Ttext-segment">;
 113
 114 defm allow_multiple_definition: B<"allow-multiple-definition",
 115     "Allow multiple definitions",
 116     "Do not allow multiple definitions (default)">;
 117
 118 defm allow_shlib_undefined: B<"allow-shlib-undefined",
 119     "Allow unresolved references in shared libraries (default when linking a shared library)",
 120     "Do not allow unresolved references in shared libraries (default when linking an executable)">;
 121
 122 defm apply_dynamic_relocs: BB<"apply-dynamic-relocs",
 123     "Apply link-time values for dynamic relocations",
 124     "Do not apply link-time values for dynamic relocations (default)">;
 125
 126 defm dependent_libraries: BB<"dependent-libraries",
 127     "Process dependent library specifiers from input files (default)",
 128     "Ignore dependent library specifiers from input files">;
 129
 130 defm as_needed: B<"as-needed",
 131     "Only set DT_NEEDED for shared libraries if used",
 132     "Always set DT_NEEDED for shared libraries (default)">;
 133
 134 defm call_graph_ordering_file:
 135   Eq<"call-graph-ordering-file", "Layout sections to optimize the given callgraph">;
 136
 137 def call_graph_profile_sort: JJ<"call-graph-profile-sort=">,
 138   HelpText<"Reorder input sections with call graph profile using the specified algorithm (default: cdsort)">,
 139   MetaVarName<"[none,hfsort,cdsort]">,
 140   Values<"none,hfsort,cdsort">;
 141 def : FF<"no-call-graph-profile-sort">, Alias<call_graph_profile_sort>, AliasArgs<["none"]>,
 142   Flags<[HelpHidden]>;
 143
 144 // --chroot doesn't have a help text because it is an internal option.
 145 def chroot: Separate<["--"], "chroot">;
 146
 147 def color_diagnostics: JJ<"color-diagnostics=">,
 148   HelpText<"Use colors in diagnostics (default: auto)">,
 149   MetaVarName<"[auto,always,never]">;
 150 def : Flag<["--"], "color-diagnostics">, Alias<color_diagnostics>, AliasArgs<["always"]>,
 151   HelpText<"Alias for --color-diagnostics=always">;
 152 def : Flag<["--"], "no-color-diagnostics">, Alias<color_diagnostics>, AliasArgs<["never"]>,
 153   HelpText<"Alias for --color-diagnostics=never">;
 154
 155 def cref: FF<"cref">,
 156   HelpText<"Output cross reference table. If -Map is specified, print to the map file">;
 157
 158 defm debug_names: BB<"debug-names",
 159     "Generate a merged .debug_names section",
 160     "Do not generate a merged .debug_names section (default)">;
 161
 162 defm default_script: EEq<"default-script", "In the absence of --script, read this default linker script">;
 163
 164 defm demangle: B<"demangle",
 165     "Demangle symbol names (default)",
 166     "Do not demangle symbol names">;
 167
 168 defm dependency_file: EEq<"dependency-file", "Write a dependency file">,
 169   MetaVarName<"<file>">;
 170
 171 def disable_new_dtags: F<"disable-new-dtags">,
 172   HelpText<"Disable new dynamic tags">;
 173
 174 def discard_all: F<"discard-all">, HelpText<"Delete all local symbols">;
 175
 176 def discard_locals: F<"discard-locals">,
 177   HelpText<"Delete temporary local symbols">;
 178
 179 def discard_none: F<"discard-none">,
 180   HelpText<"Keep all symbols in the symbol table">;
 181
 182 defm dynamic_linker: Eq<"dynamic-linker", "Which dynamic linker to use">;
 183
 184 defm dynamic_list : Eq<"dynamic-list",
 185    "Similar to --export-dynamic-symbol-list. When creating a shared object, "
 186    "this additionally implies -Bsymbolic but does not set DF_SYMBOLIC">,
 187    MetaVarName<"<file>">;
 188
 189 def eb: F<"EB">, HelpText<"Select the big-endian format in OUTPUT_FORMAT">;
 190 def el: F<"EL">, HelpText<"Select the little-endian format in OUTPUT_FORMAT">;
 191
 192 defm eh_frame_hdr: B<"eh-frame-hdr",
 193     "Request creation of .eh_frame_hdr section and PT_GNU_EH_FRAME segment header",
 194     "Do not create .eh_frame_hdr section">;
 195
 196 def emit_relocs: F<"emit-relocs">, HelpText<"Generate relocations in output">;
 197
 198 def enable_new_dtags: F<"enable-new-dtags">,
 199   HelpText<"Enable new dynamic tags (default)">;
 200
 201 def enable_non_contiguous_regions : FF<"enable-non-contiguous-regions">,
 202   HelpText<"Spill input sections to later matching output sections to avoid memory region overflow">;
 203
 204 def end_group: F<"end-group">,
 205   HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
 206
 207 def end_lib: F<"end-lib">,
 208   HelpText<"End a grouping of objects that should be treated as if they were together in an archive">;
 209
 210 defm entry: Eq<"entry", "Name of entry point symbol">,
 211   MetaVarName<"<entry>">;
 212
 213 defm error_limit:
 214   EEq<"error-limit", "Maximum number of errors to emit before stopping (0 = no limit)">;
 215
 216 def error_unresolved_symbols: F<"error-unresolved-symbols">,
 217   HelpText<"Report unresolved symbols as errors">;
 218
 219 defm error_handling_script: EEq<"error-handling-script",
 220     "Specify an error handling script">;
 221
 222 defm exclude_libs: Eq<"exclude-libs", "Exclude static libraries from automatic export">;
 223
 224 defm execute_only: BB<"execute-only",
 225     "Mark executable sections unreadable",
 226     "Mark executable sections readable (default)">;
 227
 228 defm export_dynamic: B<"export-dynamic",
 229     "Put symbols in the dynamic symbol table",
 230     "Do not put symbols in the dynamic symbol table (default)">;
 231
 232 defm export_dynamic_symbol : EEq<"export-dynamic-symbol",
 233     "(executable) Put matched symbols in the dynamic symbol table. "
 234     "(shared object) References to matched non-local STV_DEFAULT symbols "
 235     "shouldn't be bound to definitions within the shared object. "
 236     "Does not imply -Bsymbolic.">,
 237     MetaVarName<"glob">;
 238
 239 defm export_dynamic_symbol_list : EEq<"export-dynamic-symbol-list",
 240    "Read a list of dynamic symbol patterns. Apply --export-dynamic-symbol on each pattern">,
 241     MetaVarName<"file">;
 242
 243 defm fatal_warnings: B<"fatal-warnings",
 244     "Treat warnings as errors",
 245     "Do not treat warnings as errors (default)">;
 246
 247 defm filter: Eq<"filter", "Set DT_FILTER field to the specified name">;
 248
 249 defm fini: Eq<"fini", "Specify a finalizer function">, MetaVarName<"<symbol>">;
 250
 251 def fix_cortex_a53_843419: F<"fix-cortex-a53-843419">,
 252   HelpText<"Apply fixes for AArch64 Cortex-A53 erratum 843419">;
 253
 254 def fix_cortex_a8: F<"fix-cortex-a8">,
 255   HelpText<"Apply fixes for ARM Cortex-A8 erratum 657417">;
 256
 257 def force_group_allocation: FF<"force-group-allocation">,
 258   HelpText<"Only meaningful for -r. Section groups are discarded. If two section group members are placed to the same output section, combine their relocations as well">;
 259
 260 defm format: Eq<"format", "Change the input format of the inputs following this option">,
 261   MetaVarName<"[default,elf,binary]">;
 262
 263 defm gc_sections: B<"gc-sections",
 264     "Enable garbage collection of unused sections",
 265     "Disable garbage collection of unused sections (default)">;
 266
 267 defm gdb_index: BB<"gdb-index",
 268     "Generate .gdb_index section",
 269     "Do not generate .gdb_index section (default)">;
 270
 271 defm gnu_unique: BB<"gnu-unique",
 272   "Enable STB_GNU_UNIQUE symbol binding (default)",
 273   "Disable STB_GNU_UNIQUE symbol binding">;
 274
 275 defm hash_style: Eq<"hash-style", "Specify hash style (sysv, gnu or both)">;
 276
 277 def help: F<"help">, HelpText<"Print option help">;
 278
 279 def icf_all: F<"icf=all">, HelpText<"Enable identical code folding">;
 280
 281 def icf_safe: F<"icf=safe">, HelpText<"Enable safe identical code folding">;
 282
 283 def icf_none: F<"icf=none">, HelpText<"Disable identical code folding (default)">;
 284
 285 def ignore_function_address_equality: FF<"ignore-function-address-equality">,
 286   HelpText<"lld can break the address equality of functions">;
 287
 288 def ignore_data_address_equality: FF<"ignore-data-address-equality">,
 289   HelpText<"lld can break the address equality of data">;
 290
 291 defm image_base: EEq<"image-base", "Set the base address">;
 292
 293 defm init: Eq<"init", "Specify an initializer function">,
 294   MetaVarName<"<symbol>">;
 295
 296 defm just_symbols: Eq<"just-symbols", "Just link symbols">;
 297
 298 defm keep_unique: Eq<"keep-unique", "Do not fold this symbol during ICF">;
 299
 300 def library: JoinedOrSeparate<["-"], "l">, MetaVarName<"<libname>">,
 301   HelpText<"Search for library <libname>">;
 302 def library_path: JoinedOrSeparate<["-"], "L">, MetaVarName<"<dir>">,
 303   HelpText<"Add <dir> to the library search path">;
 304
 305 def m: JoinedOrSeparate<["-"], "m">, HelpText<"Set target emulation">;
 306
 307 defm Map: Eq<"Map", "Print a link map to the specified file">;
 308
 309 defm merge_exidx_entries: B<"merge-exidx-entries",
 310     "Enable merging .ARM.exidx entries (default)",
 311     "Disable merging .ARM.exidx entries">;
 312
 313 defm mmap_output_file: BB<"mmap-output-file",
 314     "Mmap the output file for writing (default)",
 315     "Do not mmap the output file for writing">;
 316
 317 def nmagic: F<"nmagic">, MetaVarName<"<magic>">,
 318   HelpText<"Do not page align sections, link against static libraries.">;
 319
 320 def nostdlib: F<"nostdlib">,
 321   HelpText<"Only search directories specified on the command line">;
 322
 323 def no_dynamic_linker: F<"no-dynamic-linker">,
 324   HelpText<"Inhibit output of .interp section">;
 325
 326 def noinhibit_exec: F<"noinhibit-exec">,
 327   HelpText<"Retain the executable output file whenever it is still usable">;
 328
 329 def no_warn_mismatch: F<"no-warn-mismatch">,
 330   HelpText<"Suppress errors for certain unknown seciton types">;
 331
 332 def no_nmagic: F<"no-nmagic">, MetaVarName<"<magic>">,
 333   HelpText<"Page align sections (default)">;
 334
 335 def no_omagic: F<"no-omagic">, MetaVarName<"<magic>">,
 336   HelpText<"Do not set the text data sections to be writable, page align sections (default)">;
 337
 338 def no_undefined: F<"no-undefined">,
 339   HelpText<"Report unresolved symbols even if the linker is creating a shared library">;
 340
 341 def no_warnings: FF<"no-warnings">, HelpText<"Suppress warnings and cancel --fatal-warnings">;
 342 def : Flag<["-"], "w">, Alias<no_warnings>, HelpText<"Alias for --no-warnings">;
 343
 344 def o: JoinedOrSeparate<["-"], "o">, MetaVarName<"<path>">,
 345   HelpText<"Path to file to write output">;
 346
 347 defm oformat: EEq<"oformat", "Specify the binary format for the output object file">,
 348   MetaVarName<"[elf,binary]">;
 349
 350 def omagic: FF<"omagic">, MetaVarName<"<magic>">,
 351   HelpText<"Set the text and data sections to be readable and writable, do not page align sections, link against static libraries">;
 352
 353 defm orphan_handling:
 354   Eq<"orphan-handling", "Control how orphan sections are handled when linker script used">;
 355
 356 defm pack_dyn_relocs:
 357   EEq<"pack-dyn-relocs", "Pack dynamic relocations in the given format">,
 358   MetaVarName<"[none,android,relr,android+relr]">;
 359
 360 defm use_android_relr_tags: BB<"use-android-relr-tags",
 361     "Use SHT_ANDROID_RELR / DT_ANDROID_RELR* tags instead of SHT_RELR / DT_RELR*",
 362     "Use SHT_RELR / DT_RELR* tags (default)">;
 363
 364 def pic_veneer: F<"pic-veneer">,
 365   HelpText<"Always generate position independent thunks (veneers)">;
 366
 367 defm pie: B<"pie",
 368     "Create a position independent executable",
 369     "Do not create a position independent executable (default)">;
 370
 371 defm print_gc_sections: B<"print-gc-sections",
 372     "List removed unused sections",
 373     "Do not list removed unused sections (default)">;
 374
 375 defm print_icf_sections: B<"print-icf-sections",
 376     "List identical folded sections",
 377     "Do not list identical folded sections (default)">;
 378
 379 def print_archive_stats: J<"print-archive-stats=">,
 380   HelpText<"Write archive usage statistics to the specified file. "
 381            "Print the numbers of members and extracted members for each archive">;
 382
 383 defm print_symbol_order: Eq<"print-symbol-order",
 384   "Print a symbol order specified by --call-graph-ordering-file into the specified file">;
 385
 386 def pop_state: F<"pop-state">,
 387   HelpText<"Restore the states saved by --push-state">;
 388
 389 def push_state: F<"push-state">,
 390   HelpText<"Save the current state of --as-needed, -static and --whole-archive">;
 391
 392 def print_map: F<"print-map">,
 393   HelpText<"Print a link map to the standard output">;
 394
 395 def print_memory_usage: F<"print-memory-usage">,
 396   HelpText<"Report target memory usage">;
 397
 398 defm relax: BB<"relax",
 399   "Enable target-specific relaxations if supported (default)",
 400   "Disable target-specific relaxations">;
 401
 402 defm relax_gp: BB<"relax-gp",
 403   "Enable global pointer relaxation",
 404   "Disable global pointer relaxation (default)">;
 405
 406 defm remap_inputs: EEq<"remap-inputs",
 407   "Remap input files matching <from-glob> to <to-file>">,
 408   MetaVarName<"<from-glob>=<to-file>">;
 409
 410 def remap_inputs_file: JJ<"remap-inputs-file=">,
 411   HelpText<"Each line contains 'from-glob=to-file'. An input file matching <from-glob> is remapped to <to-file>">,
 412   MetaVarName<"<file>">;
 413
 414 defm reproduce:
 415   EEq<"reproduce",
 416      "Write tar file containing inputs and command to reproduce link">;
 417
 418 defm rosegment: BB<"rosegment",
 419   "Put read-only non-executable sections in their own segment (default)",
 420   "Do not put read-only non-executable sections in their own segment">;
 421
 422 defm rpath: Eq<"rpath", "Add a DT_RUNPATH to the output">;
 423
 424 def relocatable: F<"relocatable">, HelpText<"Create relocatable object file">;
 425
 426 defm retain_symbols_file:
 427   Eq<"retain-symbols-file", "Retain only the symbols listed in the file">,
 428   MetaVarName<"<file>">;
 429
 430 defm script: Eq<"script", "Read linker script">;
 431
 432 defm section_start: Eq<"section-start", "Set address of section">,
 433   MetaVarName<"<address>">;
 434
 435 def shared: F<"shared">, HelpText<"Build a shared object">;
 436
 437 defm soname: Eq<"soname", "Set DT_SONAME">;
 438
 439 defm sort_section:
 440   Eq<"sort-section", "Specifies sections sorting rule when linkerscript is used">;
 441
 442 def start_group: F<"start-group">,
 443   HelpText<"Ignored for compatibility with GNU unless you pass --warn-backrefs">;
 444
 445 def start_lib: F<"start-lib">,
 446   HelpText<"Start a grouping of objects that should be treated as if they were together in an archive">;
 447
 448 def strip_all: F<"strip-all">, HelpText<"Strip all symbols. Implies --strip-debug">;
 449
 450 def strip_debug: F<"strip-debug">, HelpText<"Strip debugging information">;
 451
 452 defm symbol_ordering_file:
 453   EEq<"symbol-ordering-file", "Layout sections to place symbols in the order specified by symbol ordering file">;
 454
 455 defm sysroot: Eq<"sysroot", "Set the system root">;
 456
 457 def target1_rel: F<"target1-rel">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_REL32">;
 458
 459 def target1_abs: F<"target1-abs">, HelpText<"Interpret R_ARM_TARGET1 as R_ARM_ABS32 (default)">;
 460
 461 defm target2:
 462   Eq<"target2", "Interpret R_ARM_TARGET2 as <type>, where <type> is one of rel, abs, or got-rel">,
 463   MetaVarName<"<type>">;
 464
 465 defm threads
 466     : EEq<"threads",
 467          "Number of threads. '1' disables multi-threading. By default all "
 468          "available hardware threads are used">;
 469
 470 def time_trace_eq: JJ<"time-trace=">, MetaVarName<"<file>">,
 471   HelpText<"Record time trace to <file>">;
 472 def : FF<"time-trace">, Alias<time_trace_eq>,
 473   HelpText<"Record time trace to file next to output">;
 474
 475 defm time_trace_granularity: EEq<"time-trace-granularity",
 476   "Minimum time granularity (in microseconds) traced by time profiler">;
 477
 478 defm toc_optimize : BB<"toc-optimize",
 479     "(PowerPC64) Enable TOC related optimizations (default)",
 480     "(PowerPC64) Disable TOC related optimizations">;
 481
 482 defm pcrel_optimize : BB<"pcrel-optimize",
 483     "(PowerPC64) Enable PC-relative optimizations (default)",
 484     "(PowerPC64) Disable PC-relative optimizations">;
 485
 486 def trace: F<"trace">, HelpText<"Print the names of the input files">;
 487
 488 defm trace_symbol: Eq<"trace-symbol", "Trace references to symbols">;
 489
 490 defm undefined: Eq<"undefined", "Force undefined symbol during linking">,
 491   MetaVarName<"<symbol>">;
 492
 493 defm undefined_glob: EEq<"undefined-glob", "Force undefined symbol during linking">,
 494   MetaVarName<"<pattern>">;
 495
 496 def unique: F<"unique">, HelpText<"Creates a separate output section for every orphan input section">;
 497
 498 defm unresolved_symbols:
 499   Eq<"unresolved-symbols", "Determine how to handle unresolved symbols">;
 500
 501 defm undefined_version: B<"undefined-version",
 502   "Allow unused version in version script (disabled by default)",
 503   "Report version scripts that refer undefined symbols">;
 504
 505 defm rsp_quoting: EEq<"rsp-quoting", "Quoting style for response files">,
 506   MetaVarName<"[posix,windows]">;
 507
 508 def v: Flag<["-"], "v">, HelpText<"Display the version number">;
 509
 510 def verbose: F<"verbose">, HelpText<"Verbose mode">;
 511
 512 def version: F<"version">, HelpText<"Display the version number and exit">;
 513
 514 def power10_stubs_eq: JJ<"power10-stubs=">, MetaVarName<"<mode>">,
 515   HelpText<"Whether to use Power10 instructions in call stubs for R_PPC64_REL24_NOTOC and TOC/NOTOC "
 516   "interworking (yes (default): use; no: don't use). \"auto\" is currently the same as \"yes\"">;
 517 def power10_stubs: FF<"power10-stubs">, Alias<power10_stubs_eq>, AliasArgs<["yes"]>,
 518   HelpText<"Alias for --power10-stubs=auto">;
 519 def no_power10_stubs: FF<"no-power10-stubs">, Alias<power10_stubs_eq>, AliasArgs<["no"]>,
 520   HelpText<"Alias for --power10-stubs=no">;
 521
 522 defm version_script: Eq<"version-script", "Read a version script">;
 523
 524 defm warn_backrefs: BB<"warn-backrefs",
 525     "Warn about backward symbol references to extract archive members",
 526     "Do not warn about backward symbol references to extract archive members (default)">;
 527
 528 defm warn_backrefs_exclude
 529     : EEq<"warn-backrefs-exclude",
 530          "Glob describing an archive (or an object file within --start-lib) "
 531          "which should be ignored for --warn-backrefs.">,
 532       MetaVarName<"<glob>">;
 533
 534 defm warn_common: B<"warn-common",
 535     "Warn about duplicate common symbols",
 536     "Do not warn about duplicate common symbols (default)">;
 537
 538 defm warn_ifunc_textrel: BB<"warn-ifunc-textrel",
 539     "Warn about using ifunc symbols with text relocations",
 540     "Do not warn about using ifunc symbols with text relocations (default)">;
 541
 542 defm warn_symbol_ordering: BB<"warn-symbol-ordering",
 543     "Warn about problems with the symbol ordering file (default)",
 544     "Do not warn about problems with the symbol ordering file">;
 545
 546 def warn_unresolved_symbols: F<"warn-unresolved-symbols">,
 547   HelpText<"Report unresolved symbols as warnings">;
 548
 549 defm whole_archive: B<"whole-archive",
 550     "Force load of all members in a static library",
 551     "Do not force load of all members in a static library (default)">;
 552
 553 def why_extract: JJ<"why-extract=">, HelpText<"Print to a file about why archive members are extracted">;
 554
 555 defm wrap : Eq<"wrap", "Redirect symbol references to __wrap_symbol and "
 556                        "__real_symbol references to symbol">,
 557             MetaVarName<"<symbol>">;
 558
 559 def z: JoinedOrSeparate<["-"], "z">, MetaVarName<"<option>">,
 560   HelpText<"Linker option extensions">;
 561
 562 def visual_studio_diagnostics_format : FF<"vs-diagnostics">,
 563 HelpText<"Format diagnostics for Visual Studio compatibility">;
 564
 565 def package_metadata: JJ<"package-metadata=">, HelpText<"Emit package metadata note">;
 566
 567 // Aliases
 568 def: Separate<["-"], "dT">, Alias<default_script>, HelpText<"Alias for --default-script">;
 569 def: Separate<["-"], "f">, Alias<auxiliary>, HelpText<"Alias for --auxiliary">;
 570 def: F<"call_shared">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
 571 def: F<"dy">, Alias<Bdynamic>, HelpText<"Alias for --Bdynamic">;
 572 def: F<"dn">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
 573 def: F<"non_shared">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
 574 def: F<"static">, Alias<Bstatic>, HelpText<"Alias for --Bstatic">;
 575 def: Flag<["-"], "x">, Alias<discard_all>, HelpText<"Alias for --discard-all">;
 576 def: Flag<["-"], "X">, Alias<discard_locals>, HelpText<"Alias for --discard-locals">;
 577 def: Flag<["-"], "q">, Alias<emit_relocs>, HelpText<"Alias for --emit-relocs">;
 578 def: Flag<["-"], ")">, Alias<end_group>, HelpText<"Alias for --end-group">;
 579 def: JoinedOrSeparate<["-"], "e">, Alias<entry>, HelpText<"Alias for --entry">;
 580 def: Flag<["-"], "E">, Alias<export_dynamic>, HelpText<"Alias for --export-dynamic">;
 581 def: Separate<["-"], "F">, Alias<filter>, HelpText<"Alias for --filter">;
 582 def: Separate<["-"], "b">, Alias<format>, HelpText<"Alias for --format">;
 583 def: Separate<["--", "-"], "library">, Alias<library>;
 584 def: Joined<["--", "-"], "library=">, Alias<library>;
 585 def: Separate<["--", "-"], "library-path">, Alias<library_path>;
 586 def: Joined<["--", "-"], "library-path=">, Alias<library_path>;
 587 def: Flag<["-"], "n">, Alias<nmagic>, HelpText<"Alias for --nmagic">;
 588 def: Flag<["-"], "N">, Alias<omagic>, HelpText<"Alias for --omagic">;
 589 def: Joined<["--"], "output=">, Alias<o>, HelpText<"Alias for -o">;
 590 def: Separate<["--"], "output">, Alias<o>, HelpText<"Alias for -o">;
 591 def: F<"pic-executable">, Alias<pie>, HelpText<"Alias for --pie">;
 592 def: Flag<["-"], "M">, Alias<print_map>, HelpText<"Alias for --print-map">;
 593 def: Flag<["-"], "r">, Alias<relocatable>, HelpText<"Alias for --relocatable">;
 594 def: JoinedOrSeparate<["-"], "R">, Alias<rpath>, HelpText<"Alias for --rpath">;
 595 def: JoinedOrSeparate<["-"], "T">, Alias<script>, HelpText<"Alias for --script">;
 596 def: F<"Bshareable">, Alias<shared>, HelpText<"Alias for --shared">;
 597 def: JoinedOrSeparate<["-"], "h">, Alias<soname>, HelpText<"Alias for --soname">;
 598 def: Flag<["-"], "(">, Alias<start_group>, HelpText<"Alias for --start-group">;
 599 def: Flag<["-"], "s">, Alias<strip_all>, HelpText<"Alias for --strip-all">;
 600 def: Flag<["-"], "S">, Alias<strip_debug>, HelpText<"Alias for --strip-debug">;
 601 def: Flag<["-"], "t">, Alias<trace>, HelpText<"Alias for --trace">;
 602 def: Joined<["-", "--"], "Ttext-segment=">, Alias<Ttext_segment>;
 603 def: JoinedOrSeparate<["-"], "y">, Alias<trace_symbol>, HelpText<"Alias for --trace-symbol">;
 604 def: JoinedOrSeparate<["-"], "u">, Alias<undefined>, HelpText<"Alias for --undefined">;
 605 def: Flag<["-"], "V">, Alias<v>, HelpText<"Alias for -v">;
 606
 607 // LTO-related options.
 608
 609 def lto: JJ<"lto=">, HelpText<"Set LTO backend">,
 610                  MetaVarName<"[full,thin]">;
 611 def lto_aa_pipeline: JJ<"lto-aa-pipeline=">,
 612   HelpText<"AA pipeline to run during LTO. Used in conjunction with -lto-newpm-passes">;
 613 def lto_debug_pass_manager: FF<"lto-debug-pass-manager">,
 614   HelpText<"Debug new pass manager">;
 615 def lto_emit_asm: FF<"lto-emit-asm">,
 616   HelpText<"Emit assembly code">;
 617 def lto_emit_llvm: FF<"lto-emit-llvm">,
 618   HelpText<"Emit LLVM-IR bitcode">;
 619 def lto_newpm_passes: JJ<"lto-newpm-passes=">,
 620   HelpText<"Passes to run during LTO">;
 621 def lto_O: JJ<"lto-O">, MetaVarName<"<opt-level>">,
 622   HelpText<"Optimization level for LTO">;
 623 def lto_CGO: JJ<"lto-CGO">, MetaVarName<"<cgopt-level>">,
 624   HelpText<"Codegen optimization level for LTO">;
 625 def lto_partitions: JJ<"lto-partitions=">,
 626   HelpText<"Number of LTO codegen partitions">;
 627 def lto_cs_profile_generate: FF<"lto-cs-profile-generate">,
 628   HelpText<"Perform context sensitive PGO instrumentation">;
 629 def lto_cs_profile_file: JJ<"lto-cs-profile-file=">,
 630   HelpText<"Context sensitive profile file path">;
 631 defm lto_pgo_warn_mismatch: BB<"lto-pgo-warn-mismatch",
 632   "turn on warnings about profile cfg mismatch (default)",
 633   "turn off warnings about profile cfg mismatch">;
 634 defm lto_known_safe_vtables : EEq<"lto-known-safe-vtables",
 635   "When --lto-validate-all-vtables-have-type-infos is enabled, skip validation on these vtables (_ZTV symbols)">;
 636 def lto_obj_path_eq: JJ<"lto-obj-path=">;
 637 def lto_sample_profile: JJ<"lto-sample-profile=">,
 638   HelpText<"Sample profile file path">;
 639 defm lto_validate_all_vtables_have_type_infos: BB<"lto-validate-all-vtables-have-type-infos",
 640   "Validate that all vtables have type infos for LTO link",
 641   "Do not validate that all vtables have type infos for LTO link">;
 642 defm lto_whole_program_visibility: BB<"lto-whole-program-visibility",
 643   "Asserts that the LTO link has whole program visibility",
 644   "Asserts that the LTO link does not have whole program visibility">;
 645 def disable_verify: F<"disable-verify">;
 646 defm mllvm: Eq<"mllvm", "Additional arguments to forward to LLVM's option processing">;
 647 def opt_remarks_filename: Separate<["--"], "opt-remarks-filename">,
 648   HelpText<"YAML output file for optimization remarks">;
 649 defm opt_remarks_hotness_threshold: EEq<"opt-remarks-hotness-threshold",
 650   "Minimum profile count required for an optimization remark to be output."
 651   " Use 'auto' to apply the threshold from profile summary.">,
 652   MetaVarName<"<value>">;
 653 def opt_remarks_passes: Separate<["--"], "opt-remarks-passes">,
 654   HelpText<"Regex for the passes that need to be serialized to the output file">;
 655 def opt_remarks_with_hotness: FF<"opt-remarks-with-hotness">,
 656   HelpText<"Include hotness information in the optimization remarks file">;
 657 def opt_remarks_format: Separate<["--"], "opt-remarks-format">,
 658   HelpText<"The format used for serializing remarks (default: YAML)">;
 659 def save_temps: F<"save-temps">, HelpText<"Save intermediate LTO compilation results">;
 660 def save_temps_eq: JJ<"save-temps=">, HelpText<"Save select intermediate LTO compilation results">,
 661   Values<"resolution,preopt,promote,internalize,import,opt,precodegen,prelink,combinedindex">;
 662 def lto_basic_block_sections: JJ<"lto-basic-block-sections=">,
 663   HelpText<"Enable basic block sections for LTO">;
 664 defm lto_basic_block_address_map: BB<"lto-basic-block-address-map",
 665   "Emit basic block address map for LTO",
 666   "Do not emit basic block address map for LTO (default)">;
 667 defm lto_unique_basic_block_section_names: BB<"lto-unique-basic-block-section-names",
 668     "Give unique names to every basic block section for LTO",
 669     "Do not give unique names to every basic block section for LTO (default)">;
 670 defm shuffle_sections: EEq<"shuffle-sections",
 671   "Shuffle matched sections using the given seed before mapping them to the output sections. "
 672   "If -1, reverse the section order. If 0, use a random seed">,
 673   MetaVarName<"<section-glob>=<seed>">;
 674 def thinlto_cache_dir: JJ<"thinlto-cache-dir=">,
 675   HelpText<"Path to ThinLTO cached object file directory">;
 676 defm thinlto_cache_policy: EEq<"thinlto-cache-policy", "Pruning policy for the ThinLTO cache">;
 677 def thinlto_emit_imports_files: FF<"thinlto-emit-imports-files">;
 678 def thinlto_emit_index_files: FF<"thinlto-emit-index-files">;
 679 def thinlto_index_only: FF<"thinlto-index-only">;
 680 def thinlto_index_only_eq: JJ<"thinlto-index-only=">;
 681 def thinlto_jobs_eq: JJ<"thinlto-jobs=">,
 682   HelpText<"Number of ThinLTO jobs. Default to --threads=">;
 683 def thinlto_object_suffix_replace_eq: JJ<"thinlto-object-suffix-replace=">;
 684 def thinlto_prefix_replace_eq: JJ<"thinlto-prefix-replace=">;
 685 def thinlto_single_module_eq: JJ<"thinlto-single-module=">,
 686   HelpText<"Specify a single module to compile in ThinLTO mode, for debugging only">;
 687
 688 defm fat_lto_objects: BB<"fat-lto-objects",
 689     "Use the .llvm.lto section, which contains LLVM bitcode, in fat LTO object files to perform LTO.",
 690     "Ignore the .llvm.lto section in relocatable object files (default).">;
 691
 692 def: J<"plugin-opt=O">, Alias<lto_O>, HelpText<"Alias for --lto-O">;
 693 def: F<"plugin-opt=debug-pass-manager">,
 694   Alias<lto_debug_pass_manager>, HelpText<"Alias for --lto-debug-pass-manager">;
 695 def: F<"plugin-opt=disable-verify">, Alias<disable_verify>, HelpText<"Alias for --disable-verify">;
 696 def plugin_opt_dwo_dir_eq: J<"plugin-opt=dwo_dir=">,
 697   HelpText<"Directory to store .dwo files when LTO and debug fission are used">;
 698 def plugin_opt_emit_asm: F<"plugin-opt=emit-asm">,
 699   Alias<lto_emit_asm>, HelpText<"Alias for --lto-emit-asm">;
 700 def plugin_opt_emit_llvm: F<"plugin-opt=emit-llvm">,
 701   Alias<lto_emit_llvm>, HelpText<"Alias for --lto-emit-llvm">;
 702 def: J<"plugin-opt=jobs=">, Alias<thinlto_jobs_eq>, HelpText<"Alias for --thinlto-jobs=">;
 703 def: J<"plugin-opt=lto-partitions=">, Alias<lto_partitions>, HelpText<"Alias for --lto-partitions">;
 704 def plugin_opt_mcpu_eq: J<"plugin-opt=mcpu=">;
 705 def: F<"plugin-opt=cs-profile-generate">,
 706   Alias<lto_cs_profile_generate>, HelpText<"Alias for --lto-cs-profile-generate">;
 707 def: J<"plugin-opt=cs-profile-path=">,
 708   Alias<lto_cs_profile_file>, HelpText<"Alias for --lto-cs-profile-file">;
 709 def: J<"plugin-opt=obj-path=">,
 710   Alias<lto_obj_path_eq>,
 711   HelpText<"Alias for --lto-obj-path=">;
 712 def: J<"plugin-opt=opt-remarks-filename=">,
 713   Alias<opt_remarks_filename>,
 714   HelpText<"Alias for --opt-remarks-filename">;
 715 def: J<"plugin-opt=opt-remarks-passes=">,
 716   Alias<opt_remarks_passes>,
 717   HelpText<"Alias for --opt-remarks-passes">;
 718 def: J<"plugin-opt=opt-remarks-format=">,
 719   Alias<opt_remarks_format>,
 720   HelpText<"Alias for --opt-remarks-format">;
 721 def: F<"plugin-opt=opt-remarks-with-hotness">,
 722   Alias<opt_remarks_with_hotness>,
 723   HelpText<"Alias for --opt-remarks-with_hotness">;
 724 def: J<"plugin-opt=opt-remarks-hotness-threshold=">,
 725   Alias<opt_remarks_hotness_threshold>,
 726   HelpText<"Alias for --opt-remarks-hotness-threshold">;
 727 def: J<"plugin-opt=sample-profile=">,
 728   Alias<lto_sample_profile>, HelpText<"Alias for --lto-sample-profile">;
 729 def: F<"plugin-opt=save-temps">, Alias<save_temps>, HelpText<"Alias for --save-temps">;
 730 def plugin_opt_stats_file: J<"plugin-opt=stats-file=">,
 731   HelpText<"Filename to write LTO statistics to">;
 732 def: F<"plugin-opt=thinlto-emit-imports-files">,
 733   Alias<thinlto_emit_imports_files>,
 734   HelpText<"Alias for --thinlto-emit-imports-files">;
 735 def: F<"plugin-opt=thinlto-index-only">,
 736   Alias<thinlto_index_only>,
 737   HelpText<"Alias for --thinlto-index-only">;
 738 def: J<"plugin-opt=thinlto-index-only=">,
 739   Alias<thinlto_index_only_eq>,
 740   HelpText<"Alias for --thinlto-index-only=">;
 741 def: J<"plugin-opt=thinlto-object-suffix-replace=">,
 742  Alias<thinlto_object_suffix_replace_eq>,
 743  HelpText<"Alias for --thinlto-object-suffix-replace=">;
 744 def: J<"plugin-opt=thinlto-prefix-replace=">,
 745   Alias<thinlto_prefix_replace_eq>,
 746   HelpText<"Alias for --thinlto-prefix-replace=">;
 747
 748 // Ignore LTO plugin-related options.
 749 // clang -flto passes -plugin and -plugin-opt to the linker. This is required
 750 // for ld.gold and ld.bfd to get LTO working. But it's not for lld which doesn't
 751 // rely on a plugin. Instead of detecting which linker is used on clang side we
 752 // just ignore the option on lld side as it's easier. In fact, the linker could
 753 // be called 'ld' and understanding which linker is used would require parsing of
 754 // --version output.
 755 defm plugin: Eq<"plugin", "Ignored for compatibility with GNU linkers">;
 756
 757 def plugin_opt_eq_minus: J<"plugin-opt=-">,
 758   HelpText<"Specify an LLVM option for compatibility with LLVMgold.so">;
 759 def: J<"plugin-opt=thinlto">;
 760
 761 // Ignore GCC collect2 LTO plugin related options. Note that we don't support
 762 // GCC LTO, but GCC collect2 passes these options even in non-LTO mode.
 763 def: J<"plugin-opt=-fresolution=">;
 764 def: J<"plugin-opt=-pass-through=">;
 765 // This may be either an unhandled LLVMgold.so feature or GCC passed
 766 // -plugin-opt=path/to/{liblto_plugin.so,lto-wrapper}
 767 def plugin_opt_eq : J<"plugin-opt=">;
 768
 769 // Options listed below are silently ignored for now for compatibility.
 770 def: Flag<["-"], "d">;
 771 def: Flag<["-"], "g">;
 772 def: F<"long-plt">;
 773 def: FF<"no-add-needed">;
 774 def: F<"no-copy-dt-needed-entries">;
 775 def: F<"no-ctors-in-init-array">;
 776 def: F<"no-keep-memory">;
 777 def: Separate<["--", "-"], "rpath-link">;
 778 def: J<"rpath-link=">;
 779 def: F<"secure-plt">;
 780 def: F<"sort-common">;
 781 def: F<"stats">;
 782 def: F<"warn-execstack">;
 783 def: F<"warn-once">;
 784 def: F<"warn-shared-textrel">;
 785 def: JoinedOrSeparate<["-"], "G">;
 786
 787 // Hidden option used for testing MIPS multi-GOT implementation.
 788 defm mips_got_size:
 789   Eq<"mips-got-size", "Max size of a single MIPS GOT. 0x10000 by default.">,
 790   Flags<[HelpHidden]>;
 791
 792 // Hidden option used to opt-in to additional output checks.
 793 defm check_dynamic_relocations: BB<"check-dynamic-relocations",
 794     "Perform additional validation of the written dynamic relocations",
 795     "Do not perform additional validation of the written dynamic relocations">,
 796   Flags<[HelpHidden]>;
 797
 798 defm load_pass_plugins: EEq<"load-pass-plugin", "Load passes from plugin library">;
 799
 800 // Hidden options, used by clang's -fsanitize=memtag-* options to emit an ELF
 801 // note to designate what kinds of memory (stack/heap) should be protected using
 802 // ARM's MTE on armv8.5+. A binary's desire for stack MTE can't be obtained
 803 // implicitly, so we have a specific bit in the note to signal to the loader to
 804 // remap the stack as PROT_MTE.
 805 defm android_memtag_stack: BB<"android-memtag-stack",
 806     "Instruct the dynamic loader to prepare for MTE stack instrumentation", "">;
 807 defm android_memtag_heap: BB<"android-memtag-heap",
 808     "Instruct the dynamic loader to enable MTE protection for the heap", "">;
 809 defm android_memtag_mode: EEq<"android-memtag-mode",
 810     "Instruct the dynamic loader to start under MTE mode {async, sync, none}">;