Re: [PATCH v5 10/13] coresight: Remove misleading definitions

[James Clark <james.clark@linaro.org>]

On 20/11/2025 11:21 am, Mike Leach wrote:
> On Tue, 18 Nov 2025 at 16:28, James Clark <james.clark@linaro.org> wrote:
>>
>> ETM_OPT_* definitions duplicate the PMU format attributes that have
>> always been published in sysfs. Hardcoding them here makes it misleading
>> as to what the 'real' PMU API is and prevents attributes from being
>> rearranged in the future.
>>
>> ETM4_CFG_BIT_* definitions just define what the Arm Architecture is
>> which is not the responsibility of the kernel to do and doesn't scale to
>> other registers or versions of ETM. It's not an actual software ABI/API
>> and these definitions here mislead that it is.
>>
>> Any tools using the first ones would be broken anyway as they won't work
>> when attributes are moved, so removing them is the right thing to do and
>> will prompt a fix. Tools using the second ones can trivially redefine
>> them locally.
>>
>> Perf also has its own copy of the headers so both of these things can be
>> fixed up at a later date.
>>
> 
> The perf version is used to reconstruct the control registers for etm3
> / etm4 to put into the trace metadata headers in the perf.data file
> for the decoder to be intitialised correctly.
> 
> perf_event_attr::config uses the ETM_OPT_* values, used directly for
> etm3 since they match the bit pattern in the etm3/ptm config register,
> and remapped for etm4 from ETM_OPT_* to equivalent ETM4_CFG_BIT* for
> the etm4 config register.

That was one of the parts that confused me. Just because the format bit 
positions happened to match the register config for ETM3, didn't mean 
that it had to avoid reading the positions from sysfs. And it wasn't 
consistent between ETM3 and ETM4 either.

That's decoupled now anyway, so although they still match there's no 
reason it can't change in the future.

> 
> The reason we do this re-construction - rather than read registers as
> we do for the other metadata - is that the register value is not set
> at the point we are recording the metadata - it does not actually get
> set until the etm is enabled, later in the perf process.
> 
> On this basis it would seem that any changing of the attribute bit
> ordering has potential to break perf decode. Probably safe to remove

Yes so we should keep the positions the same until enough time has 
passed after the Perf fixes go in. Although other than the timestamp one 
I can't see any of the format bits needing to be moved.

The timestamp bit now won't be passed correctly to OpenCSD until Perf is 
fixed, but I saw it wasn't used for decode anyway, so that should be fine?

> from this version of the file though, but overall, changing bit
> meanings in the underlying variable may possibly need a fix in perf
> and  potentially a breaking change for earlier versions of the tools.
> 
> That said, for this particular version of the header, since it appears
> to no longer need the values due to earlier changes.
> 

The reconstruction of the registers will remain in Perf, so nothing will 
change there apart from not hard coding the format bit positions.

I plan to define the register bits in Perf in cs-etm.c in the same style 
as we do in the kernel. ETM_OPT_* and ETM4_CFG_* weren't searchable 
because the the bits are already defined in the kernel in a different 
style. So I'll define them to match like this:

+/* ETMv4 CONFIGR register bits */
+#define TRCCONFIGR_BB		BIT(3)
+#define TRCCONFIGR_CCI		BIT(4)
+#define TRCCONFIGR_CID		BIT(6)
+#define TRCCONFIGR_VMID	BIT(7)
+#define TRCCONFIGR_TS		BIT(11)
+#define TRCCONFIGR_RS		BIT(12)
+#define TRCCONFIGR_VMIDOPT	BIT(15)
+
+/* ETMv3 ETMCR register bits */
+#define ETMCR_CYC_ACC		BIT(12)
+#define ETMCR_TIMESTAMP_EN	BIT(28)
+#define ETMCR_RETURN_STACK	BIT(29)
+


Then use the format strings to check which ones are set:

if (!evsel__get_config_val(cs_etm_pmu, evsel, "cycacc", &val) && val)
	trcconfigr |= TRCCONFIGR_CCI;
if (!evsel__get_config_val(cs_etm_pmu, evsel, "contextid1", &val) && val)
	trcconfigr |= TRCCONFIGR_CID;
if (!evsel__get_config_val(cs_etm_pmu, evsel, "timestamp", &val) && val)
	trcconfigr |= TRCCONFIGR_TS;
if (!evsel__get_config_val(cs_etm_pmu, evsel, "retstack", &val) && val)
	trcconfigr |= TRCCONFIGR_RS;
if (!evsel__get_config_val(cs_etm_pmu, evsel, "contextid2", &val) && val)
	trcconfigr |= TRCCONFIGR_VMID | TRCCONFIGR_VMIDOPT;
if (!evsel__get_config_val(cs_etm_pmu, evsel, "branch_broadcast", &val) 
&& val)
	trcconfigr |= TRCCONFIGR_BB;


This also highlighted another Perf bug that evsel__set_config_if_unset() 
only operates on config and not config1, config2 etc. That's also used 
for setting up the event so I'll fix that too.

Seems like the API goes through a lot of effort to publish the bit 
positions in sysfs, but we've selectively not used them which wasn't 
quite right.

> Reviewed-by: Mike Leach <mike.leach@linaro.org>
> 
>> Reviewed-by: Leo Yan <leo.yan@arm.com>
>> Signed-off-by: James Clark <james.clark@linaro.org>
>> ---
>>   include/linux/coresight-pmu.h | 24 ------------------------
>>   1 file changed, 24 deletions(-)
>>
>> diff --git a/include/linux/coresight-pmu.h b/include/linux/coresight-pmu.h
>> index 89b0ac0014b0..2e179abe472a 100644
>> --- a/include/linux/coresight-pmu.h
>> +++ b/include/linux/coresight-pmu.h
>> @@ -21,30 +21,6 @@
>>    */
>>   #define CORESIGHT_LEGACY_CPU_TRACE_ID(cpu)  (0x10 + (cpu * 2))
>>
>> -/*
>> - * Below are the definition of bit offsets for perf option, and works as
>> - * arbitrary values for all ETM versions.
>> - *
>> - * Most of them are orignally from ETMv3.5/PTM's ETMCR config, therefore,
>> - * ETMv3.5/PTM doesn't define ETMCR config bits with prefix "ETM3_" and
>> - * directly use below macros as config bits.
>> - */
>> -#define ETM_OPT_BRANCH_BROADCAST 8
>> -#define ETM_OPT_CYCACC         12
>> -#define ETM_OPT_CTXTID         14
>> -#define ETM_OPT_CTXTID2                15
>> -#define ETM_OPT_TS             28
>> -#define ETM_OPT_RETSTK         29
>> -
>> -/* ETMv4 CONFIGR programming bits for the ETM OPTs */
>> -#define ETM4_CFG_BIT_BB         3
>> -#define ETM4_CFG_BIT_CYCACC    4
>> -#define ETM4_CFG_BIT_CTXTID    6
>> -#define ETM4_CFG_BIT_VMID      7
>> -#define ETM4_CFG_BIT_TS                11
>> -#define ETM4_CFG_BIT_RETSTK    12
>> -#define ETM4_CFG_BIT_VMID_OPT  15
>> -
>>   /*
>>    * Interpretation of the PERF_RECORD_AUX_OUTPUT_HW_ID payload.
>>    * Used to associate a CPU with the CoreSight Trace ID.
>>
>> --
>> 2.34.1
>>
> 
> 
> --
> Mike Leach
> Principal Engineer, ARM Ltd.
> Manchester Design Centre. UK