contrib/llvm-project/llvm/tools/llvm-objcopy/ObjcopyOpts.td

   1 include "llvm/Option/OptParser.td"
   2
   3 multiclass Eq<string name, string help> {
   4   def NAME : Separate<["--"], name>;
   5   def NAME #_eq : Joined<["--"], name #"=">,
   6                   Alias<!cast<Separate>(NAME)>,
   7                   HelpText<help>;
   8 }
   9
  10 def help : Flag<["--"], "help">;
  11 def h : Flag<["-"], "h">, Alias<help>;
  12
  13 def allow_broken_links
  14     : Flag<["--"], "allow-broken-links">,
  15       HelpText<"Allow llvm-objcopy to remove sections even if it would leave "
  16                "invalid section references. The appropriate sh_link fields "
  17                "will be set to zero.">;
  18
  19 defm binary_architecture
  20     : Eq<"binary-architecture", "Used when transforming an architecture-less "
  21                                 "format (such as binary) to another format">;
  22 def B : JoinedOrSeparate<["-"], "B">, Alias<binary_architecture>;
  23
  24 defm target : Eq<"target", "Format of the input and output file">,
  25               Values<"binary">;
  26 def F : JoinedOrSeparate<["-"], "F">, Alias<target>;
  27
  28 defm input_target : Eq<"input-target", "Format of the input file">,
  29                     Values<"binary">;
  30 def I : JoinedOrSeparate<["-"], "I">, Alias<input_target>;
  31
  32 defm output_target : Eq<"output-target", "Format of the output file">,
  33                      Values<"binary">;
  34 def O : JoinedOrSeparate<["-"], "O">, Alias<output_target>;
  35
  36 def compress_debug_sections : Flag<["--"], "compress-debug-sections">;
  37 def compress_debug_sections_eq
  38     : Joined<["--"], "compress-debug-sections=">,
  39       MetaVarName<"[ zlib | zlib-gnu ]">,
  40       HelpText<"Compress DWARF debug sections using specified style. Supported "
  41                "styles: 'zlib-gnu' and 'zlib'">;
  42 def decompress_debug_sections : Flag<["--"], "decompress-debug-sections">,
  43                                 HelpText<"Decompress DWARF debug sections.">;
  44 defm split_dwo
  45     : Eq<"split-dwo", "Equivalent to extract-dwo on the input file to "
  46                       "<dwo-file>, then strip-dwo on the input file">,
  47       MetaVarName<"dwo-file">;
  48
  49 def enable_deterministic_archives
  50     : Flag<["--"], "enable-deterministic-archives">,
  51       HelpText<"Enable deterministic mode when copying archives (use zero for "
  52                "UIDs, GIDs, and timestamps).">;
  53 def D : Flag<["-"], "D">,
  54         Alias<enable_deterministic_archives>,
  55         HelpText<"Alias for --enable-deterministic-archives">;
  56
  57 def disable_deterministic_archives
  58     : Flag<["--"], "disable-deterministic-archives">,
  59       HelpText<"Disable deterministic mode when copying archives (use real "
  60                "values for UIDs, GIDs, and timestamps).">;
  61 def U : Flag<["-"], "U">,
  62         Alias<disable_deterministic_archives>,
  63         HelpText<"Alias for --disable-deterministic-archives">;
  64
  65 def preserve_dates : Flag<["--"], "preserve-dates">,
  66                      HelpText<"Preserve access and modification timestamps">;
  67 def p : Flag<["-"], "p">, Alias<preserve_dates>;
  68
  69 defm add_gnu_debuglink
  70     : Eq<"add-gnu-debuglink", "Add a .gnu_debuglink for <debug-file>">,
  71       MetaVarName<"debug-file">;
  72
  73 defm remove_section : Eq<"remove-section", "Remove <section>">,
  74                       MetaVarName<"section">;
  75 def R : JoinedOrSeparate<["-"], "R">, Alias<remove_section>;
  76
  77 defm rename_section
  78     : Eq<"rename-section",
  79          "Renames a section from old to new, optionally with specified flags. "
  80          "Flags supported for GNU compatibility: alloc, load, noload, "
  81          "readonly, debug, code, data, rom, share, contents, merge, strings.">,
  82       MetaVarName<"old=new[,flag1,...]">;
  83 defm redefine_symbol
  84     : Eq<"redefine-sym", "Change the name of a symbol old to new">,
  85       MetaVarName<"old=new">;
  86 defm redefine_symbols
  87     : Eq<"redefine-syms",
  88          "Reads a list of symbol pairs from <filename> and runs as if "
  89          "--redefine-sym=<old>=<new> is set for each one. <filename> "
  90          "contains two symbols per line separated with whitespace and may "
  91          "contain comments beginning with '#'. Leading and trailing "
  92          "whitespace is stripped from each line. May be repeated to read "
  93          "symbols from many files.">,
  94       MetaVarName<"filename">;
  95
  96 defm keep_section : Eq<"keep-section", "Keep <section>">,
  97                     MetaVarName<"section">;
  98 defm only_section : Eq<"only-section", "Remove all but <section>">,
  99                     MetaVarName<"section">;
 100 def j : JoinedOrSeparate<["-"], "j">, Alias<only_section>;
 101 defm add_section
 102     : Eq<"add-section",
 103          "Make a section named <section> with the contents of <file>.">,
 104       MetaVarName<"section=file">;
 105
 106 defm set_section_flags
 107     : Eq<"set-section-flags",
 108          "Set section flags for a given section. Flags supported for GNU "
 109          "compatibility: alloc, load, noload, readonly, debug, code, data, "
 110          "rom, share, contents, merge, strings.">,
 111       MetaVarName<"section=flag1[,flag2,...]">;
 112
 113 def strip_all : Flag<["--"], "strip-all">,
 114                 HelpText<"Remove non-allocated sections outside segments. "
 115                          ".gnu.warning* and .ARM.attribute sections are not "
 116                          "removed">;
 117 def S : Flag<["-"], "S">, Alias<strip_all>;
 118 def strip_all_gnu : Flag<["--"], "strip-all-gnu">,
 119                     HelpText<"Compatible with GNU objcopy's --strip-all">;
 120 def strip_debug : Flag<["--"], "strip-debug">,
 121                   HelpText<"Remove all debug information">;
 122 def g : Flag<["-"], "g">, Alias<strip_debug>,
 123         HelpText<"Alias for --strip-debug">;
 124 def strip_dwo : Flag<["--"], "strip-dwo">,
 125                 HelpText<"Remove all DWARF .dwo sections from file">;
 126 def strip_sections
 127     : Flag<["--"], "strip-sections">,
 128       HelpText<"Remove all section headers and all sections not in segments">;
 129 def strip_non_alloc
 130     : Flag<["--"], "strip-non-alloc">,
 131       HelpText<"Remove all non-allocated sections outside segments">;
 132 def strip_unneeded : Flag<["--"], "strip-unneeded">,
 133                      HelpText<"Remove all symbols not needed by relocations">;
 134 defm strip_unneeded_symbol
 135     : Eq<"strip-unneeded-symbol",
 136          "Remove symbol <symbol> if it is not needed by relocations">,
 137       MetaVarName<"symbol">;
 138 defm strip_unneeded_symbols
 139     : Eq<"strip-unneeded-symbols",
 140          "Reads a list of symbols from <filename> and removes them "
 141          "if they are not needed by relocations">,
 142       MetaVarName<"filename">;
 143
 144 def extract_dwo
 145     : Flag<["--"], "extract-dwo">,
 146       HelpText<
 147           "Remove all sections that are not DWARF .dwo sections from file">;
 148
 149 defm extract_partition
 150     : Eq<"extract-partition", "Extract named partition from input file">,
 151       MetaVarName<"name">;
 152 def extract_main_partition
 153     : Flag<["--"], "extract-main-partition">,
 154       HelpText<"Extract main partition from the input file">;
 155
 156 def localize_hidden
 157     : Flag<["--"], "localize-hidden">,
 158       HelpText<
 159           "Mark all symbols that have hidden or internal visibility as local">;
 160 defm localize_symbol : Eq<"localize-symbol", "Mark <symbol> as local">,
 161                        MetaVarName<"symbol">;
 162 defm localize_symbols
 163     : Eq<"localize-symbols",
 164          "Reads a list of symbols from <filename> and marks them local.">,
 165       MetaVarName<"filename">;
 166
 167 def L : JoinedOrSeparate<["-"], "L">, Alias<localize_symbol>;
 168
 169 defm globalize_symbol : Eq<"globalize-symbol", "Mark <symbol> as global">,
 170                         MetaVarName<"symbol">;
 171
 172 defm globalize_symbols
 173     : Eq<"globalize-symbols",
 174          "Reads a list of symbols from <filename> and marks them global.">,
 175       MetaVarName<"filename">;
 176
 177 defm keep_global_symbol
 178     : Eq<"keep-global-symbol",
 179          "Convert all symbols except <symbol> to local. May be repeated to "
 180          "convert all except a set of symbols to local.">,
 181       MetaVarName<"symbol">;
 182 def G : JoinedOrSeparate<["-"], "G">, Alias<keep_global_symbol>;
 183
 184 defm keep_global_symbols
 185     : Eq<"keep-global-symbols",
 186          "Reads a list of symbols from <filename> and runs as if "
 187          "--keep-global-symbol=<symbol> is set for each one. <filename> "
 188          "contains one symbol per line and may contain comments beginning with "
 189          "'#'. Leading and trailing whitespace is stripped from each line. May "
 190          "be repeated to read symbols from many files.">,
 191       MetaVarName<"filename">;
 192
 193 defm weaken_symbol : Eq<"weaken-symbol", "Mark <symbol> as weak">,
 194                      MetaVarName<"symbol">;
 195 defm weaken_symbols
 196     : Eq<"weaken-symbols",
 197          "Reads a list of symbols from <filename> and marks them weak.">,
 198       MetaVarName<"filename">;
 199
 200 def W : JoinedOrSeparate<["-"], "W">, Alias<weaken_symbol>;
 201 def weaken : Flag<["--"], "weaken">,
 202              HelpText<"Mark all global symbols as weak">;
 203
 204 def discard_locals : Flag<["--"], "discard-locals">,
 205                      HelpText<"Remove compiler-generated local symbols, (e.g. "
 206                               "symbols starting with .L)">;
 207 def X : Flag<["-"], "X">, Alias<discard_locals>;
 208
 209 def discard_all
 210     : Flag<["--"], "discard-all">,
 211       HelpText<"Remove all local symbols except file and section symbols">;
 212 def x : Flag<["-"], "x">, Alias<discard_all>;
 213 defm strip_symbol : Eq<"strip-symbol", "Remove symbol <symbol>">,
 214                     MetaVarName<"symbol">;
 215 defm strip_symbols
 216     : Eq<"strip-symbols",
 217          "Reads a list of symbols from <filename> and removes them.">,
 218       MetaVarName<"filename">;
 219
 220 def N : JoinedOrSeparate<["-"], "N">, Alias<strip_symbol>;
 221 defm keep_symbol : Eq<"keep-symbol", "Do not remove symbol <symbol>">,
 222                    MetaVarName<"symbol">;
 223 def K : JoinedOrSeparate<["-"], "K">, Alias<keep_symbol>;
 224
 225 defm keep_symbols
 226     : Eq<"keep-symbols",
 227          "Reads a list of symbols from <filename> and runs as if "
 228          "--keep-symbol=<symbol> is set for each one. <filename> "
 229          "contains one symbol per line and may contain comments beginning with "
 230          "'#'. Leading and trailing whitespace is stripped from each line. May "
 231          "be repeated to read symbols from many files.">,
 232       MetaVarName<"filename">;
 233
 234 def only_keep_debug
 235     : Flag<["--"], "only-keep-debug">,
 236       HelpText<"Clear sections that would not be stripped by --strip-debug. "
 237                "Currently only implemented for COFF.">;
 238
 239 def keep_file_symbols : Flag<["--"], "keep-file-symbols">,
 240                         HelpText<"Do not remove file symbols">;
 241 defm dump_section
 242     : Eq<"dump-section",
 243          "Dump contents of section named <section> into file <file>">,
 244       MetaVarName<"section=file">;
 245 defm prefix_symbols
 246     : Eq<"prefix-symbols", "Add <prefix> to the start of every symbol name">,
 247       MetaVarName<"prefix">;
 248
 249 defm prefix_alloc_sections
 250     : Eq<"prefix-alloc-sections", "Add <prefix> to the start of every allocated section name">,
 251       MetaVarName<"prefix">;
 252
 253 def version : Flag<["--"], "version">,
 254               HelpText<"Print the version and exit.">;
 255 def V : Flag<["-"], "V">, Alias<version>;
 256 defm build_id_link_dir
 257     : Eq<"build-id-link-dir", "Set directory for --build-id-link-input and "
 258                               "--build-id-link-output to <dir>">,
 259       MetaVarName<"dir">;
 260 defm build_id_link_input
 261     : Eq<"build-id-link-input", "Hard-link the input to <dir>/xx/xxx<suffix> "
 262                                 "name derived from hex build ID">,
 263       MetaVarName<"suffix">;
 264 defm build_id_link_output
 265     : Eq<"build-id-link-output", "Hard-link the output to <dir>/xx/xxx<suffix> "
 266                                  "name derived from hex build ID">,
 267       MetaVarName<"suffix">;
 268
 269 def regex
 270     : Flag<["--"], "regex">,
 271       HelpText<"Permit regular expressions in name comparison">;
 272
 273 defm set_start : Eq<"set-start", "Set the start address to <addr>. Overrides "
 274                     "any previous --change-start or --adjust-start values.">,
 275                  MetaVarName<"addr">;
 276 defm change_start : Eq<"change-start", "Add <incr> to the start address. Can be "
 277                        "specified multiple times, all values will be applied "
 278                        "cumulatively.">,
 279                     MetaVarName<"incr">;
 280 def adjust_start : JoinedOrSeparate<["--"], "adjust-start">,
 281                    Alias<change_start>;
 282
 283 defm add_symbol
 284     : Eq<"add-symbol", "Add new symbol <name> to .symtab. Accepted flags: "
 285          "global, local, weak, default, hidden, file, section, object, "
 286          "function, indirect-function. Accepted but ignored for "
 287          "compatibility: debug, constructor, warning, indirect, synthetic, "
 288          "unique-object, before.">,
 289       MetaVarName<"name=[section:]value[,flags]">;