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