Merge commit 'cbd2d4342b3d42ab33baa99f5b7a23491b5692f2' into upstream-merge
[qemu-kvm.git] / qemu-config.c
blob6d9c03890554e464d9943890de46f4058fe3075c
1 #include "qemu-common.h"
2 #include "qemu-error.h"
3 #include "qemu-option.h"
4 #include "qemu-config.h"
5 #include "hw/qdev.h"
6 #include "error.h"
8 static QemuOptsList qemu_drive_opts = {
9 .name = "drive",
10 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
11 .desc = {
13 .name = "bus",
14 .type = QEMU_OPT_NUMBER,
15 .help = "bus number",
16 },{
17 .name = "unit",
18 .type = QEMU_OPT_NUMBER,
19 .help = "unit number (i.e. lun for scsi)",
20 },{
21 .name = "if",
22 .type = QEMU_OPT_STRING,
23 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
24 },{
25 .name = "index",
26 .type = QEMU_OPT_NUMBER,
27 .help = "index number",
28 },{
29 .name = "cyls",
30 .type = QEMU_OPT_NUMBER,
31 .help = "number of cylinders (ide disk geometry)",
32 },{
33 .name = "heads",
34 .type = QEMU_OPT_NUMBER,
35 .help = "number of heads (ide disk geometry)",
36 },{
37 .name = "secs",
38 .type = QEMU_OPT_NUMBER,
39 .help = "number of sectors (ide disk geometry)",
40 },{
41 .name = "trans",
42 .type = QEMU_OPT_STRING,
43 .help = "chs translation (auto, lba. none)",
44 },{
45 .name = "media",
46 .type = QEMU_OPT_STRING,
47 .help = "media type (disk, cdrom)",
48 },{
49 .name = "snapshot",
50 .type = QEMU_OPT_BOOL,
51 .help = "enable/disable snapshot mode",
52 },{
53 .name = "file",
54 .type = QEMU_OPT_STRING,
55 .help = "disk image",
56 },{
57 .name = "cache",
58 .type = QEMU_OPT_STRING,
59 .help = "host cache usage (none, writeback, writethrough, "
60 "directsync, unsafe)",
61 },{
62 .name = "aio",
63 .type = QEMU_OPT_STRING,
64 .help = "host AIO implementation (threads, native)",
65 },{
66 .name = "format",
67 .type = QEMU_OPT_STRING,
68 .help = "disk format (raw, qcow2, ...)",
69 },{
70 .name = "serial",
71 .type = QEMU_OPT_STRING,
72 .help = "disk serial number",
73 },{
74 .name = "rerror",
75 .type = QEMU_OPT_STRING,
76 .help = "read error action",
77 },{
78 .name = "werror",
79 .type = QEMU_OPT_STRING,
80 .help = "write error action",
81 },{
82 .name = "addr",
83 .type = QEMU_OPT_STRING,
84 .help = "pci address (virtio only)",
85 },{
86 .name = "readonly",
87 .type = QEMU_OPT_BOOL,
88 .help = "open drive file as read-only",
89 },{
90 .name = "iops",
91 .type = QEMU_OPT_NUMBER,
92 .help = "limit total I/O operations per second",
93 },{
94 .name = "iops_rd",
95 .type = QEMU_OPT_NUMBER,
96 .help = "limit read operations per second",
97 },{
98 .name = "iops_wr",
99 .type = QEMU_OPT_NUMBER,
100 .help = "limit write operations per second",
102 .name = "bps",
103 .type = QEMU_OPT_NUMBER,
104 .help = "limit total bytes per second",
106 .name = "bps_rd",
107 .type = QEMU_OPT_NUMBER,
108 .help = "limit read bytes per second",
110 .name = "bps_wr",
111 .type = QEMU_OPT_NUMBER,
112 .help = "limit write bytes per second",
114 .name = "copy-on-read",
115 .type = QEMU_OPT_BOOL,
116 .help = "copy read data from backing file into image file",
118 .name = "boot",
119 .type = QEMU_OPT_BOOL,
120 .help = "(deprecated, ignored)",
122 { /* end of list */ }
126 static QemuOptsList qemu_iscsi_opts = {
127 .name = "iscsi",
128 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
129 .desc = {
131 .name = "user",
132 .type = QEMU_OPT_STRING,
133 .help = "username for CHAP authentication to target",
135 .name = "password",
136 .type = QEMU_OPT_STRING,
137 .help = "password for CHAP authentication to target",
139 .name = "header-digest",
140 .type = QEMU_OPT_STRING,
141 .help = "HeaderDigest setting. "
142 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
144 .name = "initiator-name",
145 .type = QEMU_OPT_STRING,
146 .help = "Initiator iqn name to use when connecting",
148 { /* end of list */ }
152 static QemuOptsList qemu_chardev_opts = {
153 .name = "chardev",
154 .implied_opt_name = "backend",
155 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
156 .desc = {
158 .name = "backend",
159 .type = QEMU_OPT_STRING,
161 .name = "path",
162 .type = QEMU_OPT_STRING,
164 .name = "host",
165 .type = QEMU_OPT_STRING,
167 .name = "port",
168 .type = QEMU_OPT_STRING,
170 .name = "localaddr",
171 .type = QEMU_OPT_STRING,
173 .name = "localport",
174 .type = QEMU_OPT_STRING,
176 .name = "to",
177 .type = QEMU_OPT_NUMBER,
179 .name = "ipv4",
180 .type = QEMU_OPT_BOOL,
182 .name = "ipv6",
183 .type = QEMU_OPT_BOOL,
185 .name = "wait",
186 .type = QEMU_OPT_BOOL,
188 .name = "server",
189 .type = QEMU_OPT_BOOL,
191 .name = "delay",
192 .type = QEMU_OPT_BOOL,
194 .name = "telnet",
195 .type = QEMU_OPT_BOOL,
197 .name = "width",
198 .type = QEMU_OPT_NUMBER,
200 .name = "height",
201 .type = QEMU_OPT_NUMBER,
203 .name = "cols",
204 .type = QEMU_OPT_NUMBER,
206 .name = "rows",
207 .type = QEMU_OPT_NUMBER,
209 .name = "mux",
210 .type = QEMU_OPT_BOOL,
212 .name = "signal",
213 .type = QEMU_OPT_BOOL,
215 .name = "name",
216 .type = QEMU_OPT_STRING,
218 .name = "debug",
219 .type = QEMU_OPT_NUMBER,
221 { /* end of list */ }
225 QemuOptsList qemu_fsdev_opts = {
226 .name = "fsdev",
227 .implied_opt_name = "fsdriver",
228 .head = QTAILQ_HEAD_INITIALIZER(qemu_fsdev_opts.head),
229 .desc = {
231 .name = "fsdriver",
232 .type = QEMU_OPT_STRING,
233 }, {
234 .name = "path",
235 .type = QEMU_OPT_STRING,
236 }, {
237 .name = "security_model",
238 .type = QEMU_OPT_STRING,
239 }, {
240 .name = "writeout",
241 .type = QEMU_OPT_STRING,
242 }, {
243 .name = "readonly",
244 .type = QEMU_OPT_BOOL,
246 }, {
247 .name = "socket",
248 .type = QEMU_OPT_STRING,
249 }, {
250 .name = "sock_fd",
251 .type = QEMU_OPT_NUMBER,
254 { /*End of list */ }
258 QemuOptsList qemu_virtfs_opts = {
259 .name = "virtfs",
260 .implied_opt_name = "fsdriver",
261 .head = QTAILQ_HEAD_INITIALIZER(qemu_virtfs_opts.head),
262 .desc = {
264 .name = "fsdriver",
265 .type = QEMU_OPT_STRING,
266 }, {
267 .name = "path",
268 .type = QEMU_OPT_STRING,
269 }, {
270 .name = "mount_tag",
271 .type = QEMU_OPT_STRING,
272 }, {
273 .name = "security_model",
274 .type = QEMU_OPT_STRING,
275 }, {
276 .name = "writeout",
277 .type = QEMU_OPT_STRING,
278 }, {
279 .name = "readonly",
280 .type = QEMU_OPT_BOOL,
281 }, {
282 .name = "socket",
283 .type = QEMU_OPT_STRING,
284 }, {
285 .name = "sock_fd",
286 .type = QEMU_OPT_NUMBER,
289 { /*End of list */ }
293 static QemuOptsList qemu_device_opts = {
294 .name = "device",
295 .implied_opt_name = "driver",
296 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
297 .desc = {
299 * no elements => accept any
300 * sanity checking will happen later
301 * when setting device properties
303 { /* end of list */ }
307 static QemuOptsList qemu_netdev_opts = {
308 .name = "netdev",
309 .implied_opt_name = "type",
310 .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
311 .desc = {
313 * no elements => accept any params
314 * validation will happen later
316 { /* end of list */ }
320 static QemuOptsList qemu_net_opts = {
321 .name = "net",
322 .implied_opt_name = "type",
323 .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
324 .desc = {
326 * no elements => accept any params
327 * validation will happen later
329 { /* end of list */ }
333 static QemuOptsList qemu_rtc_opts = {
334 .name = "rtc",
335 .head = QTAILQ_HEAD_INITIALIZER(qemu_rtc_opts.head),
336 .desc = {
338 .name = "base",
339 .type = QEMU_OPT_STRING,
341 .name = "clock",
342 .type = QEMU_OPT_STRING,
344 .name = "driftfix",
345 .type = QEMU_OPT_STRING,
347 { /* end of list */ }
351 static QemuOptsList qemu_global_opts = {
352 .name = "global",
353 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
354 .desc = {
356 .name = "driver",
357 .type = QEMU_OPT_STRING,
359 .name = "property",
360 .type = QEMU_OPT_STRING,
362 .name = "value",
363 .type = QEMU_OPT_STRING,
365 { /* end of list */ }
369 static QemuOptsList qemu_mon_opts = {
370 .name = "mon",
371 .implied_opt_name = "chardev",
372 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
373 .desc = {
375 .name = "mode",
376 .type = QEMU_OPT_STRING,
378 .name = "chardev",
379 .type = QEMU_OPT_STRING,
381 .name = "default",
382 .type = QEMU_OPT_BOOL,
384 .name = "pretty",
385 .type = QEMU_OPT_BOOL,
387 { /* end of list */ }
391 static QemuOptsList qemu_trace_opts = {
392 .name = "trace",
393 .implied_opt_name = "trace",
394 .head = QTAILQ_HEAD_INITIALIZER(qemu_trace_opts.head),
395 .desc = {
397 .name = "events",
398 .type = QEMU_OPT_STRING,
400 .name = "file",
401 .type = QEMU_OPT_STRING,
403 { /* end of list */ }
407 static QemuOptsList qemu_cpudef_opts = {
408 .name = "cpudef",
409 .head = QTAILQ_HEAD_INITIALIZER(qemu_cpudef_opts.head),
410 .desc = {
412 .name = "name",
413 .type = QEMU_OPT_STRING,
415 .name = "level",
416 .type = QEMU_OPT_NUMBER,
418 .name = "vendor",
419 .type = QEMU_OPT_STRING,
421 .name = "family",
422 .type = QEMU_OPT_NUMBER,
424 .name = "model",
425 .type = QEMU_OPT_NUMBER,
427 .name = "stepping",
428 .type = QEMU_OPT_NUMBER,
430 .name = "feature_edx", /* cpuid 0000_0001.edx */
431 .type = QEMU_OPT_STRING,
433 .name = "feature_ecx", /* cpuid 0000_0001.ecx */
434 .type = QEMU_OPT_STRING,
436 .name = "extfeature_edx", /* cpuid 8000_0001.edx */
437 .type = QEMU_OPT_STRING,
439 .name = "extfeature_ecx", /* cpuid 8000_0001.ecx */
440 .type = QEMU_OPT_STRING,
442 .name = "xlevel",
443 .type = QEMU_OPT_NUMBER,
445 .name = "model_id",
446 .type = QEMU_OPT_STRING,
448 .name = "vendor_override",
449 .type = QEMU_OPT_NUMBER,
451 { /* end of list */ }
455 QemuOptsList qemu_spice_opts = {
456 .name = "spice",
457 .head = QTAILQ_HEAD_INITIALIZER(qemu_spice_opts.head),
458 .desc = {
460 .name = "port",
461 .type = QEMU_OPT_NUMBER,
463 .name = "tls-port",
464 .type = QEMU_OPT_NUMBER,
466 .name = "addr",
467 .type = QEMU_OPT_STRING,
469 .name = "ipv4",
470 .type = QEMU_OPT_BOOL,
472 .name = "ipv6",
473 .type = QEMU_OPT_BOOL,
475 .name = "password",
476 .type = QEMU_OPT_STRING,
478 .name = "disable-ticketing",
479 .type = QEMU_OPT_BOOL,
481 .name = "disable-copy-paste",
482 .type = QEMU_OPT_BOOL,
484 .name = "sasl",
485 .type = QEMU_OPT_BOOL,
487 .name = "x509-dir",
488 .type = QEMU_OPT_STRING,
490 .name = "x509-key-file",
491 .type = QEMU_OPT_STRING,
493 .name = "x509-key-password",
494 .type = QEMU_OPT_STRING,
496 .name = "x509-cert-file",
497 .type = QEMU_OPT_STRING,
499 .name = "x509-cacert-file",
500 .type = QEMU_OPT_STRING,
502 .name = "x509-dh-key-file",
503 .type = QEMU_OPT_STRING,
505 .name = "tls-ciphers",
506 .type = QEMU_OPT_STRING,
508 .name = "tls-channel",
509 .type = QEMU_OPT_STRING,
511 .name = "plaintext-channel",
512 .type = QEMU_OPT_STRING,
514 .name = "image-compression",
515 .type = QEMU_OPT_STRING,
517 .name = "jpeg-wan-compression",
518 .type = QEMU_OPT_STRING,
520 .name = "zlib-glz-wan-compression",
521 .type = QEMU_OPT_STRING,
523 .name = "streaming-video",
524 .type = QEMU_OPT_STRING,
526 .name = "agent-mouse",
527 .type = QEMU_OPT_BOOL,
529 .name = "playback-compression",
530 .type = QEMU_OPT_BOOL,
532 { /* end of list */ }
536 QemuOptsList qemu_option_rom_opts = {
537 .name = "option-rom",
538 .implied_opt_name = "romfile",
539 .head = QTAILQ_HEAD_INITIALIZER(qemu_option_rom_opts.head),
540 .desc = {
542 .name = "bootindex",
543 .type = QEMU_OPT_NUMBER,
544 }, {
545 .name = "romfile",
546 .type = QEMU_OPT_STRING,
548 { /* end of list */ }
552 static QemuOptsList qemu_machine_opts = {
553 .name = "machine",
554 .implied_opt_name = "type",
555 .merge_lists = true,
556 .head = QTAILQ_HEAD_INITIALIZER(qemu_machine_opts.head),
557 .desc = {
559 .name = "type",
560 .type = QEMU_OPT_STRING,
561 .help = "emulated machine"
562 }, {
563 .name = "accel",
564 .type = QEMU_OPT_STRING,
565 .help = "accelerator list",
566 }, {
567 .name = "kernel_irqchip",
568 .type = QEMU_OPT_BOOL,
569 .help = "use KVM in-kernel irqchip",
570 }, {
571 .name = "kvm_shadow_mem",
572 .type = QEMU_OPT_SIZE,
573 .help = "KVM shadow MMU size",
574 }, {
575 .name = "kernel",
576 .type = QEMU_OPT_STRING,
577 .help = "Linux kernel image file",
578 }, {
579 .name = "initrd",
580 .type = QEMU_OPT_STRING,
581 .help = "Linux initial ramdisk file",
582 }, {
583 .name = "append",
584 .type = QEMU_OPT_STRING,
585 .help = "Linux kernel command line",
586 }, {
587 .name = "dtb",
588 .type = QEMU_OPT_STRING,
589 .help = "Linux kernel device tree file",
591 { /* End of list */ }
595 QemuOptsList qemu_boot_opts = {
596 .name = "boot-opts",
597 .head = QTAILQ_HEAD_INITIALIZER(qemu_boot_opts.head),
598 .desc = {
599 /* the three names below are not used now */
601 .name = "order",
602 .type = QEMU_OPT_STRING,
603 }, {
604 .name = "once",
605 .type = QEMU_OPT_STRING,
606 }, {
607 .name = "menu",
608 .type = QEMU_OPT_STRING,
609 /* following are really used */
610 }, {
611 .name = "splash",
612 .type = QEMU_OPT_STRING,
613 }, {
614 .name = "splash-time",
615 .type = QEMU_OPT_STRING,
617 { /*End of list */ }
621 static QemuOptsList *vm_config_groups[32] = {
622 &qemu_drive_opts,
623 &qemu_chardev_opts,
624 &qemu_device_opts,
625 &qemu_netdev_opts,
626 &qemu_net_opts,
627 &qemu_rtc_opts,
628 &qemu_global_opts,
629 &qemu_mon_opts,
630 &qemu_cpudef_opts,
631 &qemu_trace_opts,
632 &qemu_option_rom_opts,
633 &qemu_machine_opts,
634 &qemu_boot_opts,
635 &qemu_iscsi_opts,
636 NULL,
639 static QemuOptsList *find_list(QemuOptsList **lists, const char *group,
640 Error **errp)
642 int i;
644 for (i = 0; lists[i] != NULL; i++) {
645 if (strcmp(lists[i]->name, group) == 0)
646 break;
648 if (lists[i] == NULL) {
649 error_set(errp, QERR_INVALID_OPTION_GROUP, group);
651 return lists[i];
654 QemuOptsList *qemu_find_opts(const char *group)
656 QemuOptsList *ret;
657 Error *local_err = NULL;
659 ret = find_list(vm_config_groups, group, &local_err);
660 if (error_is_set(&local_err)) {
661 error_report("%s\n", error_get_pretty(local_err));
662 error_free(local_err);
665 return ret;
668 QemuOptsList *qemu_find_opts_err(const char *group, Error **errp)
670 return find_list(vm_config_groups, group, errp);
673 void qemu_add_opts(QemuOptsList *list)
675 int entries, i;
677 entries = ARRAY_SIZE(vm_config_groups);
678 entries--; /* keep list NULL terminated */
679 for (i = 0; i < entries; i++) {
680 if (vm_config_groups[i] == NULL) {
681 vm_config_groups[i] = list;
682 return;
685 fprintf(stderr, "ran out of space in vm_config_groups");
686 abort();
689 int qemu_set_option(const char *str)
691 char group[64], id[64], arg[64];
692 QemuOptsList *list;
693 QemuOpts *opts;
694 int rc, offset;
696 rc = sscanf(str, "%63[^.].%63[^.].%63[^=]%n", group, id, arg, &offset);
697 if (rc < 3 || str[offset] != '=') {
698 error_report("can't parse: \"%s\"", str);
699 return -1;
702 list = qemu_find_opts(group);
703 if (list == NULL) {
704 return -1;
707 opts = qemu_opts_find(list, id);
708 if (!opts) {
709 error_report("there is no %s \"%s\" defined",
710 list->name, id);
711 return -1;
714 if (qemu_opt_set(opts, arg, str+offset+1) == -1) {
715 return -1;
717 return 0;
720 int qemu_global_option(const char *str)
722 char driver[64], property[64];
723 QemuOpts *opts;
724 int rc, offset;
726 rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
727 if (rc < 2 || str[offset] != '=') {
728 error_report("can't parse: \"%s\"", str);
729 return -1;
732 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, NULL);
733 qemu_opt_set(opts, "driver", driver);
734 qemu_opt_set(opts, "property", property);
735 qemu_opt_set(opts, "value", str+offset+1);
736 return 0;
739 struct ConfigWriteData {
740 QemuOptsList *list;
741 FILE *fp;
744 static int config_write_opt(const char *name, const char *value, void *opaque)
746 struct ConfigWriteData *data = opaque;
748 fprintf(data->fp, " %s = \"%s\"\n", name, value);
749 return 0;
752 static int config_write_opts(QemuOpts *opts, void *opaque)
754 struct ConfigWriteData *data = opaque;
755 const char *id = qemu_opts_id(opts);
757 if (id) {
758 fprintf(data->fp, "[%s \"%s\"]\n", data->list->name, id);
759 } else {
760 fprintf(data->fp, "[%s]\n", data->list->name);
762 qemu_opt_foreach(opts, config_write_opt, data, 0);
763 fprintf(data->fp, "\n");
764 return 0;
767 void qemu_config_write(FILE *fp)
769 struct ConfigWriteData data = { .fp = fp };
770 QemuOptsList **lists = vm_config_groups;
771 int i;
773 fprintf(fp, "# qemu config file\n\n");
774 for (i = 0; lists[i] != NULL; i++) {
775 data.list = lists[i];
776 qemu_opts_foreach(data.list, config_write_opts, &data, 0);
780 int qemu_config_parse(FILE *fp, QemuOptsList **lists, const char *fname)
782 char line[1024], group[64], id[64], arg[64], value[1024];
783 Location loc;
784 QemuOptsList *list = NULL;
785 Error *local_err = NULL;
786 QemuOpts *opts = NULL;
787 int res = -1, lno = 0;
789 loc_push_none(&loc);
790 while (fgets(line, sizeof(line), fp) != NULL) {
791 loc_set_file(fname, ++lno);
792 if (line[0] == '\n') {
793 /* skip empty lines */
794 continue;
796 if (line[0] == '#') {
797 /* comment */
798 continue;
800 if (sscanf(line, "[%63s \"%63[^\"]\"]", group, id) == 2) {
801 /* group with id */
802 list = find_list(lists, group, &local_err);
803 if (error_is_set(&local_err)) {
804 error_report("%s\n", error_get_pretty(local_err));
805 error_free(local_err);
806 goto out;
808 opts = qemu_opts_create(list, id, 1, NULL);
809 continue;
811 if (sscanf(line, "[%63[^]]]", group) == 1) {
812 /* group without id */
813 list = find_list(lists, group, &local_err);
814 if (error_is_set(&local_err)) {
815 error_report("%s\n", error_get_pretty(local_err));
816 error_free(local_err);
817 goto out;
819 opts = qemu_opts_create(list, NULL, 0, NULL);
820 continue;
822 if (sscanf(line, " %63s = \"%1023[^\"]\"", arg, value) == 2) {
823 /* arg = value */
824 if (opts == NULL) {
825 error_report("no group defined");
826 goto out;
828 if (qemu_opt_set(opts, arg, value) != 0) {
829 goto out;
831 continue;
833 error_report("parse error");
834 goto out;
836 if (ferror(fp)) {
837 error_report("error reading file");
838 goto out;
840 res = 0;
841 out:
842 loc_pop(&loc);
843 return res;
846 int qemu_read_config_file(const char *filename)
848 FILE *f = fopen(filename, "r");
849 int ret;
851 if (f == NULL) {
852 return -errno;
855 ret = qemu_config_parse(f, vm_config_groups, filename);
856 fclose(f);
858 if (ret == 0) {
859 return 0;
860 } else {
861 return -EINVAL;