xref: /openbmc/linux/tools/perf/tests/parse-metric.c (revision e7bae9bb)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/compiler.h>
3 #include <string.h>
4 #include <perf/cpumap.h>
5 #include <perf/evlist.h>
6 #include "metricgroup.h"
7 #include "tests.h"
8 #include "pmu-events/pmu-events.h"
9 #include "evlist.h"
10 #include "rblist.h"
11 #include "debug.h"
12 #include "expr.h"
13 #include "stat.h"
14 #include <perf/cpumap.h>
15 #include <perf/evlist.h>
16 
17 static struct pmu_event pme_test[] = {
18 {
19 	.metric_expr	= "inst_retired.any / cpu_clk_unhalted.thread",
20 	.metric_name	= "IPC",
21 	.metric_group	= "group1",
22 },
23 {
24 	.metric_expr	= "idq_uops_not_delivered.core / (4 * (( ( cpu_clk_unhalted.thread / 2 ) * "
25 			  "( 1 + cpu_clk_unhalted.one_thread_active / cpu_clk_unhalted.ref_xclk ) )))",
26 	.metric_name	= "Frontend_Bound_SMT",
27 },
28 {
29 	.metric_expr	= "l1d\\-loads\\-misses / inst_retired.any",
30 	.metric_name	= "dcache_miss_cpi",
31 },
32 {
33 	.metric_expr	= "l1i\\-loads\\-misses / inst_retired.any",
34 	.metric_name	= "icache_miss_cycles",
35 },
36 {
37 	.metric_expr	= "(dcache_miss_cpi + icache_miss_cycles)",
38 	.metric_name	= "cache_miss_cycles",
39 	.metric_group	= "group1",
40 },
41 {
42 	.metric_expr	= "l2_rqsts.demand_data_rd_hit + l2_rqsts.pf_hit + l2_rqsts.rfo_hit",
43 	.metric_name	= "DCache_L2_All_Hits",
44 },
45 {
46 	.metric_expr	= "max(l2_rqsts.all_demand_data_rd - l2_rqsts.demand_data_rd_hit, 0) + "
47 			  "l2_rqsts.pf_miss + l2_rqsts.rfo_miss",
48 	.metric_name	= "DCache_L2_All_Miss",
49 },
50 {
51 	.metric_expr	= "dcache_l2_all_hits + dcache_l2_all_miss",
52 	.metric_name	= "DCache_L2_All",
53 },
54 {
55 	.metric_expr	= "d_ratio(dcache_l2_all_hits, dcache_l2_all)",
56 	.metric_name	= "DCache_L2_Hits",
57 },
58 {
59 	.metric_expr	= "d_ratio(dcache_l2_all_miss, dcache_l2_all)",
60 	.metric_name	= "DCache_L2_Misses",
61 },
62 {
63 	.metric_expr	= "ipc + m2",
64 	.metric_name	= "M1",
65 },
66 {
67 	.metric_expr	= "ipc + m1",
68 	.metric_name	= "M2",
69 },
70 {
71 	.metric_expr	= "1/m3",
72 	.metric_name	= "M3",
73 },
74 {
75 	.name	= NULL,
76 }
77 };
78 
79 static struct pmu_events_map map = {
80 	.cpuid		= "test",
81 	.version	= "1",
82 	.type		= "core",
83 	.table		= pme_test,
84 };
85 
86 struct value {
87 	const char	*event;
88 	u64		 val;
89 };
90 
91 static u64 find_value(const char *name, struct value *values)
92 {
93 	struct value *v = values;
94 
95 	while (v->event) {
96 		if (!strcmp(name, v->event))
97 			return v->val;
98 		v++;
99 	};
100 	return 0;
101 }
102 
103 static void load_runtime_stat(struct runtime_stat *st, struct evlist *evlist,
104 			      struct value *vals)
105 {
106 	struct evsel *evsel;
107 	u64 count;
108 
109 	evlist__for_each_entry(evlist, evsel) {
110 		count = find_value(evsel->name, vals);
111 		perf_stat__update_shadow_stats(evsel, count, 0, st);
112 	}
113 }
114 
115 static double compute_single(struct rblist *metric_events, struct evlist *evlist,
116 			     struct runtime_stat *st, const char *name)
117 {
118 	struct metric_expr *mexp;
119 	struct metric_event *me;
120 	struct evsel *evsel;
121 
122 	evlist__for_each_entry(evlist, evsel) {
123 		me = metricgroup__lookup(metric_events, evsel, false);
124 		if (me != NULL) {
125 			list_for_each_entry (mexp, &me->head, nd) {
126 				if (strcmp(mexp->metric_name, name))
127 					continue;
128 				return test_generic_metric(mexp, 0, st);
129 			}
130 		}
131 	}
132 	return 0.;
133 }
134 
135 static int __compute_metric(const char *name, struct value *vals,
136 			    const char *name1, double *ratio1,
137 			    const char *name2, double *ratio2)
138 {
139 	struct rblist metric_events = {
140 		.nr_entries = 0,
141 	};
142 	struct perf_cpu_map *cpus;
143 	struct runtime_stat st;
144 	struct evlist *evlist;
145 	int err;
146 
147 	/*
148 	 * We need to prepare evlist for stat mode running on CPU 0
149 	 * because that's where all the stats are going to be created.
150 	 */
151 	evlist = evlist__new();
152 	if (!evlist)
153 		return -ENOMEM;
154 
155 	cpus = perf_cpu_map__new("0");
156 	if (!cpus) {
157 		evlist__delete(evlist);
158 		return -ENOMEM;
159 	}
160 
161 	perf_evlist__set_maps(&evlist->core, cpus, NULL);
162 
163 	/* Parse the metric into metric_events list. */
164 	err = metricgroup__parse_groups_test(evlist, &map, name,
165 					     false, false,
166 					     &metric_events);
167 	if (err)
168 		goto out;
169 
170 	err = perf_evlist__alloc_stats(evlist, false);
171 	if (err)
172 		goto out;
173 
174 	/* Load the runtime stats with given numbers for events. */
175 	runtime_stat__init(&st);
176 	load_runtime_stat(&st, evlist, vals);
177 
178 	/* And execute the metric */
179 	if (name1 && ratio1)
180 		*ratio1 = compute_single(&metric_events, evlist, &st, name1);
181 	if (name2 && ratio2)
182 		*ratio2 = compute_single(&metric_events, evlist, &st, name2);
183 
184 out:
185 	/* ... clenup. */
186 	metricgroup__rblist_exit(&metric_events);
187 	runtime_stat__exit(&st);
188 	perf_evlist__free_stats(evlist);
189 	perf_cpu_map__put(cpus);
190 	evlist__delete(evlist);
191 	return err;
192 }
193 
194 static int compute_metric(const char *name, struct value *vals, double *ratio)
195 {
196 	return __compute_metric(name, vals, name, ratio, NULL, NULL);
197 }
198 
199 static int compute_metric_group(const char *name, struct value *vals,
200 				const char *name1, double *ratio1,
201 				const char *name2, double *ratio2)
202 {
203 	return __compute_metric(name, vals, name1, ratio1, name2, ratio2);
204 }
205 
206 static int test_ipc(void)
207 {
208 	double ratio;
209 	struct value vals[] = {
210 		{ .event = "inst_retired.any",        .val = 300 },
211 		{ .event = "cpu_clk_unhalted.thread", .val = 200 },
212 		{ .event = NULL, },
213 	};
214 
215 	TEST_ASSERT_VAL("failed to compute metric",
216 			compute_metric("IPC", vals, &ratio) == 0);
217 
218 	TEST_ASSERT_VAL("IPC failed, wrong ratio",
219 			ratio == 1.5);
220 	return 0;
221 }
222 
223 static int test_frontend(void)
224 {
225 	double ratio;
226 	struct value vals[] = {
227 		{ .event = "idq_uops_not_delivered.core",        .val = 300 },
228 		{ .event = "cpu_clk_unhalted.thread",            .val = 200 },
229 		{ .event = "cpu_clk_unhalted.one_thread_active", .val = 400 },
230 		{ .event = "cpu_clk_unhalted.ref_xclk",          .val = 600 },
231 		{ .event = NULL, },
232 	};
233 
234 	TEST_ASSERT_VAL("failed to compute metric",
235 			compute_metric("Frontend_Bound_SMT", vals, &ratio) == 0);
236 
237 	TEST_ASSERT_VAL("Frontend_Bound_SMT failed, wrong ratio",
238 			ratio == 0.45);
239 	return 0;
240 }
241 
242 static int test_cache_miss_cycles(void)
243 {
244 	double ratio;
245 	struct value vals[] = {
246 		{ .event = "l1d-loads-misses",  .val = 300 },
247 		{ .event = "l1i-loads-misses",  .val = 200 },
248 		{ .event = "inst_retired.any",  .val = 400 },
249 		{ .event = NULL, },
250 	};
251 
252 	TEST_ASSERT_VAL("failed to compute metric",
253 			compute_metric("cache_miss_cycles", vals, &ratio) == 0);
254 
255 	TEST_ASSERT_VAL("cache_miss_cycles failed, wrong ratio",
256 			ratio == 1.25);
257 	return 0;
258 }
259 
260 
261 /*
262  * DCache_L2_All_Hits = l2_rqsts.demand_data_rd_hit + l2_rqsts.pf_hit + l2_rqsts.rfo_hi
263  * DCache_L2_All_Miss = max(l2_rqsts.all_demand_data_rd - l2_rqsts.demand_data_rd_hit, 0) +
264  *                      l2_rqsts.pf_miss + l2_rqsts.rfo_miss
265  * DCache_L2_All      = dcache_l2_all_hits + dcache_l2_all_miss
266  * DCache_L2_Hits     = d_ratio(dcache_l2_all_hits, dcache_l2_all)
267  * DCache_L2_Misses   = d_ratio(dcache_l2_all_miss, dcache_l2_all)
268  *
269  * l2_rqsts.demand_data_rd_hit = 100
270  * l2_rqsts.pf_hit             = 200
271  * l2_rqsts.rfo_hi             = 300
272  * l2_rqsts.all_demand_data_rd = 400
273  * l2_rqsts.pf_miss            = 500
274  * l2_rqsts.rfo_miss           = 600
275  *
276  * DCache_L2_All_Hits = 600
277  * DCache_L2_All_Miss = MAX(400 - 100, 0) + 500 + 600 = 1400
278  * DCache_L2_All      = 600 + 1400  = 2000
279  * DCache_L2_Hits     = 600 / 2000  = 0.3
280  * DCache_L2_Misses   = 1400 / 2000 = 0.7
281  */
282 static int test_dcache_l2(void)
283 {
284 	double ratio;
285 	struct value vals[] = {
286 		{ .event = "l2_rqsts.demand_data_rd_hit", .val = 100 },
287 		{ .event = "l2_rqsts.pf_hit",             .val = 200 },
288 		{ .event = "l2_rqsts.rfo_hit",            .val = 300 },
289 		{ .event = "l2_rqsts.all_demand_data_rd", .val = 400 },
290 		{ .event = "l2_rqsts.pf_miss",            .val = 500 },
291 		{ .event = "l2_rqsts.rfo_miss",           .val = 600 },
292 		{ .event = NULL, },
293 	};
294 
295 	TEST_ASSERT_VAL("failed to compute metric",
296 			compute_metric("DCache_L2_Hits", vals, &ratio) == 0);
297 
298 	TEST_ASSERT_VAL("DCache_L2_Hits failed, wrong ratio",
299 			ratio == 0.3);
300 
301 	TEST_ASSERT_VAL("failed to compute metric",
302 			compute_metric("DCache_L2_Misses", vals, &ratio) == 0);
303 
304 	TEST_ASSERT_VAL("DCache_L2_Misses failed, wrong ratio",
305 			ratio == 0.7);
306 	return 0;
307 }
308 
309 static int test_recursion_fail(void)
310 {
311 	double ratio;
312 	struct value vals[] = {
313 		{ .event = "inst_retired.any",        .val = 300 },
314 		{ .event = "cpu_clk_unhalted.thread", .val = 200 },
315 		{ .event = NULL, },
316 	};
317 
318 	TEST_ASSERT_VAL("failed to find recursion",
319 			compute_metric("M1", vals, &ratio) == -1);
320 
321 	TEST_ASSERT_VAL("failed to find recursion",
322 			compute_metric("M3", vals, &ratio) == -1);
323 	return 0;
324 }
325 
326 static int test_metric_group(void)
327 {
328 	double ratio1, ratio2;
329 	struct value vals[] = {
330 		{ .event = "cpu_clk_unhalted.thread", .val = 200 },
331 		{ .event = "l1d-loads-misses",        .val = 300 },
332 		{ .event = "l1i-loads-misses",        .val = 200 },
333 		{ .event = "inst_retired.any",        .val = 400 },
334 		{ .event = NULL, },
335 	};
336 
337 	TEST_ASSERT_VAL("failed to find recursion",
338 			compute_metric_group("group1", vals,
339 					     "IPC", &ratio1,
340 					     "cache_miss_cycles", &ratio2) == 0);
341 
342 	TEST_ASSERT_VAL("group IPC failed, wrong ratio",
343 			ratio1 == 2.0);
344 
345 	TEST_ASSERT_VAL("group cache_miss_cycles failed, wrong ratio",
346 			ratio2 == 1.25);
347 	return 0;
348 }
349 
350 int test__parse_metric(struct test *test __maybe_unused, int subtest __maybe_unused)
351 {
352 	TEST_ASSERT_VAL("IPC failed", test_ipc() == 0);
353 	TEST_ASSERT_VAL("frontend failed", test_frontend() == 0);
354 	TEST_ASSERT_VAL("cache_miss_cycles failed", test_cache_miss_cycles() == 0);
355 	TEST_ASSERT_VAL("DCache_L2 failed", test_dcache_l2() == 0);
356 	TEST_ASSERT_VAL("recursion fail failed", test_recursion_fail() == 0);
357 	TEST_ASSERT_VAL("test metric group", test_metric_group() == 0);
358 	return 0;
359 }
360