Re: [libvirt] [PATCH 2/9] perf: add task_clock software perf event support

This patch adds support and documentation for the task_clock perf event. Signed-off-by: Nitesh Konkar <nitkon12(a)linux.vnet.ibm.com&gt; --- docs/formatdomain.html.in | 6 ++++++ docs/news.xml | 5 +++-- docs/schemas/domaincommon.rng | 1 + include/libvirt/libvirt-domain.h | 10 ++++++++++ src/libvirt-domain.c | 2 ++ src/qemu/qemu_driver.c | 1 + src/util/virperf.c | 5 ++++- src/util/virperf.h | 1 + tests/genericxml2xmlindata/generic-perf.xml | 1 + tools/virsh.pod | 3 +++ 10 files changed, 32 insertions(+), 3 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index e44e758..1ed5db7 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -1938,6 +1938,7 @@ &lt;event name='stalled_cycles_backend' enabled='no'/&gt; &lt;event name='ref_cpu_cycles' enabled='no'/&gt; &lt;event name='cpu_clock' enabled='no'/&gt; + &lt;event name='task_clock' enabled='no'/&gt; &lt;/perf&gt; ... </pre> @@ -2021,6 +2022,11 @@ <td>the count of cpu clock by applications running on the platform</td> <td><code>perf.cpu_clock</code></td> </tr> + <tr> + <td><code>task_clock</code></td> + <td>the count of task clock by applications running on the platform</td> + <td><code>perf.task_clock</code></td>

+ </tr> </table> <h3><a name="elementsDevices">Devices</a></h3> diff --git a/docs/news.xml b/docs/news.xml index ec113ab..38373c0 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -136,8 +136,9 @@ <description> Add support to get the count of branch instructions executed, branch misses, bus cycles, stalled frontend - cpu cycles, stalled backend cpu cycles, ref cpu cycles - and cpu clock by applications running on the platform. + cpu cycles, stalled backend cpu cycles, ref cpu cycles, + cpu clock and task clock by applications running on the + platform.

</description> </change> <change> diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng index 86a39c8..6ee2c6f 100644 --- a/docs/schemas/domaincommon.rng +++ b/docs/schemas/domaincommon.rng @@ -434,6 +434,7 @@ <value>stalled_cycles_backend</value> <value>ref_cpu_cycles</value> <value>cpu_clock</value> + <value>task_clock</value> </choice> </attribute> <attribute name="enabled"> diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index bffe955..f4f1c74 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -2198,6 +2198,16 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); */ # define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock" +/** + * VIR_PERF_PARAM_TASK_CLOCK: + * + * Macro for typed parameter name that represents task_clock + * perf event which can be used to measure the count of task + * clock by applications running on the platform. It corresponds + * to the "perf.task_clock" field in the *Stats APIs. + */ +# define VIR_PERF_PARAM_TASK_CLOCK "task_clock" + int virDomainGetPerfEvents(virDomainPtr dom, virTypedParameterPtr *params, int *nparams, diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 001cdd7..6875848 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -11252,6 +11252,8 @@ virConnectGetDomainCapabilities(virConnectPtr conn, * ref_cpu_cycles perf event. * "perf.cpu_clock" - The count of cpu clock as unsigned long long. It is * produced by the cpu_clock perf event. + * "perf.task_clock" - The count of task clock as unsigned long long. It is + * produced by the task_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 diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index ff4803c..285156d 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -9550,6 +9550,7 @@ qemuDomainSetPerfEvents(virDomainPtr dom, 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, + VIR_PERF_PARAM_TASK_CLOCK, VIR_TYPED_PARAM_BOOLEAN, NULL) < 0) return -1; diff --git a/src/util/virperf.c b/src/util/virperf.c index 3629e5b..e19cfea 100644 --- a/src/util/virperf.c +++ b/src/util/virperf.c @@ -44,7 +44,7 @@ VIR_ENUM_IMPL(virPerfEvent, VIR_PERF_EVENT_LAST, "branch_instructions", "branch_misses", "bus_cycles", "stalled_cycles_frontend", "stalled_cycles_backend", "ref_cpu_cycles", - "cpu_clock"); + "cpu_clock", "task_clock"); struct virPerfEvent { int type; @@ -116,6 +116,9 @@ static struct virPerfEventAttr attrs[] = { {.type = VIR_PERF_EVENT_CPU_CLOCK, .attrType = PERF_TYPE_SOFTWARE, .attrConfig = PERF_COUNT_SW_CPU_CLOCK}, + {.type = VIR_PERF_EVENT_TASK_CLOCK, + .attrType = PERF_TYPE_SOFTWARE, + .attrConfig = PERF_COUNT_SW_TASK_CLOCK}

}; typedef struct virPerfEventAttr *virPerfEventAttrPtr; diff --git a/src/util/virperf.h b/src/util/virperf.h index 81f1e20..b9e8a75 100644 --- a/src/util/virperf.h +++ b/src/util/virperf.h @@ -48,6 +48,7 @@ typedef enum { processor pipeline */ VIR_PERF_EVENT_REF_CPU_CYCLES, /* Count of ref cpu cycles */ VIR_PERF_EVENT_CPU_CLOCK, /* Count of cpu clock */ + VIR_PERF_EVENT_TASK_CLOCK, /* Count of task clock */ VIR_PERF_EVENT_LAST } virPerfEventType; diff --git a/tests/genericxml2xmlindata/generic-perf.xml b/tests/genericxml2xmlindata/generic-perf.xml index 3e7834e..5ebc0a2 100644 --- a/tests/genericxml2xmlindata/generic-perf.xml +++ b/tests/genericxml2xmlindata/generic-perf.xml @@ -27,6 +27,7 @@ <event name='stalled_cycles_backend' enabled='yes'/> <event name='ref_cpu_cycles' enabled='yes'/> <event name='cpu_clock' enabled='yes'/> + <event name='task_clock' enabled='yes'/> </perf> <devices> </devices> diff --git a/tools/virsh.pod b/tools/virsh.pod index 2f0bf36..958e473 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -947,6 +947,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 +"perf.task_clock" - the count of task clock See the B<perf> command for more details about each event. @@ -2313,6 +2314,8 @@ B<Valid perf event names> applications running on the platform. cpu_clock - Provides the cpu clock time consumed by applications running on the platform. + task_clock - Provides the task 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.