Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 8a99373812cfc7feb30c28ef5fb23c774856eb38 / . / libcxx / www / index.html
blob: b9bb1f86b73e98a4d8acf1158637ae1acadf08e8 [file] [log] [blame]
Howard Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
Howard Hinnant3e519522010-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 Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]17
Howard Hinnant3e519522010-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 Lattnerf9e7e3a2010-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 Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]27 <a href="http://llvm.org/bugs/">Bug Reports</a>
Howard Hinnant38a59272010-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 Hinnant3e519522010-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 Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]37
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]38 <p>libc++ is a new implementation of the C++ standard library, targeting
Howard Hinnant51eb2ad2012-07-19 15:57:51 +0000[diff] [blame]39 C++11.</p>
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]40
Chris Lattner58dffe62010-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 Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]44
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]45 <!--=====================================================================-->
46 <h2 id="goals">Features and Goals</h2>
47 <!--=====================================================================-->
Howard Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]48
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]49 <ul>
Howard Hinnant51eb2ad2012-07-19 15:57:51 +0000[diff] [blame]50 <li>Correctness as defined by the C++11 standard.</li>
Howard Hinnant3e519522010-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 Clow497d9d22012-11-14 16:31:15 +0000[diff] [blame]60 <h2 id="why">Why a new C++ Standard Library for C++11?</h2>
Chris Lattner27de3d62010-05-12 22:21:15 +0000[diff] [blame]61 <!--=====================================================================-->
Howard Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]62
Chris Lattner27de3d62010-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 Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]67
Chris Lattner27de3d62010-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 Clow497d9d22012-11-14 16:31:15 +0000[diff] [blame]75 machines (particularly in C++11, which has rvalue references). Breaking
Chris Lattnerf005e8d2010-05-12 22:30:22 +0000[diff] [blame]76 ABI compatibility with old versions of the library was
Chris Lattner27de3d62010-05-12 22:21:15 +0000[diff] [blame]77 determined to be critical to achieving the performance goals of
78 libc++.</p></li>
Howard Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]79
Chris Lattner27de3d62010-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 Clow497d9d22012-11-14 16:31:15 +0000[diff] [blame]82 independently extended to support C++11, but this would be a fork of the
Chris Lattnera940b5b2010-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 Lattner27de3d62010-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 Clow497d9d22012-11-14 16:31:15 +0000[diff] [blame]90 candidates, but both lack C++11 support. Our experience (and the
Howard Hinnant51eb2ad2012-07-19 15:57:51 +0000[diff] [blame]91 experience of libstdc++ developers) is that adding support for C++11 (in
Chris Lattner27de3d62010-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 Lattnerd55fd112010-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 Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]96
Chris Lattner27de3d62010-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 Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]103 <h2 id="requirements">Platform Support</h2>
104 <!--=====================================================================-->
105
Dan Albertec4de782014-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 Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]112
Dan Albertec4de782014-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 Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]120
121 <!--=====================================================================-->
122 <h2 id="dir-structure">Current Status</h2>
123 <!--=====================================================================-->
124
Howard Hinnant6852b552012-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. Spencerbb8cfd02012-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 Clow079402d2014-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 Clowca6e3662014-04-03 02:35:29 +0000[diff] [blame]128 C++14 can be found <a href="cxx1y_status.html">here</a>.</p>
Marshall Clowf39d9142014-06-02 23:37:13 +0000[diff] [blame]129 <p>Implementation of the post-c++14 Technical Specifications is in progress. A list of features and
130 the current status of these features can be found <a href="ts1z_status.html">here</a>.</p>
Howard Hinnantd7aac282011-09-28 15:44:39 +0000[diff] [blame]131 <p>
Howard Hinnant8eb04fe2012-07-31 21:30:28 +0000[diff] [blame]132 Ports to other platforms are underway. Here are recent test
133 results for <a href="results.Windows.html">Windows</a>
134 and <a href="results.Linux.html">Linux</a>.
Howard Hinnantd7aac282011-09-28 15:44:39 +0000[diff] [blame]135 </p>
136
Eric Fiseliercd6ac3a2014-08-18 05:25:04 +0000[diff] [blame]137 <!--======================================================================-->
138 <h2 id="dir-structure">Build Bots</h2>
139 <!--======================================================================-->
140 <p>These are the libc++ build bots</p>
141 <ul>
142 <li><a href="http://lab.llvm.org:8013/builders/libcxx_clang-x86_64-darwin11-RA">
143 clang-libcxxabi-x86_64-darwin11
144 </a></li>
145 <li><a href="http://llvm-amd64.freebsd.your.org/b/builders/libcxx-amd64-freebsd">
146 clang-libcxxrt-x86_64-freebsd10
147 </a></li>
148 <li><a href="http://llvm-amd64.freebsd.your.org/b/builders/libcxx-i386-freebsd">
149 clang-libcxxrt-i386-freebsd10
150 </a></li>
151 <li><a href="http://lab.llvm.org:8011/builders/libcxx-libcxxabi-x86_64-linux-debian">
152 clang-libcxxabi-x86_64-linux-debian
153 </a></li>
Eric Fiselierce842e82014-10-16 03:15:31 +0000[diff] [blame]154 <li><a href="http://lab.llvm.org:8011/builders/libcxx-libcxxabi-x86_64-linux-ubuntu">
Eric Fiselier8c5bc1c2014-10-16 02:48:59 +0000[diff] [blame]155 clang-libcxxabi-x86_64-linux-ubuntu
156 </a></li>
Eric Fiseliercd6ac3a2014-08-18 05:25:04 +0000[diff] [blame]157 </ul>
158
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]159 <!--=====================================================================-->
160 <h2>Get it and get involved!</h2>
161 <!--=====================================================================-->
Howard Hinnant2807d4a2010-08-22 01:04:38 +0000[diff] [blame]162
Howard Hinnant4f4d3102011-09-30 16:58:02 +0000[diff] [blame]163 <p>First please review our
164 <a href="http://llvm.org/docs/DeveloperPolicy.html">Developer's Policy</a>.
165
Howard Hinnant73191602011-11-17 17:14:16 +0000[diff] [blame]166 <p>
Howard Hinnant1c8358c2012-11-06 21:31:37 +0000[diff] [blame]167 On Mac OS 10.7 (Lion) and later, the easiest way to get this library is to install
Howard Hinnant73191602011-11-17 17:14:16 +0000[diff] [blame]168 Xcode 4.2 or later. However if you want to install tip-of-trunk from here
Howard Hinnant6e3e78a2012-04-03 15:08:42 +0000[diff] [blame]169 (getting the bleeding edge), read on. However, be warned that Mac OS
170 10.7 will not boot without a valid copy of <code>libc++.1.dylib</code> in
171 <code>/usr/lib</code>.
Howard Hinnant73191602011-11-17 17:14:16 +0000[diff] [blame]172 </p>
173
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]174 <p>To check out the code, use:</p>
175
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]176 <ul>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]177 <li><code>svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx</code></li>
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]178 </ul>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]179
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]180 <p>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]181 Note that for an in-tree build, you should check out libcxx to
182 llvm/projects.
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]183 </p>
184
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]185 <p>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]186 The following instructions are for building libc++ on FreeBSD, Linux, or Mac
187 using <a href="http://libcxxabi.llvm.org/">libc++abi</a> as the C++ ABI
188 library. On Linux, it is also possible to use
189 <a href="#libsupcxx">libsupc++</a> or <a href="#libcxxrt">libcxxrt</a>.
190 </p>
191
192 <p>In-tree build:</p>
193 <ul>
194 <li>Check out libcxx and <a href="http://libcxxabi.llvm.org/">libcxxabi</a>
195 into llvm/projects</li>
196 <li><code>cd llvm</code></li>
197 <li><code>mkdir build &amp;&amp; cd build</code></li>
198 <li><code>cmake .. # Linux may require -DCMAKE_C_COMPILER=clang
199 -DCMAKE_CXX_COMPILER=clang++</code></li>
200 <li><code>make cxx</code></li>
201 </ul>
202
203 <p>Out-of-tree build:</p>
204 <ul>
205 <li>Check out libcxx</li>
206 <li>If not on a Mac, also check out
207 <a href="http://libcxxabi.llvm.org/">libcxxabi</a></li>
208 <li><code>cd libcxx</code></li>
209 <li><code>mkdir build &amp;&amp; cd build</code></li>
210 <li><code>cmake -DLIBCXX_CXX_ABI=libcxxabi
211 -DLIBCXX_LIBCXXABI_INCLUDE_PATHS=path/to/libcxxabi/include
212 -DLIT_EXECUTABLE=path/to/llvm/utils/lit/lit.py .. # Linux may require
213 -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++</code></li>
214 <li><code>make</code></li>
215 </ul>
216
217 <p>To run the tests:</p>
218 <ul>
219 <li><code>make check-libcxx</code></li>
220 </ul>
221
222 <p>If you wish to run a subset of the test suite:</p>
223 <ul>
224 <li><code>cd path/to/libcxx/libcxx</code></li>
225 <li><code>alias lit='python path/to/llvm/utils/lit/lit.py'</code></li>
226 <li><code>ln -s path/to/build/dir/projects/libcxx/test/lit.site.cfg
227 test/lit.site.cfg</code></li>
228 <li><code>lit -sv test/re/ # or whichever subset of tests you're interested
229 in</code></li>
230 </ul>
231 <p>The above is currently quite inconvenient. Sorry! We're working on it!</p>
232
233 <p>More information on using LIT can be found
234 <a href="http://llvm.org/docs/CommandGuide/lit.html">here</a>. For more
235 general information about the LLVM testing infrastructure, see the
236 <a href="http://llvm.org/docs/TestingGuide.html">LLVM Testing Infrastructure
237 Guide</a>
238 </p>
239
240 <p>
241 Shared libraries for libc++ should now be present in llvm/build/lib. Note
242 that it is safest to use this from its current location rather than
243 replacing your system's libc++ (if it has one, if not, go right ahead).
244 </p>
245
246 <p>
247 Mac users, remember to be careful when replacing the system's libc++.
248 <strong>Your system will not be able to boot without a funcioning
249 libc++.</strong>
250 </p>
251
252 <!--=====================================================================-->
253 <h3>Notes</h3>
254 <!--=====================================================================-->
255
256 <p>
257 Building libc++ with <code>-fno-rtti</code> is not supported. However
258 linking against it with <code>-fno-rtti</code> is supported.
259 </p>
260
261 <p>Send discussions to the
262 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">clang mailing list</a>.</p>
263
264 <!--=====================================================================-->
265 <h2>Using libc++ in your programs</h2>
266 <!--=====================================================================-->
267
268 <!--=====================================================================-->
269 <h3>FreeBSD and Mac OS X</h3>
270 <!--=====================================================================-->
271
272 <p>
273 To use your system-installed libc++ with clang you can:
Howard Hinnante4de2792011-01-27 23:18:19 +0000[diff] [blame]274 </p>
275
276 <ul>
277 <li><code>clang++ -stdlib=libc++ test.cpp</code></li>
Howard Hinnant51eb2ad2012-07-19 15:57:51 +0000[diff] [blame]278 <li><code>clang++ -std=c++11 -stdlib=libc++ test.cpp</code></li>
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]279 </ul>
280
Howard Hinnant1c8358c2012-11-06 21:31:37 +0000[diff] [blame]281 <p>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]282 To use your tip-of-trunk libc++ on Mac OS with clang you can:
Howard Hinnant1c8358c2012-11-06 21:31:37 +0000[diff] [blame]283 </p>
284
285 <ul>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]286 <li><code>export DYLD_LIBRARY_PATH=path/to/build/lib</code>
Howard Hinnant1c8358c2012-11-06 21:31:37 +0000[diff] [blame]287 <li><code>clang++ -std=c++11 -stdlib=libc++ -nostdinc++
288 -I&lt;path-to-libcxx&gt;/include -L&lt;path-to-libcxx&gt;/lib
289 test.cpp</code></li>
290 </ul>
291
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]292 <!--=====================================================================-->
293 <h3>Linux</h3>
294 <!--=====================================================================-->
295
296 <p>
297 You will need to keep the source tree of
298 <a href="http://libcxxabi.llvm.org">libc++abi</a> available on your build
299 machine and your copy of the libc++abi shared library must be placed where
300 your linker will find it.
301 </p>
302
303 <p>
304 Unfortunately you can't simply run clang with "-stdlib=libc++" at this
305 point, as clang is set up to link for libc++ linked to libsupc++. To get
306 around this you'll have to set up your linker yourself (or patch clang).
307 For example:
308 </p>
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]309
310 <ul>
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]311 <li><code>clang++ -stdlib=libc++ helloworld.cpp -nodefaultlibs -lc++ -lc++abi -lm -lc -lgcc_s -lgcc</code></li>
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]312 </ul>
313
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]314 <p>
315 Alternately, you could just add libc++abi to your libraries list, which in
316 most situations will give the same result:
317 </p>
Howard Hinnant49c3b202012-05-20 13:03:53 +0000[diff] [blame]318
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]319 <ul>
320 <li><code>clang++ -stdlib=libc++ helloworld.cpp -lc++abi</code></li>
321 </ul>
Howard Hinnant180e1d72010-05-11 19:53:34 +0000[diff] [blame]322
Howard Hinnant1de22662010-10-05 16:44:40 +0000[diff] [blame]323 <!--=====================================================================-->
Marshall Clow17c6aa02014-04-03 03:13:12 +0000[diff] [blame]324 <h2>Bug reports and patches</h2>
325 <!--=====================================================================-->
326
327<p>
328If you think you've found a bug in libc++, please report it using
329the <a href="http://llvm.org/bugs">LLVM Bugzilla</a>. If you're not sure, you
Marshall Clow5cf03ab2014-04-07 07:28:33 +0000[diff] [blame]330can post a message to the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a>
Marshall Clow17c6aa02014-04-03 03:13:12 +0000[diff] [blame]331mailing list or on IRC. Please include "libc++" in your subject.
332</p>
333
334<p>
335If you want to contribute a patch to libc++, the best place for that is the
336<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits</a>
337mailing list. Please include "libc++" and "PATCH" in your subject.
338</p>
339
340 <!--=====================================================================-->
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]341 <h2 id="libsupcxx">Build on Linux using CMake and libsupc++.</h2>
Michael J. Spencerbb8cfd02012-12-31 19:34:21 +0000[diff] [blame]342 <!--=====================================================================-->
343
344 <p>
345 You will need libstdc++ in order to provide libsupc++.
346 </p>
347
348 <p>
349 Figure out where the libsupc++ headers are on your system. On Ubuntu this
350 is <code>/usr/include/c++/&lt;version&gt;</code> and
351 <code>/usr/include/c++/&lt;version&gt;/&lt;target-triple&gt;</code>
352 </p>
353
354 <p>
355 You can also figure this out by running
356 <pre>
357$ echo | g++ -Wp,-v -x c++ - -fsyntax-only
358ignoring nonexistent directory "/usr/local/include/x86_64-linux-gnu"
359ignoring nonexistent directory "/usr/lib/gcc/x86_64-linux-gnu/4.7/../../../../x86_64-linux-gnu/include"
360#include "..." search starts here:
361#include &lt;...&gt; search starts here:
362 /usr/include/c++/4.7
363 /usr/include/c++/4.7/x86_64-linux-gnu
364 /usr/include/c++/4.7/backward
365 /usr/lib/gcc/x86_64-linux-gnu/4.7/include
366 /usr/local/include
367 /usr/lib/gcc/x86_64-linux-gnu/4.7/include-fixed
368 /usr/include/x86_64-linux-gnu
369 /usr/include
370End of search list.
371 </pre>
372
373 Note the first two entries happen to be what we are looking for. This
374 may not be correct on other platforms.
375 </p>
376
377 <p>
378 We can now run CMake:
379 <ul>
380 <li><code>CC=clang CXX=clang++ cmake -G "Unix Makefiles"
Peter Collingbourne26dd09e2013-10-06 22:13:19 +0000[diff] [blame]381 -DLIBCXX_CXX_ABI=libstdc++
Michael J. Spencerbb8cfd02012-12-31 19:34:21 +0000[diff] [blame]382 -DLIBCXX_LIBSUPCXX_INCLUDE_PATHS="/usr/include/c++/4.7/;/usr/include/c++/4.7/x86_64-linux-gnu/"
383 -DCMAKE_BUILD_TYPE=Release
384 -DCMAKE_INSTALL_PREFIX=/usr
385 &lt;libc++-source-dir&gt;</code></li>
Peter Collingbourne26dd09e2013-10-06 22:13:19 +0000[diff] [blame]386 <li>You can also substitute <code>-DLIBCXX_CXX_ABI=libsupc++</code>
387 above, which will cause the library to be linked to libsupc++ instead
388 of libstdc++, but this is only recommended if you know that you will
389 never need to link against libstdc++ in the same executable as libc++.
390 GCC ships libsupc++ separately but only as a static library. If a
391 program also needs to link against libstdc++, it will provide its
392 own copy of libsupc++ and this can lead to subtle problems.
Michael J. Spencerbb8cfd02012-12-31 19:34:21 +0000[diff] [blame]393 <li><code>make</code></li>
394 <li><code>sudo make install</code></li>
395 </ul>
396 <p>
397 You can now run clang with -stdlib=libc++.
398 </p>
399 </p>
400
401 <!--=====================================================================-->
Dan Albertec4de782014-08-11 15:12:46 +0000[diff] [blame]402 <h2 id="libcxxrt">Build on Linux using CMake and libcxxrt.</h2>
Howard Hinnantaf00dc02013-02-08 19:10:36 +0000[diff] [blame]403 <!--=====================================================================-->
404
405 <p>
406 You will need to keep the source tree of
407 <a href="https://github.com/pathscale/libcxxrt/">libcxxrt</a> available
408 on your build machine and your copy of the libcxxrt shared library must
409 be placed where your linker will find it.
410 </p>
411
412 <p>
413 We can now run CMake:
414 <ul>
415 <li><code>CC=clang CXX=clang++ cmake -G "Unix Makefiles"
416 -DLIBCXX_CXX_ABI=libcxxrt
Howard Hinnant5b22e992013-02-26 16:27:55 +0000[diff] [blame]417 -DLIBCXX_LIBCXXRT_INCLUDE_PATHS="&lt;libcxxrt-source-dir&gt;/src"
Howard Hinnantaf00dc02013-02-08 19:10:36 +0000[diff] [blame]418 -DCMAKE_BUILD_TYPE=Release
419 -DCMAKE_INSTALL_PREFIX=/usr
420 &lt;libc++-source-dir&gt;</code></li>
421 <li><code>make</code></li>
422 <li><code>sudo make install</code></li>
423 </ul>
424 <p>
425 Unfortunately you can't simply run clang with "-stdlib=libc++" at this point, as
426 clang is set up to link for libc++ linked to libsupc++. To get around this
427 you'll have to set up your linker yourself (or patch clang). For example,
428 <ul>
429 <li><code>clang++ -stdlib=libc++ helloworld.cpp -nodefaultlibs -lc++ -lcxxrt -lm -lc -lgcc_s -lgcc</code></li>
430 </ul>
431 Alternately, you could just add libcxxrt to your libraries list, which in most
432 situations will give the same result:
433 <ul>
434 <li><code>clang++ -stdlib=libc++ helloworld.cpp -lcxxrt</code></li>
435 </ul>
436 </p>
437 </p>
438
439 <!--=====================================================================-->
Eric Fiselier6f9da552014-10-18 01:15:17 +0000[diff] [blame]440 <h2 id="local-abi">Using a local ABI library</h2>
441 <!--=====================================================================-->
442 <p>
443 <strong>Note: This is not recommended in almost all cases.</strong><br>
444 Generally these instructions should only be used when you can't install
445 your ABI library.
446 </p>
447 <p>
448 Normally you must link libc++ against a ABI shared library that the
449 linker can find. If you want to build and test libc++ against an ABI
450 library not in the linker's path you need to set
451 <code>-DCMAKE_LIBRARY_PATH=/path/to/abi/lib</code> when configuring CMake.
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"
459 -DCMAKE_LIBRARY_PATH="/path/to/libcxxabi-build/lib"
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 Hinnant1de22662010-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 Hinnant4b889672010-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 Clow928f65a2013-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 Hinnantd70e6572013-03-14 18:37:48 +0000[diff] [blame]477<li><a href="debug_mode.html">Status of debug mode</a></li>
Howard Hinnant1de22662010-10-05 16:44:40 +0000[diff] [blame]478</ul>
479
Howard Hinnant3e519522010-05-11 19:42:16 +0000[diff] [blame]480</div>
481</body>
Chris Lattner6f12a7f2010-05-11 20:37:52 +0000[diff] [blame]482</html>