Commit 57e5f29f authored by Changbin Du's avatar Changbin Du Committed by Jonathan Corbet
Browse files

trace doc: convert trace/events-msr.txt to rst format 



This converts the plain text documentation to reStructuredText format and
add it into Sphinx TOC tree. No essential content change.

Cc: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: default avatarChangbin Du <changbin.du@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 15ba0538

Documentation/trace/events-msr.txt→Documentation/trace/events-msr.rst

+40 −0
Original line number Diff line number Diff line 
================

MSR Trace Events

================



The x86 kernel supports tracing most MSR (Model Specific Register) accesses.

To see the definition of the MSRs on Intel systems please see the SDM
@@ -7,29 +10,29 @@ Available trace points: 


/sys/kernel/debug/tracing/events/msr/



Trace MSR reads

Trace MSR reads:



read_msr



msr: MSR number

val: Value written

failed: 1 if the access failed, otherwise 0

  - msr: MSR number

  - val: Value written

  - failed: 1 if the access failed, otherwise 0





Trace MSR writes

Trace MSR writes:



write_msr



msr: MSR number

val: Value written

failed: 1 if the access failed, otherwise 0

  - msr: MSR number

  - val: Value written

  - failed: 1 if the access failed, otherwise 0





Trace RDPMC in kernel

Trace RDPMC in kernel:



rdpmc



The trace data can be post processed with the postprocess/decode_msr.py script

The trace data can be post processed with the postprocess/decode_msr.py script::



  cat /sys/kernel/debug/tracing/trace | decode_msr.py /usr/src/linux/include/asm/msr-index.h

Documentation/trace/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -16,3 +16,4 @@ Linux Tracing Technologies 
   events-kmem

   events-power

   events-nmi

   events-msr

CRA Git | Maintained and supported by SUSTech CRA and CCSE