1=head1 NAME
2
3xlcpupool.cfg - XL Cpupool Configuration File Syntax
4
5=head1 SYNOPSIS
6
7 /etc/xen/xlcpupool
8
9=head1 DESCRIPTION
10
11To create a Cpupool with xl requires the provision of a cpupool config
12file.  Typically these live in `/etc/xen/CPUPOOL.cfg` where CPUPOOL is
13the name of the cpupool.
14
15=head1 SYNTAX
16
17A cpupool config file consists of a series of C<KEY=VALUE> pairs.
18
19A value C<VALUE> is one of:
20
21=over 4
22
23=item B<"STRING">
24
25A string, surrounded by either single or double quotes.
26
27=item B<NUMBER>
28
29A number, in either decimal, octal (using a C<0> prefix) or
30hexadecimal (using an C<0x> prefix).
31
32=item B<[ VALUE, VALUE, ... ]>
33
34A list of C<VALUES> of the above types. Lists are homogeneous and are
35not nested.
36
37=back
38
39The semantics of each C<KEY> defines which form of C<VALUE> is required.
40
41=head1 OPTIONS
42
43=head2 Mandatory Configuration Items
44
45The following key is mandatory for any cpupool:
46
47=over 4
48
49=item B<name="NAME">
50
51Specifies the name of the cpupool.  Names of cpupools existing on a
52single host must be unique.
53
54=back
55
56=head2 Optional Configuration Items
57
58The following options apply to guests of any type.
59
60=over 4
61
62=item B<sched="SCHED">
63
64Specifies the scheduler which is used for the cpupool. Valid
65values for C<SCHED> are:
66
67=over 4
68
69=item B<credit>
70
71the credit scheduler
72
73=item B<credit2>
74
75the credit2 scheduler
76
77=item B<rtds>
78
79the RTDS scheduler
80
81=back
82
83The default scheduler is the one used for C<Pool-0> specified as
84boot parameter of the hypervisor.
85
86=item B<nodes="NODES">
87
88Specifies the cpus of the NUMA-nodes given in C<NODES> (an integer or
89a list of integers) to be member of the cpupool. The free cpus in the
90specified nodes are allocated in the new cpupool.
91
92=item B<cpus="CPU-LIST">
93
94Specifies the cpus that will be member of the cpupool. All the specified
95cpus must be free, or creation will fail. C<CPU-LIST> may be specified
96as follows:
97
98=over 4
99
100=item ["2", "3", "5"]
101
102means that cpus 2,3,5 will be member of the cpupool.
103
104=item "0-3,5,^1"
105
106means that cpus 0,2,3 and 5 will be member of the cpupool. A "node:" or
107"nodes:" modifier can be used. E.g., "0,node:1,nodes:2-3,^10-13" means
108that pcpus 0, plus all the cpus of NUMA nodes 1,2,3 with the exception
109of cpus 10,11,12,13 will be memeber of the cpupool.
110
111=back
112
113If neither B<nodes> nor B<cpus> are specified only the first free cpu
114found will be allocated in the new cpupool.
115
116=back
117
118=head1 FILES
119
120F</etc/xen/CPUPOOL.cfg>
121
122=head1 BUGS
123
124This document is a work in progress and contains items which require
125further documentation and which are generally incomplete (marked with
126XXX).  However all options are included here whether or not they are
127fully documented.
128
129Patches to improve incomplete items (or any other item) would be
130gratefully received on the xen-devel@lists.xenproject.org mailing
131list. Please see L<https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches> for
132information on how to submit a patch to Xen.
133
134