1 #ifndef __PERF_PARSE_OPTIONS_H
2 #define __PERF_PARSE_OPTIONS_H
4 #include <linux/kernel.h>
12 /* options with no arguments */
18 /* options with arguments (usually) */
27 enum 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,
35 enum parse_opt_option_flags {
40 PARSE_OPT_LASTARG_DEFAULT = 16,
41 PARSE_OPT_DISABLED = 32,
42 PARSE_OPT_EXCLUSIVE = 64,
43 PARSE_OPT_NOEMPTY = 128,
47 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
51 * holds the type of the option, you must have an OPTION_END last in your
55 * the character to use as a short option name, '\0' if none.
58 * the long option name, without the leading dashes, NULL if none.
61 * stores pointers to the values to be filled.
64 * token to explain the kind of argument this option wants. Keep it
65 * homogenous across the repository.
68 * the short help associated to what the option does.
69 * Must never be NULL (except for OPTION_END).
70 * OPTION_GROUP uses this pointer to store the group header.
73 * mask of parse_opt_option_flags.
74 * PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
75 * PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
76 * PARSE_OPT_NONEG: says that this option cannot be negated
77 * PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
81 * pointer to the callback to use for OPTION_CALLBACK.
84 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
85 * OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
87 * CALLBACKS can use it like they want.
90 * whether an option was set by the user
93 enum parse_opt_type type;
95 const char *long_name;
101 parse_opt_cb *callback;
107 #define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
109 #define OPT_END() { .type = OPTION_END }
110 #define OPT_ARGUMENT(l, h) { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
111 #define OPT_GROUP(h) { .type = OPTION_GROUP, .help = (h) }
112 #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) }
113 #define OPT_BOOLEAN(s, l, v, h) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
114 #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) }
115 #define OPT_BOOLEAN_SET(s, l, v, os, h) \
116 { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
117 .value = check_vtype(v, bool *), .help = (h), \
118 .set = check_vtype(os, bool *)}
119 #define OPT_INCR(s, l, v, h) { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
120 #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) }
121 #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) }
122 #define OPT_INTEGER(s, l, v, h) { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
123 #define OPT_UINTEGER(s, l, v, h) { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
124 #define OPT_LONG(s, l, v, h) { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
125 #define OPT_U64(s, l, v, h) { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
126 #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) }
127 #define OPT_STRING_OPTARG(s, l, v, a, h, d) \
128 { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
129 .value = check_vtype(v, const char **), (a), .help = (h), \
130 .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
131 #define OPT_STRING_NOEMPTY(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), (a), .help = (h), .flags = PARSE_OPT_NOEMPTY}
132 #define OPT_DATE(s, l, v, h) \
133 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
134 #define OPT_CALLBACK(s, l, v, a, h, f) \
135 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f) }
136 #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
137 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
138 #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
139 { .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 }
140 #define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
141 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
142 .value = (v), (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
143 .flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
144 #define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
145 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
146 .value = (v), (a), .help = (h), .callback = (f), \
147 .flags = PARSE_OPT_OPTARG, .data = (d) }
149 /* parse_options() will filter out the processed options and leave the
150 * non-option argments in argv[].
151 * Returns the number of arguments left in argv[].
153 extern int parse_options(int argc, const char **argv,
154 const struct option *options,
155 const char * const usagestr[], int flags);
157 extern int parse_options_subcommand(int argc, const char **argv,
158 const struct option *options,
159 const char *const subcommands[],
160 const char *usagestr[], int flags);
162 extern NORETURN void usage_with_options(const char * const *usagestr,
163 const struct option *options);
164 extern NORETURN __attribute__((format(printf,3,4)))
165 void usage_with_options_msg(const char * const *usagestr,
166 const struct option *options,
167 const char *fmt, ...);
169 /*----- incremantal advanced APIs -----*/
175 PARSE_OPT_LIST_SUBCMDS,
180 * It's okay for the caller to consume argv/argc in the usual way.
181 * Other fields of that structure are private to parse-options and should not
182 * be modified in any way.
184 struct parse_opt_ctx_t {
189 const struct option *excl_opt;
193 extern int parse_options_usage(const char * const *usagestr,
194 const struct option *opts,
198 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
199 int argc, const char **argv, int flags);
201 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
202 const struct option *options,
203 const char * const usagestr[]);
205 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
208 /*----- some often used options -----*/
209 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
210 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
211 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
213 #define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
214 #define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
215 #define OPT__VERBOSITY(var) \
216 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
217 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
218 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
219 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
220 #define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
221 #define OPT__ABBREV(var) \
222 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
223 "use <n> digits to display SHA-1s", \
224 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
226 extern const char *parse_options_fix_filename(const char *prefix, const char *file);
228 void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
229 #endif /* __PERF_PARSE_OPTIONS_H */