util/qemu-option.c

   1 /*
   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
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include "qemu-common.h"
  30 #include "qemu/error-report.h"
  31 #include "qapi/qmp/types.h"
  32 #include "qapi/error.h"
  33 #include "qapi/qmp/qerror.h"
  34 #include "qemu/option_int.h"
  35
  36 /*
  37  * Extracts the name of an option from the parameter string (p points at the
  38  * first byte of the option name)
  39  *
  40  * The option name is delimited by delim (usually , or =) or the string end
  41  * and is copied into buf. If the option name is longer than buf_size, it is
  42  * truncated. buf is always zero terminated.
  43  *
  44  * The return value is the position of the delimiter/zero byte after the option
  45  * name in p.
  46  */
  47 const char *get_opt_name(char *buf, int buf_size, const char *p, char delim)
  48 {
  49     char *q;
  50
  51     q = buf;
  52     while (*p != '\0' && *p != delim) {
  53         if (q && (q - buf) < buf_size - 1)
  54             *q++ = *p;
  55         p++;
  56     }
  57     if (q)
  58         *q = '\0';
  59
  60     return p;
  61 }
  62
  63 /*
  64  * Extracts the value of an option from the parameter string p (p points at the
  65  * first byte of the option value)
  66  *
  67  * This function is comparable to get_opt_name with the difference that the
  68  * delimiter is fixed to be comma which starts a new option. To specify an
  69  * option value that contains commas, double each comma.
  70  */
  71 const char *get_opt_value(char *buf, int buf_size, const char *p)
  72 {
  73     char *q;
  74
  75     q = buf;
  76     while (*p != '\0') {
  77         if (*p == ',') {
  78             if (*(p + 1) != ',')
  79                 break;
  80             p++;
  81         }
  82         if (q && (q - buf) < buf_size - 1)
  83             *q++ = *p;
  84         p++;
  85     }
  86     if (q)
  87         *q = '\0';
  88
  89     return p;
  90 }
  91
  92 int get_next_param_value(char *buf, int buf_size,
  93                          const char *tag, const char **pstr)
  94 {
  95     const char *p;
  96     char option[128];
  97
  98     p = *pstr;
  99     for(;;) {
 100         p = get_opt_name(option, sizeof(option), p, '=');
 101         if (*p != '=')
 102             break;
 103         p++;
 104         if (!strcmp(tag, option)) {
 105             *pstr = get_opt_value(buf, buf_size, p);
 106             if (**pstr == ',') {
 107                 (*pstr)++;
 108             }
 109             return strlen(buf);
 110         } else {
 111             p = get_opt_value(NULL, 0, p);
 112         }
 113         if (*p != ',')
 114             break;
 115         p++;
 116     }
 117     return 0;
 118 }
 119
 120 int get_param_value(char *buf, int buf_size,
 121                     const char *tag, const char *str)
 122 {
 123     return get_next_param_value(buf, buf_size, tag, &str);
 124 }
 125
 126 static void parse_option_bool(const char *name, const char *value, bool *ret,
 127                               Error **errp)
 128 {
 129     if (value != NULL) {
 130         if (!strcmp(value, "on")) {
 131             *ret = 1;
 132         } else if (!strcmp(value, "off")) {
 133             *ret = 0;
 134         } else {
 135             error_set(errp,QERR_INVALID_PARAMETER_VALUE, name, "'on' or 'off'");
 136         }
 137     } else {
 138         *ret = 1;
 139     }
 140 }
 141
 142 static void parse_option_number(const char *name, const char *value,
 143                                 uint64_t *ret, Error **errp)
 144 {
 145     char *postfix;
 146     uint64_t number;
 147
 148     if (value != NULL) {
 149         number = strtoull(value, &postfix, 0);
 150         if (*postfix != '\0') {
 151             error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
 152             return;
 153         }
 154         *ret = number;
 155     } else {
 156         error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
 157     }
 158 }
 159
 160 static const QemuOptDesc *find_desc_by_name(const QemuOptDesc *desc,
 161                                             const char *name)
 162 {
 163     int i;
 164
 165     for (i = 0; desc[i].name != NULL; i++) {
 166         if (strcmp(desc[i].name, name) == 0) {
 167             return &desc[i];
 168         }
 169     }
 170
 171     return NULL;
 172 }
 173
 174 void parse_option_size(const char *name, const char *value,
 175                        uint64_t *ret, Error **errp)
 176 {
 177     char *postfix;
 178     double sizef;
 179
 180     if (value != NULL) {
 181         sizef = strtod(value, &postfix);
 182         switch (*postfix) {
 183         case 'T':
 184             sizef *= 1024;
 185             /* fall through */
 186         case 'G':
 187             sizef *= 1024;
 188             /* fall through */
 189         case 'M':
 190             sizef *= 1024;
 191             /* fall through */
 192         case 'K':
 193         case 'k':
 194             sizef *= 1024;
 195             /* fall through */
 196         case 'b':
 197         case '\0':
 198             *ret = (uint64_t) sizef;
 199             break;
 200         default:
 201             error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
 202 #if 0 /* conversion from qerror_report() to error_set() broke this: */
 203             error_printf_unless_qmp("You may use k, M, G or T suffixes for "
 204                     "kilobytes, megabytes, gigabytes and terabytes.\n");
 205 #endif
 206             return;
 207         }
 208     } else {
 209         error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
 210     }
 211 }
 212
 213 bool has_help_option(const char *param)
 214 {
 215     size_t buflen = strlen(param) + 1;
 216     char *buf = g_malloc(buflen);
 217     const char *p = param;
 218     bool result = false;
 219
 220     while (*p) {
 221         p = get_opt_value(buf, buflen, p);
 222         if (*p) {
 223             p++;
 224         }
 225
 226         if (is_help_option(buf)) {
 227             result = true;
 228             goto out;
 229         }
 230     }
 231
 232 out:
 233     g_free(buf);
 234     return result;
 235 }
 236
 237 bool is_valid_option_list(const char *param)
 238 {
 239     size_t buflen = strlen(param) + 1;
 240     char *buf = g_malloc(buflen);
 241     const char *p = param;
 242     bool result = true;
 243
 244     while (*p) {
 245         p = get_opt_value(buf, buflen, p);
 246         if (*p && !*++p) {
 247             result = false;
 248             goto out;
 249         }
 250
 251         if (!*buf || *buf == ',') {
 252             result = false;
 253             goto out;
 254         }
 255     }
 256
 257 out:
 258     g_free(buf);
 259     return result;
 260 }
 261
 262 void qemu_opts_print_help(QemuOptsList *list)
 263 {
 264     QemuOptDesc *desc;
 265
 266     assert(list);
 267     desc = list->desc;
 268     printf("Supported options:\n");
 269     while (desc && desc->name) {
 270         printf("%-16s %s\n", desc->name,
 271                desc->help ? desc->help : "No description available");
 272         desc++;
 273     }
 274 }
 275 /* ------------------------------------------------------------------ */
 276
 277 QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name)
 278 {
 279     QemuOpt *opt;
 280
 281     QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
 282         if (strcmp(opt->name, name) != 0)
 283             continue;
 284         return opt;
 285     }
 286     return NULL;
 287 }
 288
 289 static void qemu_opt_del(QemuOpt *opt)
 290 {
 291     QTAILQ_REMOVE(&opt->opts->head, opt, next);
 292     g_free(opt->name);
 293     g_free(opt->str);
 294     g_free(opt);
 295 }
 296
 297 /* qemu_opt_set allows many settings for the same option.
 298  * This function deletes all settings for an option.
 299  */
 300 static void qemu_opt_del_all(QemuOpts *opts, const char *name)
 301 {
 302     QemuOpt *opt, *next_opt;
 303
 304     QTAILQ_FOREACH_SAFE(opt, &opts->head, next, next_opt) {
 305         if (!strcmp(opt->name, name)) {
 306             qemu_opt_del(opt);
 307         }
 308     }
 309 }
 310
 311 const char *qemu_opt_get(QemuOpts *opts, const char *name)
 312 {
 313     QemuOpt *opt;
 314
 315     if (opts == NULL) {
 316         return NULL;
 317     }
 318
 319     opt = qemu_opt_find(opts, name);
 320     if (!opt) {
 321         const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
 322         if (desc && desc->def_value_str) {
 323             return desc->def_value_str;
 324         }
 325     }
 326     return opt ? opt->str : NULL;
 327 }
 328
 329 /* Get a known option (or its default) and remove it from the list
 330  * all in one action. Return a malloced string of the option value.
 331  * Result must be freed by caller with g_free().
 332  */
 333 char *qemu_opt_get_del(QemuOpts *opts, const char *name)
 334 {
 335     QemuOpt *opt;
 336     const QemuOptDesc *desc;
 337     char *str = NULL;
 338
 339     if (opts == NULL) {
 340         return NULL;
 341     }
 342
 343     opt = qemu_opt_find(opts, name);
 344     if (!opt) {
 345         desc = find_desc_by_name(opts->list->desc, name);
 346         if (desc && desc->def_value_str) {
 347             str = g_strdup(desc->def_value_str);
 348         }
 349         return str;
 350     }
 351     str = opt->str;
 352     opt->str = NULL;
 353     qemu_opt_del_all(opts, name);
 354     return str;
 355 }
 356
 357 bool qemu_opt_has_help_opt(QemuOpts *opts)
 358 {
 359     QemuOpt *opt;
 360
 361     QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
 362         if (is_help_option(opt->name)) {
 363             return true;
 364         }
 365     }
 366     return false;
 367 }
 368
 369 static bool qemu_opt_get_bool_helper(QemuOpts *opts, const char *name,
 370                                      bool defval, bool del)
 371 {
 372     QemuOpt *opt;
 373     bool ret = defval;
 374
 375     if (opts == NULL) {
 376         return ret;
 377     }
 378
 379     opt = qemu_opt_find(opts, name);
 380     if (opt == NULL) {
 381         const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
 382         if (desc && desc->def_value_str) {
 383             parse_option_bool(name, desc->def_value_str, &ret, &error_abort);
 384         }
 385         return ret;
 386     }
 387     assert(opt->desc && opt->desc->type == QEMU_OPT_BOOL);
 388     ret = opt->value.boolean;
 389     if (del) {
 390         qemu_opt_del_all(opts, name);
 391     }
 392     return ret;
 393 }
 394
 395 bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval)
 396 {
 397     return qemu_opt_get_bool_helper(opts, name, defval, false);
 398 }
 399
 400 bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval)
 401 {
 402     return qemu_opt_get_bool_helper(opts, name, defval, true);
 403 }
 404
 405 static uint64_t qemu_opt_get_number_helper(QemuOpts *opts, const char *name,
 406                                            uint64_t defval, bool del)
 407 {
 408     QemuOpt *opt;
 409     uint64_t ret = defval;
 410
 411     if (opts == NULL) {
 412         return ret;
 413     }
 414
 415     opt = qemu_opt_find(opts, name);
 416     if (opt == NULL) {
 417         const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
 418         if (desc && desc->def_value_str) {
 419             parse_option_number(name, desc->def_value_str, &ret, &error_abort);
 420         }
 421         return ret;
 422     }
 423     assert(opt->desc && opt->desc->type == QEMU_OPT_NUMBER);
 424     ret = opt->value.uint;
 425     if (del) {
 426         qemu_opt_del_all(opts, name);
 427     }
 428     return ret;
 429 }
 430
 431 uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval)
 432 {
 433     return qemu_opt_get_number_helper(opts, name, defval, false);
 434 }
 435
 436 uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name,
 437                                  uint64_t defval)
 438 {
 439     return qemu_opt_get_number_helper(opts, name, defval, true);
 440 }
 441
 442 static uint64_t qemu_opt_get_size_helper(QemuOpts *opts, const char *name,
 443                                          uint64_t defval, bool del)
 444 {
 445     QemuOpt *opt;
 446     uint64_t ret = defval;
 447
 448     if (opts == NULL) {
 449         return ret;
 450     }
 451
 452     opt = qemu_opt_find(opts, name);
 453     if (opt == NULL) {
 454         const QemuOptDesc *desc = find_desc_by_name(opts->list->desc, name);
 455         if (desc && desc->def_value_str) {
 456             parse_option_size(name, desc->def_value_str, &ret, &error_abort);
 457         }
 458         return ret;
 459     }
 460     assert(opt->desc && opt->desc->type == QEMU_OPT_SIZE);
 461     ret = opt->value.uint;
 462     if (del) {
 463         qemu_opt_del_all(opts, name);
 464     }
 465     return ret;
 466 }
 467
 468 uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval)
 469 {
 470     return qemu_opt_get_size_helper(opts, name, defval, false);
 471 }
 472
 473 uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name,
 474                                uint64_t defval)
 475 {
 476     return qemu_opt_get_size_helper(opts, name, defval, true);
 477 }
 478
 479 static void qemu_opt_parse(QemuOpt *opt, Error **errp)
 480 {
 481     if (opt->desc == NULL)
 482         return;
 483
 484     switch (opt->desc->type) {
 485     case QEMU_OPT_STRING:
 486         /* nothing */
 487         return;
 488     case QEMU_OPT_BOOL:
 489         parse_option_bool(opt->name, opt->str, &opt->value.boolean, errp);
 490         break;
 491     case QEMU_OPT_NUMBER:
 492         parse_option_number(opt->name, opt->str, &opt->value.uint, errp);
 493         break;
 494     case QEMU_OPT_SIZE:
 495         parse_option_size(opt->name, opt->str, &opt->value.uint, errp);
 496         break;
 497     default:
 498         abort();
 499     }
 500 }
 501
 502 static bool opts_accepts_any(const QemuOpts *opts)
 503 {
 504     return opts->list->desc[0].name == NULL;
 505 }
 506
 507 int qemu_opt_unset(QemuOpts *opts, const char *name)
 508 {
 509     QemuOpt *opt = qemu_opt_find(opts, name);
 510
 511     assert(opts_accepts_any(opts));
 512
 513     if (opt == NULL) {
 514         return -1;
 515     } else {
 516         qemu_opt_del(opt);
 517         return 0;
 518     }
 519 }
 520
 521 static void opt_set(QemuOpts *opts, const char *name, const char *value,
 522                     bool prepend, Error **errp)
 523 {
 524     QemuOpt *opt;
 525     const QemuOptDesc *desc;
 526     Error *local_err = NULL;
 527
 528     desc = find_desc_by_name(opts->list->desc, name);
 529     if (!desc && !opts_accepts_any(opts)) {
 530         error_set(errp, QERR_INVALID_PARAMETER, name);
 531         return;
 532     }
 533
 534     opt = g_malloc0(sizeof(*opt));
 535     opt->name = g_strdup(name);
 536     opt->opts = opts;
 537     if (prepend) {
 538         QTAILQ_INSERT_HEAD(&opts->head, opt, next);
 539     } else {
 540         QTAILQ_INSERT_TAIL(&opts->head, opt, next);
 541     }
 542     opt->desc = desc;
 543     opt->str = g_strdup(value);
 544     qemu_opt_parse(opt, &local_err);
 545     if (local_err) {
 546         error_propagate(errp, local_err);
 547         qemu_opt_del(opt);
 548     }
 549 }
 550
 551 int qemu_opt_set(QemuOpts *opts, const char *name, const char *value)
 552 {
 553     Error *local_err = NULL;
 554
 555     opt_set(opts, name, value, false, &local_err);
 556     if (local_err) {
 557         qerror_report_err(local_err);
 558         error_free(local_err);
 559         return -1;
 560     }
 561
 562     return 0;
 563 }
 564
 565 void qemu_opt_set_err(QemuOpts *opts, const char *name, const char *value,
 566                       Error **errp)
 567 {
 568     opt_set(opts, name, value, false, errp);
 569 }
 570
 571 void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
 572                        Error **errp)
 573 {
 574     QemuOpt *opt;
 575     const QemuOptDesc *desc = opts->list->desc;
 576
 577     opt = g_malloc0(sizeof(*opt));
 578     opt->desc = find_desc_by_name(desc, name);
 579     if (!opt->desc && !opts_accepts_any(opts)) {
 580         error_set(errp, QERR_INVALID_PARAMETER, name);
 581         g_free(opt);
 582         return;
 583     }
 584
 585     opt->name = g_strdup(name);
 586     opt->opts = opts;
 587     opt->value.boolean = !!val;
 588     opt->str = g_strdup(val ? "on" : "off");
 589     QTAILQ_INSERT_TAIL(&opts->head, opt, next);
 590 }
 591
 592 void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
 593                          Error **errp)
 594 {
 595     QemuOpt *opt;
 596     const QemuOptDesc *desc = opts->list->desc;
 597
 598     opt = g_malloc0(sizeof(*opt));
 599     opt->desc = find_desc_by_name(desc, name);
 600     if (!opt->desc && !opts_accepts_any(opts)) {
 601         error_set(errp, QERR_INVALID_PARAMETER, name);
 602         g_free(opt);
 603         return;
 604     }
 605
 606     opt->name = g_strdup(name);
 607     opt->opts = opts;
 608     opt->value.uint = val;
 609     opt->str = g_strdup_printf("%" PRId64, val);
 610     QTAILQ_INSERT_TAIL(&opts->head, opt, next);
 611 }
 612
 613 int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
 614                      int abort_on_failure)
 615 {
 616     QemuOpt *opt;
 617     int rc = 0;
 618
 619     QTAILQ_FOREACH(opt, &opts->head, next) {
 620         rc = func(opt->name, opt->str, opaque);
 621         if (abort_on_failure  &&  rc != 0)
 622             break;
 623     }
 624     return rc;
 625 }
 626
 627 QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id)
 628 {
 629     QemuOpts *opts;
 630
 631     QTAILQ_FOREACH(opts, &list->head, next) {
 632         if (!opts->id && !id) {
 633             return opts;
 634         }
 635         if (opts->id && id && !strcmp(opts->id, id)) {
 636             return opts;
 637         }
 638     }
 639     return NULL;
 640 }
 641
 642 QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
 643                            int fail_if_exists, Error **errp)
 644 {
 645     QemuOpts *opts = NULL;
 646
 647     if (id) {
 648         if (!id_wellformed(id)) {
 649             error_set(errp,QERR_INVALID_PARAMETER_VALUE, "id", "an identifier");
 650 #if 0 /* conversion from qerror_report() to error_set() broke this: */
 651             error_printf_unless_qmp("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n");
 652 #endif
 653             return NULL;
 654         }
 655         opts = qemu_opts_find(list, id);
 656         if (opts != NULL) {
 657             if (fail_if_exists && !list->merge_lists) {
 658                 error_setg(errp, "Duplicate ID '%s' for %s", id, list->name);
 659                 return NULL;
 660             } else {
 661                 return opts;
 662             }
 663         }
 664     } else if (list->merge_lists) {
 665         opts = qemu_opts_find(list, NULL);
 666         if (opts) {
 667             return opts;
 668         }
 669     }
 670     opts = g_malloc0(sizeof(*opts));
 671     opts->id = g_strdup(id);
 672     opts->list = list;
 673     loc_save(&opts->loc);
 674     QTAILQ_INIT(&opts->head);
 675     QTAILQ_INSERT_TAIL(&list->head, opts, next);
 676     return opts;
 677 }
 678
 679 void 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
 688 void qemu_opts_loc_restore(QemuOpts *opts)
 689 {
 690     loc_restore(&opts->loc);
 691 }
 692
 693 void qemu_opts_set(QemuOptsList *list, const char *id,
 694                    const char *name, const char *value, Error **errp)
 695 {
 696     QemuOpts *opts;
 697     Error *local_err = NULL;
 698
 699     opts = qemu_opts_create(list, id, 1, &local_err);
 700     if (local_err) {
 701         error_propagate(errp, local_err);
 702         return;
 703     }
 704     qemu_opt_set_err(opts, name, value, errp);
 705 }
 706
 707 const char *qemu_opts_id(QemuOpts *opts)
 708 {
 709     return opts->id;
 710 }
 711
 712 /* The id string will be g_free()d by qemu_opts_del */
 713 void qemu_opts_set_id(QemuOpts *opts, char *id)
 714 {
 715     opts->id = id;
 716 }
 717
 718 void qemu_opts_del(QemuOpts *opts)
 719 {
 720     QemuOpt *opt;
 721
 722     if (opts == NULL) {
 723         return;
 724     }
 725
 726     for (;;) {
 727         opt = QTAILQ_FIRST(&opts->head);
 728         if (opt == NULL)
 729             break;
 730         qemu_opt_del(opt);
 731     }
 732     QTAILQ_REMOVE(&opts->list->head, opts, next);
 733     g_free(opts->id);
 734     g_free(opts);
 735 }
 736
 737 void qemu_opts_print(QemuOpts *opts, const char *sep)
 738 {
 739     QemuOpt *opt;
 740     QemuOptDesc *desc = opts->list->desc;
 741
 742     if (desc[0].name == NULL) {
 743         QTAILQ_FOREACH(opt, &opts->head, next) {
 744             printf("%s%s=\"%s\"", sep, opt->name, opt->str);
 745         }
 746         return;
 747     }
 748     for (; desc && desc->name; desc++) {
 749         const char *value;
 750         QemuOpt *opt = qemu_opt_find(opts, desc->name);
 751
 752         value = opt ? opt->str : desc->def_value_str;
 753         if (!value) {
 754             continue;
 755         }
 756         if (desc->type == QEMU_OPT_STRING) {
 757             printf("%s%s='%s'", sep, desc->name, value);
 758         } else if ((desc->type == QEMU_OPT_SIZE ||
 759                     desc->type == QEMU_OPT_NUMBER) && opt) {
 760             printf("%s%s=%" PRId64, sep, desc->name, opt->value.uint);
 761         } else {
 762             printf("%s%s=%s", sep, desc->name, value);
 763         }
 764     }
 765 }
 766
 767 static int opts_do_parse(QemuOpts *opts, const char *params,
 768                          const char *firstname, bool prepend)
 769 {
 770     char option[128], value[1024];
 771     const char *p,*pe,*pc;
 772     Error *local_err = NULL;
 773
 774     for (p = params; *p != '\0'; p++) {
 775         pe = strchr(p, '=');
 776         pc = strchr(p, ',');
 777         if (!pe || (pc && pc < pe)) {
 778             /* found "foo,more" */
 779             if (p == params && firstname) {
 780                 /* implicitly named first option */
 781                 pstrcpy(option, sizeof(option), firstname);
 782                 p = get_opt_value(value, sizeof(value), p);
 783             } else {
 784                 /* option without value, probably a flag */
 785                 p = get_opt_name(option, sizeof(option), p, ',');
 786                 if (strncmp(option, "no", 2) == 0) {
 787                     memmove(option, option+2, strlen(option+2)+1);
 788                     pstrcpy(value, sizeof(value), "off");
 789                 } else {
 790                     pstrcpy(value, sizeof(value), "on");
 791                 }
 792             }
 793         } else {
 794             /* found "foo=bar,more" */
 795             p = get_opt_name(option, sizeof(option), p, '=');
 796             if (*p != '=') {
 797                 break;
 798             }
 799             p++;
 800             p = get_opt_value(value, sizeof(value), p);
 801         }
 802         if (strcmp(option, "id") != 0) {
 803             /* store and parse */
 804             opt_set(opts, option, value, prepend, &local_err);
 805             if (local_err) {
 806                 qerror_report_err(local_err);
 807                 error_free(local_err);
 808                 return -1;
 809             }
 810         }
 811         if (*p != ',') {
 812             break;
 813         }
 814     }
 815     return 0;
 816 }
 817
 818 int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname)
 819 {
 820     return opts_do_parse(opts, params, firstname, false);
 821 }
 822
 823 static QemuOpts *opts_parse(QemuOptsList *list, const char *params,
 824                             int permit_abbrev, bool defaults)
 825 {
 826     const char *firstname;
 827     char value[1024], *id = NULL;
 828     const char *p;
 829     QemuOpts *opts;
 830     Error *local_err = NULL;
 831
 832     assert(!permit_abbrev || list->implied_opt_name);
 833     firstname = permit_abbrev ? list->implied_opt_name : NULL;
 834
 835     if (strncmp(params, "id=", 3) == 0) {
 836         get_opt_value(value, sizeof(value), params+3);
 837         id = value;
 838     } else if ((p = strstr(params, ",id=")) != NULL) {
 839         get_opt_value(value, sizeof(value), p+4);
 840         id = value;
 841     }
 842
 843     /*
 844      * This code doesn't work for defaults && !list->merge_lists: when
 845      * params has no id=, and list has an element with !opts->id, it
 846      * appends a new element instead of returning the existing opts.
 847      * However, we got no use for this case.  Guard against possible
 848      * (if unlikely) future misuse:
 849      */
 850     assert(!defaults || list->merge_lists);
 851     opts = qemu_opts_create(list, id, !defaults, &local_err);
 852     if (opts == NULL) {
 853         if (local_err) {
 854             qerror_report_err(local_err);
 855             error_free(local_err);
 856         }
 857         return NULL;
 858     }
 859
 860     if (opts_do_parse(opts, params, firstname, defaults) != 0) {
 861         qemu_opts_del(opts);
 862         return NULL;
 863     }
 864
 865     return opts;
 866 }
 867
 868 QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
 869                           int permit_abbrev)
 870 {
 871     return opts_parse(list, params, permit_abbrev, false);
 872 }
 873
 874 void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
 875                             int permit_abbrev)
 876 {
 877     QemuOpts *opts;
 878
 879     opts = opts_parse(list, params, permit_abbrev, true);
 880     assert(opts);
 881 }
 882
 883 typedef struct OptsFromQDictState {
 884     QemuOpts *opts;
 885     Error **errp;
 886 } OptsFromQDictState;
 887
 888 static void qemu_opts_from_qdict_1(const char *key, QObject *obj, void *opaque)
 889 {
 890     OptsFromQDictState *state = opaque;
 891     char buf[32];
 892     const char *value;
 893     int n;
 894
 895     if (!strcmp(key, "id") || *state->errp) {
 896         return;
 897     }
 898
 899     switch (qobject_type(obj)) {
 900     case QTYPE_QSTRING:
 901         value = qstring_get_str(qobject_to_qstring(obj));
 902         break;
 903     case QTYPE_QINT:
 904         n = snprintf(buf, sizeof(buf), "%" PRId64,
 905                      qint_get_int(qobject_to_qint(obj)));
 906         assert(n < sizeof(buf));
 907         value = buf;
 908         break;
 909     case QTYPE_QFLOAT:
 910         n = snprintf(buf, sizeof(buf), "%.17g",
 911                      qfloat_get_double(qobject_to_qfloat(obj)));
 912         assert(n < sizeof(buf));
 913         value = buf;
 914         break;
 915     case QTYPE_QBOOL:
 916         pstrcpy(buf, sizeof(buf),
 917                 qbool_get_int(qobject_to_qbool(obj)) ? "on" : "off");
 918         value = buf;
 919         break;
 920     default:
 921         return;
 922     }
 923
 924     qemu_opt_set_err(state->opts, key, value, state->errp);
 925 }
 926
 927 /*
 928  * Create QemuOpts from a QDict.
 929  * Use value of key "id" as ID if it exists and is a QString.
 930  * Only QStrings, QInts, QFloats and QBools are copied.  Entries with
 931  * other types are silently ignored.
 932  */
 933 QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
 934                                Error **errp)
 935 {
 936     OptsFromQDictState state;
 937     Error *local_err = NULL;
 938     QemuOpts *opts;
 939
 940     opts = qemu_opts_create(list, qdict_get_try_str(qdict, "id"), 1,
 941                             &local_err);
 942     if (local_err) {
 943         error_propagate(errp, local_err);
 944         return NULL;
 945     }
 946
 947     assert(opts != NULL);
 948
 949     state.errp = &local_err;
 950     state.opts = opts;
 951     qdict_iter(qdict, qemu_opts_from_qdict_1, &state);
 952     if (local_err) {
 953         error_propagate(errp, local_err);
 954         qemu_opts_del(opts);
 955         return NULL;
 956     }
 957
 958     return opts;
 959 }
 960
 961 /*
 962  * Adds all QDict entries to the QemuOpts that can be added and removes them
 963  * from the QDict. When this function returns, the QDict contains only those
 964  * entries that couldn't be added to the QemuOpts.
 965  */
 966 void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp)
 967 {
 968     const QDictEntry *entry, *next;
 969
 970     entry = qdict_first(qdict);
 971
 972     while (entry != NULL) {
 973         Error *local_err = NULL;
 974         OptsFromQDictState state = {
 975             .errp = &local_err,
 976             .opts = opts,
 977         };
 978
 979         next = qdict_next(qdict, entry);
 980
 981         if (find_desc_by_name(opts->list->desc, entry->key)) {
 982             qemu_opts_from_qdict_1(entry->key, entry->value, &state);
 983             if (local_err) {
 984                 error_propagate(errp, local_err);
 985                 return;
 986             } else {
 987                 qdict_del(qdict, entry->key);
 988             }
 989         }
 990
 991         entry = next;
 992     }
 993 }
 994
 995 /*
 996  * Convert from QemuOpts to QDict.
 997  * The QDict values are of type QString.
 998  * TODO We'll want to use types appropriate for opt->desc->type, but
 999  * this is enough for now.
1000  */
1001 QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict)
1002 {
1003     QemuOpt *opt;
1004     QObject *val;
1005
1006     if (!qdict) {
1007         qdict = qdict_new();
1008     }
1009     if (opts->id) {
1010         qdict_put(qdict, "id", qstring_from_str(opts->id));
1011     }
1012     QTAILQ_FOREACH(opt, &opts->head, next) {
1013         val = QOBJECT(qstring_from_str(opt->str));
1014         qdict_put_obj(qdict, opt->name, val);
1015     }
1016     return qdict;
1017 }
1018
1019 /* Validate parsed opts against descriptions where no
1020  * descriptions were provided in the QemuOptsList.
1021  */
1022 void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
1023 {
1024     QemuOpt *opt;
1025     Error *local_err = NULL;
1026
1027     assert(opts_accepts_any(opts));
1028
1029     QTAILQ_FOREACH(opt, &opts->head, next) {
1030         opt->desc = find_desc_by_name(desc, opt->name);
1031         if (!opt->desc) {
1032             error_set(errp, QERR_INVALID_PARAMETER, opt->name);
1033             return;
1034         }
1035
1036         qemu_opt_parse(opt, &local_err);
1037         if (local_err) {
1038             error_propagate(errp, local_err);
1039             return;
1040         }
1041     }
1042 }
1043
1044 int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque,
1045                       int abort_on_failure)
1046 {
1047     Location loc;
1048     QemuOpts *opts;
1049     int rc = 0;
1050
1051     loc_push_none(&loc);
1052     QTAILQ_FOREACH(opts, &list->head, next) {
1053         loc_restore(&opts->loc);
1054         rc |= func(opts, opaque);
1055         if (abort_on_failure  &&  rc != 0)
1056             break;
1057     }
1058     loc_pop(&loc);
1059     return rc;
1060 }
1061
1062 static size_t count_opts_list(QemuOptsList *list)
1063 {
1064     QemuOptDesc *desc = NULL;
1065     size_t num_opts = 0;
1066
1067     if (!list) {
1068         return 0;
1069     }
1070
1071     desc = list->desc;
1072     while (desc && desc->name) {
1073         num_opts++;
1074         desc++;
1075     }
1076
1077     return num_opts;
1078 }
1079
1080 void qemu_opts_free(QemuOptsList *list)
1081 {
1082     g_free(list);
1083 }
1084
1085 /* Realloc dst option list and append options from an option list (list)
1086  * to it. dst could be NULL or a malloced list.
1087  * The lifetime of dst must be shorter than the input list because the
1088  * QemuOptDesc->name, ->help, and ->def_value_str strings are shared.
1089  */
1090 QemuOptsList *qemu_opts_append(QemuOptsList *dst,
1091                                QemuOptsList *list)
1092 {
1093     size_t num_opts, num_dst_opts;
1094     QemuOptDesc *desc;
1095     bool need_init = false;
1096     bool need_head_update;
1097
1098     if (!list) {
1099         return dst;
1100     }
1101
1102     /* If dst is NULL, after realloc, some area of dst should be initialized
1103      * before adding options to it.
1104      */
1105     if (!dst) {
1106         need_init = true;
1107         need_head_update = true;
1108     } else {
1109         /* Moreover, even if dst is not NULL, the realloc may move it to a
1110          * different address in which case we may get a stale tail pointer
1111          * in dst->head. */
1112         need_head_update = QTAILQ_EMPTY(&dst->head);
1113     }
1114
1115     num_opts = count_opts_list(dst);
1116     num_dst_opts = num_opts;
1117     num_opts += count_opts_list(list);
1118     dst = g_realloc(dst, sizeof(QemuOptsList) +
1119                     (num_opts + 1) * sizeof(QemuOptDesc));
1120     if (need_init) {
1121         dst->name = NULL;
1122         dst->implied_opt_name = NULL;
1123         dst->merge_lists = false;
1124     }
1125     if (need_head_update) {
1126         QTAILQ_INIT(&dst->head);
1127     }
1128     dst->desc[num_dst_opts].name = NULL;
1129
1130     /* append list->desc to dst->desc */
1131     if (list) {
1132         desc = list->desc;
1133         while (desc && desc->name) {
1134             if (find_desc_by_name(dst->desc, desc->name) == NULL) {
1135                 dst->desc[num_dst_opts++] = *desc;
1136                 dst->desc[num_dst_opts].name = NULL;
1137             }
1138             desc++;
1139         }
1140     }
1141
1142     return dst;
1143 }