LLVM 2.8 Release Notes

@@ -164,10 +119,27 @@ production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86

In the LLVM 2.8 time-frame, the Clang team has made many improvements:

Surely these guys have done something
X86-64 abi improvements? Did they make it in?

Clang C++ is now feature-complete with respect to the ISO C++ 1998 and 2003 standards.
Added support for Objective-C++.
Clang now uses LLVM-MC to directly generate object code and to parse inline assembly (on Darwin).
Introduced many new warnings, including -Wmissing-field-initializers, -Wshadow, -Wno-protocol, -Wtautological-compare, -Wstrict-selector-match, -Wcast-align, -Wunused improvements, and greatly improved format-string checking.
Introduced the "libclang" library, a C interface to Clang intended to support IDE clients.
Added support for #pragma GCC visibility, #pragma align, and others.
Added support for SSE, AVX, ARM NEON, and AltiVec.
Improved support for many Microsoft extensions.
Implemented support for blocks in C++.
Implemented precompiled headers for C++.
Improved abstract syntax trees to retain more accurate source information.
Added driver support for handling LLVM IR and bitcode files directly.
Major improvements to compiler correctness for exception handling.
Improved generated code quality in some areas: +
- Good code generation for X86-32 and X86-64 ABI handling.
- Improved code generation for bit-fields, although important work remains.
+

-The VMKit project is an implementation of -a JVM and a CLI Virtual Machine (Microsoft .NET is an -implementation of the CLI) using LLVM for static and just-in-time -compilation.

+DragonEgg is a port of llvm-gcc to +gcc-4.5. Unlike llvm-gcc, dragonegg in theory does not require any gcc-4.5 +modifications whatsoever (currently one small patch is needed) thanks to the +new gcc plugin architecture. +DragonEgg is a gcc plugin that makes gcc-4.5 use the LLVM optimizers and code +generators instead of gcc's, just like with llvm-gcc. +

With the release of LLVM 2.8, ...

+DragonEgg is still a work in progress, but it is able to compile a lot of code, +for example all of gcc, LLVM and clang. Currently Ada, C, C++ and Fortran work +well, while all other languages either don't work at all or only work poorly. +For the moment only the x86-32 and x86-64 targets are supported, and only on +linux and darwin (darwin may need additional gcc patches). +

+ +

+The 2.8 release has the following notable changes: +

The plugin loads faster due to exporting fewer symbols.
Additional vector operations such as addps256 are now supported.
Ada global variables with no initial value are no longer zero initialized, +resulting in better optimization.
The '-fplugin-arg-dragonegg-enable-gcc-optzns' flag now runs all gcc +optimizers, rather than just a handful.
Fortran programs using common variables now link correctly.
GNU OMP constructs no longer crash the compiler.

-DragonEgg is a port of llvm-gcc to -gcc-4.5. Unlike llvm-gcc, which makes many intrusive changes to the underlying -gcc-4.2 code, dragonegg in theory does not require any gcc-4.5 modifications -whatsoever (currently one small patch is needed). This is thanks to the new -gcc plugin architecture, which -makes it possible to modify the behaviour of gcc at runtime by loading a plugin, -which is nothing more than a dynamic library which conforms to the gcc plugin -interface. DragonEgg is a gcc plugin that causes the LLVM optimizers to be run -instead of the gcc optimizers, and the LLVM code generators instead of the gcc -code generators, just like llvm-gcc. To use it, you add -"-fplugin=path/dragonegg.so" to the gcc-4.5 command line, and gcc-4.5 magically -becomes llvm-gcc-4.5! -

+LLDB is a brand new member of the LLVM +umbrella of projects. LLDB is a next generation, high-performance debugger. It +is built as a set of reusable components which highly leverage existing +libraries in the larger LLVM Project, such as the Clang expression parser, the +LLVM disassembler and the LLVM JIT.

-DragonEgg is still a work in progress. Currently C works very well, while C++, -Ada and Fortran work fairly well. All other languages either don't work at all, -or only work poorly. For the moment only the x86-32 and x86-64 targets are -supported, and only on linux and darwin (darwin needs an additional gcc patch). -

- -

-2.8 status here. +LLDB is in early development and not included as part of the LLVM 2.8 release, +but is mature enough to support basic debugging scenarios on Mac OS X in C, +Objective-C and C++. We'd really like help extending and expanding LLDB to +support new platforms, new languages, new architectures, and new features.

-libc++ is

- -

+KLEE is a symbolic execution framework for +programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths +through the application and records state transitions that lead to fault +states. This allows it to construct testcases that lead to faults and can even +be used to verify some algorithms.

-2.8 status here. -

Although KLEE does not have any major new features as of 2.8, we have made +various minor improvements, particular to ease development:

Added support for LLVM 2.8. KLEE currently maintains compatibility with + LLVM 2.6, 2.7, and 2.8.
Added a buildbot for 2.6, 2.7, and trunk. A 2.8 buildbot will be coming + soon following release.
Fixed many C++ code issues to allow building with Clang++. Mostly + complete, except for the version of MiniSAT which is inside the KLEE STP + version.
Improved support for building with separate source and build + directories.
Added support for "long double" on x86.
Initial work on KLEE support for using 'lit' test runner instead of + DejaGNU.
Added configure support for using an external version of + STP.

- What's New in LLVM 2.8? + +

+llvm-py Python Bindings for LLVM

+llvm-py has been updated to work +with LLVM 2.8. llvm-py provides Python bindings for LLVM, allowing you to write a +compiler backend or a VM in Python.

This release includes a huge number of bug fixes, performance tweaks and -minor improvements. Some of the major improvements and new features are listed -in this section. -

+ + + +

+FAUST Real-Time Audio Signal Processing Language +

+ +

+FAUST is a compiled language for real-time +audio signal processing. The name FAUST stands for Functional AUdio STream. Its +programming model combines two approaches: functional programming and block +diagram composition. In addition with the C, C++, JAVA output formats, the +Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7 and +2.8.

+ +

+ + +

+Jade Just-in-time Adaptive Decoder Engine +

+ +

Jade +(Just-in-time Adaptive Decoder Engine) is a generic video decoder engine using +LLVM for just-in-time compilation of video decoder configurations. Those +configurations are designed by MPEG Reconfigurable Video Coding (RVC) committee. +MPEG RVC standard is built on a stream-based dataflow representation of +decoders. It is composed of a standard library of coding tools written in +RVC-CAL language and a dataflow configuration — block diagram — +of a decoder.

+ +

Jade project is hosted as part of the Open +RVC-CAL Compiler and requires it to translate the RVC-CAL standard library +of video coding tools into an LLVM assembly code.

-LLVM Community Changes +LLVM JIT for Neko VM

Neko LLVM JIT +replaces the standard Neko JIT with an LLVM-based implementation. While not +fully complete, it is already providing a 1.5x speedup on 64-bit systems. +Neko LLVM JIT requires LLVM 2.8 or later.

+ +

+ + +

+Crack Scripting Language +

+ +

+Crack aims to provide +the ease of development of a scripting language with the performance of a +compiled language. The language derives concepts from C++, Java and Python, +incorporating object-oriented programming, operator overloading and strong +typing. Crack 0.2 works with LLVM 2.7, and the forthcoming Crack 0.2.1 release +builds on LLVM 2.8.

+ +

+ + +

+Dresden TM Compiler (DTMC) +

+ +

+DTMC provides support for +Transactional Memory, which is an easy-to-use and efficient way to synchronize +accesses to shared memory. Transactions can contain normal C/C++ code (e.g., +__transaction { list.remove(x); x.refCount--; }) and will be executed +virtually atomically and isolated from other transactions.

+ +

+ + +

+Kai Programming Language +

In addition to changes to the code, between LLVM 2.7 and 2.8, a number of -organization changes have happened: +

+Kai (Japanese ä¼ for +meeting/gathering) is an experimental interpreter that provides a highly +extensible runtime environment and explicit control over the compilation +process. Programs are defined using nested symbolic expressions, which are all +parsed into first-class values with minimal intrinsic semantics. Kai can +generate optimised code at run-time (using LLVM) in order to exploit the nature +of the underlying hardware and to integrate with external software libraries. +It is a unique exploration into world of dynamic code compilation, and the +interaction between high level and low level semantics.

+ +

+ + +

+OSL: Open Shading Language +

+ +

+OSL is a shading +language designed for use in physically based renderers and in particular +production rendering. By using LLVM instead of the interpreter, it was able to +meet its performance goals (>= C-code) while retaining the benefits of +runtime specialization and a portable high-level language. +

+ +

+ + + + +

+ What's New in LLVM 2.8? +

+ + +

+ +

This release includes a huge number of bug fixes, performance tweaks and +minor improvements. Some of the major improvements and new features are listed +in this section.

libc++ and lldb are new
Debugging optimized code support.

@@ -478,11 +610,16 @@ organization changes have happened:

LLVM 2.8 includes several major new capabilities:

atomic lowering pass.
RegionInfo pass: opt -regions analyze" or "opt -view-regions". -
ARMGlobalMerge:
llvm-diff
As mentioned above, libc++ and LLDB are major new additions to the LLVM collective.
LLVM 2.8 now has pretty decent support for debugging optimized code. You + should be able to reliably get debug info for function arguments, assuming + that the value is actually available where you have stopped.
A new 'llvm-diff' tool is available that does a semantic diff of .ll + files.
The MC subproject has made major progress in this release. + Direct .o file writing support for darwin/x86[-64] is now reliable and + support for other targets and object file formats are in progress.

Target Independent Code Generator Improvements @@ -623,7 +751,58 @@ infrastructure, which allows us to implement more aggressive algorithms and make it run faster:

MachO writer works.
The clang/gcc -momit-leaf-frame-pointer argument is now supported.
The clang/gcc -ffunction-sections and -fdata-sections arguments are now + supported on ELF targets (like GCC).
The MachineCSE pass is now tuned and on by default. It eliminates common + subexpressions that are exposed when lowering to machine instructions.
The "local" register allocator was replaced by a new "fast" register + allocator. This new allocator (which is often used at -O0) is substantially + faster and produces better code than the old local register allocator.
A new LLC "-regalloc=default" option is available, which automatically + chooses a register allocator based on the -O optimization level.
The common code generator code was modified to promote illegal argument and + return value vectors to wider ones when possible instead of scalarizing + them. For example, <3 x float> will now pass in one SSE register + instead of 3 on X86. This generates substantially better code since the + rest of the code generator was already expecting this.
The code generator uses a new "COPY" machine instruction. This speeds up + the code generator and eliminates the need for targets to implement the + isMoveInstr hook. Also, the copyRegToReg hook was renamed to copyPhysReg + and simplified.
The code generator now has a "LocalStackSlotPass", which optimizes stack + slot access for targets (like ARM) that have limited stack displacement + addressing.
A new "PeepholeOptimizer" is available, which eliminates sign and zero + extends, and optimizes away compare instructions when the condition result + is available from a previous instruction.
Atomic operations now get legalized into simpler atomic operations if not + natively supported, easing the implementation burden on targets.
We have added two new bottom-up pre-allocation register pressure aware schedulers: +
1. The hybrid scheduler schedules aggressively to minimize schedule length when registers are available and avoid overscheduling in high pressure situations.
2. The instruction-level-parallelism scheduler schedules for maximum ILP when registers are available and avoid overscheduling in high pressure situations.
The tblgen type inference algorithm was rewritten to be more consistent and + diagnose more target bugs. If you have an out-of-tree backend, you may + find that it finds bugs in your target description. This support also + allows limited support for writing patterns for instructions that return + multiple results (e.g. a virtual register and a flag result). The + 'parallel' modifier in tblgen was removed, you should use the new support + for multiple results instead.
A new (experimental) "-rendermf" pass is available which renders a + MachineFunction into HTML, showing live ranges and other useful + details.
The new SubRegIndex tablegen class allows subregisters to be indexed + symbolically instead of numerically. If your target uses subregisters you + will need to adapt to use SubRegIndex when you upgrade to 2.8.
The -fast-isel instruction selection path (used at -O0 on X86) was rewritten + to work bottom-up on basic blocks instead of top down. This makes it + slightly faster (because the MachineDCE pass is not needed any longer) and + allows it to generate better code in some cases.

New features of the X86 target include: +

New features and major changes in the X86 target include:

The X86 backend now supports holding X87 floating point stack values in registers across basic blocks, dramatically improving performance of code - that uses long double, and when targetting CPUs that don't support SSE.
The X86 backend now uses a SSEDomainFix pass to optimize SSE operations. On + Nehalem ("Core i7") and newer CPUs there is a 2 cycle latency penalty on + using a register in a different domain than where it was defined. This pass + optimizes away these stalls.
The X86 backend now promotes 16-bit integer operations to 32-bits when + possible. This avoids 0x66 prefixes, which are slow on some + microarchitectures and bloat the code on all of them.
The X86 backend now supports the Microsoft "thiscall" calling convention, + and a calling convention to support + ghc.
The X86 backend supports a new "llvm.x86.int" intrinsic, which maps onto + the X86 "int $42" and "int3" instructions.
At the IR level, the <2 x float> datatype is now promoted and passed + around as a <4 x float> instead of being passed and returned as an MMX + vector. If you have a frontend that uses this, please pass and return a + <2 x i32> instead (using bitcasts).
When printing .s files in verbose assembly mode (the default for clang -S), + the X86 backend now decodes X86 shuffle instructions and prints human + readable comments after the most inscrutable of them, e.g.: + +
```
+  insertps $113, %xmm3, %xmm0 # xmm0 = zero,xmm0[1,2],xmm3[1]
+  unpcklps %xmm1, %xmm0       # xmm0 = xmm0[0],xmm1[0],xmm0[1],xmm1[1]
+  pshufd   $1, %xmm1, %xmm1   # xmm1 = xmm1[1,0,0,0]
+
```
+

This release includes a number of new APIs that are used internally, which - may also be useful for external clients. -

If you're already an LLVM user or developer with out-of-tree changes based +on LLVM 2.7, this section lists some "gotchas" that you may run into upgrading +from the previous release.

The build configuration machinery changed the output directory names. It + wasn't clear to many people that a "Release-Asserts" build was a release build + without asserts. To make this more clear, "Release" does not include + assertions and "Release+Asserts" does (likewise, "Debug" and + "Debug+Asserts").
The MSIL Backend was removed, it was unsupported and broken.
The ABCD, SSI, and SCCVN passes were removed. These were not fully + functional and their behavior has been or will be subsumed by the + LazyValueInfo pass.
The LLVM IR 'Union' feature was removed. While this is a desirable feature + for LLVM IR to support, the existing implementation was half baked and + barely useful. We'd really like anyone interested to resurrect the work and + finish it for a future release.
If you're used to reading .ll files, you'll probably notice that .ll file + dumps don't produce #uses comments anymore. To get them, run a .bc file + through "llvm-dis --show-annotations".
Target triples are now stored in a normalized form, and all inputs from + humans are expected to be normalized by Triple::normalize before being + stored in a module triple or passed to another library.

Other miscellaneous features include:

In addition, many APIs have changed in this release. Some of the major LLVM +API changes are:

LLVM 2.8 changes the internal order of operands in InvokeInst + and CallInst. + To be portable across releases, please use the CallSite class and the + high-level accessors, such as getCalledValue and + setUnwindDest. +
+ You can no longer pass use_iterators directly to cast<> (and similar), + because these routines tend to perform costly dereference operations more + than once. You have to dereference the iterators yourself and pass them in. +
+ llvm.memcpy.*, llvm.memset.*, llvm.memmove.* intrinsics take an extra + parameter now ("i1 isVolatile"), totaling 5 parameters, and the pointer + operands are now address-space qualified. + If you were creating these intrinsic calls and prototypes yourself (as opposed + to using Intrinsic::getDeclaration), you can use + UpgradeIntrinsicFunction/UpgradeIntrinsicCall to be portable across releases. +
+ SetCurrentDebugLocation takes a DebugLoc now instead of a MDNode. + Change your code to use + SetCurrentDebugLocation(DebugLoc::getFromDILocation(...)). +
+ The RegisterPass and RegisterAnalysisGroup templates are + considered deprecated, but continue to function in LLVM 2.8. Clients are + strongly advised to use the upcoming INITIALIZE_PASS() and + INITIALIZE_AG_PASS() macros instead. +
+ The constructor for the Triple class no longer tries to understand odd triple + specifications. Frontends should ensure that they only pass valid triples to + LLVM. The Triple::normalize utility method has been added to help front-ends + deal with funky triples. +
+ The signature of the GCMetadataPrinter::finishAssembly virtual + function changed: the raw_ostream and MCAsmInfo arguments + were dropped. GC plugins which compute stack maps must be updated to avoid + having the old definition overload the new signature. +
+ The signature of MemoryBuffer::getMemBuffer changed. Unfortunately + calls intended for the old version still compile, but will not work correctly, + leading to a confusing error about an invalid header in the bitcode. +
+ Some APIs were renamed: +
- llvm_report_error -> report_fatal_error
- llvm_install_error_handler -> install_fatal_error_handler
- llvm::DwarfExceptionHandling -> llvm::JITExceptionHandling
- VISIBILITY_HIDDEN -> LLVM_LIBRARY_VISIBILITY
+
+ Some public headers were renamed: +
- llvm/Assembly/AsmAnnotationWriter.h was renamed + to llvm/Assembly/AssemblyAnnotationWriter.h +

If you're already an LLVM user or developer with out-of-tree changes based -on LLVM 2.7, this section lists some "gotchas" that you may run into upgrading -from the previous release.

This section lists changes to the LLVM development infrastructure. This +mostly impacts users who actively work on LLVM or follow development on +mainline, but may also impact users who leverage the LLVM build infrastructure +or are interested in LLVM qualification.

.ll file doesn't produce #uses comments anymore, to get them, run a .bc file - through "llvm-dis --show-annotations".
MSIL Backend removed.
ABCD and SSI passes removed.
'Union' LLVM IR feature removed.
The default for make check is now to use + the lit testing tool, which is + part of LLVM itself. You can use lit directly as well, or use + the llvm-lit tool which is created as part of a Makefile or CMake + build (and knows how to find the appropriate tools). See the lit + documentation and the blog + post, and PR5217 + for more information.
The LLVM test-suite infrastructure has a new "simple" test format + (make TEST=simple). The new format is intended to require only a + compiler and not a full set of LLVM tools. This makes it useful for testing + released compilers, for running the test suite with other compilers (for + performance comparisons), and makes sure that we are testing the compiler as + users would see it. The new format is also designed to work using reference + outputs instead of comparison to a baseline compiler, which makes it run much + faster and makes it less system dependent.
Significant progress has been made on a new interface to running the + LLVM test-suite (aka the LLVM "nightly tests") using + the LNT infrastructure. The LNT + interface to the test-suite brings significantly improved reporting + capabilities for monitoring the correctness and generated code quality + produced by LLVM over time.

- -

In addition, many APIs have changed in this release. Some of the major LLVM -API changes are:

- -

Known Problems @@ -794,10 +1114,10 @@ components, please contact us on the LLVMdev list.

The Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze - backends are experimental.
llc "-filetype=asm" (the default) is the only - supported value for this option. XXX Update me
The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, SystemZ + and XCore backends are experimental.
llc "-filetype=obj" is experimental on all targets + other than darwin-i386 and darwin-x86_64.

The llvm-gcc 4.2 Ada compiler has basic functionality. However, this is not a -mature technology, and problems should be expected. For example:

The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being +actively maintained. If you are interested in Ada, we recommend that you +consider using dragonegg instead.