Note some LLVM 2.7 -> 2.8 APIs that changed / got renamed.
[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   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 2.8 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.8 Release Notes</div>
12
13 <img align=right src="http://llvm.org/img/DragonSmall.png"
14     width="136" height="136" alt="LLVM Dragon Logo">
15
16 <ol>
17   <li><a href="#intro">Introduction</a></li>
18   <li><a href="#subproj">Sub-project Status Update</a></li>
19   <li><a href="#externalproj">External Projects Using LLVM 2.8</a></li>
20   <li><a href="#whatsnew">What's New in LLVM 2.8?</a></li>
21   <li><a href="GettingStarted.html">Installation Instructions</a></li>
22   <li><a href="#portability">Portability and Supported Platforms</a></li>
23   <li><a href="#knownproblems">Known Problems</a></li>
24   <li><a href="#additionalinfo">Additional Information</a></li>
25 </ol>
26
27 <div class="doc_author">
28   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
29 </div>
30
31 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.8
32 release.<br>
33 You may prefer the
34 <a href="http://llvm.org/releases/2.7/docs/ReleaseNotes.html">LLVM 2.7
35 Release Notes</a>.</h1>
36
37 <!-- *********************************************************************** -->
38 <div class="doc_section">
39   <a name="intro">Introduction</a>
40 </div>
41 <!-- *********************************************************************** -->
42
43 <div class="doc_text">
44
45 <p>This document contains the release notes for the LLVM Compiler
46 Infrastructure, release 2.8.  Here we describe the status of LLVM, including
47 major improvements from the previous release and significant known problems.
48 All LLVM releases may be downloaded from the <a
49 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
50
51 <p>For more information about LLVM, including information about the latest
52 release, please check out the <a href="http://llvm.org/">main LLVM
53 web site</a>.  If you have questions or comments, the <a
54 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
55 Mailing List</a> is a good place to send them.</p>
56
57 <p>Note that if you are reading this file from a Subversion checkout or the
58 main LLVM web page, this document applies to the <i>next</i> release, not the
59 current one.  To see the release notes for a specific release, please see the
60 <a href="http://llvm.org/releases/">releases page</a>.</p>
61
62 </div>
63  
64
65 <!--
66 Almost dead code.
67   include/llvm/Analysis/LiveValues.h => Dan
68   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
69   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
70   ABCD, GEPSplitterPass
71   MSIL backend?
72   lib/Transforms/Utils/SSI.cpp  -> ABCD depends on it.
73 -->
74  
75    
76 <!-- Features that need text if they're finished for 2.8:
77   combiner-aa?
78   strong phi elim
79   llvm.dbg.value: variable debug info for optimized code
80   loop dependence analysis
81  -->
82
83  <!-- for announcement email:
84  Logo web page.
85  Many new papers added to /pubs/
86    -->
87
88 <!-- *********************************************************************** -->
89 <div class="doc_section">
90   <a name="subproj">Sub-project Status Update</a>
91 </div>
92 <!-- *********************************************************************** -->
93
94 <div class="doc_text">
95 <p>
96 The LLVM 2.8 distribution currently consists of code from the core LLVM
97 repository (which roughly includes the LLVM optimizers, code generators
98 and supporting tools), the Clang repository and the llvm-gcc repository.  In
99 addition to this code, the LLVM Project includes other sub-projects that are in
100 development.  Here we include updates on these subprojects.
101 </p>
102
103 </div>
104
105
106 <!--=========================================================================-->
107 <div class="doc_subsection">
108 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
109 </div>
110
111 <div class="doc_text">
112
113 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
114 C++, and Objective-C languages. Clang aims to provide a better user experience
115 through expressive diagnostics, a high level of conformance to language
116 standards, fast compilation, and low memory use. Like LLVM, Clang provides a
117 modular, library-based architecture that makes it suitable for creating or
118 integrating with other development tools. Clang is considered a
119 production-quality compiler for C and Objective-C on x86 (32- and 64-bit).</p>
120
121 <p>In the LLVM 2.8 time-frame, the Clang team has made many improvements:</p>
122
123 <ul>
124
125 </ul>
126 </div>
127
128 <!--=========================================================================-->
129 <div class="doc_subsection">
130 <a name="clangsa">Clang Static Analyzer</a>
131 </div>
132
133 <div class="doc_text">
134
135 <p>The <a href="http://clang-analyzer.llvm.org/">Clang Static Analyzer</a>
136    project is an effort to use static source code analysis techniques to
137    automatically find bugs in C and Objective-C programs (and hopefully <a
138    href="http://clang-analyzer.llvm.org/dev_cxx.html">C++ in the
139    future</a>!).  The tool is very good at finding bugs that occur on specific
140    paths through code, such as on error conditions.</p>
141
142 <p>In the LLVM 2.8 time-frame, 
143 </p>
144
145 </div>
146
147 <!--=========================================================================-->
148 <div class="doc_subsection">
149 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
150 </div>
151
152 <div class="doc_text">
153 <p>
154 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
155 a JVM and a CLI Virtual Machine (Microsoft .NET is an
156 implementation of the CLI) using LLVM for static and just-in-time
157 compilation.</p>
158
159 <p>With the release of LLVM 2.8, ...</p>
160
161 </div>
162
163
164 <!--=========================================================================-->
165 <div class="doc_subsection">
166 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
167 </div>
168
169 <div class="doc_text">
170 <p>
171 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
172 is a simple library that provides an implementation of the low-level
173 target-specific hooks required by code generation and other runtime components.
174 For example, when compiling for a 32-bit target, converting a double to a 64-bit
175 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
176 function. The compiler-rt library provides highly optimized implementations of
177 this and other low-level routines (some are 3x faster than the equivalent
178 libgcc routines).</p>
179
180 <p>
181 All of the code in the compiler-rt project is available under the standard LLVM
182 License, a "BSD-style" license.  New in LLVM 2.8: 
183
184 Soft float support
185 </p>
186
187 </div>
188
189 <!--=========================================================================-->
190 <div class="doc_subsection">
191 <a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a>
192 </div>
193
194 <div class="doc_text">
195 <p>
196 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to
197 gcc-4.5.  Unlike llvm-gcc, which makes many intrusive changes to the underlying
198 gcc-4.2 code, dragonegg in theory does not require any gcc-4.5 modifications
199 whatsoever (currently one small patch is needed).  This is thanks to the new
200 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>, which
201 makes it possible to modify the behaviour of gcc at runtime by loading a plugin,
202 which is nothing more than a dynamic library which conforms to the gcc plugin
203 interface.  DragonEgg is a gcc plugin that causes the LLVM optimizers to be run
204 instead of the gcc optimizers, and the LLVM code generators instead of the gcc
205 code generators, just like llvm-gcc.  To use it, you add
206 "-fplugin=path/dragonegg.so" to the gcc-4.5 command line, and gcc-4.5 magically
207 becomes llvm-gcc-4.5!
208 </p>
209
210 <p>
211 DragonEgg is still a work in progress.  Currently C works very well, while C++,
212 Ada and Fortran work fairly well.  All other languages either don't work at all,
213 or only work poorly.  For the moment only the x86-32 and x86-64 targets are
214 supported, and only on linux and darwin (darwin needs an additional gcc patch).
215 </p>
216
217 <p>
218 2.8 status here.
219 </p>
220
221 </div>
222
223
224 <!--=========================================================================-->
225 <div class="doc_subsection">
226 <a name="mc">llvm-mc: Machine Code Toolkit</a>
227 </div>
228
229 <div class="doc_text">
230 <p>
231 The LLVM Machine Code (aka MC) sub-project of LLVM was created to solve a number
232 of problems in the realm of assembly, disassembly, object file format handling,
233 and a number of other related areas that CPU instruction-set level tools work
234 in. It is a sub-project of LLVM which provides it with a number of advantages
235 over other compilers that do not have tightly integrated assembly-level tools.
236 For a gentle introduction, please see the <a
237 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
238 LLVM MC Project Blog Post</a>.
239 </p>
240
241 <p>2.8 status here</p>
242 </div>  
243
244
245 <!-- *********************************************************************** -->
246 <div class="doc_section">
247   <a name="externalproj">External Open Source Projects Using LLVM 2.8</a>
248 </div>
249 <!-- *********************************************************************** -->
250
251 <div class="doc_text">
252
253 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
254    a lot of other language and tools projects.  This section lists some of the
255    projects that have already been updated to work with LLVM 2.8.</p>
256 </div>
257
258
259 <!-- *********************************************************************** -->
260 <div class="doc_section">
261   <a name="whatsnew">What's New in LLVM 2.8?</a>
262 </div>
263 <!-- *********************************************************************** -->
264
265 <div class="doc_text">
266
267 <p>This release includes a huge number of bug fixes, performance tweaks and
268 minor improvements.  Some of the major improvements and new features are listed
269 in this section.
270 </p>
271
272 </div>
273
274 <!--=========================================================================-->
275 <div class="doc_subsection">
276 <a name="orgchanges">LLVM Community Changes</a>
277 </div>
278
279 <div class="doc_text">
280
281 <p>In addition to changes to the code, between LLVM 2.7 and 2.8, a number of
282 organization changes have happened:
283 </p>
284
285 <ul>
286 </ul>
287 </div>
288
289 <!--=========================================================================-->
290 <div class="doc_subsection">
291 <a name="majorfeatures">Major New Features</a>
292 </div>
293
294 <div class="doc_text">
295
296 <p>LLVM 2.8 includes several major new capabilities:</p>
297
298 <ul>
299 <li>.</li>
300 </ul>
301
302 </div>
303
304 <!--=========================================================================-->
305 <div class="doc_subsection">
306 <a name="coreimprovements">LLVM IR and Core Improvements</a>
307 </div>
308
309 <div class="doc_text">
310 <p>LLVM IR has several new features for better support of new targets and that
311 expose new optimization opportunities:</p>
312
313 <ul>
314
315 <li>LLVM 2.8 changes the internal order of operands in <a
316   href="http://llvm.org/doxygen/classllvm_1_1InvokeInst.html"><tt>InvokeInst</tt></a>
317   and <a href="http://llvm.org/doxygen/classllvm_1_1CallInst.html"><tt>CallInst</tt></a>.
318   To be portable across releases, resort to <tt>CallSite</tt> and the
319   high-level accessors, such as <tt>getCalledValue</tt> and <tt>setUnwindDest</tt>.
320 </li>
321 <li>
322   You can no longer pass use_iterators directly to cast<> (and similar), because
323   these routines tend to perform costly dereference operations more than once. You
324   have to dereference the iterators yourself and pass them in.
325 </li>
326 <li>
327   llvm.memcpy.*, llvm.memset.*, llvm.memmove.* (and possibly other?) intrinsics
328   take an extra parameter now (i1 isVolatile), totaling 5 parameters.
329   If you were creating these intrinsic calls and prototypes yourself (as opposed
330   to using Intrinsic::getDeclaration), you can use UpgradeIntrinsicFunction/UpgradeIntrinsicCall
331   to be portable accross releases.
332   Note that you cannot use Intrinsic::getDeclaration() in a backwards compatible
333   way (needs 2/3 types now, in 2.7 it needed just 1).
334 </li>
335 <li>
336   SetCurrentDebugLocation takes a DebugLoc now instead of a MDNode.
337   Change your code to use
338   SetCurrentDebugLocation(DebugLoc::getFromDILocation(...)).
339 </li>
340 <li>
341   VISIBILITY_HIDDEN is gone.
342 </li>
343 <li>
344   SMDiagnostic takes different parameters now. //FIXME: how to upgrade?
345 </li>
346 <li>
347   Some APIs got renamed:
348   <ul>
349       <li>llvm_report_error -&gt; report_fatal_error</li>
350       <li>llvm_install_error_handler -&gt; install_fatal_error_handler</li>
351       <li>llvm::DwarfExceptionHandling -&gt; llvm::JITExceptionHandling</li>
352   </ul>
353 </li>
354 </ul>
355
356 </div>
357
358 <!--=========================================================================-->
359 <div class="doc_subsection">
360 <a name="optimizer">Optimizer Improvements</a>
361 </div>
362
363 <div class="doc_text">
364
365 <p>In addition to a large array of minor performance tweaks and bug fixes, this
366 release includes a few major enhancements and additions to the optimizers:</p>
367
368 <ul>
369
370 <li></li>
371
372 </ul>
373
374 </div>
375
376
377 <!--=========================================================================-->
378 <div class="doc_subsection">
379 <a name="executionengine">Interpreter and JIT Improvements</a>
380 </div>
381
382 <div class="doc_text">
383
384 <ul>
385 <li></li>
386
387 </ul>
388
389 </div>
390
391 <!--=========================================================================-->
392 <div class="doc_subsection">
393 <a name="codegen">Target Independent Code Generator Improvements</a>
394 </div>
395
396 <div class="doc_text">
397
398 <p>We have put a significant amount of work into the code generator
399 infrastructure, which allows us to implement more aggressive algorithms and make
400 it run faster:</p>
401
402 <ul>
403 <li>MachO writer works.</li>
404 </ul>
405 </div>
406
407 <!--=========================================================================-->
408 <div class="doc_subsection">
409 <a name="x86">X86-32 and X86-64 Target Improvements</a>
410 </div>
411
412 <div class="doc_text">
413 <p>New features of the X86 target include:
414 </p>
415
416 <ul>
417 <li>The X86 backend now supports holding X87 floating point stack values
418     in registers across basic blocks, dramatically improving performance of code
419     that uses long double, and when targetting CPUs that don't support SSE.</li>
420
421 </ul>
422
423 </div>
424
425 <!--=========================================================================-->
426 <div class="doc_subsection">
427 <a name="ARM">ARM Target Improvements</a>
428 </div>
429
430 <div class="doc_text">
431 <p>New features of the ARM target include:
432 </p>
433
434 <ul>
435
436 <li></li>
437
438 </ul>
439
440
441 </div>
442
443 <!--=========================================================================-->
444 <div class="doc_subsection">
445 <a name="newapis">New Useful APIs</a>
446 </div>
447
448 <div class="doc_text">
449
450 <p>This release includes a number of new APIs that are used internally, which
451    may also be useful for external clients.
452 </p>
453
454 <ul>
455 <li></li>
456 </ul>
457
458
459 </div>
460
461 <!--=========================================================================-->
462 <div class="doc_subsection">
463 <a name="otherimprovements">Other Improvements and New Features</a>
464 </div>
465
466 <div class="doc_text">
467 <p>Other miscellaneous features include:</p>
468
469 <ul>
470 <li></li>
471 </ul>
472
473 </div>
474
475
476 <!--=========================================================================-->
477 <div class="doc_subsection">
478 <a name="changes">Major Changes and Removed Features</a>
479 </div>
480
481 <div class="doc_text">
482
483 <p>If you're already an LLVM user or developer with out-of-tree changes based
484 on LLVM 2.7, this section lists some "gotchas" that you may run into upgrading
485 from the previous release.</p>
486
487 <ul>
488
489 <li>.</li>
490 </ul>
491
492 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
493 API changes are:</p>
494
495 <ul>
496 </ul>
497
498 </div>
499
500
501
502 <!-- *********************************************************************** -->
503 <div class="doc_section">
504   <a name="portability">Portability and Supported Platforms</a>
505 </div>
506 <!-- *********************************************************************** -->
507
508 <div class="doc_text">
509
510 <p>LLVM is known to work on the following platforms:</p>
511
512 <ul>
513 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
514     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
515     systems).</li>
516 <li>PowerPC and X86-based Mac OS X systems, running 10.4 and above in 32-bit
517     and 64-bit modes.</li>
518 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
519 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
520     support is available for native builds with Visual C++).</li>
521 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
522 <li>Alpha-based machines running Debian GNU/Linux.</li>
523 </ul>
524
525 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
526 to the machine and operating system on which it is built.  However, minor
527 porting may be required to get LLVM to work on new platforms.  We welcome your
528 portability patches and reports of successful builds or error messages.</p>
529
530 </div>
531
532 <!-- *********************************************************************** -->
533 <div class="doc_section">
534   <a name="knownproblems">Known Problems</a>
535 </div>
536 <!-- *********************************************************************** -->
537
538 <div class="doc_text">
539
540 <p>This section contains significant known problems with the LLVM system,
541 listed by component.  If you run into a problem, please check the <a
542 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
543 there isn't already one.</p>
544
545 <ul>    
546 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
547 using the stock GCC 3.x.x series 'out the box',
548 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
549 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
550 for x86/x86-64 has been made available from the third party AuroraUX Project
551 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
552 </ul>
553
554 </div>
555
556 <!-- ======================================================================= -->
557 <div class="doc_subsection">
558   <a name="experimental">Experimental features included with this release</a>
559 </div>
560
561 <div class="doc_text">
562
563 <p>The following components of this LLVM release are either untested, known to
564 be broken or unreliable, or are in early development.  These components should
565 not be relied on, and bugs should not be filed against them, but they may be
566 useful to some people.  In particular, if you would like to work on one of these
567 components, please contact us on the <a
568 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
569
570 <ul>
571 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze
572     backends are experimental.</li>
573 <li><tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
574     supported value for this option.  XXX Update me</li>
575 </ul>
576
577 </div>
578
579 <!-- ======================================================================= -->
580 <div class="doc_subsection">
581   <a name="x86-be">Known problems with the X86 back-end</a>
582 </div>
583
584 <div class="doc_text">
585
586 <ul>
587   <li>The X86 backend does not yet support
588     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
589     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
590     'u'.</li>
591   <li>Win64 code generation wasn't widely tested. Everything should work, but we
592     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
593     runtime currently due to lack of support for the 'u' inline assembly
594     constraint and for X87 floating point inline assembly.</li>
595   <li>The X86-64 backend does not yet support the LLVM IR instruction
596       <tt>va_arg</tt>. Currently, front-ends support variadic
597       argument constructs on X86-64 by lowering them manually.</li>
598 </ul>
599
600 </div>
601
602 <!-- ======================================================================= -->
603 <div class="doc_subsection">
604   <a name="ppc-be">Known problems with the PowerPC back-end</a>
605 </div>
606
607 <div class="doc_text">
608
609 <ul>
610 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
611 compilation, and lacks support for debug information.</li>
612 </ul>
613
614 </div>
615
616 <!-- ======================================================================= -->
617 <div class="doc_subsection">
618   <a name="arm-be">Known problems with the ARM back-end</a>
619 </div>
620
621 <div class="doc_text">
622
623 <ul>
624 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
625 processors, thumb programs can crash or produce wrong
626 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
627 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
628 </li>
629 </ul>
630
631 </div>
632
633 <!-- ======================================================================= -->
634 <div class="doc_subsection">
635   <a name="sparc-be">Known problems with the SPARC back-end</a>
636 </div>
637
638 <div class="doc_text">
639
640 <ul>
641 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
642     support the 64-bit SPARC ABI (-m64).</li>
643 </ul>
644
645 </div>
646
647 <!-- ======================================================================= -->
648 <div class="doc_subsection">
649   <a name="mips-be">Known problems with the MIPS back-end</a>
650 </div>
651
652 <div class="doc_text">
653
654 <ul>
655 <li>64-bit MIPS targets are not supported yet.</li>
656 </ul>
657
658 </div>
659
660 <!-- ======================================================================= -->
661 <div class="doc_subsection">
662   <a name="alpha-be">Known problems with the Alpha back-end</a>
663 </div>
664
665 <div class="doc_text">
666
667 <ul>
668
669 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
670 appropriate nops inserted to ensure restartability.</li>
671
672 </ul>
673 </div>
674
675 <!-- ======================================================================= -->
676 <div class="doc_subsection">
677   <a name="c-be">Known problems with the C back-end</a>
678 </div>
679
680 <div class="doc_text">
681
682 <ul>
683 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
684     inline assembly code</a>.</li>
685 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
686     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
687     C++ code compiled with <tt>llc</tt> or native compilers.</li>
688 <li>The C backend does not support all exception handling constructs.</li>
689 <li>The C backend does not support arbitrary precision integers.</li>
690 </ul>
691
692 </div>
693
694
695 <!-- ======================================================================= -->
696 <div class="doc_subsection">
697   <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
698 </div>
699
700 <div class="doc_text">
701
702 <p>The only major language feature of GCC not supported by llvm-gcc is
703     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
704     are only supported on some targets.  For example, trampolines are only
705     supported on some targets (these are used when you take the address of a
706     nested function).</p>
707
708 </div>
709
710 <!-- ======================================================================= -->
711 <div class="doc_subsection">
712   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
713 </div>
714
715 <div class="doc_text">
716 <ul>
717 <li>Fortran support generally works, but there are still several unresolved bugs
718     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
719     tools/gfortran component for details.</li>
720 </ul>
721 </div>
722
723 <!-- ======================================================================= -->
724 <div class="doc_subsection">
725   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
726 </div>
727
728 <div class="doc_text">
729 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
730 technology, and problems should be expected.
731 <ul>
732 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
733 to lack of trampoline support (pointers to nested functions) on other platforms.
734 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
735 which does support trampolines.</li>
736 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
737 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
738 exception handling, which is used internally by the compiler.
739 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
740 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
741 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
742 (c380004 also fails with gcc-4.2 mainline).
743 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
744 causes the compiler to go into an infinite loop, using up all system memory.</li>
745 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
746 <li>The <tt>-E</tt> binder option (exception backtraces)
747 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
748 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
749 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
750 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
751 or use representation clauses that result in a field of a non-discrete type
752 starting or finishing in the middle of a byte.</li>
753 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
754 'main' as generated by the Ada binder to be invalid</a>.
755 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
756 <tt>envp</tt> rather than integers.</li>
757 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
758 ignored</a>.</li>
759 </ul>
760 </div>
761
762 <!-- *********************************************************************** -->
763 <div class="doc_section">
764   <a name="additionalinfo">Additional Information</a>
765 </div>
766 <!-- *********************************************************************** -->
767
768 <div class="doc_text">
769
770 <p>A wide variety of additional information is available on the <a
771 href="http://llvm.org">LLVM web page</a>, in particular in the <a
772 href="http://llvm.org/docs/">documentation</a> section.  The web page also
773 contains versions of the API documentation which is up-to-date with the
774 Subversion version of the source code.
775 You can access versions of these documents specific to this release by going
776 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
777
778 <p>If you have any questions or comments about LLVM, please feel free to contact
779 us via the <a href="http://llvm.org/docs/#maillist"> mailing
780 lists</a>.</p>
781
782 </div>
783
784 <!-- *********************************************************************** -->
785
786 <hr>
787 <address>
788   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
789   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
790   <a href="http://validator.w3.org/check/referer"><img
791   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
792
793   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
794   Last modified: $Date$
795 </address>
796
797 </body>
798 </html>