Merge branch 'upstream-merge'
[qemu-kvm/markmc.git] / qemu-option.c
blob49efd392d939809cbd1317933f5241e79f961778
1 /*
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
23 * THE SOFTWARE.
26 #include <stdio.h>
27 #include <string.h>
29 #include "qemu-common.h"
30 #include "qemu-option.h"
33 * Extracts the name of an option from the parameter string (p points at the
34 * first byte of the option name)
36 * The option name is delimited by delim (usually , or =) or the string end
37 * and is copied into buf. If the option name is longer than buf_size, it is
38 * truncated. buf is always zero terminated.
40 * The return value is the position of the delimiter/zero byte after the option
41 * name in p.
43 const char *get_opt_name(char *buf, int buf_size, const char *p, char delim)
45 char *q;
47 q = buf;
48 while (*p != '\0' && *p != delim) {
49 if (q && (q - buf) < buf_size - 1)
50 *q++ = *p;
51 p++;
53 if (q)
54 *q = '\0';
56 return p;
60 * Extracts the value of an option from the parameter string p (p points at the
61 * first byte of the option value)
63 * This function is comparable to get_opt_name with the difference that the
64 * delimiter is fixed to be comma which starts a new option. To specify an
65 * option value that contains commas, double each comma.
67 const char *get_opt_value(char *buf, int buf_size, const char *p)
69 char *q;
71 q = buf;
72 while (*p != '\0') {
73 if (*p == ',') {
74 if (*(p + 1) != ',')
75 break;
76 p++;
78 if (q && (q - buf) < buf_size - 1)
79 *q++ = *p;
80 p++;
82 if (q)
83 *q = '\0';
85 return p;
88 int get_next_param_value(char *buf, int buf_size,
89 const char *tag, const char **pstr)
91 const char *p;
92 char option[128];
94 p = *pstr;
95 for(;;) {
96 p = get_opt_name(option, sizeof(option), p, '=');
97 if (*p != '=')
98 break;
99 p++;
100 if (!strcmp(tag, option)) {
101 *pstr = get_opt_value(buf, buf_size, p);
102 if (**pstr == ',') {
103 (*pstr)++;
105 return strlen(buf);
106 } else {
107 p = get_opt_value(NULL, 0, p);
109 if (*p != ',')
110 break;
111 p++;
113 return 0;
116 int get_param_value(char *buf, int buf_size,
117 const char *tag, const char *str)
119 return get_next_param_value(buf, buf_size, tag, &str);
122 int check_params(char *buf, int buf_size,
123 const char * const *params, const char *str)
125 const char *p;
126 int i;
128 p = str;
129 while (*p != '\0') {
130 p = get_opt_name(buf, buf_size, p, '=');
131 if (*p != '=') {
132 return -1;
134 p++;
135 for (i = 0; params[i] != NULL; i++) {
136 if (!strcmp(params[i], buf)) {
137 break;
140 if (params[i] == NULL) {
141 return -1;
143 p = get_opt_value(NULL, 0, p);
144 if (*p != ',') {
145 break;
147 p++;
149 return 0;
153 * Searches an option list for an option with the given name
155 QEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list,
156 const char *name)
158 while (list && list->name) {
159 if (!strcmp(list->name, name)) {
160 return list;
162 list++;
165 return NULL;
168 static int parse_option_bool(const char *name, const char *value, int *ret)
170 if (value != NULL) {
171 if (!strcmp(value, "on")) {
172 *ret = 1;
173 } else if (!strcmp(value, "off")) {
174 *ret = 0;
175 } else {
176 fprintf(stderr, "Option '%s': Use 'on' or 'off'\n", name);
177 return -1;
179 } else {
180 *ret = 1;
182 return 0;
185 static int parse_option_number(const char *name, const char *value, uint64_t *ret)
187 char *postfix;
188 uint64_t number;
190 if (value != NULL) {
191 number = strtoull(value, &postfix, 0);
192 if (*postfix != '\0') {
193 fprintf(stderr, "Option '%s' needs a number as parameter\n", name);
194 return -1;
196 *ret = number;
197 } else {
198 fprintf(stderr, "Option '%s' needs a parameter\n", name);
199 return -1;
201 return 0;
204 static int parse_option_size(const char *name, const char *value, uint64_t *ret)
206 char *postfix;
207 double sizef;
209 if (value != NULL) {
210 sizef = strtod(value, &postfix);
211 switch (*postfix) {
212 case 'T':
213 sizef *= 1024;
214 case 'G':
215 sizef *= 1024;
216 case 'M':
217 sizef *= 1024;
218 case 'K':
219 case 'k':
220 sizef *= 1024;
221 case 'b':
222 case '\0':
223 *ret = (uint64_t) sizef;
224 break;
225 default:
226 fprintf(stderr, "Option '%s' needs size as parameter\n", name);
227 fprintf(stderr, "You may use k, M, G or T suffixes for "
228 "kilobytes, megabytes, gigabytes and terabytes.\n");
229 return -1;
231 } else {
232 fprintf(stderr, "Option '%s' needs a parameter\n", name);
233 return -1;
235 return 0;
239 * Sets the value of a parameter in a given option list. The parsing of the
240 * value depends on the type of option:
242 * OPT_FLAG (uses value.n):
243 * If no value is given, the flag is set to 1.
244 * Otherwise the value must be "on" (set to 1) or "off" (set to 0)
246 * OPT_STRING (uses value.s):
247 * value is strdup()ed and assigned as option value
249 * OPT_SIZE (uses value.n):
250 * The value is converted to an integer. Suffixes for kilobytes etc. are
251 * allowed (powers of 1024).
253 * Returns 0 on succes, -1 in error cases
255 int set_option_parameter(QEMUOptionParameter *list, const char *name,
256 const char *value)
258 int flag;
260 // Find a matching parameter
261 list = get_option_parameter(list, name);
262 if (list == NULL) {
263 fprintf(stderr, "Unknown option '%s'\n", name);
264 return -1;
267 // Process parameter
268 switch (list->type) {
269 case OPT_FLAG:
270 if (parse_option_bool(name, value, &flag) == -1)
271 return -1;
272 list->value.n = flag;
273 break;
275 case OPT_STRING:
276 if (value != NULL) {
277 list->value.s = qemu_strdup(value);
278 } else {
279 fprintf(stderr, "Option '%s' needs a parameter\n", name);
280 return -1;
282 break;
284 case OPT_SIZE:
285 if (parse_option_size(name, value, &list->value.n) == -1)
286 return -1;
287 break;
289 default:
290 fprintf(stderr, "Bug: Option '%s' has an unknown type\n", name);
291 return -1;
294 return 0;
298 * Sets the given parameter to an integer instead of a string.
299 * This function cannot be used to set string options.
301 * Returns 0 on success, -1 in error cases
303 int set_option_parameter_int(QEMUOptionParameter *list, const char *name,
304 uint64_t value)
306 // Find a matching parameter
307 list = get_option_parameter(list, name);
308 if (list == NULL) {
309 fprintf(stderr, "Unknown option '%s'\n", name);
310 return -1;
313 // Process parameter
314 switch (list->type) {
315 case OPT_FLAG:
316 case OPT_NUMBER:
317 case OPT_SIZE:
318 list->value.n = value;
319 break;
321 default:
322 return -1;
325 return 0;
329 * Frees a option list. If it contains strings, the strings are freed as well.
331 void free_option_parameters(QEMUOptionParameter *list)
333 QEMUOptionParameter *cur = list;
335 while (cur && cur->name) {
336 if (cur->type == OPT_STRING) {
337 qemu_free(cur->value.s);
339 cur++;
342 qemu_free(list);
346 * Parses a parameter string (param) into an option list (dest).
348 * list is the templace is. If dest is NULL, a new copy of list is created for
349 * it. If list is NULL, this function fails.
351 * A parameter string consists of one or more parameters, separated by commas.
352 * Each parameter consists of its name and possibly of a value. In the latter
353 * case, the value is delimited by an = character. To specify a value which
354 * contains commas, double each comma so it won't be recognized as the end of
355 * the parameter.
357 * For more details of the parsing see above.
359 * Returns a pointer to the first element of dest (or the newly allocated copy)
360 * or NULL in error cases
362 QEMUOptionParameter *parse_option_parameters(const char *param,
363 QEMUOptionParameter *list, QEMUOptionParameter *dest)
365 QEMUOptionParameter *cur;
366 QEMUOptionParameter *allocated = NULL;
367 char name[256];
368 char value[256];
369 char *param_delim, *value_delim;
370 char next_delim;
371 size_t num_options;
373 if (list == NULL) {
374 return NULL;
377 if (dest == NULL) {
378 // Count valid options
379 num_options = 0;
380 cur = list;
381 while (cur->name) {
382 num_options++;
383 cur++;
386 // Create a copy of the option list to fill in values
387 dest = qemu_mallocz((num_options + 1) * sizeof(QEMUOptionParameter));
388 allocated = dest;
389 memcpy(dest, list, (num_options + 1) * sizeof(QEMUOptionParameter));
392 while (*param) {
394 // Find parameter name and value in the string
395 param_delim = strchr(param, ',');
396 value_delim = strchr(param, '=');
398 if (value_delim && (value_delim < param_delim || !param_delim)) {
399 next_delim = '=';
400 } else {
401 next_delim = ',';
402 value_delim = NULL;
405 param = get_opt_name(name, sizeof(name), param, next_delim);
406 if (value_delim) {
407 param = get_opt_value(value, sizeof(value), param + 1);
409 if (*param != '\0') {
410 param++;
413 // Set the parameter
414 if (set_option_parameter(dest, name, value_delim ? value : NULL)) {
415 goto fail;
419 return dest;
421 fail:
422 // Only free the list if it was newly allocated
423 free_option_parameters(allocated);
424 return NULL;
428 * Prints all options of a list that have a value to stdout
430 void print_option_parameters(QEMUOptionParameter *list)
432 while (list && list->name) {
433 switch (list->type) {
434 case OPT_STRING:
435 if (list->value.s != NULL) {
436 printf("%s='%s' ", list->name, list->value.s);
438 break;
439 case OPT_FLAG:
440 printf("%s=%s ", list->name, list->value.n ? "on" : "off");
441 break;
442 case OPT_SIZE:
443 case OPT_NUMBER:
444 printf("%s=%" PRId64 " ", list->name, list->value.n);
445 break;
446 default:
447 printf("%s=(unkown type) ", list->name);
448 break;
450 list++;
455 * Prints an overview of all available options
457 void print_option_help(QEMUOptionParameter *list)
459 printf("Supported options:\n");
460 while (list && list->name) {
461 printf("%-16s %s\n", list->name,
462 list->help ? list->help : "No description available");
463 list++;
467 /* ------------------------------------------------------------------ */
469 struct QemuOpt {
470 const char *name;
471 const char *str;
473 QemuOptDesc *desc;
474 union {
475 int boolean;
476 uint64_t uint;
477 } value;
479 QemuOpts *opts;
480 QTAILQ_ENTRY(QemuOpt) next;
483 struct QemuOpts {
484 const char *id;
485 QemuOptsList *list;
486 QTAILQ_HEAD(QemuOptHead, QemuOpt) head;
487 QTAILQ_ENTRY(QemuOpts) next;
490 static QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name)
492 QemuOpt *opt;
494 QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
495 if (strcmp(opt->name, name) != 0)
496 continue;
497 return opt;
499 return NULL;
502 const char *qemu_opt_get(QemuOpts *opts, const char *name)
504 QemuOpt *opt = qemu_opt_find(opts, name);
505 return opt ? opt->str : NULL;
508 int qemu_opt_get_bool(QemuOpts *opts, const char *name, int defval)
510 QemuOpt *opt = qemu_opt_find(opts, name);
512 if (opt == NULL)
513 return defval;
514 assert(opt->desc && opt->desc->type == QEMU_OPT_BOOL);
515 return opt->value.boolean;
518 uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval)
520 QemuOpt *opt = qemu_opt_find(opts, name);
522 if (opt == NULL)
523 return defval;
524 assert(opt->desc && opt->desc->type == QEMU_OPT_NUMBER);
525 return opt->value.uint;
528 uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval)
530 QemuOpt *opt = qemu_opt_find(opts, name);
532 if (opt == NULL)
533 return defval;
534 assert(opt->desc && opt->desc->type == QEMU_OPT_SIZE);
535 return opt->value.uint;
538 static int qemu_opt_parse(QemuOpt *opt)
540 if (opt->desc == NULL)
541 return 0;
542 switch (opt->desc->type) {
543 case QEMU_OPT_STRING:
544 /* nothing */
545 return 0;
546 case QEMU_OPT_BOOL:
547 return parse_option_bool(opt->name, opt->str, &opt->value.boolean);
548 case QEMU_OPT_NUMBER:
549 return parse_option_number(opt->name, opt->str, &opt->value.uint);
550 case QEMU_OPT_SIZE:
551 return parse_option_size(opt->name, opt->str, &opt->value.uint);
552 default:
553 abort();
557 static void qemu_opt_del(QemuOpt *opt)
559 QTAILQ_REMOVE(&opt->opts->head, opt, next);
560 qemu_free((/* !const */ char*)opt->name);
561 qemu_free((/* !const */ char*)opt->str);
562 qemu_free(opt);
565 int qemu_opt_set(QemuOpts *opts, const char *name, const char *value)
567 QemuOpt *opt;
568 QemuOptDesc *desc = opts->list->desc;
569 int i;
571 for (i = 0; desc[i].name != NULL; i++) {
572 if (strcmp(desc[i].name, name) == 0) {
573 break;
576 if (desc[i].name == NULL) {
577 if (i == 0) {
578 /* empty list -> allow any */;
579 } else {
580 fprintf(stderr, "option \"%s\" is not valid for %s\n",
581 name, opts->list->name);
582 return -1;
586 opt = qemu_mallocz(sizeof(*opt));
587 opt->name = qemu_strdup(name);
588 opt->opts = opts;
589 QTAILQ_INSERT_TAIL(&opts->head, opt, next);
590 if (desc[i].name != NULL) {
591 opt->desc = desc+i;
593 if (value) {
594 opt->str = qemu_strdup(value);
596 if (qemu_opt_parse(opt) < 0) {
597 fprintf(stderr, "Failed to parse \"%s\" for \"%s.%s\"\n", opt->str,
598 opts->list->name, opt->name);
599 qemu_opt_del(opt);
600 return -1;
602 return 0;
605 int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
606 int abort_on_failure)
608 QemuOpt *opt;
609 int rc = 0;
611 QTAILQ_FOREACH(opt, &opts->head, next) {
612 rc = func(opt->name, opt->str, opaque);
613 if (abort_on_failure && rc != 0)
614 break;
616 return rc;
619 QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id)
621 QemuOpts *opts;
623 QTAILQ_FOREACH(opts, &list->head, next) {
624 if (!opts->id) {
625 continue;
627 if (strcmp(opts->id, id) != 0) {
628 continue;
630 return opts;
632 return NULL;
635 QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, int fail_if_exists)
637 QemuOpts *opts = NULL;
639 if (id) {
640 opts = qemu_opts_find(list, id);
641 if (opts != NULL) {
642 if (fail_if_exists) {
643 fprintf(stderr, "tried to create id \"%s\" twice for \"%s\"\n",
644 id, list->name);
645 return NULL;
646 } else {
647 return opts;
651 opts = qemu_mallocz(sizeof(*opts));
652 if (id) {
653 opts->id = qemu_strdup(id);
655 opts->list = list;
656 QTAILQ_INIT(&opts->head);
657 QTAILQ_INSERT_TAIL(&list->head, opts, next);
658 return opts;
661 int qemu_opts_set(QemuOptsList *list, const char *id,
662 const char *name, const char *value)
664 QemuOpts *opts;
666 opts = qemu_opts_create(list, id, 1);
667 if (opts == NULL) {
668 return -1;
670 return qemu_opt_set(opts, name, value);
673 const char *qemu_opts_id(QemuOpts *opts)
675 return opts->id;
678 void qemu_opts_del(QemuOpts *opts)
680 QemuOpt *opt;
682 for (;;) {
683 opt = QTAILQ_FIRST(&opts->head);
684 if (opt == NULL)
685 break;
686 qemu_opt_del(opt);
688 QTAILQ_REMOVE(&opts->list->head, opts, next);
689 qemu_free(opts);
692 int qemu_opts_print(QemuOpts *opts, void *dummy)
694 QemuOpt *opt;
696 fprintf(stderr, "%s: %s:", opts->list->name,
697 opts->id ? opts->id : "<noid>");
698 QTAILQ_FOREACH(opt, &opts->head, next) {
699 fprintf(stderr, " %s=\"%s\"", opt->name, opt->str);
701 fprintf(stderr, "\n");
702 return 0;
705 int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname)
707 char option[128], value[128];
708 const char *p,*pe,*pc;
710 for (p = params; *p != '\0'; p++) {
711 pe = strchr(p, '=');
712 pc = strchr(p, ',');
713 if (!pe || (pc && pc < pe)) {
714 /* found "foo,more" */
715 if (p == params && firstname) {
716 /* implicitly named first option */
717 pstrcpy(option, sizeof(option), firstname);
718 p = get_opt_value(value, sizeof(value), p);
719 } else {
720 /* option without value, probably a flag */
721 p = get_opt_name(option, sizeof(option), p, ',');
722 if (strncmp(option, "no", 2) == 0) {
723 memmove(option, option+2, strlen(option+2)+1);
724 pstrcpy(value, sizeof(value), "off");
725 } else {
726 pstrcpy(value, sizeof(value), "on");
729 } else {
730 /* found "foo=bar,more" */
731 p = get_opt_name(option, sizeof(option), p, '=');
732 if (*p != '=') {
733 break;
735 p++;
736 p = get_opt_value(value, sizeof(value), p);
738 if (strcmp(option, "id") != 0) {
739 /* store and parse */
740 if (qemu_opt_set(opts, option, value) == -1) {
741 return -1;
744 if (*p != ',') {
745 break;
748 return 0;
751 QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, const char *firstname)
753 char value[128], *id = NULL;
754 const char *p;
755 QemuOpts *opts;
757 if (strncmp(params, "id=", 3) == 0) {
758 get_opt_value(value, sizeof(value), params+3);
759 id = qemu_strdup(value);
760 } else if ((p = strstr(params, ",id=")) != NULL) {
761 get_opt_value(value, sizeof(value), p+4);
762 id = qemu_strdup(value);
764 opts = qemu_opts_create(list, id, 1);
765 if (opts == NULL)
766 return NULL;
768 if (qemu_opts_do_parse(opts, params, firstname) != 0) {
769 qemu_opts_del(opts);
770 return NULL;
773 return opts;
776 /* Validate parsed opts against descriptions where no
777 * descriptions were provided in the QemuOptsList.
779 int qemu_opts_validate(QemuOpts *opts, QemuOptDesc *desc)
781 QemuOpt *opt;
783 assert(opts->list->desc[0].name == NULL);
785 QTAILQ_FOREACH(opt, &opts->head, next) {
786 int i;
788 for (i = 0; desc[i].name != NULL; i++) {
789 if (strcmp(desc[i].name, opt->name) == 0) {
790 break;
793 if (desc[i].name == NULL) {
794 fprintf(stderr, "option \"%s\" is not valid for %s\n",
795 opt->name, opts->list->name);
796 return -1;
799 opt->desc = &desc[i];
801 if (qemu_opt_parse(opt) < 0) {
802 return -1;
806 return 0;
809 int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque,
810 int abort_on_failure)
812 QemuOpts *opts;
813 int rc = 0;
815 QTAILQ_FOREACH(opts, &list->head, next) {
816 rc = func(opts, opaque);
817 if (abort_on_failure && rc != 0)
818 break;
820 return rc;