# HG changeset patch # Parent a4d93d0e0df2fafe5b3e2dab3e34799498a875e2 DOCS: Initial document regarding Xen's command line parameters Still a work in progress, but submitted as a start. Signed-off-by: Andrew Cooper diff -r a4d93d0e0df2 docs/misc/xen-command-line.markdown --- /dev/null +++ b/docs/misc/xen-command-line.markdown @@ -0,0 +1,222 @@ +# Xen Hypervisor Command Line Options + +**This document is still a work in progress. There are currently some command line options listed twice, and they are defined in separate arch trees, and some options are currently separate from their legacy versions. Please remove this notice when complete.** + +This document coveres the command line options which the Xen Hypervisor. + +## Types of parameter + +Most parameters take the form `option=value`. Different options on the command line should be space delimited. + +### Boolean + +All boolean option may be explicitly enabled using a `value` of +> `yes`, `on`, `true`, `enable` or `1` + +They may be explicitly disabled using a `value` of +> `no`, `off`, `false`, `disable` or `0` + +In addition, a boolean option may be enabled by simply stating its name, and may be disabled by prefixing its name with `no-`. + +####Examples + +Enable noreboot mode +> `noreboot=true` + +Disable x2apic support (if present) +> `x2apic=off` + +Enable synchronous console mode +> `sync_console` + +### Integer + +An integer parameter will default to decimal and may be prefixed with a `-` for negative numbers. Alternativly, a hexidecimal number may be used by prefixing the number with `0x`, or an octal number may be used if a leading `0` is present. + +### Size + +A size parameter may be any integer, with a size suffix + +* `G` or `g`: Giga (2^30) +* `M` or `m`: Mega (2^20) +* `K` or `k`: Kilo (2^10) +* `B` or `b`: Bytes + +Without a size suffix, the default will be kilo. + +### String + +Many parameters are more complicated and require more intricate configuration. The detailed description of each individual paramter specify which values are valid. + +### Combination + +Some parameters act as combinations of the above, most commonly a mix of Boolean and String. These are noted in the relevant sections. + +## Parameter details + +### acpi +> `= force | ht | noirq | ` + +**String**, or **Boolean** to disable. + +The `acpi` option is used to control a set of four related boolean flags; `acpi_force`, `acpi_ht`, `acpi_noirq` and `acpi_disabled`. + +By default, Xen will scan the DMI data and blacklist certain systems which are known to have broken ACPI setups. Providing `acpi=force` will cause Xen to ignore the blacklist and attempt to use all ACPI features. + +Using `acpi=ht` causes Xen to parse the ACPI tables enough to enumerate all CPUs, but will not use other ACPI features. This is not common, and only has an effect if your system is blacklisted. + +The `acpi=noirq` option causes Xen to not parse the ACPI MADT table looking for IO-APIC entries. This is also not common, and any system which requries this option to function should be blacklisted. Additionally, this will not prevent Xen from finding IO-APIC entries from the MP tables. + +Finally, any of the boolean false options can be used to disable ACPI usage entirely. + +### acpi\_apic\_instance +> `= ` + +Specify which ACPI MADT table to parse for APIC information, if more than one is present. + +### acpi\_pstate\_strict +### acpi\_skip\_timer\_override +### acpi\_sleep +### additional\_cpus +### allowsuperpage +### apic +> `= summit | bigsmp | default` + +Override Xen's logic for choosing the APIC driver. By default, if there are more than 8 CPUs, Xen will switch to `bigsmp` over `default`. + +### apic\_verbosity +> `= verbose | debug` + +Increase the verbosity of the APIC code from the default value. + +### ats +### availmem +### badpage +### bootscrub +### cachesize +### clocksource +### com1 +### com2 +### conring\_size +### console +### console\_timestamps +### console\_to\_ring +### conswitch +### contig\_mem +### cpu\_type +### cpufreq +### cpuid\_mask\_cpu +### cpuid\_mask\_ecx +### cpuid\_mask\_edx +### cpuid\_mask\_ext\_ecx +### cpuid\_mask\_ext\_edx +### cpuid\_mask\_xsave\_eax +### cpuidle +### cpuinfo +### crashkernel +### credit2\_balance\_over +### credit2\_balance\_under +### credit2\_load\_window\_shift +### debug\_stack\_lines +### debug\_stack\_lines +### debugtrace +### dma\_bits +### dom0\_ioports\_disable +### dom0\_max\_vcpus +### dom0\_max\_vcpus +### dom0\_max\_vcpus +### dom0\_mem +### dom0\_mem +### dom0\_shadow +### dom0\_vcpus\_pin +### dom0\_vhpt\_size\_log2 +### dom\_rid\_bits +### e820-mtrr-clip +### e820-verbose +### efi\_print +### extra\_guest\_irqs +### flask\_enabled +### flask\_enforcing +### font +### gdb +### gnttab\_max\_nr\_frames +### guest\_loglvl +### hap\_1gb +### hap\_2mb +### hpetbroadcast +### hvm\_debug +### hvm\_port80 +### idle\_latency\_factor +### ioapic\_ack +### iommu +### iommu\_inclusive\_mapping +### irq\_ratelimit +### irq\_vector\_map +### lapic +### lapic\_timer\_c2\_ok +### ler +### loglvl +### max\_cstate +### max\_gsi\_irqs +### maxcpus +### maxcpus +### mce +### mce\_fb +### mce\_verbosity +### mem +### mmcfg +### nmi +### noapic +### nofxsr +### noirqbalance +### nolapic +### noreboot +### noserialnumber +### nosmp +### nosmp +### nr\_irqs +### numa +### pervcpu\_vhpt +### ple\_gap +### ple\_window +### reboot +### sched +### sched\_credit2\_migrate\_resist +### sched\_credit\_default\_yield +### sched\_credit\_tslice\_ms +### sched\_ratelimit\_us +### sched\_smt\_power\_savings +### serial\_tx\_buffer +### smep +### snb\_igd\_quirk +### sync\_console +### tboot +### tbuf\_size +### tdt +### tevt\_mask +### tickle\_one\_idle\_cpu +### timer\_slop +### tmem +### tmem\_compress +### tmem\_dedup +### tmem\_lock +### tmem\_shared\_auth +### tmem\_tze +### tsc +### ucode +### unrestricted\_guest +### vcpu\_migration\_delay +### vesa-map +### vesa-mtrr +### vesa-ram +### vga +### vpid +### vpmu +### vti\_vhpt\_size +### vti\_vtlb\_size +### watchdog +### x2apic +### x2apic\_phys +### xencons +### xencons\_poll +### xsave