2019-10-24 07:42:47 +08:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
2009-07-01 06:56:43 +08:00
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ -->
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
2009-07-02 01:16:20 +08:00
|
|
|
<title>"compiler-rt" Runtime Library</title>
|
2009-07-01 06:56:43 +08:00
|
|
|
<link type="text/css" rel="stylesheet" href="menu.css">
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="content.css">
|
|
|
|
|
</head>
|
2009-07-03 05:34:35 +08:00
|
|
|
|
2009-07-01 06:56:43 +08:00
|
|
|
<body>
|
|
|
|
|
<!--#include virtual="menu.html.incl"-->
|
|
|
|
|
<div id="content">
|
|
|
|
|
<!--*********************************************************************-->
|
2014-02-27 22:39:48 +08:00
|
|
|
<h1>"compiler-rt" runtime libraries</h1>
|
2009-07-01 06:56:43 +08:00
|
|
|
<!--*********************************************************************-->
|
2019-10-24 07:42:47 +08:00
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<p>The compiler-rt project consists of:
|
|
|
|
|
<ul>
|
|
|
|
|
<li>
|
|
|
|
|
<p><b>builtins</b> - a simple library that provides an implementation
|
|
|
|
|
of the low-level target-specific hooks required by code generation and
|
|
|
|
|
other runtime components. For example, when compiling for a 32-bit target,
|
2009-07-01 06:56:43 +08:00
|
|
|
converting a double to a 64-bit unsigned integer is compiling into a runtime
|
2014-02-27 22:39:48 +08:00
|
|
|
call to the "__fixunsdfdi" function. The builtins library provides
|
|
|
|
|
optimized implementations of this and other low-level routines, either in
|
|
|
|
|
target-independent C form, or as a heavily-optimized assembly.</p>
|
|
|
|
|
<p>builtins provides full support for the libgcc interfaces on supported
|
|
|
|
|
targets and high performance hand tuned implementations of commonly used
|
|
|
|
|
functions like __floatundidf in assembly that are dramatically faster than
|
|
|
|
|
the libgcc implementations. It should be very easy to bring builtins to
|
|
|
|
|
support a new target by adding the new routines needed by that target.</p>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>sanitizer runtimes</b> - runtime libraries that are required to run
|
|
|
|
|
the code with sanitizer instrumentation. This includes runtimes for:
|
|
|
|
|
<ul>
|
2019-10-24 07:42:47 +08:00
|
|
|
<li><a href="https://clang.llvm.org/docs/AddressSanitizer.html">AddressSanitizer</a></li>
|
|
|
|
|
<li><a href="https://clang.llvm.org/docs/ThreadSanitizer.html">ThreadSanitizer</a></li>
|
|
|
|
|
<li><a href="https://clang.llvm.org/docs/UsersManual.html#opt-fsanitize-undefined">UndefinedBehaviorSanitizer</a></li>
|
|
|
|
|
<li><a href="https://clang.llvm.org/docs/MemorySanitizer.html">MemorySanitizer</a></li>
|
|
|
|
|
<li><a href="https://clang.llvm.org/docs/LeakSanitizer.html">LeakSanitizer</a></li>
|
|
|
|
|
<li><a href="https://clang.llvm.org/docs/DataFlowSanitizer.html">DataFlowSanitizer</a></li>
|
2014-02-27 22:39:48 +08:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>profile</b> - library which is used to collect coverage information.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>BlocksRuntime</b> - a target-independent implementation of Apple "Blocks"
|
|
|
|
|
runtime interfaces.
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</p>
|
2009-07-03 05:29:19 +08:00
|
|
|
|
2019-10-24 07:42:47 +08:00
|
|
|
<p>All of the code in the compiler-rt project is <a
|
|
|
|
|
href="https://llvm.org/docs/DeveloperPolicy.html#copyright-license-and-patents">dual licensed</a>
|
2010-11-17 05:34:56 +08:00
|
|
|
under the MIT license and the UIUC License (a BSD-like license).</p>
|
2011-12-08 02:43:12 +08:00
|
|
|
|
|
|
|
|
<!--=====================================================================-->
|
|
|
|
|
<h2 id="users">Clients</h2>
|
|
|
|
|
<!--=====================================================================-->
|
|
|
|
|
|
|
|
|
|
<p>Currently compiler-rt is primarily used by
|
2019-10-24 07:42:47 +08:00
|
|
|
the <a href="https://clang.llvm.org">Clang</a>
|
|
|
|
|
and <a href="https://llvm.org">LLVM</a> projects as the implementation for
|
2014-02-27 22:39:48 +08:00
|
|
|
the runtime compiler support libraries. For more information on using
|
|
|
|
|
compiler-rt with Clang, please see the Clang
|
2019-10-24 07:42:47 +08:00
|
|
|
<a href="https://clang.llvm.org/get_started.html">Getting Started</a>
|
2011-12-08 02:43:12 +08:00
|
|
|
page.</p>
|
2019-10-24 07:42:47 +08:00
|
|
|
|
2009-07-01 06:56:43 +08:00
|
|
|
<!--=====================================================================-->
|
2014-02-27 22:39:48 +08:00
|
|
|
<h2 id="requirements">Platform Support</h2>
|
2009-07-01 06:56:43 +08:00
|
|
|
<!--=====================================================================-->
|
|
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<p><b>builtins</b> is known to work on the following platforms:</p>
|
2009-07-01 06:56:43 +08:00
|
|
|
<ul>
|
2014-02-27 22:39:48 +08:00
|
|
|
<li>Machine Architectures: i386, X86-64, SPARC64, ARM, PowerPC, PowerPC 64.</li>
|
2022-03-22 05:05:58 +08:00
|
|
|
<li>OS: DragonFlyBSD, FreeBSD, NetBSD, OpenBSD, Linux, Darwin.</li>
|
2009-07-01 06:56:43 +08:00
|
|
|
</ul>
|
2009-08-03 09:26:42 +08:00
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<p>Most sanitizer runtimes are supported only on Linux x86-64. See tool-specific
|
2019-10-24 07:42:47 +08:00
|
|
|
pages in <a href="https://clang.llvm.org/docs/index.html">Clang docs</a> for more
|
2014-02-27 22:39:48 +08:00
|
|
|
details.</p>
|
2009-08-04 12:48:38 +08:00
|
|
|
|
2009-08-03 09:26:42 +08:00
|
|
|
<!--=====================================================================-->
|
|
|
|
|
<h2 id="dir-structure">Source Structure</h2>
|
|
|
|
|
<!--=====================================================================-->
|
|
|
|
|
|
|
|
|
|
<p>A short explanation of the directory structure of compiler-rt:</p>
|
|
|
|
|
|
|
|
|
|
<p>For testing it is possible to build a generic library and an optimized library.
|
|
|
|
|
The optimized library is formed by overlaying the optimized versions onto the generic library.
|
|
|
|
|
Of course, some architectures have additional functions,
|
|
|
|
|
so the optimized library may have functions not found in the generic version.</p>
|
|
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<ul>
|
|
|
|
|
<li> include/ contains headers that can be included in user programs (for example,
|
|
|
|
|
users may directly call certain function from sanitizer runtimes).</li>
|
|
|
|
|
<li> lib/ contains libraries implementations. </li>
|
|
|
|
|
<li> lib/builtins is a generic portable implementation of <b>builtins</b> routines.</li>
|
|
|
|
|
<li> lib/builtins/(arch) has optimized versions of some routines
|
|
|
|
|
for the supported architectures.</li>
|
|
|
|
|
<li> test/ contains test suites for compiler-rt runtimes.</li>
|
2009-08-03 09:26:42 +08:00
|
|
|
</ul>
|
2019-10-24 07:42:47 +08:00
|
|
|
|
2009-07-01 06:56:43 +08:00
|
|
|
<!--=====================================================================-->
|
|
|
|
|
<h2>Get it and get involved!</h2>
|
|
|
|
|
<!--=====================================================================-->
|
2019-10-24 07:42:47 +08:00
|
|
|
|
2019-01-30 00:37:27 +08:00
|
|
|
<p>Generally, you need to build LLVM/Clang in order to build compiler-rt. You
|
|
|
|
|
can build it either together with llvm and clang, or separately.
|
|
|
|
|
|
2022-02-10 01:08:44 +08:00
|
|
|
<p>To build it together, simply add compiler-rt to the -DLLVM_ENABLE_RUNTIMES= option to
|
2019-01-30 00:37:27 +08:00
|
|
|
cmake.
|
|
|
|
|
|
|
|
|
|
<p>To build it separately, first
|
2019-10-24 07:42:47 +08:00
|
|
|
<a href="https://llvm.org/docs/CMake.html#quick-start">build LLVM</a>
|
2014-02-27 22:39:48 +08:00
|
|
|
separately to get llvm-config binary, and then run:
|
|
|
|
|
|
2009-07-02 01:16:20 +08:00
|
|
|
<ul>
|
2019-01-30 00:37:27 +08:00
|
|
|
<li>cd llvm-project</li>
|
|
|
|
|
<li>mkdir build-compiler-rt</li>
|
|
|
|
|
<li>cd build-compiler-rt</li>
|
2014-02-27 22:39:48 +08:00
|
|
|
<li>cmake ../compiler-rt -DLLVM_CONFIG_PATH=/path/to/llvm-config</li>
|
2009-07-02 01:16:20 +08:00
|
|
|
<li>make</li>
|
2010-05-04 13:19:07 +08:00
|
|
|
</ul>
|
|
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<p>Tests for sanitizer runtimes are ported to
|
2019-10-24 07:42:47 +08:00
|
|
|
<a href="https://llvm.org/docs/CommandGuide/lit.html">llvm-lit</a> and are
|
2014-02-27 22:39:48 +08:00
|
|
|
run by <b>make check-all</b> command in LLVM/Clang/compiler-rt build tree.</p>
|
2010-05-04 13:19:07 +08:00
|
|
|
|
2014-02-27 22:39:48 +08:00
|
|
|
<p>compiler-rt libraries are installed to the system with <b>make install</b>
|
|
|
|
|
command in either LLVM/Clang/compiler-rt or standalone
|
|
|
|
|
compiler-rt build tree.</p>
|
2010-05-04 13:19:07 +08:00
|
|
|
|
2009-07-02 01:16:20 +08:00
|
|
|
<p>compiler-rt doesn't have its own mailing list, if you have questions please
|
|
|
|
|
email the <a
|
2019-10-24 07:42:47 +08:00
|
|
|
href="https://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev</a> mailing
|
2009-07-02 01:16:20 +08:00
|
|
|
list. Commits to the compiler-rt SVN module are automatically sent to the
|
2019-10-24 07:42:47 +08:00
|
|
|
<a
|
|
|
|
|
href="https://lists.llvm.org/mailman/listinfo/llvm-commits">llvm-commits</a>
|
2009-07-02 01:16:20 +08:00
|
|
|
mailing list.</p>
|
2009-07-01 06:56:43 +08:00
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
