1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Copyright IBM Corp. 2019
  4 * Author(s): Thomas Richter <tmricht@linux.ibm.com>
  5 *
  6 * This program is free software; you can redistribute it and/or modify
  7 * it under the terms of the GNU General Public License (version 2 only)
  8 * as published by the Free Software Foundation.
  9 *
 10 * Architecture specific trace_event function. Save event's bc000 raw data
 11 * to file. File name is aux.ctr.## where ## stands for the CPU number the
 12 * sample was taken from.
 13 */
 14
 15#include <unistd.h>
 16#include <stdio.h>
 17#include <string.h>
 18#include <inttypes.h>
 19
 20#include <sys/stat.h>
 21#include <linux/compiler.h>
 22#include <asm/byteorder.h>
 23
 24#include "debug.h"
 25#include "session.h"
 26#include "evlist.h"
 27#include "color.h"
 28#include "sample-raw.h"
 29#include "s390-cpumcf-kernel.h"
 30#include "pmu-events/pmu-events.h"
 31
 32static size_t ctrset_size(struct cf_ctrset_entry *set)
 33{
 34	return sizeof(*set) + set->ctr * sizeof(u64);
 35}
 36
 37static bool ctrset_valid(struct cf_ctrset_entry *set)
 38{
 39	return set->def == S390_CPUMCF_DIAG_DEF;
 40}
 41
 42/* CPU Measurement Counter Facility raw data is a byte stream. It is 8 byte
 43 * aligned and might have trailing padding bytes.
 44 * Display the raw data on screen.
 45 */
 46static bool s390_cpumcfdg_testctr(struct perf_sample *sample)
 47{
 48	size_t len = sample->raw_size, offset = 0;
 49	unsigned char *buf = sample->raw_data;
 50	struct cf_trailer_entry *te;
 51	struct cf_ctrset_entry *cep, ce;
 52
 53	if (!len)
 54		return false;
 55	while (offset < len) {
 56		cep = (struct cf_ctrset_entry *)(buf + offset);
 57		ce.def = be16_to_cpu(cep->def);
 58		ce.set = be16_to_cpu(cep->set);
 59		ce.ctr = be16_to_cpu(cep->ctr);
 60		ce.res1 = be16_to_cpu(cep->res1);
 61
 62		if (!ctrset_valid(&ce) || offset + ctrset_size(&ce) > len) {
 63			/* Raw data for counter sets are always multiple of 8
 64			 * bytes. Prepending a 4 bytes size field to the
 65			 * raw data block in the sample causes the perf tool
 66			 * to append 4 padding bytes to make the raw data part
 67			 * of the sample a multiple of eight bytes again.
 68			 *
 69			 * If the last entry (trailer) is 4 bytes off the raw
 70			 * area data end, all is good.
 71			 */
 72			if (len - offset - sizeof(*te) == 4)
 73				break;
 74			pr_err("Invalid counter set entry at %zd\n", offset);
 75			return false;
 76		}
 77		offset += ctrset_size(&ce);
 78	}
 79	return true;
 80}
 81
 82/* Dump event bc000 on screen, already tested on correctness. */
 83static void s390_cpumcfdg_dumptrail(const char *color, size_t offset,
 84				    struct cf_trailer_entry *tep)
 85{
 86	struct cf_trailer_entry  te;
 87
 88	te.flags = be64_to_cpu(tep->flags);
 89	te.cfvn = be16_to_cpu(tep->cfvn);
 90	te.csvn = be16_to_cpu(tep->csvn);
 91	te.cpu_speed = be32_to_cpu(tep->cpu_speed);
 92	te.timestamp = be64_to_cpu(tep->timestamp);
 93	te.progusage1 = be64_to_cpu(tep->progusage1);
 94	te.progusage2 = be64_to_cpu(tep->progusage2);
 95	te.progusage3 = be64_to_cpu(tep->progusage3);
 96	te.tod_base = be64_to_cpu(tep->tod_base);
 97	te.mach_type = be16_to_cpu(tep->mach_type);
 98	te.res1 = be16_to_cpu(tep->res1);
 99	te.res2 = be32_to_cpu(tep->res2);
100
101	color_fprintf(stdout, color, "    [%#08zx] Trailer:%c%c%c%c%c"
102		      " Cfvn:%d Csvn:%d Speed:%d TOD:%#llx\n",
103		      offset, te.clock_base ? 'T' : ' ',
104		      te.speed ? 'S' : ' ', te.mtda ? 'M' : ' ',
105		      te.caca ? 'C' : ' ', te.lcda ? 'L' : ' ',
106		      te.cfvn, te.csvn, te.cpu_speed, te.timestamp);
107	color_fprintf(stdout, color, "\t\t1:%lx 2:%lx 3:%lx TOD-Base:%#llx"
108		      " Type:%x\n\n",
109		      te.progusage1, te.progusage2, te.progusage3,
110		      te.tod_base, te.mach_type);
111}
112
113/* Return starting number of a counter set */
114static int get_counterset_start(int setnr)
115{
116	switch (setnr) {
117	case CPUMF_CTR_SET_BASIC:		/* Basic counter set */
118		return 0;
119	case CPUMF_CTR_SET_USER:		/* Problem state counter set */
120		return 32;
121	case CPUMF_CTR_SET_CRYPTO:		/* Crypto counter set */
122		return 64;
123	case CPUMF_CTR_SET_EXT:			/* Extended counter set */
124		return 128;
125	case CPUMF_CTR_SET_MT_DIAG:		/* Diagnostic counter set */
126		return 448;
127	default:
128		return -1;
129	}
130}
131
132/* Scan the PMU table and extract the logical name of a counter from the
133 * PMU events table. Input is the counter set and counter number with in the
134 * set. Construct the event number and use this as key. If they match return
135 * the name of this counter.
136 * If no match is found a NULL pointer is returned.
137 */
138static const char *get_counter_name(int set, int nr, struct pmu_events_map *map)
139{
140	int rc, event_nr, wanted = get_counterset_start(set) + nr;
141
142	if (map) {
143		struct pmu_event *evp = map->table;
144
145		for (; evp->name || evp->event || evp->desc; ++evp) {
146			if (evp->name == NULL || evp->event == NULL)
147				continue;
148			rc = sscanf(evp->event, "event=%x", &event_nr);
149			if (rc == 1 && event_nr == wanted)
150				return evp->name;
151		}
152	}
153	return NULL;
154}
155
156static void s390_cpumcfdg_dump(struct perf_sample *sample)
157{
158	size_t i, len = sample->raw_size, offset = 0;
159	unsigned char *buf = sample->raw_data;
160	const char *color = PERF_COLOR_BLUE;
161	struct cf_ctrset_entry *cep, ce;
162	struct pmu_events_map *map;
163	struct perf_pmu pmu;
164	u64 *p;
165
166	memset(&pmu, 0, sizeof(pmu));
167	map = perf_pmu__find_map(&pmu);
168	while (offset < len) {
169		cep = (struct cf_ctrset_entry *)(buf + offset);
170
171		ce.def = be16_to_cpu(cep->def);
172		ce.set = be16_to_cpu(cep->set);
173		ce.ctr = be16_to_cpu(cep->ctr);
174		ce.res1 = be16_to_cpu(cep->res1);
175
176		if (!ctrset_valid(&ce)) {	/* Print trailer */
177			s390_cpumcfdg_dumptrail(color, offset,
178						(struct cf_trailer_entry *)cep);
179			return;
180		}
181
182		color_fprintf(stdout, color, "    [%#08zx] Counterset:%d"
183			      " Counters:%d\n", offset, ce.set, ce.ctr);
184		for (i = 0, p = (u64 *)(cep + 1); i < ce.ctr; ++i, ++p) {
185			const char *ev_name = get_counter_name(ce.set, i, map);
186
187			color_fprintf(stdout, color,
188				      "\tCounter:%03d %s Value:%#018lx\n", i,
189				      ev_name ?: "<unknown>", be64_to_cpu(*p));
190		}
191		offset += ctrset_size(&ce);
192	}
193}
194
195/* S390 specific trace event function. Check for PERF_RECORD_SAMPLE events
196 * and if the event was triggered by a counter set diagnostic event display
197 * its raw data.
198 * The function is only invoked when the dump flag -D is set.
199 */
200void perf_evlist__s390_sample_raw(struct evlist *evlist, union perf_event *event,
201				  struct perf_sample *sample)
202{
203	struct evsel *ev_bc000;
204
205	if (event->header.type != PERF_RECORD_SAMPLE)
206		return;
207
208	ev_bc000 = perf_evlist__event2evsel(evlist, event);
209	if (ev_bc000 == NULL ||
210	    ev_bc000->core.attr.config != PERF_EVENT_CPUM_CF_DIAG)
211		return;
212
213	/* Display raw data on screen */
214	if (!s390_cpumcfdg_testctr(sample)) {
215		pr_err("Invalid counter set data encountered\n");
216		return;
217	}
218	s390_cpumcfdg_dump(sample);
219}