Merge remote-tracking branch 'stefanha/trivial-patches' into staging
[qemu.git] / qemu-config.c
blob5c3296b8c6f0ec85201579f9a5f4e085adc33314
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 { /* end of list */ }
122 static QemuOptsList qemu_iscsi_opts = {
123 .name = "iscsi",
124 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
125 .desc = {
127 .name = "user",
128 .type = QEMU_OPT_STRING,
129 .help = "username for CHAP authentication to target",
131 .name = "password",
132 .type = QEMU_OPT_STRING,
133 .help = "password for CHAP authentication to target",
135 .name = "header-digest",
136 .type = QEMU_OPT_STRING,
137 .help = "HeaderDigest setting. "
138 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
140 .name = "initiator-name",
141 .type = QEMU_OPT_STRING,
142 .help = "Initiator iqn name to use when connecting",
144 { /* end of list */ }
148 static QemuOptsList qemu_chardev_opts = {
149 .name = "chardev",
150 .implied_opt_name = "backend",
151 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
152 .desc = {
154 .name = "backend",
155 .type = QEMU_OPT_STRING,
157 .name = "path",
158 .type = QEMU_OPT_STRING,
160 .name = "host",
161 .type = QEMU_OPT_STRING,
163 .name = "port",
164 .type = QEMU_OPT_STRING,
166 .name = "localaddr",
167 .type = QEMU_OPT_STRING,
169 .name = "localport",
170 .type = QEMU_OPT_STRING,
172 .name = "to",
173 .type = QEMU_OPT_NUMBER,
175 .name = "ipv4",
176 .type = QEMU_OPT_BOOL,
178 .name = "ipv6",
179 .type = QEMU_OPT_BOOL,
181 .name = "wait",
182 .type = QEMU_OPT_BOOL,
184 .name = "server",
185 .type = QEMU_OPT_BOOL,
187 .name = "delay",
188 .type = QEMU_OPT_BOOL,
190 .name = "telnet",
191 .type = QEMU_OPT_BOOL,
193 .name = "width",
194 .type = QEMU_OPT_NUMBER,
196 .name = "height",
197 .type = QEMU_OPT_NUMBER,
199 .name = "cols",
200 .type = QEMU_OPT_NUMBER,
202 .name = "rows",
203 .type = QEMU_OPT_NUMBER,
205 .name = "mux",
206 .type = QEMU_OPT_BOOL,
208 .name = "signal",
209 .type = QEMU_OPT_BOOL,
211 .name = "name",
212 .type = QEMU_OPT_STRING,
214 .name = "debug",
215 .type = QEMU_OPT_NUMBER,
217 { /* end of list */ }
221 QemuOptsList qemu_fsdev_opts = {
222 .name = "fsdev",
223 .implied_opt_name = "fsdriver",
224 .head = QTAILQ_HEAD_INITIALIZER(qemu_fsdev_opts.head),
225 .desc = {
227 .name = "fsdriver",
228 .type = QEMU_OPT_STRING,
229 }, {
230 .name = "path",
231 .type = QEMU_OPT_STRING,
232 }, {
233 .name = "security_model",
234 .type = QEMU_OPT_STRING,
235 }, {
236 .name = "writeout",
237 .type = QEMU_OPT_STRING,
238 }, {
239 .name = "readonly",
240 .type = QEMU_OPT_BOOL,
242 }, {
243 .name = "socket",
244 .type = QEMU_OPT_STRING,
245 }, {
246 .name = "sock_fd",
247 .type = QEMU_OPT_NUMBER,
250 { /*End of list */ }
254 QemuOptsList qemu_virtfs_opts = {
255 .name = "virtfs",
256 .implied_opt_name = "fsdriver",
257 .head = QTAILQ_HEAD_INITIALIZER(qemu_virtfs_opts.head),
258 .desc = {
260 .name = "fsdriver",
261 .type = QEMU_OPT_STRING,
262 }, {
263 .name = "path",
264 .type = QEMU_OPT_STRING,
265 }, {
266 .name = "mount_tag",
267 .type = QEMU_OPT_STRING,
268 }, {
269 .name = "security_model",
270 .type = QEMU_OPT_STRING,
271 }, {
272 .name = "writeout",
273 .type = QEMU_OPT_STRING,
274 }, {
275 .name = "readonly",
276 .type = QEMU_OPT_BOOL,
277 }, {
278 .name = "socket",
279 .type = QEMU_OPT_STRING,
280 }, {
281 .name = "sock_fd",
282 .type = QEMU_OPT_NUMBER,
285 { /*End of list */ }
289 static QemuOptsList qemu_device_opts = {
290 .name = "device",
291 .implied_opt_name = "driver",
292 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
293 .desc = {
295 * no elements => accept any
296 * sanity checking will happen later
297 * when setting device properties
299 { /* end of list */ }
303 static QemuOptsList qemu_netdev_opts = {
304 .name = "netdev",
305 .implied_opt_name = "type",
306 .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
307 .desc = {
309 * no elements => accept any params
310 * validation will happen later
312 { /* end of list */ }
316 static QemuOptsList qemu_net_opts = {
317 .name = "net",
318 .implied_opt_name = "type",
319 .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
320 .desc = {
322 * no elements => accept any params
323 * validation will happen later
325 { /* end of list */ }
329 static QemuOptsList qemu_rtc_opts = {
330 .name = "rtc",
331 .head = QTAILQ_HEAD_INITIALIZER(qemu_rtc_opts.head),
332 .desc = {
334 .name = "base",
335 .type = QEMU_OPT_STRING,
337 .name = "clock",
338 .type = QEMU_OPT_STRING,
340 .name = "driftfix",
341 .type = QEMU_OPT_STRING,
343 { /* end of list */ }
347 static QemuOptsList qemu_global_opts = {
348 .name = "global",
349 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
350 .desc = {
352 .name = "driver",
353 .type = QEMU_OPT_STRING,
355 .name = "property",
356 .type = QEMU_OPT_STRING,
358 .name = "value",
359 .type = QEMU_OPT_STRING,
361 { /* end of list */ }
365 static QemuOptsList qemu_mon_opts = {
366 .name = "mon",
367 .implied_opt_name = "chardev",
368 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
369 .desc = {
371 .name = "mode",
372 .type = QEMU_OPT_STRING,
374 .name = "chardev",
375 .type = QEMU_OPT_STRING,
377 .name = "default",
378 .type = QEMU_OPT_BOOL,
380 .name = "pretty",
381 .type = QEMU_OPT_BOOL,
383 { /* end of list */ }
387 static QemuOptsList qemu_trace_opts = {
388 .name = "trace",
389 .implied_opt_name = "trace",
390 .head = QTAILQ_HEAD_INITIALIZER(qemu_trace_opts.head),
391 .desc = {
393 .name = "events",
394 .type = QEMU_OPT_STRING,
396 .name = "file",
397 .type = QEMU_OPT_STRING,
399 { /* end of list */ }
403 static QemuOptsList qemu_cpudef_opts = {
404 .name = "cpudef",
405 .head = QTAILQ_HEAD_INITIALIZER(qemu_cpudef_opts.head),
406 .desc = {
408 .name = "name",
409 .type = QEMU_OPT_STRING,
411 .name = "level",
412 .type = QEMU_OPT_NUMBER,
414 .name = "vendor",
415 .type = QEMU_OPT_STRING,
417 .name = "family",
418 .type = QEMU_OPT_NUMBER,
420 .name = "model",
421 .type = QEMU_OPT_NUMBER,
423 .name = "stepping",
424 .type = QEMU_OPT_NUMBER,
426 .name = "feature_edx", /* cpuid 0000_0001.edx */
427 .type = QEMU_OPT_STRING,
429 .name = "feature_ecx", /* cpuid 0000_0001.ecx */
430 .type = QEMU_OPT_STRING,
432 .name = "extfeature_edx", /* cpuid 8000_0001.edx */
433 .type = QEMU_OPT_STRING,
435 .name = "extfeature_ecx", /* cpuid 8000_0001.ecx */
436 .type = QEMU_OPT_STRING,
438 .name = "xlevel",
439 .type = QEMU_OPT_NUMBER,
441 .name = "model_id",
442 .type = QEMU_OPT_STRING,
444 .name = "vendor_override",
445 .type = QEMU_OPT_NUMBER,
447 { /* end of list */ }
451 QemuOptsList qemu_spice_opts = {
452 .name = "spice",
453 .head = QTAILQ_HEAD_INITIALIZER(qemu_spice_opts.head),
454 .desc = {
456 .name = "port",
457 .type = QEMU_OPT_NUMBER,
459 .name = "tls-port",
460 .type = QEMU_OPT_NUMBER,
462 .name = "addr",
463 .type = QEMU_OPT_STRING,
465 .name = "ipv4",
466 .type = QEMU_OPT_BOOL,
468 .name = "ipv6",
469 .type = QEMU_OPT_BOOL,
471 .name = "password",
472 .type = QEMU_OPT_STRING,
474 .name = "disable-ticketing",
475 .type = QEMU_OPT_BOOL,
477 .name = "disable-copy-paste",
478 .type = QEMU_OPT_BOOL,
480 .name = "sasl",
481 .type = QEMU_OPT_BOOL,
483 .name = "x509-dir",
484 .type = QEMU_OPT_STRING,
486 .name = "x509-key-file",
487 .type = QEMU_OPT_STRING,
489 .name = "x509-key-password",
490 .type = QEMU_OPT_STRING,
492 .name = "x509-cert-file",
493 .type = QEMU_OPT_STRING,
495 .name = "x509-cacert-file",
496 .type = QEMU_OPT_STRING,
498 .name = "x509-dh-key-file",
499 .type = QEMU_OPT_STRING,
501 .name = "tls-ciphers",
502 .type = QEMU_OPT_STRING,
504 .name = "tls-channel",
505 .type = QEMU_OPT_STRING,
507 .name = "plaintext-channel",
508 .type = QEMU_OPT_STRING,
510 .name = "image-compression",
511 .type = QEMU_OPT_STRING,
513 .name = "jpeg-wan-compression",
514 .type = QEMU_OPT_STRING,
516 .name = "zlib-glz-wan-compression",
517 .type = QEMU_OPT_STRING,
519 .name = "streaming-video",
520 .type = QEMU_OPT_STRING,
522 .name = "agent-mouse",
523 .type = QEMU_OPT_BOOL,
525 .name = "playback-compression",
526 .type = QEMU_OPT_BOOL,
528 { /* end of list */ }
532 QemuOptsList qemu_option_rom_opts = {
533 .name = "option-rom",
534 .implied_opt_name = "romfile",
535 .head = QTAILQ_HEAD_INITIALIZER(qemu_option_rom_opts.head),
536 .desc = {
538 .name = "bootindex",
539 .type = QEMU_OPT_NUMBER,
540 }, {
541 .name = "romfile",
542 .type = QEMU_OPT_STRING,
544 { /* end of list */ }
548 static QemuOptsList qemu_machine_opts = {
549 .name = "machine",
550 .implied_opt_name = "type",
551 .merge_lists = true,
552 .head = QTAILQ_HEAD_INITIALIZER(qemu_machine_opts.head),
553 .desc = {
555 .name = "type",
556 .type = QEMU_OPT_STRING,
557 .help = "emulated machine"
558 }, {
559 .name = "accel",
560 .type = QEMU_OPT_STRING,
561 .help = "accelerator list",
562 }, {
563 .name = "kernel_irqchip",
564 .type = QEMU_OPT_BOOL,
565 .help = "use KVM in-kernel irqchip",
566 }, {
567 .name = "kvm_shadow_mem",
568 .type = QEMU_OPT_SIZE,
569 .help = "KVM shadow MMU size",
570 }, {
571 .name = "kernel",
572 .type = QEMU_OPT_STRING,
573 .help = "Linux kernel image file",
574 }, {
575 .name = "initrd",
576 .type = QEMU_OPT_STRING,
577 .help = "Linux initial ramdisk file",
578 }, {
579 .name = "append",
580 .type = QEMU_OPT_STRING,
581 .help = "Linux kernel command line",
582 }, {
583 .name = "dtb",
584 .type = QEMU_OPT_STRING,
585 .help = "Linux kernel device tree file",
586 }, {
587 .name = "dumpdtb",
588 .type = QEMU_OPT_STRING,
589 .help = "Dump current dtb to a file and quit",
590 }, {
591 .name = "phandle_start",
592 .type = QEMU_OPT_STRING,
593 .help = "The first phandle ID we may generate dynamically",
594 }, {
595 .name = "dt_compatible",
596 .type = QEMU_OPT_STRING,
597 .help = "Overrides the \"compatible\" property of the dt root node",
599 { /* End of list */ }
603 QemuOptsList qemu_boot_opts = {
604 .name = "boot-opts",
605 .head = QTAILQ_HEAD_INITIALIZER(qemu_boot_opts.head),
606 .desc = {
607 /* the three names below are not used now */
609 .name = "order",
610 .type = QEMU_OPT_STRING,
611 }, {
612 .name = "once",
613 .type = QEMU_OPT_STRING,
614 }, {
615 .name = "menu",
616 .type = QEMU_OPT_STRING,
617 /* following are really used */
618 }, {
619 .name = "splash",
620 .type = QEMU_OPT_STRING,
621 }, {
622 .name = "splash-time",
623 .type = QEMU_OPT_STRING,
625 { /*End of list */ }
629 static QemuOptsList *vm_config_groups[32] = {
630 &qemu_drive_opts,
631 &qemu_chardev_opts,
632 &qemu_device_opts,
633 &qemu_netdev_opts,
634 &qemu_net_opts,
635 &qemu_rtc_opts,
636 &qemu_global_opts,
637 &qemu_mon_opts,
638 &qemu_cpudef_opts,
639 &qemu_trace_opts,
640 &qemu_option_rom_opts,
641 &qemu_machine_opts,
642 &qemu_boot_opts,
643 &qemu_iscsi_opts,
644 NULL,
647 static QemuOptsList *find_list(QemuOptsList **lists, const char *group,
648 Error **errp)
650 int i;
652 for (i = 0; lists[i] != NULL; i++) {
653 if (strcmp(lists[i]->name, group) == 0)
654 break;
656 if (lists[i] == NULL) {
657 error_set(errp, QERR_INVALID_OPTION_GROUP, group);
659 return lists[i];
662 QemuOptsList *qemu_find_opts(const char *group)
664 QemuOptsList *ret;
665 Error *local_err = NULL;
667 ret = find_list(vm_config_groups, group, &local_err);
668 if (error_is_set(&local_err)) {
669 error_report("%s\n", error_get_pretty(local_err));
670 error_free(local_err);
673 return ret;
676 QemuOptsList *qemu_find_opts_err(const char *group, Error **errp)
678 return find_list(vm_config_groups, group, errp);
681 void qemu_add_opts(QemuOptsList *list)
683 int entries, i;
685 entries = ARRAY_SIZE(vm_config_groups);
686 entries--; /* keep list NULL terminated */
687 for (i = 0; i < entries; i++) {
688 if (vm_config_groups[i] == NULL) {
689 vm_config_groups[i] = list;
690 return;
693 fprintf(stderr, "ran out of space in vm_config_groups");
694 abort();
697 int qemu_set_option(const char *str)
699 char group[64], id[64], arg[64];
700 QemuOptsList *list;
701 QemuOpts *opts;
702 int rc, offset;
704 rc = sscanf(str, "%63[^.].%63[^.].%63[^=]%n", group, id, arg, &offset);
705 if (rc < 3 || str[offset] != '=') {
706 error_report("can't parse: \"%s\"", str);
707 return -1;
710 list = qemu_find_opts(group);
711 if (list == NULL) {
712 return -1;
715 opts = qemu_opts_find(list, id);
716 if (!opts) {
717 error_report("there is no %s \"%s\" defined",
718 list->name, id);
719 return -1;
722 if (qemu_opt_set(opts, arg, str+offset+1) == -1) {
723 return -1;
725 return 0;
728 int qemu_global_option(const char *str)
730 char driver[64], property[64];
731 QemuOpts *opts;
732 int rc, offset;
734 rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
735 if (rc < 2 || str[offset] != '=') {
736 error_report("can't parse: \"%s\"", str);
737 return -1;
740 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, NULL);
741 qemu_opt_set(opts, "driver", driver);
742 qemu_opt_set(opts, "property", property);
743 qemu_opt_set(opts, "value", str+offset+1);
744 return 0;
747 struct ConfigWriteData {
748 QemuOptsList *list;
749 FILE *fp;
752 static int config_write_opt(const char *name, const char *value, void *opaque)
754 struct ConfigWriteData *data = opaque;
756 fprintf(data->fp, " %s = \"%s\"\n", name, value);
757 return 0;
760 static int config_write_opts(QemuOpts *opts, void *opaque)
762 struct ConfigWriteData *data = opaque;
763 const char *id = qemu_opts_id(opts);
765 if (id) {
766 fprintf(data->fp, "[%s \"%s\"]\n", data->list->name, id);
767 } else {
768 fprintf(data->fp, "[%s]\n", data->list->name);
770 qemu_opt_foreach(opts, config_write_opt, data, 0);
771 fprintf(data->fp, "\n");
772 return 0;
775 void qemu_config_write(FILE *fp)
777 struct ConfigWriteData data = { .fp = fp };
778 QemuOptsList **lists = vm_config_groups;
779 int i;
781 fprintf(fp, "# qemu config file\n\n");
782 for (i = 0; lists[i] != NULL; i++) {
783 data.list = lists[i];
784 qemu_opts_foreach(data.list, config_write_opts, &data, 0);
788 int qemu_config_parse(FILE *fp, QemuOptsList **lists, const char *fname)
790 char line[1024], group[64], id[64], arg[64], value[1024];
791 Location loc;
792 QemuOptsList *list = NULL;
793 Error *local_err = NULL;
794 QemuOpts *opts = NULL;
795 int res = -1, lno = 0;
797 loc_push_none(&loc);
798 while (fgets(line, sizeof(line), fp) != NULL) {
799 loc_set_file(fname, ++lno);
800 if (line[0] == '\n') {
801 /* skip empty lines */
802 continue;
804 if (line[0] == '#') {
805 /* comment */
806 continue;
808 if (sscanf(line, "[%63s \"%63[^\"]\"]", group, id) == 2) {
809 /* group with id */
810 list = find_list(lists, group, &local_err);
811 if (error_is_set(&local_err)) {
812 error_report("%s\n", error_get_pretty(local_err));
813 error_free(local_err);
814 goto out;
816 opts = qemu_opts_create(list, id, 1, NULL);
817 continue;
819 if (sscanf(line, "[%63[^]]]", group) == 1) {
820 /* group without id */
821 list = find_list(lists, group, &local_err);
822 if (error_is_set(&local_err)) {
823 error_report("%s\n", error_get_pretty(local_err));
824 error_free(local_err);
825 goto out;
827 opts = qemu_opts_create(list, NULL, 0, NULL);
828 continue;
830 if (sscanf(line, " %63s = \"%1023[^\"]\"", arg, value) == 2) {
831 /* arg = value */
832 if (opts == NULL) {
833 error_report("no group defined");
834 goto out;
836 if (qemu_opt_set(opts, arg, value) != 0) {
837 goto out;
839 continue;
841 error_report("parse error");
842 goto out;
844 if (ferror(fp)) {
845 error_report("error reading file");
846 goto out;
848 res = 0;
849 out:
850 loc_pop(&loc);
851 return res;
854 int qemu_read_config_file(const char *filename)
856 FILE *f = fopen(filename, "r");
857 int ret;
859 if (f == NULL) {
860 return -errno;
863 ret = qemu_config_parse(f, vm_config_groups, filename);
864 fclose(f);
866 if (ret == 0) {
867 return 0;
868 } else {
869 return -EINVAL;