1 | /* |
2 | * Commandline option parsing functions |
3 | * |
4 | * Copyright (c) 2003-2008 Fabrice Bellard |
5 | * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com> |
6 | * |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
8 | * of this software and associated documentation files (the "Software"), to deal |
9 | * in the Software without restriction, including without limitation the rights |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
11 | * copies of the Software, and to permit persons to whom the Software is |
12 | * furnished to do so, subject to the following conditions: |
13 | * |
14 | * The above copyright notice and this permission notice shall be included in |
15 | * all copies or substantial portions of the Software. |
16 | * |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
20 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
23 | * THE SOFTWARE. |
24 | */ |
25 | |
26 | #ifndef QEMU_OPTION_H |
27 | #define QEMU_OPTION_H |
28 | |
29 | #include "qemu/queue.h" |
30 | |
31 | const char *get_opt_value(const char *p, char **value); |
32 | |
33 | void parse_option_size(const char *name, const char *value, |
34 | uint64_t *ret, Error **errp); |
35 | bool has_help_option(const char *param); |
36 | bool is_valid_option_list(const char *param); |
37 | |
38 | enum QemuOptType { |
39 | QEMU_OPT_STRING = 0, /* no parsing (use string as-is) */ |
40 | QEMU_OPT_BOOL, /* on/off */ |
41 | QEMU_OPT_NUMBER, /* simple number */ |
42 | QEMU_OPT_SIZE, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */ |
43 | }; |
44 | |
45 | typedef struct QemuOptDesc { |
46 | const char *name; |
47 | enum QemuOptType type; |
48 | const char *help; |
49 | const char *def_value_str; |
50 | } QemuOptDesc; |
51 | |
52 | struct QemuOptsList { |
53 | const char *name; |
54 | const char *implied_opt_name; |
55 | bool merge_lists; /* Merge multiple uses of option into a single list? */ |
56 | QTAILQ_HEAD(, QemuOpts) head; |
57 | QemuOptDesc desc[]; |
58 | }; |
59 | |
60 | const char *qemu_opt_get(QemuOpts *opts, const char *name); |
61 | char *qemu_opt_get_del(QemuOpts *opts, const char *name); |
62 | /** |
63 | * qemu_opt_has_help_opt: |
64 | * @opts: options to search for a help request |
65 | * |
66 | * Check whether the options specified by @opts include one of the |
67 | * standard strings which indicate that the user is asking for a |
68 | * list of the valid values for a command line option (as defined |
69 | * by is_help_option()). |
70 | * |
71 | * Returns: true if @opts includes 'help' or equivalent. |
72 | */ |
73 | bool qemu_opt_has_help_opt(QemuOpts *opts); |
74 | QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name); |
75 | bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval); |
76 | uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); |
77 | uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); |
78 | bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval); |
79 | uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name, |
80 | uint64_t defval); |
81 | uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name, |
82 | uint64_t defval); |
83 | int qemu_opt_unset(QemuOpts *opts, const char *name); |
84 | void qemu_opt_set(QemuOpts *opts, const char *name, const char *value, |
85 | Error **errp); |
86 | void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val, |
87 | Error **errp); |
88 | void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val, |
89 | Error **errp); |
90 | typedef int (*qemu_opt_loopfunc)(void *opaque, |
91 | const char *name, const char *value, |
92 | Error **errp); |
93 | int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, |
94 | Error **errp); |
95 | |
96 | typedef struct { |
97 | QemuOpts *opts; |
98 | QemuOpt *opt; |
99 | const char *name; |
100 | } QemuOptsIter; |
101 | |
102 | void qemu_opt_iter_init(QemuOptsIter *iter, QemuOpts *opts, const char *name); |
103 | const char *qemu_opt_iter_next(QemuOptsIter *iter); |
104 | |
105 | QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); |
106 | QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, |
107 | int fail_if_exists, Error **errp); |
108 | void qemu_opts_reset(QemuOptsList *list); |
109 | void qemu_opts_loc_restore(QemuOpts *opts); |
110 | void qemu_opts_set(QemuOptsList *list, const char *id, |
111 | const char *name, const char *value, Error **errp); |
112 | const char *qemu_opts_id(QemuOpts *opts); |
113 | void qemu_opts_set_id(QemuOpts *opts, char *id); |
114 | void qemu_opts_del(QemuOpts *opts); |
115 | void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp); |
116 | void qemu_opts_do_parse(QemuOpts *opts, const char *params, |
117 | const char *firstname, Error **errp); |
118 | QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params, |
119 | bool permit_abbrev); |
120 | QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, |
121 | bool permit_abbrev, Error **errp); |
122 | void qemu_opts_set_defaults(QemuOptsList *list, const char *params, |
123 | int permit_abbrev); |
124 | QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict, |
125 | Error **errp); |
126 | QDict *qemu_opts_to_qdict_filtered(QemuOpts *opts, QDict *qdict, |
127 | QemuOptsList *list, bool del); |
128 | QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict); |
129 | void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp); |
130 | |
131 | typedef int (*qemu_opts_loopfunc)(void *opaque, QemuOpts *opts, Error **errp); |
132 | int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, |
133 | void *opaque, Error **errp); |
134 | void qemu_opts_print(QemuOpts *opts, const char *sep); |
135 | void qemu_opts_print_help(QemuOptsList *list, bool print_caption); |
136 | void qemu_opts_free(QemuOptsList *list); |
137 | QemuOptsList *qemu_opts_append(QemuOptsList *dst, QemuOptsList *list); |
138 | |
139 | QDict *keyval_parse(const char *params, const char *implied_key, |
140 | Error **errp); |
141 | |
142 | #endif |
143 | |