6d8bcc58f0734f572579509969cdba2219a3fcfc
[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.2 Release Notes</title>
7 </head>
8 <body>
9
10 <div class="doc_title">
11   LLVM 1.2 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="#experimental">Experimental features included with this release</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 the <a href="http://llvm.cs.uiuc.edu">LLVM team</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.2.  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.2/">LLVM 1.2 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, this document applies
59 to the <i>next</i> release, not the current one.  To see the release notes for
60 the current or previous releases, 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>
74 This is the third public release of the LLVM compiler infrastructure.  This
75 release incorporates several <a href="#newfeatures">new features</a> (including
76 exception handling support for the native code generators, the start of a
77 source-level debugger, and profile guided optimizer components), many <a
78 href="#qualityofimp">speedups</a> and <a href="#codequality">code quality</a>
79 improvements, documentation improvements, and a small collection of important <a
80 href="bugfix">bug fixes</a>.  Overall, this is our highest quality release to
81 date, and we encourage you to upgrade if you are using LLVM 1.0 or 1.1.
82 </p>
83
84 <p>
85 At this time, LLVM is known to correctly compile and run all C &amp; C++ SPEC
86 CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks.  It has
87 also been used to compile <b>many</b> other programs.  LLVM now also works with
88 a broad variety of C++ programs, though it has still received less testing than
89 the C front-end.
90 </p>
91
92 <!--=========================================================================-->
93 <div class="doc_subsubsection">
94 <a name="newfeatures">This release implements the following new features:</a>
95 </div>
96
97 <ol>
98 <li><a href="SourceLevelDebugging.html">A new LLVM source-level debugger has been started.</a></li>
99 <li>LLVM 1.2 encodes bytecode files for large programs in 10-30% less space.</li>
100 <li>LLVM can now feed profile information back into optimizers for Profile Guided Optimization, includes a simple basic block reordering pass, and supports edge profiling as well as function and block-level profiling.</li>
101 <li>The LLVM JIT lazily initializes global variables, reducing startup time for programs with lots of globals (like C++ programs).</li>
102
103 <li>The build and installation infrastructure in this release is dramatically
104 improved. There is now an <a
105 href="http://llvm.cs.uiuc.edu/PR105"><tt>autoconf/AutoRegen.sh</tt> script</a>
106 that you can run to rebuild the <tt>configure</tt> script and its associated
107 files as well as beta support for "<a
108 href="http://llvm.cs.uiuc.edu/PR208">make</a> <a
109 href="http://llvm.cs.uiuc.edu/PR220">install</a>" and <a
110 href="http://llvm.cs.uiuc.edu/PR203">RPM package generation</a>.</li>
111
112 <li>The "tblgen" tool is <a href="TableGenFundamentals.html">now documented</a>.</li>
113 <li>The target-independent code generator got several improvements:
114 <ul>
115   <li>It can now fold spill code into instructions (on targets that support it).</li>
116   <li>A generic machine code spiller/rewriter was added. It provides an API for
117       global register allocators to eliminate virtual registers and add the
118       appropriate spill code.</li>
119   <li>The represenation of machine code basic blocks is more efficient and has
120       an easier to use interface.</li>
121 </ul>
122 </li>
123 <li><a href="http://llvm.cs.uiuc.edu/PR253">LLVM now no longer depends on the boost library</a>.</li>
124 <li>The X86 backend now generates <b>substantially</b> better native code, and is faster.</li>
125 <li>The C backend has been turned moved from the "llvm-dis" tool to the "llc"
126 tool.  You can activate it with "<tt>llc -march=c foo.bc -o foo.c</tt>".</li>
127 <li>LLVM includes a new interprocedural optimization that marks global variables
128 "constant" when they are provably never written to.</li>
129 <li>LLVM now includes a new interprocedural optimization that converts small "by reference" arguments to "by value" arguments, which is often improve the performance of C++ programs substantially.</li>
130 <li>Bugpoint can now do a better job reducing miscompilation problems by
131 reducing programs down to a particular loop nest, instead of just the function
132 being miscompiled.</li>
133 <li>The GCSE and LICM passes can now operate on side-effect-free function calls, for example hoisting calls to "<tt>strlen</tt>" and folding "<tt>cos</tt>" common subexpressions.</li>
134 <li>LLVM has early support for a new <a
135 href="LangRef.html#i_select"><tt>select</tt></a> instruction, though it is
136 currently only supported by the C backend.</li>
137 </ol>
138
139
140 <!--=========================================================================-->
141 <div class="doc_subsubsection">
142 In this release, the following missing features were implemented:
143 </div>
144
145 <ol>
146 <li><a href="http://llvm.cs.uiuc.edu/PR16">Exception handling in the X86
147 &amp; Sparc native code generators</a> is now supported</li>
148 <li>The C/C++ front-end now support the GCC <tt>__builtin_return_address</tt> and <tt>__builtin_frame_address</tt> extensions.  These are also supported by the X86 backend and by the C backend.</li>
149 <li><a href="http://llvm.cs.uiuc.edu/PR249">[X86] Missing cast from ULong -> Double, cast FP -> bool and support for -9223372036854775808</a></li>
150 <li>The C/C++ front-end <a href="http://llvm.cs.uiuc.edu/PR273">now supports</a>
151 the "<a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">labels as values</a>" GCC extension, often used to build "threaded interpreters".</a></li>
152
153 </ol>
154
155
156 <!--=========================================================================-->
157 <div class="doc_subsubsection">
158 <a name="qualityofimp">In this release, the following Quality of Implementation issues were fixed:</a>
159 </div>
160
161 <ol>
162
163 <li><a href="http://llvm.cs.uiuc.edu/PR135">JIT should lazily initialize global variables</a></li>
164 <li><a href="http://llvm.cs.uiuc.edu/PR192">[X86] X86 Backend never releases memory for machine code structures</a></li>
165 <li><a href="http://llvm.cs.uiuc.edu/PR196">[vmcore] OpaqueType objects memory leak</a></li>
166 <li><a href="http://llvm.cs.uiuc.edu/PR182">[llvmgcc] C front-end does not compile "extern inline" into linkonce</a></li>
167 <li><a href="http://llvm.cs.uiuc.edu/PR73">Bytecode format inconsistent</a></li>
168 <li><a href="http://llvm.cs.uiuc.edu/PR209">[loadvn/inline/scalarrepl] Slow optimizations with extremely large basic blocks</a></li>
169 <li><a href="http://llvm.cs.uiuc.edu/PR224">[asmparser] Really slow parsing of types with complex upreferences</a></li>
170 <li><a href="http://llvm.cs.uiuc.edu/PR205">[llvmgcc] C front-end does not emit 'zeroinitializer' when possible</a></li>
171 <li><a href="http://llvm.cs.uiuc.edu/PR233">[llvmgcc] Structure copies result in a LOT of code</a></li>
172 <li><a href="http://llvm.cs.uiuc.edu/PR239">LLVM is now much more memory efficient when handling large zero initialized arrays</a></li>
173 <li><a href="http://llvm.cs.uiuc.edu/PR275">[llvmgcc] Local array initializers are expanded into large amounts of code</a></li>
174 </ol>
175
176 <!--=========================================================================-->
177 <div class="doc_subsubsection">
178 In this release, the following build problems were fixed:
179 </div>
180
181 <ol>
182 <li><a href="http://llvm.cs.uiuc.edu/PR210">[build] Makefiles break if C frontend target string has unexpected value</a></li>
183 <li><a href="http://llvm.cs.uiuc.edu/PR214">[build] hard-wired assumption that shared-library extension is ".so"</a></li>
184 <li><A href="http://llvm.cs.uiuc.edu/PR222">make tools-only doesn't make lib/Support</a></li>
185 </ol>
186
187 <!--=========================================================================-->
188 <div class="doc_subsubsection">
189 <a name="codequality">In this release, the following Code Quality issues were fixed:</a>
190 </div>
191
192 <ol>
193 <li><a href="http://llvm.cs.uiuc.edu/PR187">[loopsimplify] Many pointless phi nodes are created</a></li>
194 <li><a href="http://llvm.cs.uiuc.edu/PR237">[x86] wierd stack/frame pointer manipulation</a></li>
195
196 <li>The X86 backend now generate <tt>fchs</tt> to negate floating point numbers,
197 compiles memcpy() into the <tt>rep movs</tt> instruction, and makes much better
198 use of powerful addressing modes and instructions.</li>
199 </ol>
200
201
202 <!--=========================================================================-->
203 <div class="doc_subsubsection">
204 <a name="bugfix">In this release, the following bugs in the previous release were fixed:</a>
205 </div>
206
207 <p>Bugs in the LLVM Core:</p>
208
209 <ol>
210 <li><a href="http://llvm.cs.uiuc.edu/PR179">[licm] LICM promotes volatile memory
211 locations to registers</a></li>
212 <li><a href="http://llvm.cs.uiuc.edu/PR191">[licm] Memory read after free causes 
213 infrequent crash</a></li>
214 <li><a href="http://llvm.cs.uiuc.edu/PR194">[indvars] Induction variable 
215 canonicalization always makes 32-bit indvars</a></li>
216 <li><a href="http://llvm.cs.uiuc.edu/PR193">[constantmerge] Merging globals can
217 cause use of invalid pointers!</a></li>
218 <li><a href="http://llvm.cs.uiuc.edu/PR212">[bcreader] Bytecode reader misreads 'long -9223372036854775808'!</a></li>
219 <li><a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=174">Tail duplication does not update SSA form correctly.</a></li>
220 <li><a href="http://llvm.cs.uiuc.edu/PR218">VMCore mishandles double -0.0</a></li>
221 <li><a href="http://llvm.cs.uiuc.edu/PR219">[X86] X86 backend code generates -0.0 as +0.0</a></li>
222 <li><a href="http://llvm.cs.uiuc.edu/PR223">[loopsimplify] Loopsimplify incorrectly updates dominator information</a></li>
223 <li><a href="http://llvm.cs.uiuc.edu/PR225">[pruneeh] -pruneeh pass removes invoke instructions it shouldn't</a></li>
224 <li><a href="http://llvm.cs.uiuc.edu/PR228">[sparc] Boolean constants are emitted as true and false</a></li>
225 <li><a href="http://llvm.cs.uiuc.edu/PR234">[interpreter] va_list values silently corrupted by function calls</a></li>
226 <li><a href="http://llvm.cs.uiuc.edu/PR235">Tablegen aborts on errors</a></li>
227 <li><a href="http://llvm.cs.uiuc.edu/PR236">[inliner] Error inlining intrinsic calls into invoke instructions</a></li>
228 <li><a href="http://llvm.cs.uiuc.edu/PR245">Linking weak and strong global variables is dependent on link order</a></li>
229 <li><a href="http://llvm.cs.uiuc.edu/PR258">Variables used to define non-printable FP constants are externally visible</a></li>
230 <li><a href="http://llvm.cs.uiuc.edu/PR259">CBE gives linkonce functions wrong linkage semantics</a></li>
231 <li><a href="http://llvm.cs.uiuc.edu/PR274">[JIT] Programs cannot resolve the fstat function</a></li>
232 <li><a href="http://llvm.cs.uiuc.edu/PR284">[indvars] Induction variable analysis violates LLVM invariants</a></li>
233 <li><a href="http://llvm.cs.uiuc.edu/PR296">[execution engines] Unhandled cast constant expression</a></li>
234
235 </ol>
236
237
238
239 <p>Bugs in the C/C++ front-end:</p>
240
241 <ol>
242 <li><a href="http://llvm.cs.uiuc.edu/PR186">Need weak linkage on memory
243 management functions in libc runtime to allow them to be overriden</a></li>
244 <li><a href="http://llvm.cs.uiuc.edu/PR202">[llvm-gcc] asserts when an extern inline function is redefined</a></li>
245 <li><a href="http://llvm.cs.uiuc.edu/PR204">[llvmg++] Dynamically initialized constants cannot be marked 'constant'</a></li>
246 <li><a href="http://llvm.cs.uiuc.edu/PR216">[llvmgcc] floating-point unary minus is incorrect for +0.0</a></li>
247 <li><a href="http://llvm.cs.uiuc.edu/PR221">[llvm-gcc] miscompilation of 'X = Y = Z' with aggregate values</a></li>
248 <li><a href="http://llvm.cs.uiuc.edu/PR272">[llvmgcc] Invalid code created for complex division operation</a></li>
249 <li><a href="http://llvm.cs.uiuc.edu/PR268">[llvmgcc] Incorrect code generation for pointer subtraction</a></li>
250 <li><a href="http://llvm.cs.uiuc.edu/PR261">[llvmg++] Crash assigning pointers-to-members with casted types</a></li>
251 <li><a href="http://llvm.cs.uiuc.edu/PR291">[llvm-g++] Cleanups and gotos don't mix properly</a></li>
252 <li><a href="http://llvm.cs.uiuc.edu/PR297">[llvmgcc] Crash on auto register variable with specific register specified</a></li>
253 </ol>
254
255 </div>
256
257 <!-- *********************************************************************** -->
258 <div class="doc_section">
259   <a name="portability">Portability and Supported Platforms</a>
260 </div>
261 <!-- *********************************************************************** -->
262
263 <div class="doc_text">
264
265 <p>LLVM has been extensively tested on Intel and AMD machines running Red
266 Hat Linux and FreeBSD.  It has also been tested on Sun UltraSPARC workstations running Solaris 8.
267 Additionally, 
268 LLVM works on Mac OS X 10.3 and above, but only with the C backend or 
269 interpreter (no native backend for the PowerPC is available yet).
270 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
271 work on more platforms than that.  However, it is likely that we
272 missed something and that minor porting is required to get LLVM to work on 
273 new platforms.  We welcome portability patches and error messages.</p>
274
275 </div>
276
277 <!-- *********************************************************************** -->
278 <div class="doc_section">
279   <a name="knownproblems">Known Problems</a>
280 </div>
281 <!-- *********************************************************************** -->
282
283 <div class="doc_text">
284
285 <p>This section contains all known problems with the LLVM system, listed by
286 component.  As new problems are discovered, they will be added to these
287 sections.  If you run into a problem, please check the <a
288 href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
289 there isn't already one.</p>
290
291 </div>
292
293 <!-- ======================================================================= -->
294 <div class="doc_subsection">
295   <a name="experimental">Experimental features included with this release</a>
296 </div>
297
298 <div class="doc_text">
299
300 <p>
301 The following components of this LLVM release are either untested, known to be
302 broken or unreliable, or are in early development.  These components should not
303 be relied on, and bugs should not be filed against them, but they may be useful
304 to some people.  In particular, if you would like to work on one of these
305 components, please contact us on the llvmdev list.
306 </p>
307
308 <ul>
309 <li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
310     -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
311
312 <li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
313     it should) and not thoroughly tested.</li>
314 <li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
315 <li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
316 </ul>
317
318 </div>
319
320 <!-- ======================================================================= -->
321 <div class="doc_subsection">
322   <a name="core">Known problems with the LLVM Core</a>
323 </div>
324
325 <div class="doc_text">
326
327 <ul>
328
329 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
330 work.</li>
331
332 <li>The JIT does not use mutexes to protect its internal data structures.  As
333 such, execution of a threaded program could cause these data structures to be
334 corrupted.</li>
335
336 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
337
338 <li>Linking in static archive files (.a files) is very slow (there is no symbol
339 table in the archive).</li>
340
341 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
342 more than 256 elements</a>.</li>
343
344 <li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link objects/archives in the order specified on the command line.</a></li>
345
346 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
347 values live across a setjmp as volatile</a>.  This missing feature only affects
348 targets whose setjmp/longjmp libraries do not save and restore the entire
349 register file.</li>
350 </ul>
351 </div>
352
353 <!-- ======================================================================= -->
354 <div class="doc_subsection">
355   <a name="c-fe">Known problems with the C front-end</a>
356 </div>
357
358 <!-- _______________________________________________________________________ -->
359 <div class="doc_subsubsection">Bugs</div>
360
361 <div class="doc_text">
362 <ul>
363 <li>C99 Variable sized arrays do not release stack memory when they go out of 
364     scope.  Thus, the following program may run out of stack space:
365 <pre>
366     for (i = 0; i != 1000000; ++i) {
367       int X[n];
368       foo(X);
369     }
370 </pre></li>
371
372 <li>
373 Initialization of global union variables can only be done
374 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
375 union member</a>.
376 </li>
377
378 <li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly external function is re-declared as static</a></li>
379
380 </ul>
381 </div>
382
383 <!-- _______________________________________________________________________ -->
384 <div class="doc_subsubsection">
385   Notes
386 </div>
387
388 <div class="doc_text">
389
390 <ul>
391
392 <li>Inline assembly is not yet supported.</li>
393
394 <li>"long double" is transformed by the front-end into "double".  There is no
395 support for floating point data types of any size other than 32 and 64
396 bits.</li>
397     
398 <li>The following Unix system functionality has not been tested and may not
399 work:
400   <ol>
401   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
402       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
403       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
404   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
405       - These functions have not been tested.
406   </ol></li>
407
408 <li>Although many GCC extensions are supported, some are not.  In particular,
409     the following extensions are known to <b>not be</b> supported:
410   <ol>
411   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
412   <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>
413   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
414   <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>
415   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
416   <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>
417   <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>
418   <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>
419   <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>
420   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
421   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
422   </ol>
423
424   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
425   attribute means that the LLVM compiler ignores the presence of the attribute,
426   but the code should still work.  An unsupported attribute is one which is
427   ignored by the LLVM compiler and will cause a different interpretation of
428   the program.</p>
429
430   <ol>
431   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
432       Arrays whose length is computed at run time.<br>
433       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
434
435   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
436
437       Declaring that functions have no side effects or that they can never
438       return.<br>
439
440       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
441       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
442       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
443
444       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
445       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
446       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
447
448       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
449       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
450       <tt>fastcall</tt>, all other target specific attributes</li>
451    
452   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
453       Specifying attributes of variables.<br>
454       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
455                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
456                         <tt>unused</tt>, <tt>weak</tt><br>
457
458       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
459                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
460                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
461                         <tt>dllexport</tt>, all target specific attributes.</li>
462
463   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
464       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
465                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
466
467       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
468                         all target specific attributes.</li>
469
470   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
471       Other built-in functions.<br>
472       We support all builtins which have a C language equivalent (e.g., 
473          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
474          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
475          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
476
477   </ol>
478
479   <p>The following extensions <b>are</b> known to be supported:</p>
480
481   <ol>
482   <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>
483   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
484   <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>
485   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
486   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
487   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
488   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
489   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
490   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
491   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
492   <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>
493   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
494   <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>
495   <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>
496   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
497   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
498 or arrays as values.</li>
499   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
500   <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>
501   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
502   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
503   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
504   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
505   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
506   <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>
507   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
508   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
509   <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>
510   <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>
511   <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>
512   <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>
513   <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>
514   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
515   </ol></li>
516
517 </ul>
518
519 <p>If you run into GCC extensions which have not been included in any of these
520 lists, please let us know (also including whether or not they work).</p>
521
522 </div>
523
524 <!-- ======================================================================= -->
525 <div class="doc_subsection">
526   <a name="c++-fe">Known problems with the C++ front-end</a>
527 </div>
528
529 <div class="doc_text">
530
531 <p>For this release, the C++ front-end is considered to be fully functional but
532 has not been tested as thoroughly as the C front-end.  It has been tested and 
533 works for a number of non-trivial programs, but there may be lurking bugs.
534 Please report any bugs or problems.</p>
535
536 </div>
537
538 <!-- _______________________________________________________________________ -->
539 <div class="doc_subsubsection">Bugs</div>
540
541 <div class="doc_text">
542
543 <ul>
544 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
545     front-end</a>.</li>
546 </ul>
547 </div>
548
549 <!-- _______________________________________________________________________ -->
550 <div class="doc_subsubsection">
551   Notes
552 </div>
553
554 <div class="doc_text">
555
556 <ul>
557
558 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
559 parser is significantly more standards compliant (and picky) than prior GCC
560 versions.  For more information, see the C++ section of the <a
561 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
562
563 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
564     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
565     function and in the <tt>setjmp</tt> receiver function may not be run.
566     Objects in intervening stack frames will be destroyed, however (which is
567     better than most compilers).</li>
568
569 <li>The LLVM C++ front-end follows the <a
570     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
571     This document, which is not Itanium specific, specifies a standard for name
572     mangling, class layout, v-table layout, RTTI formats, and other C++
573     representation issues.  Because we use this API, code generated by the LLVM
574     compilers should be binary compatible with machine code generated by other
575     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
576     <i>However</i>, the exception handling mechanism used by LLVM is very
577     different from the model used in the Itanium ABI, so <b>exceptions will not
578     interact correctly</b>. </li>
579
580 </ul>
581
582 </div>
583
584 <!-- ======================================================================= -->
585 <div class="doc_subsection">
586   <a name="x86-be">Known problems with the X86 back-end</a>
587 </div>
588
589 <div class="doc_text">
590
591 <ul>
592 <li>None so far.
593 </ul>
594
595 </div>
596
597 <!-- ======================================================================= -->
598 <div class="doc_subsection">
599   <a name="sparc-be">Known problems with the Sparc back-end</a>
600 </div>
601
602 <div class="doc_text">
603
604 <ul>
605 <li>None so far.
606 </ul>
607
608 </div>
609
610 <!-- ======================================================================= -->
611 <div class="doc_subsection">
612   <a name="c-be">Known problems with the C back-end</a>
613 </div>
614
615 <div class="doc_text">
616
617 <ul>
618
619 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
620 Analysis rules.  As such, special options may be necessary to compile the code
621 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
622 problem probably cannot be fixed.</li>
623
624 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
625 cannot include special floating point numbers like Not-A-Number or
626 Infinity.</li>
627
628 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
629 supported</a>.  This should not affect LLVM produced by the C or C++ 
630 frontends.</li>
631
632 </ul>
633
634 </div>
635
636 <!-- *********************************************************************** -->
637 <div class="doc_section">
638   <a name="additionalinfo">Additional Information</a>
639 </div>
640 <!-- *********************************************************************** -->
641
642 <div class="doc_text">
643
644 <p>A wide variety of additional information is available on the LLVM web page,
645 including mailing lists and publications describing algorithms and components
646 implemented in LLVM.  The web page also contains versions of the API
647 documentation which is up-to-date with the CVS version of the source code.  You
648 can access versions of these documents specific to this release by going into
649 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
650
651 <p>If you have any questions or comments about LLVM, please feel free to contact
652 us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
653 lists</a>.</p>
654
655 </div>
656
657 <!-- *********************************************************************** -->
658
659 <hr>
660 <address>
661   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
662   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
663   <a href="http://validator.w3.org/check/referer"><img
664   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
665
666   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
667   Last modified: $Date$
668 </address>
669
670 </body>
671 </html>