Some more work for the Xen command line documentation, submitted now to avoid duplicate work on the Xen Docs day. ~Andrew
Andrew Cooper
2012-Jul-20 12:05 UTC
[PATCH 1 of 3] docs/cmdline: Tweak some markdown formatting
Some for readability, and some to escape underscores. Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com> diff -r 9950f2dc2ee6 -r 751e402a1aaf docs/misc/xen-command-line.markdown --- a/docs/misc/xen-command-line.markdown +++ b/docs/misc/xen-command-line.markdown @@ -75,7 +75,7 @@ of Boolean and String. These are noted **String**, or **Boolean** to disable. -The `acpi` option is used to control a set of four related boolean +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 @@ -399,13 +399,13 @@ should be rate limited. ### low\_crashinfo > `= none | min | all` -> Default: `none` if not specified at all, or to `min` if `low\_crashinfo` is present without qualification. +> Default: `none` if not specified at all, or to `min` if **low_crashinfo** is present without qualification. This option is only useful for hosts with a 32bit dom0 kernel, wishing to use kexec functionality in the case of a crash. It represents which data structures should be deliberately allocated in low memory, so the crash kernel may find find them. Should be used in combination -with `crashinfo_maxaddr`. +with **crashinfo_maxaddr**. ### max\_cstate ### max\_gsi\_irqs @@ -457,7 +457,7 @@ BIOS. This option will accept value. Do not execute real-mode bootstrap code when booting Xen. This option should not be used except for debugging. It will effectively disable -the vga option, which relies on real mode to set the video mode. +the **vga** option, which relies on real mode to set the video mode. ### noreboot > `= <boolean>` @@ -566,7 +566,7 @@ If the current cpu isn''t supported a mes is printed on the hypervisor serial log. For some Intel Nehalem processors a quirk handling exist for an unknown -wrong behaviour (see handle_pmc_quirk()). +wrong behaviour (see handle\_pmc\_quirk()). If ''vpmu=bts'' is specified the virtualisation of the Branch Trace Store (BTS) feature is switched on on Intel processors supporting this feature. @@ -583,7 +583,7 @@ don''t use the vpmu flag on production sy > Default: `false` Run an NMI watchdog on each processor. If a processor is stuck for -longer than the watchdog\_timeout, a panic occurs. +longer than the **watchdog\_timeout**, a panic occurs. ### watchdog\_timeout > `= <integer>`
Andrew Cooper
2012-Jul-20 12:05 UTC
[PATCH 2 of 3] docs/cmdline: Remove ia64 specific arguments
grep claims that all of these command line arguments no longer exist in the xen source tree. Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com> diff -r 751e402a1aaf -r 2ed554fcf226 docs/misc/xen-command-line.markdown --- a/docs/misc/xen-command-line.markdown +++ b/docs/misc/xen-command-line.markdown @@ -117,7 +117,6 @@ the domain 0 kernel this option is autom domain 0 command line ### acpi\_sleep -### additional\_cpus ### allowsuperpage ### apic > `= summit | bigsmp | default` @@ -249,7 +248,6 @@ switch the console input to dom0 during including omission, causes Xen to automatically switch to the dom0 console during dom0 boot. -### contig\_mem ### cpu\_type ### cpufreq ### cpuid\_mask\_cpu @@ -273,7 +271,6 @@ combination with the `low_crashinfo` com ### credit2\_balance\_under ### credit2\_load\_window\_shift ### debug\_stack\_lines -### debug\_stack\_lines ### debugtrace ### dma\_bits > `= <integer>` @@ -287,12 +284,7 @@ Specify the bit width of the DMA heap. Specify the maximum number of vcpus to give to dom0. This defaults to the number of pcpus on the host. -### dom0\_mem (ia64) -> `= <size>` - -Specify the total size for dom0. - -### dom0\_mem (x86) +### dom0\_mem > `= List of ( min:<size> | max:<size> | <size> )` Set the amount of memory for the initial domain (dom0). If a size is @@ -410,7 +402,6 @@ with **crashinfo_maxaddr**. ### max\_cstate ### max\_gsi\_irqs ### maxcpus -### maxcpus ### mce ### mce\_fb ### mce\_verbosity @@ -575,8 +566,6 @@ feature is switched on on Intel processo As the BTS virtualisation is not 100% safe and because of the nehalem quirk don''t use the vpmu flag on production systems with Intel cpus! -### vti\_vhpt\_size -### vti\_vtlb\_size ### watchdog > `= <boolean>` @@ -595,6 +584,4 @@ the watchdog. ### x2apic ### x2apic\_phys -### xencons -### xencons\_poll ### xsave
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
diff -r 2ed554fcf226 -r 9887e73fd5dc docs/misc/xen-command-line.markdown
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -118,6 +118,12 @@ domain 0 command line
### acpi\_sleep
### allowsuperpage
+> `= <boolean>`
+
+> Default: `true`
+
+Permit Xen to use superpages when performing memory management.
+
### apic
> `= summit | bigsmp | default`
@@ -128,6 +134,8 @@ there are more than 8 CPUs, Xen will swi
### allow\_unsafe
> `= <boolean>`
+> Default: `false`
+
Force boot on potentially unsafe systems. By default Xen will refuse to boot on
systems with the following errata:
@@ -141,7 +149,20 @@ systems with the following errata:
Increase the verbosity of the APIC code from the default value.
### ats
+> `= <boolean>`
+
+> Default: `true`
+
+Permits Xen to set up and use PCI Address Translation Services, which is
required
+for PCI Passthrough.
+
### availmem
+> `= <size>`
+
+> Default: `0` (no limit)
+
+Specify a maximum amount of available memory, to which Xen will clamp the e820
table.
+
### badpage
> `= List of [ <integer> | <integer>-<integer> ]`
@@ -151,8 +172,23 @@ that byte `0x12345678` is bad, you would
Xen''s command line.
### bootscrub
+> `= <boolean>`
+
+> Default: `true`
+
+Scrub free RAM during boot. This is a safety feature to prevent accidentally
leaking
+sensitive VM data into other VMs if Xen crashes and reboots.
+
### cachesize
+> `= <size>`
+
+If set, override Xen''s calculation of the level 2 cache line size.
+
### clocksource
+> `= pit | hpet | cyclone | acpi`
+
+If set, override Xen''s default choice for the platform timer.
+
### com1,com2
> `=
<baud>[/<clock_hz>][,DPS[,<io-base>[,<irq>[,<port-bdf>[,<bridge-bdf>]]]]
| pci | amt ] `
@@ -249,13 +285,38 @@ including omission, causes Xen to automa
console during dom0 boot.
### cpu\_type
+> `= arch_perfmon`
+
+If set, force use of the performance counters for oprofile, rather than
detecting
+available support.
+
### cpufreq
-### cpuid\_mask\_cpu
-### cpuid\_mask\_ecx
-### cpuid\_mask\_edx
-### cpuid\_mask\_ext\_ecx
-### cpuid\_mask\_ext\_edx
-### cpuid\_mask\_xsave\_eax
+> `= dom0-kernel | none | xen`
+
+> Default: `xen`
+
+Indicate where the responsibility for driving power states lies.
+
+### cpuid\_mask\_cpu (AMD only)
+> `= fam_0f_rev_c | fam_0f_rev_d | fam_0f_rev_e | fam_0f_rev_f |
fam_0f_rev_g | fam_10_rev_b | fam_10_rev_c | fam_11_rev_b`
+
+If the other **cpuid\_mask\_{,ext\_}e{c,d}x** options are fully set
(unspecified
+on the command line), specify a pre-canned cpuid mask to mask the current
+processor down to appear as the specified processor. It is important to ensure
+that all hosts in a pool appear the same to guests to allow successful live
+migration.
+
+### cpuid\_mask\_ ecx,edx,ext\_ecx,ext\_edx,xsave_eax
+> `= <integer>`
+
+> Default: `~0` (all bits set)
+
+These five command line parameters are used to specify cpuid masks to help with
+cpuid levelling across a pool of hosts. Setting a bit in the mask indicates
that
+the feature should be enabled, while clearing a bit in the mask indicates that
+the feature should be disabled. It is important to ensure that all hosts in a
+pool appear the same to guests to allow successful live migration.
+
### cpuidle
### cpuinfo
### crashinfo_maxaddr
@@ -485,7 +546,9 @@ Choose the default scheduler.
### serial\_tx\_buffer
> `= <size>`
-Set the serial transmit buffer size. Defaults to 16kB.
+> Default: `16kB`
+
+Set the serial transmit buffer size.
### smep
### snb\_igd\_quirk
@@ -543,7 +606,13 @@ The optional `keep` parameter causes Xen
console even after dom0 has been started. The default behaviour is to
relinquish control to dom0.
-### vpid
+### vpid (Intel)
+> `= <boolean>`
+
+> Default: `true`
+
+Use Virtual Processor ID support if available. This prevents the need for TLB
+flushes on VM entry and exit, increasing performance.
### vpmu
> `= ( bts )`
@@ -583,5 +652,22 @@ Set the NMI watchdog timeout in seconds.
the watchdog.
### x2apic
+> `= <boolean>`
+
+> Default: `true`
+
+Permit use of x2apic setup for SMP environments.
+
### x2apic\_phys
+> `= <boolean>`
+
+> Default: `true`
+
+Use the x2apic physical apic driver. The alternative is the x2apic cluster
driver.
+
### xsave
+> `= <boolean>`
+
+> Default: `true`
+
+Permit use of the `xsave/xrstor` instructions.
Andrew Cooper writes ("[Xen-devel] [PATCH 0 of 3]
docs/cmdline"):> Some more work for the Xen command line documentation, submitted now to
avoid
> duplicate work on the Xen Docs day.
All three
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>