diff options
| author | Michael Gottesman <mgottesman@apple.com> | 2013-03-26 00:34:27 +0000 |
|---|---|---|
| committer | Michael Gottesman <mgottesman@apple.com> | 2013-03-26 00:34:27 +0000 |
| commit | 872b4e57856e903e286e1c77f55535004357dc0b (patch) | |
| tree | 6855dde08b6f47113ea936f639288b6abd83432d /docs | |
| parent | d4584c9e5658887ec50c43760c988d04eaa13e34 (diff) | |
| download | llvm-872b4e57856e903e286e1c77f55535004357dc0b.tar.gz llvm-872b4e57856e903e286e1c77f55535004357dc0b.tar.bz2 llvm-872b4e57856e903e286e1c77f55535004357dc0b.tar.xz | |
Added documentation to LangRef for the intrinsic llvm.ptr.annotation.* which for some reason was never written.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@177950 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/LangRef.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/LangRef.rst b/docs/LangRef.rst index 03004f66df..659f02afb9 100644 --- a/docs/LangRef.rst +++ b/docs/LangRef.rst @@ -8342,6 +8342,46 @@ strings. This can be useful for special purpose optimizations that want to look for these annotations. These have no other defined use; they are ignored by code generation and optimization. +'``llvm.ptr.annotation.*``' Intrinsic +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Syntax: +""""""" + +This is an overloaded intrinsic. You can use '``llvm.ptr.annotation``' on a +pointer to an integer of any width. *NOTE* you must specify an address space for +the pointer. The identifier for the default address space is the integer +'``0``'. + +:: + + declare i8* @llvm.ptr.annotation.p<address space>i8(i8* <val>, i8* <str>, i8* <str>, i32 <int>) + declare i16* @llvm.ptr.annotation.p<address space>i16(i16* <val>, i8* <str>, i8* <str>, i32 <int>) + declare i32* @llvm.ptr.annotation.p<address space>i32(i32* <val>, i8* <str>, i8* <str>, i32 <int>) + declare i64* @llvm.ptr.annotation.p<address space>i64(i64* <val>, i8* <str>, i8* <str>, i32 <int>) + declare i256* @llvm.ptr.annotation.p<address space>i256(i256* <val>, i8* <str>, i8* <str>, i32 <int>) + +Overview: +""""""""" + +The '``llvm.ptr.annotation``' intrinsic. + +Arguments: +"""""""""" + +The first argument is a pointer to an integer value of arbitrary bitwidth +(result of some expression), the second is a pointer to a global string, the +third is a pointer to a global string which is the source file name, and the +last argument is the line number. It returns the value of the first argument. + +Semantics: +"""""""""" + +This intrinsic allows annotation of a pointer to an integer with arbitrary +strings. This can be useful for special purpose optimizations that want to look +for these annotations. These have no other defined use; they are ignored by code +generation and optimization. + '``llvm.annotation.*``' Intrinsic ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |