qemu-option.c 28.1 KB
Newer Older
K
Kevin Wolf 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Commandline option parsing functions
 *
 * Copyright (c) 2003-2008 Fabrice Bellard
 * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include <stdio.h>
#include <string.h>

#include "qemu-common.h"
30
#include "qemu-error.h"
31
#include "qemu-objects.h"
K
Kevin Wolf 已提交
32
#include "qemu-option.h"
33
#include "error.h"
34
#include "qerror.h"
K
Kevin Wolf 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

/*
 * Extracts the name of an option from the parameter string (p points at the
 * first byte of the option name)
 *
 * The option name is delimited by delim (usually , or =) or the string end
 * and is copied into buf. If the option name is longer than buf_size, it is
 * truncated. buf is always zero terminated.
 *
 * The return value is the position of the delimiter/zero byte after the option
 * name in p.
 */
const char *get_opt_name(char *buf, int buf_size, const char *p, char delim)
{
    char *q;

    q = buf;
    while (*p != '\0' && *p != delim) {
        if (q && (q - buf) < buf_size - 1)
            *q++ = *p;
        p++;
    }
    if (q)
        *q = '\0';

    return p;
}

/*
 * Extracts the value of an option from the parameter string p (p points at the
 * first byte of the option value)
 *
 * This function is comparable to get_opt_name with the difference that the
 * delimiter is fixed to be comma which starts a new option. To specify an
 * option value that contains commas, double each comma.
 */
const char *get_opt_value(char *buf, int buf_size, const char *p)
{
    char *q;

    q = buf;
    while (*p != '\0') {
        if (*p == ',') {
            if (*(p + 1) != ',')
                break;
            p++;
        }
        if (q && (q - buf) < buf_size - 1)
            *q++ = *p;
        p++;
    }
    if (q)
        *q = '\0';

    return p;
}

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
int get_next_param_value(char *buf, int buf_size,
                         const char *tag, const char **pstr)
{
    const char *p;
    char option[128];

    p = *pstr;
    for(;;) {
        p = get_opt_name(option, sizeof(option), p, '=');
        if (*p != '=')
            break;
        p++;
        if (!strcmp(tag, option)) {
            *pstr = get_opt_value(buf, buf_size, p);
            if (**pstr == ',') {
                (*pstr)++;
            }
            return strlen(buf);
        } else {
            p = get_opt_value(NULL, 0, p);
        }
        if (*p != ',')
            break;
        p++;
    }
    return 0;
}

int get_param_value(char *buf, int buf_size,
                    const char *tag, const char *str)
{
    return get_next_param_value(buf, buf_size, tag, &str);
}

int check_params(char *buf, int buf_size,
                 const char * const *params, const char *str)
{
    const char *p;
    int i;

    p = str;
    while (*p != '\0') {
        p = get_opt_name(buf, buf_size, p, '=');
        if (*p != '=') {
            return -1;
        }
        p++;
        for (i = 0; params[i] != NULL; i++) {
            if (!strcmp(params[i], buf)) {
                break;
            }
        }
        if (params[i] == NULL) {
            return -1;
        }
        p = get_opt_value(NULL, 0, p);
        if (*p != ',') {
            break;
        }
        p++;
    }
    return 0;
}

K
Kevin Wolf 已提交
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
/*
 * Searches an option list for an option with the given name
 */
QEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list,
    const char *name)
{
    while (list && list->name) {
        if (!strcmp(list->name, name)) {
            return list;
        }
        list++;
    }

    return NULL;
}

172 173
static void parse_option_bool(const char *name, const char *value, bool *ret,
                              Error **errp)
174 175 176 177 178 179 180
{
    if (value != NULL) {
        if (!strcmp(value, "on")) {
            *ret = 1;
        } else if (!strcmp(value, "off")) {
            *ret = 0;
        } else {
181
            error_set(errp,QERR_INVALID_PARAMETER_VALUE, name, "'on' or 'off'");
182 183 184 185 186 187
        }
    } else {
        *ret = 1;
    }
}

188 189
static void parse_option_number(const char *name, const char *value,
                                uint64_t *ret, Error **errp)
190 191 192 193 194 195 196
{
    char *postfix;
    uint64_t number;

    if (value != NULL) {
        number = strtoull(value, &postfix, 0);
        if (*postfix != '\0') {
197 198
            error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
            return;
199
        }
200
        *ret = number;
201
    } else {
202
        error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a number");
203 204 205
    }
}

206 207
static void parse_option_size(const char *name, const char *value,
                              uint64_t *ret, Error **errp)
208 209 210 211 212 213 214 215 216
{
    char *postfix;
    double sizef;

    if (value != NULL) {
        sizef = strtod(value, &postfix);
        switch (*postfix) {
        case 'T':
            sizef *= 1024;
217
            /* fall through */
218 219
        case 'G':
            sizef *= 1024;
220
            /* fall through */
221 222
        case 'M':
            sizef *= 1024;
223
            /* fall through */
224 225 226
        case 'K':
        case 'k':
            sizef *= 1024;
227
            /* fall through */
228 229 230 231 232
        case 'b':
        case '\0':
            *ret = (uint64_t) sizef;
            break;
        default:
233
            error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
234
            error_printf_unless_qmp("You may use k, M, G or T suffixes for "
235
                    "kilobytes, megabytes, gigabytes and terabytes.\n");
236
            return;
237 238
        }
    } else {
239
        error_set(errp, QERR_INVALID_PARAMETER_VALUE, name, "a size");
240 241 242
    }
}

K
Kevin Wolf 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
/*
 * Sets the value of a parameter in a given option list. The parsing of the
 * value depends on the type of option:
 *
 * OPT_FLAG (uses value.n):
 *      If no value is given, the flag is set to 1.
 *      Otherwise the value must be "on" (set to 1) or "off" (set to 0)
 *
 * OPT_STRING (uses value.s):
 *      value is strdup()ed and assigned as option value
 *
 * OPT_SIZE (uses value.n):
 *      The value is converted to an integer. Suffixes for kilobytes etc. are
 *      allowed (powers of 1024).
 *
 * Returns 0 on succes, -1 in error cases
 */
int set_option_parameter(QEMUOptionParameter *list, const char *name,
    const char *value)
{
263
    bool flag;
264
    Error *local_err = NULL;
265

K
Kevin Wolf 已提交
266 267 268 269 270 271 272 273 274 275
    // Find a matching parameter
    list = get_option_parameter(list, name);
    if (list == NULL) {
        fprintf(stderr, "Unknown option '%s'\n", name);
        return -1;
    }

    // Process parameter
    switch (list->type) {
    case OPT_FLAG:
276 277 278 279
        parse_option_bool(name, value, &flag, &local_err);
        if (!error_is_set(&local_err)) {
            list->value.n = flag;
        }
K
Kevin Wolf 已提交
280 281 282 283
        break;

    case OPT_STRING:
        if (value != NULL) {
284
            list->value.s = g_strdup(value);
K
Kevin Wolf 已提交
285 286 287 288 289 290 291
        } else {
            fprintf(stderr, "Option '%s' needs a parameter\n", name);
            return -1;
        }
        break;

    case OPT_SIZE:
292
        parse_option_size(name, value, &list->value.n, &local_err);
K
Kevin Wolf 已提交
293
        break;
294

K
Kevin Wolf 已提交
295 296 297 298 299
    default:
        fprintf(stderr, "Bug: Option '%s' has an unknown type\n", name);
        return -1;
    }

300 301 302 303 304 305
    if (error_is_set(&local_err)) {
        qerror_report_err(local_err);
        error_free(local_err);
        return -1;
    }

K
Kevin Wolf 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
    return 0;
}

/*
 * Sets the given parameter to an integer instead of a string.
 * This function cannot be used to set string options.
 *
 * Returns 0 on success, -1 in error cases
 */
int set_option_parameter_int(QEMUOptionParameter *list, const char *name,
    uint64_t value)
{
    // Find a matching parameter
    list = get_option_parameter(list, name);
    if (list == NULL) {
        fprintf(stderr, "Unknown option '%s'\n", name);
        return -1;
    }

    // Process parameter
    switch (list->type) {
    case OPT_FLAG:
    case OPT_NUMBER:
    case OPT_SIZE:
        list->value.n = value;
        break;

    default:
        return -1;
    }

    return 0;
}

/*
 * Frees a option list. If it contains strings, the strings are freed as well.
 */
void free_option_parameters(QEMUOptionParameter *list)
{
    QEMUOptionParameter *cur = list;

    while (cur && cur->name) {
        if (cur->type == OPT_STRING) {
349
            g_free(cur->value.s);
K
Kevin Wolf 已提交
350 351 352 353
        }
        cur++;
    }

354
    g_free(list);
K
Kevin Wolf 已提交
355 356
}

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/*
 * Count valid options in list
 */
static size_t count_option_parameters(QEMUOptionParameter *list)
{
    size_t num_options = 0;

    while (list && list->name) {
        num_options++;
        list++;
    }

    return num_options;
}

/*
 * Append an option list (list) to an option list (dest).
 *
 * If dest is NULL, a new copy of list is created.
 *
 * Returns a pointer to the first element of dest (or the newly allocated copy)
 */
QEMUOptionParameter *append_option_parameters(QEMUOptionParameter *dest,
    QEMUOptionParameter *list)
{
    size_t num_options, num_dest_options;

    num_options = count_option_parameters(dest);
    num_dest_options = num_options;

    num_options += count_option_parameters(list);

389
    dest = g_realloc(dest, (num_options + 1) * sizeof(QEMUOptionParameter));
390
    dest[num_dest_options].name = NULL;
391 392 393 394 395 396 397 398 399 400 401 402

    while (list && list->name) {
        if (get_option_parameter(dest, list->name) == NULL) {
            dest[num_dest_options++] = *list;
            dest[num_dest_options].name = NULL;
        }
        list++;
    }

    return dest;
}

K
Kevin Wolf 已提交
403 404 405
/*
 * Parses a parameter string (param) into an option list (dest).
 *
406 407
 * list is the template option list. If dest is NULL, a new copy of list is
 * created. If list is NULL, this function fails.
K
Kevin Wolf 已提交
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
 *
 * A parameter string consists of one or more parameters, separated by commas.
 * Each parameter consists of its name and possibly of a value. In the latter
 * case, the value is delimited by an = character. To specify a value which
 * contains commas, double each comma so it won't be recognized as the end of
 * the parameter.
 *
 * For more details of the parsing see above.
 *
 * Returns a pointer to the first element of dest (or the newly allocated copy)
 * or NULL in error cases
 */
QEMUOptionParameter *parse_option_parameters(const char *param,
    QEMUOptionParameter *list, QEMUOptionParameter *dest)
{
    QEMUOptionParameter *allocated = NULL;
    char name[256];
    char value[256];
    char *param_delim, *value_delim;
    char next_delim;

    if (list == NULL) {
        return NULL;
    }

    if (dest == NULL) {
434
        dest = allocated = append_option_parameters(NULL, list);
K
Kevin Wolf 已提交
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
    }

    while (*param) {

        // Find parameter name and value in the string
        param_delim = strchr(param, ',');
        value_delim = strchr(param, '=');

        if (value_delim && (value_delim < param_delim || !param_delim)) {
            next_delim = '=';
        } else {
            next_delim = ',';
            value_delim = NULL;
        }

        param = get_opt_name(name, sizeof(name), param, next_delim);
        if (value_delim) {
            param = get_opt_value(value, sizeof(value), param + 1);
        }
        if (*param != '\0') {
            param++;
        }

        // Set the parameter
        if (set_option_parameter(dest, name, value_delim ? value : NULL)) {
            goto fail;
        }
    }

    return dest;

fail:
    // Only free the list if it was newly allocated
    free_option_parameters(allocated);
    return NULL;
}

/*
 * Prints all options of a list that have a value to stdout
 */
void print_option_parameters(QEMUOptionParameter *list)
{
    while (list && list->name) {
        switch (list->type) {
            case OPT_STRING:
                 if (list->value.s != NULL) {
                     printf("%s='%s' ", list->name, list->value.s);
                 }
                break;
            case OPT_FLAG:
                printf("%s=%s ", list->name, list->value.n ? "on" : "off");
                break;
            case OPT_SIZE:
            case OPT_NUMBER:
                printf("%s=%" PRId64 " ", list->name, list->value.n);
                break;
            default:
D
Dong Xu Wang 已提交
492
                printf("%s=(unknown type) ", list->name);
K
Kevin Wolf 已提交
493 494 495 496 497
                break;
        }
        list++;
    }
}
498 499 500 501 502 503 504 505 506 507 508 509 510

/*
 * Prints an overview of all available options
 */
void print_option_help(QEMUOptionParameter *list)
{
    printf("Supported options:\n");
    while (list && list->name) {
        printf("%-16s %s\n", list->name,
            list->help ? list->help : "No description available");
        list++;
    }
}
511 512 513 514 515 516 517

/* ------------------------------------------------------------------ */

struct QemuOpt {
    const char   *name;
    const char   *str;

B
Blue Swirl 已提交
518
    const QemuOptDesc *desc;
519
    union {
520
        bool boolean;
521 522 523 524
        uint64_t uint;
    } value;

    QemuOpts     *opts;
B
Blue Swirl 已提交
525
    QTAILQ_ENTRY(QemuOpt) next;
526 527 528
};

struct QemuOpts {
J
Jan Kiszka 已提交
529
    char *id;
530
    QemuOptsList *list;
531
    Location loc;
M
Mark McLoughlin 已提交
532
    QTAILQ_HEAD(QemuOptHead, QemuOpt) head;
B
Blue Swirl 已提交
533
    QTAILQ_ENTRY(QemuOpts) next;
534 535 536 537 538 539
};

static QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name)
{
    QemuOpt *opt;

M
Mark McLoughlin 已提交
540
    QTAILQ_FOREACH_REVERSE(opt, &opts->head, QemuOptHead, next) {
541 542 543 544 545 546 547 548 549 550 551 552 553
        if (strcmp(opt->name, name) != 0)
            continue;
        return opt;
    }
    return NULL;
}

const char *qemu_opt_get(QemuOpts *opts, const char *name)
{
    QemuOpt *opt = qemu_opt_find(opts, name);
    return opt ? opt->str : NULL;
}

554
bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval)
555 556 557 558 559 560
{
    QemuOpt *opt = qemu_opt_find(opts, name);

    if (opt == NULL)
        return defval;
    assert(opt->desc && opt->desc->type == QEMU_OPT_BOOL);
561
    return opt->value.boolean;
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
}

uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval)
{
    QemuOpt *opt = qemu_opt_find(opts, name);

    if (opt == NULL)
        return defval;
    assert(opt->desc && opt->desc->type == QEMU_OPT_NUMBER);
    return opt->value.uint;
}

uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval)
{
    QemuOpt *opt = qemu_opt_find(opts, name);

    if (opt == NULL)
        return defval;
    assert(opt->desc && opt->desc->type == QEMU_OPT_SIZE);
    return opt->value.uint;
}

584
static void qemu_opt_parse(QemuOpt *opt, Error **errp)
585 586
{
    if (opt->desc == NULL)
587
        return;
588

589 590 591
    switch (opt->desc->type) {
    case QEMU_OPT_STRING:
        /* nothing */
592
        return;
593
    case QEMU_OPT_BOOL:
594
        parse_option_bool(opt->name, opt->str, &opt->value.boolean, errp);
595
        break;
596
    case QEMU_OPT_NUMBER:
597
        parse_option_number(opt->name, opt->str, &opt->value.uint, errp);
598
        break;
599
    case QEMU_OPT_SIZE:
600
        parse_option_size(opt->name, opt->str, &opt->value.uint, errp);
601
        break;
602 603 604 605 606 607 608
    default:
        abort();
    }
}

static void qemu_opt_del(QemuOpt *opt)
{
B
Blue Swirl 已提交
609
    QTAILQ_REMOVE(&opt->opts->head, opt, next);
610 611 612
    g_free((/* !const */ char*)opt->name);
    g_free((/* !const */ char*)opt->str);
    g_free(opt);
613 614
}

615 616
static void opt_set(QemuOpts *opts, const char *name, const char *value,
                    bool prepend, Error **errp)
617 618
{
    QemuOpt *opt;
B
Blue Swirl 已提交
619
    const QemuOptDesc *desc = opts->list->desc;
620
    Error *local_err = NULL;
M
Mark McLoughlin 已提交
621
    int i;
622

M
Mark McLoughlin 已提交
623 624 625
    for (i = 0; desc[i].name != NULL; i++) {
        if (strcmp(desc[i].name, name) == 0) {
            break;
626
        }
M
Mark McLoughlin 已提交
627 628 629 630 631
    }
    if (desc[i].name == NULL) {
        if (i == 0) {
            /* empty list -> allow any */;
        } else {
632 633
            error_set(errp, QERR_INVALID_PARAMETER, name);
            return;
634 635
        }
    }
M
Mark McLoughlin 已提交
636

637 638
    opt = g_malloc0(sizeof(*opt));
    opt->name = g_strdup(name);
M
Mark McLoughlin 已提交
639
    opt->opts = opts;
640 641 642 643 644
    if (prepend) {
        QTAILQ_INSERT_HEAD(&opts->head, opt, next);
    } else {
        QTAILQ_INSERT_TAIL(&opts->head, opt, next);
    }
M
Mark McLoughlin 已提交
645 646 647
    if (desc[i].name != NULL) {
        opt->desc = desc+i;
    }
648
    if (value) {
649
        opt->str = g_strdup(value);
650
    }
651 652
    qemu_opt_parse(opt, &local_err);
    if (error_is_set(&local_err)) {
653
        error_propagate(errp, local_err);
654 655 656 657
        qemu_opt_del(opt);
    }
}

658 659
int qemu_opt_set(QemuOpts *opts, const char *name, const char *value)
{
660 661 662 663 664 665 666 667 668 669
    Error *local_err = NULL;

    opt_set(opts, name, value, false, &local_err);
    if (error_is_set(&local_err)) {
        qerror_report_err(local_err);
        error_free(local_err);
        return -1;
    }

    return 0;
670 671
}

672 673 674 675 676 677
void qemu_opt_set_err(QemuOpts *opts, const char *name, const char *value,
                      Error **errp)
{
    opt_set(opts, name, value, false, errp);
}

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
int qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val)
{
    QemuOpt *opt;
    const QemuOptDesc *desc = opts->list->desc;
    int i;

    for (i = 0; desc[i].name != NULL; i++) {
        if (strcmp(desc[i].name, name) == 0) {
            break;
        }
    }
    if (desc[i].name == NULL) {
        if (i == 0) {
            /* empty list -> allow any */;
        } else {
            qerror_report(QERR_INVALID_PARAMETER, name);
            return -1;
        }
    }

    opt = g_malloc0(sizeof(*opt));
    opt->name = g_strdup(name);
    opt->opts = opts;
    QTAILQ_INSERT_TAIL(&opts->head, opt, next);
    if (desc[i].name != NULL) {
        opt->desc = desc+i;
    }
    opt->value.boolean = !!val;
    return 0;
}

G
Gerd Hoffmann 已提交
709 710 711 712 713 714
int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
                     int abort_on_failure)
{
    QemuOpt *opt;
    int rc = 0;

B
Blue Swirl 已提交
715
    QTAILQ_FOREACH(opt, &opts->head, next) {
G
Gerd Hoffmann 已提交
716 717 718 719 720 721 722
        rc = func(opt->name, opt->str, opaque);
        if (abort_on_failure  &&  rc != 0)
            break;
    }
    return rc;
}

723 724 725 726
QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id)
{
    QemuOpts *opts;

B
Blue Swirl 已提交
727
    QTAILQ_FOREACH(opts, &list->head, next) {
728
        if (!opts->id) {
729 730 731
            if (!id) {
                return opts;
            }
732 733 734 735 736 737 738 739 740 741
            continue;
        }
        if (strcmp(opts->id, id) != 0) {
            continue;
        }
        return opts;
    }
    return NULL;
}

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
static int id_wellformed(const char *id)
{
    int i;

    if (!qemu_isalpha(id[0])) {
        return 0;
    }
    for (i = 1; id[i]; i++) {
        if (!qemu_isalnum(id[i]) && !strchr("-._", id[i])) {
            return 0;
        }
    }
    return 1;
}

757 758
QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
                           int fail_if_exists, Error **errp)
759 760 761 762
{
    QemuOpts *opts = NULL;

    if (id) {
763
        if (!id_wellformed(id)) {
764
            error_set(errp,QERR_INVALID_PARAMETER_VALUE, "id", "an identifier");
765 766 767
            error_printf_unless_qmp("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n");
            return NULL;
        }
768 769
        opts = qemu_opts_find(list, id);
        if (opts != NULL) {
770
            if (fail_if_exists && !list->merge_lists) {
771
                error_set(errp, QERR_DUPLICATE_ID, id, list->name);
772 773 774 775 776
                return NULL;
            } else {
                return opts;
            }
        }
777 778 779 780 781
    } else if (list->merge_lists) {
        opts = qemu_opts_find(list, NULL);
        if (opts) {
            return opts;
        }
782
    }
783
    opts = g_malloc0(sizeof(*opts));
784
    if (id) {
785
        opts->id = g_strdup(id);
786 787
    }
    opts->list = list;
788
    loc_save(&opts->loc);
B
Blue Swirl 已提交
789 790
    QTAILQ_INIT(&opts->head);
    QTAILQ_INSERT_TAIL(&list->head, opts, next);
791 792 793
    return opts;
}

794 795 796 797 798 799 800 801 802
void qemu_opts_reset(QemuOptsList *list)
{
    QemuOpts *opts, *next_opts;

    QTAILQ_FOREACH_SAFE(opts, &list->head, next, next_opts) {
        qemu_opts_del(opts);
    }
}

803 804 805 806 807
void qemu_opts_loc_restore(QemuOpts *opts)
{
    loc_restore(&opts->loc);
}

808 809 810 811
int qemu_opts_set(QemuOptsList *list, const char *id,
                  const char *name, const char *value)
{
    QemuOpts *opts;
812
    Error *local_err = NULL;
813

814 815 816 817
    opts = qemu_opts_create(list, id, 1, &local_err);
    if (error_is_set(&local_err)) {
        qerror_report_err(local_err);
        error_free(local_err);
818 819 820 821 822
        return -1;
    }
    return qemu_opt_set(opts, name, value);
}

G
Gerd Hoffmann 已提交
823 824 825 826 827
const char *qemu_opts_id(QemuOpts *opts)
{
    return opts->id;
}

828 829 830 831 832
void qemu_opts_del(QemuOpts *opts)
{
    QemuOpt *opt;

    for (;;) {
B
Blue Swirl 已提交
833
        opt = QTAILQ_FIRST(&opts->head);
834 835 836 837
        if (opt == NULL)
            break;
        qemu_opt_del(opt);
    }
B
Blue Swirl 已提交
838
    QTAILQ_REMOVE(&opts->list->head, opts, next);
839 840
    g_free(opts->id);
    g_free(opts);
841 842 843 844 845 846 847 848
}

int qemu_opts_print(QemuOpts *opts, void *dummy)
{
    QemuOpt *opt;

    fprintf(stderr, "%s: %s:", opts->list->name,
            opts->id ? opts->id : "<noid>");
B
Blue Swirl 已提交
849
    QTAILQ_FOREACH(opt, &opts->head, next) {
850 851 852 853 854 855
        fprintf(stderr, " %s=\"%s\"", opt->name, opt->str);
    }
    fprintf(stderr, "\n");
    return 0;
}

856 857
static int opts_do_parse(QemuOpts *opts, const char *params,
                         const char *firstname, bool prepend)
858
{
859
    char option[128], value[1024];
860
    const char *p,*pe,*pc;
861
    Error *local_err = NULL;
862

863
    for (p = params; *p != '\0'; p++) {
864 865 866 867 868 869 870 871 872 873 874
        pe = strchr(p, '=');
        pc = strchr(p, ',');
        if (!pe || (pc && pc < pe)) {
            /* found "foo,more" */
            if (p == params && firstname) {
                /* implicitly named first option */
                pstrcpy(option, sizeof(option), firstname);
                p = get_opt_value(value, sizeof(value), p);
            } else {
                /* option without value, probably a flag */
                p = get_opt_name(option, sizeof(option), p, ',');
875
                if (strncmp(option, "no", 2) == 0) {
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
                    memmove(option, option+2, strlen(option+2)+1);
                    pstrcpy(value, sizeof(value), "off");
                } else {
                    pstrcpy(value, sizeof(value), "on");
                }
            }
        } else {
            /* found "foo=bar,more" */
            p = get_opt_name(option, sizeof(option), p, '=');
            if (*p != '=') {
                break;
            }
            p++;
            p = get_opt_value(value, sizeof(value), p);
        }
        if (strcmp(option, "id") != 0) {
            /* store and parse */
893 894 895 896
            opt_set(opts, option, value, prepend, &local_err);
            if (error_is_set(&local_err)) {
                qerror_report_err(local_err);
                error_free(local_err);
897
                return -1;
898 899 900 901 902 903
            }
        }
        if (*p != ',') {
            break;
        }
    }
904 905 906
    return 0;
}

907 908 909 910 911 912 913
int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname)
{
    return opts_do_parse(opts, params, firstname, false);
}

static QemuOpts *opts_parse(QemuOptsList *list, const char *params,
                            int permit_abbrev, bool defaults)
914
{
915
    const char *firstname;
916
    char value[1024], *id = NULL;
917 918
    const char *p;
    QemuOpts *opts;
919
    Error *local_err = NULL;
920

921 922 923
    assert(!permit_abbrev || list->implied_opt_name);
    firstname = permit_abbrev ? list->implied_opt_name : NULL;

924 925
    if (strncmp(params, "id=", 3) == 0) {
        get_opt_value(value, sizeof(value), params+3);
J
Jan Kiszka 已提交
926
        id = value;
927 928
    } else if ((p = strstr(params, ",id=")) != NULL) {
        get_opt_value(value, sizeof(value), p+4);
J
Jan Kiszka 已提交
929
        id = value;
930
    }
931 932 933 934
    if (defaults) {
        if (!id && !QTAILQ_EMPTY(&list->head)) {
            opts = qemu_opts_find(list, NULL);
        } else {
935
            opts = qemu_opts_create(list, id, 0, &local_err);
936 937
        }
    } else {
938
        opts = qemu_opts_create(list, id, 1, &local_err);
939
    }
940 941 942 943 944
    if (opts == NULL) {
        if (error_is_set(&local_err)) {
            qerror_report_err(local_err);
            error_free(local_err);
        }
945
        return NULL;
946
    }
947

948
    if (opts_do_parse(opts, params, firstname, defaults) != 0) {
949 950 951 952
        qemu_opts_del(opts);
        return NULL;
    }

953 954 955
    return opts;
}

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
                          int permit_abbrev)
{
    return opts_parse(list, params, permit_abbrev, false);
}

void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
                            int permit_abbrev)
{
    QemuOpts *opts;

    opts = opts_parse(list, params, permit_abbrev, true);
    assert(opts);
}

971 972 973 974 975
typedef struct OptsFromQDictState {
    QemuOpts *opts;
    Error **errp;
} OptsFromQDictState;

976 977
static void qemu_opts_from_qdict_1(const char *key, QObject *obj, void *opaque)
{
978
    OptsFromQDictState *state = opaque;
979 980 981 982
    char buf[32];
    const char *value;
    int n;

983
    if (!strcmp(key, "id") || error_is_set(state->errp)) {
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
        return;
    }

    switch (qobject_type(obj)) {
    case QTYPE_QSTRING:
        value = qstring_get_str(qobject_to_qstring(obj));
        break;
    case QTYPE_QINT:
        n = snprintf(buf, sizeof(buf), "%" PRId64,
                     qint_get_int(qobject_to_qint(obj)));
        assert(n < sizeof(buf));
        value = buf;
        break;
    case QTYPE_QFLOAT:
        n = snprintf(buf, sizeof(buf), "%.17g",
                     qfloat_get_double(qobject_to_qfloat(obj)));
        assert(n < sizeof(buf));
        value = buf;
        break;
    case QTYPE_QBOOL:
B
Blue Swirl 已提交
1004 1005
        pstrcpy(buf, sizeof(buf),
                qbool_get_int(qobject_to_qbool(obj)) ? "on" : "off");
1006 1007 1008 1009 1010
        value = buf;
        break;
    default:
        return;
    }
1011 1012

    qemu_opt_set_err(state->opts, key, value, state->errp);
1013 1014 1015 1016 1017 1018 1019 1020
}

/*
 * Create QemuOpts from a QDict.
 * Use value of key "id" as ID if it exists and is a QString.
 * Only QStrings, QInts, QFloats and QBools are copied.  Entries with
 * other types are silently ignored.
 */
1021 1022
QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
                               Error **errp)
1023
{
1024
    OptsFromQDictState state;
1025
    Error *local_err = NULL;
1026
    QemuOpts *opts;
1027

1028 1029 1030
    opts = qemu_opts_create(list, qdict_get_try_str(qdict, "id"), 1,
                            &local_err);
    if (error_is_set(&local_err)) {
1031
        error_propagate(errp, local_err);
1032
        return NULL;
1033
    }
1034

1035
    assert(opts != NULL);
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

    state.errp = &local_err;
    state.opts = opts;
    qdict_iter(qdict, qemu_opts_from_qdict_1, &state);
    if (error_is_set(&local_err)) {
        error_propagate(errp, local_err);
        qemu_opts_del(opts);
        return NULL;
    }

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    return opts;
}

/*
 * Convert from QemuOpts to QDict.
 * The QDict values are of type QString.
 * TODO We'll want to use types appropriate for opt->desc->type, but
 * this is enough for now.
 */
QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict)
{
    QemuOpt *opt;
    QObject *val;

    if (!qdict) {
        qdict = qdict_new();
    }
    if (opts->id) {
        qdict_put(qdict, "id", qstring_from_str(opts->id));
    }
    QTAILQ_FOREACH(opt, &opts->head, next) {
        val = QOBJECT(qstring_from_str(opt->str));
        qdict_put_obj(qdict, opt->name, val);
    }
    return qdict;
}

1073 1074 1075
/* Validate parsed opts against descriptions where no
 * descriptions were provided in the QemuOptsList.
 */
1076
void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
1077 1078
{
    QemuOpt *opt;
1079
    Error *local_err = NULL;
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091

    assert(opts->list->desc[0].name == NULL);

    QTAILQ_FOREACH(opt, &opts->head, next) {
        int i;

        for (i = 0; desc[i].name != NULL; i++) {
            if (strcmp(desc[i].name, opt->name) == 0) {
                break;
            }
        }
        if (desc[i].name == NULL) {
1092 1093
            error_set(errp, QERR_INVALID_PARAMETER, opt->name);
            return;
1094 1095 1096 1097
        }

        opt->desc = &desc[i];

1098 1099
        qemu_opt_parse(opt, &local_err);
        if (error_is_set(&local_err)) {
1100 1101
            error_propagate(errp, local_err);
            return;
1102 1103 1104 1105
        }
    }
}

1106 1107 1108
int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque,
                      int abort_on_failure)
{
1109
    Location loc;
1110 1111 1112
    QemuOpts *opts;
    int rc = 0;

1113
    loc_push_none(&loc);
B
Blue Swirl 已提交
1114
    QTAILQ_FOREACH(opts, &list->head, next) {
1115
        loc_restore(&opts->loc);
1116
        rc |= func(opts, opaque);
1117 1118 1119
        if (abort_on_failure  &&  rc != 0)
            break;
    }
1120
    loc_pop(&loc);
1121 1122
    return rc;
}