xref: /freebsd/usr.bin/clang/llvm-nm/llvm-nm.1 (revision 62cfcf62f627e5093fb37026a6d8c98e4d2ef04c)
$FreeBSD$
Man page generated from reStructuredText.
.
"LLVM-NM" "1" "2020-06-26" "10" "LLVM"
NAME
llvm-nm - list LLVM bitcode and object file's symbol table . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
SYNOPSIS
llvm-nm [options] [filenames...]
DESCRIPTION
The llvm-nm utility lists the names of symbols from LLVM bitcode files, object files, and archives. Each symbol is listed along with some simple information about its provenance. If no filename is specified, a.out is used as the input. If - is used as a filename, llvm-nm will read a file from its standard input stream. llvm-nm\(aqs default output format is the traditional BSD nm output format. Each such output record consists of an (optional) 8-digit hexadecimal address, followed by a type code character, followed by a name, for each symbol. One record is printed per line; fields are separated by spaces. When the address is omitted, it is replaced by 8 spaces. The supported type code characters are as follows. Where both lower and upper-case characters are listed for the same meaning, a lower-case character represents a local symbol, whilst an upper-case character represents a global (external) symbol: a, A NDENT 0.0 NDENT 3.5 Absolute symbol. NINDENT NINDENT b, B NDENT 0.0 NDENT 3.5 Uninitialized data (bss) object. NINDENT NINDENT C NDENT 0.0 NDENT 3.5 Common symbol. Multiple definitions link together into one definition. NINDENT NINDENT d, D NDENT 0.0 NDENT 3.5 Writable data object. NINDENT NINDENT i, I NDENT 0.0 NDENT 3.5 COFF: .idata symbol or symbol in a section with IMAGE_SCN_LNK_INFO set. NINDENT NINDENT n NDENT 0.0 NDENT 3.5 ELF: local symbol from non-alloc section. COFF: debug symbol. NINDENT NINDENT N NDENT 0.0 NDENT 3.5 ELF: debug section symbol, or global symbol from non-alloc section. NINDENT NINDENT s, S NDENT 0.0 NDENT 3.5 COFF: section symbol. Mach-O: absolute symbol or symbol from a section other than __TEXT_EXEC __text, __TEXT __text, __DATA __data, or __DATA __bss. NINDENT NINDENT r, R NDENT 0.0 NDENT 3.5 Read-only data object. NINDENT NINDENT t, T NDENT 0.0 NDENT 3.5 Code (text) object. NINDENT NINDENT u NDENT 0.0 NDENT 3.5 ELF: GNU unique symbol. NINDENT NINDENT U NDENT 0.0 NDENT 3.5 Named object is undefined in this file. NINDENT NINDENT v NDENT 0.0 NDENT 3.5 ELF: Undefined weak object. It is not a link failure if the object is not defined. NINDENT NINDENT V NDENT 0.0 NDENT 3.5 ELF: Defined weak object symbol. This definition will only be used if no regular definitions exist in a link. If multiple weak definitions and no regular definitions exist, one of the weak definitions will be used. NINDENT NINDENT w NDENT 0.0 NDENT 3.5 Undefined weak symbol other than an ELF object symbol. It is not a link failure if the symbol is not defined. NINDENT NINDENT W NDENT 0.0 NDENT 3.5 Defined weak symbol other than an ELF object symbol. This definition will only be used if no regular definitions exist in a link. If multiple weak definitions and no regular definitions exist, one of the weak definitions will be used. NINDENT NINDENT - NDENT 0.0 NDENT 3.5 Mach-O: N_STAB symbol. NINDENT NINDENT ? NDENT 0.0 NDENT 3.5 Something unrecognizable. NINDENT NINDENT Because LLVM bitcode files typically contain objects that are not considered to have addresses until they are linked into an executable image or dynamically compiled "just-in-time", llvm-nm does not print an address for any symbol in an LLVM bitcode file, even symbols which are defined in the bitcode file.
OPTIONS
NDENT 0.0

-B Use BSD output format. Alias for --format=bsd. NINDENT NDENT 0.0

--debug-syms, -a Show all symbols, even those usually suppressed. NINDENT NDENT 0.0

--defined-only, -U Print only symbols defined in this file. NINDENT NDENT 0.0

--demangle, -C Demangle symbol names. NINDENT NDENT 0.0

--dynamic, -D Display dynamic symbols instead of normal symbols. NINDENT NDENT 0.0

--extern-only, -g Print only symbols whose definitions are external; that is, accessible from other files. NINDENT NDENT 0.0

--format=<format>, -f Select an output format; format may be sysv, posix, darwin, or bsd. The default is bsd. NINDENT NDENT 0.0

--help, -h Print a summary of command-line options and their meanings. NINDENT NDENT 0.0

--help-list Print an uncategorized summary of command-line options and their meanings. NINDENT NDENT 0.0

--just-symbol-name, -j Print just the symbol names. NINDENT NDENT 0.0

-m Use Darwin format. Alias for --format=darwin. NINDENT NDENT 0.0

--no-demangle Don\(aqt demangle symbol names. This is the default. NINDENT NDENT 0.0

--no-llvm-bc Disable the LLVM bitcode reader. NINDENT NDENT 0.0

--no-sort, -p Show symbols in the order encountered. NINDENT NDENT 0.0

--no-weak, -W Don\(aqt print weak symbols. NINDENT NDENT 0.0

--numeric-sort, -n, -v Sort symbols by address. NINDENT NDENT 0.0

--portability, -P Use POSIX.2 output format. Alias for --format=posix. NINDENT NDENT 0.0

--print-armap, -M Print the archive symbol table, in addition to the symbols. NINDENT NDENT 0.0

--print-file-name, -A, -o Precede each symbol with the file it came from. NINDENT NDENT 0.0

--print-size, -S Show symbol size as well as address (not applicable for Mach-O). NINDENT NDENT 0.0

--radix=<RADIX>, -t Specify the radix of the symbol address(es). Values accepted are d (decimal), x (hexadecimal) and o (octal). NINDENT NDENT 0.0

--reverse-sort, -r Sort symbols in reverse order. NINDENT NDENT 0.0

--size-sort Sort symbols by size. NINDENT NDENT 0.0

--special-syms Ignored. For GNU compatibility only. NINDENT NDENT 0.0

--undefined-only, -u Print only undefined symbols. NINDENT NDENT 0.0

--version Display the version of the llvm-nm executable. Does not stack with other commands. NINDENT NDENT 0.0

--without-aliases Exclude aliases from the output. NINDENT NDENT 0.0

@<FILE> Read command-line options from response file <FILE>. NINDENT

MACH-O SPECIFIC OPTIONS
NDENT 0.0

--add-dyldinfo Add symbols from the dyldinfo, if they are not already in the symbol table. This is the default. NINDENT NDENT 0.0

--arch=<arch1[,arch2,...]> Dump the symbols from the specified architecture(s). NINDENT NDENT 0.0

--dyldinfo-only Dump only symbols from the dyldinfo. NINDENT NDENT 0.0

--no-dyldinfo Do not add any symbols from the dyldinfo. NINDENT NDENT 0.0

-s=<segment section> Dump only symbols from this segment and section name. NINDENT NDENT 0.0

-x Print symbol entry in hex. NINDENT

BUGS
NDENT 0.0 NDENT 3.5 NDENT 0.0
\(bu 2
llvm-nm does not support the full set of arguments that GNU nm does. NINDENT NINDENT NINDENT
EXIT STATUS
llvm-nm exits with an exit code of zero.
SEE ALSO
llvm-ar(1), llvm-objdump(1), llvm-readelf(1), llvm-readobj(1)
AUTHOR
Maintained by the LLVM Team (https://llvm.org/).
COPYRIGHT
2003-2020, LLVM Project Generated by docutils manpage writer.
.