2 * Commandline option parsing functions
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #include "qemu/osdep.h"
28 #include "qapi/error.h"
29 #include "qemu-common.h"
30 #include "qemu/error-report.h"
31 #include "qapi/qmp/qbool.h"
32 #include "qapi/qmp/qdict.h"
33 #include "qapi/qmp/qnum.h"
34 #include "qapi/qmp/qstring.h"
35 #include "qapi/qmp/qerror.h"
36 #include "qemu/option_int.h"
37 #include "qemu/cutils.h"
39 #include "qemu/help_option.h"
42 * Extracts the name of an option from the parameter string (p points at the
43 * first byte of the option name)
45 * The option name is delimited by delim (usually , or =) or the string end
46 * and is copied into option. The caller is responsible for free'ing option
47 * when no longer required.
49 * The return value is the position of the delimiter/zero byte after the option
52 static const char *get_opt_name(const char *p
, char **option
, char delim
)
54 char *offset
= strchr(p
, delim
);
57 *option
= g_strndup(p
, offset
- p
);
60 *option
= g_strdup(p
);
66 * Extracts the value of an option from the parameter string p (p points at the
67 * first byte of the option value)
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.
73 const char *get_opt_value(const char *p
, char **value
)
75 size_t capacity
= 0, length
;
80 offset
= qemu_strchrnul(p
, ',');
82 if (*offset
!= '\0' && *(offset
+ 1) == ',') {
86 *value
= g_renew(char, *value
, capacity
+ length
+ 1);
87 strncpy(*value
+ capacity
, p
, length
);
88 (*value
)[capacity
+ length
] = '\0';
91 if (*offset
== '\0' ||
92 *(offset
+ 1) != ',') {
96 p
+= (offset
- p
) + 2;
102 static void parse_option_bool(const char *name
, const char *value
, bool *ret
,
105 if (!strcmp(value
, "on")) {
107 } else if (!strcmp(value
, "off")) {
110 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
111 name
, "'on' or 'off'");
115 static void parse_option_number(const char *name
, const char *value
,
116 uint64_t *ret
, Error
**errp
)
121 err
= qemu_strtou64(value
, NULL
, 0, &number
);
122 if (err
== -ERANGE
) {
123 error_setg(errp
, "Value '%s' is too large for parameter '%s'",
128 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, name
, "a number");
134 static const QemuOptDesc
*find_desc_by_name(const QemuOptDesc
*desc
,
139 for (i
= 0; desc
[i
].name
!= NULL
; i
++) {
140 if (strcmp(desc
[i
].name
, name
) == 0) {
148 void parse_option_size(const char *name
, const char *value
,
149 uint64_t *ret
, Error
**errp
)
154 err
= qemu_strtosz(value
, NULL
, &size
);
155 if (err
== -ERANGE
) {
156 error_setg(errp
, "Value '%s' is out of range for parameter '%s'",
161 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, name
,
162 "a non-negative number below 2^64");
163 error_append_hint(errp
, "Optional suffix k, M, G, T, P or E means"
164 " kilo-, mega-, giga-, tera-, peta-\n"
165 "and exabytes, respectively.\n");
171 bool has_help_option(const char *param
)
173 const char *p
= param
;
176 while (*p
&& !result
) {
179 p
= get_opt_value(p
, &value
);
184 result
= is_help_option(value
);
191 bool is_valid_option_list(const char *p
)
197 p
= get_opt_value(p
, &value
);
199 (!*value
|| *value
== ',')) {
213 void qemu_opts_print_help(QemuOptsList
*list
)
219 while (desc
&& desc
->name
) {
220 printf("%-16s %s\n", desc
->name
,
221 desc
->help
? desc
->help
: "No description available");
225 /* ------------------------------------------------------------------ */
227 QemuOpt
*qemu_opt_find(QemuOpts
*opts
, const char *name
)
231 QTAILQ_FOREACH_REVERSE(opt
, &opts
->head
, QemuOptHead
, next
) {
232 if (strcmp(opt
->name
, name
) != 0)
239 static void qemu_opt_del(QemuOpt
*opt
)
241 QTAILQ_REMOVE(&opt
->opts
->head
, opt
, next
);
247 /* qemu_opt_set allows many settings for the same option.
248 * This function deletes all settings for an option.
250 static void qemu_opt_del_all(QemuOpts
*opts
, const char *name
)
252 QemuOpt
*opt
, *next_opt
;
254 QTAILQ_FOREACH_SAFE(opt
, &opts
->head
, next
, next_opt
) {
255 if (!strcmp(opt
->name
, name
)) {
261 const char *qemu_opt_get(QemuOpts
*opts
, const char *name
)
269 opt
= qemu_opt_find(opts
, name
);
271 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
272 if (desc
&& desc
->def_value_str
) {
273 return desc
->def_value_str
;
276 return opt
? opt
->str
: NULL
;
279 void qemu_opt_iter_init(QemuOptsIter
*iter
, QemuOpts
*opts
, const char *name
)
282 iter
->opt
= QTAILQ_FIRST(&opts
->head
);
286 const char *qemu_opt_iter_next(QemuOptsIter
*iter
)
288 QemuOpt
*ret
= iter
->opt
;
290 while (ret
&& !g_str_equal(iter
->name
, ret
->name
)) {
291 ret
= QTAILQ_NEXT(ret
, next
);
294 iter
->opt
= ret
? QTAILQ_NEXT(ret
, next
) : NULL
;
295 return ret
? ret
->str
: NULL
;
298 /* Get a known option (or its default) and remove it from the list
299 * all in one action. Return a malloced string of the option value.
300 * Result must be freed by caller with g_free().
302 char *qemu_opt_get_del(QemuOpts
*opts
, const char *name
)
305 const QemuOptDesc
*desc
;
312 opt
= qemu_opt_find(opts
, name
);
314 desc
= find_desc_by_name(opts
->list
->desc
, name
);
315 if (desc
&& desc
->def_value_str
) {
316 str
= g_strdup(desc
->def_value_str
);
322 qemu_opt_del_all(opts
, name
);
326 bool qemu_opt_has_help_opt(QemuOpts
*opts
)
330 QTAILQ_FOREACH_REVERSE(opt
, &opts
->head
, QemuOptHead
, next
) {
331 if (is_help_option(opt
->name
)) {
338 static bool qemu_opt_get_bool_helper(QemuOpts
*opts
, const char *name
,
339 bool defval
, bool del
)
348 opt
= qemu_opt_find(opts
, name
);
350 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
351 if (desc
&& desc
->def_value_str
) {
352 parse_option_bool(name
, desc
->def_value_str
, &ret
, &error_abort
);
356 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_BOOL
);
357 ret
= opt
->value
.boolean
;
359 qemu_opt_del_all(opts
, name
);
364 bool qemu_opt_get_bool(QemuOpts
*opts
, const char *name
, bool defval
)
366 return qemu_opt_get_bool_helper(opts
, name
, defval
, false);
369 bool qemu_opt_get_bool_del(QemuOpts
*opts
, const char *name
, bool defval
)
371 return qemu_opt_get_bool_helper(opts
, name
, defval
, true);
374 static uint64_t qemu_opt_get_number_helper(QemuOpts
*opts
, const char *name
,
375 uint64_t defval
, bool del
)
378 uint64_t ret
= defval
;
384 opt
= qemu_opt_find(opts
, name
);
386 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
387 if (desc
&& desc
->def_value_str
) {
388 parse_option_number(name
, desc
->def_value_str
, &ret
, &error_abort
);
392 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_NUMBER
);
393 ret
= opt
->value
.uint
;
395 qemu_opt_del_all(opts
, name
);
400 uint64_t qemu_opt_get_number(QemuOpts
*opts
, const char *name
, uint64_t defval
)
402 return qemu_opt_get_number_helper(opts
, name
, defval
, false);
405 uint64_t qemu_opt_get_number_del(QemuOpts
*opts
, const char *name
,
408 return qemu_opt_get_number_helper(opts
, name
, defval
, true);
411 static uint64_t qemu_opt_get_size_helper(QemuOpts
*opts
, const char *name
,
412 uint64_t defval
, bool del
)
415 uint64_t ret
= defval
;
421 opt
= qemu_opt_find(opts
, name
);
423 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
424 if (desc
&& desc
->def_value_str
) {
425 parse_option_size(name
, desc
->def_value_str
, &ret
, &error_abort
);
429 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_SIZE
);
430 ret
= opt
->value
.uint
;
432 qemu_opt_del_all(opts
, name
);
437 uint64_t qemu_opt_get_size(QemuOpts
*opts
, const char *name
, uint64_t defval
)
439 return qemu_opt_get_size_helper(opts
, name
, defval
, false);
442 uint64_t qemu_opt_get_size_del(QemuOpts
*opts
, const char *name
,
445 return qemu_opt_get_size_helper(opts
, name
, defval
, true);
448 static void qemu_opt_parse(QemuOpt
*opt
, Error
**errp
)
450 if (opt
->desc
== NULL
)
453 switch (opt
->desc
->type
) {
454 case QEMU_OPT_STRING
:
458 parse_option_bool(opt
->name
, opt
->str
, &opt
->value
.boolean
, errp
);
460 case QEMU_OPT_NUMBER
:
461 parse_option_number(opt
->name
, opt
->str
, &opt
->value
.uint
, errp
);
464 parse_option_size(opt
->name
, opt
->str
, &opt
->value
.uint
, errp
);
471 static bool opts_accepts_any(const QemuOpts
*opts
)
473 return opts
->list
->desc
[0].name
== NULL
;
476 int qemu_opt_unset(QemuOpts
*opts
, const char *name
)
478 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
480 assert(opts_accepts_any(opts
));
490 static void opt_set(QemuOpts
*opts
, const char *name
, char *value
,
491 bool prepend
, Error
**errp
)
494 const QemuOptDesc
*desc
;
495 Error
*local_err
= NULL
;
497 desc
= find_desc_by_name(opts
->list
->desc
, name
);
498 if (!desc
&& !opts_accepts_any(opts
)) {
500 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
504 opt
= g_malloc0(sizeof(*opt
));
505 opt
->name
= g_strdup(name
);
508 QTAILQ_INSERT_HEAD(&opts
->head
, opt
, next
);
510 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
514 qemu_opt_parse(opt
, &local_err
);
516 error_propagate(errp
, local_err
);
521 void qemu_opt_set(QemuOpts
*opts
, const char *name
, const char *value
,
524 opt_set(opts
, name
, g_strdup(value
), false, errp
);
527 void qemu_opt_set_bool(QemuOpts
*opts
, const char *name
, bool val
,
531 const QemuOptDesc
*desc
= opts
->list
->desc
;
533 opt
= g_malloc0(sizeof(*opt
));
534 opt
->desc
= find_desc_by_name(desc
, name
);
535 if (!opt
->desc
&& !opts_accepts_any(opts
)) {
536 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
541 opt
->name
= g_strdup(name
);
543 opt
->value
.boolean
= !!val
;
544 opt
->str
= g_strdup(val
? "on" : "off");
545 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
548 void qemu_opt_set_number(QemuOpts
*opts
, const char *name
, int64_t val
,
552 const QemuOptDesc
*desc
= opts
->list
->desc
;
554 opt
= g_malloc0(sizeof(*opt
));
555 opt
->desc
= find_desc_by_name(desc
, name
);
556 if (!opt
->desc
&& !opts_accepts_any(opts
)) {
557 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
562 opt
->name
= g_strdup(name
);
564 opt
->value
.uint
= val
;
565 opt
->str
= g_strdup_printf("%" PRId64
, val
);
566 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
570 * For each member of @opts, call @func(@opaque, name, value, @errp).
571 * @func() may store an Error through @errp, but must return non-zero then.
572 * When @func() returns non-zero, break the loop and return that value.
573 * Return zero when the loop completes.
575 int qemu_opt_foreach(QemuOpts
*opts
, qemu_opt_loopfunc func
, void *opaque
,
581 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
582 rc
= func(opaque
, opt
->name
, opt
->str
, errp
);
586 assert(!errp
|| !*errp
);
591 QemuOpts
*qemu_opts_find(QemuOptsList
*list
, const char *id
)
595 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
596 if (!opts
->id
&& !id
) {
599 if (opts
->id
&& id
&& !strcmp(opts
->id
, id
)) {
606 QemuOpts
*qemu_opts_create(QemuOptsList
*list
, const char *id
,
607 int fail_if_exists
, Error
**errp
)
609 QemuOpts
*opts
= NULL
;
612 if (!id_wellformed(id
)) {
613 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "id",
615 error_append_hint(errp
, "Identifiers consist of letters, digits, "
616 "'-', '.', '_', starting with a letter.\n");
619 opts
= qemu_opts_find(list
, id
);
621 if (fail_if_exists
&& !list
->merge_lists
) {
622 error_setg(errp
, "Duplicate ID '%s' for %s", id
, list
->name
);
628 } else if (list
->merge_lists
) {
629 opts
= qemu_opts_find(list
, NULL
);
634 opts
= g_malloc0(sizeof(*opts
));
635 opts
->id
= g_strdup(id
);
637 loc_save(&opts
->loc
);
638 QTAILQ_INIT(&opts
->head
);
639 QTAILQ_INSERT_TAIL(&list
->head
, opts
, next
);
643 void qemu_opts_reset(QemuOptsList
*list
)
645 QemuOpts
*opts
, *next_opts
;
647 QTAILQ_FOREACH_SAFE(opts
, &list
->head
, next
, next_opts
) {
652 void qemu_opts_loc_restore(QemuOpts
*opts
)
654 loc_restore(&opts
->loc
);
657 void qemu_opts_set(QemuOptsList
*list
, const char *id
,
658 const char *name
, const char *value
, Error
**errp
)
661 Error
*local_err
= NULL
;
663 opts
= qemu_opts_create(list
, id
, 1, &local_err
);
665 error_propagate(errp
, local_err
);
668 qemu_opt_set(opts
, name
, value
, errp
);
671 const char *qemu_opts_id(QemuOpts
*opts
)
676 /* The id string will be g_free()d by qemu_opts_del */
677 void qemu_opts_set_id(QemuOpts
*opts
, char *id
)
682 void qemu_opts_del(QemuOpts
*opts
)
691 opt
= QTAILQ_FIRST(&opts
->head
);
696 QTAILQ_REMOVE(&opts
->list
->head
, opts
, next
);
701 /* print value, escaping any commas in value */
702 static void escaped_print(const char *value
)
706 for (ptr
= value
; *ptr
; ++ptr
) {
714 void qemu_opts_print(QemuOpts
*opts
, const char *separator
)
717 QemuOptDesc
*desc
= opts
->list
->desc
;
718 const char *sep
= "";
721 printf("id=%s", opts
->id
); /* passed id_wellformed -> no commas */
725 if (desc
[0].name
== NULL
) {
726 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
727 printf("%s%s=", sep
, opt
->name
);
728 escaped_print(opt
->str
);
733 for (; desc
&& desc
->name
; desc
++) {
735 opt
= qemu_opt_find(opts
, desc
->name
);
737 value
= opt
? opt
->str
: desc
->def_value_str
;
741 if (desc
->type
== QEMU_OPT_STRING
) {
742 printf("%s%s=", sep
, desc
->name
);
743 escaped_print(value
);
744 } else if ((desc
->type
== QEMU_OPT_SIZE
||
745 desc
->type
== QEMU_OPT_NUMBER
) && opt
) {
746 printf("%s%s=%" PRId64
, sep
, desc
->name
, opt
->value
.uint
);
748 printf("%s%s=%s", sep
, desc
->name
, value
);
754 static void opts_do_parse(QemuOpts
*opts
, const char *params
,
755 const char *firstname
, bool prepend
, Error
**errp
)
759 const char *p
,*pe
,*pc
;
760 Error
*local_err
= NULL
;
762 for (p
= params
; *p
!= '\0'; p
++) {
765 if (!pe
|| (pc
&& pc
< pe
)) {
766 /* found "foo,more" */
767 if (p
== params
&& firstname
) {
768 /* implicitly named first option */
769 option
= g_strdup(firstname
);
770 p
= get_opt_value(p
, &value
);
772 /* option without value, probably a flag */
773 p
= get_opt_name(p
, &option
, ',');
774 if (strncmp(option
, "no", 2) == 0) {
775 memmove(option
, option
+2, strlen(option
+2)+1);
776 value
= g_strdup("off");
778 value
= g_strdup("on");
782 /* found "foo=bar,more" */
783 p
= get_opt_name(p
, &option
, '=');
786 p
= get_opt_value(p
, &value
);
788 if (strcmp(option
, "id") != 0) {
789 /* store and parse */
790 opt_set(opts
, option
, value
, prepend
, &local_err
);
793 error_propagate(errp
, local_err
);
802 option
= value
= NULL
;
811 * Store options parsed from @params into @opts.
812 * If @firstname is non-null, the first key=value in @params may omit
813 * key=, and is treated as if key was @firstname.
814 * On error, store an error object through @errp if non-null.
816 void qemu_opts_do_parse(QemuOpts
*opts
, const char *params
,
817 const char *firstname
, Error
**errp
)
819 opts_do_parse(opts
, params
, firstname
, false, errp
);
822 static QemuOpts
*opts_parse(QemuOptsList
*list
, const char *params
,
823 bool permit_abbrev
, bool defaults
, Error
**errp
)
825 const char *firstname
;
829 Error
*local_err
= NULL
;
831 assert(!permit_abbrev
|| list
->implied_opt_name
);
832 firstname
= permit_abbrev
? list
->implied_opt_name
: NULL
;
834 if (strncmp(params
, "id=", 3) == 0) {
835 get_opt_value(params
+ 3, &id
);
836 } else if ((p
= strstr(params
, ",id=")) != NULL
) {
837 get_opt_value(p
+ 4, &id
);
841 * This code doesn't work for defaults && !list->merge_lists: when
842 * params has no id=, and list has an element with !opts->id, it
843 * appends a new element instead of returning the existing opts.
844 * However, we got no use for this case. Guard against possible
845 * (if unlikely) future misuse:
847 assert(!defaults
|| list
->merge_lists
);
848 opts
= qemu_opts_create(list
, id
, !defaults
, &local_err
);
851 error_propagate(errp
, local_err
);
855 opts_do_parse(opts
, params
, firstname
, defaults
, &local_err
);
857 error_propagate(errp
, local_err
);
866 * Create a QemuOpts in @list and with options parsed from @params.
867 * If @permit_abbrev, the first key=value in @params may omit key=,
868 * and is treated as if key was @list->implied_opt_name.
869 * On error, store an error object through @errp if non-null.
870 * Return the new QemuOpts on success, null pointer on error.
872 QemuOpts
*qemu_opts_parse(QemuOptsList
*list
, const char *params
,
873 bool permit_abbrev
, Error
**errp
)
875 return opts_parse(list
, params
, permit_abbrev
, false, errp
);
879 * Create a QemuOpts in @list and with options parsed from @params.
880 * If @permit_abbrev, the first key=value in @params may omit key=,
881 * and is treated as if key was @list->implied_opt_name.
882 * Report errors with error_report_err(). This is inappropriate in
883 * QMP context. Do not use this function there!
884 * Return the new QemuOpts on success, null pointer on error.
886 QemuOpts
*qemu_opts_parse_noisily(QemuOptsList
*list
, const char *params
,
892 opts
= opts_parse(list
, params
, permit_abbrev
, false, &err
);
894 error_report_err(err
);
899 void qemu_opts_set_defaults(QemuOptsList
*list
, const char *params
,
904 opts
= opts_parse(list
, params
, permit_abbrev
, true, NULL
);
908 typedef struct OptsFromQDictState
{
911 } OptsFromQDictState
;
913 static void qemu_opts_from_qdict_1(const char *key
, QObject
*obj
, void *opaque
)
915 OptsFromQDictState
*state
= opaque
;
916 char buf
[32], *tmp
= NULL
;
919 if (!strcmp(key
, "id") || *state
->errp
) {
923 switch (qobject_type(obj
)) {
925 value
= qstring_get_str(qobject_to(QString
, obj
));
928 tmp
= qnum_to_string(qobject_to(QNum
, obj
));
932 pstrcpy(buf
, sizeof(buf
),
933 qbool_get_bool(qobject_to(QBool
, obj
)) ? "on" : "off");
940 qemu_opt_set(state
->opts
, key
, value
, state
->errp
);
945 * Create QemuOpts from a QDict.
946 * Use value of key "id" as ID if it exists and is a QString. Only
947 * QStrings, QNums and QBools are copied. Entries with other types
948 * are silently ignored.
950 QemuOpts
*qemu_opts_from_qdict(QemuOptsList
*list
, const QDict
*qdict
,
953 OptsFromQDictState state
;
954 Error
*local_err
= NULL
;
957 opts
= qemu_opts_create(list
, qdict_get_try_str(qdict
, "id"), 1,
960 error_propagate(errp
, local_err
);
964 assert(opts
!= NULL
);
966 state
.errp
= &local_err
;
968 qdict_iter(qdict
, qemu_opts_from_qdict_1
, &state
);
970 error_propagate(errp
, local_err
);
979 * Adds all QDict entries to the QemuOpts that can be added and removes them
980 * from the QDict. When this function returns, the QDict contains only those
981 * entries that couldn't be added to the QemuOpts.
983 void qemu_opts_absorb_qdict(QemuOpts
*opts
, QDict
*qdict
, Error
**errp
)
985 const QDictEntry
*entry
, *next
;
987 entry
= qdict_first(qdict
);
989 while (entry
!= NULL
) {
990 Error
*local_err
= NULL
;
991 OptsFromQDictState state
= {
996 next
= qdict_next(qdict
, entry
);
998 if (find_desc_by_name(opts
->list
->desc
, entry
->key
)) {
999 qemu_opts_from_qdict_1(entry
->key
, entry
->value
, &state
);
1001 error_propagate(errp
, local_err
);
1004 qdict_del(qdict
, entry
->key
);
1013 * Convert from QemuOpts to QDict. The QDict values are of type QString.
1015 * If @list is given, only add those options to the QDict that are contained in
1016 * the list. If @del is true, any options added to the QDict are removed from
1017 * the QemuOpts, otherwise they remain there.
1019 * If two options in @opts have the same name, they are processed in order
1020 * so that the last one wins (consistent with the reverse iteration in
1021 * qemu_opt_find()), but all of them are deleted if @del is true.
1023 * TODO We'll want to use types appropriate for opt->desc->type, but
1024 * this is enough for now.
1026 QDict
*qemu_opts_to_qdict_filtered(QemuOpts
*opts
, QDict
*qdict
,
1027 QemuOptsList
*list
, bool del
)
1029 QemuOpt
*opt
, *next
;
1032 qdict
= qdict_new();
1035 qdict_put_str(qdict
, "id", opts
->id
);
1037 QTAILQ_FOREACH_SAFE(opt
, &opts
->head
, next
, next
) {
1041 for (desc
= list
->desc
; desc
->name
; desc
++) {
1042 if (!strcmp(desc
->name
, opt
->name
)) {
1051 qdict_put_str(qdict
, opt
->name
, opt
->str
);
1059 /* Copy all options in a QemuOpts to the given QDict. See
1060 * qemu_opts_to_qdict_filtered() for details. */
1061 QDict
*qemu_opts_to_qdict(QemuOpts
*opts
, QDict
*qdict
)
1063 return qemu_opts_to_qdict_filtered(opts
, qdict
, NULL
, false);
1066 /* Validate parsed opts against descriptions where no
1067 * descriptions were provided in the QemuOptsList.
1069 void qemu_opts_validate(QemuOpts
*opts
, const QemuOptDesc
*desc
, Error
**errp
)
1072 Error
*local_err
= NULL
;
1074 assert(opts_accepts_any(opts
));
1076 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
1077 opt
->desc
= find_desc_by_name(desc
, opt
->name
);
1079 error_setg(errp
, QERR_INVALID_PARAMETER
, opt
->name
);
1083 qemu_opt_parse(opt
, &local_err
);
1085 error_propagate(errp
, local_err
);
1092 * For each member of @list, call @func(@opaque, member, @errp).
1093 * Call it with the current location temporarily set to the member's.
1094 * @func() may store an Error through @errp, but must return non-zero then.
1095 * When @func() returns non-zero, break the loop and return that value.
1096 * Return zero when the loop completes.
1098 int qemu_opts_foreach(QemuOptsList
*list
, qemu_opts_loopfunc func
,
1099 void *opaque
, Error
**errp
)
1105 loc_push_none(&loc
);
1106 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
1107 loc_restore(&opts
->loc
);
1108 rc
= func(opaque
, opts
, errp
);
1112 assert(!errp
|| !*errp
);
1118 static size_t count_opts_list(QemuOptsList
*list
)
1120 QemuOptDesc
*desc
= NULL
;
1121 size_t num_opts
= 0;
1128 while (desc
&& desc
->name
) {
1136 void qemu_opts_free(QemuOptsList
*list
)
1141 /* Realloc dst option list and append options from an option list (list)
1142 * to it. dst could be NULL or a malloced list.
1143 * The lifetime of dst must be shorter than the input list because the
1144 * QemuOptDesc->name, ->help, and ->def_value_str strings are shared.
1146 QemuOptsList
*qemu_opts_append(QemuOptsList
*dst
,
1149 size_t num_opts
, num_dst_opts
;
1151 bool need_init
= false;
1152 bool need_head_update
;
1158 /* If dst is NULL, after realloc, some area of dst should be initialized
1159 * before adding options to it.
1163 need_head_update
= true;
1165 /* Moreover, even if dst is not NULL, the realloc may move it to a
1166 * different address in which case we may get a stale tail pointer
1168 need_head_update
= QTAILQ_EMPTY(&dst
->head
);
1171 num_opts
= count_opts_list(dst
);
1172 num_dst_opts
= num_opts
;
1173 num_opts
+= count_opts_list(list
);
1174 dst
= g_realloc(dst
, sizeof(QemuOptsList
) +
1175 (num_opts
+ 1) * sizeof(QemuOptDesc
));
1178 dst
->implied_opt_name
= NULL
;
1179 dst
->merge_lists
= false;
1181 if (need_head_update
) {
1182 QTAILQ_INIT(&dst
->head
);
1184 dst
->desc
[num_dst_opts
].name
= NULL
;
1186 /* append list->desc to dst->desc */
1189 while (desc
&& desc
->name
) {
1190 if (find_desc_by_name(dst
->desc
, desc
->name
) == NULL
) {
1191 dst
->desc
[num_dst_opts
++] = *desc
;
1192 dst
->desc
[num_dst_opts
].name
= NULL
;