From c515c80fda3530cf3f562e63012a7e02781fbc17 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Sun, 4 Aug 2019 18:14:43 -0600 Subject: perlapi: Document LIKELY, UNLIKELY --- perl.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'perl.h') diff --git a/perl.h b/perl.h index 746ce980a4..937ad17065 100644 --- a/perl.h +++ b/perl.h @@ -3514,8 +3514,25 @@ EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex) #else # define EXPECT(expr,val) (expr) #endif + +/* +=head1 Miscellaneous Functions + +=for apidoc AmU|bool|LIKELY|const bool expr + +Returns the input unchanged, but at the same time it gives a branch prediction +hint to the compiler that this condition is likely to be true. + +=for apidoc AmU|bool|UNLIKELY|const bool expr + +Returns the input unchanged, but at the same time it gives a branch prediction +hint to the compiler that this condition is likely to be false. + +=cut +*/ #define LIKELY(cond) EXPECT(cBOOL(cond),TRUE) #define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE) + #ifdef HAS_BUILTIN_CHOOSE_EXPR /* placeholder */ #endif -- cgit v1.2.1