Skip to content

Commit 0f6db8e

Browse files
Update function commentary to highlight poison behaviour.
1 parent e755af3 commit 0f6db8e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

llvm/include/llvm/IR/IRBuilder.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,11 +951,13 @@ class IRBuilderBase {
951951
}
952952

953953
/// Create an expression which evaluates to the number of elements in \p EC
954-
/// at runtime.
954+
/// at runtime. This can result in poison if type \p Ty is not big enough to
955+
/// hold the value.
955956
LLVM_ABI Value *CreateElementCount(Type *Ty, ElementCount EC);
956957

957958
/// Create an expression which evaluates to the number of units in \p Size
958-
/// at runtime. This works for both units of bits and bytes.
959+
/// at runtime. This works for both units of bits and bytes. This can result
960+
/// in poison if type \p Ty is not big enough to hold the value.
959961
LLVM_ABI Value *CreateTypeSize(Type *Ty, TypeSize Size);
960962

961963
/// Creates a vector of type \p DstType with the linear sequence <0, 1, ...>

0 commit comments

Comments
 (0)