Commit e754dd7e authored by Leo Yan's avatar Leo Yan Committed by Arnaldo Carvalho de Melo
Browse files

perf c2c: Update documentation for new display option 'peer' 



Since the new display option 'peer' is introduced, this patch is to
update the documentation to reflect it.

Reviewed-by: default avatarAli Saidi <alisaidi@amazon.com>
Signed-off-by: default avatarLeo Yan <leo.yan@linaro.org>
Acked-by: default avatarIan Rogers <irogers@google.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Anshuman Khandual <anshuman.khandual@arm.com>
Cc: German Gomez <german.gomez@arm.com>
Cc: Gustavo A. R. Silva <gustavoars@kernel.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@arm.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: John Garry <john.garry@huawei.com>
Cc: Kajol Jain <kjain@linux.ibm.com>
Cc: Like Xu <likexu@tencent.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Mike Leach <mike.leach@linaro.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Timothy Hayes <timothy.hayes@arm.com>
Cc: Will Deacon <will@kernel.org>
Cc: linux-arm-kernel@lists.infradead.org
Link: https://lore.kernel.org/r/20220811062451.435810-16-leo.yan@linaro.org


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent ead42a0f

tools/perf/Documentation/perf-c2c.txt

+24 −7
Original line number Diff line number Diff line
@@ -109,7 +109,9 @@ REPORT OPTIONS 


-d::

--display::

	Switch to HITM type (rmt, lcl) to display and sort on. Total HITMs as default.

	Switch to HITM type (rmt, lcl) or peer snooping type (peer) to display

	and sort on. Total HITMs (tot) as default, except Arm64 uses peer mode

	as default.



--stitch-lbr::

	Show callgraph with stitched LBRs, which may have more complete
@@ -174,12 +176,18 @@ For each cacheline in the 1) list we display following data: 
  Cacheline

  - cacheline address (hex number)



  Rmt/Lcl Hitm

  Rmt/Lcl Hitm (Display with HITM types)

  - cacheline percentage of all Remote/Local HITM accesses



  LLC Load Hitm - Total, LclHitm, RmtHitm

  Peer Snoop (Display with peer type)

  - cacheline percentage of all peer accesses



  LLC Load Hitm - Total, LclHitm, RmtHitm (For display with HITM types)

  - count of Total/Local/Remote load HITMs



  Load Peer - Total, Local, Remote (For display with peer type)

  - count of Total/Local/Remote load from peer cache or DRAM



  Total records

  - sum of all cachelines accesses
@@ -201,16 +209,21 @@ For each cacheline in the 1) list we display following data: 
  - count of LLC load accesses, includes LLC hits and LLC HITMs



  RMT Load Hit - RmtHit, RmtHitm

  - count of remote load accesses, includes remote hits and remote HITMs

  - count of remote load accesses, includes remote hits and remote HITMs;

    on Arm neoverse cores, RmtHit is used to account remote accesses,

    includes remote DRAM or any upward cache level in remote node



  Load Dram - Lcl, Rmt

  - count of local and remote DRAM accesses



For each offset in the 2) list we display following data:



  HITM - Rmt, Lcl

  HITM - Rmt, Lcl (Display with HITM types)

  - % of Remote/Local HITM accesses for given offset within cacheline



  Peer Snoop - Rmt, Lcl (Display with peer type)

  - % of Remote/Local peer accesses for given offset within cacheline



  Store Refs - L1 Hit, L1 Miss, N/A

  - % of store accesses that hit L1, missed L1 and N/A (no available) memory

    level for given offset within cacheline
@@ -227,9 +240,12 @@ For each offset in the 2) list we display following data: 
  Code address

  - code address responsible for the accesses



  cycles - rmt hitm, lcl hitm, load

  cycles - rmt hitm, lcl hitm, load (Display with HITM types)

    - sum of cycles for given accesses - Remote/Local HITM and generic load



  cycles - rmt peer, lcl peer, load (Display with peer type)

    - sum of cycles for given accesses - Remote/Local peer load and generic load



  cpu cnt

    - number of cpus that participated on the access
@@ -251,7 +267,8 @@ The 'Node' field displays nodes that accesses given cacheline 
offset. Its output comes in 3 flavors:

  - node IDs separated by ','

  - node IDs with stats for each ID, in following format:

      Node{cpus %hitms %stores}

      Node{cpus %hitms %stores} (Display with HITM types)

      Node{cpus %peers %stores} (Display with peer type)

  - node IDs with list of affected CPUs in following format:

      Node{cpu list}