Documentation added to xl command regarding usage of vnuma configuration options. Signed-off-by: Elena Ufimtseva <ufimtseva@gmail.com> --- docs/man/xl.cfg.pod.5 | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/docs/man/xl.cfg.pod.5 b/docs/man/xl.cfg.pod.5 index 278dba1..64072e6 100644 --- a/docs/man/xl.cfg.pod.5 +++ b/docs/man/xl.cfg.pod.5 @@ -216,6 +216,53 @@ if the values of B<memory=> and B<maxmem=> differ. A "pre-ballooned" HVM guest needs a balloon driver, without a balloon driver it will crash. +=item B<vnuma_nodes=N> + +Number of vNUMA nodes the guest will be initialized with on boot. In general case, +this is the only required option. If only this option is given, all other +vNUMA topology parameters will be taken as default. + +=item B<vnuma_mem=[vmem1, vmem2, ...]> + +The vnode memory sizes defined in MBytes. If the sum of all vnode memories +does not match the domain memory, the total memory will be equally split between +vnodes. +Example: vnuma_mem=[1024, 1024, 2048, 2048] + +=item B<vdistance=[d1, d2, ... ,dn]> + +Defines the distance table for vNUMA nodes. Distance for NUMA machines usually + represented by two dimensional array and all distance may be spcified in one +line here, by rows. In short, distance can be specified as two numbers [d1, d2], +where d1 is same node distance, d2 is a value for all other distances. +If vdistance was specified with errors, the defaul distance in use, e.g. [10, 20]. + +Examples: +vdistance=[10, 20, 20, 10] - 2 vnodes; +vdistance=[10, 20] - any number of nodes; + +=item B<vnuma_vcpumap="vnode1, vnode2, ..."> + +Defines vcpu to vnode mapping as a string of integers, representing node +numbers. If not defined, the vcpus are interleaved over the virtual nodes. +Current limitation: vNUMA nodes have to have at least one vcpu, otherwise +default vcpu_to_vnode will be used. + +=item B<vnuma_vnodemap=[p1, p2, ..., pn]> + +vnode to pnode mapping. Can be configured if manual vnode allocation +required. Will be only taken into effect on real NUMA machines and if +memory or other constraints do not prevent it. If the mapping is fine, +automatic NUMA placement will be disabled. If the mapping incorrect, +automatic NUMA placement will be taken into account when selecting +physical nodes for allocation, or mask will not be used on non-NUMA +machines or if automatic allocation fails. + +Example: +assume two node NUMA node machine: +vnuma_vndoemap=[1, 0] +first vnode will be placed on node 1, second on node0. + =back =head3 Event Actions -- 1.7.10.4