From: William C. <wc...@re...> - 2013-07-05 16:08:40
|
A recent review at Red Hat of the oprofile man pages showed a number of options that the man pages missed. Also a couple of executable (oprof_start and op-check-perfevents) that didn't have any man pages. This series of patches updates the man pages to better document what is availabe in oprofile. William Cohen (7): Add the "--no-header" short form option, "-n", to the opreport man page Document all the ophelp command options Add the --merge option description to opannotate man page. Document the opcontrol short form options on the man page Add a short man page for op-check-perfevents. Add man page for oprof_start. Remove obsolete --note-table-size option from opcontrol configure.ac | 2 ++ doc/Makefile.am | 2 ++ doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++ doc/opannotate.1.in | 4 ++++ doc/opcontrol.1.in | 24 ++++++++++++------------ doc/ophelp.1.in | 22 ++++++++++++++++++++++ doc/opreport.1.in | 2 +- doc/oprof_start.1.in | 43 +++++++++++++++++++++++++++++++++++++++++++ utils/opcontrol | 13 ------------- 9 files changed, 122 insertions(+), 26 deletions(-) create mode 100644 doc/op-check-perfevents.1.in create mode 100644 doc/oprof_start.1.in -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:41
|
Signed-off-by: William Cohen <wc...@re...> --- doc/opreport.1.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/opreport.1.in b/doc/opreport.1.in index 57e5ed8..46acf02 100644 --- a/doc/opreport.1.in +++ b/doc/opreport.1.in @@ -77,7 +77,7 @@ Output full paths instead of basenames. Merge any profiles separated in a --separate session. .br .TP -.BI "--no-header" +.BI "--no-header / -n" Don't output a header detailing profiling parameters. .br .TP -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:42
|
There were some options missing from the ophelp man page. Added information about the following options: --get-default-event / -d --check-events / -e [events] --callgraph [callgraph_depth] --unit-mask / -u [event] --extra-mask / -E [event] Signed-off-by: William Cohen <wc...@re...> --- doc/ophelp.1.in | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/ophelp.1.in b/doc/ophelp.1.in index 3548d74..083cc85 100644 --- a/doc/ophelp.1.in +++ b/doc/ophelp.1.in @@ -27,6 +27,28 @@ Show the events for the given numerical CPU type. Show the symbolic CPU name. .br .TP +.BI "--get-default-event / -d" +.br +Show the default event for the specified CPU type. +.TP +.BI "--check-events / -e [events]" +Check the given space-separated event descriptions for validity. +If the events are valid, show which pmu counter each event would be assigned to. +.br +.TP +.BI "--callgraph [callgraph_depth]" +Use the callgraph depth to compute the higher minimum sampling intervals +for the events. +.br +.TP +.BI "--unit-mask / -u [event]" +Show the default unit mask for the given event. +.br +.TP +.BI "--extra-mask / -E [event]" +Show the extra unit mask for given event. +.br +.TP .BI "--xml / -X" List events in XML format. .br -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:44
|
Signed-off-by: William Cohen <wc...@re...> --- configure.ac | 1 + doc/Makefile.am | 1 + doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 doc/op-check-perfevents.1.in diff --git a/configure.ac b/configure.ac index a985d1d..39b8af9 100644 --- a/configure.ac +++ b/configure.ac @@ -426,6 +426,7 @@ AC_OUTPUT(Makefile \ doc/oprofile.1 \ doc/opcontrol.1 \ doc/ophelp.1 \ + doc/op-check-perfevents.1 \ doc/opreport.1 \ doc/opannotate.1 \ doc/opgprof.1 \ diff --git a/doc/Makefile.am b/doc/Makefile.am index 68d472b..a78943b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -15,6 +15,7 @@ man_MANS = \ opannotate.1 \ opgprof.1 \ ophelp.1 \ + op-check-perfevents.1 \ oparchive.1 \ opimport.1 diff --git a/doc/op-check-perfevents.1.in b/doc/op-check-perfevents.1.in new file mode 100644 index 0000000..79c8e01 --- /dev/null +++ b/doc/op-check-perfevents.1.in @@ -0,0 +1,36 @@ +.TH OP-CHECK-PERFEVENTS 1 "@DATE@" "oprofile @VERSION@" +.UC 4 +.SH NAME +op-check-perfevents \- checks for kernel perf pmu support +.SH SYNOPSIS +.br +.B op-check-perfevents +[ +.I options +] +.SH DESCRIPTION + +The small helper program +.B op-check-perfevents +determines whether the kernel supports the perf interface +and returns a zero exit status if the perf pmu support is available. +.SH OPTIONS +.TP +.BI "--help / -h" +Show usage help message. +.br +.TP +.BI "--verbose / -v" +Print string describing the error number of perf_event_open syscall +.br + +.SH ENVIRONMENT +No special environment variables are recognised by op-check-perfevents. + +.SH VERSION +.TP +This man page is current for @PACKAGE@-@VERSION@. + +.SH SEE ALSO +.BR @OP_DOCDIR@, +.BR oprofile(1) -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:45
|
Only the very old kernels (2.4) provided support for --note-table-size option. Given that other 2.4 support was removed from OProfile there isn't any reason to keep this around. Signed-off-by: William Cohen <wc...@re...> --- utils/opcontrol | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/utils/opcontrol b/utils/opcontrol index 9c9fe31..d87641e 100644 --- a/utils/opcontrol +++ b/utils/opcontrol @@ -233,9 +233,6 @@ opcontrol: usage: buffer-size. --cpu-buffer-size=num per-cpu buffer size in units (2.6 kernel) Same rules as defined for buffer-size. - --note-table-size kernel notes buffer size in notes units (2.4 - kernel) - --xen Xen image (for Xen only) --active-domains=<list> List of domains in profiling session (for Xen) (list contains domain ids separated by commas) @@ -939,16 +936,6 @@ do_options() ACTIVE_DOMAINS=$val DO_SETUP=yes ;; - --note-table-size) - if test "$KERNEL_SUPPORT" = "yes"; then - echo "\"$arg\" meaningless on this kernel" >&2 - exit 1 - else - error_if_not_number "$arg" "$val" - NOTE_SIZE=$val - fi - DO_SETUP=yes - ;; -i|--image) error_if_invalid_arg "$arg" "$val" if test "$val" = "all"; then -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:41
|
Signed-off-by: William Cohen <wc...@re...> --- doc/opannotate.1.in | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/opannotate.1.in b/doc/opannotate.1.in index ba57a38..394c82e 100644 --- a/doc/opannotate.1.in +++ b/doc/opannotate.1.in @@ -64,6 +64,10 @@ A path to a filesystem to search for additional binaries. Only include files in the given comma-separated list of glob patterns. .br .TP +.BI "--merge / -m [lib,cpu,tid,tgid,unitmask,all]" +Merge any profiles separated in a --separate session. +.br +.TP .BI "--include-symbols / -i [symbols]" Only include symbols in the given comma-separated list. .br -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:42
|
Mention the following opcontrol short form option: -? -V -c -d -e -h -i -l -p -s -t -v Signed-off-by: William Cohen <wc...@re...> --- doc/opcontrol.1.in | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/opcontrol.1.in b/doc/opcontrol.1.in index b7fbb98..2418336 100644 --- a/doc/opcontrol.1.in +++ b/doc/opcontrol.1.in @@ -15,15 +15,15 @@ dump profile data, and set up the profiling parameters. .SH OPTIONS .TP -.BI "--help" +.BI "--help / -?" Show help message. .br .TP -.BI "--version" +.BI "--version / -v" Show version. .br .TP -.BI "--list-events" +.BI "--list-events / -l" Shows the monitorable events. .br .TP @@ -45,20 +45,20 @@ Show configuration information. Start the oprofile daemon without starting profiling. .br .TP -.BI "--start" +.BI "--start / -s" Start data collection with either arguments provided by --setup or with information saved in ~root/.oprofile/daemonrc. .br .TP -.BI "--dump" +.BI "--dump / -d" Force a flush of the collected profiling data to the daemon. .br .TP -.BI "--stop" +.BI "--stop / -t" Stop data collection. .br .TP -.BI "--shutdown" +.BI "--shutdown / -h" Stop data collection and kill the daemon. .br .TP @@ -99,7 +99,7 @@ rate it can help to increase this if the log file show excessive count of sample lost cpu buffer overflow. Same rules as defined for buffer-size. .br .TP -.BI "--event="[event|"default"] +.BI "--event / -e "[event|"default"] Specify an event to measure for the hardware performance counters, or "default" for the default event. The event is of the form "CPU_CLK_UNHALTED:30000:0:1:1" where the numeric values are @@ -117,7 +117,7 @@ output). For some named unit masks, the hex value is not unique; thus, OProfile tools enforce specifying such unit masks value by name. .br .TP -.BI "--separate="[none,lib,kernel,thread,cpu,all] +.BI "--separate / -p "[none,lib,kernel,thread,cpu,all] Separate samples based on the given separator. 'lib' separates dynamically linked library samples per application. 'kernel' separates kernel and kernel module samples per application; 'kernel' @@ -126,13 +126,13 @@ task. 'cpu' separates for each CPU. 'all' implies all of the above options and 'none' turns off separation. .br .TP -.BI "--callgraph=#depth" +.BI "--callgraph / -c "[#depth] Enable callgraph sample collection with a maximum depth. Use 0 to disable callgraph profiling. This option is available on x86 using a 2.6+ kernel with callgraph support enabled. It is also available on PowerPC using a 2.6.17+ kernel. .br .TP -.BI "--image="[name,name...|"all"] +.BI "--image / -i "[name,name...|"all"] Only profile the given absolute paths to binaries, or "all" to profile everything (the default). .br @@ -146,7 +146,7 @@ Use this when you don't have a kernel vmlinux file, and you don't want to profile the kernel. .br .TP -.BI "--verbose" +.BI "--verbose / -V "[options] Be verbose in the daemon log. This has a high overhead. .br .TP -- 1.8.1.4 |
From: William C. <wc...@re...> - 2013-07-05 16:08:45
|
Signed-off-by: William Cohen <wc...@re...> --- configure.ac | 1 + doc/Makefile.am | 1 + doc/oprof_start.1.in | 43 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 doc/oprof_start.1.in diff --git a/configure.ac b/configure.ac index 39b8af9..fa94be6 100644 --- a/configure.ac +++ b/configure.ac @@ -427,6 +427,7 @@ AC_OUTPUT(Makefile \ doc/opcontrol.1 \ doc/ophelp.1 \ doc/op-check-perfevents.1 \ + doc/oprof_start.1 \ doc/opreport.1 \ doc/opannotate.1 \ doc/opgprof.1 \ diff --git a/doc/Makefile.am b/doc/Makefile.am index a78943b..da71748 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,6 +16,7 @@ man_MANS = \ opgprof.1 \ ophelp.1 \ op-check-perfevents.1 \ + oprof_start.1 \ oparchive.1 \ opimport.1 diff --git a/doc/oprof_start.1.in b/doc/oprof_start.1.in new file mode 100644 index 0000000..219df0e --- /dev/null +++ b/doc/oprof_start.1.in @@ -0,0 +1,43 @@ +.TH OPROF_START 1 "@DATE@" "oprofile @VERSION@" +.UC 4 +.SH NAME +oprof_start \- A GUI interface for OProfile +.SH SYNOPSIS +.br +.B oprof_start +[ +.I options +] +.SH DESCRIPTION + +The +.B oprof_start +application provides a GUI interface to control the operation of OProfile. +Running +.B oprof_start +requires root privileges and does not support +.B operf +due to +.B oprof_start +using the older +.B opcontrol +script. + +.SH ENVIRONMENT +No special environment variables are recognised by oprof_start. + +.SH FILES +.TP +.I /root/.oprofile/daemonrc +Configuration file for opcontrol +.TP +.I /var/lib/oprofile/samples/ +The location of the generated sample files. + +.SH VERSION +.TP +This man page is current for @PACKAGE@-@VERSION@. + +.SH SEE ALSO +.BR @OP_DOCDIR@, +.BR oprofile(1) -- 1.8.1.4 |
From: Maynard J. <may...@us...> - 2013-07-10 15:44:54
|
On 07/05/2013 11:08 AM, William Cohen wrote: > A recent review at Red Hat of the oprofile man pages showed a number > of options that the man pages missed. Also a couple of executable > (oprof_start and op-check-perfevents) that didn't have any man pages. > This series of patches updates the man pages to better document what > is availabe in oprofile. Will, Thanks for these patches. Sorry for the delay in reviewing them -- I've been tied up on another project. I'll try to get to them today. -Maynard > > William Cohen (7): > Add the "--no-header" short form option, "-n", to the opreport man > page > Document all the ophelp command options > Add the --merge option description to opannotate man page. > Document the opcontrol short form options on the man page > Add a short man page for op-check-perfevents. > Add man page for oprof_start. > Remove obsolete --note-table-size option from opcontrol > > configure.ac | 2 ++ > doc/Makefile.am | 2 ++ > doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++ > doc/opannotate.1.in | 4 ++++ > doc/opcontrol.1.in | 24 ++++++++++++------------ > doc/ophelp.1.in | 22 ++++++++++++++++++++++ > doc/opreport.1.in | 2 +- > doc/oprof_start.1.in | 43 +++++++++++++++++++++++++++++++++++++++++++ > utils/opcontrol | 13 ------------- > 9 files changed, 122 insertions(+), 26 deletions(-) > create mode 100644 doc/op-check-perfevents.1.in > create mode 100644 doc/oprof_start.1.in > |
From: William C. <wc...@re...> - 2013-07-15 17:19:57
|
On 07/10/2013 11:44 AM, Maynard Johnson wrote: > On 07/05/2013 11:08 AM, William Cohen wrote: >> A recent review at Red Hat of the oprofile man pages showed a number >> of options that the man pages missed. Also a couple of executable >> (oprof_start and op-check-perfevents) that didn't have any man pages. >> This series of patches updates the man pages to better document what >> is availabe in oprofile. > Will, > Thanks for these patches. Sorry for the delay in reviewing them -- I've been tied up on another project. I'll try to get to them today. > > -Maynard Hi Maynard, Any comments on the patches? If they look okay to you, I can go ahead and commit them to the git repo. -Will >> >> William Cohen (7): >> Add the "--no-header" short form option, "-n", to the opreport man >> page >> Document all the ophelp command options >> Add the --merge option description to opannotate man page. >> Document the opcontrol short form options on the man page >> Add a short man page for op-check-perfevents. >> Add man page for oprof_start. >> Remove obsolete --note-table-size option from opcontrol >> >> configure.ac | 2 ++ >> doc/Makefile.am | 2 ++ >> doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++ >> doc/opannotate.1.in | 4 ++++ >> doc/opcontrol.1.in | 24 ++++++++++++------------ >> doc/ophelp.1.in | 22 ++++++++++++++++++++++ >> doc/opreport.1.in | 2 +- >> doc/oprof_start.1.in | 43 +++++++++++++++++++++++++++++++++++++++++++ >> utils/opcontrol | 13 ------------- >> 9 files changed, 122 insertions(+), 26 deletions(-) >> create mode 100644 doc/op-check-perfevents.1.in >> create mode 100644 doc/oprof_start.1.in >> > > > ------------------------------------------------------------------------------ > See everything from the browser to the database with AppDynamics > Get end-to-end visibility with application monitoring from AppDynamics > Isolate bottlenecks and diagnose root cause in seconds. > Start your free trial of AppDynamics Pro today! > http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk > _______________________________________________ > oprofile-list mailing list > opr...@li... > https://lists.sourceforge.net/lists/listinfo/oprofile-list > |
From: Maynard J. <may...@us...> - 2013-07-15 22:48:59
|
On 07/15/2013 12:19 PM, William Cohen wrote: > On 07/10/2013 11:44 AM, Maynard Johnson wrote: >> On 07/05/2013 11:08 AM, William Cohen wrote: >>> A recent review at Red Hat of the oprofile man pages showed a number >>> of options that the man pages missed. Also a couple of executable >>> (oprof_start and op-check-perfevents) that didn't have any man pages. >>> This series of patches updates the man pages to better document what >>> is availabe in oprofile. >> Will, >> Thanks for these patches. Sorry for the delay in reviewing them -- I've been tied up on another project. I'll try to get to them today. >> >> -Maynard > > Hi Maynard, > > Any comments on the patches? If they look okay to you, I can go ahead and commit them to the git repo. Will, Very sorry for the delay. The patches look fine, except a couple of whitespace issues that 'git apply' complains about with patches 5 and 6. Yes, please go ahead and commit them, but make sure to include a one-liner description for each in the commit message. Thanks very much for these fixes. -Maynard > > -Will > >>> >>> William Cohen (7): >>> Add the "--no-header" short form option, "-n", to the opreport man >>> page >>> Document all the ophelp command options >>> Add the --merge option description to opannotate man page. >>> Document the opcontrol short form options on the man page >>> Add a short man page for op-check-perfevents. >>> Add man page for oprof_start. >>> Remove obsolete --note-table-size option from opcontrol >>> >>> configure.ac | 2 ++ >>> doc/Makefile.am | 2 ++ >>> doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++ >>> doc/opannotate.1.in | 4 ++++ >>> doc/opcontrol.1.in | 24 ++++++++++++------------ >>> doc/ophelp.1.in | 22 ++++++++++++++++++++++ >>> doc/opreport.1.in | 2 +- >>> doc/oprof_start.1.in | 43 +++++++++++++++++++++++++++++++++++++++++++ >>> utils/opcontrol | 13 ------------- >>> 9 files changed, 122 insertions(+), 26 deletions(-) >>> create mode 100644 doc/op-check-perfevents.1.in >>> create mode 100644 doc/oprof_start.1.in >>> >> >> >> ------------------------------------------------------------------------------ >> See everything from the browser to the database with AppDynamics >> Get end-to-end visibility with application monitoring from AppDynamics >> Isolate bottlenecks and diagnose root cause in seconds. >> Start your free trial of AppDynamics Pro today! >> http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk >> _______________________________________________ >> oprofile-list mailing list >> opr...@li... >> https://lists.sourceforge.net/lists/listinfo/oprofile-list >> > |