sysctl: annotate struct pm_cx_stat's pc[]/cc[]

Suggested-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Signed-off-by: Jan Beulich <jbeulich@suse.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
Acked-by: Keir Fraser <keir@xen.org>

diff --git a/xen/include/public/sysctl.h b/xen/include/public/sysctl.h
index 8ae6870b408395deaae69674a3c19a33dc42de01..35886985e93b839d27447019f6af218d7ba63e42 100644 (file)
--- a/xen/include/public/sysctl.h
+++ b/xen/include/public/sysctl.h
@@ -228,8 +228,15 @@ struct pm_cx_stat {
     XEN_GUEST_HANDLE_64(uint64) residencies; /* Cx residencies */
     uint32_t nr_pc;                          /* entry nr in pc[] */
     uint32_t nr_cc;                          /* entry nr in cc[] */
-    XEN_GUEST_HANDLE_64(uint64) pc;          /* 1-biased indexing */
-    XEN_GUEST_HANDLE_64(uint64) cc;          /* 1-biased indexing */
+    /*
+     * These two arrays may (and generally will) have unused slots; slots not
+     * having a corresponding hardware register will not be written by the
+     * hypervisor. It is therefore up to the caller to put a suitable sentinel
+     * into all slots before invoking the function.
+     * Indexing is 1-biased (PC1/CC1 being at index 0).
+     */
+    XEN_GUEST_HANDLE_64(uint64) pc;
+    XEN_GUEST_HANDLE_64(uint64) cc;
 };
 
 struct xen_sysctl_get_pmstat {