From: Andi Kleen <ak@linux.intel.com>
To: gcc-patches@gcc.gnu.org
Cc: richard.guenther@gmail.com, nathan@acm.org, josmyers@redhat.com,
richard.sandiford@arm.com, jason@redhat.com,
Andi Kleen <ak@linux.intel.com>
Subject: [PATCH v6 8/8] Add documentation for musttail attribute
Date: Tue, 21 May 2024 07:28:41 -0700 [thread overview]
Message-ID: <20240521143203.2893096-9-ak@linux.intel.com> (raw)
In-Reply-To: <20240521143203.2893096-1-ak@linux.intel.com>
gcc/ChangeLog:
* doc/extend.texi: Document [[musttail]]
---
gcc/doc/extend.texi | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index e290265d68d3..f3df7688edf1 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -9839,7 +9839,7 @@ same manner as the @code{deprecated} attribute.
@section Statement Attributes
@cindex Statement Attributes
-GCC allows attributes to be set on null statements. @xref{Attribute Syntax},
+GCC allows attributes to be set on statements. @xref{Attribute Syntax},
for details of the exact syntax for using attributes. Other attributes are
available for functions (@pxref{Function Attributes}), variables
(@pxref{Variable Attributes}), labels (@pxref{Label Attributes}), enumerators
@@ -9896,6 +9896,23 @@ foo (int x, int y)
@code{y} is not actually incremented and the compiler can but does not
have to optimize it to just @code{return 42 + 42;}.
+@cindex @code{musttail} statement attribute
+@item musttail
+
+The @code{gnu::musttail} or @code{clang::musttail} attribute
+can be applied to a @code{return} statement with a return-value expression
+that is a function call. It asserts that the call must be a tail call that
+does not allocate extra stack space.
+
+@smallexample
+[[gnu::musttail]] return foo();
+@end smallexample
+
+If the compiler cannot generate a tail call it generates
+an error. On some targets they may not be supported.
+Tail calls cannot reference locals in memory, which may affect
+builds without optimization when passing structures that
+would fit into registers.
@end table
@node Attribute Syntax
@@ -10019,7 +10036,9 @@ the constant expression, if present.
@subsubheading Statement Attributes
In GNU C, an attribute specifier list may appear as part of a null
-statement. The attribute goes before the semicolon.
+statement. The attribute goes before the semicolon.
+Some attributes in new style syntax are also supported
+on non-null statements.
@subsubheading Type Attributes
--
2.44.0
prev parent reply other threads:[~2024-05-21 14:32 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-21 14:28 Musttail patchkit v6 Andi Kleen
2024-05-21 14:28 ` [PATCH v6 1/8] Improve must tail in RTL backend Andi Kleen
2024-05-29 13:39 ` Michael Matz
2024-05-31 18:00 ` Andi Kleen
2024-06-03 17:02 ` Michael Matz
2024-06-03 17:17 ` Jakub Jelinek
2024-06-04 13:49 ` Michael Matz
2024-06-03 17:31 ` Andi Kleen
2024-05-21 14:28 ` [PATCH v6 2/8] Add a musttail generic attribute to the c-attribs table Andi Kleen
2024-05-21 14:28 ` [PATCH v6 3/8] C++: Support clang compatible [[musttail]] (PR83324) Andi Kleen
2024-05-21 14:28 ` [PATCH v6 4/8] C: Implement musttail attribute for returns Andi Kleen
2024-05-21 14:28 ` [PATCH v6 5/8] Add tests for C/C++ musttail attributes Andi Kleen
2024-05-21 14:28 ` [PATCH v6 6/8] Enable musttail tail conversion even when not optimizing Andi Kleen
2024-05-21 14:28 ` [PATCH v6 7/8] Give better error messages for musttail Andi Kleen
2024-06-05 4:52 ` Andi Kleen
2024-05-21 14:28 ` Andi Kleen [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240521143203.2893096-9-ak@linux.intel.com \
--to=ak@linux.intel.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=jason@redhat.com \
--cc=josmyers@redhat.com \
--cc=nathan@acm.org \
--cc=richard.guenther@gmail.com \
--cc=richard.sandiford@arm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).