Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / external / github.com / llvm / llvm-project / libcxx / 5ac35df153832d2a9ec6fdacd9a2e6f41f167a1d / . / www / index.html
blob: 2052ad64cdf803a01a94507d8974dc000e02de30 [file] [log] [blame]
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]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">
7 <title>"libc++" C++ Standard Library</title>
8 <link type="text/css" rel="stylesheet" href="menu.css">
9 <link type="text/css" rel="stylesheet" href="content.css">
10</head>
11
12<body>
13<div id="menu">
14 <div>
15 <a href="http://llvm.org/">LLVM Home</a>
16 </div>
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]18 <div class="submenu">
19 <label>libc++ Info</label>
20 <a href="/index.html">About</a>
21 </div>
22
23 <div class="submenu">
24 <label>Quick Links</label>
Chris Lattner3c9af342010-05-11 20:53:16 +0000[diff] [blame]25 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a>
26 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits</a>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]27 <a href="http://llvm.org/bugs/">Bug Reports</a>
Howard Hinnant00171852010-05-11 20:51:20 +0000[diff] [blame]28 <a href="http://llvm.org/svn/llvm-project/libcxx/trunk/">Browse SVN</a>
29 <a href="http://llvm.org/viewvc/llvm-project/libcxx/trunk/">Browse ViewVC</a>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]30 </div>
31</div>
32
33<div id="content">
34 <!--*********************************************************************-->
35 <h1>"libc++" C++ Standard Library</h1>
36 <!--*********************************************************************-->
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]37
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]38 <p>libc++ is a new implementation of the C++ standard library, targeting
Howard Hinnantd04724c2012-07-19 15:57:51 +0000[diff] [blame]39 C++11.</p>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]40
Chris Lattner7b2aacc2010-11-16 21:40:19 +0000[diff] [blame]41 <p>All of the code in libc++ is <a
42 href="http://llvm.org/docs/DeveloperPolicy.html#license">dual licensed</a>
43 under the MIT license and the UIUC License (a BSD-like license).</p>
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]44
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]45 <!--=====================================================================-->
46 <h2 id="goals">Features and Goals</h2>
47 <!--=====================================================================-->
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]48
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]49 <ul>
Howard Hinnantd04724c2012-07-19 15:57:51 +0000[diff] [blame]50 <li>Correctness as defined by the C++11 standard.</li>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]51 <li>Fast execution.</li>
52 <li>Minimal memory use.</li>
53 <li>Fast compile times.</li>
54 <li>ABI compatibility with gcc's libstdc++ for some low-level features
55 such as exception objects, rtti and memory allocation.</li>
56 <li>Extensive unit tests.</li>
57 </ul>
58
59 <!--=====================================================================-->
Marshall Clowb6a04fe2012-11-14 16:31:15 +0000[diff] [blame]60 <h2 id="why">Why a new C++ Standard Library for C++11?</h2>
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]61 <!--=====================================================================-->
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]62
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]63 <p>After its initial introduction, many people have asked "why start a new
64 library instead of contributing to an existing library?" (like Apache's
65 libstdcxx, GNU's libstdc++, STLport, etc). There are many contributing
66 reasons, but some of the major ones are:</p>
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]67
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]68 <ul>
69 <li><p>From years of experience (including having implemented the standard
70 library before), we've learned many things about implementing
71 the standard containers which require ABI breakage and fundamental changes
72 to how they are implemented. For example, it is generally accepted that
73 building std::string using the "short string optimization" instead of
74 using Copy On Write (COW) is a superior approach for multicore
Marshall Clowb6a04fe2012-11-14 16:31:15 +0000[diff] [blame]75 machines (particularly in C++11, which has rvalue references). Breaking
Chris Lattnerc67061b2010-05-12 22:30:22 +0000[diff] [blame]76 ABI compatibility with old versions of the library was
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]77 determined to be critical to achieving the performance goals of
78 libc++.</p></li>
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]79
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]80 <li><p>Mainline libstdc++ has switched to GPL3, a license which the developers
81 of libc++ cannot use. libstdc++ 4.2 (the last GPL2 version) could be
Marshall Clowb6a04fe2012-11-14 16:31:15 +0000[diff] [blame]82 independently extended to support C++11, but this would be a fork of the
Chris Lattnere7bdfe62010-05-12 22:33:00 +0000[diff] [blame]83 codebase (which is often seen as worse for a project than starting a new
84 independent one). Another problem with libstdc++ is that it is tightly
85 integrated with G++ development, tending to be tied fairly closely to the
86 matching version of G++.</p>
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]87 </li>
88
89 <li><p>STLport and the Apache libstdcxx library are two other popular
Marshall Clowb6a04fe2012-11-14 16:31:15 +0000[diff] [blame]90 candidates, but both lack C++11 support. Our experience (and the
Howard Hinnantd04724c2012-07-19 15:57:51 +0000[diff] [blame]91 experience of libstdc++ developers) is that adding support for C++11 (in
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]92 particular rvalue references and move-only types) requires changes to
93 almost every class and function, essentially amounting to a rewrite.
Chris Lattner48035ce2010-05-12 22:34:21 +0000[diff] [blame]94 Faced with a rewrite, we decided to start from scratch and evaluate every
95 design decision from first principles based on experience.</p>
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]96
Chris Lattnere2b07272010-05-12 22:21:15 +0000[diff] [blame]97 <p>Further, both projects are apparently abandoned: STLport 5.2.1 was
98 released in Oct'08, and STDCXX 4.2.1 in May'08.</p>
99
100 </ul>
101
102 <!--=====================================================================-->
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]103 <h2 id="requirements">Platform Support</h2>
104 <!--=====================================================================-->
105
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]106 <p>
107 libc++ is known to work on the following platforms, using g++-4.2 and
108 clang (lack of C++11 language support disables some functionality). Note
109 that functionality provided by &lt;atomic&gt; is only functional with
110 clang.
111 </p>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]112
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]113 <ul>
114 <li>Mac OS X i386</li>
115 <li>Mac OS X x86_64</li>
116 <li>FreeBSD 10+ i386</li>
117 <li>FreeBSD 10+ x86_64</li>
118 <li>FreeBSD 10+ ARM</li>
119 </ul>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]120
121 <!--=====================================================================-->
122 <h2 id="dir-structure">Current Status</h2>
123 <!--=====================================================================-->
124
Howard Hinnant09ce6822012-11-27 18:52:32 +0000[diff] [blame]125 <p>libc++ is a 100% complete C++11 implementation on Apple's OS X. </p>
Michael J. Spencera86f97e2012-12-31 19:34:21 +0000[diff] [blame]126 <p>LLVM and Clang can self host in C++ and C++11 mode with libc++ on Linux.</p>
Marshall Clow979d36a2014-04-03 02:38:12 +0000[diff] [blame]127 <p>libc++ is also a 100% complete C++14 implementation. A list of new features and changes for
Marshall Clow6d44d712014-04-03 02:35:29 +0000[diff] [blame]128 C++14 can be found <a href="cxx1y_status.html">here</a>.</p>
Marshall Clow5ac35df2014-11-10 15:43:20 +0000[diff] [blame^]129 <p>A list of features and changes for the next C++ standard, known here as
130 "C++1z" (probably to be C++17) can be found <a href="cxx1z_status.html">here</a>.</p>
Marshall Clowbbec82d2014-06-02 23:37:13 +0000[diff] [blame]131 <p>Implementation of the post-c++14 Technical Specifications is in progress. A list of features and
132 the current status of these features can be found <a href="ts1z_status.html">here</a>.</p>
Howard Hinnant2347d2f2011-09-28 15:44:39 +0000[diff] [blame]133 <p>
Howard Hinnante1a0abb2012-07-31 21:30:28 +0000[diff] [blame]134 Ports to other platforms are underway. Here are recent test
135 results for <a href="results.Windows.html">Windows</a>
136 and <a href="results.Linux.html">Linux</a>.
Howard Hinnant2347d2f2011-09-28 15:44:39 +0000[diff] [blame]137 </p>
138
Eric Fiselierdc770102014-08-18 05:25:04 +0000[diff] [blame]139 <!--======================================================================-->
140 <h2 id="dir-structure">Build Bots</h2>
141 <!--======================================================================-->
142 <p>These are the libc++ build bots</p>
143 <ul>
Eric Fiselierdc770102014-08-18 05:25:04 +0000[diff] [blame]144 <li><a href="http://llvm-amd64.freebsd.your.org/b/builders/libcxx-amd64-freebsd">
145 clang-libcxxrt-x86_64-freebsd10
146 </a></li>
147 <li><a href="http://llvm-amd64.freebsd.your.org/b/builders/libcxx-i386-freebsd">
148 clang-libcxxrt-i386-freebsd10
149 </a></li>
150 <li><a href="http://lab.llvm.org:8011/builders/libcxx-libcxxabi-x86_64-linux-debian">
151 clang-libcxxabi-x86_64-linux-debian
152 </a></li>
Eric Fiselier132e1a82014-10-16 03:15:31 +0000[diff] [blame]153 <li><a href="http://lab.llvm.org:8011/builders/libcxx-libcxxabi-x86_64-linux-ubuntu">
Eric Fiselier7b7ef162014-10-16 02:48:59 +0000[diff] [blame]154 clang-libcxxabi-x86_64-linux-ubuntu
155 </a></li>
Eric Fiselierdc770102014-08-18 05:25:04 +0000[diff] [blame]156 </ul>
157
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]158 <!--=====================================================================-->
159 <h2>Get it and get involved!</h2>
160 <!--=====================================================================-->
Howard Hinnant3e1b0422010-08-22 01:04:38 +0000[diff] [blame]161
Howard Hinnantf0721aa2011-09-30 16:58:02 +0000[diff] [blame]162 <p>First please review our
163 <a href="http://llvm.org/docs/DeveloperPolicy.html">Developer's Policy</a>.
164
Howard Hinnantbec2fd52011-11-17 17:14:16 +0000[diff] [blame]165 <p>
Howard Hinnant79d6bcc2012-11-06 21:31:37 +0000[diff] [blame]166 On Mac OS 10.7 (Lion) and later, the easiest way to get this library is to install
Howard Hinnantbec2fd52011-11-17 17:14:16 +0000[diff] [blame]167 Xcode 4.2 or later. However if you want to install tip-of-trunk from here
Howard Hinnant961a7352012-04-03 15:08:42 +0000[diff] [blame]168 (getting the bleeding edge), read on. However, be warned that Mac OS
169 10.7 will not boot without a valid copy of <code>libc++.1.dylib</code> in
170 <code>/usr/lib</code>.
Howard Hinnantbec2fd52011-11-17 17:14:16 +0000[diff] [blame]171 </p>
172
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]173 <p>To check out the code, use:</p>
174
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]175 <ul>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]176 <li><code>svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx</code></li>
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]177 </ul>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]178
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]179 <p>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]180 Note that for an in-tree build, you should check out libcxx to
181 llvm/projects.
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]182 </p>
183
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]184 <p>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]185 The following instructions are for building libc++ on FreeBSD, Linux, or Mac
186 using <a href="http://libcxxabi.llvm.org/">libc++abi</a> as the C++ ABI
187 library. On Linux, it is also possible to use
188 <a href="#libsupcxx">libsupc++</a> or <a href="#libcxxrt">libcxxrt</a>.
189 </p>
190
191 <p>In-tree build:</p>
192 <ul>
193 <li>Check out libcxx and <a href="http://libcxxabi.llvm.org/">libcxxabi</a>
194 into llvm/projects</li>
195 <li><code>cd llvm</code></li>
196 <li><code>mkdir build &amp;&amp; cd build</code></li>
197 <li><code>cmake .. # Linux may require -DCMAKE_C_COMPILER=clang
198 -DCMAKE_CXX_COMPILER=clang++</code></li>
199 <li><code>make cxx</code></li>
200 </ul>
201
202 <p>Out-of-tree build:</p>
203 <ul>
204 <li>Check out libcxx</li>
205 <li>If not on a Mac, also check out
206 <a href="http://libcxxabi.llvm.org/">libcxxabi</a></li>
207 <li><code>cd libcxx</code></li>
208 <li><code>mkdir build &amp;&amp; cd build</code></li>
209 <li><code>cmake -DLIBCXX_CXX_ABI=libcxxabi
210 -DLIBCXX_LIBCXXABI_INCLUDE_PATHS=path/to/libcxxabi/include
211 -DLIT_EXECUTABLE=path/to/llvm/utils/lit/lit.py .. # Linux may require
212 -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++</code></li>
213 <li><code>make</code></li>
214 </ul>
215
216 <p>To run the tests:</p>
217 <ul>
218 <li><code>make check-libcxx</code></li>
219 </ul>
220
221 <p>If you wish to run a subset of the test suite:</p>
222 <ul>
223 <li><code>cd path/to/libcxx/libcxx</code></li>
224 <li><code>alias lit='python path/to/llvm/utils/lit/lit.py'</code></li>
225 <li><code>ln -s path/to/build/dir/projects/libcxx/test/lit.site.cfg
226 test/lit.site.cfg</code></li>
227 <li><code>lit -sv test/re/ # or whichever subset of tests you're interested
228 in</code></li>
229 </ul>
230 <p>The above is currently quite inconvenient. Sorry! We're working on it!</p>
231
232 <p>More information on using LIT can be found
233 <a href="http://llvm.org/docs/CommandGuide/lit.html">here</a>. For more
234 general information about the LLVM testing infrastructure, see the
235 <a href="http://llvm.org/docs/TestingGuide.html">LLVM Testing Infrastructure
236 Guide</a>
237 </p>
238
239 <p>
240 Shared libraries for libc++ should now be present in llvm/build/lib. Note
241 that it is safest to use this from its current location rather than
242 replacing your system's libc++ (if it has one, if not, go right ahead).
243 </p>
244
245 <p>
246 Mac users, remember to be careful when replacing the system's libc++.
247 <strong>Your system will not be able to boot without a funcioning
248 libc++.</strong>
249 </p>
250
251 <!--=====================================================================-->
252 <h3>Notes</h3>
253 <!--=====================================================================-->
254
255 <p>
256 Building libc++ with <code>-fno-rtti</code> is not supported. However
257 linking against it with <code>-fno-rtti</code> is supported.
258 </p>
259
260 <p>Send discussions to the
261 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">clang mailing list</a>.</p>
262
263 <!--=====================================================================-->
264 <h2>Using libc++ in your programs</h2>
265 <!--=====================================================================-->
266
267 <!--=====================================================================-->
268 <h3>FreeBSD and Mac OS X</h3>
269 <!--=====================================================================-->
270
271 <p>
272 To use your system-installed libc++ with clang you can:
Howard Hinnantefc7aa22011-01-27 23:18:19 +0000[diff] [blame]273 </p>
274
275 <ul>
276 <li><code>clang++ -stdlib=libc++ test.cpp</code></li>
Howard Hinnantd04724c2012-07-19 15:57:51 +0000[diff] [blame]277 <li><code>clang++ -std=c++11 -stdlib=libc++ test.cpp</code></li>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]278 </ul>
279
Howard Hinnant79d6bcc2012-11-06 21:31:37 +0000[diff] [blame]280 <p>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]281 To use your tip-of-trunk libc++ on Mac OS with clang you can:
Howard Hinnant79d6bcc2012-11-06 21:31:37 +0000[diff] [blame]282 </p>
283
284 <ul>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]285 <li><code>export DYLD_LIBRARY_PATH=path/to/build/lib</code>
Howard Hinnant79d6bcc2012-11-06 21:31:37 +0000[diff] [blame]286 <li><code>clang++ -std=c++11 -stdlib=libc++ -nostdinc++
287 -I&lt;path-to-libcxx&gt;/include -L&lt;path-to-libcxx&gt;/lib
288 test.cpp</code></li>
289 </ul>
290
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]291 <!--=====================================================================-->
292 <h3>Linux</h3>
293 <!--=====================================================================-->
294
295 <p>
296 You will need to keep the source tree of
297 <a href="http://libcxxabi.llvm.org">libc++abi</a> available on your build
298 machine and your copy of the libc++abi shared library must be placed where
299 your linker will find it.
300 </p>
301
302 <p>
303 Unfortunately you can't simply run clang with "-stdlib=libc++" at this
304 point, as clang is set up to link for libc++ linked to libsupc++. To get
305 around this you'll have to set up your linker yourself (or patch clang).
306 For example:
307 </p>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]308
309 <ul>
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]310 <li><code>clang++ -stdlib=libc++ helloworld.cpp -nodefaultlibs -lc++ -lc++abi -lm -lc -lgcc_s -lgcc</code></li>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]311 </ul>
312
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]313 <p>
314 Alternately, you could just add libc++abi to your libraries list, which in
315 most situations will give the same result:
316 </p>
Howard Hinnant24147cf2012-05-20 13:03:53 +0000[diff] [blame]317
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]318 <ul>
319 <li><code>clang++ -stdlib=libc++ helloworld.cpp -lc++abi</code></li>
320 </ul>
Howard Hinnantc5b02f22010-05-11 19:53:34 +0000[diff] [blame]321
Howard Hinnantbded6c92010-10-05 16:44:40 +0000[diff] [blame]322 <!--=====================================================================-->
Marshall Clowf7cc9a12014-04-03 03:13:12 +0000[diff] [blame]323 <h2>Bug reports and patches</h2>
324 <!--=====================================================================-->
325
326<p>
327If you think you've found a bug in libc++, please report it using
328the <a href="http://llvm.org/bugs">LLVM Bugzilla</a>. If you're not sure, you
Marshall Clowc15fec52014-04-07 07:28:33 +0000[diff] [blame]329can post a message to the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a>
Marshall Clowf7cc9a12014-04-03 03:13:12 +0000[diff] [blame]330mailing list or on IRC. Please include "libc++" in your subject.
331</p>
332
333<p>
334If you want to contribute a patch to libc++, the best place for that is the
335<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits</a>
336mailing list. Please include "libc++" and "PATCH" in your subject.
337</p>
338
339 <!--=====================================================================-->
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]340 <h2 id="libsupcxx">Build on Linux using CMake and libsupc++.</h2>
Michael J. Spencera86f97e2012-12-31 19:34:21 +0000[diff] [blame]341 <!--=====================================================================-->
342
343 <p>
344 You will need libstdc++ in order to provide libsupc++.
345 </p>
346
347 <p>
348 Figure out where the libsupc++ headers are on your system. On Ubuntu this
349 is <code>/usr/include/c++/&lt;version&gt;</code> and
350 <code>/usr/include/c++/&lt;version&gt;/&lt;target-triple&gt;</code>
351 </p>
352
353 <p>
354 You can also figure this out by running
355 <pre>
356$ echo | g++ -Wp,-v -x c++ - -fsyntax-only
357ignoring nonexistent directory "/usr/local/include/x86_64-linux-gnu"
358ignoring nonexistent directory "/usr/lib/gcc/x86_64-linux-gnu/4.7/../../../../x86_64-linux-gnu/include"
359#include "..." search starts here:
360#include &lt;...&gt; search starts here:
361 /usr/include/c++/4.7
362 /usr/include/c++/4.7/x86_64-linux-gnu
363 /usr/include/c++/4.7/backward
364 /usr/lib/gcc/x86_64-linux-gnu/4.7/include
365 /usr/local/include
366 /usr/lib/gcc/x86_64-linux-gnu/4.7/include-fixed
367 /usr/include/x86_64-linux-gnu
368 /usr/include
369End of search list.
370 </pre>
371
372 Note the first two entries happen to be what we are looking for. This
373 may not be correct on other platforms.
374 </p>
375
376 <p>
377 We can now run CMake:
378 <ul>
379 <li><code>CC=clang CXX=clang++ cmake -G "Unix Makefiles"
Peter Collingbourne22dc63b2013-10-06 22:13:19 +0000[diff] [blame]380 -DLIBCXX_CXX_ABI=libstdc++
Michael J. Spencera86f97e2012-12-31 19:34:21 +0000[diff] [blame]381 -DLIBCXX_LIBSUPCXX_INCLUDE_PATHS="/usr/include/c++/4.7/;/usr/include/c++/4.7/x86_64-linux-gnu/"
382 -DCMAKE_BUILD_TYPE=Release
383 -DCMAKE_INSTALL_PREFIX=/usr
384 &lt;libc++-source-dir&gt;</code></li>
Peter Collingbourne22dc63b2013-10-06 22:13:19 +0000[diff] [blame]385 <li>You can also substitute <code>-DLIBCXX_CXX_ABI=libsupc++</code>
386 above, which will cause the library to be linked to libsupc++ instead
387 of libstdc++, but this is only recommended if you know that you will
388 never need to link against libstdc++ in the same executable as libc++.
389 GCC ships libsupc++ separately but only as a static library. If a
390 program also needs to link against libstdc++, it will provide its
391 own copy of libsupc++ and this can lead to subtle problems.
Michael J. Spencera86f97e2012-12-31 19:34:21 +0000[diff] [blame]392 <li><code>make</code></li>
393 <li><code>sudo make install</code></li>
394 </ul>
395 <p>
396 You can now run clang with -stdlib=libc++.
397 </p>
398 </p>
399
400 <!--=====================================================================-->
Dan Albertce369362014-08-11 15:12:46 +0000[diff] [blame]401 <h2 id="libcxxrt">Build on Linux using CMake and libcxxrt.</h2>
Howard Hinnant8d3824d2013-02-08 19:10:36 +0000[diff] [blame]402 <!--=====================================================================-->
403
404 <p>
405 You will need to keep the source tree of
406 <a href="https://github.com/pathscale/libcxxrt/">libcxxrt</a> available
407 on your build machine and your copy of the libcxxrt shared library must
408 be placed where your linker will find it.
409 </p>
410
411 <p>
412 We can now run CMake:
413 <ul>
414 <li><code>CC=clang CXX=clang++ cmake -G "Unix Makefiles"
415 -DLIBCXX_CXX_ABI=libcxxrt
Howard Hinnant727ff912013-02-26 16:27:55 +0000[diff] [blame]416 -DLIBCXX_LIBCXXRT_INCLUDE_PATHS="&lt;libcxxrt-source-dir&gt;/src"
Howard Hinnant8d3824d2013-02-08 19:10:36 +0000[diff] [blame]417 -DCMAKE_BUILD_TYPE=Release
418 -DCMAKE_INSTALL_PREFIX=/usr
419 &lt;libc++-source-dir&gt;</code></li>
420 <li><code>make</code></li>
421 <li><code>sudo make install</code></li>
422 </ul>
423 <p>
424 Unfortunately you can't simply run clang with "-stdlib=libc++" at this point, as
425 clang is set up to link for libc++ linked to libsupc++. To get around this
426 you'll have to set up your linker yourself (or patch clang). For example,
427 <ul>
428 <li><code>clang++ -stdlib=libc++ helloworld.cpp -nodefaultlibs -lc++ -lcxxrt -lm -lc -lgcc_s -lgcc</code></li>
429 </ul>
430 Alternately, you could just add libcxxrt to your libraries list, which in most
431 situations will give the same result:
432 <ul>
433 <li><code>clang++ -stdlib=libc++ helloworld.cpp -lcxxrt</code></li>
434 </ul>
435 </p>
436 </p>
437
438 <!--=====================================================================-->
Eric Fiselierf2348552014-10-18 01:15:17 +0000[diff] [blame]439 <h2 id="local-abi">Using a local ABI library</h2>
440 <!--=====================================================================-->
441 <p>
442 <strong>Note: This is not recommended in almost all cases.</strong><br>
443 Generally these instructions should only be used when you can't install
444 your ABI library.
445 </p>
446 <p>
447 Normally you must link libc++ against a ABI shared library that the
448 linker can find. If you want to build and test libc++ against an ABI
449 library not in the linker's path you need to set
Eric Fiseliere1b33602014-10-19 00:42:41 +0000[diff] [blame]450 <code>-DLIBCXX_CXX_ABI_LIBRARY_PATH=/path/to/abi/lib</code> when
451 configuring CMake.
Eric Fiselierf2348552014-10-18 01:15:17 +0000[diff] [blame]452 </p>
453 <p>
454 An example build using libc++abi would look like:
455 <ul>
456 <li><code>CC=clang CXX=clang++ cmake
457 -DLIBCXX_CXX_ABI=libc++abi
458 -DLIBCXX_LIBCXXABI_INCLUDE_PATHS="/path/to/libcxxabi/include"
Eric Fiseliere1b33602014-10-19 00:42:41 +0000[diff] [blame]459 -DLIBCXX_CXX_ABI_LIBRARY_PATH="/path/to/libcxxabi-build/lib"
Eric Fiselierf2348552014-10-18 01:15:17 +0000[diff] [blame]460 path/to/libcxx</code></li>
461 <li><code>make</code></li>
462 </ul>
463 </p>
464 <p>
465 When testing libc++ LIT will automatically link against the proper ABI
466 library.
467 </p>
468
469 <!--=====================================================================-->
Howard Hinnantbded6c92010-10-05 16:44:40 +0000[diff] [blame]470 <h2>Design Documents</h2>
471 <!--=====================================================================-->
472
473<ul>
474<li><a href="atomic_design.html"><tt>&lt;atomic&gt;</tt></a></li>
Howard Hinnante20b8de2010-11-19 01:38:58 +0000[diff] [blame]475<li><a href="type_traits_design.html"><tt>&lt;type_traits&gt;</tt></a></li>
Marshall Clow68aa6b42013-03-14 19:00:34 +0000[diff] [blame]476<li><a href="http://cplusplusmusings.wordpress.com/2012/07/05/clang-and-standard-libraries-on-mac-os-x/">Excellent notes by Marshall Clow</a></li>
Howard Hinnant57724c32013-03-14 18:37:48 +0000[diff] [blame]477<li><a href="debug_mode.html">Status of debug mode</a></li>
Howard Hinnantbded6c92010-10-05 16:44:40 +0000[diff] [blame]478</ul>
479
Howard Hinnantc51e1022010-05-11 19:42:16 +0000[diff] [blame]480</div>
481</body>
Chris Lattnere66f1e32010-05-11 20:37:52 +0000[diff] [blame]482</html>