Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 3 | <html> |
| 4 | <head> |
Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 6 | <link rel="stylesheet" href="llvm.css" type="text/css" media="screen"> |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 7 | <title>Bootstrapping the LLVM C/C++ Front-End</title> |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 8 | </head> |
| 9 | <body> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 10 | |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 11 | <div class="doc_title"> |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 12 | Bootstrapping the LLVM C/C++ Front-End |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 13 | </div> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 14 | |
Brian Gaeke | 7af03e9 | 2003-11-12 20:47:30 +0000 | [diff] [blame] | 15 | <ol> |
| 16 | <li><a href="#cautionarynote">A Cautionary Note</a> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 17 | <ul> |
Misha Brukman | 62a9343 | 2004-06-18 15:54:54 +0000 | [diff] [blame] | 18 | <li><a href="#cygwin">Building under Cygwin</a></li> |
Misha Brukman | 03ea9d4 | 2004-08-23 17:54:45 +0000 | [diff] [blame] | 19 | <li><a href="#aix">Building under AIX</a></li> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 20 | </ul> |
| 21 | </li> |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 22 | <li><a href="#instructions">llvm-gcc4 Instructions</a></li> |
| 23 | <li><a href="#llvm-gcc3-instructions">llvm-gcc3 Instructions</a></li> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 24 | <li><a href="#license">License Information</a></li> |
Brian Gaeke | 7af03e9 | 2003-11-12 20:47:30 +0000 | [diff] [blame] | 25 | </ol> |
| 26 | |
Chris Lattner | 7911ce2 | 2004-05-23 21:07:27 +0000 | [diff] [blame] | 27 | <div class="doc_author"> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 28 | <p>Written by Brian R. Gaeke and |
| 29 | <a href="http://nondot.org/sabre">Chris Lattner</a></p> |
Brian Gaeke | 7af03e9 | 2003-11-12 20:47:30 +0000 | [diff] [blame] | 30 | </div> |
| 31 | |
| 32 | <!-- *********************************************************************** --> |
| 33 | <div class="doc_section"> |
| 34 | <a name="cautionarynote">A Cautionary Note</a> |
| 35 | </div> |
| 36 | <!-- *********************************************************************** --> |
| 37 | |
| 38 | <div class="doc_text"> |
| 39 | <p>This document is intended to explain the process of building the |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 40 | LLVM C/C++ front-end from its source code. You have to do this, for example, if |
| 41 | you are porting LLVM to a new architecture or operating system, if you are |
| 42 | working from Top-Of-Tree CVS/SVN, or if there is no precompiled snapshot |
| 43 | available.</p> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 44 | |
| 45 | <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 46 | process, and you should <b>only</b> try to do it if:</p> |
| 47 | |
| 48 | <ol> |
| 49 | <li>you really, really, really can't use the binaries we distribute</li> |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 50 | <li>you are an elite GCC hacker.</li> |
Chris Lattner | c8118e1 | 2005-02-21 16:35:31 +0000 | [diff] [blame] | 51 | <li>you want to use the latest bits from CVS.</li> |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 52 | </ol> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 53 | |
| 54 | <p>We welcome patches to help make this process simpler.</p> |
Brian Gaeke | 7af03e9 | 2003-11-12 20:47:30 +0000 | [diff] [blame] | 55 | </div> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 56 | |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 57 | <!--=========================================================================--> |
| 58 | <div class="doc_subsection"> |
Misha Brukman | 62a9343 | 2004-06-18 15:54:54 +0000 | [diff] [blame] | 59 | <a name="cygwin">Building under Cygwin</a> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 60 | </div> |
| 61 | <!--=========================================================================--> |
| 62 | |
| 63 | <div class="doc_text"> |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 64 | <p>If you are building LLVM and the GCC front-end under Cygwin, please note that |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 65 | the LLVM and GCC makefiles do not correctly handle spaces in paths. To deal |
| 66 | with this issue, make sure that your LLVM and GCC source and build trees are |
| 67 | located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and |
| 68 | <tt>/cygdrive/c/llvm-cfrontend</tt>), not in a directory that contains a space |
| 69 | (which includes your "home directory", because it lives under the "Documents |
| 70 | and Settings" directory). We welcome patches to fix this issue. |
| 71 | </p> |
Reid Spencer | 2404236 | 2004-12-22 09:52:30 +0000 | [diff] [blame] | 72 | <p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin |
John Criswell | d6c6ee0 | 2005-10-24 16:37:24 +0000 | [diff] [blame] | 73 | versions is incapable of compiling the LLVM GCC front-end correctly. If your |
| 74 | Cygwin |
John Criswell | d0c4a76 | 2005-05-13 20:38:44 +0000 | [diff] [blame] | 75 | installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 76 | GCC 3.4.3, build it separately, and use it for compiling the LLVM GCC front-end. |
| 77 | This has been |
Reid Spencer | 2404236 | 2004-12-22 09:52:30 +0000 | [diff] [blame] | 78 | shown to work correctly.</p> |
Reid Spencer | 72a5900 | 2004-12-23 19:49:54 +0000 | [diff] [blame] | 79 | <p>Some versions of Cygwin utilize an experimental version of GNU binutils that |
| 80 | will cause the GNU <tt>ld</tt> linker to fail an assertion when linking |
| 81 | components of the libstdc++. It is recommended that you replace the entire |
| 82 | binutils package with version 2.15 such that "<tt>ld --version</tt>" responds |
Misha Brukman | 00b95c3 | 2005-03-01 17:19:21 +0000 | [diff] [blame] | 83 | with</p> |
Reid Spencer | 72a5900 | 2004-12-23 19:49:54 +0000 | [diff] [blame] | 84 | <pre>GNU ld version 2.15</pre> |
| 85 | not with:<br/> |
| 86 | <pre>GNU ld version 2.15.91 20040725</pre> |
Misha Brukman | 00b95c3 | 2005-03-01 17:19:21 +0000 | [diff] [blame] | 87 | </div> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 88 | |
Misha Brukman | 03ea9d4 | 2004-08-23 17:54:45 +0000 | [diff] [blame] | 89 | <!--=========================================================================--> |
Reid Spencer | e0a7ddd | 2004-12-31 19:48:59 +0000 | [diff] [blame] | 90 | <div class="doc_subsection"><a name="aix">Building under AIX</a></div> |
Misha Brukman | 03ea9d4 | 2004-08-23 17:54:45 +0000 | [diff] [blame] | 91 | <div class="doc_text"> |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 92 | <p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU |
Misha Brukman | 03ea9d4 | 2004-08-23 17:54:45 +0000 | [diff] [blame] | 93 | Binutils. They are not stable under AIX and may produce incorrect and/or |
| 94 | invalid code. Instead, use the system assembler and linker. |
| 95 | </p> |
| 96 | </div> |
| 97 | |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 98 | <!-- *********************************************************************** --> |
| 99 | <div class="doc_section"> |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 100 | <a name="instructions">llvm-gcc4 Instructions</a> |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 101 | </div> |
| 102 | <!-- *********************************************************************** --> |
| 103 | |
| 104 | <div class="doc_text"> |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 105 | |
| 106 | <p>This section describes how to aquire and build llvm-gcc4, which is based on |
| 107 | the GCC 4.0.1 front-end. This front-end supports C, C++, Objective-C, and |
| 108 | Objective-C++. Note that the instructions for building this front-end are |
| 109 | completely different than those for building llvm-gcc3. |
| 110 | </p> |
| 111 | |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 112 | <ol> |
Jim Laskey | e9493d3 | 2006-06-16 23:34:49 +0000 | [diff] [blame] | 113 | <li> |
| 114 | <p>Retrieve the appropriate llvm-gcc4-x.y.source.tar.gz archive from the llvm |
| 115 | web site.</p> |
| 116 | <p>It is also possible to download the sources of the llvm-gcc4 front end from |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 117 | a read-only mirror using subversion. To check out the code the first time use: |
Jim Laskey | e9493d3 | 2006-06-16 23:34:49 +0000 | [diff] [blame] | 118 | </p> |
| 119 | |
Jim Laskey | 6c3acb7 | 2006-07-31 21:37:55 +0000 | [diff] [blame] | 120 | <tt>svn co svn://anonsvn.opensource.apple.com/svn/llvm/trunk |
| 121 | <i>dst-directory</i></tt> |
Jim Laskey | e9493d3 | 2006-06-16 23:34:49 +0000 | [diff] [blame] | 122 | |
| 123 | <p>After that, the code can be be updated in the destination directory using; |
| 124 | </p> |
| 125 | |
| 126 | <tt>svn update</tt> |
| 127 | |
| 128 | <p>The mirror is brought up to date every evening.</p> |
| 129 | </li> |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 130 | |
| 131 | <li>Follow the directions in the top-level README.LLVM file for up-to-date |
| 132 | instructions on how to build llvm-gcc4.</li> |
| 133 | </ol> |
| 134 | </div> |
| 135 | |
| 136 | <!-- *********************************************************************** --> |
| 137 | <div class="doc_section"> |
| 138 | <a name="llvm-gcc3-instructions">llvm-gcc3 Instructions</a> |
| 139 | </div> |
| 140 | <!-- *********************************************************************** --> |
| 141 | |
| 142 | <div class="doc_text"> |
| 143 | <ol> |
| 144 | <li>Aquire llvm-gcc3 from <a href="GettingStarted.html#checkout">LLVM CVS</a> or |
| 145 | from a <a href="http://llvm.org/releases/">release tarball</a>.</li> |
| 146 | |
Reid Spencer | e0a7ddd | 2004-12-31 19:48:59 +0000 | [diff] [blame] | 147 | <li><p>Configure and build the LLVM libraries and tools. There are two ways to |
John Criswell | d0c4a76 | 2005-05-13 20:38:44 +0000 | [diff] [blame] | 148 | do this: either with <i>objdir</i> == <i>srcdir</i> or |
| 149 | <i>objdir</i> != <i>srcdir</i>. It is recommended |
Chris Lattner | e996714 | 2005-09-21 03:56:26 +0000 | [diff] [blame] | 150 | that <i>srcdir</i> be the same as <i>objdir</i> for your LLVM tree (but note |
| 151 | that you should always use <i>srcdir</i> != <i>objdir</i> for llvm-gcc):</p> |
Reid Spencer | e0a7ddd | 2004-12-31 19:48:59 +0000 | [diff] [blame] | 152 | <ul> |
| 153 | <li>With <i>objdir</i> != <i>srcdir</i>:<pre> |
| 154 | % cd <i>objdir</i> |
| 155 | % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...] |
| 156 | % gmake tools-only |
| 157 | </pre></li> |
| 158 | <li>With <i>objdir</i> == <i>srcdir</i>:<pre> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 159 | % cd llvm |
Reid Spencer | 0b4f468 | 2004-12-01 05:15:44 +0000 | [diff] [blame] | 160 | % ./configure --prefix=/some/path/you/can/install/to [options...] |
Misha Brukman | e749053 | 2004-08-14 22:13:33 +0000 | [diff] [blame] | 161 | % gmake tools-only |
Reid Spencer | e0a7ddd | 2004-12-31 19:48:59 +0000 | [diff] [blame] | 162 | </pre></li> |
| 163 | </ul> |
| 164 | <p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt> |
| 165 | option defaults to /usr/local (per configure standards) but unless you are a |
| 166 | system administrator, you probably won't be able to install LLVM there because |
| 167 | of permissions. Specify a path into which LLVM can be installed (e.g. |
| 168 | <tt>--prefix=/home/user/llvm</tt>).</p> |
Reid Spencer | 0b4f468 | 2004-12-01 05:15:44 +0000 | [diff] [blame] | 169 | </li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 170 | |
| 171 | <li><p>Add the directory containing the tools to your PATH.</p> |
| 172 | <pre> |
John Criswell | c7f4264 | 2004-12-01 14:12:30 +0000 | [diff] [blame] | 173 | % set path = ( `cd llvm/Debug/bin && pwd` $path ) |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 174 | </pre></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 175 | |
Chris Lattner | b1241b0 | 2005-02-11 21:17:26 +0000 | [diff] [blame] | 176 | <li><p>Unpack the C/C++ front-end source into cfrontend/src, either by |
John Criswell | 8bfe6a7 | 2005-05-18 19:43:33 +0000 | [diff] [blame] | 177 | untar'ing a cfrontend.source.tar.gz file or checking out CVS into this |
Chris Lattner | b1241b0 | 2005-02-11 21:17:26 +0000 | [diff] [blame] | 178 | directory.</p></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 179 | |
John Criswell | d0c4a76 | 2005-05-13 20:38:44 +0000 | [diff] [blame] | 180 | <li><p>Make "build" and "install" directories as siblings of the "src" tree:</p> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 181 | <pre> |
| 182 | % pwd |
| 183 | /usr/local/example/cfrontend/src |
| 184 | % cd .. |
| 185 | % mkdir build install |
| 186 | % set CFEINSTALL = `pwd`/install |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 187 | </pre></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 188 | |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 189 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 190 | <li><p>Configure, build, and install the GCC front-end:</p> |
John Criswell | 5507284 | 2003-12-08 19:59:14 +0000 | [diff] [blame] | 191 | |
| 192 | <p> |
Misha Brukman | 31b2432 | 2004-06-21 14:00:44 +0000 | [diff] [blame] | 193 | <b>Linux/x86:</b><br> |
Duraid Madina | 0203a31 | 2005-06-14 07:29:50 +0000 | [diff] [blame] | 194 | <b>Linux/IA-64:</b><br> |
Misha Brukman | a964fe5 | 2004-08-09 18:37:04 +0000 | [diff] [blame] | 195 | <b>MacOS X/PowerPC</b> (requires dlcompat library):<br> |
| 196 | <b>AIX/PowerPC:</b> |
John Criswell | 5507284 | 2003-12-08 19:59:14 +0000 | [diff] [blame] | 197 | </p> |
| 198 | |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 199 | <pre> |
| 200 | % cd build |
Misha Brukman | a964fe5 | 2004-08-09 18:37:04 +0000 | [diff] [blame] | 201 | % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \ |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 202 | --disable-shared --enable-languages=c,c++ --program-prefix=llvm- |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 203 | % gmake all; gmake install |
| 204 | </pre> |
| 205 | |
Misha Brukman | 62a9343 | 2004-06-18 15:54:54 +0000 | [diff] [blame] | 206 | <p><b>Cygwin/x86:</b></p> |
Chris Lattner | 893c26a | 2004-06-02 19:27:50 +0000 | [diff] [blame] | 207 | |
| 208 | <pre> |
| 209 | % cd build |
Misha Brukman | a964fe5 | 2004-08-09 18:37:04 +0000 | [diff] [blame] | 210 | % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \ |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 211 | --disable-shared --enable-languages=c,c++ --disable-c-mbchar \ |
| 212 | --program-prefix=llvm- |
Chris Lattner | 893c26a | 2004-06-02 19:27:50 +0000 | [diff] [blame] | 213 | % gmake all; gmake install |
| 214 | </pre> |
| 215 | |
| 216 | <p><b>Solaris/SPARC:</b></p> |
John Criswell | 5507284 | 2003-12-08 19:59:14 +0000 | [diff] [blame] | 217 | |
| 218 | <p> |
John Criswell | af94d58 | 2005-05-13 20:54:44 +0000 | [diff] [blame] | 219 | The GCC front-end can be configured for either SPARC V8 (32 bit) or SPARC V9 (64 |
| 220 | bit). This changes, among other things, the sizes of integer types and the |
| 221 | macros defined for conditional compilation. |
| 222 | </p> |
| 223 | |
| 224 | <p> |
Chris Lattner | 23c5b3c | 2006-02-05 06:44:17 +0000 | [diff] [blame] | 225 | The SPARC V8 ABI support is more robust than the V9 ABI support and can generate |
| 226 | SPARC V9 code. It is highly recommended that you use the V8 ABI with LLVM, as |
| 227 | shown below. Also, |
Brian Gaeke | 7e9bd80 | 2004-01-28 20:54:41 +0000 | [diff] [blame] | 228 | note that Solaris has trouble with various wide (multibyte) character |
| 229 | functions from C as referenced from C++, so we typically configure with |
Reid Spencer | 05fe4b0 | 2006-03-14 05:39:39 +0000 | [diff] [blame] | 230 | --disable-c-mbchar (cf. <a href="http://llvm.org/PR206">Bug 206</a>). |
John Criswell | 5507284 | 2003-12-08 19:59:14 +0000 | [diff] [blame] | 231 | </p> |
| 232 | |
| 233 | <pre> |
| 234 | % cd build |
Brian Gaeke | 7e9bd80 | 2004-01-28 20:54:41 +0000 | [diff] [blame] | 235 | % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \ |
Chris Lattner | 23c5b3c | 2006-02-05 06:44:17 +0000 | [diff] [blame] | 236 | --disable-shared --enable-languages=c,c++ --host=sparc-sun-solaris2.8 \ |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 237 | --disable-c-mbchar --program-prefix=llvm- |
Brian Gaeke | 7e9bd80 | 2004-01-28 20:54:41 +0000 | [diff] [blame] | 238 | % gmake all; gmake install |
John Criswell | 5507284 | 2003-12-08 19:59:14 +0000 | [diff] [blame] | 239 | </pre> |
| 240 | |
Chris Lattner | e38c628 | 2003-10-23 03:55:23 +0000 | [diff] [blame] | 241 | <p><b>Common Problem:</b> You may get error messages regarding the fact |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 242 | that LLVM does not support inline assembly. Here are two common |
| 243 | fixes:</p> |
| 244 | |
| 245 | <ul> |
| 246 | <li><p><b>Fix 1:</b> If you have system header files that include |
| 247 | inline assembly, you may have to modify them to remove the inline |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 248 | assembly and install the modified versions in |
Chris Lattner | 3787405 | 2004-10-06 03:13:47 +0000 | [diff] [blame] | 249 | <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 250 | |
| 251 | <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we |
| 252 | haven't tried yet, you will probably have to edit the appropriate |
| 253 | version of atomicity.h under |
| 254 | <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code> |
Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 255 | and apply a patch so that it does not use inline assembly.</li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 256 | </ul> |
| 257 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 258 | <p><b>Porting to a new architecture:</b> If you are porting the front-end |
| 259 | to a new architecture or compiling in a configuration that we have |
| 260 | not tried previously, there are probably several changes you will have to make |
| 261 | to the GCC target to get it to work correctly. These include:<p> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 262 | |
| 263 | <ul> |
John Criswell | 6e35eda | 2004-11-29 21:46:29 +0000 | [diff] [blame] | 264 | <li>Often targets include special assembler or linker flags which |
Chris Lattner | e38c628 | 2003-10-23 03:55:23 +0000 | [diff] [blame] | 265 | <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can |
| 266 | just be removed.</li> |
| 267 | <li>LLVM currently does not support any floating point values other than |
| 268 | 32-bit and 64-bit IEEE floating point. The primary effect of this is |
| 269 | that you may have to map "long double" onto "double".</li> |
| 270 | <li>The profiling hooks in GCC do not apply at all to the LLVM front-end. |
| 271 | These may need to be disabled.</li> |
| 272 | <li>No inline assembly for position independent code. At the LLVM level, |
| 273 | everything is position independent.</li> |
| 274 | <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li> |
Chris Lattner | 13964e0 | 2003-10-24 16:02:34 +0000 | [diff] [blame] | 275 | <li>You may have to disable multilib support in your target. Using multilib |
| 276 | support causes the GCC compiler driver to add a lot of "<tt>-L</tt>" |
| 277 | options to the link line, which do not relate to LLVM and confuse |
| 278 | <tt>gccld</tt>. To disable multilibs, delete any |
| 279 | <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li> |
Chris Lattner | e38c628 | 2003-10-23 03:55:23 +0000 | [diff] [blame] | 280 | <li>Did we mention that we don't support inline assembly? You'll probably |
| 281 | have to add some fixinclude hacks to disable it in the system |
| 282 | headers.</li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 283 | </ul> |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 284 | </li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 285 | |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 286 | <li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment |
| 287 | variable.</p> |
| 288 | <ul> |
| 289 | <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li> |
| 290 | <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li> |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 291 | </ul> |
| 292 | </li> |
| 293 | |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 294 | <li><p>Go back into the LLVM source tree proper. Rerun configure, using |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 295 | the same options as the last time. This will cause the configuration to now find |
| 296 | the newly built llvm-gcc and llvm-g++ executables. </p></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 297 | |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 298 | <li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be |
| 299 | rebuilt, but it should build the runtime libraries. After the tree is |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 300 | built, install the runtime libraries into your GCC front-end build tree. |
Misha Brukman | 98558ae | 2005-03-01 17:15:23 +0000 | [diff] [blame] | 301 | These are the commands you need:</p> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 302 | <pre> |
Chris Lattner | 6a615ad | 2004-06-01 18:13:05 +0000 | [diff] [blame] | 303 | % gmake |
Reid Spencer | 3149ba7 | 2004-12-04 08:13:20 +0000 | [diff] [blame] | 304 | % gmake -C runtime install-bytecode |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 305 | </pre></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 306 | |
Reid Spencer | f99e59a | 2004-11-25 17:13:17 +0000 | [diff] [blame] | 307 | <li><p>Optionally, build a symbol table for the newly installed runtime |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 308 | libraries. Although this step is optional, you are strongly encouraged to |
| 309 | do this as the symbol tables will make a significant difference in your |
| 310 | link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p> |
Reid Spencer | f99e59a | 2004-11-25 17:13:17 +0000 | [diff] [blame] | 311 | <pre> |
| 312 | % cd $CFEINSTALL/lib |
| 313 | % llvm-ranlib libiberty.a |
| 314 | % llvm-ranlib libstdc++.a |
Chris Lattner | 302ed2a | 2004-12-01 04:16:29 +0000 | [diff] [blame] | 315 | % llvm-ranlib libsupc++.a |
Reid Spencer | cfaf80c | 2004-12-22 16:19:05 +0000 | [diff] [blame] | 316 | % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm |
Reid Spencer | f99e59a | 2004-11-25 17:13:17 +0000 | [diff] [blame] | 317 | % llvm-ranlib libgcc.a |
| 318 | % llvm-ranlib libgcov.a |
| 319 | </pre> |
| 320 | |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 321 | <li><p>Test the newly-installed C frontend by one or more of the |
| 322 | following means:</p> |
| 323 | <ul> |
Reid Spencer | 4ac30650 | 2004-12-22 06:40:29 +0000 | [diff] [blame] | 324 | <li> running the feature & regression tests via <tt>make check</tt></li> |
Chris Lattner | e38c628 | 2003-10-23 03:55:23 +0000 | [diff] [blame] | 325 | <li> compiling and running a "hello, LLVM" program in C and C++.</li> |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 326 | <li> running the tests found in the <tt>llvm-test</tt> CVS module</li> |
Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 327 | </ul></li> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 328 | </ol> |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 329 | </div> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 330 | |
| 331 | <!-- *********************************************************************** --> |
John Criswell | d000e1d | 2003-12-18 16:43:17 +0000 | [diff] [blame] | 332 | <div class="doc_section"> |
| 333 | <a name="license">License Information</a> |
| 334 | </div> |
| 335 | |
| 336 | <div class="doc_text"> |
| 337 | <p> |
| 338 | The LLVM GCC frontend is licensed to you under the GNU General Public License |
| 339 | and the GNU Lesser General Public License. Please see the files COPYING and |
| 340 | COPYING.LIB for more details. |
| 341 | </p> |
| 342 | |
| 343 | <p> |
Chris Lattner | 810ad8c | 2006-07-11 20:47:00 +0000 | [diff] [blame] | 344 | More information is <a href="FAQ.html#license">available in the FAQ</a>. |
John Criswell | d000e1d | 2003-12-18 16:43:17 +0000 | [diff] [blame] | 345 | </p> |
John Criswell | d000e1d | 2003-12-18 16:43:17 +0000 | [diff] [blame] | 346 | </pre> |
| 347 | </div> |
| 348 | |
| 349 | <!-- *********************************************************************** --> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 350 | |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 351 | <hr> |
Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 352 | <address> |
| 353 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
| 354 | src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a> |
| 355 | <a href="http://validator.w3.org/check/referer"><img |
| 356 | src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> |
| 357 | |
| 358 | Brian Gaeke<br> |
Reid Spencer | 05fe4b0 | 2006-03-14 05:39:39 +0000 | [diff] [blame] | 359 | <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> |
Misha Brukman | b9e5789 | 2003-10-28 21:09:29 +0000 | [diff] [blame] | 360 | Last modified: $Date$ |
Misha Brukman | 6a2b310 | 2004-05-12 18:49:47 +0000 | [diff] [blame] | 361 | </address> |
Brian Gaeke | 46079d2 | 2003-10-21 21:58:38 +0000 | [diff] [blame] | 362 | |
Misha Brukman | 83bd33a | 2003-10-23 01:48:33 +0000 | [diff] [blame] | 363 | </body> |
| 364 | </html> |