blob: 5c94864135e4fdd6f6244476afe2239cac921f89 [file] [log] [blame]
Michael J. Spencerd01c8fe2012-04-08 02:06:04 +00001.. _index:
2
3lld - The LLVM Linker
4=====================
5
6lld 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
34Why a new linker?
35-----------------
36
37The fact that clang relies on whatever linker tool you happen to have installed
38means that clang has been very conservative adopting features which require a
39recent linker.
40
41In the same way that the MC layer of LLVM has removed clang's reliance on the
42system assembler tool, the lld project will remove clang's reliance on the
43system linker tool.
44
45
46Current Status
47--------------
48
Michael J. Spencer1dd27662014-03-07 01:42:19 +000049lld can self host on x86-64 Linux and x86 Windows.
Michael J. Spencerd01c8fe2012-04-08 02:06:04 +000050
Michael J. Spencer1dd27662014-03-07 01:42:19 +000051All SingleSource tests in test-suite pass on x86-64 Linux.
Michael J. Spencer31dffbb2013-01-15 02:00:48 +000052
Simon Atanasyane747a442014-09-08 14:56:20 +000053All SingleSource and MultiSource tests in the LLVM test-suite
54pass on MIPS 32-bit little-endian Linux.
55
Michael J. Spencerd01c8fe2012-04-08 02:06:04 +000056Source
57------
58
59lld is available in the LLVM SVN repository::
60
61 svn co http://llvm.org/svn/llvm-project/lld/trunk
62
63lld is also available via the read-only git mirror::
64
65 git clone http://llvm.org/git/lld.git
66
67Contents
68--------
69
70.. toctree::
71 :maxdepth: 2
72
73 design
Michael J. Spencer365f1ec2012-04-25 19:34:24 +000074 getting_started
Michael J. Spencerd01c8fe2012-04-08 02:06:04 +000075 development
Rui Ueyama3e373262014-03-05 22:35:32 +000076 windows_support
Michael J. Spencerd01c8fe2012-04-08 02:06:04 +000077 open_projects
78 sphinx_intro
79
80Indices and tables
81------------------
82
83* :ref:`genindex`
84* :ref:`search`
85
86__ http://llvm.org/docs/DeveloperPolicy.html#license