From da8b9c2c5c2548ba967e48b49fbe6fefb95967ee Mon Sep 17 00:00:00 2001 From: cvs2svn Date: Wed, 23 May 2007 18:12:40 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'RELEASE_20'. git-svn-id: https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_20@37313 91177308-0d34-0410-b5e6-96231b3b80d8 --- Makefile.rules | 15 +- autoconf/configure.ac | 3 +- configure | 69 ++- docs/BitCodeFormat.html | 609 ++++++++++++++++++- docs/CommandGuide/man/man1/bugpoint.1 | 240 ++++++++ docs/CommandGuide/man/man1/llc.1 | 277 +++++++++ docs/CommandGuide/man/man1/lli.1 | 206 +++++++ docs/CommandGuide/man/man1/llvm-ar.1 | 461 ++++++++++++++ docs/CommandGuide/man/man1/llvm-as.1 | 182 ++++++ docs/CommandGuide/man/man1/llvm-bcanalyzer.1 | 370 ++++++++++++ docs/CommandGuide/man/man1/llvm-config.1 | 227 +++++++ docs/CommandGuide/man/man1/llvm-db.1 | 141 +++++ docs/CommandGuide/man/man1/llvm-dis.1 | 175 ++++++ docs/CommandGuide/man/man1/llvm-extract.1 | 177 ++++++ docs/CommandGuide/man/man1/llvm-ld.1 | 348 +++++++++++ docs/CommandGuide/man/man1/llvm-link.1 | 186 ++++++ docs/CommandGuide/man/man1/llvm-nm.1 | 219 +++++++ docs/CommandGuide/man/man1/llvm-prof.1 | 173 ++++++ docs/CommandGuide/man/man1/llvm-ranlib.1 | 167 ++++++ docs/CommandGuide/man/man1/llvm-upgrade.1 | 179 ++++++ docs/CommandGuide/man/man1/llvm2cpp.1 | 301 ++++++++++ docs/CommandGuide/man/man1/llvmc.1 | 455 ++++++++++++++ docs/CommandGuide/man/man1/llvmgcc.1 | 194 ++++++ docs/CommandGuide/man/man1/llvmgxx.1 | 194 ++++++ docs/CommandGuide/man/man1/opt.1 | 246 ++++++++ docs/CommandGuide/man/man1/stkrc.1 | 198 ++++++ docs/CommandGuide/man/man1/tblgen.1 | 215 +++++++ docs/GettingStarted.html | 11 +- docs/LangRef.html | 56 +- docs/ReleaseNotes.html | 655 ++++++++++++-------- docs/WritingAnLLVMPass.html | 12 +- include/llvm/BasicBlock.h | 1 + include/llvm/IntrinsicsX86.td | 4 + include/llvm/ValueSymbolTable.h | 1 + lib/Bitcode/Reader/BitcodeReader.cpp | 165 +++-- lib/Bitcode/Reader/BitcodeReader.h | 13 +- lib/Bitcode/Writer/BitcodeWriter.cpp | 27 +- lib/CodeGen/SelectionDAG/DAGCombiner.cpp | 4 +- lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp | 26 +- lib/Support/APInt.cpp | 6 + lib/System/Unix/MappedFile.inc | 1 + lib/Target/CBackend/CBackend.cpp | 5 + lib/Target/PowerPC/PPCISelLowering.cpp | 26 +- lib/Target/PowerPC/PPCRegisterInfo.td | 6 +- lib/Target/X86/X86ISelLowering.cpp | 14 +- lib/Target/X86/X86InstrMMX.td | 4 +- lib/Transforms/IPO/GlobalOpt.cpp | 6 +- lib/Transforms/Scalar/InstructionCombining.cpp | 34 +- test/CodeGen/SPARC/2007-05-09-JumpTables.ll | 30 + test/Feature/llvm2cpp.ll | 795 ------------------------- tools/llvm-upgrade/UpgradeLexer.cpp.cvs | 332 +++++------ tools/llvm-upgrade/UpgradeParser.cpp.cvs | 626 +++++++++---------- tools/llvm-upgrade/UpgradeParser.h.cvs | 2 +- tools/llvm-upgrade/UpgradeParser.y.cvs | 90 +-- utils/TableGen/DAGISelEmitter.cpp | 12 +- 55 files changed, 7464 insertions(+), 1727 deletions(-) create mode 100644 docs/CommandGuide/man/man1/bugpoint.1 create mode 100644 docs/CommandGuide/man/man1/llc.1 create mode 100644 docs/CommandGuide/man/man1/lli.1 create mode 100644 docs/CommandGuide/man/man1/llvm-ar.1 create mode 100644 docs/CommandGuide/man/man1/llvm-as.1 create mode 100644 docs/CommandGuide/man/man1/llvm-bcanalyzer.1 create mode 100644 docs/CommandGuide/man/man1/llvm-config.1 create mode 100644 docs/CommandGuide/man/man1/llvm-db.1 create mode 100644 docs/CommandGuide/man/man1/llvm-dis.1 create mode 100644 docs/CommandGuide/man/man1/llvm-extract.1 create mode 100644 docs/CommandGuide/man/man1/llvm-ld.1 create mode 100644 docs/CommandGuide/man/man1/llvm-link.1 create mode 100644 docs/CommandGuide/man/man1/llvm-nm.1 create mode 100644 docs/CommandGuide/man/man1/llvm-prof.1 create mode 100644 docs/CommandGuide/man/man1/llvm-ranlib.1 create mode 100644 docs/CommandGuide/man/man1/llvm-upgrade.1 create mode 100644 docs/CommandGuide/man/man1/llvm2cpp.1 create mode 100644 docs/CommandGuide/man/man1/llvmc.1 create mode 100644 docs/CommandGuide/man/man1/llvmgcc.1 create mode 100644 docs/CommandGuide/man/man1/llvmgxx.1 create mode 100644 docs/CommandGuide/man/man1/opt.1 create mode 100644 docs/CommandGuide/man/man1/stkrc.1 create mode 100644 docs/CommandGuide/man/man1/tblgen.1 create mode 100644 test/CodeGen/SPARC/2007-05-09-JumpTables.ll delete mode 100644 test/Feature/llvm2cpp.ll diff --git a/Makefile.rules b/Makefile.rules index 888c5bdf0406..d83f2fa548b3 100644 --- a/Makefile.rules +++ b/Makefile.rules @@ -1359,15 +1359,12 @@ all:: $(YaccFiles:%.y=$(PROJ_SRC_DIR)/%.cpp.cvs) %.h: %.y # Rule for building the bison based parsers... -$(PROJ_SRC_DIR)/%.cpp $(PROJ_SRC_DIR)/%.h : $(PROJ_SRC_DIR)/%.y ifneq ($(BISON),) +$(PROJ_SRC_DIR)/%.cpp $(PROJ_SRC_DIR)/%.h : $(PROJ_SRC_DIR)/%.y $(Echo) "Bisoning $*.y" $(Verb) $(BISON) -v -d -p $(. # @@ -715,8 +715,8 @@ SHELL=${CONFIG_SHELL-/bin/sh} # Identity of this package. PACKAGE_NAME='llvm' PACKAGE_TARNAME='-llvm-' -PACKAGE_VERSION='2.0cvs' -PACKAGE_STRING='llvm 2.0cvs' +PACKAGE_VERSION='2.0' +PACKAGE_STRING='llvm 2.0' PACKAGE_BUGREPORT='llvmbugs@cs.uiuc.edu' ac_unique_file="lib/VMCore/Module.cpp" @@ -1450,7 +1450,7 @@ if test "$ac_init_help" = "long"; then # Omit some internal or obsolete options to make the list less imposing. # This message is too long to be a string in the A/UX 3.1 sh. cat <<_ACEOF -\`configure' configures llvm 2.0cvs to adapt to many kinds of systems. +\`configure' configures llvm 2.0 to adapt to many kinds of systems. Usage: $0 [OPTION]... [VAR=VALUE]... @@ -1516,7 +1516,7 @@ fi if test -n "$ac_init_help"; then case $ac_init_help in - short | recursive ) echo "Configuration of llvm 2.0cvs:";; + short | recursive ) echo "Configuration of llvm 2.0:";; esac cat <<\_ACEOF @@ -1641,7 +1641,7 @@ fi test -n "$ac_init_help" && exit $ac_status if $ac_init_version; then cat <<\_ACEOF -llvm configure 2.0cvs +llvm configure 2.0 generated by GNU Autoconf 2.60 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, @@ -1657,7 +1657,7 @@ cat >config.log <<_ACEOF This file contains any messages produced by compilers while running configure, to aid debugging if configure makes a mistake. -It was created by llvm $as_me 2.0cvs, which was +It was created by llvm $as_me 2.0, which was generated by GNU Autoconf 2.60. Invocation command line was $ $0 $@ @@ -7374,6 +7374,9 @@ fi if test x"$PERL" = xnone; then HAVE_PERL=0 + { { echo "$as_me:$LINENO: error: perl is required but was not found, please install it" >&5 +echo "$as_me: error: perl is required but was not found, please install it" >&2;} + { (exit 1); exit 1; }; } else HAVE_PERL=1 @@ -10340,7 +10343,7 @@ else lt_dlunknown=0; lt_dlno_uscore=1; lt_dlneed_uscore=2 lt_status=$lt_dlunknown cat > conftest.$ac_ext < conftest.$ac_ext + echo '#line 12490 "configure"' > conftest.$ac_ext if { (eval echo "$as_me:$LINENO: \"$ac_compile\"") >&5 (eval $ac_compile) 2>&5 ac_status=$? @@ -14202,11 +14205,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:14205: $lt_compile\"" >&5) + (eval echo "\"\$as_me:14208: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:14209: \$? = $ac_status" >&5 + echo "$as_me:14212: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -14470,11 +14473,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:14473: $lt_compile\"" >&5) + (eval echo "\"\$as_me:14476: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:14477: \$? = $ac_status" >&5 + echo "$as_me:14480: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -14574,11 +14577,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:14577: $lt_compile\"" >&5) + (eval echo "\"\$as_me:14580: $lt_compile\"" >&5) (eval "$lt_compile" 2>out/conftest.err) ac_status=$? cat out/conftest.err >&5 - echo "$as_me:14581: \$? = $ac_status" >&5 + echo "$as_me:14584: \$? = $ac_status" >&5 if (exit $ac_status) && test -s out/conftest2.$ac_objext then # The compiler can only warn and ignore the option if not recognized @@ -17026,7 +17029,7 @@ else lt_dlunknown=0; lt_dlno_uscore=1; lt_dlneed_uscore=2 lt_status=$lt_dlunknown cat > conftest.$ac_ext < conftest.$ac_ext <&5) + (eval echo "\"\$as_me:19500: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:19501: \$? = $ac_status" >&5 + echo "$as_me:19504: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -19598,11 +19601,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:19601: $lt_compile\"" >&5) + (eval echo "\"\$as_me:19604: $lt_compile\"" >&5) (eval "$lt_compile" 2>out/conftest.err) ac_status=$? cat out/conftest.err >&5 - echo "$as_me:19605: \$? = $ac_status" >&5 + echo "$as_me:19608: \$? = $ac_status" >&5 if (exit $ac_status) && test -s out/conftest2.$ac_objext then # The compiler can only warn and ignore the option if not recognized @@ -21168,11 +21171,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:21171: $lt_compile\"" >&5) + (eval echo "\"\$as_me:21174: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:21175: \$? = $ac_status" >&5 + echo "$as_me:21178: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -21272,11 +21275,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:21275: $lt_compile\"" >&5) + (eval echo "\"\$as_me:21278: $lt_compile\"" >&5) (eval "$lt_compile" 2>out/conftest.err) ac_status=$? cat out/conftest.err >&5 - echo "$as_me:21279: \$? = $ac_status" >&5 + echo "$as_me:21282: \$? = $ac_status" >&5 if (exit $ac_status) && test -s out/conftest2.$ac_objext then # The compiler can only warn and ignore the option if not recognized @@ -23507,11 +23510,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:23510: $lt_compile\"" >&5) + (eval echo "\"\$as_me:23513: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:23514: \$? = $ac_status" >&5 + echo "$as_me:23517: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -23775,11 +23778,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:23778: $lt_compile\"" >&5) + (eval echo "\"\$as_me:23781: $lt_compile\"" >&5) (eval "$lt_compile" 2>conftest.err) ac_status=$? cat conftest.err >&5 - echo "$as_me:23782: \$? = $ac_status" >&5 + echo "$as_me:23785: \$? = $ac_status" >&5 if (exit $ac_status) && test -s "$ac_outfile"; then # The compiler can only warn and ignore the option if not recognized # So say no if there are warnings other than the usual output. @@ -23879,11 +23882,11 @@ else -e 's:.*FLAGS}\{0,1\} :&$lt_compiler_flag :; t' \ -e 's: [^ ]*conftest\.: $lt_compiler_flag&:; t' \ -e 's:$: $lt_compiler_flag:'` - (eval echo "\"\$as_me:23882: $lt_compile\"" >&5) + (eval echo "\"\$as_me:23885: $lt_compile\"" >&5) (eval "$lt_compile" 2>out/conftest.err) ac_status=$? cat out/conftest.err >&5 - echo "$as_me:23886: \$? = $ac_status" >&5 + echo "$as_me:23889: \$? = $ac_status" >&5 if (exit $ac_status) && test -s out/conftest2.$ac_objext then # The compiler can only warn and ignore the option if not recognized @@ -34017,7 +34020,7 @@ exec 6>&1 # report actual input values of CONFIG_FILES etc. instead of their # values after options handling. ac_log=" -This file was extended by llvm $as_me 2.0cvs, which was +This file was extended by llvm $as_me 2.0, which was generated by GNU Autoconf 2.60. Invocation command line was CONFIG_FILES = $CONFIG_FILES @@ -34070,7 +34073,7 @@ Report bugs to ." _ACEOF cat >>$CONFIG_STATUS <<_ACEOF ac_cs_version="\\ -llvm config.status 2.0cvs +llvm config.status 2.0 configured by $0, generated by GNU Autoconf 2.60, with options \\"`echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`\\" diff --git a/docs/BitCodeFormat.html b/docs/BitCodeFormat.html index 0579a42115eb..7194c7a6d343 100644 --- a/docs/BitCodeFormat.html +++ b/docs/BitCodeFormat.html @@ -1,59 +1,612 @@ - + LLVM Bitcode File Format -
LLVM Bitcode File Format
  1. Abstract
    2. -
  2. Concepts
    3. +
  3. Overview
    4. +
  4. Bitstream Format +
      +
    1. Magic Numbers
      2. +
    2. Primitives
      3. +
    3. Abbreviation IDs
      4. +
    4. Blocks
      5. +
    5. Data Records
      6. +
    6. Abbreviations
      7. +
    7. Standard Blocks
      8. +
    +
    5. +
  5. LLVM IR Encoding +
      +
    1. Basics
      2. +
    +
-

Written by Reid Spencer and - Chris Lattner. +

Written by Chris Lattner.

+ -
Abstract
+
Abstract
+
-

This document describes the LLVM bitcode file format. It specifies -the binary encoding rules of the bitcode file format so that -equivalent systems can encode bitcode files correctly. The LLVM -bitcode representation is used to store the intermediate -representation on disk in a compacted form.

-

This document supercedes the LLVM bytecode file format for the 2.0 -release.

+ +

This document describes the LLVM bitstream file format and the encoding of +the LLVM IR into it.

+
+ -
Concepts
+
Overview
+
-

This section describes the general concepts of the bitcode file -format without getting into specific layout details. It is recommended -that you read this section thoroughly before interpreting the detailed -descriptions.

+ +

+What is commonly known as the LLVM bitcode file format (also, sometimes +anachronistically known as bytecode) is actually two things: a bitstream container format +and an encoding of LLVM IR into the container format.

+ +

+The bitstream format is an abstract encoding of structured data, very +similar to XML in some ways. Like XML, bitstream files contain tags, and nested +structures, and you can parse the file without having to understand the tags. +Unlike XML, the bitstream format is a binary encoding, and unlike XML it +provides a mechanism for the file to self-describe "abbreviations", which are +effectively size optimizations for the content.

+ +

This document first describes the LLVM bitstream format, then describes the +record structure used by LLVM IR files. +

+ +
+ + +
Bitstream Format
+ + +
+ +

+The bitstream format is literally a stream of bits, with a very simple +structure. This structure consists of the following concepts: +

+ +
    +
  • A "magic number" that identifies the contents of + the stream.
    • +
  • Encoding primitives like variable bit-rate + integers.
    • +
  • Blocks, which define nested content.
    • +
  • Data Records, which describe entities within the + file.
    • +
  • Abbreviations, which specify compression optimizations for the file.
    • +
+ +

Note that the llvm-bcanalyzer tool can be +used to dump and inspect arbitrary bitstreams, which is very useful for +understanding the encoding.

+ +
+ + +
Magic Numbers +
+ +
+ +

The first four bytes of the stream identify the encoding of the file. This +is used by a reader to know what is contained in the file.

+ +
+ + +
Primitives +
+ +
+ +

+A bitstream literally consists of a stream of bits. This stream is made up of a +number of primitive values that encode a stream of unsigned integer values. +These +integers are are encoded in two ways: either as Fixed +Width Integers or as Variable Width +Integers. +

+ +
+ + +
Fixed Width Integers +
+ +
+ +

Fixed-width integer values have their low bits emitted directly to the file. + For example, a 3-bit integer value encodes 1 as 001. Fixed width integers + are used when there are a well-known number of options for a field. For + example, boolean values are usually encoded with a 1-bit wide integer. +

+ +
+ + +
Variable Width +Integers
+ +
+ +

Variable-width integer (VBR) values encode values of arbitrary size, +optimizing for the case where the values are small. Given a 4-bit VBR field, +any 3-bit value (0 through 7) is encoded directly, with the high bit set to +zero. Values larger than N-1 bits emit their bits in a series of N-1 bit +chunks, where all but the last set the high bit.

+ +

For example, the value 27 (0x1B) is encoded as 1011 0011 when emitted as a +vbr4 value. The first set of four bits indicates the value 3 (011) with a +continuation piece (indicated by a high bit of 1). The next word indicates a +value of 24 (011 << 3) with no continuation. The sum (3+24) yields the value +27. +

+ +
+ + +
6-bit characters
+ +
+ +

6-bit characters encode common characters into a fixed 6-bit field. They +represent the following characters with the following 6-bit values:

+ +
    +
  • 'a' .. 'z' - 0 .. 25
    • +
  • 'A' .. 'Z' - 26 .. 52
    • +
  • '0' .. '9' - 53 .. 61
    • +
  • '.' - 62
    • +
  • '_' - 63
    • +
+ +

This encoding is only suitable for encoding characters and strings that +consist only of the above characters. It is completely incapable of encoding +characters not in the set.

+ +
+ + +
Word Alignment
+ +
+ +

Occasionally, it is useful to emit zero bits until the bitstream is a +multiple of 32 bits. This ensures that the bit position in the stream can be +represented as a multiple of 32-bit words.

+ +
+ + + +
Abbreviation IDs +
+ +
+ +

+A bitstream is a sequential series of Blocks and +Data Records. Both of these start with an +abbreviation ID encoded as a fixed-bitwidth field. The width is specified by +the current block, as described below. The value of the abbreviation ID +specifies either a builtin ID (which have special meanings, defined below) or +one of the abbreviation IDs defined by the stream itself. +

+ +

+The set of builtin abbrev IDs is: +

+ +
    +
  • 0 - END_BLOCK - This abbrev ID marks the end of the + current block.
    • +
  • 1 - ENTER_SUBBLOCK - This abbrev ID marks the + beginning of a new block.
    • +
  • 2 - DEFINE_ABBREV - This defines a new + abbreviation.
    • +
  • 3 - UNABBREV_RECORD - This ID specifies the + definition of an unabbreviated record.
    • +
+ +

Abbreviation IDs 4 and above are defined by the stream itself, and specify +an abbreviated record encoding.

+ +
+ + +
Blocks +
+ +
+ +

+Blocks in a bitstream denote nested regions of the stream, and are identified by +a content-specific id number (for example, LLVM IR uses an ID of 12 to represent +function bodies). Nested blocks capture the hierachical structure of the data +encoded in it, and various properties are associated with blocks as the file is +parsed. Block definitions allow the reader to efficiently skip blocks +in constant time if the reader wants a summary of blocks, or if it wants to +efficiently skip data they do not understand. The LLVM IR reader uses this +mechanism to skip function bodies, lazily reading them on demand. +

+ +

+When reading and encoding the stream, several properties are maintained for the +block. In particular, each block maintains: +

+ +
    +
  1. A current abbrev id width. This value starts at 2, and is set every time a + block record is entered. The block entry specifies the abbrev id width for + the body of the block.
    2. + +
  2. A set of abbreviations. Abbreviations may be defined within a block, or + they may be associated with all blocks of a particular ID. +
    3. +
+ +

As sub blocks are entered, these properties are saved and the new sub-block +has its own set of abbreviations, and its own abbrev id width. When a sub-block +is popped, the saved values are restored.

+ +
+ + +
ENTER_SUBBLOCK +Encoding
+ +
+ +

[ENTER_SUBBLOCK, blockidvbr8, newabbrevlenvbr4, + <align32bits>, blocklen32]

+ +

+The ENTER_SUBBLOCK abbreviation ID specifies the start of a new block record. +The blockid value is encoded as a 8-bit VBR identifier, and indicates +the type of block being entered (which is application specific). The +newabbrevlen value is a 4-bit VBR which specifies the +abbrev id width for the sub-block. The blocklen is a 32-bit aligned +value that specifies the size of the subblock, in 32-bit words. This value +allows the reader to skip over the entire block in one jump. +

+ +
+ + +
END_BLOCK +Encoding
+ +
+ +

[END_BLOCK, <align32bits>]

+ +

+The END_BLOCK abbreviation ID specifies the end of the current block record. +Its end is aligned to 32-bits to ensure that the size of the block is an even +multiple of 32-bits.

+ +
+ + + + +
Data Records +
+ +
+

+Data records consist of a record code and a number of (up to) 64-bit integer +values. The interpretation of the code and values is application specific and +there are multiple different ways to encode a record (with an unabbrev record +or with an abbreviation). In the LLVM IR format, for example, there is a record +which encodes the target triple of a module. The code is MODULE_CODE_TRIPLE, +and the values of the record are the ascii codes for the characters in the +string.

+ +
+ + +
UNABBREV_RECORD +Encoding
+ +
+ +

[UNABBREV_RECORD, codevbr6, numopsvbr6, + op0vbr6, op1vbr6, ...]

+ +

An UNABBREV_RECORD provides a default fallback encoding, which is both +completely general and also extremely inefficient. It can describe an arbitrary +record, by emitting the code and operands as vbrs.

+ +

For example, emitting an LLVM IR target triple as an unabbreviated record +requires emitting the UNABBREV_RECORD abbrevid, a vbr6 for the +MODULE_CODE_TRIPLE code, a vbr6 for the length of the string (which is equal to +the number of operands), and a vbr6 for each character. Since there are no +letters with value less than 32, each letter would need to be emitted as at +least a two-part VBR, which means that each letter would require at least 12 +bits. This is not an efficient encoding, but it is fully general.

+ +
+ + +
Abbreviated Record +Encoding
+ +
+ +

[<abbrevid>, fields...]

+ +

An abbreviated record is a abbreviation id followed by a set of fields that +are encoded according to the abbreviation +definition. This allows records to be encoded significantly more densely +than records encoded with the UNABBREV_RECORD +type, and allows the abbreviation types to be specified in the stream itself, +which allows the files to be completely self describing. The actual encoding +of abbreviations is defined below. +

+ +
+ + +
Abbreviations +
+ +
+

+Abbreviations are an important form of compression for bitstreams. The idea is +to specify a dense encoding for a class of records once, then use that encoding +to emit many records. It takes space to emit the encoding into the file, but +the space is recouped (hopefully plus some) when the records that use it are +emitted. +

+ +

+Abbreviations can be determined dynamically per client, per file. Since the +abbreviations are stored in the bitstream itself, different streams of the same +format can contain different sets of abbreviations if the specific stream does +not need it. As a concrete example, LLVM IR files usually emit an abbreviation +for binary operators. If a specific LLVM module contained no or few binary +operators, the abbreviation does not need to be emitted. +

+
+ + +
DEFINE_ABBREV + Encoding
+ +
+ +

[DEFINE_ABBREV, numabbrevopsvbr5, abbrevop0, abbrevop1, + ...]

+ +

An abbreviation definition consists of the DEFINE_ABBREV abbrevid followed +by a VBR that specifies the number of abbrev operands, then the abbrev +operands themselves. Abbreviation operands come in three forms. They all start +with a single bit that indicates whether the abbrev operand is a literal operand +(when the bit is 1) or an encoding operand (when the bit is 0).

+ +
    +
  1. Literal operands - [11, litvaluevbr8] - +Literal operands specify that the value in the result +is always a single specific value. This specific value is emitted as a vbr8 +after the bit indicating that it is a literal operand.
    2. +
  2. Encoding info without data - [01, encoding3] + - Operand encodings that do not have extra data are just emitted as their code. +
    3. +
  3. Encoding info with data - [01, encoding3, +valuevbr5] - Operand encodings that do have extra data are +emitted as their code, followed by the extra data. +
    4. +
+ +

The possible operand encodings are:

+ +
    +
  • 1 - Fixed - The field should be emitted as a fixed-width value, whose width + is specified by the encoding operand.
    • +
  • 2 - VBR - The field should be emitted as a variable-width value, whose width + is specified by the encoding operand.
    • +
  • 3 - Array - This field is an array of values. The element type of the array + is specified by the next encoding operand.
    • +
  • 4 - Char6 - This field should be emitted as a char6-encoded + value.
    • +
+ +

For example, target triples in LLVM modules are encoded as a record of the +form [TRIPLE, 'a', 'b', 'c', 'd']. Consider if the bitstream emitted +the following abbrev entry:

+ +
    +
  • [0, Fixed, 4]
    • +
  • [0, Array]
    • +
  • [0, Char6]
    • +
+ +

When emitting a record with this abbreviation, the above entry would be +emitted as:

+ +

[4abbrevwidth, 24, 4vbr6, + 06, 16, 26, 36]

+ +

These values are:

+ +
    +
  1. The first value, 4, is the abbreviation ID for this abbreviation.
    2. +
  2. The second value, 2, is the code for TRIPLE in LLVM IR files.
    3. +
  3. The third value, 4, is the length of the array.
    4. +
  4. The rest of the values are the char6 encoded values for "abcd".
    5. +
+ +

With this abbreviation, the triple is emitted with only 37 bits (assuming a +abbrev id width of 3). Without the abbreviation, significantly more space would +be required to emit the target triple. Also, since the TRIPLE value is not +emitted as a literal in the abbreviation, the abbreviation can also be used for +any other string value. +

+ +
+ + +
Standard Blocks +
+ +
+ +

+In addition to the basic block structure and record encodings, the bitstream +also defines specific builtin block types. These block types specify how the +stream is to be decoded or other metadata. In the future, new standard blocks +may be added. +

+ +
+ + +
#0 - BLOCKINFO +Block
+ +
+ +

The BLOCKINFO block allows the description of metadata for other blocks. The + currently specified records are:

+ +
    +
  • [SETBID (#1), blockid]
    • +
  • [DEFINE_ABBREV, ...]
    • +
+ +

+The SETBID record indicates which block ID is being described. The standard +DEFINE_ABBREV record specifies an abbreviation. The abbreviation is associated +with the record ID, and any records with matching ID automatically get the +abbreviation. +

+ +
+ + +
LLVM IR Encoding
+ + +
+ +

LLVM IR is encoded into a bitstream by defining blocks and records. It uses +blocks for things like constant pools, functions, symbol tables, etc. It uses +records for things like instructions, global variable descriptors, type +descriptions, etc. This document does not describe the set of abbreviations +that the writer uses, as these are fully self-described in the file, and the +reader is not allowed to build in any knowledge of this.

+ +
+ + +
Basics +
+ + +
LLVM IR Magic Number
+ +
+ +

+The magic number for LLVM IR files is: +

+ +

['B'8, 'C'8, 0x04, 0xC4, +0xE4, 0xD4]

+ +

When viewed as bytes, this is "BC 0xC0DE".

+ +
+ + +
Signed VBRs
+ +
+ +

+Variable Width Integers are an efficient way to +encode arbitrary sized unsigned values, but is an extremely inefficient way to +encode signed values (as signed values are otherwise treated as maximally large +unsigned values).

+ +

As such, signed vbr values of a specific width are emitted as follows:

+ +
    +
  • Positive values are emitted as vbrs of the specified width, but with their + value shifted left by one.
    • +
  • Negative values are emitted as vbrs of the specified width, but the negated + value is shifted left by one, and the low bit is set.
    • +
+ +

With this encoding, small positive and small negative values can both be +emitted efficiently.

+ +
+ + + +
LLVM IR Blocks
+ +
+ +

+LLVM IR is defined with the following blocks: +

+ +
    +
  • 8 - MODULE_BLOCK - This is the top-level block that contains the + entire module, and describes a variety of per-module information.
    • +
  • 9 - PARAMATTR_BLOCK - This enumerates the parameter attributes.
    • +
  • 10 - TYPE_BLOCK - This describes all of the types in the module.
    • +
  • 11 - CONSTANTS_BLOCK - This describes constants for a module or + function.
    • +
  • 12 - FUNCTION_BLOCK - This describes a function body.
    • +
  • 13 - TYPE_SYMTAB_BLOCK - This describes the type symbol table.
    • +
  • 14 - VALUE_SYMTAB_BLOCK - This describes a value symbol table.
    • +
+ +
+ + +
MODULE_BLOCK Contents +
+ +
+ +

+

+
+ +
Valid CSS! Valid HTML 4.01! -Reid Spencer and Chris Lattner
+ Chris Lattner
The LLVM Compiler Infrastructure
Last modified: $Date$
diff --git a/docs/CommandGuide/man/man1/bugpoint.1 b/docs/CommandGuide/man/man1/bugpoint.1 new file mode 100644 index 000000000000..422be7a2ee01 --- /dev/null +++ b/docs/CommandGuide/man/man1/bugpoint.1 @@ -0,0 +1,240 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "BUGPOINT 1" +.TH BUGPOINT 1 "2006-09-13" "CVS" "LLVM Command Guide" +.SH "NAME" +bugpoint \- automatic test case reduction tool +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBbugpoint\fR [\fIoptions\fR] [\fIinput \s-1LLVM\s0 ll/bc files\fR] [\fI\s-1LLVM\s0 passes\fR] \fB\-\-args\fR +\&\fIprogram arguments\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBbugpoint\fR narrows down the source of problems in \s-1LLVM\s0 tools and passes. It +can be used to debug three types of failures: optimizer crashes, miscompilations +by optimizers, or bad native code generation (including problems in the static +and \s-1JIT\s0 compilers). It aims to reduce large test cases to small, useful ones. +For more information on the design and inner workings of \fBbugpoint\fR, as well as +advice for using bugpoint, see \fIllvm/docs/Bugpoint.html\fR in the \s-1LLVM\s0 +distribution. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-additional\-so\fR \fIlibrary\fR" 4 +.IX Item "--additional-so library" +Load the dynamic shared object \fIlibrary\fR into the test program whenever it is +run. This is useful if you are debugging programs which depend on non-LLVM +libraries (such as the X or curses libraries) to run. +.IP "\fB\-\-args\fR \fIprogram args\fR" 4 +.IX Item "--args program args" +Pass all arguments specified after \-args to the test program whenever it runs. +Note that if any of the \fIprogram args\fR start with a '\-', you should use: +.Sp +.Vb 1 +\& bugpoint [bugpoint args] --args -- [program args] +.Ve +.Sp +The \*(L"\-\-\*(R" right after the \fB\-\-args\fR option tells \fBbugpoint\fR to consider any +options starting with \f(CW\*(C`\-\*(C'\fR to be part of the \fB\-\-args\fR option, not as options to +\&\fBbugpoint\fR itself. +.IP "\fB\-\-tool\-args\fR \fItool args\fR" 4 +.IX Item "--tool-args tool args" +Pass all arguments specified after \-\-tool\-args to the \s-1LLVM\s0 tool under test +(\fBllc\fR, \fBlli\fR, etc.) whenever it runs. You should use this option in the +following way: +.Sp +.Vb 1 +\& bugpoint [bugpoint args] --tool-args -- [tool args] +.Ve +.Sp +The \*(L"\-\-\*(R" right after the \fB\-\-tool\-args\fR option tells \fBbugpoint\fR to consider any +options starting with \f(CW\*(C`\-\*(C'\fR to be part of the \fB\-\-tool\-args\fR option, not as +options to \fBbugpoint\fR itself. (See \fB\-\-args\fR, above.) +.IP "\fB\-\-check\-exit\-code\fR=\fI{true,false}\fR" 4 +.IX Item "--check-exit-code={true,false}" +Assume a non-zero exit code or core dump from the test program is a failure. +Defaults to true. +.IP "\fB\-\-disable\-{dce,simplifycfg}\fR" 4 +.IX Item "--disable-{dce,simplifycfg}" +Do not run the specified passes to clean up and reduce the size of the test +program. By default, \fBbugpoint\fR uses these passes internally when attempting to +reduce test programs. If you're trying to find a bug in one of these passes, +\&\fBbugpoint\fR may crash. +.IP "\fB\-find\-bugs\fR" 4 +.IX Item "-find-bugs" +Continually randomize the specified passes and run them on the test program +until a bug is found or the user kills \fBbugpoint\fR. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-\-input\fR \fIfilename\fR" 4 +.IX Item "--input filename" +Open \fIfilename\fR and redirect the standard input of the test program, whenever +it runs, to come from that file. +.IP "\fB\-\-load\fR \fIplugin\fR" 4 +.IX Item "--load plugin" +Load the dynamic object \fIplugin\fR into \fBbugpoint\fR itself. This object should +register new optimization passes. Once loaded, the object will add new command +line options to enable various optimizations. To see the new complete list of +optimizations, use the \fB\-\-help\fR and \fB\-\-load\fR options together; for example: +.Sp +.Vb 1 +\& bugpoint --load myNewPass.so --help +.Ve +.IP "\fB\-\-output\fR \fIfilename\fR" 4 +.IX Item "--output filename" +Whenever the test program produces output on its standard output stream, it +should match the contents of \fIfilename\fR (the \*(L"reference output\*(R"). If you +do not use this option, \fBbugpoint\fR will attempt to generate a reference output +by compiling the program with the C backend and running it. +.IP "\fB\-\-profile\-info\-file\fR \fIfilename\fR" 4 +.IX Item "--profile-info-file filename" +Profile file loaded by \fB\-\-profile\-loader\fR. +.IP "\fB\-\-run\-{int,jit,llc,cbe}\fR" 4 +.IX Item "--run-{int,jit,llc,cbe}" +Whenever the test program is compiled, \fBbugpoint\fR should generate code for it +using the specified code generator. These options allow you to choose the +interpreter, the \s-1JIT\s0 compiler, the static native code compiler, or the C +backend, respectively. +.IP "\fB\-\-enable\-valgrind\fR" 4 +.IX Item "--enable-valgrind" +Use valgrind to find faults in the optimization phase. This will allow +bugpoint to find otherwise asymptomatic problems caused by memory +mis\-management. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBbugpoint\fR succeeds in finding a problem, it will exit with 0. Otherwise, +if an error occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +opt +.SH "AUTHOR" +.IX Header "AUTHOR" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llc.1 b/docs/CommandGuide/man/man1/llc.1 new file mode 100644 index 000000000000..81832b10a6b7 --- /dev/null +++ b/docs/CommandGuide/man/man1/llc.1 @@ -0,0 +1,277 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLC 1" +.TH LLC 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llc \- LLVM static compiler +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllc\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllc\fR command compiles \s-1LLVM\s0 bytecode into assembly language for a +specified architecture. The assembly language output can then be passed through +a native assembler and linker to generate a native executable. +.PP +The choice of architecture for the output assembly code is automatically +determined from the input bytecode file, unless the \fB\-march\fR option is used to +override the default. +.SH "OPTIONS" +.IX Header "OPTIONS" +If \fIfilename\fR is \- or omitted, \fBllc\fR reads \s-1LLVM\s0 bytecode from standard input. +Otherwise, it will read \s-1LLVM\s0 bytecode from \fIfilename\fR. +.PP +If the \fB\-o\fR option is omitted, then \fBllc\fR will send its output to standard +output if the input is from standard input. If the \fB\-o\fR option specifies \-, +then the output will also be sent to standard output. +.PP +If no \fB\-o\fR option is specified and an input file other than \- is specified, +then \fBllc\fR creates the output filename by taking the input filename, +removing any existing \fI.bc\fR extension, and adding a \fI.s\fR suffix. +.PP +Other \fBllc\fR options are as follows: +.Sh "End-user Options" +.IX Subsection "End-user Options" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Overwrite output files. By default, \fBllc\fR will refuse to overwrite +an output file which already exists. +.IP "\fB\-mtriple\fR=\fItarget triple\fR" 4 +.IX Item "-mtriple=target triple" +Override the target triple specified in the input bytecode file with the +specified string. +.IP "\fB\-march\fR=\fIarch\fR" 4 +.IX Item "-march=arch" +Specify the architecture for which to generate assembly, overriding the target +encoded in the bytecode file. See the output of \fBllc \-\-help\fR for a list of +valid architectures. By default this is inferred from the target triple or +autodetected to the current architecture. +.IP "\fB\-mcpu\fR=\fIcpuname\fR" 4 +.IX Item "-mcpu=cpuname" +Specify a specific chip in the current architecture to generate code for. +By default this is inferred from the target triple and autodetected to +the current architecture. For a list of available CPUs, use: +\&\fBllvm-as < /dev/null | llc \-march=xyz \-mcpu=help\fR +.IP "\fB\-mattr\fR=\fIa1,+a2,\-a3,...\fR" 4 +.IX Item "-mattr=a1,+a2,-a3,..." +Override or control specific attributes of the target, such as whether \s-1SIMD\s0 +operations are enabled or not. The default set of attributes is set by the +current \s-1CPU\s0. For a list of available attributes, use: +\&\fBllvm-as < /dev/null | llc \-march=xyz \-mattr=help\fR +.IP "\fB\-\-disable\-fp\-elim\fR" 4 +.IX Item "--disable-fp-elim" +Disable frame pointer elimination optimization. +.IP "\fB\-\-disable\-excess\-fp\-precision\fR" 4 +.IX Item "--disable-excess-fp-precision" +Disable optimizations that may produce excess precision for floating point. +Note that this option can dramatically slow down code on some systems +(e.g. X86). +.IP "\fB\-\-enable\-unsafe\-fp\-math\fR" 4 +.IX Item "--enable-unsafe-fp-math" +Enable optimizations that make unsafe assumptions about \s-1IEEE\s0 math (e.g. that +addition is associative) or may not work for all input ranges. These +optimizations allow the code generator to make use of some instructions which +would otherwise not be usable (such as fsin on X86). +.IP "\fB\-\-enable\-correct\-eh\-support\fR" 4 +.IX Item "--enable-correct-eh-support" +Instruct the \fBlowerinvoke\fR pass to insert code for correct exception handling +support. This is expensive and is by default omitted for efficiency. +.IP "\fB\-\-stats\fR" 4 +.IX Item "--stats" +Print statistics recorded by code-generation passes. +.IP "\fB\-\-time\-passes\fR" 4 +.IX Item "--time-passes" +Record the amount of time needed for each pass and print a report to standard +error. +.IP "\fB\-\-load\fR=\fIdso_path\fR" 4 +.IX Item "--load=dso_path" +Dynamically load \fIdso_path\fR (a path to a dynamically shared object) that +implements an \s-1LLVM\s0 target. This will permit the target name to be used with the +\&\fB\-march\fR option so that code can be generated for that target. +.Sh "Tuning/Configuration Options" +.IX Subsection "Tuning/Configuration Options" +.IP "\fB\-\-print\-machineinstrs\fR" 4 +.IX Item "--print-machineinstrs" +Print generated machine code between compilation phases (useful for debugging). +.IP "\fB\-\-regalloc\fR=\fIallocator\fR" 4 +.IX Item "--regalloc=allocator" +Specify the register allocator to use. The default \fIallocator\fR is \fIlocal\fR. +Valid register allocators are: +.RS 4 +.IP "\fIsimple\fR" 4 +.IX Item "simple" +Very simple \*(L"always spill\*(R" register allocator +.IP "\fIlocal\fR" 4 +.IX Item "local" +Local register allocator +.IP "\fIlinearscan\fR" 4 +.IX Item "linearscan" +Linear scan global register allocator +.IP "\fIiterativescan\fR" 4 +.IX Item "iterativescan" +Iterative scan global register allocator +.RE +.RS 4 +.RE +.IP "\fB\-\-spiller\fR=\fIspiller\fR" 4 +.IX Item "--spiller=spiller" +Specify the spiller to use for register allocators that support it. Currently +this option is used only by the linear scan register allocator. The default +\&\fIspiller\fR is \fIlocal\fR. Valid spillers are: +.RS 4 +.IP "\fIsimple\fR" 4 +.IX Item "simple" +Simple spiller +.IP "\fIlocal\fR" 4 +.IX Item "local" +Local spiller +.RE +.RS 4 +.RE +.Sh "Intel IA\-32\-specific Options" +.IX Subsection "Intel IA-32-specific Options" +.IP "\fB\-\-x86\-asm\-syntax=att|intel\fR" 4 +.IX Item "--x86-asm-syntax=att|intel" +Specify whether to emit assembly code in \s-1AT&T\s0 syntax (the default) or intel +syntax. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllc\fR succeeds, it will exit with 0. Otherwise, if an error occurs, +it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +lli +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/lli.1 b/docs/CommandGuide/man/man1/lli.1 new file mode 100644 index 000000000000..ee21774b8862 --- /dev/null +++ b/docs/CommandGuide/man/man1/lli.1 @@ -0,0 +1,206 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLI 1" +.TH LLI 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +lli \- directly execute programs from LLVM bytecode +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBlli\fR [\fIoptions\fR] [\fIfilename\fR] [\fIprogram args\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBlli\fR directly executes programs in \s-1LLVM\s0 bytecode format. It takes a program +in \s-1LLVM\s0 bytecode format and executes it using a just-in-time compiler, if one is +available for the current architecture, or an interpreter. \fBlli\fR takes all of +the same code generator options as llc, but they are only effective when +\&\fBlli\fR is using the just-in-time compiler. +.PP +If \fIfilename\fR is not specified, then \fBlli\fR reads the \s-1LLVM\s0 bytecode for the +program from standard input. +.PP +The optional \fIargs\fR specified on the command line are passed to the program as +arguments. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a summary of command line options. +.IP "\fB\-stats\fR" 4 +.IX Item "-stats" +Print statistics from the code-generation passes. This is only meaningful for +the just-in-time compiler, at present. +.IP "\fB\-time\-passes\fR" 4 +.IX Item "-time-passes" +Record the amount of time needed for each code-generation pass and print it to +standard error. +.IP "\fB\-mtriple\fR=\fItarget triple\fR" 4 +.IX Item "-mtriple=target triple" +Override the target triple specified in the input bytecode file with the +specified string. This may result in a crash if you pick an +architecture which is not compatible with the current system. +.IP "\fB\-march\fR=\fIarch\fR" 4 +.IX Item "-march=arch" +Specify the architecture for which to generate assembly, overriding the target +encoded in the bytecode file. See the output of \fBllc \-\-help\fR for a list of +valid architectures. By default this is inferred from the target triple or +autodetected to the current architecture. +.IP "\fB\-mcpu\fR=\fIcpuname\fR" 4 +.IX Item "-mcpu=cpuname" +Specify a specific chip in the current architecture to generate code for. +By default this is inferred from the target triple and autodetected to +the current architecture. For a list of available CPUs, use: +\&\fBllvm-as < /dev/null | llc \-march=xyz \-mcpu=help\fR +.IP "\fB\-mattr\fR=\fIa1,+a2,\-a3,...\fR" 4 +.IX Item "-mattr=a1,+a2,-a3,..." +Override or control specific attributes of the target, such as whether \s-1SIMD\s0 +operations are enabled or not. The default set of attributes is set by the +current \s-1CPU\s0. For a list of available attributes, use: +\&\fBllvm-as < /dev/null | llc \-march=xyz \-mattr=help\fR +.IP "\fB\-force\-interpreter\fR=\fI{false,true}\fR" 4 +.IX Item "-force-interpreter={false,true}" +If set to true, use the interpreter even if a just-in-time compiler is available +for this architecture. Defaults to false. +.IP "\fB\-f\fR=\fIname\fR" 4 +.IX Item "-f=name" +Call the function named \fIname\fR to start the program. Note: The +function is assumed to have the C signature \f(CW\*(C`int\*(C'\fR \fIname\fR \f(CW\*(C`(int, +char **, char **)\*(C'\fR. If you try to use this option to call a function of +incompatible type, undefined behavior may result. Defaults to \f(CW\*(C`main\*(C'\fR. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBlli\fR fails to load the program, it will exit with an exit code of 1. +Otherwise, it will return the exit code of the program it executes. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llc +.SH "AUTHOR" +.IX Header "AUTHOR" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-ar.1 b/docs/CommandGuide/man/man1/llvm-ar.1 new file mode 100644 index 000000000000..a624f46f9cd2 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-ar.1 @@ -0,0 +1,461 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-AR 1" +.TH LLVM-AR 1 "2006-11-20" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-ar \- LLVM archiver +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-ar\fR [\-]{dmpqrtx}[Rabfikouz] [relpos] [count] [files...] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-ar\fR command is similar to the common Unix utility, \f(CW\*(C`ar\*(C'\fR. It +archives several files together into a single file. The intent for this is +to produce archive libraries by \s-1LLVM\s0 bytecode that can be linked into an +\&\s-1LLVM\s0 program. However, the archive can contain any kind of file. By default, +\&\fBllvm-ar\fR generates a symbol table that makes linking faster because +only the symbol table needs to be consulted, not each individual file member +of the archive. +.PP +The \fBllvm-ar\fR command can be used to \fIread\fR both \s-1SVR4\s0 and \s-1BSD\s0 style archive +files. However, it cannot be used to write them. While the \fBllvm-ar\fR command +produces files that are \fIalmost\fR identical to the format used by other \f(CW\*(C`ar\*(C'\fR +implementations, it has two significant departures in order to make the +archive appropriate for \s-1LLVM\s0. The first departure is that \fBllvm-ar\fR only +uses \s-1BSD4\s0.4 style long path names (stored immediately after the header) and +never contains a string table for long names. The second departure is that the +symbol table is formated for efficient construction of an in-memory data +structure that permits rapid (red\-black tree) lookups. Consequently, archives +produced with \fBllvm-ar\fR usually won't be readable or editable with any +\&\f(CW\*(C`ar\*(C'\fR implementation or useful for linking. Using the \f(CW\*(C`f\*(C'\fR modifier to flatten +file names will make the archive readable by other \f(CW\*(C`ar\*(C'\fR implementations +but not for linking because the symbol table format for \s-1LLVM\s0 is unique. If an +\&\s-1SVR4\s0 or \s-1BSD\s0 style archive is used with the \f(CW\*(C`r\*(C'\fR (replace) or \f(CW\*(C`q\*(C'\fR (quick +update) operations, the archive will be reconstructed in \s-1LLVM\s0 format. This +means that the string table will be dropped (in deference to \s-1BSD\s0 4.4 long names) +and an \s-1LLVM\s0 symbol table will be added (by default). The system symbol table +will be retained. +.PP +Here's where \fBllvm-ar\fR departs from previous \f(CW\*(C`ar\*(C'\fR implementations: +.IP "\fISymbol Table\fR" 4 +.IX Item "Symbol Table" +Since \fBllvm-ar\fR is intended to archive bytecode files, the symbol table +won't make much sense to anything but \s-1LLVM\s0. Consequently, the symbol table's +format has been simplified. It consists simply of a sequence of pairs +of a file member index number as an \s-1LSB\s0 4byte integer and a null-terminated +string. +.IP "\fILong Paths\fR" 4 +.IX Item "Long Paths" +Some \f(CW\*(C`ar\*(C'\fR implementations (\s-1SVR4\s0) use a separate file member to record long +path names (> 15 characters). \fBllvm-ar\fR takes the \s-1BSD\s0 4.4 and Mac \s-1OS\s0 X +approach which is to simply store the full path name immediately preceding +the data for the file. The path name is null terminated and may contain the +slash (/) character. +.IP "\fICompression\fR" 4 +.IX Item "Compression" +\&\fBllvm-ar\fR can compress the members of an archive to save space. The +compression used depends on what's available on the platform and what choices +the \s-1LLVM\s0 Compressor utility makes. It generally favors bzip2 but will select +between \*(L"no compression\*(R" or bzip2 depending on what makes sense for the +file's content. +.IP "\fIDirectory Recursion\fR" 4 +.IX Item "Directory Recursion" +Most \f(CW\*(C`ar\*(C'\fR implementations do not recurse through directories but simply +ignore directories if they are presented to the program in the \fIfiles\fR +option. \fBllvm-ar\fR, however, can recurse through directory structures and +add all the files under a directory, if requested. +.IP "\fI\s-1TOC\s0 Verbose Output\fR" 4 +.IX Item "TOC Verbose Output" +When \fBllvm-ar\fR prints out the verbose table of contents (\f(CW\*(C`tv\*(C'\fR option), it +precedes the usual output with a character indicating the basic kind of +content in the file. A blank means the file is a regular file. A 'Z' means +the file is compressed. A 'B' means the file is an \s-1LLVM\s0 bytecode file. An +\&'S' means the file is the symbol table. +.SH "OPTIONS" +.IX Header "OPTIONS" +The options to \fBllvm-ar\fR are compatible with other \f(CW\*(C`ar\*(C'\fR implementations. +However, there are a few modifiers (\fIzR\fR) that are not found in other +\&\f(CW\*(C`ar\*(C'\fRs. The options to \fBllvm-ar\fR specify a single basic operation to +perform on the archive, a variety of modifiers for that operation, the +name of the archive file, and an optional list of file names. These options +are used to determine how \fBllvm-ar\fR should process the archive file. +.PP +The Operations and Modifiers are explained in the sections below. The minimal +set of options is at least one operator and the name of the archive. Typically +archive files end with a \f(CW\*(C`.a\*(C'\fR suffix, but this is not required. Following +the \fIarchive-name\fR comes a list of \fIfiles\fR that indicate the specific members +of the archive to operate on. If the \fIfiles\fR option is not specified, it +generally means either \*(L"none\*(R" or \*(L"all\*(R" members, depending on the operation. +.Sh "Operations" +.IX Subsection "Operations" +.IP "d" 4 +.IX Item "d" +Delete files from the archive. No modifiers are applicable to this operation. +The \fIfiles\fR options specify which members should be removed from the +archive. It is not an error if a specified file does not appear in the archive. +If no \fIfiles\fR are specified, the archive is not modified. +.IP "m[abi]" 4 +.IX Item "m[abi]" +Move files from one location in the archive to another. The \fIa\fR, \fIb\fR, and +\&\fIi\fR modifiers apply to this operation. The \fIfiles\fR will all be moved +to the location given by the modifiers. If no modifiers are used, the files +will be moved to the end of the archive. If no \fIfiles\fR are specified, the +archive is not modified. +.IP "p[k]" 4 +.IX Item "p[k]" +Print files to the standard output. The \fIk\fR modifier applies to this +operation. This operation simply prints the \fIfiles\fR indicated to the +standard output. If no \fIfiles\fR are specified, the entire archive is printed. +Printing bytecode files is ill-advised as they might confuse your terminal +settings. The \fIp\fR operation never modifies the archive. +.IP "q[Rfz]" 4 +.IX Item "q[Rfz]" +Quickly append files to the end of the archive. The \fIR\fR, \fIf\fR, and \fIz\fR +modifiers apply to this operation. This operation quickly adds the +\&\fIfiles\fR to the archive without checking for duplicates that should be +removed first. If no \fIfiles\fR are specified, the archive is not modified. +Because of the way that \fBllvm-ar\fR constructs the archive file, its dubious +whether the \fIq\fR operation is any faster than the \fIr\fR operation. +.IP "r[Rabfuz]" 4 +.IX Item "r[Rabfuz]" +Replace or insert file members. The \fIR\fR, \fIa\fR, \fIb\fR, \fIf\fR, \fIu\fR, and \fIz\fR +modifiers apply to this operation. This operation will replace existing +\&\fIfiles\fR or insert them at the end of the archive if they do not exist. If no +\&\fIfiles\fR are specified, the archive is not modified. +.IP "t[v]" 4 +.IX Item "t[v]" +Print the table of contents. Without any modifiers, this operation just prints +the names of the members to the standard output. With the \fIv\fR modifier, +\&\fBllvm-ar\fR also prints out the file type (B=bytecode, Z=compressed, S=symbol +table, blank=regular file), the permission mode, the owner and group, the +size, and the date. If any \fIfiles\fR are specified, the listing is only for +those files. If no \fIfiles\fR are specified, the table of contents for the +whole archive is printed. +.IP "x[oP]" 4 +.IX Item "x[oP]" +Extract archive members back to files. The \fIo\fR modifier applies to this +operation. This operation retrieves the indicated \fIfiles\fR from the archive +and writes them back to the operating system's file system. If no +\&\fIfiles\fR are specified, the entire archive is extract. +.Sh "Modifiers (operation specific)" +.IX Subsection "Modifiers (operation specific)" +The modifiers below are specific to certain operations. See the Operations +section (above) to determine which modifiers are applicable to which operations. +.IP "[a]" 4 +.IX Item "[a]" +When inserting or moving member files, this option specifies the destination of +the new files as being \f(CW\*(C`a\*(C'\fRfter the \fIrelpos\fR member. If \fIrelpos\fR is not found, +the files are placed at the end of the archive. +.IP "[b]" 4 +.IX Item "[b]" +When inserting or moving member files, this option specifies the destination of +the new files as being \f(CW\*(C`b\*(C'\fRefore the \fIrelpos\fR member. If \fIrelpos\fR is not +found, the files are placed at the end of the archive. This modifier is +identical to the the \fIi\fR modifier. +.IP "[f]" 4 +.IX Item "[f]" +Normally, \fBllvm-ar\fR stores the full path name to a file as presented to it on +the command line. With this option, truncated (15 characters max) names are +used. This ensures name compatibility with older versions of \f(CW\*(C`ar\*(C'\fR but may also +thwart correct extraction of the files (duplicates may overwrite). If used with +the \fIR\fR option, the directory recursion will be performed but the file names +will all be \f(CW\*(C`f\*(C'\fRlattened to simple file names. +.IP "[i]" 4 +.IX Item "[i]" +A synonym for the \fIb\fR option. +.IP "[k]" 4 +.IX Item "[k]" +Normally, \fBllvm-ar\fR will not print the contents of bytecode files when the +\&\fIp\fR operation is used. This modifier defeats the default and allows the +bytecode members to be printed. +.IP "[N]" 4 +.IX Item "[N]" +This option is ignored by \fBllvm-ar\fR but provided for compatibility. +.IP "[o]" 4 +.IX Item "[o]" +When extracting files, this option will cause \fBllvm-ar\fR to preserve the +original modification times of the files it writes. +.IP "[P]" 4 +.IX Item "[P]" +use full path names when matching +.IP "[R]" 4 +.IX Item "[R]" +This modifier instructions the \fIr\fR option to recursively process directories. +Without \fIR\fR, directories are ignored and only those \fIfiles\fR that refer to +files will be added to the archive. When \fIR\fR is used, any directories specified +with \fIfiles\fR will be scanned (recursively) to find files to be added to the +archive. Any file whose name begins with a dot will not be added. +.IP "[u]" 4 +.IX Item "[u]" +When replacing existing files in the archive, only replace those files that have +a time stamp than the time stamp of the member in the archive. +.IP "[z]" 4 +.IX Item "[z]" +When inserting or replacing any file in the archive, compress the file first. +This +modifier is safe to use when (previously) compressed bytecode files are added to +the archive; the compressed bytecode files will not be doubly compressed. +.Sh "Modifiers (generic)" +.IX Subsection "Modifiers (generic)" +The modifiers below may be applied to any operation. +.IP "[c]" 4 +.IX Item "[c]" +For all operations, \fBllvm-ar\fR will always create the archive if it doesn't +exist. Normally, \fBllvm-ar\fR will print a warning message indicating that the +archive is being created. Using this modifier turns off that warning. +.IP "[s]" 4 +.IX Item "[s]" +This modifier requests that an archive index (or symbol table) be added to the +archive. This is the default mode of operation. The symbol table will contain +all the externally visible functions and global variables defined by all the +bytecode files in the archive. Using this modifier is more efficient that using +llvm-ranlib which also creates the symbol table. +.IP "[S]" 4 +.IX Item "[S]" +This modifier is the opposite of the \fIs\fR modifier. It instructs \fBllvm-ar\fR to +not build the symbol table. If both \fIs\fR and \fIS\fR are used, the last modifier to +occur in the options will prevail. +.IP "[v]" 4 +.IX Item "[v]" +This modifier instructs \fBllvm-ar\fR to be verbose about what it is doing. Each +editing operation taken against the archive will produce a line of output saying +what is being done. +.SH "STANDARDS" +.IX Header "STANDARDS" +The \fBllvm-ar\fR utility is intended to provide a superset of the \s-1IEEE\s0 Std 1003.2 +(\s-1POSIX\s0.2) functionality for \f(CW\*(C`ar\*(C'\fR. \fBllvm-ar\fR can read both \s-1SVR4\s0 and \s-1BSD4\s0.4 (or +Mac \s-1OS\s0 X) archives. If the \f(CW\*(C`f\*(C'\fR modifier is given to the \f(CW\*(C`x\*(C'\fR or \f(CW\*(C`r\*(C'\fR operations +then \fBllvm-ar\fR will write \s-1SVR4\s0 compatible archives. Without this modifier, +\&\fBllvm-ar\fR will write \s-1BSD4\s0.4 compatible archives that have long names +immediately after the header and indicated using the \*(L"#1/ddd\*(R" notation for the +name in the header. +.SH "FILE FORMAT" +.IX Header "FILE FORMAT" +The file format for \s-1LLVM\s0 Archive files is similar to that of \s-1BSD\s0 4.4 or Mac \s-1OSX\s0 +archive files. In fact, except for the symbol table, the \f(CW\*(C`ar\*(C'\fR commands on those +operating systems should be able to read \s-1LLVM\s0 archive files. The details of the +file format follow. +.PP +Each archive begins with the archive magic number which is the eight printable +characters \*(L"!\en\*(R" where \en represents the newline character (0x0A). +Following the magic number, the file is composed of even length members that +begin with an archive header and end with a \en padding character if necessary +(to make the length even). Each file member is composed of a header (defined +below), an optional newline-terminated \*(L"long file name\*(R" and the contents of +the file. +.PP +The fields of the header are described in the items below. All fields of the +header contain only \s-1ASCII\s0 characters, are left justified and are right padded +with space characters. +.IP "name \- char[16]" 4 +.IX Item "name - char[16]" +This field of the header provides the name of the archive member. If the name is +longer than 15 characters or contains a slash (/) character, then this field +contains \f(CW\*(C`#1/nnn\*(C'\fR where \f(CW\*(C`nnn\*(C'\fR provides the length of the name and the \f(CW\*(C`#1/\*(C'\fR +is literal. In this case, the actual name of the file is provided in the \f(CW\*(C`nnn\*(C'\fR +bytes immediately following the header. If the name is 15 characters or less, it +is contained directly in this field and terminated with a slash (/) character. +.IP "date \- char[12]" 4 +.IX Item "date - char[12]" +This field provides the date of modification of the file in the form of a +decimal encoded number that provides the number of seconds since the epoch +(since 00:00:00 Jan 1, 1970) per Posix specifications. +.IP "uid \- char[6]" 4 +.IX Item "uid - char[6]" +This field provides the user id of the file encoded as a decimal \s-1ASCII\s0 string. +This field might not make much sense on non-Unix systems. On Unix, it is the +same value as the st_uid field of the stat structure returned by the \fIstat\fR\|(2) +operating system call. +.IP "gid \- char[6]" 4 +.IX Item "gid - char[6]" +This field provides the group id of the file encoded as a decimal \s-1ASCII\s0 string. +This field might not make much sense on non-Unix systems. On Unix, it is the +same value as the st_gid field of the stat structure returned by the \fIstat\fR\|(2) +operating system call. +.IP "mode \- char[8]" 4 +.IX Item "mode - char[8]" +This field provides the access mode of the file encoded as an octal \s-1ASCII\s0 +string. This field might not make much sense on non-Unix systems. On Unix, it +is the same value as the st_mode field of the stat structure returned by the +\&\fIstat\fR\|(2) operating system call. +.IP "size \- char[10]" 4 +.IX Item "size - char[10]" +This field provides the size of the file, in bytes, encoded as a decimal \s-1ASCII\s0 +string. If the size field is negative (starts with a minus sign, 0x02D), then +the archive member is stored in compressed form. The first byte of the archive +member's data indicates the compression type used. A value of 0 (0x30) indicates +that no compression was used. A value of 2 (0x32) indicates that bzip2 +compression was used. +.IP "fmag \- char[2]" 4 +.IX Item "fmag - char[2]" +This field is the archive file member magic number. Its content is always the +two characters back tick (0x60) and newline (0x0A). This provides some measure +utility in identifying archive files that have been corrupted. +.PP +The \s-1LLVM\s0 symbol table has the special name \*(L"#_LLVM_SYM_TAB_#\*(R". It is presumed +that no regular archive member file will want this name. The \s-1LLVM\s0 symbol table +is simply composed of a sequence of triplets: byte offset, length of symbol, +and the symbol itself. Symbols are not null or newline terminated. Here are +the details on each of these items: +.IP "offset \- vbr encoded 32\-bit integer" 4 +.IX Item "offset - vbr encoded 32-bit integer" +The offset item provides the offset into the archive file where the bytecode +member is stored that is associated with the symbol. The offset value is 0 +based at the start of the first \*(L"normal\*(R" file member. To derive the actual +file offset of the member, you must add the number of bytes occupied by the file +signature (8 bytes) and the symbol tables. The value of this item is encoded +using variable bit rate encoding to reduce the size of the symbol table. +Variable bit rate encoding uses the high bit (0x80) of each byte to indicate +if there are more bytes to follow. The remaining 7 bits in each byte carry bits +from the value. The final byte does not have the high bit set. +.IP "length \- vbr encoded 32\-bit integer" 4 +.IX Item "length - vbr encoded 32-bit integer" +The length item provides the length of the symbol that follows. Like this +\&\fIoffset\fR item, the length is variable bit rate encoded. +.IP "symbol \- character array" 4 +.IX Item "symbol - character array" +The symbol item provides the text of the symbol that is associated with the +\&\fIoffset\fR. The symbol is not terminated by any character. Its length is provided +by the \fIlength\fR field. Note that is allowed (but unwise) to use non-printing +characters (even 0x00) in the symbol. This allows for multiple encodings of +symbol names. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-ar\fR succeeds, it will exit with 0. A usage error, results +in an exit code of 1. A hard (file system typically) error results in an +exit code of 2. Miscellaneous or unknown errors result in an +exit code of 3. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-ranlib, \fIar\fR\|(1) +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-as.1 b/docs/CommandGuide/man/man1/llvm-as.1 new file mode 100644 index 000000000000..fe17759761ff --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-as.1 @@ -0,0 +1,182 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-AS 1" +.TH LLVM-AS 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-as \- LLVM assembler +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-as\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvm-as\fR is the \s-1LLVM\s0 assembler. It reads a file containing human-readable +\&\s-1LLVM\s0 assembly language, translates it to \s-1LLVM\s0 bytecode, and writes the result +into a file or to standard output. +.PP +If \fIfilename\fR is omitted or is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-as\fR reads its input from +standard input. +.PP +If an output file is not specified with the \fB\-o\fR option, then +\&\fBllvm-as\fR sends its output to a file or standard output by following +these rules: +.IP "\(bu" 4 +If the input is standard input, then the output is standard output. +.IP "\(bu" 4 +If the input is a file that ends with \f(CW\*(C`.ll\*(C'\fR, then the output file is of +the same name, except that the suffix is changed to \f(CW\*(C`.bc\*(C'\fR. +.IP "\(bu" 4 +If the input is a file that does not end with the \f(CW\*(C`.ll\*(C'\fR suffix, then the +output file has the same name as the input file, except that the \f(CW\*(C`.bc\*(C'\fR +suffix is appended. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBllvm-as\fR will refuse to overwrite an +output file that already exists. With this option, \fBllvm-as\fR +will overwrite the output file and replace it with new bytecode. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-as\fR +sends its output to standard output. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-as\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-dis, gccas +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-bcanalyzer.1 b/docs/CommandGuide/man/man1/llvm-bcanalyzer.1 new file mode 100644 index 000000000000..eeb6270fd39b --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-bcanalyzer.1 @@ -0,0 +1,370 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-BCANALYZER 1" +.TH LLVM-BCANALYZER 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-bcanalyzer \- LLVM bytecode analyzer +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-bcanalyzer\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-bcanalyzer\fR command is a small utility for analyzing bytecode files. +The tool reads a bytecode file (such as generated with the \fBllvm-as\fR tool) and +produces a statistical report on the contents of the byteocde file. The tool +can also dump a low level but human readable version of the bytecode file. +This tool is probably not of much interest or utility except for those working +directly with the bytecode file format. Most \s-1LLVM\s0 users can just ignore +this tool. +.PP +If \fIfilename\fR is omitted or is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-bcanalyzer\fR reads its input +from standard input. This is useful for combining the tool into a pipeline. +Output is written to the standard output. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-nodetails\fR" 4 +.IX Item "-nodetails" +Causes \fBllvm-bcanalyzer\fR to abbreviate its output by writing out only a module +level summary. The details for individual functions are not displayed. +.IP "\fB\-dump\fR" 4 +.IX Item "-dump" +Causes \fBllvm-bcanalyzer\fR to dump the bytecode in a human readable format. This +format is significantly different from \s-1LLVM\s0 assembly and provides details about +the encoding of the bytecode file. +.IP "\fB\-verify\fR" 4 +.IX Item "-verify" +Causes \fBllvm-bcanalyzer\fR to verify the module produced by reading the +bytecode. This ensures that the statistics generated are based on a consistent +module. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-bcanalyzer\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value, usually 1. +.SH "SUMMARY OUTPUT DEFINITIONS" +.IX Header "SUMMARY OUTPUT DEFINITIONS" +The following items are always printed by llvm\-bcanalyzer. They comprize the +summary output. +.IP "\fBBytecode Analysis Of Module\fR" 4 +.IX Item "Bytecode Analysis Of Module" +This just provides the name of the module for which bytecode analysis is being +generated. +.IP "\fBBytecode Version Number\fR" 4 +.IX Item "Bytecode Version Number" +The bytecode version (not \s-1LLVM\s0 version) of the file read by the analyzer. +.IP "\fBFile Size\fR" 4 +.IX Item "File Size" +The size, in bytes, of the entire bytecode file. +.IP "\fBModule Bytes\fR" 4 +.IX Item "Module Bytes" +The size, in bytes, of the module block. Percentage is relative to File Size. +.IP "\fBFunction Bytes\fR" 4 +.IX Item "Function Bytes" +The size, in bytes, of all the function blocks. Percentage is relative to File +Size. +.IP "\fBGlobal Types Bytes\fR" 4 +.IX Item "Global Types Bytes" +The size, in bytes, of the Global Types Pool. Percentage is relative to File +Size. This is the size of the definitions of all types in the bytecode file. +.IP "\fBConstant Pool Bytes\fR" 4 +.IX Item "Constant Pool Bytes" +The size, in bytes, of the Constant Pool Blocks Percentage is relative to File +Size. +.IP "\fBModule Globals Bytes\fR" 4 +.IX Item "Module Globals Bytes" +Ths size, in bytes, of the Global Variable Definitions and their initializers. +Percentage is relative to File Size. +.IP "\fBInstruction List Bytes\fR" 4 +.IX Item "Instruction List Bytes" +The size, in bytes, of all the instruction lists in all the functions. +Percentage is relative to File Size. Note that this value is also included in +the Function Bytes. +.IP "\fBCompaction Table Bytes\fR" 4 +.IX Item "Compaction Table Bytes" +The size, in bytes, of all the compaction tables in all the functions. +Percentage is relative to File Size. Note that this value is also included in +the Function Bytes. +.IP "\fBSymbol Table Bytes\fR" 4 +.IX Item "Symbol Table Bytes" +The size, in bytes, of all the symbol tables in all the functions. Percentage is +relative to File Size. Note that this value is also included in the Function +Bytes. +.IP "\fBDependent Libraries Bytes\fR" 4 +.IX Item "Dependent Libraries Bytes" +The size, in bytes, of the list of dependent libraries in the module. Percentage +is relative to File Size. Note that this value is also included in the Module +Global Bytes. +.IP "\fBNumber Of Bytecode Blocks\fR" 4 +.IX Item "Number Of Bytecode Blocks" +The total number of blocks of any kind in the bytecode file. +.IP "\fBNumber Of Functions\fR" 4 +.IX Item "Number Of Functions" +The total number of function definitions in the bytecode file. +.IP "\fBNumber Of Types\fR" 4 +.IX Item "Number Of Types" +The total number of types defined in the Global Types Pool. +.IP "\fBNumber Of Constants\fR" 4 +.IX Item "Number Of Constants" +The total number of constants (of any type) defined in the Constant Pool. +.IP "\fBNumber Of Basic Blocks\fR" 4 +.IX Item "Number Of Basic Blocks" +The total number of basic blocks defined in all functions in the bytecode file. +.IP "\fBNumber Of Instructions\fR" 4 +.IX Item "Number Of Instructions" +The total number of instructions defined in all functions in the bytecode file. +.IP "\fBNumber Of Long Instructions\fR" 4 +.IX Item "Number Of Long Instructions" +The total number of long instructions defined in all functions in the bytecode +file. Long instructions are those taking greater than 4 bytes. Typically long +instructions are GetElementPtr with several indices, \s-1PHI\s0 nodes, and calls to +functions with large numbers of arguments. +.IP "\fBNumber Of Operands\fR" 4 +.IX Item "Number Of Operands" +The total number of operands used in all instructions in the bytecode file. +.IP "\fBNumber Of Compaction Tables\fR" 4 +.IX Item "Number Of Compaction Tables" +The total number of compaction tables in all functions in the bytecode file. +.IP "\fBNumber Of Symbol Tables\fR" 4 +.IX Item "Number Of Symbol Tables" +The total number of symbol tables in all functions in the bytecode file. +.IP "\fBNumber Of Dependent Libs\fR" 4 +.IX Item "Number Of Dependent Libs" +The total number of dependent libraries found in the bytecode file. +.IP "\fBTotal Instruction Size\fR" 4 +.IX Item "Total Instruction Size" +The total size of the instructions in all functions in the bytecode file. +.IP "\fBAverage Instruction Size\fR" 4 +.IX Item "Average Instruction Size" +The average number of bytes per instruction across all functions in the bytecode +file. This value is computed by dividing Total Instruction Size by Number Of +Instructions. +.IP "\fBMaximum Type Slot Number\fR" 4 +.IX Item "Maximum Type Slot Number" +The maximum value used for a type's slot number. Larger slot number values take +more bytes to encode. +.IP "\fBMaximum Value Slot Number\fR" 4 +.IX Item "Maximum Value Slot Number" +The maximum value used for a value's slot number. Larger slot number values take +more bytes to encode. +.IP "\fBBytes Per Value\fR" 4 +.IX Item "Bytes Per Value" +The average size of a Value definition (of any type). This is computed by +dividing File Size by the total number of values of any type. +.IP "\fBBytes Per Global\fR" 4 +.IX Item "Bytes Per Global" +The average size of a global definition (constants and global variables). +.IP "\fBBytes Per Function\fR" 4 +.IX Item "Bytes Per Function" +The average number of bytes per function definition. This is computed by +dividing Function Bytes by Number Of Functions. +.IP "\fB# of \s-1VBR\s0 32\-bit Integers\fR" 4 +.IX Item "# of VBR 32-bit Integers" +The total number of 32\-bit integers encoded using the Variable Bit Rate +encoding scheme. +.IP "\fB# of \s-1VBR\s0 64\-bit Integers\fR" 4 +.IX Item "# of VBR 64-bit Integers" +The total number of 64\-bit integers encoded using the Variable Bit Rate encoding +scheme. +.IP "\fB# of \s-1VBR\s0 Compressed Bytes\fR" 4 +.IX Item "# of VBR Compressed Bytes" +The total number of bytes consumed by the 32\-bit and 64\-bit integers that use +the Variable Bit Rate encoding scheme. +.IP "\fB# of \s-1VBR\s0 Expanded Bytes\fR" 4 +.IX Item "# of VBR Expanded Bytes" +The total number of bytes that would have been consumed by the 32\-bit and 64\-bit +integers had they not been compressed with the Variable Bit Rage encoding +scheme. +.IP "\fBBytes Saved With \s-1VBR\s0\fR" 4 +.IX Item "Bytes Saved With VBR" +The total number of bytes saved by using the Variable Bit Rate encoding scheme. +The percentage is relative to # of \s-1VBR\s0 Expanded Bytes. +.SH "DETAILED OUTPUT DEFINITIONS" +.IX Header "DETAILED OUTPUT DEFINITIONS" +The following definitions occur only if the \-nodetails option was not given. +The detailed output provides additional information on a per-function basis. +.IP "\fBType\fR" 4 +.IX Item "Type" +The type signature of the function. +.IP "\fBByte Size\fR" 4 +.IX Item "Byte Size" +The total number of bytes in the function's block. +.IP "\fBBasic Blocks\fR" 4 +.IX Item "Basic Blocks" +The number of basic blocks defined by the function. +.IP "\fBInstructions\fR" 4 +.IX Item "Instructions" +The number of instructions defined by the function. +.IP "\fBLong Instructions\fR" 4 +.IX Item "Long Instructions" +The number of instructions using the long instruction format in the function. +.IP "\fBOperands\fR" 4 +.IX Item "Operands" +The number of operands used by all instructions in the function. +.IP "\fBInstruction Size\fR" 4 +.IX Item "Instruction Size" +The number of bytes consumed by instructions in the function. +.IP "\fBAverage Instruction Size\fR" 4 +.IX Item "Average Instruction Size" +The average number of bytes consumed by the instructions in the funtion. This +value is computed by dividing Instruction Size by Instructions. +.IP "\fBBytes Per Instruction\fR" 4 +.IX Item "Bytes Per Instruction" +The average number of bytes used by the function per instruction. This value is +computed by dividing Byte Size by Instructions. Note that this is not the same +as Average Instruction Size. It computes a number relative to the total function +size not just the size of the instruction list. +.IP "\fBNumber of \s-1VBR\s0 32\-bit Integers\fR" 4 +.IX Item "Number of VBR 32-bit Integers" +The total number of 32\-bit integers found in this function (for any use). +.IP "\fBNumber of \s-1VBR\s0 64\-bit Integers\fR" 4 +.IX Item "Number of VBR 64-bit Integers" +The total number of 64\-bit integers found in this function (for any use). +.IP "\fBNumber of \s-1VBR\s0 Compressed Bytes\fR" 4 +.IX Item "Number of VBR Compressed Bytes" +The total number of bytes in this function consumed by the 32\-bit and 64\-bit +integers that use the Variable Bit Rate encoding scheme. +.IP "\fBNumber of \s-1VBR\s0 Expanded Bytes\fR" 4 +.IX Item "Number of VBR Expanded Bytes" +The total number of bytes in this function that would have been consumed by +the 32\-bit and 64\-bit integers had they not been compressed with the Variable +Bit Rate encoding scheme. +.IP "\fBBytes Saved With \s-1VBR\s0\fR" 4 +.IX Item "Bytes Saved With VBR" +The total number of bytes saved in this function by using the Variable Bit +Rate encoding scheme. The percentage is relative to # of \s-1VBR\s0 Expanded Bytes. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-dis, +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-config.1 b/docs/CommandGuide/man/man1/llvm-config.1 new file mode 100644 index 000000000000..5246ecaccb46 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-config.1 @@ -0,0 +1,227 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-CONFIG 1" +.TH LLVM-CONFIG 1 "2006-08-01" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-config \- Print LLVM compilation options +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-config\fR \fIoption\fR [\fIcomponents\fR...] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvm-config\fR makes it easier to build applications that use \s-1LLVM\s0. It can +print the compiler flags, linker flags and object libraries needed to link +against \s-1LLVM\s0. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +To link against the \s-1JIT:\s0 +.PP +.Vb 3 +\& g++ `llvm-config --cxxflags` -o HowToUseJIT.o -c HowToUseJIT.cpp +\& g++ `llvm-config --ldflags` -o HowToUseJIT HowToUseJIT.o \e +\& `llvm-config --libs engine bcreader scalaropts` +.Ve +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +Print the version number of \s-1LLVM\s0. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of \fBllvm-config\fR arguments. +.IP "\fB\-\-prefix\fR" 4 +.IX Item "--prefix" +Print the installation prefix for \s-1LLVM\s0. +.IP "\fB\-\-src\-root\fR" 4 +.IX Item "--src-root" +Print the source root from which \s-1LLVM\s0 was built. +.IP "\fB\-\-obj\-root\fR" 4 +.IX Item "--obj-root" +Print the object root used to build \s-1LLVM\s0. +.IP "\fB\-\-bindir\fR" 4 +.IX Item "--bindir" +Print the installation directory for \s-1LLVM\s0 binaries. +.IP "\fB\-\-includedir\fR" 4 +.IX Item "--includedir" +Print the installation directory for \s-1LLVM\s0 headers. +.IP "\fB\-\-libdir\fR" 4 +.IX Item "--libdir" +Print the installation directory for \s-1LLVM\s0 libraries. +.IP "\fB\-\-cxxflags\fR" 4 +.IX Item "--cxxflags" +Print the \*(C+ compiler flags needed to use \s-1LLVM\s0 headers. +.IP "\fB\-\-ldflags\fR" 4 +.IX Item "--ldflags" +Print the flags needed to link against \s-1LLVM\s0 libraries. +.IP "\fB\-\-libs\fR" 4 +.IX Item "--libs" +Print all the libraries needed to link against the specified \s-1LLVM\s0 +\&\fIcomponents\fR, including any dependencies. +.IP "\fB\-\-libnames\fR" 4 +.IX Item "--libnames" +Similar to \fB\-\-libs\fR, but prints the bare filenames of the libraries +without \fB\-l\fR or pathnames. Useful for linking against a not-yet-installed +copy of \s-1LLVM\s0. +.IP "\fB\-\-libfiles\fR" 4 +.IX Item "--libfiles" +Similar to \fB\-\-libs\fR, but print the full path to each library file. This is +useful when creating makefile dependencies, to ensure that a tool is relinked if +any library it uses changes. +.IP "\fB\-\-components\fR" 4 +.IX Item "--components" +Print all valid component names. +.IP "\fB\-\-targets\-built\fR" 4 +.IX Item "--targets-built" +Print the component names for all targets supported by this copy of \s-1LLVM\s0. +.IP "\fB\-\-build\-mode\fR" 4 +.IX Item "--build-mode" +Print the build mode used when \s-1LLVM\s0 was built (e.g. Debug or Release) +.SH "COMPONENTS" +.IX Header "COMPONENTS" +To print a list of all available components, run \fBllvm-config +\&\-\-components\fR. In most cases, components correspond directly to \s-1LLVM\s0 +libraries. Useful \*(L"virtual\*(R" components include: +.IP "\fBall\fR" 4 +.IX Item "all" +Includes all \s-1LLVM\s0 libaries. The default if no components are specified. +.IP "\fBbackend\fR" 4 +.IX Item "backend" +Includes either a native backend or the C backend. +.IP "\fBengine\fR" 4 +.IX Item "engine" +Includes either a native \s-1JIT\s0 or the bytecode interpreter. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-config\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-db.1 b/docs/CommandGuide/man/man1/llvm-db.1 new file mode 100644 index 000000000000..d27844360ed0 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-db.1 @@ -0,0 +1,141 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-DB 1" +.TH LLVM-DB 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-db \- LLVM debugger (alpha) +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +Details coming soon. Please see + in the meantime. +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-dis.1 b/docs/CommandGuide/man/man1/llvm-dis.1 new file mode 100644 index 000000000000..2633ad5d715b --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-dis.1 @@ -0,0 +1,175 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-DIS 1" +.TH LLVM-DIS 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-dis \- LLVM disassembler +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-dis\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-dis\fR command is the \s-1LLVM\s0 disassembler. It takes an \s-1LLVM\s0 +bytecode file and converts it into human-readable \s-1LLVM\s0 assembly language. +.PP +If filename is omitted or specified as \f(CW\*(C`\-\*(C'\fR, \fBllvm-dis\fR reads its +input from standard input. +.PP +If the input is being read from standard input, then \fBllvm-dis\fR +will send its output to standard output by default. Otherwise, the +output will be written to a file named after the input file, with +a \f(CW\*(C`.ll\*(C'\fR suffix added (any existing \f(CW\*(C`.bc\*(C'\fR suffix will first be +removed). You can override the choice of output file using the +\&\fB\-o\fR option. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBllvm-dis\fR will refuse to overwrite +an output file that already exists. With this option, \fBllvm-dis\fR +will overwrite the output file. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \-, then the output is sent +to standard output. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-dis\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-as +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-extract.1 b/docs/CommandGuide/man/man1/llvm-extract.1 new file mode 100644 index 000000000000..fdbef37a3a0b --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-extract.1 @@ -0,0 +1,177 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-EXTRACT 1" +.TH LLVM-EXTRACT 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-extract \- extract a function from an LLVM module +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-extract\fR [\fIoptions\fR] \fB\-\-func\fR \fIfunction-name\fR [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-extract\fR command takes the name of a function and extracts it from +the specified \s-1LLVM\s0 bytecode file. It is primarily used as a debugging tool to +reduce test cases from larger programs that are triggering a bug. +.PP +In addition to extracting the bytecode of the specified function, +\&\fBllvm-extract\fR will also remove unreachable global variables, prototypes, and +unused types. +.PP +The \fBllvm-extract\fR command reads its input from standard input if filename is +omitted or if filename is \-. The output is always written to standard output, +unless the \fB\-o\fR option is specified (see below). +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBllvm-extract\fR will refuse to overwrite an +output file that already exists. With this option, \fBllvm-extract\fR +will overwrite the output file and replace it with new bytecode. +.IP "\fB\-\-func\fR \fIfunction-name\fR" 4 +.IX Item "--func function-name" +Extract the function named \fIfunction-name\fR from the \s-1LLVM\s0 bytecode. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output filename. If filename is \*(L"\-\*(R" (the default), then +\&\fBllvm-extract\fR sends its output to standard output. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-extract\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +bugpoint +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-ld.1 b/docs/CommandGuide/man/man1/llvm-ld.1 new file mode 100644 index 000000000000..cd079b5994d6 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-ld.1 @@ -0,0 +1,348 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-LD 1" +.TH LLVM-LD 1 "2007-05-06" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-ld \- LLVM linker +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-ld\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-ld\fR tool takes a set of \s-1LLVM\s0 bytecode files and links them +together into a single \s-1LLVM\s0 bytecode file. The output bytecode file can be +another bytecode file or an executable bytecode program. Using additional +options, \fBllvm-ld\fR is able to produce native code executables. +.PP +The \fBllvm-ld\fR tool is the main linker for \s-1LLVM\s0. It is used to link together +the output of \s-1LLVM\s0 front-end compilers and run \*(L"link time\*(R" optimizations (mostly +the inter-procedural kind). +.PP +The \fBllvm-ld\fR tools attemps to mimic the interface provided by the default +system linker so that it can act as a \fIdrop-in\fR replacement. +.Sh "Search Order" +.IX Subsection "Search Order" +When looking for objects specified on the command line, \fBllvm-ld\fR will search +for the object first in the current directory and then in the directory +specified by the \fB\s-1LLVM_LIB_SEARCH_PATH\s0\fR environment variable. If it cannot +find the object, it fails. +.PP +When looking for a library specified with the \fB\-l\fR option, \fBllvm-ld\fR first +attempts to load a file with that name from the current directory. If that +fails, it looks for lib\fIlibrary\fR.bc, lib\fIlibrary\fR.a, or lib\fIlibrary\fR.\fIshared +library extension\fR, in that order, in each directory added to the library search +path with the \fB\-L\fR option. These directories are searched in the order they +are specified. If the library cannot be located, then \fBllvm-ld\fR looks in the +directory specified by the \fB\s-1LLVM_LIB_SEARCH_PATH\s0\fR environment variable. If it +does not find a library there, it fails. +.PP +The \fIshared library extension\fR may be \fI.so\fR, \fI.dyld\fR, \fI.dll\fR, or something +different, depending upon the system. +.PP +The \fB\-L\fR option is global. It does not matter where it is specified in the +list of command line arguments; the directory is simply added to the search path +and is applied to all libraries, preceding or succeeding, in the command line. +.Sh "Link order" +.IX Subsection "Link order" +All object and bytecode files are linked first in the order they were +specified on the command line. All library files are linked next. +Some libraries may not be linked into the object program; see below. +.Sh "Library Linkage" +.IX Subsection "Library Linkage" +Object files and static bytecode objects are always linked into the output +file. Library archives (.a files) load only the objects within the archive +that define symbols needed by the output file. Hence, libraries should be +listed after the object files and libraries which need them; otherwise, the +library may not be linked in, and the dependent library will not have its +undefined symbols defined. +.Sh "Native code generation" +.IX Subsection "Native code generation" +The \fBllvm-ld\fR program has limited support for native code generation, when +using the \fB\-native\fR or \fB\-native\-cbe\fR options. Native code generation is +perfomed by converting the linked bytecode into native assembly (.s) or C code +and running the system compiler (typically gcc) on the result. +.SH "OPTIONS" +.IX Header "OPTIONS" +.Sh "General Options" +.IX Subsection "General Options" +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a summary of command line options. +.IP "\fB\-v\fR" 4 +.IX Item "-v" +Specifies verbose mode. In this mode the linker will print additional +information about the actions it takes, programs it executes, etc. +.IP "\fB\-stats\fR" 4 +.IX Item "-stats" +Print statistics. +.IP "\fB\-time\-passes\fR" 4 +.IX Item "-time-passes" +Record the amount of time needed for each pass and print it to standard +error. +.Sh "Input/Output Options" +.IX Subsection "Input/Output Options" +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +This overrides the default output file and specifies the name of the file that +should be generated by the linker. By default, \fBllvm-ld\fR generates a file named +\&\fIa.out\fR for compatibility with \fBld\fR. The output will be written to +\&\fIfilename\fR. +.IP "\fB\-l\fR\fIname\fR" 4 +.IX Item "-lname" +This option specifies the \fIname\fR of a library to search when resolving symbols +for the program. Only the base name should be specified as \fIname\fR, without a +\&\fIlib\fR prefix or any suffix. +.IP "\fB\-L\fR\fIPath\fR" 4 +.IX Item "-LPath" +This option tells \fBllvm-ld\fR to look in \fIPath\fR to find any library subsequently +specified with the \fB\-l\fR option. The paths will be searched in the order in +which they are specified on the command line. If the library is still not found, +a small set of system specific directories will also be searched. Note that +libraries specified with the \fB\-l\fR option that occur \fIbefore\fR any \fB\-L\fR options +will not search the paths given by the \fB\-L\fR options following it. +.IP "\fB\-link\-as\-library\fR" 4 +.IX Item "-link-as-library" +Link the bytecode files together as a library, not an executable. In this mode, +undefined symbols will be permitted. +.IP "\fB\-r\fR" 4 +.IX Item "-r" +An alias for \-link\-as\-library. +.ie n .IP "\fB\-march=\fR""target""" 4 +.el .IP "\fB\-march=\fR\f(CWtarget\fR" 4 +.IX Item "-march=target" +Specifies the kind of machine for which code or assembly should be generated. +.IP "\fB\-native\fR" 4 +.IX Item "-native" +Generate a native machine code executable. +.Sp +When generating native executables, \fBllvm-ld\fR first checks for a bytecode +version of the library and links it in, if necessary. If the library is +missing, \fBllvm-ld\fR skips it. Then, \fBllvm-ld\fR links in the same +libraries as native code. +.Sp +In this way, \fBllvm-ld\fR should be able to link in optimized bytecode +subsets of common libraries and then link in any part of the library that +hasn't been converted to bytecode. +.IP "\fB\-native\-cbe\fR" 4 +.IX Item "-native-cbe" +Generate a native machine code executable with the \s-1LLVM\s0 C backend. +.Sp +This option is identical to the \fB\-native\fR option, but uses the +C backend to generate code for the program instead of an \s-1LLVM\s0 native +code generator. +.Sh "Optimization Options" +.IX Subsection "Optimization Options" +.IP "\fB\-O0\fR" 4 +.IX Item "-O0" +An alias for the \-O1 option. +.IP "\fB\-O1\fR" 4 +.IX Item "-O1" +Optimize for linking speed, not execution speed. The optimizer will attempt to +reduce the size of the linked program to reduce I/O but will not otherwise +perform any link-time optimizations. +.IP "\fB\-O2\fR" 4 +.IX Item "-O2" +Perform only the minimal or required set of scalar optimizations. +.IP "\fB\-03\fR" 4 +.IX Item "-03" +An alias for the \-O2 option. +.IP "\fB\-04\fR" 4 +.IX Item "-04" +Perform the standard link time inter-procedural optimizations. This will +attempt to optimize the program taking the entire program into consideration. +.IP "\fB\-O5\fR" 4 +.IX Item "-O5" +Perform aggressive link time optimizations. This is the same as \-O4 but works +more aggressively to optimize the program. +.IP "\fB\-disable\-inlining\fR" 4 +.IX Item "-disable-inlining" +Do not run the inlining pass. Functions will not be inlined into other +functions. +.IP "\fB\-disable\-opt\fR" 4 +.IX Item "-disable-opt" +Completely disable optimization. The various \fB\-On\fR options will be ignored and +no link time optimization passes will be run. +.IP "\fB\-disable\-internalize\fR" 4 +.IX Item "-disable-internalize" +Do not mark all symbols as internal. +.IP "\fB\-verify\-each\fR" 4 +.IX Item "-verify-each" +Run the verification pass after each of the passes to verify intermediate +results. +.IP "\fB\-strip\-all\fR" 4 +.IX Item "-strip-all" +Strip all debug and symbol information from the executable to make it smaller. +.IP "\fB\-strip\-debug\fR" 4 +.IX Item "-strip-debug" +Strip all debug information from the executable to make it smaller. +.IP "\fB\-s\fR" 4 +.IX Item "-s" +An alias for \fB\-strip\-all\fR. +.IP "\fB\-S\fR" 4 +.IX Item "-S" +An alias for \fB\-strip\-debug\fR. +.IP "\fB\-export\-dynamic\fR" 4 +.IX Item "-export-dynamic" +An alias for \fB\-disable\-internalize\fR +.IP "\fB\-load\fR \fImodule\fR" 4 +.IX Item "-load module" +Load an optimization module, \fImodule\fR, which is expected to be a dynamic +library that provides the function name \f(CW\*(C`RunOptimizations\*(C'\fR. This function will +be passed the PassManager, and the optimization level (values 0\-5 based on the +\&\fB\-On\fR option). This function may add passes to the PassManager that should be +run. This feature allows the optimization passes of \fBllvm-ld\fR to be extended. +.IP "\fB\-post\-link\-opt\fR\fIPath\fR" 4 +.IX Item "-post-link-optPath" +Run post-link optimization program. After linking is completed a bytecode file +will be generated. It will be passed to the program specified by \fIPath\fR as the +first argument. The second argument to the program will be the name of a +temporary file into which the program should place its optimized output. For +example, the \*(L"no\-op optimization\*(R" would be a simple shell script: +.Sp +.Vb 2 +\& #!/bin/bash +\& cp $1 $2 +.Ve +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-ld\fR succeeds, it will exit with 0 return code. If an error occurs, +it will exit with a non-zero return code. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +The \f(CW\*(C`LLVM_LIB_SEARCH_PATH\*(C'\fR environment variable is used to find bytecode +libraries. Any paths specified in this variable will be searched after the \f(CW\*(C`\-L\*(C'\fR +options. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-link +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-link.1 b/docs/CommandGuide/man/man1/llvm-link.1 new file mode 100644 index 000000000000..1702dbe392eb --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-link.1 @@ -0,0 +1,186 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-LINK 1" +.TH LLVM-LINK 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-link \- LLVM linker +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-link\fR [\fIoptions\fR] \fIfilename ...\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvm-link\fR takes several \s-1LLVM\s0 bytecode files and links them together into a +single \s-1LLVM\s0 bytecode file. It writes the output file to standard output, unless +the \fB\-o\fR option is used to specify a filename. +.PP +\&\fBllvm-link\fR attempts to load the input files from the current directory. If +that fails, it looks for each file in each of the directories specified by the +\&\fB\-L\fR options on the command line. The library search paths are global; each +one is searched for every input file if necessary. The directories are searched +in the order they were specified on the command line. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-L\fR \fIdirectory\fR" 4 +.IX Item "-L directory" +Add the specified \fIdirectory\fR to the library search path. When looking for +libraries, \fBllvm-link\fR will look in pathname for libraries. This option can be +specified multiple times; \fBllvm-link\fR will search inside these directories in +the order in which they were specified on the command line. +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Overwrite output files. By default, \fBllvm-link\fR will not overwrite an output +file if it alreadys exists. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-link\fR will +write its output to standard output. +.IP "\fB\-d\fR" 4 +.IX Item "-d" +If specified, \fBllvm-link\fR prints a human-readable version of the output +bytecode file to standard error. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-v\fR" 4 +.IX Item "-v" +Verbose mode. Print information about what \fBllvm-link\fR is doing. This +typically includes a message for each bytecode file linked in and for each +library found. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-link\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +gccld +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-nm.1 b/docs/CommandGuide/man/man1/llvm-nm.1 new file mode 100644 index 000000000000..386d9e6e3c52 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-nm.1 @@ -0,0 +1,219 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-NM 1" +.TH LLVM-NM 1 "2006-11-20" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-nm \- list LLVM bytecode file's symbol table +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-nm\fR [\fIoptions\fR] [\fIfilenames...\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-nm\fR utility lists the names of symbols from the \s-1LLVM\s0 bytecode files, +or \fBar\fR archives containing \s-1LLVM\s0 bytecode files, named on the command line. +Each symbol is listed along with some simple information about its provenance. +If no filename is specified, or \fI\-\fR is used as a filename, \fBllvm-nm\fR will +process a bytecode file on its standard input stream. +.PP +\&\fBllvm-nm\fR's default output format is the traditional \s-1BSD\s0 \fBnm\fR 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. +.PP +Type code characters currently supported, and their meanings, are as follows: +.IP "U" 4 +.IX Item "U" +Named object is referenced but undefined in this bytecode file +.IP "C" 4 +.IX Item "C" +Common (multiple defs link together into one def) +.IP "W" 4 +.IX Item "W" +Weak reference (multiple defs link together into zero or one defs) +.IP "t" 4 +.IX Item "t" +Local function (text) object +.IP "T" 4 +.IX Item "T" +Global function (text) object +.IP "d" 4 +.IX Item "d" +Local data object +.IP "D" 4 +.IX Item "D" +Global data object +.IP "?" 4 +Something unrecognizable +.PP +Because \s-1LLVM\s0 bytecode files typically contain objects that are not considered to +have addresses until they are linked into an executable image or dynamically +compiled \*(L"just\-in\-time\*(R", \fBllvm-nm\fR does not print an address for any symbol, +even symbols which are defined in the bytecode file. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-P\fR" 4 +.IX Item "-P" +Use \s-1POSIX\s0.2 output format. Alias for \fB\-\-format=posix\fR. +.IP "\fB\-B\fR (default)" 4 +.IX Item "-B (default)" +Use \s-1BSD\s0 output format. Alias for \fB\-\-format=bsd\fR. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command-line options and their meanings. +.IP "\fB\-\-defined\-only\fR" 4 +.IX Item "--defined-only" +Print only symbols defined in this bytecode file (as opposed to +symbols which may be referenced by objects in this file, but not +defined in this file.) +.IP "\fB\-\-extern\-only\fR, \fB\-g\fR" 4 +.IX Item "--extern-only, -g" +Print only symbols whose definitions are external; that is, accessible +from other bytecode files. +.IP "\fB\-\-undefined\-only\fR, \fB\-u\fR" 4 +.IX Item "--undefined-only, -u" +Print only symbols referenced but not defined in this bytecode file. +.IP "\fB\-\-format=\fR\fIfmt\fR, \fB\-f\fR" 4 +.IX Item "--format=fmt, -f" +Select an output format; \fIfmt\fR may be \fIsysv\fR, \fIposix\fR, or \fIbsd\fR. The +default is \fIbsd\fR. +.SH "BUGS" +.IX Header "BUGS" +\&\fBllvm-nm\fR cannot demangle \*(C+ mangled names, like \s-1GNU\s0 \fBnm\fR can. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +\&\fBllvm-nm\fR exits with an exit code of zero. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-dis, \fIar\fR\|(1), \fInm\fR\|(1) +.SH "AUTHOR" +.IX Header "AUTHOR" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-prof.1 b/docs/CommandGuide/man/man1/llvm-prof.1 new file mode 100644 index 000000000000..d7d765163a5e --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-prof.1 @@ -0,0 +1,173 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-PROF 1" +.TH LLVM-PROF 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-prof \- print execution profile of LLVM program +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-prof\fR [\fIoptions\fR] [\fIbytecode file\fR] [\fIllvmprof.out\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-prof\fR tool reads in an \fIllvmprof.out\fR file (which can +optionally use a specific file with the third program argument), a bytecode file +for the program, and produces a human readable report, suitable for determining +where the program hotspots are. +.PP +This program is often used in conjunction with the \fIutils/profile.pl\fR +script. This script automatically instruments a program, runs it with the \s-1JIT\s0, +then runs \fBllvm-prof\fR to format a report. To get more information about +\&\fIutils/profile.pl\fR, execute it with the \fB\-\-help\fR option. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-annotated\-llvm\fR or \fB\-A\fR" 4 +.IX Item "--annotated-llvm or -A" +In addition to the normal report printed, print out the code for the +program, annotated with execution frequency information. This can be +particularly useful when trying to visualize how frequently basic blocks +are executed. This is most useful with basic block profiling +information or better. +.IP "\fB\-\-print\-all\-code\fR" 4 +.IX Item "--print-all-code" +Using this option enables the \fB\-\-annotated\-llvm\fR option, but it +prints the entire module, instead of just the most commonly executed +functions. +.IP "\fB\-\-time\-passes\fR" 4 +.IX Item "--time-passes" +Record the amount of time needed for each pass and print it to standard +error. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +\&\fBllvm-prof\fR returns 1 if it cannot load the bytecode file or the profile +information. Otherwise, it exits with zero. +.SH "AUTHOR" +.IX Header "AUTHOR" +\&\fBllvm-prof\fR is maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-ranlib.1 b/docs/CommandGuide/man/man1/llvm-ranlib.1 new file mode 100644 index 000000000000..daccd0e0efca --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-ranlib.1 @@ -0,0 +1,167 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-RANLIB 1" +.TH LLVM-RANLIB 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-ranlib \- Generate index for LLVM archive +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-ranlib\fR [\-\-version] [\-\-help] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-ranlib\fR command is similar to the common Unix utility, \f(CW\*(C`ranlib\*(C'\fR. It +adds or updates the symbol table in an \s-1LLVM\s0 archive file. Note that using the +\&\fBllvm-ar\fR modifier \fIs\fR is usually more efficient than running \fBllvm-ranlib\fR +which is only provided only for completness and compatibility. Unlike other +implementations of \f(CW\*(C`ranlib\*(C'\fR, \fBllvm-ranlib\fR indexes \s-1LLVM\s0 bytecode files, not +native object modules. You can list the contents of the symbol table with the +\&\f(CW\*(C`llvm\-nm \-s\*(C'\fR command. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fIarchive-file\fR" 4 +.IX Item "archive-file" +Specifies the archive-file to which the symbol table is added or updated. +.IP "\fI\-\-version\fR" 4 +.IX Item "--version" +Print the version of \fBllvm-ranlib\fR and exit without building a symbol table. +.IP "\fI\-\-help\fR" 4 +.IX Item "--help" +Print usage help for \fBllvm-ranlib\fR and exit without building a symbol table. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-ranlib\fR succeeds, it will exit with 0. If an error occurs, a non-zero +exit code will be returned. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-ar, \fIranlib\fR\|(1) +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm-upgrade.1 b/docs/CommandGuide/man/man1/llvm-upgrade.1 new file mode 100644 index 000000000000..26860c14fb5e --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm-upgrade.1 @@ -0,0 +1,179 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM-UPGRADE 1" +.TH LLVM-UPGRADE 1 "2006-12-02" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-upgrade \- LLVM assembly upgrader +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-upgrade\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvm-upgrade\fR is the \s-1LLVM\s0 assembly upgrader. It reads a file containing +human-readable \s-1LLVM\s0 assembly language, and upgrades that assembly to the current +version of \s-1LLVM\s0. If the input is in the form currently accepted by \s-1LLVM\s0, then +no upgrades are performed. +.PP +The expected usage of this tool is as a filter, like this: +.Sp +.RS 4 +\&\fBllvm\-1.9/bin/llvm\-dis < 1.9.bc | llvm-upgrade | llvm\-2.0/bin/llvm\-as \-o 2.0.bc\fR +.RE +.PP +If \fIfilename\fR is omitted or is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-upgrade\fR reads its input from +standard input. +.PP +If an output file is not specified with the \fB\-o\fR option, then +\&\fBllvm-upgrade\fR sends its output to standard output. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBllvm-upgrade\fR will refuse to overwrite an +output file that already exists. With this option, \fBllvm-upgrade\fR +will overwrite the output file. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-upgrade\fR +sends its output to standard output. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-upgrade\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-as, llvm-dis +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvm2cpp.1 b/docs/CommandGuide/man/man1/llvm2cpp.1 new file mode 100644 index 000000000000..1c8a6381bbf3 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvm2cpp.1 @@ -0,0 +1,301 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVM2CPP 1" +.TH LLVM2CPP 1 "2006-08-10" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm2xpp \- LLVM bytecode to LLVM C++ IR translator +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm2cpp\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvm2cpp\fR translates from \s-1LLVM\s0 bytecode (.bc files) to a +corresponding \*(C+ source file that will make calls against the \s-1LLVM\s0 \*(C+ \s-1API\s0 to +build the same module as the input. By default, the \*(C+ output is a complete +program that builds the module, verifies it and then emits the module as +\&\s-1LLVM\s0 assembly. This technique assists with testing because the input to +\&\fBllvm2cpp\fR and the output of the generated \*(C+ program should be identical. +.PP +If \fIfilename\fR is omitted or is \f(CW\*(C`\-\*(C'\fR, then \fBllvm2cpp\fR reads its input from +standard input. +.PP +If an output file is not specified with the \fB\-o\fR option, then +\&\fBllvm2cpp\fR sends its output to a file or standard output by following +these rules: +.IP "\(bu" 4 +If the input is standard input, then the output is standard output. +.IP "\(bu" 4 +If the input is a file that ends with \f(CW\*(C`.bc\*(C'\fR, then the output file is of +the same name, except that the suffix is changed to \f(CW\*(C`.cpp\*(C'\fR. +.IP "\(bu" 4 +If the input is a file that does not end with the \f(CW\*(C`.bc\*(C'\fR suffix, then the +output file has the same name as the input file, except that the \f(CW\*(C`.cpp\*(C'\fR +suffix is appended. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBllvm2cpp\fR will refuse to overwrite an +output file that already exists. With this option, \fBllvm2cpp\fR +will overwrite the output file and replace it with new \*(C+ source code. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Normally, \fBllvm2cpp\fR will not overwrite an existing output file. With this +option, that default behavior is changed and the program will overwrite existing +output files. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm2cpp\fR +sends its output to standard output. +.IP "\fB\-funcname\fR \fIfunctionName\fR" 4 +.IX Item "-funcname functionName" +Specify the name of the function to be generated. The generated code contains a +single function that produces the input module. By default its name is +\&\fImakeLLVMModule\fR. The \fB\-funcname\fR option overrides this default and allows +you to control the name of the generated function. This is handy in conjunction +with the \fB\-fragment\fR option when you only want \fBllvm2cpp\fR to generate a +single function that produces the module. With both options, such generated code +could be \fI#included\fR into another program. +.IP "\fB\-for\fR" 4 +.IX Item "-for" +Specify the name of the thing for which \*(C+ code should be generated. By default +the entire input module is re\-generated. However, use of the various \fB\-gen\-*\fR +options can restrict what is produced. This option indicates what that +restriction is. +.IP "\fB\-gen\-program\fR" 4 +.IX Item "-gen-program" +Specify that the output should be a complete program. Such program will recreate +\&\fBllvm2cpp\fR's input as an \s-1LLVM\s0 module, verify that module, and then write out +the module in \s-1LLVM\s0 assembly format. This is useful for doing identity tests +where the output of the generated program is identical to the input to +\&\fBllvm2cpp\fR. The \s-1LLVM\s0 DejaGnu test suite can make use of this fact. This is the +default form of generated output. +.Sp +If the \fB\-for\fR option is given with this option, it specifies the module +identifier to use for the module created. +.IP "\fB\-gen\-module\fR" 4 +.IX Item "-gen-module" +Specify that the output should be a function that regenerates the module. It is +assumed that this output will be #included into another program that has already +arranged for the correct header files to be #included. The function generated +takes no arguments and returns a \fIModule*\fR. +.Sp +If the \fB\-for\fR option is given with this option, it specifies the module +identifier to use in creating the module returned by the generated function. +.IP "\fB\-gen\-contents\fR" 4 +.IX Item "-gen-contents" +Specify that the output should be a function that adds the contents of the input +module to another module. It is assumed that the output will be #included into +another program that has already arranged for the correct header files to be +#included. The function generated takes a single argument of type \fIModule*\fR and +returns that argument. Note that Module level attributes such as endianess, +pointer size, target triple and inline asm are not passed on from the input +module to the destination module. Only the sub-elements of the module (types, +constants, functions, global variables) will be added to the input module. +.Sp +If the \fB\-for\fR option is given with this option, it specifies the module +identifier to set in the input module by the generated function. +.IP "\fB\-gen\-function\fR" 4 +.IX Item "-gen-function" +Specify that the output should be a function that produces the definitions +necessary for a specific function to be added to a module. It is assumed that +the output will be #included into another program that has already arranged +for the correct header files to be #included. The function generated takes a +single argument of type \fIModule*\fR and returns the \fIFunction*\fR that it added to +the module. Note that only those things (types, constants, etc.) directly +needed in the definition of the function will be placed in the generated +function. +.Sp +The \fB\-for\fR option must be given with this option or an error will be produced. +The value of the option must be the name of a function in the input module for +which code should be generated. If the named function does not exist an error +will be produced. +.IP "\fB\-gen\-inline\fR" 4 +.IX Item "-gen-inline" +This option is very analagous to \fB\-gen\-function\fR except that the generated +function will not re-produce the target function's definition. Instead, the body +of the target function is inserted into some other function passed as an +argument to the generated function. Similarly any arguments to the function must +be passed to the generated function. The result of the generated function is the +first basic block of the target function. +.Sp +The \fB\-for\fR option works the same way as it does for \fB\-gen\-function\fR. +.IP "\fB\-gen\-variable\fR" 4 +.IX Item "-gen-variable" +Specify that the output should be a function that produces the definitions +necessary for a specific global variable to be added to a module. It is assumed +that the output will be #included into another program that has already arranged +for the correct header files to be #included. The function generated takes a +single argument of type \fIModule*\fR and returns the \fIGlobalVariable*\fR that it +added to the module. Note that only those things (types, constants, etc.) +directly needed in the definition of the global variable will be placed in the +generated function. +.Sp +The \fB\-for\fR option must be given with this option or an error will be produced. +THe value of the option must be the name of a global variable in the input +module for which code should be generated. If the named global variable does not +exist an error will be produced. +.IP "\fB\-gen\-type\fR" 4 +.IX Item "-gen-type" +Specify that the output should be a function that produces the definitions +necessary for specific type to be added to a module. It is assumed that the +otuput will be #included into another program that has already arranged for the +correct header files to be #included. The function generated take a single +argument of type \fIModule*\fR and returns the \fIType*\fR that it added to the +module. Note that the generated function will only add the necessary type +definitions to (possibly recursively) define the requested type. +.Sp +The \fB\-for\fR option must be given with this option or an error will be produced. +The value of the option must be the name of a global type in the input module +for which code should be generated. If the named type does not exist an error +will be produced. +.IP "\fB\-stats\fR" 4 +.IX Item "-stats" +Show pass statistics (not interesting in this program). +.IP "\fB\-time\-passes\fR" 4 +.IX Item "-time-passes" +Show pass timing statistics (not interesting in this program). +.IP "\fB\-version\fR" 4 +.IX Item "-version" +Show the version number of this program. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm2cpp\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-as tblgen +.SH "AUTHORS" +.IX Header "AUTHORS" +Written by Reid Spencer (). diff --git a/docs/CommandGuide/man/man1/llvmc.1 b/docs/CommandGuide/man/man1/llvmc.1 new file mode 100644 index 000000000000..9506c5e495c2 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvmc.1 @@ -0,0 +1,455 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVMC 1" +.TH LLVMC 1 "2007-02-11" "CVS" "LLVM Command Guide" +.SH "NAME" +llvmc \- The LLVM Compiler Driver (experimental) +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvmc\fR [\fIoptions\fR] [\fIfilenames\fR...] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBllvmc\fR is a configurable driver for invoking other \s-1LLVM\s0 (and non\-LLVM) tools +in order to compile, optimize and link software for multiple languages. For +those familiar with \s-1FSF\s0's \fBgcc\fR tool, it is very similar. Please note that +\&\fBllvmc\fR is considered an experimental tool. \fBllvmc\fR has the following goals: +.IP "* provide a single point of access to the \s-1LLVM\s0 tool set," 4 +.IX Item "provide a single point of access to the LLVM tool set," +.PD 0 +.IP "* hide the complexities of the \s-1LLVM\s0 tools through a single interface," 4 +.IX Item "hide the complexities of the LLVM tools through a single interface," +.IP "* make integration of existing non-LLVM tools simple," 4 +.IX Item "make integration of existing non-LLVM tools simple," +.IP "* extend the capabilities of minimal front ends, and" 4 +.IX Item "extend the capabilities of minimal front ends, and" +.IP "* make the interface for compiling consistent for all languages." 4 +.IX Item "make the interface for compiling consistent for all languages." +.PD +.PP +The tool itself does nothing with a user's program. It merely invokes other +tools to get the compilation tasks done. +.PP +The options supported by \fBllvmc\fR generalize the compilation process and +provide a consistent and simple interface for multiple programming languages. +This makes it easier for developers to get their software compiled with \s-1LLVM\s0. +Without \fBllvmc\fR, developers would need to understand how to invoke the +front-end compiler, optimizer, assembler, and linker in order to compile their +programs. \fBllvmc\fR's sole mission is to trivialize that process. +.Sh "Basic Operation" +.IX Subsection "Basic Operation" +\&\fBllvmc\fR always takes the following basic actions: +.IP "* Command line options and filenames are collected." 4 +.IX Item "Command line options and filenames are collected." +The command line options provide the marching orders to \fBllvmc\fR on what actions +it should perform. This is the \fIrequest\fR the user is making of \fBllvmc\fR and it +is interpreted first. +.IP "* Configuration files are read." 4 +.IX Item "Configuration files are read." +Based on the options and the suffixes of the filenames presented, a set of +configuration files are read to configure the actions \fBllvmc\fR will take. +Configuration files are provided by either \s-1LLVM\s0 or the front end compiler tools +that \fBllvmc\fR invokes. Users generally don't need to be concerned with the +contents of the configuration files. +.IP "* Determine actions to take." 4 +.IX Item "Determine actions to take." +The tool chain needed to complete the task is determined. This is the primary +work of \fBllvmc\fR. It breaks the request specified by the command line options +into a set of basic actions to be done: +.RS 4 +.IP "* Pre\-processing: gathering/filtering compiler input (optional)." 4 +.IX Item "Pre-processing: gathering/filtering compiler input (optional)." +.PD 0 +.IP "* Translation: source language to bytecode conversion." 4 +.IX Item "Translation: source language to bytecode conversion." +.IP "* Assembly: bytecode to native code conversion." 4 +.IX Item "Assembly: bytecode to native code conversion." +.IP "* Optimization: conversion of bytecode to something that runs faster." 4 +.IX Item "Optimization: conversion of bytecode to something that runs faster." +.IP "* Linking: combining multiple bytecodes to produce executable program." 4 +.IX Item "Linking: combining multiple bytecodes to produce executable program." +.RE +.RS 4 +.RE +.IP "* Execute actions." 4 +.IX Item "Execute actions." +.PD +The actions determined previously are executed sequentially and then +\&\fBllvmc\fR terminates. +.SH "OPTIONS" +.IX Header "OPTIONS" +.Sh "Control Options" +.IX Subsection "Control Options" +Control options tell \fBllvmc\fR what to do at a high level. The +following control options are defined: +.IP "\fB\-c\fR or \fB\-\-compile\fR" 4 +.IX Item "-c or --compile" +This option specifies that the linking phase is not to be run. All +previous phases, if applicable will run. This is generally how a given +bytecode file is compiled and optimized for a source language module. +.IP "\fB\-k\fR or \fB\-\-link\fR or default" 4 +.IX Item "-k or --link or default" +This option (or the lack of any control option) specifies that all stages +of compilation, optimization, and linking should be attempted. Source files +specified on the command line will be compiled and linked with objects and +libraries also specified. +.IP "\fB\-S\fR" 4 +.IX Item "-S" +This option specifies that compilation should end in the creation of +an \s-1LLVM\s0 assembly file that can be later converted to an \s-1LLVM\s0 object +file. +.IP "\fB\-E\fR" 4 +.IX Item "-E" +This option specifies that no compilation or linking should be +performed. Only pre\-processing, if applicable to the language being +compiled, is performed. For languages that support it, this will +result in the output containing the raw input to the compiler. +.Sh "Optimization Options" +.IX Subsection "Optimization Options" +Optimization with \fBllvmc\fR is based on goals and specified with +the following \-O options. The specific details of which +optimizations run is controlled by the configuration files because +each source language will have different needs. +.IP "\fB\-O1\fR or \fB\-O0\fR (default, fast compilation)" 4 +.IX Item "-O1 or -O0 (default, fast compilation)" +Only those optimizations that will hasten the compilation (mostly by reducing +the output) are applied. In general these are extremely fast and simple +optimizations that reduce emitted code size. The goal here is not to make the +resulting program fast but to make the compilation fast. If not specified, +this is the default level of optimization. +.IP "\fB\-O2\fR (basic optimization)" 4 +.IX Item "-O2 (basic optimization)" +This level of optimization specifies a balance between generating good code +that will execute reasonably quickly and not spending too much time optimizing +the code to get there. For example, this level of optimization may include +things like global common subexpression elimination, aggressive dead code +elimination, and scalar replication. +.IP "\fB\-O3\fR (aggressive optimization)" 4 +.IX Item "-O3 (aggressive optimization)" +This level of optimization aggressively optimizes each set of files compiled +together. However, no link-time inter-procedural optimization is performed. +This level implies all the optimizations of the \fB\-O1\fR and \fB\-O2\fR optimization +levels, and should also provide loop optimizations and compile time +inter-procedural optimizations. Essentially, this level tries to do as much +as it can with the input it is given but doesn't do any link time \s-1IPO\s0. +.IP "\fB\-O4\fR (link time optimization)" 4 +.IX Item "-O4 (link time optimization)" +In addition to the previous three levels of optimization, this level of +optimization aggressively optimizes each program at link time. It employs +basic analysis and basic link-time inter-procedural optimizations, +considering the program as a whole. +.IP "\fB\-O5\fR (aggressive link time optimization)" 4 +.IX Item "-O5 (aggressive link time optimization)" +This is the same as \fB\-O4\fR except it employs aggressive analyses and +aggressive inter-procedural optimization. +.IP "\fB\-O6\fR (profile guided optimization: not implemented)" 4 +.IX Item "-O6 (profile guided optimization: not implemented)" +This is the same as \fB\-O5\fR except that it employs profile-guided +re-optimization of the program after it has executed. Note that this implies +a single level of re-optimization based on runtime profile analysis. Once +the re-optimization has completed, the profiling instrumentation is +removed and final optimizations are employed. +.IP "\fB\-O7\fR (lifelong optimization: not implemented)" 4 +.IX Item "-O7 (lifelong optimization: not implemented)" +This is the same as \fB\-O5\fR and similar to \fB\-O6\fR except that re-optimization +is performed through the life of the program. That is, each run will update +the profile by which future re-optimizations are directed. +.Sh "Input Options" +.IX Subsection "Input Options" +.IP "\fB\-l\fR \fI\s-1LIBRARY\s0\fR" 4 +.IX Item "-l LIBRARY" +This option instructs \fBllvmc\fR to locate a library named \fI\s-1LIBRARY\s0\fR and search +it for unresolved symbols when linking the program. +.IP "\fB\-L\fR \fIpath\fR" 4 +.IX Item "-L path" +This option instructs \fBllvmc\fR to add \fIpath\fR to the list of places in which +the linker will +.IP "\fB\-x\fR \fI\s-1LANGUAGE\s0\fR" 4 +.IX Item "-x LANGUAGE" +This option instructs \fBllvmc\fR to regard the following input files as +containing programs in the language \fI\s-1LANGUAGE\s0\fR. Normally, input file languages +are identified by their suffix but this option will override that default +behavior. The \fB\-x\fR option stays in effect until the end of the options or +a new \fB\-x\fR option is encountered. +.Sh "Output Options" +.IX Subsection "Output Options" +.IP "\fB\-m\fR\fIarch\fR" 4 +.IX Item "-march" +This option selects the back end code generator to use. The \fIarch\fR portion +of the option names the back end to use. +.IP "\fB\-\-native\fR" 4 +.IX Item "--native" +Normally, \fBllvmc\fR produces bytecode files at most stages of compilation. +With this option, \fBllvmc\fR will arrange for native object files to be +generated with the \fB\-c\fR option, native assembly files to be generated +with the \fB\-S\fR option, and native executables to be generated with the +\&\fB\-\-link\fR option. In the case of the \fB\-E\fR option, the output will not +differ as there is no \fInative\fR version of pre-processed output. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. The contents of the file depend on other +options. +.Sh "Information Options" +.IX Subsection "Information Options" +.IP "\fB\-n\fR or \fB\-\-no\-op\fR" 4 +.IX Item "-n or --no-op" +This option tells \fBllvmc\fR to do everything but actually execute the +resulting tools. In combination with the \fB\-v\fR option, this causes \fBllvmc\fR +to merely print out what it would have done. +.IP "\fB\-v\fR or \fB\-\-verbose\fR" 4 +.IX Item "-v or --verbose" +This option will cause \fBllvmc\fR to print out (on standard output) each of the +actions it takes to accomplish the objective. The output will immediately +precede the invocation of other tools. +.IP "\fB\-\-stats\fR" 4 +.IX Item "--stats" +Print all statistics gathered during the compilation to the standard error. +Note that this option is merely passed through to the sub-tools to do with +as they please. +.IP "\fB\-\-time\-passes\fR" 4 +.IX Item "--time-passes" +Record the amount of time needed for each optimization pass and print it +to standard error. Like \fB\-\-stats\fR this option is just passed through to +the sub-tools to do with as they please. +.IP "\fB\-\-time\-programs\fR" 4 +.IX Item "--time-programs" +Record the amount of time each program (compilation tool) takes and print +it to the standard error. +.Sh "Language Specific Options" +.IX Subsection "Language Specific Options" +.IP "\fB\-T,pre\fR=\fIoptions\fR" 4 +.IX Item "-T,pre=options" +Pass an arbitrary option to the pre\-processor. +.IP "\fB\-T,opt\fR=\fIoptions\fR" 4 +.IX Item "-T,opt=options" +Pass an arbitrary option to the optimizer. +.IP "\fB\-T,lnk\fR=\fIoptions\fR" 4 +.IX Item "-T,lnk=options" +Pass an arbitrary option to the linker. +.IP "\fB\-T,asm\fR=\fIoptions\fR" 4 +.IX Item "-T,asm=options" +Pass an arbitrary option to the code generator. +.Sh "C/\*(C+ Specific Options" +.IX Subsection "C/ Specific Options" +.IP "\fB\-I\fR\fIpath\fR" 4 +.IX Item "-Ipath" +This option is just passed through to a C or \*(C+ front end compiler to tell it +where include files can be found. +.IP "\fB\-D\fR\fIsymbol\fR" 4 +.IX Item "-Dsymbol" +This option is just passed through to a C or \*(C+ front end compiler to tell it +to define a symbol. +.Sh "Miscellaneous Options" +.IX Subsection "Miscellaneous Options" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +This option will cause \fBllvmc\fR to print out its version number and terminate. +.Sh "Advanced Options" +.IX Subsection "Advanced Options" +You better know what you're doing if you use these options. Improper use +of these options can produce drastically wrong results. +.IP "\fB\-\-config\-dir\fR \fIdirname\fR" 4 +.IX Item "--config-dir dirname" +This option tells \fBllvmc\fR to read configuration data from the \fIdirectory\fR +named \fIdirname\fR. Data from such directories will be read in the order +specified on the command line after all other standard configuration files have +been read. This allows users or groups of users to conveniently create +their own configuration directories in addition to the standard ones to which +they may not have write access. +.Sh "Unimplemented Options" +.IX Subsection "Unimplemented Options" +The options below are not currently implemented in \fBllvmc\fR but will be +eventually. They are documented here as \*(L"future design\*(R". +.IP "\fB\-\-show\-config\fR \fI[suffixes...]\fR" 4 +.IX Item "--show-config [suffixes...]" +When this option is given, the only action taken by \fBllvmc\fR is to show its +final configuration state in the form of a configuration file. No compilation +tasks will be conducted when this option is given; processing will stop once +the configuration has been printed. The optional (comma separated) list of +suffixes controls what is printed. Without any suffixes, the configuration +for all languages is printed. With suffixes, only the languages pertaining +to those file suffixes will be printed. The configuration information is +printed after all command line options and configuration files have been +read and processed. This allows the user to verify that the correct +configuration data has been read by \fBllvmc\fR. +.IP "\fB\-\-config\fR :\fIsection\fR:\fIname\fR=\fIvalue\fR" 4 +.IX Item "--config :section:name=value" +This option instructs \fBllvmc\fR to accept \fIvalue\fR as the value for configuration +item \fIname\fR in the section named \fIsection\fR. This is a quick way to override +a configuration item on the command line without resorting to changing the +configuration files. +.IP "\fB\-\-config\-only\-from\fR \fIdirname\fR" 4 +.IX Item "--config-only-from dirname" +This option tells \fBllvmc\fR to skip the normal processing of configuration +files and only configure from the contents of the \fIdirname\fR directory. Multiple +\&\fB\-\-config\-only\-from\fR options may be given in which case the directories are +read in the order given on the command line. +.IP "\fB\-\-emit\-raw\-code\fR" 4 +.IX Item "--emit-raw-code" +No optimization is done whatsoever. The compilers invoked by \fBllvmc\fR with +this option given will be instructed to produce raw, unoptimized code. This +option is useful only to front end language developers and therefore does not +participate in the list of \fB\-O\fR options. This is distinctly different from +the \fB\-O0\fR option (a synonym for \fB\-O1\fR) because those optimizations will +reduce code size to make compilation faster. With \fB\-\-emit\-raw\-code\fR, only +the full raw code produced by the compiler will be generated. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvmc\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value and no compilation actions +will be taken. If one of the compilation tools returns a non-zero +status, pending actions will be discarded and \fBllvmc\fR will return the +same result code as the failing compilation tool. +.SH "DEFICIENCIES" +.IX Header "DEFICIENCIES" +\&\fBllvmc\fR is considered an experimental \s-1LLVM\s0 tool because it has these +deficiencies: +.IP "Insufficient support for native linking" 4 +.IX Item "Insufficient support for native linking" +Because \fBllvm-ld\fR doesn't handle native linking, neither can \fBllvmc\fR +.IP "Poor configuration support" 4 +.IX Item "Poor configuration support" +The support for configuring new languages, etc. is weak. There are many +command line configurations that cannot be achieved with the current +support. Furthermore the grammar is cumbersome for configuration files. +Please see for further details. +.IP "Does not handle target specific configurations" 4 +.IX Item "Does not handle target specific configurations" +This is one of the major deficiencies, also addressed in + +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-as, llvm-dis, llc, llvm-link +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvmgcc.1 b/docs/CommandGuide/man/man1/llvmgcc.1 new file mode 100644 index 000000000000..45b23cb00ac8 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvmgcc.1 @@ -0,0 +1,194 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVMGCC 1" +.TH LLVMGCC 1 "2007-02-11" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-gcc \- LLVM C front\-end +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm-gcc\fR [\fIoptions\fR] \fIfilename\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm-gcc\fR command is the \s-1LLVM\s0 C front end. It is a modified +version of gcc that compiles C/ObjC programs into native objects, \s-1LLVM\s0 +bytecode or \s-1LLVM\s0 assembly language, depending upon the options. +.PP +By default, \fBllvm-gcc\fR compiles to native objects just like \s-1GCC\s0 does. If the +\&\fB\-emit\-llvm\fR option is given then it will generate \s-1LLVM\s0 bytecode files instead. +If \fB\-S\fR (assembly) is also given, then it will generate \s-1LLVM\s0 assembly. +.PP +Being derived from the \s-1GNU\s0 Compiler Collection, \fBllvm-gcc\fR has many +of gcc's features and accepts most of gcc's options. It handles a +number of gcc's extensions to the C programming language. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-S\fR" 4 +.IX Item "-S" +Do not generate an \s-1LLVM\s0 bytecode file. Rather, compile the source +file into an \s-1LLVM\s0 assembly language file. +.IP "\fB\-c\fR" 4 +.IX Item "-c" +Do not generate a linked executable. Rather, compile the source +file into an \s-1LLVM\s0 bytecode file. This bytecode file can then be +linked with other bytecode files later on to generate a full \s-1LLVM\s0 +executable. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file to be \fIfilename\fR. +.IP "\fB\-I\fR \fIdirectory\fR" 4 +.IX Item "-I directory" +Add a directory to the header file search path. This option can be +repeated. +.IP "\fB\-L\fR \fIdirectory\fR" 4 +.IX Item "-L directory" +Add \fIdirectory\fR to the library search path. This option can be +repeated. +.IP "\fB\-l\fR\fIname\fR" 4 +.IX Item "-lname" +Link in the library lib\fIname\fR.[bc | a | so]. This library should +be a bytecode library. +.IP "\fB\-emit\-llvm\fR" 4 +.IX Item "-emit-llvm" +Make the output be \s-1LLVM\s0 bytecode (or assembly) instead of native object (or +assembly). +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm-gcc\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm\-g++ +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/llvmgxx.1 b/docs/CommandGuide/man/man1/llvmgxx.1 new file mode 100644 index 000000000000..362ee49a73b6 --- /dev/null +++ b/docs/CommandGuide/man/man1/llvmgxx.1 @@ -0,0 +1,194 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LLVMGXX 1" +.TH LLVMGXX 1 "2007-02-11" "CVS" "LLVM Command Guide" +.SH "NAME" +llvm\-g++ \- LLVM C++ front\-end +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBllvm\-g++\fR [\fIoptions\fR] \fIfilename\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBllvm\-g++\fR command is the \s-1LLVM\s0 \*(C+ front end. It is a modified +version of g++ that compiles \*(C+/ObjC++ programs into native code, +\&\s-1LLVM\s0 bytecode or assembly language, depending upon the options. +.PP +By default, \fBllvm\-g++\fR compiles to native objects just like \s-1GCC\s0 does. If the +\&\fB\-emit\-llvm\fR option is given then it will generate \s-1LLVM\s0 bytecode files instead. +If \fB\-S\fR (assembly) is also given, then it will generate \s-1LLVM\s0 assembly. +.PP +Being derived from the \s-1GNU\s0 Compiler Collection, \fBllvm\-g++\fR has many +of g++'s features and accepts most of g++'s options. It handles a +number of g++'s extensions to the \*(C+ programming language. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-S\fR" 4 +.IX Item "-S" +Do not generate an \s-1LLVM\s0 bytecode file. Rather, compile the source +file into an \s-1LLVM\s0 assembly language file. +.IP "\fB\-c\fR" 4 +.IX Item "-c" +Do not generate a linked executable. Rather, compile the source +file into an \s-1LLVM\s0 bytecode file. This bytecode file can then be +linked with other bytecode files later on to generate a full \s-1LLVM\s0 +executable. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file to be \fIfilename\fR. +.IP "\fB\-I\fR \fIdirectory\fR" 4 +.IX Item "-I directory" +Add a directory to the header file search path. This option can be +repeated. +.IP "\fB\-L\fR \fIdirectory\fR" 4 +.IX Item "-L directory" +Add \fIdirectory\fR to the library search path. This option can be +repeated. +.IP "\fB\-l\fR\fIname\fR" 4 +.IX Item "-lname" +Link in the library lib\fIname\fR.[bc | a | so]. This library should +be a bytecode library. +.IP "\fB\-emit\-llvm\fR" 4 +.IX Item "-emit-llvm" +Make the output be \s-1LLVM\s0 bytecode (or assembly) instead of native object (or +assembly). +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBllvm\-g++\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-gcc +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/opt.1 b/docs/CommandGuide/man/man1/opt.1 new file mode 100644 index 000000000000..f080e9f8b67f --- /dev/null +++ b/docs/CommandGuide/man/man1/opt.1 @@ -0,0 +1,246 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "OPT 1" +.TH OPT 1 "2007-02-02" "CVS" "LLVM Command Guide" +.SH "NAME" +opt \- LLVM optimizer +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBopt\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBopt\fR command is the modular \s-1LLVM\s0 optimizer and analyzer. It takes \s-1LLVM\s0 +bytecode as input, runs the specified optimizations or analyses on it, and then +outputs the optimized \s-1LLVM\s0 bytecode or the analysis results. The function of +\&\fBopt\fR depends on whether the \fB\-analyze\fR option is given. +.PP +When \fB\-analyze\fR is specified, \fBopt\fR performs various analyses of \s-1LLVM\s0 +bytecode. It will usually print the results on standard output, but in a few +cases, it will print output to standard error or generate a file with the +analysis output, which is usually done when the output is meant for another +program. +.PP +While \fB\-analyze\fR is \fInot\fR given, \fBopt\fR attempts to produce an optimized +bytecode file. The optimizations available via \fBopt\fR depend upon what +libraries were linked into it as well as any additional libraries that have +been loaded with the \fB\-load\fR option. Use the \fB\-help\fR option to determine +what optimizations you can use. +.PP +If \fIfilename\fR is omitted from the command line or is \fI\-\fR, \fBopt\fR reads its +input from standard input. The input must be an \s-1LLVM\s0 bytecode file. +.PP +If an output filename is not specified with the \fB\-o\fR option, \fBopt\fR +writes its output to the standard output. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force overwrite. Normally, \fBopt\fR will refuse to overwrite an +output file that already exists. With this option, \fBopt\fR will +overwrite the output file and replace it with new bytecode. +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output filename. +.IP "\fB\-{passname}\fR" 4 +.IX Item "-{passname}" +\&\fBopt\fR provides the ability to run any of \s-1LLVM\s0's optimization or analysis passes +in any order. The \fB\-help\fR option lists all the passes available. The order in +which the options occur on the command line are the order in which they are +executed (within pass constraints). +.IP "\fB\-std\-compile\-opts\fR" 4 +.IX Item "-std-compile-opts" +This is short hand for a standard list of \fIcompile time optimization\fR passes. +This is typically used to optimize the output from the llvm-gcc front end. It +might be useful for other front end compilers as well. To discover the full set +of options available, use the following command: +.Sp +.Vb 1 +\& llvm-as < /dev/null | opt -std-compile-opts -disable-output -debug-pass=Arguments +.Ve +.IP "\fB\-disable\-inlining\fR" 4 +.IX Item "-disable-inlining" +This option is only meaningful when \fB\-std\-compile\-opts\fR is given. It simply +removes the inlining pass from the standard list. +.IP "\fB\-disable\-opt\fR" 4 +.IX Item "-disable-opt" +This option is only meaningful when \fB\-std\-compile\-opts\fR is given. It disables +most, but not all, of the \fB\-std\-compile\-opts\fR. The ones that remain are +\&\fB\-verify\fR, \fB\-lower\-setjmp\fR, and \fB\-funcresolve\fR. +.IP "\fB\-strip\-debug\fR" 4 +.IX Item "-strip-debug" +This option causes opt to strip debug information from the module before +applying other optimizations. It is essentially the same as \fB\-strip\fR but it +ensures that stripping of debug information is done first. +.IP "\fB\-verify\-each\fR" 4 +.IX Item "-verify-each" +This option causes opt to add a verify pass after every pass otherwise specified +on the command line (including \fB\-verify\fR). This is useful for cases where it +is suspected that a pass is creating an invalid module but it is not clear which +pass is doing it. The combination of \fB\-std\-compile\-opts\fR and \fB\-verify\-each\fR +can quickly track down this kind of problem. +.IP "\fB\-profile\-info\-file\fR \fIfilename\fR" 4 +.IX Item "-profile-info-file filename" +Specify the name of the file loaded by the \-profile\-loader option. +.IP "\fB\-stats\fR" 4 +.IX Item "-stats" +Print statistics. +.IP "\fB\-time\-passes\fR" 4 +.IX Item "-time-passes" +Record the amount of time needed for each pass and print it to standard +error. +.IP "\fB\-debug\fR" 4 +.IX Item "-debug" +If this is a debug build, this option will enable debug printouts +from passes which use the \fI\s-1\fIDEBUG\s0()\fI\fR macro. See the \fB\s-1LLVM\s0 Programmer's +Manual\fR, section \fI#DEBUG\fR for more information. +.IP "\fB\-load\fR=\fIplugin\fR" 4 +.IX Item "-load=plugin" +Load the dynamic object \fIplugin\fR. This object should register new optimization +or analysis passes. Once loaded, the object will add new command line options to +enable various optimizations or analyses. To see the new complete list of +optimizations, use the \fB\-help\fR and \fB\-load\fR options together. For example: +.Sp +.Vb 1 +\& opt -load=plugin.so -help +.Ve +.IP "\fB\-p\fR" 4 +.IX Item "-p" +Print module after each transformation. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBopt\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/stkrc.1 b/docs/CommandGuide/man/man1/stkrc.1 new file mode 100644 index 000000000000..46c1584d6802 --- /dev/null +++ b/docs/CommandGuide/man/man1/stkrc.1 @@ -0,0 +1,198 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "STKRC 1" +.TH STKRC 1 "2006-03-13" "CVS" "LLVM Command Guide" +.SH "NAME" +stkrc \- Stacker Compiler +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBstkrc\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBstkrc\fR command is the compiler for the Stacker language. Stacker is a +simple stack based, Forth-like language that was written as a demonstration +language for \s-1LLVM\s0. For details on the language, please see + . The \fBstkrc\fR compiler is fairly +minimal. It compiles to bytecode only and doesn't perform any optimizations. +The output of stkrc (a bytecode file) can be piped through other \s-1LLVM\s0 tools +for optimization and linking. +.PP +If \fIfilename\fR is omitted or is \f(CW\*(C`\-\*(C'\fR, then \fBstkrc\fR reads its input +from standard input. This is useful for combining the tool into a pipeline. +.PP +If an output file is not specified with the \fB\-o\fR option, then +\&\fBllvm-as\fR sends its output to a file or standard output by following +these rules: +.IP "\(bu" 4 +If the input is standard input, then the output is standard output. +.IP "\(bu" 4 +If the input is a file that ends with \f(CW\*(C`.st\*(C'\fR, then the output file is of +the same name, except that the suffix is changed to \f(CW\*(C`.bc\*(C'\fR. +.IP "\(bu" 4 +If the input is a file that does not end with the \f(CW\*(C`.st\*(C'\fR suffix, then the +output file has the same name as the input file, except that the \f(CW\*(C`.bc\*(C'\fR +suffix is appended. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-as\fR +sends its output to standard output. +.IP "\fB\-stats\fR" 4 +.IX Item "-stats" +Print statistics acquired during compilation. +.IP "\fB\-time\-passes\fR" 4 +.IX Item "-time-passes" +Record the amount of time needed for each pass and print it to standard +error. +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force the output to be written. Normally, \fBstkrc\fR won't overwrite an existing +bytecode file. This option overrides that behavior. +.IP "\fB\-s\fR \fIstacksize\fR" 4 +.IX Item "-s stacksize" +Specify the stack size for the program. The default stack size, 1024, should be +sufficient for most programs. For very large programs, especially those that +recurse a lot, you might want to provide a larger value. Each unit of this +value consumes 8 bytes of memory. +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a summary of command line options. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBstkrc\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value, usually 1. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +llvm-as, +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by the \s-1LLVM\s0 Team (). diff --git a/docs/CommandGuide/man/man1/tblgen.1 b/docs/CommandGuide/man/man1/tblgen.1 new file mode 100644 index 000000000000..021f79919af5 --- /dev/null +++ b/docs/CommandGuide/man/man1/tblgen.1 @@ -0,0 +1,215 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "TBLGEN 1" +.TH TBLGEN 1 "2006-06-02" "CVS" "LLVM Command Guide" +.SH "NAME" +tblgen \- Target Description To C++ Code Generator +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBtblgen\fR [\fIoptions\fR] [\fIfilename\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtblgen\fR translates from target description (.td) files into \*(C+ code that can +be included in the definition of an \s-1LLVM\s0 target library. Most users of \s-1LLVM\s0 will +not need to use this program. It is only for assisting with writing an \s-1LLVM\s0 +target backend. +.PP +The input and output of \fBtblgen\fR is beyond the scope of this short +introduction. Please see the \fICodeGeneration\fR page in the \s-1LLVM\s0 documentation. +.PP +The \fIfilename\fR argument specifies the name of a Target Description (.td) file +to read as input. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a summary of command line options. +.IP "\fB\-o\fR \fIfilename\fR" 4 +.IX Item "-o filename" +Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBtblgen\fR +sends its output to standard output. +.IP "\fB\-I\fR \fIdirectory\fR" 4 +.IX Item "-I directory" +Specify where to find other target description files for inclusion. The +\&\fIdirectory\fR value should be a full or partial path to a directory that contains +target description files. +.IP "\fB\-asmwriternum\fR \fIN\fR" 4 +.IX Item "-asmwriternum N" +Make \-gen\-asm\-writer emit assembly writer number \fIN\fR. +.IP "\fB\-class\fR \fIclass Name\fR" 4 +.IX Item "-class class Name" +Print the enumeration list for this class. +.IP "\fB\-print\-records\fR" 4 +.IX Item "-print-records" +Print all records to standard output (default). +.IP "\fB\-print\-enums\fR" 4 +.IX Item "-print-enums" +Print enumeration values for a class +.IP "\fB\-gen\-emitter\fR" 4 +.IX Item "-gen-emitter" +Generate machine code emitter. +.IP "\fB\-gen\-register\-enums\fR" 4 +.IX Item "-gen-register-enums" +Generate the enumeration values for all registers. +.IP "\fB\-gen\-register\-desc\fR" 4 +.IX Item "-gen-register-desc" +Generate a register info description for each register. +.IP "\fB\-gen\-register\-desc\-header\fR" 4 +.IX Item "-gen-register-desc-header" +Generate a register info description header for each register. +.IP "\fB\-gen\-instr\-enums\fR" 4 +.IX Item "-gen-instr-enums" +Generate enumeration values for instructions. +.IP "\fB\-gen\-instr\-desc\fR" 4 +.IX Item "-gen-instr-desc" +Generate instruction descriptions. +.IP "\fB\-gen\-asm\-writer\fR" 4 +.IX Item "-gen-asm-writer" +Generate the assembly writer. +.IP "\fB\-gen\-dag\-isel\fR" 4 +.IX Item "-gen-dag-isel" +Generate a \s-1DAG\s0 (Directed Acycle Graph) instruction selector. +.IP "\fB\-gen\-subtarget\fR" 4 +.IX Item "-gen-subtarget" +Generate subtarget enumerations. +.IP "\fB\-gen\-intrinsic\fR" 4 +.IX Item "-gen-intrinsic" +Generate intrinsic information. +.IP "\fB\-version\fR" 4 +.IX Item "-version" +Show the version number of this program. +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +If \fBtblgen\fR succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. +.SH "AUTHORS" +.IX Header "AUTHORS" +Maintained by The \s-1LLVM\s0 Team (). diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 0e871336deb8..b8f330df7042 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -499,8 +499,8 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

LLVM is very demanding of the host C++ compiler, and as such tends to expose bugs in the compiler. In particular, several versions of GCC crash when trying to compile LLVM. We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1 -successfully with them (however, see below). Other versions of GCC will -probably work as well. GCC versions listed +successfully with them (however, see important notes below). Other versions +of GCC will probably work as well. GCC versions listed here are known to not work. If you are using one of these versions, please try to upgrade your GCC to something more recent. If you run into a problem with a version of GCC not listed here, please let @@ -525,6 +525,13 @@ the "convert_from_eh_region_ranges_1" GCC function.

possibly others) does not compile LLVM correctly (it appears that exception handling is broken in some cases). Please download the FSF 3.3.3 or upgrade to a newer version of GCC.

+

GCC 3.4.0 on linux/x86 (32-bit): GCC miscompiles portions of the + code generator, causing an infinite loop in the llvm-gcc build when built + with optimizations enabled (i.e. a release build).

+

GCC 3.4.2 on linux/x86 (32-bit): GCC miscompiles portions of the + code generator at -O3, as with 3.4.0. However gcc 3.4.2 (unlike 3.4.0) + correctly compiles LLVM at -O2. A work around is to build release LLVM + builds with "make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ..."

GCC 3.4.x on X86-64/amd64: GCC miscompiles portions of LLVM.

IA-64 GCC 4.0.0: The IA-64 version of GCC 4.0.0 is known to diff --git a/docs/LangRef.html b/docs/LangRef.html index 58e0e3c5f39f..40a344a68ae2 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -908,9 +908,6 @@ system. The current set of primitive types is as follows:

TypeDescription voidNo value - i88-bit value - i3232-bit value - float32-bit floating point value labelBranch destination @@ -919,9 +916,7 @@ system. The current set of primitive types is as follows:

- - - +
TypeDescription
i1True or False value
i1616-bit value
i6464-bit value
float32-bit floating point value
double64-bit floating point value
@@ -942,7 +937,7 @@ classifications:

ClassificationTypes integer - i1, i8, i16, i32, i64 + i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... floating point @@ -950,7 +945,7 @@ classifications:

first class - i1, i8, i16, i32, i64, float, double,
+ i1, ..., float, double,
pointer,vector @@ -976,6 +971,51 @@ recursive: For example, it is possible to have a two dimensional array.

+ +
Integer Type
+ +
+ +
Overview:
+

The integer type is a very simple derived type that simply specifies an +arbitrary bit width for the integer type desired. Any bit width from 1 bit to +2^23-1 (about 8 million) can be specified.

+ +
Syntax:
+ +
+  iN
+
+ +

The number of bits the integer will occupy is specified by the N +value.

+ +
Examples:
+ + + + + +
+ i1
+ i4
+ i8
+ i16
+ i32
+ i42
+ i64
+ i1942652
+ 		+ A boolean integer of 1 bit
+ A nibble sized integer of 4 bits.
+ A byte sized integer of 8 bits.
+ A half word sized integer of 16 bits.
+ A word sized integer of 32 bits.
+ An integer whose bit width is the answer.
+ A double word sized integer of 64 bits.
+ A really big integer of over 1 million bits.
+
+
Array Type
diff --git a/docs/ReleaseNotes.html b/docs/ReleaseNotes.html index 279a17906ce6..c3449e51e96b 100644 --- a/docs/ReleaseNotes.html +++ b/docs/ReleaseNotes.html @@ -4,11 +4,11 @@ - LLVM 1.9 Release Notes + LLVM 2.0 Release Notes -
LLVM 1.9 Release Notes
+
LLVM 2.0 Release Notes
  1. Introduction
    2. @@ -32,13 +32,10 @@

    This document contains the release notes for the LLVM compiler -infrastructure, release 1.9. Here we describe the status of LLVM, including any -known problems and major improvements from the previous release. The most -up-to-date version of this document (corresponding to LLVM CVS) can be found -on the LLVM releases web site. If you are -not reading this on the LLVM web pages, you should probably go there because -this document may be updated after the release.

    +infrastructure, release 2.0. Here we describe the status of LLVM, including +major improvements from the previous release and any known problems. All LLVM +releases may be downloaded from the LLVM +releases web site.

    For more information about LLVM, including information about the latest release, please check out the main LLVM @@ -61,67 +58,175 @@ href="http://llvm.org/releases/">releases page.

    -

    This is the tenth public release of the LLVM Compiler Infrastructure. This -release incorporates a large number of enhancements, new features, and bug -fixes. We recommend that all users of previous LLVM versions upgrade. -

    +

    This is the eleventh public release of the LLVM Compiler Infrastructure. +Being the first major release since 1.0, this release is different in several +ways from our previous releases:

    + +
      +
    1. We took this as an opportunity to +break backwards compatibility with the LLVM 1.x bytecode and .ll file format. +If you have LLVM 1.9 .ll files that you would like to upgrade to LLVM 2.x, we +recommend the use of the stand alone llvm-upgrade +tool (which is included with 2.0). We intend to keep compatibility with .ll +and .bc formats within the 2.x release series, like we did within the 1.x +series.
      2. +
    2. There are several significant change to the LLVM IR and internal APIs, such + as a major overhaul of the type system, the completely new bitcode file + format, etc (described below).
      3. +
    3. We designed the release around a 6 month release cycle instead of the usual + 3-month cycle. This gave us extra time to develop and test some of the + more invasive features in this release.
      4. +
    4. LLVM 2.0 no longer supports the llvm-gcc3 front-end. Users are required to + upgrade to llvm-gcc4. llvm-gcc4 includes many features over + llvm-gcc3, is faster, and is much easier to + build from source.
      5. +
    + +

    Note that while this is a major version bump, this release has been + extensively tested on a wide range of software. It is easy to say that this + is our best release yet, in terms of both features and correctness. This is + the first LLVM release to correctly compile and optimize major software like + LLVM itself, Mozilla/Seamonkey, Qt 4.3rc1, kOffice, etc out of the box on + linux/x86. +

    -New Features in LLVM 1.9 +New Features in LLVM 2.0
    -
    New X86-64 Backend
    +
    Major Changes
    -

    LLVM 1.9 now fully supports the x86-64 instruction set on Mac OS/X, and -supports it on Linux (and other operating systems) when compiling in -static -mode. LLVM includes JIT support for X86-64, and supports both Intel EMT-64T -and AMD-64 architectures. The X86-64 instruction set permits addressing a -64-bit addressing space and provides the compiler with twice the -number of integer registers to use.

    -
    - -
    Link-Time Optimization integration -with native linkers
    -
    -

    LLVM now includes liblto which can -be used to integrate LLVM Link-Time Optimization support into a native linker. -This allows LLVM .bc to transparently participate with linking an application, -even when some .o files are in LLVM form and some are not.

    +

    Changes to the LLVM IR itself:

    + +
      + +
    • Integer types are now completely signless. This means that we + have types like i8/i16/i32 instead of ubyte/sbyte/short/ushort/int + etc. LLVM operations that depend on sign have been split up into + separate instructions (PR950). This + eliminates cast instructions that just change the sign of the operands (e.g. + int -> uint), which reduces the size of the IR and makes optimizers + simpler to write.
      • + +
    • Integer types with arbitrary bitwidths (e.g. i13, i36, i42, i1057, etc) are + now supported in the LLVM IR and optimizations (PR1043). However, neither llvm-gcc + (PR1284) nor the native code generators + (PR1270) support non-standard width + integers yet.
      • + +
    • 'Type planes' have been removed (PR411). + It is no longer possible to have two values with the same name in the + same symbol table. This simplifies LLVM internals, allowing significant + speedups.
      • + +
    • Global variables and functions in .ll files are now prefixed with + @ instead of % (PR645).
      • + +
    • The LLVM 1.x "bytecode" format has been replaced with a + completely new binary representation, named 'bitcode'. The Bitcode Format brings a + number of advantages to the LLVM over the old bytecode format: it is denser + (files are smaller), more extensible, requires less memory to read, + is easier to keep backwards compatible (so LLVM 2.5 will read 2.0 .bc + files), and has many other nice features.
      • + +
    • Load and store instructions now track the alignment of their pointer + (PR400). This allows the IR to + express loads that are not sufficiently aligned (e.g. due to '#pragma + packed') or to capture extra alignment information.
      • +
    + +

    Major new features:

    + +
      + +
    • A number of ELF features are now supported by LLVM, including 'visibility', + extern weak linkage, Thread Local Storage (TLS) with the __thread + keyword, and symbol aliases. + Among other things, this means that many of the special options needed to + configure llvm-gcc on linux are no longer needed, and special hacks to build + large C++ libraries like Qt are not needed.
      • + +
    • LLVM now has a new MSIL backend. llc -march=msil will now turn LLVM + into MSIL (".net") bytecode. This is still fairly early development + with a number of limitations.
      • + +
    • A new llvm-upgrade tool + exists to migrates LLVM 1.9 .ll files to LLVM 2.0 syntax.
      • +
    +
    + -
    DWARF debugging -support for Linux, Cygwin and MinGW on X86
    +
    llvm-gcc +Improvements
    -

    llvm-gcc4 now supports generating debugging info for Linux, Cygwin and MinGW. -This extends the PPC/Darwin and X86/Darwin debugging support available in the -1.8 release. DWARF is a standard debugging format used on many platforms.

    +

    New features include: +

    + +
      +
    • Precompiled Headers (PCH) are now supported.
      • + +
    • "#pragma packed" is now supported, as are the various features + described above (visibility, extern weak linkage, __thread, aliases, + etc).
      • + +
    • Tracking function parameter/result attributes is now possible.
      • + +
    • Many internal enhancements have been added, such as improvements to + NON_LVALUE_EXPR, arrays with non-zero base, structs with variable sized + fields, VIEW_CONVERT_EXPR, CEIL_DIV_EXPR, nested functions, and many other + things. This is primarily to supports non-C GCC front-ends, like Ada.
      • + +
    • It is simpler to configure llvm-gcc for linux.
      • + +
    +
    Optimizer Improvements
    +
    -

    The mid-level optimizer is now faster and produces better code in many cases. - Significant changes include:

    +

    New features include: +

      -
    • LLVM includes a new 'predicate simplifier' pass, which - currently performs dominator tree-based optimizations.
      • -
    • The complete loop unroll pass now supports unrolling of - multiple basic block loops.
      • -
    • The 'globalopt' pass can now perform the scalar replacement of - aggregates transformation on some heap allocations.
      • -
    • The globalsmodref-aa alias analysis can now track 'indirect pointer - globals' more accurately.
      • -
    • The instruction combiner can now perform element propagation -analysis of vector expressions, eliminating computation of vector elements -that are not used.
      • +
    • The pass manager has been entirely + rewritten, making it significantly smaller, simpler, and more extensible. + Support has been added to run FunctionPasses interlaced with + CallGraphSCCPasses, we now support loop transformations + explicitly with LoopPass, and ModulePasses may now use the + result of FunctionPasses.
      • + +
    • LLVM 2.0 includes a new loop rotation pass, which converts "for loops" into + "do/while loops", where the condition is at the bottom of the loop.
      • + +
    • The Loop Strength Reduction pass has been improved, and we now support + sinking expressions across blocks to reduce register pressure.
      • + +
    • The -scalarrepl pass can now promote unions containing FP values + into a register, it can also handle unions of vectors of the same + size.
      • + +
    • The [Post]DominatorSet classes have been removed from LLVM and clients + switched to use the more-efficient ETForest class instead.
      • + +
    • The ImmediateDominator class has also been removed, and clients have been + switched to use DominatorTree instead.
      • + +
    • The predicate simplifier pass has been improved, making it able to do + simple value range propagation and eliminate more conditionals. However, + note that predsimplify is not enabled by default in llvm-gcc.
      • +
    @@ -132,96 +237,233 @@ Generator Enhancements

    -The LLVM Target-Independent code generator now supports more target features and -optimizes many cases more aggressively. New features include: +New features include:

      -
    • LLVM now includes a late branch folding pass which optimizes code - layout, performs several branch optzns, and deletes unreachable code.
      • -
    • The code generator now support targets that have pre/post-increment - addressing modes.
      • -
    • LLVM now supports dynamically-loadable register allocators and - schedulers.
      • -
    • LLVM 1.9 includes several improvements to inline asm support, - including support for new constraints and modifiers.
      • -
    • The register coalescer is now more aggressive than before, - allowing it to eliminate more copies.
      • + +
    • LLVM now supports software floating point, which allows LLVM to target + chips that don't have hardware FPUs (e.g. ARM thumb mode).
      • + +
    • A new register scavenger has been implemented, which is useful for + finding free registers after register allocation. This is useful when + rewriting frame references on RISC targets, for example.
      • + +
    • Heuristics have been added to avoid coalescing vregs with very large live + ranges to physregs. This was bad because it effectively pinned the physical + register for the entire lifetime of the virtual register (PR711).
      • + +
    • Support now exists for very simple (but still very useful) + rematerialization the register allocator, enough to move + instructions like "load immediate" and constant pool loads.
      • + +
    • Switch statement lowering is significantly better, improving codegen for + sparse switches that have dense subregions, and implemented support + for the shift/and trick.
      • + +
    • LLVM now supports tracking physreg sub-registers and super-registers + in the code generator, and includes extensive register + allocator changes to track them.
      • + +
    • There is initial support for virtreg sub-registers + (PR1350).
      • + +
    + +

    +Other improvements include: +

    + +
      + +
    • Inline assembly support is much more solid that before. + The two primary features still missing are support for 80-bit floating point + stack registers on X86 (PR879), and + support for inline asm in the C backend (PR802).
      • + +
    • DWARF debug information generation has been improved. LLVM now passes + most of the GDB testsuite on MacOS and debug info is more dense.
      • + +
    • Codegen support for Zero-cost DWARF exception handling has been added (PR592). It is mostly + complete and just in need of continued bug fixes and optimizations at + this point. However, support in llvm-g++ is disabled with an + #ifdef for the 2.0 release (PR870).
      • + +
    • The code generator now has more accurate and general hooks for + describing addressing modes ("isLegalAddressingMode") to + optimizations like loop strength reduction and code sinking.
      • + +
    • Progress has been made on a direct Mach-o .o file writer. Many small + apps work, but it is still not quite complete.
      • +

    In addition, the LLVM target description format has itself been extended in several ways:

      -
    • tblgen now allows definition of 'multiclasses' which can be - used to factor instruction patterns more aggressively in .td files.
      • -
    • LLVM has a new TargetAsmInfo class which captures a variety of - information about the target assembly language format.
      • -
    • .td files now support "${:foo}" syntax for encoding - subtarget-specific assembler syntax into instruction descriptions.
      • +
    • TargetData now supports better target parameterization in + the .ll/.bc files, eliminating the 'pointersize/endianness' attributes + in the files (PR761).
      • + +
    • TargetData was generalized for finer grained alignment handling, + handling of vector alignment, and handling of preferred alignment
      • + +
    • LLVM now supports describing target calling conventions + explicitly in .td files, reducing the amount of C++ code that needs + to be written for a port.
      • +
    -

    Further, several significant target-specific enhancements are included in -LLVM 1.9:

    +
    + + +
    Target-Specific +Improvements
    + +
    + +

    X86-specific Code Generator Enhancements: +

      -
    • The LLVM ARM backend now supports more instructions - and the use of a frame pointer. It is now possible to build - libgcc and a simple cross compiler, but it is not considered "complete" yet. -
      • -
    • LLVM supports the Win32 dllimport/dllexport linkage and - stdcall/fastcall calling conventions.
      • +
    • The MMX instruction set is now supported through intrinsics.
      • +
    • The scheduler was improved to better reduce register pressure on + X86 and other targets that are register pressure sensitive.
      • +
    • Linux/x86-64 support is much better.
      • +
    • PIC support for linux/x86 has been added.
      • +
    • The X86 backend now supports the GCC regparm attribute.
      • +
    • LLVM now supports inline asm with multiple constraint letters per operand + (like "mri") which is common in X86 inline asms.
      • +
    + +

    ARM-specific Code Generator Enhancements:

    + +
      +
    • The ARM code generator is now stable and fully supported.
      • + +
    • There are major new features, including support for ARM + v4-v6 chips, vfp support, soft float point support, pre/postinc support, + load/store multiple generation, constant pool entry motion (to support + large functions), inline asm support, weak linkage support, static + ctor/dtor support and many bug fixes.
      • + +
    • Added support for Thumb code generation (llc -march=thumb).
      • + +
    • The ARM backend now supports the ARM AAPCS/EABI ABI and PIC codegen on + arm/linux.
      • + +
    • Several bugs were fixed for DWARF debug info generation on arm/linux.
      • + +
    + +

    PowerPC-specific Code Generator Enhancements:

    + +
      +
    • The PowerPC 64 JIT now supports addressing code loaded above the 2G + boundary.
      • + +
    • Improved support for the Linux/ppc ABI and the linux/ppc JIT is fully + functional now. llvm-gcc and static compilation are not fully supported + yet though.
      • + +
    • Many PowerPC 64 bug fixes.
      • +
    +
    Other Improvements
    -

    This release includes many other improvements, including improvements to - the optimizers and code generators (improving the generated code) changes to - speed up the compiler in many ways (improving algorithms and fine tuning - code), and changes to reduce the code size of the compiler itself.

    More specific changes include:

      -
    • The llvm-test framework now supports SPEC2006.
      • -
    • LLVM now includes a FAQ about the -getelementptr instruction.
      • -
    • Bugpoint now supports a new "-find-bugs" mode. This mode makes - bugpoint permute pass sequences to try to expose bugs due to pass - sequencing.
      • -
    • The JIT now supports lazily streaming code from multiple modules at a - time, implicitly linking the code as it goes.
      • -
    -
    +
  2. LLVM no longer relies on static destructors to shut itself down. Instead, + it lazily initializes itself and shuts down when llvm_shutdown() is + explicitly called.
    3. - -
    -Significant API Changes in LLVM 1.9 +
  3. LLVM now has significantly fewer static constructors, reducing startup time. +
    4. + +
  4. Several classes have been refactored to reduce the amount of code that + gets linked into apps that use the JIT.
    5. + +
  5. Construction of intrinsic function declarations has been simplified.
    6. + +
  6. The gccas/gccld tools have been replaced with small shell scripts.
    7. + +
  7. Support has been added to llvm-test for running on low-memory + or slow machines (make SMALL_PROBLEM_SIZE=1).
    8. + +
    + +
    API Changes
    -

    Several significant API changes have been made. If you are maintaining -out-of-tree code, please be aware that:

    +

    LLVM 2.0 contains a revamp of the type system and several other significant +internal changes. If you are programming to the C++ API, be aware of the +following major changes:

      -
    • The ConstantSInt and ConstantUInt classes have been merged into the - ConstantInt class.
      • -

    • As a step towards making LLVM's integer types signless, several new -instructions have been added to LLVM. The Div instruction is now -UDiv, SDiv, and FDiv. The Rem instruction -is now URem, SRem and FRem. See the -Language Reference for details on these new -instructions.

      -

    • ConstantBool::True and ConstantBool::False have been - renamed to ConstantBool::getTrue() and - ConstantBool::getFalse().

      • -
    • The 'analyze' tool has been merged into the 'opt' tool.
      • +
    • Pass registration is slightly different in LLVM 2.0 (you now need an + intptr_t in your constructor), as explained in the Writing an LLVM Pass + document.
      • + +
    • ConstantBool, ConstantIntegral and ConstantInt + classes have been merged together, we now just have + ConstantInt.
      • + +
    • Type::IntTy, Type::UIntTy, Type::SByteTy, ... are + replaced by Type::Int8Ty, Type::Int16Ty, etc. LLVM types + have always corresponded to fixed size types + (e.g. long was always 64-bits), but the type system no longer includes + information about the sign of the type. Also, the + Type::isPrimitiveType() method now returns false for integers.
      • + +
    • Several classes (CallInst, GetElementPtrInst, + ConstantArray, etc), that once took std::vector as + arguments now take ranges instead. For example, you can create a + GetElementPtrInst with code like: + + 
      +      Value *Ops[] = { Op1, Op2, Op3 };
+      GEP = new GetElementPtrInst(BasePtr, Ops, 3);
+
      + + This avoids creation of a temporary vector (and a call to malloc/free). If + you have an std::vector, use code like this: + 
      +      std::vector<Value*> Ops = ...;
+      GEP = new GetElementPtrInst(BasePtr, &Ops[0], Ops.size());
+
      + +
      • + +
    • CastInst is now abstract and its functionality is split into + several parts, one for each of the new + cast instructions.
      • +
    • Instruction::getNext()/getPrev() are now private (along with + BasicBlock::getNext, etc), for efficiency reasons (they are now no + longer just simple pointers). Please use BasicBlock::iterator, etc + instead. +
      • + +
    • Module::getNamedFunction() is now called + Module::getFunction().
      • + +
    • SymbolTable.h has been split into ValueSymbolTable.h and +TypeSymbolTable.h.
    @@ -237,14 +479,14 @@ instructions.

    LLVM is known to work on the following platforms:

      -
    • Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD +
    • Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD (and probably other unix-like systems).
      • +
    • PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and + 64-bit modes.
    • Intel and AMD machines running on Win32 using MinGW libraries (native)
      • -
    • Sun UltraSPARC workstations running Solaris 8.
    • Intel and AMD machines running on Win32 with the Cygwin libraries (limited support is available for native builds with Visual C++).
      • -
    • PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and - 64-bit modes.
      • +
    • Sun UltraSPARC workstations running Solaris 8.
    • Alpha-based machines running Debian GNU/Linux.
    • Itanium-based machines running Linux and HP-UX.
    @@ -289,8 +531,9 @@ components, please contact us on the -filetype=asm    " (the default) is the only supported value for the -filetype llc option. @@ -307,9 +550,7 @@ components, please contact us on the inline - assembly that uses the X86 floating point stack. See the bug for details on workarounds on - Linux. + assembly that uses the X86 floating point stack.
@@ -324,52 +565,41 @@ components, please contact us on the PowerPC backend does not correctly implement ordered FP comparisons. -
  • The 64-bit PowerPC backend is not fully stable. If you desire PPC64 support, - please use mainline CVS LLVM, which has several important bug fixes.
    • +
  • The Linux PPC32/ABI support needs testing for the interpreter and static +compilation, and lacks support for debug information.
    • - Known problems with the SPARC back-end + Known problems with the ARM back-end
      -
    • The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not - support the 64-bit SPARC ABI (-m64).
      • +
    • Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6 +processors, thumb program can crash or produces wrong +results (PR1388).
      • +
    • Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested. +
      • +
    • There is a bug in QEMU-ARM (<= 0.9.0) which causes it to incorrectly execute +programs compiled with LLVM. Please use more recent versions of QEMU.
    - Known problems with the C back-end + Known problems with the SPARC back-end
      - -
    • The C back-end produces code that violates the ANSI C Type-Based Alias -Analysis rules. As such, special options may be necessary to compile the code -(for example, GCC requires the -fno-strict-aliasing option). This -problem probably cannot be fixed.
      • - -
    • Zero arg vararg functions are not -supported. This should not affect LLVM produced by the C or C++ -frontends.
      • - -
    • The C backend does not correctly implement the llvm.stacksave or -llvm.stackrestore -intrinsics. This means that some code compiled by it can run out of stack -space if they depend on these (e.g. C99 varargs).
      • - -
    • The C backend does not support inline - assembly code.
      • +
    • The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not + support the 64-bit SPARC ABI (-m64).
    @@ -415,36 +645,25 @@ programs.
  • Defining vararg functions is not supported (but calling them is ok).
    • +
  • The Itanium backend has bitrotted somewhat.
    • - Known problems with the ARM back-end + Known problems with the C back-end
    - -
    - Known problems with the LLVM Core -
    - -
    - -
      -
    • In the JIT, dlsym() on a symbol compiled by the JIT will not - work.
      • -
    -
    @@ -456,15 +675,9 @@ ready for production use.
    -

    - -

    llvm-gcc4 is far more stable and produces better code than llvm-gcc3, but -does not currently support Link-Time -Optimization or C++ Exception Handling, -which llvm-gcc3 does.

    - -

    llvm-gcc4 does not support the GCC indirect -goto extension, but llvm-gcc3 does.

    +

    llvm-gcc4 does not currently support Link-Time +Optimization on most platforms "out-of-the-box". Please inquire on the +llvmdev mailing list if you are interested.

    @@ -474,86 +687,52 @@ goto extension, but llvm-gcc3 does.

    -
      -
    • "long double" is transformed by the front-end into "double". There is no -support for floating point data types of any size other than 32 and 64 -bits.
      • +

    • "long double" is silently transformed by the front-end into "double". There +is no support for floating point data types of any size other than 32 and 64 +bits.

      • -
    • Although many GCC extensions are supported, some are not. In particular, - the following extensions are known to not be supported: -
        -
      1. Local Labels: Labels local to a block.
        2. -
      2. Nested Functions: As in Algol and Pascal, lexical scoping of functions.
        3. -
      3. Constructing Calls: Dispatching a call to another function.
        4. -
      4. Thread-Local: Per-thread variables.
        5. -
      5. Pragmas: Pragmas accepted by GCC.
        6. -
      - -

      The following GCC extensions are partially supported. An ignored - attribute means that the LLVM compiler ignores the presence of the attribute, - but the code should still work. An unsupported attribute is one which is - ignored by the LLVM compiler and will cause a different interpretation of - the program.

      +

    • llvm-gcc does not support __builtin_apply yet. + See Constructing Calls: Dispatching a call to another function.

      +
      • +

    • llvm-gcc partially supports these GCC extensions:

        -
      1. Variable Length: - Arrays whose length is computed at run time.
        - Supported, but allocated stack space is not freed until the function returns (noted above).
        2. +
      2. Nested Functions: As in Algol and Pascal, lexical scoping of functions.
        + Nested functions are supported, but llvm-gcc does not support non-local + gotos or taking the address of a nested function.
      3. Function Attributes: Declaring that functions have no side effects or that they can never return.
        - Supported: constructor, destructor, + Supported: alias, always_inline, cdecl, + constructor, destructor, deprecated, fastcall, format, - format_arg, non_null, noreturn, + format_arg, non_null, noreturn, regparm section, stdcall, unused, used, visibility, warn_unused_result, weak
        - Ignored: noinline, - always_inline, pure, const, nothrow, - malloc, no_instrument_function, cdecl
        - - Unsupported: alias, regparm, all other target specific - attributes
        4. - -
      4. Variable Attributes: - Specifying attributes of variables.
        - Supported: cleanup, common, nocommon, - deprecated, dllimport, dllexport, - section, transparent_union, unused, - used, weak
        - - Unsupported: aligned, mode, packed, - shared, tls_model, - vector_size, all target specific attributes. -
        5. - -
      5. Type Attributes: Specifying attributes of types.
        - Supported: transparent_union, unused, - deprecated, may_alias
        - - Unsupported: aligned, packed, - all target specific attributes.
        6. - -
      6. Other Builtins: - Other built-in functions.
        - We support all builtins which have a C language equivalent (e.g., - __builtin_cos), __builtin_alloca, - __builtin_types_compatible_p, __builtin_choose_expr, - __builtin_constant_p, and __builtin_expect - (currently ignored). We also support builtins for ISO C99 floating - point comparison macros (e.g., __builtin_islessequal), - __builtin_prefetch, __builtin_popcount[ll], - __builtin_clz[ll], and __builtin_ctz[ll].
        7. + Ignored: noinline, pure, const, nothrow, + malloc, no_instrument_function
      +
      • -

      The following extensions are known to be supported:

      +

    • llvm-gcc supports the vast majority of GCC extensions, including:

        +
      1. Pragmas: Pragmas accepted by GCC.
        2. +
      2. Local Labels: Labels local to a block.
        3. +
      3. Other Builtins: + Other built-in functions.
        4. +
      4. Variable Attributes: + Specifying attributes of variables.
        5. +
      5. Type Attributes: Specifying attributes of types.
        6. +
      6. Thread-Local: Per-thread variables.
        7. +
      7. Variable Length: + Arrays whose length is computed at run time.
      8. Labels as Values: Getting pointers to labels and computed gotos.
      9. Statement Exprs: Putting statements and declarations inside expressions.
      10. Typeof: typeof: referring to the type of an expression.
        11. @@ -609,20 +788,15 @@ lists, please let us know (also including whether or not they work).

        -

        For this release, the C++ front-end is considered to be fully +

        The C++ front-end is considered to be fully tested and works for a number of non-trivial programs, including LLVM -itself.

        +itself, Qt, Mozilla, etc.

        -
        - - -
        - Notes -
        - -
          -
        • llvm-gcc4 does not support C++ exception handling at all yet.
          • +
        • llvm-gcc4 only has partial support for C++ +Exception Handling, and it is not enabled by default.
          • + +
        @@ -656,11 +830,10 @@ itself.

        A wide variety of additional information is available on the LLVM web page, including documentation and publications describing algorithms and -components implemented in LLVM. The web page also contains versions of the -API documentation which is up-to-date with the CVS version of the source code. +href="http://llvm.org">LLVM web page, in particular in the documentation section. The web page also +contains versions of the API documentation which is up-to-date with the CVS +version of the source code. You can access versions of these documents specific to this release by going into the "llvm/doc/" directory in the LLVM tree.

        @@ -679,7 +852,7 @@ lists.

        Valid HTML 4.01! - The LLVM Compiler Infrastructure
        + LLVM Compiler Infrastructure
        Last modified: $Date$ diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index f65b6791d31d..925d9811a4ed 100644 --- a/docs/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html @@ -264,7 +264,7 @@ time.

              static char ID;
-     Hello() : FunctionPass((intptr_t)&ID) {}
+     Hello() : FunctionPass((intptr_t)&ID) {}

        This declares pass identifier used by LLVM to identify pass. This allows LLVM to @@ -312,7 +312,7 @@ argument "hello", and a name "Hello World Pass".

        struct Hello : public FunctionPass { static char ID; - Hello() : FunctionPass((intptr_t)&ID) {} + Hello() : FunctionPass((intptr_t)&ID) {} virtual bool runOnFunction(Function &F) { llvm::cerr << "Hello: " << F.getName() << "\n"; @@ -485,7 +485,7 @@ refering to function bodies in no predictable order, or adding and removing functions. Because nothing is known about the behavior of ModulePass subclasses, no optimization can be done for their execution. A module pass can use function level passes (e.g. dominators) using getAnalysis interface - getAnalysis(Function).

        + getAnalysis<DominatorTree>(Function).

        To write a correct ModulePass subclass, derive from ModulePass and overload the runOnModule method with the @@ -746,7 +746,7 @@ program, or false if they didn't.

        virtual bool doInitialization(Loop *, LPPassManager &LPM);
        -The doInitialization method is designed to do simple initialization +

        The doInitialization method is designed to do simple initialization type of stuff that does not depend on the functions being processed. The doInitialization method call is not scheduled to overlap with any other pass executions (thus it should be very fast). LPPassManager @@ -1159,7 +1159,7 @@ For example:

        }
    -In above example, runOnFunction for DominatorTree is called by pass manager +

    In above example, runOnFunction for DominatorTree is called by pass manager before returning a reference to the desired pass.

    @@ -1797,6 +1797,8 @@ places (for global resources). Although this is a simple extension, we simply haven't had time (or multiprocessor machines, thus a reason) to implement this. Despite that, we have kept the LLVM passes SMP ready, and you should too.

    + +
    diff --git a/include/llvm/BasicBlock.h b/include/llvm/BasicBlock.h index 56b64ed2abf7..f2722b0382e1 100644 --- a/include/llvm/BasicBlock.h +++ b/include/llvm/BasicBlock.h @@ -17,6 +17,7 @@ #include "llvm/Instruction.h" #include "llvm/SymbolTableListTraits.h" #include "llvm/ADT/ilist" +#include "llvm/Support/DataTypes.h" namespace llvm { diff --git a/include/llvm/IntrinsicsX86.td b/include/llvm/IntrinsicsX86.td index c510eef6a868..0f61e24d925f 100644 --- a/include/llvm/IntrinsicsX86.td +++ b/include/llvm/IntrinsicsX86.td @@ -702,6 +702,10 @@ let TargetPrefix = "x86" in { // All intrinsics start with "llvm.x86.". // Misc. let TargetPrefix = "x86" in { // All intrinsics start with "llvm.x86.". + def int_x86_mmx_maskmovq : GCCBuiltin<"__builtin_ia32_maskmovq">, + Intrinsic<[llvm_void_ty, llvm_v8i8_ty, llvm_v8i8_ty, llvm_ptr_ty], + [IntrWriteMem]>; + def int_x86_mmx_pmovmskb : GCCBuiltin<"__builtin_ia32_pmovmskb">, Intrinsic<[llvm_i32_ty, llvm_v8i8_ty], [IntrNoMem]>; diff --git a/include/llvm/ValueSymbolTable.h b/include/llvm/ValueSymbolTable.h index 8f007b9559c3..a695ee8a5a63 100644 --- a/include/llvm/ValueSymbolTable.h +++ b/include/llvm/ValueSymbolTable.h @@ -16,6 +16,7 @@ #include "llvm/Value.h" #include "llvm/ADT/StringMap.h" +#include "llvm/Support/DataTypes.h" namespace llvm { template diff --git a/lib/Bitcode/Reader/BitcodeReader.cpp b/lib/Bitcode/Reader/BitcodeReader.cpp index e9531f1e1d91..7408580b23cf 100644 --- a/lib/Bitcode/Reader/BitcodeReader.cpp +++ b/lib/Bitcode/Reader/BitcodeReader.cpp @@ -24,8 +24,15 @@ #include "llvm/Support/MemoryBuffer.h" using namespace llvm; -BitcodeReader::~BitcodeReader() { +void BitcodeReader::FreeState() { delete Buffer; + Buffer = 0; + std::vector().swap(TypeList); + ValueList.clear(); + std::vector().swap(ParamAttrs); + std::vector().swap(FunctionBBs); + std::vector().swap(FunctionsWithBodies); + DeferredFunctionInfo.clear(); } //===----------------------------------------------------------------------===// @@ -985,10 +992,10 @@ bool BitcodeReader::ParseModule(const std::string &ModuleID) { GlobalInits.push_back(std::make_pair(NewGV, InitID-1)); break; } - // FUNCTION: [type, callingconv, isproto, linkage, alignment, section, - // visibility] + // FUNCTION: [type, callingconv, isproto, linkage, paramattr, + // alignment, section, visibility] case bitc::MODULE_CODE_FUNCTION: { - if (Record.size() < 7) + if (Record.size() < 8) return Error("Invalid MODULE_CODE_FUNCTION record"); const Type *Ty = getTypeByID(Record[0]); if (!isa(Ty)) @@ -1004,13 +1011,17 @@ bool BitcodeReader::ParseModule(const std::string &ModuleID) { Func->setCallingConv(Record[1]); bool isProto = Record[2]; Func->setLinkage(GetDecodedLinkage(Record[3])); - Func->setAlignment((1 << Record[4]) >> 1); - if (Record[5]) { - if (Record[5]-1 >= SectionTable.size()) + + assert(Func->getFunctionType()->getParamAttrs() == + getParamAttrs(Record[4])); + + Func->setAlignment((1 << Record[5]) >> 1); + if (Record[6]) { + if (Record[6]-1 >= SectionTable.size()) return Error("Invalid section ID"); - Func->setSection(SectionTable[Record[5]-1]); + Func->setSection(SectionTable[Record[6]-1]); } - Func->setVisibility(GetDecodedVisibility(Record[6])); + Func->setVisibility(GetDecodedVisibility(Record[7])); ValueList.push_back(Func); @@ -1098,42 +1109,6 @@ bool BitcodeReader::ParseBitcode() { } -bool BitcodeReader::materializeFunction(Function *F, std::string *ErrInfo) { - // If it already is material, ignore the request. - if (!F->hasNotBeenReadFromBytecode()) return false; - - DenseMap >::iterator DFII = - DeferredFunctionInfo.find(F); - assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!"); - - // Move the bit stream to the saved position of the deferred function body and - // restore the real linkage type for the function. - Stream.JumpToBit(DFII->second.first); - F->setLinkage((GlobalValue::LinkageTypes)DFII->second.second); - DeferredFunctionInfo.erase(DFII); - - if (ParseFunctionBody(F)) { - if (ErrInfo) *ErrInfo = ErrorString; - return true; - } - - return false; -} - -Module *BitcodeReader::materializeModule(std::string *ErrInfo) { - DenseMap >::iterator I = - DeferredFunctionInfo.begin(); - while (!DeferredFunctionInfo.empty()) { - Function *F = (*I++).first; - assert(F->hasNotBeenReadFromBytecode() && - "Deserialized function found in map!"); - if (materializeFunction(F, ErrInfo)) - return 0; - } - return TheModule; -} - - /// ParseFunctionBody - Lazily parse the specified function body block. bool BitcodeReader::ParseFunctionBody(Function *F) { if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID)) @@ -1364,12 +1339,12 @@ bool BitcodeReader::ParseFunctionBody(Function *F) { } case bitc::FUNC_CODE_INST_INVOKE: { // INVOKE: [cc,fnty, op0,op1,op2, ...] - if (Record.size() < 3) return Error("Invalid INVOKE record"); - unsigned CCInfo = Record[0]; - BasicBlock *NormalBB = getBasicBlock(Record[1]); - BasicBlock *UnwindBB = getBasicBlock(Record[2]); + if (Record.size() < 4) return Error("Invalid INVOKE record"); + unsigned CCInfo = Record[1]; + BasicBlock *NormalBB = getBasicBlock(Record[2]); + BasicBlock *UnwindBB = getBasicBlock(Record[3]); - unsigned OpNum = 3; + unsigned OpNum = 4; Value *Callee; if (getValueTypePair(Record, OpNum, NextValueNo, Callee)) return Error("Invalid INVOKE record"); @@ -1383,6 +1358,8 @@ bool BitcodeReader::ParseFunctionBody(Function *F) { Record.size() < OpNum+FTy->getNumParams()) return Error("Invalid INVOKE record"); + assert(FTy->getParamAttrs() == getParamAttrs(Record[0])); + SmallVector Ops; for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) { Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i))); @@ -1484,11 +1461,12 @@ bool BitcodeReader::ParseFunctionBody(Function *F) { break; } case bitc::FUNC_CODE_INST_CALL: { // CALL: [cc, fnty, fnid, arg0, arg1...] - if (Record.size() < 1) + if (Record.size() < 2) return Error("Invalid CALL record"); - unsigned CCInfo = Record[0]; - unsigned OpNum = 1; + unsigned CCInfo = Record[1]; + + unsigned OpNum = 2; Value *Callee; if (getValueTypePair(Record, OpNum, NextValueNo, Callee)) return Error("Invalid CALL record"); @@ -1499,6 +1477,8 @@ bool BitcodeReader::ParseFunctionBody(Function *F) { if (!FTy || Record.size() < FTy->getNumParams()+OpNum) return Error("Invalid CALL record"); + assert(FTy->getParamAttrs() == getParamAttrs(Record[0])); + SmallVector Args; // Read the fixed params. for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) { @@ -1577,6 +1557,69 @@ bool BitcodeReader::ParseFunctionBody(Function *F) { return false; } +//===----------------------------------------------------------------------===// +// ModuleProvider implementation +//===----------------------------------------------------------------------===// + + +bool BitcodeReader::materializeFunction(Function *F, std::string *ErrInfo) { + // If it already is material, ignore the request. + if (!F->hasNotBeenReadFromBytecode()) return false; + + DenseMap >::iterator DFII = + DeferredFunctionInfo.find(F); + assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!"); + + // Move the bit stream to the saved position of the deferred function body and + // restore the real linkage type for the function. + Stream.JumpToBit(DFII->second.first); + F->setLinkage((GlobalValue::LinkageTypes)DFII->second.second); + + if (ParseFunctionBody(F)) { + if (ErrInfo) *ErrInfo = ErrorString; + return true; + } + + return false; +} + +void BitcodeReader::dematerializeFunction(Function *F) { + // If this function isn't materialized, or if it is a proto, this is a noop. + if (F->hasNotBeenReadFromBytecode() || F->isDeclaration()) + return; + + assert(DeferredFunctionInfo.count(F) && "No info to read function later?"); + + // Just forget the function body, we can remat it later. + F->deleteBody(); + F->setLinkage(GlobalValue::GhostLinkage); +} + + +Module *BitcodeReader::materializeModule(std::string *ErrInfo) { + for (DenseMap >::iterator I = + DeferredFunctionInfo.begin(), E = DeferredFunctionInfo.end(); I != E; + ++I) { + Function *F = I->first; + if (F->hasNotBeenReadFromBytecode() && + materializeFunction(F, ErrInfo)) + return 0; + } + return TheModule; +} + + +/// This method is provided by the parent ModuleProvde class and overriden +/// here. It simply releases the module from its provided and frees up our +/// state. +/// @brief Release our hold on the generated module +Module *BitcodeReader::releaseModule(std::string *ErrInfo) { + // Since we're losing control of this Module, we must hand it back complete + Module *M = ModuleProvider::releaseModule(ErrInfo); + FreeState(); + return M; +} + //===----------------------------------------------------------------------===// // External interface @@ -1606,12 +1649,18 @@ Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, std::string *ErrMsg){ R = static_cast(getBitcodeModuleProvider(Buffer, ErrMsg)); if (!R) return 0; - // Read the whole module, get a pointer to it, tell ModuleProvider not to - // delete it when its dtor is run. - Module *M = R->releaseModule(ErrMsg); - - // Don't let the BitcodeReader dtor delete 'Buffer'. + // Read in the entire module. + Module *M = R->materializeModule(ErrMsg); + + // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether + // there was an error. R->releaseMemoryBuffer(); + + // If there was no error, tell ModuleProvider not to delete it when its dtor + // is run. + if (M) + M = R->releaseModule(ErrMsg); + delete R; return M; } diff --git a/lib/Bitcode/Reader/BitcodeReader.h b/lib/Bitcode/Reader/BitcodeReader.h index b70a99c05761..2f61b06c6017 100644 --- a/lib/Bitcode/Reader/BitcodeReader.h +++ b/lib/Bitcode/Reader/BitcodeReader.h @@ -39,6 +39,10 @@ public: ++NumOperands; } + void clear() { + std::vector().swap(Uses); + } + Value *operator[](unsigned i) const { return getOperand(i); } Value *back() const { return Uses.back(); } @@ -111,8 +115,11 @@ public: BitcodeReader(MemoryBuffer *buffer) : Buffer(buffer), ErrorString(0) { HasReversedFunctionsWithBodies = false; } - ~BitcodeReader(); + ~BitcodeReader() { + FreeState(); + } + void FreeState(); /// releaseMemoryBuffer - This causes the reader to completely forget about /// the memory buffer it contains, which prevents the buffer from being @@ -123,7 +130,9 @@ public: virtual bool materializeFunction(Function *F, std::string *ErrInfo = 0); virtual Module *materializeModule(std::string *ErrInfo = 0); - + virtual void dematerializeFunction(Function *F); + virtual Module *releaseModule(std::string *ErrInfo = 0); + bool Error(const char *Str) { ErrorString = Str; return true; diff --git a/lib/Bitcode/Writer/BitcodeWriter.cpp b/lib/Bitcode/Writer/BitcodeWriter.cpp index 34c838343ef4..1ea763360782 100644 --- a/lib/Bitcode/Writer/BitcodeWriter.cpp +++ b/lib/Bitcode/Writer/BitcodeWriter.cpp @@ -386,6 +386,12 @@ static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE, Vals.push_back(F->getCallingConv()); Vals.push_back(F->isDeclaration()); Vals.push_back(getEncodedLinkage(F)); + + // Note: we emit the param attr ID number for the function type of this + // function. In the future, we intend for attrs to be properties of + // functions, instead of on the type. This is to support this future work. + Vals.push_back(VE.getParamAttrID(F->getFunctionType()->getParamAttrs())); + Vals.push_back(Log2_32(F->getAlignment())+1); Vals.push_back(F->hasSection() ? SectionMap[F->getSection()] : 0); Vals.push_back(getEncodedVisibility(F)); @@ -736,15 +742,21 @@ static void WriteInstruction(const Instruction &I, unsigned InstID, Vals.push_back(VE.getValueID(I.getOperand(i))); break; case Instruction::Invoke: { + const PointerType *PTy = cast(I.getOperand(0)->getType()); + const FunctionType *FTy = cast(PTy->getElementType()); Code = bitc::FUNC_CODE_INST_INVOKE; + + // Note: we emit the param attr ID number for the function type of this + // function. In the future, we intend for attrs to be properties of + // functions, instead of on the type. This is to support this future work. + Vals.push_back(VE.getParamAttrID(FTy->getParamAttrs())); + Vals.push_back(cast(I).getCallingConv()); Vals.push_back(VE.getValueID(I.getOperand(1))); // normal dest Vals.push_back(VE.getValueID(I.getOperand(2))); // unwind dest PushValueAndType(I.getOperand(0), InstID, Vals, VE); // callee // Emit value #'s for the fixed parameters. - const PointerType *PTy = cast(I.getOperand(0)->getType()); - const FunctionType *FTy = cast(PTy->getElementType()); for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) Vals.push_back(VE.getValueID(I.getOperand(i+3))); // fixed param. @@ -806,14 +818,21 @@ static void WriteInstruction(const Instruction &I, unsigned InstID, Vals.push_back(cast(I).isVolatile()); break; case Instruction::Call: { + const PointerType *PTy = cast(I.getOperand(0)->getType()); + const FunctionType *FTy = cast(PTy->getElementType()); + Code = bitc::FUNC_CODE_INST_CALL; + + // Note: we emit the param attr ID number for the function type of this + // function. In the future, we intend for attrs to be properties of + // functions, instead of on the type. This is to support this future work. + Vals.push_back(VE.getParamAttrID(FTy->getParamAttrs())); + Vals.push_back((cast(I).getCallingConv() << 1) | unsigned(cast(I).isTailCall())); PushValueAndType(I.getOperand(0), InstID, Vals, VE); // Callee // Emit value #'s for the fixed parameters. - const PointerType *PTy = cast(I.getOperand(0)->getType()); - const FunctionType *FTy = cast(PTy->getElementType()); for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) Vals.push_back(VE.getValueID(I.getOperand(i+1))); // fixed param. diff --git a/lib/CodeGen/SelectionDAG/DAGCombiner.cpp b/lib/CodeGen/SelectionDAG/DAGCombiner.cpp index 290d621cf0ed..744a474ba4e9 100644 --- a/lib/CodeGen/SelectionDAG/DAGCombiner.cpp +++ b/lib/CodeGen/SelectionDAG/DAGCombiner.cpp @@ -3422,8 +3422,8 @@ SDOperand DAGCombiner::visitSTORE(SDNode *N) { SDOperand Ptr = ST->getBasePtr(); // If this is a store of a bit convert, store the input value if the - // resultant store does not need a higher alignment than the original. - if (Value.getOpcode() == ISD::BIT_CONVERT) { + // resultant store does not need a higher alignment than the original. + if (Value.getOpcode() == ISD::BIT_CONVERT && !ST->isTruncatingStore()) { unsigned Align = ST->getAlignment(); MVT::ValueType SVT = Value.getOperand(0).getValueType(); unsigned OrigAlign = TLI.getTargetMachine().getTargetData()-> diff --git a/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp b/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp index b70366357d93..19f10ebf2aff 100644 --- a/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp +++ b/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp @@ -1462,6 +1462,11 @@ bool SelectionDAGLowering::handleSmallSwitchRange(CaseRec& CR, return true; } +static inline bool areJTsAllowed(const TargetLowering &TLI) { + return (TLI.isOperationLegal(ISD::BR_JT, MVT::Other) || + TLI.isOperationLegal(ISD::BRIND, MVT::Other)); +} + /// handleJTSwitchCase - Emit jumptable for current switch case range bool SelectionDAGLowering::handleJTSwitchCase(CaseRec& CR, CaseRecVector& WorkList, @@ -1478,9 +1483,7 @@ bool SelectionDAGLowering::handleJTSwitchCase(CaseRec& CR, I!=E; ++I) TSize += I->size(); - if ((!TLI.isOperationLegal(ISD::BR_JT, MVT::Other) && - !TLI.isOperationLegal(ISD::BRIND, MVT::Other)) || - TSize <= 3) + if (!areJTsAllowed(TLI) || TSize <= 3) return false; double Density = (double)TSize / (double)((Last - First) + 1ULL); @@ -1622,8 +1625,12 @@ bool SelectionDAGLowering::handleBTSplitSwitchCase(CaseRec& CR, LSize += J->size(); RSize -= J->size(); } - // If our case is dense we *really* should handle it earlier! - assert((FMetric > 0) && "Should handle dense range earlier!"); + if (areJTsAllowed(TLI)) { + // If our case is dense we *really* should handle it earlier! + assert((FMetric > 0) && "Should handle dense range earlier!"); + } else { + Pivot = CR.Range.first + Size/2; + } CaseRange LHSR(CR.Range.first, Pivot); CaseRange RHSR(Pivot, CR.Range.second); @@ -3441,7 +3448,8 @@ void SelectionDAGLowering::visitInlineAsm(CallInst &I) { // Add information to the INLINEASM node to know about this output. unsigned ResOpType = 4/*MEM*/ | (1 << 3); - AsmNodeOperands.push_back(DAG.getConstant(ResOpType, MVT::i32)); + AsmNodeOperands.push_back(DAG.getTargetConstant(ResOpType, + TLI.getPointerTy())); AsmNodeOperands.push_back(OpInfo.CallOperand); break; } @@ -3533,7 +3541,8 @@ void SelectionDAGLowering::visitInlineAsm(CallInst &I) { // Add information to the INLINEASM node to know about this input. unsigned ResOpType = 3 /*IMM*/ | (1 << 3); - AsmNodeOperands.push_back(DAG.getConstant(ResOpType, MVT::i32)); + AsmNodeOperands.push_back(DAG.getTargetConstant(ResOpType, + TLI.getPointerTy())); AsmNodeOperands.push_back(InOperandVal); break; } else if (OpInfo.ConstraintType == TargetLowering::C_Memory) { @@ -3543,7 +3552,8 @@ void SelectionDAGLowering::visitInlineAsm(CallInst &I) { // Add information to the INLINEASM node to know about this input. unsigned ResOpType = 4/*MEM*/ | (1 << 3); - AsmNodeOperands.push_back(DAG.getConstant(ResOpType, MVT::i32)); + AsmNodeOperands.push_back(DAG.getTargetConstant(ResOpType, + TLI.getPointerTy())); AsmNodeOperands.push_back(InOperandVal); break; } diff --git a/lib/Support/APInt.cpp b/lib/Support/APInt.cpp index 4142c6ec8bc4..2a35aa057ef3 100644 --- a/lib/Support/APInt.cpp +++ b/lib/Support/APInt.cpp @@ -1199,6 +1199,12 @@ APInt APInt::shl(uint32_t shiftAmt) const { if (shiftAmt == BitWidth) return APInt(BitWidth, 0); + // If none of the bits are shifted out, the result is *this. This avoids a + // lshr by the words size in the loop below which can produce incorrect + // results. It also avoids the expensive computation below for a common case. + if (shiftAmt == 0) + return *this; + // Create some space for the result. uint64_t * val = new uint64_t[getNumWords()]; diff --git a/lib/System/Unix/MappedFile.inc b/lib/System/Unix/MappedFile.inc index 5e76e2bc26aa..91b92ece5a5a 100644 --- a/lib/System/Unix/MappedFile.inc +++ b/lib/System/Unix/MappedFile.inc @@ -78,6 +78,7 @@ void MappedFile::unmap() { if (options_ & WRITE_ACCESS) ::msync(base_, info_->Size, MS_SYNC); ::munmap(base_, info_->Size); + base_ = 0; // Mark this as non-mapped. } } diff --git a/lib/Target/CBackend/CBackend.cpp b/lib/Target/CBackend/CBackend.cpp index 02119a4ed348..91f427fa2cb5 100644 --- a/lib/Target/CBackend/CBackend.cpp +++ b/lib/Target/CBackend/CBackend.cpp @@ -1398,6 +1398,11 @@ static void generateCompilerSpecificCode(std::ostream& Out) { << "#define __ATTRIBUTE_DTOR__\n" << "#define LLVM_ASM(X)\n" << "#endif\n\n"; + + Out << "#if __GNUC__ < 4 /* Old GCC's, or compilers not GCC */ \n" + << "#define __builtin_stack_save() 0 /* not implemented */\n" + << "#define __builtin_stack_restore(X) /* noop */\n" + << "#endif\n\n"; // Output target-specific code that should be inserted into main. Out << "#define CODE_FOR_MAIN() /* Any target-specific code for main()*/\n"; diff --git a/lib/Target/PowerPC/PPCISelLowering.cpp b/lib/Target/PowerPC/PPCISelLowering.cpp index 13ab52abd4b2..818fcd5f59ad 100644 --- a/lib/Target/PowerPC/PPCISelLowering.cpp +++ b/lib/Target/PowerPC/PPCISelLowering.cpp @@ -3326,31 +3326,39 @@ isOperandValidForConstraint(SDOperand Op, char Letter, SelectionDAG &DAG) { case 'N': case 'O': case 'P': { - if (!isa(Op)) return SDOperand(0,0);// Must be an immediate. - unsigned Value = cast(Op)->getValue(); + ConstantSDNode *CST = dyn_cast(Op); + if (!CST) return SDOperand(0, 0); // Must be an immediate to match. + unsigned Value = CST->getValue(); switch (Letter) { default: assert(0 && "Unknown constraint letter!"); case 'I': // "I" is a signed 16-bit constant. - if ((short)Value == (int)Value) return Op; + if ((short)Value == (int)Value) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'J': // "J" is a constant with only the high-order 16 bits nonzero. case 'L': // "L" is a signed 16-bit constant shifted left 16 bits. - if ((short)Value == 0) return Op; + if ((short)Value == 0) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'K': // "K" is a constant with only the low-order 16 bits nonzero. - if ((Value >> 16) == 0) return Op; + if ((Value >> 16) == 0) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'M': // "M" is a constant that is greater than 31. - if (Value > 31) return Op; + if (Value > 31) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'N': // "N" is a positive constant that is an exact power of two. - if ((int)Value > 0 && isPowerOf2_32(Value)) return Op; + if ((int)Value > 0 && isPowerOf2_32(Value)) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'O': // "O" is the constant zero. - if (Value == 0) return Op; + if (Value == 0) + return DAG.getTargetConstant(Value, Op.getValueType()); break; case 'P': // "P" is a constant whose negation is a signed 16-bit constant. - if ((short)-Value == (int)-Value) return Op; + if ((short)-Value == (int)-Value) + return DAG.getTargetConstant(Value, Op.getValueType()); break; } break; diff --git a/lib/Target/PowerPC/PPCRegisterInfo.td b/lib/Target/PowerPC/PPCRegisterInfo.td index 3891755247ef..0b3b4cabde77 100644 --- a/lib/Target/PowerPC/PPCRegisterInfo.td +++ b/lib/Target/PowerPC/PPCRegisterInfo.td @@ -22,9 +22,9 @@ class GPR num, string n> : PPCReg { } // GP8 - One of the 32 64-bit general-purpose registers -class GP8 : PPCReg { - field bits<5> Num = Alias.Num; - let Aliases = [Alias]; +class GP8 : PPCReg { + field bits<5> Num = SubReg.Num; + let SubRegs = [SubReg]; } // SPR - One of the 32-bit special-purpose registers diff --git a/lib/Target/X86/X86ISelLowering.cpp b/lib/Target/X86/X86ISelLowering.cpp index da95925848f4..0616513b5ee1 100644 --- a/lib/Target/X86/X86ISelLowering.cpp +++ b/lib/Target/X86/X86ISelLowering.cpp @@ -2675,7 +2675,8 @@ X86TargetLowering::LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG) { return Op; } - if (X86::isSHUFPMask(PermMask.Val)) + if (X86::isSHUFPMask(PermMask.Val) && + MVT::getSizeInBits(VT) != 64) // Don't do this for MMX. return Op; // Handle v8i16 shuffle high / low shuffle node pair. @@ -2712,7 +2713,9 @@ X86TargetLowering::LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG) { } } - if (NumElems == 4) { + if (NumElems == 4 && + // Don't do this for MMX. + MVT::getSizeInBits(VT) != 64) { MVT::ValueType MaskVT = PermMask.getValueType(); MVT::ValueType MaskEVT = MVT::getVectorBaseType(MaskVT); SmallVector, 8> Locs; @@ -4725,18 +4728,19 @@ isOperandValidForConstraint(SDOperand Op, char Constraint, SelectionDAG &DAG) { case 'I': if (ConstantSDNode *C = dyn_cast(Op)) { if (C->getValue() <= 31) - return Op; + return DAG.getTargetConstant(C->getValue(), Op.getValueType()); } return SDOperand(0,0); case 'N': if (ConstantSDNode *C = dyn_cast(Op)) { if (C->getValue() <= 255) - return Op; + return DAG.getTargetConstant(C->getValue(), Op.getValueType()); } return SDOperand(0,0); case 'i': { // Literal immediates are always ok. - if (isa(Op)) return Op; + if (ConstantSDNode *CST = dyn_cast(Op)) + return DAG.getTargetConstant(CST->getValue(), Op.getValueType()); // If we are in non-pic codegen mode, we allow the address of a global (with // an optional displacement) to be used with 'i'. diff --git a/lib/Target/X86/X86InstrMMX.td b/lib/Target/X86/X86InstrMMX.td index 63f01bf11c34..897d8f2aab2e 100644 --- a/lib/Target/X86/X86InstrMMX.td +++ b/lib/Target/X86/X86InstrMMX.td @@ -493,7 +493,9 @@ def MMX_PMOVMSKBrr : MMXI<0xD7, MRMSrcReg, (ops GR32:$dst, VR64:$src), // Misc. def MMX_MASKMOVQ : MMXI<0xF7, MRMDestMem, (ops VR64:$src, VR64:$mask), - "maskmovq {$mask, $src|$src, $mask}", []>; + "maskmovq {$mask, $src|$src, $mask}", + [(int_x86_mmx_maskmovq VR64:$src, VR64:$mask, EDI)]>, + Imp<[EDI],[]>; //===----------------------------------------------------------------------===// // Alias Instructions diff --git a/lib/Transforms/IPO/GlobalOpt.cpp b/lib/Transforms/IPO/GlobalOpt.cpp index f5d2baa426a6..516ba4363ee5 100644 --- a/lib/Transforms/IPO/GlobalOpt.cpp +++ b/lib/Transforms/IPO/GlobalOpt.cpp @@ -623,7 +623,11 @@ static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) { Loads.push_back(LI); Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV); } else { - assert(isa(*GUI) && "Only expect load and stores!"); + // If we get here we could have stores, selects, or phi nodes whose values + // are loaded. + assert((isa(*GUI) || isa(*GUI) || + isa(*GUI)) && + "Only expect load and stores!"); } if (Changed) { diff --git a/lib/Transforms/Scalar/InstructionCombining.cpp b/lib/Transforms/Scalar/InstructionCombining.cpp index 950404a7f816..482e1722c92e 100644 --- a/lib/Transforms/Scalar/InstructionCombining.cpp +++ b/lib/Transforms/Scalar/InstructionCombining.cpp @@ -389,8 +389,7 @@ static const Type *getPromotedType(const Type *Ty) { if (const IntegerType* ITy = dyn_cast(Ty)) { if (ITy->getBitWidth() < 32) return Type::Int32Ty; - } else if (Ty == Type::FloatTy) - return Type::DoubleTy; + } return Ty; } @@ -6449,16 +6448,25 @@ Instruction *InstCombiner::commonPointerCastTransforms(CastInst &CI) { while (Offset) { if (const StructType *STy = dyn_cast(GEPIdxTy)) { const StructLayout *SL = TD->getStructLayout(STy); - unsigned Elt = SL->getElementContainingOffset(Offset); - NewIndices.push_back(ConstantInt::get(Type::Int32Ty, Elt)); + if (Offset < (int64_t)SL->getSizeInBytes()) { + unsigned Elt = SL->getElementContainingOffset(Offset); + NewIndices.push_back(ConstantInt::get(Type::Int32Ty, Elt)); - Offset -= SL->getElementOffset(Elt); - GEPIdxTy = STy->getElementType(Elt); + Offset -= SL->getElementOffset(Elt); + GEPIdxTy = STy->getElementType(Elt); + } else { + // Otherwise, we can't index into this, bail out. + Offset = 0; + OrigBase = 0; + } } else if (isa(GEPIdxTy) || isa(GEPIdxTy)) { const SequentialType *STy = cast(GEPIdxTy); - uint64_t EltSize = TD->getTypeSize(STy->getElementType()); - NewIndices.push_back(ConstantInt::get(IntPtrTy, Offset/EltSize)); - Offset %= EltSize; + if (uint64_t EltSize = TD->getTypeSize(STy->getElementType())) { + NewIndices.push_back(ConstantInt::get(IntPtrTy,Offset/EltSize)); + Offset %= EltSize; + } else { + NewIndices.push_back(ConstantInt::get(IntPtrTy, 0)); + } GEPIdxTy = STy->getElementType(); } else { // Otherwise, we can't index into this, bail out. @@ -7759,6 +7767,14 @@ bool InstCombiner::transformConstExprCastCall(CallSite CS) { const FunctionType *FT = Callee->getFunctionType(); const Type *OldRetTy = Caller->getType(); + const FunctionType *ActualFT = + cast(cast(CE->getType())->getElementType()); + + // If the parameter attributes don't match up, don't do the xform. We don't + // want to lose an sret attribute or something. + if (FT->getParamAttrs() != ActualFT->getParamAttrs()) + return false; + // Check to see if we are changing the return type... if (OldRetTy != FT->getReturnType()) { if (Callee->isDeclaration() && !Caller->use_empty() && diff --git a/test/CodeGen/SPARC/2007-05-09-JumpTables.ll b/test/CodeGen/SPARC/2007-05-09-JumpTables.ll new file mode 100644 index 000000000000..a014acefa904 --- /dev/null +++ b/test/CodeGen/SPARC/2007-05-09-JumpTables.ll @@ -0,0 +1,30 @@ +; RUN: llvm-as < %s | llc -march=sparc + +; We cannot emit jump tables on Sparc, but we should correctly handle this case. + +target datalayout = "e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:32:64-f32:32:32-f64:32:64-v64:64:64-v128:128:128-a0:0:64" + +define i32 @foo(i32 %f) { +entry: + switch i32 %f, label %bb14 [ + i32 0, label %UnifiedReturnBlock + i32 1, label %bb4 + i32 2, label %bb7 + i32 3, label %bb10 + ] + +bb4: ; preds = %entry + ret i32 2 + +bb7: ; preds = %entry + ret i32 5 + +bb10: ; preds = %entry + ret i32 9 + +bb14: ; preds = %entry + ret i32 0 + +UnifiedReturnBlock: ; preds = %entry + ret i32 1 +} diff --git a/test/Feature/llvm2cpp.ll b/test/Feature/llvm2cpp.ll deleted file mode 100644 index 4cfb66d2401d..000000000000 --- a/test/Feature/llvm2cpp.ll +++ /dev/null @@ -1,795 +0,0 @@ -; RUN: llvm-as < %s | llvm-dis > %t1.ll -; RUN: llvm-as < %s | llvm2cpp -gen-program -o %t2.cpp - -f -; RUN: %link -o %t2.exe %t2.cpp -lLLVMCore -lLLVMSupport -lLLVMSystem -lstdc++ -; RUN: %t2.exe > %t2.ll -; RUN: diff %t1.ll %t2.ll - -@X = global i32 4, align 16 ; [#uses=0] - -define i32* @test1012() align 32 { - %X = alloca i32, align 4 ; [#uses=1] - %Y = alloca i32, i32 42, align 16 ; [#uses=0] - %Z = alloca i32 ; [#uses=0] - ret i32* %X -} - -define i32* @test1013() { - %X = malloc i32, align 4 ; [#uses=1] - %Y = malloc i32, i32 42, align 16 ; [#uses=0] - %Z = malloc i32 ; [#uses=0] - ret i32* %X -} - -define void @void(i32, i32) { - add i32 0, 0 ; :3 [#uses=2] - sub i32 0, 4 ; :4 [#uses=2] - br label %5 - -;