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