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