tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

perf script: Update brstack syntax documentation

The following commits added new fields/flags to the branch stack field
list:

commit 1f48989cdc7d ("perf script: Output branch sample type")
commit 6ade6c646035 ("perf script: Show branch speculation info")
commit 1e66dcff7b9b ("perf script: Add not taken event for branch stack")

Update brstack syntax documentation to be consistent with the latest
branch stack field list. Improve the descriptions to help users
interpret the fields accurately.

Signed-off-by: Yujie Liu <yujie.liu@intel.com>
Reviewed-by: Leo Yan <leo.yan@arm.com>
Reviewed-by: Sandipan Das <sandipan.das@amd.com>
Link: https://lore.kernel.org/r/20250312072329.419020-1-yujie.liu@intel.com
Signed-off-by: Namhyung Kim <namhyung@kernel.org>

authored by

Yujie Liu and committed by
Namhyung Kim fa9bc517 2f39edec

+16 -7
+16 -7
tools/perf/Documentation/perf-script.txt
··· 239 239 i.e., -F "" is not allowed. 240 240 241 241 The brstack output includes branch related information with raw addresses using the 242 - /v/v/v/v/cycles syntax in the following order: 243 - FROM: branch source instruction 244 - TO : branch target instruction 245 - M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported 246 - X/- : X=branch inside a transactional region, -=not in transaction region or not supported 247 - A/- : A=TSX abort entry, -=not aborted region or not supported 248 - cycles 242 + FROM/TO/EVENT/INTX/ABORT/CYCLES/TYPE/SPEC syntax in the following order: 243 + FROM : branch source instruction 244 + TO : branch target instruction 245 + EVENT : M=branch target or direction was mispredicted 246 + P=branch target or direction was predicted 247 + N=branch not-taken 248 + -=no event or not supported 249 + INTX : X=branch inside a transactional region 250 + -=branch not in transaction region or not supported 251 + ABORT : A=TSX abort entry 252 + -=not aborted region or not supported 253 + CYCLES: the number of cycles that have elapsed since the last branch was recorded 254 + TYPE : branch type: COND/UNCOND/IND/CALL/IND_CALL/RET etc. 255 + -=not supported 256 + SPEC : branch speculation info: SPEC_WRONG_PATH/NON_SPEC_CORRECT_PATH/SPEC_CORRECT_PATH 257 + -=not supported 249 258 250 259 The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible. 251 260