xen: rework the comments for struct xen_domctl_vnuma.
PATCH 1/1 xen: rework the comments for struct xen_domctl_vnuma.
In fact: vnode_to_pnode is an array, not a mask; there was a typo in the one about vmemrange; there was no indication of the data directions.
--- xen/include/public/domctl.h | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-)
xen/include/public/domctl.h +21 -11
@@ -958,27 +958,37 @@ typedef struct xen_domctl_vcpu_msrs xen_domctl_vcpu_msrs_t;DEFINE_XEN_GUEST_HANDLE (xen_domctl_vcpu_msrs_t);#endif -/* -* Use in XEN_DOMCTL_setvnumainfo to set -* vNUMA domain topology. -*/ +/* XEN_DOMCTL_setvnumainfo: specifies a virtual NUMA topology for the guest */ struct xen_domctl_vnuma { +/* IN: number of vNUMA nodes to setup. Shall be greater than 0 */ uint32_t nr_vnodes; +/* IN: number of memory ranges to setup */ uint32_t nr_vmemranges; +/* +* IN: number of vCPUs of the domain (used as size of the vcpu_to_vnode +* array declared below). Shall be equal to the domain's max_vcpus. +*/ uint32_t nr_vcpus; -uint32_t pad; +uint32_t pad;/* must be zero */ + +/* +* IN: array for specifying the distances of the vNUMA nodes +* between each others. Shall have nr_vnodes*nr_vnodes elements. +*/ XEN_GUEST_HANDLE_64 (uint) vdistance; +/* +* IN: array for specifying to what vNUMA node each vCPU +* belongs. Shall have nr_vcpus elements. +*/ XEN_GUEST_HANDLE_64 (uint) vcpu_to_vnode; -/* -* vnodes to physical NUMA nodes mask. -* This kept on per-domain basis for -* interested consumers, such as numa aware ballooning. +* IN: array for specifying on what physical NUMA node +* each vNUMA node is placed. Shall have nr_vnodes elements. */ XEN_GUEST_HANDLE_64 (uint) vnode_to_pnode; -/* -* memory rages for each vNUMA node +* IN: array for specifying the memory ranges. +* Shall have nr_vmemranges elements. */ XEN_GUEST_HANDLE_64 (xen_vmemrange_t) vmemrange; };
Quoted 48 lines · Dario Faggioli
In fact:
vnode_to_pnodeis an array, not a mask; there was a typo in the one about vmemrange; there was no indication of the data directions.Signed-off-by Dario Faggioli <[email protected]>Cc Wei Liu <[email protected]>Cc Jan Beulich <[email protected]>Cc Andrew Cooper <[email protected]>Cc Keir Fraser <[email protected]>Cc Elena Ufimtseva <[email protected]>--- xen/include/public/domctl.h | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-)xen/include/public/domctl.h +16
-5@@ -958,27 +958,37 @@ typedef struct xen_domctl_vcpu_msrs xen_domctl_vcpu_msrs_t;DEFINE_XEN_GUEST_HANDLE (xen_domctl_vcpu_msrs_t);#endif -/* -* Use in XEN_DOMCTL_setvnumainfo to set -* vNUMA domain topology. -*/ +/* XEN_DOMCTL_setvnumainfo: specifies a virtual NUMA topology for the guest */ struct xen_domctl_vnuma { +/* IN: number of vNUMA nodes to setup. Shall be greater than 0 */ uint32_t nr_vnodes; +/* IN: number of memory ranges to setup */ uint32_t nr_vmemranges; +/* +* IN: number of vCPUs of the domain (used as size of the vcpu_to_vnode +* array declared below). Shall be equal to the domain's max_vcpus. +*/ uint32_t nr_vcpus; -uint32_t pad; +uint32_t pad;/* must be zero */ + +/* +* IN: array for specifying the distances of the vNUMA nodes +* between each others. Shall have nr_vnodes*nr_vnodes elements. +*/ XEN_GUEST_HANDLE_64 (uint) vdistance; +/* +* IN: array for specifying to what vNUMA node each vCPU +* belongs. Shall have nr_vcpus elements.
xen/include/public/domctl.h typedef struct xen_domctl_vcpu_msrs xen_domctl_vcpu_msrs_t; · line 987
Quoted 10 lines
xen/include/public/domctl.h +3
-4+*/ XEN_GUEST_HANDLE_64 (uint) vcpu_to_vnode; -/* -* vnodes to physical NUMA nodes mask. -* This kept on per-domain basis for -* interested consumers, such as numa aware ballooning. +* IN: array for specifying on what physical NUMA node +* each vNUMA node is placed. Shall have nr_vnodes elements. */
At the very least this hunk should be backported to 4.5?
xen/include/public/domctl.h typedef struct xen_domctl_vcpu_msrs xen_domctl_vcpu_msrs_t; · line 991
Quoted 6 lines
xen/include/public/domctl.h +2
-2XEN_GUEST_HANDLE_64 (uint) vnode_to_pnode; -/* -* memory rages for each vNUMA node +* IN: array for specifying the memory ranges. +* Shall have nr_vmemranges elements.
Inconsistent filling column setup? This line wraps at around 55 characters while others appear to be around 80. I think it might be better to wrap around 72.
Wei.
Quoted 3 lines
xen/include/public/domctl.h +0
-0*/ XEN_GUEST_HANDLE_64 (xen_vmemrange_t) vmemrange; };