util/qemu-config.c

   1 #include "qemu/osdep.h"
   2 #include "block/qdict.h" /* for qdict_extract_subqdict() */
   3 #include "qapi/error.h"
   4 #include "qapi/qapi-commands-misc.h"
   5 #include "qapi/qmp/qerror.h"
   6 #include "qapi/qmp/qdict.h"
   7 #include "qapi/qmp/qlist.h"
   8 #include "qemu/error-report.h"
   9 #include "qemu/option.h"
  10 #include "qemu/config-file.h"
  11
  12 static QemuOptsList *vm_config_groups[48];
  13 static QemuOptsList *drive_config_groups[5];
  14
  15 static QemuOptsList *find_list(QemuOptsList **lists, const char *group,
  16                                Error **errp)
  17 {
  18     int i;
  19
  20     qemu_load_module_for_opts(group);
  21     for (i = 0; lists[i] != NULL; i++) {
  22         if (strcmp(lists[i]->name, group) == 0)
  23             break;
  24     }
  25     if (lists[i] == NULL) {
  26         error_setg(errp, "There is no option group '%s'", group);
  27     }
  28     return lists[i];
  29 }
  30
  31 QemuOptsList *qemu_find_opts(const char *group)
  32 {
  33     QemuOptsList *ret;
  34     Error *local_err = NULL;
  35
  36     ret = find_list(vm_config_groups, group, &local_err);
  37     if (local_err) {
  38         error_report_err(local_err);
  39     }
  40
  41     return ret;
  42 }
  43
  44 QemuOpts *qemu_find_opts_singleton(const char *group)
  45 {
  46     QemuOptsList *list;
  47     QemuOpts *opts;
  48
  49     list = qemu_find_opts(group);
  50     assert(list);
  51     opts = qemu_opts_find(list, NULL);
  52     if (!opts) {
  53         opts = qemu_opts_create(list, NULL, 0, &error_abort);
  54     }
  55     return opts;
  56 }
  57
  58 static CommandLineParameterInfoList *query_option_descs(const QemuOptDesc *desc)
  59 {
  60     CommandLineParameterInfoList *param_list = NULL;
  61     CommandLineParameterInfo *info;
  62     int i;
  63
  64     for (i = 0; desc[i].name != NULL; i++) {
  65         info = g_malloc0(sizeof(*info));
  66         info->name = g_strdup(desc[i].name);
  67
  68         switch (desc[i].type) {
  69         case QEMU_OPT_STRING:
  70             info->type = COMMAND_LINE_PARAMETER_TYPE_STRING;
  71             break;
  72         case QEMU_OPT_BOOL:
  73             info->type = COMMAND_LINE_PARAMETER_TYPE_BOOLEAN;
  74             break;
  75         case QEMU_OPT_NUMBER:
  76             info->type = COMMAND_LINE_PARAMETER_TYPE_NUMBER;
  77             break;
  78         case QEMU_OPT_SIZE:
  79             info->type = COMMAND_LINE_PARAMETER_TYPE_SIZE;
  80             break;
  81         }
  82
  83         if (desc[i].help) {
  84             info->has_help = true;
  85             info->help = g_strdup(desc[i].help);
  86         }
  87         if (desc[i].def_value_str) {
  88             info->has_q_default = true;
  89             info->q_default = g_strdup(desc[i].def_value_str);
  90         }
  91
  92         QAPI_LIST_PREPEND(param_list, info);
  93     }
  94
  95     return param_list;
  96 }
  97
  98 /* remove repeated entry from the info list */
  99 static void cleanup_infolist(CommandLineParameterInfoList *head)
 100 {
 101     CommandLineParameterInfoList *pre_entry, *cur, *del_entry;
 102
 103     cur = head;
 104     while (cur->next) {
 105         pre_entry = head;
 106         while (pre_entry != cur->next) {
 107             if (!strcmp(pre_entry->value->name, cur->next->value->name)) {
 108                 del_entry = cur->next;
 109                 cur->next = cur->next->next;
 110                 del_entry->next = NULL;
 111                 qapi_free_CommandLineParameterInfoList(del_entry);
 112                 break;
 113             }
 114             pre_entry = pre_entry->next;
 115         }
 116         cur = cur->next;
 117     }
 118 }
 119
 120 /* merge the description items of two parameter infolists */
 121 static void connect_infolist(CommandLineParameterInfoList *head,
 122                              CommandLineParameterInfoList *new)
 123 {
 124     CommandLineParameterInfoList *cur;
 125
 126     cur = head;
 127     while (cur->next) {
 128         cur = cur->next;
 129     }
 130     cur->next = new;
 131 }
 132
 133 /* access all the local QemuOptsLists for drive option */
 134 static CommandLineParameterInfoList *get_drive_infolist(void)
 135 {
 136     CommandLineParameterInfoList *head = NULL, *cur;
 137     int i;
 138
 139     for (i = 0; drive_config_groups[i] != NULL; i++) {
 140         if (!head) {
 141             head = query_option_descs(drive_config_groups[i]->desc);
 142         } else {
 143             cur = query_option_descs(drive_config_groups[i]->desc);
 144             connect_infolist(head, cur);
 145         }
 146     }
 147     cleanup_infolist(head);
 148
 149     return head;
 150 }
 151
 152 /* restore machine options that are now machine's properties */
 153 static QemuOptsList machine_opts = {
 154     .merge_lists = true,
 155     .head = QTAILQ_HEAD_INITIALIZER(machine_opts.head),
 156     .desc = {
 157         {
 158             .name = "type",
 159             .type = QEMU_OPT_STRING,
 160             .help = "emulated machine"
 161         },{
 162             .name = "accel",
 163             .type = QEMU_OPT_STRING,
 164             .help = "accelerator list",
 165         },{
 166             .name = "kernel_irqchip",
 167             .type = QEMU_OPT_BOOL,
 168             .help = "use KVM in-kernel irqchip",
 169         },{
 170             .name = "kvm_shadow_mem",
 171             .type = QEMU_OPT_SIZE,
 172             .help = "KVM shadow MMU size",
 173         },{
 174             .name = "kernel",
 175             .type = QEMU_OPT_STRING,
 176             .help = "Linux kernel image file",
 177         },{
 178             .name = "initrd",
 179             .type = QEMU_OPT_STRING,
 180             .help = "Linux initial ramdisk file",
 181         },{
 182             .name = "append",
 183             .type = QEMU_OPT_STRING,
 184             .help = "Linux kernel command line",
 185         },{
 186             .name = "dtb",
 187             .type = QEMU_OPT_STRING,
 188             .help = "Linux kernel device tree file",
 189         },{
 190             .name = "dumpdtb",
 191             .type = QEMU_OPT_STRING,
 192             .help = "Dump current dtb to a file and quit",
 193         },{
 194             .name = "phandle_start",
 195             .type = QEMU_OPT_NUMBER,
 196             .help = "The first phandle ID we may generate dynamically",
 197         },{
 198             .name = "dt_compatible",
 199             .type = QEMU_OPT_STRING,
 200             .help = "Overrides the \"compatible\" property of the dt root node",
 201         },{
 202             .name = "dump-guest-core",
 203             .type = QEMU_OPT_BOOL,
 204             .help = "Include guest memory in  a core dump",
 205         },{
 206             .name = "mem-merge",
 207             .type = QEMU_OPT_BOOL,
 208             .help = "enable/disable memory merge support",
 209         },{
 210             .name = "usb",
 211             .type = QEMU_OPT_BOOL,
 212             .help = "Set on/off to enable/disable usb",
 213         },{
 214             .name = "firmware",
 215             .type = QEMU_OPT_STRING,
 216             .help = "firmware image",
 217         },{
 218             .name = "iommu",
 219             .type = QEMU_OPT_BOOL,
 220             .help = "Set on/off to enable/disable Intel IOMMU (VT-d)",
 221         },{
 222             .name = "suppress-vmdesc",
 223             .type = QEMU_OPT_BOOL,
 224             .help = "Set on to disable self-describing migration",
 225         },{
 226             .name = "aes-key-wrap",
 227             .type = QEMU_OPT_BOOL,
 228             .help = "enable/disable AES key wrapping using the CPACF wrapping key",
 229         },{
 230             .name = "dea-key-wrap",
 231             .type = QEMU_OPT_BOOL,
 232             .help = "enable/disable DEA key wrapping using the CPACF wrapping key",
 233         },{
 234             .name = "loadparm",
 235             .type = QEMU_OPT_STRING,
 236             .help = "Up to 8 chars in set of [A-Za-z0-9. ](lower case chars"
 237                     " converted to upper case) to pass to machine"
 238                     " loader, boot manager, and guest kernel",
 239         },{
 240             .name = "zpcii-disable",
 241             .type = QEMU_OPT_BOOL,
 242             .help = "disable zPCI interpretation facilities",
 243         },
 244         { /* End of list */ }
 245     }
 246 };
 247
 248 CommandLineOptionInfoList *qmp_query_command_line_options(bool has_option,
 249                                                           const char *option,
 250                                                           Error **errp)
 251 {
 252     CommandLineOptionInfoList *conf_list = NULL;
 253     CommandLineOptionInfo *info;
 254     int i;
 255
 256     for (i = 0; vm_config_groups[i] != NULL; i++) {
 257         if (!has_option || !strcmp(option, vm_config_groups[i]->name)) {
 258             info = g_malloc0(sizeof(*info));
 259             info->option = g_strdup(vm_config_groups[i]->name);
 260             if (!strcmp("drive", vm_config_groups[i]->name)) {
 261                 info->parameters = get_drive_infolist();
 262             } else {
 263                 info->parameters =
 264                     query_option_descs(vm_config_groups[i]->desc);
 265             }
 266             QAPI_LIST_PREPEND(conf_list, info);
 267         }
 268     }
 269
 270     if (!has_option || !strcmp(option, "machine")) {
 271         info = g_malloc0(sizeof(*info));
 272         info->option = g_strdup("machine");
 273         info->parameters = query_option_descs(machine_opts.desc);
 274         QAPI_LIST_PREPEND(conf_list, info);
 275     }
 276
 277     if (conf_list == NULL) {
 278         error_setg(errp, "invalid option name: %s", option);
 279     }
 280
 281     return conf_list;
 282 }
 283
 284 QemuOptsList *qemu_find_opts_err(const char *group, Error **errp)
 285 {
 286     return find_list(vm_config_groups, group, errp);
 287 }
 288
 289 void qemu_add_drive_opts(QemuOptsList *list)
 290 {
 291     int entries, i;
 292
 293     entries = ARRAY_SIZE(drive_config_groups);
 294     entries--; /* keep list NULL terminated */
 295     for (i = 0; i < entries; i++) {
 296         if (drive_config_groups[i] == NULL) {
 297             drive_config_groups[i] = list;
 298             return;
 299         }
 300     }
 301     fprintf(stderr, "ran out of space in drive_config_groups");
 302     abort();
 303 }
 304
 305 void qemu_add_opts(QemuOptsList *list)
 306 {
 307     int entries, i;
 308
 309     entries = ARRAY_SIZE(vm_config_groups);
 310     entries--; /* keep list NULL terminated */
 311     for (i = 0; i < entries; i++) {
 312         if (vm_config_groups[i] == NULL) {
 313             vm_config_groups[i] = list;
 314             return;
 315         }
 316     }
 317     fprintf(stderr, "ran out of space in vm_config_groups");
 318     abort();
 319 }
 320
 321 /* Returns number of config groups on success, -errno on error */
 322 static int qemu_config_foreach(FILE *fp, QEMUConfigCB *cb, void *opaque,
 323                                const char *fname, Error **errp)
 324 {
 325     char line[1024], prev_group[64], group[64], arg[64], value[1024];
 326     Location loc;
 327     Error *local_err = NULL;
 328     QDict *qdict = NULL;
 329     int res = -EINVAL, lno = 0;
 330     int count = 0;
 331
 332     loc_push_none(&loc);
 333     while (fgets(line, sizeof(line), fp) != NULL) {
 334         ++lno;
 335         if (line[0] == '\n') {
 336             /* skip empty lines */
 337             continue;
 338         }
 339         if (line[0] == '#') {
 340             /* comment */
 341             continue;
 342         }
 343         if (line[0] == '[') {
 344             QDict *prev = qdict;
 345             if (sscanf(line, "[%63s \"%63[^\"]\"]", group, value) == 2) {
 346                 qdict = qdict_new();
 347                 qdict_put_str(qdict, "id", value);
 348                 count++;
 349             } else if (sscanf(line, "[%63[^]]]", group) == 1) {
 350                 qdict = qdict_new();
 351                 count++;
 352             }
 353             if (qdict != prev) {
 354                 if (prev) {
 355                     cb(prev_group, prev, opaque, &local_err);
 356                     qobject_unref(prev);
 357                     if (local_err) {
 358                         error_propagate(errp, local_err);
 359                         goto out;
 360                     }
 361                 }
 362                 strcpy(prev_group, group);
 363                 continue;
 364             }
 365         }
 366         loc_set_file(fname, lno);
 367         value[0] = '\0';
 368         if (sscanf(line, " %63s = \"%1023[^\"]\"", arg, value) == 2 ||
 369             sscanf(line, " %63s = \"\"", arg) == 1) {
 370             /* arg = value */
 371             if (qdict == NULL) {
 372                 error_setg(errp, "no group defined");
 373                 goto out;
 374             }
 375             qdict_put_str(qdict, arg, value);
 376             continue;
 377         }
 378         error_setg(errp, "parse error");
 379         goto out;
 380     }
 381     if (ferror(fp)) {
 382         loc_pop(&loc);
 383         error_setg_errno(errp, errno, "Cannot read config file");
 384         goto out_no_loc;
 385     }
 386     res = count;
 387     if (qdict) {
 388         cb(group, qdict, opaque, errp);
 389     }
 390 out:
 391     loc_pop(&loc);
 392 out_no_loc:
 393     qobject_unref(qdict);
 394     return res;
 395 }
 396
 397 void qemu_config_do_parse(const char *group, QDict *qdict, void *opaque, Error **errp)
 398 {
 399     QemuOptsList **lists = opaque;
 400     QemuOptsList *list;
 401
 402     list = find_list(lists, group, errp);
 403     if (!list) {
 404         return;
 405     }
 406
 407     qemu_opts_from_qdict(list, qdict, errp);
 408 }
 409
 410 int qemu_config_parse(FILE *fp, QemuOptsList **lists, const char *fname, Error **errp)
 411 {
 412     return qemu_config_foreach(fp, qemu_config_do_parse, lists, fname, errp);
 413 }
 414
 415 int qemu_read_config_file(const char *filename, QEMUConfigCB *cb, Error **errp)
 416 {
 417     FILE *f = fopen(filename, "r");
 418     int ret;
 419
 420     if (f == NULL) {
 421         error_setg_file_open(errp, errno, filename);
 422         return -errno;
 423     }
 424
 425     ret = qemu_config_foreach(f, cb, vm_config_groups, filename, errp);
 426     fclose(f);
 427     return ret;
 428 }
 429
 430 static void config_parse_qdict_section(QDict *options, QemuOptsList *opts,
 431                                        Error **errp)
 432 {
 433     QemuOpts *subopts;
 434     QDict *subqdict;
 435     QList *list = NULL;
 436     size_t orig_size, enum_size;
 437     char *prefix;
 438
 439     prefix = g_strdup_printf("%s.", opts->name);
 440     qdict_extract_subqdict(options, &subqdict, prefix);
 441     g_free(prefix);
 442     orig_size = qdict_size(subqdict);
 443     if (!orig_size) {
 444         goto out;
 445     }
 446
 447     subopts = qemu_opts_create(opts, NULL, 0, errp);
 448     if (!subopts) {
 449         goto out;
 450     }
 451
 452     if (!qemu_opts_absorb_qdict(subopts, subqdict, errp)) {
 453         goto out;
 454     }
 455
 456     enum_size = qdict_size(subqdict);
 457     if (enum_size < orig_size && enum_size) {
 458         error_setg(errp, "Unknown option '%s' for [%s]",
 459                    qdict_first(subqdict)->key, opts->name);
 460         goto out;
 461     }
 462
 463     if (enum_size) {
 464         /* Multiple, enumerated sections */
 465         QListEntry *list_entry;
 466         unsigned i = 0;
 467
 468         /* Not required anymore */
 469         qemu_opts_del(subopts);
 470
 471         qdict_array_split(subqdict, &list);
 472         if (qdict_size(subqdict)) {
 473             error_setg(errp, "Unused option '%s' for [%s]",
 474                        qdict_first(subqdict)->key, opts->name);
 475             goto out;
 476         }
 477
 478         QLIST_FOREACH_ENTRY(list, list_entry) {
 479             QDict *section = qobject_to(QDict, qlist_entry_obj(list_entry));
 480             char *opt_name;
 481
 482             if (!section) {
 483                 error_setg(errp, "[%s] section (index %u) does not consist of "
 484                            "keys", opts->name, i);
 485                 goto out;
 486             }
 487
 488             opt_name = g_strdup_printf("%s.%u", opts->name, i++);
 489             subopts = qemu_opts_create(opts, opt_name, 1, errp);
 490             g_free(opt_name);
 491             if (!subopts) {
 492                 goto out;
 493             }
 494
 495             if (!qemu_opts_absorb_qdict(subopts, section, errp)) {
 496                 qemu_opts_del(subopts);
 497                 goto out;
 498             }
 499
 500             if (qdict_size(section)) {
 501                 error_setg(errp, "[%s] section doesn't support the option '%s'",
 502                            opts->name, qdict_first(section)->key);
 503                 qemu_opts_del(subopts);
 504                 goto out;
 505             }
 506         }
 507     }
 508
 509 out:
 510     qobject_unref(subqdict);
 511     qobject_unref(list);
 512 }
 513
 514 void qemu_config_parse_qdict(QDict *options, QemuOptsList **lists,
 515                              Error **errp)
 516 {
 517     int i;
 518     Error *local_err = NULL;
 519
 520     for (i = 0; lists[i]; i++) {
 521         config_parse_qdict_section(options, lists[i], &local_err);
 522         if (local_err) {
 523             error_propagate(errp, local_err);
 524             return;
 525         }
 526     }
 527 }