| 
 | 1 | +============================  | 
 | 2 | +LLVM |release| Release Notes  | 
 | 3 | +============================  | 
 | 4 | + | 
 | 5 | +.. contents::  | 
 | 6 | +    :local:  | 
 | 7 | + | 
 | 8 | +.. only:: PreRelease  | 
 | 9 | + | 
 | 10 | +  .. warning::  | 
 | 11 | +     These are in-progress notes for the upcoming LLVM |version| release.  | 
 | 12 | +     Release notes for previous releases can be found on  | 
 | 13 | +     `the Download Page <https://releases.llvm.org/download.html>`_.  | 
 | 14 | + | 
 | 15 | + | 
 | 16 | +Introduction  | 
 | 17 | +============  | 
 | 18 | + | 
 | 19 | +This document contains the release notes for the LLVM Compiler Infrastructure,  | 
 | 20 | +release |release|.  Here we describe the status of LLVM, including major improvements  | 
 | 21 | +from the previous release, improvements in various subprojects of LLVM, and  | 
 | 22 | +some of the current users of the code.  All LLVM releases may be downloaded  | 
 | 23 | +from the `LLVM releases web site <https://llvm.org/releases/>`_.  | 
 | 24 | + | 
 | 25 | +For more information about LLVM, including information about the latest  | 
 | 26 | +release, please check out the `main LLVM web site <https://llvm.org/>`_.  If you  | 
 | 27 | +have questions or comments, the `Discourse forums  | 
 | 28 | +<https://discourse.llvm.org>`_ is a good place to ask  | 
 | 29 | +them.  | 
 | 30 | + | 
 | 31 | +Note that if you are reading this file from a Git checkout or the main  | 
 | 32 | +LLVM web page, this document applies to the *next* release, not the current  | 
 | 33 | +one.  To see the release notes for a specific release, please see the `releases  | 
 | 34 | +page <https://llvm.org/releases/>`_.  | 
 | 35 | + | 
 | 36 | +Non-comprehensive list of changes in this release  | 
 | 37 | +=================================================  | 
 | 38 | +.. NOTE  | 
 | 39 | +   For small 1-3 sentence descriptions, just add an entry at the end of  | 
 | 40 | +   this list. If your description won't fit comfortably in one bullet  | 
 | 41 | +   point (e.g. maybe you would like to give an example of the  | 
 | 42 | +   functionality, or simply have a lot to talk about), see the `NOTE` below  | 
 | 43 | +   for adding a new subsection.  | 
 | 44 | +
  | 
 | 45 | +* ...  | 
 | 46 | + | 
 | 47 | +Update on required toolchains to build LLVM  | 
 | 48 | +-------------------------------------------  | 
 | 49 | + | 
 | 50 | +Changes to the LLVM IR  | 
 | 51 | +----------------------  | 
 | 52 | + | 
 | 53 | +* The ``x86_mmx`` IR type has been removed. It will be translated to  | 
 | 54 | +  the standard vector type ``<1 x i64>`` in bitcode upgrade.  | 
 | 55 | + | 
 | 56 | +Changes to LLVM infrastructure  | 
 | 57 | +------------------------------  | 
 | 58 | + | 
 | 59 | +Changes to building LLVM  | 
 | 60 | +------------------------  | 
 | 61 | + | 
 | 62 | +Changes to TableGen  | 
 | 63 | +-------------------  | 
 | 64 | + | 
 | 65 | +Changes to Interprocedural Optimizations  | 
 | 66 | +----------------------------------------  | 
 | 67 | + | 
 | 68 | +Changes to the AArch64 Backend  | 
 | 69 | +------------------------------  | 
 | 70 | + | 
 | 71 | +* `.balign N, 0`, `.p2align N, 0`, `.align N, 0` in code sections will now fill  | 
 | 72 | +  the required alignment space with a sequence of `0x0` bytes (the requested  | 
 | 73 | +  fill value) rather than NOPs.  | 
 | 74 | + | 
 | 75 | +Changes to the AMDGPU Backend  | 
 | 76 | +-----------------------------  | 
 | 77 | + | 
 | 78 | +Changes to the ARM Backend  | 
 | 79 | +--------------------------  | 
 | 80 | + | 
 | 81 | +* `.balign N, 0`, `.p2align N, 0`, `.align N, 0` in code sections will now fill  | 
 | 82 | +  the required alignment space with a sequence of `0x0` bytes (the requested  | 
 | 83 | +  fill value) rather than NOPs.  | 
 | 84 | + | 
 | 85 | +Changes to the AVR Backend  | 
 | 86 | +--------------------------  | 
 | 87 | + | 
 | 88 | +Changes to the DirectX Backend  | 
 | 89 | +------------------------------  | 
 | 90 | + | 
 | 91 | +Changes to the Hexagon Backend  | 
 | 92 | +------------------------------  | 
 | 93 | + | 
 | 94 | +Changes to the LoongArch Backend  | 
 | 95 | +--------------------------------  | 
 | 96 | + | 
 | 97 | +Changes to the MIPS Backend  | 
 | 98 | +---------------------------  | 
 | 99 | + | 
 | 100 | +Changes to the PowerPC Backend  | 
 | 101 | +------------------------------  | 
 | 102 | + | 
 | 103 | +Changes to the RISC-V Backend  | 
 | 104 | +-----------------------------  | 
 | 105 | + | 
 | 106 | +* `.balign N, 0`, `.p2align N, 0`, `.align N, 0` in code sections will now fill  | 
 | 107 | +  the required alignment space with a sequence of `0x0` bytes (the requested  | 
 | 108 | +  fill value) rather than NOPs.  | 
 | 109 | + | 
 | 110 | +Changes to the WebAssembly Backend  | 
 | 111 | +----------------------------------  | 
 | 112 | + | 
 | 113 | +Changes to the Windows Target  | 
 | 114 | +-----------------------------  | 
 | 115 | + | 
 | 116 | +Changes to the X86 Backend  | 
 | 117 | +--------------------------  | 
 | 118 | + | 
 | 119 | +* `.balign N, 0x90`, `.p2align N, 0x90`, and `.align N, 0x90` in code sections  | 
 | 120 | +  now fill the required alignment space with repeating `0x90` bytes, rather than  | 
 | 121 | +  using optimised NOP filling. Optimised NOP filling fills the space with NOP  | 
 | 122 | +  instructions of various widths, not just those that use the `0x90` byte  | 
 | 123 | +  encoding. To use optimised NOP filling in a code section, leave off the  | 
 | 124 | +  "fillval" argument, i.e. `.balign N`, `.p2align N` or `.align N` respectively.  | 
 | 125 | + | 
 | 126 | +* Due to the removal of the ``x86_mmx`` IR type, functions with  | 
 | 127 | +  ``x86_mmx`` arguments or return values will use a different,  | 
 | 128 | +  incompatible, calling convention ABI. Such functions are not  | 
 | 129 | +  generally seen in the wild (Clang never generates them!), so this is  | 
 | 130 | +  not expected to result in real-world compatibility problems.  | 
 | 131 | + | 
 | 132 | +Changes to the OCaml bindings  | 
 | 133 | +-----------------------------  | 
 | 134 | + | 
 | 135 | +Changes to the Python bindings  | 
 | 136 | +------------------------------  | 
 | 137 | + | 
 | 138 | +Changes to the C API  | 
 | 139 | +--------------------  | 
 | 140 | + | 
 | 141 | +* The following symbols are deleted due to the removal of the ``x86_mmx`` IR type:  | 
 | 142 | + | 
 | 143 | +  * ``LLVMX86_MMXTypeKind``  | 
 | 144 | +  * ``LLVMX86MMXTypeInContext``  | 
 | 145 | +  * ``LLVMX86MMXType``  | 
 | 146 | + | 
 | 147 | +Changes to the CodeGen infrastructure  | 
 | 148 | +-------------------------------------  | 
 | 149 | + | 
 | 150 | +Changes to the Metadata Info  | 
 | 151 | +---------------------------------  | 
 | 152 | + | 
 | 153 | +Changes to the Debug Info  | 
 | 154 | +---------------------------------  | 
 | 155 | + | 
 | 156 | +Changes to the LLVM tools  | 
 | 157 | +---------------------------------  | 
 | 158 | + | 
 | 159 | +Changes to LLDB  | 
 | 160 | +---------------------------------  | 
 | 161 | + | 
 | 162 | +Changes to BOLT  | 
 | 163 | +---------------------------------  | 
 | 164 | + | 
 | 165 | +Changes to Sanitizers  | 
 | 166 | +---------------------  | 
 | 167 | + | 
 | 168 | +Other Changes  | 
 | 169 | +-------------  | 
 | 170 | + | 
 | 171 | +External Open Source Projects Using LLVM 19  | 
 | 172 | +===========================================  | 
 | 173 | + | 
 | 174 | +* A project...  | 
 | 175 | + | 
 | 176 | +Additional Information  | 
 | 177 | +======================  | 
 | 178 | + | 
 | 179 | +A wide variety of additional information is available on the `LLVM web page  | 
 | 180 | +<https://llvm.org/>`_, in particular in the `documentation  | 
 | 181 | +<https://llvm.org/docs/>`_ section.  The web page also contains versions of the  | 
 | 182 | +API documentation which is up-to-date with the Git version of the source  | 
 | 183 | +code.  You can access versions of these documents specific to this release by  | 
 | 184 | +going into the ``llvm/docs/`` directory in the LLVM tree.  | 
 | 185 | + | 
 | 186 | +If you have any questions or comments about LLVM, please feel free to contact  | 
 | 187 | +us via the `Discourse forums <https://discourse.llvm.org>`_.  | 
0 commit comments