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
= strchr(p
, ',');
82 offset
= p
+ strlen(p
);
86 if (*offset
!= '\0' && *(offset
+ 1) == ',') {
90 *value
= g_renew(char, *value
, capacity
+ length
+ 1);
91 strncpy(*value
+ capacity
, p
, length
);
92 (*value
)[capacity
+ length
] = '\0';
95 if (*offset
== '\0' ||
96 *(offset
+ 1) != ',') {
100 p
+= (offset
- p
) + 2;
106 static void parse_option_bool(const char *name
, const char *value
, bool *ret
,
109 if (!strcmp(value
, "on")) {
111 } else if (!strcmp(value
, "off")) {
114 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
115 name
, "'on' or 'off'");
119 static void parse_option_number(const char *name
, const char *value
,
120 uint64_t *ret
, Error
**errp
)
125 err
= qemu_strtou64(value
, NULL
, 0, &number
);
126 if (err
== -ERANGE
) {
127 error_setg(errp
, "Value '%s' is too large for parameter '%s'",
132 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, name
, "a number");
138 static const QemuOptDesc
*find_desc_by_name(const QemuOptDesc
*desc
,
143 for (i
= 0; desc
[i
].name
!= NULL
; i
++) {
144 if (strcmp(desc
[i
].name
, name
) == 0) {
152 void parse_option_size(const char *name
, const char *value
,
153 uint64_t *ret
, Error
**errp
)
158 err
= qemu_strtosz(value
, NULL
, &size
);
159 if (err
== -ERANGE
) {
160 error_setg(errp
, "Value '%s' is out of range for parameter '%s'",
165 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, name
,
166 "a non-negative number below 2^64");
167 error_append_hint(errp
, "Optional suffix k, M, G, T, P or E means"
168 " kilo-, mega-, giga-, tera-, peta-\n"
169 "and exabytes, respectively.\n");
175 bool has_help_option(const char *param
)
177 const char *p
= param
;
180 while (*p
&& !result
) {
183 p
= get_opt_value(p
, &value
);
188 result
= is_help_option(value
);
195 bool is_valid_option_list(const char *p
)
201 p
= get_opt_value(p
, &value
);
203 (!*value
|| *value
== ',')) {
217 void qemu_opts_print_help(QemuOptsList
*list
)
223 while (desc
&& desc
->name
) {
224 printf("%-16s %s\n", desc
->name
,
225 desc
->help
? desc
->help
: "No description available");
229 /* ------------------------------------------------------------------ */
231 QemuOpt
*qemu_opt_find(QemuOpts
*opts
, const char *name
)
235 QTAILQ_FOREACH_REVERSE(opt
, &opts
->head
, QemuOptHead
, next
) {
236 if (strcmp(opt
->name
, name
) != 0)
243 static void qemu_opt_del(QemuOpt
*opt
)
245 QTAILQ_REMOVE(&opt
->opts
->head
, opt
, next
);
251 /* qemu_opt_set allows many settings for the same option.
252 * This function deletes all settings for an option.
254 static void qemu_opt_del_all(QemuOpts
*opts
, const char *name
)
256 QemuOpt
*opt
, *next_opt
;
258 QTAILQ_FOREACH_SAFE(opt
, &opts
->head
, next
, next_opt
) {
259 if (!strcmp(opt
->name
, name
)) {
265 const char *qemu_opt_get(QemuOpts
*opts
, const char *name
)
273 opt
= qemu_opt_find(opts
, name
);
275 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
276 if (desc
&& desc
->def_value_str
) {
277 return desc
->def_value_str
;
280 return opt
? opt
->str
: NULL
;
283 void qemu_opt_iter_init(QemuOptsIter
*iter
, QemuOpts
*opts
, const char *name
)
286 iter
->opt
= QTAILQ_FIRST(&opts
->head
);
290 const char *qemu_opt_iter_next(QemuOptsIter
*iter
)
292 QemuOpt
*ret
= iter
->opt
;
294 while (ret
&& !g_str_equal(iter
->name
, ret
->name
)) {
295 ret
= QTAILQ_NEXT(ret
, next
);
298 iter
->opt
= ret
? QTAILQ_NEXT(ret
, next
) : NULL
;
299 return ret
? ret
->str
: NULL
;
302 /* Get a known option (or its default) and remove it from the list
303 * all in one action. Return a malloced string of the option value.
304 * Result must be freed by caller with g_free().
306 char *qemu_opt_get_del(QemuOpts
*opts
, const char *name
)
309 const QemuOptDesc
*desc
;
316 opt
= qemu_opt_find(opts
, name
);
318 desc
= find_desc_by_name(opts
->list
->desc
, name
);
319 if (desc
&& desc
->def_value_str
) {
320 str
= g_strdup(desc
->def_value_str
);
326 qemu_opt_del_all(opts
, name
);
330 bool qemu_opt_has_help_opt(QemuOpts
*opts
)
334 QTAILQ_FOREACH_REVERSE(opt
, &opts
->head
, QemuOptHead
, next
) {
335 if (is_help_option(opt
->name
)) {
342 static bool qemu_opt_get_bool_helper(QemuOpts
*opts
, const char *name
,
343 bool defval
, bool del
)
352 opt
= qemu_opt_find(opts
, name
);
354 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
355 if (desc
&& desc
->def_value_str
) {
356 parse_option_bool(name
, desc
->def_value_str
, &ret
, &error_abort
);
360 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_BOOL
);
361 ret
= opt
->value
.boolean
;
363 qemu_opt_del_all(opts
, name
);
368 bool qemu_opt_get_bool(QemuOpts
*opts
, const char *name
, bool defval
)
370 return qemu_opt_get_bool_helper(opts
, name
, defval
, false);
373 bool qemu_opt_get_bool_del(QemuOpts
*opts
, const char *name
, bool defval
)
375 return qemu_opt_get_bool_helper(opts
, name
, defval
, true);
378 static uint64_t qemu_opt_get_number_helper(QemuOpts
*opts
, const char *name
,
379 uint64_t defval
, bool del
)
382 uint64_t ret
= defval
;
388 opt
= qemu_opt_find(opts
, name
);
390 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
391 if (desc
&& desc
->def_value_str
) {
392 parse_option_number(name
, desc
->def_value_str
, &ret
, &error_abort
);
396 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_NUMBER
);
397 ret
= opt
->value
.uint
;
399 qemu_opt_del_all(opts
, name
);
404 uint64_t qemu_opt_get_number(QemuOpts
*opts
, const char *name
, uint64_t defval
)
406 return qemu_opt_get_number_helper(opts
, name
, defval
, false);
409 uint64_t qemu_opt_get_number_del(QemuOpts
*opts
, const char *name
,
412 return qemu_opt_get_number_helper(opts
, name
, defval
, true);
415 static uint64_t qemu_opt_get_size_helper(QemuOpts
*opts
, const char *name
,
416 uint64_t defval
, bool del
)
419 uint64_t ret
= defval
;
425 opt
= qemu_opt_find(opts
, name
);
427 const QemuOptDesc
*desc
= find_desc_by_name(opts
->list
->desc
, name
);
428 if (desc
&& desc
->def_value_str
) {
429 parse_option_size(name
, desc
->def_value_str
, &ret
, &error_abort
);
433 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_SIZE
);
434 ret
= opt
->value
.uint
;
436 qemu_opt_del_all(opts
, name
);
441 uint64_t qemu_opt_get_size(QemuOpts
*opts
, const char *name
, uint64_t defval
)
443 return qemu_opt_get_size_helper(opts
, name
, defval
, false);
446 uint64_t qemu_opt_get_size_del(QemuOpts
*opts
, const char *name
,
449 return qemu_opt_get_size_helper(opts
, name
, defval
, true);
452 static void qemu_opt_parse(QemuOpt
*opt
, Error
**errp
)
454 if (opt
->desc
== NULL
)
457 switch (opt
->desc
->type
) {
458 case QEMU_OPT_STRING
:
462 parse_option_bool(opt
->name
, opt
->str
, &opt
->value
.boolean
, errp
);
464 case QEMU_OPT_NUMBER
:
465 parse_option_number(opt
->name
, opt
->str
, &opt
->value
.uint
, errp
);
468 parse_option_size(opt
->name
, opt
->str
, &opt
->value
.uint
, errp
);
475 static bool opts_accepts_any(const QemuOpts
*opts
)
477 return opts
->list
->desc
[0].name
== NULL
;
480 int qemu_opt_unset(QemuOpts
*opts
, const char *name
)
482 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
484 assert(opts_accepts_any(opts
));
494 static void opt_set(QemuOpts
*opts
, const char *name
, char *value
,
495 bool prepend
, Error
**errp
)
498 const QemuOptDesc
*desc
;
499 Error
*local_err
= NULL
;
501 desc
= find_desc_by_name(opts
->list
->desc
, name
);
502 if (!desc
&& !opts_accepts_any(opts
)) {
504 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
508 opt
= g_malloc0(sizeof(*opt
));
509 opt
->name
= g_strdup(name
);
512 QTAILQ_INSERT_HEAD(&opts
->head
, opt
, next
);
514 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
518 qemu_opt_parse(opt
, &local_err
);
520 error_propagate(errp
, local_err
);
525 void qemu_opt_set(QemuOpts
*opts
, const char *name
, const char *value
,
528 opt_set(opts
, name
, g_strdup(value
), false, errp
);
531 void qemu_opt_set_bool(QemuOpts
*opts
, const char *name
, bool val
,
535 const QemuOptDesc
*desc
= opts
->list
->desc
;
537 opt
= g_malloc0(sizeof(*opt
));
538 opt
->desc
= find_desc_by_name(desc
, name
);
539 if (!opt
->desc
&& !opts_accepts_any(opts
)) {
540 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
545 opt
->name
= g_strdup(name
);
547 opt
->value
.boolean
= !!val
;
548 opt
->str
= g_strdup(val
? "on" : "off");
549 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
552 void qemu_opt_set_number(QemuOpts
*opts
, const char *name
, int64_t val
,
556 const QemuOptDesc
*desc
= opts
->list
->desc
;
558 opt
= g_malloc0(sizeof(*opt
));
559 opt
->desc
= find_desc_by_name(desc
, name
);
560 if (!opt
->desc
&& !opts_accepts_any(opts
)) {
561 error_setg(errp
, QERR_INVALID_PARAMETER
, name
);
566 opt
->name
= g_strdup(name
);
568 opt
->value
.uint
= val
;
569 opt
->str
= g_strdup_printf("%" PRId64
, val
);
570 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
574 * For each member of @opts, call @func(@opaque, name, value, @errp).
575 * @func() may store an Error through @errp, but must return non-zero then.
576 * When @func() returns non-zero, break the loop and return that value.
577 * Return zero when the loop completes.
579 int qemu_opt_foreach(QemuOpts
*opts
, qemu_opt_loopfunc func
, void *opaque
,
585 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
586 rc
= func(opaque
, opt
->name
, opt
->str
, errp
);
590 assert(!errp
|| !*errp
);
595 QemuOpts
*qemu_opts_find(QemuOptsList
*list
, const char *id
)
599 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
600 if (!opts
->id
&& !id
) {
603 if (opts
->id
&& id
&& !strcmp(opts
->id
, id
)) {
610 QemuOpts
*qemu_opts_create(QemuOptsList
*list
, const char *id
,
611 int fail_if_exists
, Error
**errp
)
613 QemuOpts
*opts
= NULL
;
616 if (!id_wellformed(id
)) {
617 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "id",
619 error_append_hint(errp
, "Identifiers consist of letters, digits, "
620 "'-', '.', '_', starting with a letter.\n");
623 opts
= qemu_opts_find(list
, id
);
625 if (fail_if_exists
&& !list
->merge_lists
) {
626 error_setg(errp
, "Duplicate ID '%s' for %s", id
, list
->name
);
632 } else if (list
->merge_lists
) {
633 opts
= qemu_opts_find(list
, NULL
);
638 opts
= g_malloc0(sizeof(*opts
));
639 opts
->id
= g_strdup(id
);
641 loc_save(&opts
->loc
);
642 QTAILQ_INIT(&opts
->head
);
643 QTAILQ_INSERT_TAIL(&list
->head
, opts
, next
);
647 void qemu_opts_reset(QemuOptsList
*list
)
649 QemuOpts
*opts
, *next_opts
;
651 QTAILQ_FOREACH_SAFE(opts
, &list
->head
, next
, next_opts
) {
656 void qemu_opts_loc_restore(QemuOpts
*opts
)
658 loc_restore(&opts
->loc
);
661 void qemu_opts_set(QemuOptsList
*list
, const char *id
,
662 const char *name
, const char *value
, Error
**errp
)
665 Error
*local_err
= NULL
;
667 opts
= qemu_opts_create(list
, id
, 1, &local_err
);
669 error_propagate(errp
, local_err
);
672 qemu_opt_set(opts
, name
, value
, errp
);
675 const char *qemu_opts_id(QemuOpts
*opts
)
680 /* The id string will be g_free()d by qemu_opts_del */
681 void qemu_opts_set_id(QemuOpts
*opts
, char *id
)
686 void qemu_opts_del(QemuOpts
*opts
)
695 opt
= QTAILQ_FIRST(&opts
->head
);
700 QTAILQ_REMOVE(&opts
->list
->head
, opts
, next
);
705 /* print value, escaping any commas in value */
706 static void escaped_print(const char *value
)
710 for (ptr
= value
; *ptr
; ++ptr
) {
718 void qemu_opts_print(QemuOpts
*opts
, const char *separator
)
721 QemuOptDesc
*desc
= opts
->list
->desc
;
722 const char *sep
= "";
725 printf("id=%s", opts
->id
); /* passed id_wellformed -> no commas */
729 if (desc
[0].name
== NULL
) {
730 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
731 printf("%s%s=", sep
, opt
->name
);
732 escaped_print(opt
->str
);
737 for (; desc
&& desc
->name
; desc
++) {
739 opt
= qemu_opt_find(opts
, desc
->name
);
741 value
= opt
? opt
->str
: desc
->def_value_str
;
745 if (desc
->type
== QEMU_OPT_STRING
) {
746 printf("%s%s=", sep
, desc
->name
);
747 escaped_print(value
);
748 } else if ((desc
->type
== QEMU_OPT_SIZE
||
749 desc
->type
== QEMU_OPT_NUMBER
) && opt
) {
750 printf("%s%s=%" PRId64
, sep
, desc
->name
, opt
->value
.uint
);
752 printf("%s%s=%s", sep
, desc
->name
, value
);
758 static void opts_do_parse(QemuOpts
*opts
, const char *params
,
759 const char *firstname
, bool prepend
, Error
**errp
)
763 const char *p
,*pe
,*pc
;
764 Error
*local_err
= NULL
;
766 for (p
= params
; *p
!= '\0'; p
++) {
769 if (!pe
|| (pc
&& pc
< pe
)) {
770 /* found "foo,more" */
771 if (p
== params
&& firstname
) {
772 /* implicitly named first option */
773 option
= g_strdup(firstname
);
774 p
= get_opt_value(p
, &value
);
776 /* option without value, probably a flag */
777 p
= get_opt_name(p
, &option
, ',');
778 if (strncmp(option
, "no", 2) == 0) {
779 memmove(option
, option
+2, strlen(option
+2)+1);
780 value
= g_strdup("off");
782 value
= g_strdup("on");
786 /* found "foo=bar,more" */
787 p
= get_opt_name(p
, &option
, '=');
790 p
= get_opt_value(p
, &value
);
792 if (strcmp(option
, "id") != 0) {
793 /* store and parse */
794 opt_set(opts
, option
, value
, prepend
, &local_err
);
797 error_propagate(errp
, local_err
);
806 option
= value
= NULL
;
815 * Store options parsed from @params into @opts.
816 * If @firstname is non-null, the first key=value in @params may omit
817 * key=, and is treated as if key was @firstname.
818 * On error, store an error object through @errp if non-null.
820 void qemu_opts_do_parse(QemuOpts
*opts
, const char *params
,
821 const char *firstname
, Error
**errp
)
823 opts_do_parse(opts
, params
, firstname
, false, errp
);
826 static QemuOpts
*opts_parse(QemuOptsList
*list
, const char *params
,
827 bool permit_abbrev
, bool defaults
, Error
**errp
)
829 const char *firstname
;
833 Error
*local_err
= NULL
;
835 assert(!permit_abbrev
|| list
->implied_opt_name
);
836 firstname
= permit_abbrev
? list
->implied_opt_name
: NULL
;
838 if (strncmp(params
, "id=", 3) == 0) {
839 get_opt_value(params
+ 3, &id
);
840 } else if ((p
= strstr(params
, ",id=")) != NULL
) {
841 get_opt_value(p
+ 4, &id
);
845 * This code doesn't work for defaults && !list->merge_lists: when
846 * params has no id=, and list has an element with !opts->id, it
847 * appends a new element instead of returning the existing opts.
848 * However, we got no use for this case. Guard against possible
849 * (if unlikely) future misuse:
851 assert(!defaults
|| list
->merge_lists
);
852 opts
= qemu_opts_create(list
, id
, !defaults
, &local_err
);
855 error_propagate(errp
, local_err
);
859 opts_do_parse(opts
, params
, firstname
, defaults
, &local_err
);
861 error_propagate(errp
, local_err
);
870 * Create a QemuOpts in @list and with options parsed from @params.
871 * If @permit_abbrev, the first key=value in @params may omit key=,
872 * and is treated as if key was @list->implied_opt_name.
873 * On error, store an error object through @errp if non-null.
874 * Return the new QemuOpts on success, null pointer on error.
876 QemuOpts
*qemu_opts_parse(QemuOptsList
*list
, const char *params
,
877 bool permit_abbrev
, Error
**errp
)
879 return opts_parse(list
, params
, permit_abbrev
, false, errp
);
883 * Create a QemuOpts in @list and with options parsed from @params.
884 * If @permit_abbrev, the first key=value in @params may omit key=,
885 * and is treated as if key was @list->implied_opt_name.
886 * Report errors with error_report_err(). This is inappropriate in
887 * QMP context. Do not use this function there!
888 * Return the new QemuOpts on success, null pointer on error.
890 QemuOpts
*qemu_opts_parse_noisily(QemuOptsList
*list
, const char *params
,
896 opts
= opts_parse(list
, params
, permit_abbrev
, false, &err
);
898 error_report_err(err
);
903 void qemu_opts_set_defaults(QemuOptsList
*list
, const char *params
,
908 opts
= opts_parse(list
, params
, permit_abbrev
, true, NULL
);
912 typedef struct OptsFromQDictState
{
915 } OptsFromQDictState
;
917 static void qemu_opts_from_qdict_1(const char *key
, QObject
*obj
, void *opaque
)
919 OptsFromQDictState
*state
= opaque
;
920 char buf
[32], *tmp
= NULL
;
923 if (!strcmp(key
, "id") || *state
->errp
) {
927 switch (qobject_type(obj
)) {
929 value
= qstring_get_str(qobject_to(QString
, obj
));
932 tmp
= qnum_to_string(qobject_to(QNum
, obj
));
936 pstrcpy(buf
, sizeof(buf
),
937 qbool_get_bool(qobject_to(QBool
, obj
)) ? "on" : "off");
944 qemu_opt_set(state
->opts
, key
, value
, state
->errp
);
949 * Create QemuOpts from a QDict.
950 * Use value of key "id" as ID if it exists and is a QString. Only
951 * QStrings, QNums and QBools are copied. Entries with other types
952 * are silently ignored.
954 QemuOpts
*qemu_opts_from_qdict(QemuOptsList
*list
, const QDict
*qdict
,
957 OptsFromQDictState state
;
958 Error
*local_err
= NULL
;
961 opts
= qemu_opts_create(list
, qdict_get_try_str(qdict
, "id"), 1,
964 error_propagate(errp
, local_err
);
968 assert(opts
!= NULL
);
970 state
.errp
= &local_err
;
972 qdict_iter(qdict
, qemu_opts_from_qdict_1
, &state
);
974 error_propagate(errp
, local_err
);
983 * Adds all QDict entries to the QemuOpts that can be added and removes them
984 * from the QDict. When this function returns, the QDict contains only those
985 * entries that couldn't be added to the QemuOpts.
987 void qemu_opts_absorb_qdict(QemuOpts
*opts
, QDict
*qdict
, Error
**errp
)
989 const QDictEntry
*entry
, *next
;
991 entry
= qdict_first(qdict
);
993 while (entry
!= NULL
) {
994 Error
*local_err
= NULL
;
995 OptsFromQDictState state
= {
1000 next
= qdict_next(qdict
, entry
);
1002 if (find_desc_by_name(opts
->list
->desc
, entry
->key
)) {
1003 qemu_opts_from_qdict_1(entry
->key
, entry
->value
, &state
);
1005 error_propagate(errp
, local_err
);
1008 qdict_del(qdict
, entry
->key
);
1017 * Convert from QemuOpts to QDict. The QDict values are of type QString.
1019 * If @list is given, only add those options to the QDict that are contained in
1020 * the list. If @del is true, any options added to the QDict are removed from
1021 * the QemuOpts, otherwise they remain there.
1023 * If two options in @opts have the same name, they are processed in order
1024 * so that the last one wins (consistent with the reverse iteration in
1025 * qemu_opt_find()), but all of them are deleted if @del is true.
1027 * TODO We'll want to use types appropriate for opt->desc->type, but
1028 * this is enough for now.
1030 QDict
*qemu_opts_to_qdict_filtered(QemuOpts
*opts
, QDict
*qdict
,
1031 QemuOptsList
*list
, bool del
)
1033 QemuOpt
*opt
, *next
;
1036 qdict
= qdict_new();
1039 qdict_put_str(qdict
, "id", opts
->id
);
1041 QTAILQ_FOREACH_SAFE(opt
, &opts
->head
, next
, next
) {
1045 for (desc
= list
->desc
; desc
->name
; desc
++) {
1046 if (!strcmp(desc
->name
, opt
->name
)) {
1055 qdict_put_str(qdict
, opt
->name
, opt
->str
);
1063 /* Copy all options in a QemuOpts to the given QDict. See
1064 * qemu_opts_to_qdict_filtered() for details. */
1065 QDict
*qemu_opts_to_qdict(QemuOpts
*opts
, QDict
*qdict
)
1067 return qemu_opts_to_qdict_filtered(opts
, qdict
, NULL
, false);
1070 /* Validate parsed opts against descriptions where no
1071 * descriptions were provided in the QemuOptsList.
1073 void qemu_opts_validate(QemuOpts
*opts
, const QemuOptDesc
*desc
, Error
**errp
)
1076 Error
*local_err
= NULL
;
1078 assert(opts_accepts_any(opts
));
1080 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
1081 opt
->desc
= find_desc_by_name(desc
, opt
->name
);
1083 error_setg(errp
, QERR_INVALID_PARAMETER
, opt
->name
);
1087 qemu_opt_parse(opt
, &local_err
);
1089 error_propagate(errp
, local_err
);
1096 * For each member of @list, call @func(@opaque, member, @errp).
1097 * Call it with the current location temporarily set to the member's.
1098 * @func() may store an Error through @errp, but must return non-zero then.
1099 * When @func() returns non-zero, break the loop and return that value.
1100 * Return zero when the loop completes.
1102 int qemu_opts_foreach(QemuOptsList
*list
, qemu_opts_loopfunc func
,
1103 void *opaque
, Error
**errp
)
1109 loc_push_none(&loc
);
1110 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
1111 loc_restore(&opts
->loc
);
1112 rc
= func(opaque
, opts
, errp
);
1116 assert(!errp
|| !*errp
);
1122 static size_t count_opts_list(QemuOptsList
*list
)
1124 QemuOptDesc
*desc
= NULL
;
1125 size_t num_opts
= 0;
1132 while (desc
&& desc
->name
) {
1140 void qemu_opts_free(QemuOptsList
*list
)
1145 /* Realloc dst option list and append options from an option list (list)
1146 * to it. dst could be NULL or a malloced list.
1147 * The lifetime of dst must be shorter than the input list because the
1148 * QemuOptDesc->name, ->help, and ->def_value_str strings are shared.
1150 QemuOptsList
*qemu_opts_append(QemuOptsList
*dst
,
1153 size_t num_opts
, num_dst_opts
;
1155 bool need_init
= false;
1156 bool need_head_update
;
1162 /* If dst is NULL, after realloc, some area of dst should be initialized
1163 * before adding options to it.
1167 need_head_update
= true;
1169 /* Moreover, even if dst is not NULL, the realloc may move it to a
1170 * different address in which case we may get a stale tail pointer
1172 need_head_update
= QTAILQ_EMPTY(&dst
->head
);
1175 num_opts
= count_opts_list(dst
);
1176 num_dst_opts
= num_opts
;
1177 num_opts
+= count_opts_list(list
);
1178 dst
= g_realloc(dst
, sizeof(QemuOptsList
) +
1179 (num_opts
+ 1) * sizeof(QemuOptDesc
));
1182 dst
->implied_opt_name
= NULL
;
1183 dst
->merge_lists
= false;
1185 if (need_head_update
) {
1186 QTAILQ_INIT(&dst
->head
);
1188 dst
->desc
[num_dst_opts
].name
= NULL
;
1190 /* append list->desc to dst->desc */
1193 while (desc
&& desc
->name
) {
1194 if (find_desc_by_name(dst
->desc
, desc
->name
) == NULL
) {
1195 dst
->desc
[num_dst_opts
++] = *desc
;
1196 dst
->desc
[num_dst_opts
].name
= NULL
;