docs/ReleaseNotes.rst

   1 ======================
   2 LLVM 3.4 Release Notes
   3 ======================
   4
   5 .. contents::
   6     :local:
   7
   8 Introduction
   9 ============
  10
  11 This document contains the release notes for the LLVM Compiler Infrastructure,
  12 release 3.4.  Here we describe the status of LLVM, including major improvements
  13 from the previous release, improvements in various subprojects of LLVM, and
  14 some of the current users of the code.  All LLVM releases may be downloaded
  15 from the `LLVM releases web site <http://llvm.org/releases/>`_.
  16
  17 For more information about LLVM, including information about the latest
  18 release, please check out the `main LLVM web site <http://llvm.org/>`_.  If you
  19 have questions or comments, the `LLVM Developer's Mailing List
  20 <http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_ is a good place to send
  21 them.
  22
  23 Note that if you are reading this file from a Subversion checkout or the main
  24 LLVM web page, this document applies to the *next* release, not the current
  25 one.  To see the release notes for a specific release, please see the `releases
  26 page <http://llvm.org/releases/>`_.
  27
  28 Non-comprehensive list of changes in this release
  29 =================================================
  30
  31 .. NOTE
  32    For small 1-3 sentence descriptions, just add an entry at the end of
  33    this list. If your description won't fit comfortably in one bullet
  34    point (e.g. maybe you would like to give an example of the
  35    functionality, or simply have a lot to talk about), see the `NOTE` below
  36    for adding a new subsection.
  37
  38 * This is expected to be the last release of LLVM which compiles using a C++98
  39   toolchain. We expect to start using some C++11 features in LLVM and other
  40   sub-projects starting after this release. That said, we are committed to
  41   supporting a reasonable set of modern C++ toolchains as the host compiler on
  42   all of the platforms. This will at least include Visual Studio 2012 on
  43   Windows, and Clang 3.1 or GCC 4.7.x on Mac and Linux. The final set of
  44   compilers (and the C++11 features they support) is not set in stone, but we
  45   wanted users of LLVM to have a heads up that the next release will involve
  46   a substantial change in the host toolchain requirements.
  47
  48 * The regression tests now fail if any command in a pipe fails. To disable it in
  49   a directory, just add ``config.pipefail = False`` to its ``lit.local.cfg``.
  50   See :doc:`Lit <CommandGuide/lit>` for the details.
  51
  52 * Support for exception handling has been removed from the old JIT. Use MCJIT
  53   if you need EH support.
  54
  55 * The R600 backend is not marked experimental anymore and is built by default.
  56
  57 * APFloat::isNormal() was renamed to APFloat::isFiniteNonZero() and
  58   APFloat::isIEEENormal() was renamed to APFloat::isNormal(). This ensures that
  59   APFloat::isNormal() conforms to IEEE-754R-2008.
  60
  61 * The library call simplification pass has been removed.  Its functionality
  62   has been integrated into the instruction combiner and function attribute
  63   marking passes.
  64
  65 * Support for building using Visual Studio 2008 has been dropped. Use VS 2010
  66   or later instead. For more information, see the `Getting Started using Visual
  67   Studio <GettingStartedVS.html>`_ page.
  68
  69 * The Loop Vectorizer that was previously enabled for -O3 is now enabled for
  70   -Os and -O2.
  71
  72 * The new SLP Vectorizer is now enabled by default.
  73
  74 * llvm-ar now uses the new Object library and produces archives and
  75   symbol tables in the gnu format.
  76
  77 * FileCheck now allows specifing -check-prefix multiple times. This
  78   helps reduce duplicate check lines when using multiple RUN lines.
  79
  80 * The bitcast instruction no longer allows casting between pointers
  81    with different address spaces. To achieve this, use the new
  82    addrspacecast instruction.
  83
  84 * Different sized pointers for different address spaces should now
  85   generally work. This is primarily useful for GPU targets.
  86
  87 * OCaml bindings have been significantly extended to cover almost all of the
  88   LLVM libraries.
  89
  90 * ... next change ...
  91
  92 .. NOTE
  93    If you would like to document a larger change, then you can add a
  94    subsection about it right here. You can copy the following boilerplate
  95    and un-indent it (the indentation causes it to be inside this comment).
  96
  97    Special New Feature
  98    -------------------
  99
 100    Makes programs 10x faster by doing Special New Thing.
 101
 102 Mips Target
 103 -----------
 104
 105 Support for the MIPS SIMD Architecture (MSA) has been added. MSA is supported
 106 through inline assembly, intrinsics with the prefix '__builtin_msa', and normal
 107 code generation.
 108
 109 For more information on MSA (including documentation for the instruction set),
 110 see the `MIPS SIMD page at Imagination Technologies
 111 <http://imgtec.com/mips/mips-simd.asp>`_
 112
 113 SPARC Target
 114 ------------
 115
 116 The SPARC backend got many improvements, namely
 117
 118 * experimental SPARC V9 backend
 119 * JIT support for SPARC
 120 * fp128 support
 121 * exception handling
 122 * TLS support
 123 * leaf functions optimization
 124 * bug fixes
 125
 126 External Open Source Projects Using LLVM 3.4
 127 ============================================
 128
 129 An exciting aspect of LLVM is that it is used as an enabling technology for
 130 a lot of other language and tools projects. This section lists some of the
 131 projects that have already been updated to work with LLVM 3.4.
 132
 133 DXR
 134 ---
 135
 136 `DXR <https://wiki.mozilla.org/DXR>`_ is Mozilla's code search and navigation
 137 tool, aimed at making sense of large projects like Firefox. It supports
 138 full-text and regex searches as well as structural queries like "Find all the
 139 callers of this function." Behind the scenes, it uses a custom trigram index,
 140 the re2 library, and structural data collected by a clang compiler plugin.
 141
 142 LDC - the LLVM-based D compiler
 143 -------------------------------
 144
 145 `D <http://dlang.org>`_ is a language with C-like syntax and static typing. It
 146 pragmatically combines efficiency, control, and modeling power, with safety and
 147 programmer productivity. D supports powerful concepts like Compile-Time Function
 148 Execution (CTFE) and Template Meta-Programming, provides an innovative approach
 149 to concurrency and offers many classical paradigms.
 150
 151 `LDC <http://wiki.dlang.org/LDC>`_ uses the frontend from the reference compiler
 152 combined with LLVM as backend to produce efficient native code. LDC targets
 153 x86/x86_64 systems like Linux, OS X, FreeBSD and Windows and also Linux/PPC64.
 154 Ports to other architectures like ARM and AArch64 are underway.
 155
 156 LibBeauty
 157 ---------
 158
 159 The `LibBeauty <http://www.libbeauty.com>`_ decompiler and reverse
 160 engineering tool currently utilises the LLVM disassembler and the LLVM IR
 161 Builder. The current aim of the project is to take a x86_64 binary ``.o`` file
 162 as input, and produce an equivalent LLVM IR ``.bc`` or ``.ll`` file as
 163 output. Support for ARM binary ``.o`` file as input will be added later.
 164
 165 Likely
 166 ------
 167
 168 `Likely <http://www.liblikely.org/>`_ is an open source domain specific
 169 language for image recognition.  Algorithms are just-in-time compiled using
 170 LLVM's MCJIT infrastructure to execute on single or multi-threaded CPUs as well
 171 as OpenCL SPIR or CUDA enabled GPUs. Likely exploits the observation that while
 172 image processing and statistical learning kernels must be written generically
 173 to handle any matrix datatype, at runtime they tend to be executed repeatedly
 174 on the same type.
 175
 176 Portable Computing Language (pocl)
 177 ----------------------------------
 178
 179 In addition to producing an easily portable open source OpenCL
 180 implementation, another major goal of `pocl <http://portablecl.org/>`_
 181 is improving performance portability of OpenCL programs with
 182 compiler optimizations, reducing the need for target-dependent manual
 183 optimizations. An important part of pocl is a set of LLVM passes used to
 184 statically parallelize multiple work-items with the kernel compiler, even in
 185 the presence of work-group barriers. This enables static parallelization of
 186 the fine-grained static concurrency in the work groups in multiple ways.
 187
 188 Portable Native Client (PNaCl)
 189 ------------------------------
 190
 191 `Portable Native Client (PNaCl) <http://www.chromium.org/nativeclient/pnacl>`_
 192 is a Chrome initiative to bring the performance and low-level control of native
 193 code to modern web browsers, without sacrificing the security benefits and
 194 portability of web applications. PNaCl works by compiling native C and C++ code
 195 to an intermediate representation using the LLVM clang compiler. This
 196 intermediate representation is a subset of LLVM bytecode that is wrapped into a
 197 portable executable, which can be hosted on a web server like any other website
 198 asset. When the site is accessed, Chrome fetches and translates the portable
 199 executable into an architecture-specific machine code optimized directly for
 200 the underlying device. PNaCl lets developers compile their code once to run on
 201 any hardware platform and embed their PNaCl application in any website,
 202 enabling developers to directly leverage the power of the underlying CPU and
 203 GPU.
 204
 205 TTA-based Co-design Environment (TCE)
 206 -------------------------------------
 207
 208 `TCE <http://tce.cs.tut.fi/>`_ is a toolset for designing new
 209 exposed datapath processors based on the Transport triggered architecture (TTA).
 210 The toolset provides a complete co-design flow from C/C++
 211 programs down to synthesizable VHDL/Verilog and parallel program binaries.
 212 Processor customization points include the register files, function units,
 213 supported operations, and the interconnection network.
 214
 215 TCE uses Clang and LLVM for C/C++/OpenCL C language support, target independent
 216 optimizations and also for parts of code generation. It generates
 217 new LLVM-based code generators "on the fly" for the designed processors and
 218 loads them in to the compiler backend as runtime libraries to avoid
 219 per-target recompilation of larger parts of the compiler chain.
 220
 221 WebCL Validator
 222 ---------------
 223
 224 `WebCL Validator <https://github.com/KhronosGroup/webcl-validator>`_ implements
 225 validation for WebCL C language which is a subset of OpenCL ES 1.1. Validator
 226 checks the correctness of WebCL C, and implements memory protection for it as a
 227 source-2-source transformation. The transformation converts WebCL to memory
 228 protected OpenCL. The protected OpenCL cannot access any memory ranges which
 229 were not allocated for it, and its memory is always initialized to prevent
 230 information leakage from other programs.
 231
 232
 233 Additional Information
 234 ======================
 235
 236 A wide variety of additional information is available on the `LLVM web page
 237 <http://llvm.org/>`_, in particular in the `documentation
 238 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 239 API documentation which is up-to-date with the Subversion version of the source
 240 code.  You can access versions of these documents specific to this release by
 241 going into the ``llvm/docs/`` directory in the LLVM tree.
 242
 243 If you have any questions or comments about LLVM, please feel free to contact
 244 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
 245