1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __SUBCMD_PARSE_OPTIONS_H
3#define __SUBCMD_PARSE_OPTIONS_H
4
5#include <linux/kernel.h>
6#include <stdbool.h>
7#include <stdint.h>
8
9#ifndef NORETURN
10#define NORETURN __attribute__((__noreturn__))
11#endif
12
13enum parse_opt_type {
14	/* special types */
15	OPTION_END,
16	OPTION_ARGUMENT,
17	OPTION_GROUP,
18	/* options with no arguments */
19	OPTION_BIT,
20	OPTION_BOOLEAN,
21	OPTION_INCR,
22	OPTION_SET_UINT,
23	OPTION_SET_PTR,
24	/* options with arguments (usually) */
25	OPTION_STRING,
26	OPTION_INTEGER,
27	OPTION_LONG,
28	OPTION_ULONG,
29	OPTION_CALLBACK,
30	OPTION_U64,
31	OPTION_UINTEGER,
32};
33
34enum parse_opt_flags {
35	PARSE_OPT_KEEP_DASHDASH = 1,
36	PARSE_OPT_STOP_AT_NON_OPTION = 2,
37	PARSE_OPT_KEEP_ARGV0 = 4,
38	PARSE_OPT_KEEP_UNKNOWN = 8,
39	PARSE_OPT_NO_INTERNAL_HELP = 16,
40};
41
42enum parse_opt_option_flags {
43	PARSE_OPT_OPTARG  = 1,
44	PARSE_OPT_NOARG   = 2,
45	PARSE_OPT_NONEG   = 4,
46	PARSE_OPT_HIDDEN  = 8,
47	PARSE_OPT_LASTARG_DEFAULT = 16,
48	PARSE_OPT_DISABLED = 32,
49	PARSE_OPT_EXCLUSIVE = 64,
50	PARSE_OPT_NOEMPTY  = 128,
51	PARSE_OPT_NOBUILD  = 256,
52	PARSE_OPT_CANSKIP  = 512,
53};
54
55struct option;
56typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
57
58/*
59 * `type`::
60 *   holds the type of the option, you must have an OPTION_END last in your
61 *   array.
62 *
63 * `short_name`::
64 *   the character to use as a short option name, '\0' if none.
65 *
66 * `long_name`::
67 *   the long option name, without the leading dashes, NULL if none.
68 *
69 * `value`::
70 *   stores pointers to the values to be filled.
71 *
72 * `argh`::
73 *   token to explain the kind of argument this option wants. Keep it
74 *   homogeneous across the repository.
75 *
76 * `help`::
77 *   the short help associated to what the option does.
78 *   Must never be NULL (except for OPTION_END).
79 *   OPTION_GROUP uses this pointer to store the group header.
80 *
81 * `flags`::
82 *   mask of parse_opt_option_flags.
83 *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
84 *   PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
85 *   PARSE_OPT_NONEG: says that this option cannot be negated
86 *   PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
87 *                    the long one.
88 *
89 * `callback`::
90 *   pointer to the callback to use for OPTION_CALLBACK.
91 *
92 * `defval`::
93 *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
94 *   OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
95 *   the value when met.
96 *   CALLBACKS can use it like they want.
97 *
98 * `set`::
99 *   whether an option was set by the user
100 */
101struct option {
102	enum parse_opt_type type;
103	int short_name;
104	const char *long_name;
105	void *value;
106	const char *argh;
107	const char *help;
108	const char *build_opt;
109
110	int flags;
111	parse_opt_cb *callback;
112	intptr_t defval;
113	bool *set;
114	void *data;
115	const struct option *parent;
116};
117
118#define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
119
120#define OPT_END()                   { .type = OPTION_END }
121#define OPT_PARENT(p)               { .type = OPTION_END, .parent = (p) }
122#define OPT_ARGUMENT(l, h)          { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
123#define OPT_GROUP(h)                { .type = OPTION_GROUP, .help = (h) }
124#define OPT_BIT(s, l, v, h, b)      { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h), .defval = (b) }
125#define OPT_BOOLEAN(s, l, v, h)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
126#define OPT_BOOLEAN_FLAG(s, l, v, h, f)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h), .flags = (f) }
127#define OPT_BOOLEAN_SET(s, l, v, os, h) \
128	{ .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
129	.value = check_vtype(v, bool *), .help = (h), \
130	.set = check_vtype(os, bool *)}
131#define OPT_INCR(s, l, v, h)        { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
132#define OPT_SET_UINT(s, l, v, h, i)  { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h), .defval = (i) }
133#define OPT_SET_PTR(s, l, v, h, p)  { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) }
134#define OPT_INTEGER(s, l, v, h)     { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
135#define OPT_UINTEGER(s, l, v, h)    { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
136#define OPT_LONG(s, l, v, h)        { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
137#define OPT_ULONG(s, l, v, h)        { .type = OPTION_ULONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned long *), .help = (h) }
138#define OPT_U64(s, l, v, h)         { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
139#define OPT_STRING(s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h) }
140#define OPT_STRING_OPTARG(s, l, v, a, h, d) \
141	{ .type = OPTION_STRING,  .short_name = (s), .long_name = (l), \
142	  .value = check_vtype(v, const char **), .argh =(a), .help = (h), \
143	  .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
144#define OPT_STRING_OPTARG_SET(s, l, v, os, a, h, d) \
145	{ .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
146	  .value = check_vtype(v, const char **), .argh = (a), .help = (h), \
147	  .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d), \
148	  .set = check_vtype(os, bool *)}
149#define OPT_STRING_NOEMPTY(s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h), .flags = PARSE_OPT_NOEMPTY}
150#define OPT_DATE(s, l, v, h) \
151	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
152#define OPT_CALLBACK(s, l, v, a, h, f) \
153	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f) }
154#define OPT_CALLBACK_SET(s, l, v, os, a, h, f) \
155	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .set = check_vtype(os, bool *)}
156#define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
157	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
158#define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
159	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT }
160#define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
161	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
162	.value = (v), .arg = (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
163	.flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
164#define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
165	{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
166	  .value = (v), .argh = (a), .help = (h), .callback = (f), \
167	  .flags = PARSE_OPT_OPTARG, .data = (d) }
168
169/* parse_options() will filter out the processed options and leave the
170 * non-option argments in argv[].
171 * Returns the number of arguments left in argv[].
172 *
173 * NOTE: parse_options() and parse_options_subcommand() may call exit() in the
174 * case of an error (or for 'special' options like --list-cmds or --list-opts).
175 */
176extern int parse_options(int argc, const char **argv,
177                         const struct option *options,
178                         const char * const usagestr[], int flags);
179
180extern int parse_options_subcommand(int argc, const char **argv,
181				const struct option *options,
182				const char *const subcommands[],
183				const char *usagestr[], int flags);
184
185extern NORETURN void usage_with_options(const char * const *usagestr,
186                                        const struct option *options);
187extern NORETURN __attribute__((format(printf,3,4)))
188void usage_with_options_msg(const char * const *usagestr,
189			    const struct option *options,
190			    const char *fmt, ...);
191
192/*----- incremantal advanced APIs -----*/
193
194enum {
195	PARSE_OPT_HELP = -1,
196	PARSE_OPT_DONE,
197	PARSE_OPT_LIST_OPTS,
198	PARSE_OPT_LIST_SUBCMDS,
199	PARSE_OPT_UNKNOWN,
200};
201
202/*
203 * It's okay for the caller to consume argv/argc in the usual way.
204 * Other fields of that structure are private to parse-options and should not
205 * be modified in any way.
206 */
207struct parse_opt_ctx_t {
208	const char **argv;
209	const char **out;
210	int argc, cpidx;
211	const char *opt;
212	const struct option *excl_opt;
213	int flags;
214};
215
216extern int parse_options_usage(const char * const *usagestr,
217			       const struct option *opts,
218			       const char *optstr,
219			       bool short_opt);
220
221
222/*----- some often used options -----*/
223extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
224extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
225extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
226
227#define OPT__VERBOSE(var)  OPT_BOOLEAN('v', "verbose", (var), "be verbose")
228#define OPT__QUIET(var)    OPT_BOOLEAN('q', "quiet",   (var), "be quiet")
229#define OPT__VERBOSITY(var) \
230	{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
231	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
232	{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
233	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
234#define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
235#define OPT__ABBREV(var)  \
236	{ OPTION_CALLBACK, 0, "abbrev", (var), "n", \
237	  "use <n> digits to display SHA-1s", \
238	  PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
239
240extern const char *parse_options_fix_filename(const char *prefix, const char *file);
241
242void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
243void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
244			const char *build_opt, bool can_skip);
245
246#endif /* __SUBCMD_PARSE_OPTIONS_H */
247