From b170e2de8339e239084420293f7657b85c74af74 Mon Sep 17 00:00:00 2001
From: Jakub Staszak
Date: Sun, 4 Dec 2011 18:29:26 +0000
Subject: [PATCH] Add 'llvm.expect' intrinsic description.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145792 91177308-0d34-0410-b5e6-96231b3b80d8
---
docs/LangRef.html | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/docs/LangRef.html b/docs/LangRef.html
index ed4e4d58214..d9e02bdeaca 100644
--- a/docs/LangRef.html
+++ b/docs/LangRef.html
@@ -306,6 +306,8 @@
'llvm.stackprotector' Intrinsic
'llvm.objectsize' Intrinsic
+
+ 'llvm.expect' Intrinsic
@@ -8205,11 +8207,35 @@ LLVM.
compile time.
+
+
+
+
+
Syntax:
+
+ declare i32 @llvm.expect.i32(i32 <val>, i32 <expected_val>)
+ declare i64 @llvm.expect.i64(i64 <val>, i64 <expected_val>)
+
+
+
Overview:
+
The llvm.expect intrinsic provides information about expected (the
+ most probable) value of val, which can be used by optimizers.
+
+
Arguments:
+
The llvm.expect intrinsic takes two arguments. The first
+ argument is a value. The second argument is an expected value, this needs to
+ be a constant value, variables are not allowed.
+
+
Semantics:
+
This intrinsic is lowered to the val.
+