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 void qemu_opt_set(QemuOpts *opts, const char *name, const char *value,
 552                   Error **errp)
 553 {
 554     opt_set(opts, name, value, false, errp);
 555 }
 556
 557 void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
 558                        Error **errp)
 559 {
 560     QemuOpt *opt;
 561     const QemuOptDesc *desc = opts->list->desc;
 562
 563     opt = g_malloc0(sizeof(*opt));
 564     opt->desc = find_desc_by_name(desc, name);
 565     if (!opt->desc && !opts_accepts_any(opts)) {
 566         error_set(errp, QERR_INVALID_PARAMETER, name);
 567         g_free(opt);
 568         return;
 569     }
 570
 571     opt->name = g_strdup(name);
 572     opt->opts = opts;
 573     opt->value.boolean = !!val;
 574     opt->str = g_strdup(val ? "on" : "off");
 575     QTAILQ_INSERT_TAIL(&opts->head, opt, next);
 576 }
 577
 578 void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
 579                          Error **errp)
 580 {
 581     QemuOpt *opt;
 582     const QemuOptDesc *desc = opts->list->desc;
 583
 584     opt = g_malloc0(sizeof(*opt));
 585     opt->desc = find_desc_by_name(desc, name);
 586     if (!opt->desc && !opts_accepts_any(opts)) {
 587         error_set(errp, QERR_INVALID_PARAMETER, name);
 588         g_free(opt);
 589         return;
 590     }
 591
 592     opt->name = g_strdup(name);
 593     opt->opts = opts;
 594     opt->value.uint = val;
 595     opt->str = g_strdup_printf("%" PRId64, val);
 596     QTAILQ_INSERT_TAIL(&opts->head, opt, next);
 597 }
 598
 599 int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
 600                      int abort_on_failure)
 601 {
 602     QemuOpt *opt;
 603     int rc = 0;
 604
 605     QTAILQ_FOREACH(opt, &opts->head, next) {
 606         rc = func(opt->name, opt->str, opaque);
 607         if (abort_on_failure  &&  rc != 0)
 608             break;
 609     }
 610     return rc;
 611 }
 612
 613 QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id)
 614 {
 615     QemuOpts *opts;
 616
 617     QTAILQ_FOREACH(opts, &list->head, next) {
 618         if (!opts->id && !id) {
 619             return opts;
 620         }
 621         if (opts->id && id && !strcmp(opts->id, id)) {
 622             return opts;
 623         }
 624     }
 625     return NULL;
 626 }
 627
 628 QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
 629                            int fail_if_exists, Error **errp)
 630 {
 631     QemuOpts *opts = NULL;
 632
 633     if (id) {
 634         if (!id_wellformed(id)) {
 635             error_set(errp,QERR_INVALID_PARAMETER_VALUE, "id", "an identifier");
 636 #if 0 /* conversion from qerror_report() to error_set() broke this: */
 637             error_printf_unless_qmp("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n");
 638 #endif
 639             return NULL;
 640         }
 641         opts = qemu_opts_find(list, id);
 642         if (opts != NULL) {
 643             if (fail_if_exists && !list->merge_lists) {
 644                 error_setg(errp, "Duplicate ID '%s' for %s", id, list->name);
 645                 return NULL;
 646             } else {
 647                 return opts;
 648             }
 649         }
 650     } else if (list->merge_lists) {
 651         opts = qemu_opts_find(list, NULL);
 652         if (opts) {
 653             return opts;
 654         }
 655     }
 656     opts = g_malloc0(sizeof(*opts));
 657     opts->id = g_strdup(id);
 658     opts->list = list;
 659     loc_save(&opts->loc);
 660     QTAILQ_INIT(&opts->head);
 661     QTAILQ_INSERT_TAIL(&list->head, opts, next);
 662     return opts;
 663 }
 664
 665 void qemu_opts_reset(QemuOptsList *list)
 666 {
 667     QemuOpts *opts, *next_opts;
 668
 669     QTAILQ_FOREACH_SAFE(opts, &list->head, next, next_opts) {
 670         qemu_opts_del(opts);
 671     }
 672 }
 673
 674 void qemu_opts_loc_restore(QemuOpts *opts)
 675 {
 676     loc_restore(&opts->loc);
 677 }
 678
 679 void qemu_opts_set(QemuOptsList *list, const char *id,
 680                    const char *name, const char *value, Error **errp)
 681 {
 682     QemuOpts *opts;
 683     Error *local_err = NULL;
 684
 685     opts = qemu_opts_create(list, id, 1, &local_err);
 686     if (local_err) {
 687         error_propagate(errp, local_err);
 688         return;
 689     }
 690     qemu_opt_set(opts, name, value, errp);
 691 }
 692
 693 const char *qemu_opts_id(QemuOpts *opts)
 694 {
 695     return opts->id;
 696 }
 697
 698 /* The id string will be g_free()d by qemu_opts_del */
 699 void qemu_opts_set_id(QemuOpts *opts, char *id)
 700 {
 701     opts->id = id;
 702 }
 703
 704 void qemu_opts_del(QemuOpts *opts)
 705 {
 706     QemuOpt *opt;
 707
 708     if (opts == NULL) {
 709         return;
 710     }
 711
 712     for (;;) {
 713         opt = QTAILQ_FIRST(&opts->head);
 714         if (opt == NULL)
 715             break;
 716         qemu_opt_del(opt);
 717     }
 718     QTAILQ_REMOVE(&opts->list->head, opts, next);
 719     g_free(opts->id);
 720     g_free(opts);
 721 }
 722
 723 void qemu_opts_print(QemuOpts *opts, const char *sep)
 724 {
 725     QemuOpt *opt;
 726     QemuOptDesc *desc = opts->list->desc;
 727
 728     if (desc[0].name == NULL) {
 729         QTAILQ_FOREACH(opt, &opts->head, next) {
 730             printf("%s%s=\"%s\"", sep, opt->name, opt->str);
 731         }
 732         return;
 733     }
 734     for (; desc && desc->name; desc++) {
 735         const char *value;
 736         QemuOpt *opt = qemu_opt_find(opts, desc->name);
 737
 738         value = opt ? opt->str : desc->def_value_str;
 739         if (!value) {
 740             continue;
 741         }
 742         if (desc->type == QEMU_OPT_STRING) {
 743             printf("%s%s='%s'", sep, desc->name, value);
 744         } else if ((desc->type == QEMU_OPT_SIZE ||
 745                     desc->type == QEMU_OPT_NUMBER) && opt) {
 746             printf("%s%s=%" PRId64, sep, desc->name, opt->value.uint);
 747         } else {
 748             printf("%s%s=%s", sep, desc->name, value);
 749         }
 750     }
 751 }
 752
 753 static void opts_do_parse(QemuOpts *opts, const char *params,
 754                           const char *firstname, bool prepend, Error **errp)
 755 {
 756     char option[128], value[1024];
 757     const char *p,*pe,*pc;
 758     Error *local_err = NULL;
 759
 760     for (p = params; *p != '\0'; p++) {
 761         pe = strchr(p, '=');
 762         pc = strchr(p, ',');
 763         if (!pe || (pc && pc < pe)) {
 764             /* found "foo,more" */
 765             if (p == params && firstname) {
 766                 /* implicitly named first option */
 767                 pstrcpy(option, sizeof(option), firstname);
 768                 p = get_opt_value(value, sizeof(value), p);
 769             } else {
 770                 /* option without value, probably a flag */
 771                 p = get_opt_name(option, sizeof(option), p, ',');
 772                 if (strncmp(option, "no", 2) == 0) {
 773                     memmove(option, option+2, strlen(option+2)+1);
 774                     pstrcpy(value, sizeof(value), "off");
 775                 } else {
 776                     pstrcpy(value, sizeof(value), "on");
 777                 }
 778             }
 779         } else {
 780             /* found "foo=bar,more" */
 781             p = get_opt_name(option, sizeof(option), p, '=');
 782             if (*p != '=') {
 783                 break;
 784             }
 785             p++;
 786             p = get_opt_value(value, sizeof(value), p);
 787         }
 788         if (strcmp(option, "id") != 0) {
 789             /* store and parse */
 790             opt_set(opts, option, value, prepend, &local_err);
 791             if (local_err) {
 792                 error_propagate(errp, local_err);
 793                 return;
 794             }
 795         }
 796         if (*p != ',') {
 797             break;
 798         }
 799     }
 800 }
 801
 802 /**
 803  * Store options parsed from @params into @opts.
 804  * If @firstname is non-null, the first key=value in @params may omit
 805  * key=, and is treated as if key was @firstname.
 806  * On error, store an error object through @errp if non-null.
 807  */
 808 void qemu_opts_do_parse(QemuOpts *opts, const char *params,
 809                        const char *firstname, Error **errp)
 810 {
 811     opts_do_parse(opts, params, firstname, false, errp);
 812 }
 813
 814 static QemuOpts *opts_parse(QemuOptsList *list, const char *params,
 815                             int permit_abbrev, bool defaults, Error **errp)
 816 {
 817     const char *firstname;
 818     char value[1024], *id = NULL;
 819     const char *p;
 820     QemuOpts *opts;
 821     Error *local_err = NULL;
 822
 823     assert(!permit_abbrev || list->implied_opt_name);
 824     firstname = permit_abbrev ? list->implied_opt_name : NULL;
 825
 826     if (strncmp(params, "id=", 3) == 0) {
 827         get_opt_value(value, sizeof(value), params+3);
 828         id = value;
 829     } else if ((p = strstr(params, ",id=")) != NULL) {
 830         get_opt_value(value, sizeof(value), p+4);
 831         id = value;
 832     }
 833
 834     /*
 835      * This code doesn't work for defaults && !list->merge_lists: when
 836      * params has no id=, and list has an element with !opts->id, it
 837      * appends a new element instead of returning the existing opts.
 838      * However, we got no use for this case.  Guard against possible
 839      * (if unlikely) future misuse:
 840      */
 841     assert(!defaults || list->merge_lists);
 842     opts = qemu_opts_create(list, id, !defaults, &local_err);
 843     if (opts == NULL) {
 844         error_propagate(errp, local_err);
 845         return NULL;
 846     }
 847
 848     opts_do_parse(opts, params, firstname, defaults, &local_err);
 849     if (local_err) {
 850         error_propagate(errp, local_err);
 851         qemu_opts_del(opts);
 852         return NULL;
 853     }
 854
 855     return opts;
 856 }
 857
 858 /**
 859  * Create a QemuOpts in @list and with options parsed from @params.
 860  * If @permit_abbrev, the first key=value in @params may omit key=,
 861  * and is treated as if key was @list->implied_opt_name.
 862  * Report errors with qerror_report_err().
 863  * Return the new QemuOpts on success, null pointer on error.
 864  */
 865 QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
 866                           int permit_abbrev)
 867 {
 868     Error *err = NULL;
 869     QemuOpts *opts;
 870
 871     opts = opts_parse(list, params, permit_abbrev, false, &err);
 872     if (!opts) {
 873         qerror_report_err(err);
 874         error_free(err);
 875     }
 876     return opts;
 877 }
 878
 879 void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
 880                             int permit_abbrev)
 881 {
 882     QemuOpts *opts;
 883
 884     opts = opts_parse(list, params, permit_abbrev, true, NULL);
 885     assert(opts);
 886 }
 887
 888 typedef struct OptsFromQDictState {
 889     QemuOpts *opts;
 890     Error **errp;
 891 } OptsFromQDictState;
 892
 893 static void qemu_opts_from_qdict_1(const char *key, QObject *obj, void *opaque)
 894 {
 895     OptsFromQDictState *state = opaque;
 896     char buf[32];
 897     const char *value;
 898     int n;
 899
 900     if (!strcmp(key, "id") || *state->errp) {
 901         return;
 902     }
 903
 904     switch (qobject_type(obj)) {
 905     case QTYPE_QSTRING:
 906         value = qstring_get_str(qobject_to_qstring(obj));
 907         break;
 908     case QTYPE_QINT:
 909         n = snprintf(buf, sizeof(buf), "%" PRId64,
 910                      qint_get_int(qobject_to_qint(obj)));
 911         assert(n < sizeof(buf));
 912         value = buf;
 913         break;
 914     case QTYPE_QFLOAT:
 915         n = snprintf(buf, sizeof(buf), "%.17g",
 916                      qfloat_get_double(qobject_to_qfloat(obj)));
 917         assert(n < sizeof(buf));
 918         value = buf;
 919         break;
 920     case QTYPE_QBOOL:
 921         pstrcpy(buf, sizeof(buf),
 922                 qbool_get_int(qobject_to_qbool(obj)) ? "on" : "off");
 923         value = buf;
 924         break;
 925     default:
 926         return;
 927     }
 928
 929     qemu_opt_set(state->opts, key, value, state->errp);
 930 }
 931
 932 /*
 933  * Create QemuOpts from a QDict.
 934  * Use value of key "id" as ID if it exists and is a QString.
 935  * Only QStrings, QInts, QFloats and QBools are copied.  Entries with
 936  * other types are silently ignored.
 937  */
 938 QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
 939                                Error **errp)
 940 {
 941     OptsFromQDictState state;
 942     Error *local_err = NULL;
 943     QemuOpts *opts;
 944
 945     opts = qemu_opts_create(list, qdict_get_try_str(qdict, "id"), 1,
 946                             &local_err);
 947     if (local_err) {
 948         error_propagate(errp, local_err);
 949         return NULL;
 950     }
 951
 952     assert(opts != NULL);
 953
 954     state.errp = &local_err;
 955     state.opts = opts;
 956     qdict_iter(qdict, qemu_opts_from_qdict_1, &state);
 957     if (local_err) {
 958         error_propagate(errp, local_err);
 959         qemu_opts_del(opts);
 960         return NULL;
 961     }
 962
 963     return opts;
 964 }
 965
 966 /*
 967  * Adds all QDict entries to the QemuOpts that can be added and removes them
 968  * from the QDict. When this function returns, the QDict contains only those
 969  * entries that couldn't be added to the QemuOpts.
 970  */
 971 void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp)
 972 {
 973     const QDictEntry *entry, *next;
 974
 975     entry = qdict_first(qdict);
 976
 977     while (entry != NULL) {
 978         Error *local_err = NULL;
 979         OptsFromQDictState state = {
 980             .errp = &local_err,
 981             .opts = opts,
 982         };
 983
 984         next = qdict_next(qdict, entry);
 985
 986         if (find_desc_by_name(opts->list->desc, entry->key)) {
 987             qemu_opts_from_qdict_1(entry->key, entry->value, &state);
 988             if (local_err) {
 989                 error_propagate(errp, local_err);
 990                 return;
 991             } else {
 992                 qdict_del(qdict, entry->key);
 993             }
 994         }
 995
 996         entry = next;
 997     }
 998 }
 999
1000 /*
1001  * Convert from QemuOpts to QDict.
1002  * The QDict values are of type QString.
1003  * TODO We'll want to use types appropriate for opt->desc->type, but
1004  * this is enough for now.
1005  */
1006 QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict)
1007 {
1008     QemuOpt *opt;
1009     QObject *val;
1010
1011     if (!qdict) {
1012         qdict = qdict_new();
1013     }
1014     if (opts->id) {
1015         qdict_put(qdict, "id", qstring_from_str(opts->id));
1016     }
1017     QTAILQ_FOREACH(opt, &opts->head, next) {
1018         val = QOBJECT(qstring_from_str(opt->str));
1019         qdict_put_obj(qdict, opt->name, val);
1020     }
1021     return qdict;
1022 }
1023
1024 /* Validate parsed opts against descriptions where no
1025  * descriptions were provided in the QemuOptsList.
1026  */
1027 void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
1028 {
1029     QemuOpt *opt;
1030     Error *local_err = NULL;
1031
1032     assert(opts_accepts_any(opts));
1033
1034     QTAILQ_FOREACH(opt, &opts->head, next) {
1035         opt->desc = find_desc_by_name(desc, opt->name);
1036         if (!opt->desc) {
1037             error_set(errp, QERR_INVALID_PARAMETER, opt->name);
1038             return;
1039         }
1040
1041         qemu_opt_parse(opt, &local_err);
1042         if (local_err) {
1043             error_propagate(errp, local_err);
1044             return;
1045         }
1046     }
1047 }
1048
1049 int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque,
1050                       int abort_on_failure)
1051 {
1052     Location loc;
1053     QemuOpts *opts;
1054     int rc = 0;
1055
1056     loc_push_none(&loc);
1057     QTAILQ_FOREACH(opts, &list->head, next) {
1058         loc_restore(&opts->loc);
1059         rc |= func(opts, opaque);
1060         if (abort_on_failure  &&  rc != 0)
1061             break;
1062     }
1063     loc_pop(&loc);
1064     return rc;
1065 }
1066
1067 static size_t count_opts_list(QemuOptsList *list)
1068 {
1069     QemuOptDesc *desc = NULL;
1070     size_t num_opts = 0;
1071
1072     if (!list) {
1073         return 0;
1074     }
1075
1076     desc = list->desc;
1077     while (desc && desc->name) {
1078         num_opts++;
1079         desc++;
1080     }
1081
1082     return num_opts;
1083 }
1084
1085 void qemu_opts_free(QemuOptsList *list)
1086 {
1087     g_free(list);
1088 }
1089
1090 /* Realloc dst option list and append options from an option list (list)
1091  * to it. dst could be NULL or a malloced list.
1092  * The lifetime of dst must be shorter than the input list because the
1093  * QemuOptDesc->name, ->help, and ->def_value_str strings are shared.
1094  */
1095 QemuOptsList *qemu_opts_append(QemuOptsList *dst,
1096                                QemuOptsList *list)
1097 {
1098     size_t num_opts, num_dst_opts;
1099     QemuOptDesc *desc;
1100     bool need_init = false;
1101     bool need_head_update;
1102
1103     if (!list) {
1104         return dst;
1105     }
1106
1107     /* If dst is NULL, after realloc, some area of dst should be initialized
1108      * before adding options to it.
1109      */
1110     if (!dst) {
1111         need_init = true;
1112         need_head_update = true;
1113     } else {
1114         /* Moreover, even if dst is not NULL, the realloc may move it to a
1115          * different address in which case we may get a stale tail pointer
1116          * in dst->head. */
1117         need_head_update = QTAILQ_EMPTY(&dst->head);
1118     }
1119
1120     num_opts = count_opts_list(dst);
1121     num_dst_opts = num_opts;
1122     num_opts += count_opts_list(list);
1123     dst = g_realloc(dst, sizeof(QemuOptsList) +
1124                     (num_opts + 1) * sizeof(QemuOptDesc));
1125     if (need_init) {
1126         dst->name = NULL;
1127         dst->implied_opt_name = NULL;
1128         dst->merge_lists = false;
1129     }
1130     if (need_head_update) {
1131         QTAILQ_INIT(&dst->head);
1132     }
1133     dst->desc[num_dst_opts].name = NULL;
1134
1135     /* append list->desc to dst->desc */
1136     if (list) {
1137         desc = list->desc;
1138         while (desc && desc->name) {
1139             if (find_desc_by_name(dst->desc, desc->name) == NULL) {
1140                 dst->desc[num_dst_opts++] = *desc;
1141                 dst->desc[num_dst_opts].name = NULL;
1142             }
1143             desc++;
1144         }
1145     }
1146
1147     return dst;
1148 }