perf: add cpu_clock software perf event support

This patch adds support and documentation for
the cpu_clock perf event.

Signed-off-by: Nitesh Konkar <nitkon12@linux.vnet.ibm.com>

docs/formatdomain.html.in

@@ -1947,6 +1947,7 @@
   <event name='stalled_cycles_frontend' enabled='no'/>
   <event name='stalled_cycles_backend' enabled='no'/>
   <event name='ref_cpu_cycles' enabled='no'/>
+  <event name='cpu_clock' enabled='no'/>
 </perf>
 ...
 </pre>
@@ -2025,6 +2026,13 @@
          by applications running on the platform</td>
       <td><code>perf.ref_cpu_cycles</code></td>
     </tr>
+    <tr>
+      <td><code>cpu_clock</code></td>
+      <td>the count of cpu clock time, as measured by a monotonic
+          high-resolution per-CPU timer, by applications running on
+          the platform</td>
+      <td><code>perf.cpu_clock</code></td>
+    </tr>
   </table>
 
     <h3><a name="elementsDevices">Devices</a></h3>

docs/schemas/domaincommon.rng

@@ -433,6 +433,7 @@
               <value>stalled_cycles_frontend</value>
               <value>stalled_cycles_backend</value>
               <value>ref_cpu_cycles</value>
+              <value>cpu_clock</value>
             </choice>
           </attribute>
           <attribute name="enabled">

include/libvirt/libvirt-domain.h

@@ -2188,6 +2188,17 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats);
  */
 # define VIR_PERF_PARAM_REF_CPU_CYCLES "ref_cpu_cycles"
 
+/**
+ * VIR_PERF_PARAM_CPU_CLOCK:
+ *
+ * Macro for typed parameter name that represents cpu_clock
+ * perf event which can be used to measure the count of cpu
+ * clock time by applications running on the platform. It
+ * corresponds to the "perf.cpu_clock" field in the *Stats
+ * APIs.
+ */
+# define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock"
+
 int virDomainGetPerfEvents(virDomainPtr dom,
                            virTypedParameterPtr *params,
                            int *nparams,

src/libvirt-domain.c

@@ -11250,6 +11250,8 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
  *                             CPU frequency scaling by applications running
  *                             as unsigned long long. It is produced by the
  *                             ref_cpu_cycles perf event.
+ *     "perf.cpu_clock" - The count of cpu clock time as unsigned long long.
+ *                        It is produced by the cpu_clock perf event.
  *
  * Note that entire stats groups or individual stat fields may be missing from
  * the output in case they are not supported by the given hypervisor, are not

src/qemu/qemu_driver.c

@@ -9567,6 +9567,7 @@ qemuDomainSetPerfEvents(virDomainPtr dom,
                                VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND, VIR_TYPED_PARAM_BOOLEAN,
                                VIR_PERF_PARAM_STALLED_CYCLES_BACKEND, VIR_TYPED_PARAM_BOOLEAN,
                                VIR_PERF_PARAM_REF_CPU_CYCLES, VIR_TYPED_PARAM_BOOLEAN,
+                               VIR_PERF_PARAM_CPU_CLOCK, VIR_TYPED_PARAM_BOOLEAN,
                                NULL) < 0)
         return -1;
 

src/util/virperf.c

@@ -43,7 +43,8 @@ VIR_ENUM_IMPL(virPerfEvent, VIR_PERF_EVENT_LAST,
               "cache_references", "cache_misses",
               "branch_instructions", "branch_misses",
               "bus_cycles", "stalled_cycles_frontend",
-              "stalled_cycles_backend", "ref_cpu_cycles");
+              "stalled_cycles_backend", "ref_cpu_cycles",
+              "cpu_clock");
 
 struct virPerfEvent {
     int type;
@@ -112,6 +113,9 @@ static struct virPerfEventAttr attrs[] = {
      .attrConfig = 0,
 # endif
     },
+    {.type = VIR_PERF_EVENT_CPU_CLOCK,
+     .attrType = PERF_TYPE_SOFTWARE,
+     .attrConfig = PERF_COUNT_SW_CPU_CLOCK},
 };
 typedef struct virPerfEventAttr *virPerfEventAttrPtr;
 

src/util/virperf.h

@@ -47,6 +47,7 @@ typedef enum {
                                               the backend of the instruction
                                               processor pipeline */
     VIR_PERF_EVENT_REF_CPU_CYCLES,   /* Count of ref cpu cycles */
+    VIR_PERF_EVENT_CPU_CLOCK,   /* Count of cpu clock time*/
 
     VIR_PERF_EVENT_LAST
 } virPerfEventType;

tests/genericxml2xmlindata/generic-perf.xml

@@ -26,6 +26,7 @@
     <event name='stalled_cycles_frontend' enabled='yes'/>
     <event name='stalled_cycles_backend' enabled='yes'/>
     <event name='ref_cpu_cycles' enabled='yes'/>
+    <event name='cpu_clock' enabled='yes'/>
   </perf>
   <devices>
   </devices>

tools/virsh.pod

@@ -964,6 +964,7 @@ I<--perf> returns the statistics of all enabled perf events:
  "perf.stalled_cycles_backend" - the count of stalled backend
                                  cpu cycles
  "perf.ref_cpu_cycles" - the count of ref cpu cycles
+ "perf.cpu_clock" - the count of cpu clock time
 
 See the B<perf> command for more details about each event.
 
@@ -2333,6 +2334,8 @@ B<Valid perf event names>
   ref_cpu_cycles   -  Provides the count of total cpu cycles
                       not affected by CPU frequency scaling by
                       applications running on the platform.
+  cpu_clock - Provides the cpu clock time consumed by
+              applications running on the platform.
 
 B<Note>: The statistics can be retrieved using the B<domstats> command using
 the I<--perf> flag.