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