Blame - docs/CommandGuide/llvm-nm.rst - fp2-dev/platform/external/llvm

blob: 83d9fbaf9e8ccd1cb4f39fbbe8196b69b4a33602 [file] [log] [blame]

Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	1	llvm-nm - list LLVM bitcode and object file's symbol table
				2	==========================================================
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	3
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	4	SYNOPSIS
				5	--------
				6
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	7	:program:`llvm-nm` [options] [filenames...]
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	8
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	9	DESCRIPTION
				10	-----------
				11
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	12	The :program:`llvm-nm` utility lists the names of symbols from the LLVM bitcode
				13	files, object files, or :program:`ar` archives containing them, named on the
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	14	command line. Each symbol is listed along with some simple information about
				15	its provenance. If no file name is specified, or - is used as a file name,
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	16	:program:`llvm-nm` will process a file on its standard input stream.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	17
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	18	:program:`llvm-nm`'s default output format is the traditional BSD :program:`nm`
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	19	output format. Each such output record consists of an (optional) 8-digit
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	20	hexadecimal address, followed by a type code character, followed by a name, for
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	21	each symbol. One record is printed per line; fields are separated by spaces.
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	22	When the address is omitted, it is replaced by 8 spaces.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	23
				24	Type code characters currently supported, and their meanings, are as follows:
				25
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	26	U
				27
				28	Named object is referenced but undefined in this bitcode file
				29
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	30	C
				31
				32	Common (multiple definitions link together into one def)
				33
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	34	W
				35
				36	Weak reference (multiple definitions link together into zero or one definitions)
				37
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	38	t
				39
				40	Local function (text) object
				41
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	42	T
				43
				44	Global function (text) object
				45
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	46	d
				47
				48	Local data object
				49
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	50	D
				51
				52	Global data object
				53
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	54	?
				55
				56	Something unrecognizable
				57
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	58	Because LLVM bitcode files typically contain objects that are not considered to
				59	have addresses until they are linked into an executable image or dynamically
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	60	compiled "just-in-time", :program:`llvm-nm` does not print an address for any
Daniel Dunbar	1323006	2013-08-16 23:30:19 +0000	[diff] [blame]	61	symbol in an LLVM bitcode file, even symbols which are defined in the bitcode
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	62	file.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	63
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	64	OPTIONS
				65	-------
				66
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	67	.. program:: llvm-nm
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	68
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	69	.. option:: -B (default)
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	70
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	71	Use BSD output format. Alias for :option:`--format=bsd`.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	72
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	73	.. option:: -P
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	74
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	75	Use POSIX.2 output format. Alias for :option:`--format=posix`.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	76
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	77	.. option:: --debug-syms, -a
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	78
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	79	Show all symbols, even debugger only.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	80
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	81	.. option:: --defined-only
				82
				83	Print only symbols defined in this file (as opposed to
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	84	symbols which may be referenced by objects in this file, but not
				85	defined in this file.)
				86
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	87	.. option:: --dynamic, -D
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	88
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	89	Display dynamic symbols instead of normal symbols.
				90
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	91	.. option:: --extern-only, -g
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	92
				93	Print only symbols whose definitions are external; that is, accessible
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	94	from other files.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	95
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	96	.. option:: --format=format, -f format
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	97
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	98	Select an output format; format may be sysv, posix, or bsd. The default
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	99	is bsd.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	100
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	101	.. option:: -help
				102
				103	Print a summary of command-line options and their meanings.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	104
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	105	.. option:: --no-sort, -p
				106
				107	Shows symbols in order encountered.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	108
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	109	.. option:: --numeric-sort, -n, -v
				110
				111	Sort symbols by address.
				112
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	113	.. option:: --print-file-name, -A, -o
				114
				115	Precede each symbol with the file it came from.
				116
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	117	.. option:: --print-size, -S
				118
				119	Show symbol size instead of address.
				120
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	121	.. option:: --size-sort
				122
				123	Sort symbols by size.
				124
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	125	.. option:: --undefined-only, -u
				126
				127	Print only symbols referenced but not defined in this file.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	128
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	129	BUGS
				130	----
				131
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	132	* :program:`llvm-nm` cannot demangle C++ mangled names, like GNU :program:`nm`
				133	can.
				134
				135	* :program:`llvm-nm` does not support the full set of arguments that GNU
				136	:program:`nm` does.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	137
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	138	EXIT STATUS
				139	-----------
				140
Michael J. Spencer	4d61664	2012-06-06 23:34:10 +0000	[diff] [blame]	141	:program:`llvm-nm` exits with an exit code of zero.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	142
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	143	SEE ALSO
				144	--------
				145
Dmitri Gribenko	70f6b36	2013-08-18 08:32:32 +0000	[diff] [blame]	146	llvm-dis, ar(1), nm(1)