Menu
▾
▴
[oprof-cvs] CVS: oprofile/doc oprofile.1.in,1.13,1.14 oprofile.sgml,1.43,1.44
|
From: Philippe E. <ph...@us...> - 2001-11-06 21:38:18
|
Update of /cvsroot/oprofile/oprofile/doc In directory usw-pr-cvs1:/tmp/cvs-serv26014/oprofile/doc Modified Files: oprofile.1.in oprofile.sgml Log Message: doc: update - pp: opf_filter options handling issues Index: oprofile.1.in =================================================================== RCS file: /cvsroot/oprofile/oprofile/doc/oprofile.1.in,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- oprofile.1.in 2001/10/11 04:01:50 1.13 +++ oprofile.1.in 2001/11/06 21:38:15 1.14 @@ -39,210 +39,222 @@ .B op_start options .br .TP -.I "--help" +.BI "--help" List help .br .TP -.I "--list-events" +.BI "--list-events" Show available events for the hardware counters .br .TP -.I "--map-file" +.BI "--map-file " filename specify System.map for running kernel .br .TP -.I "--vmlinux" +.BI "--vmlinux " filename specify vmlinux kernel image .br .TP -.I "--ctrX-event" +.BI "--ctrX-event " event_name symbolic event name for counter X .br .TP -.I "--ctrX-count" +.BI "--ctrX-count " count_nr number of events between samples for counter X .br .TP -.I "--ctrX-unit-mask" +.BI "--ctrX-unit-mask " unit_mask unit mask for counter X .br .TP -.I "--ctrX-kernel" +.BI "--ctrX-kernel" whether to count kernel events for counter X .br .TP -.I "--ctrX-user" +.BI "--ctrX-user" whether to count user events for counter X .br .TP -.I "--buffer-size" +.BI "--buffer-size " nr number of samples in kernel buffer .br .TP -.I "--hash-table-size" +.BI "--hash-table-size " nr number of entries in kernel hash table .br .TP -.I "--kernel-only" +.BI "--note-table-size " nr +number of entries in kernel note table +.br +.TP +.BI "--kernel-only " profile only the kernel .br .TP -.I "--pid-filter" -Only profile process pid (if compiled in) +.BI "--pid-filter " pid +Only profile process pid .br .TP -.I "--pgrp-filter" -Only profile process group pgrp (if compiled in) +.BI "--pgrp-filter " pgrp +Only profile process group pgrp .br .TP -.I "--ignore-myself" +.BI "--ignore-myself " ignore samples for oprofiled .br .TP -.I "--log-file" +.BI "--log-file " filename specify log file .br .TP -.I "--base-dir" +.BI "--base-dir " dirname base directory of daemon .br .TP -.I "--samples-dir" +.BI "--samples-dir " dirname output samples directory .br .TP -.I "--device-file" +.BI "--device-file " filename profile device file .br .TP -.I "--hash-map-device-file" +.BI "--hash-map-device-file " filename profile hash map device file .br .TP -.I "--verbose" +.BI "--verbose" be verbose in the daemon log .PP .br .B oprofpp options .br .TP -.I "--help" +.BI "--help -? --usage" Show help message .br .TP -.I "--samples-file" +.BI "--samples-file " filename ", -f "filename image sample file .br .TP -.I "--image-file" +.BI "--image-file " filename ", -i "filename image file .br .TP -.I "--list-symbols" +.BI "--list-symbols -l" list samples by symbol .br .TP -.I "--dump-gprof-file" +.BI "--dump-gprof-file " filename ", -g "filename dump gprof format file .br .TP -.I "--list-symbol" -give detailed samples for a symbol +.BI "--list-symbol " name ", -s "name +give detailed samples for the symbol name .br .TP -.I "--base-dir" +.BI "--base-dir " directory_name ", -b "directory_name .br .TP -.I "--list-all-symbols-details" +.BI "--list-all-symbols-details -L" give detailed samples for all symbols .br .TP -.I "--output-linenr-info" +.BI "--output-linenr-info -o" output filename:linenr info for all samples, usable only with --list-all-symbols-details .br .TP -.I "--demangle" +.BI "--demangle -d" demangle GNU C++ symbol names .br .TP -.I "--counter" +.BI "--counter " counter_nr ", -c "counter_nr which counter to use .br .TP -.I "--version" +.BI "--version -v" show version .br .TP -.I "--verbose" +.BI "--verbose -V" verbose output .br .TP -.I "--base-dir" +.BI "--base-dir " dir_name ", -b "dirname base directory of profile daemon .PP .br .B op_to_source options .br .TP -.I "--help" +.BI "--help -? --usage" Show help message .br .TP -.I "--samples-file" +.BI "--samples-file " filename ", -f "filename image sample file .br .TP -.I "--image-file" +.BI "--image-file " filename ", -i "filename image file .br .TP -.I "--demangle" +.BI "--demangle -d" demangle GNU C++ symbol names .br .TP -.I "--assembly" +.BI "--assembly -a" output assembly code .br .TP -.I "--source-dir base_directory" +.BI "--source-dir " base_directory if you request for annotated source this option give the base directory where come the source file. All source file outside this base directory are ignored .br .TP -.I "--output-dir base_directory" +.BI "--output-dir " base_directory output base directory where annotated source file are generated. If you do not specify --source-dir neither --output-dir annotated source file go to stdout .br .TP -.I "--output patterns" +.BI "--output " patterns if you request for annotated source this option give a list of patterns separated by "," so only source filename that match one of this pattern are output. This option have no effect if --source-dir or --output-dir have not been set. .br .TP -.I "--no-output patterns" +.BI "--no-output " patterns filename matched by the --output option can be filtered by one of the patterns given with this option. .br .TP -.I "--source-with-assembly" +.BI "--source-with-assembly -s" output assembly mixed with source file .br .TP -.I "--until-more-than-samples percent_samples" -output source or assembly symbol until percent_samples are reached +.BI "--until-more-than-samples " percent_nr ", -m "percent_nr +output source files until the amount of samples in these files reach percent_nr samples .br .TP -.I "--with-more-than-samples percent_samples" -output source or assembly symbol with more than percent_samples +.BI "--with-more-than-samples " percent_nr ", -w "percent_nr +output source files which contains more than percent_nr samples .br .TP -.I "--sort-by-counter" +.BI "--sort-by-counter " counter_nr ", -c "counter_nr which counter to use for sorting purposes .br .TP -.I "--version" +.BI "--version -v" show version .br .TP +.BI "--verbose -V" +verbose output +.br +.TP +.BI "--base-dir " dirname ", -b "dirname +base directory of profile daemon +.br +.TP .B oprof_convert filename [filenames] The oprof_convert utility is only needed when upgrading the profiler version. Further details can be found in the HTML documentation. @@ -281,7 +293,7 @@ .I /var/opd/oprofiled.log The user-space daemon logfile. .TP -.I /var/opd/opdev, /var/opd/ophashmapdev +.I /var/opd/opdev, /var/opd/ophashmapdev, /var/opd/opnotedev The device files for communication with the kernel module. .TP .I /var/opd/samples/ Index: oprofile.sgml =================================================================== RCS file: /cvsroot/oprofile/oprofile/doc/oprofile.sgml,v retrieving revision 1.43 retrieving revision 1.44 diff -u -d -r1.43 -r1.44 --- oprofile.sgml 2001/10/25 18:37:09 1.43 +++ oprofile.sgml 2001/11/06 21:38:15 1.44 @@ -311,7 +311,7 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—buffer-size</option></term> + <term><option>—buffer-size</option> nr</term> <listitem><para> This is the number of entries in the kernel-side profiling buffer. Generally the default value is fine: you might want to change this on low-memory machines, or if you are doing very detailed profiling. @@ -319,7 +319,7 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—hash-table-size</option></term> + <term><option>—hash-table-size</option> nr</term> <listitem><para> This is the number of entries in the kernel-side profiling hash table. Generally the default value is fine: you might want to change this on low-memory machines, or if you are doing very detailed profiling. @@ -327,7 +327,15 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—kernel-only</option></term> + <term><option>—note-table-size</option> nr</term> + <listitem><para> + This is the number of entries in the kernel note table. Generally the default value + is fine: you might want to change this on low-memory machines, or if you are doing very detailed profiling. + Each entry in the buffer takes 20 bytes. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>—kernel-only</option> nr</term> <listitem><para> Default is to profile both user-space and the kernel. You can profile only the kernel with this option; this does not prevent the occasional user-space sample due to the hardware constraints, but reduces the @@ -335,14 +343,14 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—map-file</option></term> + <term><option>—map-file</option> <filename>filename</filename</term> <listitem><para> Specify the <filename>System.map</filename> file from the current kernel's compile. This must match the running kernel if you expect meaningful profiles of the kernel. </para></listitem> </varlistentry> <varlistentry> - <term><option>—vmlinux</option></term> + <term><option>—vmlinux</option> <filename>filename</filename></term> <listitem><para> Specify the <filename>vmlinux</filename> file from the current kernel's compile. This must match the running kernel if you expect meaningful profiles of the kernel. Note that this is separate file @@ -351,14 +359,14 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—pid-filter</option></term> + <term><option>—pid-filter</option> pid</term> <listitem><para> Only samples of this process id will be collected (including any kernel-side samples when this process is in the kernel). Note that threaded programs under Linux have a different process id for each thread. </para></listitem> </varlistentry> <varlistentry> - <term><option>—pgrp-filter</option></term> + <term><option>—pgrp-filter</option> pgpr</term> <listitem><para> Only samples of this process group id will be collected (including any kernel-side samples when this process is in the kernel). @@ -505,6 +513,12 @@ </para></listitem> </varlistentry> <varlistentry> + <term><filename>notesize</filename></term> + <listitem><para> + The note table size, corresponding to the <option>—note-table-size</option> option. + </para></listitem> + </varlistentry> + <varlistentry> <term><filename>kernel_only</filename></term> <listitem><para> Corresponding to the <option>—kernel-only</option> option. @@ -692,14 +706,16 @@ Some interesting options of the post-processor : <variablelist> <varlistentry> - <term><option>—samples-file</option></term> + <term><option>—samples-file</option> <filename>filename</filename></term> + <term><option>-f</option> <filename>filename</filename></term> <listitem><para> The samples file to use. This is not necessary, as it can be derived from the filename of the absolute-path-specified binary image. </para></listitem> </varlistentry> <varlistentry> - <term><option>—image-file</option></term> + <term><option>—image-file</option> <filename>filename</filename></term> + <term><option>-i</option> <filename>filename</filename></term> <listitem><para> The binary image (shared library, kernel vmlinux, or program) to produce data for. </para></listitem> @@ -711,25 +727,28 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—counter</option></term> + <term><option>—counter</option> nr</term> <listitem><para> - Which counter (0 - 3) to extract information for. + Which counter (0 - N) to extract information for. N is dependant of your cpu type 1 for Intel P2 core based cpu, 3 for Athlon based cpu. </para></listitem> </varlistentry> <varlistentry> <term><option>—list-symbols</option></term> + <term><option>-l</option></term> <listitem><para> List a histogram of sample counts against symbols. </para></listitem> </varlistentry> <varlistentry> - <term><option>—list-symbol</option></term> + <term><option>—list-symbol</option> name</term> + <term><option>-s</option> name</term> <listitem><para> - Provide a detailed listing for the specified symbol. + Provide a detailed listing for the specified symbol name. </para></listitem> </varlistentry> <varlistentry> <term><option>—dump-gprof-file filename</option></term> + <term><option>-g filename</option></term> <listitem><para> Dump output to the specified file in <command>gprof</command> format. If you specify <filename>gmon.out</filename>, you can then call <command>gprof -p <binary></command>. @@ -773,6 +792,7 @@ <variablelist> <varlistentry> <term><option>—assembly</option></term> + <term><option>-a</option></term> <listitem><para> <!-- FIXME: update if this changes --> Output assembly code. Currently the assembly code is sorted in increasing order on the vma @@ -781,7 +801,7 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—source-dir</option></term> + <term><option>—source-dir</option> <filename>dirname</filename></term> <listitem><para> This option is used in conjunction with <option>—output-dir</option>. You can use it to specify the base directory of the source which you wish to produce @@ -790,7 +810,7 @@ </para></listitem> </varlistentry> <varlistentry> - <term><option>—output-dir</option></term> + <term><option>—output-dir</option> <filename>dirname</filename></term> <listitem><para> Specify that you want to produce an annotated source tree, rather than getting all output to stdout. This creates a hierarchy of annotated source files, and is affected by the <option>—source-dir</option>, @@ -825,41 +845,48 @@ </varlistentry> <varlistentry> <term><option>—source-with-assembly</option></term> + <term><option>-s</option></term> <listitem><para> Output assembly code mixed with the source file, implies <option>—assembly</option>. </para></listitem> </varlistentry> <varlistentry> <term><option>—sort-by-counter counter_nr</option></term> + <term><option>-c counter_nr</option></term> <listitem><para> Sort by decreasing number of samples on counter_nr. For assembly output this option provides only a filtering and not a sort order. </para></listitem> </varlistentry> <varlistentry> - <term><option>—with-more-than-samples percent_samples</option></term> + <term><option>—with-more-than-samples percent_nr</option></term> + <term><option>-w percent_nr</option></term> <listitem><para> - Output source file or assembly symbol which contains at least <option>percent_samples</option>. + Output source file which contains at least <option>percent_nr</option> samples. Can not be combined with <option>—until-more-than-samples</option>. </para></listitem> </varlistentry> <varlistentry> - <term><option>—until-more-than-samples percent_samples</option></term> + <term><option>—until-more-than-samples percent_nr</option></term> + <term><option>-m percent_nr</option></term> <listitem><para> <!-- FIXME: it's unclear what this means exactly ? --> - Output source file or assembly symbol until the amount of samples outputted reach percent_samples. + <!-- FIXME: John is it enough clear now ? --> + Output source files until the amount of samples in these files reach percent_nr samples. Can not be combined with <option>—with-more-than-samples</option>. </para></listitem> </varlistentry> <varlistentry> - <term><option>—samples-file</option></term> + <term><option>—samples-file</option> <filename>filename</filename></term> + <term><option>-f</option> <filename>filename</filename></term> <listitem><para> Specify the samples file. At least one of the <option>—samples-file</option> or <option>—image-file</option> must be specifed. </para></listitem> </varlistentry> <varlistentry> - <term><option>—image-file</option></term> + <term><option>—image-file</option> <filename>filename</filename></term> + <term><option>-i </option> <filename>filename</filename></term> <listitem><para> Specify the image file. </para></listitem> |