From: Sandra Loosemore Date: Sun, 11 Nov 2018 18:39:10 +0000 (-0500) Subject: re PR c/26366 (__builtin_expect needs better documentation) X-Git-Tag: basepoints/gcc-10~3151 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6157c37500dd889e46ded9a8eb357de9a71de0eb;p=thirdparty%2Fgcc.git re PR c/26366 (__builtin_expect needs better documentation) 2018-11-11 Sandra Loosemore PR c/26366 gcc/ * doc/extend.texi (Other Builtins): Document probability associated with __builtin_expect. From-SVN: r266017 --- diff --git a/gcc/ChangeLog b/gcc/ChangeLog index 67a6b80c0a44..4a8293fa47c8 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,9 @@ +2018-11-11 Sandra Loosemore + + PR c/26366 + * doc/extend.texi (Other Builtins): Document probability associated + with __builtin_expect. + 2018-11-11 Uros Bizjak PR target/87928 diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index 5ce506907d7d..022d0e0c121e 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -12121,6 +12121,12 @@ if (__builtin_expect (ptr != NULL, 1)) @noindent when testing pointer or floating-point values. + +For the purposes of branch prediction optimizations, the probability that +a @code{__builtin_expect} expression is true is controlled by GCC's +@code{builtin-expect-probability} parameter, which defaults to 90%. +You can also use @code{__builtin_expect_with_probability} to explicitly +assign a probability value to individual expressions. @end deftypefn @deftypefn {Built-in Function} long __builtin_expect_with_probability