* [PATCH 0/3] perf tools: Fix missing guest option documentation
@ 2022-08-11 17:04 Adrian Hunter
2022-08-11 17:04 ` [PATCH 1/3] perf script: " Adrian Hunter
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Adrian Hunter @ 2022-08-11 17:04 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo
Cc: Jiri Olsa, Namhyung Kim, Ian Rogers, linux-kernel
Hi
Here are a couple of small documentation fixes and subsequent corresponding
tidy-up.
Adrian Hunter (3):
perf script: Fix missing guest option documentation
perf inject: Fix missing guestmount option documentation
perf tools: Tidy guest option documentation
tools/perf/Documentation/guest-files.txt | 16 ++++++++++++++++
tools/perf/Documentation/guestmount.txt | 11 +++++++++++
tools/perf/Documentation/perf-inject.txt | 4 ++++
tools/perf/Documentation/perf-kvm.txt | 25 +++++--------------------
tools/perf/Documentation/perf-script.txt | 6 +++---
5 files changed, 39 insertions(+), 23 deletions(-)
create mode 100644 tools/perf/Documentation/guest-files.txt
create mode 100644 tools/perf/Documentation/guestmount.txt
Regards
Adrian
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/3] perf script: Fix missing guest option documentation
2022-08-11 17:04 [PATCH 0/3] perf tools: Fix missing guest option documentation Adrian Hunter
@ 2022-08-11 17:04 ` Adrian Hunter
2022-08-11 17:04 ` [PATCH 2/3] perf inject: Fix missing guestmount " Adrian Hunter
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Adrian Hunter @ 2022-08-11 17:04 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo
Cc: Jiri Olsa, Namhyung Kim, Ian Rogers, linux-kernel
perf script documentation is missing several options relating to guests.
Add them.
Fixes: 15a108af1a18 ("perf script: Allow specifying the files to process guest samples")
Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
---
tools/perf/Documentation/perf-script.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
index 4c95e79e2c39..48ee42a891b6 100644
--- a/tools/perf/Documentation/perf-script.txt
+++ b/tools/perf/Documentation/perf-script.txt
@@ -487,6 +487,29 @@ include::itrace.txt[]
For itrace only show specified functions and their callees for
itrace. Multiple functions can be separated by comma.
+--guestmount=<path>::
+ Guest OS root file system mount directory. Users mount guest OS
+ root directories under <path> by a specific filesystem access method,
+ typically, sshfs.
+ For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
+[verse]
+ $ mkdir \~/guestmount
+ $ cd \~/guestmount
+ $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
+ $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
+ $ perf script --guestmount=~/guestmount
+
+--guestkallsyms=<path>::
+ Guest OS /proc/kallsyms file copy. perf reads it to get guest
+ kernel symbols. Users copy it out from guest OS.
+
+--guestmodules=<path>::
+ Guest OS /proc/modules file copy. perf reads it to get guest
+ kernel module information. Users copy it out from guest OS.
+
+--guestvmlinux=<path>::
+ Guest OS kernel vmlinux.
+
--switch-on EVENT_NAME::
Only consider events after this event is found.
--
2.25.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 2/3] perf inject: Fix missing guestmount option documentation
2022-08-11 17:04 [PATCH 0/3] perf tools: Fix missing guest option documentation Adrian Hunter
2022-08-11 17:04 ` [PATCH 1/3] perf script: " Adrian Hunter
@ 2022-08-11 17:04 ` Adrian Hunter
2022-08-11 17:04 ` [PATCH 3/3] perf tools: Tidy guest " Adrian Hunter
2022-08-11 21:50 ` [PATCH 0/3] perf tools: Fix missing " Arnaldo Carvalho de Melo
3 siblings, 0 replies; 5+ messages in thread
From: Adrian Hunter @ 2022-08-11 17:04 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo
Cc: Jiri Olsa, Namhyung Kim, Ian Rogers, linux-kernel
perf inject documentation is missing the guestmount option. Add it.
Fixes: 97406a7e4fa6 ("perf inject: Add support for injecting guest sideband events")
Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
---
tools/perf/Documentation/perf-inject.txt | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/tools/perf/Documentation/perf-inject.txt b/tools/perf/Documentation/perf-inject.txt
index 646aa31586ed..c741ca2107b1 100644
--- a/tools/perf/Documentation/perf-inject.txt
+++ b/tools/perf/Documentation/perf-inject.txt
@@ -102,6 +102,18 @@ include::itrace.txt[]
should be used, and also --buildid-all and --switch-events may be
useful.
+--guestmount=<path>::
+ Guest OS root file system mount directory. Users mount guest OS
+ root directories under <path> by a specific filesystem access method,
+ typically, sshfs.
+ For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
+[verse]
+ $ mkdir \~/guestmount
+ $ cd \~/guestmount
+ $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
+ $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
+ $ perf inject --guestmount=~/guestmount
+
SEE ALSO
--------
linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1],
--
2.25.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 3/3] perf tools: Tidy guest option documentation
2022-08-11 17:04 [PATCH 0/3] perf tools: Fix missing guest option documentation Adrian Hunter
2022-08-11 17:04 ` [PATCH 1/3] perf script: " Adrian Hunter
2022-08-11 17:04 ` [PATCH 2/3] perf inject: Fix missing guestmount " Adrian Hunter
@ 2022-08-11 17:04 ` Adrian Hunter
2022-08-11 21:50 ` [PATCH 0/3] perf tools: Fix missing " Arnaldo Carvalho de Melo
3 siblings, 0 replies; 5+ messages in thread
From: Adrian Hunter @ 2022-08-11 17:04 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo
Cc: Jiri Olsa, Namhyung Kim, Ian Rogers, linux-kernel
Move common guest options into include files. Use attribute substitution to
customize an example, using "[verse]" to define the block instead of a
"literal" block which does not permit substitution.
Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
---
tools/perf/Documentation/guest-files.txt | 16 +++++++++++++
tools/perf/Documentation/guestmount.txt | 11 +++++++++
tools/perf/Documentation/perf-inject.txt | 14 +++---------
tools/perf/Documentation/perf-kvm.txt | 25 ++++----------------
tools/perf/Documentation/perf-script.txt | 29 +++---------------------
5 files changed, 38 insertions(+), 57 deletions(-)
create mode 100644 tools/perf/Documentation/guest-files.txt
create mode 100644 tools/perf/Documentation/guestmount.txt
diff --git a/tools/perf/Documentation/guest-files.txt b/tools/perf/Documentation/guest-files.txt
new file mode 100644
index 000000000000..8cc0b092f996
--- /dev/null
+++ b/tools/perf/Documentation/guest-files.txt
@@ -0,0 +1,16 @@
+include::guestmount.txt[]
+
+--guestkallsyms=<path>::
+ Guest OS /proc/kallsyms file copy. perf reads it to get guest
+ kernel symbols. Users copy it out from guest OS.
+
+--guestmodules=<path>::
+ Guest OS /proc/modules file copy. perf reads it to get guest
+ kernel module information. Users copy it out from guest OS.
+
+--guestvmlinux=<path>::
+ Guest OS kernel vmlinux.
+
+--guest-code::
+ Indicate that guest code can be found in the hypervisor process,
+ which is a common case for KVM test programs.
diff --git a/tools/perf/Documentation/guestmount.txt b/tools/perf/Documentation/guestmount.txt
new file mode 100644
index 000000000000..6edf12363add
--- /dev/null
+++ b/tools/perf/Documentation/guestmount.txt
@@ -0,0 +1,11 @@
+--guestmount=<path>::
+ Guest OS root file system mount directory. Users mount guest OS
+ root directories under <path> by a specific filesystem access method,
+ typically, sshfs.
+ For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
+[verse]
+ $ mkdir \~/guestmount
+ $ cd \~/guestmount
+ $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
+ $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
+ $ perf {GMEXAMPLECMD} --guestmount=~/guestmount {GMEXAMPLESUBCMD}
diff --git a/tools/perf/Documentation/perf-inject.txt b/tools/perf/Documentation/perf-inject.txt
index c741ca2107b1..ffc293fdf61d 100644
--- a/tools/perf/Documentation/perf-inject.txt
+++ b/tools/perf/Documentation/perf-inject.txt
@@ -102,17 +102,9 @@ include::itrace.txt[]
should be used, and also --buildid-all and --switch-events may be
useful.
---guestmount=<path>::
- Guest OS root file system mount directory. Users mount guest OS
- root directories under <path> by a specific filesystem access method,
- typically, sshfs.
- For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
-[verse]
- $ mkdir \~/guestmount
- $ cd \~/guestmount
- $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
- $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
- $ perf inject --guestmount=~/guestmount
+:GMEXAMPLECMD: inject
+:GMEXAMPLESUBCMD:
+include::guestmount.txt[]
SEE ALSO
--------
diff --git a/tools/perf/Documentation/perf-kvm.txt b/tools/perf/Documentation/perf-kvm.txt
index 83c742adf86e..2ad3f5d9f72b 100644
--- a/tools/perf/Documentation/perf-kvm.txt
+++ b/tools/perf/Documentation/perf-kvm.txt
@@ -77,26 +77,11 @@ OPTIONS
Collect host side performance profile.
--guest::
Collect guest side performance profile.
---guestmount=<path>::
- Guest os root file system mount directory. Users mounts guest os
- root directories under <path> by a specific filesystem access method,
- typically, sshfs. For example, start 2 guest os. The one's pid is 8888
- and the other's is 9999.
- #mkdir ~/guestmount; cd ~/guestmount
- #sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
- #sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
- #perf kvm --host --guest --guestmount=~/guestmount top
---guestkallsyms=<path>::
- Guest os /proc/kallsyms file copy. 'perf' kvm' reads it to get guest
- kernel symbols. Users copy it out from guest os.
---guestmodules=<path>::
- Guest os /proc/modules file copy. 'perf' kvm' reads it to get guest
- kernel module information. Users copy it out from guest os.
---guestvmlinux=<path>::
- Guest os kernel vmlinux.
---guest-code::
- Indicate that guest code can be found in the hypervisor process,
- which is a common case for KVM test programs.
+
+:GMEXAMPLECMD: kvm --host --guest
+:GMEXAMPLESUBCMD: top
+include::guest-files.txt[]
+
-v::
--verbose::
Be more verbose (show counter open errors, etc).
diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
index 48ee42a891b6..68e37de5fae4 100644
--- a/tools/perf/Documentation/perf-script.txt
+++ b/tools/perf/Documentation/perf-script.txt
@@ -487,29 +487,6 @@ include::itrace.txt[]
For itrace only show specified functions and their callees for
itrace. Multiple functions can be separated by comma.
---guestmount=<path>::
- Guest OS root file system mount directory. Users mount guest OS
- root directories under <path> by a specific filesystem access method,
- typically, sshfs.
- For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
-[verse]
- $ mkdir \~/guestmount
- $ cd \~/guestmount
- $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
- $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
- $ perf script --guestmount=~/guestmount
-
---guestkallsyms=<path>::
- Guest OS /proc/kallsyms file copy. perf reads it to get guest
- kernel symbols. Users copy it out from guest OS.
-
---guestmodules=<path>::
- Guest OS /proc/modules file copy. perf reads it to get guest
- kernel module information. Users copy it out from guest OS.
-
---guestvmlinux=<path>::
- Guest OS kernel vmlinux.
-
--switch-on EVENT_NAME::
Only consider events after this event is found.
@@ -530,9 +507,9 @@ include::itrace.txt[]
The known limitations include exception handing such as
setjmp/longjmp will have calls/returns not match.
---guest-code::
- Indicate that guest code can be found in the hypervisor process,
- which is a common case for KVM test programs.
+:GMEXAMPLECMD: script
+:GMEXAMPLESUBCMD:
+include::guest-files.txt[]
SEE ALSO
--------
--
2.25.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 0/3] perf tools: Fix missing guest option documentation
2022-08-11 17:04 [PATCH 0/3] perf tools: Fix missing guest option documentation Adrian Hunter
` (2 preceding siblings ...)
2022-08-11 17:04 ` [PATCH 3/3] perf tools: Tidy guest " Adrian Hunter
@ 2022-08-11 21:50 ` Arnaldo Carvalho de Melo
3 siblings, 0 replies; 5+ messages in thread
From: Arnaldo Carvalho de Melo @ 2022-08-11 21:50 UTC (permalink / raw)
To: Adrian Hunter; +Cc: Jiri Olsa, Namhyung Kim, Ian Rogers, linux-kernel
Em Thu, Aug 11, 2022 at 08:04:08PM +0300, Adrian Hunter escreveu:
> Hi
>
> Here are a couple of small documentation fixes and subsequent corresponding
> tidy-up.
Thanks, applied.
- Arnaldo
>
> Adrian Hunter (3):
> perf script: Fix missing guest option documentation
> perf inject: Fix missing guestmount option documentation
> perf tools: Tidy guest option documentation
>
> tools/perf/Documentation/guest-files.txt | 16 ++++++++++++++++
> tools/perf/Documentation/guestmount.txt | 11 +++++++++++
> tools/perf/Documentation/perf-inject.txt | 4 ++++
> tools/perf/Documentation/perf-kvm.txt | 25 +++++--------------------
> tools/perf/Documentation/perf-script.txt | 6 +++---
> 5 files changed, 39 insertions(+), 23 deletions(-)
> create mode 100644 tools/perf/Documentation/guest-files.txt
> create mode 100644 tools/perf/Documentation/guestmount.txt
>
>
> Regards
> Adrian
--
- Arnaldo
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-08-11 21:50 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-11 17:04 [PATCH 0/3] perf tools: Fix missing guest option documentation Adrian Hunter
2022-08-11 17:04 ` [PATCH 1/3] perf script: " Adrian Hunter
2022-08-11 17:04 ` [PATCH 2/3] perf inject: Fix missing guestmount " Adrian Hunter
2022-08-11 17:04 ` [PATCH 3/3] perf tools: Tidy guest " Adrian Hunter
2022-08-11 21:50 ` [PATCH 0/3] perf tools: Fix missing " Arnaldo Carvalho de Melo
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).