Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 3 | <html> |
| 4 | <head> |
| 5 | <title>LLVM Assembly Language Reference Manual</title> |
Reid Spencer | 3921c74 | 2004-08-26 20:44:00 +0000 | [diff] [blame] | 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| 7 | <meta name="author" content="Chris Lattner"> |
| 8 | <meta name="description" |
| 9 | content="LLVM Assembly Language Reference Manual."> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 10 | <link rel="stylesheet" href="llvm.css" type="text/css"> |
| 11 | </head> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 12 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 13 | <body> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 14 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 15 | <div class="doc_title"> LLVM Language Reference Manual </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 16 | <ol> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 17 | <li><a href="#abstract">Abstract</a></li> |
| 18 | <li><a href="#introduction">Introduction</a></li> |
| 19 | <li><a href="#identifiers">Identifiers</a></li> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 20 | <li><a href="#highlevel">High Level Structure</a> |
| 21 | <ol> |
| 22 | <li><a href="#modulestructure">Module Structure</a></li> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 23 | <li><a href="#linkage">Linkage Types</a></li> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 24 | <li><a href="#callingconv">Calling Conventions</a></li> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 25 | <li><a href="#globalvars">Global Variables</a></li> |
| 26 | <li><a href="#functionstructure">Function Structure</a></li> |
| 27 | </ol> |
| 28 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 29 | <li><a href="#typesystem">Type System</a> |
| 30 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 31 | <li><a href="#t_primitive">Primitive Types</a> |
| 32 | <ol> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 33 | <li><a href="#t_classifications">Type Classifications</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 34 | </ol> |
| 35 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 36 | <li><a href="#t_derived">Derived Types</a> |
| 37 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 38 | <li><a href="#t_array">Array Type</a></li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 39 | <li><a href="#t_function">Function Type</a></li> |
| 40 | <li><a href="#t_pointer">Pointer Type</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 41 | <li><a href="#t_struct">Structure Type</a></li> |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 42 | <li><a href="#t_packed">Packed Type</a></li> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 43 | <li><a href="#t_opaque">Opaque Type</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 44 | </ol> |
| 45 | </li> |
| 46 | </ol> |
| 47 | </li> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 48 | <li><a href="#constants">Constants</a> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 49 | <ol> |
| 50 | <li><a href="#simpleconstants">Simple Constants</a> |
| 51 | <li><a href="#aggregateconstants">Aggregate Constants</a> |
| 52 | <li><a href="#globalconstants">Global Variable and Function Addresses</a> |
| 53 | <li><a href="#undefvalues">Undefined Values</a> |
| 54 | <li><a href="#constantexprs">Constant Expressions</a> |
| 55 | </ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 56 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 57 | <li><a href="#instref">Instruction Reference</a> |
| 58 | <ol> |
| 59 | <li><a href="#terminators">Terminator Instructions</a> |
| 60 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 61 | <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li> |
| 62 | <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 63 | <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li> |
| 64 | <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 65 | <li><a href="#i_unwind">'<tt>unwind</tt>' Instruction</a></li> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 66 | <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 67 | </ol> |
| 68 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 69 | <li><a href="#binaryops">Binary Operations</a> |
| 70 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 71 | <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li> |
| 72 | <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li> |
| 73 | <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li> |
| 74 | <li><a href="#i_div">'<tt>div</tt>' Instruction</a></li> |
| 75 | <li><a href="#i_rem">'<tt>rem</tt>' Instruction</a></li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 76 | <li><a href="#i_setcc">'<tt>set<i>cc</i></tt>' Instructions</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 77 | </ol> |
| 78 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 79 | <li><a href="#bitwiseops">Bitwise Binary Operations</a> |
| 80 | <ol> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 81 | <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 82 | <li><a href="#i_or">'<tt>or</tt>' Instruction</a></li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 83 | <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li> |
| 84 | <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li> |
| 85 | <li><a href="#i_shr">'<tt>shr</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 86 | </ol> |
| 87 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 88 | <li><a href="#memoryops">Memory Access Operations</a> |
| 89 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 90 | <li><a href="#i_malloc">'<tt>malloc</tt>' Instruction</a></li> |
| 91 | <li><a href="#i_free">'<tt>free</tt>' Instruction</a></li> |
| 92 | <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li> |
| 93 | <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li> |
| 94 | <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li> |
| 95 | <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li> |
| 96 | </ol> |
| 97 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 98 | <li><a href="#otherops">Other Operations</a> |
| 99 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 100 | <li><a href="#i_phi">'<tt>phi</tt>' Instruction</a></li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 101 | <li><a href="#i_cast">'<tt>cast .. to</tt>' Instruction</a></li> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 102 | <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 103 | <li><a href="#i_call">'<tt>call</tt>' Instruction</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 104 | <li><a href="#i_vaarg">'<tt>vaarg</tt>' Instruction</a></li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 105 | </ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 106 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 107 | </ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 108 | </li> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 109 | <li><a href="#intrinsics">Intrinsic Functions</a> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 110 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 111 | <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a> |
| 112 | <ol> |
| 113 | <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li> |
| 114 | <li><a href="#i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a></li> |
| 115 | <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a></li> |
| 116 | </ol> |
| 117 | </li> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 118 | <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a> |
| 119 | <ol> |
| 120 | <li><a href="#i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li> |
| 121 | <li><a href="#i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li> |
| 122 | <li><a href="#i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li> |
| 123 | </ol> |
| 124 | </li> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 125 | <li><a href="#int_codegen">Code Generator Intrinsics</a> |
| 126 | <ol> |
| 127 | <li><a href="#i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li> |
| 128 | <li><a href="#i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a></li> |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 129 | <li><a href="#i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li> |
Andrew Lenharth | 7f4ec3b | 2005-03-28 20:05:49 +0000 | [diff] [blame] | 130 | <li><a href="#i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li> |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 131 | </ol> |
| 132 | </li> |
| 133 | <li><a href="#int_os">Operating System Intrinsics</a> |
| 134 | <ol> |
Chris Lattner | 3200628 | 2004-06-11 02:28:03 +0000 | [diff] [blame] | 135 | <li><a href="#i_readport">'<tt>llvm.readport</tt>' Intrinsic</a></li> |
| 136 | <li><a href="#i_writeport">'<tt>llvm.writeport</tt>' Intrinsic</a></li> |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 137 | <li><a href="#i_readio">'<tt>llvm.readio</tt>' Intrinsic</a></li> |
| 138 | <li><a href="#i_writeio">'<tt>llvm.writeio</tt>' Intrinsic</a></li> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 139 | </ol> |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 140 | <li><a href="#int_libc">Standard C Library Intrinsics</a> |
| 141 | <ol> |
| 142 | <li><a href="#i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a></li> |
Chris Lattner | 0eb51b4 | 2004-02-12 18:10:10 +0000 | [diff] [blame] | 143 | <li><a href="#i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a></li> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 144 | <li><a href="#i_memset">'<tt>llvm.memset</tt>' Intrinsic</a></li> |
Alkis Evlogimenos | 9685372 | 2004-06-12 19:19:14 +0000 | [diff] [blame] | 145 | <li><a href="#i_isunordered">'<tt>llvm.isunordered</tt>' Intrinsic</a></li> |
Chris Lattner | a4d7414 | 2005-07-21 01:29:16 +0000 | [diff] [blame] | 146 | <li><a href="#i_sqrt">'<tt>llvm.sqrt</tt>' Intrinsic</a></li> |
| 147 | |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 148 | </ol> |
| 149 | </li> |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 150 | <li><a href="#int_count">Bit counting Intrinsics</a> |
| 151 | <ol> |
| 152 | <li><a href="#int_ctpop">'<tt>llvm.ctpop</tt>' Intrinsic </a></li> |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 153 | <li><a href="#int_ctlz">'<tt>llvm.ctlz</tt>' Intrinsic </a></li> |
Chris Lattner | eff29ab | 2005-05-15 19:39:26 +0000 | [diff] [blame] | 154 | <li><a href="#int_cttz">'<tt>llvm.cttz</tt>' Intrinsic </a></li> |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 155 | </ol> |
| 156 | </li> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 157 | <li><a href="#int_debugger">Debugger intrinsics</a></li> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 158 | </ol> |
| 159 | </li> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 160 | </ol> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 161 | |
| 162 | <div class="doc_author"> |
| 163 | <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a> |
| 164 | and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 165 | </div> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 166 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 167 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 168 | <div class="doc_section"> <a name="abstract">Abstract </a></div> |
| 169 | <!-- *********************************************************************** --> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 170 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 171 | <div class="doc_text"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 172 | <p>This document is a reference manual for the LLVM assembly language. |
| 173 | LLVM is an SSA based representation that provides type safety, |
| 174 | low-level operations, flexibility, and the capability of representing |
| 175 | 'all' high-level languages cleanly. It is the common code |
| 176 | representation used throughout all phases of the LLVM compilation |
| 177 | strategy.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 178 | </div> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 179 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 180 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 181 | <div class="doc_section"> <a name="introduction">Introduction</a> </div> |
| 182 | <!-- *********************************************************************** --> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 183 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 184 | <div class="doc_text"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 185 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 186 | <p>The LLVM code representation is designed to be used in three |
| 187 | different forms: as an in-memory compiler IR, as an on-disk bytecode |
| 188 | representation (suitable for fast loading by a Just-In-Time compiler), |
| 189 | and as a human readable assembly language representation. This allows |
| 190 | LLVM to provide a powerful intermediate representation for efficient |
| 191 | compiler transformations and analysis, while providing a natural means |
| 192 | to debug and visualize the transformations. The three different forms |
| 193 | of LLVM are all equivalent. This document describes the human readable |
| 194 | representation and notation.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 195 | |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 196 | <p>The LLVM representation aims to be light-weight and low-level |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 197 | while being expressive, typed, and extensible at the same time. It |
| 198 | aims to be a "universal IR" of sorts, by being at a low enough level |
| 199 | that high-level ideas may be cleanly mapped to it (similar to how |
| 200 | microprocessors are "universal IR's", allowing many source languages to |
| 201 | be mapped to them). By providing type information, LLVM can be used as |
| 202 | the target of optimizations: for example, through pointer analysis, it |
| 203 | can be proven that a C automatic variable is never accessed outside of |
| 204 | the current function... allowing it to be promoted to a simple SSA |
| 205 | value instead of a memory location.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 206 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 207 | </div> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 208 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 209 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 210 | <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 211 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 212 | <div class="doc_text"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 213 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 214 | <p>It is important to note that this document describes 'well formed' |
| 215 | LLVM assembly language. There is a difference between what the parser |
| 216 | accepts and what is considered 'well formed'. For example, the |
| 217 | following instruction is syntactically okay, but not well formed:</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 218 | |
| 219 | <pre> |
| 220 | %x = <a href="#i_add">add</a> int 1, %x |
| 221 | </pre> |
| 222 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 223 | <p>...because the definition of <tt>%x</tt> does not dominate all of |
| 224 | its uses. The LLVM infrastructure provides a verification pass that may |
| 225 | be used to verify that an LLVM module is well formed. This pass is |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 226 | automatically run by the parser after parsing input assembly and by |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 227 | the optimizer before it outputs bytecode. The violations pointed out |
| 228 | by the verifier pass indicate bugs in transformation passes or input to |
| 229 | the parser.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 230 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 231 | <!-- Describe the typesetting conventions here. --> </div> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 232 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 233 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 234 | <div class="doc_section"> <a name="identifiers">Identifiers</a> </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 235 | <!-- *********************************************************************** --> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 236 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 237 | <div class="doc_text"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 238 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 239 | <p>LLVM uses three different forms of identifiers, for different |
| 240 | purposes:</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 241 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 242 | <ol> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 243 | <li>Named values are represented as a string of characters with a '%' prefix. |
| 244 | For example, %foo, %DivisionByZero, %a.really.long.identifier. The actual |
| 245 | regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'. |
| 246 | Identifiers which require other characters in their names can be surrounded |
| 247 | with quotes. In this way, anything except a <tt>"</tt> character can be used |
| 248 | in a name.</li> |
| 249 | |
| 250 | <li>Unnamed values are represented as an unsigned numeric value with a '%' |
| 251 | prefix. For example, %12, %2, %44.</li> |
| 252 | |
Reid Spencer | cc16dc3 | 2004-12-09 18:02:53 +0000 | [diff] [blame] | 253 | <li>Constants, which are described in a <a href="#constants">section about |
| 254 | constants</a>, below.</li> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 255 | </ol> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 256 | |
| 257 | <p>LLVM requires that values start with a '%' sign for two reasons: Compilers |
| 258 | don't need to worry about name clashes with reserved words, and the set of |
| 259 | reserved words may be expanded in the future without penalty. Additionally, |
| 260 | unnamed identifiers allow a compiler to quickly come up with a temporary |
| 261 | variable without having to avoid symbol table conflicts.</p> |
| 262 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 263 | <p>Reserved words in LLVM are very similar to reserved words in other |
| 264 | languages. There are keywords for different opcodes ('<tt><a |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 265 | href="#i_add">add</a></tt>', '<tt><a href="#i_cast">cast</a></tt>', '<tt><a |
| 266 | href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a |
| 267 | href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>', etc...), |
| 268 | and others. These reserved words cannot conflict with variable names, because |
| 269 | none of them start with a '%' character.</p> |
| 270 | |
| 271 | <p>Here is an example of LLVM code to multiply the integer variable |
| 272 | '<tt>%X</tt>' by 8:</p> |
| 273 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 274 | <p>The easy way:</p> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 275 | |
| 276 | <pre> |
| 277 | %result = <a href="#i_mul">mul</a> uint %X, 8 |
| 278 | </pre> |
| 279 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 280 | <p>After strength reduction:</p> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 281 | |
| 282 | <pre> |
| 283 | %result = <a href="#i_shl">shl</a> uint %X, ubyte 3 |
| 284 | </pre> |
| 285 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 286 | <p>And the hard way:</p> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 287 | |
| 288 | <pre> |
| 289 | <a href="#i_add">add</a> uint %X, %X <i>; yields {uint}:%0</i> |
| 290 | <a href="#i_add">add</a> uint %0, %0 <i>; yields {uint}:%1</i> |
| 291 | %result = <a href="#i_add">add</a> uint %1, %1 |
| 292 | </pre> |
| 293 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 294 | <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several |
| 295 | important lexical features of LLVM:</p> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 296 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 297 | <ol> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 298 | |
| 299 | <li>Comments are delimited with a '<tt>;</tt>' and go until the end of |
| 300 | line.</li> |
| 301 | |
| 302 | <li>Unnamed temporaries are created when the result of a computation is not |
| 303 | assigned to a named value.</li> |
| 304 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 305 | <li>Unnamed temporaries are numbered sequentially</li> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 306 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 307 | </ol> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 308 | |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 309 | <p>...and it also shows a convention that we follow in this document. When |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 310 | demonstrating instructions, we will follow an instruction with a comment that |
| 311 | defines the type and name of value produced. Comments are shown in italic |
| 312 | text.</p> |
| 313 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 314 | </div> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 315 | |
| 316 | <!-- *********************************************************************** --> |
| 317 | <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div> |
| 318 | <!-- *********************************************************************** --> |
| 319 | |
| 320 | <!-- ======================================================================= --> |
| 321 | <div class="doc_subsection"> <a name="modulestructure">Module Structure</a> |
| 322 | </div> |
| 323 | |
| 324 | <div class="doc_text"> |
| 325 | |
| 326 | <p>LLVM programs are composed of "Module"s, each of which is a |
| 327 | translation unit of the input programs. Each module consists of |
| 328 | functions, global variables, and symbol table entries. Modules may be |
| 329 | combined together with the LLVM linker, which merges function (and |
| 330 | global variable) definitions, resolves forward declarations, and merges |
| 331 | symbol table entries. Here is an example of the "hello world" module:</p> |
| 332 | |
| 333 | <pre><i>; Declare the string constant as a global constant...</i> |
| 334 | <a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a |
| 335 | href="#globalvars">constant</a> <a href="#t_array">[13 x sbyte]</a> c"hello world\0A\00" <i>; [13 x sbyte]*</i> |
| 336 | |
| 337 | <i>; External declaration of the puts function</i> |
| 338 | <a href="#functionstructure">declare</a> int %puts(sbyte*) <i>; int(sbyte*)* </i> |
| 339 | |
| 340 | <i>; Definition of main function</i> |
| 341 | int %main() { <i>; int()* </i> |
| 342 | <i>; Convert [13x sbyte]* to sbyte *...</i> |
| 343 | %cast210 = <a |
| 344 | href="#i_getelementptr">getelementptr</a> [13 x sbyte]* %.LC0, long 0, long 0 <i>; sbyte*</i> |
| 345 | |
| 346 | <i>; Call puts function to write out the string to stdout...</i> |
| 347 | <a |
| 348 | href="#i_call">call</a> int %puts(sbyte* %cast210) <i>; int</i> |
| 349 | <a |
| 350 | href="#i_ret">ret</a> int 0<br>}<br></pre> |
| 351 | |
| 352 | <p>This example is made up of a <a href="#globalvars">global variable</a> |
| 353 | named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" |
| 354 | function, and a <a href="#functionstructure">function definition</a> |
| 355 | for "<tt>main</tt>".</p> |
| 356 | |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 357 | <p>In general, a module is made up of a list of global values, |
| 358 | where both functions and global variables are global values. Global values are |
| 359 | represented by a pointer to a memory location (in this case, a pointer to an |
| 360 | array of char, and a pointer to a function), and have one of the following <a |
| 361 | href="#linkage">linkage types</a>.</p> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 362 | |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 363 | </div> |
| 364 | |
| 365 | <!-- ======================================================================= --> |
| 366 | <div class="doc_subsection"> |
| 367 | <a name="linkage">Linkage Types</a> |
| 368 | </div> |
| 369 | |
| 370 | <div class="doc_text"> |
| 371 | |
| 372 | <p> |
| 373 | All Global Variables and Functions have one of the following types of linkage: |
| 374 | </p> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 375 | |
| 376 | <dl> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 377 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 378 | <dt><tt><b><a name="linkage_internal">internal</a></b></tt> </dt> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 379 | |
| 380 | <dd>Global values with internal linkage are only directly accessible by |
| 381 | objects in the current module. In particular, linking code into a module with |
| 382 | an internal global value may cause the internal to be renamed as necessary to |
| 383 | avoid collisions. Because the symbol is internal to the module, all |
| 384 | references can be updated. This corresponds to the notion of the |
| 385 | '<tt>static</tt>' keyword in C, or the idea of "anonymous namespaces" in C++. |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 386 | </dd> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 387 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 388 | <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 389 | |
| 390 | <dd>"<tt>linkonce</tt>" linkage is similar to <tt>internal</tt> linkage, with |
| 391 | the twist that linking together two modules defining the same |
| 392 | <tt>linkonce</tt> globals will cause one of the globals to be discarded. This |
| 393 | is typically used to implement inline functions. Unreferenced |
| 394 | <tt>linkonce</tt> globals are allowed to be discarded. |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 395 | </dd> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 396 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 397 | <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 398 | |
| 399 | <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt> linkage, |
| 400 | except that unreferenced <tt>weak</tt> globals may not be discarded. This is |
| 401 | used to implement constructs in C such as "<tt>int X;</tt>" at global scope. |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 402 | </dd> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 403 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 404 | <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 405 | |
| 406 | <dd>"<tt>appending</tt>" linkage may only be applied to global variables of |
| 407 | pointer to array type. When two global variables with appending linkage are |
| 408 | linked together, the two global arrays are appended together. This is the |
| 409 | LLVM, typesafe, equivalent of having the system linker append together |
| 410 | "sections" with identical names when .o files are linked. |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 411 | </dd> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 412 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 413 | <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 414 | |
| 415 | <dd>If none of the above identifiers are used, the global is externally |
| 416 | visible, meaning that it participates in linkage and can be used to resolve |
| 417 | external symbol references. |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 418 | </dd> |
| 419 | </dl> |
| 420 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 421 | <p><a name="linkage_external">For example, since the "<tt>.LC0</tt>" |
| 422 | variable is defined to be internal, if another module defined a "<tt>.LC0</tt>" |
| 423 | variable and was linked with this one, one of the two would be renamed, |
| 424 | preventing a collision. Since "<tt>main</tt>" and "<tt>puts</tt>" are |
| 425 | external (i.e., lacking any linkage declarations), they are accessible |
| 426 | outside of the current module. It is illegal for a function <i>declaration</i> |
| 427 | to have any linkage type other than "externally visible".</a></p> |
Chris Lattner | e5d947b | 2004-12-09 16:36:40 +0000 | [diff] [blame] | 428 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 429 | </div> |
| 430 | |
| 431 | <!-- ======================================================================= --> |
| 432 | <div class="doc_subsection"> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 433 | <a name="callingconv">Calling Conventions</a> |
| 434 | </div> |
| 435 | |
| 436 | <div class="doc_text"> |
| 437 | |
| 438 | <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a> |
| 439 | and <a href="#i_invoke">invokes</a> can all have an optional calling convention |
| 440 | specified for the call. The calling convention of any pair of dynamic |
| 441 | caller/callee must match, or the behavior of the program is undefined. The |
| 442 | following calling conventions are supported by LLVM, and more may be added in |
| 443 | the future:</p> |
| 444 | |
| 445 | <dl> |
| 446 | <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt> |
| 447 | |
| 448 | <dd>This calling convention (the default if no other calling convention is |
| 449 | specified) matches the target C calling conventions. This calling convention |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 450 | supports varargs function calls and tolerates some mismatch in the declared |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 451 | prototype and implemented declaration of the function (as does normal C). |
| 452 | </dd> |
| 453 | |
| 454 | <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt> |
| 455 | |
| 456 | <dd>This calling convention attempts to make calls as fast as possible |
| 457 | (e.g. by passing things in registers). This calling convention allows the |
| 458 | target to use whatever tricks it wants to produce fast code for the target, |
Chris Lattner | 8cdc5bc | 2005-05-06 23:08:23 +0000 | [diff] [blame] | 459 | without having to conform to an externally specified ABI. Implementations of |
| 460 | this convention should allow arbitrary tail call optimization to be supported. |
| 461 | This calling convention does not support varargs and requires the prototype of |
| 462 | all callees to exactly match the prototype of the function definition. |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 463 | </dd> |
| 464 | |
| 465 | <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt> |
| 466 | |
| 467 | <dd>This calling convention attempts to make code in the caller as efficient |
| 468 | as possible under the assumption that the call is not commonly executed. As |
| 469 | such, these calls often preserve all registers so that the call does not break |
| 470 | any live ranges in the caller side. This calling convention does not support |
| 471 | varargs and requires the prototype of all callees to exactly match the |
| 472 | prototype of the function definition. |
| 473 | </dd> |
| 474 | |
Chris Lattner | cfe6b37 | 2005-05-07 01:46:40 +0000 | [diff] [blame] | 475 | <dt><b>"<tt>cc <<em>n</em>></tt>" - Numbered convention</b>:</dt> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 476 | |
| 477 | <dd>Any calling convention may be specified by number, allowing |
| 478 | target-specific calling conventions to be used. Target specific calling |
| 479 | conventions start at 64. |
| 480 | </dd> |
Chris Lattner | cfe6b37 | 2005-05-07 01:46:40 +0000 | [diff] [blame] | 481 | </dl> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 482 | |
| 483 | <p>More calling conventions can be added/defined on an as-needed basis, to |
| 484 | support pascal conventions or any other well-known target-independent |
| 485 | convention.</p> |
| 486 | |
| 487 | </div> |
| 488 | |
| 489 | <!-- ======================================================================= --> |
| 490 | <div class="doc_subsection"> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 491 | <a name="globalvars">Global Variables</a> |
| 492 | </div> |
| 493 | |
| 494 | <div class="doc_text"> |
| 495 | |
Chris Lattner | 3689a34 | 2005-02-12 19:30:21 +0000 | [diff] [blame] | 496 | <p>Global variables define regions of memory allocated at compilation time |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 497 | instead of run-time. Global variables may optionally be initialized, and may |
| 498 | have an optional explicit alignment specified. A |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 499 | variable may be defined as a global "constant," which indicates that the |
Chris Lattner | 3689a34 | 2005-02-12 19:30:21 +0000 | [diff] [blame] | 500 | contents of the variable will <b>never</b> be modified (enabling better |
| 501 | optimization, allowing the global data to be placed in the read-only section of |
| 502 | an executable, etc). Note that variables that need runtime initialization |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 503 | cannot be marked "constant" as there is a store to the variable.</p> |
Chris Lattner | 3689a34 | 2005-02-12 19:30:21 +0000 | [diff] [blame] | 504 | |
| 505 | <p> |
| 506 | LLVM explicitly allows <em>declarations</em> of global variables to be marked |
| 507 | constant, even if the final definition of the global is not. This capability |
| 508 | can be used to enable slightly better optimization of the program, but requires |
| 509 | the language definition to guarantee that optimizations based on the |
| 510 | 'constantness' are valid for the translation units that do not include the |
| 511 | definition. |
| 512 | </p> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 513 | |
| 514 | <p>As SSA values, global variables define pointer values that are in |
| 515 | scope (i.e. they dominate) all basic blocks in the program. Global |
| 516 | variables always define a pointer to their "content" type because they |
| 517 | describe a region of memory, and all memory objects in LLVM are |
| 518 | accessed through pointers.</p> |
| 519 | |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 520 | <p>An explicit alignment may be specified for a global. If not present, or if |
| 521 | the alignment is set to zero, the alignment of the global is set by the target |
| 522 | to whatever it feels convenient. If an explicit alignment is specified, the |
| 523 | global is forced to have at least that much alignment. All alignments must be |
| 524 | a power of 2.</p> |
| 525 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 526 | </div> |
| 527 | |
| 528 | |
| 529 | <!-- ======================================================================= --> |
| 530 | <div class="doc_subsection"> |
| 531 | <a name="functionstructure">Functions</a> |
| 532 | </div> |
| 533 | |
| 534 | <div class="doc_text"> |
| 535 | |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 536 | <p>LLVM function definitions consist of an optional <a href="#linkage">linkage |
| 537 | type</a>, an optional <a href="#callingconv">calling convention</a>, a return |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 538 | type, a function name, a (possibly empty) argument list, an optional alignment, |
| 539 | an opening curly brace, |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 540 | a list of basic blocks, and a closing curly brace. LLVM function declarations |
| 541 | are defined with the "<tt>declare</tt>" keyword, an optional <a |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 542 | href="#callingconv">calling convention</a>, a return type, a function name, |
| 543 | a possibly empty list of arguments, and an optional alignment.</p> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 544 | |
| 545 | <p>A function definition contains a list of basic blocks, forming the CFG for |
| 546 | the function. Each basic block may optionally start with a label (giving the |
| 547 | basic block a symbol table entry), contains a list of instructions, and ends |
| 548 | with a <a href="#terminators">terminator</a> instruction (such as a branch or |
| 549 | function return).</p> |
| 550 | |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 551 | <p>The first basic block in a program is special in two ways: it is immediately |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 552 | executed on entrance to the function, and it is not allowed to have predecessor |
| 553 | basic blocks (i.e. there can not be any branches to the entry block of a |
| 554 | function). Because the block can have no predecessors, it also cannot have any |
| 555 | <a href="#i_phi">PHI nodes</a>.</p> |
| 556 | |
| 557 | <p>LLVM functions are identified by their name and type signature. Hence, two |
| 558 | functions with the same name but different parameter lists or return values are |
Chris Lattner | d4f6b17 | 2005-03-07 22:13:59 +0000 | [diff] [blame] | 559 | considered different functions, and LLVM will resolve references to each |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 560 | appropriately.</p> |
| 561 | |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 562 | <p>An explicit alignment may be specified for a function. If not present, or if |
| 563 | the alignment is set to zero, the alignment of the function is set by the target |
| 564 | to whatever it feels convenient. If an explicit alignment is specified, the |
| 565 | function is forced to have at least that much alignment. All alignments must be |
| 566 | a power of 2.</p> |
| 567 | |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 568 | </div> |
| 569 | |
| 570 | |
| 571 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 572 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 573 | <div class="doc_section"> <a name="typesystem">Type System</a> </div> |
| 574 | <!-- *********************************************************************** --> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 575 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 576 | <div class="doc_text"> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 577 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 578 | <p>The LLVM type system is one of the most important features of the |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 579 | intermediate representation. Being typed enables a number of |
| 580 | optimizations to be performed on the IR directly, without having to do |
| 581 | extra analyses on the side before the transformation. A strong type |
| 582 | system makes it easier to read the generated code and enables novel |
| 583 | analyses and transformations that are not feasible to perform on normal |
| 584 | three address code representations.</p> |
Chris Lattner | fa73021 | 2004-12-09 16:11:40 +0000 | [diff] [blame] | 585 | |
| 586 | </div> |
| 587 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 588 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 589 | <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 590 | <div class="doc_text"> |
John Criswell | 4457dc9 | 2004-04-09 16:48:45 +0000 | [diff] [blame] | 591 | <p>The primitive types are the fundamental building blocks of the LLVM |
Chris Lattner | d4f6b17 | 2005-03-07 22:13:59 +0000 | [diff] [blame] | 592 | system. The current set of primitive types is as follows:</p> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 593 | |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 594 | <table class="layout"> |
| 595 | <tr class="layout"> |
| 596 | <td class="left"> |
| 597 | <table> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 598 | <tbody> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 599 | <tr><th>Type</th><th>Description</th></tr> |
| 600 | <tr><td><tt>void</tt></td><td>No value</td></tr> |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 601 | <tr><td><tt>ubyte</tt></td><td>Unsigned 8-bit value</td></tr> |
| 602 | <tr><td><tt>ushort</tt></td><td>Unsigned 16-bit value</td></tr> |
| 603 | <tr><td><tt>uint</tt></td><td>Unsigned 32-bit value</td></tr> |
| 604 | <tr><td><tt>ulong</tt></td><td>Unsigned 64-bit value</td></tr> |
| 605 | <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 606 | <tr><td><tt>label</tt></td><td>Branch destination</td></tr> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 607 | </tbody> |
| 608 | </table> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 609 | </td> |
| 610 | <td class="right"> |
| 611 | <table> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 612 | <tbody> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 613 | <tr><th>Type</th><th>Description</th></tr> |
| 614 | <tr><td><tt>bool</tt></td><td>True or False value</td></tr> |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 615 | <tr><td><tt>sbyte</tt></td><td>Signed 8-bit value</td></tr> |
| 616 | <tr><td><tt>short</tt></td><td>Signed 16-bit value</td></tr> |
| 617 | <tr><td><tt>int</tt></td><td>Signed 32-bit value</td></tr> |
| 618 | <tr><td><tt>long</tt></td><td>Signed 64-bit value</td></tr> |
| 619 | <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 620 | </tbody> |
| 621 | </table> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 622 | </td> |
| 623 | </tr> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 624 | </table> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 625 | </div> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 626 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 627 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 628 | <div class="doc_subsubsection"> <a name="t_classifications">Type |
| 629 | Classifications</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 630 | <div class="doc_text"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 631 | <p>These different primitive types fall into a few useful |
| 632 | classifications:</p> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 633 | |
| 634 | <table border="1" cellspacing="0" cellpadding="4"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 635 | <tbody> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 636 | <tr><th>Classification</th><th>Types</th></tr> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 637 | <tr> |
| 638 | <td><a name="t_signed">signed</a></td> |
| 639 | <td><tt>sbyte, short, int, long, float, double</tt></td> |
| 640 | </tr> |
| 641 | <tr> |
| 642 | <td><a name="t_unsigned">unsigned</a></td> |
| 643 | <td><tt>ubyte, ushort, uint, ulong</tt></td> |
| 644 | </tr> |
| 645 | <tr> |
| 646 | <td><a name="t_integer">integer</a></td> |
| 647 | <td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td> |
| 648 | </tr> |
| 649 | <tr> |
| 650 | <td><a name="t_integral">integral</a></td> |
Misha Brukman | c24b758 | 2004-08-12 20:16:08 +0000 | [diff] [blame] | 651 | <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long</tt> |
| 652 | </td> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 653 | </tr> |
| 654 | <tr> |
| 655 | <td><a name="t_floating">floating point</a></td> |
| 656 | <td><tt>float, double</tt></td> |
| 657 | </tr> |
| 658 | <tr> |
| 659 | <td><a name="t_firstclass">first class</a></td> |
Misha Brukman | c24b758 | 2004-08-12 20:16:08 +0000 | [diff] [blame] | 660 | <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long,<br> |
| 661 | float, double, <a href="#t_pointer">pointer</a>, |
| 662 | <a href="#t_packed">packed</a></tt></td> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 663 | </tr> |
| 664 | </tbody> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 665 | </table> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 666 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 667 | <p>The <a href="#t_firstclass">first class</a> types are perhaps the |
| 668 | most important. Values of these types are the only ones which can be |
| 669 | produced by instructions, passed as arguments, or used as operands to |
| 670 | instructions. This means that all structures and arrays must be |
| 671 | manipulated either by pointer or by component.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 672 | </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 673 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 674 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 675 | <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 676 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 677 | <div class="doc_text"> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 678 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 679 | <p>The real power in LLVM comes from the derived types in the system. |
| 680 | This is what allows a programmer to represent arrays, functions, |
| 681 | pointers, and other useful types. Note that these derived types may be |
| 682 | recursive: For example, it is possible to have a two dimensional array.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 683 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 684 | </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 685 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 686 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 687 | <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 688 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 689 | <div class="doc_text"> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 690 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 691 | <h5>Overview:</h5> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 692 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 693 | <p>The array type is a very simple derived type that arranges elements |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 694 | sequentially in memory. The array type requires a size (number of |
| 695 | elements) and an underlying data type.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 696 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 697 | <h5>Syntax:</h5> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 698 | |
| 699 | <pre> |
| 700 | [<# elements> x <elementtype>] |
| 701 | </pre> |
| 702 | |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 703 | <p>The number of elements is a constant integer value; elementtype may |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 704 | be any type with a size.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 705 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 706 | <h5>Examples:</h5> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 707 | <table class="layout"> |
| 708 | <tr class="layout"> |
| 709 | <td class="left"> |
| 710 | <tt>[40 x int ]</tt><br/> |
| 711 | <tt>[41 x int ]</tt><br/> |
| 712 | <tt>[40 x uint]</tt><br/> |
| 713 | </td> |
| 714 | <td class="left"> |
| 715 | Array of 40 integer values.<br/> |
| 716 | Array of 41 integer values.<br/> |
| 717 | Array of 40 unsigned integer values.<br/> |
| 718 | </td> |
| 719 | </tr> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 720 | </table> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 721 | <p>Here are some examples of multidimensional arrays:</p> |
| 722 | <table class="layout"> |
| 723 | <tr class="layout"> |
| 724 | <td class="left"> |
| 725 | <tt>[3 x [4 x int]]</tt><br/> |
| 726 | <tt>[12 x [10 x float]]</tt><br/> |
| 727 | <tt>[2 x [3 x [4 x uint]]]</tt><br/> |
| 728 | </td> |
| 729 | <td class="left"> |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 730 | 3x4 array of integer values.<br/> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 731 | 12x10 array of single precision floating point values.<br/> |
| 732 | 2x3x4 array of unsigned integer values.<br/> |
| 733 | </td> |
| 734 | </tr> |
| 735 | </table> |
Chris Lattner | e67a951 | 2005-06-24 17:22:57 +0000 | [diff] [blame] | 736 | |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 737 | <p>Note that 'variable sized arrays' can be implemented in LLVM with a zero |
| 738 | length array. Normally, accesses past the end of an array are undefined in |
Chris Lattner | e67a951 | 2005-06-24 17:22:57 +0000 | [diff] [blame] | 739 | LLVM (e.g. it is illegal to access the 5th element of a 3 element array). |
| 740 | As a special case, however, zero length arrays are recognized to be variable |
| 741 | length. This allows implementation of 'pascal style arrays' with the LLVM |
| 742 | type "{ int, [0 x float]}", for example.</p> |
| 743 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 744 | </div> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 745 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 746 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 747 | <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 748 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 749 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 750 | <p>The function type can be thought of as a function signature. It |
| 751 | consists of a return type and a list of formal parameter types. |
John Criswell | 009900b | 2003-11-25 21:45:46 +0000 | [diff] [blame] | 752 | Function types are usually used to build virtual function tables |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 753 | (which are structures of pointers to functions), for indirect function |
| 754 | calls, and when defining a function.</p> |
John Criswell | 009900b | 2003-11-25 21:45:46 +0000 | [diff] [blame] | 755 | <p> |
| 756 | The return type of a function type cannot be an aggregate type. |
| 757 | </p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 758 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 759 | <pre> <returntype> (<parameter list>)<br></pre> |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 760 | <p>...where '<tt><parameter list></tt>' is a comma-separated list of type |
Misha Brukman | c24b758 | 2004-08-12 20:16:08 +0000 | [diff] [blame] | 761 | specifiers. Optionally, the parameter list may include a type <tt>...</tt>, |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 762 | which indicates that the function takes a variable number of arguments. |
| 763 | Variable argument functions can access their arguments with the <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 764 | href="#int_varargs">variable argument handling intrinsic</a> functions.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 765 | <h5>Examples:</h5> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 766 | <table class="layout"> |
| 767 | <tr class="layout"> |
| 768 | <td class="left"> |
| 769 | <tt>int (int)</tt> <br/> |
| 770 | <tt>float (int, int *) *</tt><br/> |
| 771 | <tt>int (sbyte *, ...)</tt><br/> |
| 772 | </td> |
| 773 | <td class="left"> |
| 774 | function taking an <tt>int</tt>, returning an <tt>int</tt><br/> |
| 775 | <a href="#t_pointer">Pointer</a> to a function that takes an |
Misha Brukman | c24b758 | 2004-08-12 20:16:08 +0000 | [diff] [blame] | 776 | <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>, |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 777 | returning <tt>float</tt>.<br/> |
| 778 | A vararg function that takes at least one <a href="#t_pointer">pointer</a> |
| 779 | to <tt>sbyte</tt> (signed char in C), which returns an integer. This is |
| 780 | the signature for <tt>printf</tt> in LLVM.<br/> |
| 781 | </td> |
| 782 | </tr> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 783 | </table> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 784 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 785 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 786 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 787 | <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 788 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 789 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 790 | <p>The structure type is used to represent a collection of data members |
| 791 | together in memory. The packing of the field types is defined to match |
| 792 | the ABI of the underlying processor. The elements of a structure may |
| 793 | be any type that has a size.</p> |
| 794 | <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt> |
| 795 | and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a |
| 796 | field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' |
| 797 | instruction.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 798 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 799 | <pre> { <type list> }<br></pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 800 | <h5>Examples:</h5> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 801 | <table class="layout"> |
| 802 | <tr class="layout"> |
| 803 | <td class="left"> |
| 804 | <tt>{ int, int, int }</tt><br/> |
| 805 | <tt>{ float, int (int) * }</tt><br/> |
| 806 | </td> |
| 807 | <td class="left"> |
| 808 | a triple of three <tt>int</tt> values<br/> |
| 809 | A pair, where the first element is a <tt>float</tt> and the second element |
| 810 | is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a> |
| 811 | that takes an <tt>int</tt>, returning an <tt>int</tt>.<br/> |
| 812 | </td> |
| 813 | </tr> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 814 | </table> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 815 | </div> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 816 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 817 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 818 | <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 819 | <div class="doc_text"> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 820 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 821 | <p>As in many languages, the pointer type represents a pointer or |
| 822 | reference to another object, which must live in memory.</p> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 823 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 824 | <pre> <type> *<br></pre> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 825 | <h5>Examples:</h5> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 826 | <table class="layout"> |
| 827 | <tr class="layout"> |
| 828 | <td class="left"> |
| 829 | <tt>[4x int]*</tt><br/> |
| 830 | <tt>int (int *) *</tt><br/> |
| 831 | </td> |
| 832 | <td class="left"> |
| 833 | A <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a> of |
| 834 | four <tt>int</tt> values<br/> |
| 835 | A <a href="#t_pointer">pointer</a> to a <a |
Chris Lattner | a977c48 | 2005-02-19 02:22:14 +0000 | [diff] [blame] | 836 | href="#t_function">function</a> that takes an <tt>int*</tt>, returning an |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 837 | <tt>int</tt>.<br/> |
| 838 | </td> |
| 839 | </tr> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 840 | </table> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 841 | </div> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 842 | |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 843 | <!-- _______________________________________________________________________ --> |
| 844 | <div class="doc_subsubsection"> <a name="t_packed">Packed Type</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 845 | <div class="doc_text"> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 846 | |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 847 | <h5>Overview:</h5> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 848 | |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 849 | <p>A packed type is a simple derived type that represents a vector |
| 850 | of elements. Packed types are used when multiple primitive data |
| 851 | are operated in parallel using a single instruction (SIMD). |
| 852 | A packed type requires a size (number of |
| 853 | elements) and an underlying primitive data type. Packed types are |
| 854 | considered <a href="#t_firstclass">first class</a>.</p> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 855 | |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 856 | <h5>Syntax:</h5> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 857 | |
| 858 | <pre> |
| 859 | < <# elements> x <elementtype> > |
| 860 | </pre> |
| 861 | |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 862 | <p>The number of elements is a constant integer value; elementtype may |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 863 | be any integral or floating point type.</p> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 864 | |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 865 | <h5>Examples:</h5> |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 866 | |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 867 | <table class="layout"> |
| 868 | <tr class="layout"> |
| 869 | <td class="left"> |
| 870 | <tt><4 x int></tt><br/> |
| 871 | <tt><8 x float></tt><br/> |
| 872 | <tt><2 x uint></tt><br/> |
| 873 | </td> |
| 874 | <td class="left"> |
| 875 | Packed vector of 4 integer values.<br/> |
| 876 | Packed vector of 8 floating-point values.<br/> |
| 877 | Packed vector of 2 unsigned integer values.<br/> |
| 878 | </td> |
| 879 | </tr> |
| 880 | </table> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 881 | </div> |
| 882 | |
Chris Lattner | 69c11bb | 2005-04-25 17:34:15 +0000 | [diff] [blame] | 883 | <!-- _______________________________________________________________________ --> |
| 884 | <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div> |
| 885 | <div class="doc_text"> |
| 886 | |
| 887 | <h5>Overview:</h5> |
| 888 | |
| 889 | <p>Opaque types are used to represent unknown types in the system. This |
| 890 | corresponds (for example) to the C notion of a foward declared structure type. |
| 891 | In LLVM, opaque types can eventually be resolved to any type (not just a |
| 892 | structure type).</p> |
| 893 | |
| 894 | <h5>Syntax:</h5> |
| 895 | |
| 896 | <pre> |
| 897 | opaque |
| 898 | </pre> |
| 899 | |
| 900 | <h5>Examples:</h5> |
| 901 | |
| 902 | <table class="layout"> |
| 903 | <tr class="layout"> |
| 904 | <td class="left"> |
| 905 | <tt>opaque</tt> |
| 906 | </td> |
| 907 | <td class="left"> |
| 908 | An opaque type.<br/> |
| 909 | </td> |
| 910 | </tr> |
| 911 | </table> |
| 912 | </div> |
| 913 | |
| 914 | |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 915 | <!-- *********************************************************************** --> |
| 916 | <div class="doc_section"> <a name="constants">Constants</a> </div> |
| 917 | <!-- *********************************************************************** --> |
| 918 | |
| 919 | <div class="doc_text"> |
| 920 | |
| 921 | <p>LLVM has several different basic types of constants. This section describes |
| 922 | them all and their syntax.</p> |
| 923 | |
| 924 | </div> |
| 925 | |
| 926 | <!-- ======================================================================= --> |
Reid Spencer | cc16dc3 | 2004-12-09 18:02:53 +0000 | [diff] [blame] | 927 | <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 928 | |
| 929 | <div class="doc_text"> |
| 930 | |
| 931 | <dl> |
| 932 | <dt><b>Boolean constants</b></dt> |
| 933 | |
| 934 | <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid |
| 935 | constants of the <tt><a href="#t_primitive">bool</a></tt> type. |
| 936 | </dd> |
| 937 | |
| 938 | <dt><b>Integer constants</b></dt> |
| 939 | |
Reid Spencer | cc16dc3 | 2004-12-09 18:02:53 +0000 | [diff] [blame] | 940 | <dd>Standard integers (such as '4') are constants of the <a |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 941 | href="#t_integer">integer</a> type. Negative numbers may be used with signed |
| 942 | integer types. |
| 943 | </dd> |
| 944 | |
| 945 | <dt><b>Floating point constants</b></dt> |
| 946 | |
| 947 | <dd>Floating point constants use standard decimal notation (e.g. 123.421), |
| 948 | exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 949 | notation (see below). Floating point constants must have a <a |
| 950 | href="#t_floating">floating point</a> type. </dd> |
| 951 | |
| 952 | <dt><b>Null pointer constants</b></dt> |
| 953 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 954 | <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 955 | and must be of <a href="#t_pointer">pointer type</a>.</dd> |
| 956 | |
| 957 | </dl> |
| 958 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 959 | <p>The one non-intuitive notation for constants is the optional hexadecimal form |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 960 | of floating point constants. For example, the form '<tt>double |
| 961 | 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double |
| 962 | 4.5e+15</tt>'. The only time hexadecimal floating point constants are required |
Reid Spencer | cc16dc3 | 2004-12-09 18:02:53 +0000 | [diff] [blame] | 963 | (and the only time that they are generated by the disassembler) is when a |
| 964 | floating point constant must be emitted but it cannot be represented as a |
| 965 | decimal floating point number. For example, NaN's, infinities, and other |
| 966 | special values are represented in their IEEE hexadecimal format so that |
| 967 | assembly and disassembly do not cause any bits to change in the constants.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 968 | |
| 969 | </div> |
| 970 | |
| 971 | <!-- ======================================================================= --> |
| 972 | <div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a> |
| 973 | </div> |
| 974 | |
| 975 | <div class="doc_text"> |
Chris Lattner | d4f6b17 | 2005-03-07 22:13:59 +0000 | [diff] [blame] | 976 | <p>Aggregate constants arise from aggregation of simple constants |
| 977 | and smaller aggregate constants.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 978 | |
| 979 | <dl> |
| 980 | <dt><b>Structure constants</b></dt> |
| 981 | |
| 982 | <dd>Structure constants are represented with notation similar to structure |
| 983 | type definitions (a comma separated list of elements, surrounded by braces |
Chris Lattner | d4f6b17 | 2005-03-07 22:13:59 +0000 | [diff] [blame] | 984 | (<tt>{}</tt>)). For example: "<tt>{ int 4, float 17.0, int* %G }</tt>", |
| 985 | where "<tt>%G</tt>" is declared as "<tt>%G = external global int</tt>". Structure constants |
| 986 | must have <a href="#t_struct">structure type</a>, and the number and |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 987 | types of elements must match those specified by the type. |
| 988 | </dd> |
| 989 | |
| 990 | <dt><b>Array constants</b></dt> |
| 991 | |
| 992 | <dd>Array constants are represented with notation similar to array type |
| 993 | definitions (a comma separated list of elements, surrounded by square brackets |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 994 | (<tt>[]</tt>)). For example: "<tt>[ int 42, int 11, int 74 ]</tt>". Array |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 995 | constants must have <a href="#t_array">array type</a>, and the number and |
| 996 | types of elements must match those specified by the type. |
| 997 | </dd> |
| 998 | |
| 999 | <dt><b>Packed constants</b></dt> |
| 1000 | |
| 1001 | <dd>Packed constants are represented with notation similar to packed type |
| 1002 | definitions (a comma separated list of elements, surrounded by |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1003 | less-than/greater-than's (<tt><></tt>)). For example: "<tt>< int 42, |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1004 | int 11, int 74, int 100 ></tt>". Packed constants must have <a |
| 1005 | href="#t_packed">packed type</a>, and the number and types of elements must |
| 1006 | match those specified by the type. |
| 1007 | </dd> |
| 1008 | |
| 1009 | <dt><b>Zero initialization</b></dt> |
| 1010 | |
| 1011 | <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a |
| 1012 | value to zero of <em>any</em> type, including scalar and aggregate types. |
| 1013 | This is often used to avoid having to print large zero initializers (e.g. for |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 1014 | large arrays) and is always exactly equivalent to using explicit zero |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1015 | initializers. |
| 1016 | </dd> |
| 1017 | </dl> |
| 1018 | |
| 1019 | </div> |
| 1020 | |
| 1021 | <!-- ======================================================================= --> |
| 1022 | <div class="doc_subsection"> |
| 1023 | <a name="globalconstants">Global Variable and Function Addresses</a> |
| 1024 | </div> |
| 1025 | |
| 1026 | <div class="doc_text"> |
| 1027 | |
| 1028 | <p>The addresses of <a href="#globalvars">global variables</a> and <a |
| 1029 | href="#functionstructure">functions</a> are always implicitly valid (link-time) |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1030 | constants. These constants are explicitly referenced when the <a |
| 1031 | href="#identifiers">identifier for the global</a> is used and always have <a |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1032 | href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM |
| 1033 | file:</p> |
| 1034 | |
| 1035 | <pre> |
| 1036 | %X = global int 17 |
| 1037 | %Y = global int 42 |
| 1038 | %Z = global [2 x int*] [ int* %X, int* %Y ] |
| 1039 | </pre> |
| 1040 | |
| 1041 | </div> |
| 1042 | |
| 1043 | <!-- ======================================================================= --> |
Reid Spencer | 2dc45b8 | 2004-12-09 18:13:12 +0000 | [diff] [blame] | 1044 | <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1045 | <div class="doc_text"> |
Reid Spencer | 2dc45b8 | 2004-12-09 18:13:12 +0000 | [diff] [blame] | 1046 | <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1047 | no specific value. Undefined values may be of any type and be used anywhere |
Reid Spencer | 2dc45b8 | 2004-12-09 18:13:12 +0000 | [diff] [blame] | 1048 | a constant is permitted.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1049 | |
Reid Spencer | 2dc45b8 | 2004-12-09 18:13:12 +0000 | [diff] [blame] | 1050 | <p>Undefined values indicate to the compiler that the program is well defined |
| 1051 | no matter what value is used, giving the compiler more freedom to optimize. |
| 1052 | </p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1053 | </div> |
| 1054 | |
| 1055 | <!-- ======================================================================= --> |
| 1056 | <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a> |
| 1057 | </div> |
| 1058 | |
| 1059 | <div class="doc_text"> |
| 1060 | |
| 1061 | <p>Constant expressions are used to allow expressions involving other constants |
| 1062 | to be used as constants. Constant expressions may be of any <a |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1063 | href="#t_firstclass">first class</a> type and may involve any LLVM operation |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1064 | that does not have side effects (e.g. load and call are not supported). The |
| 1065 | following is the syntax for constant expressions:</p> |
| 1066 | |
| 1067 | <dl> |
| 1068 | <dt><b><tt>cast ( CST to TYPE )</tt></b></dt> |
| 1069 | |
| 1070 | <dd>Cast a constant to another type.</dd> |
| 1071 | |
| 1072 | <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt> |
| 1073 | |
| 1074 | <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on |
| 1075 | constants. As with the <a href="#i_getelementptr">getelementptr</a> |
| 1076 | instruction, the index list may have zero or more indexes, which are required |
| 1077 | to make sense for the type of "CSTPTR".</dd> |
| 1078 | |
| 1079 | <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt> |
| 1080 | |
Reid Spencer | 2dc45b8 | 2004-12-09 18:13:12 +0000 | [diff] [blame] | 1081 | <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may |
| 1082 | be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1083 | binary</a> operations. The constraints on operands are the same as those for |
| 1084 | the corresponding instruction (e.g. no bitwise operations on floating point |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 1085 | values are allowed).</dd> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1086 | </dl> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1087 | </div> |
Chris Lattner | 9ee5d22 | 2004-03-08 16:49:10 +0000 | [diff] [blame] | 1088 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1089 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1090 | <div class="doc_section"> <a name="instref">Instruction Reference</a> </div> |
| 1091 | <!-- *********************************************************************** --> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1092 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1093 | <div class="doc_text"> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1094 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1095 | <p>The LLVM instruction set consists of several different |
| 1096 | classifications of instructions: <a href="#terminators">terminator |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1097 | instructions</a>, <a href="#binaryops">binary instructions</a>, |
| 1098 | <a href="#bitwiseops">bitwise binary instructions</a>, <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1099 | href="#memoryops">memory instructions</a>, and <a href="#otherops">other |
| 1100 | instructions</a>.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1101 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1102 | </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1103 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1104 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1105 | <div class="doc_subsection"> <a name="terminators">Terminator |
| 1106 | Instructions</a> </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1107 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1108 | <div class="doc_text"> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1109 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1110 | <p>As mentioned <a href="#functionstructure">previously</a>, every |
| 1111 | basic block in a program ends with a "Terminator" instruction, which |
| 1112 | indicates which block should be executed after the current block is |
| 1113 | finished. These terminator instructions typically yield a '<tt>void</tt>' |
| 1114 | value: they produce control flow, not values (the one exception being |
| 1115 | the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p> |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1116 | <p>There are six different terminator instructions: the '<a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1117 | href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>' |
| 1118 | instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction, |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1119 | the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a |
| 1120 | href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a |
| 1121 | href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1122 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1123 | </div> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 1124 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1125 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1126 | <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>' |
| 1127 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1128 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1129 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1130 | <pre> ret <type> <value> <i>; Return a value from a non-void function</i> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1131 | ret void <i>; Return from void function</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1132 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1133 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1134 | <p>The '<tt>ret</tt>' instruction is used to return control flow (and a |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1135 | value) from a function back to the caller.</p> |
John Criswell | 4457dc9 | 2004-04-09 16:48:45 +0000 | [diff] [blame] | 1136 | <p>There are two forms of the '<tt>ret</tt>' instruction: one that |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1137 | returns a value and then causes control flow, and one that just causes |
| 1138 | control flow to occur.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1139 | <h5>Arguments:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1140 | <p>The '<tt>ret</tt>' instruction may return any '<a |
| 1141 | href="#t_firstclass">first class</a>' type. Notice that a function is |
| 1142 | not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>' |
| 1143 | instruction inside of the function that returns a value that does not |
| 1144 | match the return type of the function.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1145 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1146 | <p>When the '<tt>ret</tt>' instruction is executed, control flow |
| 1147 | returns back to the calling function's context. If the caller is a "<a |
John Criswell | fa08187 | 2004-06-25 15:16:57 +0000 | [diff] [blame] | 1148 | href="#i_call"><tt>call</tt></a>" instruction, execution continues at |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1149 | the instruction after the call. If the caller was an "<a |
| 1150 | href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 1151 | at the beginning of the "normal" destination block. If the instruction |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1152 | returns a value, that value shall set the call or invoke instruction's |
| 1153 | return value.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1154 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1155 | <pre> ret int 5 <i>; Return an integer value of 5</i> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1156 | ret void <i>; Return from a void function</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1157 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1158 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1159 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1160 | <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1161 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1162 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1163 | <pre> br bool <cond>, label <iftrue>, label <iffalse><br> br label <dest> <i>; Unconditional branch</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1164 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1165 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1166 | <p>The '<tt>br</tt>' instruction is used to cause control flow to |
| 1167 | transfer to a different basic block in the current function. There are |
| 1168 | two forms of this instruction, corresponding to a conditional branch |
| 1169 | and an unconditional branch.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1170 | <h5>Arguments:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1171 | <p>The conditional branch form of the '<tt>br</tt>' instruction takes a |
| 1172 | single '<tt>bool</tt>' value and two '<tt>label</tt>' values. The |
| 1173 | unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' |
| 1174 | value as a target.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1175 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1176 | <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>' |
| 1177 | argument is evaluated. If the value is <tt>true</tt>, control flows |
| 1178 | to the '<tt>iftrue</tt>' <tt>label</tt> argument. If "cond" is <tt>false</tt>, |
| 1179 | control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1180 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1181 | <pre>Test:<br> %cond = <a href="#i_setcc">seteq</a> int %a, %b<br> br bool %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br> <a |
| 1182 | href="#i_ret">ret</a> int 1<br>IfUnequal:<br> <a href="#i_ret">ret</a> int 0<br></pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1183 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1184 | <!-- _______________________________________________________________________ --> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1185 | <div class="doc_subsubsection"> |
| 1186 | <a name="i_switch">'<tt>switch</tt>' Instruction</a> |
| 1187 | </div> |
| 1188 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1189 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1190 | <h5>Syntax:</h5> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1191 | |
| 1192 | <pre> |
| 1193 | switch <intty> <value>, label <defaultdest> [ <intty> <val>, label <dest> ... ] |
| 1194 | </pre> |
| 1195 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1196 | <h5>Overview:</h5> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1197 | |
| 1198 | <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of |
| 1199 | several different places. It is a generalization of the '<tt>br</tt>' |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1200 | instruction, allowing a branch to occur to one of many possible |
| 1201 | destinations.</p> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1202 | |
| 1203 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1204 | <h5>Arguments:</h5> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1205 | |
| 1206 | <p>The '<tt>switch</tt>' instruction uses three parameters: an integer |
| 1207 | comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and |
| 1208 | an array of pairs of comparison value constants and '<tt>label</tt>'s. The |
| 1209 | table is not allowed to contain duplicate constant entries.</p> |
| 1210 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1211 | <h5>Semantics:</h5> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1212 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1213 | <p>The <tt>switch</tt> instruction specifies a table of values and |
| 1214 | destinations. When the '<tt>switch</tt>' instruction is executed, this |
John Criswell | 8411475 | 2004-06-25 16:05:06 +0000 | [diff] [blame] | 1215 | table is searched for the given value. If the value is found, control flow is |
| 1216 | transfered to the corresponding destination; otherwise, control flow is |
| 1217 | transfered to the default destination.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1218 | |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1219 | <h5>Implementation:</h5> |
| 1220 | |
| 1221 | <p>Depending on properties of the target machine and the particular |
| 1222 | <tt>switch</tt> instruction, this instruction may be code generated in different |
John Criswell | 8411475 | 2004-06-25 16:05:06 +0000 | [diff] [blame] | 1223 | ways. For example, it could be generated as a series of chained conditional |
| 1224 | branches or with a lookup table.</p> |
Chris Lattner | c88c17b | 2004-02-24 04:54:45 +0000 | [diff] [blame] | 1225 | |
| 1226 | <h5>Example:</h5> |
| 1227 | |
| 1228 | <pre> |
| 1229 | <i>; Emulate a conditional br instruction</i> |
| 1230 | %Val = <a href="#i_cast">cast</a> bool %value to int |
| 1231 | switch int %Val, label %truedest [int 0, label %falsedest ] |
| 1232 | |
| 1233 | <i>; Emulate an unconditional br instruction</i> |
| 1234 | switch uint 0, label %dest [ ] |
| 1235 | |
| 1236 | <i>; Implement a jump table:</i> |
| 1237 | switch uint %val, label %otherwise [ uint 0, label %onzero |
| 1238 | uint 1, label %onone |
| 1239 | uint 2, label %ontwo ] |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1240 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1241 | </div> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1242 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1243 | <!-- _______________________________________________________________________ --> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1244 | <div class="doc_subsubsection"> |
| 1245 | <a name="i_invoke">'<tt>invoke</tt>' Instruction</a> |
| 1246 | </div> |
| 1247 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1248 | <div class="doc_text"> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1249 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1250 | <h5>Syntax:</h5> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1251 | |
| 1252 | <pre> |
| 1253 | <result> = invoke [<a href="#callingconv">cconv</a>] <ptr to function ty> %<function ptr val>(<function args>) |
| 1254 | to label <normal label> except label <exception label> |
| 1255 | </pre> |
| 1256 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 1257 | <h5>Overview:</h5> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1258 | |
| 1259 | <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified |
| 1260 | function, with the possibility of control flow transfer to either the |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 1261 | '<tt>normal</tt>' label or the |
| 1262 | '<tt>exception</tt>' label. If the callee function returns with the |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1263 | "<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the |
| 1264 | "normal" label. If the callee (or any indirect callees) returns with the "<a |
John Criswell | e4c57cc | 2005-05-12 16:52:32 +0000 | [diff] [blame] | 1265 | href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and |
| 1266 | continued at the dynamically nearest "exception" label.</p> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1267 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1268 | <h5>Arguments:</h5> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1269 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1270 | <p>This instruction requires several arguments:</p> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1271 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1272 | <ol> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1273 | <li> |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1274 | The optional "cconv" marker indicates which <a href="callingconv">calling |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1275 | convention</a> the call should use. If none is specified, the call defaults |
| 1276 | to using C calling conventions. |
| 1277 | </li> |
| 1278 | <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to |
| 1279 | function value being invoked. In most cases, this is a direct function |
| 1280 | invocation, but indirect <tt>invoke</tt>s are just as possible, branching off |
| 1281 | an arbitrary pointer to function value. |
| 1282 | </li> |
| 1283 | |
| 1284 | <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a |
| 1285 | function to be invoked. </li> |
| 1286 | |
| 1287 | <li>'<tt>function args</tt>': argument list whose types match the function |
| 1288 | signature argument types. If the function signature indicates the function |
| 1289 | accepts a variable number of arguments, the extra arguments can be |
| 1290 | specified. </li> |
| 1291 | |
| 1292 | <li>'<tt>normal label</tt>': the label reached when the called function |
| 1293 | executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li> |
| 1294 | |
| 1295 | <li>'<tt>exception label</tt>': the label reached when a callee returns with |
| 1296 | the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li> |
| 1297 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1298 | </ol> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1299 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1300 | <h5>Semantics:</h5> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1301 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1302 | <p>This instruction is designed to operate as a standard '<tt><a |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1303 | href="#i_call">call</a></tt>' instruction in most regards. The primary |
| 1304 | difference is that it establishes an association with a label, which is used by |
| 1305 | the runtime library to unwind the stack.</p> |
| 1306 | |
| 1307 | <p>This instruction is used in languages with destructors to ensure that proper |
| 1308 | cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown |
| 1309 | exception. Additionally, this is important for implementation of |
| 1310 | '<tt>catch</tt>' clauses in high-level languages that support them.</p> |
| 1311 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1312 | <h5>Example:</h5> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 1313 | <pre> |
| 1314 | %retval = invoke int %Test(int 15) to label %Continue |
| 1315 | except label %TestCleanup <i>; {int}:retval set</i> |
| 1316 | %retval = invoke <a href="#callingconv">coldcc</a> int %Test(int 15) to label %Continue |
| 1317 | except label %TestCleanup <i>; {int}:retval set</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1318 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1319 | </div> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1320 | |
| 1321 | |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 1322 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1323 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1324 | <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>' |
| 1325 | Instruction</a> </div> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1326 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1327 | <div class="doc_text"> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1328 | |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 1329 | <h5>Syntax:</h5> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1330 | <pre> |
| 1331 | unwind |
| 1332 | </pre> |
| 1333 | |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 1334 | <h5>Overview:</h5> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1335 | |
| 1336 | <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow |
| 1337 | at the first callee in the dynamic call stack which used an <a |
| 1338 | href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call. This is |
| 1339 | primarily used to implement exception handling.</p> |
| 1340 | |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 1341 | <h5>Semantics:</h5> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1342 | |
| 1343 | <p>The '<tt>unwind</tt>' intrinsic causes execution of the current function to |
| 1344 | immediately halt. The dynamic call stack is then searched for the first <a |
| 1345 | href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack. Once found, |
| 1346 | execution continues at the "exceptional" destination block specified by the |
| 1347 | <tt>invoke</tt> instruction. If there is no <tt>invoke</tt> instruction in the |
| 1348 | dynamic call chain, undefined behavior results.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1349 | </div> |
Chris Lattner | 35eca58 | 2004-10-16 18:04:13 +0000 | [diff] [blame] | 1350 | |
| 1351 | <!-- _______________________________________________________________________ --> |
| 1352 | |
| 1353 | <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>' |
| 1354 | Instruction</a> </div> |
| 1355 | |
| 1356 | <div class="doc_text"> |
| 1357 | |
| 1358 | <h5>Syntax:</h5> |
| 1359 | <pre> |
| 1360 | unreachable |
| 1361 | </pre> |
| 1362 | |
| 1363 | <h5>Overview:</h5> |
| 1364 | |
| 1365 | <p>The '<tt>unreachable</tt>' instruction has no defined semantics. This |
| 1366 | instruction is used to inform the optimizer that a particular portion of the |
| 1367 | code is not reachable. This can be used to indicate that the code after a |
| 1368 | no-return function cannot be reached, and other facts.</p> |
| 1369 | |
| 1370 | <h5>Semantics:</h5> |
| 1371 | |
| 1372 | <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p> |
| 1373 | </div> |
| 1374 | |
| 1375 | |
| 1376 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1377 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1378 | <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1379 | <div class="doc_text"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1380 | <p>Binary operators are used to do most of the computation in a |
| 1381 | program. They require two operands, execute an operation on them, and |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1382 | produce a single value. The operands might represent |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1383 | multiple data, as is the case with the <a href="#t_packed">packed</a> data type. |
| 1384 | The result value of a binary operator is not |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1385 | necessarily the same type as its operands.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1386 | <p>There are several different binary operators:</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1387 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1388 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1389 | <div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>' |
| 1390 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1391 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1392 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1393 | <pre> <result> = add <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1394 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1395 | <h5>Overview:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1396 | <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1397 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1398 | <p>The two arguments to the '<tt>add</tt>' instruction must be either <a |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1399 | href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> values. |
| 1400 | This instruction can also take <a href="#t_packed">packed</a> versions of the values. |
| 1401 | Both arguments must have identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1402 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1403 | <p>The value produced is the integer or floating point sum of the two |
| 1404 | operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1405 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1406 | <pre> <result> = add int 4, %var <i>; yields {int}:result = 4 + %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1407 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1408 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1409 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1410 | <div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>' |
| 1411 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1412 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1413 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1414 | <pre> <result> = sub <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1415 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1416 | <h5>Overview:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1417 | <p>The '<tt>sub</tt>' instruction returns the difference of its two |
| 1418 | operands.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1419 | <p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>' |
| 1420 | instruction present in most other intermediate representations.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1421 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1422 | <p>The two arguments to the '<tt>sub</tt>' instruction must be either <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1423 | href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1424 | values. |
| 1425 | This instruction can also take <a href="#t_packed">packed</a> versions of the values. |
| 1426 | Both arguments must have identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1427 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1428 | <p>The value produced is the integer or floating point difference of |
| 1429 | the two operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1430 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1431 | <pre> <result> = sub int 4, %var <i>; yields {int}:result = 4 - %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1432 | <result> = sub int 0, %val <i>; yields {int}:result = -%var</i> |
| 1433 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1434 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1435 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1436 | <div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>' |
| 1437 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1438 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1439 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1440 | <pre> <result> = mul <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1441 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1442 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1443 | <p>The '<tt>mul</tt>' instruction returns the product of its two |
| 1444 | operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1445 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1446 | <p>The two arguments to the '<tt>mul</tt>' instruction must be either <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1447 | href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1448 | values. |
| 1449 | This instruction can also take <a href="#t_packed">packed</a> versions of the values. |
| 1450 | Both arguments must have identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1451 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1452 | <p>The value produced is the integer or floating point product of the |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1453 | two operands.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1454 | <p>There is no signed vs unsigned multiplication. The appropriate |
| 1455 | action is taken based on the type of the operand.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1456 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1457 | <pre> <result> = mul int 4, %var <i>; yields {int}:result = 4 * %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1458 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1459 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1460 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1461 | <div class="doc_subsubsection"> <a name="i_div">'<tt>div</tt>' |
| 1462 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1463 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1464 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1465 | <pre> <result> = div <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
| 1466 | </pre> |
| 1467 | <h5>Overview:</h5> |
| 1468 | <p>The '<tt>div</tt>' instruction returns the quotient of its two |
| 1469 | operands.</p> |
| 1470 | <h5>Arguments:</h5> |
| 1471 | <p>The two arguments to the '<tt>div</tt>' instruction must be either <a |
| 1472 | href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1473 | values. |
| 1474 | This instruction can also take <a href="#t_packed">packed</a> versions of the values. |
| 1475 | Both arguments must have identical types.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1476 | <h5>Semantics:</h5> |
| 1477 | <p>The value produced is the integer or floating point quotient of the |
| 1478 | two operands.</p> |
| 1479 | <h5>Example:</h5> |
| 1480 | <pre> <result> = div int 4, %var <i>; yields {int}:result = 4 / %var</i> |
| 1481 | </pre> |
| 1482 | </div> |
| 1483 | <!-- _______________________________________________________________________ --> |
| 1484 | <div class="doc_subsubsection"> <a name="i_rem">'<tt>rem</tt>' |
| 1485 | Instruction</a> </div> |
| 1486 | <div class="doc_text"> |
| 1487 | <h5>Syntax:</h5> |
| 1488 | <pre> <result> = rem <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
| 1489 | </pre> |
| 1490 | <h5>Overview:</h5> |
| 1491 | <p>The '<tt>rem</tt>' instruction returns the remainder from the |
| 1492 | division of its two operands.</p> |
| 1493 | <h5>Arguments:</h5> |
| 1494 | <p>The two arguments to the '<tt>rem</tt>' instruction must be either <a |
| 1495 | href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> |
Chris Lattner | a58561b | 2004-08-12 19:12:28 +0000 | [diff] [blame] | 1496 | values. |
| 1497 | This instruction can also take <a href="#t_packed">packed</a> versions of the values. |
| 1498 | Both arguments must have identical types.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1499 | <h5>Semantics:</h5> |
| 1500 | <p>This returns the <i>remainder</i> of a division (where the result |
| 1501 | has the same sign as the divisor), not the <i>modulus</i> (where the |
| 1502 | result has the same sign as the dividend) of a value. For more |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 1503 | information about the difference, see <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1504 | href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The |
| 1505 | Math Forum</a>.</p> |
| 1506 | <h5>Example:</h5> |
| 1507 | <pre> <result> = rem int 4, %var <i>; yields {int}:result = 4 % %var</i> |
| 1508 | </pre> |
| 1509 | </div> |
| 1510 | <!-- _______________________________________________________________________ --> |
| 1511 | <div class="doc_subsubsection"> <a name="i_setcc">'<tt>set<i>cc</i></tt>' |
| 1512 | Instructions</a> </div> |
| 1513 | <div class="doc_text"> |
| 1514 | <h5>Syntax:</h5> |
| 1515 | <pre> <result> = seteq <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1516 | <result> = setne <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
| 1517 | <result> = setlt <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
| 1518 | <result> = setgt <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
| 1519 | <result> = setle <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
| 1520 | <result> = setge <ty> <var1>, <var2> <i>; yields {bool}:result</i> |
| 1521 | </pre> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1522 | <h5>Overview:</h5> |
| 1523 | <p>The '<tt>set<i>cc</i></tt>' family of instructions returns a boolean |
| 1524 | value based on a comparison of their two operands.</p> |
| 1525 | <h5>Arguments:</h5> |
| 1526 | <p>The two arguments to the '<tt>set<i>cc</i></tt>' instructions must |
| 1527 | be of <a href="#t_firstclass">first class</a> type (it is not possible |
| 1528 | to compare '<tt>label</tt>'s, '<tt>array</tt>'s, '<tt>structure</tt>' |
| 1529 | or '<tt>void</tt>' values, etc...). Both arguments must have identical |
| 1530 | types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1531 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1532 | <p>The '<tt>seteq</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1533 | value if both operands are equal.<br> |
| 1534 | The '<tt>setne</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1535 | value if both operands are unequal.<br> |
| 1536 | The '<tt>setlt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1537 | value if the first operand is less than the second operand.<br> |
| 1538 | The '<tt>setgt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1539 | value if the first operand is greater than the second operand.<br> |
| 1540 | The '<tt>setle</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1541 | value if the first operand is less than or equal to the second operand.<br> |
| 1542 | The '<tt>setge</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' |
| 1543 | value if the first operand is greater than or equal to the second |
| 1544 | operand.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1545 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1546 | <pre> <result> = seteq int 4, 5 <i>; yields {bool}:result = false</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1547 | <result> = setne float 4, 5 <i>; yields {bool}:result = true</i> |
| 1548 | <result> = setlt uint 4, 5 <i>; yields {bool}:result = true</i> |
| 1549 | <result> = setgt sbyte 4, 5 <i>; yields {bool}:result = false</i> |
| 1550 | <result> = setle sbyte 4, 5 <i>; yields {bool}:result = true</i> |
| 1551 | <result> = setge sbyte 4, 5 <i>; yields {bool}:result = false</i> |
| 1552 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1553 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1554 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1555 | <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary |
| 1556 | Operations</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1557 | <div class="doc_text"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1558 | <p>Bitwise binary operators are used to do various forms of |
| 1559 | bit-twiddling in a program. They are generally very efficient |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1560 | instructions and can commonly be strength reduced from other |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1561 | instructions. They require two operands, execute an operation on them, |
| 1562 | and produce a single value. The resulting value of the bitwise binary |
| 1563 | operators is always the same type as its first operand.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1564 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1565 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1566 | <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>' |
| 1567 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1568 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1569 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1570 | <pre> <result> = and <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1571 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1572 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1573 | <p>The '<tt>and</tt>' instruction returns the bitwise logical and of |
| 1574 | its two operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1575 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1576 | <p>The two arguments to the '<tt>and</tt>' instruction must be <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1577 | href="#t_integral">integral</a> values. Both arguments must have |
| 1578 | identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1579 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1580 | <p>The truth table used for the '<tt>and</tt>' instruction is:</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1581 | <p> </p> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1582 | <div style="align: center"> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1583 | <table border="1" cellspacing="0" cellpadding="4"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1584 | <tbody> |
| 1585 | <tr> |
| 1586 | <td>In0</td> |
| 1587 | <td>In1</td> |
| 1588 | <td>Out</td> |
| 1589 | </tr> |
| 1590 | <tr> |
| 1591 | <td>0</td> |
| 1592 | <td>0</td> |
| 1593 | <td>0</td> |
| 1594 | </tr> |
| 1595 | <tr> |
| 1596 | <td>0</td> |
| 1597 | <td>1</td> |
| 1598 | <td>0</td> |
| 1599 | </tr> |
| 1600 | <tr> |
| 1601 | <td>1</td> |
| 1602 | <td>0</td> |
| 1603 | <td>0</td> |
| 1604 | </tr> |
| 1605 | <tr> |
| 1606 | <td>1</td> |
| 1607 | <td>1</td> |
| 1608 | <td>1</td> |
| 1609 | </tr> |
| 1610 | </tbody> |
| 1611 | </table> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1612 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1613 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1614 | <pre> <result> = and int 4, %var <i>; yields {int}:result = 4 & %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1615 | <result> = and int 15, 40 <i>; yields {int}:result = 8</i> |
| 1616 | <result> = and int 4, 8 <i>; yields {int}:result = 0</i> |
| 1617 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1618 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1619 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1620 | <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1621 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1622 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1623 | <pre> <result> = or <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1624 | </pre> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1625 | <h5>Overview:</h5> |
| 1626 | <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive |
| 1627 | or of its two operands.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1628 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1629 | <p>The two arguments to the '<tt>or</tt>' instruction must be <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1630 | href="#t_integral">integral</a> values. Both arguments must have |
| 1631 | identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1632 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1633 | <p>The truth table used for the '<tt>or</tt>' instruction is:</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1634 | <p> </p> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1635 | <div style="align: center"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1636 | <table border="1" cellspacing="0" cellpadding="4"> |
| 1637 | <tbody> |
| 1638 | <tr> |
| 1639 | <td>In0</td> |
| 1640 | <td>In1</td> |
| 1641 | <td>Out</td> |
| 1642 | </tr> |
| 1643 | <tr> |
| 1644 | <td>0</td> |
| 1645 | <td>0</td> |
| 1646 | <td>0</td> |
| 1647 | </tr> |
| 1648 | <tr> |
| 1649 | <td>0</td> |
| 1650 | <td>1</td> |
| 1651 | <td>1</td> |
| 1652 | </tr> |
| 1653 | <tr> |
| 1654 | <td>1</td> |
| 1655 | <td>0</td> |
| 1656 | <td>1</td> |
| 1657 | </tr> |
| 1658 | <tr> |
| 1659 | <td>1</td> |
| 1660 | <td>1</td> |
| 1661 | <td>1</td> |
| 1662 | </tr> |
| 1663 | </tbody> |
| 1664 | </table> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1665 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1666 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1667 | <pre> <result> = or int 4, %var <i>; yields {int}:result = 4 | %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1668 | <result> = or int 15, 40 <i>; yields {int}:result = 47</i> |
| 1669 | <result> = or int 4, 8 <i>; yields {int}:result = 12</i> |
| 1670 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1671 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1672 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1673 | <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>' |
| 1674 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1675 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1676 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1677 | <pre> <result> = xor <ty> <var1>, <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1678 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1679 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1680 | <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive |
| 1681 | or of its two operands. The <tt>xor</tt> is used to implement the |
| 1682 | "one's complement" operation, which is the "~" operator in C.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1683 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1684 | <p>The two arguments to the '<tt>xor</tt>' instruction must be <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1685 | href="#t_integral">integral</a> values. Both arguments must have |
| 1686 | identical types.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1687 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1688 | <p>The truth table used for the '<tt>xor</tt>' instruction is:</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1689 | <p> </p> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1690 | <div style="align: center"> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1691 | <table border="1" cellspacing="0" cellpadding="4"> |
| 1692 | <tbody> |
| 1693 | <tr> |
| 1694 | <td>In0</td> |
| 1695 | <td>In1</td> |
| 1696 | <td>Out</td> |
| 1697 | </tr> |
| 1698 | <tr> |
| 1699 | <td>0</td> |
| 1700 | <td>0</td> |
| 1701 | <td>0</td> |
| 1702 | </tr> |
| 1703 | <tr> |
| 1704 | <td>0</td> |
| 1705 | <td>1</td> |
| 1706 | <td>1</td> |
| 1707 | </tr> |
| 1708 | <tr> |
| 1709 | <td>1</td> |
| 1710 | <td>0</td> |
| 1711 | <td>1</td> |
| 1712 | </tr> |
| 1713 | <tr> |
| 1714 | <td>1</td> |
| 1715 | <td>1</td> |
| 1716 | <td>0</td> |
| 1717 | </tr> |
| 1718 | </tbody> |
| 1719 | </table> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 1720 | </div> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1721 | <p> </p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1722 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1723 | <pre> <result> = xor int 4, %var <i>; yields {int}:result = 4 ^ %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1724 | <result> = xor int 15, 40 <i>; yields {int}:result = 39</i> |
| 1725 | <result> = xor int 4, 8 <i>; yields {int}:result = 12</i> |
Chris Lattner | 27f71f2 | 2003-09-03 00:41:47 +0000 | [diff] [blame] | 1726 | <result> = xor int %V, -1 <i>; yields {int}:result = ~%V</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1727 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1728 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1729 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1730 | <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>' |
| 1731 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1732 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1733 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1734 | <pre> <result> = shl <ty> <var1>, ubyte <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1735 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1736 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1737 | <p>The '<tt>shl</tt>' instruction returns the first operand shifted to |
| 1738 | the left a specified number of bits.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1739 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1740 | <p>The first argument to the '<tt>shl</tt>' instruction must be an <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1741 | href="#t_integer">integer</a> type. The second argument must be an '<tt>ubyte</tt>' |
| 1742 | type.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1743 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1744 | <p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1745 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1746 | <pre> <result> = shl int 4, ubyte %var <i>; yields {int}:result = 4 << %var</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1747 | <result> = shl int 4, ubyte 2 <i>; yields {int}:result = 16</i> |
| 1748 | <result> = shl int 1, ubyte 10 <i>; yields {int}:result = 1024</i> |
| 1749 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1750 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1751 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1752 | <div class="doc_subsubsection"> <a name="i_shr">'<tt>shr</tt>' |
| 1753 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1754 | <div class="doc_text"> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1755 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1756 | <pre> <result> = shr <ty> <var1>, ubyte <var2> <i>; yields {ty}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1757 | </pre> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1758 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1759 | <p>The '<tt>shr</tt>' instruction returns the first operand shifted to |
| 1760 | the right a specified number of bits.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1761 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1762 | <p>The first argument to the '<tt>shr</tt>' instruction must be an <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1763 | href="#t_integer">integer</a> type. The second argument must be an '<tt>ubyte</tt>' |
| 1764 | type.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1765 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1766 | <p>If the first argument is a <a href="#t_signed">signed</a> type, the |
| 1767 | most significant bit is duplicated in the newly free'd bit positions. |
| 1768 | If the first argument is unsigned, zero bits shall fill the empty |
| 1769 | positions.</p> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1770 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1771 | <pre> <result> = shr int 4, ubyte %var <i>; yields {int}:result = 4 >> %var</i> |
Chris Lattner | 8c6bb90 | 2003-06-18 21:30:51 +0000 | [diff] [blame] | 1772 | <result> = shr uint 4, ubyte 1 <i>; yields {uint}:result = 2</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1773 | <result> = shr int 4, ubyte 2 <i>; yields {int}:result = 1</i> |
Chris Lattner | 8c6bb90 | 2003-06-18 21:30:51 +0000 | [diff] [blame] | 1774 | <result> = shr sbyte 4, ubyte 3 <i>; yields {sbyte}:result = 0</i> |
| 1775 | <result> = shr sbyte -2, ubyte 1 <i>; yields {sbyte}:result = -1</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1776 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1777 | </div> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1778 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1779 | <!-- ======================================================================= --> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1780 | <div class="doc_subsection"> |
| 1781 | <a name="memoryops">Memory Access Operations</a> |
| 1782 | </div> |
| 1783 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1784 | <div class="doc_text"> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1785 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1786 | <p>A key design point of an SSA-based representation is how it |
| 1787 | represents memory. In LLVM, no memory locations are in SSA form, which |
| 1788 | makes things very simple. This section describes how to read, write, |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1789 | allocate, and free memory in LLVM.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1790 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1791 | </div> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1792 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1793 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1794 | <div class="doc_subsubsection"> |
| 1795 | <a name="i_malloc">'<tt>malloc</tt>' Instruction</a> |
| 1796 | </div> |
| 1797 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1798 | <div class="doc_text"> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1799 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1800 | <h5>Syntax:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1801 | |
| 1802 | <pre> |
| 1803 | <result> = malloc <type>[, uint <NumElements>][, align <alignment>] <i>; yields {type*}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1804 | </pre> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1805 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1806 | <h5>Overview:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1807 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1808 | <p>The '<tt>malloc</tt>' instruction allocates memory from the system |
| 1809 | heap and returns a pointer to it.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1810 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1811 | <h5>Arguments:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1812 | |
| 1813 | <p>The '<tt>malloc</tt>' instruction allocates |
| 1814 | <tt>sizeof(<type>)*NumElements</tt> |
John Criswell | 6e4ca61 | 2004-02-24 16:13:56 +0000 | [diff] [blame] | 1815 | bytes of memory from the operating system and returns a pointer of the |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1816 | appropriate type to the program. If "NumElements" is specified, it is the |
| 1817 | number of elements allocated. If an alignment is specified, the value result |
| 1818 | of the allocation is guaranteed to be aligned to at least that boundary. If |
| 1819 | not specified, or if zero, the target can choose to align the allocation on any |
| 1820 | convenient boundary.</p> |
| 1821 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1822 | <p>'<tt>type</tt>' must be a sized type.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1823 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1824 | <h5>Semantics:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1825 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1826 | <p>Memory is allocated using the system "<tt>malloc</tt>" function, and |
| 1827 | a pointer is returned.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1828 | |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1829 | <h5>Example:</h5> |
| 1830 | |
| 1831 | <pre> |
| 1832 | %array = malloc [4 x ubyte ] <i>; yields {[%4 x ubyte]*}:array</i> |
| 1833 | |
| 1834 | %size = <a href="#i_add">add</a> uint 2, 2 <i>; yields {uint}:size = uint 4</i> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1835 | %array1 = malloc ubyte, uint 4 <i>; yields {ubyte*}:array1</i> |
| 1836 | %array2 = malloc [12 x ubyte], uint %size <i>; yields {[12 x ubyte]*}:array2</i> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1837 | %array3 = malloc int, uint 4, align 1024 <i>; yields {int*}:array3</i> |
| 1838 | %array4 = malloc int, align 1024 <i>; yields {int*}:array4</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1839 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1840 | </div> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1841 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1842 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1843 | <div class="doc_subsubsection"> |
| 1844 | <a name="i_free">'<tt>free</tt>' Instruction</a> |
| 1845 | </div> |
| 1846 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1847 | <div class="doc_text"> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1848 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1849 | <h5>Syntax:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1850 | |
| 1851 | <pre> |
| 1852 | free <type> <value> <i>; yields {void}</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1853 | </pre> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1854 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1855 | <h5>Overview:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1856 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1857 | <p>The '<tt>free</tt>' instruction returns memory back to the unused |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1858 | memory heap to be reallocated in the future.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1859 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1860 | <h5>Arguments:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1861 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1862 | <p>'<tt>value</tt>' shall be a pointer value that points to a value |
| 1863 | that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>' |
| 1864 | instruction.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1865 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1866 | <h5>Semantics:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1867 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1868 | <p>Access to the memory pointed to by the pointer is no longer defined |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1869 | after this instruction executes.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1870 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1871 | <h5>Example:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1872 | |
| 1873 | <pre> |
| 1874 | %array = <a href="#i_malloc">malloc</a> [4 x ubyte] <i>; yields {[4 x ubyte]*}:array</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1875 | free [4 x ubyte]* %array |
| 1876 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1877 | </div> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1878 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1879 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1880 | <div class="doc_subsubsection"> |
| 1881 | <a name="i_alloca">'<tt>alloca</tt>' Instruction</a> |
| 1882 | </div> |
| 1883 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1884 | <div class="doc_text"> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1885 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1886 | <h5>Syntax:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1887 | |
| 1888 | <pre> |
| 1889 | <result> = alloca <type>[, uint <NumElements>][, align <alignment>] <i>; yields {type*}:result</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1890 | </pre> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1891 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1892 | <h5>Overview:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1893 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1894 | <p>The '<tt>alloca</tt>' instruction allocates memory on the current |
| 1895 | stack frame of the procedure that is live until the current function |
| 1896 | returns to its caller.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1897 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1898 | <h5>Arguments:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1899 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 1900 | <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(<type>)*NumElements</tt> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1901 | bytes of memory on the runtime stack, returning a pointer of the |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1902 | appropriate type to the program. If "NumElements" is specified, it is the |
| 1903 | number of elements allocated. If an alignment is specified, the value result |
| 1904 | of the allocation is guaranteed to be aligned to at least that boundary. If |
| 1905 | not specified, or if zero, the target can choose to align the allocation on any |
| 1906 | convenient boundary.</p> |
| 1907 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1908 | <p>'<tt>type</tt>' may be any sized type.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1909 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1910 | <h5>Semantics:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1911 | |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1912 | <p>Memory is allocated; a pointer is returned. '<tt>alloca</tt>'d |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1913 | memory is automatically released when the function returns. The '<tt>alloca</tt>' |
| 1914 | instruction is commonly used to represent automatic variables that must |
| 1915 | have an address available. When the function returns (either with the <tt><a |
John Criswell | dae2e93 | 2005-05-12 16:55:34 +0000 | [diff] [blame] | 1916 | href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1917 | instructions), the memory is reclaimed.</p> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1918 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1919 | <h5>Example:</h5> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1920 | |
| 1921 | <pre> |
| 1922 | %ptr = alloca int <i>; yields {int*}:ptr</i> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1923 | %ptr = alloca int, uint 4 <i>; yields {int*}:ptr</i> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1924 | %ptr = alloca int, uint 4, align 1024 <i>; yields {int*}:ptr</i> |
| 1925 | %ptr = alloca int, align 1024 <i>; yields {int*}:ptr</i> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1926 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1927 | </div> |
Chris Lattner | 2cbdc45 | 2005-11-06 08:02:57 +0000 | [diff] [blame^] | 1928 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1929 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1930 | <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>' |
| 1931 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1932 | <div class="doc_text"> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1933 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1934 | <pre> <result> = load <ty>* <pointer><br> <result> = volatile load <ty>* <pointer><br></pre> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1935 | <h5>Overview:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1936 | <p>The '<tt>load</tt>' instruction is used to read from memory.</p> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1937 | <h5>Arguments:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1938 | <p>The argument to the '<tt>load</tt>' instruction specifies the memory |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 1939 | address from which to load. The pointer must point to a <a |
Chris Lattner | e53e508 | 2004-06-03 22:57:15 +0000 | [diff] [blame] | 1940 | href="#t_firstclass">first class</a> type. If the <tt>load</tt> is |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 1941 | marked as <tt>volatile</tt>, then the optimizer is not allowed to modify |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1942 | the number or order of execution of this <tt>load</tt> with other |
| 1943 | volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt> |
| 1944 | instructions. </p> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1945 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1946 | <p>The location of memory pointed to is loaded.</p> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1947 | <h5>Examples:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1948 | <pre> %ptr = <a href="#i_alloca">alloca</a> int <i>; yields {int*}:ptr</i> |
| 1949 | <a |
| 1950 | href="#i_store">store</a> int 3, int* %ptr <i>; yields {void}</i> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1951 | %val = load int* %ptr <i>; yields {int}:val = int 3</i> |
| 1952 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1953 | </div> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1954 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1955 | <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>' |
| 1956 | Instruction</a> </div> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1957 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1958 | <pre> store <ty> <value>, <ty>* <pointer> <i>; yields {void}</i> |
Chris Lattner | f065107 | 2003-09-08 18:27:49 +0000 | [diff] [blame] | 1959 | volatile store <ty> <value>, <ty>* <pointer> <i>; yields {void}</i> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1960 | </pre> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1961 | <h5>Overview:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1962 | <p>The '<tt>store</tt>' instruction is used to write to memory.</p> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1963 | <h5>Arguments:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1964 | <p>There are two arguments to the '<tt>store</tt>' instruction: a value |
John Criswell | 0ec250c | 2005-10-24 16:17:18 +0000 | [diff] [blame] | 1965 | to store and an address in which to store it. The type of the '<tt><pointer></tt>' |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1966 | operand must be a pointer to the type of the '<tt><value></tt>' |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 1967 | operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1968 | optimizer is not allowed to modify the number or order of execution of |
| 1969 | this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a |
| 1970 | href="#i_store">store</a></tt> instructions.</p> |
| 1971 | <h5>Semantics:</h5> |
| 1972 | <p>The contents of memory are updated to contain '<tt><value></tt>' |
| 1973 | at the location specified by the '<tt><pointer></tt>' operand.</p> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1974 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 1975 | <pre> %ptr = <a href="#i_alloca">alloca</a> int <i>; yields {int*}:ptr</i> |
| 1976 | <a |
| 1977 | href="#i_store">store</a> int 3, int* %ptr <i>; yields {void}</i> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1978 | %val = load int* %ptr <i>; yields {int}:val = int 3</i> |
| 1979 | </pre> |
Chris Lattner | 2b7d320 | 2002-05-06 03:03:22 +0000 | [diff] [blame] | 1980 | <!-- _______________________________________________________________________ --> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 1981 | <div class="doc_subsubsection"> |
| 1982 | <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a> |
| 1983 | </div> |
| 1984 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 1985 | <div class="doc_text"> |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1986 | <h5>Syntax:</h5> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 1987 | <pre> |
| 1988 | <result> = getelementptr <ty>* <ptrval>{, <ty> <idx>}* |
| 1989 | </pre> |
| 1990 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1991 | <h5>Overview:</h5> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 1992 | |
| 1993 | <p> |
| 1994 | The '<tt>getelementptr</tt>' instruction is used to get the address of a |
| 1995 | subelement of an aggregate data structure.</p> |
| 1996 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 1997 | <h5>Arguments:</h5> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 1998 | |
| 1999 | <p>This instruction takes a list of integer constants that indicate what |
| 2000 | elements of the aggregate object to index to. The actual types of the arguments |
| 2001 | provided depend on the type of the first pointer argument. The |
| 2002 | '<tt>getelementptr</tt>' instruction is used to index down through the type |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2003 | levels of a structure or to a specific index in an array. When indexing into a |
| 2004 | structure, only <tt>uint</tt> |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 2005 | integer constants are allowed. When indexing into an array or pointer, |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2006 | <tt>int</tt> and <tt>long</tt> indexes are allowed of any sign.</p> |
| 2007 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2008 | <p>For example, let's consider a C code fragment and how it gets |
| 2009 | compiled to LLVM:</p> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2010 | |
| 2011 | <pre> |
| 2012 | struct RT { |
| 2013 | char A; |
| 2014 | int B[10][20]; |
| 2015 | char C; |
| 2016 | }; |
| 2017 | struct ST { |
| 2018 | int X; |
| 2019 | double Y; |
| 2020 | struct RT Z; |
| 2021 | }; |
| 2022 | |
| 2023 | int *foo(struct ST *s) { |
| 2024 | return &s[1].Z.B[5][13]; |
| 2025 | } |
| 2026 | </pre> |
| 2027 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2028 | <p>The LLVM code generated by the GCC frontend is:</p> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2029 | |
| 2030 | <pre> |
| 2031 | %RT = type { sbyte, [10 x [20 x int]], sbyte } |
| 2032 | %ST = type { int, double, %RT } |
| 2033 | |
Brian Gaeke | 7283e7c | 2004-07-02 21:08:14 +0000 | [diff] [blame] | 2034 | implementation |
| 2035 | |
| 2036 | int* %foo(%ST* %s) { |
| 2037 | entry: |
| 2038 | %reg = getelementptr %ST* %s, int 1, uint 2, uint 1, int 5, int 13 |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2039 | ret int* %reg |
| 2040 | } |
| 2041 | </pre> |
| 2042 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 2043 | <h5>Semantics:</h5> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2044 | |
| 2045 | <p>The index types specified for the '<tt>getelementptr</tt>' instruction depend |
John Criswell | c1f786c | 2005-05-13 22:25:59 +0000 | [diff] [blame] | 2046 | on the pointer type that is being indexed into. <a href="#t_pointer">Pointer</a> |
Chris Lattner | e53e508 | 2004-06-03 22:57:15 +0000 | [diff] [blame] | 2047 | and <a href="#t_array">array</a> types require <tt>uint</tt>, <tt>int</tt>, |
| 2048 | <tt>ulong</tt>, or <tt>long</tt> values, and <a href="#t_struct">structure</a> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2049 | types require <tt>uint</tt> <b>constants</b>.</p> |
| 2050 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2051 | <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>' |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2052 | type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ int, double, %RT |
| 2053 | }</tt>' type, a structure. The second index indexes into the third element of |
| 2054 | the structure, yielding a '<tt>%RT</tt>' = '<tt>{ sbyte, [10 x [20 x int]], |
| 2055 | sbyte }</tt>' type, another structure. The third index indexes into the second |
| 2056 | element of the structure, yielding a '<tt>[10 x [20 x int]]</tt>' type, an |
| 2057 | array. The two dimensions of the array are subscripted into, yielding an |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2058 | '<tt>int</tt>' type. The '<tt>getelementptr</tt>' instruction returns a pointer |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2059 | to this element, thus computing a value of '<tt>int*</tt>' type.</p> |
| 2060 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2061 | <p>Note that it is perfectly legal to index partially through a |
| 2062 | structure, returning a pointer to an inner element. Because of this, |
| 2063 | the LLVM code for the given testcase is equivalent to:</p> |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2064 | |
| 2065 | <pre> |
Chris Lattner | d4f6b17 | 2005-03-07 22:13:59 +0000 | [diff] [blame] | 2066 | int* %foo(%ST* %s) { |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2067 | %t1 = getelementptr %ST* %s, int 1 <i>; yields %ST*:%t1</i> |
| 2068 | %t2 = getelementptr %ST* %t1, int 0, uint 2 <i>; yields %RT*:%t2</i> |
| 2069 | %t3 = getelementptr %RT* %t2, int 0, uint 1 <i>; yields [10 x [20 x int]]*:%t3</i> |
| 2070 | %t4 = getelementptr [10 x [20 x int]]* %t3, int 0, int 5 <i>; yields [20 x int]*:%t4</i> |
| 2071 | %t5 = getelementptr [20 x int]* %t4, int 0, int 13 <i>; yields int*:%t5</i> |
| 2072 | ret int* %t5 |
| 2073 | } |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2074 | </pre> |
Chris Lattner | e67a951 | 2005-06-24 17:22:57 +0000 | [diff] [blame] | 2075 | |
| 2076 | <p>Note that it is undefined to access an array out of bounds: array and |
| 2077 | pointer indexes must always be within the defined bounds of the array type. |
| 2078 | The one exception for this rules is zero length arrays. These arrays are |
| 2079 | defined to be accessible as variable length arrays, which requires access |
| 2080 | beyond the zero'th element.</p> |
| 2081 | |
Chris Lattner | 7faa883 | 2002-04-14 06:13:44 +0000 | [diff] [blame] | 2082 | <h5>Example:</h5> |
Chris Lattner | e67a951 | 2005-06-24 17:22:57 +0000 | [diff] [blame] | 2083 | |
Chris Lattner | f74d5c7 | 2004-04-05 01:30:49 +0000 | [diff] [blame] | 2084 | <pre> |
| 2085 | <i>; yields [12 x ubyte]*:aptr</i> |
| 2086 | %aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, uint 1 |
| 2087 | </pre> |
| 2088 | |
| 2089 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2090 | <!-- ======================================================================= --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2091 | <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2092 | <div class="doc_text"> |
John Criswell | 4457dc9 | 2004-04-09 16:48:45 +0000 | [diff] [blame] | 2093 | <p>The instructions in this category are the "miscellaneous" |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2094 | instructions, which defy better classification.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2095 | </div> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2096 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2097 | <div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>' |
| 2098 | Instruction</a> </div> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2099 | <div class="doc_text"> |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2100 | <h5>Syntax:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2101 | <pre> <result> = phi <ty> [ <val0>, <label0>], ...<br></pre> |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2102 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2103 | <p>The '<tt>phi</tt>' instruction is used to implement the φ node in |
| 2104 | the SSA graph representing the function.</p> |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2105 | <h5>Arguments:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2106 | <p>The type of the incoming values are specified with the first type |
| 2107 | field. After this, the '<tt>phi</tt>' instruction takes a list of pairs |
| 2108 | as arguments, with one pair for each predecessor basic block of the |
| 2109 | current block. Only values of <a href="#t_firstclass">first class</a> |
| 2110 | type may be used as the value arguments to the PHI node. Only labels |
| 2111 | may be used as the label arguments.</p> |
| 2112 | <p>There must be no non-phi instructions between the start of a basic |
| 2113 | block and the PHI instructions: i.e. PHI instructions must be first in |
| 2114 | a basic block.</p> |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2115 | <h5>Semantics:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2116 | <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the |
| 2117 | value specified by the parameter, depending on which basic block we |
| 2118 | came from in the last <a href="#terminators">terminator</a> instruction.</p> |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2119 | <h5>Example:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2120 | <pre>Loop: ; Infinite loop that counts from 0 on up...<br> %indvar = phi uint [ 0, %LoopHeader ], [ %nextindvar, %Loop ]<br> %nextindvar = add uint %indvar, 1<br> br label %Loop<br></pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2121 | </div> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2122 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2123 | <!-- _______________________________________________________________________ --> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2124 | <div class="doc_subsubsection"> |
| 2125 | <a name="i_cast">'<tt>cast .. to</tt>' Instruction</a> |
| 2126 | </div> |
| 2127 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2128 | <div class="doc_text"> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2129 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2130 | <h5>Syntax:</h5> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2131 | |
| 2132 | <pre> |
| 2133 | <result> = cast <ty> <value> to <ty2> <i>; yields ty2</i> |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2134 | </pre> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2135 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2136 | <h5>Overview:</h5> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2137 | |
| 2138 | <p> |
| 2139 | The '<tt>cast</tt>' instruction is used as the primitive means to convert |
| 2140 | integers to floating point, change data type sizes, and break type safety (by |
| 2141 | casting pointers). |
| 2142 | </p> |
| 2143 | |
| 2144 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2145 | <h5>Arguments:</h5> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2146 | |
| 2147 | <p> |
| 2148 | The '<tt>cast</tt>' instruction takes a value to cast, which must be a first |
| 2149 | class value, and a type to cast it to, which must also be a <a |
| 2150 | href="#t_firstclass">first class</a> type. |
| 2151 | </p> |
| 2152 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2153 | <h5>Semantics:</h5> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2154 | |
| 2155 | <p> |
| 2156 | This instruction follows the C rules for explicit casts when determining how the |
| 2157 | data being cast must change to fit in its new container. |
| 2158 | </p> |
| 2159 | |
| 2160 | <p> |
| 2161 | When casting to bool, any value that would be considered true in the context of |
| 2162 | a C '<tt>if</tt>' condition is converted to the boolean '<tt>true</tt>' values, |
| 2163 | all else are '<tt>false</tt>'. |
| 2164 | </p> |
| 2165 | |
| 2166 | <p> |
| 2167 | When extending an integral value from a type of one signness to another (for |
| 2168 | example '<tt>sbyte</tt>' to '<tt>ulong</tt>'), the value is sign-extended if the |
| 2169 | <b>source</b> value is signed, and zero-extended if the source value is |
| 2170 | unsigned. <tt>bool</tt> values are always zero extended into either zero or |
| 2171 | one. |
| 2172 | </p> |
| 2173 | |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2174 | <h5>Example:</h5> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2175 | |
| 2176 | <pre> |
| 2177 | %X = cast int 257 to ubyte <i>; yields ubyte:1</i> |
Chris Lattner | 7bae395 | 2002-06-25 18:03:17 +0000 | [diff] [blame] | 2178 | %Y = cast int 123 to bool <i>; yields bool:true</i> |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2179 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2180 | </div> |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2181 | |
| 2182 | <!-- _______________________________________________________________________ --> |
| 2183 | <div class="doc_subsubsection"> |
| 2184 | <a name="i_select">'<tt>select</tt>' Instruction</a> |
| 2185 | </div> |
| 2186 | |
| 2187 | <div class="doc_text"> |
| 2188 | |
| 2189 | <h5>Syntax:</h5> |
| 2190 | |
| 2191 | <pre> |
| 2192 | <result> = select bool <cond>, <ty> <val1>, <ty> <val2> <i>; yields ty</i> |
| 2193 | </pre> |
| 2194 | |
| 2195 | <h5>Overview:</h5> |
| 2196 | |
| 2197 | <p> |
| 2198 | The '<tt>select</tt>' instruction is used to choose one value based on a |
| 2199 | condition, without branching. |
| 2200 | </p> |
| 2201 | |
| 2202 | |
| 2203 | <h5>Arguments:</h5> |
| 2204 | |
| 2205 | <p> |
| 2206 | The '<tt>select</tt>' instruction requires a boolean value indicating the condition, and two values of the same <a href="#t_firstclass">first class</a> type. |
| 2207 | </p> |
| 2208 | |
| 2209 | <h5>Semantics:</h5> |
| 2210 | |
| 2211 | <p> |
| 2212 | If the boolean condition evaluates to true, the instruction returns the first |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2213 | value argument; otherwise, it returns the second value argument. |
Chris Lattner | cc37aae | 2004-03-12 05:50:16 +0000 | [diff] [blame] | 2214 | </p> |
| 2215 | |
| 2216 | <h5>Example:</h5> |
| 2217 | |
| 2218 | <pre> |
| 2219 | %X = select bool true, ubyte 17, ubyte 42 <i>; yields ubyte:17</i> |
| 2220 | </pre> |
| 2221 | </div> |
| 2222 | |
| 2223 | |
| 2224 | |
| 2225 | |
| 2226 | |
Chris Lattner | 33ba0d9 | 2001-07-09 00:26:23 +0000 | [diff] [blame] | 2227 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2228 | <div class="doc_subsubsection"> |
| 2229 | <a name="i_call">'<tt>call</tt>' Instruction</a> |
| 2230 | </div> |
| 2231 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2232 | <div class="doc_text"> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2233 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2234 | <h5>Syntax:</h5> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2235 | <pre> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 2236 | <result> = [tail] call [<a href="#callingconv">cconv</a>] <ty>* <fnptrval>(<param list>) |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2237 | </pre> |
| 2238 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2239 | <h5>Overview:</h5> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2240 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2241 | <p>The '<tt>call</tt>' instruction represents a simple function call.</p> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2242 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2243 | <h5>Arguments:</h5> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2244 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2245 | <p>This instruction requires several arguments:</p> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2246 | |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2247 | <ol> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2248 | <li> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 2249 | <p>The optional "tail" marker indicates whether the callee function accesses |
| 2250 | any allocas or varargs in the caller. If the "tail" marker is present, the |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2251 | function call is eligible for tail call optimization. Note that calls may |
| 2252 | be marked "tail" even if they do not occur before a <a |
| 2253 | href="#i_ret"><tt>ret</tt></a> instruction. |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2254 | </li> |
| 2255 | <li> |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 2256 | <p>The optional "cconv" marker indicates which <a href="callingconv">calling |
| 2257 | convention</a> the call should use. If none is specified, the call defaults |
| 2258 | to using C calling conventions. |
| 2259 | </li> |
| 2260 | <li> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2261 | <p>'<tt>ty</tt>': shall be the signature of the pointer to function value |
| 2262 | being invoked. The argument types must match the types implied by this |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2263 | signature. This type can be omitted if the function is not varargs and |
| 2264 | if the function type does not return a pointer to a function.</p> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2265 | </li> |
| 2266 | <li> |
| 2267 | <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to |
| 2268 | be invoked. In most cases, this is a direct function invocation, but |
| 2269 | indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2270 | to function value.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2271 | </li> |
| 2272 | <li> |
| 2273 | <p>'<tt>function args</tt>': argument list whose types match the |
Reid Spencer | a7e302a | 2005-05-01 22:22:57 +0000 | [diff] [blame] | 2274 | function signature argument types. All arguments must be of |
| 2275 | <a href="#t_firstclass">first class</a> type. If the function signature |
| 2276 | indicates the function accepts a variable number of arguments, the extra |
| 2277 | arguments can be specified.</p> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2278 | </li> |
Chris Lattner | 6536cfe | 2002-05-06 22:08:29 +0000 | [diff] [blame] | 2279 | </ol> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2280 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2281 | <h5>Semantics:</h5> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2282 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2283 | <p>The '<tt>call</tt>' instruction is used to cause control flow to |
| 2284 | transfer to a specified function, with its incoming arguments bound to |
| 2285 | the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>' |
| 2286 | instruction in the called function, control flow continues with the |
| 2287 | instruction after the function call, and the return value of the |
| 2288 | function is bound to the result argument. This is a simpler case of |
| 2289 | the <a href="#i_invoke">invoke</a> instruction.</p> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2290 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 2291 | <h5>Example:</h5> |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2292 | |
| 2293 | <pre> |
| 2294 | %retval = call int %test(int %argc) |
| 2295 | call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42); |
| 2296 | %X = tail call int %foo() |
Chris Lattner | bad10ee | 2005-05-06 22:57:40 +0000 | [diff] [blame] | 2297 | %Y = tail call <a href="#callingconv">fastcc</a> int %foo() |
Chris Lattner | 2bff524 | 2005-05-06 05:47:36 +0000 | [diff] [blame] | 2298 | </pre> |
| 2299 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2300 | </div> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2301 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2302 | <!-- _______________________________________________________________________ --> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2303 | <div class="doc_subsubsection"> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2304 | <a name="i_vaarg">'<tt>vaarg</tt>' Instruction</a> |
| 2305 | </div> |
| 2306 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2307 | <div class="doc_text"> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2308 | |
Chris Lattner | 8d1a81d | 2003-10-18 05:51:36 +0000 | [diff] [blame] | 2309 | <h5>Syntax:</h5> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2310 | |
| 2311 | <pre> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2312 | <resultval> = va_arg <va_list*> <arglist>, <argty> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2313 | </pre> |
| 2314 | |
Chris Lattner | 8d1a81d | 2003-10-18 05:51:36 +0000 | [diff] [blame] | 2315 | <h5>Overview:</h5> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2316 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2317 | <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2318 | the "variable argument" area of a function call. It is used to implement the |
| 2319 | <tt>va_arg</tt> macro in C.</p> |
| 2320 | |
Chris Lattner | 8d1a81d | 2003-10-18 05:51:36 +0000 | [diff] [blame] | 2321 | <h5>Arguments:</h5> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2322 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2323 | <p>This instruction takes a <tt>va_list*</tt> value and the type of |
| 2324 | the argument. It returns a value of the specified argument type and |
| 2325 | increments the <tt>va_list</tt> to poin to the next argument. Again, the |
| 2326 | actual type of <tt>va_list</tt> is target specific.</p> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2327 | |
Chris Lattner | 8d1a81d | 2003-10-18 05:51:36 +0000 | [diff] [blame] | 2328 | <h5>Semantics:</h5> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2329 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2330 | <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified |
| 2331 | type from the specified <tt>va_list</tt> and causes the |
| 2332 | <tt>va_list</tt> to point to the next argument. For more information, |
| 2333 | see the variable argument handling <a href="#int_varargs">Intrinsic |
| 2334 | Functions</a>.</p> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2335 | |
| 2336 | <p>It is legal for this instruction to be called in a function which does not |
| 2337 | take a variable number of arguments, for example, the <tt>vfprintf</tt> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2338 | function.</p> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2339 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2340 | <p><tt>va_arg</tt> is an LLVM instruction instead of an <a |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2341 | href="#intrinsics">intrinsic function</a> because it takes a type as an |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2342 | argument.</p> |
| 2343 | |
Chris Lattner | 8d1a81d | 2003-10-18 05:51:36 +0000 | [diff] [blame] | 2344 | <h5>Example:</h5> |
Chris Lattner | e19d7a7 | 2004-09-27 21:51:25 +0000 | [diff] [blame] | 2345 | |
| 2346 | <p>See the <a href="#int_varargs">variable argument processing</a> section.</p> |
| 2347 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2348 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2349 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2350 | <!-- *********************************************************************** --> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2351 | <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div> |
| 2352 | <!-- *********************************************************************** --> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2353 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2354 | <div class="doc_text"> |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2355 | |
| 2356 | <p>LLVM supports the notion of an "intrinsic function". These functions have |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2357 | well known names and semantics and are required to follow certain |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2358 | restrictions. Overall, these instructions represent an extension mechanism for |
| 2359 | the LLVM language that does not require changing all of the transformations in |
| 2360 | LLVM to add to the language (or the bytecode reader/writer, the parser, |
| 2361 | etc...).</p> |
| 2362 | |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2363 | <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This |
| 2364 | prefix is reserved in LLVM for intrinsic names; thus, functions may not be named |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2365 | this. Intrinsic functions must always be external functions: you cannot define |
| 2366 | the body of intrinsic functions. Intrinsic functions may only be used in call |
| 2367 | or invoke instructions: it is illegal to take the address of an intrinsic |
| 2368 | function. Additionally, because intrinsic functions are part of the LLVM |
| 2369 | language, it is required that they all be documented here if any are added.</p> |
| 2370 | |
| 2371 | |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2372 | <p>To learn how to add an intrinsic function, please see the <a |
Chris Lattner | 590cff3 | 2005-05-11 03:35:57 +0000 | [diff] [blame] | 2373 | href="ExtendingLLVM.html">Extending LLVM Guide</a>. |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2374 | </p> |
| 2375 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2376 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2377 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2378 | <!-- ======================================================================= --> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2379 | <div class="doc_subsection"> |
| 2380 | <a name="int_varargs">Variable Argument Handling Intrinsics</a> |
| 2381 | </div> |
| 2382 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2383 | <div class="doc_text"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2384 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2385 | <p>Variable argument support is defined in LLVM with the <a |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2386 | href="#i_vanext"><tt>vanext</tt></a> instruction and these three |
| 2387 | intrinsic functions. These functions are related to the similarly |
| 2388 | named macros defined in the <tt><stdarg.h></tt> header file.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2389 | |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2390 | <p>All of these functions operate on arguments that use a |
| 2391 | target-specific value type "<tt>va_list</tt>". The LLVM assembly |
| 2392 | language reference manual does not define what this type is, so all |
| 2393 | transformations should be prepared to handle intrinsics with any type |
| 2394 | used.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2395 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2396 | <p>This example shows how the <a href="#i_vanext"><tt>vanext</tt></a> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2397 | instruction and the variable argument handling intrinsic functions are |
| 2398 | used.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2399 | |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2400 | <pre> |
| 2401 | int %test(int %X, ...) { |
| 2402 | ; Initialize variable argument processing |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2403 | %ap = alloca sbyte* |
| 2404 | call void %<a href="#i_va_start">llvm.va_start</a>(sbyte** %ap) |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2405 | |
| 2406 | ; Read a single integer argument |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2407 | %tmp = va_arg sbyte** %ap, int |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2408 | |
| 2409 | ; Demonstrate usage of llvm.va_copy and llvm.va_end |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2410 | %aq = alloca sbyte* |
Andrew Lenharth | d0a4c62 | 2005-06-22 20:38:11 +0000 | [diff] [blame] | 2411 | call void %<a href="#i_va_copy">llvm.va_copy</a>(sbyte** %aq, sbyte** %ap) |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2412 | call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %aq) |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2413 | |
| 2414 | ; Stop processing of arguments. |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2415 | call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %ap) |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2416 | ret int %tmp |
| 2417 | } |
| 2418 | </pre> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2419 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2420 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2421 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2422 | <div class="doc_subsubsection"> |
| 2423 | <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a> |
| 2424 | </div> |
| 2425 | |
| 2426 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2427 | <div class="doc_text"> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2428 | <h5>Syntax:</h5> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2429 | <pre> declare void %llvm.va_start(<va_list>* <arglist>)<br></pre> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2430 | <h5>Overview:</h5> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2431 | <P>The '<tt>llvm.va_start</tt>' intrinsic initializes |
| 2432 | <tt>*<arglist></tt> for subsequent use by <tt><a |
| 2433 | href="#i_va_arg">va_arg</a></tt>.</p> |
| 2434 | |
| 2435 | <h5>Arguments:</h5> |
| 2436 | |
| 2437 | <P>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p> |
| 2438 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2439 | <h5>Semantics:</h5> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2440 | |
| 2441 | <P>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt> |
| 2442 | macro available in C. In a target-dependent way, it initializes the |
| 2443 | <tt>va_list</tt> element the argument points to, so that the next call to |
| 2444 | <tt>va_arg</tt> will produce the first variable argument passed to the function. |
| 2445 | Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the |
| 2446 | last argument of the function, the compiler can figure that out.</p> |
| 2447 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2448 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2449 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2450 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2451 | <div class="doc_subsubsection"> |
| 2452 | <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a> |
| 2453 | </div> |
| 2454 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2455 | <div class="doc_text"> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2456 | <h5>Syntax:</h5> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2457 | <pre> declare void %llvm.va_end(<va_list*> <arglist>)<br></pre> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2458 | <h5>Overview:</h5> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2459 | <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt><arglist></tt> |
| 2460 | which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt> |
| 2461 | or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2462 | <h5>Arguments:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2463 | <p>The argument is a <tt>va_list</tt> to destroy.</p> |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2464 | <h5>Semantics:</h5> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2465 | <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt> |
Chris Lattner | 261efe9 | 2003-11-25 01:02:51 +0000 | [diff] [blame] | 2466 | macro available in C. In a target-dependent way, it destroys the <tt>va_list</tt>. |
| 2467 | Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a |
| 2468 | href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly |
| 2469 | with calls to <tt>llvm.va_end</tt>.</p> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2470 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2471 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2472 | <!-- _______________________________________________________________________ --> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2473 | <div class="doc_subsubsection"> |
| 2474 | <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a> |
| 2475 | </div> |
| 2476 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2477 | <div class="doc_text"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2478 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2479 | <h5>Syntax:</h5> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2480 | |
| 2481 | <pre> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2482 | declare void %llvm.va_copy(<va_list>* <destarglist>, |
Andrew Lenharth | d0a4c62 | 2005-06-22 20:38:11 +0000 | [diff] [blame] | 2483 | <va_list>* <srcarglist>) |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2484 | </pre> |
| 2485 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2486 | <h5>Overview:</h5> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2487 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2488 | <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position from |
| 2489 | the source argument list to the destination argument list.</p> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2490 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2491 | <h5>Arguments:</h5> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2492 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2493 | <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize. |
Andrew Lenharth | d0a4c62 | 2005-06-22 20:38:11 +0000 | [diff] [blame] | 2494 | The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p> |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2495 | |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2496 | |
Chris Lattner | d9ad5b3 | 2003-05-08 04:57:36 +0000 | [diff] [blame] | 2497 | <h5>Semantics:</h5> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2498 | |
Andrew Lenharth | 8bf607a | 2005-06-18 18:28:17 +0000 | [diff] [blame] | 2499 | <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt> macro |
| 2500 | available in C. In a target-dependent way, it copies the source |
| 2501 | <tt>va_list</tt> element into the destination list. This intrinsic is necessary |
| 2502 | because the <tt><a href="i_va_begin">llvm.va_begin</a></tt> intrinsic may be |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2503 | arbitrarily complex and require memory allocation, for example.</p> |
| 2504 | |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 2505 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 2506 | |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 2507 | <!-- ======================================================================= --> |
| 2508 | <div class="doc_subsection"> |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2509 | <a name="int_gc">Accurate Garbage Collection Intrinsics</a> |
| 2510 | </div> |
| 2511 | |
| 2512 | <div class="doc_text"> |
| 2513 | |
| 2514 | <p> |
| 2515 | LLVM support for <a href="GarbageCollection.html">Accurate Garbage |
| 2516 | Collection</a> requires the implementation and generation of these intrinsics. |
| 2517 | These intrinsics allow identification of <a href="#i_gcroot">GC roots on the |
| 2518 | stack</a>, as well as garbage collector implementations that require <a |
| 2519 | href="#i_gcread">read</a> and <a href="#i_gcwrite">write</a> barriers. |
| 2520 | Front-ends for type-safe garbage collected languages should generate these |
| 2521 | intrinsics to make use of the LLVM garbage collectors. For more details, see <a |
| 2522 | href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>. |
| 2523 | </p> |
| 2524 | </div> |
| 2525 | |
| 2526 | <!-- _______________________________________________________________________ --> |
| 2527 | <div class="doc_subsubsection"> |
| 2528 | <a name="i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a> |
| 2529 | </div> |
| 2530 | |
| 2531 | <div class="doc_text"> |
| 2532 | |
| 2533 | <h5>Syntax:</h5> |
| 2534 | |
| 2535 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2536 | declare void %llvm.gcroot(<ty>** %ptrloc, <ty2>* %metadata) |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2537 | </pre> |
| 2538 | |
| 2539 | <h5>Overview:</h5> |
| 2540 | |
John Criswell | 9e2485c | 2004-12-10 15:51:16 +0000 | [diff] [blame] | 2541 | <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2542 | the code generator, and allows some metadata to be associated with it.</p> |
| 2543 | |
| 2544 | <h5>Arguments:</h5> |
| 2545 | |
| 2546 | <p>The first argument specifies the address of a stack object that contains the |
| 2547 | root pointer. The second pointer (which must be either a constant or a global |
| 2548 | value address) contains the meta-data to be associated with the root.</p> |
| 2549 | |
| 2550 | <h5>Semantics:</h5> |
| 2551 | |
| 2552 | <p>At runtime, a call to this intrinsics stores a null pointer into the "ptrloc" |
| 2553 | location. At compile-time, the code generator generates information to allow |
| 2554 | the runtime to find the pointer at GC safe points. |
| 2555 | </p> |
| 2556 | |
| 2557 | </div> |
| 2558 | |
| 2559 | |
| 2560 | <!-- _______________________________________________________________________ --> |
| 2561 | <div class="doc_subsubsection"> |
| 2562 | <a name="i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a> |
| 2563 | </div> |
| 2564 | |
| 2565 | <div class="doc_text"> |
| 2566 | |
| 2567 | <h5>Syntax:</h5> |
| 2568 | |
| 2569 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2570 | declare sbyte* %llvm.gcread(sbyte** %Ptr) |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2571 | </pre> |
| 2572 | |
| 2573 | <h5>Overview:</h5> |
| 2574 | |
| 2575 | <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap |
| 2576 | locations, allowing garbage collector implementations that require read |
| 2577 | barriers.</p> |
| 2578 | |
| 2579 | <h5>Arguments:</h5> |
| 2580 | |
| 2581 | <p>The argument is the address to read from, which should be an address |
| 2582 | allocated from the garbage collector.</p> |
| 2583 | |
| 2584 | <h5>Semantics:</h5> |
| 2585 | |
| 2586 | <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load |
| 2587 | instruction, but may be replaced with substantially more complex code by the |
| 2588 | garbage collector runtime, as needed.</p> |
| 2589 | |
| 2590 | </div> |
| 2591 | |
| 2592 | |
| 2593 | <!-- _______________________________________________________________________ --> |
| 2594 | <div class="doc_subsubsection"> |
| 2595 | <a name="i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a> |
| 2596 | </div> |
| 2597 | |
| 2598 | <div class="doc_text"> |
| 2599 | |
| 2600 | <h5>Syntax:</h5> |
| 2601 | |
| 2602 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2603 | declare void %llvm.gcwrite(sbyte* %P1, sbyte** %P2) |
Chris Lattner | d792391 | 2004-05-23 21:06:01 +0000 | [diff] [blame] | 2604 | </pre> |
| 2605 | |
| 2606 | <h5>Overview:</h5> |
| 2607 | |
| 2608 | <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap |
| 2609 | locations, allowing garbage collector implementations that require write |
| 2610 | barriers (such as generational or reference counting collectors).</p> |
| 2611 | |
| 2612 | <h5>Arguments:</h5> |
| 2613 | |
| 2614 | <p>The first argument is the reference to store, and the second is the heap |
| 2615 | location to store to.</p> |
| 2616 | |
| 2617 | <h5>Semantics:</h5> |
| 2618 | |
| 2619 | <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store |
| 2620 | instruction, but may be replaced with substantially more complex code by the |
| 2621 | garbage collector runtime, as needed.</p> |
| 2622 | |
| 2623 | </div> |
| 2624 | |
| 2625 | |
| 2626 | |
| 2627 | <!-- ======================================================================= --> |
| 2628 | <div class="doc_subsection"> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2629 | <a name="int_codegen">Code Generator Intrinsics</a> |
| 2630 | </div> |
| 2631 | |
| 2632 | <div class="doc_text"> |
| 2633 | <p> |
| 2634 | These intrinsics are provided by LLVM to expose special features that may only |
| 2635 | be implemented with code generator support. |
| 2636 | </p> |
| 2637 | |
| 2638 | </div> |
| 2639 | |
| 2640 | <!-- _______________________________________________________________________ --> |
| 2641 | <div class="doc_subsubsection"> |
| 2642 | <a name="i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a> |
| 2643 | </div> |
| 2644 | |
| 2645 | <div class="doc_text"> |
| 2646 | |
| 2647 | <h5>Syntax:</h5> |
| 2648 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2649 | declare void* %llvm.returnaddress(uint <level>) |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2650 | </pre> |
| 2651 | |
| 2652 | <h5>Overview:</h5> |
| 2653 | |
| 2654 | <p> |
| 2655 | The '<tt>llvm.returnaddress</tt>' intrinsic returns a target-specific value |
| 2656 | indicating the return address of the current function or one of its callers. |
| 2657 | </p> |
| 2658 | |
| 2659 | <h5>Arguments:</h5> |
| 2660 | |
| 2661 | <p> |
| 2662 | The argument to this intrinsic indicates which function to return the address |
| 2663 | for. Zero indicates the calling function, one indicates its caller, etc. The |
| 2664 | argument is <b>required</b> to be a constant integer value. |
| 2665 | </p> |
| 2666 | |
| 2667 | <h5>Semantics:</h5> |
| 2668 | |
| 2669 | <p> |
| 2670 | The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating |
| 2671 | the return address of the specified call frame, or zero if it cannot be |
| 2672 | identified. The value returned by this intrinsic is likely to be incorrect or 0 |
| 2673 | for arguments other than zero, so it should only be used for debugging purposes. |
| 2674 | </p> |
| 2675 | |
| 2676 | <p> |
| 2677 | Note that calling this intrinsic does not prevent function inlining or other |
Chris Lattner | b40bb38 | 2005-03-07 20:30:51 +0000 | [diff] [blame] | 2678 | aggressive transformations, so the value returned may not be that of the obvious |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2679 | source-language caller. |
| 2680 | </p> |
| 2681 | </div> |
| 2682 | |
| 2683 | |
| 2684 | <!-- _______________________________________________________________________ --> |
| 2685 | <div class="doc_subsubsection"> |
| 2686 | <a name="i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a> |
| 2687 | </div> |
| 2688 | |
| 2689 | <div class="doc_text"> |
| 2690 | |
| 2691 | <h5>Syntax:</h5> |
| 2692 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2693 | declare void* %llvm.frameaddress(uint <level>) |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2694 | </pre> |
| 2695 | |
| 2696 | <h5>Overview:</h5> |
| 2697 | |
| 2698 | <p> |
| 2699 | The '<tt>llvm.frameaddress</tt>' intrinsic returns the target-specific frame |
| 2700 | pointer value for the specified stack frame. |
| 2701 | </p> |
| 2702 | |
| 2703 | <h5>Arguments:</h5> |
| 2704 | |
| 2705 | <p> |
| 2706 | The argument to this intrinsic indicates which function to return the frame |
| 2707 | pointer for. Zero indicates the calling function, one indicates its caller, |
| 2708 | etc. The argument is <b>required</b> to be a constant integer value. |
| 2709 | </p> |
| 2710 | |
| 2711 | <h5>Semantics:</h5> |
| 2712 | |
| 2713 | <p> |
| 2714 | The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating |
| 2715 | the frame address of the specified call frame, or zero if it cannot be |
| 2716 | identified. The value returned by this intrinsic is likely to be incorrect or 0 |
| 2717 | for arguments other than zero, so it should only be used for debugging purposes. |
| 2718 | </p> |
| 2719 | |
| 2720 | <p> |
| 2721 | Note that calling this intrinsic does not prevent function inlining or other |
Chris Lattner | b40bb38 | 2005-03-07 20:30:51 +0000 | [diff] [blame] | 2722 | aggressive transformations, so the value returned may not be that of the obvious |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2723 | source-language caller. |
| 2724 | </p> |
| 2725 | </div> |
| 2726 | |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 2727 | <!-- _______________________________________________________________________ --> |
| 2728 | <div class="doc_subsubsection"> |
| 2729 | <a name="i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a> |
| 2730 | </div> |
| 2731 | |
| 2732 | <div class="doc_text"> |
| 2733 | |
| 2734 | <h5>Syntax:</h5> |
| 2735 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2736 | declare void %llvm.prefetch(sbyte * <address>, |
| 2737 | uint <rw>, uint <locality>) |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 2738 | </pre> |
| 2739 | |
| 2740 | <h5>Overview:</h5> |
| 2741 | |
| 2742 | |
| 2743 | <p> |
| 2744 | The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2745 | a prefetch instruction if supported; otherwise, it is a noop. Prefetches have |
| 2746 | no |
| 2747 | effect on the behavior of the program but can change its performance |
Chris Lattner | 2a61536 | 2005-02-28 19:47:14 +0000 | [diff] [blame] | 2748 | characteristics. |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 2749 | </p> |
| 2750 | |
| 2751 | <h5>Arguments:</h5> |
| 2752 | |
| 2753 | <p> |
| 2754 | <tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier |
| 2755 | determining if the fetch should be for a read (0) or write (1), and |
| 2756 | <tt>locality</tt> is a temporal locality specifier ranging from (0) - no |
Chris Lattner | aeffb4a | 2005-03-07 20:31:38 +0000 | [diff] [blame] | 2757 | locality, to (3) - extremely local keep in cache. The <tt>rw</tt> and |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 2758 | <tt>locality</tt> arguments must be constant integers. |
| 2759 | </p> |
| 2760 | |
| 2761 | <h5>Semantics:</h5> |
| 2762 | |
| 2763 | <p> |
| 2764 | This intrinsic does not modify the behavior of the program. In particular, |
| 2765 | prefetches cannot trap and do not produce a value. On targets that support this |
| 2766 | intrinsic, the prefetch can provide hints to the processor cache for better |
| 2767 | performance. |
| 2768 | </p> |
| 2769 | |
| 2770 | </div> |
| 2771 | |
Andrew Lenharth | 7f4ec3b | 2005-03-28 20:05:49 +0000 | [diff] [blame] | 2772 | <!-- _______________________________________________________________________ --> |
| 2773 | <div class="doc_subsubsection"> |
| 2774 | <a name="i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a> |
| 2775 | </div> |
| 2776 | |
| 2777 | <div class="doc_text"> |
| 2778 | |
| 2779 | <h5>Syntax:</h5> |
| 2780 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2781 | declare void %llvm.pcmarker( uint <id> ) |
Andrew Lenharth | 7f4ec3b | 2005-03-28 20:05:49 +0000 | [diff] [blame] | 2782 | </pre> |
| 2783 | |
| 2784 | <h5>Overview:</h5> |
| 2785 | |
| 2786 | |
| 2787 | <p> |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2788 | The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter |
| 2789 | (PC) in a region of |
Andrew Lenharth | 7f4ec3b | 2005-03-28 20:05:49 +0000 | [diff] [blame] | 2790 | code to simulators and other tools. The method is target specific, but it is |
| 2791 | expected that the marker will use exported symbols to transmit the PC of the marker. |
| 2792 | The marker makes no guaranties that it will remain with any specific instruction |
| 2793 | after optimizations. It is possible that the presense of a marker will inhibit |
| 2794 | optimizations. The intended use is to be inserted after optmizations to allow |
John Criswell | fc6b895 | 2005-05-16 16:17:45 +0000 | [diff] [blame] | 2795 | correlations of simulation runs. |
Andrew Lenharth | 7f4ec3b | 2005-03-28 20:05:49 +0000 | [diff] [blame] | 2796 | </p> |
| 2797 | |
| 2798 | <h5>Arguments:</h5> |
| 2799 | |
| 2800 | <p> |
| 2801 | <tt>id</tt> is a numerical id identifying the marker. |
| 2802 | </p> |
| 2803 | |
| 2804 | <h5>Semantics:</h5> |
| 2805 | |
| 2806 | <p> |
| 2807 | This intrinsic does not modify the behavior of the program. Backends that do not |
| 2808 | support this intrinisic may ignore it. |
| 2809 | </p> |
| 2810 | |
| 2811 | </div> |
| 2812 | |
Chris Lattner | 9a9d7ac | 2005-02-28 19:24:19 +0000 | [diff] [blame] | 2813 | |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2814 | <!-- ======================================================================= --> |
| 2815 | <div class="doc_subsection"> |
| 2816 | <a name="int_os">Operating System Intrinsics</a> |
| 2817 | </div> |
| 2818 | |
| 2819 | <div class="doc_text"> |
| 2820 | <p> |
| 2821 | These intrinsics are provided by LLVM to support the implementation of |
| 2822 | operating system level code. |
| 2823 | </p> |
| 2824 | |
| 2825 | </div> |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2826 | |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2827 | <!-- _______________________________________________________________________ --> |
| 2828 | <div class="doc_subsubsection"> |
| 2829 | <a name="i_readport">'<tt>llvm.readport</tt>' Intrinsic</a> |
| 2830 | </div> |
| 2831 | |
| 2832 | <div class="doc_text"> |
| 2833 | |
| 2834 | <h5>Syntax:</h5> |
| 2835 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2836 | declare <integer type> %llvm.readport (<integer type> <address>) |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2837 | </pre> |
| 2838 | |
| 2839 | <h5>Overview:</h5> |
| 2840 | |
| 2841 | <p> |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2842 | The '<tt>llvm.readport</tt>' intrinsic reads data from the specified hardware |
| 2843 | I/O port. |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2844 | </p> |
| 2845 | |
| 2846 | <h5>Arguments:</h5> |
| 2847 | |
| 2848 | <p> |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2849 | The argument to this intrinsic indicates the hardware I/O address from which |
| 2850 | to read the data. The address is in the hardware I/O address namespace (as |
| 2851 | opposed to being a memory location for memory mapped I/O). |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2852 | </p> |
| 2853 | |
| 2854 | <h5>Semantics:</h5> |
| 2855 | |
| 2856 | <p> |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2857 | The '<tt>llvm.readport</tt>' intrinsic reads data from the hardware I/O port |
| 2858 | specified by <i>address</i> and returns the value. The address and return |
| 2859 | value must be integers, but the size is dependent upon the platform upon which |
| 2860 | the program is code generated. For example, on x86, the address must be an |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 2861 | unsigned 16-bit value, and the return value must be 8, 16, or 32 bits. |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2862 | </p> |
| 2863 | |
| 2864 | </div> |
| 2865 | |
| 2866 | <!-- _______________________________________________________________________ --> |
| 2867 | <div class="doc_subsubsection"> |
| 2868 | <a name="i_writeport">'<tt>llvm.writeport</tt>' Intrinsic</a> |
| 2869 | </div> |
| 2870 | |
| 2871 | <div class="doc_text"> |
| 2872 | |
| 2873 | <h5>Syntax:</h5> |
| 2874 | <pre> |
Chris Lattner | c3f5976 | 2004-12-09 17:30:23 +0000 | [diff] [blame] | 2875 | call void (<integer type>, <integer type>)* |
| 2876 | %llvm.writeport (<integer type> <value>, |
| 2877 | <integer type> <address>) |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2878 | </pre> |
| 2879 | |
| 2880 | <h5>Overview:</h5> |
| 2881 | |
| 2882 | <p> |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2883 | The '<tt>llvm.writeport</tt>' intrinsic writes data to the specified hardware |
| 2884 | I/O port. |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2885 | </p> |
| 2886 | |
| 2887 | <h5>Arguments:</h5> |
| 2888 | |
| 2889 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2890 | The first argument is the value to write to the I/O port. |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2891 | </p> |
| 2892 | |
| 2893 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2894 | The second argument indicates the hardware I/O address to which data should be |
| 2895 | written. The address is in the hardware I/O address namespace (as opposed to |
| 2896 | being a memory location for memory mapped I/O). |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2897 | </p> |
| 2898 | |
| 2899 | <h5>Semantics:</h5> |
| 2900 | |
| 2901 | <p> |
| 2902 | The '<tt>llvm.writeport</tt>' intrinsic writes <i>value</i> to the I/O port |
| 2903 | specified by <i>address</i>. The address and value must be integers, but the |
| 2904 | size is dependent upon the platform upon which the program is code generated. |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 2905 | For example, on x86, the address must be an unsigned 16-bit value, and the |
John Criswell | 7123e27 | 2004-04-09 16:43:20 +0000 | [diff] [blame] | 2906 | value written must be 8, 16, or 32 bits in length. |
John Criswell | cfd3bac | 2004-04-09 15:23:37 +0000 | [diff] [blame] | 2907 | </p> |
| 2908 | |
| 2909 | </div> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 2910 | |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2911 | <!-- _______________________________________________________________________ --> |
| 2912 | <div class="doc_subsubsection"> |
| 2913 | <a name="i_readio">'<tt>llvm.readio</tt>' Intrinsic</a> |
| 2914 | </div> |
| 2915 | |
| 2916 | <div class="doc_text"> |
| 2917 | |
| 2918 | <h5>Syntax:</h5> |
| 2919 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2920 | declare <result> %llvm.readio (<ty> * <pointer>) |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2921 | </pre> |
| 2922 | |
| 2923 | <h5>Overview:</h5> |
| 2924 | |
| 2925 | <p> |
| 2926 | The '<tt>llvm.readio</tt>' intrinsic reads data from a memory mapped I/O |
| 2927 | address. |
| 2928 | </p> |
| 2929 | |
| 2930 | <h5>Arguments:</h5> |
| 2931 | |
| 2932 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2933 | The argument to this intrinsic is a pointer indicating the memory address from |
| 2934 | which to read the data. The data must be a |
| 2935 | <a href="#t_firstclass">first class</a> type. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2936 | </p> |
| 2937 | |
| 2938 | <h5>Semantics:</h5> |
| 2939 | |
| 2940 | <p> |
| 2941 | The '<tt>llvm.readio</tt>' intrinsic reads data from a memory mapped I/O |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2942 | location specified by <i>pointer</i> and returns the value. The argument must |
| 2943 | be a pointer, and the return value must be a |
| 2944 | <a href="#t_firstclass">first class</a> type. However, certain architectures |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 2945 | may not support I/O on all first class types. For example, 32-bit processors |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2946 | may only support I/O on data types that are 32 bits or less. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2947 | </p> |
| 2948 | |
| 2949 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2950 | This intrinsic enforces an in-order memory model for llvm.readio and |
| 2951 | llvm.writeio calls on machines that use dynamic scheduling. Dynamically |
| 2952 | scheduled processors may execute loads and stores out of order, re-ordering at |
| 2953 | run time accesses to memory mapped I/O registers. Using these intrinsics |
| 2954 | ensures that accesses to memory mapped I/O registers occur in program order. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2955 | </p> |
| 2956 | |
| 2957 | </div> |
| 2958 | |
| 2959 | <!-- _______________________________________________________________________ --> |
| 2960 | <div class="doc_subsubsection"> |
| 2961 | <a name="i_writeio">'<tt>llvm.writeio</tt>' Intrinsic</a> |
| 2962 | </div> |
| 2963 | |
| 2964 | <div class="doc_text"> |
| 2965 | |
| 2966 | <h5>Syntax:</h5> |
| 2967 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 2968 | declare void %llvm.writeio (<ty1> <value>, <ty2> * <pointer>) |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2969 | </pre> |
| 2970 | |
| 2971 | <h5>Overview:</h5> |
| 2972 | |
| 2973 | <p> |
| 2974 | The '<tt>llvm.writeio</tt>' intrinsic writes data to the specified memory |
| 2975 | mapped I/O address. |
| 2976 | </p> |
| 2977 | |
| 2978 | <h5>Arguments:</h5> |
| 2979 | |
| 2980 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2981 | The first argument is the value to write to the memory mapped I/O location. |
| 2982 | The second argument is a pointer indicating the memory address to which the |
| 2983 | data should be written. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2984 | </p> |
| 2985 | |
| 2986 | <h5>Semantics:</h5> |
| 2987 | |
| 2988 | <p> |
| 2989 | The '<tt>llvm.writeio</tt>' intrinsic writes <i>value</i> to the memory mapped |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2990 | I/O address specified by <i>pointer</i>. The value must be a |
| 2991 | <a href="#t_firstclass">first class</a> type. However, certain architectures |
Misha Brukman | cfa87bc | 2005-04-22 18:02:52 +0000 | [diff] [blame] | 2992 | may not support I/O on all first class types. For example, 32-bit processors |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2993 | may only support I/O on data types that are 32 bits or less. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 2994 | </p> |
| 2995 | |
| 2996 | <p> |
John Criswell | 96db6fc | 2004-04-12 16:33:19 +0000 | [diff] [blame] | 2997 | This intrinsic enforces an in-order memory model for llvm.readio and |
| 2998 | llvm.writeio calls on machines that use dynamic scheduling. Dynamically |
| 2999 | scheduled processors may execute loads and stores out of order, re-ordering at |
| 3000 | run time accesses to memory mapped I/O registers. Using these intrinsics |
| 3001 | ensures that accesses to memory mapped I/O registers occur in program order. |
John Criswell | 183402a | 2004-04-12 15:02:16 +0000 | [diff] [blame] | 3002 | </p> |
| 3003 | |
| 3004 | </div> |
| 3005 | |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 3006 | <!-- ======================================================================= --> |
| 3007 | <div class="doc_subsection"> |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 3008 | <a name="int_libc">Standard C Library Intrinsics</a> |
| 3009 | </div> |
| 3010 | |
| 3011 | <div class="doc_text"> |
| 3012 | <p> |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 3013 | LLVM provides intrinsics for a few important standard C library functions. |
| 3014 | These intrinsics allow source-language front-ends to pass information about the |
| 3015 | alignment of the pointer arguments to the code generator, providing opportunity |
| 3016 | for more efficient code generation. |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 3017 | </p> |
| 3018 | |
| 3019 | </div> |
| 3020 | |
| 3021 | <!-- _______________________________________________________________________ --> |
| 3022 | <div class="doc_subsubsection"> |
| 3023 | <a name="i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a> |
| 3024 | </div> |
| 3025 | |
| 3026 | <div class="doc_text"> |
| 3027 | |
| 3028 | <h5>Syntax:</h5> |
| 3029 | <pre> |
Reid Spencer | d462235 | 2005-04-26 20:41:16 +0000 | [diff] [blame] | 3030 | declare void %llvm.memcpy(sbyte* <dest>, sbyte* <src>, |
| 3031 | uint <len>, uint <align>) |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 3032 | </pre> |
| 3033 | |
| 3034 | <h5>Overview:</h5> |
| 3035 | |
| 3036 | <p> |
| 3037 | The '<tt>llvm.memcpy</tt>' intrinsic copies a block of memory from the source |
| 3038 | location to the destination location. |
| 3039 | </p> |
| 3040 | |
| 3041 | <p> |
| 3042 | Note that, unlike the standard libc function, the <tt>llvm.memcpy</tt> intrinsic |
| 3043 | does not return a value, and takes an extra alignment argument. |
| 3044 | </p> |
| 3045 | |
| 3046 | <h5>Arguments:</h5> |
| 3047 | |
| 3048 | <p> |
| 3049 | The first argument is a pointer to the destination, the second is a pointer to |
| 3050 | the source. The third argument is an (arbitrarily sized) integer argument |
| 3051 | specifying the number of bytes to copy, and the fourth argument is the alignment |
| 3052 | of the source and destination locations. |
| 3053 | </p> |
| 3054 | |
Chris Lattner | 3301ced | 2004-02-12 21:18:15 +0000 | [diff] [blame] | 3055 | <p> |
| 3056 | If the call to this intrinisic has an alignment value that is not 0 or 1, then |
| 3057 | the caller guarantees that the size of the copy is a multiple of the alignment |
| 3058 | and that both the source and destination pointers are aligned to that boundary. |
| 3059 | </p> |
| 3060 | |
Chris Lattner | 33aec9e | 2004-02-12 17:01:32 +0000 | [diff] [blame] | 3061 | <h5>Semantics:</h5> |
| 3062 | |
| 3063 | <p> |
| 3064 | The '<tt>llvm.memcpy</tt>' intrinsic copies a block of memory from the source |
| 3065 | location to the destination location, which are not allowed to overlap. It |
| 3066 | copies "len" bytes of memory over. If the argument is known to be aligned to |
| 3067 | some boundary, this can be specified as the fourth argument, otherwise it should |
| 3068 | be set to 0 or 1. |
| 3069 | </p> |
| 3070 | </div> |
| 3071 | |
| 3072 | |
Chris Lattner | 0eb51b4 | 2004-02-12 18:10:10 +0000 | [diff] [blame] | 3073 | <!-- _______________________________________________________________________ --> |
| 3074 | <div class="doc_subsubsection"> |
| 3075 | <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a> |
| 3076 | </div> |
| 3077 | |
| 3078 | <div class="doc_text"> |
| 3079 | |
| 3080 | <h5>Syntax:</h5> |
| 3081 | <pre> |
Reid Spencer | d462235 | 2005-04-26 20:41:16 +0000 | [diff] [blame] | 3082 | declare void %llvm.memmove(sbyte* <dest>, sbyte* <src>, |
| 3083 | uint <len>, uint <align>) |
Chris Lattner | 0eb51b4 | 2004-02-12 18:10:10 +0000 | [diff] [blame] | 3084 | </pre> |
| 3085 | |
| 3086 | <h5>Overview:</h5> |
| 3087 | |
| 3088 | <p> |
| 3089 | The '<tt>llvm.memmove</tt>' intrinsic moves a block of memory from the source |
| 3090 | location to the destination location. It is similar to the '<tt>llvm.memcpy</tt>' |
| 3091 | intrinsic but allows the two memory locations to overlap. |
| 3092 | </p> |
| 3093 | |
| 3094 | <p> |
| 3095 | Note that, unlike the standard libc function, the <tt>llvm.memmove</tt> intrinsic |
| 3096 | does not return a value, and takes an extra alignment argument. |
| 3097 | </p> |
| 3098 | |
| 3099 | <h5>Arguments:</h5> |
| 3100 | |
| 3101 | <p> |
| 3102 | The first argument is a pointer to the destination, the second is a pointer to |
| 3103 | the source. The third argument is an (arbitrarily sized) integer argument |
| 3104 | specifying the number of bytes to copy, and the fourth argument is the alignment |
| 3105 | of the source and destination locations. |
| 3106 | </p> |
| 3107 | |
Chris Lattner | 3301ced | 2004-02-12 21:18:15 +0000 | [diff] [blame] | 3108 | <p> |
| 3109 | If the call to this intrinisic has an alignment value that is not 0 or 1, then |
| 3110 | the caller guarantees that the size of the copy is a multiple of the alignment |
| 3111 | and that both the source and destination pointers are aligned to that boundary. |
| 3112 | </p> |
| 3113 | |
Chris Lattner | 0eb51b4 | 2004-02-12 18:10:10 +0000 | [diff] [blame] | 3114 | <h5>Semantics:</h5> |
| 3115 | |
| 3116 | <p> |
| 3117 | The '<tt>llvm.memmove</tt>' intrinsic copies a block of memory from the source |
| 3118 | location to the destination location, which may overlap. It |
| 3119 | copies "len" bytes of memory over. If the argument is known to be aligned to |
| 3120 | some boundary, this can be specified as the fourth argument, otherwise it should |
| 3121 | be set to 0 or 1. |
| 3122 | </p> |
| 3123 | </div> |
| 3124 | |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 3125 | |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 3126 | <!-- _______________________________________________________________________ --> |
| 3127 | <div class="doc_subsubsection"> |
| 3128 | <a name="i_memset">'<tt>llvm.memset</tt>' Intrinsic</a> |
| 3129 | </div> |
| 3130 | |
| 3131 | <div class="doc_text"> |
| 3132 | |
| 3133 | <h5>Syntax:</h5> |
| 3134 | <pre> |
Reid Spencer | d462235 | 2005-04-26 20:41:16 +0000 | [diff] [blame] | 3135 | declare void %llvm.memset(sbyte* <dest>, ubyte <val>, |
| 3136 | uint <len>, uint <align>) |
Chris Lattner | 1061064 | 2004-02-14 04:08:35 +0000 | [diff] [blame] | 3137 | </pre> |
| 3138 | |
| 3139 | <h5>Overview:</h5> |
| 3140 | |
| 3141 | <p> |
| 3142 | The '<tt>llvm.memset</tt>' intrinsic fills a block of memory with a particular |
| 3143 | byte value. |
| 3144 | </p> |
| 3145 | |
| 3146 | <p> |
| 3147 | Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic |
| 3148 | does not return a value, and takes an extra alignment argument. |
| 3149 | </p> |
| 3150 | |
| 3151 | <h5>Arguments:</h5> |
| 3152 | |
| 3153 | <p> |
| 3154 | The first argument is a pointer to the destination to fill, the second is the |
| 3155 | byte value to fill it with, the third argument is an (arbitrarily sized) integer |
| 3156 | argument specifying the number of bytes to fill, and the fourth argument is the |
| 3157 | known alignment of destination location. |
| 3158 | </p> |
| 3159 | |
| 3160 | <p> |
| 3161 | If the call to this intrinisic has an alignment value that is not 0 or 1, then |
| 3162 | the caller guarantees that the size of the copy is a multiple of the alignment |
| 3163 | and that the destination pointer is aligned to that boundary. |
| 3164 | </p> |
| 3165 | |
| 3166 | <h5>Semantics:</h5> |
| 3167 | |
| 3168 | <p> |
| 3169 | The '<tt>llvm.memset</tt>' intrinsic fills "len" bytes of memory starting at the |
| 3170 | destination location. If the argument is known to be aligned to some boundary, |
| 3171 | this can be specified as the fourth argument, otherwise it should be set to 0 or |
| 3172 | 1. |
| 3173 | </p> |
| 3174 | </div> |
| 3175 | |
| 3176 | |
Chris Lattner | 3200628 | 2004-06-11 02:28:03 +0000 | [diff] [blame] | 3177 | <!-- _______________________________________________________________________ --> |
| 3178 | <div class="doc_subsubsection"> |
Alkis Evlogimenos | 26bbe93 | 2004-06-13 01:16:15 +0000 | [diff] [blame] | 3179 | <a name="i_isunordered">'<tt>llvm.isunordered</tt>' Intrinsic</a> |
| 3180 | </div> |
| 3181 | |
| 3182 | <div class="doc_text"> |
| 3183 | |
| 3184 | <h5>Syntax:</h5> |
| 3185 | <pre> |
Reid Spencer | a8d451e | 2005-04-26 20:50:44 +0000 | [diff] [blame] | 3186 | declare bool %llvm.isunordered(<float or double> Val1, <float or double> Val2) |
Alkis Evlogimenos | 26bbe93 | 2004-06-13 01:16:15 +0000 | [diff] [blame] | 3187 | </pre> |
| 3188 | |
| 3189 | <h5>Overview:</h5> |
| 3190 | |
| 3191 | <p> |
| 3192 | The '<tt>llvm.isunordered</tt>' intrinsic returns true if either or both of the |
| 3193 | specified floating point values is a NAN. |
| 3194 | </p> |
| 3195 | |
| 3196 | <h5>Arguments:</h5> |
| 3197 | |
| 3198 | <p> |
| 3199 | The arguments are floating point numbers of the same type. |
| 3200 | </p> |
| 3201 | |
| 3202 | <h5>Semantics:</h5> |
| 3203 | |
| 3204 | <p> |
| 3205 | If either or both of the arguments is a SNAN or QNAN, it returns true, otherwise |
| 3206 | false. |
| 3207 | </p> |
| 3208 | </div> |
| 3209 | |
| 3210 | |
Chris Lattner | a4d7414 | 2005-07-21 01:29:16 +0000 | [diff] [blame] | 3211 | <!-- _______________________________________________________________________ --> |
| 3212 | <div class="doc_subsubsection"> |
| 3213 | <a name="i_sqrt">'<tt>llvm.sqrt</tt>' Intrinsic</a> |
| 3214 | </div> |
| 3215 | |
| 3216 | <div class="doc_text"> |
| 3217 | |
| 3218 | <h5>Syntax:</h5> |
| 3219 | <pre> |
| 3220 | declare <float or double> %llvm.sqrt(<float or double> Val) |
| 3221 | </pre> |
| 3222 | |
| 3223 | <h5>Overview:</h5> |
| 3224 | |
| 3225 | <p> |
| 3226 | The '<tt>llvm.sqrt</tt>' intrinsic returns the sqrt of the specified operand, |
| 3227 | returning the same value as the libm '<tt>sqrt</tt>' function would. Unlike |
| 3228 | <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for |
| 3229 | negative numbers (which allows for better optimization). |
| 3230 | </p> |
| 3231 | |
| 3232 | <h5>Arguments:</h5> |
| 3233 | |
| 3234 | <p> |
| 3235 | The argument and return value are floating point numbers of the same type. |
| 3236 | </p> |
| 3237 | |
| 3238 | <h5>Semantics:</h5> |
| 3239 | |
| 3240 | <p> |
| 3241 | This function returns the sqrt of the specified operand if it is a positive |
| 3242 | floating point number. |
| 3243 | </p> |
| 3244 | </div> |
| 3245 | |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3246 | <!-- ======================================================================= --> |
| 3247 | <div class="doc_subsection"> |
| 3248 | <a name="int_count">Bit Counting Intrinsics</a> |
| 3249 | </div> |
| 3250 | |
| 3251 | <div class="doc_text"> |
| 3252 | <p> |
| 3253 | LLVM provides intrinsics for a few important bit counting operations. |
| 3254 | These allow efficient code generation for some algorithms. |
| 3255 | </p> |
| 3256 | |
| 3257 | </div> |
| 3258 | |
| 3259 | <!-- _______________________________________________________________________ --> |
| 3260 | <div class="doc_subsubsection"> |
| 3261 | <a name="int_ctpop">'<tt>llvm.ctpop</tt>' Intrinsic</a> |
| 3262 | </div> |
| 3263 | |
| 3264 | <div class="doc_text"> |
| 3265 | |
| 3266 | <h5>Syntax:</h5> |
| 3267 | <pre> |
| 3268 | declare int %llvm.ctpop(int <src>) |
| 3269 | |
| 3270 | </pre> |
| 3271 | |
| 3272 | <h5>Overview:</h5> |
| 3273 | |
| 3274 | <p> |
| 3275 | The '<tt>llvm.ctpop</tt>' intrinsic counts the number of ones in a variable. |
| 3276 | </p> |
| 3277 | |
| 3278 | <h5>Arguments:</h5> |
| 3279 | |
| 3280 | <p> |
Chris Lattner | cfe6b37 | 2005-05-07 01:46:40 +0000 | [diff] [blame] | 3281 | The only argument is the value to be counted. The argument may be of any |
| 3282 | integer type. The return type must match the argument type. |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3283 | </p> |
| 3284 | |
| 3285 | <h5>Semantics:</h5> |
| 3286 | |
| 3287 | <p> |
| 3288 | The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable. |
| 3289 | </p> |
| 3290 | </div> |
| 3291 | |
| 3292 | <!-- _______________________________________________________________________ --> |
| 3293 | <div class="doc_subsubsection"> |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3294 | <a name="int_ctlz">'<tt>llvm.ctlz</tt>' Intrinsic</a> |
| 3295 | </div> |
| 3296 | |
| 3297 | <div class="doc_text"> |
| 3298 | |
| 3299 | <h5>Syntax:</h5> |
| 3300 | <pre> |
| 3301 | declare int %llvm.ctlz(int <src>) |
| 3302 | |
| 3303 | </pre> |
| 3304 | |
| 3305 | <h5>Overview:</h5> |
| 3306 | |
| 3307 | <p> |
Chris Lattner | cfe6b37 | 2005-05-07 01:46:40 +0000 | [diff] [blame] | 3308 | The '<tt>llvm.ctlz</tt>' intrinsic counts the number of leading zeros in a |
| 3309 | variable. |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3310 | </p> |
| 3311 | |
| 3312 | <h5>Arguments:</h5> |
| 3313 | |
| 3314 | <p> |
Chris Lattner | cfe6b37 | 2005-05-07 01:46:40 +0000 | [diff] [blame] | 3315 | The only argument is the value to be counted. The argument may be of any |
| 3316 | integer type. The return type must match the argument type. |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3317 | </p> |
| 3318 | |
| 3319 | <h5>Semantics:</h5> |
| 3320 | |
| 3321 | <p> |
Chris Lattner | eff29ab | 2005-05-15 19:39:26 +0000 | [diff] [blame] | 3322 | The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros |
| 3323 | in a variable. If the src == 0 then the result is the size in bits of the type |
| 3324 | of src. For example, <tt>llvm.cttz(int 2) = 30</tt>. |
Andrew Lenharth | ec370fd | 2005-05-03 18:01:48 +0000 | [diff] [blame] | 3325 | </p> |
| 3326 | </div> |
Chris Lattner | 3200628 | 2004-06-11 02:28:03 +0000 | [diff] [blame] | 3327 | |
| 3328 | |
Chris Lattner | eff29ab | 2005-05-15 19:39:26 +0000 | [diff] [blame] | 3329 | |
| 3330 | <!-- _______________________________________________________________________ --> |
| 3331 | <div class="doc_subsubsection"> |
| 3332 | <a name="int_cttz">'<tt>llvm.cttz</tt>' Intrinsic</a> |
| 3333 | </div> |
| 3334 | |
| 3335 | <div class="doc_text"> |
| 3336 | |
| 3337 | <h5>Syntax:</h5> |
| 3338 | <pre> |
| 3339 | declare int %llvm.cttz(int <src>) |
| 3340 | |
| 3341 | </pre> |
| 3342 | |
| 3343 | <h5>Overview:</h5> |
| 3344 | |
| 3345 | <p> |
| 3346 | The '<tt>llvm.cttz</tt>' intrinsic counts the number of trailing zeros. |
| 3347 | </p> |
| 3348 | |
| 3349 | <h5>Arguments:</h5> |
| 3350 | |
| 3351 | <p> |
| 3352 | The only argument is the value to be counted. The argument may be of any |
| 3353 | integer type. The return type must match the argument type. |
| 3354 | </p> |
| 3355 | |
| 3356 | <h5>Semantics:</h5> |
| 3357 | |
| 3358 | <p> |
| 3359 | The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros |
| 3360 | in a variable. If the src == 0 then the result is the size in bits of the type |
| 3361 | of src. For example, <tt>llvm.cttz(2) = 1</tt>. |
| 3362 | </p> |
| 3363 | </div> |
| 3364 | |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 3365 | <!-- ======================================================================= --> |
| 3366 | <div class="doc_subsection"> |
| 3367 | <a name="int_debugger">Debugger Intrinsics</a> |
| 3368 | </div> |
| 3369 | |
| 3370 | <div class="doc_text"> |
| 3371 | <p> |
| 3372 | The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix), |
| 3373 | are described in the <a |
| 3374 | href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level |
| 3375 | Debugging</a> document. |
| 3376 | </p> |
| 3377 | </div> |
| 3378 | |
| 3379 | |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 3380 | <!-- *********************************************************************** --> |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 3381 | <hr> |
Misha Brukman | daa4cb0 | 2004-03-01 17:47:27 +0000 | [diff] [blame] | 3382 | <address> |
| 3383 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
| 3384 | src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a> |
| 3385 | <a href="http://validator.w3.org/check/referer"><img |
| 3386 | src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a> |
| 3387 | |
| 3388 | <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> |
| 3389 | <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br> |
| 3390 | Last modified: $Date$ |
| 3391 | </address> |
Misha Brukman | 9d0919f | 2003-11-08 01:05:38 +0000 | [diff] [blame] | 3392 | </body> |
| 3393 | </html> |