X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGoldPlugin.html;h=68c5cf19280288ced2c771185e39105d4ae58069;hb=e70c526d59e92048c89281d1b7011af0b1d9ee95;hp=a16b1101ad199a3931f4d81a887ccfece42ec63c;hpb=f3888ba23ff0e08c7091cd4a8a61a267a99eadc7;p=oota-llvm.git diff --git a/docs/GoldPlugin.html b/docs/GoldPlugin.html index a16b1101ad1..68c5cf19280 100644 --- a/docs/GoldPlugin.html +++ b/docs/GoldPlugin.html @@ -14,6 +14,7 @@
  • Usage
  • Licensing
  • @@ -26,7 +27,7 @@

    Building with link time optimization requires cooperation from the system linker. LTO support on Linux systems requires that you use the gold linker which supports -LTO via plugins. This is the same system used by the upcoming +LTO via plugins. This is the same mechanism used by the GCC LTO project.

    The LLVM gold plugin implements the @@ -40,24 +41,31 @@ The same plugin can also be used by other tools such as ar and

    How to build it
    -

    You need to build gold with plugin support and build the LLVMgold -plugin.

    +

    You need to have gold with plugin support and build the LLVMgold +plugin. Check whether you have gold running /usr/bin/ld -v. It will +report “GNU gold” or else “GNU ld” if not. If you have +gold, check for plugin support by running /usr/bin/ld -plugin. If it +complains “missing argument” then you have plugin support. If not, +such as an “unknown option” error then you will either need to +build gold or install a version with plugin support.

    @@ -126,8 +139,9 @@ void foo4(void) { --- command lines --- $ llvm-gcc -flto a.c -c -o a.o # <-- a.o is LLVM bitcode file +$ ar q a.a a.o # <-- a.a is an archive with LLVM bitcode $ llvm-gcc b.c -c -o b.o # <-- b.o is native object file -$ llvm-gcc -use-gold-plugin a.o b.o -o main # <-- link with LLVMgold plugin +$ llvm-gcc -use-gold-plugin a.a b.o -o main # <-- link with LLVMgold plugin

    Gold informs the plugin that foo3 is never referenced outside the IR, leading LLVM to delete that function. However, unlike in the @@ -135,14 +149,53 @@ $ llvm-gcc -use-gold-plugin a.o b.o -o main # <-- link with LLVMgold plugin example gold does not currently eliminate foo4.

    + +
    Quickstart for using LTO with autotooled projects
    + +
    +

    Once your system ld, ar and nm all support LLVM + bitcode, everything is in place for an easy to use LTO build of autotooled + projects:

    + +

    The environment variable settings may work for non-autotooled projects + too, but you may need to set the LD environment variable as well.

    +
    +
    Licensing
    -Gold is licensed under the GPLv3. LLVMgold uses the interface file +

    Gold is licensed under the GPLv3. LLVMgold uses the interface file plugin-api.h from gold which means that the resulting LLVMgold.so binary is also GPLv3. This can still be used to link non-GPLv3 programs just -as much as gold could without the plugin. +as much as gold could without the plugin.

    @@ -154,7 +207,7 @@ as much as gold could without the plugin. src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> Nick Lewycky
    The LLVM Compiler Infrastructure
    - Last modified: $Date: 2009-01-01 23:10:51 -0800 (Thu, 01 Jan 2009) $ + Last modified: $Date: 2010-04-16 23:58:21 -0800 (Fri, 16 Apr 2010) $