Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 93a498566a5ed50d1513511e2f827c0866676e65 / . / docs / LangRef.html
blob: 64725a700fe6c6600697de7d2f08c2994fd54fbf [file] [log] [blame]
Misha Brukmandaa4cb02004-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 Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3<html>
4<head>
5 <title>LLVM Assembly Language Reference Manual</title>
Reid Spencer3921c742004-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 Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]10 <link rel="stylesheet" href="llvm.css" type="text/css">
11</head>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]12
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]13<body>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]14
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]15<div class="doc_title"> LLVM Language Reference Manual </div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]16<ol>
Misha Brukman9d0919f2003-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 Lattnerfa730212004-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 Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]23 <li><a href="#linkage">Linkage Types</a></li>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]24 <li><a href="#callingconv">Calling Conventions</a></li>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]25 <li><a href="#globalvars">Global Variables</a></li>
Chris Lattner4e9aba72006-01-23 23:23:47 +0000[diff] [blame]26 <li><a href="#functionstructure">Functions</a></li>
27 <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]28 </ol>
29 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]30 <li><a href="#typesystem">Type System</a>
31 <ol>
Robert Bocchino7b81c752006-02-17 21:18:08 +0000[diff] [blame]32 <li><a href="#t_primitive">Primitive Types</a>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]33 <ol>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]34 <li><a href="#t_classifications">Type Classifications</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]35 </ol>
36 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]37 <li><a href="#t_derived">Derived Types</a>
38 <ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]39 <li><a href="#t_array">Array Type</a></li>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]40 <li><a href="#t_function">Function Type</a></li>
41 <li><a href="#t_pointer">Pointer Type</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]42 <li><a href="#t_struct">Structure Type</a></li>
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]43 <li><a href="#t_packed">Packed Type</a></li>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]44 <li><a href="#t_opaque">Opaque Type</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]45 </ol>
46 </li>
47 </ol>
48 </li>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]49 <li><a href="#constants">Constants</a>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]50 <ol>
51 <li><a href="#simpleconstants">Simple Constants</a>
52 <li><a href="#aggregateconstants">Aggregate Constants</a>
53 <li><a href="#globalconstants">Global Variable and Function Addresses</a>
54 <li><a href="#undefvalues">Undefined Values</a>
55 <li><a href="#constantexprs">Constant Expressions</a>
56 </ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]57 </li>
Chris Lattnere87d6532006-01-25 23:47:57 +0000[diff] [blame]58 <li><a href="#othervalues">Other Values</a>
59 <ol>
60 <li><a href="#inlineasm">Inline Assembler Expressions</a>
61 </ol>
62 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]63 <li><a href="#instref">Instruction Reference</a>
64 <ol>
65 <li><a href="#terminators">Terminator Instructions</a>
66 <ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]67 <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
68 <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]69 <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
70 <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]71 <li><a href="#i_unwind">'<tt>unwind</tt>' Instruction</a></li>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]72 <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]73 </ol>
74 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]75 <li><a href="#binaryops">Binary Operations</a>
76 <ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]77 <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
78 <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
79 <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]80 <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
81 <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
82 <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]83 <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
84 <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
85 <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]86 </ol>
87 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]88 <li><a href="#bitwiseops">Bitwise Binary Operations</a>
89 <ol>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]90 <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]91 <li><a href="#i_or">'<tt>or</tt>' Instruction</a></li>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]92 <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
93 <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]94 <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
95 <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]96 </ol>
97 </li>
Chris Lattner3df241e2006-04-08 23:07:04 +0000[diff] [blame]98 <li><a href="#vectorops">Vector Operations</a>
99 <ol>
100 <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
101 <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
102 <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
Chris Lattner3df241e2006-04-08 23:07:04 +0000[diff] [blame]103 </ol>
104 </li>
Chris Lattner884a9702006-08-15 00:45:58 +0000[diff] [blame]105 <li><a href="#memoryops">Memory Access and Addressing Operations</a>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]106 <ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]107 <li><a href="#i_malloc">'<tt>malloc</tt>' Instruction</a></li>
108 <li><a href="#i_free">'<tt>free</tt>' Instruction</a></li>
109 <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
Robert Bocchino7b81c752006-02-17 21:18:08 +0000[diff] [blame]110 <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
111 <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
112 <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]113 </ol>
114 </li>
Reid Spencer2fd21e62006-11-08 01:18:52 +0000[diff] [blame]115 <li><a href="#convertops">Conversion Operations</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]116 <ol>
117 <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
118 <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
119 <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
120 <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
121 <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]122 <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
123 <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
124 <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
125 <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
Reid Spencer72679252006-11-11 21:00:47 +0000[diff] [blame]126 <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
127 <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]128 <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]129 </ol>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]130 <li><a href="#otherops">Other Operations</a>
131 <ol>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]132 <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
133 <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]134 <li><a href="#i_phi">'<tt>phi</tt>' Instruction</a></li>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]135 <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]136 <li><a href="#i_call">'<tt>call</tt>' Instruction</a></li>
Chris Lattnerfb6977d2006-01-13 23:26:01 +0000[diff] [blame]137 <li><a href="#i_va_arg">'<tt>va_arg</tt>' Instruction</a></li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]138 </ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]139 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]140 </ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]141 </li>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]142 <li><a href="#intrinsics">Intrinsic Functions</a>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]143 <ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]144 <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
145 <ol>
146 <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
147 <li><a href="#i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a></li>
148 <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a></li>
149 </ol>
150 </li>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]151 <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
152 <ol>
153 <li><a href="#i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
154 <li><a href="#i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
155 <li><a href="#i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
156 </ol>
157 </li>
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]158 <li><a href="#int_codegen">Code Generator Intrinsics</a>
159 <ol>
160 <li><a href="#i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
161 <li><a href="#i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a></li>
Chris Lattner57e1f392006-01-13 02:03:13 +0000[diff] [blame]162 <li><a href="#i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
163 <li><a href="#i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]164 <li><a href="#i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
Andrew Lenharth7f4ec3b2005-03-28 20:05:49 +0000[diff] [blame]165 <li><a href="#i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
Andrew Lenharth51b8d542005-11-11 16:47:30 +0000[diff] [blame]166 <li><a href="#i_readcyclecounter"><tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
John Criswell7123e272004-04-09 16:43:20 +0000[diff] [blame]167 </ol>
168 </li>
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]169 <li><a href="#int_libc">Standard C Library Intrinsics</a>
170 <ol>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]171 <li><a href="#i_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
172 <li><a href="#i_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
173 <li><a href="#i_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]174 <li><a href="#i_isunordered">'<tt>llvm.isunordered.*</tt>' Intrinsic</a></li>
175 <li><a href="#i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
Chris Lattnerf4d252d2006-09-08 06:34:02 +0000[diff] [blame]176 <li><a href="#i_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]177 </ol>
178 </li>
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]179 <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]180 <ol>
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]181 <li><a href="#i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
Chris Lattner8a886be2006-01-16 22:34:14 +0000[diff] [blame]182 <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
183 <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
184 <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]185 </ol>
186 </li>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]187 <li><a href="#int_debugger">Debugger intrinsics</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]188 </ol>
189 </li>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]190</ol>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]191
192<div class="doc_author">
193 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
194 and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]195</div>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]196
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]197<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]198<div class="doc_section"> <a name="abstract">Abstract </a></div>
199<!-- *********************************************************************** -->
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]200
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]201<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]202<p>This document is a reference manual for the LLVM assembly language.
203LLVM is an SSA based representation that provides type safety,
204low-level operations, flexibility, and the capability of representing
205'all' high-level languages cleanly. It is the common code
206representation used throughout all phases of the LLVM compilation
207strategy.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]208</div>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]209
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]210<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]211<div class="doc_section"> <a name="introduction">Introduction</a> </div>
212<!-- *********************************************************************** -->
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]213
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]214<div class="doc_text">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]215
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]216<p>The LLVM code representation is designed to be used in three
217different forms: as an in-memory compiler IR, as an on-disk bytecode
218representation (suitable for fast loading by a Just-In-Time compiler),
219and as a human readable assembly language representation. This allows
220LLVM to provide a powerful intermediate representation for efficient
221compiler transformations and analysis, while providing a natural means
222to debug and visualize the transformations. The three different forms
223of LLVM are all equivalent. This document describes the human readable
224representation and notation.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]225
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]226<p>The LLVM representation aims to be light-weight and low-level
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]227while being expressive, typed, and extensible at the same time. It
228aims to be a "universal IR" of sorts, by being at a low enough level
229that high-level ideas may be cleanly mapped to it (similar to how
230microprocessors are "universal IR's", allowing many source languages to
231be mapped to them). By providing type information, LLVM can be used as
232the target of optimizations: for example, through pointer analysis, it
233can be proven that a C automatic variable is never accessed outside of
234the current function... allowing it to be promoted to a simple SSA
235value instead of a memory location.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]236
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]237</div>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]238
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]239<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]240<div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]241
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]242<div class="doc_text">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]243
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]244<p>It is important to note that this document describes 'well formed'
245LLVM assembly language. There is a difference between what the parser
246accepts and what is considered 'well formed'. For example, the
247following instruction is syntactically okay, but not well formed:</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]248
249<pre>
250 %x = <a href="#i_add">add</a> int 1, %x
251</pre>
252
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]253<p>...because the definition of <tt>%x</tt> does not dominate all of
254its uses. The LLVM infrastructure provides a verification pass that may
255be used to verify that an LLVM module is well formed. This pass is
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]256automatically run by the parser after parsing input assembly and by
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]257the optimizer before it outputs bytecode. The violations pointed out
258by the verifier pass indicate bugs in transformation passes or input to
259the parser.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]260
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]261<!-- Describe the typesetting conventions here. --> </div>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]262
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]263<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]264<div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]265<!-- *********************************************************************** -->
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]266
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]267<div class="doc_text">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]268
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]269<p>LLVM uses three different forms of identifiers, for different
270purposes:</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]271
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]272<ol>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]273 <li>Named values are represented as a string of characters with a '%' prefix.
274 For example, %foo, %DivisionByZero, %a.really.long.identifier. The actual
275 regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
276 Identifiers which require other characters in their names can be surrounded
277 with quotes. In this way, anything except a <tt>"</tt> character can be used
278 in a name.</li>
279
280 <li>Unnamed values are represented as an unsigned numeric value with a '%'
281 prefix. For example, %12, %2, %44.</li>
282
Reid Spencercc16dc32004-12-09 18:02:53 +0000[diff] [blame]283 <li>Constants, which are described in a <a href="#constants">section about
284 constants</a>, below.</li>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]285</ol>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]286
287<p>LLVM requires that values start with a '%' sign for two reasons: Compilers
288don't need to worry about name clashes with reserved words, and the set of
289reserved words may be expanded in the future without penalty. Additionally,
290unnamed identifiers allow a compiler to quickly come up with a temporary
291variable without having to avoid symbol table conflicts.</p>
292
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]293<p>Reserved words in LLVM are very similar to reserved words in other
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]294languages. There are keywords for different opcodes
295('<tt><a href="#i_add">add</a></tt>',
296 '<tt><a href="#i_bitcast">bitcast</a></tt>',
297 '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]298href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>', etc...),
299and others. These reserved words cannot conflict with variable names, because
300none of them start with a '%' character.</p>
301
302<p>Here is an example of LLVM code to multiply the integer variable
303'<tt>%X</tt>' by 8:</p>
304
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]305<p>The easy way:</p>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]306
307<pre>
308 %result = <a href="#i_mul">mul</a> uint %X, 8
309</pre>
310
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]311<p>After strength reduction:</p>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]312
313<pre>
314 %result = <a href="#i_shl">shl</a> uint %X, ubyte 3
315</pre>
316
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]317<p>And the hard way:</p>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]318
319<pre>
320 <a href="#i_add">add</a> uint %X, %X <i>; yields {uint}:%0</i>
321 <a href="#i_add">add</a> uint %0, %0 <i>; yields {uint}:%1</i>
322 %result = <a href="#i_add">add</a> uint %1, %1
323</pre>
324
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]325<p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
326important lexical features of LLVM:</p>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]327
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]328<ol>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]329
330 <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
331 line.</li>
332
333 <li>Unnamed temporaries are created when the result of a computation is not
334 assigned to a named value.</li>
335
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]336 <li>Unnamed temporaries are numbered sequentially</li>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]337
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]338</ol>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]339
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]340<p>...and it also shows a convention that we follow in this document. When
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]341demonstrating instructions, we will follow an instruction with a comment that
342defines the type and name of value produced. Comments are shown in italic
343text.</p>
344
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]345</div>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]346
347<!-- *********************************************************************** -->
348<div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
349<!-- *********************************************************************** -->
350
351<!-- ======================================================================= -->
352<div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
353</div>
354
355<div class="doc_text">
356
357<p>LLVM programs are composed of "Module"s, each of which is a
358translation unit of the input programs. Each module consists of
359functions, global variables, and symbol table entries. Modules may be
360combined together with the LLVM linker, which merges function (and
361global variable) definitions, resolves forward declarations, and merges
362symbol table entries. Here is an example of the "hello world" module:</p>
363
364<pre><i>; Declare the string constant as a global constant...</i>
365<a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a
366 href="#globalvars">constant</a> <a href="#t_array">[13 x sbyte]</a> c"hello world\0A\00" <i>; [13 x sbyte]*</i>
367
368<i>; External declaration of the puts function</i>
369<a href="#functionstructure">declare</a> int %puts(sbyte*) <i>; int(sbyte*)* </i>
370
Chris Lattner81c01f02006-06-13 03:05:47 +0000[diff] [blame]371<i>; Global variable / Function body section separator</i>
372implementation
373
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]374<i>; Definition of main function</i>
375int %main() { <i>; int()* </i>
376 <i>; Convert [13x sbyte]* to sbyte *...</i>
377 %cast210 = <a
378 href="#i_getelementptr">getelementptr</a> [13 x sbyte]* %.LC0, long 0, long 0 <i>; sbyte*</i>
379
380 <i>; Call puts function to write out the string to stdout...</i>
381 <a
382 href="#i_call">call</a> int %puts(sbyte* %cast210) <i>; int</i>
383 <a
384 href="#i_ret">ret</a> int 0<br>}<br></pre>
385
386<p>This example is made up of a <a href="#globalvars">global variable</a>
387named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
388function, and a <a href="#functionstructure">function definition</a>
389for "<tt>main</tt>".</p>
390
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]391<p>In general, a module is made up of a list of global values,
392where both functions and global variables are global values. Global values are
393represented by a pointer to a memory location (in this case, a pointer to an
394array of char, and a pointer to a function), and have one of the following <a
395href="#linkage">linkage types</a>.</p>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]396
Chris Lattner81c01f02006-06-13 03:05:47 +0000[diff] [blame]397<p>Due to a limitation in the current LLVM assembly parser (it is limited by
398one-token lookahead), modules are split into two pieces by the "implementation"
399keyword. Global variable prototypes and definitions must occur before the
400keyword, and function definitions must occur after it. Function prototypes may
401occur either before or after it. In the future, the implementation keyword may
402become a noop, if the parser gets smarter.</p>
403
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]404</div>
405
406<!-- ======================================================================= -->
407<div class="doc_subsection">
408 <a name="linkage">Linkage Types</a>
409</div>
410
411<div class="doc_text">
412
413<p>
414All Global Variables and Functions have one of the following types of linkage:
415</p>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]416
417<dl>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]418
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]419 <dt><tt><b><a name="linkage_internal">internal</a></b></tt> </dt>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]420
421 <dd>Global values with internal linkage are only directly accessible by
422 objects in the current module. In particular, linking code into a module with
423 an internal global value may cause the internal to be renamed as necessary to
424 avoid collisions. Because the symbol is internal to the module, all
425 references can be updated. This corresponds to the notion of the
426 '<tt>static</tt>' keyword in C, or the idea of "anonymous namespaces" in C++.
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]427 </dd>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]428
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]429 <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]430
431 <dd>"<tt>linkonce</tt>" linkage is similar to <tt>internal</tt> linkage, with
432 the twist that linking together two modules defining the same
433 <tt>linkonce</tt> globals will cause one of the globals to be discarded. This
434 is typically used to implement inline functions. Unreferenced
435 <tt>linkonce</tt> globals are allowed to be discarded.
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]436 </dd>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]437
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]438 <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]439
440 <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt> linkage,
441 except that unreferenced <tt>weak</tt> globals may not be discarded. This is
442 used to implement constructs in C such as "<tt>int X;</tt>" at global scope.
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]443 </dd>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]444
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]445 <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]446
447 <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
448 pointer to array type. When two global variables with appending linkage are
449 linked together, the two global arrays are appended together. This is the
450 LLVM, typesafe, equivalent of having the system linker append together
451 "sections" with identical names when .o files are linked.
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]452 </dd>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]453
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]454 <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]455
456 <dd>If none of the above identifiers are used, the global is externally
457 visible, meaning that it participates in linkage and can be used to resolve
458 external symbol references.
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]459 </dd>
Anton Korobeynikovb74ed072006-09-14 18:23:27 +0000[diff] [blame]460
461 <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt>: </dt>
462
463 <dd>"<tt>extern_weak</tt>" TBD
464 </dd>
465
466 <p>
467 The next two types of linkage are targeted for Microsoft Windows platform
468 only. They are designed to support importing (exporting) symbols from (to)
469 DLLs.
470 </p>
471
472 <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt>: </dt>
473
474 <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
475 or variable via a global pointer to a pointer that is set up by the DLL
476 exporting the symbol. On Microsoft Windows targets, the pointer name is
477 formed by combining <code>_imp__</code> and the function or variable name.
478 </dd>
479
480 <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt>: </dt>
481
482 <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
483 pointer to a pointer in a DLL, so that it can be referenced with the
484 <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
485 name is formed by combining <code>_imp__</code> and the function or variable
486 name.
487 </dd>
488
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]489</dl>
490
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]491<p><a name="linkage_external">For example, since the "<tt>.LC0</tt>"
492variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
493variable and was linked with this one, one of the two would be renamed,
494preventing a collision. Since "<tt>main</tt>" and "<tt>puts</tt>" are
495external (i.e., lacking any linkage declarations), they are accessible
496outside of the current module. It is illegal for a function <i>declaration</i>
497to have any linkage type other than "externally visible".</a></p>
Chris Lattnere5d947b2004-12-09 16:36:40 +0000[diff] [blame]498
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]499</div>
500
501<!-- ======================================================================= -->
502<div class="doc_subsection">
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]503 <a name="callingconv">Calling Conventions</a>
504</div>
505
506<div class="doc_text">
507
508<p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
509and <a href="#i_invoke">invokes</a> can all have an optional calling convention
510specified for the call. The calling convention of any pair of dynamic
511caller/callee must match, or the behavior of the program is undefined. The
512following calling conventions are supported by LLVM, and more may be added in
513the future:</p>
514
515<dl>
516 <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
517
518 <dd>This calling convention (the default if no other calling convention is
519 specified) matches the target C calling conventions. This calling convention
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]520 supports varargs function calls and tolerates some mismatch in the declared
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]521 prototype and implemented declaration of the function (as does normal C).
522 </dd>
523
Chris Lattner5710ce92006-05-19 21:15:36 +0000[diff] [blame]524 <dt><b>"<tt>csretcc</tt>" - The C struct return calling convention</b>:</dt>
525
526 <dd>This calling convention matches the target C calling conventions, except
527 that functions with this convention are required to take a pointer as their
528 first argument, and the return type of the function must be void. This is
529 used for C functions that return aggregates by-value. In this case, the
530 function has been transformed to take a pointer to the struct as the first
531 argument to the function. For targets where the ABI specifies specific
532 behavior for structure-return calls, the calling convention can be used to
533 distinguish between struct return functions and other functions that take a
534 pointer to a struct as the first argument.
535 </dd>
536
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]537 <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
538
539 <dd>This calling convention attempts to make calls as fast as possible
540 (e.g. by passing things in registers). This calling convention allows the
541 target to use whatever tricks it wants to produce fast code for the target,
Chris Lattner8cdc5bc2005-05-06 23:08:23 +0000[diff] [blame]542 without having to conform to an externally specified ABI. Implementations of
543 this convention should allow arbitrary tail call optimization to be supported.
544 This calling convention does not support varargs and requires the prototype of
545 all callees to exactly match the prototype of the function definition.
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]546 </dd>
547
548 <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
549
550 <dd>This calling convention attempts to make code in the caller as efficient
551 as possible under the assumption that the call is not commonly executed. As
552 such, these calls often preserve all registers so that the call does not break
553 any live ranges in the caller side. This calling convention does not support
554 varargs and requires the prototype of all callees to exactly match the
555 prototype of the function definition.
556 </dd>
557
Chris Lattnercfe6b372005-05-07 01:46:40 +0000[diff] [blame]558 <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]559
560 <dd>Any calling convention may be specified by number, allowing
561 target-specific calling conventions to be used. Target specific calling
562 conventions start at 64.
563 </dd>
Chris Lattnercfe6b372005-05-07 01:46:40 +0000[diff] [blame]564</dl>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]565
566<p>More calling conventions can be added/defined on an as-needed basis, to
567support pascal conventions or any other well-known target-independent
568convention.</p>
569
570</div>
571
572<!-- ======================================================================= -->
573<div class="doc_subsection">
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]574 <a name="globalvars">Global Variables</a>
575</div>
576
577<div class="doc_text">
578
Chris Lattner3689a342005-02-12 19:30:21 +0000[diff] [blame]579<p>Global variables define regions of memory allocated at compilation time
Chris Lattner88f6c462005-11-12 00:45:07 +0000[diff] [blame]580instead of run-time. Global variables may optionally be initialized, may have
581an explicit section to be placed in, and may
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]582have an optional explicit alignment specified. A
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]583variable may be defined as a global "constant," which indicates that the
Chris Lattner3689a342005-02-12 19:30:21 +0000[diff] [blame]584contents of the variable will <b>never</b> be modified (enabling better
585optimization, allowing the global data to be placed in the read-only section of
586an executable, etc). Note that variables that need runtime initialization
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]587cannot be marked "constant" as there is a store to the variable.</p>
Chris Lattner3689a342005-02-12 19:30:21 +0000[diff] [blame]588
589<p>
590LLVM explicitly allows <em>declarations</em> of global variables to be marked
591constant, even if the final definition of the global is not. This capability
592can be used to enable slightly better optimization of the program, but requires
593the language definition to guarantee that optimizations based on the
594'constantness' are valid for the translation units that do not include the
595definition.
596</p>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]597
598<p>As SSA values, global variables define pointer values that are in
599scope (i.e. they dominate) all basic blocks in the program. Global
600variables always define a pointer to their "content" type because they
601describe a region of memory, and all memory objects in LLVM are
602accessed through pointers.</p>
603
Chris Lattner88f6c462005-11-12 00:45:07 +0000[diff] [blame]604<p>LLVM allows an explicit section to be specified for globals. If the target
605supports it, it will emit globals to the section specified.</p>
606
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]607<p>An explicit alignment may be specified for a global. If not present, or if
608the alignment is set to zero, the alignment of the global is set by the target
609to whatever it feels convenient. If an explicit alignment is specified, the
610global is forced to have at least that much alignment. All alignments must be
611a power of 2.</p>
612
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]613</div>
614
615
616<!-- ======================================================================= -->
617<div class="doc_subsection">
618 <a name="functionstructure">Functions</a>
619</div>
620
621<div class="doc_text">
622
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]623<p>LLVM function definitions consist of an optional <a href="#linkage">linkage
624type</a>, an optional <a href="#callingconv">calling convention</a>, a return
Chris Lattner88f6c462005-11-12 00:45:07 +0000[diff] [blame]625type, a function name, a (possibly empty) argument list, an optional section,
626an optional alignment, an opening curly brace,
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]627a list of basic blocks, and a closing curly brace. LLVM function declarations
628are defined with the "<tt>declare</tt>" keyword, an optional <a
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]629href="#callingconv">calling convention</a>, a return type, a function name,
630a possibly empty list of arguments, and an optional alignment.</p>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]631
632<p>A function definition contains a list of basic blocks, forming the CFG for
633the function. Each basic block may optionally start with a label (giving the
634basic block a symbol table entry), contains a list of instructions, and ends
635with a <a href="#terminators">terminator</a> instruction (such as a branch or
636function return).</p>
637
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]638<p>The first basic block in a program is special in two ways: it is immediately
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]639executed on entrance to the function, and it is not allowed to have predecessor
640basic blocks (i.e. there can not be any branches to the entry block of a
641function). Because the block can have no predecessors, it also cannot have any
642<a href="#i_phi">PHI nodes</a>.</p>
643
644<p>LLVM functions are identified by their name and type signature. Hence, two
645functions with the same name but different parameter lists or return values are
Chris Lattnerd4f6b172005-03-07 22:13:59 +0000[diff] [blame]646considered different functions, and LLVM will resolve references to each
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]647appropriately.</p>
648
Chris Lattner88f6c462005-11-12 00:45:07 +0000[diff] [blame]649<p>LLVM allows an explicit section to be specified for functions. If the target
650supports it, it will emit functions to the section specified.</p>
651
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]652<p>An explicit alignment may be specified for a function. If not present, or if
653the alignment is set to zero, the alignment of the function is set by the target
654to whatever it feels convenient. If an explicit alignment is specified, the
655function is forced to have at least that much alignment. All alignments must be
656a power of 2.</p>
657
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]658</div>
659
Chris Lattner4e9aba72006-01-23 23:23:47 +0000[diff] [blame]660<!-- ======================================================================= -->
661<div class="doc_subsection">
Chris Lattner1eeeb0c2006-04-08 04:40:53 +0000[diff] [blame]662 <a name="moduleasm">Module-Level Inline Assembly</a>
Chris Lattner4e9aba72006-01-23 23:23:47 +0000[diff] [blame]663</div>
664
665<div class="doc_text">
666<p>
667Modules may contain "module-level inline asm" blocks, which corresponds to the
668GCC "file scope inline asm" blocks. These blocks are internally concatenated by
669LLVM and treated as a single unit, but may be separated in the .ll file if
670desired. The syntax is very simple:
671</p>
672
673<div class="doc_code"><pre>
Chris Lattner52599e12006-01-24 00:37:20 +0000[diff] [blame]674 module asm "inline asm code goes here"
675 module asm "more can go here"
Chris Lattner4e9aba72006-01-23 23:23:47 +0000[diff] [blame]676</pre></div>
677
678<p>The strings can contain any character by escaping non-printable characters.
679 The escape sequence used is simply "\xx" where "xx" is the two digit hex code
680 for the number.
681</p>
682
683<p>
684 The inline asm code is simply printed to the machine code .s file when
685 assembly code is generated.
686</p>
687</div>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]688
689
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]690<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]691<div class="doc_section"> <a name="typesystem">Type System</a> </div>
692<!-- *********************************************************************** -->
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]693
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]694<div class="doc_text">
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]695
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]696<p>The LLVM type system is one of the most important features of the
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]697intermediate representation. Being typed enables a number of
698optimizations to be performed on the IR directly, without having to do
699extra analyses on the side before the transformation. A strong type
700system makes it easier to read the generated code and enables novel
701analyses and transformations that are not feasible to perform on normal
702three address code representations.</p>
Chris Lattnerfa730212004-12-09 16:11:40 +0000[diff] [blame]703
704</div>
705
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]706<!-- ======================================================================= -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]707<div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]708<div class="doc_text">
John Criswell4457dc92004-04-09 16:48:45 +0000[diff] [blame]709<p>The primitive types are the fundamental building blocks of the LLVM
Chris Lattnerd4f6b172005-03-07 22:13:59 +0000[diff] [blame]710system. The current set of primitive types is as follows:</p>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]711
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]712<table class="layout">
713 <tr class="layout">
714 <td class="left">
715 <table>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]716 <tbody>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]717 <tr><th>Type</th><th>Description</th></tr>
718 <tr><td><tt>void</tt></td><td>No value</td></tr>
Misha Brukmancfa87bc2005-04-22 18:02:52 +0000[diff] [blame]719 <tr><td><tt>ubyte</tt></td><td>Unsigned 8-bit value</td></tr>
720 <tr><td><tt>ushort</tt></td><td>Unsigned 16-bit value</td></tr>
721 <tr><td><tt>uint</tt></td><td>Unsigned 32-bit value</td></tr>
722 <tr><td><tt>ulong</tt></td><td>Unsigned 64-bit value</td></tr>
723 <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]724 <tr><td><tt>label</tt></td><td>Branch destination</td></tr>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]725 </tbody>
726 </table>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]727 </td>
728 <td class="right">
729 <table>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]730 <tbody>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]731 <tr><th>Type</th><th>Description</th></tr>
732 <tr><td><tt>bool</tt></td><td>True or False value</td></tr>
Misha Brukmancfa87bc2005-04-22 18:02:52 +0000[diff] [blame]733 <tr><td><tt>sbyte</tt></td><td>Signed 8-bit value</td></tr>
734 <tr><td><tt>short</tt></td><td>Signed 16-bit value</td></tr>
735 <tr><td><tt>int</tt></td><td>Signed 32-bit value</td></tr>
736 <tr><td><tt>long</tt></td><td>Signed 64-bit value</td></tr>
737 <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]738 </tbody>
739 </table>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]740 </td>
741 </tr>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]742</table>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]743</div>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]744
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]745<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]746<div class="doc_subsubsection"> <a name="t_classifications">Type
747Classifications</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]748<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]749<p>These different primitive types fall into a few useful
750classifications:</p>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]751
752<table border="1" cellspacing="0" cellpadding="4">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]753 <tbody>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]754 <tr><th>Classification</th><th>Types</th></tr>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]755 <tr>
756 <td><a name="t_signed">signed</a></td>
757 <td><tt>sbyte, short, int, long, float, double</tt></td>
758 </tr>
759 <tr>
760 <td><a name="t_unsigned">unsigned</a></td>
761 <td><tt>ubyte, ushort, uint, ulong</tt></td>
762 </tr>
763 <tr>
764 <td><a name="t_integer">integer</a></td>
765 <td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td>
766 </tr>
767 <tr>
768 <td><a name="t_integral">integral</a></td>
Misha Brukmanc24b7582004-08-12 20:16:08 +0000[diff] [blame]769 <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long</tt>
770 </td>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]771 </tr>
772 <tr>
773 <td><a name="t_floating">floating point</a></td>
774 <td><tt>float, double</tt></td>
775 </tr>
776 <tr>
777 <td><a name="t_firstclass">first class</a></td>
Misha Brukmanc24b7582004-08-12 20:16:08 +0000[diff] [blame]778 <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long,<br>
779 float, double, <a href="#t_pointer">pointer</a>,
780 <a href="#t_packed">packed</a></tt></td>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]781 </tr>
782 </tbody>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]783</table>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]784
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]785<p>The <a href="#t_firstclass">first class</a> types are perhaps the
786most important. Values of these types are the only ones which can be
787produced by instructions, passed as arguments, or used as operands to
788instructions. This means that all structures and arrays must be
789manipulated either by pointer or by component.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]790</div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]791
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]792<!-- ======================================================================= -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]793<div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]794
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]795<div class="doc_text">
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]796
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]797<p>The real power in LLVM comes from the derived types in the system.
798This is what allows a programmer to represent arrays, functions,
799pointers, and other useful types. Note that these derived types may be
800recursive: For example, it is possible to have a two dimensional array.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]801
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]802</div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]803
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]804<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]805<div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]806
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]807<div class="doc_text">
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]808
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]809<h5>Overview:</h5>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]810
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]811<p>The array type is a very simple derived type that arranges elements
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]812sequentially in memory. The array type requires a size (number of
813elements) and an underlying data type.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]814
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]815<h5>Syntax:</h5>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]816
817<pre>
818 [&lt;# elements&gt; x &lt;elementtype&gt;]
819</pre>
820
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]821<p>The number of elements is a constant integer value; elementtype may
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]822be any type with a size.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]823
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]824<h5>Examples:</h5>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]825<table class="layout">
826 <tr class="layout">
827 <td class="left">
828 <tt>[40 x int ]</tt><br/>
829 <tt>[41 x int ]</tt><br/>
830 <tt>[40 x uint]</tt><br/>
831 </td>
832 <td class="left">
833 Array of 40 integer values.<br/>
834 Array of 41 integer values.<br/>
835 Array of 40 unsigned integer values.<br/>
836 </td>
837 </tr>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]838</table>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]839<p>Here are some examples of multidimensional arrays:</p>
840<table class="layout">
841 <tr class="layout">
842 <td class="left">
843 <tt>[3 x [4 x int]]</tt><br/>
844 <tt>[12 x [10 x float]]</tt><br/>
845 <tt>[2 x [3 x [4 x uint]]]</tt><br/>
846 </td>
847 <td class="left">
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]848 3x4 array of integer values.<br/>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]849 12x10 array of single precision floating point values.<br/>
850 2x3x4 array of unsigned integer values.<br/>
851 </td>
852 </tr>
853</table>
Chris Lattnere67a9512005-06-24 17:22:57 +0000[diff] [blame]854
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]855<p>Note that 'variable sized arrays' can be implemented in LLVM with a zero
856length array. Normally, accesses past the end of an array are undefined in
Chris Lattnere67a9512005-06-24 17:22:57 +0000[diff] [blame]857LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
858As a special case, however, zero length arrays are recognized to be variable
859length. This allows implementation of 'pascal style arrays' with the LLVM
860type "{ int, [0 x float]}", for example.</p>
861
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]862</div>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]863
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]864<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]865<div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]866<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]867<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]868<p>The function type can be thought of as a function signature. It
869consists of a return type and a list of formal parameter types.
John Criswell009900b2003-11-25 21:45:46 +0000[diff] [blame]870Function types are usually used to build virtual function tables
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]871(which are structures of pointers to functions), for indirect function
872calls, and when defining a function.</p>
John Criswell009900b2003-11-25 21:45:46 +0000[diff] [blame]873<p>
874The return type of a function type cannot be an aggregate type.
875</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]876<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]877<pre> &lt;returntype&gt; (&lt;parameter list&gt;)<br></pre>
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]878<p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
Misha Brukmanc24b7582004-08-12 20:16:08 +0000[diff] [blame]879specifiers. Optionally, the parameter list may include a type <tt>...</tt>,
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]880which indicates that the function takes a variable number of arguments.
881Variable argument functions can access their arguments with the <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]882 href="#int_varargs">variable argument handling intrinsic</a> functions.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]883<h5>Examples:</h5>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]884<table class="layout">
885 <tr class="layout">
886 <td class="left">
887 <tt>int (int)</tt> <br/>
888 <tt>float (int, int *) *</tt><br/>
889 <tt>int (sbyte *, ...)</tt><br/>
890 </td>
891 <td class="left">
892 function taking an <tt>int</tt>, returning an <tt>int</tt><br/>
893 <a href="#t_pointer">Pointer</a> to a function that takes an
Misha Brukmanc24b7582004-08-12 20:16:08 +0000[diff] [blame]894 <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>,
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]895 returning <tt>float</tt>.<br/>
896 A vararg function that takes at least one <a href="#t_pointer">pointer</a>
897 to <tt>sbyte</tt> (signed char in C), which returns an integer. This is
898 the signature for <tt>printf</tt> in LLVM.<br/>
899 </td>
900 </tr>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]901</table>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]902
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]903</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]904<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]905<div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]906<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]907<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]908<p>The structure type is used to represent a collection of data members
909together in memory. The packing of the field types is defined to match
910the ABI of the underlying processor. The elements of a structure may
911be any type that has a size.</p>
912<p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
913and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
914field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
915instruction.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]916<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]917<pre> { &lt;type list&gt; }<br></pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]918<h5>Examples:</h5>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]919<table class="layout">
920 <tr class="layout">
921 <td class="left">
922 <tt>{ int, int, int }</tt><br/>
923 <tt>{ float, int (int) * }</tt><br/>
924 </td>
925 <td class="left">
926 a triple of three <tt>int</tt> values<br/>
927 A pair, where the first element is a <tt>float</tt> and the second element
928 is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a>
929 that takes an <tt>int</tt>, returning an <tt>int</tt>.<br/>
930 </td>
931 </tr>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]932</table>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]933</div>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]934
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]935<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]936<div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]937<div class="doc_text">
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]938<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]939<p>As in many languages, the pointer type represents a pointer or
940reference to another object, which must live in memory.</p>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]941<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]942<pre> &lt;type&gt; *<br></pre>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]943<h5>Examples:</h5>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]944<table class="layout">
945 <tr class="layout">
946 <td class="left">
947 <tt>[4x int]*</tt><br/>
948 <tt>int (int *) *</tt><br/>
949 </td>
950 <td class="left">
951 A <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a> of
952 four <tt>int</tt> values<br/>
953 A <a href="#t_pointer">pointer</a> to a <a
Chris Lattnera977c482005-02-19 02:22:14 +0000[diff] [blame]954 href="#t_function">function</a> that takes an <tt>int*</tt>, returning an
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]955 <tt>int</tt>.<br/>
956 </td>
957 </tr>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]958</table>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]959</div>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]960
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]961<!-- _______________________________________________________________________ -->
962<div class="doc_subsubsection"> <a name="t_packed">Packed Type</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]963<div class="doc_text">
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]964
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]965<h5>Overview:</h5>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]966
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]967<p>A packed type is a simple derived type that represents a vector
968of elements. Packed types are used when multiple primitive data
969are operated in parallel using a single instruction (SIMD).
970A packed type requires a size (number of
Chris Lattnerb8d172f2005-11-10 01:44:22 +0000[diff] [blame]971elements) and an underlying primitive data type. Vectors must have a power
972of two length (1, 2, 4, 8, 16 ...). Packed types are
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]973considered <a href="#t_firstclass">first class</a>.</p>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]974
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]975<h5>Syntax:</h5>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]976
977<pre>
978 &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
979</pre>
980
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]981<p>The number of elements is a constant integer value; elementtype may
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]982be any integral or floating point type.</p>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]983
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]984<h5>Examples:</h5>
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]985
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]986<table class="layout">
987 <tr class="layout">
988 <td class="left">
989 <tt>&lt;4 x int&gt;</tt><br/>
990 <tt>&lt;8 x float&gt;</tt><br/>
991 <tt>&lt;2 x uint&gt;</tt><br/>
992 </td>
993 <td class="left">
994 Packed vector of 4 integer values.<br/>
995 Packed vector of 8 floating-point values.<br/>
996 Packed vector of 2 unsigned integer values.<br/>
997 </td>
998 </tr>
999</table>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1000</div>
1001
Chris Lattner69c11bb2005-04-25 17:34:15 +0000[diff] [blame]1002<!-- _______________________________________________________________________ -->
1003<div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1004<div class="doc_text">
1005
1006<h5>Overview:</h5>
1007
1008<p>Opaque types are used to represent unknown types in the system. This
1009corresponds (for example) to the C notion of a foward declared structure type.
1010In LLVM, opaque types can eventually be resolved to any type (not just a
1011structure type).</p>
1012
1013<h5>Syntax:</h5>
1014
1015<pre>
1016 opaque
1017</pre>
1018
1019<h5>Examples:</h5>
1020
1021<table class="layout">
1022 <tr class="layout">
1023 <td class="left">
1024 <tt>opaque</tt>
1025 </td>
1026 <td class="left">
1027 An opaque type.<br/>
1028 </td>
1029 </tr>
1030</table>
1031</div>
1032
1033
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1034<!-- *********************************************************************** -->
1035<div class="doc_section"> <a name="constants">Constants</a> </div>
1036<!-- *********************************************************************** -->
1037
1038<div class="doc_text">
1039
1040<p>LLVM has several different basic types of constants. This section describes
1041them all and their syntax.</p>
1042
1043</div>
1044
1045<!-- ======================================================================= -->
Reid Spencercc16dc32004-12-09 18:02:53 +0000[diff] [blame]1046<div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1047
1048<div class="doc_text">
1049
1050<dl>
1051 <dt><b>Boolean constants</b></dt>
1052
1053 <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
1054 constants of the <tt><a href="#t_primitive">bool</a></tt> type.
1055 </dd>
1056
1057 <dt><b>Integer constants</b></dt>
1058
Reid Spencercc16dc32004-12-09 18:02:53 +0000[diff] [blame]1059 <dd>Standard integers (such as '4') are constants of the <a
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1060 href="#t_integer">integer</a> type. Negative numbers may be used with signed
1061 integer types.
1062 </dd>
1063
1064 <dt><b>Floating point constants</b></dt>
1065
1066 <dd>Floating point constants use standard decimal notation (e.g. 123.421),
1067 exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1068 notation (see below). Floating point constants must have a <a
1069 href="#t_floating">floating point</a> type. </dd>
1070
1071 <dt><b>Null pointer constants</b></dt>
1072
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1073 <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1074 and must be of <a href="#t_pointer">pointer type</a>.</dd>
1075
1076</dl>
1077
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1078<p>The one non-intuitive notation for constants is the optional hexadecimal form
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1079of floating point constants. For example, the form '<tt>double
10800x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
10814.5e+15</tt>'. The only time hexadecimal floating point constants are required
Reid Spencercc16dc32004-12-09 18:02:53 +0000[diff] [blame]1082(and the only time that they are generated by the disassembler) is when a
1083floating point constant must be emitted but it cannot be represented as a
1084decimal floating point number. For example, NaN's, infinities, and other
1085special values are represented in their IEEE hexadecimal format so that
1086assembly and disassembly do not cause any bits to change in the constants.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1087
1088</div>
1089
1090<!-- ======================================================================= -->
1091<div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a>
1092</div>
1093
1094<div class="doc_text">
Chris Lattnerd4f6b172005-03-07 22:13:59 +0000[diff] [blame]1095<p>Aggregate constants arise from aggregation of simple constants
1096and smaller aggregate constants.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1097
1098<dl>
1099 <dt><b>Structure constants</b></dt>
1100
1101 <dd>Structure constants are represented with notation similar to structure
1102 type definitions (a comma separated list of elements, surrounded by braces
Chris Lattnerd4f6b172005-03-07 22:13:59 +0000[diff] [blame]1103 (<tt>{}</tt>)). For example: "<tt>{ int 4, float 17.0, int* %G }</tt>",
1104 where "<tt>%G</tt>" is declared as "<tt>%G = external global int</tt>". Structure constants
1105 must have <a href="#t_struct">structure type</a>, and the number and
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1106 types of elements must match those specified by the type.
1107 </dd>
1108
1109 <dt><b>Array constants</b></dt>
1110
1111 <dd>Array constants are represented with notation similar to array type
1112 definitions (a comma separated list of elements, surrounded by square brackets
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1113 (<tt>[]</tt>)). For example: "<tt>[ int 42, int 11, int 74 ]</tt>". Array
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1114 constants must have <a href="#t_array">array type</a>, and the number and
1115 types of elements must match those specified by the type.
1116 </dd>
1117
1118 <dt><b>Packed constants</b></dt>
1119
1120 <dd>Packed constants are represented with notation similar to packed type
1121 definitions (a comma separated list of elements, surrounded by
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1122 less-than/greater-than's (<tt>&lt;&gt;</tt>)). For example: "<tt>&lt; int 42,
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1123 int 11, int 74, int 100 &gt;</tt>". Packed constants must have <a
1124 href="#t_packed">packed type</a>, and the number and types of elements must
1125 match those specified by the type.
1126 </dd>
1127
1128 <dt><b>Zero initialization</b></dt>
1129
1130 <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
1131 value to zero of <em>any</em> type, including scalar and aggregate types.
1132 This is often used to avoid having to print large zero initializers (e.g. for
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]1133 large arrays) and is always exactly equivalent to using explicit zero
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1134 initializers.
1135 </dd>
1136</dl>
1137
1138</div>
1139
1140<!-- ======================================================================= -->
1141<div class="doc_subsection">
1142 <a name="globalconstants">Global Variable and Function Addresses</a>
1143</div>
1144
1145<div class="doc_text">
1146
1147<p>The addresses of <a href="#globalvars">global variables</a> and <a
1148href="#functionstructure">functions</a> are always implicitly valid (link-time)
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1149constants. These constants are explicitly referenced when the <a
1150href="#identifiers">identifier for the global</a> is used and always have <a
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1151href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
1152file:</p>
1153
1154<pre>
1155 %X = global int 17
1156 %Y = global int 42
1157 %Z = global [2 x int*] [ int* %X, int* %Y ]
1158</pre>
1159
1160</div>
1161
1162<!-- ======================================================================= -->
Reid Spencer2dc45b82004-12-09 18:13:12 +0000[diff] [blame]1163<div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1164<div class="doc_text">
Reid Spencer2dc45b82004-12-09 18:13:12 +0000[diff] [blame]1165 <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]1166 no specific value. Undefined values may be of any type and be used anywhere
Reid Spencer2dc45b82004-12-09 18:13:12 +0000[diff] [blame]1167 a constant is permitted.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1168
Reid Spencer2dc45b82004-12-09 18:13:12 +0000[diff] [blame]1169 <p>Undefined values indicate to the compiler that the program is well defined
1170 no matter what value is used, giving the compiler more freedom to optimize.
1171 </p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1172</div>
1173
1174<!-- ======================================================================= -->
1175<div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
1176</div>
1177
1178<div class="doc_text">
1179
1180<p>Constant expressions are used to allow expressions involving other constants
1181to be used as constants. Constant expressions may be of any <a
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]1182href="#t_firstclass">first class</a> type and may involve any LLVM operation
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1183that does not have side effects (e.g. load and call are not supported). The
1184following is the syntax for constant expressions:</p>
1185
1186<dl>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1187 <dt><b><tt>trunc ( CST to TYPE )</tt></b></dt>
1188 <dd>Truncate a constant to another type. The bit size of CST must be larger
1189 than the bit size of TYPE. Both types must be integral.</dd>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1190
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1191 <dt><b><tt>zext ( CST to TYPE )</tt></b></dt>
1192 <dd>Zero extend a constant to another type. The bit size of CST must be
1193 smaller or equal to the bit size of TYPE. Both types must be integral.</dd>
1194
1195 <dt><b><tt>sext ( CST to TYPE )</tt></b></dt>
1196 <dd>Sign extend a constant to another type. The bit size of CST must be
1197 smaller or equal to the bit size of TYPE. Both types must be integral.</dd>
1198
1199 <dt><b><tt>fptrunc ( CST to TYPE )</tt></b></dt>
1200 <dd>Truncate a floating point constant to another floating point type. The
1201 size of CST must be larger than the size of TYPE. Both types must be
1202 floating point.</dd>
1203
1204 <dt><b><tt>fpext ( CST to TYPE )</tt></b></dt>
1205 <dd>Floating point extend a constant to another type. The size of CST must be
1206 smaller or equal to the size of TYPE. Both types must be floating point.</dd>
1207
1208 <dt><b><tt>fp2uint ( CST to TYPE )</tt></b></dt>
1209 <dd>Convert a floating point constant to the corresponding unsigned integer
1210 constant. TYPE must be an integer type. CST must be floating point. If the
1211 value won't fit in the integer type, the results are undefined.</dd>
1212
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]1213 <dt><b><tt>fptosi ( CST to TYPE )</tt></b></dt>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1214 <dd>Convert a floating point constant to the corresponding signed integer
1215 constant. TYPE must be an integer type. CST must be floating point. If the
1216 value won't fit in the integer type, the results are undefined.</dd>
1217
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]1218 <dt><b><tt>uitofp ( CST to TYPE )</tt></b></dt>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1219 <dd>Convert an unsigned integer constant to the corresponding floating point
1220 constant. TYPE must be floating point. CST must be of integer type. If the
1221 value won't fit in the floating point type, the results are undefined.</dd>
1222
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]1223 <dt><b><tt>sitofp ( CST to TYPE )</tt></b></dt>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1224 <dd>Convert a signed integer constant to the corresponding floating point
1225 constant. TYPE must be floating point. CST must be of integer type. If the
1226 value won't fit in the floating point type, the results are undefined.</dd>
1227
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]1228 <dt><b><tt>ptrtoint ( CST to TYPE )</tt></b></dt>
1229 <dd>Convert a pointer typed constant to the corresponding integer constant
1230 TYPE must be an integer type. CST must be of pointer type. The CST value is
1231 zero extended, truncated, or unchanged to make it fit in TYPE.</dd>
1232
1233 <dt><b><tt>inttoptr ( CST to TYPE )</tt></b></dt>
1234 <dd>Convert a integer constant to a pointer constant. TYPE must be a
1235 pointer type. CST must be of integer type. The CST value is zero extended,
1236 truncated, or unchanged to make it fit in a pointer size. This one is
1237 <i>really</i> dangerous!</dd>
1238
1239 <dt><b><tt>bitcast ( CST to TYPE )</tt></b></dt>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1240 <dd>Convert a constant, CST, to another TYPE. The size of CST and TYPE must be
1241 identical (same number of bits). The conversion is done as if the CST value
1242 was stored to memory and read back as TYPE. In other words, no bits change
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]1243 with this operator, just the type. This can be used for conversion of
1244 packed types to any other type, as long as they have the same bit width. For
1245 pointers it is only valid to cast to another pointer type.
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1246 </dd>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1247
1248 <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
1249
1250 <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
1251 constants. As with the <a href="#i_getelementptr">getelementptr</a>
1252 instruction, the index list may have zero or more indexes, which are required
1253 to make sense for the type of "CSTPTR".</dd>
1254
Robert Bocchino9fbe1452006-01-10 19:31:34 +0000[diff] [blame]1255 <dt><b><tt>select ( COND, VAL1, VAL2 )</tt></b></dt>
1256
1257 <dd>Perform the <a href="#i_select">select operation</a> on
Reid Spencer01c42592006-12-04 19:23:19 +0000[diff] [blame]1258 constants.</dd>
1259
1260 <dt><b><tt>icmp COND ( VAL1, VAL2 )</tt></b></dt>
1261 <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
1262
1263 <dt><b><tt>fcmp COND ( VAL1, VAL2 )</tt></b></dt>
1264 <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
Robert Bocchino9fbe1452006-01-10 19:31:34 +0000[diff] [blame]1265
1266 <dt><b><tt>extractelement ( VAL, IDX )</tt></b></dt>
1267
1268 <dd>Perform the <a href="#i_extractelement">extractelement
1269 operation</a> on constants.
1270
Robert Bocchino05ccd702006-01-15 20:48:27 +0000[diff] [blame]1271 <dt><b><tt>insertelement ( VAL, ELT, IDX )</tt></b></dt>
1272
1273 <dd>Perform the <a href="#i_insertelement">insertelement
Reid Spencer01c42592006-12-04 19:23:19 +0000[diff] [blame]1274 operation</a> on constants.</dd>
Robert Bocchino05ccd702006-01-15 20:48:27 +0000[diff] [blame]1275
Chris Lattnerc1989542006-04-08 00:13:41 +0000[diff] [blame]1276
1277 <dt><b><tt>shufflevector ( VEC1, VEC2, IDXMASK )</tt></b></dt>
1278
1279 <dd>Perform the <a href="#i_shufflevector">shufflevector
Reid Spencer01c42592006-12-04 19:23:19 +0000[diff] [blame]1280 operation</a> on constants.</dd>
Chris Lattnerc1989542006-04-08 00:13:41 +0000[diff] [blame]1281
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1282 <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
1283
Reid Spencer2dc45b82004-12-09 18:13:12 +0000[diff] [blame]1284 <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
1285 be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1286 binary</a> operations. The constraints on operands are the same as those for
1287 the corresponding instruction (e.g. no bitwise operations on floating point
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]1288 values are allowed).</dd>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1289</dl>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1290</div>
Chris Lattner9ee5d222004-03-08 16:49:10 +0000[diff] [blame]1291
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1292<!-- *********************************************************************** -->
Chris Lattnere87d6532006-01-25 23:47:57 +0000[diff] [blame]1293<div class="doc_section"> <a name="othervalues">Other Values</a> </div>
1294<!-- *********************************************************************** -->
1295
1296<!-- ======================================================================= -->
1297<div class="doc_subsection">
1298<a name="inlineasm">Inline Assembler Expressions</a>
1299</div>
1300
1301<div class="doc_text">
1302
1303<p>
1304LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm">
1305Module-Level Inline Assembly</a>) through the use of a special value. This
1306value represents the inline assembler as a string (containing the instructions
1307to emit), a list of operand constraints (stored as a string), and a flag that
1308indicates whether or not the inline asm expression has side effects. An example
1309inline assembler expression is:
1310</p>
1311
1312<pre>
1313 int(int) asm "bswap $0", "=r,r"
1314</pre>
1315
1316<p>
1317Inline assembler expressions may <b>only</b> be used as the callee operand of
1318a <a href="#i_call"><tt>call</tt> instruction</a>. Thus, typically we have:
1319</p>
1320
1321<pre>
1322 %X = call int asm "<a href="#i_bswap">bswap</a> $0", "=r,r"(int %Y)
1323</pre>
1324
1325<p>
1326Inline asms with side effects not visible in the constraint list must be marked
1327as having side effects. This is done through the use of the
1328'<tt>sideeffect</tt>' keyword, like so:
1329</p>
1330
1331<pre>
1332 call void asm sideeffect "eieio", ""()
1333</pre>
1334
1335<p>TODO: The format of the asm and constraints string still need to be
1336documented here. Constraints on what can be done (e.g. duplication, moving, etc
1337need to be documented).
1338</p>
1339
1340</div>
1341
1342<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1343<div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
1344<!-- *********************************************************************** -->
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1345
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1346<div class="doc_text">
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1347
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1348<p>The LLVM instruction set consists of several different
1349classifications of instructions: <a href="#terminators">terminator
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]1350instructions</a>, <a href="#binaryops">binary instructions</a>,
1351<a href="#bitwiseops">bitwise binary instructions</a>, <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1352 href="#memoryops">memory instructions</a>, and <a href="#otherops">other
1353instructions</a>.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1354
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1355</div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1356
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1357<!-- ======================================================================= -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1358<div class="doc_subsection"> <a name="terminators">Terminator
1359Instructions</a> </div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1360
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1361<div class="doc_text">
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1362
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1363<p>As mentioned <a href="#functionstructure">previously</a>, every
1364basic block in a program ends with a "Terminator" instruction, which
1365indicates which block should be executed after the current block is
1366finished. These terminator instructions typically yield a '<tt>void</tt>'
1367value: they produce control flow, not values (the one exception being
1368the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1369<p>There are six different terminator instructions: the '<a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1370 href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
1371instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1372the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
1373 href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
1374 href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1375
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1376</div>
Chris Lattnerc3f59762004-12-09 17:30:23 +0000[diff] [blame]1377
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1378<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1379<div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
1380Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1381<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1382<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1383<pre> ret &lt;type&gt; &lt;value&gt; <i>; Return a value from a non-void function</i>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]1384 ret void <i>; Return from void function</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1385</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1386<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1387<p>The '<tt>ret</tt>' instruction is used to return control flow (and a
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]1388value) from a function back to the caller.</p>
John Criswell4457dc92004-04-09 16:48:45 +0000[diff] [blame]1389<p>There are two forms of the '<tt>ret</tt>' instruction: one that
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1390returns a value and then causes control flow, and one that just causes
1391control flow to occur.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1392<h5>Arguments:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1393<p>The '<tt>ret</tt>' instruction may return any '<a
1394 href="#t_firstclass">first class</a>' type. Notice that a function is
1395not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>'
1396instruction inside of the function that returns a value that does not
1397match the return type of the function.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1398<h5>Semantics:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1399<p>When the '<tt>ret</tt>' instruction is executed, control flow
1400returns back to the calling function's context. If the caller is a "<a
John Criswellfa081872004-06-25 15:16:57 +0000[diff] [blame]1401 href="#i_call"><tt>call</tt></a>" instruction, execution continues at
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1402the instruction after the call. If the caller was an "<a
1403 href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]1404at the beginning of the "normal" destination block. If the instruction
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1405returns a value, that value shall set the call or invoke instruction's
1406return value.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1407<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1408<pre> ret int 5 <i>; Return an integer value of 5</i>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]1409 ret void <i>; Return from a void function</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1410</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1411</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1412<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1413<div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1414<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1415<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1416<pre> br bool &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br> br label &lt;dest&gt; <i>; Unconditional branch</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1417</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1418<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1419<p>The '<tt>br</tt>' instruction is used to cause control flow to
1420transfer to a different basic block in the current function. There are
1421two forms of this instruction, corresponding to a conditional branch
1422and an unconditional branch.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1423<h5>Arguments:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1424<p>The conditional branch form of the '<tt>br</tt>' instruction takes a
1425single '<tt>bool</tt>' value and two '<tt>label</tt>' values. The
1426unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>'
1427value as a target.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1428<h5>Semantics:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1429<p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>'
1430argument is evaluated. If the value is <tt>true</tt>, control flows
1431to the '<tt>iftrue</tt>' <tt>label</tt> argument. If "cond" is <tt>false</tt>,
1432control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1433<h5>Example:</h5>
Reid Spencer36d68e42006-11-18 21:55:45 +0000[diff] [blame]1434<pre>Test:<br> %cond = <a href="#i_icmp">icmp</a> eq, int %a, %b<br> br bool %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br> <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1435 href="#i_ret">ret</a> int 1<br>IfUnequal:<br> <a href="#i_ret">ret</a> int 0<br></pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1436</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1437<!-- _______________________________________________________________________ -->
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1438<div class="doc_subsubsection">
1439 <a name="i_switch">'<tt>switch</tt>' Instruction</a>
1440</div>
1441
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1442<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1443<h5>Syntax:</h5>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1444
1445<pre>
1446 switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
1447</pre>
1448
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1449<h5>Overview:</h5>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1450
1451<p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
1452several different places. It is a generalization of the '<tt>br</tt>'
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1453instruction, allowing a branch to occur to one of many possible
1454destinations.</p>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1455
1456
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1457<h5>Arguments:</h5>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1458
1459<p>The '<tt>switch</tt>' instruction uses three parameters: an integer
1460comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
1461an array of pairs of comparison value constants and '<tt>label</tt>'s. The
1462table is not allowed to contain duplicate constant entries.</p>
1463
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1464<h5>Semantics:</h5>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1465
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1466<p>The <tt>switch</tt> instruction specifies a table of values and
1467destinations. When the '<tt>switch</tt>' instruction is executed, this
John Criswell84114752004-06-25 16:05:06 +0000[diff] [blame]1468table is searched for the given value. If the value is found, control flow is
1469transfered to the corresponding destination; otherwise, control flow is
1470transfered to the default destination.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1471
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1472<h5>Implementation:</h5>
1473
1474<p>Depending on properties of the target machine and the particular
1475<tt>switch</tt> instruction, this instruction may be code generated in different
John Criswell84114752004-06-25 16:05:06 +0000[diff] [blame]1476ways. For example, it could be generated as a series of chained conditional
1477branches or with a lookup table.</p>
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1478
1479<h5>Example:</h5>
1480
1481<pre>
1482 <i>; Emulate a conditional br instruction</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]1483 %Val = <a href="#i_zext">zext</a> bool %value to int
Chris Lattnerc88c17b2004-02-24 04:54:45 +0000[diff] [blame]1484 switch int %Val, label %truedest [int 0, label %falsedest ]
1485
1486 <i>; Emulate an unconditional br instruction</i>
1487 switch uint 0, label %dest [ ]
1488
1489 <i>; Implement a jump table:</i>
1490 switch uint %val, label %otherwise [ uint 0, label %onzero
1491 uint 1, label %onone
1492 uint 2, label %ontwo ]
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1493</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1494</div>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1495
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1496<!-- _______________________________________________________________________ -->
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1497<div class="doc_subsubsection">
1498 <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
1499</div>
1500
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1501<div class="doc_text">
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1502
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1503<h5>Syntax:</h5>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1504
1505<pre>
1506 &lt;result&gt; = invoke [<a href="#callingconv">cconv</a>] &lt;ptr to function ty&gt; %&lt;function ptr val&gt;(&lt;function args&gt;)
Chris Lattner76b8a332006-05-14 18:23:06 +0000[diff] [blame]1507 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1508</pre>
1509
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]1510<h5>Overview:</h5>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1511
1512<p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
1513function, with the possibility of control flow transfer to either the
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]1514'<tt>normal</tt>' label or the
1515'<tt>exception</tt>' label. If the callee function returns with the
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1516"<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the
1517"normal" label. If the callee (or any indirect callees) returns with the "<a
John Criswelle4c57cc2005-05-12 16:52:32 +0000[diff] [blame]1518href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and
1519continued at the dynamically nearest "exception" label.</p>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1520
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1521<h5>Arguments:</h5>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1522
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1523<p>This instruction requires several arguments:</p>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1524
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1525<ol>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1526 <li>
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]1527 The optional "cconv" marker indicates which <a href="callingconv">calling
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1528 convention</a> the call should use. If none is specified, the call defaults
1529 to using C calling conventions.
1530 </li>
1531 <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
1532 function value being invoked. In most cases, this is a direct function
1533 invocation, but indirect <tt>invoke</tt>s are just as possible, branching off
1534 an arbitrary pointer to function value.
1535 </li>
1536
1537 <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
1538 function to be invoked. </li>
1539
1540 <li>'<tt>function args</tt>': argument list whose types match the function
1541 signature argument types. If the function signature indicates the function
1542 accepts a variable number of arguments, the extra arguments can be
1543 specified. </li>
1544
1545 <li>'<tt>normal label</tt>': the label reached when the called function
1546 executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
1547
1548 <li>'<tt>exception label</tt>': the label reached when a callee returns with
1549 the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
1550
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1551</ol>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1552
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1553<h5>Semantics:</h5>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1554
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1555<p>This instruction is designed to operate as a standard '<tt><a
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1556href="#i_call">call</a></tt>' instruction in most regards. The primary
1557difference is that it establishes an association with a label, which is used by
1558the runtime library to unwind the stack.</p>
1559
1560<p>This instruction is used in languages with destructors to ensure that proper
1561cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
1562exception. Additionally, this is important for implementation of
1563'<tt>catch</tt>' clauses in high-level languages that support them.</p>
1564
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1565<h5>Example:</h5>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1566<pre>
1567 %retval = invoke int %Test(int 15) to label %Continue
Chris Lattner76b8a332006-05-14 18:23:06 +0000[diff] [blame]1568 unwind label %TestCleanup <i>; {int}:retval set</i>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]1569 %retval = invoke <a href="#callingconv">coldcc</a> int %Test(int 15) to label %Continue
Chris Lattner76b8a332006-05-14 18:23:06 +0000[diff] [blame]1570 unwind label %TestCleanup <i>; {int}:retval set</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1571</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1572</div>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1573
1574
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]1575<!-- _______________________________________________________________________ -->
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1576
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1577<div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
1578Instruction</a> </div>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1579
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1580<div class="doc_text">
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1581
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]1582<h5>Syntax:</h5>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1583<pre>
1584 unwind
1585</pre>
1586
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]1587<h5>Overview:</h5>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1588
1589<p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
1590at the first callee in the dynamic call stack which used an <a
1591href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call. This is
1592primarily used to implement exception handling.</p>
1593
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]1594<h5>Semantics:</h5>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1595
1596<p>The '<tt>unwind</tt>' intrinsic causes execution of the current function to
1597immediately halt. The dynamic call stack is then searched for the first <a
1598href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack. Once found,
1599execution continues at the "exceptional" destination block specified by the
1600<tt>invoke</tt> instruction. If there is no <tt>invoke</tt> instruction in the
1601dynamic call chain, undefined behavior results.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1602</div>
Chris Lattner35eca582004-10-16 18:04:13 +0000[diff] [blame]1603
1604<!-- _______________________________________________________________________ -->
1605
1606<div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
1607Instruction</a> </div>
1608
1609<div class="doc_text">
1610
1611<h5>Syntax:</h5>
1612<pre>
1613 unreachable
1614</pre>
1615
1616<h5>Overview:</h5>
1617
1618<p>The '<tt>unreachable</tt>' instruction has no defined semantics. This
1619instruction is used to inform the optimizer that a particular portion of the
1620code is not reachable. This can be used to indicate that the code after a
1621no-return function cannot be reached, and other facts.</p>
1622
1623<h5>Semantics:</h5>
1624
1625<p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
1626</div>
1627
1628
1629
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1630<!-- ======================================================================= -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1631<div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1632<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1633<p>Binary operators are used to do most of the computation in a
1634program. They require two operands, execute an operation on them, and
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1635produce a single value. The operands might represent
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]1636multiple data, as is the case with the <a href="#t_packed">packed</a> data type.
1637The result value of a binary operator is not
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1638necessarily the same type as its operands.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1639<p>There are several different binary operators:</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1640</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1641<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1642<div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>'
1643Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1644<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1645<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1646<pre> &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1647</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1648<h5>Overview:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1649<p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1650<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1651<p>The two arguments to the '<tt>add</tt>' instruction must be either <a
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]1652 href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> values.
1653 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1654Both arguments must have identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1655<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1656<p>The value produced is the integer or floating point sum of the two
1657operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1658<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1659<pre> &lt;result&gt; = add int 4, %var <i>; yields {int}:result = 4 + %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1660</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1661</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1662<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1663<div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>'
1664Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1665<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1666<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1667<pre> &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1668</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1669<h5>Overview:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1670<p>The '<tt>sub</tt>' instruction returns the difference of its two
1671operands.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1672<p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>'
1673instruction present in most other intermediate representations.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1674<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1675<p>The two arguments to the '<tt>sub</tt>' instruction must be either <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1676 href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]1677values.
1678This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1679Both arguments must have identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1680<h5>Semantics:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1681<p>The value produced is the integer or floating point difference of
1682the two operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1683<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1684<pre> &lt;result&gt; = sub int 4, %var <i>; yields {int}:result = 4 - %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1685 &lt;result&gt; = sub int 0, %val <i>; yields {int}:result = -%var</i>
1686</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1687</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1688<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1689<div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>'
1690Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1691<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1692<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1693<pre> &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1694</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1695<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1696<p>The '<tt>mul</tt>' instruction returns the product of its two
1697operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1698<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1699<p>The two arguments to the '<tt>mul</tt>' instruction must be either <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1700 href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
Chris Lattnera58561b2004-08-12 19:12:28 +0000[diff] [blame]1701values.
1702This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1703Both arguments must have identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1704<h5>Semantics:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1705<p>The value produced is the integer or floating point product of the
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1706two operands.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1707<p>There is no signed vs unsigned multiplication. The appropriate
1708action is taken based on the type of the operand.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1709<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1710<pre> &lt;result&gt; = mul int 4, %var <i>; yields {int}:result = 4 * %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1711</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1712</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1713<!-- _______________________________________________________________________ -->
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1714<div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
1715</a></div>
1716<div class="doc_text">
1717<h5>Syntax:</h5>
1718<pre> &lt;result&gt; = udiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
1719</pre>
1720<h5>Overview:</h5>
1721<p>The '<tt>udiv</tt>' instruction returns the quotient of its two
1722operands.</p>
1723<h5>Arguments:</h5>
1724<p>The two arguments to the '<tt>udiv</tt>' instruction must be
1725<a href="#t_integer">integer</a> values. Both arguments must have identical
1726types. This instruction can also take <a href="#t_packed">packed</a> versions
1727of the values in which case the elements must be integers.</p>
1728<h5>Semantics:</h5>
1729<p>The value produced is the unsigned integer quotient of the two operands. This
1730instruction always performs an unsigned division operation, regardless of
1731whether the arguments are unsigned or not.</p>
1732<h5>Example:</h5>
1733<pre> &lt;result&gt; = udiv uint 4, %var <i>; yields {uint}:result = 4 / %var</i>
1734</pre>
1735</div>
1736<!-- _______________________________________________________________________ -->
1737<div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
1738</a> </div>
1739<div class="doc_text">
1740<h5>Syntax:</h5>
1741<pre> &lt;result&gt; = sdiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
1742</pre>
1743<h5>Overview:</h5>
1744<p>The '<tt>sdiv</tt>' instruction returns the quotient of its two
1745operands.</p>
1746<h5>Arguments:</h5>
1747<p>The two arguments to the '<tt>sdiv</tt>' instruction must be
1748<a href="#t_integer">integer</a> values. Both arguments must have identical
1749types. This instruction can also take <a href="#t_packed">packed</a> versions
1750of the values in which case the elements must be integers.</p>
1751<h5>Semantics:</h5>
1752<p>The value produced is the signed integer quotient of the two operands. This
1753instruction always performs a signed division operation, regardless of whether
1754the arguments are signed or not.</p>
1755<h5>Example:</h5>
1756<pre> &lt;result&gt; = sdiv int 4, %var <i>; yields {int}:result = 4 / %var</i>
1757</pre>
1758</div>
1759<!-- _______________________________________________________________________ -->
1760<div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1761Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1762<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1763<h5>Syntax:</h5>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1764<pre> &lt;result&gt; = fdiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1765</pre>
1766<h5>Overview:</h5>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1767<p>The '<tt>fdiv</tt>' instruction returns the quotient of its two
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1768operands.</p>
1769<h5>Arguments:</h5>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1770<p>The two arguments to the '<tt>div</tt>' instruction must be
1771<a href="#t_floating">floating point</a> values. Both arguments must have
1772identical types. This instruction can also take <a href="#t_packed">packed</a>
1773versions of the values in which case the elements must be floating point.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1774<h5>Semantics:</h5>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1775<p>The value produced is the floating point quotient of the two operands.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1776<h5>Example:</h5>
Reid Spencer1628cec2006-10-26 06:15:43 +0000[diff] [blame]1777<pre> &lt;result&gt; = fdiv float 4.0, %var <i>; yields {float}:result = 4.0 / %var</i>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1778</pre>
1779</div>
1780<!-- _______________________________________________________________________ -->
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1781<div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
1782</div>
1783<div class="doc_text">
1784<h5>Syntax:</h5>
1785<pre> &lt;result&gt; = urem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
1786</pre>
1787<h5>Overview:</h5>
1788<p>The '<tt>urem</tt>' instruction returns the remainder from the
1789unsigned division of its two arguments.</p>
1790<h5>Arguments:</h5>
1791<p>The two arguments to the '<tt>urem</tt>' instruction must be
1792<a href="#t_integer">integer</a> values. Both arguments must have identical
1793types.</p>
1794<h5>Semantics:</h5>
1795<p>This instruction returns the unsigned integer <i>remainder</i> of a division.
1796This instruction always performs an unsigned division to get the remainder,
1797regardless of whether the arguments are unsigned or not.</p>
1798<h5>Example:</h5>
1799<pre> &lt;result&gt; = urem uint 4, %var <i>; yields {uint}:result = 4 % %var</i>
1800</pre>
1801
1802</div>
1803<!-- _______________________________________________________________________ -->
1804<div class="doc_subsubsection"> <a name="i_srem">'<tt>srem</tt>'
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1805Instruction</a> </div>
1806<div class="doc_text">
1807<h5>Syntax:</h5>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1808<pre> &lt;result&gt; = srem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1809</pre>
1810<h5>Overview:</h5>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1811<p>The '<tt>srem</tt>' instruction returns the remainder from the
1812signed division of its two operands.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1813<h5>Arguments:</h5>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1814<p>The two arguments to the '<tt>srem</tt>' instruction must be
1815<a href="#t_integer">integer</a> values. Both arguments must have identical
1816types.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1817<h5>Semantics:</h5>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1818<p>This instruction returns the <i>remainder</i> of a division (where the result
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1819has the same sign as the divisor), not the <i>modulus</i> (where the
1820result has the same sign as the dividend) of a value. For more
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]1821information about the difference, see <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1822 href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
1823Math Forum</a>.</p>
1824<h5>Example:</h5>
Reid Spencer0a783f72006-11-02 01:53:59 +0000[diff] [blame]1825<pre> &lt;result&gt; = srem int 4, %var <i>; yields {int}:result = 4 % %var</i>
1826</pre>
1827
1828</div>
1829<!-- _______________________________________________________________________ -->
1830<div class="doc_subsubsection"> <a name="i_frem">'<tt>frem</tt>'
1831Instruction</a> </div>
1832<div class="doc_text">
1833<h5>Syntax:</h5>
1834<pre> &lt;result&gt; = frem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
1835</pre>
1836<h5>Overview:</h5>
1837<p>The '<tt>frem</tt>' instruction returns the remainder from the
1838division of its two operands.</p>
1839<h5>Arguments:</h5>
1840<p>The two arguments to the '<tt>frem</tt>' instruction must be
1841<a href="#t_floating">floating point</a> values. Both arguments must have
1842identical types.</p>
1843<h5>Semantics:</h5>
1844<p>This instruction returns the <i>remainder</i> of a division.</p>
1845<h5>Example:</h5>
1846<pre> &lt;result&gt; = frem float 4.0, %var <i>; yields {float}:result = 4.0 % %var</i>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1847</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1848</div>
Robert Bocchino7b81c752006-02-17 21:18:08 +0000[diff] [blame]1849
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1850<!-- ======================================================================= -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1851<div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
1852Operations</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1853<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1854<p>Bitwise binary operators are used to do various forms of
1855bit-twiddling in a program. They are generally very efficient
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]1856instructions and can commonly be strength reduced from other
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1857instructions. They require two operands, execute an operation on them,
1858and produce a single value. The resulting value of the bitwise binary
1859operators is always the same type as its first operand.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1860</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1861<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1862<div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
1863Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1864<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1865<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1866<pre> &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1867</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1868<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1869<p>The '<tt>and</tt>' instruction returns the bitwise logical and of
1870its two operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1871<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1872<p>The two arguments to the '<tt>and</tt>' instruction must be <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1873 href="#t_integral">integral</a> values. Both arguments must have
1874identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1875<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1876<p>The truth table used for the '<tt>and</tt>' instruction is:</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1877<p> </p>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]1878<div style="align: center">
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1879<table border="1" cellspacing="0" cellpadding="4">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1880 <tbody>
1881 <tr>
1882 <td>In0</td>
1883 <td>In1</td>
1884 <td>Out</td>
1885 </tr>
1886 <tr>
1887 <td>0</td>
1888 <td>0</td>
1889 <td>0</td>
1890 </tr>
1891 <tr>
1892 <td>0</td>
1893 <td>1</td>
1894 <td>0</td>
1895 </tr>
1896 <tr>
1897 <td>1</td>
1898 <td>0</td>
1899 <td>0</td>
1900 </tr>
1901 <tr>
1902 <td>1</td>
1903 <td>1</td>
1904 <td>1</td>
1905 </tr>
1906 </tbody>
1907</table>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]1908</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1909<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1910<pre> &lt;result&gt; = and int 4, %var <i>; yields {int}:result = 4 &amp; %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1911 &lt;result&gt; = and int 15, 40 <i>; yields {int}:result = 8</i>
1912 &lt;result&gt; = and int 4, 8 <i>; yields {int}:result = 0</i>
1913</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1914</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1915<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1916<div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1917<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1918<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1919<pre> &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1920</pre>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1921<h5>Overview:</h5>
1922<p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
1923or of its two operands.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1924<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1925<p>The two arguments to the '<tt>or</tt>' instruction must be <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1926 href="#t_integral">integral</a> values. Both arguments must have
1927identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1928<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1929<p>The truth table used for the '<tt>or</tt>' instruction is:</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1930<p> </p>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]1931<div style="align: center">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1932<table border="1" cellspacing="0" cellpadding="4">
1933 <tbody>
1934 <tr>
1935 <td>In0</td>
1936 <td>In1</td>
1937 <td>Out</td>
1938 </tr>
1939 <tr>
1940 <td>0</td>
1941 <td>0</td>
1942 <td>0</td>
1943 </tr>
1944 <tr>
1945 <td>0</td>
1946 <td>1</td>
1947 <td>1</td>
1948 </tr>
1949 <tr>
1950 <td>1</td>
1951 <td>0</td>
1952 <td>1</td>
1953 </tr>
1954 <tr>
1955 <td>1</td>
1956 <td>1</td>
1957 <td>1</td>
1958 </tr>
1959 </tbody>
1960</table>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]1961</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1962<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1963<pre> &lt;result&gt; = or int 4, %var <i>; yields {int}:result = 4 | %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1964 &lt;result&gt; = or int 15, 40 <i>; yields {int}:result = 47</i>
1965 &lt;result&gt; = or int 4, 8 <i>; yields {int}:result = 12</i>
1966</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1967</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1968<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1969<div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
1970Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1971<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1972<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1973<pre> &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1974</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1975<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1976<p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
1977or of its two operands. The <tt>xor</tt> is used to implement the
1978"one's complement" operation, which is the "~" operator in C.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1979<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1980<p>The two arguments to the '<tt>xor</tt>' instruction must be <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1981 href="#t_integral">integral</a> values. Both arguments must have
1982identical types.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]1983<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]1984<p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1985<p> </p>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]1986<div style="align: center">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1987<table border="1" cellspacing="0" cellpadding="4">
1988 <tbody>
1989 <tr>
1990 <td>In0</td>
1991 <td>In1</td>
1992 <td>Out</td>
1993 </tr>
1994 <tr>
1995 <td>0</td>
1996 <td>0</td>
1997 <td>0</td>
1998 </tr>
1999 <tr>
2000 <td>0</td>
2001 <td>1</td>
2002 <td>1</td>
2003 </tr>
2004 <tr>
2005 <td>1</td>
2006 <td>0</td>
2007 <td>1</td>
2008 </tr>
2009 <tr>
2010 <td>1</td>
2011 <td>1</td>
2012 <td>0</td>
2013 </tr>
2014 </tbody>
2015</table>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]2016</div>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2017<p> </p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2018<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2019<pre> &lt;result&gt; = xor int 4, %var <i>; yields {int}:result = 4 ^ %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2020 &lt;result&gt; = xor int 15, 40 <i>; yields {int}:result = 39</i>
2021 &lt;result&gt; = xor int 4, 8 <i>; yields {int}:result = 12</i>
Chris Lattner27f71f22003-09-03 00:41:47 +0000[diff] [blame]2022 &lt;result&gt; = xor int %V, -1 <i>; yields {int}:result = ~%V</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2023</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2024</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2025<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2026<div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
2027Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2028<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2029<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2030<pre> &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2031</pre>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2032<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2033<p>The '<tt>shl</tt>' instruction returns the first operand shifted to
2034the left a specified number of bits.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2035<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2036<p>The first argument to the '<tt>shl</tt>' instruction must be an <a
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2037 href="#t_integer">integer</a> type. The second argument must be an '<tt>ubyte</tt>'
2038type.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2039<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2040<p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2041<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2042<pre> &lt;result&gt; = shl int 4, ubyte %var <i>; yields {int}:result = 4 &lt;&lt; %var</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2043 &lt;result&gt; = shl int 4, ubyte 2 <i>; yields {int}:result = 16</i>
2044 &lt;result&gt; = shl int 1, ubyte 10 <i>; yields {int}:result = 1024</i>
2045</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2046</div>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2047<!-- _______________________________________________________________________ -->
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2048<div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2049Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2050<div class="doc_text">
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2051<h5>Syntax:</h5>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2052<pre> &lt;result&gt; = lshr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt; <i>; yields {ty}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2053</pre>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2054
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2055<h5>Overview:</h5>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2056<p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
2057operand shifted to the right a specified number of bits.</p>
2058
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2059<h5>Arguments:</h5>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2060<p>The first argument to the '<tt>lshr</tt>' instruction must be an <a
2061 href="#t_integer">integer</a> type. The second argument must be an '<tt>ubyte</tt>' type.</p>
2062
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2063<h5>Semantics:</h5>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2064<p>This instruction always performs a logical shift right operation, regardless
2065of whether the arguments are unsigned or not. The <tt>var2</tt> most significant
2066bits will be filled with zero bits after the shift.</p>
2067
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2068<h5>Example:</h5>
Reid Spencer3822ff52006-11-08 06:47:33 +0000[diff] [blame]2069<pre>
2070 &lt;result&gt; = lshr uint 4, ubyte 1 <i>; yields {uint}:result = 2</i>
2071 &lt;result&gt; = lshr int 4, ubyte 2 <i>; yields {uint}:result = 1</i>
2072 &lt;result&gt; = lshr sbyte 4, ubyte 3 <i>; yields {sbyte}:result = 0</i>
2073 &lt;result&gt; = lshr sbyte -2, ubyte 1 <i>; yields {sbyte}:result = 0x7FFFFFFF </i>
2074</pre>
2075</div>
2076
2077<!-- ======================================================================= -->
2078<div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
2079Instruction</a> </div>
2080<div class="doc_text">
2081
2082<h5>Syntax:</h5>
2083<pre> &lt;result&gt; = ashr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt; <i>; yields {ty}:result</i>
2084</pre>
2085
2086<h5>Overview:</h5>
2087<p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
2088operand shifted to the right a specified number of bits.</p>
2089
2090<h5>Arguments:</h5>
2091<p>The first argument to the '<tt>ashr</tt>' instruction must be an
2092<a href="#t_integer">integer</a> type. The second argument must be an
2093'<tt>ubyte</tt>' type.</p>
2094
2095<h5>Semantics:</h5>
2096<p>This instruction always performs an arithmetic shift right operation,
2097regardless of whether the arguments are signed or not. The <tt>var2</tt> most
2098significant bits will be filled with the sign bit of <tt>var1</tt>.</p>
2099
2100<h5>Example:</h5>
2101<pre>
2102 &lt;result&gt; = ashr uint 4, ubyte 1 <i>; yields {uint}:result = 2</i>
2103 &lt;result&gt; = ashr int 4, ubyte 2 <i>; yields {int}:result = 1</i>
2104 &lt;result&gt; = ashr ubyte 4, ubyte 3 <i>; yields {ubyte}:result = 0</i>
2105 &lt;result&gt; = ashr sbyte -2, ubyte 1 <i>; yields {sbyte}:result = -1</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2106</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2107</div>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2108
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2109<!-- ======================================================================= -->
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2110<div class="doc_subsection">
Chris Lattner3df241e2006-04-08 23:07:04 +0000[diff] [blame]2111 <a name="vectorops">Vector Operations</a>
2112</div>
2113
2114<div class="doc_text">
2115
2116<p>LLVM supports several instructions to represent vector operations in a
2117target-independent manner. This instructions cover the element-access and
2118vector-specific operations needed to process vectors effectively. While LLVM
2119does directly support these vector operations, many sophisticated algorithms
2120will want to use target-specific intrinsics to take full advantage of a specific
2121target.</p>
2122
2123</div>
2124
2125<!-- _______________________________________________________________________ -->
2126<div class="doc_subsubsection">
2127 <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
2128</div>
2129
2130<div class="doc_text">
2131
2132<h5>Syntax:</h5>
2133
2134<pre>
2135 &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, uint &lt;idx&gt; <i>; yields &lt;ty&gt;</i>
2136</pre>
2137
2138<h5>Overview:</h5>
2139
2140<p>
2141The '<tt>extractelement</tt>' instruction extracts a single scalar
2142element from a packed vector at a specified index.
2143</p>
2144
2145
2146<h5>Arguments:</h5>
2147
2148<p>
2149The first operand of an '<tt>extractelement</tt>' instruction is a
2150value of <a href="#t_packed">packed</a> type. The second operand is
2151an index indicating the position from which to extract the element.
2152The index may be a variable.</p>
2153
2154<h5>Semantics:</h5>
2155
2156<p>
2157The result is a scalar of the same type as the element type of
2158<tt>val</tt>. Its value is the value at position <tt>idx</tt> of
2159<tt>val</tt>. If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
2160results are undefined.
2161</p>
2162
2163<h5>Example:</h5>
2164
2165<pre>
2166 %result = extractelement &lt;4 x int&gt; %vec, uint 0 <i>; yields int</i>
2167</pre>
2168</div>
2169
2170
2171<!-- _______________________________________________________________________ -->
2172<div class="doc_subsubsection">
2173 <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
2174</div>
2175
2176<div class="doc_text">
2177
2178<h5>Syntax:</h5>
2179
2180<pre>
2181 &lt;result&gt; = insertelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt, uint &lt;idx&gt; <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
2182</pre>
2183
2184<h5>Overview:</h5>
2185
2186<p>
2187The '<tt>insertelement</tt>' instruction inserts a scalar
2188element into a packed vector at a specified index.
2189</p>
2190
2191
2192<h5>Arguments:</h5>
2193
2194<p>
2195The first operand of an '<tt>insertelement</tt>' instruction is a
2196value of <a href="#t_packed">packed</a> type. The second operand is a
2197scalar value whose type must equal the element type of the first
2198operand. The third operand is an index indicating the position at
2199which to insert the value. The index may be a variable.</p>
2200
2201<h5>Semantics:</h5>
2202
2203<p>
2204The result is a packed vector of the same type as <tt>val</tt>. Its
2205element values are those of <tt>val</tt> except at position
2206<tt>idx</tt>, where it gets the value <tt>elt</tt>. If <tt>idx</tt>
2207exceeds the length of <tt>val</tt>, the results are undefined.
2208</p>
2209
2210<h5>Example:</h5>
2211
2212<pre>
2213 %result = insertelement &lt;4 x int&gt; %vec, int 1, uint 0 <i>; yields &lt;4 x int&gt;</i>
2214</pre>
2215</div>
2216
2217<!-- _______________________________________________________________________ -->
2218<div class="doc_subsubsection">
2219 <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
2220</div>
2221
2222<div class="doc_text">
2223
2224<h5>Syntax:</h5>
2225
2226<pre>
2227 &lt;result&gt; = shufflevector &lt;n x &lt;ty&gt;&gt; &lt;v1&gt;, &lt;n x &lt;ty&gt;&gt; &lt;v2&gt;, &lt;n x uint&gt; &lt;mask&gt; <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
2228</pre>
2229
2230<h5>Overview:</h5>
2231
2232<p>
2233The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
2234from two input vectors, returning a vector of the same type.
2235</p>
2236
2237<h5>Arguments:</h5>
2238
2239<p>
2240The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
2241with types that match each other and types that match the result of the
2242instruction. The third argument is a shuffle mask, which has the same number
2243of elements as the other vector type, but whose element type is always 'uint'.
2244</p>
2245
2246<p>
2247The shuffle mask operand is required to be a constant vector with either
2248constant integer or undef values.
2249</p>
2250
2251<h5>Semantics:</h5>
2252
2253<p>
2254The elements of the two input vectors are numbered from left to right across
2255both of the vectors. The shuffle mask operand specifies, for each element of
2256the result vector, which element of the two input registers the result element
2257gets. The element selector may be undef (meaning "don't care") and the second
2258operand may be undef if performing a shuffle from only one vector.
2259</p>
2260
2261<h5>Example:</h5>
2262
2263<pre>
2264 %result = shufflevector &lt;4 x int&gt; %v1, &lt;4 x int&gt; %v2,
2265 &lt;4 x uint&gt; &lt;uint 0, uint 4, uint 1, uint 5&gt; <i>; yields &lt;4 x int&gt;</i>
2266 %result = shufflevector &lt;4 x int&gt; %v1, &lt;4 x int&gt; undef,
2267 &lt;4 x uint&gt; &lt;uint 0, uint 1, uint 2, uint 3&gt; <i>; yields &lt;4 x int&gt;</i> - Identity shuffle.
2268</pre>
2269</div>
2270
Tanya Lattner09474292006-04-14 19:24:33 +0000[diff] [blame]2271
Chris Lattner3df241e2006-04-08 23:07:04 +0000[diff] [blame]2272<!-- ======================================================================= -->
2273<div class="doc_subsection">
Chris Lattner884a9702006-08-15 00:45:58 +0000[diff] [blame]2274 <a name="memoryops">Memory Access and Addressing Operations</a>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2275</div>
2276
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2277<div class="doc_text">
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2278
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2279<p>A key design point of an SSA-based representation is how it
2280represents memory. In LLVM, no memory locations are in SSA form, which
2281makes things very simple. This section describes how to read, write,
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]2282allocate, and free memory in LLVM.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2283
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2284</div>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2285
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2286<!-- _______________________________________________________________________ -->
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2287<div class="doc_subsubsection">
2288 <a name="i_malloc">'<tt>malloc</tt>' Instruction</a>
2289</div>
2290
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2291<div class="doc_text">
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2292
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2293<h5>Syntax:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2294
2295<pre>
2296 &lt;result&gt; = malloc &lt;type&gt;[, uint &lt;NumElements&gt;][, align &lt;alignment&gt;] <i>; yields {type*}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2297</pre>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2298
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2299<h5>Overview:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2300
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2301<p>The '<tt>malloc</tt>' instruction allocates memory from the system
2302heap and returns a pointer to it.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2303
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2304<h5>Arguments:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2305
2306<p>The '<tt>malloc</tt>' instruction allocates
2307<tt>sizeof(&lt;type&gt;)*NumElements</tt>
John Criswell6e4ca612004-02-24 16:13:56 +0000[diff] [blame]2308bytes of memory from the operating system and returns a pointer of the
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2309appropriate type to the program. If "NumElements" is specified, it is the
2310number of elements allocated. If an alignment is specified, the value result
2311of the allocation is guaranteed to be aligned to at least that boundary. If
2312not specified, or if zero, the target can choose to align the allocation on any
2313convenient boundary.</p>
2314
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2315<p>'<tt>type</tt>' must be a sized type.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2316
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2317<h5>Semantics:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2318
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2319<p>Memory is allocated using the system "<tt>malloc</tt>" function, and
2320a pointer is returned.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2321
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2322<h5>Example:</h5>
2323
2324<pre>
2325 %array = malloc [4 x ubyte ] <i>; yields {[%4 x ubyte]*}:array</i>
2326
2327 %size = <a href="#i_add">add</a> uint 2, 2 <i>; yields {uint}:size = uint 4</i>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2328 %array1 = malloc ubyte, uint 4 <i>; yields {ubyte*}:array1</i>
2329 %array2 = malloc [12 x ubyte], uint %size <i>; yields {[12 x ubyte]*}:array2</i>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2330 %array3 = malloc int, uint 4, align 1024 <i>; yields {int*}:array3</i>
2331 %array4 = malloc int, align 1024 <i>; yields {int*}:array4</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2332</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2333</div>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2334
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2335<!-- _______________________________________________________________________ -->
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2336<div class="doc_subsubsection">
2337 <a name="i_free">'<tt>free</tt>' Instruction</a>
2338</div>
2339
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2340<div class="doc_text">
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2341
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2342<h5>Syntax:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2343
2344<pre>
2345 free &lt;type&gt; &lt;value&gt; <i>; yields {void}</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2346</pre>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2347
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2348<h5>Overview:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2349
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2350<p>The '<tt>free</tt>' instruction returns memory back to the unused
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]2351memory heap to be reallocated in the future.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2352
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2353<h5>Arguments:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2354
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2355<p>'<tt>value</tt>' shall be a pointer value that points to a value
2356that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
2357instruction.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2358
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2359<h5>Semantics:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2360
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]2361<p>Access to the memory pointed to by the pointer is no longer defined
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2362after this instruction executes.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2363
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2364<h5>Example:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2365
2366<pre>
2367 %array = <a href="#i_malloc">malloc</a> [4 x ubyte] <i>; yields {[4 x ubyte]*}:array</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2368 free [4 x ubyte]* %array
2369</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2370</div>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2371
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2372<!-- _______________________________________________________________________ -->
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2373<div class="doc_subsubsection">
2374 <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
2375</div>
2376
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2377<div class="doc_text">
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2378
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2379<h5>Syntax:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2380
2381<pre>
2382 &lt;result&gt; = alloca &lt;type&gt;[, uint &lt;NumElements&gt;][, align &lt;alignment&gt;] <i>; yields {type*}:result</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2383</pre>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2384
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2385<h5>Overview:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2386
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2387<p>The '<tt>alloca</tt>' instruction allocates memory on the current
2388stack frame of the procedure that is live until the current function
2389returns to its caller.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2390
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2391<h5>Arguments:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2392
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]2393<p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2394bytes of memory on the runtime stack, returning a pointer of the
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2395appropriate type to the program. If "NumElements" is specified, it is the
2396number of elements allocated. If an alignment is specified, the value result
2397of the allocation is guaranteed to be aligned to at least that boundary. If
2398not specified, or if zero, the target can choose to align the allocation on any
2399convenient boundary.</p>
2400
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2401<p>'<tt>type</tt>' may be any sized type.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2402
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2403<h5>Semantics:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2404
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]2405<p>Memory is allocated; a pointer is returned. '<tt>alloca</tt>'d
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2406memory is automatically released when the function returns. The '<tt>alloca</tt>'
2407instruction is commonly used to represent automatic variables that must
2408have an address available. When the function returns (either with the <tt><a
John Criswelldae2e932005-05-12 16:55:34 +0000[diff] [blame]2409 href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2410instructions), the memory is reclaimed.</p>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2411
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2412<h5>Example:</h5>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2413
2414<pre>
2415 %ptr = alloca int <i>; yields {int*}:ptr</i>
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2416 %ptr = alloca int, uint 4 <i>; yields {int*}:ptr</i>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2417 %ptr = alloca int, uint 4, align 1024 <i>; yields {int*}:ptr</i>
2418 %ptr = alloca int, align 1024 <i>; yields {int*}:ptr</i>
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2419</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2420</div>
Chris Lattner2cbdc452005-11-06 08:02:57 +0000[diff] [blame]2421
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2422<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2423<div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
2424Instruction</a> </div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2425<div class="doc_text">
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2426<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2427<pre> &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;<br> &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;<br></pre>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2428<h5>Overview:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2429<p>The '<tt>load</tt>' instruction is used to read from memory.</p>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2430<h5>Arguments:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2431<p>The argument to the '<tt>load</tt>' instruction specifies the memory
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]2432address from which to load. The pointer must point to a <a
Chris Lattnere53e5082004-06-03 22:57:15 +0000[diff] [blame]2433 href="#t_firstclass">first class</a> type. If the <tt>load</tt> is
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]2434marked as <tt>volatile</tt>, then the optimizer is not allowed to modify
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2435the number or order of execution of this <tt>load</tt> with other
2436volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
2437instructions. </p>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2438<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2439<p>The location of memory pointed to is loaded.</p>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2440<h5>Examples:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2441<pre> %ptr = <a href="#i_alloca">alloca</a> int <i>; yields {int*}:ptr</i>
2442 <a
2443 href="#i_store">store</a> int 3, int* %ptr <i>; yields {void}</i>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2444 %val = load int* %ptr <i>; yields {int}:val = int 3</i>
2445</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2446</div>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2447<!-- _______________________________________________________________________ -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2448<div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
2449Instruction</a> </div>
Reid Spencer035ab572006-11-09 21:18:01 +0000[diff] [blame]2450<div class="doc_text">
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2451<h5>Syntax:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2452<pre> store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt; <i>; yields {void}</i>
Chris Lattnerf0651072003-09-08 18:27:49 +0000[diff] [blame]2453 volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt; <i>; yields {void}</i>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2454</pre>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2455<h5>Overview:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2456<p>The '<tt>store</tt>' instruction is used to write to memory.</p>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2457<h5>Arguments:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2458<p>There are two arguments to the '<tt>store</tt>' instruction: a value
John Criswell0ec250c2005-10-24 16:17:18 +0000[diff] [blame]2459to store and an address in which to store it. The type of the '<tt>&lt;pointer&gt;</tt>'
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2460operand must be a pointer to the type of the '<tt>&lt;value&gt;</tt>'
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]2461operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2462optimizer is not allowed to modify the number or order of execution of
2463this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
2464 href="#i_store">store</a></tt> instructions.</p>
2465<h5>Semantics:</h5>
2466<p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
2467at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2468<h5>Example:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2469<pre> %ptr = <a href="#i_alloca">alloca</a> int <i>; yields {int*}:ptr</i>
2470 <a
2471 href="#i_store">store</a> int 3, int* %ptr <i>; yields {void}</i>
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2472 %val = load int* %ptr <i>; yields {int}:val = int 3</i>
2473</pre>
Reid Spencer47ce1792006-11-09 21:15:49 +0000[diff] [blame]2474</div>
2475
Chris Lattner2b7d3202002-05-06 03:03:22 +0000[diff] [blame]2476<!-- _______________________________________________________________________ -->
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2477<div class="doc_subsubsection">
2478 <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
2479</div>
2480
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2481<div class="doc_text">
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2482<h5>Syntax:</h5>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2483<pre>
2484 &lt;result&gt; = getelementptr &lt;ty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
2485</pre>
2486
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2487<h5>Overview:</h5>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2488
2489<p>
2490The '<tt>getelementptr</tt>' instruction is used to get the address of a
2491subelement of an aggregate data structure.</p>
2492
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2493<h5>Arguments:</h5>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2494
Reid Spencer85f5b5b2006-12-04 21:29:24 +0000[diff] [blame]2495<p>This instruction takes a list of integer operands that indicate what
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2496elements of the aggregate object to index to. The actual types of the arguments
2497provided depend on the type of the first pointer argument. The
2498'<tt>getelementptr</tt>' instruction is used to index down through the type
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]2499levels of a structure or to a specific index in an array. When indexing into a
Reid Spencer42ddd842006-12-03 16:53:48 +0000[diff] [blame]2500structure, only <tt>uint</tt> integer constants are allowed. When indexing
Reid Spencer85f5b5b2006-12-04 21:29:24 +0000[diff] [blame]2501into an array or pointer, only integers of 32 or 64 bits are allowed, and will
2502be sign extended to 64-bit values.</p>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2503
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2504<p>For example, let's consider a C code fragment and how it gets
2505compiled to LLVM:</p>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2506
2507<pre>
2508 struct RT {
2509 char A;
2510 int B[10][20];
2511 char C;
2512 };
2513 struct ST {
2514 int X;
2515 double Y;
2516 struct RT Z;
2517 };
2518
2519 int *foo(struct ST *s) {
2520 return &amp;s[1].Z.B[5][13];
2521 }
2522</pre>
2523
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2524<p>The LLVM code generated by the GCC frontend is:</p>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2525
2526<pre>
2527 %RT = type { sbyte, [10 x [20 x int]], sbyte }
2528 %ST = type { int, double, %RT }
2529
Brian Gaeke7283e7c2004-07-02 21:08:14 +0000[diff] [blame]2530 implementation
2531
2532 int* %foo(%ST* %s) {
2533 entry:
2534 %reg = getelementptr %ST* %s, int 1, uint 2, uint 1, int 5, int 13
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2535 ret int* %reg
2536 }
2537</pre>
2538
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2539<h5>Semantics:</h5>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2540
2541<p>The index types specified for the '<tt>getelementptr</tt>' instruction depend
John Criswellc1f786c2005-05-13 22:25:59 +0000[diff] [blame]2542on the pointer type that is being indexed into. <a href="#t_pointer">Pointer</a>
Reid Spencer85f5b5b2006-12-04 21:29:24 +0000[diff] [blame]2543and <a href="#t_array">array</a> types can use a 32-bit or 64-bit
Reid Spencer42ddd842006-12-03 16:53:48 +0000[diff] [blame]2544<a href="#t_integer">integer</a> type but the value will always be sign extended
2545to 64-bits. <a href="#t_struct">Structure</a> types, require <tt>uint</tt>
2546<b>constants</b>.</p>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2547
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2548<p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2549type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ int, double, %RT
2550}</tt>' type, a structure. The second index indexes into the third element of
2551the structure, yielding a '<tt>%RT</tt>' = '<tt>{ sbyte, [10 x [20 x int]],
2552sbyte }</tt>' type, another structure. The third index indexes into the second
2553element of the structure, yielding a '<tt>[10 x [20 x int]]</tt>' type, an
2554array. The two dimensions of the array are subscripted into, yielding an
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]2555'<tt>int</tt>' type. The '<tt>getelementptr</tt>' instruction returns a pointer
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2556to this element, thus computing a value of '<tt>int*</tt>' type.</p>
2557
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2558<p>Note that it is perfectly legal to index partially through a
2559structure, returning a pointer to an inner element. Because of this,
2560the LLVM code for the given testcase is equivalent to:</p>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2561
2562<pre>
Chris Lattnerd4f6b172005-03-07 22:13:59 +0000[diff] [blame]2563 int* %foo(%ST* %s) {
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2564 %t1 = getelementptr %ST* %s, int 1 <i>; yields %ST*:%t1</i>
2565 %t2 = getelementptr %ST* %t1, int 0, uint 2 <i>; yields %RT*:%t2</i>
2566 %t3 = getelementptr %RT* %t2, int 0, uint 1 <i>; yields [10 x [20 x int]]*:%t3</i>
2567 %t4 = getelementptr [10 x [20 x int]]* %t3, int 0, int 5 <i>; yields [20 x int]*:%t4</i>
2568 %t5 = getelementptr [20 x int]* %t4, int 0, int 13 <i>; yields int*:%t5</i>
2569 ret int* %t5
2570 }
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]2571</pre>
Chris Lattnere67a9512005-06-24 17:22:57 +0000[diff] [blame]2572
2573<p>Note that it is undefined to access an array out of bounds: array and
2574pointer indexes must always be within the defined bounds of the array type.
2575The one exception for this rules is zero length arrays. These arrays are
2576defined to be accessible as variable length arrays, which requires access
2577beyond the zero'th element.</p>
2578
Chris Lattner884a9702006-08-15 00:45:58 +0000[diff] [blame]2579<p>The getelementptr instruction is often confusing. For some more insight
2580into how it works, see <a href="GetElementPtr.html">the getelementptr
2581FAQ</a>.</p>
2582
Chris Lattner7faa8832002-04-14 06:13:44 +0000[diff] [blame]2583<h5>Example:</h5>
Chris Lattnere67a9512005-06-24 17:22:57 +0000[diff] [blame]2584
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2585<pre>
2586 <i>; yields [12 x ubyte]*:aptr</i>
2587 %aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, uint 1
2588</pre>
Chris Lattnerf74d5c72004-04-05 01:30:49 +0000[diff] [blame]2589</div>
Reid Spencer47ce1792006-11-09 21:15:49 +0000[diff] [blame]2590
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]2591<!-- ======================================================================= -->
Reid Spencer2fd21e62006-11-08 01:18:52 +0000[diff] [blame]2592<div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2593</div>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2594<div class="doc_text">
Reid Spencer2fd21e62006-11-08 01:18:52 +0000[diff] [blame]2595<p>The instructions in this category are the conversion instructions (casting)
2596which all take a single operand and a type. They perform various bit conversions
2597on the operand.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]2598</div>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2599
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]2600<!-- _______________________________________________________________________ -->
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2601<div class="doc_subsubsection">
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2602 <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
2603</div>
2604<div class="doc_text">
2605
2606<h5>Syntax:</h5>
2607<pre>
2608 &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2609</pre>
2610
2611<h5>Overview:</h5>
2612<p>
2613The '<tt>trunc</tt>' instruction truncates its operand to the type <tt>ty2</tt>.
2614</p>
2615
2616<h5>Arguments:</h5>
2617<p>
2618The '<tt>trunc</tt>' instruction takes a <tt>value</tt> to trunc, which must
2619be an <a href="#t_integer">integer</a> type, and a type that specifies the size
2620and type of the result, which must be an <a href="#t_integral">integral</a>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2621type. The bit size of <tt>value</tt> must be larger than the bit size of
2622<tt>ty2</tt>. Equal sized types are not allowed.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2623
2624<h5>Semantics:</h5>
2625<p>
2626The '<tt>trunc</tt>' instruction truncates the high order bits in <tt>value</tt>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2627and converts the remaining bits to <tt>ty2</tt>. Since the source size must be
2628larger than the destination size, <tt>trunc</tt> cannot be a <i>no-op cast</i>.
2629It will always truncate bits.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2630
2631<h5>Example:</h5>
2632<pre>
2633 %X = trunc int 257 to ubyte <i>; yields ubyte:1</i>
2634 %Y = trunc int 123 to bool <i>; yields bool:true</i>
2635</pre>
2636</div>
2637
2638<!-- _______________________________________________________________________ -->
2639<div class="doc_subsubsection">
2640 <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
2641</div>
2642<div class="doc_text">
2643
2644<h5>Syntax:</h5>
2645<pre>
2646 &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2647</pre>
2648
2649<h5>Overview:</h5>
2650<p>The '<tt>zext</tt>' instruction zero extends its operand to type
2651<tt>ty2</tt>.</p>
2652
2653
2654<h5>Arguments:</h5>
2655<p>The '<tt>zext</tt>' instruction takes a value to cast, which must be of
2656<a href="#t_integral">integral</a> type, and a type to cast it to, which must
2657also be of <a href="#t_integral">integral</a> type. The bit size of the
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2658<tt>value</tt> must be smaller than the bit size of the destination type,
2659<tt>ty2</tt>.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2660
2661<h5>Semantics:</h5>
2662<p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
2663bits until it reaches the size of the destination type, <tt>ty2</tt>. When the
2664the operand and the type are the same size, no bit filling is done and the
2665cast is considered a <i>no-op cast</i> because no bits change (only the type
2666changes).</p>
2667
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2668<p>When zero extending from bool, the result will alwasy be either 0 or 1.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2669
2670<h5>Example:</h5>
2671<pre>
2672 %X = zext int 257 to ulong <i>; yields ulong:257</i>
2673 %Y = zext bool true to int <i>; yields int:1</i>
2674</pre>
2675</div>
2676
2677<!-- _______________________________________________________________________ -->
2678<div class="doc_subsubsection">
2679 <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
2680</div>
2681<div class="doc_text">
2682
2683<h5>Syntax:</h5>
2684<pre>
2685 &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2686</pre>
2687
2688<h5>Overview:</h5>
2689<p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
2690
2691<h5>Arguments:</h5>
2692<p>
2693The '<tt>sext</tt>' instruction takes a value to cast, which must be of
2694<a href="#t_integral">integral</a> type, and a type to cast it to, which must
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2695also be of <a href="#t_integral">integral</a> type. The bit size of the
2696<tt>value</tt> must be smaller than the bit size of the destination type,
2697<tt>ty2</tt>.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2698
2699<h5>Semantics:</h5>
2700<p>
2701The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
2702bit (highest order bit) of the <tt>value</tt> until it reaches the bit size of
2703the type <tt>ty2</tt>. When the the operand and the type are the same size,
2704no bit filling is done and the cast is considered a <i>no-op cast</i> because
2705no bits change (only the type changes).</p>
2706
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2707<p>When sign extending from bool, the extension always results in -1 or 0.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2708
2709<h5>Example:</h5>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2710<pre>
2711 %X = sext sbyte -1 to ushort <i>; yields ushort:65535</i>
2712 %Y = sext bool true to int <i>; yields int:-1</i>
2713</pre>
2714</div>
2715
2716<!-- _______________________________________________________________________ -->
2717<div class="doc_subsubsection">
Reid Spencer3fa91b02006-11-09 21:48:10 +0000[diff] [blame]2718 <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
2719</div>
2720
2721<div class="doc_text">
2722
2723<h5>Syntax:</h5>
2724
2725<pre>
2726 &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2727</pre>
2728
2729<h5>Overview:</h5>
2730<p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
2731<tt>ty2</tt>.</p>
2732
2733
2734<h5>Arguments:</h5>
2735<p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
2736 point</a> value to cast and a <a href="#t_floating">floating point</a> type to
2737cast it to. The size of <tt>value</tt> must be larger than the size of
2738<tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
2739<i>no-op cast</i>.</p>
2740
2741<h5>Semantics:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2742<p> The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
2743<a href="#t_floating">floating point</a> type to a smaller
2744<a href="#t_floating">floating point</a> type. If the value cannot fit within
2745the destination type, <tt>ty2</tt>, then the results are undefined.</p>
Reid Spencer3fa91b02006-11-09 21:48:10 +0000[diff] [blame]2746
2747<h5>Example:</h5>
2748<pre>
2749 %X = fptrunc double 123.0 to float <i>; yields float:123.0</i>
2750 %Y = fptrunc double 1.0E+300 to float <i>; yields undefined</i>
2751</pre>
2752</div>
2753
2754<!-- _______________________________________________________________________ -->
2755<div class="doc_subsubsection">
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2756 <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
2757</div>
2758<div class="doc_text">
2759
2760<h5>Syntax:</h5>
2761<pre>
2762 &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2763</pre>
2764
2765<h5>Overview:</h5>
2766<p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
2767floating point value.</p>
2768
2769<h5>Arguments:</h5>
2770<p>The '<tt>fpext</tt>' instruction takes a
2771<a href="#t_floating">floating point</a> <tt>value</tt> to cast,
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2772and a <a href="#t_floating">floating point</a> type to cast it to. The source
2773type must be smaller than the destination type.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2774
2775<h5>Semantics:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2776<p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
2777<a href="t_floating">floating point</a> type to a larger
2778<a href="t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
2779used to make a <i>no-op cast</i> because it always changes bits. Use
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]2780<tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2781
2782<h5>Example:</h5>
2783<pre>
2784 %X = fpext float 3.1415 to double <i>; yields double:3.1415</i>
2785 %Y = fpext float 1.0 to float <i>; yields float:1.0 (no-op)</i>
2786</pre>
2787</div>
2788
2789<!-- _______________________________________________________________________ -->
2790<div class="doc_subsubsection">
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2791 <a name="i_fp2uint">'<tt>fptoui .. to</tt>' Instruction</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2792</div>
2793<div class="doc_text">
2794
2795<h5>Syntax:</h5>
2796<pre>
2797 &lt;result&gt; = fp2uint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2798</pre>
2799
2800<h5>Overview:</h5>
2801<p>The '<tt>fp2uint</tt>' converts a floating point <tt>value</tt> to its
2802unsigned integer equivalent of type <tt>ty2</tt>.
2803</p>
2804
2805<h5>Arguments:</h5>
2806<p>The '<tt>fp2uint</tt>' instruction takes a value to cast, which must be a
2807<a href="#t_floating">floating point</a> value, and a type to cast it to, which
2808must be an <a href="#t_integral">integral</a> type.</p>
2809
2810<h5>Semantics:</h5>
2811<p> The '<tt>fp2uint</tt>' instruction converts its
2812<a href="#t_floating">floating point</a> operand into the nearest (rounding
2813towards zero) unsigned integer value. If the value cannot fit in <tt>ty2</tt>,
2814the results are undefined.</p>
2815
2816<p>When converting to bool, the conversion is done as a comparison against
2817zero. If the <tt>value</tt> was zero, the bool result will be <tt>false</tt>.
2818If the <tt>value</tt> was non-zero, the bool result will be <tt>true</tt>.</p>
2819
2820<h5>Example:</h5>
2821<pre>
2822 %X = fp2uint double 123.0 to int <i>; yields int:123</i>
2823 %Y = fp2uint float 1.0E+300 to bool <i>; yields bool:true</i>
2824 %X = fp2uint float 1.04E+17 to ubyte <i>; yields undefined:1</i>
2825</pre>
2826</div>
2827
2828<!-- _______________________________________________________________________ -->
2829<div class="doc_subsubsection">
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2830 <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2831</div>
2832<div class="doc_text">
2833
2834<h5>Syntax:</h5>
2835<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2836 &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2837</pre>
2838
2839<h5>Overview:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2840<p>The '<tt>fptosi</tt>' instruction converts
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2841<a href="#t_floating">floating point</a> <tt>value</tt> to type <tt>ty2</tt>.
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2842</p>
2843
2844
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]2845<h5>Arguments:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2846<p> The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2847<a href="#t_floating">floating point</a> value, and a type to cast it to, which
2848must also be an <a href="#t_integral">integral</a> type.</p>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2849
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]2850<h5>Semantics:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2851<p>The '<tt>fptosi</tt>' instruction converts its
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2852<a href="#t_floating">floating point</a> operand into the nearest (rounding
2853towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
2854the results are undefined.</p>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2855
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2856<p>When converting to bool, the conversion is done as a comparison against
2857zero. If the <tt>value</tt> was zero, the bool result will be <tt>false</tt>.
2858If the <tt>value</tt> was non-zero, the bool result will be <tt>true</tt>.</p>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2859
Chris Lattner33ba0d92001-07-09 00:26:23 +0000[diff] [blame]2860<h5>Example:</h5>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]2861<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2862 %X = fptosi double -123.0 to int <i>; yields int:-123</i>
2863 %Y = fptosi float 1.0E-247 to bool <i>; yields bool:true</i>
2864 %X = fptosi float 1.04E+17 to sbyte <i>; yields undefined:1</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2865</pre>
2866</div>
2867
2868<!-- _______________________________________________________________________ -->
2869<div class="doc_subsubsection">
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2870 <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2871</div>
2872<div class="doc_text">
2873
2874<h5>Syntax:</h5>
2875<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2876 &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2877</pre>
2878
2879<h5>Overview:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2880<p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2881integer and converts that value to the <tt>ty2</tt> type.</p>
2882
2883
2884<h5>Arguments:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2885<p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be an
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2886<a href="#t_integral">integral</a> value, and a type to cast it to, which must
2887be a <a href="#t_floating">floating point</a> type.</p>
2888
2889<h5>Semantics:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2890<p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2891integer quantity and converts it to the corresponding floating point value. If
2892the value cannot fit in the floating point value, the results are undefined.</p>
2893
2894
2895<h5>Example:</h5>
2896<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2897 %X = uitofp int 257 to float <i>; yields float:257.0</i>
2898 %Y = uitofp sbyte -1 to double <i>; yields double:255.0</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2899</pre>
2900</div>
2901
2902<!-- _______________________________________________________________________ -->
2903<div class="doc_subsubsection">
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2904 <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2905</div>
2906<div class="doc_text">
2907
2908<h5>Syntax:</h5>
2909<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2910 &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2911</pre>
2912
2913<h5>Overview:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2914<p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2915integer and converts that value to the <tt>ty2</tt> type.</p>
2916
2917<h5>Arguments:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2918<p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be an
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2919<a href="#t_integral">integral</a> value, and a type to cast it to, which must be
2920a <a href="#t_floating">floating point</a> type.</p>
2921
2922<h5>Semantics:</h5>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2923<p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2924integer quantity and converts it to the corresponding floating point value. If
2925the value cannot fit in the floating point value, the results are undefined.</p>
2926
2927<h5>Example:</h5>
2928<pre>
Reid Spencerd4448792006-11-09 23:03:26 +0000[diff] [blame]2929 %X = sitofp int 257 to float <i>; yields float:257.0</i>
2930 %Y = sitofp sbyte -1 to double <i>; yields double:-1.0</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]2931</pre>
2932</div>
2933
2934<!-- _______________________________________________________________________ -->
2935<div class="doc_subsubsection">
Reid Spencer72679252006-11-11 21:00:47 +0000[diff] [blame]2936 <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
2937</div>
2938<div class="doc_text">
2939
2940<h5>Syntax:</h5>
2941<pre>
2942 &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2943</pre>
2944
2945<h5>Overview:</h5>
2946<p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
2947the integer type <tt>ty2</tt>.</p>
2948
2949<h5>Arguments:</h5>
2950<p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
2951must be a <a href="t_pointer">pointer</a> value, and a type to cast it to
2952<tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.
2953
2954<h5>Semantics:</h5>
2955<p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
2956<tt>ty2</tt> by interpreting the pointer value as an integer and either
2957truncating or zero extending that value to the size of the integer type. If
2958<tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
2959<tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
2960are the same size, then nothing is done (<i>no-op cast</i>).</p>
2961
2962<h5>Example:</h5>
2963<pre>
2964 %X = ptrtoint int* %X to sbyte <i>; yields truncation on 32-bit</i>
2965 %Y = ptrtoint int* %x to ulong <i>; yields zero extend on 32-bit</i>
2966</pre>
2967</div>
2968
2969<!-- _______________________________________________________________________ -->
2970<div class="doc_subsubsection">
2971 <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
2972</div>
2973<div class="doc_text">
2974
2975<h5>Syntax:</h5>
2976<pre>
2977 &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
2978</pre>
2979
2980<h5>Overview:</h5>
2981<p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to
2982a pointer type, <tt>ty2</tt>.</p>
2983
2984<h5>Arguments:</h5>
2985<p>The '<tt>inttoptr</tt>' instruction takes an <a href="i_integer">integer</a>
2986value to cast, and a type to cast it to, which must be a
2987<a href="#t_pointer">pointer</a> type. </tt>
2988
2989<h5>Semantics:</h5>
2990<p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
2991<tt>ty2</tt> by applying either a zero extension or a truncation depending on
2992the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
2993size of a pointer then a truncation is done. If <tt>value</tt> is smaller than
2994the size of a pointer then a zero extension is done. If they are the same size,
2995nothing is done (<i>no-op cast</i>).</p>
2996
2997<h5>Example:</h5>
2998<pre>
2999 %X = inttoptr int 255 to int* <i>; yields zero extend on 64-bit</i>
3000 %X = inttoptr int 255 to int* <i>; yields no-op on 32-bit </i>
3001 %Y = inttoptr short 0 to int* <i>; yields zero extend on 32-bit</i>
3002</pre>
3003</div>
3004
3005<!-- _______________________________________________________________________ -->
3006<div class="doc_subsubsection">
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3007 <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]3008</div>
3009<div class="doc_text">
3010
3011<h5>Syntax:</h5>
3012<pre>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3013 &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt; <i>; yields ty2</i>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]3014</pre>
3015
3016<h5>Overview:</h5>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3017<p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]3018<tt>ty2</tt> without changing any bits.</p>
3019
3020<h5>Arguments:</h5>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3021<p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]3022a first class value, and a type to cast it to, which must also be a <a
3023 href="#t_firstclass">first class</a> type. The bit sizes of <tt>value</tt>
3024and the destination type, <tt>ty2</tt>, must be identical.</p>
3025
3026<h5>Semantics:</h5>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3027<p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
Reid Spencer72679252006-11-11 21:00:47 +0000[diff] [blame]3028<tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
3029this conversion. The conversion is done as if the <tt>value</tt> had been
3030stored to memory and read back as type <tt>ty2</tt>. Pointer types may only be
3031converted to other pointer types with this instruction. To convert pointers to
3032other types, use the <a href="#i_inttoptr">inttoptr</a> or
3033<a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
Reid Spencer9dee3ac2006-11-08 01:11:31 +0000[diff] [blame]3034
3035<h5>Example:</h5>
3036<pre>
Reid Spencer5c0ef472006-11-11 23:08:07 +0000[diff] [blame]3037 %X = bitcast ubyte 255 to sbyte <i>; yields sbyte:-1</i>
3038 %Y = bitcast uint* %x to sint* <i>; yields sint*:%x</i>
3039 %Z = bitcast <2xint> %V to long; <i>; yields long: %V</i>
Chris Lattner33ba0d92001-07-09 00:26:23 +0000[diff] [blame]3040</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3041</div>
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]3042
Reid Spencer2fd21e62006-11-08 01:18:52 +0000[diff] [blame]3043<!-- ======================================================================= -->
3044<div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
3045<div class="doc_text">
3046<p>The instructions in this category are the "miscellaneous"
3047instructions, which defy better classification.</p>
3048</div>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3049
3050<!-- _______________________________________________________________________ -->
3051<div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
3052</div>
3053<div class="doc_text">
3054<h5>Syntax:</h5>
3055<pre> &lt;result&gt; = icmp &lt;cond&gt; &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {bool}:result</i>
3056</pre>
3057<h5>Overview:</h5>
3058<p>The '<tt>icmp</tt>' instruction returns a boolean value based on comparison
3059of its two integer operands.</p>
3060<h5>Arguments:</h5>
3061<p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
3062the condition code which indicates the kind of comparison to perform. It is not
3063a value, just a keyword. The possibilities for the condition code are:
3064<ol>
3065 <li><tt>eq</tt>: equal</li>
3066 <li><tt>ne</tt>: not equal </li>
3067 <li><tt>ugt</tt>: unsigned greater than</li>
3068 <li><tt>uge</tt>: unsigned greater or equal</li>
3069 <li><tt>ult</tt>: unsigned less than</li>
3070 <li><tt>ule</tt>: unsigned less or equal</li>
3071 <li><tt>sgt</tt>: signed greater than</li>
3072 <li><tt>sge</tt>: signed greater or equal</li>
3073 <li><tt>slt</tt>: signed less than</li>
3074 <li><tt>sle</tt>: signed less or equal</li>
3075</ol>
3076<p>The remaining two arguments must be of <a href="#t_integral">integral</a>,
3077<a href="#t_pointer">pointer</a> or a <a href="#t_packed">packed</a> integral
3078type. They must have identical types.</p>
3079<h5>Semantics:</h5>
3080<p>The '<tt>icmp</tt>' compares <tt>var1</tt> and <tt>var2</tt> according to
3081the condition code given as <tt>cond</tt>. The comparison performed always
3082yields a <a href="#t_bool">bool</a> result, as follows:
3083<ol>
3084 <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
3085 <tt>false</tt> otherwise. No sign interpretation is necessary or performed.
3086 </li>
3087 <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
3088 <tt>false</tt> otherwise. No sign interpretation is necessary or performed.
3089 <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
3090 <tt>true</tt> if <tt>var1</tt> is greater than <tt>var2</tt>.</li>
3091 <li><tt>uge</tt>: interprets the operands as unsigned values and yields
3092 <tt>true</tt> if <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3093 <li><tt>ult</tt>: interprets the operands as unsigned values and yields
3094 <tt>true</tt> if <tt>var1</tt> is less than <tt>var2</tt>.</li>
3095 <li><tt>ule</tt>: interprets the operands as unsigned values and yields
3096 <tt>true</tt> if <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3097 <li><tt>sgt</tt>: interprets the operands as signed values and yields
3098 <tt>true</tt> if <tt>var1</tt> is greater than <tt>var2</tt>.</li>
3099 <li><tt>sge</tt>: interprets the operands as signed values and yields
3100 <tt>true</tt> if <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3101 <li><tt>slt</tt>: interprets the operands as signed values and yields
3102 <tt>true</tt> if <tt>var1</tt> is less than <tt>var2</tt>.</li>
3103 <li><tt>sle</tt>: interprets the operands as signed values and yields
3104 <tt>true</tt> if <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3105 </li>
3106</ol>
3107<p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
3108values are treated as integers and then compared.</p>
3109<p>If the operands are <a href="#t_packed">packed</a> typed, the elements of
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3110the vector are compared in turn and the predicate must hold for all
3111elements.</p>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3112
3113<h5>Example:</h5>
3114<pre> &lt;result&gt; = icmp eq int 4, 5 <i>; yields: result=false</i>
3115 &lt;result&gt; = icmp ne float* %X, %X <i>; yields: result=false</i>
3116 &lt;result&gt; = icmp ult short 4, 5 <i>; yields: result=true</i>
3117 &lt;result&gt; = icmp sgt sbyte 4, 5 <i>; yields: result=false</i>
3118 &lt;result&gt; = icmp ule sbyte -4, 5 <i>; yields: result=false</i>
3119 &lt;result&gt; = icmp sge sbyte 4, 5 <i>; yields: result=false</i>
3120</pre>
3121</div>
3122
3123<!-- _______________________________________________________________________ -->
3124<div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
3125</div>
3126<div class="doc_text">
3127<h5>Syntax:</h5>
3128<pre> &lt;result&gt; = fcmp &lt;cond&gt; &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt; <i>; yields {bool}:result</i>
3129</pre>
3130<h5>Overview:</h5>
3131<p>The '<tt>fcmp</tt>' instruction returns a boolean value based on comparison
3132of its floating point operands.</p>
3133<h5>Arguments:</h5>
3134<p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
3135the condition code which indicates the kind of comparison to perform. It is not
3136a value, just a keyword. The possibilities for the condition code are:
3137<ol>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3138 <li><tt>false</tt>: no comparison, always returns false</li>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3139 <li><tt>oeq</tt>: ordered and equal</li>
3140 <li><tt>ogt</tt>: ordered and greater than </li>
3141 <li><tt>oge</tt>: ordered and greater than or equal</li>
3142 <li><tt>olt</tt>: ordered and less than </li>
3143 <li><tt>ole</tt>: ordered and less than or equal</li>
3144 <li><tt>one</tt>: ordered and not equal</li>
3145 <li><tt>ord</tt>: ordered (no nans)</li>
3146 <li><tt>ueq</tt>: unordered or equal</li>
3147 <li><tt>ugt</tt>: unordered or greater than </li>
3148 <li><tt>uge</tt>: unordered or greater than or equal</li>
3149 <li><tt>ult</tt>: unordered or less than </li>
3150 <li><tt>ule</tt>: unordered or less than or equal</li>
3151 <li><tt>une</tt>: unordered or not equal</li>
3152 <li><tt>uno</tt>: unordered (either nans)</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3153 <li><tt>true</tt>: no comparison, always returns true</li>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3154</ol>
Reid Spencer93a49852006-12-06 07:08:07 +0000[diff] [blame^]3155<p>In the preceding, <i>ordered</i> means that neither operand is a QNAN while
3156<i>unordered</i> means that either operand may be a QNAN.</p>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3157<p>The <tt>val1</tt> and <tt>val2</tt> arguments must be of
3158<a href="#t_floating">floating point</a>, or a <a href="#t_packed">packed</a>
3159floating point type. They must have identical types.</p>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3160<p>In the foregoing, <i>ordered</i> means that neither operand is a QNAN and
3161<i>unordered</i> means that either operand is a QNAN.</p>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3162<h5>Semantics:</h5>
3163<p>The '<tt>fcmp</tt>' compares <tt>var1</tt> and <tt>var2</tt> according to
3164the condition code given as <tt>cond</tt>. The comparison performed always
3165yields a <a href="#t_bool">bool</a> result, as follows:
3166<ol>
3167 <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3168 <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3169 <tt>var1</tt> is equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3170 <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3171 <tt>var1</tt> is greather than <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3172 <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3173 <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3174 <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3175 <tt>var1</tt> is less than <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3176 <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3177 <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3178 <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3179 <tt>var1</tt> is not equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3180 <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
3181 <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3182 <tt>var1</tt> is equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3183 <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3184 <tt>var1</tt> is greater than <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3185 <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3186 <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3187 <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3188 <tt>var1</tt> is less than <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3189 <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3190 <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3191 <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3192 <tt>var1</tt> is not equal to <tt>var2</tt>.</li>
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3193 <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3194 <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
3195</ol>
3196<p>If the operands are <a href="#t_packed">packed</a> typed, the elements of
3197the vector are compared in turn and the predicate must hold for all elements.
Reid Spencerb7f26282006-11-19 03:00:14 +0000[diff] [blame]3198</p>
Reid Spencerf3a70a62006-11-18 21:50:54 +0000[diff] [blame]3199
3200<h5>Example:</h5>
3201<pre> &lt;result&gt; = fcmp oeq float 4.0, 5.0 <i>; yields: result=false</i>
3202 &lt;result&gt; = icmp one float 4.0, 5.0 <i>; yields: result=true</i>
3203 &lt;result&gt; = icmp olt float 4.0, 5.0 <i>; yields: result=true</i>
3204 &lt;result&gt; = icmp ueq double 1.0, 2.0 <i>; yields: result=false</i>
3205</pre>
3206</div>
3207
Reid Spencer2fd21e62006-11-08 01:18:52 +0000[diff] [blame]3208<!-- _______________________________________________________________________ -->
3209<div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>'
3210Instruction</a> </div>
3211<div class="doc_text">
3212<h5>Syntax:</h5>
3213<pre> &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
3214<h5>Overview:</h5>
3215<p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
3216the SSA graph representing the function.</p>
3217<h5>Arguments:</h5>
3218<p>The type of the incoming values are specified with the first type
3219field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
3220as arguments, with one pair for each predecessor basic block of the
3221current block. Only values of <a href="#t_firstclass">first class</a>
3222type may be used as the value arguments to the PHI node. Only labels
3223may be used as the label arguments.</p>
3224<p>There must be no non-phi instructions between the start of a basic
3225block and the PHI instructions: i.e. PHI instructions must be first in
3226a basic block.</p>
3227<h5>Semantics:</h5>
3228<p>At runtime, the '<tt>phi</tt>' instruction logically takes on the
3229value specified by the parameter, depending on which basic block we
3230came from in the last <a href="#terminators">terminator</a> instruction.</p>
3231<h5>Example:</h5>
3232<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>
3233</div>
3234
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]3235<!-- _______________________________________________________________________ -->
3236<div class="doc_subsubsection">
3237 <a name="i_select">'<tt>select</tt>' Instruction</a>
3238</div>
3239
3240<div class="doc_text">
3241
3242<h5>Syntax:</h5>
3243
3244<pre>
3245 &lt;result&gt; = select bool &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt; <i>; yields ty</i>
3246</pre>
3247
3248<h5>Overview:</h5>
3249
3250<p>
3251The '<tt>select</tt>' instruction is used to choose one value based on a
3252condition, without branching.
3253</p>
3254
3255
3256<h5>Arguments:</h5>
3257
3258<p>
3259The '<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.
3260</p>
3261
3262<h5>Semantics:</h5>
3263
3264<p>
3265If the boolean condition evaluates to true, the instruction returns the first
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3266value argument; otherwise, it returns the second value argument.
Chris Lattnercc37aae2004-03-12 05:50:16 +0000[diff] [blame]3267</p>
3268
3269<h5>Example:</h5>
3270
3271<pre>
3272 %X = select bool true, ubyte 17, ubyte 42 <i>; yields ubyte:17</i>
3273</pre>
3274</div>
3275
Robert Bocchino05ccd702006-01-15 20:48:27 +0000[diff] [blame]3276
3277<!-- _______________________________________________________________________ -->
3278<div class="doc_subsubsection">
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3279 <a name="i_call">'<tt>call</tt>' Instruction</a>
3280</div>
3281
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3282<div class="doc_text">
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3283
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]3284<h5>Syntax:</h5>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3285<pre>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]3286 &lt;result&gt; = [tail] call [<a href="#callingconv">cconv</a>] &lt;ty&gt;* &lt;fnptrval&gt;(&lt;param list&gt;)
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3287</pre>
3288
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]3289<h5>Overview:</h5>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3290
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3291<p>The '<tt>call</tt>' instruction represents a simple function call.</p>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3292
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]3293<h5>Arguments:</h5>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3294
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3295<p>This instruction requires several arguments:</p>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3296
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]3297<ol>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3298 <li>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]3299 <p>The optional "tail" marker indicates whether the callee function accesses
3300 any allocas or varargs in the caller. If the "tail" marker is present, the
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3301 function call is eligible for tail call optimization. Note that calls may
3302 be marked "tail" even if they do not occur before a <a
3303 href="#i_ret"><tt>ret</tt></a> instruction.
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3304 </li>
3305 <li>
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]3306 <p>The optional "cconv" marker indicates which <a href="callingconv">calling
3307 convention</a> the call should use. If none is specified, the call defaults
3308 to using C calling conventions.
3309 </li>
3310 <li>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3311 <p>'<tt>ty</tt>': shall be the signature of the pointer to function value
3312 being invoked. The argument types must match the types implied by this
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3313 signature. This type can be omitted if the function is not varargs and
3314 if the function type does not return a pointer to a function.</p>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3315 </li>
3316 <li>
3317 <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
3318 be invoked. In most cases, this is a direct function invocation, but
3319 indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3320 to function value.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3321 </li>
3322 <li>
3323 <p>'<tt>function args</tt>': argument list whose types match the
Reid Spencera7e302a2005-05-01 22:22:57 +0000[diff] [blame]3324 function signature argument types. All arguments must be of
3325 <a href="#t_firstclass">first class</a> type. If the function signature
3326 indicates the function accepts a variable number of arguments, the extra
3327 arguments can be specified.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3328 </li>
Chris Lattner6536cfe2002-05-06 22:08:29 +0000[diff] [blame]3329</ol>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3330
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]3331<h5>Semantics:</h5>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3332
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3333<p>The '<tt>call</tt>' instruction is used to cause control flow to
3334transfer to a specified function, with its incoming arguments bound to
3335the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
3336instruction in the called function, control flow continues with the
3337instruction after the function call, and the return value of the
3338function is bound to the result argument. This is a simpler case of
3339the <a href="#i_invoke">invoke</a> instruction.</p>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3340
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]3341<h5>Example:</h5>
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3342
3343<pre>
3344 %retval = call int %test(int %argc)
3345 call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42);
3346 %X = tail call int %foo()
Chris Lattnerbad10ee2005-05-06 22:57:40 +0000[diff] [blame]3347 %Y = tail call <a href="#callingconv">fastcc</a> int %foo()
Chris Lattner2bff5242005-05-06 05:47:36 +0000[diff] [blame]3348</pre>
3349
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3350</div>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3351
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3352<!-- _______________________________________________________________________ -->
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3353<div class="doc_subsubsection">
Chris Lattnerfb6977d2006-01-13 23:26:01 +0000[diff] [blame]3354 <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3355</div>
3356
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3357<div class="doc_text">
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3358
Chris Lattner8d1a81d2003-10-18 05:51:36 +0000[diff] [blame]3359<h5>Syntax:</h5>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3360
3361<pre>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3362 &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3363</pre>
3364
Chris Lattner8d1a81d2003-10-18 05:51:36 +0000[diff] [blame]3365<h5>Overview:</h5>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3366
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3367<p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3368the "variable argument" area of a function call. It is used to implement the
3369<tt>va_arg</tt> macro in C.</p>
3370
Chris Lattner8d1a81d2003-10-18 05:51:36 +0000[diff] [blame]3371<h5>Arguments:</h5>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3372
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3373<p>This instruction takes a <tt>va_list*</tt> value and the type of
3374the argument. It returns a value of the specified argument type and
Jeff Cohen25d4f7e2005-11-11 02:15:27 +0000[diff] [blame]3375increments the <tt>va_list</tt> to point to the next argument. Again, the
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3376actual type of <tt>va_list</tt> is target specific.</p>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3377
Chris Lattner8d1a81d2003-10-18 05:51:36 +0000[diff] [blame]3378<h5>Semantics:</h5>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3379
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3380<p>The '<tt>va_arg</tt>' instruction loads an argument of the specified
3381type from the specified <tt>va_list</tt> and causes the
3382<tt>va_list</tt> to point to the next argument. For more information,
3383see the variable argument handling <a href="#int_varargs">Intrinsic
3384Functions</a>.</p>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3385
3386<p>It is legal for this instruction to be called in a function which does not
3387take a variable number of arguments, for example, the <tt>vfprintf</tt>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3388function.</p>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3389
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3390<p><tt>va_arg</tt> is an LLVM instruction instead of an <a
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3391href="#intrinsics">intrinsic function</a> because it takes a type as an
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3392argument.</p>
3393
Chris Lattner8d1a81d2003-10-18 05:51:36 +0000[diff] [blame]3394<h5>Example:</h5>
Chris Lattnere19d7a72004-09-27 21:51:25 +0000[diff] [blame]3395
3396<p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
3397
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3398</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3399
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3400<!-- *********************************************************************** -->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3401<div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
3402<!-- *********************************************************************** -->
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3403
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3404<div class="doc_text">
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3405
3406<p>LLVM supports the notion of an "intrinsic function". These functions have
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3407well known names and semantics and are required to follow certain
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3408restrictions. Overall, these instructions represent an extension mechanism for
3409the LLVM language that does not require changing all of the transformations in
3410LLVM to add to the language (or the bytecode reader/writer, the parser,
3411etc...).</p>
3412
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3413<p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
3414prefix is reserved in LLVM for intrinsic names; thus, functions may not be named
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3415this. Intrinsic functions must always be external functions: you cannot define
3416the body of intrinsic functions. Intrinsic functions may only be used in call
3417or invoke instructions: it is illegal to take the address of an intrinsic
3418function. Additionally, because intrinsic functions are part of the LLVM
3419language, it is required that they all be documented here if any are added.</p>
3420
3421
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3422<p>To learn how to add an intrinsic function, please see the <a
Chris Lattner590cff32005-05-11 03:35:57 +0000[diff] [blame]3423href="ExtendingLLVM.html">Extending LLVM Guide</a>.
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3424</p>
3425
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3426</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3427
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3428<!-- ======================================================================= -->
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3429<div class="doc_subsection">
3430 <a name="int_varargs">Variable Argument Handling Intrinsics</a>
3431</div>
3432
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3433<div class="doc_text">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3434
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3435<p>Variable argument support is defined in LLVM with the <a
Chris Lattnerfb6977d2006-01-13 23:26:01 +0000[diff] [blame]3436 href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3437intrinsic functions. These functions are related to the similarly
3438named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3439
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3440<p>All of these functions operate on arguments that use a
3441target-specific value type "<tt>va_list</tt>". The LLVM assembly
3442language reference manual does not define what this type is, so all
3443transformations should be prepared to handle intrinsics with any type
3444used.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3445
Chris Lattner374ab302006-05-15 17:26:46 +0000[diff] [blame]3446<p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3447instruction and the variable argument handling intrinsic functions are
3448used.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3449
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3450<pre>
3451int %test(int %X, ...) {
3452 ; Initialize variable argument processing
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3453 %ap = alloca sbyte*
3454 call void %<a href="#i_va_start">llvm.va_start</a>(sbyte** %ap)
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3455
3456 ; Read a single integer argument
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3457 %tmp = va_arg sbyte** %ap, int
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3458
3459 ; Demonstrate usage of llvm.va_copy and llvm.va_end
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3460 %aq = alloca sbyte*
Andrew Lenharthd0a4c622005-06-22 20:38:11 +0000[diff] [blame]3461 call void %<a href="#i_va_copy">llvm.va_copy</a>(sbyte** %aq, sbyte** %ap)
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3462 call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %aq)
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3463
3464 ; Stop processing of arguments.
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3465 call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %ap)
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3466 ret int %tmp
3467}
3468</pre>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3469</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3470
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3471<!-- _______________________________________________________________________ -->
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3472<div class="doc_subsubsection">
3473 <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
3474</div>
3475
3476
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3477<div class="doc_text">
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3478<h5>Syntax:</h5>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3479<pre> declare void %llvm.va_start(&lt;va_list&gt;* &lt;arglist&gt;)<br></pre>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3480<h5>Overview:</h5>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3481<P>The '<tt>llvm.va_start</tt>' intrinsic initializes
3482<tt>*&lt;arglist&gt;</tt> for subsequent use by <tt><a
3483href="#i_va_arg">va_arg</a></tt>.</p>
3484
3485<h5>Arguments:</h5>
3486
3487<P>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
3488
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3489<h5>Semantics:</h5>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3490
3491<P>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
3492macro available in C. In a target-dependent way, it initializes the
3493<tt>va_list</tt> element the argument points to, so that the next call to
3494<tt>va_arg</tt> will produce the first variable argument passed to the function.
3495Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the
3496last argument of the function, the compiler can figure that out.</p>
3497
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3498</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3499
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3500<!-- _______________________________________________________________________ -->
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3501<div class="doc_subsubsection">
3502 <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
3503</div>
3504
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3505<div class="doc_text">
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3506<h5>Syntax:</h5>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3507<pre> declare void %llvm.va_end(&lt;va_list*&gt; &lt;arglist&gt;)<br></pre>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3508<h5>Overview:</h5>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3509<p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>&lt;arglist&gt;</tt>
3510which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt>
3511or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3512<h5>Arguments:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3513<p>The argument is a <tt>va_list</tt> to destroy.</p>
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3514<h5>Semantics:</h5>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3515<p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3516macro available in C. In a target-dependent way, it destroys the <tt>va_list</tt>.
3517Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a
3518 href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly
3519with calls to <tt>llvm.va_end</tt>.</p>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3520</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3521
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3522<!-- _______________________________________________________________________ -->
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3523<div class="doc_subsubsection">
3524 <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
3525</div>
3526
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3527<div class="doc_text">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3528
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3529<h5>Syntax:</h5>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3530
3531<pre>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3532 declare void %llvm.va_copy(&lt;va_list&gt;* &lt;destarglist&gt;,
Andrew Lenharthd0a4c622005-06-22 20:38:11 +0000[diff] [blame]3533 &lt;va_list&gt;* &lt;srcarglist&gt;)
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3534</pre>
3535
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3536<h5>Overview:</h5>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3537
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3538<p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position from
3539the source argument list to the destination argument list.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3540
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3541<h5>Arguments:</h5>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3542
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3543<p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
Andrew Lenharthd0a4c622005-06-22 20:38:11 +0000[diff] [blame]3544The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p>
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3545
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3546
Chris Lattnerd9ad5b32003-05-08 04:57:36 +0000[diff] [blame]3547<h5>Semantics:</h5>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3548
Andrew Lenharth8bf607a2005-06-18 18:28:17 +0000[diff] [blame]3549<p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt> macro
3550available in C. In a target-dependent way, it copies the source
3551<tt>va_list</tt> element into the destination list. This intrinsic is necessary
3552because the <tt><a href="i_va_begin">llvm.va_begin</a></tt> intrinsic may be
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3553arbitrarily complex and require memory allocation, for example.</p>
3554
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]3555</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]3556
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3557<!-- ======================================================================= -->
3558<div class="doc_subsection">
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3559 <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
3560</div>
3561
3562<div class="doc_text">
3563
3564<p>
3565LLVM support for <a href="GarbageCollection.html">Accurate Garbage
3566Collection</a> requires the implementation and generation of these intrinsics.
3567These intrinsics allow identification of <a href="#i_gcroot">GC roots on the
3568stack</a>, as well as garbage collector implementations that require <a
3569href="#i_gcread">read</a> and <a href="#i_gcwrite">write</a> barriers.
3570Front-ends for type-safe garbage collected languages should generate these
3571intrinsics to make use of the LLVM garbage collectors. For more details, see <a
3572href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
3573</p>
3574</div>
3575
3576<!-- _______________________________________________________________________ -->
3577<div class="doc_subsubsection">
3578 <a name="i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
3579</div>
3580
3581<div class="doc_text">
3582
3583<h5>Syntax:</h5>
3584
3585<pre>
Reid Spencera8d451e2005-04-26 20:50:44 +0000[diff] [blame]3586 declare void %llvm.gcroot(&lt;ty&gt;** %ptrloc, &lt;ty2&gt;* %metadata)
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3587</pre>
3588
3589<h5>Overview:</h5>
3590
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]3591<p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3592the code generator, and allows some metadata to be associated with it.</p>
3593
3594<h5>Arguments:</h5>
3595
3596<p>The first argument specifies the address of a stack object that contains the
3597root pointer. The second pointer (which must be either a constant or a global
3598value address) contains the meta-data to be associated with the root.</p>
3599
3600<h5>Semantics:</h5>
3601
3602<p>At runtime, a call to this intrinsics stores a null pointer into the "ptrloc"
3603location. At compile-time, the code generator generates information to allow
3604the runtime to find the pointer at GC safe points.
3605</p>
3606
3607</div>
3608
3609
3610<!-- _______________________________________________________________________ -->
3611<div class="doc_subsubsection">
3612 <a name="i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
3613</div>
3614
3615<div class="doc_text">
3616
3617<h5>Syntax:</h5>
3618
3619<pre>
Chris Lattner80626e92006-03-14 20:02:51 +0000[diff] [blame]3620 declare sbyte* %llvm.gcread(sbyte* %ObjPtr, sbyte** %Ptr)
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3621</pre>
3622
3623<h5>Overview:</h5>
3624
3625<p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
3626locations, allowing garbage collector implementations that require read
3627barriers.</p>
3628
3629<h5>Arguments:</h5>
3630
Chris Lattner80626e92006-03-14 20:02:51 +0000[diff] [blame]3631<p>The second argument is the address to read from, which should be an address
3632allocated from the garbage collector. The first object is a pointer to the
3633start of the referenced object, if needed by the language runtime (otherwise
3634null).</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3635
3636<h5>Semantics:</h5>
3637
3638<p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
3639instruction, but may be replaced with substantially more complex code by the
3640garbage collector runtime, as needed.</p>
3641
3642</div>
3643
3644
3645<!-- _______________________________________________________________________ -->
3646<div class="doc_subsubsection">
3647 <a name="i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
3648</div>
3649
3650<div class="doc_text">
3651
3652<h5>Syntax:</h5>
3653
3654<pre>
Chris Lattner80626e92006-03-14 20:02:51 +0000[diff] [blame]3655 declare void %llvm.gcwrite(sbyte* %P1, sbyte* %Obj, sbyte** %P2)
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3656</pre>
3657
3658<h5>Overview:</h5>
3659
3660<p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
3661locations, allowing garbage collector implementations that require write
3662barriers (such as generational or reference counting collectors).</p>
3663
3664<h5>Arguments:</h5>
3665
Chris Lattner80626e92006-03-14 20:02:51 +0000[diff] [blame]3666<p>The first argument is the reference to store, the second is the start of the
3667object to store it to, and the third is the address of the field of Obj to
3668store to. If the runtime does not require a pointer to the object, Obj may be
3669null.</p>
Chris Lattnerd7923912004-05-23 21:06:01 +0000[diff] [blame]3670
3671<h5>Semantics:</h5>
3672
3673<p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
3674instruction, but may be replaced with substantially more complex code by the
3675garbage collector runtime, as needed.</p>
3676
3677</div>
3678
3679
3680
3681<!-- ======================================================================= -->
3682<div class="doc_subsection">
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3683 <a name="int_codegen">Code Generator Intrinsics</a>
3684</div>
3685
3686<div class="doc_text">
3687<p>
3688These intrinsics are provided by LLVM to expose special features that may only
3689be implemented with code generator support.
3690</p>
3691
3692</div>
3693
3694<!-- _______________________________________________________________________ -->
3695<div class="doc_subsubsection">
3696 <a name="i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
3697</div>
3698
3699<div class="doc_text">
3700
3701<h5>Syntax:</h5>
3702<pre>
Chris Lattnerfcf39d42006-01-13 01:20:27 +0000[diff] [blame]3703 declare sbyte *%llvm.returnaddress(uint &lt;level&gt;)
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3704</pre>
3705
3706<h5>Overview:</h5>
3707
3708<p>
Chris Lattner32b5d712006-10-15 20:05:59 +0000[diff] [blame]3709The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
3710target-specific value indicating the return address of the current function
3711or one of its callers.
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3712</p>
3713
3714<h5>Arguments:</h5>
3715
3716<p>
3717The argument to this intrinsic indicates which function to return the address
3718for. Zero indicates the calling function, one indicates its caller, etc. The
3719argument is <b>required</b> to be a constant integer value.
3720</p>
3721
3722<h5>Semantics:</h5>
3723
3724<p>
3725The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
3726the return address of the specified call frame, or zero if it cannot be
3727identified. The value returned by this intrinsic is likely to be incorrect or 0
3728for arguments other than zero, so it should only be used for debugging purposes.
3729</p>
3730
3731<p>
3732Note that calling this intrinsic does not prevent function inlining or other
Chris Lattnerb40bb382005-03-07 20:30:51 +0000[diff] [blame]3733aggressive transformations, so the value returned may not be that of the obvious
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3734source-language caller.
3735</p>
3736</div>
3737
3738
3739<!-- _______________________________________________________________________ -->
3740<div class="doc_subsubsection">
3741 <a name="i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
3742</div>
3743
3744<div class="doc_text">
3745
3746<h5>Syntax:</h5>
3747<pre>
Chris Lattnerfcf39d42006-01-13 01:20:27 +0000[diff] [blame]3748 declare sbyte *%llvm.frameaddress(uint &lt;level&gt;)
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3749</pre>
3750
3751<h5>Overview:</h5>
3752
3753<p>
Chris Lattner32b5d712006-10-15 20:05:59 +0000[diff] [blame]3754The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
3755target-specific frame pointer value for the specified stack frame.
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3756</p>
3757
3758<h5>Arguments:</h5>
3759
3760<p>
3761The argument to this intrinsic indicates which function to return the frame
3762pointer for. Zero indicates the calling function, one indicates its caller,
3763etc. The argument is <b>required</b> to be a constant integer value.
3764</p>
3765
3766<h5>Semantics:</h5>
3767
3768<p>
3769The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
3770the frame address of the specified call frame, or zero if it cannot be
3771identified. The value returned by this intrinsic is likely to be incorrect or 0
3772for arguments other than zero, so it should only be used for debugging purposes.
3773</p>
3774
3775<p>
3776Note that calling this intrinsic does not prevent function inlining or other
Chris Lattnerb40bb382005-03-07 20:30:51 +0000[diff] [blame]3777aggressive transformations, so the value returned may not be that of the obvious
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3778source-language caller.
3779</p>
3780</div>
3781
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]3782<!-- _______________________________________________________________________ -->
3783<div class="doc_subsubsection">
Chris Lattner57e1f392006-01-13 02:03:13 +0000[diff] [blame]3784 <a name="i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
3785</div>
3786
3787<div class="doc_text">
3788
3789<h5>Syntax:</h5>
3790<pre>
3791 declare sbyte *%llvm.stacksave()
3792</pre>
3793
3794<h5>Overview:</h5>
3795
3796<p>
3797The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state of
3798the function stack, for use with <a href="#i_stackrestore">
3799<tt>llvm.stackrestore</tt></a>. This is useful for implementing language
3800features like scoped automatic variable sized arrays in C99.
3801</p>
3802
3803<h5>Semantics:</h5>
3804
3805<p>
3806This intrinsic returns a opaque pointer value that can be passed to <a
3807href="#i_stackrestore"><tt>llvm.stackrestore</tt></a>. When an
3808<tt>llvm.stackrestore</tt> intrinsic is executed with a value saved from
3809<tt>llvm.stacksave</tt>, it effectively restores the state of the stack to the
3810state it was in when the <tt>llvm.stacksave</tt> intrinsic executed. In
3811practice, this pops any <a href="#i_alloca">alloca</a> blocks from the stack
3812that were allocated after the <tt>llvm.stacksave</tt> was executed.
3813</p>
3814
3815</div>
3816
3817<!-- _______________________________________________________________________ -->
3818<div class="doc_subsubsection">
3819 <a name="i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
3820</div>
3821
3822<div class="doc_text">
3823
3824<h5>Syntax:</h5>
3825<pre>
3826 declare void %llvm.stackrestore(sbyte* %ptr)
3827</pre>
3828
3829<h5>Overview:</h5>
3830
3831<p>
3832The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
3833the function stack to the state it was in when the corresponding <a
3834href="#llvm.stacksave"><tt>llvm.stacksave</tt></a> intrinsic executed. This is
3835useful for implementing language features like scoped automatic variable sized
3836arrays in C99.
3837</p>
3838
3839<h5>Semantics:</h5>
3840
3841<p>
3842See the description for <a href="#i_stacksave"><tt>llvm.stacksave</tt></a>.
3843</p>
3844
3845</div>
3846
3847
3848<!-- _______________________________________________________________________ -->
3849<div class="doc_subsubsection">
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]3850 <a name="i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
3851</div>
3852
3853<div class="doc_text">
3854
3855<h5>Syntax:</h5>
3856<pre>
Reid Spencera8d451e2005-04-26 20:50:44 +0000[diff] [blame]3857 declare void %llvm.prefetch(sbyte * &lt;address&gt;,
3858 uint &lt;rw&gt;, uint &lt;locality&gt;)
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]3859</pre>
3860
3861<h5>Overview:</h5>
3862
3863
3864<p>
3865The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3866a prefetch instruction if supported; otherwise, it is a noop. Prefetches have
3867no
3868effect on the behavior of the program but can change its performance
Chris Lattner2a615362005-02-28 19:47:14 +0000[diff] [blame]3869characteristics.
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]3870</p>
3871
3872<h5>Arguments:</h5>
3873
3874<p>
3875<tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
3876determining if the fetch should be for a read (0) or write (1), and
3877<tt>locality</tt> is a temporal locality specifier ranging from (0) - no
Chris Lattneraeffb4a2005-03-07 20:31:38 +0000[diff] [blame]3878locality, to (3) - extremely local keep in cache. The <tt>rw</tt> and
Chris Lattner9a9d7ac2005-02-28 19:24:19 +0000[diff] [blame]3879<tt>locality</tt> arguments must be constant integers.
3880</p>
3881
3882<h5>Semantics:</h5>
3883
3884<p>
3885This intrinsic does not modify the behavior of the program. In particular,
3886prefetches cannot trap and do not produce a value. On targets that support this
3887intrinsic, the prefetch can provide hints to the processor cache for better
3888performance.
3889</p>
3890
3891</div>
3892
Andrew Lenharth7f4ec3b2005-03-28 20:05:49 +0000[diff] [blame]3893<!-- _______________________________________________________________________ -->
3894<div class="doc_subsubsection">
3895 <a name="i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
3896</div>
3897
3898<div class="doc_text">
3899
3900<h5>Syntax:</h5>
3901<pre>
Reid Spencera8d451e2005-04-26 20:50:44 +0000[diff] [blame]3902 declare void %llvm.pcmarker( uint &lt;id&gt; )
Andrew Lenharth7f4ec3b2005-03-28 20:05:49 +0000[diff] [blame]3903</pre>
3904
3905<h5>Overview:</h5>
3906
3907
3908<p>
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3909The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter
3910(PC) in a region of
Andrew Lenharth7f4ec3b2005-03-28 20:05:49 +0000[diff] [blame]3911code to simulators and other tools. The method is target specific, but it is
3912expected that the marker will use exported symbols to transmit the PC of the marker.
Jeff Cohen25d4f7e2005-11-11 02:15:27 +0000[diff] [blame]3913The marker makes no guarantees that it will remain with any specific instruction
Chris Lattnerd07c3f42005-11-15 06:07:55 +0000[diff] [blame]3914after optimizations. It is possible that the presence of a marker will inhibit
Chris Lattnerb3e7afd2006-03-24 07:16:10 +0000[diff] [blame]3915optimizations. The intended use is to be inserted after optimizations to allow
John Criswellfc6b8952005-05-16 16:17:45 +0000[diff] [blame]3916correlations of simulation runs.
Andrew Lenharth7f4ec3b2005-03-28 20:05:49 +0000[diff] [blame]3917</p>
3918
3919<h5>Arguments:</h5>
3920
3921<p>
3922<tt>id</tt> is a numerical id identifying the marker.
3923</p>
3924
3925<h5>Semantics:</h5>
3926
3927<p>
3928This intrinsic does not modify the behavior of the program. Backends that do not
3929support this intrinisic may ignore it.
3930</p>
3931
3932</div>
3933
Andrew Lenharth51b8d542005-11-11 16:47:30 +0000[diff] [blame]3934<!-- _______________________________________________________________________ -->
3935<div class="doc_subsubsection">
3936 <a name="i_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
3937</div>
3938
3939<div class="doc_text">
3940
3941<h5>Syntax:</h5>
3942<pre>
3943 declare ulong %llvm.readcyclecounter( )
3944</pre>
3945
3946<h5>Overview:</h5>
3947
3948
3949<p>
3950The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
3951counter register (or similar low latency, high accuracy clocks) on those targets
3952that support it. On X86, it should map to RDTSC. On Alpha, it should map to RPCC.
3953As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
3954should only be used for small timings.
3955</p>
3956
3957<h5>Semantics:</h5>
3958
3959<p>
3960When directly supported, reading the cycle counter should not modify any memory.
3961Implementations are allowed to either return a application specific value or a
3962system wide value. On backends without support, this is lowered to a constant 0.
3963</p>
3964
3965</div>
3966
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3967<!-- ======================================================================= -->
3968<div class="doc_subsection">
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3969 <a name="int_libc">Standard C Library Intrinsics</a>
3970</div>
3971
3972<div class="doc_text">
3973<p>
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]3974LLVM provides intrinsics for a few important standard C library functions.
3975These intrinsics allow source-language front-ends to pass information about the
3976alignment of the pointer arguments to the code generator, providing opportunity
3977for more efficient code generation.
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3978</p>
3979
3980</div>
3981
3982<!-- _______________________________________________________________________ -->
3983<div class="doc_subsubsection">
3984 <a name="i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
3985</div>
3986
3987<div class="doc_text">
3988
3989<h5>Syntax:</h5>
3990<pre>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]3991 declare void %llvm.memcpy.i32(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3992 uint &lt;len&gt;, uint &lt;align&gt;)
3993 declare void %llvm.memcpy.i64(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3994 ulong &lt;len&gt;, uint &lt;align&gt;)
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]3995</pre>
3996
3997<h5>Overview:</h5>
3998
3999<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4000The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]4001location to the destination location.
4002</p>
4003
4004<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4005Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
4006intrinsics do not return a value, and takes an extra alignment argument.
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]4007</p>
4008
4009<h5>Arguments:</h5>
4010
4011<p>
4012The first argument is a pointer to the destination, the second is a pointer to
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4013the source. The third argument is an integer argument
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]4014specifying the number of bytes to copy, and the fourth argument is the alignment
4015of the source and destination locations.
4016</p>
4017
Chris Lattner3301ced2004-02-12 21:18:15 +0000[diff] [blame]4018<p>
4019If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattnerf0afc2c2006-03-04 00:02:10 +0000[diff] [blame]4020the caller guarantees that both the source and destination pointers are aligned
4021to that boundary.
Chris Lattner3301ced2004-02-12 21:18:15 +0000[diff] [blame]4022</p>
4023
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]4024<h5>Semantics:</h5>
4025
4026<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4027The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner33aec9e2004-02-12 17:01:32 +0000[diff] [blame]4028location to the destination location, which are not allowed to overlap. It
4029copies "len" bytes of memory over. If the argument is known to be aligned to
4030some boundary, this can be specified as the fourth argument, otherwise it should
4031be set to 0 or 1.
4032</p>
4033</div>
4034
4035
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4036<!-- _______________________________________________________________________ -->
4037<div class="doc_subsubsection">
4038 <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
4039</div>
4040
4041<div class="doc_text">
4042
4043<h5>Syntax:</h5>
4044<pre>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4045 declare void %llvm.memmove.i32(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
4046 uint &lt;len&gt;, uint &lt;align&gt;)
4047 declare void %llvm.memmove.i64(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
4048 ulong &lt;len&gt;, uint &lt;align&gt;)
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4049</pre>
4050
4051<h5>Overview:</h5>
4052
4053<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4054The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the source
4055location to the destination location. It is similar to the
4056'<tt>llvm.memcmp</tt>' intrinsic but allows the two memory locations to overlap.
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4057</p>
4058
4059<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4060Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
4061intrinsics do not return a value, and takes an extra alignment argument.
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4062</p>
4063
4064<h5>Arguments:</h5>
4065
4066<p>
4067The first argument is a pointer to the destination, the second is a pointer to
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4068the source. The third argument is an integer argument
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4069specifying the number of bytes to copy, and the fourth argument is the alignment
4070of the source and destination locations.
4071</p>
4072
Chris Lattner3301ced2004-02-12 21:18:15 +0000[diff] [blame]4073<p>
4074If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattnerf0afc2c2006-03-04 00:02:10 +0000[diff] [blame]4075the caller guarantees that the source and destination pointers are aligned to
4076that boundary.
Chris Lattner3301ced2004-02-12 21:18:15 +0000[diff] [blame]4077</p>
4078
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4079<h5>Semantics:</h5>
4080
4081<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4082The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner0eb51b42004-02-12 18:10:10 +0000[diff] [blame]4083location to the destination location, which may overlap. It
4084copies "len" bytes of memory over. If the argument is known to be aligned to
4085some boundary, this can be specified as the fourth argument, otherwise it should
4086be set to 0 or 1.
4087</p>
4088</div>
4089
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]4090
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4091<!-- _______________________________________________________________________ -->
4092<div class="doc_subsubsection">
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4093 <a name="i_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4094</div>
4095
4096<div class="doc_text">
4097
4098<h5>Syntax:</h5>
4099<pre>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4100 declare void %llvm.memset.i32(sbyte* &lt;dest&gt;, ubyte &lt;val&gt;,
4101 uint &lt;len&gt;, uint &lt;align&gt;)
4102 declare void %llvm.memset.i64(sbyte* &lt;dest&gt;, ubyte &lt;val&gt;,
4103 ulong &lt;len&gt;, uint &lt;align&gt;)
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4104</pre>
4105
4106<h5>Overview:</h5>
4107
4108<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4109The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a particular
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4110byte value.
4111</p>
4112
4113<p>
4114Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
4115does not return a value, and takes an extra alignment argument.
4116</p>
4117
4118<h5>Arguments:</h5>
4119
4120<p>
4121The first argument is a pointer to the destination to fill, the second is the
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4122byte value to fill it with, the third argument is an integer
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4123argument specifying the number of bytes to fill, and the fourth argument is the
4124known alignment of destination location.
4125</p>
4126
4127<p>
4128If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattnerf0afc2c2006-03-04 00:02:10 +0000[diff] [blame]4129the caller guarantees that the destination pointer is aligned to that boundary.
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4130</p>
4131
4132<h5>Semantics:</h5>
4133
4134<p>
Chris Lattner5b310c32006-03-03 00:07:20 +0000[diff] [blame]4135The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting at
4136the
Chris Lattner10610642004-02-14 04:08:35 +0000[diff] [blame]4137destination location. If the argument is known to be aligned to some boundary,
4138this can be specified as the fourth argument, otherwise it should be set to 0 or
41391.
4140</p>
4141</div>
4142
4143
Chris Lattner32006282004-06-11 02:28:03 +0000[diff] [blame]4144<!-- _______________________________________________________________________ -->
4145<div class="doc_subsubsection">
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4146 <a name="i_isunordered">'<tt>llvm.isunordered.*</tt>' Intrinsic</a>
Alkis Evlogimenos26bbe932004-06-13 01:16:15 +0000[diff] [blame]4147</div>
4148
4149<div class="doc_text">
4150
4151<h5>Syntax:</h5>
4152<pre>
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4153 declare bool %llvm.isunordered.f32(float Val1, float Val2)
4154 declare bool %llvm.isunordered.f64(double Val1, double Val2)
Alkis Evlogimenos26bbe932004-06-13 01:16:15 +0000[diff] [blame]4155</pre>
4156
4157<h5>Overview:</h5>
4158
4159<p>
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4160The '<tt>llvm.isunordered</tt>' intrinsics return true if either or both of the
Alkis Evlogimenos26bbe932004-06-13 01:16:15 +0000[diff] [blame]4161specified floating point values is a NAN.
4162</p>
4163
4164<h5>Arguments:</h5>
4165
4166<p>
4167The arguments are floating point numbers of the same type.
4168</p>
4169
4170<h5>Semantics:</h5>
4171
4172<p>
4173If either or both of the arguments is a SNAN or QNAN, it returns true, otherwise
4174false.
4175</p>
4176</div>
4177
4178
Chris Lattnera4d74142005-07-21 01:29:16 +0000[diff] [blame]4179<!-- _______________________________________________________________________ -->
4180<div class="doc_subsubsection">
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4181 <a name="i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
Chris Lattnera4d74142005-07-21 01:29:16 +0000[diff] [blame]4182</div>
4183
4184<div class="doc_text">
4185
4186<h5>Syntax:</h5>
4187<pre>
Chris Lattnerf4d252d2006-09-08 06:34:02 +0000[diff] [blame]4188 declare float %llvm.sqrt.f32(float %Val)
4189 declare double %llvm.sqrt.f64(double %Val)
Chris Lattnera4d74142005-07-21 01:29:16 +0000[diff] [blame]4190</pre>
4191
4192<h5>Overview:</h5>
4193
4194<p>
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4195The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
Chris Lattnera4d74142005-07-21 01:29:16 +0000[diff] [blame]4196returning the same value as the libm '<tt>sqrt</tt>' function would. Unlike
4197<tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for
4198negative numbers (which allows for better optimization).
4199</p>
4200
4201<h5>Arguments:</h5>
4202
4203<p>
4204The argument and return value are floating point numbers of the same type.
4205</p>
4206
4207<h5>Semantics:</h5>
4208
4209<p>
4210This function returns the sqrt of the specified operand if it is a positive
4211floating point number.
4212</p>
4213</div>
4214
Chris Lattnerf4d252d2006-09-08 06:34:02 +0000[diff] [blame]4215<!-- _______________________________________________________________________ -->
4216<div class="doc_subsubsection">
4217 <a name="i_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
4218</div>
4219
4220<div class="doc_text">
4221
4222<h5>Syntax:</h5>
4223<pre>
4224 declare float %llvm.powi.f32(float %Val, int %power)
4225 declare double %llvm.powi.f64(double %Val, int %power)
4226</pre>
4227
4228<h5>Overview:</h5>
4229
4230<p>
4231The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
4232specified (positive or negative) power. The order of evaluation of
4233multiplications is not defined.
4234</p>
4235
4236<h5>Arguments:</h5>
4237
4238<p>
4239The second argument is an integer power, and the first is a value to raise to
4240that power.
4241</p>
4242
4243<h5>Semantics:</h5>
4244
4245<p>
4246This function returns the first value raised to the second power with an
4247unspecified sequence of rounding operations.</p>
4248</div>
4249
4250
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4251<!-- ======================================================================= -->
4252<div class="doc_subsection">
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4253 <a name="int_manip">Bit Manipulation Intrinsics</a>
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4254</div>
4255
4256<div class="doc_text">
4257<p>
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4258LLVM provides intrinsics for a few important bit manipulation operations.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4259These allow efficient code generation for some algorithms.
4260</p>
4261
4262</div>
4263
4264<!-- _______________________________________________________________________ -->
4265<div class="doc_subsubsection">
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4266 <a name="i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
4267</div>
4268
4269<div class="doc_text">
4270
4271<h5>Syntax:</h5>
4272<pre>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4273 declare ushort %llvm.bswap.i16(ushort &lt;id&gt;)
4274 declare uint %llvm.bswap.i32(uint &lt;id&gt;)
4275 declare ulong %llvm.bswap.i64(ulong &lt;id&gt;)
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4276</pre>
4277
4278<h5>Overview:</h5>
4279
4280<p>
4281The '<tt>llvm.bwsap</tt>' family of intrinsics is used to byteswap a 16, 32 or
428264 bit quantity. These are useful for performing operations on data that is not
4283in the target's native byte order.
4284</p>
4285
4286<h5>Semantics:</h5>
4287
4288<p>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4289The <tt>llvm.bswap.16</tt> intrinsic returns a ushort value that has the high and low
4290byte of the input ushort swapped. Similarly, the <tt>llvm.bswap.i32</tt> intrinsic
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4291returns a uint value that has the four bytes of the input uint swapped, so that
4292if the input bytes are numbered 0, 1, 2, 3 then the returned uint will have its
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4293bytes in 3, 2, 1, 0 order. The <tt>llvm.bswap.i64</tt> intrinsic extends this concept
Nate Begeman7e36c472006-01-13 23:26:38 +0000[diff] [blame]4294to 64 bits.
4295</p>
4296
4297</div>
4298
4299<!-- _______________________________________________________________________ -->
4300<div class="doc_subsubsection">
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4301 <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4302</div>
4303
4304<div class="doc_text">
4305
4306<h5>Syntax:</h5>
4307<pre>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4308 declare ubyte %llvm.ctpop.i8 (ubyte &lt;src&gt;)
4309 declare ushort %llvm.ctpop.i16(ushort &lt;src&gt;)
4310 declare uint %llvm.ctpop.i32(uint &lt;src&gt;)
4311 declare ulong %llvm.ctpop.i64(ulong &lt;src&gt;)
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4312</pre>
4313
4314<h5>Overview:</h5>
4315
4316<p>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4317The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set in a
4318value.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4319</p>
4320
4321<h5>Arguments:</h5>
4322
4323<p>
Chris Lattnercfe6b372005-05-07 01:46:40 +0000[diff] [blame]4324The only argument is the value to be counted. The argument may be of any
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4325unsigned integer type. The return type must match the argument type.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4326</p>
4327
4328<h5>Semantics:</h5>
4329
4330<p>
4331The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
4332</p>
4333</div>
4334
4335<!-- _______________________________________________________________________ -->
4336<div class="doc_subsubsection">
Chris Lattner8a886be2006-01-16 22:34:14 +0000[diff] [blame]4337 <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4338</div>
4339
4340<div class="doc_text">
4341
4342<h5>Syntax:</h5>
4343<pre>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4344 declare ubyte %llvm.ctlz.i8 (ubyte &lt;src&gt;)
4345 declare ushort %llvm.ctlz.i16(ushort &lt;src&gt;)
4346 declare uint %llvm.ctlz.i32(uint &lt;src&gt;)
4347 declare ulong %llvm.ctlz.i64(ulong &lt;src&gt;)
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4348</pre>
4349
4350<h5>Overview:</h5>
4351
4352<p>
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4353The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
4354leading zeros in a variable.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4355</p>
4356
4357<h5>Arguments:</h5>
4358
4359<p>
Chris Lattnercfe6b372005-05-07 01:46:40 +0000[diff] [blame]4360The only argument is the value to be counted. The argument may be of any
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4361unsigned integer type. The return type must match the argument type.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4362</p>
4363
4364<h5>Semantics:</h5>
4365
4366<p>
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4367The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros
4368in a variable. If the src == 0 then the result is the size in bits of the type
Chris Lattner99d3c272006-04-21 21:37:40 +0000[diff] [blame]4369of src. For example, <tt>llvm.ctlz(int 2) = 30</tt>.
Andrew Lenharthec370fd2005-05-03 18:01:48 +0000[diff] [blame]4370</p>
4371</div>
Chris Lattner32006282004-06-11 02:28:03 +0000[diff] [blame]4372
4373
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4374
4375<!-- _______________________________________________________________________ -->
4376<div class="doc_subsubsection">
Chris Lattner8a886be2006-01-16 22:34:14 +0000[diff] [blame]4377 <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4378</div>
4379
4380<div class="doc_text">
4381
4382<h5>Syntax:</h5>
4383<pre>
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4384 declare ubyte %llvm.cttz.i8 (ubyte &lt;src&gt;)
4385 declare ushort %llvm.cttz.i16(ushort &lt;src&gt;)
4386 declare uint %llvm.cttz.i32(uint &lt;src&gt;)
4387 declare ulong %llvm.cttz.i64(ulong &lt;src&gt;)
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4388</pre>
4389
4390<h5>Overview:</h5>
4391
4392<p>
Reid Spencer0b118202006-01-16 21:12:35 +0000[diff] [blame]4393The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
4394trailing zeros.
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4395</p>
4396
4397<h5>Arguments:</h5>
4398
4399<p>
4400The only argument is the value to be counted. The argument may be of any
Chris Lattnerec6cb612006-01-16 22:38:59 +0000[diff] [blame]4401unsigned integer type. The return type must match the argument type.
Chris Lattnereff29ab2005-05-15 19:39:26 +0000[diff] [blame]4402</p>
4403
4404<h5>Semantics:</h5>
4405
4406<p>
4407The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros
4408in a variable. If the src == 0 then the result is the size in bits of the type
4409of src. For example, <tt>llvm.cttz(2) = 1</tt>.
4410</p>
4411</div>
4412
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]4413<!-- ======================================================================= -->
4414<div class="doc_subsection">
4415 <a name="int_debugger">Debugger Intrinsics</a>
4416</div>
4417
4418<div class="doc_text">
4419<p>
4420The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
4421are described in the <a
4422href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
4423Debugging</a> document.
4424</p>
4425</div>
4426
4427
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]4428<!-- *********************************************************************** -->
Chris Lattner00950542001-06-06 20:29:01 +0000[diff] [blame]4429<hr>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]4430<address>
4431 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
4432 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
4433 <a href="http://validator.w3.org/check/referer"><img
4434 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
4435
4436 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]4437 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukmandaa4cb02004-03-01 17:47:27 +0000[diff] [blame]4438 Last modified: $Date$
4439</address>
Misha Brukman9d0919f2003-11-08 01:05:38 +0000[diff] [blame]4440</body>
4441</html>