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
29 #include "qemu-common.h"
30 #include "qemu-error.h"
31 #include "qemu-objects.h"
32 #include "qemu-option.h"
36 * Extracts the name of an option from the parameter string (p points at the
37 * first byte of the option name)
39 * The option name is delimited by delim (usually , or =) or the string end
40 * and is copied into buf. If the option name is longer than buf_size, it is
41 * truncated. buf is always zero terminated.
43 * The return value is the position of the delimiter/zero byte after the option
46 const char *get_opt_name(char *buf
, int buf_size
, const char *p
, char delim
)
51 while (*p
!= '\0' && *p
!= delim
) {
52 if (q
&& (q
- buf
) < buf_size
- 1)
63 * Extracts the value of an option from the parameter string p (p points at the
64 * first byte of the option value)
66 * This function is comparable to get_opt_name with the difference that the
67 * delimiter is fixed to be comma which starts a new option. To specify an
68 * option value that contains commas, double each comma.
70 const char *get_opt_value(char *buf
, int buf_size
, const char *p
)
81 if (q
&& (q
- buf
) < buf_size
- 1)
91 int get_next_param_value(char *buf
, int buf_size
,
92 const char *tag
, const char **pstr
)
99 p
= get_opt_name(option
, sizeof(option
), p
, '=');
103 if (!strcmp(tag
, option
)) {
104 *pstr
= get_opt_value(buf
, buf_size
, p
);
110 p
= get_opt_value(NULL
, 0, p
);
119 int get_param_value(char *buf
, int buf_size
,
120 const char *tag
, const char *str
)
122 return get_next_param_value(buf
, buf_size
, tag
, &str
);
125 int check_params(char *buf
, int buf_size
,
126 const char * const *params
, const char *str
)
133 p
= get_opt_name(buf
, buf_size
, p
, '=');
138 for (i
= 0; params
[i
] != NULL
; i
++) {
139 if (!strcmp(params
[i
], buf
)) {
143 if (params
[i
] == NULL
) {
146 p
= get_opt_value(NULL
, 0, p
);
156 * Searches an option list for an option with the given name
158 QEMUOptionParameter
*get_option_parameter(QEMUOptionParameter
*list
,
161 while (list
&& list
->name
) {
162 if (!strcmp(list
->name
, name
)) {
171 static int parse_option_bool(const char *name
, const char *value
, int *ret
)
174 if (!strcmp(value
, "on")) {
176 } else if (!strcmp(value
, "off")) {
179 qerror_report(QERR_INVALID_PARAMETER_VALUE
, name
, "'on' or 'off'");
188 static int parse_option_number(const char *name
, const char *value
, uint64_t *ret
)
194 number
= strtoull(value
, &postfix
, 0);
195 if (*postfix
!= '\0') {
196 qerror_report(QERR_INVALID_PARAMETER_VALUE
, name
, "a number");
201 qerror_report(QERR_INVALID_PARAMETER_VALUE
, name
, "a number");
207 static int parse_option_size(const char *name
, const char *value
, uint64_t *ret
)
213 sizef
= strtod(value
, &postfix
);
226 *ret
= (uint64_t) sizef
;
229 qerror_report(QERR_INVALID_PARAMETER_VALUE
, name
, "a size");
230 error_printf_unless_qmp("You may use k, M, G or T suffixes for "
231 "kilobytes, megabytes, gigabytes and terabytes.\n");
235 qerror_report(QERR_INVALID_PARAMETER_VALUE
, name
, "a size");
242 * Sets the value of a parameter in a given option list. The parsing of the
243 * value depends on the type of option:
245 * OPT_FLAG (uses value.n):
246 * If no value is given, the flag is set to 1.
247 * Otherwise the value must be "on" (set to 1) or "off" (set to 0)
249 * OPT_STRING (uses value.s):
250 * value is strdup()ed and assigned as option value
252 * OPT_SIZE (uses value.n):
253 * The value is converted to an integer. Suffixes for kilobytes etc. are
254 * allowed (powers of 1024).
256 * Returns 0 on succes, -1 in error cases
258 int set_option_parameter(QEMUOptionParameter
*list
, const char *name
,
263 // Find a matching parameter
264 list
= get_option_parameter(list
, name
);
266 fprintf(stderr
, "Unknown option '%s'\n", name
);
271 switch (list
->type
) {
273 if (parse_option_bool(name
, value
, &flag
) == -1)
275 list
->value
.n
= flag
;
280 list
->value
.s
= qemu_strdup(value
);
282 fprintf(stderr
, "Option '%s' needs a parameter\n", name
);
288 if (parse_option_size(name
, value
, &list
->value
.n
) == -1)
293 fprintf(stderr
, "Bug: Option '%s' has an unknown type\n", name
);
301 * Sets the given parameter to an integer instead of a string.
302 * This function cannot be used to set string options.
304 * Returns 0 on success, -1 in error cases
306 int set_option_parameter_int(QEMUOptionParameter
*list
, const char *name
,
309 // Find a matching parameter
310 list
= get_option_parameter(list
, name
);
312 fprintf(stderr
, "Unknown option '%s'\n", name
);
317 switch (list
->type
) {
321 list
->value
.n
= value
;
332 * Frees a option list. If it contains strings, the strings are freed as well.
334 void free_option_parameters(QEMUOptionParameter
*list
)
336 QEMUOptionParameter
*cur
= list
;
338 while (cur
&& cur
->name
) {
339 if (cur
->type
== OPT_STRING
) {
340 qemu_free(cur
->value
.s
);
349 * Count valid options in list
351 static size_t count_option_parameters(QEMUOptionParameter
*list
)
353 size_t num_options
= 0;
355 while (list
&& list
->name
) {
364 * Append an option list (list) to an option list (dest).
366 * If dest is NULL, a new copy of list is created.
368 * Returns a pointer to the first element of dest (or the newly allocated copy)
370 QEMUOptionParameter
*append_option_parameters(QEMUOptionParameter
*dest
,
371 QEMUOptionParameter
*list
)
373 size_t num_options
, num_dest_options
;
375 num_options
= count_option_parameters(dest
);
376 num_dest_options
= num_options
;
378 num_options
+= count_option_parameters(list
);
380 dest
= qemu_realloc(dest
, (num_options
+ 1) * sizeof(QEMUOptionParameter
));
381 dest
[num_dest_options
].name
= NULL
;
383 while (list
&& list
->name
) {
384 if (get_option_parameter(dest
, list
->name
) == NULL
) {
385 dest
[num_dest_options
++] = *list
;
386 dest
[num_dest_options
].name
= NULL
;
395 * Parses a parameter string (param) into an option list (dest).
397 * list is the templace is. If dest is NULL, a new copy of list is created for
398 * it. If list is NULL, this function fails.
400 * A parameter string consists of one or more parameters, separated by commas.
401 * Each parameter consists of its name and possibly of a value. In the latter
402 * case, the value is delimited by an = character. To specify a value which
403 * contains commas, double each comma so it won't be recognized as the end of
406 * For more details of the parsing see above.
408 * Returns a pointer to the first element of dest (or the newly allocated copy)
409 * or NULL in error cases
411 QEMUOptionParameter
*parse_option_parameters(const char *param
,
412 QEMUOptionParameter
*list
, QEMUOptionParameter
*dest
)
414 QEMUOptionParameter
*allocated
= NULL
;
417 char *param_delim
, *value_delim
;
426 // Count valid options
427 num_options
= count_option_parameters(list
);
429 // Create a copy of the option list to fill in values
430 dest
= qemu_mallocz((num_options
+ 1) * sizeof(QEMUOptionParameter
));
432 memcpy(dest
, list
, (num_options
+ 1) * sizeof(QEMUOptionParameter
));
437 // Find parameter name and value in the string
438 param_delim
= strchr(param
, ',');
439 value_delim
= strchr(param
, '=');
441 if (value_delim
&& (value_delim
< param_delim
|| !param_delim
)) {
448 param
= get_opt_name(name
, sizeof(name
), param
, next_delim
);
450 param
= get_opt_value(value
, sizeof(value
), param
+ 1);
452 if (*param
!= '\0') {
457 if (set_option_parameter(dest
, name
, value_delim
? value
: NULL
)) {
465 // Only free the list if it was newly allocated
466 free_option_parameters(allocated
);
471 * Prints all options of a list that have a value to stdout
473 void print_option_parameters(QEMUOptionParameter
*list
)
475 while (list
&& list
->name
) {
476 switch (list
->type
) {
478 if (list
->value
.s
!= NULL
) {
479 printf("%s='%s' ", list
->name
, list
->value
.s
);
483 printf("%s=%s ", list
->name
, list
->value
.n
? "on" : "off");
487 printf("%s=%" PRId64
" ", list
->name
, list
->value
.n
);
490 printf("%s=(unkown type) ", list
->name
);
498 * Prints an overview of all available options
500 void print_option_help(QEMUOptionParameter
*list
)
502 printf("Supported options:\n");
503 while (list
&& list
->name
) {
504 printf("%-16s %s\n", list
->name
,
505 list
->help
? list
->help
: "No description available");
510 /* ------------------------------------------------------------------ */
516 const QemuOptDesc
*desc
;
523 QTAILQ_ENTRY(QemuOpt
) next
;
530 QTAILQ_HEAD(QemuOptHead
, QemuOpt
) head
;
531 QTAILQ_ENTRY(QemuOpts
) next
;
534 static QemuOpt
*qemu_opt_find(QemuOpts
*opts
, const char *name
)
538 QTAILQ_FOREACH_REVERSE(opt
, &opts
->head
, QemuOptHead
, next
) {
539 if (strcmp(opt
->name
, name
) != 0)
546 const char *qemu_opt_get(QemuOpts
*opts
, const char *name
)
548 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
549 return opt
? opt
->str
: NULL
;
552 int qemu_opt_get_bool(QemuOpts
*opts
, const char *name
, int defval
)
554 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
558 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_BOOL
);
559 return opt
->value
.boolean
;
562 uint64_t qemu_opt_get_number(QemuOpts
*opts
, const char *name
, uint64_t defval
)
564 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
568 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_NUMBER
);
569 return opt
->value
.uint
;
572 uint64_t qemu_opt_get_size(QemuOpts
*opts
, const char *name
, uint64_t defval
)
574 QemuOpt
*opt
= qemu_opt_find(opts
, name
);
578 assert(opt
->desc
&& opt
->desc
->type
== QEMU_OPT_SIZE
);
579 return opt
->value
.uint
;
582 static int qemu_opt_parse(QemuOpt
*opt
)
584 if (opt
->desc
== NULL
)
586 switch (opt
->desc
->type
) {
587 case QEMU_OPT_STRING
:
591 return parse_option_bool(opt
->name
, opt
->str
, &opt
->value
.boolean
);
592 case QEMU_OPT_NUMBER
:
593 return parse_option_number(opt
->name
, opt
->str
, &opt
->value
.uint
);
595 return parse_option_size(opt
->name
, opt
->str
, &opt
->value
.uint
);
601 static void qemu_opt_del(QemuOpt
*opt
)
603 QTAILQ_REMOVE(&opt
->opts
->head
, opt
, next
);
604 qemu_free((/* !const */ char*)opt
->name
);
605 qemu_free((/* !const */ char*)opt
->str
);
609 int qemu_opt_set(QemuOpts
*opts
, const char *name
, const char *value
)
612 const QemuOptDesc
*desc
= opts
->list
->desc
;
615 for (i
= 0; desc
[i
].name
!= NULL
; i
++) {
616 if (strcmp(desc
[i
].name
, name
) == 0) {
620 if (desc
[i
].name
== NULL
) {
622 /* empty list -> allow any */;
624 qerror_report(QERR_INVALID_PARAMETER
, name
);
629 opt
= qemu_mallocz(sizeof(*opt
));
630 opt
->name
= qemu_strdup(name
);
632 QTAILQ_INSERT_TAIL(&opts
->head
, opt
, next
);
633 if (desc
[i
].name
!= NULL
) {
637 opt
->str
= qemu_strdup(value
);
639 if (qemu_opt_parse(opt
) < 0) {
646 int qemu_opt_foreach(QemuOpts
*opts
, qemu_opt_loopfunc func
, void *opaque
,
647 int abort_on_failure
)
652 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
653 rc
= func(opt
->name
, opt
->str
, opaque
);
654 if (abort_on_failure
&& rc
!= 0)
660 QemuOpts
*qemu_opts_find(QemuOptsList
*list
, const char *id
)
664 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
668 if (strcmp(opts
->id
, id
) != 0) {
676 static int id_wellformed(const char *id
)
680 if (!qemu_isalpha(id
[0])) {
683 for (i
= 1; id
[i
]; i
++) {
684 if (!qemu_isalnum(id
[i
]) && !strchr("-._", id
[i
])) {
691 QemuOpts
*qemu_opts_create(QemuOptsList
*list
, const char *id
, int fail_if_exists
)
693 QemuOpts
*opts
= NULL
;
696 if (!id_wellformed(id
)) {
697 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "id", "an identifier");
698 error_printf_unless_qmp("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n");
701 opts
= qemu_opts_find(list
, id
);
703 if (fail_if_exists
) {
704 qerror_report(QERR_DUPLICATE_ID
, id
, list
->name
);
711 opts
= qemu_mallocz(sizeof(*opts
));
713 opts
->id
= qemu_strdup(id
);
716 loc_save(&opts
->loc
);
717 QTAILQ_INIT(&opts
->head
);
718 QTAILQ_INSERT_TAIL(&list
->head
, opts
, next
);
722 void qemu_opts_reset(QemuOptsList
*list
)
724 QemuOpts
*opts
, *next_opts
;
726 QTAILQ_FOREACH_SAFE(opts
, &list
->head
, next
, next_opts
) {
731 void qemu_opts_loc_restore(QemuOpts
*opts
)
733 loc_restore(&opts
->loc
);
736 int qemu_opts_set(QemuOptsList
*list
, const char *id
,
737 const char *name
, const char *value
)
741 opts
= qemu_opts_create(list
, id
, 1);
745 return qemu_opt_set(opts
, name
, value
);
748 const char *qemu_opts_id(QemuOpts
*opts
)
753 void qemu_opts_del(QemuOpts
*opts
)
758 opt
= QTAILQ_FIRST(&opts
->head
);
763 QTAILQ_REMOVE(&opts
->list
->head
, opts
, next
);
768 int qemu_opts_print(QemuOpts
*opts
, void *dummy
)
772 fprintf(stderr
, "%s: %s:", opts
->list
->name
,
773 opts
->id
? opts
->id
: "<noid>");
774 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
775 fprintf(stderr
, " %s=\"%s\"", opt
->name
, opt
->str
);
777 fprintf(stderr
, "\n");
781 int qemu_opts_do_parse(QemuOpts
*opts
, const char *params
, const char *firstname
)
783 char option
[128], value
[1024];
784 const char *p
,*pe
,*pc
;
786 for (p
= params
; *p
!= '\0'; p
++) {
789 if (!pe
|| (pc
&& pc
< pe
)) {
790 /* found "foo,more" */
791 if (p
== params
&& firstname
) {
792 /* implicitly named first option */
793 pstrcpy(option
, sizeof(option
), firstname
);
794 p
= get_opt_value(value
, sizeof(value
), p
);
796 /* option without value, probably a flag */
797 p
= get_opt_name(option
, sizeof(option
), p
, ',');
798 if (strncmp(option
, "no", 2) == 0) {
799 memmove(option
, option
+2, strlen(option
+2)+1);
800 pstrcpy(value
, sizeof(value
), "off");
802 pstrcpy(value
, sizeof(value
), "on");
806 /* found "foo=bar,more" */
807 p
= get_opt_name(option
, sizeof(option
), p
, '=');
812 p
= get_opt_value(value
, sizeof(value
), p
);
814 if (strcmp(option
, "id") != 0) {
815 /* store and parse */
816 if (qemu_opt_set(opts
, option
, value
) == -1) {
827 QemuOpts
*qemu_opts_parse(QemuOptsList
*list
, const char *params
,
830 const char *firstname
;
831 char value
[1024], *id
= 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(value
, sizeof(value
), params
+3);
841 } else if ((p
= strstr(params
, ",id=")) != NULL
) {
842 get_opt_value(value
, sizeof(value
), p
+4);
845 opts
= qemu_opts_create(list
, id
, 1);
849 if (qemu_opts_do_parse(opts
, params
, firstname
) != 0) {
857 static void qemu_opts_from_qdict_1(const char *key
, QObject
*obj
, void *opaque
)
863 if (!strcmp(key
, "id")) {
867 switch (qobject_type(obj
)) {
869 value
= qstring_get_str(qobject_to_qstring(obj
));
872 n
= snprintf(buf
, sizeof(buf
), "%" PRId64
,
873 qint_get_int(qobject_to_qint(obj
)));
874 assert(n
< sizeof(buf
));
878 n
= snprintf(buf
, sizeof(buf
), "%.17g",
879 qfloat_get_double(qobject_to_qfloat(obj
)));
880 assert(n
< sizeof(buf
));
884 pstrcpy(buf
, sizeof(buf
),
885 qbool_get_int(qobject_to_qbool(obj
)) ? "on" : "off");
891 qemu_opt_set(opaque
, key
, value
);
895 * Create QemuOpts from a QDict.
896 * Use value of key "id" as ID if it exists and is a QString.
897 * Only QStrings, QInts, QFloats and QBools are copied. Entries with
898 * other types are silently ignored.
900 QemuOpts
*qemu_opts_from_qdict(QemuOptsList
*list
, const QDict
*qdict
)
904 opts
= qemu_opts_create(list
, qdict_get_try_str(qdict
, "id"), 1);
908 qdict_iter(qdict
, qemu_opts_from_qdict_1
, opts
);
913 * Convert from QemuOpts to QDict.
914 * The QDict values are of type QString.
915 * TODO We'll want to use types appropriate for opt->desc->type, but
916 * this is enough for now.
918 QDict
*qemu_opts_to_qdict(QemuOpts
*opts
, QDict
*qdict
)
927 qdict_put(qdict
, "id", qstring_from_str(opts
->id
));
929 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
930 val
= QOBJECT(qstring_from_str(opt
->str
));
931 qdict_put_obj(qdict
, opt
->name
, val
);
936 /* Validate parsed opts against descriptions where no
937 * descriptions were provided in the QemuOptsList.
939 int qemu_opts_validate(QemuOpts
*opts
, const QemuOptDesc
*desc
)
943 assert(opts
->list
->desc
[0].name
== NULL
);
945 QTAILQ_FOREACH(opt
, &opts
->head
, next
) {
948 for (i
= 0; desc
[i
].name
!= NULL
; i
++) {
949 if (strcmp(desc
[i
].name
, opt
->name
) == 0) {
953 if (desc
[i
].name
== NULL
) {
954 qerror_report(QERR_INVALID_PARAMETER
, opt
->name
);
958 opt
->desc
= &desc
[i
];
960 if (qemu_opt_parse(opt
) < 0) {
968 int qemu_opts_foreach(QemuOptsList
*list
, qemu_opts_loopfunc func
, void *opaque
,
969 int abort_on_failure
)
976 QTAILQ_FOREACH(opts
, &list
->head
, next
) {
977 loc_restore(&opts
->loc
);
978 rc
|= func(opts
, opaque
);
979 if (abort_on_failure
&& rc
!= 0)