tools/perf/util/parse-options.h

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