blob: 285ab9d69db29589d2621f2af63fd09fe4c7282f [file] [log] [blame]
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +00001include "llvm/Option/OptParser.td"
2
Fangrui Songab205a32018-11-01 17:20:40 +00003multiclass Eq<string name, string help> {
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +00004 def NAME : Separate<["--", "-"], name>;
5 def NAME #_eq : Joined<["--", "-"], name #"=">,
6 Alias<!cast<Separate>(NAME)>,
7 HelpText<help>;
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +00008}
9
10def help : Flag<["-", "--"], "help">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000011
Fangrui Songab205a32018-11-01 17:20:40 +000012defm binary_architecture
13 : Eq<"binary-architecture", "Used when transforming an architecture-less "
14 "format (such as binary) to another format">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000015def B : JoinedOrSeparate<["-"], "B">, Alias<binary_architecture>;
16
Fangrui Songab205a32018-11-01 17:20:40 +000017defm target : Eq<"target", "Format of the input and output file">,
Jordan Rupprechtbb4588e2018-10-12 00:36:01 +000018 Values<"binary">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000019def F : JoinedOrSeparate<["-"], "F">, Alias<target>;
20
Fangrui Songab205a32018-11-01 17:20:40 +000021defm input_target : Eq<"input-target", "Format of the input file">,
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +000022 Values<"binary">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000023def I : JoinedOrSeparate<["-"], "I">, Alias<input_target>;
24
Fangrui Songab205a32018-11-01 17:20:40 +000025defm output_target : Eq<"output-target", "Format of the output file">,
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +000026 Values<"binary">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000027def O : JoinedOrSeparate<["-"], "O">, Alias<output_target>;
28
Puyan Lotfi99124cc2018-09-07 08:10:22 +000029def compress_debug_sections : Flag<["--", "-"], "compress-debug-sections">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000030def compress_debug_sections_eq
31 : Joined<["--", "-"], "compress-debug-sections=">,
32 MetaVarName<"[ zlib | zlib-gnu ]">,
33 HelpText<"Compress DWARF debug sections using specified style. Supported "
34 "styles: 'zlib-gnu' and 'zlib'">;
Puyan Lotfiaf048642018-10-01 10:29:41 +000035def decompress_debug_sections : Flag<["-", "--"], "decompress-debug-sections">,
36 HelpText<"Decompress DWARF debug sections.">;
Fangrui Songab205a32018-11-01 17:20:40 +000037defm split_dwo
38 : Eq<"split-dwo", "Equivalent to extract-dwo on the input file to "
39 "<dwo-file>, then strip-dwo on the input file">,
40 MetaVarName<"dwo-file">;
Jordan Rupprechtd1767dc2018-08-16 18:29:40 +000041
Jordan Rupprechtfc780bb2018-11-01 17:36:37 +000042def enable_deterministic_archives
43 : Flag<["-", "--"], "enable-deterministic-archives">,
44 HelpText<"Enable deterministic mode when copying archives (use zero for "
45 "UIDs, GIDs, and timestamps).">;
46def D : Flag<["-"], "D">,
47 Alias<enable_deterministic_archives>,
48 HelpText<"Alias for --enable-deterministic-archives">;
49
50def disable_deterministic_archives
51 : Flag<["-", "--"], "disable-deterministic-archives">,
52 HelpText<"Disable deterministic mode when copying archives (use real "
53 "values for UIDs, GIDs, and timestamps).">;
54def U : Flag<["-"], "U">,
55 Alias<disable_deterministic_archives>,
56 HelpText<"Alias for --disable-deterministic-archives">;
57
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000058def preserve_dates : Flag<["-", "--"], "preserve-dates">,
Jordan Rupprechtd1767dc2018-08-16 18:29:40 +000059 HelpText<"Preserve access and modification timestamps">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000060def p : Flag<["-"], "p">, Alias<preserve_dates>;
Jordan Rupprechtd1767dc2018-08-16 18:29:40 +000061
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000062defm add_gnu_debuglink
63 : Eq<"add-gnu-debuglink", "Add a .gnu_debuglink for <debug-file>">,
64 MetaVarName<"debug-file">;
Jordan Rupprechtd1767dc2018-08-16 18:29:40 +000065
Fangrui Songab205a32018-11-01 17:20:40 +000066defm remove_section : Eq<"remove-section", "Remove <section>">,
67 MetaVarName<"section">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000068def R : JoinedOrSeparate<["-"], "R">, Alias<remove_section>;
69
Jordan Rupprechtd67c1e12018-08-01 16:23:22 +000070defm rename_section
Fangrui Songab205a32018-11-01 17:20:40 +000071 : Eq<"rename-section",
72 "Renames a section from old to new, optionally with specified flags. "
73 "Flags supported for GNU compatibility: alloc, load, noload, "
74 "readonly, debug, code, data, rom, share, contents, merge, strings.">,
75 MetaVarName<"old=new[,flag1,...]">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000076defm redefine_symbol
77 : Eq<"redefine-sym", "Change the name of a symbol old to new">,
78 MetaVarName<"old=new">;
79defm keep : Eq<"keep", "Keep <section>">, MetaVarName<"section">;
Fangrui Songab205a32018-11-01 17:20:40 +000080defm only_keep : Eq<"only-keep", "Remove all but <section>">,
81 MetaVarName<"section">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000082def j : JoinedOrSeparate<["-"], "j">, Alias<only_keep>;
Fangrui Songab205a32018-11-01 17:20:40 +000083defm add_section
84 : Eq<"add-section",
85 "Make a section named <section> with the contents of <file>.">,
86 MetaVarName<"section=file">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +000087
88def strip_all
89 : Flag<["-", "--"], "strip-all">,
90 HelpText<
91 "Remove non-allocated sections other than .gnu.warning* sections">;
92def S : Flag<["-"], "S">, Alias<strip_all>;
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +000093def strip_all_gnu : Flag<["-", "--"], "strip-all-gnu">,
Jordan Rupprecht30d1b192018-11-01 17:48:46 +000094 HelpText<"Compatible with GNU objcopy's --strip-all">;
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +000095def strip_debug : Flag<["-", "--"], "strip-debug">,
Alexander Shaposhnikovb3bfd3b2018-04-24 21:44:13 +000096 HelpText<"Remove all debug information">;
Alexander Shaposhnikovd6884792018-04-24 05:43:32 +000097def strip_dwo : Flag<["-", "--"], "strip-dwo">,
98 HelpText<"Remove all DWARF .dwo sections from file">;
99def strip_sections : Flag<["-", "--"], "strip-sections">,
100 HelpText<"Remove all section headers">;
101def strip_non_alloc : Flag<["-", "--"], "strip-non-alloc">,
102 HelpText<"Remove all non-allocated sections">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000103def strip_unneeded : Flag<["-", "--"], "strip-unneeded">,
104 HelpText<"Remove all symbols not needed by relocations">;
105
106def extract_dwo
107 : Flag<["-", "--"], "extract-dwo">,
108 HelpText<
109 "Remove all sections that are not DWARF .dwo sections from file">;
110
111def localize_hidden
112 : Flag<["-", "--"], "localize-hidden">,
113 HelpText<
114 "Mark all symbols that have hidden or internal visibility as local">;
Fangrui Songab205a32018-11-01 17:20:40 +0000115defm localize_symbol : Eq<"localize-symbol", "Mark <symbol> as local">,
116 MetaVarName<"symbol">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000117def L : JoinedOrSeparate<["-"], "L">, Alias<localize_symbol>;
Jordan Rupprechtbe8ebcc2018-08-17 22:34:48 +0000118
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000119defm globalize_symbol : Eq<"globalize-symbol", "Mark <symbol> as global">,
120 MetaVarName<"symbol">;
Jordan Rupprechtbe8ebcc2018-08-17 22:34:48 +0000121defm keep_global_symbol
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000122 : Eq<"keep-global-symbol",
123 "Convert all symbols except <symbol> to local. May be repeated to "
124 "convert all except a set of symbols to local.">,
Fangrui Songab205a32018-11-01 17:20:40 +0000125 MetaVarName<"symbol">;
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000126def G : JoinedOrSeparate<["-"], "G">, Alias<keep_global_symbol>;
Jordan Rupprechtbe8ebcc2018-08-17 22:34:48 +0000127
128defm keep_global_symbols
Fangrui Songab205a32018-11-01 17:20:40 +0000129 : Eq<"keep-global-symbols",
130 "Reads a list of symbols from <filename> and runs as if "
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000131 "--keep-global-symbol=<symbol> is set for each one. <filename> "
132 "contains one symbol per line and may contain comments beginning with "
133 "'#'. Leading and trailing whitespace is stripped from each line. May "
134 "be repeated to read symbols from many files.">,
Fangrui Songab205a32018-11-01 17:20:40 +0000135 MetaVarName<"filename">;
Jordan Rupprechtbe8ebcc2018-08-17 22:34:48 +0000136
Fangrui Songab205a32018-11-01 17:20:40 +0000137defm weaken_symbol : Eq<"weaken-symbol", "Mark <symbol> as weak">,
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000138 MetaVarName<"symbol">;
139def W : JoinedOrSeparate<["-"], "W">, Alias<weaken_symbol>;
Paul Semel2c0510f2018-05-02 20:14:49 +0000140def weaken : Flag<["-", "--"], "weaken">,
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000141 HelpText<"Mark all global symbols as weak">;
142def discard_all
143 : Flag<["-", "--"], "discard-all">,
144 HelpText<"Remove all local symbols except file and section symbols">;
145def x : Flag<["-"], "x">, Alias<discard_all>;
Fangrui Songab205a32018-11-01 17:20:40 +0000146defm strip_symbol : Eq<"strip-symbol", "Remove symbol <symbol>">,
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000147 MetaVarName<"symbol">;
148def N : JoinedOrSeparate<["-"], "N">, Alias<strip_symbol>;
Fangrui Songab205a32018-11-01 17:20:40 +0000149defm keep_symbol : Eq<"keep-symbol", "Do not remove symbol <symbol>">,
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000150 MetaVarName<"symbol">;
151def K : JoinedOrSeparate<["-"], "K">, Alias<keep_symbol>;
152def only_keep_debug
153 : Flag<["-", "--"], "only-keep-debug">,
154 HelpText<"Currently ignored. Only for compatibility with GNU objcopy.">;
Paul Semelcf51c802018-05-26 08:10:37 +0000155def keep_file_symbols : Flag<["-", "--"], "keep-file-symbols">,
Jordan Rupprecht56c0ee02018-11-01 21:38:14 +0000156 HelpText<"Do not remove file symbols">;
157defm dump_section
158 : Eq<"dump-section",
159 "Dump contents of section named <section> into file <file>">,
160 MetaVarName<"section=file">;
161defm prefix_symbols
162 : Eq<"prefix-symbols", "Add <prefix> to the start of every symbol name">,
163 MetaVarName<"prefix">;
164
165def version : Flag<["-", "--"], "version">,
166 HelpText<"Print the version and exit.">;