components/llvm/Solaris/man1/llvm-symbolizer.1
changeset 6512 92717ce71105
equal deleted inserted replaced
6511:d283aa33e131 6512:92717ce71105
       
     1 .\" Man page generated from reStructuredText.
       
     2 .
       
     3 .TH "LLVM-SYMBOLIZER" "1" "2016-07-10" "3.8" "LLVM"
       
     4 .SH NAME
       
     5 llvm-symbolizer \- convert addresses into source code locations
       
     6 .
       
     7 .nr rst2man-indent-level 0
       
     8 .
       
     9 .de1 rstReportMargin
       
    10 \\$1 \\n[an-margin]
       
    11 level \\n[rst2man-indent-level]
       
    12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
       
    13 -
       
    14 \\n[rst2man-indent0]
       
    15 \\n[rst2man-indent1]
       
    16 \\n[rst2man-indent2]
       
    17 ..
       
    18 .de1 INDENT
       
    19 .\" .rstReportMargin pre:
       
    20 . RS \\$1
       
    21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
       
    22 . nr rst2man-indent-level +1
       
    23 .\" .rstReportMargin post:
       
    24 ..
       
    25 .de UNINDENT
       
    26 . RE
       
    27 .\" indent \\n[an-margin]
       
    28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
       
    29 .nr rst2man-indent-level -1
       
    30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
       
    31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
       
    32 ..
       
    33 .SH SYNOPSIS
       
    34 .sp
       
    35 \fBllvm\-symbolizer\fP [options]
       
    36 .SH DESCRIPTION
       
    37 .sp
       
    38 \fBllvm\-symbolizer\fP reads object file names and addresses from standard
       
    39 input and prints corresponding source code locations to standard output.
       
    40 If object file is specified in command line, \fBllvm\-symbolizer\fP
       
    41 processes only addresses from standard input, the rest is output verbatim.
       
    42 This program uses debug info sections and symbol table in the object files.
       
    43 .SH EXAMPLE
       
    44 .INDENT 0.0
       
    45 .INDENT 3.5
       
    46 .sp
       
    47 .nf
       
    48 .ft C
       
    49 $ cat addr.txt
       
    50 a.out 0x4004f4
       
    51 /tmp/b.out 0x400528
       
    52 /tmp/c.so 0x710
       
    53 /tmp/mach_universal_binary:i386 0x1f84
       
    54 /tmp/mach_universal_binary:x86_64 0x100000f24
       
    55 $ llvm\-symbolizer < addr.txt
       
    56 main
       
    57 /tmp/a.cc:4
       
    58 
       
    59 f(int, int)
       
    60 /tmp/b.cc:11
       
    61 
       
    62 h_inlined_into_g
       
    63 /tmp/header.h:2
       
    64 g_inlined_into_f
       
    65 /tmp/header.h:7
       
    66 f_inlined_into_main
       
    67 /tmp/source.cc:3
       
    68 main
       
    69 /tmp/source.cc:8
       
    70 
       
    71 _main
       
    72 /tmp/source_i386.cc:8
       
    73 
       
    74 _main
       
    75 /tmp/source_x86_64.cc:8
       
    76 $ cat addr2.txt
       
    77 0x4004f4
       
    78 0x401000
       
    79 $ llvm\-symbolizer \-obj=a.out < addr2.txt
       
    80 main
       
    81 /tmp/a.cc:4
       
    82 
       
    83 foo(int)
       
    84 /tmp/a.cc:12
       
    85 $cat addr.txt
       
    86 0x40054d
       
    87 $llvm\-symbolizer \-inlining \-print\-address \-pretty\-print \-obj=addr.exe < addr.txt
       
    88 0x40054d: inc at /tmp/x.c:3:3
       
    89  (inlined by) main at /tmp/x.c:9:0
       
    90 $llvm\-symbolizer \-inlining \-pretty\-print \-obj=addr.exe < addr.txt
       
    91 inc at /tmp/x.c:3:3
       
    92  (inlined by) main at /tmp/x.c:9:0
       
    93 .ft P
       
    94 .fi
       
    95 .UNINDENT
       
    96 .UNINDENT
       
    97 .SH OPTIONS
       
    98 .INDENT 0.0
       
    99 .TP
       
   100 .B \-obj
       
   101 Path to object file to be symbolized.
       
   102 .UNINDENT
       
   103 .INDENT 0.0
       
   104 .TP
       
   105 .B \-functions=[none|short|linkage]
       
   106 Specify the way function names are printed (omit function name,
       
   107 print short function name, or print full linkage name, respectively).
       
   108 Defaults to \fBlinkage\fP\&.
       
   109 .UNINDENT
       
   110 .INDENT 0.0
       
   111 .TP
       
   112 .B \-use\-symbol\-table
       
   113 Prefer function names stored in symbol table to function names
       
   114 in debug info sections. Defaults to true.
       
   115 .UNINDENT
       
   116 .INDENT 0.0
       
   117 .TP
       
   118 .B \-demangle
       
   119 Print demangled function names. Defaults to true.
       
   120 .UNINDENT
       
   121 .INDENT 0.0
       
   122 .TP
       
   123 .B \-inlining
       
   124 If a source code location is in an inlined function, prints all the
       
   125 inlnied frames. Defaults to true.
       
   126 .UNINDENT
       
   127 .INDENT 0.0
       
   128 .TP
       
   129 .B \-default\-arch
       
   130 If a binary contains object files for multiple architectures (e.g. it is a
       
   131 Mach\-O universal binary), symbolize the object file for a given architecture.
       
   132 You can also specify architecture by writing \fBbinary_name:arch_name\fP in the
       
   133 input (see example above). If architecture is not specified in either way,
       
   134 address will not be symbolized. Defaults to empty string.
       
   135 .UNINDENT
       
   136 .INDENT 0.0
       
   137 .TP
       
   138 .B \-dsym\-hint=<path/to/file.dSYM>
       
   139 (Darwin\-only flag). If the debug info for a binary isn\(aqt present in the default
       
   140 location, look for the debug info at the .dSYM path provided via the
       
   141 \fB\-dsym\-hint\fP flag. This flag can be used multiple times.
       
   142 .UNINDENT
       
   143 .INDENT 0.0
       
   144 .TP
       
   145 .B \-print\-address
       
   146 Print address before the source code location. Defaults to false.
       
   147 .UNINDENT
       
   148 .INDENT 0.0
       
   149 .TP
       
   150 .B \-pretty\-print
       
   151 Print human readable output. If \fB\-inlining\fP is specified, enclosing scope is
       
   152 prefixed by (inlined by). Refer to listed examples.
       
   153 .UNINDENT
       
   154 .SH EXIT STATUS
       
   155 .sp
       
   156 \fBllvm\-symbolizer\fP returns 0. Other exit codes imply internal program error.
       
   157 .SH AUTHOR
       
   158 Maintained by The LLVM Team (http://llvm.org/).
       
   159 .SH COPYRIGHT
       
   160 2003-2016, LLVM Project
       
   161 .\" Generated by docutils manpage writer.
       
   162 .