This document covers the command line options which the Xen Hypervisor.
Most parameters take the form option=value
. Different options on
the command line should be space delimited. All options are case
sensitive, as are all values unless explicitly noted.
<boolean>
)All boolean option may be explicitly enabled using a value
of
yes
,on
,true
,enable
or1
They may be explicitly disabled using a value
of
no
,off
,false
,disable
or0
In addition, a boolean option may be enabled by simply stating its
name, and may be disabled by prefixing its name with no-
.
Enable noreboot mode
noreboot=true
Disable x2apic support (if present)
x2apic=off
Enable synchronous console mode
sync_console
Explicitly specifying any value other than those listed above is
undefined, as is stacking a no-
prefix with an explicit value.
<integer>
)An integer parameter will default to decimal and may be prefixed with
a -
for negative numbers. Alternatively, a hexadecimal number may be
used by prefixing the number with 0x
, or an octal number may be used
if a leading 0
is present.
Providing a string which does not validly convert to an integer is undefined.
<size>
)A size parameter may be any integer, with a size suffix
G
or g
: GiB (2^30)M
or m
: MiB (2^20)K
or k
: KiB (2^10)B
or b
: BytesWithout a size suffix, the default will be kilo. Providing a suffix other than those listed above is undefined.
Many parameters are more complicated and require more intricate configuration. The detailed description of each individual parameter specify which values are valid.
Some options take a comma separated list of values.
Some parameters act as combinations of the above, most commonly a mix of Boolean and String. These are noted in the relevant sections.
= force | ht | noirq | <boolean>
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 requires 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.
Because responsibility for ACPI processing is shared between Xen and the domain 0 kernel this option is automatically propagated to the domain 0 command line
= <integer>
Specify which ACPI MADT table to parse for APIC information, if more than one is present.
= <integer>
= <boolean>
Instruct Xen to ignore timer-interrupt override.
Because responsibility for ACPI processing is shared between Xen and the domain 0 kernel this option is automatically propagated to the domain 0 command line
= s3_bios | s3_mode
= <boolean>
Default:
true
Permit Xen to use superpages when performing memory management.
= 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
.
= <boolean>
Default:
false
Force boot on potentially unsafe systems. By default Xen will refuse to boot on systems with the following errata:
= verbose | debug
Increase the verbosity of the APIC code from the default value.
= <boolean>
Default:
true
Permit Xen to use "Always Running APIC Timer" support on compatible hardware in combination with cpuidle. This option is only expected to be useful for developers wishing Xen to fall back to older timing methods on newer hardware.
= <boolean>
Default:
false
Permits Xen to set up and use PCI Address Translation Services. This is a performance optimisation for PCI Passthrough.
WARNING: Xen cannot currently safely use ATS because of its synchronous wait loops for Queued Invalidation completions.
= <size>
Default:
0
(no limit)
Specify a maximum amount of available memory, to which Xen will clamp the e820 table.
= List of [ <integer> | <integer>-<integer> ]
Specify that certain pages, or certain ranges of pages contain bad
bytes and should not be used. For example, if your memory tester says
that byte 0x12345678
is bad, you would place badpage=0x12345
on
Xen's command line.
= <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.
= <size>
If set, override Xen's calculation of the level 2 cache line size.
= pit | hpet | acpi
If set, override Xen's default choice for the platform timer.
= <baud>[/<clock_hz>][,[DPS][,[<io-base>|pci|amt][,[<irq>][,[<port-bdf>][,[<bridge-bdf>]]]]]]
Both option com1
and com2
follow the same format.
<baud>
may be either an integer baud rate, or the string auto
if
the bootloader or other earlier firmware has already set it up.DPS
represents the number of data bits, the parity, and the number
of stop bits.
D
is an integer between 5 and 8 for the number of data bits.P
is a single character representing the type of parity:
n
Noo
Odde
Evenm
Marks
SpaceS
is an integer 1 or 2 for the number of stop bits.<io-base>
is an integer which specifies the IO base port for UART
registers.<irq>
is the IRQ number to use, or 0
to use the UART in poll
mode only.<port-bdf>
is the PCI location of the UART, in
<bus>:<device>.<function>
notation.<bridge-bdf>
is the PCI bridge behind which is the UART, in
<bus>:<device>.<function>
notation.pci
indicates that Xen should scan the PCI bus for the UART,
avoiding Intel AMT devices.amt
indicated that Xen should scan the PCI bus for the UART,
including Intel AMT devices if present.A typical setup for most situations might be com1=115200,8n1
= <size>
Default:
conring_size=16k
Specify the size of the console ring buffer.
= List of [ vga | com1[H,L] | com2[H,L] | dbgp | none ]
Default:
console=com1,vga
Specify which console(s) Xen should use.
vga
indicates that Xen should try and use the vga graphics adapter.
com1
and com2
indicates that Xen should use serial ports 1 and 2
respectively. Optionally, these arguments may be followed by an H
or
L
. H
indicates that transmitted characters will have their MSB
set, while received characters must have their MSB set. L
indicates
the converse; transmitted and received characters will have their MSB
cleared. This allows a single port to be shared by two subsystems
(e.g. console and debugger).
dbgp
indicates that Xen should use a USB debug port.
none
indicates that Xen should not use a console. This option only
makes sense on its own.
= <boolean>
Default:
false
Flag to indicate whether include a timestamp with each console line.
= <boolean>
Default:
false
Flag to indicate whether all guest console output should be copied into the console ring buffer.
= <switch char>[x]
Default
conswitch=a
Specify which character should be used to switch serial input between Xen and dom0. The required sequence is CTRL-<switch char> three times.
The optional trailing x
indicates that Xen should not automatically
switch the console input to dom0 during boot. Any other value,
including omission, causes Xen to automatically switch to the dom0
console during dom0 boot. Use conswitch=ax
to keep the default switch
character, but for xen to keep the console.
= arch_perfmon
If set, force use of the performance counters for oprofile, rather than detecting available support.
= dom0-kernel | none | xen
Default:
xen
Indicate where the responsibility for driving power states lies.
= 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.
= <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.
= <boolean>
= <boolean>
= <size>
Default:
4G
Specify the maximum address to allocate certain structures, if used in
combination with the low_crashinfo
command line option.
= <ramsize-range>:<size>[,...][@<offset>]
= <integer>
= <integer>
= <integer>
= ehci[ <integer> | @pci<bus>:<slot>.<func> ]
Specify the USB controller to use, either by instance number (when going over the PCI busses sequentially) or by PCI device (must be on segment 0).
= <integer>
Default:
20
Limits the number lines printed in Xen stack traces.
= <integer>
Default:
128
Specify the size of the console debug trace buffer in KiB. The debug trace feature is only enabled in debugging builds of Xen.
= <integer>
Specify the bit width of the DMA heap.
= List of <hex>-<hex>
Specify a list of IO ports to be excluded from dom0 access.
Either:
= <integer>
.
The number of VCPUs to give to dom0. This number of VCPUs can be more than the number of PCPUs on the host. The default is the number of PCPUs.
Or:
= <min>-<max>
where<min>
and<max>
are integers.
Gives dom0 a number of VCPUs equal to the number of PCPUs, but always
at least <min>
and no more than <max>
. Using <min>
may give
more VCPUs than PCPUs. <min>
or <max>
may be omitted and the
defaults of 1 and unlimited respectively are used instead.
For example, with dom0_max_vcpus=4-8
:
Number of
PCPUs | Dom0 VCPUs 2 | 4 4 | 4 6 | 6 8 | 8 10 | 8
= List of ( min:<size> | max:<size> | <size> )
Set the amount of memory for the initial domain (dom0). If a size is positive, it represents an absolute value. If a size is negative, it is subtracted from the total available memory.
<size>
specifies the exact amount of memory.min:<size>
specifies the minimum amount of memory.max:<size>
specifies the maximum amount of memory.If <size>
is not specified, the default is all the available memory
minus some reserve. The reserve is 1/16 of the available memory or
128 MB (whichever is smaller).
The amount of memory will be at least the minimum but never more than
the maximum (i.e., max
overrides the min
option). If there isn't
enough memory then as much as possible is allocated.
max:<size>
also sets the maximum reservation (the maximum amount of
memory dom0 can balloon up to). If this is omitted then the maximum
reservation is unlimited.
For example, to set dom0's initial memory allocation to 512MB but
allow it to balloon up as far as 1GB use dom0_mem=512M,max:1G
If you use this option then it is highly recommended that you disable any dom0 autoballooning feature present in your toolstack. See the xl.conf(5) man page or Xen Best Practices.
= <boolean>
= <boolean>
Default:
false
Pin dom0 vcpus to their respective pcpus
= <boolean>
Flag that specifies if RAM should be clipped to the highest cacheable MTRR.
Default:
true
on Intel CPUs, otherwisefalse
= <boolean>
Default:
false
Flag that enables verbose output when processing e820 information and applying clipping.
= off | on | skipmbr
Control retrieval of Extended Disc Data (EDD) from the BIOS during boot.
= no | force
Either force retrieval of monitor EDID information via VESA DDC, or disable it (edid=no). This option should not normally be required except for debugging purposes.
= List of [ rs | attr ]
All options are of boolean kind and can be prefixed with no-
to
effect the inverse meaning.
rs
Default:
true
Force or disable use of EFI runtime services.
attr=uc
Default:
off
Allows mapping of RuntimeServices which have no cachability attribute set as UC.
= [<domU number>][,<dom0 number>]
Default:
32,256
Change the number of PIRQs available for guests. The optional first number is
common for all domUs, while the optional second number (preceded by a comma)
is for dom0. Changing the setting for domU has no impact on dom0 and vice
versa. For example to change dom0 without changing domU, use
extra_guest_irqs=,512
= <integer>
= <integer>
= <height>
where height is8x8 | 8x14 | 8x16 '
Specify the font size when using the VESA console driver.
= <baud>[/<clock_hz>][,DPS[,<io-base>[,<irq>[,<port-bdf>[,<bridge-bdf>]]]] | pci | amt ]
Specify the serial parameters for the GDB stub.
= <integer>
Specify the maximum number of frames per grant table operation.
= <level>[/<rate-limited level>]
where level isnone | error | warning | info | debug | all
Default:
guest_loglvl=none/warning
Set the logging level for Xen guests. Any log message with equal more more importance will be printed.
The optional <rate-limited level>
option instructs which severities
should be rate limited.
= <boolean>
Default:
true
Flag to globally enable or disable support for Hardware Assisted Paging (HAP)
= <boolean>
Default:
true
Flag to enable 1 GB host page table support for Hardware Assisted Paging (HAP).
= <boolean>
Default:
true
Flag to enable 2 MB host page table support for Hardware Assisted Paging (HAP).
= <boolean>
= <integer>
= <boolean>
= <size>
Specify the memory boundary past which memory will be treated as highmem (x86 debug hypervisor only).
= <integer>
= <boolean>
= <integer>
<hpet>
]
=[<seg>:]<bus>:<device>.<func>
Force the use of [<seg>:]<bus>:<device>.<func>
as device ID of HPET
<hpet>
instead of the one specified by the IVHD sub-tables of the IVRS
ACPI table.
<ioapic>
]
=[<seg>:]<bus>:<device>.<func>
Force the use of [<seg>:]<bus>:<device>.<func>
as device ID of IO-APIC
<ioapic>
instead of the one specified by the IVHD sub-tables of the IVRS
ACPI table.
Force the use of use of the local APIC on a uniprocessor system, even if left disabled by the BIOS. This option will accept any value at all.
= <boolean>
= <boolean>
= <level>[/<rate-limited level>]
where level isnone | error | warning | info | debug | all
Default:
loglvl=warning
Set the logging level for Xen. Any log message with equal more more importance will be printed.
The optional <rate-limited level>
option instructs which severities
should be rate limited.
= none | min | all
Default:
none
if not specified at all, or tomin
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.
= [<domU>][,[<ctldom>][,[<hwdom>][,<ptdom>]]]
x86 default:
9,18,12,12
ARM default:9,18,10,10
Change the maximum order permitted for allocation (or allocation-like) requests issued by the various kinds of domains (in this order: ordinary DomU, control domain, hardware domain, and - when supported by the platform - DomU with pass-through device assigned).
= <integer>
= <integer>
= <integer>
= <integer>
= <integer>
= verbose
Specify verbose machine check output.
= <size>
Specify the maximum address of physical RAM. Any RAM beyond this limit is ignored by Xen.
= <boolean>[,amd-fam10]
Default:
1
Specify if the MMConfig space should be enabled.
= <boolean> | all
Default:
false
By default, domains may not create cached mappings to MMIO regions.
This option relaxes the check for Domain 0 (or when using all
, all PV
domains), to permit the use of cacheable MMIO mappings.
= <boolean>
Default:
true
Force Xen to (not) use PCI-MSI, even if ACPI FADT says otherwise.
= <boolean>
Default:
true
Use the MWAIT idle driver (with model specific C-state knowledge) instead of the ACPI based one.
= ignore | dom0 | fatal
Default:
nmi=fatal
Specify what Xen should do in the event of an NMI parity or I/O error.
ignore
discards the error; dom0
causes Xen to report the error to
dom0, while 'fatal' causes Xen to print diagnostics and then hang.
Instruct Xen to ignore any IOAPICs that are present in the system, and instead continue to use the legacy PIC. This is not recommended with pvops type kernels.
Because responsibility for APIC setup is shared between Xen and the domain 0 kernel this option is automatically propagated to the domain 0 command line.
= <boolean>
= <boolean>
Disable software IRQ balancing and affinity. This can be used on systems such as Dell 1850/2850 that have workarounds in hardware for IRQ routing issues.
= <boolean>
Default:
false
Ignore the local APIC on a uniprocessor system, even if enabled by the BIOS. This option will accept value.
= <boolean>
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.
= <boolean>
Do not automatically reboot after an error. This is useful for catching debug output. Defaults to automatically reboot after 5 seconds.
= <boolean>
Disable CPU serial number reporting.
= <boolean>
Disable SMP support. No secondary processors will be booted. Defaults to booting secondary processors.
= <integer>
= on | off | fake=<integer> | noacpi
Default: on
= {no-}serr | {no-}perr
Disable signaling of SERR (system errors) and/or PERR (parity errors) on all PCI devices.
Default: Signaling left as set by firmware.
=[<seg>:]<bus>:<device>,<stride>
Mark a group of PCI devices as using phantom functions without actually advertising so, so the IOMMU can create translation contexts for them.
All numbers specified must be hexadecimal ones.
This option can be specified more than once (up to 8 times at present).
= <integer>
= <integer>
= t[riple] | k[bd] | a[cpi] | p[ci] | e[fi] | n[o] [, [w]arm | [c]old]
Default: 0
Specify the host reboot method.
warm
instructs Xen to not set the cold reboot flag.
cold
instructs Xen to set the cold reboot flag.
triple
instructs Xen to reboot the host by causing a triple fault.
kbd
instructs Xen to reboot the host via the keyboard controller.
acpi
instructs Xen to reboot the host using RESET_REG in the ACPI FADT.
pci
instructs Xen to reboot the host using PCI reset register (port CF9).
'efi' instructs Xen to reboot using the EFI reboot call (in EFI mode by default it will use that method first).
= credit | credit2 | sedf | arinc653
Default:
sched=credit
Choose the default scheduler.
= <integer>
= <integer>
Set the timeslice of the credit1 scheduler, in milliseconds. The default is 30ms. Reasonable values may include 10, 5, or even 1 for very latency-sensitive workloads.
= <integer>
In order to limit the rate of context switching, set the minimum amount of time that a vcpu can be scheduled for before preempting it, in microseconds. The default is 1000us (1ms). Setting this to 0 disables it altogether.
= <boolean>
Normally Xen will try to maximize performance and cache utilization by spreading out vcpus across as many different divisions as possible (i.e, numa nodes, sockets, cores threads, &c). This often maximizes throughput, but also maximizes energy usage, since it reduces the depth to which a processor can sleep.
This option inverts the logic, so that the scheduler in effect tries to keep the vcpus on the smallest amount of silicon possible; i.e., first fill up sibling threads, then sibling cores, then sibling sockets, &c. This will reduce performance somewhat, particularly on systems with hyperthreading enabled, but should reduce power by enabling more sockets and cores to go into deeper sleep states.
= <size>
Default:
16kB
Set the serial transmit buffer size.
= <boolean>
Default:
true
Flag to enable Supervisor Mode Execution Protection
= <boolean>
= <boolean>
Default:
false
Flag to force synchronous console output. Useful for debugging, but not suitable for production environments due to incurred overhead.
= 0x<phys_addr>
Specify the physical address of the trusted boot shared page.
= <integer>
Specify the per-cpu trace buffer size in pages.
= <boolean>
Default:
true
Flag to enable TSC deadline as the APIC timer mode.
= <integer>
Specify a mask for Xen event tracing. This allows Xen tracing to be enabled at boot. Refer to the xentrace(8) documentation for a list of valid event mask values. In order to enable tracing, a buffer size (in pages) must also be specified via the tbuf_size parameter.
= <boolean>
= <integer>
= <boolean>
= <boolean>
= <boolean>
= <integer>
= <boolean>
= <integer>
= unstable | skewed
= [<integer> | scan]
Specify how and where to find CPU microcode update blob.
'integer' specifies the CPU microcode update blob module index. When positive,
this specifies the n-th module (in the GrUB entry, zero based) to be used
for updating CPU micrcode. When negative, counting starts at the end of
the modules in the GrUB entry (so with the blob commonly being last,
one could specify ucode=-1
). Note that the value of zero is not valid
here (entry zero, i.e. the first module, is always the Dom0 kernel
image). Note further that use of this option has an unspecified effect
when used with xen.efi (there the concept of modules doesn't exist, and
the blob gets specified via the ucode=<filename>
config file/section
entry; see EFI configuration file description).
'scan' instructs the hypervisor to scan the multiboot images for an cpio image that contains microcode. Depending on the platform the blob with the microcode in the cpio name space must be: - on Intel: kernel/x86/microcode/GenuineIntel.bin - on AMD : kernel/x86/microcode/AuthenticAMD.bin
= <boolean>
= <integer>
Default:
0
Specify a delay, in microseconds, between migrations of a VCPU between PCPUs when using the credit1 scheduler. This prevents rapid fluttering of a VCPU between CPUs, and reduces the implicit overheads such as cache-warming. 1ms (1000) has been measured as a good value.
= <integer>
= <integer>
= <integer>
= ( ask | current | text-80x<rows> | gfx-<width>x<height>x<depth> | mode-<mode> )[,keep]
ask
causes Xen to display a menu of available modes and request the
user to choose one of them.
current
causes Xen to use the graphics adapter in its current state,
without further setup.
text-80x<rows>
instructs Xen to set up text mode. Valid values for
<rows>
are 25, 28, 30, 34, 43, 50, 80
gfx-<width>x<height>x<depth>
instructs Xen to set up graphics mode
with the specified width, height and depth.
mode-<mode>
instructs Xen to use a specific mode, as shown with the
ask
option. (N.B menu modes are displayed in hex, so <mode>
should be a hexadecimal number)
The optional keep
parameter causes Xen to continue using the vga
console even after dom0 has been started. The default behaviour is to
relinquish control to dom0.
= <boolean>
Default:
true
Use Virtual Processor ID support if available. This prevents the need for TLB flushes on VM entry and exit, increasing performance.
= ( bts )
Default:
off
Switch on the virtualized performance monitoring unit for HVM guests.
If the current cpu isn't supported a message like
'VPMU: Initialization failed. ...'
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()).
If 'vpmu=bts' is specified the virtualisation of the Branch Trace Store (BTS) feature is switched on on Intel processors supporting this feature.
Note that if watchdog option is also specified vpmu will be turned off.
Warning: As the virtualisation is not 100% safe, don't use the vpmu flag on production systems (see Xen Security Advisory 163, http://xenbits.xen.org/xsa/advisory-163.html)!
= force | <boolean>
Default:
false
Run an NMI watchdog on each processor. If a processor is stuck for
longer than the watchdog_timeout, a panic occurs. When force
is
specified, in addition to running an NMI watchdog on each processor,
unknown NMIs will still be processed.
= <integer>
Default:
5
Set the NMI watchdog timeout in seconds. Specifying 0
will turn off
the watchdog.
= <boolean>
Default:
true
Permit use of x2apic setup for SMP environments.
= <boolean>
Default:
true
if FADT mandates physical mode,false
otherwise.
In the case that x2apic is in use, this option switches between physical and clustered mode. The default, given no hint from the FADT, is cluster mode.
= <boolean>
Default:
true
Permit use of the xsave/xrstor
instructions.