Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / compiler-rt / 799172d60d32feb1acba1a6867f3a9c39a999e5c / . / www / index.html
blob: 5d21abf26a3b66d9babfcdc2f459a59218010aa4 [file] [log] [blame]
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ -->
4<html>
5<head>
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]7 <title>"compiler-rt" Runtime Library</title>
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]8 <link type="text/css" rel="stylesheet" href="menu.css">
9 <link type="text/css" rel="stylesheet" href="content.css">
10</head>
Chris Lattner135bcdf2009-07-02 21:34:35 +0000[diff] [blame]11
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]12<body>
13<!--#include virtual="menu.html.incl"-->
14<div id="content">
15 <!--*********************************************************************-->
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]16 <h1>"compiler-rt" runtime libraries</h1>
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]17 <!--*********************************************************************-->
18
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]19 <p>The compiler-rt project consists of:
20 <ul>
21 <li>
22 <p><b>builtins</b> - a simple library that provides an implementation
23 of the low-level target-specific hooks required by code generation and
24 other runtime components. For example, when compiling for a 32-bit target,
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]25 converting a double to a 64-bit unsigned integer is compiling into a runtime
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]26 call to the "__fixunsdfdi" function. The builtins library provides
27 optimized implementations of this and other low-level routines, either in
28 target-independent C form, or as a heavily-optimized assembly.</p>
29 <p>builtins provides full support for the libgcc interfaces on supported
30 targets and high performance hand tuned implementations of commonly used
31 functions like __floatundidf in assembly that are dramatically faster than
32 the libgcc implementations. It should be very easy to bring builtins to
33 support a new target by adding the new routines needed by that target.</p>
34 </li>
35 <li>
36 <b>sanitizer runtimes</b> - runtime libraries that are required to run
37 the code with sanitizer instrumentation. This includes runtimes for:
38 <ul>
39 <li><a href="http://clang.llvm.org/docs/AddressSanitizer.html">AddressSanitizer</a></li>
40 <li><a href="http://clang.llvm.org/docs/ThreadSanitizer.html">ThreadSanitizer</a></li>
41 <li><a href="http://clang.llvm.org/docs/UsersManual.html#opt-fsanitize-undefined">UndefinedBehaviorSanitizer</a></li>
42 <li><a href="http://clang.llvm.org/docs/MemorySanitizer.html">MemorySanitizer</a></li>
43 <li><a href="http://clang.llvm.org/docs/LeakSanitizer.html">LeakSanitizer</a></li>
44 <li><a href="http://clang.llvm.org/docs/DataFlowSanitizer.html">DataFlowSanitizer</a></li>
45 </ul>
46 </li>
47 <li>
48 <b>profile</b> - library which is used to collect coverage information.
49 </li>
50 <li>
51 <b>BlocksRuntime</b> - a target-independent implementation of Apple "Blocks"
52 runtime interfaces.
53 </li>
54 </ul>
55 </p>
Chris Lattnereb561be2009-07-02 21:29:19 +0000[diff] [blame]56
Chris Lattner4b121962010-11-16 21:34:56 +0000[diff] [blame]57 <p>All of the code in the compiler-rt project is <a
58 href="http://llvm.org/docs/DeveloperPolicy.html#license">dual licensed</a>
59 under the MIT license and the UIUC License (a BSD-like license).</p>
Daniel Dunbar0ec64ce2011-12-07 18:43:12 +0000[diff] [blame]60
61 <!--=====================================================================-->
62 <h2 id="users">Clients</h2>
63 <!--=====================================================================-->
64
65 <p>Currently compiler-rt is primarily used by
66 the <a href="http://clang.llvm.org">Clang</a>
67 and <a href="http://llvm.org">LLVM</a> projects as the implementation for
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]68 the runtime compiler support libraries. For more information on using
69 compiler-rt with Clang, please see the Clang
Daniel Dunbar0ec64ce2011-12-07 18:43:12 +0000[diff] [blame]70 <a href="http://clang.llvm.org/get_started.html">Getting Started</a>
71 page.</p>
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]72
73 <!--=====================================================================-->
Edward O'Callaghanf361ff12009-08-04 04:48:38 +0000[diff] [blame]74 <h2 id="requirements">Platform Support</h2>
75 <!--=====================================================================-->
76
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]77 <p><b>builtins</b> is known to work on the following platforms:</p>
78 <ul>
79 <li>Machine Architectures: i386, X86-64, SPARC64, ARM, PowerPC, PowerPC 64.</li>
80 <li>OS: AuroraUX, DragonFlyBSD, FreeBSD, NetBSD, Linux, Darwin.</li>
81 </ul>
Edward O'Callaghanf361ff12009-08-04 04:48:38 +0000[diff] [blame]82
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]83 <p>Most sanitizer runtimes are supported only on Linux x86-64. See tool-specific
84 pages in <a href="http://clang.llvm.org/docs/index.html">Clang docs</a> for more
85 details.</p>
Edward O'Callaghanf361ff12009-08-04 04:48:38 +0000[diff] [blame]86
87 <!--=====================================================================-->
Edward O'Callaghanf9981562009-08-03 01:26:42 +0000[diff] [blame]88 <h2 id="dir-structure">Source Structure</h2>
89 <!--=====================================================================-->
90
91 <p>A short explanation of the directory structure of compiler-rt:</p>
92
93 <p>For testing it is possible to build a generic library and an optimized library.
94 The optimized library is formed by overlaying the optimized versions onto the generic library.
95 Of course, some architectures have additional functions,
96 so the optimized library may have functions not found in the generic version.</p>
97
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]98 <ul>
99 <li> include/ contains headers that can be included in user programs (for example,
100 users may directly call certain function from sanitizer runtimes).</li>
101 <li> lib/ contains libraries implementations. </li>
102 <li> lib/builtins is a generic portable implementation of <b>builtins</b> routines.</li>
103 <li> lib/builtins/(arch) has optimized versions of some routines
104 for the supported architectures.</li>
105 <li> test/ contains test suites for compiler-rt runtimes.</li>
Edward O'Callaghanf9981562009-08-03 01:26:42 +0000[diff] [blame]106 </ul>
107
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]108 <!--=====================================================================-->
109 <h2>Get it and get involved!</h2>
110 <!--=====================================================================-->
111
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]112 <p>Generally, you need to build LLVM/Clang in order to build compiler-rt. You can
113 either follow the Clang's
114 <a href="http://clang.llvm.org/get_started.html">Getting Started</a> page, or
115 <a href="http://llvm.org/docs/CMake.html#quick-start">build LLVM</a>
116 separately to get llvm-config binary, and then run:
117
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]118 <ul>
119 <li>svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt</li>
Edward O'Callaghan2d05d962009-09-23 05:04:26 +0000[diff] [blame]120 <li>mkdir build</li>
121 <li>cd build</li>
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]122 <li>cmake ../compiler-rt -DLLVM_CONFIG_PATH=/path/to/llvm-config</li>
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]123 <li>make</li>
Chris Lattner1bb4c382010-05-04 05:19:07 +0000[diff] [blame]124 </ul>
125
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]126 <p>Tests for sanitizer runtimes are ported to
127 <a href="http://llvm.org/docs/CommandGuide/lit.html">llvm-lit</a> and are
128 run by <b>make check-all</b> command in LLVM/Clang/compiler-rt build tree.</p>
Chris Lattner1bb4c382010-05-04 05:19:07 +0000[diff] [blame]129
Stephen Hines2d1fdb22014-05-28 23:58:16 -0700[diff] [blame]130 <p>compiler-rt libraries are installed to the system with <b>make install</b>
131 command in either LLVM/Clang/compiler-rt or standalone
132 compiler-rt build tree.</p>
Chris Lattner1bb4c382010-05-04 05:19:07 +0000[diff] [blame]133
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]134 <p>compiler-rt doesn't have its own mailing list, if you have questions please
135 email the <a
Pirama Arumuga Nainar799172d2016-03-03 15:50:30 -0800[diff] [blame^]136 href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev</a> mailing
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]137 list. Commits to the compiler-rt SVN module are automatically sent to the
138 <a
Pirama Arumuga Nainar799172d2016-03-03 15:50:30 -0800[diff] [blame^]139 href="http://lists.llvm.org/mailman/listinfo/llvm-commits">llvm-commits</a>
Chris Lattnerc1346742009-07-01 17:16:20 +0000[diff] [blame]140 mailing list.</p>
Chris Lattnerff5380f2009-06-30 22:56:43 +0000[diff] [blame]141</div>
142</body>
143</html>