opannotate(1)

1OPANNOTATE(1)               General Commands Manual              OPANNOTATE(1)
2
3
4

NAME

6       opannotate - produce source or assembly annotated with profile data
7

SYNOPSIS

9       opannotate [ options ] [profile specification]
10

DESCRIPTION

12       opannotate  outputs  annotated source and/or assembly from profile data
13       of an OProfile session. See oprofile(1) for how to write profile speci‐
14       fications.
15
16

OPTIONS

18       --assembly / -a
19              Output  annotated assembly. The binary file to be annotated does
20              not need full debugging information to use this option, but sym‐
21              bol information is required. Without symbol information, opanno‐
22              tate will silently refuse  to  annotate  the  binary.   If  this
23              option  is  combined with --source, then mixed source / assembly
24              annotations are output.
25
26       --demangle / -D none|smart|normal
27              none: no demangling. normal:  use  default  demangler  (default)
28              smart:  use  pattern-matching to make C++ symbol demangling more
29              readable.
30
31       --exclude-dependent / -x
32              Do not include application-specific images for libraries, kernel
33              modules and the kernel. This option only makes sense if the pro‐
34              file session used --separate.
35
36       --exclude-file [files]
37              Exclude all files in the given comma-separated list of glob pat‐
38              terns.
39
40       --exclude-symbols / -e [symbols]
41              Exclude all the symbols in the given comma-separated list.
42
43       --help / -? / --usage
44              Show help message.
45
46       --image-path / -p [paths]
47              Comma-separated list of additional paths to search for binaries.
48              This is needed to find modules in kernels 2.6 and upwards.
49
50       --root / -R [path]
51              A path to a filesystem to search for additional binaries.
52
53       --include-file [files]
54              Only include files in the given  comma-separated  list  of  glob
55              patterns.
56
57       --merge / -m [lib,cpu,tid,tgid,unitmask,all]
58              Merge any profiles separated in a --separate session.
59
60       --include-symbols / -i [symbols]
61              Only include symbols in the given comma-separated list.
62
63       --objdump-params [params]
64              Pass  the given parameters as extra values when calling objdump.
65              If more than one option is to be passed to objdump, the  parame‐
66              ters must be enclosed in a quoted string.
67
68              An example of where this option is useful is when your toolchain
69              does not automatically recognize instructions that are  specific
70              to  your  processor.  For example, on IBM POWER7/RHEL 6, objdump
71              must be  told  that  a  binary  file  may  have  POWER7-specific
72              instructions.  The opannotate option to show the POWER7-specific
73              instructions is:
74                 --objdump-params=-Mpower7
75
76              The opannotate option to show the POWER7-specific  instructions,
77              the source code (--source) and the line numbers (-l) would be:
78                 --objdump-params="-Mpower7 -l --source"
79
80
81       --output-dir / -o [dir]
82              Output  directory.  This  makes  opannotate output one annotated
83              file for each source file. This option can't be used in conjunc‐
84              tion with --assembly.
85
86       --search-dirs / -d [paths]
87              Comma-separated  list  of  paths to search for source files. You
88              may need to use this option when the debug  information  for  an
89              image contains relative paths.
90
91       --base-dirs / -b [paths]
92              Comma-separated  list of paths to strip from debug source files,
93              prior to looking for them in --search-dirs.
94
95       --session-dir=dir_path
96              Use  sample  database  from  the  specified  directory  dir_path
97              instead of the default locations. If --session-dir is not speci‐
98              fied,  then  opannotate  will  search  for  samples   in   <cur‐
99              rent_dir>/oprofile_data first. If that directory does not exist,
100              the standard session-dir of /var/lib/oprofile is used.
101
102       --source / -s
103              Output annotated source. This requires debugging information  to
104              be available for the binaries.
105
106       --threshold / -t [percentage]
107              Only  output data for symbols that have more than the given per‐
108              centage of total samples.
109
110       --verbose / -V [options]
111              Give verbose debugging output.
112
113       --version / -v
114              Show version.
115
116

ENVIRONMENT

118       No special environment variables are recognised by opannotate.
119
120

FILES

122       <current_dir>/oprofile_data/samples
123              Or
124       /var/lib/oprofile/samples/
125
126              The location of the generated sample files.
127
128

VERSION

130       This man page is current for oprofile-0.9.9.
131
132