block/io: Make bdrv_requests_pending() public
[qemu.git] / util / qemu-config.c
blob5fcfd0e6ac4624d640b22e3792c199ca7cb3218d
1 #include "qemu-common.h"
2 #include "qemu/error-report.h"
3 #include "qemu/option.h"
4 #include "qemu/config-file.h"
5 #include "qapi/error.h"
6 #include "qmp-commands.h"
8 static QemuOptsList *vm_config_groups[48];
9 static QemuOptsList *drive_config_groups[4];
11 static QemuOptsList *find_list(QemuOptsList **lists, const char *group,
12 Error **errp)
14 int i;
16 for (i = 0; lists[i] != NULL; i++) {
17 if (strcmp(lists[i]->name, group) == 0)
18 break;
20 if (lists[i] == NULL) {
21 error_setg(errp, "There is no option group '%s'", group);
23 return lists[i];
26 QemuOptsList *qemu_find_opts(const char *group)
28 QemuOptsList *ret;
29 Error *local_err = NULL;
31 ret = find_list(vm_config_groups, group, &local_err);
32 if (local_err) {
33 error_report_err(local_err);
36 return ret;
39 QemuOpts *qemu_find_opts_singleton(const char *group)
41 QemuOptsList *list;
42 QemuOpts *opts;
44 list = qemu_find_opts(group);
45 assert(list);
46 opts = qemu_opts_find(list, NULL);
47 if (!opts) {
48 opts = qemu_opts_create(list, NULL, 0, &error_abort);
50 return opts;
53 static CommandLineParameterInfoList *query_option_descs(const QemuOptDesc *desc)
55 CommandLineParameterInfoList *param_list = NULL, *entry;
56 CommandLineParameterInfo *info;
57 int i;
59 for (i = 0; desc[i].name != NULL; i++) {
60 info = g_malloc0(sizeof(*info));
61 info->name = g_strdup(desc[i].name);
63 switch (desc[i].type) {
64 case QEMU_OPT_STRING:
65 info->type = COMMAND_LINE_PARAMETER_TYPE_STRING;
66 break;
67 case QEMU_OPT_BOOL:
68 info->type = COMMAND_LINE_PARAMETER_TYPE_BOOLEAN;
69 break;
70 case QEMU_OPT_NUMBER:
71 info->type = COMMAND_LINE_PARAMETER_TYPE_NUMBER;
72 break;
73 case QEMU_OPT_SIZE:
74 info->type = COMMAND_LINE_PARAMETER_TYPE_SIZE;
75 break;
78 if (desc[i].help) {
79 info->has_help = true;
80 info->help = g_strdup(desc[i].help);
82 if (desc[i].def_value_str) {
83 info->has_q_default = true;
84 info->q_default = g_strdup(desc[i].def_value_str);
87 entry = g_malloc0(sizeof(*entry));
88 entry->value = info;
89 entry->next = param_list;
90 param_list = entry;
93 return param_list;
96 /* remove repeated entry from the info list */
97 static void cleanup_infolist(CommandLineParameterInfoList *head)
99 CommandLineParameterInfoList *pre_entry, *cur, *del_entry;
101 cur = head;
102 while (cur->next) {
103 pre_entry = head;
104 while (pre_entry != cur->next) {
105 if (!strcmp(pre_entry->value->name, cur->next->value->name)) {
106 del_entry = cur->next;
107 cur->next = cur->next->next;
108 g_free(del_entry);
109 break;
111 pre_entry = pre_entry->next;
113 cur = cur->next;
117 /* merge the description items of two parameter infolists */
118 static void connect_infolist(CommandLineParameterInfoList *head,
119 CommandLineParameterInfoList *new)
121 CommandLineParameterInfoList *cur;
123 cur = head;
124 while (cur->next) {
125 cur = cur->next;
127 cur->next = new;
130 /* access all the local QemuOptsLists for drive option */
131 static CommandLineParameterInfoList *get_drive_infolist(void)
133 CommandLineParameterInfoList *head = NULL, *cur;
134 int i;
136 for (i = 0; drive_config_groups[i] != NULL; i++) {
137 if (!head) {
138 head = query_option_descs(drive_config_groups[i]->desc);
139 } else {
140 cur = query_option_descs(drive_config_groups[i]->desc);
141 connect_infolist(head, cur);
144 cleanup_infolist(head);
146 return head;
149 /* restore machine options that are now machine's properties */
150 static QemuOptsList machine_opts = {
151 .merge_lists = true,
152 .head = QTAILQ_HEAD_INITIALIZER(machine_opts.head),
153 .desc = {
155 .name = "type",
156 .type = QEMU_OPT_STRING,
157 .help = "emulated machine"
159 .name = "accel",
160 .type = QEMU_OPT_STRING,
161 .help = "accelerator list",
163 .name = "kernel_irqchip",
164 .type = QEMU_OPT_BOOL,
165 .help = "use KVM in-kernel irqchip",
167 .name = "kvm_shadow_mem",
168 .type = QEMU_OPT_SIZE,
169 .help = "KVM shadow MMU size",
171 .name = "kernel",
172 .type = QEMU_OPT_STRING,
173 .help = "Linux kernel image file",
175 .name = "initrd",
176 .type = QEMU_OPT_STRING,
177 .help = "Linux initial ramdisk file",
179 .name = "append",
180 .type = QEMU_OPT_STRING,
181 .help = "Linux kernel command line",
183 .name = "dtb",
184 .type = QEMU_OPT_STRING,
185 .help = "Linux kernel device tree file",
187 .name = "dumpdtb",
188 .type = QEMU_OPT_STRING,
189 .help = "Dump current dtb to a file and quit",
191 .name = "phandle_start",
192 .type = QEMU_OPT_NUMBER,
193 .help = "The first phandle ID we may generate dynamically",
195 .name = "dt_compatible",
196 .type = QEMU_OPT_STRING,
197 .help = "Overrides the \"compatible\" property of the dt root node",
199 .name = "dump-guest-core",
200 .type = QEMU_OPT_BOOL,
201 .help = "Include guest memory in a core dump",
203 .name = "mem-merge",
204 .type = QEMU_OPT_BOOL,
205 .help = "enable/disable memory merge support",
207 .name = "usb",
208 .type = QEMU_OPT_BOOL,
209 .help = "Set on/off to enable/disable usb",
211 .name = "firmware",
212 .type = QEMU_OPT_STRING,
213 .help = "firmware image",
215 .name = "iommu",
216 .type = QEMU_OPT_BOOL,
217 .help = "Set on/off to enable/disable Intel IOMMU (VT-d)",
219 .name = "suppress-vmdesc",
220 .type = QEMU_OPT_BOOL,
221 .help = "Set on to disable self-describing migration",
223 { /* End of list */ }
227 CommandLineOptionInfoList *qmp_query_command_line_options(bool has_option,
228 const char *option,
229 Error **errp)
231 CommandLineOptionInfoList *conf_list = NULL, *entry;
232 CommandLineOptionInfo *info;
233 int i;
235 for (i = 0; vm_config_groups[i] != NULL; i++) {
236 if (!has_option || !strcmp(option, vm_config_groups[i]->name)) {
237 info = g_malloc0(sizeof(*info));
238 info->option = g_strdup(vm_config_groups[i]->name);
239 if (!strcmp("drive", vm_config_groups[i]->name)) {
240 info->parameters = get_drive_infolist();
241 } else if (!strcmp("machine", vm_config_groups[i]->name)) {
242 info->parameters = query_option_descs(machine_opts.desc);
243 } else {
244 info->parameters =
245 query_option_descs(vm_config_groups[i]->desc);
247 entry = g_malloc0(sizeof(*entry));
248 entry->value = info;
249 entry->next = conf_list;
250 conf_list = entry;
254 if (conf_list == NULL) {
255 error_setg(errp, "invalid option name: %s", option);
258 return conf_list;
261 QemuOptsList *qemu_find_opts_err(const char *group, Error **errp)
263 return find_list(vm_config_groups, group, errp);
266 void qemu_add_drive_opts(QemuOptsList *list)
268 int entries, i;
270 entries = ARRAY_SIZE(drive_config_groups);
271 entries--; /* keep list NULL terminated */
272 for (i = 0; i < entries; i++) {
273 if (drive_config_groups[i] == NULL) {
274 drive_config_groups[i] = list;
275 return;
278 fprintf(stderr, "ran out of space in drive_config_groups");
279 abort();
282 void qemu_add_opts(QemuOptsList *list)
284 int entries, i;
286 entries = ARRAY_SIZE(vm_config_groups);
287 entries--; /* keep list NULL terminated */
288 for (i = 0; i < entries; i++) {
289 if (vm_config_groups[i] == NULL) {
290 vm_config_groups[i] = list;
291 return;
294 fprintf(stderr, "ran out of space in vm_config_groups");
295 abort();
298 int qemu_set_option(const char *str)
300 Error *local_err = NULL;
301 char group[64], id[64], arg[64];
302 QemuOptsList *list;
303 QemuOpts *opts;
304 int rc, offset;
306 rc = sscanf(str, "%63[^.].%63[^.].%63[^=]%n", group, id, arg, &offset);
307 if (rc < 3 || str[offset] != '=') {
308 error_report("can't parse: \"%s\"", str);
309 return -1;
312 list = qemu_find_opts(group);
313 if (list == NULL) {
314 return -1;
317 opts = qemu_opts_find(list, id);
318 if (!opts) {
319 error_report("there is no %s \"%s\" defined",
320 list->name, id);
321 return -1;
324 qemu_opt_set(opts, arg, str + offset + 1, &local_err);
325 if (local_err) {
326 error_report_err(local_err);
327 return -1;
329 return 0;
332 struct ConfigWriteData {
333 QemuOptsList *list;
334 FILE *fp;
337 static int config_write_opt(void *opaque, const char *name, const char *value,
338 Error **errp)
340 struct ConfigWriteData *data = opaque;
342 fprintf(data->fp, " %s = \"%s\"\n", name, value);
343 return 0;
346 static int config_write_opts(void *opaque, QemuOpts *opts, Error **errp)
348 struct ConfigWriteData *data = opaque;
349 const char *id = qemu_opts_id(opts);
351 if (id) {
352 fprintf(data->fp, "[%s \"%s\"]\n", data->list->name, id);
353 } else {
354 fprintf(data->fp, "[%s]\n", data->list->name);
356 qemu_opt_foreach(opts, config_write_opt, data, NULL);
357 fprintf(data->fp, "\n");
358 return 0;
361 void qemu_config_write(FILE *fp)
363 struct ConfigWriteData data = { .fp = fp };
364 QemuOptsList **lists = vm_config_groups;
365 int i;
367 fprintf(fp, "# qemu config file\n\n");
368 for (i = 0; lists[i] != NULL; i++) {
369 data.list = lists[i];
370 qemu_opts_foreach(data.list, config_write_opts, &data, NULL);
374 int qemu_config_parse(FILE *fp, QemuOptsList **lists, const char *fname)
376 char line[1024], group[64], id[64], arg[64], value[1024];
377 Location loc;
378 QemuOptsList *list = NULL;
379 Error *local_err = NULL;
380 QemuOpts *opts = NULL;
381 int res = -1, lno = 0;
383 loc_push_none(&loc);
384 while (fgets(line, sizeof(line), fp) != NULL) {
385 loc_set_file(fname, ++lno);
386 if (line[0] == '\n') {
387 /* skip empty lines */
388 continue;
390 if (line[0] == '#') {
391 /* comment */
392 continue;
394 if (sscanf(line, "[%63s \"%63[^\"]\"]", group, id) == 2) {
395 /* group with id */
396 list = find_list(lists, group, &local_err);
397 if (local_err) {
398 error_report_err(local_err);
399 goto out;
401 opts = qemu_opts_create(list, id, 1, NULL);
402 continue;
404 if (sscanf(line, "[%63[^]]]", group) == 1) {
405 /* group without id */
406 list = find_list(lists, group, &local_err);
407 if (local_err) {
408 error_report_err(local_err);
409 goto out;
411 opts = qemu_opts_create(list, NULL, 0, &error_abort);
412 continue;
414 value[0] = '\0';
415 if (sscanf(line, " %63s = \"%1023[^\"]\"", arg, value) == 2 ||
416 sscanf(line, " %63s = \"\"", arg) == 1) {
417 /* arg = value */
418 if (opts == NULL) {
419 error_report("no group defined");
420 goto out;
422 qemu_opt_set(opts, arg, value, &local_err);
423 if (local_err) {
424 error_report_err(local_err);
425 goto out;
427 continue;
429 error_report("parse error");
430 goto out;
432 if (ferror(fp)) {
433 error_report("error reading file");
434 goto out;
436 res = 0;
437 out:
438 loc_pop(&loc);
439 return res;
442 int qemu_read_config_file(const char *filename)
444 FILE *f = fopen(filename, "r");
445 int ret;
447 if (f == NULL) {
448 return -errno;
451 ret = qemu_config_parse(f, vm_config_groups, filename);
452 fclose(f);
454 if (ret == 0) {
455 return 0;
456 } else {
457 return -EINVAL;
461 static void config_parse_qdict_section(QDict *options, QemuOptsList *opts,
462 Error **errp)
464 QemuOpts *subopts;
465 QDict *subqdict;
466 QList *list = NULL;
467 Error *local_err = NULL;
468 size_t orig_size, enum_size;
469 char *prefix;
471 prefix = g_strdup_printf("%s.", opts->name);
472 qdict_extract_subqdict(options, &subqdict, prefix);
473 g_free(prefix);
474 orig_size = qdict_size(subqdict);
475 if (!orig_size) {
476 goto out;
479 subopts = qemu_opts_create(opts, NULL, 0, &local_err);
480 if (local_err) {
481 error_propagate(errp, local_err);
482 goto out;
485 qemu_opts_absorb_qdict(subopts, subqdict, &local_err);
486 if (local_err) {
487 error_propagate(errp, local_err);
488 goto out;
491 enum_size = qdict_size(subqdict);
492 if (enum_size < orig_size && enum_size) {
493 error_setg(errp, "Unknown option '%s' for [%s]",
494 qdict_first(subqdict)->key, opts->name);
495 goto out;
498 if (enum_size) {
499 /* Multiple, enumerated sections */
500 QListEntry *list_entry;
501 unsigned i = 0;
503 /* Not required anymore */
504 qemu_opts_del(subopts);
506 qdict_array_split(subqdict, &list);
507 if (qdict_size(subqdict)) {
508 error_setg(errp, "Unused option '%s' for [%s]",
509 qdict_first(subqdict)->key, opts->name);
510 goto out;
513 QLIST_FOREACH_ENTRY(list, list_entry) {
514 QDict *section = qobject_to_qdict(qlist_entry_obj(list_entry));
515 char *opt_name;
517 if (!section) {
518 error_setg(errp, "[%s] section (index %u) does not consist of "
519 "keys", opts->name, i);
520 goto out;
523 opt_name = g_strdup_printf("%s.%u", opts->name, i++);
524 subopts = qemu_opts_create(opts, opt_name, 1, &local_err);
525 g_free(opt_name);
526 if (local_err) {
527 error_propagate(errp, local_err);
528 goto out;
531 qemu_opts_absorb_qdict(subopts, section, &local_err);
532 if (local_err) {
533 error_propagate(errp, local_err);
534 qemu_opts_del(subopts);
535 goto out;
538 if (qdict_size(section)) {
539 error_setg(errp, "[%s] section doesn't support the option '%s'",
540 opts->name, qdict_first(section)->key);
541 qemu_opts_del(subopts);
542 goto out;
547 out:
548 QDECREF(subqdict);
549 QDECREF(list);
552 void qemu_config_parse_qdict(QDict *options, QemuOptsList **lists,
553 Error **errp)
555 int i;
556 Error *local_err = NULL;
558 for (i = 0; lists[i]; i++) {
559 config_parse_qdict_section(options, lists[i], &local_err);
560 if (local_err) {
561 error_propagate(errp, local_err);
562 return;