blob: 3467dc239784e37eabcd7d4db48f77e9a368f2f6 [file] [log] [blame]
Kevin Wolfd3f24362009-05-18 16:42:09 +02001/*
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
Peter Maydellaafd7582016-01-29 17:49:55 +000026#include "qemu/osdep.h"
Kevin Wolfd3f24362009-05-18 16:42:09 +020027
Markus Armbrusterda34e652016-03-14 09:01:28 +010028#include "qapi/error.h"
Kevin Wolfd3f24362009-05-18 16:42:09 +020029#include "qemu-common.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010030#include "qemu/error-report.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010031#include "qapi/qmp/types.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010032#include "qapi/qmp/qerror.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010033#include "qemu/option_int.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020034#include "qemu/cutils.h"
35#include "qemu/id.h"
36#include "qemu/help_option.h"
Kevin Wolfd3f24362009-05-18 16:42:09 +020037
38/*
39 * Extracts the name of an option from the parameter string (p points at the
40 * first byte of the option name)
41 *
42 * The option name is delimited by delim (usually , or =) or the string end
43 * and is copied into buf. If the option name is longer than buf_size, it is
44 * truncated. buf is always zero terminated.
45 *
46 * The return value is the position of the delimiter/zero byte after the option
47 * name in p.
48 */
49const char *get_opt_name(char *buf, int buf_size, const char *p, char delim)
50{
51 char *q;
52
53 q = buf;
54 while (*p != '\0' && *p != delim) {
55 if (q && (q - buf) < buf_size - 1)
56 *q++ = *p;
57 p++;
58 }
59 if (q)
60 *q = '\0';
61
62 return p;
63}
64
65/*
66 * Extracts the value of an option from the parameter string p (p points at the
67 * first byte of the option value)
68 *
69 * This function is comparable to get_opt_name with the difference that the
70 * delimiter is fixed to be comma which starts a new option. To specify an
71 * option value that contains commas, double each comma.
72 */
73const char *get_opt_value(char *buf, int buf_size, const char *p)
74{
75 char *q;
76
77 q = buf;
78 while (*p != '\0') {
79 if (*p == ',') {
80 if (*(p + 1) != ',')
81 break;
82 p++;
83 }
84 if (q && (q - buf) < buf_size - 1)
85 *q++ = *p;
86 p++;
87 }
88 if (q)
89 *q = '\0';
90
91 return p;
92}
93
Gerd Hoffmann62c58022009-07-22 16:43:00 +020094int get_next_param_value(char *buf, int buf_size,
95 const char *tag, const char **pstr)
96{
97 const char *p;
98 char option[128];
99
100 p = *pstr;
101 for(;;) {
102 p = get_opt_name(option, sizeof(option), p, '=');
103 if (*p != '=')
104 break;
105 p++;
106 if (!strcmp(tag, option)) {
107 *pstr = get_opt_value(buf, buf_size, p);
108 if (**pstr == ',') {
109 (*pstr)++;
110 }
111 return strlen(buf);
112 } else {
113 p = get_opt_value(NULL, 0, p);
114 }
115 if (*p != ',')
116 break;
117 p++;
118 }
119 return 0;
120}
121
122int get_param_value(char *buf, int buf_size,
123 const char *tag, const char *str)
124{
125 return get_next_param_value(buf, buf_size, tag, &str);
126}
127
Luiz Capitulinocf62adf2012-03-21 14:54:42 -0300128static void parse_option_bool(const char *name, const char *value, bool *ret,
129 Error **errp)
Gerd Hoffmann67b13552009-07-22 16:43:01 +0200130{
131 if (value != NULL) {
132 if (!strcmp(value, "on")) {
133 *ret = 1;
134 } else if (!strcmp(value, "off")) {
135 *ret = 0;
136 } else {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100137 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
138 name, "'on' or 'off'");
Gerd Hoffmann67b13552009-07-22 16:43:01 +0200139 }
140 } else {
141 *ret = 1;
142 }
Gerd Hoffmann67b13552009-07-22 16:43:01 +0200143}
144
Luiz Capitulino2f39df52012-03-21 14:37:44 -0300145static void parse_option_number(const char *name, const char *value,
146 uint64_t *ret, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200147{
148 char *postfix;
149 uint64_t number;
150
151 if (value != NULL) {
152 number = strtoull(value, &postfix, 0);
153 if (*postfix != '\0') {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100154 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
Luiz Capitulino2f39df52012-03-21 14:37:44 -0300155 return;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200156 }
Gerd Hoffmann21c9f4c2009-07-29 10:39:59 +0200157 *ret = number;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200158 } else {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100159 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200160 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200161}
162
Chunyan Liu5e89db72014-06-05 17:20:40 +0800163static const QemuOptDesc *find_desc_by_name(const QemuOptDesc *desc,
164 const char *name)
165{
166 int i;
167
168 for (i = 0; desc[i].name != NULL; i++) {
169 if (strcmp(desc[i].name, name) == 0) {
170 return &desc[i];
171 }
172 }
173
174 return NULL;
175}
176
Vasilis Liaskovitise8cd45c2013-07-29 16:47:56 +0200177void parse_option_size(const char *name, const char *value,
178 uint64_t *ret, Error **errp)
Gerd Hoffmann76950192009-07-22 16:43:02 +0200179{
180 char *postfix;
181 double sizef;
182
183 if (value != NULL) {
184 sizef = strtod(value, &postfix);
Bo Tu21278992015-07-03 15:28:49 +0800185 if (sizef < 0 || sizef > UINT64_MAX) {
186 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name,
187 "a non-negative number below 2^64");
188 return;
189 }
Gerd Hoffmann76950192009-07-22 16:43:02 +0200190 switch (*postfix) {
191 case 'T':
192 sizef *= 1024;
Stefan Weil0b0404b2012-01-09 18:29:51 +0100193 /* fall through */
Gerd Hoffmann76950192009-07-22 16:43:02 +0200194 case 'G':
195 sizef *= 1024;
Stefan Weil0b0404b2012-01-09 18:29:51 +0100196 /* fall through */
Gerd Hoffmann76950192009-07-22 16:43:02 +0200197 case 'M':
198 sizef *= 1024;
Stefan Weil0b0404b2012-01-09 18:29:51 +0100199 /* fall through */
Gerd Hoffmann76950192009-07-22 16:43:02 +0200200 case 'K':
201 case 'k':
202 sizef *= 1024;
Stefan Weil0b0404b2012-01-09 18:29:51 +0100203 /* fall through */
Gerd Hoffmann76950192009-07-22 16:43:02 +0200204 case 'b':
205 case '\0':
206 *ret = (uint64_t) sizef;
207 break;
208 default:
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100209 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
Eric Blake50b7b002015-09-10 10:19:16 -0600210 error_append_hint(errp, "You may use k, M, G or T suffixes for "
Markus Armbruster543202c2015-12-17 17:35:14 +0100211 "kilobytes, megabytes, gigabytes and terabytes.\n");
Luiz Capitulinoec7b2cc2012-03-21 15:03:45 -0300212 return;
Gerd Hoffmann76950192009-07-22 16:43:02 +0200213 }
214 } else {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100215 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
Gerd Hoffmann76950192009-07-22 16:43:02 +0200216 }
Gerd Hoffmann76950192009-07-22 16:43:02 +0200217}
218
Kevin Wolf7cc07ab2014-02-21 16:24:03 +0100219bool has_help_option(const char *param)
220{
221 size_t buflen = strlen(param) + 1;
Markus Armbruster96c044a2015-01-28 15:54:01 +0100222 char *buf = g_malloc(buflen);
Kevin Wolf7cc07ab2014-02-21 16:24:03 +0100223 const char *p = param;
224 bool result = false;
225
226 while (*p) {
227 p = get_opt_value(buf, buflen, p);
228 if (*p) {
229 p++;
230 }
231
232 if (is_help_option(buf)) {
233 result = true;
234 goto out;
235 }
236 }
237
238out:
Markus Armbrusterc0462f62015-01-28 15:54:02 +0100239 g_free(buf);
Kevin Wolf7cc07ab2014-02-21 16:24:03 +0100240 return result;
241}
242
243bool is_valid_option_list(const char *param)
244{
245 size_t buflen = strlen(param) + 1;
Markus Armbruster96c044a2015-01-28 15:54:01 +0100246 char *buf = g_malloc(buflen);
Kevin Wolf7cc07ab2014-02-21 16:24:03 +0100247 const char *p = param;
248 bool result = true;
249
250 while (*p) {
251 p = get_opt_value(buf, buflen, p);
252 if (*p && !*++p) {
253 result = false;
254 goto out;
255 }
256
257 if (!*buf || *buf == ',') {
258 result = false;
259 goto out;
260 }
261 }
262
263out:
Markus Armbrusterc0462f62015-01-28 15:54:02 +0100264 g_free(buf);
Kevin Wolf7cc07ab2014-02-21 16:24:03 +0100265 return result;
266}
267
Chunyan Liu504189a2014-06-05 17:20:47 +0800268void qemu_opts_print_help(QemuOptsList *list)
269{
270 QemuOptDesc *desc;
271
272 assert(list);
273 desc = list->desc;
274 printf("Supported options:\n");
275 while (desc && desc->name) {
276 printf("%-16s %s\n", desc->name,
277 desc->help ? desc->help : "No description available");
278 desc++;
279 }
280}
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200281/* ------------------------------------------------------------------ */
282
Chunyan Liu74c3c192014-06-05 17:20:58 +0800283QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200284{
285 QemuOpt *opt;
286
Mark McLoughlindc9ca4b2009-10-06 12:17:04 +0100287 QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200288 if (strcmp(opt->name, name) != 0)
289 continue;
290 return opt;
291 }
292 return NULL;
293}
294
Chunyan Liufc345512014-06-05 17:20:45 +0800295static void qemu_opt_del(QemuOpt *opt)
296{
297 QTAILQ_REMOVE(&opt->opts->head, opt, next);
298 g_free(opt->name);
299 g_free(opt->str);
300 g_free(opt);
301}
302
Chunyan Liu782730b2014-06-05 17:20:46 +0800303/* qemu_opt_set allows many settings for the same option.
304 * This function deletes all settings for an option.
305 */
306static void qemu_opt_del_all(QemuOpts *opts, const char *name)
307{
308 QemuOpt *opt, *next_opt;
309
310 QTAILQ_FOREACH_SAFE(opt, &opts->head, next, next_opt) {
311 if (!strcmp(opt->name, name)) {
312 qemu_opt_del(opt);
313 }
314 }
315}
316
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200317const char *qemu_opt_get(QemuOpts *opts, const char *name)
318{
Chunyan Liu435db4c2014-06-18 10:47:26 +0800319 QemuOpt *opt;
Chunyan Liu09722032014-06-05 17:20:42 +0800320
Chunyan Liu435db4c2014-06-18 10:47:26 +0800321 if (opts == NULL) {
322 return NULL;
323 }
324
325 opt = qemu_opt_find(opts, name);
Chunyan Liu09722032014-06-05 17:20:42 +0800326 if (!opt) {
327 const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
328 if (desc && desc->def_value_str) {
329 return desc->def_value_str;
330 }
331 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200332 return opt ? opt->str : NULL;
333}
334
Chunyan Liu782730b2014-06-05 17:20:46 +0800335/* Get a known option (or its default) and remove it from the list
336 * all in one action. Return a malloced string of the option value.
337 * Result must be freed by caller with g_free().
338 */
339char *qemu_opt_get_del(QemuOpts *opts, const char *name)
340{
341 QemuOpt *opt;
342 const QemuOptDesc *desc;
343 char *str = NULL;
344
345 if (opts == NULL) {
346 return NULL;
347 }
348
349 opt = qemu_opt_find(opts, name);
350 if (!opt) {
351 desc = find_desc_by_name(opts->list->desc, name);
352 if (desc && desc->def_value_str) {
353 str = g_strdup(desc->def_value_str);
354 }
355 return str;
356 }
357 str = opt->str;
358 opt->str = NULL;
359 qemu_opt_del_all(opts, name);
360 return str;
361}
362
Peter Maydellc8057f92012-08-02 13:45:54 +0100363bool qemu_opt_has_help_opt(QemuOpts *opts)
364{
365 QemuOpt *opt;
366
367 QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
368 if (is_help_option(opt->name)) {
369 return true;
370 }
371 }
372 return false;
373}
374
Chunyan Liu782730b2014-06-05 17:20:46 +0800375static bool qemu_opt_get_bool_helper(QemuOpts *opts, const char *name,
376 bool defval, bool del)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200377{
Chunyan Liu435db4c2014-06-18 10:47:26 +0800378 QemuOpt *opt;
Chunyan Liu782730b2014-06-05 17:20:46 +0800379 bool ret = defval;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200380
Chunyan Liu435db4c2014-06-18 10:47:26 +0800381 if (opts == NULL) {
382 return ret;
383 }
384
385 opt = qemu_opt_find(opts, name);
Chunyan Liu09722032014-06-05 17:20:42 +0800386 if (opt == NULL) {
387 const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
388 if (desc && desc->def_value_str) {
Chunyan Liu782730b2014-06-05 17:20:46 +0800389 parse_option_bool(name, desc->def_value_str, &ret, &error_abort);
Chunyan Liu09722032014-06-05 17:20:42 +0800390 }
Chunyan Liu782730b2014-06-05 17:20:46 +0800391 return ret;
Chunyan Liu09722032014-06-05 17:20:42 +0800392 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200393 assert(opt->desc && opt->desc->type == QEMU_OPT_BOOL);
Chunyan Liu782730b2014-06-05 17:20:46 +0800394 ret = opt->value.boolean;
395 if (del) {
396 qemu_opt_del_all(opts, name);
397 }
398 return ret;
399}
400
401bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval)
402{
403 return qemu_opt_get_bool_helper(opts, name, defval, false);
404}
405
406bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval)
407{
408 return qemu_opt_get_bool_helper(opts, name, defval, true);
409}
410
411static uint64_t qemu_opt_get_number_helper(QemuOpts *opts, const char *name,
412 uint64_t defval, bool del)
413{
Chunyan Liu435db4c2014-06-18 10:47:26 +0800414 QemuOpt *opt;
Chunyan Liu782730b2014-06-05 17:20:46 +0800415 uint64_t ret = defval;
416
Chunyan Liu435db4c2014-06-18 10:47:26 +0800417 if (opts == NULL) {
418 return ret;
419 }
420
421 opt = qemu_opt_find(opts, name);
Chunyan Liu782730b2014-06-05 17:20:46 +0800422 if (opt == NULL) {
423 const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
424 if (desc && desc->def_value_str) {
425 parse_option_number(name, desc->def_value_str, &ret, &error_abort);
426 }
427 return ret;
428 }
429 assert(opt->desc && opt->desc->type == QEMU_OPT_NUMBER);
430 ret = opt->value.uint;
431 if (del) {
432 qemu_opt_del_all(opts, name);
433 }
434 return ret;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200435}
436
437uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval)
438{
Chunyan Liu782730b2014-06-05 17:20:46 +0800439 return qemu_opt_get_number_helper(opts, name, defval, false);
440}
441
442uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name,
443 uint64_t defval)
444{
445 return qemu_opt_get_number_helper(opts, name, defval, true);
446}
447
448static uint64_t qemu_opt_get_size_helper(QemuOpts *opts, const char *name,
449 uint64_t defval, bool del)
450{
Chunyan Liu435db4c2014-06-18 10:47:26 +0800451 QemuOpt *opt;
Chunyan Liu782730b2014-06-05 17:20:46 +0800452 uint64_t ret = defval;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200453
Chunyan Liu435db4c2014-06-18 10:47:26 +0800454 if (opts == NULL) {
455 return ret;
456 }
457
458 opt = qemu_opt_find(opts, name);
Chunyan Liu09722032014-06-05 17:20:42 +0800459 if (opt == NULL) {
460 const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
461 if (desc && desc->def_value_str) {
Chunyan Liu782730b2014-06-05 17:20:46 +0800462 parse_option_size(name, desc->def_value_str, &ret, &error_abort);
Chunyan Liu09722032014-06-05 17:20:42 +0800463 }
Chunyan Liu782730b2014-06-05 17:20:46 +0800464 return ret;
Chunyan Liu09722032014-06-05 17:20:42 +0800465 }
Chunyan Liu782730b2014-06-05 17:20:46 +0800466 assert(opt->desc && opt->desc->type == QEMU_OPT_SIZE);
467 ret = opt->value.uint;
468 if (del) {
469 qemu_opt_del_all(opts, name);
470 }
471 return ret;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200472}
473
474uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval)
475{
Chunyan Liu782730b2014-06-05 17:20:46 +0800476 return qemu_opt_get_size_helper(opts, name, defval, false);
477}
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200478
Chunyan Liu782730b2014-06-05 17:20:46 +0800479uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name,
480 uint64_t defval)
481{
482 return qemu_opt_get_size_helper(opts, name, defval, true);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200483}
484
Luiz Capitulino6c519402012-03-21 15:21:26 -0300485static void qemu_opt_parse(QemuOpt *opt, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200486{
487 if (opt->desc == NULL)
Luiz Capitulino6c519402012-03-21 15:21:26 -0300488 return;
Luiz Capitulino2f39df52012-03-21 14:37:44 -0300489
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200490 switch (opt->desc->type) {
491 case QEMU_OPT_STRING:
492 /* nothing */
Luiz Capitulino6c519402012-03-21 15:21:26 -0300493 return;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200494 case QEMU_OPT_BOOL:
Luiz Capitulino6c519402012-03-21 15:21:26 -0300495 parse_option_bool(opt->name, opt->str, &opt->value.boolean, errp);
Luiz Capitulinocf62adf2012-03-21 14:54:42 -0300496 break;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200497 case QEMU_OPT_NUMBER:
Luiz Capitulino6c519402012-03-21 15:21:26 -0300498 parse_option_number(opt->name, opt->str, &opt->value.uint, errp);
Luiz Capitulino2f39df52012-03-21 14:37:44 -0300499 break;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200500 case QEMU_OPT_SIZE:
Luiz Capitulino6c519402012-03-21 15:21:26 -0300501 parse_option_size(opt->name, opt->str, &opt->value.uint, errp);
Luiz Capitulinoec7b2cc2012-03-21 15:03:45 -0300502 break;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200503 default:
504 abort();
505 }
506}
507
Dong Xu Wangc474ced2012-12-06 14:47:18 +0800508static bool opts_accepts_any(const QemuOpts *opts)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200509{
Dong Xu Wangc474ced2012-12-06 14:47:18 +0800510 return opts->list->desc[0].name == NULL;
511}
512
Kevin Wolf0dd6c522013-07-17 14:40:37 +0200513int qemu_opt_unset(QemuOpts *opts, const char *name)
514{
515 QemuOpt *opt = qemu_opt_find(opts, name);
516
517 assert(opts_accepts_any(opts));
518
519 if (opt == NULL) {
520 return -1;
521 } else {
522 qemu_opt_del(opt);
523 return 0;
524 }
525}
526
Dong Xu Wangc474ced2012-12-06 14:47:18 +0800527static void opt_set(QemuOpts *opts, const char *name, const char *value,
528 bool prepend, Error **errp)
529{
530 QemuOpt *opt;
531 const QemuOptDesc *desc;
532 Error *local_err = NULL;
533
534 desc = find_desc_by_name(opts->list->desc, name);
535 if (!desc && !opts_accepts_any(opts)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100536 error_setg(errp, QERR_INVALID_PARAMETER, name);
Dong Xu Wangc474ced2012-12-06 14:47:18 +0800537 return;
Mark McLoughlindc9ca4b2009-10-06 12:17:04 +0100538 }
539
Anthony Liguori7267c092011-08-20 22:09:37 -0500540 opt = g_malloc0(sizeof(*opt));
541 opt->name = g_strdup(name);
Mark McLoughlindc9ca4b2009-10-06 12:17:04 +0100542 opt->opts = opts;
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100543 if (prepend) {
544 QTAILQ_INSERT_HEAD(&opts->head, opt, next);
545 } else {
546 QTAILQ_INSERT_TAIL(&opts->head, opt, next);
547 }
Dong Xu Wangc474ced2012-12-06 14:47:18 +0800548 opt->desc = desc;
Markus Armbrusterc64f50d2013-01-22 11:07:57 +0100549 opt->str = g_strdup(value);
Luiz Capitulino6c519402012-03-21 15:21:26 -0300550 qemu_opt_parse(opt, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100551 if (local_err) {
Luiz Capitulino584d4062012-03-21 16:13:24 -0300552 error_propagate(errp, local_err);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200553 qemu_opt_del(opt);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200554 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200555}
556
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100557void qemu_opt_set(QemuOpts *opts, const char *name, const char *value,
558 Error **errp)
Luiz Capitulino384f2132012-03-21 16:17:21 -0300559{
560 opt_set(opts, name, value, false, errp);
561}
562
Markus Armbrustercccb7962015-02-12 16:37:44 +0100563void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
564 Error **errp)
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530565{
566 QemuOpt *opt;
567 const QemuOptDesc *desc = opts->list->desc;
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530568
569 opt = g_malloc0(sizeof(*opt));
Dong Xu Wangad718d02012-12-06 14:47:20 +0800570 opt->desc = find_desc_by_name(desc, name);
571 if (!opt->desc && !opts_accepts_any(opts)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100572 error_setg(errp, QERR_INVALID_PARAMETER, name);
Dong Xu Wangad718d02012-12-06 14:47:20 +0800573 g_free(opt);
Markus Armbrustercccb7962015-02-12 16:37:44 +0100574 return;
Dong Xu Wangad718d02012-12-06 14:47:20 +0800575 }
576
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530577 opt->name = g_strdup(name);
578 opt->opts = opts;
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530579 opt->value.boolean = !!val;
Dong Xu Wangad718d02012-12-06 14:47:20 +0800580 opt->str = g_strdup(val ? "on" : "off");
581 QTAILQ_INSERT_TAIL(&opts->head, opt, next);
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530582}
583
Markus Armbruster39101f22015-02-12 16:46:36 +0100584void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
585 Error **errp)
Dong Xu Wangb83c18e2012-12-06 14:47:23 +0800586{
587 QemuOpt *opt;
588 const QemuOptDesc *desc = opts->list->desc;
589
590 opt = g_malloc0(sizeof(*opt));
591 opt->desc = find_desc_by_name(desc, name);
592 if (!opt->desc && !opts_accepts_any(opts)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100593 error_setg(errp, QERR_INVALID_PARAMETER, name);
Dong Xu Wangb83c18e2012-12-06 14:47:23 +0800594 g_free(opt);
Markus Armbruster39101f22015-02-12 16:46:36 +0100595 return;
Dong Xu Wangb83c18e2012-12-06 14:47:23 +0800596 }
597
598 opt->name = g_strdup(name);
599 opt->opts = opts;
600 opt->value.uint = val;
601 opt->str = g_strdup_printf("%" PRId64, val);
602 QTAILQ_INSERT_TAIL(&opts->head, opt, next);
Dong Xu Wangb83c18e2012-12-06 14:47:23 +0800603}
604
Markus Armbruster1640b202015-03-12 07:45:10 +0100605/**
Markus Armbruster71df1d82015-03-12 08:40:25 +0100606 * For each member of @opts, call @func(@opaque, name, value, @errp).
607 * @func() may store an Error through @errp, but must return non-zero then.
Markus Armbruster1640b202015-03-12 07:45:10 +0100608 * When @func() returns non-zero, break the loop and return that value.
609 * Return zero when the loop completes.
610 */
Markus Armbruster71df1d82015-03-12 08:40:25 +0100611int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
612 Error **errp)
Gerd Hoffmann48026072009-07-31 12:25:32 +0200613{
614 QemuOpt *opt;
Markus Armbruster1640b202015-03-12 07:45:10 +0100615 int rc;
Gerd Hoffmann48026072009-07-31 12:25:32 +0200616
Blue Swirl72cf2d42009-09-12 07:36:22 +0000617 QTAILQ_FOREACH(opt, &opts->head, next) {
Markus Armbruster71df1d82015-03-12 08:40:25 +0100618 rc = func(opaque, opt->name, opt->str, errp);
Markus Armbruster1640b202015-03-12 07:45:10 +0100619 if (rc) {
620 return rc;
621 }
Markus Armbruster71df1d82015-03-12 08:40:25 +0100622 assert(!errp || !*errp);
Gerd Hoffmann48026072009-07-31 12:25:32 +0200623 }
Markus Armbruster1640b202015-03-12 07:45:10 +0100624 return 0;
Gerd Hoffmann48026072009-07-31 12:25:32 +0200625}
626
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200627QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id)
628{
629 QemuOpts *opts;
630
Blue Swirl72cf2d42009-09-12 07:36:22 +0000631 QTAILQ_FOREACH(opts, &list->head, next) {
Markus Armbruster96bc97e2013-07-04 15:09:17 +0200632 if (!opts->id && !id) {
633 return opts;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200634 }
Markus Armbruster96bc97e2013-07-04 15:09:17 +0200635 if (opts->id && id && !strcmp(opts->id, id)) {
636 return opts;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200637 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200638 }
639 return NULL;
640}
641
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300642QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
643 int fail_if_exists, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200644{
645 QemuOpts *opts = NULL;
646
647 if (id) {
Markus Armbrusterf5bebbb2014-09-30 13:59:30 +0200648 if (!id_wellformed(id)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +0100649 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "id",
650 "an identifier");
Eric Blake50b7b002015-09-10 10:19:16 -0600651 error_append_hint(errp, "Identifiers consist of letters, digits, "
Markus Armbruster543202c2015-12-17 17:35:14 +0100652 "'-', '.', '_', starting with a letter.\n");
Markus Armbrusterb560a9a2010-06-08 13:54:26 +0200653 return NULL;
654 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200655 opts = qemu_opts_find(list, id);
656 if (opts != NULL) {
Peter Maydellda933182012-02-08 05:41:37 +0000657 if (fail_if_exists && !list->merge_lists) {
Cole Robinsonf231b882014-03-21 19:42:26 -0400658 error_setg(errp, "Duplicate ID '%s' for %s", id, list->name);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200659 return NULL;
660 } else {
661 return opts;
662 }
663 }
Peter Maydellda933182012-02-08 05:41:37 +0000664 } else if (list->merge_lists) {
665 opts = qemu_opts_find(list, NULL);
666 if (opts) {
667 return opts;
668 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200669 }
Anthony Liguori7267c092011-08-20 22:09:37 -0500670 opts = g_malloc0(sizeof(*opts));
Markus Armbrusterc64f50d2013-01-22 11:07:57 +0100671 opts->id = g_strdup(id);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200672 opts->list = list;
Markus Armbruster827b0812010-02-18 19:46:49 +0100673 loc_save(&opts->loc);
Blue Swirl72cf2d42009-09-12 07:36:22 +0000674 QTAILQ_INIT(&opts->head);
675 QTAILQ_INSERT_TAIL(&list->head, opts, next);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200676 return opts;
677}
678
Markus Armbrusterbb67ab02010-06-01 10:47:34 +0200679void qemu_opts_reset(QemuOptsList *list)
680{
681 QemuOpts *opts, *next_opts;
682
683 QTAILQ_FOREACH_SAFE(opts, &list->head, next, next_opts) {
684 qemu_opts_del(opts);
685 }
686}
687
Markus Armbruster94ac7262010-05-27 21:06:04 +0200688void qemu_opts_loc_restore(QemuOpts *opts)
689{
690 loc_restore(&opts->loc);
691}
692
Markus Armbruster79087c72015-02-12 17:07:34 +0100693void qemu_opts_set(QemuOptsList *list, const char *id,
694 const char *name, const char *value, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200695{
696 QemuOpts *opts;
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300697 Error *local_err = NULL;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200698
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300699 opts = qemu_opts_create(list, id, 1, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100700 if (local_err) {
Markus Armbruster79087c72015-02-12 17:07:34 +0100701 error_propagate(errp, local_err);
702 return;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200703 }
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100704 qemu_opt_set(opts, name, value, errp);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200705}
706
Gerd Hoffmann48026072009-07-31 12:25:32 +0200707const char *qemu_opts_id(QemuOpts *opts)
708{
709 return opts->id;
710}
711
Kevin Wolf326642b2013-07-11 12:52:34 +0200712/* The id string will be g_free()d by qemu_opts_del */
713void qemu_opts_set_id(QemuOpts *opts, char *id)
714{
715 opts->id = id;
716}
717
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200718void qemu_opts_del(QemuOpts *opts)
719{
720 QemuOpt *opt;
721
Chunyan Liu47821832014-06-05 17:20:50 +0800722 if (opts == NULL) {
723 return;
724 }
725
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200726 for (;;) {
Blue Swirl72cf2d42009-09-12 07:36:22 +0000727 opt = QTAILQ_FIRST(&opts->head);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200728 if (opt == NULL)
729 break;
730 qemu_opt_del(opt);
731 }
Blue Swirl72cf2d42009-09-12 07:36:22 +0000732 QTAILQ_REMOVE(&opts->list->head, opts, next);
Anthony Liguori7267c092011-08-20 22:09:37 -0500733 g_free(opts->id);
734 g_free(opts);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200735}
736
Kővágó, Zoltánfe646692015-07-07 16:42:10 +0200737/* print value, escaping any commas in value */
738static void escaped_print(const char *value)
739{
740 const char *ptr;
741
742 for (ptr = value; *ptr; ++ptr) {
743 if (*ptr == ',') {
744 putchar(',');
745 }
746 putchar(*ptr);
747 }
748}
749
750void qemu_opts_print(QemuOpts *opts, const char *separator)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200751{
752 QemuOpt *opt;
Chunyan Liu09722032014-06-05 17:20:42 +0800753 QemuOptDesc *desc = opts->list->desc;
Kővágó, Zoltánfe646692015-07-07 16:42:10 +0200754 const char *sep = "";
755
756 if (opts->id) {
757 printf("id=%s", opts->id); /* passed id_wellformed -> no commas */
758 sep = separator;
759 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200760
Chunyan Liu09722032014-06-05 17:20:42 +0800761 if (desc[0].name == NULL) {
762 QTAILQ_FOREACH(opt, &opts->head, next) {
Kővágó, Zoltánfe646692015-07-07 16:42:10 +0200763 printf("%s%s=", sep, opt->name);
764 escaped_print(opt->str);
765 sep = separator;
Chunyan Liu09722032014-06-05 17:20:42 +0800766 }
767 return;
768 }
769 for (; desc && desc->name; desc++) {
770 const char *value;
771 QemuOpt *opt = qemu_opt_find(opts, desc->name);
772
773 value = opt ? opt->str : desc->def_value_str;
774 if (!value) {
775 continue;
776 }
777 if (desc->type == QEMU_OPT_STRING) {
Kővágó, Zoltánfe646692015-07-07 16:42:10 +0200778 printf("%s%s=", sep, desc->name);
779 escaped_print(value);
Chunyan Liu09722032014-06-05 17:20:42 +0800780 } else if ((desc->type == QEMU_OPT_SIZE ||
781 desc->type == QEMU_OPT_NUMBER) && opt) {
Fam Zheng43c5d8f2014-12-09 15:38:04 +0800782 printf("%s%s=%" PRId64, sep, desc->name, opt->value.uint);
Chunyan Liu09722032014-06-05 17:20:42 +0800783 } else {
Fam Zheng43c5d8f2014-12-09 15:38:04 +0800784 printf("%s%s=%s", sep, desc->name, value);
Chunyan Liu09722032014-06-05 17:20:42 +0800785 }
Kővágó, Zoltánfe646692015-07-07 16:42:10 +0200786 sep = separator;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200787 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200788}
789
Markus Armbrusterd93ae3c2015-02-12 17:59:06 +0100790static void opts_do_parse(QemuOpts *opts, const char *params,
791 const char *firstname, bool prepend, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200792{
Gerd Hoffmannd318ff92009-12-10 11:11:08 +0100793 char option[128], value[1024];
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200794 const char *p,*pe,*pc;
Luiz Capitulino584d4062012-03-21 16:13:24 -0300795 Error *local_err = NULL;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200796
Mark McLoughlin2cfa5712009-10-06 12:17:02 +0100797 for (p = params; *p != '\0'; p++) {
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200798 pe = strchr(p, '=');
799 pc = strchr(p, ',');
800 if (!pe || (pc && pc < pe)) {
801 /* found "foo,more" */
802 if (p == params && firstname) {
803 /* implicitly named first option */
804 pstrcpy(option, sizeof(option), firstname);
805 p = get_opt_value(value, sizeof(value), p);
806 } else {
807 /* option without value, probably a flag */
808 p = get_opt_name(option, sizeof(option), p, ',');
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200809 if (strncmp(option, "no", 2) == 0) {
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200810 memmove(option, option+2, strlen(option+2)+1);
811 pstrcpy(value, sizeof(value), "off");
812 } else {
813 pstrcpy(value, sizeof(value), "on");
814 }
815 }
816 } else {
817 /* found "foo=bar,more" */
818 p = get_opt_name(option, sizeof(option), p, '=');
819 if (*p != '=') {
820 break;
821 }
822 p++;
823 p = get_opt_value(value, sizeof(value), p);
824 }
825 if (strcmp(option, "id") != 0) {
826 /* store and parse */
Luiz Capitulino584d4062012-03-21 16:13:24 -0300827 opt_set(opts, option, value, prepend, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100828 if (local_err) {
Markus Armbrusterd93ae3c2015-02-12 17:59:06 +0100829 error_propagate(errp, local_err);
830 return;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200831 }
832 }
833 if (*p != ',') {
834 break;
835 }
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200836 }
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200837}
838
Markus Armbrusterdc523cd342015-02-12 18:37:11 +0100839/**
840 * Store options parsed from @params into @opts.
841 * If @firstname is non-null, the first key=value in @params may omit
842 * key=, and is treated as if key was @firstname.
843 * On error, store an error object through @errp if non-null.
844 */
845void qemu_opts_do_parse(QemuOpts *opts, const char *params,
846 const char *firstname, Error **errp)
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100847{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +0100848 opts_do_parse(opts, params, firstname, false, errp);
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100849}
850
851static QemuOpts *opts_parse(QemuOptsList *list, const char *params,
Markus Armbruster70b94332015-02-13 12:50:26 +0100852 bool permit_abbrev, bool defaults, Error **errp)
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200853{
Markus Armbruster8212c642010-02-10 19:52:18 +0100854 const char *firstname;
Gerd Hoffmannd318ff92009-12-10 11:11:08 +0100855 char value[1024], *id = NULL;
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200856 const char *p;
857 QemuOpts *opts;
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300858 Error *local_err = NULL;
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200859
Markus Armbruster8212c642010-02-10 19:52:18 +0100860 assert(!permit_abbrev || list->implied_opt_name);
861 firstname = permit_abbrev ? list->implied_opt_name : NULL;
862
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200863 if (strncmp(params, "id=", 3) == 0) {
864 get_opt_value(value, sizeof(value), params+3);
Jan Kiszkad510c5c2010-04-29 18:24:43 +0200865 id = value;
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200866 } else if ((p = strstr(params, ",id=")) != NULL) {
867 get_opt_value(value, sizeof(value), p+4);
Jan Kiszkad510c5c2010-04-29 18:24:43 +0200868 id = value;
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200869 }
Markus Armbrustercb77d192013-08-02 09:34:00 +0200870
871 /*
872 * This code doesn't work for defaults && !list->merge_lists: when
873 * params has no id=, and list has an element with !opts->id, it
874 * appends a new element instead of returning the existing opts.
875 * However, we got no use for this case. Guard against possible
876 * (if unlikely) future misuse:
877 */
878 assert(!defaults || list->merge_lists);
Markus Armbruster6d4cd402013-07-04 15:09:18 +0200879 opts = qemu_opts_create(list, id, !defaults, &local_err);
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300880 if (opts == NULL) {
Markus Armbruster4f812732015-02-12 18:24:10 +0100881 error_propagate(errp, local_err);
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200882 return NULL;
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300883 }
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200884
Markus Armbrusterd93ae3c2015-02-12 17:59:06 +0100885 opts_do_parse(opts, params, firstname, defaults, &local_err);
886 if (local_err) {
Markus Armbruster4f812732015-02-12 18:24:10 +0100887 error_propagate(errp, local_err);
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200888 qemu_opts_del(opts);
889 return NULL;
890 }
891
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200892 return opts;
893}
894
Markus Armbruster4f812732015-02-12 18:24:10 +0100895/**
896 * Create a QemuOpts in @list and with options parsed from @params.
897 * If @permit_abbrev, the first key=value in @params may omit key=,
898 * and is treated as if key was @list->implied_opt_name.
Markus Armbruster70b94332015-02-13 12:50:26 +0100899 * On error, store an error object through @errp if non-null.
Markus Armbruster4f812732015-02-12 18:24:10 +0100900 * Return the new QemuOpts on success, null pointer on error.
901 */
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100902QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
Markus Armbruster70b94332015-02-13 12:50:26 +0100903 bool permit_abbrev, Error **errp)
904{
905 return opts_parse(list, params, permit_abbrev, false, errp);
906}
907
908/**
909 * Create a QemuOpts in @list and with options parsed from @params.
910 * If @permit_abbrev, the first key=value in @params may omit key=,
911 * and is treated as if key was @list->implied_opt_name.
912 * Report errors with error_report_err(). This is inappropriate in
913 * QMP context. Do not use this function there!
914 * Return the new QemuOpts on success, null pointer on error.
915 */
916QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params,
917 bool permit_abbrev)
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100918{
Markus Armbruster4f812732015-02-12 18:24:10 +0100919 Error *err = NULL;
920 QemuOpts *opts;
921
922 opts = opts_parse(list, params, permit_abbrev, false, &err);
Markus Armbruster70b94332015-02-13 12:50:26 +0100923 if (err) {
924 error_report_err(err);
Markus Armbruster4f812732015-02-12 18:24:10 +0100925 }
926 return opts;
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100927}
928
929void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
930 int permit_abbrev)
931{
932 QemuOpts *opts;
933
Markus Armbruster4f812732015-02-12 18:24:10 +0100934 opts = opts_parse(list, params, permit_abbrev, true, NULL);
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100935 assert(opts);
936}
937
Luiz Capitulino4e899782012-04-18 17:24:01 -0300938typedef struct OptsFromQDictState {
939 QemuOpts *opts;
940 Error **errp;
941} OptsFromQDictState;
942
Markus Armbruster01e7f182010-02-10 20:15:29 +0100943static void qemu_opts_from_qdict_1(const char *key, QObject *obj, void *opaque)
944{
Luiz Capitulino4e899782012-04-18 17:24:01 -0300945 OptsFromQDictState *state = opaque;
Markus Armbruster01e7f182010-02-10 20:15:29 +0100946 char buf[32];
947 const char *value;
948 int n;
949
Markus Armbruster2767cee2014-05-02 13:26:40 +0200950 if (!strcmp(key, "id") || *state->errp) {
Markus Armbruster01e7f182010-02-10 20:15:29 +0100951 return;
952 }
953
954 switch (qobject_type(obj)) {
955 case QTYPE_QSTRING:
956 value = qstring_get_str(qobject_to_qstring(obj));
957 break;
958 case QTYPE_QINT:
959 n = snprintf(buf, sizeof(buf), "%" PRId64,
960 qint_get_int(qobject_to_qint(obj)));
961 assert(n < sizeof(buf));
962 value = buf;
963 break;
964 case QTYPE_QFLOAT:
965 n = snprintf(buf, sizeof(buf), "%.17g",
966 qfloat_get_double(qobject_to_qfloat(obj)));
967 assert(n < sizeof(buf));
968 value = buf;
969 break;
970 case QTYPE_QBOOL:
Blue Swirld35215f2010-03-18 20:48:19 +0000971 pstrcpy(buf, sizeof(buf),
Eric Blakefc48ffc2015-05-15 16:24:59 -0600972 qbool_get_bool(qobject_to_qbool(obj)) ? "on" : "off");
Markus Armbruster01e7f182010-02-10 20:15:29 +0100973 value = buf;
974 break;
975 default:
976 return;
977 }
Luiz Capitulino4e899782012-04-18 17:24:01 -0300978
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100979 qemu_opt_set(state->opts, key, value, state->errp);
Markus Armbruster01e7f182010-02-10 20:15:29 +0100980}
981
982/*
983 * Create QemuOpts from a QDict.
984 * Use value of key "id" as ID if it exists and is a QString.
985 * Only QStrings, QInts, QFloats and QBools are copied. Entries with
986 * other types are silently ignored.
987 */
Luiz Capitulino4e899782012-04-18 17:24:01 -0300988QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
989 Error **errp)
Markus Armbruster01e7f182010-02-10 20:15:29 +0100990{
Luiz Capitulino4e899782012-04-18 17:24:01 -0300991 OptsFromQDictState state;
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300992 Error *local_err = NULL;
Luiz Capitulino4e899782012-04-18 17:24:01 -0300993 QemuOpts *opts;
Markus Armbruster01e7f182010-02-10 20:15:29 +0100994
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300995 opts = qemu_opts_create(list, qdict_get_try_str(qdict, "id"), 1,
996 &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100997 if (local_err) {
Luiz Capitulino4e899782012-04-18 17:24:01 -0300998 error_propagate(errp, local_err);
Markus Armbruster01e7f182010-02-10 20:15:29 +0100999 return NULL;
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -03001000 }
Markus Armbruster01e7f182010-02-10 20:15:29 +01001001
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -03001002 assert(opts != NULL);
Luiz Capitulino4e899782012-04-18 17:24:01 -03001003
1004 state.errp = &local_err;
1005 state.opts = opts;
1006 qdict_iter(qdict, qemu_opts_from_qdict_1, &state);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001007 if (local_err) {
Luiz Capitulino4e899782012-04-18 17:24:01 -03001008 error_propagate(errp, local_err);
1009 qemu_opts_del(opts);
1010 return NULL;
1011 }
1012
Markus Armbruster01e7f182010-02-10 20:15:29 +01001013 return opts;
1014}
1015
1016/*
Kevin Wolf376609c2013-03-15 10:35:05 +01001017 * Adds all QDict entries to the QemuOpts that can be added and removes them
1018 * from the QDict. When this function returns, the QDict contains only those
1019 * entries that couldn't be added to the QemuOpts.
1020 */
1021void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp)
1022{
1023 const QDictEntry *entry, *next;
1024
1025 entry = qdict_first(qdict);
1026
1027 while (entry != NULL) {
1028 Error *local_err = NULL;
1029 OptsFromQDictState state = {
1030 .errp = &local_err,
1031 .opts = opts,
1032 };
1033
1034 next = qdict_next(qdict, entry);
1035
1036 if (find_desc_by_name(opts->list->desc, entry->key)) {
1037 qemu_opts_from_qdict_1(entry->key, entry->value, &state);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001038 if (local_err) {
Kevin Wolf376609c2013-03-15 10:35:05 +01001039 error_propagate(errp, local_err);
1040 return;
1041 } else {
1042 qdict_del(qdict, entry->key);
1043 }
1044 }
1045
1046 entry = next;
1047 }
1048}
1049
1050/*
Markus Armbruster01e7f182010-02-10 20:15:29 +01001051 * Convert from QemuOpts to QDict.
1052 * The QDict values are of type QString.
1053 * TODO We'll want to use types appropriate for opt->desc->type, but
1054 * this is enough for now.
1055 */
1056QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict)
1057{
1058 QemuOpt *opt;
1059 QObject *val;
1060
1061 if (!qdict) {
1062 qdict = qdict_new();
1063 }
1064 if (opts->id) {
1065 qdict_put(qdict, "id", qstring_from_str(opts->id));
1066 }
1067 QTAILQ_FOREACH(opt, &opts->head, next) {
1068 val = QOBJECT(qstring_from_str(opt->str));
1069 qdict_put_obj(qdict, opt->name, val);
1070 }
1071 return qdict;
1072}
1073
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001074/* Validate parsed opts against descriptions where no
1075 * descriptions were provided in the QemuOptsList.
1076 */
Luiz Capitulino29952862012-04-12 11:58:57 -03001077void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001078{
1079 QemuOpt *opt;
Luiz Capitulino6c519402012-03-21 15:21:26 -03001080 Error *local_err = NULL;
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001081
Dong Xu Wangdb97ceb2012-12-06 14:47:19 +08001082 assert(opts_accepts_any(opts));
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001083
1084 QTAILQ_FOREACH(opt, &opts->head, next) {
Dong Xu Wangdb97ceb2012-12-06 14:47:19 +08001085 opt->desc = find_desc_by_name(desc, opt->name);
1086 if (!opt->desc) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001087 error_setg(errp, QERR_INVALID_PARAMETER, opt->name);
Luiz Capitulino29952862012-04-12 11:58:57 -03001088 return;
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001089 }
1090
Luiz Capitulino6c519402012-03-21 15:21:26 -03001091 qemu_opt_parse(opt, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001092 if (local_err) {
Luiz Capitulino29952862012-04-12 11:58:57 -03001093 error_propagate(errp, local_err);
1094 return;
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001095 }
1096 }
Mark McLoughlin5dc519e2009-10-06 12:17:03 +01001097}
1098
Markus Armbrustera4c73672015-03-13 11:07:24 +01001099/**
Markus Armbruster28d0de72015-03-13 13:35:14 +01001100 * For each member of @list, call @func(@opaque, member, @errp).
Markus Armbrustera4c73672015-03-13 11:07:24 +01001101 * Call it with the current location temporarily set to the member's.
Markus Armbruster28d0de72015-03-13 13:35:14 +01001102 * @func() may store an Error through @errp, but must return non-zero then.
Markus Armbrustera4c73672015-03-13 11:07:24 +01001103 * When @func() returns non-zero, break the loop and return that value.
1104 * Return zero when the loop completes.
1105 */
1106int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func,
Markus Armbruster28d0de72015-03-13 13:35:14 +01001107 void *opaque, Error **errp)
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +02001108{
Markus Armbruster827b0812010-02-18 19:46:49 +01001109 Location loc;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +02001110 QemuOpts *opts;
Markus Armbruster37f32342016-04-27 16:29:07 +02001111 int rc = 0;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +02001112
Markus Armbruster827b0812010-02-18 19:46:49 +01001113 loc_push_none(&loc);
Blue Swirl72cf2d42009-09-12 07:36:22 +00001114 QTAILQ_FOREACH(opts, &list->head, next) {
Markus Armbruster827b0812010-02-18 19:46:49 +01001115 loc_restore(&opts->loc);
Markus Armbruster28d0de72015-03-13 13:35:14 +01001116 rc = func(opaque, opts, errp);
Markus Armbrustera4c73672015-03-13 11:07:24 +01001117 if (rc) {
Markus Armbruster37f32342016-04-27 16:29:07 +02001118 break;
Markus Armbrustera4c73672015-03-13 11:07:24 +01001119 }
Markus Armbruster28d0de72015-03-13 13:35:14 +01001120 assert(!errp || !*errp);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +02001121 }
Markus Armbruster827b0812010-02-18 19:46:49 +01001122 loc_pop(&loc);
Markus Armbruster37f32342016-04-27 16:29:07 +02001123 return rc;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +02001124}
Chunyan Liu8559e452014-06-05 17:20:48 +08001125
1126static size_t count_opts_list(QemuOptsList *list)
1127{
1128 QemuOptDesc *desc = NULL;
1129 size_t num_opts = 0;
1130
1131 if (!list) {
1132 return 0;
1133 }
1134
1135 desc = list->desc;
1136 while (desc && desc->name) {
1137 num_opts++;
1138 desc++;
1139 }
1140
1141 return num_opts;
1142}
1143
Chunyan Liu8559e452014-06-05 17:20:48 +08001144void qemu_opts_free(QemuOptsList *list)
1145{
Chunyan Liu8559e452014-06-05 17:20:48 +08001146 g_free(list);
1147}
Chunyan Liua1097a22014-06-05 17:20:49 +08001148
Chunyan Liuc282e1f2014-06-05 17:21:11 +08001149/* Realloc dst option list and append options from an option list (list)
1150 * to it. dst could be NULL or a malloced list.
Chunyan Liu98d896d2014-06-05 17:21:12 +08001151 * The lifetime of dst must be shorter than the input list because the
1152 * QemuOptDesc->name, ->help, and ->def_value_str strings are shared.
Chunyan Liua1097a22014-06-05 17:20:49 +08001153 */
1154QemuOptsList *qemu_opts_append(QemuOptsList *dst,
Chunyan Liuc282e1f2014-06-05 17:21:11 +08001155 QemuOptsList *list)
Chunyan Liua1097a22014-06-05 17:20:49 +08001156{
1157 size_t num_opts, num_dst_opts;
1158 QemuOptDesc *desc;
1159 bool need_init = false;
Michal Privoznika7607152014-06-25 10:38:41 +02001160 bool need_head_update;
Chunyan Liua1097a22014-06-05 17:20:49 +08001161
Chunyan Liuc282e1f2014-06-05 17:21:11 +08001162 if (!list) {
Chunyan Liua1097a22014-06-05 17:20:49 +08001163 return dst;
1164 }
1165
Chunyan Liua1097a22014-06-05 17:20:49 +08001166 /* If dst is NULL, after realloc, some area of dst should be initialized
1167 * before adding options to it.
1168 */
1169 if (!dst) {
1170 need_init = true;
Michal Privoznika7607152014-06-25 10:38:41 +02001171 need_head_update = true;
1172 } else {
1173 /* Moreover, even if dst is not NULL, the realloc may move it to a
1174 * different address in which case we may get a stale tail pointer
1175 * in dst->head. */
1176 need_head_update = QTAILQ_EMPTY(&dst->head);
Chunyan Liua1097a22014-06-05 17:20:49 +08001177 }
1178
1179 num_opts = count_opts_list(dst);
1180 num_dst_opts = num_opts;
1181 num_opts += count_opts_list(list);
1182 dst = g_realloc(dst, sizeof(QemuOptsList) +
1183 (num_opts + 1) * sizeof(QemuOptDesc));
1184 if (need_init) {
1185 dst->name = NULL;
1186 dst->implied_opt_name = NULL;
Chunyan Liua1097a22014-06-05 17:20:49 +08001187 dst->merge_lists = false;
1188 }
Michal Privoznika7607152014-06-25 10:38:41 +02001189 if (need_head_update) {
1190 QTAILQ_INIT(&dst->head);
1191 }
Chunyan Liua1097a22014-06-05 17:20:49 +08001192 dst->desc[num_dst_opts].name = NULL;
1193
Chunyan Liua1097a22014-06-05 17:20:49 +08001194 /* append list->desc to dst->desc */
1195 if (list) {
1196 desc = list->desc;
1197 while (desc && desc->name) {
1198 if (find_desc_by_name(dst->desc, desc->name) == NULL) {
Chunyan Liu98d896d2014-06-05 17:21:12 +08001199 dst->desc[num_dst_opts++] = *desc;
Chunyan Liua1097a22014-06-05 17:20:49 +08001200 dst->desc[num_dst_opts].name = NULL;
1201 }
1202 desc++;
1203 }
1204 }
1205
Chunyan Liua1097a22014-06-05 17:20:49 +08001206 return dst;
1207}