]>
Commit | Line | Data |
---|---|---|
d3f24367 KW |
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 | ||
121d0712 MA |
26 | #ifndef QEMU_OPTION_H |
27 | #define QEMU_OPTION_H | |
d3f24367 | 28 | |
1de7afc9 | 29 | #include "qemu/queue.h" |
e27c88fe | 30 | |
8f4d9555 PMD |
31 | /** |
32 | * get_opt_value | |
33 | * @p: a pointer to the option name, delimited by commas | |
34 | * @value: a non-NULL pointer that will received the delimited options | |
35 | * | |
36 | * The @value char pointer will be allocated and filled with | |
37 | * the delimited options. | |
38 | * | |
39 | * Returns the position of the comma delimiter/zero byte after the | |
40 | * option name in @p. | |
41 | * The memory pointer in @value must be released with a call to g_free() | |
42 | * when no longer required. | |
43 | */ | |
950c4e6c | 44 | const char *get_opt_value(const char *p, char **value); |
d3f24367 | 45 | |
e8cd45c7 VL |
46 | void parse_option_size(const char *name, const char *value, |
47 | uint64_t *ret, Error **errp); | |
7cc07ab8 | 48 | bool has_help_option(const char *param); |
d3f24367 | 49 | |
e27c88fe GH |
50 | enum QemuOptType { |
51 | QEMU_OPT_STRING = 0, /* no parsing (use string as-is) */ | |
52 | QEMU_OPT_BOOL, /* on/off */ | |
53 | QEMU_OPT_NUMBER, /* simple number */ | |
54 | QEMU_OPT_SIZE, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */ | |
55 | }; | |
56 | ||
57 | typedef struct QemuOptDesc { | |
58 | const char *name; | |
59 | enum QemuOptType type; | |
60 | const char *help; | |
09722032 | 61 | const char *def_value_str; |
e27c88fe GH |
62 | } QemuOptDesc; |
63 | ||
64 | struct QemuOptsList { | |
65 | const char *name; | |
8212c64f | 66 | const char *implied_opt_name; |
da93318a | 67 | bool merge_lists; /* Merge multiple uses of option into a single list? */ |
72cf2d4f | 68 | QTAILQ_HEAD(, QemuOpts) head; |
e27c88fe GH |
69 | QemuOptDesc desc[]; |
70 | }; | |
71 | ||
72 | const char *qemu_opt_get(QemuOpts *opts, const char *name); | |
782730b0 | 73 | char *qemu_opt_get_del(QemuOpts *opts, const char *name); |
c8057f95 PM |
74 | /** |
75 | * qemu_opt_has_help_opt: | |
76 | * @opts: options to search for a help request | |
77 | * | |
78 | * Check whether the options specified by @opts include one of the | |
79 | * standard strings which indicate that the user is asking for a | |
80 | * list of the valid values for a command line option (as defined | |
81 | * by is_help_option()). | |
82 | * | |
83 | * Returns: true if @opts includes 'help' or equivalent. | |
84 | */ | |
85 | bool qemu_opt_has_help_opt(QemuOpts *opts); | |
74c3c197 | 86 | QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name); |
f02b77c9 | 87 | bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval); |
e27c88fe GH |
88 | uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); |
89 | uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); | |
782730b0 CL |
90 | bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval); |
91 | uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name, | |
92 | uint64_t defval); | |
93 | uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name, | |
94 | uint64_t defval); | |
0dd6c526 | 95 | int qemu_opt_unset(QemuOpts *opts, const char *name); |
f43e47db MA |
96 | void qemu_opt_set(QemuOpts *opts, const char *name, const char *value, |
97 | Error **errp); | |
cccb7967 MA |
98 | void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val, |
99 | Error **errp); | |
39101f25 MA |
100 | void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val, |
101 | Error **errp); | |
71df1d83 MA |
102 | typedef int (*qemu_opt_loopfunc)(void *opaque, |
103 | const char *name, const char *value, | |
104 | Error **errp); | |
105 | int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, | |
106 | Error **errp); | |
e27c88fe | 107 | |
e998e209 DB |
108 | typedef struct { |
109 | QemuOpts *opts; | |
110 | QemuOpt *opt; | |
111 | const char *name; | |
112 | } QemuOptsIter; | |
113 | ||
114 | void qemu_opt_iter_init(QemuOptsIter *iter, QemuOpts *opts, const char *name); | |
115 | const char *qemu_opt_iter_next(QemuOptsIter *iter); | |
116 | ||
e27c88fe | 117 | QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); |
8be7e7e4 LC |
118 | QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, |
119 | int fail_if_exists, Error **errp); | |
bb67ab02 | 120 | void qemu_opts_reset(QemuOptsList *list); |
94ac7268 | 121 | void qemu_opts_loc_restore(QemuOpts *opts); |
79087c78 MA |
122 | void qemu_opts_set(QemuOptsList *list, const char *id, |
123 | const char *name, const char *value, Error **errp); | |
48026075 | 124 | const char *qemu_opts_id(QemuOpts *opts); |
326642bc | 125 | void qemu_opts_set_id(QemuOpts *opts, char *id); |
e27c88fe | 126 | void qemu_opts_del(QemuOpts *opts); |
29952866 | 127 | void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp); |
dc523cd3 MA |
128 | void qemu_opts_do_parse(QemuOpts *opts, const char *params, |
129 | const char *firstname, Error **errp); | |
70b94331 MA |
130 | QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params, |
131 | bool permit_abbrev); | |
132 | QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, | |
133 | bool permit_abbrev, Error **errp); | |
4f6dd9af JK |
134 | void qemu_opts_set_defaults(QemuOptsList *list, const char *params, |
135 | int permit_abbrev); | |
4e89978e LC |
136 | QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict, |
137 | Error **errp); | |
72215395 KW |
138 | QDict *qemu_opts_to_qdict_filtered(QemuOpts *opts, QDict *qdict, |
139 | QemuOptsList *list, bool del); | |
01e7f188 | 140 | QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict); |
376609cc | 141 | void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp); |
e27c88fe | 142 | |
28d0de7a | 143 | typedef int (*qemu_opts_loopfunc)(void *opaque, QemuOpts *opts, Error **errp); |
a4c7367f | 144 | int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, |
28d0de7a | 145 | void *opaque, Error **errp); |
43c5d8f8 | 146 | void qemu_opts_print(QemuOpts *opts, const char *sep); |
63898712 | 147 | void qemu_opts_print_help(QemuOptsList *list, bool print_caption); |
8559e45e | 148 | void qemu_opts_free(QemuOptsList *list); |
c282e1fd | 149 | QemuOptsList *qemu_opts_append(QemuOptsList *dst, QemuOptsList *list); |
e27c88fe | 150 | |
d454dbe0 MA |
151 | QDict *keyval_parse(const char *params, const char *implied_key, |
152 | Error **errp); | |
153 | ||
d3f24367 | 154 | #endif |