Fixed a comma error.
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <link rel="stylesheet" href="llvm.css" type="text/css">
6   <title>LLVM 1.1 Release Notes</title>
7 </head>
8 <body>
9
10 <div class="doc_title">
11   LLVM 1.1 Release Notes
12 </div>
13  
14 <ol>
15   <li><a href="#intro">Introduction</a></li>
16   <li><a href="#whatsnew">What's New?</a></li>
17   <li><a href="#portability">Portability and Supported Platforms</a></li>
18   <li><a href="#install-instructions">Installation Instructions</a></li>
19   <li><a href="#knownproblems">Known Problems</a>
20   <ul>
21 <!--    <li><a href="#portabilityprobs">Portability Problems</a> -->
22     <li><a href="#core">Known problems with the LLVM Core</a>
23     <li><a href="#c-fe">Known problems with the C Front-end</a>
24     <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
25     <li><a href="#x86-be">Known problems with the X86 Back-end</a>
26     <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
27     <li><a href="#c-be">Known problems with the C back-end</a>
28   </ul></li>
29   <li><a href="#additionalinfo">Additional Information</a></li>
30 </ol>
31
32 <div class="doc_text">
33   <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></b><p>
34 </div>
35
36 <!-- *********************************************************************** -->
37 <div class="doc_section">
38   <a name="intro">Introduction</a>
39 </div>
40 <!-- *********************************************************************** -->
41
42 <div class="doc_text">
43
44 <p>This document contains the release notes for the LLVM compiler
45 infrastructure, release 1.1.  Here we describe the status of LLVM, including any
46 known problems, and bug fixes from the previous release.  The most up-to-date
47 version of this document can be found on the <a
48 href="http://llvm.cs.uiuc.edu/releases/1.1/">LLVM 1.1 web site</a>.  If you are
49 not reading this on the LLVM web pages, you should probably go there, because
50 this document may be updated after the release.</p>
51
52 <p>For more information about LLVM, including information about potentially more
53 current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
54 web site</a>.  If you have questions or comments, the <a
55 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
56 list</a> is a good place to send them.</p>
57
58 <p>Note that if you are reading this file from CVS, that this document applies
59 to the <i>next</i> release, not the previous one.  To see the release notes for
60 the previous release, see the <a
61 href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
62
63 </div>
64
65 <!-- *********************************************************************** -->
66 <div class="doc_section">
67   <a name="whatsnew">What's New?</a>
68 </div>
69 <!-- *********************************************************************** -->
70
71 <div class="doc_text">
72
73 <p>This is the second public release of the LLVM compiler infrastructure.  This
74 release is primarily a bugfix release, dramatically improving the C/C++
75 front-end, and improving support for C++ in the LLVM core.  This release also
76 includes a few new features, such as a simple profiler, support for Mac OS/X,
77 and better interoperability with external source bases.</p>
78
79 <p>At this time, LLVM is known to correctly compile the SPEC CPU2000 benchmarks
80 (X86 only), the Olden benchmarks, and the Ptrdist benchmarks along with
81 <b>many</b> other programs.  LLVM now also works with a fairly broad variety of
82 C++ programs, though it has still received much less testing than the C
83 front-end.
84 </p>
85
86 <p>
87 Note that the Sparc and X86 backends do not currently support exception throwing
88 or long jumping (including 253.perlbmk in SPEC).  For these programs, you must
89 use the C backend.  Support for unwinding will be added in a future release.
90 </p>
91
92
93 <!--=========================================================================-->
94 <div class="doc_subsubsection">
95 This release implements the following new features:
96 </div>
97
98 <ol>
99 <li><a
100 href="http://mail.cs.uiuc.edu/pipermail/llvmdev/2003-November/000528.html">A new
101 LLVM profiler, similar to gprof</a> is available</li>
102
103 <li>LLVM and the C/C++ front-end now compile on Mac OS/X!  Mac OS/X users can
104 now explore the LLVM optimizer with the C backend (note that LLVM requires GCC
105 3.3 on Mac OS/X).</li>
106
107 <li>LLVM has been <a
108 href="http://mail.cs.uiuc.edu/pipermail/llvmdev/2003-November/000554.html">moved
109 into an 'llvm' C++ namespace</a>, for easier integration with third-party
110 code. Note that lack of namespace handling in GDB 5.x, you will probably want to
111 upgrade to GDB 6 or better to debug LLVM code.</li>
112
113 <li>
114 The build system now copies Makefiles dynamically from the source tree to the
115 object tree as subdirectories are built.  This means that:
116   <ol>
117   <li>
118   New directories can be added to the source tree, and the build will
119   automatically pick them up (i.e. no need to re-run <tt>configure</tt>).
120   </li>
121
122   <li>
123   You will need to build LLVM from the top of the object tree once to ensure
124   that all of the Makefiles are copied into the object tree subdirectories.
125   </li>
126   </ol>
127 </li>
128
129 <li>
130 The <tt>configure</tt> script will now configure all projects placed in the
131 <tt>llvm/projects</tt> directory.
132 </li>
133 </ol>
134
135
136 <!--=========================================================================-->
137 <div class="doc_subsubsection">
138 In this release, the following missing features were implemented:
139 </div>
140
141 <ol>
142 <li><a href="http://llvm.cs.uiuc.edu/PR88">The interpreter does not support
143 invoke or unwind</a></li>
144
145 <li><a href="http://llvm.cs.uiuc.edu/PR99">Interpreter does not support the
146 <tt>vaarg</tt> instruction</a></li>
147
148 <li><a href="http://llvm.cs.uiuc.edu/PR117">llvm-nm cannot read archive
149 files</a></li>
150
151 </ol>
152
153
154 <!--=========================================================================-->
155 <div class="doc_subsubsection">
156 In this release, the following Quality of Implementation issues were
157 fixed:
158 </div>
159
160 <ol>
161
162 <li><a href="http://llvm.cs.uiuc.edu/PR29">C++ front-end is not generating
163 linkonce linkage type when it can</a></li>
164
165 <li><a href="http://llvm.cs.uiuc.edu/PR84">C front-end doesn't emit
166 getelementptr for address of array element</a></li>
167
168 <li><a href="http://llvm.cs.uiuc.edu/PR96">Bad path to the C/C++ frontend causes
169 build problems</a></li>
170
171 <li><a href="http://llvm.cs.uiuc.edu/PR114">LLVM header files should be -Wold-style-cast clean</a></li>
172
173 <li>The LLVM bytecode reader has been <a
174 href="http://llvm.cs.uiuc.edu/PR127">sped up a lot</a> (up to 4x in some
175 cases).</li>
176
177 <li>Methods and functions in anonymous namespaces <a href="http://llvm.cs.uiuc.edu/PR85">now get internal linkage</a>.</li>
178
179 <li>Constant initializers now generate loops instead of potentially <a href="http://llvm.cs.uiuc.edu/PR75">huge amounts of straight-line code</a>.</li>
180
181 <li>Code for running C++ destructors is now properly shared when possible.  Before, the C++ front-end
182 <a href="http://llvm.cs.uiuc.edu/PR11">generated N^2 amounts of duplicated cleanup code</a> in some cases.</li>
183 </ol>
184
185
186 <!--=========================================================================-->
187 <div class="doc_subsubsection">
188 In this release, the following bugs in the previous release were fixed:
189 </div>
190
191 <p>Bugs in the LLVM Core:</p>
192
193 <ol>
194 <li><a href="http://llvm.cs.uiuc.edu/PR57">[inliner] Inlining invoke with PHI in unwind target is broken</a></li>
195 <li><a href="http://llvm.cs.uiuc.edu/PR58">[linker] linkonce globals should link successfully to external globals</a></li>
196 <li><a href="http://llvm.cs.uiuc.edu/PR64">[constmerge] Constant merging pass merges constants with external linkage</a></li>
197 <li><a href="http://llvm.cs.uiuc.edu/PR66">[scalarrepl] Scalar Replacement of aggregates is decimating structures it shouldn't be</a></li>
198 <li><a href="http://llvm.cs.uiuc.edu/PR70">[instcombine] Resolving invoke inserts cast after terminator</a></li>
199 <li><a href="http://llvm.cs.uiuc.edu/PR71">llvm-as crashes when labels are used in phi nodes</a></li>
200 <li><a href="http://llvm.cs.uiuc.edu/PR72">[build problem] Callgraph.cpp not pulled in from libipa.a</a></li>
201 <li><a href="http://llvm.cs.uiuc.edu/PR77">Variables in scope of output setjmp
202 calls should be volatile</a> (Note that this does not effect correctness on
203 many platforms, such as X86).</li>
204 <li><a href="http://llvm.cs.uiuc.edu/PR83">[X86] Emission of global bool initializers broken</a></li>
205 <li><a href="http://llvm.cs.uiuc.edu/PR91">[gccld] The -r (relinking) option does not work correctly</a></li>
206 <li><a href="http://llvm.cs.uiuc.edu/PR92">[bcreader] Cannot read shift constant expressions from bytecode file</a></li>
207 <li><a href="http://llvm.cs.uiuc.edu/PR93">[lowersetjmp] Lowersetjmp pass breaks dominance properties!</a></li>
208 <li><a href="http://llvm.cs.uiuc.edu/PR95">SymbolTable::getUniqueName is very inefficient</a></li>
209 <li><a href="http://llvm.cs.uiuc.edu/PR98">[buildscripts] Building into objdir with .o in it fails</a></li>
210 <li><a href="http://llvm.cs.uiuc.edu/PR101">[setjmp/longjmp] Linking C programs which use setjmp/longjmp sometimes fail with references to the C++ runtime library!</a></li>
211 <li><a href="http://llvm.cs.uiuc.edu/PR107">AsmParser Misses Symbol Redefinition Error</a></li>
212 <li><a href="http://llvm.cs.uiuc.edu/PR108">gccld -Lfoo -lfoo fails to find ./foo/libfoo.a</a></li>
213 <li><a href="http://llvm.cs.uiuc.edu/PR110">[bcreader] Incorrect cast causes misread forward constant references</a></li>
214 <li><a href="http://llvm.cs.uiuc.edu/PR116">[adce] ADCE considers blocks without postdominators to be unreachable</a></li>
215 <li><a href="http://llvm.cs.uiuc.edu/PR123">[X86] div and rem constant exprs invalidate iterators!</a></li>
216 <li><a href="http://llvm.cs.uiuc.edu/PR130">[vmcore] Symbol table doesn't rename colliding variables during type resolution</a></li>
217 <li><a href="http://llvm.cs.uiuc.edu/PR97">bugpoint must not pass -R&lt;directory&gt; to Mach-O linker</a></li>
218 <li><a href="http://llvm.cs.uiuc.edu/PR140">gccld produces a runner script that includes command-line options to load the necessary shared objects</a></li>
219 </ol>
220
221
222 <p>Bugs in the C/C++ front-end:</p>
223
224 <ol>
225 <li><a href="http://llvm.cs.uiuc.edu/PR59">C++ frontend can crash when compiling virtual base classes</a></li>
226 <li><a href="http://llvm.cs.uiuc.edu/PR62">C backend fails on constant cast expr to ptr-to-anonymous struct</a></li>
227 <li><a href="http://llvm.cs.uiuc.edu/PR63">#ident is not recognized by C frontend</a></li>
228 <li><a href="http://llvm.cs.uiuc.edu/PR65">C front-end miscompiles the builtin_expect intrinsic!</a></li>
229 <li><a href="http://llvm.cs.uiuc.edu/PR67">1.0 precompiled libstdc++ does not include wchar_t support</a></li>
230 <li><a href="http://llvm.cs.uiuc.edu/PR68">llvmgcc asserts when compiling functions renamed with asm's</a></li>
231 <li><a href="http://llvm.cs.uiuc.edu/PR69">C frontend crashes on some programs with lots of types.</a></li>
232 <li><a href="http://llvm.cs.uiuc.edu/PR79">llvm-gcc crashes compiling global union initializer</a></li>
233 <li><a href="http://llvm.cs.uiuc.edu/PR80">C front-end crash on empty structure</a></li>
234 <li><a href="http://llvm.cs.uiuc.edu/PR81">CFrontend crashes when compiling C99 compound expressions</a></li>
235 <li><a href="http://llvm.cs.uiuc.edu/PR87">llvm-gcc infinite loops on "case MAXINT:"</a></li>
236 <li><a href="http://llvm.cs.uiuc.edu/PR89">[C++] Catch blocks make unparsable labels</a></li>
237 <li><a href="http://llvm.cs.uiuc.edu/PR90">[C++] Initializing array with constructable objects fail</a></li>
238 <li><a href="http://llvm.cs.uiuc.edu/PR94">llvm-gcc tries to add bools</a></li>
239 <li><a href="http://llvm.cs.uiuc.edu/PR104">[c++] C++ Frontend lays out superclasses like anonymous bitfields!</a></li>
240 <li><a href="http://llvm.cs.uiuc.edu/PR54">C front-end miscompiles unsigned enums whose LLVM types are signed</a></li>
241 <li><a href="http://llvm.cs.uiuc.edu/PR112">Casting a string constant to void crashes llvm-gcc</a></li>
242 <li><a href="http://llvm.cs.uiuc.edu/PR125">[llvmg++] Enum types are incorrectly shrunk to smaller than 'int' size</a></li>
243 <li><a href="http://llvm.cs.uiuc.edu/PR128">[llvmg++] Cannot use pointer to member to initialize global</a></li>
244 <li><a href="http://llvm.cs.uiuc.edu/PR131">[llvm-gcc] ?: operator as lvalue not implemented</a></li>
245 <li><a href="http://llvm.cs.uiuc.edu/PR133">[C/C++] Bogus warning about taking the address of 'register' variable</a></li>
246 <li><a href="http://llvm.cs.uiuc.edu/PR113">crash assigning into an array in a struct which contains a bitfield</a>.</li>
247 <li><a href="http://llvm.cs.uiuc.edu/PR6">Oversized integer bitfields cause crash</a></li>
248 <li><a href="http://llvm.cs.uiuc.edu/PR141">[llvm-gcc] Bitfields &amp; large array don't mix well</a></li>
249 <li><a href="http://llvm.cs.uiuc.edu/PR132">[llvm-gcc] Complex division is not supported</a></li>
250 <li><a href="http://llvm.cs.uiuc.edu/PR143">[llvm-gcc] Illegal union field reference</a></li>
251 <li><a href="http://llvm.cs.uiuc.edu/PR148">[llvmg++] Front-end attempts to return structure by value</a></li>
252 <li><a href="http://llvm.cs.uiuc.edu/PR152">[llvmg++] Pointer to member initializers not supported in constructors</a></li>
253 <li><a href="http://llvm.cs.uiuc.edu/PR155">[llvm-gcc] crash on union initialization</a></li>
254 <li><a href="http://llvm.cs.uiuc.edu/PR124">[llvm-g++] ?: expressions do not run correct number of destructors!</a></li>
255 <li><a href="http://llvm.cs.uiuc.edu/PR157">[llvm-gcc] Pointer & constant results in invalid shift</a></li>
256 <li><a href="http://llvm.cs.uiuc.edu/PR165">[llvmg++] call through array of pointers to member functions causes assertion</a></li>
257 </ol>
258
259 </div>
260
261 <!-- *********************************************************************** -->
262 <div class="doc_section">
263   <a name="portability">Portability and Supported Platforms</a>
264 </div>
265 <!-- *********************************************************************** -->
266
267 <div class="doc_text">
268
269 <p>LLVM has been extensively tested on Intel and AMD machines running Red
270 Hat Linux, and Sun UltraSPARC workstations running Solaris 8.  Additionally, 
271 LLVM works on Mac OS/X 10.3 and above, but only with the C back-end (no native
272 backend for the PowerPC is available yet).
273 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
274 work on more platforms than that.  However, it is likely that we
275 missed something, and that minor porting is required to get LLVM to work on 
276 new platforms.  We welcome portability patches and error messages.</p>
277
278 </div>
279
280 <!-- *********************************************************************** -->
281 <div class="doc_section">
282   <a name="knownproblems">Known Problems</a>
283 </div>
284 <!-- *********************************************************************** -->
285
286 <div class="doc_text">
287
288 <p>This section contains all known problems with the LLVM system, listed by
289 component.  As new problems are discovered, they will be added to these
290 sections.</p>
291
292 </div>
293
294 <!-- _______________________________________________________________________ -->
295 <!--
296 </ul><h4><a name="portability"><hr size=0>Portability Problems</h4><ul>
297 -->
298
299
300 <!-- ======================================================================= -->
301 <div class="doc_subsection">
302   <a name="core">Known problems with the LLVM Core</a>
303 </div>
304
305 <div class="doc_text">
306
307 <ul>
308
309 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
310 work.</li>
311
312 <li>The JIT does not use mutexes to protect its internal data structures.  As
313 such, execution of a threaded program could cause these data structures to be
314 corrupted.</li>
315
316 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
317
318 <li>Linking in static archive files (.a files) is very slow (there is no symbol
319 table in the archive).</li>
320
321 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
322 more than 256 elements</a>.</li>
323
324 </ul>
325
326 </div>
327
328 <!-- ======================================================================= -->
329 <div class="doc_subsection">
330   <a name="c-fe">Known problems with the C front-end</a>
331 </div>
332
333 <!-- _______________________________________________________________________ -->
334 <div class="doc_subsubsection">
335   Bugs
336 </div>
337
338 <div class="doc_text">
339
340 <ul>
341
342 <li>C99 Variable sized arrays do not release stack memory when they go out of 
343     scope.  Thus, the following program may run out of stack space:
344 <pre>
345     for (i = 0; i != 1000000; ++i) {
346       int X[n];
347       foo(X);
348     }
349 </pre></li>
350
351 </ul>
352
353 </div>
354
355 <!-- _______________________________________________________________________ -->
356 <div class="doc_subsubsection">
357   Notes
358 </div>
359
360 <div class="doc_text">
361
362 <ul>
363
364 <li>Inline assembly is not yet supported.</li>
365
366 <li>"long double" is transformed by the front-end into "double".  There is no
367 support for floating point data types of any size other than 32 and 64
368 bits.</li>
369     
370 <li>The following Unix system functionality has not been tested and may not
371 work:
372   <ol>
373   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
374       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
375       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
376   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
377       - These functions have not been tested.
378   </ol></li>
379
380 <li>Although many GCC extensions are supported, some are not.  In particular,
381     the following extensions are known to <b>not be</b> supported:
382   <ol>
383   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
384   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">Labels as Values</a>: Getting pointers to labels, and computed gotos.</li>
385   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>: As in Algol and Pascal, lexical scoping of functions.</li>
386   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
387   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html#Extended%20Asm">Extended Asm</a>: Assembler instructions with C expressions as operands.</li>
388   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands</li>
389   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Asm-Labels.html#Asm%20Labels">Asm Labels</a>: Specifying the assembler name to use for a C symbol.</li>
390   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Explicit-Reg-Vars.html#Explicit%20Reg%20Vars">Explicit Reg Vars</a>: Defining variables residing in specified registers.</li>
391   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Return-Address.html#Return%20Address">Return Address</a>: Getting the return or frame address of a function.</li>
392   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Vector-Extensions.html#Vector%20Extensions">Vector Extensions</a>: Using vector instructions through built-in functions.</li>
393   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Target-Builtins.html#Target%20Builtins">Target Builtins</a>:   Built-in functions specific to particular targets.</li>
394   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
395   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
396   </ol>
397
398   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
399   attribute means that the LLVM compiler ignores the presence of the attribute,
400   but the code should still work.  An unsupported attribute is one which is
401   ignored by the LLVM compiler, which will cause a different interpretation of
402   the program.</p>
403
404   <ol>
405   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
406       Arrays whose length is computed at run time.<br>
407       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
408
409   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
410
411       Declaring that functions have no side effects, or that they can never
412       return.<br>
413
414       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
415       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
416       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
417
418       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
419       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
420       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
421
422       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
423       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
424       <tt>fastcall</tt>, all other target specific attributes</li>
425    
426   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
427       Specifying attributes of variables.<br>
428       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
429                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
430                         <tt>unused</tt>, <tt>weak</tt><br>
431
432       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
433                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
434                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
435                         <tt>dllexport</tt>, all target specific attributes.</li>
436
437   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types. 
438       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
439                         <tt>deprecated</tt>, <tt>may_alias</tt>
440
441       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
442                         all target specific attributes.</li>
443
444   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
445       Other built-in functions.<br>
446       We support all builtins which have a C language equivalent (e.g., 
447          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
448          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
449          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
450
451   </ol>
452
453   <p>The following extensions <b>are</b> known to be supported:</p>
454
455   <ol>
456   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
457   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Typeof.html#Typeof">Typeof</a>: <code>typeof</code>: referring to the type of an expression.</li>
458   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
459   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
460   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
461   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
462   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
463   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
464   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
465   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variadic-Macros.html#Variadic%20Macros">Variadic Macros</a>: Macros with a variable number of arguments.</li>
466   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
467   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue.</li>
468   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html#Pointer%20Arith">Pointer Arith</a>:Arithmetic on <code>void</code>-pointers and function pointers.</li>
469   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
470   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions or arrays as values.</li>
471   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
472   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Cast-to-Union.html#Cast%20to%20Union">Cast to Union</a>:Casting to union type from any member of the union.</li>
473   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
474   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
475   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
476   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
477   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
478   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Character-Escapes.html#Character%20Escapes">Character Escapes</a>: <code>\e</code> stands for the character &lt;ESC&gt;.</li>
479   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
480   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
481   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alternate-Keywords.html#Alternate%20Keywords">Alternate Keywords</a>:<code>__const__</code>, <code>__asm__</code>, etc., for header files.</li>
482   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Incomplete-Enums.html#Incomplete%20Enums">Incomplete Enums</a>:  <code>enum foo;</code>, with details to follow.</li>
483   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Names.html#Function%20Names">Function Names</a>: Printable strings which are the name of the current function.</li>
484   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Unnamed-Fields.html#Unnamed%20Fields">Unnamed Fields</a>: Unnamed struct/union fields within structs/unions.</li>
485   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
486   </ol></li>
487
488 </ul>
489
490 <p>If you run into GCC extensions which have not been included in any of these
491 lists, please let us know (also including whether or not they work).</p>
492
493 </div>
494
495 <!-- ======================================================================= -->
496 <div class="doc_subsection">
497   <a name="c++-fe">Known problems with the C++ front-end</a>
498 </div>
499
500 <div class="doc_text">
501
502 <p>For this release, the C++ front-end is considered to be fully functional but
503 of <b>beta</b> quality.  It has been tested and works for a number of simple
504 programs that collectively exercise most of the language.  Nevertheless, it has
505 not been in use as long as the C front-end.  Please report any bugs or
506 problems.</p>
507
508 </div>
509
510 <!-- _______________________________________________________________________ -->
511 <div class="doc_subsubsection">
512   Bugs
513 </div>
514
515 <div class="doc_text">
516
517 <ul>
518 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
519     front-end</a></li>
520 </ul>
521
522 </div>
523
524 <!-- _______________________________________________________________________ -->
525 <div class="doc_subsubsection">
526   Notes
527 </div>
528
529 <div class="doc_text">
530
531 <ul>
532
533 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
534 parser is significantly more standards compliant (and picky) than prior GCC
535 versions.  For more information, see the C++ section of the <a
536 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.<p>
537
538 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
539     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
540     function and in the <tt>setjmp</tt> receiver function may not be run.
541     Objects in intervening stack frames will be destroyed however (which is
542     better than most compilers).</li>
543
544 <li>The LLVM C++ front-end follows the <a
545     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
546     This document, which is not Itanium specific, specifies a standard for name
547     mangling, class layout, v-table layout, RTTI formats, and other C++
548     representation issues.  Because we use this API, code generated by the LLVM
549     compilers should be binary compatible with machine code generated by other
550     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
551     <i>However</i>, the exception handling mechanism used by LLVM is very
552     different from the model used in the Itanium ABI, so <b>exceptions will not
553     interact correctly</b>. </li>
554
555 </ul>
556
557 </div>
558
559 <!-- ======================================================================= -->
560 <div class="doc_subsection">
561   <a name="x86-be">Known problems with the X86 back-end</a>
562 </div>
563
564 <div class="doc_text">
565
566 <ul>
567
568 <li>The X86 code generator <a
569 href="http://llvm.cs.uiuc.edu/PR16">does not currently
570 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
571 or calls the C <tt>longjmp</tt> function will abort.</li>
572
573 </ul>
574
575 </div>
576
577 <!-- ======================================================================= -->
578 <div class="doc_subsection">
579   <a name="sparc-be">Known problems with the Sparc back-end</a>
580 </div>
581
582 <div class="doc_text">
583
584 <ul>
585
586 <li>The Sparc code generator <a
587 href="http://llvm.cs.uiuc.edu/PR15">does not currently
588 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
589 or calls the C <tt>longjmp</tt> function will abort.</li>
590
591 </ul>
592
593 </div>
594
595 <!-- ======================================================================= -->
596 <div class="doc_subsection">
597   <a name="c-be">Known problems with the C back-end</a>
598 </div>
599
600 <div class="doc_text">
601
602 <ul>
603
604 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
605 Analysis rules.  As such, special options may be necessary to compile the code
606 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
607 problem probably cannot be fixed.</li>
608
609 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
610 cannot include special floating point numbers like Not-A-Number or
611 Infinity.</li>
612
613 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
614 supported</a>.  This should not affect LLVM produced by the C or C++ 
615 frontends.</li>
616
617 </ul>
618
619 </div>
620
621 <!-- *********************************************************************** -->
622 <div class="doc_section">
623   <a name="additionalinfo">Additional Information</a>
624 </div>
625 <!-- *********************************************************************** -->
626
627 <div class="doc_text">
628
629 <p>A wide variety of additional information is available on the LLVM web page,
630 including mailing lists publications describing algorithms and components
631 implemented in LLVM.  The web page also contains versions of the API
632 documentation which is up-to-date with the CVS version of the source code.  You
633 can access versions of these documents specific to this release by going into
634 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
635
636 <p>If you have any questions or comments about LLVM, please feel free to contact
637 us via the mailing lists.</p>
638
639 </div>
640
641 <!-- *********************************************************************** -->
642
643 <hr>
644 <address>
645   <a href="http://jigsaw.w3.org/css-validator/"><img
646   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
647   <a href="http://validator.w3.org/check/referer"><img
648   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
649
650   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
651   Last modified: $Date$
652 </address>
653
654 </body>
655 </html>