| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 1 | .. _index: |
| 2 | |
| 3 | lld - The LLVM Linker |
| 4 | ===================== |
| 5 | |
| 6 | lld is a new set of modular code for creating linker tools. |
| 7 | |
| 8 | * End-User Features: |
| 9 | |
| 10 | * Compatible with existing linker options |
| 11 | * Reads standard Object Files (e.g. ELF, Mach-O, PE/COFF) |
| 12 | * Writes standard Executable Files (e.g. ELF, Mach-O, PE) |
| 13 | * Fast link times |
| 14 | * Minimal memory use |
| 15 | * Remove clang's reliance on "the system linker" |
| 16 | * Uses the LLVM `"UIUC" BSD-Style license`__. |
| 17 | |
| 18 | * Applications: |
| 19 | |
| 20 | * Modular design |
| 21 | * Support cross linking |
| 22 | * Easy to add new CPU support |
| 23 | * Can be built as static tool or library |
| 24 | |
| 25 | * Design and Implementation: |
| 26 | |
| 27 | * Extensive unit tests |
| 28 | * Internal linker model can be dumped/read to textual format |
| 29 | * Internal linker model can be dumped/read to a new native format |
| 30 | * Native format designed to be fast to read and write |
| 31 | * Additional linking features can be plugged in as "passes" |
| 32 | * OS specific and CPU specific code factored out |
| 33 | |
| 34 | Why a new linker? |
| 35 | ----------------- |
| 36 | |
| 37 | The fact that clang relies on whatever linker tool you happen to have installed |
| 38 | means that clang has been very conservative adopting features which require a |
| 39 | recent linker. |
| 40 | |
| 41 | In the same way that the MC layer of LLVM has removed clang's reliance on the |
| 42 | system assembler tool, the lld project will remove clang's reliance on the |
| 43 | system linker tool. |
| 44 | |
| 45 | |
| 46 | Current Status |
| 47 | -------------- |
| 48 | |
| Ed Maste | aaa317a | 2014-12-17 19:14:57 +0000 | [diff] [blame] | 49 | lld can self host on x86-64 FreeBSD and Linux and x86 Windows. |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 50 | |
| Michael J. Spencer | 1dd2766 | 2014-03-07 01:42:19 +0000 | [diff] [blame] | 51 | All SingleSource tests in test-suite pass on x86-64 Linux. |
| Michael J. Spencer | 31dffbb | 2013-01-15 02:00:48 +0000 | [diff] [blame] | 52 | |
| Simon Atanasyan | e747a44 | 2014-09-08 14:56:20 +0000 | [diff] [blame] | 53 | All SingleSource and MultiSource tests in the LLVM test-suite |
| 54 | pass on MIPS 32-bit little-endian Linux. |
| 55 | |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 56 | Source |
| 57 | ------ |
| 58 | |
| 59 | lld is available in the LLVM SVN repository:: |
| 60 | |
| Nico Weber | 9b839f8 | 2014-12-23 18:52:41 +0000 | [diff] [blame^] | 61 | svn co http://llvm.org/svn/llvm-project/lld/trunk lld |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 62 | |
| 63 | lld is also available via the read-only git mirror:: |
| 64 | |
| 65 | git clone http://llvm.org/git/lld.git |
| 66 | |
| Nico Weber | 9b839f8 | 2014-12-23 18:52:41 +0000 | [diff] [blame^] | 67 | Put it in llvm's tools/ directory, rerun cmake, then build target lld. |
| 68 | |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 69 | Contents |
| 70 | -------- |
| 71 | |
| 72 | .. toctree:: |
| 73 | :maxdepth: 2 |
| 74 | |
| 75 | design |
| Michael J. Spencer | 365f1ec | 2012-04-25 19:34:24 +0000 | [diff] [blame] | 76 | getting_started |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 77 | development |
| Rui Ueyama | 3e37326 | 2014-03-05 22:35:32 +0000 | [diff] [blame] | 78 | windows_support |
| Michael J. Spencer | d01c8fe | 2012-04-08 02:06:04 +0000 | [diff] [blame] | 79 | open_projects |
| 80 | sphinx_intro |
| 81 | |
| 82 | Indices and tables |
| 83 | ------------------ |
| 84 | |
| 85 | * :ref:`genindex` |
| 86 | * :ref:`search` |
| 87 | |
| 88 | __ http://llvm.org/docs/DeveloperPolicy.html#license |