llvm-project/clang/docs/ReleaseNotes.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

415 lines
16 KiB
ReStructuredText
Raw Normal View History

2021-05-03 18:32:36 +02:00
========================================
Clang 14.0.0 (In-Progress) Release Notes
========================================
.. contents::
:local:
:depth: 2
Written by the `LLVM Team <https://llvm.org/>`_
.. warning::
These are in-progress notes for the upcoming Clang 14 release.
Release notes for previous releases can be found on
`the Download Page <https://releases.llvm.org/download.html>`_.
Introduction
============
This document contains the release notes for the Clang C/C++/Objective-C
frontend, part of the LLVM Compiler Infrastructure, release 14.0.0. Here we
describe the status of Clang in some detail, including major
improvements from the previous release and new feature work. For the
general LLVM release notes, see `the LLVM
documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM
releases may be downloaded from the `LLVM releases web
site <https://llvm.org/releases/>`_.
For more information about Clang or LLVM, including information about the
latest release, please see the `Clang Web Site <https://clang.llvm.org>`_ or the
`LLVM Web Site <https://llvm.org>`_.
Note that if you are reading this file from a Git checkout or the
main Clang web page, this document applies to the *next* release, not
the current one. To see the release notes for a specific release, please
see the `releases page <https://llvm.org/releases/>`_.
What's New in Clang 14.0.0?
===========================
Some of the major new features and improvements to Clang are listed
here. Generic improvements to Clang as a whole or to its underlying
infrastructure are described first, followed by language-specific
sections with improvements to Clang's support for those languages.
Major New Features
------------------
- ...
Improvements to Clang's diagnostics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- -Wbitwise-instead-of-logical (part of -Wbool-operation) warns about use of bitwise operators with boolean operands which have side effects.
- Added diagnostic groups to control diagnostics for attribute extensions by
adding groups ``-Wc++N-attribute-extensions`` (where ``N`` is the standard
release being diagnosed against). These new groups are automatically implied
when passing ``-Wc++N-extensions``. Resolves PR33518.
- Support ``-Wdeclaration-after-statement`` with C99 and later standards, and
not just C89, matching GCC's behaviour. A notable usecase is supporting style
guides that forbid mixing declarations and code, but want to move to newer C
standards.
Non-comprehensive list of changes in this release
-------------------------------------------------
- Maximum _ExtInt size was decreased from 16,777,215 bits to 8,388,608 bits.
Motivation for this was discussed in PR51829.
- Configuration file syntax extended with ``<CFGDIR>`` token. This expands to
the base path of the current config file. See :ref:`configuration-files` for
details.
New Compiler Flags
------------------
- Clang plugin arguments can now be passed through the compiler driver via
``-fplugin-arg-pluginname-arg``, similar to GCC's ``-fplugin-arg``.
Deprecated Compiler Flags
-------------------------
- -Wweak-template-vtables has been deprecated and no longer has any effect. The
flag will be removed in the next release.
Modified Compiler Flags
-----------------------
- Support has been added for the following processors (``-mcpu`` identifiers in parentheses):
- RISC-V SiFive E20 (``sifive-e20``).
- RISC-V SiFive E21 (``sifive-e21``).
- RISC-V SiFive E24 (``sifive-e24``).
- RISC-V SiFive E34 (``sifive-e34``).
- RISC-V SiFive S21 (``sifive-s21``).
- RISC-V SiFive S51 (``sifive-s51``).
- RISC-V SiFive S54 (``sifive-s54``).
- RISC-V SiFive S76 (``sifive-s76``).
- Support has been added for the following architectures (``-march`` identifiers in parentheses):
- Armv9-A (``armv9-a``).
- Armv9.1-A (``armv9.1-a``).
- Armv9.2-A (``armv9.2-a``).
Removed Compiler Flags
-------------------------
- ...
New Pragmas in Clang
--------------------
- ...
Attribute Changes in Clang
--------------------------
- Attributes loaded as clang plugins which are sensitive to LangOpts must
now override ``acceptsLangOpts`` instead of ``diagLangOpts``.
Returning false will produce a generic "attribute ignored" diagnostic, as
with clang's built-in attributes.
If plugins want to provide richer diagnostics, they can do so when the
attribute is handled instead, e.g. in ``handleDeclAttribute``.
(This was changed in order to better support attributes in code completion).
- __has_cpp_attribute, __has_c_attribute, __has_attribute, and __has_declspec
will now macro expand their argument. This causes a change in behavior for
code using ``__has_cpp_attribute(__clang__::attr)`` (and same for
``__has_c_attribute``) where it would previously expand to ``0`` for all
attributes, but will now issue an error due to the expansion of the
predefined ``__clang__`` macro.
Windows Support
---------------
- An MSVC compatibility workaround for C++ operator names was removed. As a
result, the ``<query.h>`` Windows SDK header may not compile out of the box.
Users should use a recent SDK and pass ``-DQUERY_H_RESTRICTION_PERMISSIVE``
or pass ``/permissive`` to disable C++ operator names altogether. See
`PR42427 <https://llvm.org/pr42427>` for more info.
[clang-cl] Support the /HOTPATCH flag This patch adds support for the MSVC /HOTPATCH flag: https://docs.microsoft.com/sv-se/cpp/build/reference/hotpatch-create-hotpatchable-image?view=msvc-170&viewFallbackFrom=vs-2019 The flag is translated to a new -fms-hotpatch flag, which in turn adds a 'patchable-function' attribute for each function in the TU. This is then picked up by the PatchableFunction pass which would generate a TargetOpcode::PATCHABLE_OP of minsize = 2 (which means the target instruction must resolve to at least two bytes). TargetOpcode::PATCHABLE_OP is only implemented for x86/x64. When targetting ARM/ARM64, /HOTPATCH isn't required (instructions are always 2/4 bytes and suitable for hotpatching). Additionally, when using /Z7, we generate a 'hot patchable' flag in the CodeView debug stream, in the S_COMPILE3 record. This flag is then picked up by LLD (or link.exe) and is used in conjunction with the linker /FUNCTIONPADMIN flag to generate extra space before each function, to accommodate for live patching long jumps. Please see: https://github.com/llvm/llvm-project/blob/d703b922961e0d02a5effdd4bfbb23ad50a3cc9f/lld/COFF/Writer.cpp#L1298 The outcome is that we can finally use Live++ or Recode along with clang-cl. NOTE: It seems that MSVC cl.exe always enables /HOTPATCH on x64 by default, although if we did the same I thought we might generate sub-optimal code (if this flag was active by default). Additionally, MSVC always generates a .debug$S section and a S_COMPILE3 record, which Clang doesn't do without /Z7. Therefore, the following MSVC command-line "cl /c file.cpp" would have to be written with Clang such as "clang-cl /c file.cpp /HOTPATCH /Z7" in order to obtain the same result. Depends on D43002, D80833 and D81301 for the full feature. Differential Revision: https://reviews.llvm.org/D116511
2022-01-20 11:04:46 -05:00
- Add support for MSVC-compatible ``/hotpatch`` flag in clang-cl, and equivalent
-cc1 flag ``-fms-hotpatch``. Along with the linker flag ``/functionpadmin``
this creates executable images suitable for runtime code patching. This flag
is only required for x86/x64 targets; ARM/ARM64 simply needs the linker
``/functionpadmin``.
With this addition, clang-cl can be used in live code patching scenarios,
along with tools such as Live++ or Recode. Microsoft Edit and Continue isn't
currently supported.
C Language Changes in Clang
---------------------------
- The value of ``__STDC_VERSION__`` has been bumped to ``202000L`` when passing
``-std=c2x`` so that it can be distinguished from C17 mode. This value is
expected to change again when C23 is published.
- Wide multi-characters literals such as ``L'ab'`` that would previously be interpreted as ``L'b'``
are now ill-formed in all language modes. The motivation for this change is outlined in
`P2362 <wg21.link/P2362>`_.
[Clang] add support for error+warning fn attrs Add support for the GNU C style __attribute__((error(""))) and __attribute__((warning(""))). These attributes are meant to be put on declarations of functions whom should not be called. They are frequently used to provide compile time diagnostics similar to _Static_assert, but which may rely on non-ICE conditions (ie. relying on compiler optimizations). This is also similar to diagnose_if function attribute, but can diagnose after optimizations have been run. While users may instead simply call undefined functions in such cases to get a linkage failure from the linker, these provide a much more ergonomic and actionable diagnostic to users and do so at compile time rather than at link time. Users instead may be able use inline asm .err directives. These are used throughout the Linux kernel in its implementation of BUILD_BUG and BUILD_BUG_ON macros. These macros generally cannot be converted to use _Static_assert because many of the parameters are not ICEs. The Linux kernel still needs to be modified to make use of these when building with Clang; I have a patch that does so I will send once this feature is landed. To do so, we create a new IR level Function attribute, "dontcall" (both error and warning boil down to one IR Fn Attr). Then, similar to calls to inline asm, we attach a !srcloc Metadata node to call sites of such attributed callees. The backend diagnoses these during instruction selection, while we still know that a call is a call (vs say a JMP that's a tail call) in an arch agnostic manner. The frontend then reconstructs the SourceLocation from that Metadata, and determines whether to emit an error or warning based on the callee's attribute. Link: https://bugs.llvm.org/show_bug.cgi?id=16428 Link: https://github.com/ClangBuiltLinux/linux/issues/1173 Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D106030
2021-08-25 10:18:13 -07:00
- Support for ``__attribute__((error("")))`` and
``__attribute__((warning("")))`` function attributes have been added.
- The maximum allowed alignment has been increased from 2^29 to 2^32.
- Clang now supports the ``_BitInt(N)`` family of bit-precise integer types
from C23. This type was previously exposed as ``_ExtInt(N)``, which is now a
deprecated alias for ``_BitInt(N)`` (so diagnostics will mention ``_BitInt``
even if source uses ``_ExtInt``). ``_BitInt(N)`` and ``_ExtInt(N)`` are the
same types in all respects beyond spelling and the deprecation warning.
``_BitInt(N)`` is supported as an extension in older C modes and in all C++
modes. Note: the ABI for ``_BitInt(N)`` is still in the process of being
stabilized, so this type should not yet be used in interfaces that require
ABI stability.
2022-01-11 11:51:22 -08:00
- When using ``asm goto`` with outputs whose constraint modifier is ``"+"``, we
now change the numbering of the labels to occur after hidden tied inputs for
better compatibility with GCC. For better portability between different
compilers and versions, symbolic references rather than numbered references
should be preferred. See
`this thread <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=103640>` for more
info.
- Implemented `WG14 N2412 <http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2412.pdf>`_,
which adds ``*_WIDTH`` macros to limits.h and stdint.h to report the bit
width of various integer datatypes.
- The ``ATOMIC_VAR_INIT`` macro from ``<stdatomic.h>`` is now diagnosed as
deprecated in C17 and later. The diagnostic can be disabled by defining the
``_CLANG_DISABLE_CRT_DEPRECATION_WARNINGS`` macro prior to including the
header.
C++ Language Changes in Clang
-----------------------------
- ...
C++20 Feature Support
^^^^^^^^^^^^^^^^^^^^^
- The ``ATOMIC_VAR_INIT`` and ``ATOMIC_FLAG_INIT`` macros from the C standard
library ``<stdatomic.h>`` header are now diagnosed as deprecated in C++20 and
later. Note, the behavior is specific to the inclusion of ``<stdatomic.h>``
in C++ code; the STL ``<atomic>`` header also controls the behavior of these
macros and is not affected by these changes. The ``<stdatomic.h>`` diagnostic
can be disabled by defining the ``_CLANG_DISABLE_CRT_DEPRECATION_WARNINGS``
macro prior to including the header.
C++2b Feature Support
^^^^^^^^^^^^^^^^^^^^^
- Implemented `P1938R3: if consteval <https://wg21.link/P1938R3>`_.
- Implemented `P2360R0: Extend init-statement to allow alias-declaration <https://wg21.link/P2360R0>`_.
CUDA Language Changes in Clang
2021-08-23 13:45:13 -07:00
------------------------------
- Clang now supports CUDA versions up to 11.5.
- Default GPU architecture has been changed from sm_20 to sm_35.
Objective-C Language Changes in Clang
-------------------------------------
OpenCL C Language Changes in Clang
----------------------------------
...
ABI Changes in Clang
--------------------
- The ``_ExtInt(N)`` extension has been standardized in C23 as ``_BitInt(N)``.
2021-12-07 07:56:40 -05:00
The mangling of this type in C++ has accordingly changed: under the Microsoft
ABI it is now mangled using the ``_BitInt`` spelling, and under the Itanium ABI
it is now mangled using a dedicated production. Note: the ABI for ``_BitInt(N)``
is still in the process of being stabilized, so this type should not yet be
used in interfaces that require ABI stability.
OpenMP Support in Clang
-----------------------
- ``clang-nvlink-wrapper`` tool introduced to support linking of cubin files archived in an archive. See :doc:`ClangNvlinkWrapper`.
CUDA Support in Clang
---------------------
- ...
X86 Support in Clang
--------------------
- Support for ``AVX512-FP16`` instructions has been added.
Arm and AArch64 Support in Clang
--------------------------------
- Support has been added for the following processors (command-line identifiers in parentheses):
- Arm Cortex-A510 (``cortex-a510``)
- Arm Cortex-X2 (``cortex-x2``)
- Arm Cortex-A710 (``cortex-A710``)
- The -mtune flag is no longer ignored for AArch64. It is now possible to
tune code generation for a particular CPU with -mtune without setting any
architectural features. For example, compiling with
"-mcpu=generic -mtune=cortex-a57" will not enable any Cortex-A57 specific
architecture features, but will enable certain optimizations specific to
Cortex-A57 CPUs and enable the use of a more accurate scheduling model.
Floating Point Support in Clang
-------------------------------
- The default setting of FP contraction (FMA) is now -ffp-contract=on (for
languages other than CUDA/HIP) even when optimization is off. Previously,
the default behavior was equivalent to -ffp-contract=off (-ffp-contract
was not set).
Related to this, the switch -ffp-model=precise now implies -ffp-contract=on
rather than -ffp-contract=fast, and the documentation of these features has
been clarified. Previously, the documentation claimed that -ffp-model=precise
was the default, but this was incorrect because the precise model implied
-ffp-contract=fast, whereas the (now corrected) default behavior is
-ffp-contract=on.
-ffp-model=precise is now exactly the default mode of the compiler.
- -fstrict-float-cast-overflow no longer has target specific behavior. Clang
will saturate towards the smallest and largest representable integer values.
NaNs will be converted to zero.
Internal API Changes
--------------------
- A new sugar ``Type`` AST node represents types accessed via a C++ using
declaration. Given code ``using std::error_code; error_code x;``, ``x`` has
a ``UsingType`` which desugars to the previous ``RecordType``.
Removed a RecursiveASTVisitor feature to visit operator kinds with different methods Summary: This feature was only used in two places, but contributed a non-trivial amount to the complexity of RecursiveASTVisitor, and was buggy (see my recent patches where I was fixing the bugs that I noticed). I don't think the convenience benefit of this feature is worth the complexity. Besides complexity, another issue with the current state of RecursiveASTVisitor is the non-uniformity in how it handles different AST nodes. All AST nodes follow a regular pattern, but operators are special -- and this special behavior not documented. Correct usage of RecursiveASTVisitor relies on shadowing member functions with specific names and signatures. Near misses don't cause any compile-time errors, incorrectly named or typed methods are just silently ignored. Therefore, predictability of RecursiveASTVisitor API is quite important. This change reduces the size of the `clang` binary by 38 KB (0.2%) in release mode, and by 7 MB (0.3%) in debug mode. The `clang-tidy` binary is reduced by 205 KB (0.3%) in release mode, and by 5 MB (0.4%) in debug mode. I don't think these code size improvements are significant enough to justify this change on its own (for me, the primary motivation is reducing code complexity), but they I think are a nice side-effect. Reviewers: rsmith, sammccall, ymandel, aaron.ballman Reviewed By: rsmith, sammccall, ymandel, aaron.ballman Subscribers: cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D82921
2020-07-03 17:01:01 +02:00
Build System Changes
--------------------
- Linux distros can specify ``-DCLANG_DEFAULT_PIE_ON_LINUX=On`` to use ``-fPIE`` and
``-pie`` by default. This matches GCC installations on many Linux distros
(configured with ``--enable-default-pie``).
(`D113372 <https://reviews.llvm.org/D113372>`_)
AST Matchers
------------
- ``TypeLoc`` AST Matchers are now available. These matchers provide helpful
utilities for matching ``TypeLoc`` nodes, such as the ``pointerTypeLoc``
matcher or the ``hasReturnTypeLoc`` matcher. The addition of these matchers
was made possible by changes to the handling of ``TypeLoc`` nodes that
allows them to enjoy the same static type checking as other AST node kinds.
- ``LambdaCapture`` AST Matchers are now available. These matchers allow for
the binding of ``LambdaCapture`` nodes. The ``LambdaCapture`` matchers added
include the ``lambdaCapture`` node matcher, the ``capturesVar`` traversal
matcher, and ``capturesThis`` narrowing matcher.
- The ``hasAnyCapture`` matcher now only accepts an inner matcher of type
``Matcher<LambdaCapture>``. The matcher originally accepted an inner matcher
of type ``Matcher<CXXThisExpr>`` or ``Matcher<VarDecl>``.
- The ``usingType`` matcher is now available and needed to refer to types that
are referred to via using C++ using declarations.
The associated ``UsingShadowDecl`` can be matched using ``throughUsingDecl``
and the underlying ``Type`` with ``hasUnderlyingType``.
``hasDeclaration`` continues to see through the alias and apply to the
underlying type.
- Added the ``isConsteval`` matcher to match ``consteval`` function
declarations as well as `if consteval` and `if ! consteval` statements.
clang-format
------------
- Option ``AllowShortEnumsOnASingleLine: false`` has been improved, it now
correctly places the opening brace according to ``BraceWrapping.AfterEnum``.
[clang-format] Add basic support for formatting JSON I find as I develop I'm moving between many different languages C++,C#,JavaScript all the time. As I move between the file types I like to keep `clang-format` as my formatting tool of choice. (hence why I initially added C# support in {D58404}) I know those other languages have their own tools but I have to learn them all, and I have to work out how to configure them, and they may or may not have integration into my IDE or my source code integration. I am increasingly finding that I'm editing additional JSON files as part of my daily work and my editor and git commit hooks are just not setup to go and run [[ https://stedolan.github.io/jq/ | jq ]], So I tend to go to [[ https://jsonformatter.curiousconcept.com/ | JSON Formatter ]] and copy and paste back and forth. To get nicely formatted JSON. This is a painful process and I'd like a new one that causes me much less friction. This has come up from time to time: {D10543} https://stackoverflow.com/questions/35856565/clang-format-a-json-file https://bugs.llvm.org/show_bug.cgi?id=18699 I would like to stop having to do that and have formatting JSON as a first class clang-format support `Language` (even if it has minimal style settings at present). This revision adds support for formatting JSON using the inbuilt JSON serialization library of LLVM, With limited control at present only over the indentation level This adds an additional Language into the .clang-format file to separate the settings from your other supported languages. Reviewed By: HazardyKnusperkeks Differential Revision: https://reviews.llvm.org/D93528
2021-06-26 15:20:17 +01:00
- Option ``AlignAfterOpenBracket: BlockIndent`` has been added. If set, it will
always break after an open bracket, if the parameters don't fit on a single
line. Closing brackets will be placed on a new line.
- Option ``QualifierAlignment`` has been added in order to auto-arrange the
positioning of specifiers/qualifiers
`const` `volatile` `static` `inline` `constexpr` `restrict`
in variable and parameter declarations to be either ``Right`` aligned
or ``Left`` aligned or ``Custom`` using ``QualifierOrder``.
- Option ``QualifierOrder`` has been added to allow the order
`const` `volatile` `static` `inline` `constexpr` `restrict`
to be controlled relative to the `type`.
- Option ``RemoveBracesLLVM`` has been added to remove optional braces of
control statements for the LLVM style.
- Option ``SeparateDefinitionBlocks`` has been added to insert or remove empty
lines between definition blocks including functions, classes, structs, enums,
and namespaces.
- Add a ``Custom`` style to ``SpaceBeforeParens``, to better configure the
space before parentheses. The custom options can be set using
``SpaceBeforeParensOptions``.
- The command line argument `-style=<string>` has been extended so that a specific
format file at location <format_file_path> can be selected. This is supported
via the syntax: `-style=file:<format_file_path>`.
- Improved C++20 Modules and Coroutines support.
- Option ``AfterOverloadedOperator`` has been added in ``SpaceBeforeParensOptions``
to allow space between overloaded operator and opening parentheses.
libclang
--------
- ...
Static Analyzer
---------------
- ...
.. _release-notes-ubsan:
Undefined Behavior Sanitizer (UBSan)
------------------------------------
Core Analysis Improvements
==========================
- ...
New Issues Found
================
- ...
Python Binding Changes
----------------------
The following methods have been added:
- ...
Significant Known Problems
==========================
Additional Information
======================
A wide variety of additional information is available on the `Clang web
page <https://clang.llvm.org/>`_. The web page contains versions of the
2020-03-22 22:18:40 +01:00
API documentation which are up-to-date with the Git version of
the source code. You can access versions of these documents specific to
this release by going into the "``clang/docs/``" directory in the Clang
tree.
If you have any questions or comments about Clang, please feel free to
contact us via the `mailing
list <https://lists.llvm.org/mailman/listinfo/cfe-dev>`_.