2004-03-01 18:47:27 +01:00
< !DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
2003-11-08 02:05:38 +01:00
< html >
< head >
< title > LLVM Assembly Language Reference Manual< / title >
2004-08-26 22:44:00 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta name = "author" content = "Chris Lattner" >
< meta name = "description"
content="LLVM Assembly Language Reference Manual.">
2003-11-08 02:05:38 +01:00
< link rel = "stylesheet" href = "llvm.css" type = "text/css" >
< / head >
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< body >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
< div class = "doc_title" > LLVM Language Reference Manual < / div >
2001-06-06 22:29:01 +02:00
< ol >
2003-11-08 02:05:38 +01:00
< li > < a href = "#abstract" > Abstract< / a > < / li >
< li > < a href = "#introduction" > Introduction< / a > < / li >
< li > < a href = "#identifiers" > Identifiers< / a > < / li >
2004-12-09 17:11:40 +01:00
< li > < a href = "#highlevel" > High Level Structure< / a >
< ol >
< li > < a href = "#modulestructure" > Module Structure< / a > < / li >
2004-12-09 17:36:40 +01:00
< li > < a href = "#linkage" > Linkage Types< / a > < / li >
2005-05-07 00:57:40 +02:00
< li > < a href = "#callingconv" > Calling Conventions< / a > < / li >
2004-12-09 17:11:40 +01:00
< li > < a href = "#globalvars" > Global Variables< / a > < / li >
2006-01-24 00:23:47 +01:00
< li > < a href = "#functionstructure" > Functions< / a > < / li >
< li > < a href = "#moduleasm" > Module-Level Inline Assembly< / a > < / li >
2004-12-09 17:11:40 +01:00
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< li > < a href = "#typesystem" > Type System< / a >
< ol >
2006-02-17 22:18:08 +01:00
< li > < a href = "#t_primitive" > Primitive Types< / a >
2003-11-25 02:02:51 +01:00
< ol >
2003-11-08 02:05:38 +01:00
< li > < a href = "#t_classifications" > Type Classifications< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< li > < a href = "#t_derived" > Derived Types< / a >
< ol >
2003-11-25 02:02:51 +01:00
< li > < a href = "#t_array" > Array Type< / a > < / li >
2003-11-08 02:05:38 +01:00
< li > < a href = "#t_function" > Function Type< / a > < / li >
< li > < a href = "#t_pointer" > Pointer Type< / a > < / li >
2003-11-25 02:02:51 +01:00
< li > < a href = "#t_struct" > Structure Type< / a > < / li >
2004-08-12 21:12:28 +02:00
< li > < a href = "#t_packed" > Packed Type< / a > < / li >
2005-04-25 19:34:15 +02:00
< li > < a href = "#t_opaque" > Opaque Type< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
< / ol >
< / li >
2004-12-09 17:11:40 +01:00
< li > < a href = "#constants" > Constants< / a >
2004-12-09 18:30:23 +01:00
< ol >
< li > < a href = "#simpleconstants" > Simple Constants< / a >
< li > < a href = "#aggregateconstants" > Aggregate Constants< / a >
< li > < a href = "#globalconstants" > Global Variable and Function Addresses< / a >
< li > < a href = "#undefvalues" > Undefined Values< / a >
< li > < a href = "#constantexprs" > Constant Expressions< / a >
< / ol >
2003-11-25 02:02:51 +01:00
< / li >
2006-01-26 00:47:57 +01:00
< li > < a href = "#othervalues" > Other Values< / a >
< ol >
< li > < a href = "#inlineasm" > Inline Assembler Expressions< / a >
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< li > < a href = "#instref" > Instruction Reference< / a >
< ol >
< li > < a href = "#terminators" > Terminator Instructions< / a >
< ol >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_ret" > '< tt > ret< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_br" > '< tt > br< / tt > ' Instruction< / a > < / li >
2003-11-08 02:05:38 +01:00
< li > < a href = "#i_switch" > '< tt > switch< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_invoke" > '< tt > invoke< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_unwind" > '< tt > unwind< / tt > ' Instruction< / a > < / li >
2004-10-16 20:04:13 +02:00
< li > < a href = "#i_unreachable" > '< tt > unreachable< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< li > < a href = "#binaryops" > Binary Operations< / a >
< ol >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_add" > '< tt > add< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_sub" > '< tt > sub< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_mul" > '< tt > mul< / tt > ' Instruction< / a > < / li >
2006-10-26 08:15:43 +02:00
< li > < a href = "#i_udiv" > '< tt > udiv< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_sdiv" > '< tt > sdiv< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_fdiv" > '< tt > fdiv< / tt > ' Instruction< / a > < / li >
2006-11-02 02:53:59 +01:00
< li > < a href = "#i_urem" > '< tt > urem< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_srem" > '< tt > srem< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_frem" > '< tt > frem< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< li > < a href = "#bitwiseops" > Bitwise Binary Operations< / a >
< ol >
2003-11-08 02:05:38 +01:00
< li > < a href = "#i_and" > '< tt > and< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_or" > '< tt > or< / tt > ' Instruction< / a > < / li >
2003-11-08 02:05:38 +01:00
< li > < a href = "#i_xor" > '< tt > xor< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_shl" > '< tt > shl< / tt > ' Instruction< / a > < / li >
2006-11-08 07:47:33 +01:00
< li > < a href = "#i_lshr" > '< tt > lshr< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_ashr" > '< tt > ashr< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2006-11-18 22:50:54 +01:00
< li >
2006-04-09 01:07:04 +02:00
< li > < a href = "#vectorops" > Vector Operations< / a >
< ol >
< li > < a href = "#i_extractelement" > '< tt > extractelement< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_insertelement" > '< tt > insertelement< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_shufflevector" > '< tt > shufflevector< / tt > ' Instruction< / a > < / li >
< / ol >
< / li >
2006-08-15 02:45:58 +02:00
< li > < a href = "#memoryops" > Memory Access and Addressing Operations< / a >
2001-06-06 22:29:01 +02:00
< ol >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_malloc" > '< tt > malloc< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_free" > '< tt > free< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_alloca" > '< tt > alloca< / tt > ' Instruction< / a > < / li >
2006-02-17 22:18:08 +01:00
< li > < a href = "#i_load" > '< tt > load< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_store" > '< tt > store< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_getelementptr" > '< tt > getelementptr< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2006-11-08 02:18:52 +01:00
< li > < a href = "#convertops" > Conversion Operations< / a >
2006-11-08 02:11:31 +01:00
< ol >
< li > < a href = "#i_trunc" > '< tt > trunc .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_zext" > '< tt > zext .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_sext" > '< tt > sext .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_fptrunc" > '< tt > fptrunc .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_fpext" > '< tt > fpext .. to< / tt > ' Instruction< / a > < / li >
2006-11-10 00:03:26 +01:00
< li > < a href = "#i_fptoui" > '< tt > fptoui .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_fptosi" > '< tt > fptosi .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_uitofp" > '< tt > uitofp .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_sitofp" > '< tt > sitofp .. to< / tt > ' Instruction< / a > < / li >
2006-11-11 22:00:47 +01:00
< li > < a href = "#i_ptrtoint" > '< tt > ptrtoint .. to< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_inttoptr" > '< tt > inttoptr .. to< / tt > ' Instruction< / a > < / li >
2006-11-12 00:08:07 +01:00
< li > < a href = "#i_bitcast" > '< tt > bitcast .. to< / tt > ' Instruction< / a > < / li >
2006-11-08 02:11:31 +01:00
< / ol >
2001-06-06 22:29:01 +02:00
< li > < a href = "#otherops" > Other Operations< / a >
< ol >
2006-11-18 22:50:54 +01:00
< li > < a href = "#i_icmp" > '< tt > icmp< / tt > ' Instruction< / a > < / li >
< li > < a href = "#i_fcmp" > '< tt > fcmp< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_phi" > '< tt > phi< / tt > ' Instruction< / a > < / li >
2004-03-12 06:50:16 +01:00
< li > < a href = "#i_select" > '< tt > select< / tt > ' Instruction< / a > < / li >
2003-11-25 02:02:51 +01:00
< li > < a href = "#i_call" > '< tt > call< / tt > ' Instruction< / a > < / li >
2006-01-14 00:26:01 +01:00
< li > < a href = "#i_va_arg" > '< tt > va_arg< / tt > ' Instruction< / a > < / li >
2001-06-06 22:29:01 +02:00
< / ol >
2003-11-25 02:02:51 +01:00
< / li >
2001-06-06 22:29:01 +02:00
< / ol >
2003-11-25 02:02:51 +01:00
< / li >
2003-05-08 06:57:36 +02:00
< li > < a href = "#intrinsics" > Intrinsic Functions< / a >
< ol >
2003-11-25 02:02:51 +01:00
< li > < a href = "#int_varargs" > Variable Argument Handling Intrinsics< / a >
< ol >
< li > < a href = "#i_va_start" > '< tt > llvm.va_start< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_va_end" > '< tt > llvm.va_end< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_va_copy" > '< tt > llvm.va_copy< / tt > ' Intrinsic< / a > < / li >
< / ol >
< / li >
2004-05-23 23:06:01 +02:00
< li > < a href = "#int_gc" > Accurate Garbage Collection Intrinsics< / a >
< ol >
< li > < a href = "#i_gcroot" > '< tt > llvm.gcroot< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_gcread" > '< tt > llvm.gcread< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_gcwrite" > '< tt > llvm.gcwrite< / tt > ' Intrinsic< / a > < / li >
< / ol >
< / li >
2004-02-14 05:08:35 +01:00
< li > < a href = "#int_codegen" > Code Generator Intrinsics< / a >
< ol >
< li > < a href = "#i_returnaddress" > '< tt > llvm.returnaddress< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_frameaddress" > '< tt > llvm.frameaddress< / tt > ' Intrinsic< / a > < / li >
2006-01-13 03:03:13 +01:00
< li > < a href = "#i_stacksave" > '< tt > llvm.stacksave< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_stackrestore" > '< tt > llvm.stackrestore< / tt > ' Intrinsic< / a > < / li >
2005-02-28 20:24:19 +01:00
< li > < a href = "#i_prefetch" > '< tt > llvm.prefetch< / tt > ' Intrinsic< / a > < / li >
2005-03-28 22:05:49 +02:00
< li > < a href = "#i_pcmarker" > '< tt > llvm.pcmarker< / tt > ' Intrinsic< / a > < / li >
2005-11-11 17:47:30 +01:00
< li > < a href = "#i_readcyclecounter" > < tt > llvm.readcyclecounter< / tt > ' Intrinsic< / a > < / li >
2004-04-09 18:43:20 +02:00
< / ol >
< / li >
2004-02-12 18:01:32 +01:00
< li > < a href = "#int_libc" > Standard C Library Intrinsics< / a >
< ol >
2006-03-03 01:07:20 +01:00
< li > < a href = "#i_memcpy" > '< tt > llvm.memcpy.*< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_memmove" > '< tt > llvm.memmove.*< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_memset" > '< tt > llvm.memset.*< / tt > ' Intrinsic< / a > < / li >
2006-01-16 23:38:59 +01:00
< li > < a href = "#i_isunordered" > '< tt > llvm.isunordered.*< / tt > ' Intrinsic< / a > < / li >
< li > < a href = "#i_sqrt" > '< tt > llvm.sqrt.*< / tt > ' Intrinsic< / a > < / li >
2006-09-08 08:34:02 +02:00
< li > < a href = "#i_powi" > '< tt > llvm.powi.*< / tt > ' Intrinsic< / a > < / li >
2004-02-12 18:01:32 +01:00
< / ol >
< / li >
2006-01-14 00:26:38 +01:00
< li > < a href = "#int_manip" > Bit Manipulation Intrinsics< / a >
2005-05-03 20:01:48 +02:00
< ol >
2006-01-14 00:26:38 +01:00
< li > < a href = "#i_bswap" > '< tt > llvm.bswap.*< / tt > ' Intrinsics< / a > < / li >
2006-01-16 23:34:14 +01:00
< li > < a href = "#int_ctpop" > '< tt > llvm.ctpop.*< / tt > ' Intrinsic < / a > < / li >
< li > < a href = "#int_ctlz" > '< tt > llvm.ctlz.*< / tt > ' Intrinsic < / a > < / li >
< li > < a href = "#int_cttz" > '< tt > llvm.cttz.*< / tt > ' Intrinsic < / a > < / li >
2005-05-03 20:01:48 +02:00
< / ol >
< / li >
2004-05-23 23:06:01 +02:00
< li > < a href = "#int_debugger" > Debugger intrinsics< / a > < / li >
2003-11-25 02:02:51 +01:00
< / ol >
< / li >
2001-06-06 22:29:01 +02:00
< / ol >
2004-05-23 23:06:01 +02:00
< div class = "doc_author" >
< p > Written by < a href = "mailto:sabre@nondot.org" > Chris Lattner< / a >
and < a href = "mailto:vadve@cs.uiuc.edu" > Vikram Adve< / a > < / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-05-23 23:06:01 +02:00
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "abstract" > Abstract < / a > < / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-11-25 02:02:51 +01:00
< p > This document is a reference manual for the LLVM assembly language.
LLVM is an SSA based representation that provides type safety,
low-level operations, flexibility, and the capability of representing
'all' high-level languages cleanly. It is the common code
representation used throughout all phases of the LLVM compilation
strategy.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-05-23 23:06:01 +02:00
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "introduction" > Introduction< / a > < / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
< p > The LLVM code representation is designed to be used in three
different forms: as an in-memory compiler IR, as an on-disk bytecode
representation (suitable for fast loading by a Just-In-Time compiler),
and as a human readable assembly language representation. This allows
LLVM to provide a powerful intermediate representation for efficient
compiler transformations and analysis, while providing a natural means
to debug and visualize the transformations. The three different forms
of LLVM are all equivalent. This document describes the human readable
representation and notation.< / p >
2004-05-23 23:06:01 +02:00
2005-05-14 00:25:59 +02:00
< p > The LLVM representation aims to be light-weight and low-level
2003-11-25 02:02:51 +01:00
while being expressive, typed, and extensible at the same time. It
aims to be a "universal IR" of sorts, by being at a low enough level
that high-level ideas may be cleanly mapped to it (similar to how
microprocessors are "universal IR's", allowing many source languages to
be mapped to them). By providing type information, LLVM can be used as
the target of optimizations: for example, through pointer analysis, it
can be proven that a C automatic variable is never accessed outside of
the current function... allowing it to be promoted to a simple SSA
value instead of a memory location.< / p >
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< / div >
2004-05-23 23:06:01 +02:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "wellformed" > Well-Formedness< / a > < / div >
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
< p > It is important to note that this document describes 'well formed'
LLVM assembly language. There is a difference between what the parser
accepts and what is considered 'well formed'. For example, the
following instruction is syntactically okay, but not well formed:< / p >
2004-05-23 23:06:01 +02:00
< pre >
%x = < a href = "#i_add" > add< / a > int 1, %x
< / pre >
2003-11-25 02:02:51 +01:00
< p > ...because the definition of < tt > %x< / tt > does not dominate all of
its uses. The LLVM infrastructure provides a verification pass that may
be used to verify that an LLVM module is well formed. This pass is
2005-05-14 00:25:59 +02:00
automatically run by the parser after parsing input assembly and by
2003-11-25 02:02:51 +01:00
the optimizer before it outputs bytecode. The violations pointed out
by the verifier pass indicate bugs in transformation passes or input to
the parser.< / p >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
<!-- Describe the typesetting conventions here. --> < / div >
2004-05-23 23:06:01 +02:00
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "identifiers" > Identifiers< / a > < / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
< p > LLVM uses three different forms of identifiers, for different
purposes:< / p >
2004-05-23 23:06:01 +02:00
2001-06-06 22:29:01 +02:00
< ol >
2004-12-09 17:36:40 +01:00
< li > Named values are represented as a string of characters with a '%' prefix.
For example, %foo, %DivisionByZero, %a.really.long.identifier. The actual
regular expression used is '< tt > %[a-zA-Z$._][a-zA-Z$._0-9]*< / tt > '.
Identifiers which require other characters in their names can be surrounded
with quotes. In this way, anything except a < tt > "< / tt > character can be used
in a name.< / li >
< li > Unnamed values are represented as an unsigned numeric value with a '%'
prefix. For example, %12, %2, %44.< / li >
2004-12-09 19:02:53 +01:00
< li > Constants, which are described in a < a href = "#constants" > section about
constants< / a > , below.< / li >
2003-11-08 02:05:38 +01:00
< / ol >
2004-12-09 17:36:40 +01:00
< p > LLVM requires that values start with a '%' sign for two reasons: Compilers
don't need to worry about name clashes with reserved words, and the set of
reserved words may be expanded in the future without penalty. Additionally,
unnamed identifiers allow a compiler to quickly come up with a temporary
variable without having to avoid symbol table conflicts.< / p >
2003-11-25 02:02:51 +01:00
< p > Reserved words in LLVM are very similar to reserved words in other
2006-11-12 00:08:07 +01:00
languages. There are keywords for different opcodes
('< tt > < a href = "#i_add" > add< / a > < / tt > ',
'< tt > < a href = "#i_bitcast" > bitcast< / a > < / tt > ',
'< tt > < a href = "#i_ret" > ret< / a > < / tt > ', etc...), for primitive type names ('< tt > < a
2004-12-09 17:36:40 +01:00
href="#t_void">void< / a > < / tt > ', '< tt > < a href = "#t_uint" > uint< / a > < / tt > ', etc...),
and others. These reserved words cannot conflict with variable names, because
none of them start with a '%' character.< / p >
< p > Here is an example of LLVM code to multiply the integer variable
'< tt > %X< / tt > ' by 8:< / p >
2003-11-08 02:05:38 +01:00
< p > The easy way:< / p >
2004-12-09 17:36:40 +01:00
< pre >
%result = < a href = "#i_mul" > mul< / a > uint %X, 8
< / pre >
2003-11-08 02:05:38 +01:00
< p > After strength reduction:< / p >
2004-12-09 17:36:40 +01:00
< pre >
%result = < a href = "#i_shl" > shl< / a > uint %X, ubyte 3
< / pre >
2003-11-08 02:05:38 +01:00
< p > And the hard way:< / p >
2004-12-09 17:36:40 +01:00
< pre >
< a href = "#i_add" > add< / a > uint %X, %X < i > ; yields {uint}:%0< / i >
< a href = "#i_add" > add< / a > uint %0, %0 < i > ; yields {uint}:%1< / i >
%result = < a href = "#i_add" > add< / a > uint %1, %1
< / pre >
2003-11-25 02:02:51 +01:00
< p > This last way of multiplying < tt > %X< / tt > by 8 illustrates several
important lexical features of LLVM:< / p >
2004-12-09 17:36:40 +01:00
2001-06-06 22:29:01 +02:00
< ol >
2004-12-09 17:36:40 +01:00
< li > Comments are delimited with a '< tt > ;< / tt > ' and go until the end of
line.< / li >
< li > Unnamed temporaries are created when the result of a computation is not
assigned to a named value.< / li >
2003-11-08 02:05:38 +01:00
< li > Unnamed temporaries are numbered sequentially< / li >
2004-12-09 17:36:40 +01:00
2003-11-08 02:05:38 +01:00
< / ol >
2004-12-09 17:36:40 +01:00
2005-05-12 18:52:32 +02:00
< p > ...and it also shows a convention that we follow in this document. When
2004-12-09 17:36:40 +01:00
demonstrating instructions, we will follow an instruction with a comment that
defines the type and name of value produced. Comments are shown in italic
text.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-12-09 17:11:40 +01:00
<!-- *********************************************************************** -->
< div class = "doc_section" > < a name = "highlevel" > High Level Structure< / a > < / div >
<!-- *********************************************************************** -->
<!-- ======================================================================= -->
< div class = "doc_subsection" > < a name = "modulestructure" > Module Structure< / a >
< / div >
< div class = "doc_text" >
< p > LLVM programs are composed of "Module"s, each of which is a
translation unit of the input programs. Each module consists of
functions, global variables, and symbol table entries. Modules may be
combined together with the LLVM linker, which merges function (and
global variable) definitions, resolves forward declarations, and merges
symbol table entries. Here is an example of the "hello world" module:< / p >
< pre > < i > ; Declare the string constant as a global constant...< / i >
< a href = "#identifiers" > %.LC0< / a > = < a href = "#linkage_internal" > internal< / a > < a
href="#globalvars">constant< / a > < a href = "#t_array" > [13 x sbyte]< / a > c"hello world\0A\00" < i > ; [13 x sbyte]*< / i >
< i > ; External declaration of the puts function< / i >
< a href = "#functionstructure" > declare< / a > int %puts(sbyte*) < i > ; int(sbyte*)* < / i >
2006-06-13 05:05:47 +02:00
< i > ; Global variable / Function body section separator< / i >
implementation
2004-12-09 17:11:40 +01:00
< i > ; Definition of main function< / i >
int %main() { < i > ; int()* < / i >
< i > ; Convert [13x sbyte]* to sbyte *...< / i >
%cast210 = < a
href="#i_getelementptr">getelementptr< / a > [13 x sbyte]* %.LC0, long 0, long 0 < i > ; sbyte*< / i >
< i > ; Call puts function to write out the string to stdout...< / i >
< a
href="#i_call">call< / a > int %puts(sbyte* %cast210) < i > ; int< / i >
< a
href="#i_ret">ret< / a > int 0< br > }< br > < / pre >
< p > This example is made up of a < a href = "#globalvars" > global variable< / a >
named "< tt > .LC0< / tt > ", an external declaration of the "< tt > puts< / tt > "
function, and a < a href = "#functionstructure" > function definition< / a >
for "< tt > main< / tt > ".< / p >
2004-12-09 17:36:40 +01:00
< p > In general, a module is made up of a list of global values,
where both functions and global variables are global values. Global values are
represented by a pointer to a memory location (in this case, a pointer to an
array of char, and a pointer to a function), and have one of the following < a
href="#linkage">linkage types< / a > .< / p >
2006-06-13 05:05:47 +02:00
< p > Due to a limitation in the current LLVM assembly parser (it is limited by
one-token lookahead), modules are split into two pieces by the "implementation"
keyword. Global variable prototypes and definitions must occur before the
keyword, and function definitions must occur after it. Function prototypes may
occur either before or after it. In the future, the implementation keyword may
become a noop, if the parser gets smarter.< / p >
2004-12-09 17:36:40 +01:00
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "linkage" > Linkage Types< / a >
< / div >
2004-12-09 17:11:40 +01:00
2004-12-09 17:36:40 +01:00
< div class = "doc_text" >
< p >
All Global Variables and Functions have one of the following types of linkage:
< / p >
2004-12-09 17:11:40 +01:00
< dl >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< dt > < tt > < b > < a name = "linkage_internal" > internal< / a > < / b > < / tt > < / dt >
2004-12-09 17:36:40 +01:00
< dd > Global values with internal linkage are only directly accessible by
objects in the current module. In particular, linking code into a module with
an internal global value may cause the internal to be renamed as necessary to
avoid collisions. Because the symbol is internal to the module, all
references can be updated. This corresponds to the notion of the
'< tt > static< / tt > ' keyword in C, or the idea of "anonymous namespaces" in C++.
2004-12-09 17:11:40 +01:00
< / dd >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< dt > < tt > < b > < a name = "linkage_linkonce" > linkonce< / a > < / b > < / tt > : < / dt >
2004-12-09 17:36:40 +01:00
< dd > "< tt > linkonce< / tt > " linkage is similar to < tt > internal< / tt > linkage, with
the twist that linking together two modules defining the same
< tt > linkonce< / tt > globals will cause one of the globals to be discarded. This
is typically used to implement inline functions. Unreferenced
< tt > linkonce< / tt > globals are allowed to be discarded.
2004-12-09 17:11:40 +01:00
< / dd >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< dt > < tt > < b > < a name = "linkage_weak" > weak< / a > < / b > < / tt > : < / dt >
2004-12-09 17:36:40 +01:00
< dd > "< tt > weak< / tt > " linkage is exactly the same as < tt > linkonce< / tt > linkage,
except that unreferenced < tt > weak< / tt > globals may not be discarded. This is
used to implement constructs in C such as "< tt > int X;< / tt > " at global scope.
2004-12-09 17:11:40 +01:00
< / dd >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< dt > < tt > < b > < a name = "linkage_appending" > appending< / a > < / b > < / tt > : < / dt >
2004-12-09 17:36:40 +01:00
< dd > "< tt > appending< / tt > " linkage may only be applied to global variables of
pointer to array type. When two global variables with appending linkage are
linked together, the two global arrays are appended together. This is the
LLVM, typesafe, equivalent of having the system linker append together
"sections" with identical names when .o files are linked.
2004-12-09 17:11:40 +01:00
< / dd >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< dt > < tt > < b > < a name = "linkage_external" > externally visible< / a > < / b > < / tt > :< / dt >
2004-12-09 17:36:40 +01:00
< dd > If none of the above identifiers are used, the global is externally
visible, meaning that it participates in linkage and can be used to resolve
external symbol references.
2004-12-09 17:11:40 +01:00
< / dd >
2006-09-14 20:23:27 +02:00
< dt > < tt > < b > < a name = "linkage_externweak" > extern_weak< / a > < / b > < / tt > : < / dt >
< dd > "< tt > extern_weak< / tt > " TBD
< / dd >
< p >
The next two types of linkage are targeted for Microsoft Windows platform
only. They are designed to support importing (exporting) symbols from (to)
DLLs.
< / p >
< dt > < tt > < b > < a name = "linkage_dllimport" > dllimport< / a > < / b > < / tt > : < / dt >
< dd > "< tt > dllimport< / tt > " linkage causes the compiler to reference a function
or variable via a global pointer to a pointer that is set up by the DLL
exporting the symbol. On Microsoft Windows targets, the pointer name is
formed by combining < code > _imp__< / code > and the function or variable name.
< / dd >
< dt > < tt > < b > < a name = "linkage_dllexport" > dllexport< / a > < / b > < / tt > : < / dt >
< dd > "< tt > dllexport< / tt > " linkage causes the compiler to provide a global
pointer to a pointer in a DLL, so that it can be referenced with the
< tt > dllimport< / tt > attribute. On Microsoft Windows targets, the pointer
name is formed by combining < code > _imp__< / code > and the function or variable
name.
< / dd >
2004-12-09 17:11:40 +01:00
< / dl >
< p > < a name = "linkage_external" > For example, since the "< tt > .LC0< / tt > "
variable is defined to be internal, if another module defined a "< tt > .LC0< / tt > "
variable and was linked with this one, one of the two would be renamed,
preventing a collision. Since "< tt > main< / tt > " and "< tt > puts< / tt > " are
external (i.e., lacking any linkage declarations), they are accessible
outside of the current module. It is illegal for a function < i > declaration< / i >
to have any linkage type other than "externally visible".< / a > < / p >
2004-12-09 17:36:40 +01:00
2004-12-09 17:11:40 +01:00
< / div >
2005-05-07 00:57:40 +02:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "callingconv" > Calling Conventions< / a >
< / div >
< div class = "doc_text" >
< p > LLVM < a href = "#functionstructure" > functions< / a > , < a href = "#i_call" > calls< / a >
and < a href = "#i_invoke" > invokes< / a > can all have an optional calling convention
specified for the call. The calling convention of any pair of dynamic
caller/callee must match, or the behavior of the program is undefined. The
following calling conventions are supported by LLVM, and more may be added in
the future:< / p >
< dl >
< dt > < b > "< tt > ccc< / tt > " - The C calling convention< / b > :< / dt >
< dd > This calling convention (the default if no other calling convention is
specified) matches the target C calling conventions. This calling convention
2005-05-12 18:52:32 +02:00
supports varargs function calls and tolerates some mismatch in the declared
2005-05-07 00:57:40 +02:00
prototype and implemented declaration of the function (as does normal C).
< / dd >
2006-05-19 23:15:36 +02:00
< dt > < b > "< tt > csretcc< / tt > " - The C struct return calling convention< / b > :< / dt >
< dd > This calling convention matches the target C calling conventions, except
that functions with this convention are required to take a pointer as their
first argument, and the return type of the function must be void. This is
used for C functions that return aggregates by-value. In this case, the
function has been transformed to take a pointer to the struct as the first
argument to the function. For targets where the ABI specifies specific
behavior for structure-return calls, the calling convention can be used to
distinguish between struct return functions and other functions that take a
pointer to a struct as the first argument.
< / dd >
2005-05-07 00:57:40 +02:00
< dt > < b > "< tt > fastcc< / tt > " - The fast calling convention< / b > :< / dt >
< dd > This calling convention attempts to make calls as fast as possible
(e.g. by passing things in registers). This calling convention allows the
target to use whatever tricks it wants to produce fast code for the target,
2005-05-07 01:08:23 +02:00
without having to conform to an externally specified ABI. Implementations of
this convention should allow arbitrary tail call optimization to be supported.
This calling convention does not support varargs and requires the prototype of
all callees to exactly match the prototype of the function definition.
2005-05-07 00:57:40 +02:00
< / dd >
< dt > < b > "< tt > coldcc< / tt > " - The cold calling convention< / b > :< / dt >
< dd > This calling convention attempts to make code in the caller as efficient
as possible under the assumption that the call is not commonly executed. As
such, these calls often preserve all registers so that the call does not break
any live ranges in the caller side. This calling convention does not support
varargs and requires the prototype of all callees to exactly match the
prototype of the function definition.
< / dd >
2005-05-07 03:46:40 +02:00
< dt > < b > "< tt > cc < < em > n< / em > > < / tt > " - Numbered convention< / b > :< / dt >
2005-05-07 00:57:40 +02:00
< dd > Any calling convention may be specified by number, allowing
target-specific calling conventions to be used. Target specific calling
conventions start at 64.
< / dd >
2005-05-07 03:46:40 +02:00
< / dl >
2005-05-07 00:57:40 +02:00
< p > More calling conventions can be added/defined on an as-needed basis, to
support pascal conventions or any other well-known target-independent
convention.< / p >
< / div >
2004-12-09 17:11:40 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "globalvars" > Global Variables< / a >
< / div >
< div class = "doc_text" >
2005-02-12 20:30:21 +01:00
< p > Global variables define regions of memory allocated at compilation time
2005-11-12 01:45:07 +01:00
instead of run-time. Global variables may optionally be initialized, may have
an explicit section to be placed in, and may
2005-11-06 09:02:57 +01:00
have an optional explicit alignment specified. A
2005-10-24 18:17:18 +02:00
variable may be defined as a global "constant," which indicates that the
2005-02-12 20:30:21 +01:00
contents of the variable will < b > never< / b > be modified (enabling better
optimization, allowing the global data to be placed in the read-only section of
an executable, etc). Note that variables that need runtime initialization
2005-10-24 18:17:18 +02:00
cannot be marked "constant" as there is a store to the variable.< / p >
2005-02-12 20:30:21 +01:00
< p >
LLVM explicitly allows < em > declarations< / em > of global variables to be marked
constant, even if the final definition of the global is not. This capability
can be used to enable slightly better optimization of the program, but requires
the language definition to guarantee that optimizations based on the
'constantness' are valid for the translation units that do not include the
definition.
< / p >
2004-12-09 17:11:40 +01:00
< p > As SSA values, global variables define pointer values that are in
scope (i.e. they dominate) all basic blocks in the program. Global
variables always define a pointer to their "content" type because they
describe a region of memory, and all memory objects in LLVM are
accessed through pointers.< / p >
2005-11-12 01:45:07 +01:00
< p > LLVM allows an explicit section to be specified for globals. If the target
supports it, it will emit globals to the section specified.< / p >
2005-11-06 09:02:57 +01:00
< p > An explicit alignment may be specified for a global. If not present, or if
the alignment is set to zero, the alignment of the global is set by the target
to whatever it feels convenient. If an explicit alignment is specified, the
global is forced to have at least that much alignment. All alignments must be
a power of 2.< / p >
2004-12-09 17:11:40 +01:00
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "functionstructure" > Functions< / a >
< / div >
< div class = "doc_text" >
2005-05-07 00:57:40 +02:00
< p > LLVM function definitions consist of an optional < a href = "#linkage" > linkage
type< / a > , an optional < a href = "#callingconv" > calling convention< / a > , a return
2005-11-12 01:45:07 +01:00
type, a function name, a (possibly empty) argument list, an optional section,
an optional alignment, an opening curly brace,
2005-05-07 00:57:40 +02:00
a list of basic blocks, and a closing curly brace. LLVM function declarations
are defined with the "< tt > declare< / tt > " keyword, an optional < a
2005-11-06 09:02:57 +01:00
href="#callingconv">calling convention< / a > , a return type, a function name,
a possibly empty list of arguments, and an optional alignment.< / p >
2004-12-09 17:11:40 +01:00
< p > A function definition contains a list of basic blocks, forming the CFG for
the function. Each basic block may optionally start with a label (giving the
basic block a symbol table entry), contains a list of instructions, and ends
with a < a href = "#terminators" > terminator< / a > instruction (such as a branch or
function return).< / p >
2005-05-12 18:52:32 +02:00
< p > The first basic block in a program is special in two ways: it is immediately
2004-12-09 17:11:40 +01:00
executed on entrance to the function, and it is not allowed to have predecessor
basic blocks (i.e. there can not be any branches to the entry block of a
function). Because the block can have no predecessors, it also cannot have any
< a href = "#i_phi" > PHI nodes< / a > .< / p >
< p > LLVM functions are identified by their name and type signature. Hence, two
functions with the same name but different parameter lists or return values are
2005-03-07 23:13:59 +01:00
considered different functions, and LLVM will resolve references to each
2004-12-09 17:11:40 +01:00
appropriately.< / p >
2005-11-12 01:45:07 +01:00
< p > LLVM allows an explicit section to be specified for functions. If the target
supports it, it will emit functions to the section specified.< / p >
2005-11-06 09:02:57 +01:00
< p > An explicit alignment may be specified for a function. If not present, or if
the alignment is set to zero, the alignment of the function is set by the target
to whatever it feels convenient. If an explicit alignment is specified, the
function is forced to have at least that much alignment. All alignments must be
a power of 2.< / p >
2004-12-09 17:11:40 +01:00
< / div >
2006-01-24 00:23:47 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
2006-04-08 06:40:53 +02:00
< a name = "moduleasm" > Module-Level Inline Assembly< / a >
2006-01-24 00:23:47 +01:00
< / div >
< div class = "doc_text" >
< p >
Modules may contain "module-level inline asm" blocks, which corresponds to the
GCC "file scope inline asm" blocks. These blocks are internally concatenated by
LLVM and treated as a single unit, but may be separated in the .ll file if
desired. The syntax is very simple:
< / p >
< div class = "doc_code" > < pre >
2006-01-24 01:37:20 +01:00
module asm "inline asm code goes here"
module asm "more can go here"
2006-01-24 00:23:47 +01:00
< / pre > < / div >
< p > The strings can contain any character by escaping non-printable characters.
The escape sequence used is simply "\xx" where "xx" is the two digit hex code
for the number.
< / p >
< p >
The inline asm code is simply printed to the machine code .s file when
assembly code is generated.
< / p >
< / div >
2004-12-09 17:11:40 +01:00
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "typesystem" > Type System< / a > < / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2004-12-09 17:11:40 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-12-09 17:11:40 +01:00
2003-11-08 02:05:38 +01:00
< p > The LLVM type system is one of the most important features of the
2003-11-25 02:02:51 +01:00
intermediate representation. Being typed enables a number of
optimizations to be performed on the IR directly, without having to do
extra analyses on the side before the transformation. A strong type
system makes it easier to read the generated code and enables novel
analyses and transformations that are not feasible to perform on normal
three address code representations.< / p >
2004-12-09 17:11:40 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsection" > < a name = "t_primitive" > Primitive Types< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-04-09 18:48:45 +02:00
< p > The primitive types are the fundamental building blocks of the LLVM
2005-03-07 23:13:59 +01:00
system. The current set of primitive types is as follows:< / p >
2004-03-01 18:47:27 +01:00
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< table >
2003-11-25 02:02:51 +01:00
< tbody >
2004-11-01 09:19:36 +01:00
< tr > < th > Type< / th > < th > Description< / th > < / tr >
< tr > < td > < tt > void< / tt > < / td > < td > No value< / td > < / tr >
2005-04-22 20:02:52 +02:00
< tr > < td > < tt > ubyte< / tt > < / td > < td > Unsigned 8-bit value< / td > < / tr >
< tr > < td > < tt > ushort< / tt > < / td > < td > Unsigned 16-bit value< / td > < / tr >
< tr > < td > < tt > uint< / tt > < / td > < td > Unsigned 32-bit value< / td > < / tr >
< tr > < td > < tt > ulong< / tt > < / td > < td > Unsigned 64-bit value< / td > < / tr >
< tr > < td > < tt > float< / tt > < / td > < td > 32-bit floating point value< / td > < / tr >
2004-11-01 09:19:36 +01:00
< tr > < td > < tt > label< / tt > < / td > < td > Branch destination< / td > < / tr >
2003-11-25 02:02:51 +01:00
< / tbody >
< / table >
2004-11-01 09:19:36 +01:00
< / td >
< td class = "right" >
< table >
2003-11-25 02:02:51 +01:00
< tbody >
2004-11-01 09:19:36 +01:00
< tr > < th > Type< / th > < th > Description< / th > < / tr >
< tr > < td > < tt > bool< / tt > < / td > < td > True or False value< / td > < / tr >
2005-04-22 20:02:52 +02:00
< tr > < td > < tt > sbyte< / tt > < / td > < td > Signed 8-bit value< / td > < / tr >
< tr > < td > < tt > short< / tt > < / td > < td > Signed 16-bit value< / td > < / tr >
< tr > < td > < tt > int< / tt > < / td > < td > Signed 32-bit value< / td > < / tr >
< tr > < td > < tt > long< / tt > < / td > < td > Signed 64-bit value< / td > < / tr >
< tr > < td > < tt > double< / tt > < / td > < td > 64-bit floating point value< / td > < / tr >
2003-11-25 02:02:51 +01:00
< / tbody >
< / table >
2004-11-01 09:19:36 +01:00
< / td >
< / tr >
2003-11-08 02:05:38 +01:00
< / table >
< / div >
2004-11-01 09:19:36 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "t_classifications" > Type
Classifications< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-11-25 02:02:51 +01:00
< p > These different primitive types fall into a few useful
classifications:< / p >
2004-03-01 18:47:27 +01:00
< table border = "1" cellspacing = "0" cellpadding = "4" >
2003-11-25 02:02:51 +01:00
< tbody >
2004-11-01 09:19:36 +01:00
< tr > < th > Classification< / th > < th > Types< / th > < / tr >
2003-11-25 02:02:51 +01:00
< tr >
< td > < a name = "t_signed" > signed< / a > < / td >
< td > < tt > sbyte, short, int, long, float, double< / tt > < / td >
< / tr >
< tr >
< td > < a name = "t_unsigned" > unsigned< / a > < / td >
< td > < tt > ubyte, ushort, uint, ulong< / tt > < / td >
< / tr >
< tr >
< td > < a name = "t_integer" > integer< / a > < / td >
< td > < tt > ubyte, sbyte, ushort, short, uint, int, ulong, long< / tt > < / td >
< / tr >
< tr >
< td > < a name = "t_integral" > integral< / a > < / td >
2004-08-12 22:16:08 +02:00
< td > < tt > bool, ubyte, sbyte, ushort, short, uint, int, ulong, long< / tt >
< / td >
2003-11-25 02:02:51 +01:00
< / tr >
< tr >
< td > < a name = "t_floating" > floating point< / a > < / td >
< td > < tt > float, double< / tt > < / td >
< / tr >
< tr >
< td > < a name = "t_firstclass" > first class< / a > < / td >
2004-08-12 22:16:08 +02:00
< td > < tt > bool, ubyte, sbyte, ushort, short, uint, int, ulong, long,< br >
float, double, < a href = "#t_pointer" > pointer< / a > ,
< a href = "#t_packed" > packed< / a > < / tt > < / td >
2003-11-25 02:02:51 +01:00
< / tr >
< / tbody >
2003-11-08 02:05:38 +01:00
< / table >
2004-03-01 18:47:27 +01:00
2003-11-25 02:02:51 +01:00
< p > The < a href = "#t_firstclass" > first class< / a > types are perhaps the
most important. Values of these types are the only ones which can be
produced by instructions, passed as arguments, or used as operands to
instructions. This means that all structures and arrays must be
manipulated either by pointer or by component.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-12-09 18:30:23 +01:00
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsection" > < a name = "t_derived" > Derived Types< / a > < / div >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-12-09 18:30:23 +01:00
2003-11-25 02:02:51 +01:00
< p > The real power in LLVM comes from the derived types in the system.
This is what allows a programmer to represent arrays, functions,
pointers, and other useful types. Note that these derived types may be
recursive: For example, it is possible to have a two dimensional array.< / p >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< / div >
2004-12-09 18:30:23 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "t_array" > Array Type< / a > < / div >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-12-09 18:30:23 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< p > The array type is a very simple derived type that arranges elements
2003-11-25 02:02:51 +01:00
sequentially in memory. The array type requires a size (number of
elements) and an underlying data type.< / p >
2004-12-09 18:30:23 +01:00
2002-04-14 08:13:44 +02:00
< h5 > Syntax:< / h5 >
2004-12-09 18:30:23 +01:00
< pre >
[< # elements> x < elementtype> ]
< / pre >
2005-05-12 18:52:32 +02:00
< p > The number of elements is a constant integer value; elementtype may
2003-11-25 02:02:51 +01:00
be any type with a size.< / p >
2004-12-09 18:30:23 +01:00
2002-04-14 08:13:44 +02:00
< h5 > Examples:< / h5 >
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > [40 x int ]< / tt > < br / >
< tt > [41 x int ]< / tt > < br / >
< tt > [40 x uint]< / tt > < br / >
< / td >
< td class = "left" >
Array of 40 integer values.< br / >
Array of 41 integer values.< br / >
Array of 40 unsigned integer values.< br / >
< / td >
< / tr >
< / table >
2003-11-08 02:05:38 +01:00
< p > Here are some examples of multidimensional arrays:< / p >
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > [3 x [4 x int]]< / tt > < br / >
< tt > [12 x [10 x float]]< / tt > < br / >
< tt > [2 x [3 x [4 x uint]]]< / tt > < br / >
< / td >
< td class = "left" >
2005-05-14 00:25:59 +02:00
3x4 array of integer values.< br / >
2004-11-01 09:19:36 +01:00
12x10 array of single precision floating point values.< br / >
2x3x4 array of unsigned integer values.< br / >
< / td >
< / tr >
2001-06-06 22:29:01 +02:00
< / table >
2005-06-24 19:22:57 +02:00
2005-10-24 18:17:18 +02:00
< p > Note that 'variable sized arrays' can be implemented in LLVM with a zero
length array. Normally, accesses past the end of an array are undefined in
2005-06-24 19:22:57 +02:00
LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
As a special case, however, zero length arrays are recognized to be variable
length. This allows implementation of 'pascal style arrays' with the LLVM
type "{ int, [0 x float]}", for example.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-11-01 09:19:36 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "t_function" > Function Type< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The function type can be thought of as a function signature. It
consists of a return type and a list of formal parameter types.
2003-11-25 22:45:46 +01:00
Function types are usually used to build virtual function tables
2003-11-25 02:02:51 +01:00
(which are structures of pointers to functions), for indirect function
calls, and when defining a function.< / p >
2003-11-25 22:45:46 +01:00
< p >
The return type of a function type cannot be an aggregate type.
< / p >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < returntype> (< parameter list> )< br > < / pre >
2005-10-24 18:17:18 +02:00
< p > ...where '< tt > < parameter list> < / tt > ' is a comma-separated list of type
2004-08-12 22:16:08 +02:00
specifiers. Optionally, the parameter list may include a type < tt > ...< / tt > ,
2003-09-03 02:41:47 +02:00
which indicates that the function takes a variable number of arguments.
Variable argument functions can access their arguments with the < a
2003-11-25 02:02:51 +01:00
href="#int_varargs">variable argument handling intrinsic< / a > functions.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Examples:< / h5 >
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > int (int)< / tt > < br / >
< tt > float (int, int *) *< / tt > < br / >
< tt > int (sbyte *, ...)< / tt > < br / >
< / td >
< td class = "left" >
function taking an < tt > int< / tt > , returning an < tt > int< / tt > < br / >
< a href = "#t_pointer" > Pointer< / a > to a function that takes an
2004-08-12 22:16:08 +02:00
< tt > int< / tt > and a < a href = "#t_pointer" > pointer< / a > to < tt > int< / tt > ,
2004-11-01 09:19:36 +01:00
returning < tt > float< / tt > .< br / >
A vararg function that takes at least one < a href = "#t_pointer" > pointer< / a >
to < tt > sbyte< / tt > (signed char in C), which returns an integer. This is
the signature for < tt > printf< / tt > in LLVM.< br / >
< / td >
< / tr >
2001-06-06 22:29:01 +02:00
< / table >
2004-03-01 18:47:27 +01:00
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "t_struct" > Structure Type< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The structure type is used to represent a collection of data members
together in memory. The packing of the field types is defined to match
the ABI of the underlying processor. The elements of a structure may
be any type that has a size.< / p >
< p > Structures are accessed using '< tt > < a href = "#i_load" > load< / a > < / tt >
and '< tt > < a href = "#i_store" > store< / a > < / tt > ' by getting a pointer to a
field with the '< tt > < a href = "#i_getelementptr" > getelementptr< / a > < / tt > '
instruction.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > { < type list> }< br > < / pre >
2001-06-06 22:29:01 +02:00
< h5 > Examples:< / h5 >
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > { int, int, int }< / tt > < br / >
< tt > { float, int (int) * }< / tt > < br / >
< / td >
< td class = "left" >
a triple of three < tt > int< / tt > values< br / >
A pair, where the first element is a < tt > float< / tt > and the second element
is a < a href = "#t_pointer" > pointer< / a > to a < a href = "#t_function" > function< / a >
that takes an < tt > int< / tt > , returning an < tt > int< / tt > .< br / >
< / td >
< / tr >
2001-06-06 22:29:01 +02:00
< / table >
2003-11-08 02:05:38 +01:00
< / div >
2004-11-01 09:19:36 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "t_pointer" > Pointer Type< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2002-04-14 08:13:44 +02:00
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > As in many languages, the pointer type represents a pointer or
reference to another object, which must live in memory.< / p >
2002-04-14 08:13:44 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < type> *< br > < / pre >
2002-04-14 08:13:44 +02:00
< h5 > Examples:< / h5 >
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > [4x int]*< / tt > < br / >
< tt > int (int *) *< / tt > < br / >
< / td >
< td class = "left" >
A < a href = "#t_pointer" > pointer< / a > to < a href = "#t_array" > array< / a > of
four < tt > int< / tt > values< br / >
A < a href = "#t_pointer" > pointer< / a > to a < a
2005-02-19 03:22:14 +01:00
href="#t_function">function< / a > that takes an < tt > int*< / tt > , returning an
2004-11-01 09:19:36 +01:00
< tt > int< / tt > .< br / >
< / td >
< / tr >
2003-11-08 02:05:38 +01:00
< / table >
< / div >
2004-11-01 09:19:36 +01:00
2004-08-12 21:12:28 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "t_packed" > Packed Type< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-04-25 19:34:15 +02:00
2004-08-12 21:12:28 +02:00
< h5 > Overview:< / h5 >
2005-04-25 19:34:15 +02:00
2004-08-12 21:12:28 +02:00
< p > A packed type is a simple derived type that represents a vector
of elements. Packed types are used when multiple primitive data
are operated in parallel using a single instruction (SIMD).
A packed type requires a size (number of
2005-11-10 02:44:22 +01:00
elements) and an underlying primitive data type. Vectors must have a power
of two length (1, 2, 4, 8, 16 ...). Packed types are
2004-08-12 21:12:28 +02:00
considered < a href = "#t_firstclass" > first class< / a > .< / p >
2005-04-25 19:34:15 +02:00
2004-08-12 21:12:28 +02:00
< h5 > Syntax:< / h5 >
2005-04-25 19:34:15 +02:00
< pre >
< < # elements> x < elementtype> >
< / pre >
2005-05-14 00:25:59 +02:00
< p > The number of elements is a constant integer value; elementtype may
2004-08-12 21:12:28 +02:00
be any integral or floating point type.< / p >
2005-04-25 19:34:15 +02:00
2004-08-12 21:12:28 +02:00
< h5 > Examples:< / h5 >
2005-04-25 19:34:15 +02:00
2004-11-01 09:19:36 +01:00
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > < 4 x int> < / tt > < br / >
< tt > < 8 x float> < / tt > < br / >
< tt > < 2 x uint> < / tt > < br / >
< / td >
< td class = "left" >
Packed vector of 4 integer values.< br / >
Packed vector of 8 floating-point values.< br / >
Packed vector of 2 unsigned integer values.< br / >
< / td >
< / tr >
< / table >
2003-11-08 02:05:38 +01:00
< / div >
2005-04-25 19:34:15 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "t_opaque" > Opaque Type< / a > < / div >
< div class = "doc_text" >
< h5 > Overview:< / h5 >
< p > Opaque types are used to represent unknown types in the system. This
corresponds (for example) to the C notion of a foward declared structure type.
In LLVM, opaque types can eventually be resolved to any type (not just a
structure type).< / p >
< h5 > Syntax:< / h5 >
< pre >
opaque
< / pre >
< h5 > Examples:< / h5 >
< table class = "layout" >
< tr class = "layout" >
< td class = "left" >
< tt > opaque< / tt >
< / td >
< td class = "left" >
An opaque type.< br / >
< / td >
< / tr >
< / table >
< / div >
2004-12-09 18:30:23 +01:00
<!-- *********************************************************************** -->
< div class = "doc_section" > < a name = "constants" > Constants< / a > < / div >
<!-- *********************************************************************** -->
< div class = "doc_text" >
< p > LLVM has several different basic types of constants. This section describes
them all and their syntax.< / p >
< / div >
<!-- ======================================================================= -->
2004-12-09 19:02:53 +01:00
< div class = "doc_subsection" > < a name = "simpleconstants" > Simple Constants< / a > < / div >
2004-12-09 18:30:23 +01:00
< div class = "doc_text" >
< dl >
< dt > < b > Boolean constants< / b > < / dt >
< dd > The two strings '< tt > true< / tt > ' and '< tt > false< / tt > ' are both valid
constants of the < tt > < a href = "#t_primitive" > bool< / a > < / tt > type.
< / dd >
< dt > < b > Integer constants< / b > < / dt >
2004-12-09 19:02:53 +01:00
< dd > Standard integers (such as '4') are constants of the < a
2004-12-09 18:30:23 +01:00
href="#t_integer">integer< / a > type. Negative numbers may be used with signed
integer types.
< / dd >
< dt > < b > Floating point constants< / b > < / dt >
< dd > Floating point constants use standard decimal notation (e.g. 123.421),
exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
notation (see below). Floating point constants must have a < a
href="#t_floating">floating point< / a > type. < / dd >
< dt > < b > Null pointer constants< / b > < / dt >
2004-12-10 16:51:16 +01:00
< dd > The identifier '< tt > null< / tt > ' is recognized as a null pointer constant
2004-12-09 18:30:23 +01:00
and must be of < a href = "#t_pointer" > pointer type< / a > .< / dd >
< / dl >
2004-12-10 16:51:16 +01:00
< p > The one non-intuitive notation for constants is the optional hexadecimal form
2004-12-09 18:30:23 +01:00
of floating point constants. For example, the form '< tt > double
0x432ff973cafa8000< / tt > ' is equivalent to (but harder to read than) '< tt > double
4.5e+15< / tt > '. The only time hexadecimal floating point constants are required
2004-12-09 19:02:53 +01:00
(and the only time that they are generated by the disassembler) is when a
floating point constant must be emitted but it cannot be represented as a
decimal floating point number. For example, NaN's, infinities, and other
special values are represented in their IEEE hexadecimal format so that
assembly and disassembly do not cause any bits to change in the constants.< / p >
2004-12-09 18:30:23 +01:00
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" > < a name = "aggregateconstants" > Aggregate Constants< / a >
< / div >
< div class = "doc_text" >
2005-03-07 23:13:59 +01:00
< p > Aggregate constants arise from aggregation of simple constants
and smaller aggregate constants.< / p >
2004-12-09 18:30:23 +01:00
< dl >
< dt > < b > Structure constants< / b > < / dt >
< dd > Structure constants are represented with notation similar to structure
type definitions (a comma separated list of elements, surrounded by braces
2005-03-07 23:13:59 +01:00
(< tt > {}< / tt > )). For example: "< tt > { int 4, float 17.0, int* %G }< / tt > ",
where "< tt > %G< / tt > " is declared as "< tt > %G = external global int< / tt > ". Structure constants
must have < a href = "#t_struct" > structure type< / a > , and the number and
2004-12-09 18:30:23 +01:00
types of elements must match those specified by the type.
< / dd >
< dt > < b > Array constants< / b > < / dt >
< dd > Array constants are represented with notation similar to array type
definitions (a comma separated list of elements, surrounded by square brackets
2004-12-10 16:51:16 +01:00
(< tt > []< / tt > )). For example: "< tt > [ int 42, int 11, int 74 ]< / tt > ". Array
2004-12-09 18:30:23 +01:00
constants must have < a href = "#t_array" > array type< / a > , and the number and
types of elements must match those specified by the type.
< / dd >
< dt > < b > Packed constants< / b > < / dt >
< dd > Packed constants are represented with notation similar to packed type
definitions (a comma separated list of elements, surrounded by
2004-12-10 16:51:16 +01:00
less-than/greater-than's (< tt > < > < / tt > )). For example: "< tt > < int 42,
2004-12-09 18:30:23 +01:00
int 11, int 74, int 100 > < / tt > ". Packed constants must have < a
href="#t_packed">packed type< / a > , and the number and types of elements must
match those specified by the type.
< / dd >
< dt > < b > Zero initialization< / b > < / dt >
< dd > The string '< tt > zeroinitializer< / tt > ' can be used to zero initialize a
value to zero of < em > any< / em > type, including scalar and aggregate types.
This is often used to avoid having to print large zero initializers (e.g. for
2005-10-24 18:17:18 +02:00
large arrays) and is always exactly equivalent to using explicit zero
2004-12-09 18:30:23 +01:00
initializers.
< / dd >
< / dl >
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "globalconstants" > Global Variable and Function Addresses< / a >
< / div >
< div class = "doc_text" >
< p > The addresses of < a href = "#globalvars" > global variables< / a > and < a
href="#functionstructure">functions< / a > are always implicitly valid (link-time)
2004-12-10 16:51:16 +01:00
constants. These constants are explicitly referenced when the < a
href="#identifiers">identifier for the global< / a > is used and always have < a
2004-12-09 18:30:23 +01:00
href="#t_pointer">pointer< / a > type. For example, the following is a legal LLVM
file:< / p >
< pre >
%X = global int 17
%Y = global int 42
%Z = global [2 x int*] [ int* %X, int* %Y ]
< / pre >
< / div >
<!-- ======================================================================= -->
2004-12-09 19:13:12 +01:00
< div class = "doc_subsection" > < a name = "undefvalues" > Undefined Values< / a > < / div >
2004-12-09 18:30:23 +01:00
< div class = "doc_text" >
2004-12-09 19:13:12 +01:00
< p > The string '< tt > undef< / tt > ' is recognized as a type-less constant that has
2005-05-14 00:25:59 +02:00
no specific value. Undefined values may be of any type and be used anywhere
2004-12-09 19:13:12 +01:00
a constant is permitted.< / p >
2004-12-09 18:30:23 +01:00
2004-12-09 19:13:12 +01:00
< p > Undefined values indicate to the compiler that the program is well defined
no matter what value is used, giving the compiler more freedom to optimize.
< / p >
2004-12-09 18:30:23 +01:00
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" > < a name = "constantexprs" > Constant Expressions< / a >
< / div >
< div class = "doc_text" >
< p > Constant expressions are used to allow expressions involving other constants
to be used as constants. Constant expressions may be of any < a
2005-05-14 00:25:59 +02:00
href="#t_firstclass">first class< / a > type and may involve any LLVM operation
2004-12-09 18:30:23 +01:00
that does not have side effects (e.g. load and call are not supported). The
following is the syntax for constant expressions:< / p >
< dl >
2006-11-08 02:11:31 +01:00
< dt > < b > < tt > trunc ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Truncate a constant to another type. The bit size of CST must be larger
than the bit size of TYPE. Both types must be integral.< / dd >
< dt > < b > < tt > zext ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Zero extend a constant to another type. The bit size of CST must be
smaller or equal to the bit size of TYPE. Both types must be integral.< / dd >
< dt > < b > < tt > sext ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Sign extend a constant to another type. The bit size of CST must be
smaller or equal to the bit size of TYPE. Both types must be integral.< / dd >
< dt > < b > < tt > fptrunc ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Truncate a floating point constant to another floating point type. The
size of CST must be larger than the size of TYPE. Both types must be
floating point.< / dd >
< dt > < b > < tt > fpext ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Floating point extend a constant to another type. The size of CST must be
smaller or equal to the size of TYPE. Both types must be floating point.< / dd >
< dt > < b > < tt > fp2uint ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Convert a floating point constant to the corresponding unsigned integer
constant. TYPE must be an integer type. CST must be floating point. If the
value won't fit in the integer type, the results are undefined.< / dd >
2006-11-10 00:03:26 +01:00
< dt > < b > < tt > fptosi ( CST to TYPE )< / tt > < / b > < / dt >
2006-11-08 02:11:31 +01:00
< dd > Convert a floating point constant to the corresponding signed integer
constant. TYPE must be an integer type. CST must be floating point. If the
value won't fit in the integer type, the results are undefined.< / dd >
2006-11-10 00:03:26 +01:00
< dt > < b > < tt > uitofp ( CST to TYPE )< / tt > < / b > < / dt >
2006-11-08 02:11:31 +01:00
< dd > Convert an unsigned integer constant to the corresponding floating point
constant. TYPE must be floating point. CST must be of integer type. If the
value won't fit in the floating point type, the results are undefined.< / dd >
2006-11-10 00:03:26 +01:00
< dt > < b > < tt > sitofp ( CST to TYPE )< / tt > < / b > < / dt >
2006-11-08 02:11:31 +01:00
< dd > Convert a signed integer constant to the corresponding floating point
constant. TYPE must be floating point. CST must be of integer type. If the
value won't fit in the floating point type, the results are undefined.< / dd >
2006-11-12 00:08:07 +01:00
< dt > < b > < tt > ptrtoint ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Convert a pointer typed constant to the corresponding integer constant
TYPE must be an integer type. CST must be of pointer type. The CST value is
zero extended, truncated, or unchanged to make it fit in TYPE.< / dd >
< dt > < b > < tt > inttoptr ( CST to TYPE )< / tt > < / b > < / dt >
< dd > Convert a integer constant to a pointer constant. TYPE must be a
pointer type. CST must be of integer type. The CST value is zero extended,
truncated, or unchanged to make it fit in a pointer size. This one is
< i > really< / i > dangerous!< / dd >
< dt > < b > < tt > bitcast ( CST to TYPE )< / tt > < / b > < / dt >
2006-11-08 02:11:31 +01:00
< dd > Convert a constant, CST, to another TYPE. The size of CST and TYPE must be
identical (same number of bits). The conversion is done as if the CST value
was stored to memory and read back as TYPE. In other words, no bits change
2006-11-12 00:08:07 +01:00
with this operator, just the type. This can be used for conversion of
packed types to any other type, as long as they have the same bit width. For
pointers it is only valid to cast to another pointer type.
2006-11-08 02:11:31 +01:00
< / dd >
2004-12-09 18:30:23 +01:00
< dt > < b > < tt > getelementptr ( CSTPTR, IDX0, IDX1, ... )< / tt > < / b > < / dt >
< dd > Perform the < a href = "#i_getelementptr" > getelementptr operation< / a > on
constants. As with the < a href = "#i_getelementptr" > getelementptr< / a >
instruction, the index list may have zero or more indexes, which are required
to make sense for the type of "CSTPTR".< / dd >
2006-01-10 20:31:34 +01:00
< dt > < b > < tt > select ( COND, VAL1, VAL2 )< / tt > < / b > < / dt >
< dd > Perform the < a href = "#i_select" > select operation< / a > on
constants.
< dt > < b > < tt > extractelement ( VAL, IDX )< / tt > < / b > < / dt >
< dd > Perform the < a href = "#i_extractelement" > extractelement
operation< / a > on constants.
2006-01-15 21:48:27 +01:00
< dt > < b > < tt > insertelement ( VAL, ELT, IDX )< / tt > < / b > < / dt >
< dd > Perform the < a href = "#i_insertelement" > insertelement
operation< / a > on constants.
2006-04-08 02:13:41 +02:00
< dt > < b > < tt > shufflevector ( VEC1, VEC2, IDXMASK )< / tt > < / b > < / dt >
< dd > Perform the < a href = "#i_shufflevector" > shufflevector
operation< / a > on constants.
2004-12-09 18:30:23 +01:00
< dt > < b > < tt > OPCODE ( LHS, RHS )< / tt > < / b > < / dt >
2004-12-09 19:13:12 +01:00
< dd > Perform the specified operation of the LHS and RHS constants. OPCODE may
be any of the < a href = "#binaryops" > binary< / a > or < a href = "#bitwiseops" > bitwise
2004-12-09 18:30:23 +01:00
binary< / a > operations. The constraints on operands are the same as those for
the corresponding instruction (e.g. no bitwise operations on floating point
2005-05-12 18:52:32 +02:00
values are allowed).< / dd >
2004-12-09 18:30:23 +01:00
< / dl >
< / div >
2004-03-08 17:49:10 +01:00
2006-01-26 00:47:57 +01:00
<!-- *********************************************************************** -->
< div class = "doc_section" > < a name = "othervalues" > Other Values< / a > < / div >
<!-- *********************************************************************** -->
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "inlineasm" > Inline Assembler Expressions< / a >
< / div >
< div class = "doc_text" >
< p >
LLVM supports inline assembler expressions (as opposed to < a href = "#moduleasm" >
Module-Level Inline Assembly< / a > ) through the use of a special value. This
value represents the inline assembler as a string (containing the instructions
to emit), a list of operand constraints (stored as a string), and a flag that
indicates whether or not the inline asm expression has side effects. An example
inline assembler expression is:
< / p >
< pre >
int(int) asm "bswap $0", "=r,r"
< / pre >
< p >
Inline assembler expressions may < b > only< / b > be used as the callee operand of
a < a href = "#i_call" > < tt > call< / tt > instruction< / a > . Thus, typically we have:
< / p >
< pre >
%X = call int asm "< a href = "#i_bswap" > bswap< / a > $0", "=r,r"(int %Y)
< / pre >
< p >
Inline asms with side effects not visible in the constraint list must be marked
as having side effects. This is done through the use of the
'< tt > sideeffect< / tt > ' keyword, like so:
< / p >
< pre >
call void asm sideeffect "eieio", ""()
< / pre >
< p > TODO: The format of the asm and constraints string still need to be
documented here. Constraints on what can be done (e.g. duplication, moving, etc
need to be documented).
< / p >
< / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "instref" > Instruction Reference< / a > < / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-12-09 18:30:23 +01:00
2003-11-25 02:02:51 +01:00
< p > The LLVM instruction set consists of several different
classifications of instructions: < a href = "#terminators" > terminator
2005-05-14 00:25:59 +02:00
instructions< / a > , < a href = "#binaryops" > binary instructions< / a > ,
< a href = "#bitwiseops" > bitwise binary instructions< / a > , < a
2003-11-25 02:02:51 +01:00
href="#memoryops">memory instructions< / a > , and < a href = "#otherops" > other
instructions< / a > .< / p >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< / div >
2004-12-09 18:30:23 +01:00
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsection" > < a name = "terminators" > Terminator
Instructions< / a > < / div >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-12-09 18:30:23 +01:00
2003-11-25 02:02:51 +01:00
< p > As mentioned < a href = "#functionstructure" > previously< / a > , every
basic block in a program ends with a "Terminator" instruction, which
indicates which block should be executed after the current block is
finished. These terminator instructions typically yield a '< tt > void< / tt > '
value: they produce control flow, not values (the one exception being
the '< a href = "#i_invoke" > < tt > invoke< / tt > < / a > ' instruction).< / p >
2004-12-10 16:51:16 +01:00
< p > There are six different terminator instructions: the '< a
2003-11-25 02:02:51 +01:00
href="#i_ret">< tt > ret< / tt > < / a > ' instruction, the '< a href = "#i_br" > < tt > br< / tt > < / a > '
instruction, the '< a href = "#i_switch" > < tt > switch< / tt > < / a > ' instruction,
2004-10-16 20:04:13 +02:00
the '< a href = "#i_invoke" > < tt > invoke< / tt > < / a > ' instruction, the '< a
href="#i_unwind">< tt > unwind< / tt > < / a > ' instruction, and the '< a
href="#i_unreachable">< tt > unreachable< / tt > < / a > ' instruction.< / p >
2004-12-09 18:30:23 +01:00
2003-11-08 02:05:38 +01:00
< / div >
2004-12-09 18:30:23 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_ret" > '< tt > ret< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > ret < type> < value> < i > ; Return a value from a non-void function< / i >
2002-04-14 08:13:44 +02:00
ret void < i > ; Return from void function< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > ret< / tt > ' instruction is used to return control flow (and a
2005-05-14 00:25:59 +02:00
value) from a function back to the caller.< / p >
2004-04-09 18:48:45 +02:00
< p > There are two forms of the '< tt > ret< / tt > ' instruction: one that
2003-11-25 02:02:51 +01:00
returns a value and then causes control flow, and one that just causes
control flow to occur.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > ret< / tt > ' instruction may return any '< a
href="#t_firstclass">first class< / a > ' type. Notice that a function is
not < a href = "#wellformed" > well formed< / a > if there exists a '< tt > ret< / tt > '
instruction inside of the function that returns a value that does not
match the return type of the function.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-25 02:02:51 +01:00
< p > When the '< tt > ret< / tt > ' instruction is executed, control flow
returns back to the calling function's context. If the caller is a "< a
2004-06-25 17:16:57 +02:00
href="#i_call">< tt > call< / tt > < / a > " instruction, execution continues at
2003-11-25 02:02:51 +01:00
the instruction after the call. If the caller was an "< a
href="#i_invoke">< tt > invoke< / tt > < / a > " instruction, execution continues
2005-05-12 18:52:32 +02:00
at the beginning of the "normal" destination block. If the instruction
2003-11-25 02:02:51 +01:00
returns a value, that value shall set the call or invoke instruction's
return value.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > ret int 5 < i > ; Return an integer value of 5< / i >
2002-04-14 08:13:44 +02:00
ret void < i > ; Return from a void function< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_br" > '< tt > br< / tt > ' Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > br bool < cond> , label < iftrue> , label < iffalse> < br > br label < dest> < i > ; Unconditional branch< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > br< / tt > ' instruction is used to cause control flow to
transfer to a different basic block in the current function. There are
two forms of this instruction, corresponding to a conditional branch
and an unconditional branch.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The conditional branch form of the '< tt > br< / tt > ' instruction takes a
single '< tt > bool< / tt > ' value and two '< tt > label< / tt > ' values. The
unconditional form of the '< tt > br< / tt > ' instruction takes a single '< tt > label< / tt > '
value as a target.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-25 02:02:51 +01:00
< p > Upon execution of a conditional '< tt > br< / tt > ' instruction, the '< tt > bool< / tt > '
argument is evaluated. If the value is < tt > true< / tt > , control flows
to the '< tt > iftrue< / tt > ' < tt > label< / tt > argument. If "cond" is < tt > false< / tt > ,
control flows to the '< tt > iffalse< / tt > ' < tt > label< / tt > argument.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2006-11-18 22:55:45 +01:00
< 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
2003-11-25 02:02:51 +01:00
href="#i_ret">ret< / a > int 1< br > IfUnequal:< br > < a href = "#i_ret" > ret< / a > int 0< br > < / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2004-02-24 05:54:45 +01:00
< div class = "doc_subsubsection" >
< a name = "i_switch" > '< tt > switch< / tt > ' Instruction< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2004-02-24 05:54:45 +01:00
< pre >
switch < intty> < value> , label < defaultdest> [ < intty> < val> , label < dest> ... ]
< / pre >
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2004-02-24 05:54:45 +01:00
< p > The '< tt > switch< / tt > ' instruction is used to transfer control flow to one of
several different places. It is a generalization of the '< tt > br< / tt > '
2003-11-08 02:05:38 +01:00
instruction, allowing a branch to occur to one of many possible
destinations.< / p >
2004-02-24 05:54:45 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2004-02-24 05:54:45 +01:00
< p > The '< tt > switch< / tt > ' instruction uses three parameters: an integer
comparison value '< tt > value< / tt > ', a default '< tt > label< / tt > ' destination, and
an array of pairs of comparison value constants and '< tt > label< / tt > 's. The
table is not allowed to contain duplicate constant entries.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2004-02-24 05:54:45 +01:00
2003-11-25 02:02:51 +01:00
< p > The < tt > switch< / tt > instruction specifies a table of values and
destinations. When the '< tt > switch< / tt > ' instruction is executed, this
2004-06-25 18:05:06 +02:00
table is searched for the given value. If the value is found, control flow is
transfered to the corresponding destination; otherwise, control flow is
transfered to the default destination.< / p >
2004-02-24 05:54:45 +01:00
2003-05-08 07:08:48 +02:00
< h5 > Implementation:< / h5 >
2004-02-24 05:54:45 +01:00
< p > Depending on properties of the target machine and the particular
< tt > switch< / tt > instruction, this instruction may be code generated in different
2004-06-25 18:05:06 +02:00
ways. For example, it could be generated as a series of chained conditional
branches or with a lookup table.< / p >
2004-02-24 05:54:45 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2004-02-24 05:54:45 +01:00
< pre >
< i > ; Emulate a conditional br instruction< / i >
2006-11-08 02:11:31 +01:00
%Val = < a href = "#i_zext" > zext< / a > bool %value to int
2004-02-24 05:54:45 +01:00
switch int %Val, label %truedest [int 0, label %falsedest ]
< i > ; Emulate an unconditional br instruction< / i >
switch uint 0, label %dest [ ]
< i > ; Implement a jump table:< / i >
switch uint %val, label %otherwise [ uint 0, label %onzero
uint 1, label %onone
uint 2, label %ontwo ]
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2005-05-07 00:57:40 +02:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2005-05-07 00:57:40 +02:00
< div class = "doc_subsubsection" >
< a name = "i_invoke" > '< tt > invoke< / tt > ' Instruction< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-05-07 00:57:40 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2005-05-07 00:57:40 +02:00
< pre >
< result> = invoke [< a href = "#callingconv" > cconv< / a > ] < ptr to function ty> %< function ptr val> (< function args> )
2006-05-14 20:23:06 +02:00
to label < normal label> unwind label < exception label>
2005-05-07 00:57:40 +02:00
< / pre >
2002-05-07 00:08:29 +02:00
< h5 > Overview:< / h5 >
2005-05-07 00:57:40 +02:00
< p > The '< tt > invoke< / tt > ' instruction causes control to transfer to a specified
function, with the possibility of control flow transfer to either the
2005-05-12 18:52:32 +02:00
'< tt > normal< / tt > ' label or the
'< tt > exception< / tt > ' label. If the callee function returns with the
2005-05-07 00:57:40 +02:00
"< tt > < a href = "#i_ret" > ret< / a > < / tt > " instruction, control flow will return to the
"normal" label. If the callee (or any indirect callees) returns with the "< a
2005-05-12 18:52:32 +02:00
href="#i_unwind">< tt > unwind< / tt > < / a > " instruction, control is interrupted and
continued at the dynamically nearest "exception" label.< / p >
2005-05-07 00:57:40 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2005-05-07 00:57:40 +02:00
2003-11-08 02:05:38 +01:00
< p > This instruction requires several arguments:< / p >
2005-05-07 00:57:40 +02:00
2001-06-06 22:29:01 +02:00
< ol >
2005-05-07 00:57:40 +02:00
< li >
2005-05-14 00:25:59 +02:00
The optional "cconv" marker indicates which < a href = "callingconv" > calling
2005-05-07 00:57:40 +02:00
convention< / a > the call should use. If none is specified, the call defaults
to using C calling conventions.
< / li >
< li > '< tt > ptr to function ty< / tt > ': shall be the signature of the pointer to
function value being invoked. In most cases, this is a direct function
invocation, but indirect < tt > invoke< / tt > s are just as possible, branching off
an arbitrary pointer to function value.
< / li >
< li > '< tt > function ptr val< / tt > ': An LLVM value containing a pointer to a
function to be invoked. < / li >
< li > '< tt > function args< / tt > ': argument list whose types match the function
signature argument types. If the function signature indicates the function
accepts a variable number of arguments, the extra arguments can be
specified. < / li >
< li > '< tt > normal label< / tt > ': the label reached when the called function
executes a '< tt > < a href = "#i_ret" > ret< / a > < / tt > ' instruction. < / li >
< li > '< tt > exception label< / tt > ': the label reached when a callee returns with
the < a href = "#i_unwind" > < tt > unwind< / tt > < / a > instruction. < / li >
2001-06-06 22:29:01 +02:00
< / ol >
2005-05-07 00:57:40 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2005-05-07 00:57:40 +02:00
2003-11-08 02:05:38 +01:00
< p > This instruction is designed to operate as a standard '< tt > < a
2005-05-07 00:57:40 +02:00
href="#i_call">call< / a > < / tt > ' instruction in most regards. The primary
difference is that it establishes an association with a label, which is used by
the runtime library to unwind the stack.< / p >
< p > This instruction is used in languages with destructors to ensure that proper
cleanup is performed in the case of either a < tt > longjmp< / tt > or a thrown
exception. Additionally, this is important for implementation of
'< tt > catch< / tt > ' clauses in high-level languages that support them.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2005-05-07 00:57:40 +02:00
< pre >
%retval = invoke int %Test(int 15) to label %Continue
2006-05-14 20:23:06 +02:00
unwind label %TestCleanup < i > ; {int}:retval set< / i >
2005-05-07 00:57:40 +02:00
%retval = invoke < a href = "#callingconv" > coldcc< / a > int %Test(int 15) to label %Continue
2006-05-14 20:23:06 +02:00
unwind label %TestCleanup < i > ; {int}:retval set< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2004-10-16 20:04:13 +02:00
2003-09-03 02:41:47 +02:00
<!-- _______________________________________________________________________ -->
2004-10-16 20:04:13 +02:00
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_unwind" > '< tt > unwind< / tt > '
Instruction< / a > < / div >
2004-10-16 20:04:13 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-10-16 20:04:13 +02:00
2003-09-03 02:41:47 +02:00
< h5 > Syntax:< / h5 >
2004-10-16 20:04:13 +02:00
< pre >
unwind
< / pre >
2003-09-03 02:41:47 +02:00
< h5 > Overview:< / h5 >
2004-10-16 20:04:13 +02:00
< p > The '< tt > unwind< / tt > ' instruction unwinds the stack, continuing control flow
at the first callee in the dynamic call stack which used an < a
href="#i_invoke">< tt > invoke< / tt > < / a > instruction to perform the call. This is
primarily used to implement exception handling.< / p >
2003-09-03 02:41:47 +02:00
< h5 > Semantics:< / h5 >
2004-10-16 20:04:13 +02:00
< p > The '< tt > unwind< / tt > ' intrinsic causes execution of the current function to
immediately halt. The dynamic call stack is then searched for the first < a
href="#i_invoke">< tt > invoke< / tt > < / a > instruction on the call stack. Once found,
execution continues at the "exceptional" destination block specified by the
< tt > invoke< / tt > instruction. If there is no < tt > invoke< / tt > instruction in the
dynamic call chain, undefined behavior results.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-10-16 20:04:13 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_unreachable" > '< tt > unreachable< / tt > '
Instruction< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
unreachable
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > unreachable< / tt > ' instruction has no defined semantics. This
instruction is used to inform the optimizer that a particular portion of the
code is not reachable. This can be used to indicate that the code after a
no-return function cannot be reached, and other facts.< / p >
< h5 > Semantics:< / h5 >
< p > The '< tt > unreachable< / tt > ' instruction has no defined semantics.< / p >
< / div >
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsection" > < a name = "binaryops" > Binary Operations< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-11-25 02:02:51 +01:00
< p > Binary operators are used to do most of the computation in a
program. They require two operands, execute an operation on them, and
2004-12-10 16:51:16 +01:00
produce a single value. The operands might represent
2004-08-12 21:12:28 +02:00
multiple data, as is the case with the < a href = "#t_packed" > packed< / a > data type.
The result value of a binary operator is not
2003-11-25 02:02:51 +01:00
necessarily the same type as its operands.< / p >
2003-11-08 02:05:38 +01:00
< p > There are several different binary operators:< / p >
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_add" > '< tt > add< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = add < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The '< tt > add< / tt > ' instruction returns the sum of its two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > add< / tt > ' instruction must be either < a
2004-08-12 21:12:28 +02:00
href="#t_integer">integer< / a > or < a href = "#t_floating" > floating point< / a > values.
This instruction can also take < a href = "#t_packed" > packed< / a > versions of the values.
Both arguments must have identical types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The value produced is the integer or floating point sum of the two
operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = add int 4, %var < i > ; yields {int}:result = 4 + %var< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_sub" > '< tt > sub< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = sub < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The '< tt > sub< / tt > ' instruction returns the difference of its two
operands.< / p >
2003-11-25 02:02:51 +01:00
< p > Note that the '< tt > sub< / tt > ' instruction is used to represent the '< tt > neg< / tt > '
instruction present in most other intermediate representations.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > sub< / tt > ' instruction must be either < a
2003-11-25 02:02:51 +01:00
href="#t_integer">integer< / a > or < a href = "#t_floating" > floating point< / a >
2004-08-12 21:12:28 +02:00
values.
This instruction can also take < a href = "#t_packed" > packed< / a > versions of the values.
Both arguments must have identical types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The value produced is the integer or floating point difference of
the two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = sub int 4, %var < i > ; yields {int}:result = 4 - %var< / i >
2001-06-06 22:29:01 +02:00
< result> = sub int 0, %val < i > ; yields {int}:result = -%var< / i >
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_mul" > '< tt > mul< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = mul < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > mul< / tt > ' instruction returns the product of its two
operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > mul< / tt > ' instruction must be either < a
2003-11-25 02:02:51 +01:00
href="#t_integer">integer< / a > or < a href = "#t_floating" > floating point< / a >
2004-08-12 21:12:28 +02:00
values.
This instruction can also take < a href = "#t_packed" > packed< / a > versions of the values.
Both arguments must have identical types.< / p >
2003-11-08 02:05:38 +01:00
< h5 > Semantics:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The value produced is the integer or floating point product of the
two operands.< / p >
< p > There is no signed vs unsigned multiplication. The appropriate
action is taken based on the type of the operand.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = mul int 4, %var < i > ; yields {int}:result = 4 * %var< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2006-10-26 08:15:43 +02:00
< div class = "doc_subsubsection" > < a name = "i_udiv" > '< tt > udiv< / tt > ' Instruction
< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = udiv < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > udiv< / tt > ' instruction returns the quotient of its two
operands.< / p >
< h5 > Arguments:< / h5 >
< p > The two arguments to the '< tt > udiv< / tt > ' instruction must be
< a href = "#t_integer" > integer< / a > values. Both arguments must have identical
types. This instruction can also take < a href = "#t_packed" > packed< / a > versions
of the values in which case the elements must be integers.< / p >
< h5 > Semantics:< / h5 >
< p > The value produced is the unsigned integer quotient of the two operands. This
instruction always performs an unsigned division operation, regardless of
whether the arguments are unsigned or not.< / p >
< h5 > Example:< / h5 >
< pre > < result> = udiv uint 4, %var < i > ; yields {uint}:result = 4 / %var< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_sdiv" > '< tt > sdiv< / tt > ' Instruction
< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = sdiv < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > sdiv< / tt > ' instruction returns the quotient of its two
operands.< / p >
< h5 > Arguments:< / h5 >
< p > The two arguments to the '< tt > sdiv< / tt > ' instruction must be
< a href = "#t_integer" > integer< / a > values. Both arguments must have identical
types. This instruction can also take < a href = "#t_packed" > packed< / a > versions
of the values in which case the elements must be integers.< / p >
< h5 > Semantics:< / h5 >
< p > The value produced is the signed integer quotient of the two operands. This
instruction always performs a signed division operation, regardless of whether
the arguments are signed or not.< / p >
< h5 > Example:< / h5 >
< pre > < result> = sdiv int 4, %var < i > ; yields {int}:result = 4 / %var< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_fdiv" > '< tt > fdiv< / tt > '
2003-11-25 02:02:51 +01:00
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2006-10-26 08:15:43 +02:00
< pre > < result> = fdiv < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2006-10-26 08:15:43 +02:00
< p > The '< tt > fdiv< / tt > ' instruction returns the quotient of its two
2003-11-25 02:02:51 +01:00
operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2006-10-26 08:15:43 +02:00
< p > The two arguments to the '< tt > div< / tt > ' instruction must be
< a href = "#t_floating" > floating point< / a > values. Both arguments must have
identical types. This instruction can also take < a href = "#t_packed" > packed< / a >
versions of the values in which case the elements must be floating point.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2006-10-26 08:15:43 +02:00
< p > The value produced is the floating point quotient of the two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2006-10-26 08:15:43 +02:00
< pre > < result> = fdiv float 4.0, %var < i > ; yields {float}:result = 4.0 / %var< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2006-11-02 02:53:59 +01:00
< div class = "doc_subsubsection" > < a name = "i_urem" > '< tt > urem< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = urem < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > urem< / tt > ' instruction returns the remainder from the
unsigned division of its two arguments.< / p >
< h5 > Arguments:< / h5 >
< p > The two arguments to the '< tt > urem< / tt > ' instruction must be
< a href = "#t_integer" > integer< / a > values. Both arguments must have identical
types.< / p >
< h5 > Semantics:< / h5 >
< p > This instruction returns the unsigned integer < i > remainder< / i > of a division.
This instruction always performs an unsigned division to get the remainder,
regardless of whether the arguments are unsigned or not.< / p >
< h5 > Example:< / h5 >
< pre > < result> = urem uint 4, %var < i > ; yields {uint}:result = 4 % %var< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_srem" > '< tt > srem< / tt > '
2003-11-25 02:02:51 +01:00
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2006-11-02 02:53:59 +01:00
< pre > < result> = srem < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-02 02:53:59 +01:00
< p > The '< tt > srem< / tt > ' instruction returns the remainder from the
signed division of its two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2006-11-02 02:53:59 +01:00
< p > The two arguments to the '< tt > srem< / tt > ' instruction must be
< a href = "#t_integer" > integer< / a > values. Both arguments must have identical
types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2006-11-02 02:53:59 +01:00
< p > This instruction returns the < i > remainder< / i > of a division (where the result
2003-11-25 02:02:51 +01:00
has the same sign as the divisor), not the < i > modulus< / i > (where the
result has the same sign as the dividend) of a value. For more
2005-10-24 18:17:18 +02:00
information about the difference, see < a
2003-11-25 02:02:51 +01:00
href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
Math Forum< / a > .< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2006-11-02 02:53:59 +01:00
< pre > < result> = srem int 4, %var < i > ; yields {int}:result = 4 % %var< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_frem" > '< tt > frem< / tt > '
Instruction< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = frem < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > frem< / tt > ' instruction returns the remainder from the
division of its two operands.< / p >
< h5 > Arguments:< / h5 >
< p > The two arguments to the '< tt > frem< / tt > ' instruction must be
< a href = "#t_floating" > floating point< / a > values. Both arguments must have
identical types.< / p >
< h5 > Semantics:< / h5 >
< p > This instruction returns the < i > remainder< / i > of a division.< / p >
< h5 > Example:< / h5 >
< pre > < result> = frem float 4.0, %var < i > ; yields {float}:result = 4.0 % %var< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2006-02-17 22:18:08 +01:00
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsection" > < a name = "bitwiseops" > Bitwise Binary
Operations< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-11-25 02:02:51 +01:00
< p > Bitwise binary operators are used to do various forms of
bit-twiddling in a program. They are generally very efficient
2004-12-10 16:51:16 +01:00
instructions and can commonly be strength reduced from other
2003-11-25 02:02:51 +01:00
instructions. They require two operands, execute an operation on them,
and produce a single value. The resulting value of the bitwise binary
operators is always the same type as its first operand.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_and" > '< tt > and< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = and < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > and< / tt > ' instruction returns the bitwise logical and of
its two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > and< / tt > ' instruction must be < a
2003-11-25 02:02:51 +01:00
href="#t_integral">integral< / a > values. Both arguments must have
identical types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The truth table used for the '< tt > and< / tt > ' instruction is:< / p >
2003-11-25 02:02:51 +01:00
< p > < / p >
2004-03-01 18:47:27 +01:00
< div style = "align: center" >
2003-11-08 02:05:38 +01:00
< table border = "1" cellspacing = "0" cellpadding = "4" >
2003-11-25 02:02:51 +01:00
< tbody >
< tr >
< td > In0< / td >
< td > In1< / td >
< td > Out< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 0< / td >
< td > 0< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 1< / td >
< td > 0< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 0< / td >
< td > 0< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 1< / td >
< td > 1< / td >
< / tr >
< / tbody >
< / table >
2004-03-01 18:47:27 +01:00
< / div >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = and int 4, %var < i > ; yields {int}:result = 4 & %var< / i >
2001-06-06 22:29:01 +02:00
< result> = and int 15, 40 < i > ; yields {int}:result = 8< / i >
< result> = and int 4, 8 < i > ; yields {int}:result = 0< / i >
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_or" > '< tt > or< / tt > ' Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = or < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-25 02:02:51 +01:00
< h5 > Overview:< / h5 >
< p > The '< tt > or< / tt > ' instruction returns the bitwise logical inclusive
or of its two operands.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > or< / tt > ' instruction must be < a
2003-11-25 02:02:51 +01:00
href="#t_integral">integral< / a > values. Both arguments must have
identical types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The truth table used for the '< tt > or< / tt > ' instruction is:< / p >
2003-11-25 02:02:51 +01:00
< p > < / p >
2004-03-01 18:47:27 +01:00
< div style = "align: center" >
2003-11-25 02:02:51 +01:00
< table border = "1" cellspacing = "0" cellpadding = "4" >
< tbody >
< tr >
< td > In0< / td >
< td > In1< / td >
< td > Out< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 0< / td >
< td > 0< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 1< / td >
< td > 1< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 0< / td >
< td > 1< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 1< / td >
< td > 1< / td >
< / tr >
< / tbody >
< / table >
2004-03-01 18:47:27 +01:00
< / div >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = or int 4, %var < i > ; yields {int}:result = 4 | %var< / i >
2001-06-06 22:29:01 +02:00
< result> = or int 15, 40 < i > ; yields {int}:result = 47< / i >
< result> = or int 4, 8 < i > ; yields {int}:result = 12< / i >
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_xor" > '< tt > xor< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = xor < ty> < var1> , < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > xor< / tt > ' instruction returns the bitwise logical exclusive
or of its two operands. The < tt > xor< / tt > is used to implement the
"one's complement" operation, which is the "~" operator in C.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The two arguments to the '< tt > xor< / tt > ' instruction must be < a
2003-11-25 02:02:51 +01:00
href="#t_integral">integral< / a > values. Both arguments must have
identical types.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The truth table used for the '< tt > xor< / tt > ' instruction is:< / p >
2003-11-25 02:02:51 +01:00
< p > < / p >
2004-03-01 18:47:27 +01:00
< div style = "align: center" >
2003-11-25 02:02:51 +01:00
< table border = "1" cellspacing = "0" cellpadding = "4" >
< tbody >
< tr >
< td > In0< / td >
< td > In1< / td >
< td > Out< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 0< / td >
< td > 0< / td >
< / tr >
< tr >
< td > 0< / td >
< td > 1< / td >
< td > 1< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 0< / td >
< td > 1< / td >
< / tr >
< tr >
< td > 1< / td >
< td > 1< / td >
< td > 0< / td >
< / tr >
< / tbody >
< / table >
2004-03-01 18:47:27 +01:00
< / div >
2003-11-25 02:02:51 +01:00
< p > < / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = xor int 4, %var < i > ; yields {int}:result = 4 ^ %var< / i >
2001-06-06 22:29:01 +02:00
< result> = xor int 15, 40 < i > ; yields {int}:result = 39< / i >
< result> = xor int 4, 8 < i > ; yields {int}:result = 12< / i >
2003-09-03 02:41:47 +02:00
< result> = xor int %V, -1 < i > ; yields {int}:result = ~%V< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2003-11-25 02:02:51 +01:00
< div class = "doc_subsubsection" > < a name = "i_shl" > '< tt > shl< / tt > '
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = shl < ty> < var1> , ubyte < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > shl< / tt > ' instruction returns the first operand shifted to
the left a specified number of bits.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The first argument to the '< tt > shl< / tt > ' instruction must be an < a
2003-11-25 02:02:51 +01:00
href="#t_integer">integer< / a > type. The second argument must be an '< tt > ubyte< / tt > '
type.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The value produced is < tt > var1< / tt > * 2< sup > < tt > var2< / tt > < / sup > .< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-25 02:02:51 +01:00
< pre > < result> = shl int 4, ubyte %var < i > ; yields {int}:result = 4 < < %var< / i >
2001-06-06 22:29:01 +02:00
< result> = shl int 4, ubyte 2 < i > ; yields {int}:result = 16< / i >
< result> = shl int 1, ubyte 10 < i > ; yields {int}:result = 1024< / i >
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2006-11-08 07:47:33 +01:00
< div class = "doc_subsubsection" > < a name = "i_lshr" > '< tt > lshr< / tt > '
2003-11-25 02:02:51 +01:00
Instruction< / a > < / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2006-11-08 07:47:33 +01:00
< pre > < result> = lshr < ty> < var1> , ubyte < var2> < i > ; yields {ty}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2006-11-08 07:47:33 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2006-11-08 07:47:33 +01:00
< p > The '< tt > lshr< / tt > ' instruction (logical shift right) returns the first
operand shifted to the right a specified number of bits.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2006-11-08 07:47:33 +01:00
< p > The first argument to the '< tt > lshr< / tt > ' instruction must be an < a
href="#t_integer">integer< / a > type. The second argument must be an '< tt > ubyte< / tt > ' type.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2006-11-08 07:47:33 +01:00
< p > This instruction always performs a logical shift right operation, regardless
of whether the arguments are unsigned or not. The < tt > var2< / tt > most significant
bits will be filled with zero bits after the shift.< / p >
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2006-11-08 07:47:33 +01:00
< pre >
< result> = lshr uint 4, ubyte 1 < i > ; yields {uint}:result = 2< / i >
< result> = lshr int 4, ubyte 2 < i > ; yields {uint}:result = 1< / i >
< result> = lshr sbyte 4, ubyte 3 < i > ; yields {sbyte}:result = 0< / i >
< result> = lshr sbyte -2, ubyte 1 < i > ; yields {sbyte}:result = 0x7FFFFFFF < / i >
< / pre >
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsubsection" > < a name = "i_ashr" > '< tt > ashr< / tt > '
Instruction< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = ashr < ty> < var1> , ubyte < var2> < i > ; yields {ty}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > ashr< / tt > ' instruction (arithmetic shift right) returns the first
operand shifted to the right a specified number of bits.< / p >
< h5 > Arguments:< / h5 >
< p > The first argument to the '< tt > ashr< / tt > ' instruction must be an
< a href = "#t_integer" > integer< / a > type. The second argument must be an
'< tt > ubyte< / tt > ' type.< / p >
< h5 > Semantics:< / h5 >
< p > This instruction always performs an arithmetic shift right operation,
regardless of whether the arguments are signed or not. The < tt > var2< / tt > most
significant bits will be filled with the sign bit of < tt > var1< / tt > .< / p >
< h5 > Example:< / h5 >
< pre >
< result> = ashr uint 4, ubyte 1 < i > ; yields {uint}:result = 2< / i >
< result> = ashr int 4, ubyte 2 < i > ; yields {int}:result = 1< / i >
< result> = ashr ubyte 4, ubyte 3 < i > ; yields {ubyte}:result = 0< / i >
< result> = ashr sbyte -2, ubyte 1 < i > ; yields {sbyte}:result = -1< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2005-11-06 09:02:57 +01:00
< div class = "doc_subsection" >
2006-04-09 01:07:04 +02:00
< a name = "vectorops" > Vector Operations< / a >
2005-11-06 09:02:57 +01:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p > LLVM supports several instructions to represent vector operations in a
target-independent manner. This instructions cover the element-access and
vector-specific operations needed to process vectors effectively. While LLVM
does directly support these vector operations, many sophisticated algorithms
will want to use target-specific intrinsics to take full advantage of a specific
target.< / p >
2005-11-06 09:02:57 +01:00
2003-11-08 02:05:38 +01:00
< / div >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2005-11-06 09:02:57 +01:00
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_extractelement" > '< tt > extractelement< / tt > ' Instruction< / a >
2005-11-06 09:02:57 +01:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
< result> = extractelement < n x < ty> > < val> , uint < idx> < i > ; yields < ty> < / i >
2001-06-06 22:29:01 +02:00
< / pre >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The '< tt > extractelement< / tt > ' instruction extracts a single scalar
element from a packed vector at a specified index.
< / p >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< h5 > Arguments:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The first operand of an '< tt > extractelement< / tt > ' instruction is a
value of < a href = "#t_packed" > packed< / a > type. The second operand is
an index indicating the position from which to extract the element.
The index may be a variable.< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The result is a scalar of the same type as the element type of
< tt > val< / tt > . Its value is the value at position < tt > idx< / tt > of
< tt > val< / tt > . If < tt > idx< / tt > exceeds the length of < tt > val< / tt > , the
results are undefined.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2003-11-08 02:05:38 +01:00
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
%result = extractelement < 4 x int> %vec, uint 0 < i > ; yields int< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2005-11-06 09:02:57 +01:00
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_insertelement" > '< tt > insertelement< / tt > ' Instruction< / a >
2005-11-06 09:02:57 +01:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
< result> = insertelement < n x < ty> > < val> , < ty> < elt& gt, uint < idx> < i > ; yields < n x < ty> > < / i >
2001-06-06 22:29:01 +02:00
< / pre >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The '< tt > insertelement< / tt > ' instruction inserts a scalar
element into a packed vector at a specified index.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The first operand of an '< tt > insertelement< / tt > ' instruction is a
value of < a href = "#t_packed" > packed< / a > type. The second operand is a
scalar value whose type must equal the element type of the first
operand. The third operand is an index indicating the position at
which to insert the value. The index may be a variable.< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The result is a packed vector of the same type as < tt > val< / tt > . Its
element values are those of < tt > val< / tt > except at position
< tt > idx< / tt > , where it gets the value < tt > elt< / tt > . If < tt > idx< / tt >
exceeds the length of < tt > val< / tt > , the results are undefined.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
%result = insertelement < 4 x int> %vec, int 1, uint 0 < i > ; yields < 4 x int> < / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2005-11-06 09:02:57 +01:00
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_shufflevector" > '< tt > shufflevector< / tt > ' Instruction< / a >
2005-11-06 09:02:57 +01:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
< result> = shufflevector < n x < ty> > < v1> , < n x < ty> > < v2> , < n x uint> < mask> < i > ; yields < n x < ty> > < / i >
2001-06-06 22:29:01 +02:00
< / pre >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The '< tt > shufflevector< / tt > ' instruction constructs a permutation of elements
from two input vectors, returning a vector of the same type.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The first two operands of a '< tt > shufflevector< / tt > ' instruction are vectors
with types that match each other and types that match the result of the
instruction. The third argument is a shuffle mask, which has the same number
of elements as the other vector type, but whose element type is always 'uint'.
< / p >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The shuffle mask operand is required to be a constant vector with either
constant integer or undef values.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2005-11-06 09:02:57 +01:00
2006-04-09 01:07:04 +02:00
< p >
The elements of the two input vectors are numbered from left to right across
both of the vectors. The shuffle mask operand specifies, for each element of
the result vector, which element of the two input registers the result element
gets. The element selector may be undef (meaning "don't care") and the second
operand may be undef if performing a shuffle from only one vector.
< / p >
2005-11-06 09:02:57 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2005-11-06 09:02:57 +01:00
< pre >
2006-04-09 01:07:04 +02:00
%result = shufflevector < 4 x int> %v1, < 4 x int> %v2,
< 4 x uint> < uint 0, uint 4, uint 1, uint 5> < i > ; yields < 4 x int> < / i >
%result = shufflevector < 4 x int> %v1, < 4 x int> undef,
< 4 x uint> < uint 0, uint 1, uint 2, uint 3> < i > ; yields < 4 x int> < / i > - Identity shuffle.
2002-04-14 08:13:44 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2005-11-06 09:02:57 +01:00
2006-04-14 21:24:33 +02:00
2001-06-06 22:29:01 +02:00
<!-- ======================================================================= -->
2006-04-09 01:07:04 +02:00
< div class = "doc_subsection" >
2006-08-15 02:45:58 +02:00
< a name = "memoryops" > Memory Access and Addressing Operations< / a >
2003-11-08 02:05:38 +01:00
< / div >
2006-04-09 01:07:04 +02:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2006-04-09 01:07:04 +02:00
< p > A key design point of an SSA-based representation is how it
represents memory. In LLVM, no memory locations are in SSA form, which
makes things very simple. This section describes how to read, write,
allocate, and free memory in LLVM.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-03-12 06:50:16 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2004-03-12 06:50:16 +01:00
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_malloc" > '< tt > malloc< / tt > ' Instruction< / a >
2004-03-12 06:50:16 +01:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-03-12 06:50:16 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2004-03-12 06:50:16 +01:00
< pre >
2006-04-09 01:07:04 +02:00
< result> = malloc < type> [, uint < NumElements> ][, align < alignment> ] < i > ; yields {type*}:result< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2004-03-12 06:50:16 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > The '< tt > malloc< / tt > ' instruction allocates memory from the system
heap and returns a pointer to it.< / p >
2004-03-12 06:50:16 +01:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > The '< tt > malloc< / tt > ' instruction allocates
< tt > sizeof(< type> )*NumElements< / tt >
bytes of memory from the operating system and returns a pointer of the
appropriate type to the program. If "NumElements" is specified, it is the
number of elements allocated. If an alignment is specified, the value result
of the allocation is guaranteed to be aligned to at least that boundary. If
not specified, or if zero, the target can choose to align the allocation on any
convenient boundary.< / p >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > '< tt > type< / tt > ' must be a sized type.< / p >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< h5 > Semantics:< / h5 >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > Memory is allocated using the system "< tt > malloc< / tt > " function, and
a pointer is returned.< / p >
2004-03-12 06:50:16 +01:00
2002-05-07 00:08:29 +02:00
< h5 > Example:< / h5 >
2004-03-12 06:50:16 +01:00
< pre >
2006-04-09 01:07:04 +02:00
%array = malloc [4 x ubyte ] < i > ; yields {[%4 x ubyte]*}:array< / i >
%size = < a href = "#i_add" > add< / a > uint 2, 2 < i > ; yields {uint}:size = uint 4< / i >
%array1 = malloc ubyte, uint 4 < i > ; yields {ubyte*}:array1< / i >
%array2 = malloc [12 x ubyte], uint %size < i > ; yields {[12 x ubyte]*}:array2< / i >
%array3 = malloc int, uint 4, align 1024 < i > ; yields {int*}:array3< / i >
%array4 = malloc int, align 1024 < i > ; yields {int*}:array4< / i >
2001-06-06 22:29:01 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2004-03-12 06:50:16 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_free" > '< tt > free< / tt > ' Instruction< / a >
2004-03-12 06:50:16 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
free < type> < value> < i > ; yields {void}< / i >
2004-03-12 06:50:16 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The '< tt > free< / tt > ' instruction returns memory back to the unused
memory heap to be reallocated in the future.< / p >
2004-03-12 06:50:16 +01:00
< h5 > Arguments:< / h5 >
2006-04-09 01:07:04 +02:00
< p > '< tt > value< / tt > ' shall be a pointer value that points to a value
that was allocated with the '< tt > < a href = "#i_malloc" > malloc< / a > < / tt > '
instruction.< / p >
2004-03-12 06:50:16 +01:00
< h5 > Semantics:< / h5 >
2006-04-09 01:07:04 +02:00
< p > Access to the memory pointed to by the pointer is no longer defined
after this instruction executes.< / p >
2004-03-12 06:50:16 +01:00
< h5 > Example:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
%array = < a href = "#i_malloc" > malloc< / a > [4 x ubyte] < i > ; yields {[4 x ubyte]*}:array< / i >
free [4 x ubyte]* %array
2004-03-12 06:50:16 +01:00
< / pre >
< / div >
2006-02-17 22:18:08 +01:00
<!-- _______________________________________________________________________ -->
2006-04-09 01:07:04 +02:00
< div class = "doc_subsubsection" >
< a name = "i_alloca" > '< tt > alloca< / tt > ' Instruction< / a >
< / div >
2006-02-17 22:18:08 +01:00
< div class = "doc_text" >
2006-04-09 01:07:04 +02:00
2006-02-17 22:18:08 +01:00
< h5 > Syntax:< / h5 >
2006-04-09 01:07:04 +02:00
< pre >
< result> = alloca < type> [, uint < NumElements> ][, align < alignment> ] < i > ; yields {type*}:result< / i >
2006-02-17 22:18:08 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The '< tt > alloca< / tt > ' instruction allocates memory on the current
stack frame of the procedure that is live until the current function
returns to its caller.< / p >
2006-02-17 22:18:08 +01:00
< h5 > Arguments:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The '< tt > alloca< / tt > ' instruction allocates < tt > sizeof(< type> )*NumElements< / tt >
bytes of memory on the runtime stack, returning a pointer of the
appropriate type to the program. If "NumElements" is specified, it is the
number of elements allocated. If an alignment is specified, the value result
of the allocation is guaranteed to be aligned to at least that boundary. If
not specified, or if zero, the target can choose to align the allocation on any
convenient boundary.< / p >
2006-02-17 22:18:08 +01:00
2006-04-09 01:07:04 +02:00
< p > '< tt > type< / tt > ' may be any sized type.< / p >
2006-02-17 22:18:08 +01:00
2006-04-09 01:07:04 +02:00
< h5 > Semantics:< / h5 >
2006-02-17 22:18:08 +01:00
2006-04-09 01:07:04 +02:00
< p > Memory is allocated; a pointer is returned. '< tt > alloca< / tt > 'd
memory is automatically released when the function returns. The '< tt > alloca< / tt > '
instruction is commonly used to represent automatic variables that must
have an address available. When the function returns (either with the < tt > < a
href="#i_ret">ret< / a > < / tt > or < tt > < a href = "#i_unwind" > unwind< / a > < / tt >
instructions), the memory is reclaimed.< / p >
2006-02-17 22:18:08 +01:00
2006-03-14 21:55:28 +01:00
< h5 > Example:< / h5 >
2006-04-09 01:07:04 +02:00
< pre >
%ptr = alloca int < i > ; yields {int*}:ptr< / i >
%ptr = alloca int, uint 4 < i > ; yields {int*}:ptr< / i >
%ptr = alloca int, uint 4, align 1024 < i > ; yields {int*}:ptr< / i >
%ptr = alloca int, align 1024 < i > ; yields {int*}:ptr< / i >
2006-03-14 21:55:28 +01:00
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
2006-04-09 01:07:04 +02:00
< div class = "doc_subsubsection" > < a name = "i_load" > '< tt > load< / tt > '
2006-03-14 21:55:28 +01:00
Instruction< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
2006-04-09 01:07:04 +02:00
< pre > < result> = load < ty> * < pointer> < br > < result> = volatile load < ty> * < pointer> < br > < / pre >
2006-03-14 21:55:28 +01:00
< h5 > Overview:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The '< tt > load< / tt > ' instruction is used to read from memory.< / p >
2006-03-14 21:55:28 +01:00
< h5 > Arguments:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The argument to the '< tt > load< / tt > ' instruction specifies the memory
address from which to load. The pointer must point to a < a
href="#t_firstclass">first class< / a > type. If the < tt > load< / tt > is
marked as < tt > volatile< / tt > , then the optimizer is not allowed to modify
the number or order of execution of this < tt > load< / tt > with other
volatile < tt > load< / tt > and < tt > < a href = "#i_store" > store< / a > < / tt >
instructions. < / p >
2006-03-14 21:55:28 +01:00
< h5 > Semantics:< / h5 >
2006-04-09 01:07:04 +02:00
< p > The location of memory pointed to is loaded.< / p >
< h5 > Examples:< / h5 >
< pre > %ptr = < a href = "#i_alloca" > alloca< / a > int < i > ; yields {int*}:ptr< / i >
< a
href="#i_store">store< / a > int 3, int* %ptr < i > ; yields {void}< / i >
%val = load int* %ptr < i > ; yields {int}:val = int 3< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_store" > '< tt > store< / tt > '
Instruction< / a > < / div >
2006-11-09 22:18:01 +01:00
< div class = "doc_text" >
2006-04-09 01:07:04 +02:00
< h5 > Syntax:< / h5 >
< pre > store < ty> < value> , < ty> * < pointer> < i > ; yields {void}< / i >
volatile store < ty> < value> , < ty> * < pointer> < i > ; yields {void}< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > store< / tt > ' instruction is used to write to memory.< / p >
< h5 > Arguments:< / h5 >
< p > There are two arguments to the '< tt > store< / tt > ' instruction: a value
to store and an address in which to store it. The type of the '< tt > < pointer> < / tt > '
operand must be a pointer to the type of the '< tt > < value> < / tt > '
operand. If the < tt > store< / tt > is marked as < tt > volatile< / tt > , then the
optimizer is not allowed to modify the number or order of execution of
this < tt > store< / tt > with other volatile < tt > load< / tt > and < tt > < a
href="#i_store">store< / a > < / tt > instructions.< / p >
< h5 > Semantics:< / h5 >
< p > The contents of memory are updated to contain '< tt > < value> < / tt > '
at the location specified by the '< tt > < pointer> < / tt > ' operand.< / p >
2006-02-17 22:18:08 +01:00
< h5 > Example:< / h5 >
2006-04-09 01:07:04 +02:00
< pre > %ptr = < a href = "#i_alloca" > alloca< / a > int < i > ; yields {int*}:ptr< / i >
< a
href="#i_store">store< / a > int 3, int* %ptr < i > ; yields {void}< / i >
%val = load int* %ptr < i > ; yields {int}:val = int 3< / i >
2006-02-17 22:18:08 +01:00
< / pre >
2006-11-09 22:15:49 +01:00
< / div >
2006-02-17 22:18:08 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_getelementptr" > '< tt > getelementptr< / tt > ' Instruction< / a >
2006-02-17 22:18:08 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
< result> = getelementptr < ty> * < ptrval> {, < ty> < idx> }*
2006-02-17 22:18:08 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-04-09 01:07:04 +02:00
The '< tt > getelementptr< / tt > ' instruction is used to get the address of a
subelement of an aggregate data structure.< / p >
2006-02-17 22:18:08 +01:00
< h5 > Arguments:< / h5 >
2006-04-09 01:07:04 +02:00
< p > This instruction takes a list of integer constants that indicate what
elements of the aggregate object to index to. The actual types of the arguments
provided depend on the type of the first pointer argument. The
'< tt > getelementptr< / tt > ' instruction is used to index down through the type
levels of a structure or to a specific index in an array. When indexing into a
structure, only < tt > uint< / tt >
integer constants are allowed. When indexing into an array or pointer,
2006-11-18 22:50:54 +01:00
< tt > int< / tt > and < tt > long< / tt > and < tt > ulong< / tt > indexes are allowed.< / p >
2006-02-17 22:18:08 +01:00
2006-04-09 01:07:04 +02:00
< p > For example, let's consider a C code fragment and how it gets
compiled to LLVM:< / p >
2006-02-17 22:18:08 +01:00
< pre >
2006-04-09 01:07:04 +02:00
struct RT {
char A;
int B[10][20];
char C;
};
struct ST {
int X;
double Y;
struct RT Z;
};
int *foo(struct ST *s) {
return & s[1].Z.B[5][13];
}
2006-02-17 22:18:08 +01:00
< / pre >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > The LLVM code generated by the GCC frontend is:< / p >
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
< pre >
%RT = type { sbyte, [10 x [20 x int]], sbyte }
%ST = type { int, double, %RT }
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
implementation
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
int* %foo(%ST* %s) {
entry:
%reg = getelementptr %ST* %s, int 1, uint 2, uint 1, int 5, int 13
ret int* %reg
}
2006-01-05 18:37:02 +01:00
< / pre >
2006-04-09 01:07:04 +02:00
< h5 > Semantics:< / h5 >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > The index types specified for the '< tt > getelementptr< / tt > ' instruction depend
on the pointer type that is being indexed into. < a href = "#t_pointer" > Pointer< / a >
2006-11-18 22:50:54 +01:00
and < a href = "#t_array" > array< / a > types require < tt > int< / tt > ,
2006-04-09 01:07:04 +02:00
< tt > ulong< / tt > , or < tt > long< / tt > values, and < a href = "#t_struct" > structure< / a >
types require < tt > uint< / tt > < b > constants< / b > .< / p >
2004-03-12 06:50:16 +01:00
2006-04-09 01:07:04 +02:00
< p > In the example above, the first index is indexing into the '< tt > %ST*< / tt > '
type, which is a pointer, yielding a '< tt > %ST< / tt > ' = '< tt > { int, double, %RT
}< / tt > ' type, a structure. The second index indexes into the third element of
the structure, yielding a '< tt > %RT< / tt > ' = '< tt > { sbyte, [10 x [20 x int]],
sbyte }< / tt > ' type, another structure. The third index indexes into the second
element of the structure, yielding a '< tt > [10 x [20 x int]]< / tt > ' type, an
array. The two dimensions of the array are subscripted into, yielding an
'< tt > int< / tt > ' type. The '< tt > getelementptr< / tt > ' instruction returns a pointer
to this element, thus computing a value of '< tt > int*< / tt > ' type.< / p >
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
< p > Note that it is perfectly legal to index partially through a
structure, returning a pointer to an inner element. Because of this,
the LLVM code for the given testcase is equivalent to:< / p >
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
< pre >
int* %foo(%ST* %s) {
%t1 = getelementptr %ST* %s, int 1 < i > ; yields %ST*:%t1< / i >
%t2 = getelementptr %ST* %t1, int 0, uint 2 < i > ; yields %RT*:%t2< / i >
%t3 = getelementptr %RT* %t2, int 0, uint 1 < i > ; yields [10 x [20 x int]]*:%t3< / i >
%t4 = getelementptr [10 x [20 x int]]* %t3, int 0, int 5 < i > ; yields [20 x int]*:%t4< / i >
%t5 = getelementptr [20 x int]* %t4, int 0, int 13 < i > ; yields int*:%t5< / i >
ret int* %t5
}
< / pre >
2006-01-05 18:37:02 +01:00
2006-04-09 01:07:04 +02:00
< p > Note that it is undefined to access an array out of bounds: array and
pointer indexes must always be within the defined bounds of the array type.
The one exception for this rules is zero length arrays. These arrays are
defined to be accessible as variable length arrays, which requires access
beyond the zero'th element.< / p >
2006-01-05 18:37:02 +01:00
2006-08-15 02:45:58 +02:00
< p > The getelementptr instruction is often confusing. For some more insight
into how it works, see < a href = "GetElementPtr.html" > the getelementptr
FAQ< / a > .< / p >
2006-01-05 18:37:02 +01:00
< h5 > Example:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
< i > ; yields [12 x ubyte]*:aptr< / i >
%aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, uint 1
2006-01-05 18:37:02 +01:00
< / pre >
2006-04-09 01:07:04 +02:00
< / div >
2006-11-09 22:15:49 +01:00
2006-04-09 01:07:04 +02:00
<!-- ======================================================================= -->
2006-11-08 02:18:52 +01:00
< div class = "doc_subsection" > < a name = "convertops" > Conversion Operations< / a >
2006-04-09 01:07:04 +02:00
< / div >
< div class = "doc_text" >
2006-11-08 02:18:52 +01:00
< p > The instructions in this category are the conversion instructions (casting)
which all take a single operand and a type. They perform various bit conversions
on the operand.< / p >
2006-04-09 01:07:04 +02:00
< / div >
2004-03-12 06:50:16 +01:00
2006-01-15 21:48:27 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-08 02:11:31 +01:00
< a name = "i_trunc" > '< tt > trunc .. to< / tt > ' Instruction< / a >
2006-01-15 21:48:27 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-08 02:11:31 +01:00
< result> = trunc < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-01-15 21:48:27 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-11-08 02:11:31 +01:00
The '< tt > trunc< / tt > ' instruction truncates its operand to the type < tt > ty2< / tt > .
2006-01-15 21:48:27 +01:00
< / p >
< h5 > Arguments:< / h5 >
2006-11-08 02:11:31 +01:00
< p >
The '< tt > trunc< / tt > ' instruction takes a < tt > value< / tt > to trunc, which must
be an < a href = "#t_integer" > integer< / a > type, and a type that specifies the size
and type of the result, which must be an < a href = "#t_integral" > integral< / a >
2006-11-10 00:03:26 +01:00
type. The bit size of < tt > value< / tt > must be larger than the bit size of
< tt > ty2< / tt > . Equal sized types are not allowed.< / p >
2006-01-15 21:48:27 +01:00
2006-11-08 02:11:31 +01:00
< h5 > Semantics:< / h5 >
2006-01-15 21:48:27 +01:00
< p >
2006-11-08 02:11:31 +01:00
The '< tt > trunc< / tt > ' instruction truncates the high order bits in < tt > value< / tt >
2006-11-10 00:03:26 +01:00
and converts the remaining bits to < tt > ty2< / tt > . Since the source size must be
larger than the destination size, < tt > trunc< / tt > cannot be a < i > no-op cast< / i > .
It will always truncate bits.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
< pre >
%X = trunc int 257 to ubyte < i > ; yields ubyte:1< / i >
%Y = trunc int 123 to bool < i > ; yields bool:true< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_zext" > '< tt > zext .. to< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
< result> = zext < ty> < value> to < ty2> < i > ; yields ty2< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > zext< / tt > ' instruction zero extends its operand to type
< tt > ty2< / tt > .< / p >
< h5 > Arguments:< / h5 >
< p > The '< tt > zext< / tt > ' instruction takes a value to cast, which must be of
< a href = "#t_integral" > integral< / a > type, and a type to cast it to, which must
also be of < a href = "#t_integral" > integral< / a > type. The bit size of the
2006-11-10 00:03:26 +01:00
< tt > value< / tt > must be smaller than the bit size of the destination type,
< tt > ty2< / tt > .< / p >
2006-01-15 21:48:27 +01:00
< h5 > Semantics:< / h5 >
2006-11-08 02:11:31 +01:00
< p > The < tt > zext< / tt > fills the high order bits of the < tt > value< / tt > with zero
bits until it reaches the size of the destination type, < tt > ty2< / tt > . When the
the operand and the type are the same size, no bit filling is done and the
cast is considered a < i > no-op cast< / i > because no bits change (only the type
changes).< / p >
2006-11-10 00:03:26 +01:00
< p > When zero extending from bool, the result will alwasy be either 0 or 1.< / p >
2006-01-15 21:48:27 +01:00
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
< pre >
%X = zext int 257 to ulong < i > ; yields ulong:257< / i >
%Y = zext bool true to int < i > ; yields int:1< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_sext" > '< tt > sext .. to< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
< result> = sext < ty> < value> to < ty2> < i > ; yields ty2< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > sext< / tt > ' sign extends < tt > value< / tt > to the type < tt > ty2< / tt > .< / p >
< h5 > Arguments:< / h5 >
2006-01-15 21:48:27 +01:00
< p >
2006-11-08 02:11:31 +01:00
The '< tt > sext< / tt > ' instruction takes a value to cast, which must be of
< a href = "#t_integral" > integral< / a > type, and a type to cast it to, which must
2006-11-10 00:03:26 +01:00
also be of < a href = "#t_integral" > integral< / a > type. The bit size of the
< tt > value< / tt > must be smaller than the bit size of the destination type,
< tt > ty2< / tt > .< / p >
2006-04-09 01:07:04 +02:00
2006-11-08 02:11:31 +01:00
< h5 > Semantics:< / h5 >
2006-04-09 01:07:04 +02:00
< p >
2006-11-08 02:11:31 +01:00
The '< tt > sext< / tt > ' instruction performs a sign extension by copying the sign
bit (highest order bit) of the < tt > value< / tt > until it reaches the bit size of
the type < tt > ty2< / tt > . When the the operand and the type are the same size,
no bit filling is done and the cast is considered a < i > no-op cast< / i > because
no bits change (only the type changes).< / p >
2006-11-10 00:03:26 +01:00
< p > When sign extending from bool, the extension always results in -1 or 0.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
< pre >
%X = sext sbyte -1 to ushort < i > ; yields ushort:65535< / i >
%Y = sext bool true to int < i > ; yields int:-1< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-09 22:48:10 +01:00
< a name = "i_fptrunc" > '< tt > fptrunc .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
2006-11-09 22:48:10 +01:00
2006-11-08 02:11:31 +01:00
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
2006-11-09 22:48:10 +01:00
2006-11-08 02:11:31 +01:00
< pre >
2006-11-09 22:48:10 +01:00
< result> = fptrunc < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-09 22:48:10 +01:00
< p > The '< tt > fptrunc< / tt > ' instruction truncates < tt > value< / tt > to type
< tt > ty2< / tt > .< / p >
2006-11-08 02:11:31 +01:00
< h5 > Arguments:< / h5 >
2006-11-09 22:48:10 +01:00
< p > The '< tt > fptrunc< / tt > ' instruction takes a < a href = "#t_floating" > floating
point< / a > value to cast and a < a href = "#t_floating" > floating point< / a > type to
cast it to. The size of < tt > value< / tt > must be larger than the size of
< tt > ty2< / tt > . This implies that < tt > fptrunc< / tt > cannot be used to make a
< i > no-op cast< / i > .< / p >
2006-11-08 02:11:31 +01:00
< h5 > Semantics:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > fptrunc< / tt > ' instruction truncates a < tt > value< / tt > from a larger
< a href = "#t_floating" > floating point< / a > type to a smaller
< a href = "#t_floating" > floating point< / a > type. If the value cannot fit within
the destination type, < tt > ty2< / tt > , then the results are undefined.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
< pre >
2006-11-09 22:48:10 +01:00
%X = fptrunc double 123.0 to float < i > ; yields float:123.0< / i >
%Y = fptrunc double 1.0E+300 to float < i > ; yields undefined< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-09 22:48:10 +01:00
< a name = "i_fpext" > '< tt > fpext .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-09 22:48:10 +01:00
< result> = fpext < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-09 22:48:10 +01:00
< p > The '< tt > fpext< / tt > ' extends a floating point < tt > value< / tt > to a larger
floating point value.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Arguments:< / h5 >
2006-11-09 22:48:10 +01:00
< p > The '< tt > fpext< / tt > ' instruction takes a
< a href = "#t_floating" > floating point< / a > < tt > value< / tt > to cast,
2006-11-10 00:03:26 +01:00
and a < a href = "#t_floating" > floating point< / a > type to cast it to. The source
type must be smaller than the destination type.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Semantics:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > fpext< / tt > ' instruction extends the < tt > value< / tt > from a smaller
< a href = "t_floating" > floating point< / a > type to a larger
< a href = "t_floating" > floating point< / a > type. The < tt > fpext< / tt > cannot be
used to make a < i > no-op cast< / i > because it always changes bits. Use
2006-11-12 00:08:07 +01:00
< tt > bitcast< / tt > to make a < i > no-op cast< / i > for a floating point cast.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
< pre >
2006-11-09 22:48:10 +01:00
%X = fpext float 3.1415 to double < i > ; yields double:3.1415< / i >
%Y = fpext float 1.0 to float < i > ; yields float:1.0 (no-op)< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-10 00:03:26 +01:00
< a name = "i_fp2uint" > '< tt > fptoui .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
< result> = fp2uint < ty> < value> to < ty2> < i > ; yields ty2< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > fp2uint< / tt > ' converts a floating point < tt > value< / tt > to its
unsigned integer equivalent of type < tt > ty2< / tt > .
2006-04-09 01:07:04 +02:00
< / p >
2006-11-08 02:11:31 +01:00
< h5 > Arguments:< / h5 >
< p > The '< tt > fp2uint< / tt > ' instruction takes a value to cast, which must be a
< a href = "#t_floating" > floating point< / a > value, and a type to cast it to, which
must be an < a href = "#t_integral" > integral< / a > type.< / p >
< h5 > Semantics:< / h5 >
< p > The '< tt > fp2uint< / tt > ' instruction converts its
< a href = "#t_floating" > floating point< / a > operand into the nearest (rounding
towards zero) unsigned integer value. If the value cannot fit in < tt > ty2< / tt > ,
the results are undefined.< / p >
< p > When converting to bool, the conversion is done as a comparison against
zero. If the < tt > value< / tt > was zero, the bool result will be < tt > false< / tt > .
If the < tt > value< / tt > was non-zero, the bool result will be < tt > true< / tt > .< / p >
< h5 > Example:< / h5 >
< pre >
%X = fp2uint double 123.0 to int < i > ; yields int:123< / i >
%Y = fp2uint float 1.0E+300 to bool < i > ; yields bool:true< / i >
%X = fp2uint float 1.04E+17 to ubyte < i > ; yields undefined:1< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-10 00:03:26 +01:00
< a name = "i_fptosi" > '< tt > fptosi .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-10 00:03:26 +01:00
< result> = fptosi < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > fptosi< / tt > ' instruction converts
2006-11-08 02:11:31 +01:00
< a href = "#t_floating" > floating point< / a > < tt > value< / tt > to type < tt > ty2< / tt > .
2006-01-15 21:48:27 +01:00
< / p >
2006-11-08 02:11:31 +01:00
< h5 > Arguments:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > fptosi< / tt > ' instruction takes a value to cast, which must be a
2006-11-08 02:11:31 +01:00
< a href = "#t_floating" > floating point< / a > value, and a type to cast it to, which
must also be an < a href = "#t_integral" > integral< / a > type.< / p >
< h5 > Semantics:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > fptosi< / tt > ' instruction converts its
2006-11-08 02:11:31 +01:00
< a href = "#t_floating" > floating point< / a > operand into the nearest (rounding
towards zero) signed integer value. If the value cannot fit in < tt > ty2< / tt > ,
the results are undefined.< / p >
< p > When converting to bool, the conversion is done as a comparison against
zero. If the < tt > value< / tt > was zero, the bool result will be < tt > false< / tt > .
If the < tt > value< / tt > was non-zero, the bool result will be < tt > true< / tt > .< / p >
< h5 > Example:< / h5 >
< pre >
2006-11-10 00:03:26 +01:00
%X = fptosi double -123.0 to int < i > ; yields int:-123< / i >
%Y = fptosi float 1.0E-247 to bool < i > ; yields bool:true< / i >
%X = fptosi float 1.04E+17 to sbyte < i > ; yields undefined:1< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-10 00:03:26 +01:00
< a name = "i_uitofp" > '< tt > uitofp .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-10 00:03:26 +01:00
< result> = uitofp < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > uitofp< / tt > ' instruction regards < tt > value< / tt > as an unsigned
2006-11-08 02:11:31 +01:00
integer and converts that value to the < tt > ty2< / tt > type.< / p >
< h5 > Arguments:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > uitofp< / tt > ' instruction takes a value to cast, which must be an
2006-11-08 02:11:31 +01:00
< a href = "#t_integral" > integral< / a > value, and a type to cast it to, which must
be a < a href = "#t_floating" > floating point< / a > type.< / p >
< h5 > Semantics:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > uitofp< / tt > ' instruction interprets its operand as an unsigned
2006-11-08 02:11:31 +01:00
integer quantity and converts it to the corresponding floating point value. If
the value cannot fit in the floating point value, the results are undefined.< / p >
< h5 > Example:< / h5 >
< pre >
2006-11-10 00:03:26 +01:00
%X = uitofp int 257 to float < i > ; yields float:257.0< / i >
%Y = uitofp sbyte -1 to double < i > ; yields double:255.0< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-10 00:03:26 +01:00
< a name = "i_sitofp" > '< tt > sitofp .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-10 00:03:26 +01:00
< result> = sitofp < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > sitofp< / tt > ' instruction regards < tt > value< / tt > as a signed
2006-11-08 02:11:31 +01:00
integer and converts that value to the < tt > ty2< / tt > type.< / p >
< h5 > Arguments:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > sitofp< / tt > ' instruction takes a value to cast, which must be an
2006-11-08 02:11:31 +01:00
< a href = "#t_integral" > integral< / a > value, and a type to cast it to, which must be
a < a href = "#t_floating" > floating point< / a > type.< / p >
< h5 > Semantics:< / h5 >
2006-11-10 00:03:26 +01:00
< p > The '< tt > sitofp< / tt > ' instruction interprets its operand as a signed
2006-11-08 02:11:31 +01:00
integer quantity and converts it to the corresponding floating point value. If
the value cannot fit in the floating point value, the results are undefined.< / p >
2006-01-15 21:48:27 +01:00
< h5 > Example:< / h5 >
2006-11-08 02:11:31 +01:00
< pre >
2006-11-10 00:03:26 +01:00
%X = sitofp int 257 to float < i > ; yields float:257.0< / i >
%Y = sitofp sbyte -1 to double < i > ; yields double:-1.0< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< / div >
2006-01-15 21:48:27 +01:00
2006-11-11 22:00:47 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_ptrtoint" > '< tt > ptrtoint .. to< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
< result> = ptrtoint < ty> < value> to < ty2> < i > ; yields ty2< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > ptrtoint< / tt > ' instruction converts the pointer < tt > value< / tt > to
the integer type < tt > ty2< / tt > .< / p >
< h5 > Arguments:< / h5 >
< p > The '< tt > ptrtoint< / tt > ' instruction takes a < tt > value< / tt > to cast, which
must be a < a href = "t_pointer" > pointer< / a > value, and a type to cast it to
< tt > ty2< / tt > , which must be an < a href = "#t_integer" > integer< / a > type.
< h5 > Semantics:< / h5 >
< p > The '< tt > ptrtoint< / tt > ' instruction converts < tt > value< / tt > to integer type
< tt > ty2< / tt > by interpreting the pointer value as an integer and either
truncating or zero extending that value to the size of the integer type. If
< tt > value< / tt > is smaller than < tt > ty2< / tt > then a zero extension is done. If
< tt > value< / tt > is larger than < tt > ty2< / tt > then a truncation is done. If they
are the same size, then nothing is done (< i > no-op cast< / i > ).< / p >
< h5 > Example:< / h5 >
< pre >
%X = ptrtoint int* %X to sbyte < i > ; yields truncation on 32-bit< / i >
%Y = ptrtoint int* %x to ulong < i > ; yields zero extend on 32-bit< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_inttoptr" > '< tt > inttoptr .. to< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
< result> = inttoptr < ty> < value> to < ty2> < i > ; yields ty2< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > inttoptr< / tt > ' instruction converts an integer < tt > value< / tt > to
a pointer type, < tt > ty2< / tt > .< / p >
< h5 > Arguments:< / h5 >
< p > The '< tt > inttoptr< / tt > ' instruction takes an < a href = "i_integer" > integer< / a >
value to cast, and a type to cast it to, which must be a
< a href = "#t_pointer" > pointer< / a > type. < / tt >
< h5 > Semantics:< / h5 >
< p > The '< tt > inttoptr< / tt > ' instruction converts < tt > value< / tt > to type
< tt > ty2< / tt > by applying either a zero extension or a truncation depending on
the size of the integer < tt > value< / tt > . If < tt > value< / tt > is larger than the
size of a pointer then a truncation is done. If < tt > value< / tt > is smaller than
the size of a pointer then a zero extension is done. If they are the same size,
nothing is done (< i > no-op cast< / i > ).< / p >
< h5 > Example:< / h5 >
< pre >
%X = inttoptr int 255 to int* < i > ; yields zero extend on 64-bit< / i >
%X = inttoptr int 255 to int* < i > ; yields no-op on 32-bit < / i >
%Y = inttoptr short 0 to int* < i > ; yields zero extend on 32-bit< / i >
< / pre >
< / div >
2006-11-08 02:11:31 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-11-12 00:08:07 +01:00
< a name = "i_bitcast" > '< tt > bitcast .. to< / tt > ' Instruction< / a >
2006-11-08 02:11:31 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-11-12 00:08:07 +01:00
< result> = bitcast < ty> < value> to < ty2> < i > ; yields ty2< / i >
2006-11-08 02:11:31 +01:00
< / pre >
< h5 > Overview:< / h5 >
2006-11-12 00:08:07 +01:00
< p > The '< tt > bitcast< / tt > ' instruction converts < tt > value< / tt > to type
2006-11-08 02:11:31 +01:00
< tt > ty2< / tt > without changing any bits.< / p >
< h5 > Arguments:< / h5 >
2006-11-12 00:08:07 +01:00
< p > The '< tt > bitcast< / tt > ' instruction takes a value to cast, which must be
2006-11-08 02:11:31 +01:00
a first class value, and a type to cast it to, which must also be a < a
href="#t_firstclass">first class< / a > type. The bit sizes of < tt > value< / tt >
and the destination type, < tt > ty2< / tt > , must be identical.< / p >
< h5 > Semantics:< / h5 >
2006-11-12 00:08:07 +01:00
< p > The '< tt > bitcast< / tt > ' instruction converts < tt > value< / tt > to type
2006-11-11 22:00:47 +01:00
< tt > ty2< / tt > . It is always a < i > no-op cast< / i > because no bits change with
this conversion. The conversion is done as if the < tt > value< / tt > had been
stored to memory and read back as type < tt > ty2< / tt > . Pointer types may only be
converted to other pointer types with this instruction. To convert pointers to
other types, use the < a href = "#i_inttoptr" > inttoptr< / a > or
< a href = "#i_ptrtoint" > ptrtoint< / a > instructions first.< / p >
2006-11-08 02:11:31 +01:00
< h5 > Example:< / h5 >
2006-01-15 21:48:27 +01:00
< pre >
2006-11-12 00:08:07 +01:00
%X = bitcast ubyte 255 to sbyte < i > ; yields sbyte:-1< / i >
%Y = bitcast uint* %x to sint* < i > ; yields sint*:%x< / i >
%Z = bitcast < 2xint > %V to long; < i > ; yields long: %V< / i >
2006-01-15 21:48:27 +01:00
< / pre >
< / div >
2006-11-08 02:18:52 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" > < a name = "otherops" > Other Operations< / a > < / div >
< div class = "doc_text" >
< p > The instructions in this category are the "miscellaneous"
instructions, which defy better classification.< / p >
< / div >
2006-11-18 22:50:54 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_icmp" > '< tt > icmp< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = icmp < cond> < ty> < var1> , < var2> < i > ; yields {bool}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > icmp< / tt > ' instruction returns a boolean value based on comparison
of its two integer operands.< / p >
< h5 > Arguments:< / h5 >
< p > The '< tt > icmp< / tt > ' instruction takes three operands. The first operand is
the condition code which indicates the kind of comparison to perform. It is not
a value, just a keyword. The possibilities for the condition code are:
< ol >
< li > < tt > eq< / tt > : equal< / li >
< li > < tt > ne< / tt > : not equal < / li >
< li > < tt > ugt< / tt > : unsigned greater than< / li >
< li > < tt > uge< / tt > : unsigned greater or equal< / li >
< li > < tt > ult< / tt > : unsigned less than< / li >
< li > < tt > ule< / tt > : unsigned less or equal< / li >
< li > < tt > sgt< / tt > : signed greater than< / li >
< li > < tt > sge< / tt > : signed greater or equal< / li >
< li > < tt > slt< / tt > : signed less than< / li >
< li > < tt > sle< / tt > : signed less or equal< / li >
< / ol >
< p > The remaining two arguments must be of < a href = "#t_integral" > integral< / a > ,
< a href = "#t_pointer" > pointer< / a > or a < a href = "#t_packed" > packed< / a > integral
type. They must have identical types.< / p >
< h5 > Semantics:< / h5 >
< p > The '< tt > icmp< / tt > ' compares < tt > var1< / tt > and < tt > var2< / tt > according to
the condition code given as < tt > cond< / tt > . The comparison performed always
yields a < a href = "#t_bool" > bool< / a > result, as follows:
< ol >
< li > < tt > eq< / tt > : yields < tt > true< / tt > if the operands are equal,
< tt > false< / tt > otherwise. No sign interpretation is necessary or performed.
< / li >
< li > < tt > ne< / tt > : yields < tt > true< / tt > if the operands are unequal,
< tt > false< / tt > otherwise. No sign interpretation is necessary or performed.
< li > < tt > ugt< / tt > : interprets the operands as unsigned values and yields
< tt > true< / tt > if < tt > var1< / tt > is greater than < tt > var2< / tt > .< / li >
< li > < tt > uge< / tt > : interprets the operands as unsigned values and yields
< tt > true< / tt > if < tt > var1< / tt > is greater than or equal to < tt > var2< / tt > .< / li >
< li > < tt > ult< / tt > : interprets the operands as unsigned values and yields
< tt > true< / tt > if < tt > var1< / tt > is less than < tt > var2< / tt > .< / li >
< li > < tt > ule< / tt > : interprets the operands as unsigned values and yields
< tt > true< / tt > if < tt > var1< / tt > is less than or equal to < tt > var2< / tt > .< / li >
< li > < tt > sgt< / tt > : interprets the operands as signed values and yields
< tt > true< / tt > if < tt > var1< / tt > is greater than < tt > var2< / tt > .< / li >
< li > < tt > sge< / tt > : interprets the operands as signed values and yields
< tt > true< / tt > if < tt > var1< / tt > is greater than or equal to < tt > var2< / tt > .< / li >
< li > < tt > slt< / tt > : interprets the operands as signed values and yields
< tt > true< / tt > if < tt > var1< / tt > is less than < tt > var2< / tt > .< / li >
< li > < tt > sle< / tt > : interprets the operands as signed values and yields
< tt > true< / tt > if < tt > var1< / tt > is less than or equal to < tt > var2< / tt > .< / li >
< / li >
< / ol >
< p > If the operands are < a href = "#t_pointer" > pointer< / a > typed, the pointer
values are treated as integers and then compared.< / p >
< p > If the operands are < a href = "#t_packed" > packed< / a > typed, the elements of
the vector are compared in turn and the predicate must hold for all elements.
While this is of dubious use for predicates other than < tt > eq< / tt > and
< tt > ne< / tt > , the other predicates can be used with packed types.< / p >
< h5 > Example:< / h5 >
< pre > < result> = icmp eq int 4, 5 < i > ; yields: result=false< / i >
< result> = icmp ne float* %X, %X < i > ; yields: result=false< / i >
< result> = icmp ult short 4, 5 < i > ; yields: result=true< / i >
< result> = icmp sgt sbyte 4, 5 < i > ; yields: result=false< / i >
< result> = icmp ule sbyte -4, 5 < i > ; yields: result=false< / i >
< result> = icmp sge sbyte 4, 5 < i > ; yields: result=false< / i >
< / pre >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_fcmp" > '< tt > fcmp< / tt > ' Instruction< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = fcmp < cond> < ty> < var1> , < var2> < i > ; yields {bool}:result< / i >
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > fcmp< / tt > ' instruction returns a boolean value based on comparison
of its floating point operands.< / p >
< h5 > Arguments:< / h5 >
< p > The '< tt > fcmp< / tt > ' instruction takes three operands. The first operand is
the condition code which indicates the kind of comparison to perform. It is not
a value, just a keyword. The possibilities for the condition code are:
< ol >
< li > < tt > false< / tt > : no comparison, always false (always folded)< / li >
< li > < tt > oeq< / tt > : ordered and equal< / li >
< li > < tt > ogt< / tt > : ordered and greater than < / li >
< li > < tt > oge< / tt > : ordered and greater than or equal< / li >
< li > < tt > olt< / tt > : ordered and less than < / li >
< li > < tt > ole< / tt > : ordered and less than or equal< / li >
< li > < tt > one< / tt > : ordered and not equal< / li >
< li > < tt > ord< / tt > : ordered (no nans)< / li >
< li > < tt > ueq< / tt > : unordered or equal< / li >
< li > < tt > ugt< / tt > : unordered or greater than < / li >
< li > < tt > uge< / tt > : unordered or greater than or equal< / li >
< li > < tt > ult< / tt > : unordered or less than < / li >
< li > < tt > ule< / tt > : unordered or less than or equal< / li >
< li > < tt > une< / tt > : unordered or not equal< / li >
< li > < tt > uno< / tt > : unordered (either nans)< / li >
< li > < tt > true< / tt > : no comparison, always true (always folded)< / li >
< / ol >
< p > The < tt > val1< / tt > and < tt > val2< / tt > arguments must be of
< a href = "#t_floating" > floating point< / a > , or a < a href = "#t_packed" > packed< / a >
floating point type. They must have identical types.< / p >
< h5 > Semantics:< / h5 >
< p > The '< tt > fcmp< / tt > ' compares < tt > var1< / tt > and < tt > var2< / tt > according to
the condition code given as < tt > cond< / tt > . The comparison performed always
yields a < a href = "#t_bool" > bool< / a > result, as follows:
< ol >
< li > < tt > false< / tt > : always yields < tt > false< / tt > , regardless of operands.< / li >
< li > < tt > oeq< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is equal to < tt > var2< / tt > .< / li >
< li > < tt > ogt< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is greather than < tt > var2< / tt > .< / li >
< li > < tt > oge< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is greater than or equal to < tt > var2< / tt > .< / li >
< li > < tt > olt< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is less than < tt > var2< / tt > .< / li >
< li > < tt > ole< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is less than or equal to < tt > var2< / tt > .< / li >
< li > < tt > one< / tt > : yields < tt > true< / tt > if both operands are ordered and
< tt > var1< / tt > is not equal to < tt > var2< / tt > .< / li >
< li > < tt > ord< / tt > : yields < tt > true< / tt > if both operands are ordered.< / li >
< li > < tt > ueq< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is equal to < tt > var2< / tt > .< / li >
< li > < tt > ugt< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is greater than < tt > var2< / tt > .< / li >
< li > < tt > uge< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is greater than or equal to < tt > var2< / tt > .< / li >
< li > < tt > ult< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is less than < tt > var2< / tt > .< / li >
< li > < tt > ule< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is less than or equal to < tt > var2< / tt > .< / li >
< li > < tt > une< / tt > : yields < tt > true< / tt > if either operand is unordered or
< tt > var1< / tt > is not equal to < tt > var2< / tt > .< / li >
< li > < tt > uno< / tt > : yields < tt > true< / tt > if either operand is unordered.< / li >
< li > < tt > true< / tt > : always yields < tt > true< / tt > , regardless of operands.< / li >
< / ol >
< p > If the operands are < a href = "#t_packed" > packed< / a > typed, the elements of
the vector are compared in turn and the predicate must hold for all elements.
While this is of dubious use for predicates other than < tt > eq< / tt > and
< tt > ne< / tt > , the other predicates can be used with packed types.< / p >
< h5 > Example:< / h5 >
< pre > < result> = fcmp oeq float 4.0, 5.0 < i > ; yields: result=false< / i >
< result> = icmp one float 4.0, 5.0 < i > ; yields: result=true< / i >
< result> = icmp olt float 4.0, 5.0 < i > ; yields: result=true< / i >
< result> = icmp ueq double 1.0, 2.0 < i > ; yields: result=false< / i >
< / pre >
< / div >
2006-11-08 02:18:52 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" > < a name = "i_phi" > '< tt > phi< / tt > '
Instruction< / a > < / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre > < result> = phi < ty> [ < val0> , < label0> ], ...< br > < / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > phi< / tt > ' instruction is used to implement the φ node in
the SSA graph representing the function.< / p >
< h5 > Arguments:< / h5 >
< p > The type of the incoming values are specified with the first type
field. After this, the '< tt > phi< / tt > ' instruction takes a list of pairs
as arguments, with one pair for each predecessor basic block of the
current block. Only values of < a href = "#t_firstclass" > first class< / a >
type may be used as the value arguments to the PHI node. Only labels
may be used as the label arguments.< / p >
< p > There must be no non-phi instructions between the start of a basic
block and the PHI instructions: i.e. PHI instructions must be first in
a basic block.< / p >
< h5 > Semantics:< / h5 >
< p > At runtime, the '< tt > phi< / tt > ' instruction logically takes on the
value specified by the parameter, depending on which basic block we
came from in the last < a href = "#terminators" > terminator< / a > instruction.< / p >
< h5 > Example:< / h5 >
< 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 >
< / div >
2006-04-08 02:13:41 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-04-09 01:07:04 +02:00
< a name = "i_select" > '< tt > select< / tt > ' Instruction< / a >
2006-04-08 02:13:41 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
< result> = select bool < cond> , < ty> < val1> , < ty> < val2> < i > ; yields ty< / i >
2006-04-08 02:13:41 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-04-09 01:07:04 +02:00
The '< tt > select< / tt > ' instruction is used to choose one value based on a
condition, without branching.
2006-04-08 02:13:41 +02:00
< / p >
2006-04-09 01:07:04 +02:00
< h5 > Arguments:< / h5 >
2006-04-08 02:13:41 +02:00
< p >
2006-04-09 01:07:04 +02:00
The '< tt > select< / tt > ' instruction requires a boolean value indicating the condition, and two values of the same < a href = "#t_firstclass" > first class< / a > type.
2006-04-08 02:13:41 +02:00
< / p >
< h5 > Semantics:< / h5 >
< p >
2006-04-09 01:07:04 +02:00
If the boolean condition evaluates to true, the instruction returns the first
value argument; otherwise, it returns the second value argument.
2006-04-08 02:13:41 +02:00
< / p >
< h5 > Example:< / h5 >
< pre >
2006-04-09 01:07:04 +02:00
%X = select bool true, ubyte 17, ubyte 42 < i > ; yields ubyte:17< / i >
2006-04-08 02:13:41 +02:00
< / pre >
< / div >
2006-01-15 21:48:27 +01:00
2001-06-06 22:29:01 +02:00
<!-- _______________________________________________________________________ -->
2005-05-06 07:47:36 +02:00
< div class = "doc_subsubsection" >
< a name = "i_call" > '< tt > call< / tt > ' Instruction< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2005-05-06 07:47:36 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Syntax:< / h5 >
2005-05-06 07:47:36 +02:00
< pre >
2005-05-07 00:57:40 +02:00
< result> = [tail] call [< a href = "#callingconv" > cconv< / a > ] < ty> * < fnptrval> (< param list> )
2005-05-06 07:47:36 +02:00
< / pre >
2001-06-06 22:29:01 +02:00
< h5 > Overview:< / h5 >
2005-05-06 07:47:36 +02:00
2003-11-08 02:05:38 +01:00
< p > The '< tt > call< / tt > ' instruction represents a simple function call.< / p >
2005-05-06 07:47:36 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Arguments:< / h5 >
2005-05-06 07:47:36 +02:00
2003-11-08 02:05:38 +01:00
< p > This instruction requires several arguments:< / p >
2005-05-06 07:47:36 +02:00
2002-05-07 00:08:29 +02:00
< ol >
2003-11-25 02:02:51 +01:00
< li >
2005-05-07 00:57:40 +02:00
< p > The optional "tail" marker indicates whether the callee function accesses
any allocas or varargs in the caller. If the "tail" marker is present, the
2005-05-06 07:47:36 +02:00
function call is eligible for tail call optimization. Note that calls may
be marked "tail" even if they do not occur before a < a
href="#i_ret">< tt > ret< / tt > < / a > instruction.
< / li >
2005-05-07 00:57:40 +02:00
< li >
< p > The optional "cconv" marker indicates which < a href = "callingconv" > calling
convention< / a > the call should use. If none is specified, the call defaults
to using C calling conventions.
< / li >
2005-05-06 07:47:36 +02:00
< li >
< p > '< tt > ty< / tt > ': shall be the signature of the pointer to function value
being invoked. The argument types must match the types implied by this
2005-05-16 18:17:45 +02:00
signature. This type can be omitted if the function is not varargs and
if the function type does not return a pointer to a function.< / p >
2003-11-25 02:02:51 +01:00
< / li >
< li >
2005-05-06 07:47:36 +02:00
< p > '< tt > fnptrval< / tt > ': An LLVM value containing a pointer to a function to
be invoked. In most cases, this is a direct function invocation, but
indirect < tt > call< / tt > s are just as possible, calling an arbitrary pointer
2005-05-16 18:17:45 +02:00
to function value.< / p >
2003-11-25 02:02:51 +01:00
< / li >
< li >
< p > '< tt > function args< / tt > ': argument list whose types match the
2005-05-02 00:22:57 +02:00
function signature argument types. All arguments must be of
< a href = "#t_firstclass" > first class< / a > type. If the function signature
indicates the function accepts a variable number of arguments, the extra
arguments can be specified.< / p >
2003-11-25 02:02:51 +01:00
< / li >
2002-05-07 00:08:29 +02:00
< / ol >
2005-05-06 07:47:36 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Semantics:< / h5 >
2005-05-06 07:47:36 +02:00
2003-11-25 02:02:51 +01:00
< p > The '< tt > call< / tt > ' instruction is used to cause control flow to
transfer to a specified function, with its incoming arguments bound to
the specified values. Upon a '< tt > < a href = "#i_ret" > ret< / a > < / tt > '
instruction in the called function, control flow continues with the
instruction after the function call, and the return value of the
function is bound to the result argument. This is a simpler case of
the < a href = "#i_invoke" > invoke< / a > instruction.< / p >
2005-05-06 07:47:36 +02:00
2001-06-06 22:29:01 +02:00
< h5 > Example:< / h5 >
2005-05-06 07:47:36 +02:00
< pre >
%retval = call int %test(int %argc)
call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42);
%X = tail call int %foo()
2005-05-07 00:57:40 +02:00
%Y = tail call < a href = "#callingconv" > fastcc< / a > int %foo()
2005-05-06 07:47:36 +02:00
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2004-09-27 23:51:25 +02:00
2003-10-18 07:51:36 +02:00
<!-- _______________________________________________________________________ -->
2004-09-27 23:51:25 +02:00
< div class = "doc_subsubsection" >
2006-01-14 00:26:01 +01:00
< a name = "i_va_arg" > '< tt > va_arg< / tt > ' Instruction< / a >
2004-09-27 23:51:25 +02:00
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-09-27 23:51:25 +02:00
2003-10-18 07:51:36 +02:00
< h5 > Syntax:< / h5 >
2004-09-27 23:51:25 +02:00
< pre >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< resultval> = va_arg < va_list*> < arglist> , < argty>
2004-09-27 23:51:25 +02:00
< / pre >
2003-10-18 07:51:36 +02:00
< h5 > Overview:< / h5 >
2004-09-27 23:51:25 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > The '< tt > va_arg< / tt > ' instruction is used to access arguments passed through
2004-09-27 23:51:25 +02:00
the "variable argument" area of a function call. It is used to implement the
< tt > va_arg< / tt > macro in C.< / p >
2003-10-18 07:51:36 +02:00
< h5 > Arguments:< / h5 >
2004-09-27 23:51:25 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > This instruction takes a < tt > va_list*< / tt > value and the type of
the argument. It returns a value of the specified argument type and
2005-11-11 03:15:27 +01:00
increments the < tt > va_list< / tt > to point to the next argument. Again, the
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
actual type of < tt > va_list< / tt > is target specific.< / p >
2004-09-27 23:51:25 +02:00
2003-10-18 07:51:36 +02:00
< h5 > Semantics:< / h5 >
2004-09-27 23:51:25 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > The '< tt > va_arg< / tt > ' instruction loads an argument of the specified
type from the specified < tt > va_list< / tt > and causes the
< tt > va_list< / tt > to point to the next argument. For more information,
see the variable argument handling < a href = "#int_varargs" > Intrinsic
Functions< / a > .< / p >
2004-09-27 23:51:25 +02:00
< p > It is legal for this instruction to be called in a function which does not
take a variable number of arguments, for example, the < tt > vfprintf< / tt >
2003-11-08 02:05:38 +01:00
function.< / p >
2004-09-27 23:51:25 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > < tt > va_arg< / tt > is an LLVM instruction instead of an < a
2005-05-16 18:17:45 +02:00
href="#intrinsics">intrinsic function< / a > because it takes a type as an
2004-09-27 23:51:25 +02:00
argument.< / p >
2003-10-18 07:51:36 +02:00
< h5 > Example:< / h5 >
2004-09-27 23:51:25 +02:00
< p > See the < a href = "#int_varargs" > variable argument processing< / a > section.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2003-05-08 06:57:36 +02:00
<!-- *********************************************************************** -->
2003-11-25 02:02:51 +01:00
< div class = "doc_section" > < a name = "intrinsics" > Intrinsic Functions< / a > < / div >
2003-05-08 06:57:36 +02:00
<!-- *********************************************************************** -->
2004-01-06 06:31:32 +01:00
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-02-12 18:01:32 +01:00
< p > LLVM supports the notion of an "intrinsic function". These functions have
2005-05-16 18:17:45 +02:00
well known names and semantics and are required to follow certain
2004-02-12 18:01:32 +01:00
restrictions. Overall, these instructions represent an extension mechanism for
the LLVM language that does not require changing all of the transformations in
LLVM to add to the language (or the bytecode reader/writer, the parser,
etc...).< / p >
2005-05-16 18:17:45 +02:00
< p > Intrinsic function names must all start with an "< tt > llvm.< / tt > " prefix. This
prefix is reserved in LLVM for intrinsic names; thus, functions may not be named
2004-02-12 18:01:32 +01:00
this. Intrinsic functions must always be external functions: you cannot define
the body of intrinsic functions. Intrinsic functions may only be used in call
or invoke instructions: it is illegal to take the address of an intrinsic
function. Additionally, because intrinsic functions are part of the LLVM
language, it is required that they all be documented here if any are added.< / p >
2005-05-16 18:17:45 +02:00
< p > To learn how to add an intrinsic function, please see the < a
2005-05-11 05:35:57 +02:00
href="ExtendingLLVM.html">Extending LLVM Guide< / a > .
2004-02-12 18:01:32 +01:00
< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2003-05-08 06:57:36 +02:00
<!-- ======================================================================= -->
2004-01-06 06:31:32 +01:00
< div class = "doc_subsection" >
< a name = "int_varargs" > Variable Argument Handling Intrinsics< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-05-23 23:06:01 +02:00
2003-11-08 02:05:38 +01:00
< p > Variable argument support is defined in LLVM with the < a
2006-01-14 00:26:01 +01:00
href="#i_va_arg">< tt > va_arg< / tt > < / a > instruction and these three
2003-11-25 02:02:51 +01:00
intrinsic functions. These functions are related to the similarly
named macros defined in the < tt > < stdarg.h> < / tt > header file.< / p >
2004-05-23 23:06:01 +02:00
2003-11-25 02:02:51 +01:00
< p > All of these functions operate on arguments that use a
target-specific value type "< tt > va_list< / tt > ". The LLVM assembly
language reference manual does not define what this type is, so all
transformations should be prepared to handle intrinsics with any type
used.< / p >
2004-05-23 23:06:01 +02:00
2006-05-15 19:26:46 +02:00
< p > This example shows how the < a href = "#i_va_arg" > < tt > va_arg< / tt > < / a >
2003-11-25 02:02:51 +01:00
instruction and the variable argument handling intrinsic functions are
used.< / p >
2004-05-23 23:06:01 +02:00
2004-02-12 18:01:32 +01:00
< pre >
int %test(int %X, ...) {
; Initialize variable argument processing
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
%ap = alloca sbyte*
call void %< a href = "#i_va_start" > llvm.va_start< / a > (sbyte** %ap)
2004-02-12 18:01:32 +01:00
; Read a single integer argument
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
%tmp = va_arg sbyte** %ap, int
2004-02-12 18:01:32 +01:00
; Demonstrate usage of llvm.va_copy and llvm.va_end
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
%aq = alloca sbyte*
2005-06-22 22:38:11 +02:00
call void %< a href = "#i_va_copy" > llvm.va_copy< / a > (sbyte** %aq, sbyte** %ap)
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
call void %< a href = "#i_va_end" > llvm.va_end< / a > (sbyte** %aq)
2004-02-12 18:01:32 +01:00
; Stop processing of arguments.
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
call void %< a href = "#i_va_end" > llvm.va_end< / a > (sbyte** %ap)
2004-02-12 18:01:32 +01:00
ret int %tmp
}
< / pre >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2003-05-08 06:57:36 +02:00
<!-- _______________________________________________________________________ -->
2004-01-06 06:31:32 +01:00
< div class = "doc_subsubsection" >
< a name = "i_va_start" > '< tt > llvm.va_start< / tt > ' Intrinsic< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-05-08 06:57:36 +02:00
< h5 > Syntax:< / h5 >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< pre > declare void %llvm.va_start(< va_list> * < arglist> )< br > < / pre >
2003-05-08 06:57:36 +02:00
< h5 > Overview:< / h5 >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< P > The '< tt > llvm.va_start< / tt > ' intrinsic initializes
< tt > *< arglist> < / tt > for subsequent use by < tt > < a
href="#i_va_arg">va_arg< / a > < / tt > .< / p >
< h5 > Arguments:< / h5 >
< P > The argument is a pointer to a < tt > va_list< / tt > element to initialize.< / p >
2003-05-08 06:57:36 +02:00
< h5 > Semantics:< / h5 >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< P > The '< tt > llvm.va_start< / tt > ' intrinsic works just like the < tt > va_start< / tt >
macro available in C. In a target-dependent way, it initializes the
< tt > va_list< / tt > element the argument points to, so that the next call to
< tt > va_arg< / tt > will produce the first variable argument passed to the function.
Unlike the C < tt > va_start< / tt > macro, this intrinsic does not need to know the
last argument of the function, the compiler can figure that out.< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2003-05-08 06:57:36 +02:00
<!-- _______________________________________________________________________ -->
2004-01-06 06:31:32 +01:00
< div class = "doc_subsubsection" >
< a name = "i_va_end" > '< tt > llvm.va_end< / tt > ' Intrinsic< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2003-05-08 06:57:36 +02:00
< h5 > Syntax:< / h5 >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< pre > declare void %llvm.va_end(< va_list*> < arglist> )< br > < / pre >
2003-05-08 06:57:36 +02:00
< h5 > Overview:< / h5 >
2003-11-25 02:02:51 +01:00
< p > The '< tt > llvm.va_end< / tt > ' intrinsic destroys < tt > < arglist> < / tt >
which has been initialized previously with < tt > < a href = "#i_va_start" > llvm.va_start< / a > < / tt >
or < tt > < a href = "#i_va_copy" > llvm.va_copy< / a > < / tt > .< / p >
2003-05-08 06:57:36 +02:00
< h5 > Arguments:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The argument is a < tt > va_list< / tt > to destroy.< / p >
2003-05-08 06:57:36 +02:00
< h5 > Semantics:< / h5 >
2003-11-08 02:05:38 +01:00
< p > The '< tt > llvm.va_end< / tt > ' intrinsic works just like the < tt > va_end< / tt >
2003-11-25 02:02:51 +01:00
macro available in C. In a target-dependent way, it destroys the < tt > va_list< / tt > .
Calls to < a href = "#i_va_start" > < tt > llvm.va_start< / tt > < / a > and < a
href="#i_va_copy">< tt > llvm.va_copy< / tt > < / a > must be matched exactly
with calls to < tt > llvm.va_end< / tt > .< / p >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2003-05-08 06:57:36 +02:00
<!-- _______________________________________________________________________ -->
2004-01-06 06:31:32 +01:00
< div class = "doc_subsubsection" >
< a name = "i_va_copy" > '< tt > llvm.va_copy< / tt > ' Intrinsic< / a >
< / div >
2003-11-08 02:05:38 +01:00
< div class = "doc_text" >
2004-05-23 23:06:01 +02:00
2003-05-08 06:57:36 +02:00
< h5 > Syntax:< / h5 >
2004-05-23 23:06:01 +02:00
< pre >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
declare void %llvm.va_copy(< va_list> * < destarglist> ,
2005-06-22 22:38:11 +02:00
< va_list> * < srcarglist> )
2004-05-23 23:06:01 +02:00
< / pre >
2003-05-08 06:57:36 +02:00
< h5 > Overview:< / h5 >
2004-05-23 23:06:01 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > The '< tt > llvm.va_copy< / tt > ' intrinsic copies the current argument position from
the source argument list to the destination argument list.< / p >
2004-05-23 23:06:01 +02:00
2003-05-08 06:57:36 +02:00
< h5 > Arguments:< / h5 >
2004-05-23 23:06:01 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > The first argument is a pointer to a < tt > va_list< / tt > element to initialize.
2005-06-22 22:38:11 +02:00
The second argument is a pointer to a < tt > va_list< / tt > element to copy from.< / p >
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
2004-05-23 23:06:01 +02:00
2003-05-08 06:57:36 +02:00
< h5 > Semantics:< / h5 >
2004-05-23 23:06:01 +02:00
OK, after checking the backwards compatibility code on X86 and the new code
path on alpha, now has come the time for new vararg support. So, with out
further ado, I revert behavior back a couple of years!
Well, ok, I lied. A few more notes.
First, the Simple ISels cannot be expected to work any longer, but they
should still compile
Second, there are likely some bugs to track down once the nightly testers
start with this.
Third, the initial patch doesn't include sparcv9, but I'll do that today.
Forth, subsequent patches won't bother being long winded.
llvm-svn: 22251
2005-06-18 20:28:17 +02:00
< p > The '< tt > llvm.va_copy< / tt > ' intrinsic works just like the < tt > va_copy< / tt > macro
available in C. In a target-dependent way, it copies the source
< tt > va_list< / tt > element into the destination list. This intrinsic is necessary
because the < tt > < a href = "i_va_begin" > llvm.va_begin< / a > < / tt > intrinsic may be
2004-05-23 23:06:01 +02:00
arbitrarily complex and require memory allocation, for example.< / p >
< / div >
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "int_gc" > Accurate Garbage Collection Intrinsics< / a >
2003-11-08 02:05:38 +01:00
< / div >
2004-01-06 06:31:32 +01:00
2004-05-23 23:06:01 +02:00
< div class = "doc_text" >
< p >
LLVM support for < a href = "GarbageCollection.html" > Accurate Garbage
Collection< / a > requires the implementation and generation of these intrinsics.
These intrinsics allow identification of < a href = "#i_gcroot" > GC roots on the
stack< / a > , as well as garbage collector implementations that require < a
href="#i_gcread">read< / a > and < a href = "#i_gcwrite" > write< / a > barriers.
Front-ends for type-safe garbage collected languages should generate these
intrinsics to make use of the LLVM garbage collectors. For more details, see < a
href="GarbageCollection.html">Accurate Garbage Collection with LLVM< / a > .
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_gcroot" > '< tt > llvm.gcroot< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2005-04-26 22:50:44 +02:00
declare void %llvm.gcroot(< ty> ** %ptrloc, < ty2> * %metadata)
2004-05-23 23:06:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
2004-12-10 16:51:16 +01:00
< p > The '< tt > llvm.gcroot< / tt > ' intrinsic declares the existence of a GC root to
2004-05-23 23:06:01 +02:00
the code generator, and allows some metadata to be associated with it.< / p >
< h5 > Arguments:< / h5 >
< p > The first argument specifies the address of a stack object that contains the
root pointer. The second pointer (which must be either a constant or a global
value address) contains the meta-data to be associated with the root.< / p >
< h5 > Semantics:< / h5 >
< p > At runtime, a call to this intrinsics stores a null pointer into the "ptrloc"
location. At compile-time, the code generator generates information to allow
the runtime to find the pointer at GC safe points.
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_gcread" > '< tt > llvm.gcread< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-03-14 21:02:51 +01:00
declare sbyte* %llvm.gcread(sbyte* %ObjPtr, sbyte** %Ptr)
2004-05-23 23:06:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > llvm.gcread< / tt > ' intrinsic identifies reads of references from heap
locations, allowing garbage collector implementations that require read
barriers.< / p >
< h5 > Arguments:< / h5 >
2006-03-14 21:02:51 +01:00
< p > The second argument is the address to read from, which should be an address
allocated from the garbage collector. The first object is a pointer to the
start of the referenced object, if needed by the language runtime (otherwise
null).< / p >
2004-05-23 23:06:01 +02:00
< h5 > Semantics:< / h5 >
< p > The '< tt > llvm.gcread< / tt > ' intrinsic has the same semantics as a load
instruction, but may be replaced with substantially more complex code by the
garbage collector runtime, as needed.< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_gcwrite" > '< tt > llvm.gcwrite< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-03-14 21:02:51 +01:00
declare void %llvm.gcwrite(sbyte* %P1, sbyte* %Obj, sbyte** %P2)
2004-05-23 23:06:01 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p > The '< tt > llvm.gcwrite< / tt > ' intrinsic identifies writes of references to heap
locations, allowing garbage collector implementations that require write
barriers (such as generational or reference counting collectors).< / p >
< h5 > Arguments:< / h5 >
2006-03-14 21:02:51 +01:00
< p > The first argument is the reference to store, the second is the start of the
object to store it to, and the third is the address of the field of Obj to
store to. If the runtime does not require a pointer to the object, Obj may be
null.< / p >
2004-05-23 23:06:01 +02:00
< h5 > Semantics:< / h5 >
< p > The '< tt > llvm.gcwrite< / tt > ' intrinsic has the same semantics as a store
instruction, but may be replaced with substantially more complex code by the
garbage collector runtime, as needed.< / p >
< / div >
2004-02-12 18:01:32 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
2004-02-14 05:08:35 +01:00
< a name = "int_codegen" > Code Generator Intrinsics< / a >
< / div >
< div class = "doc_text" >
< p >
These intrinsics are provided by LLVM to expose special features that may only
be implemented with code generator support.
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_returnaddress" > '< tt > llvm.returnaddress< / tt > ' Intrinsic< / a >
2004-02-12 18:01:32 +01:00
< / div >
< div class = "doc_text" >
2004-02-14 05:08:35 +01:00
< h5 > Syntax:< / h5 >
< pre >
2006-01-13 02:20:27 +01:00
declare sbyte *%llvm.returnaddress(uint < level> )
2004-02-14 05:08:35 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-10-15 22:05:59 +02:00
The '< tt > llvm.returnaddress< / tt > ' intrinsic attempts to compute a
target-specific value indicating the return address of the current function
or one of its callers.
2004-02-14 05:08:35 +01:00
< / p >
< h5 > Arguments:< / h5 >
< p >
The argument to this intrinsic indicates which function to return the address
for. Zero indicates the calling function, one indicates its caller, etc. The
argument is < b > required< / b > to be a constant integer value.
< / p >
< h5 > Semantics:< / h5 >
< p >
The '< tt > llvm.returnaddress< / tt > ' intrinsic either returns a pointer indicating
the return address of the specified call frame, or zero if it cannot be
identified. The value returned by this intrinsic is likely to be incorrect or 0
for arguments other than zero, so it should only be used for debugging purposes.
< / p >
< p >
Note that calling this intrinsic does not prevent function inlining or other
2005-03-07 21:30:51 +01:00
aggressive transformations, so the value returned may not be that of the obvious
2004-02-14 05:08:35 +01:00
source-language caller.
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_frameaddress" > '< tt > llvm.frameaddress< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-01-13 02:20:27 +01:00
declare sbyte *%llvm.frameaddress(uint < level> )
2004-02-14 05:08:35 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-10-15 22:05:59 +02:00
The '< tt > llvm.frameaddress< / tt > ' intrinsic attempts to return the
target-specific frame pointer value for the specified stack frame.
2004-02-14 05:08:35 +01:00
< / p >
< h5 > Arguments:< / h5 >
< p >
The argument to this intrinsic indicates which function to return the frame
pointer for. Zero indicates the calling function, one indicates its caller,
etc. The argument is < b > required< / b > to be a constant integer value.
< / p >
< h5 > Semantics:< / h5 >
< p >
The '< tt > llvm.frameaddress< / tt > ' intrinsic either returns a pointer indicating
the frame address of the specified call frame, or zero if it cannot be
identified. The value returned by this intrinsic is likely to be incorrect or 0
for arguments other than zero, so it should only be used for debugging purposes.
< / p >
2004-02-12 18:01:32 +01:00
< p >
2004-02-14 05:08:35 +01:00
Note that calling this intrinsic does not prevent function inlining or other
2005-03-07 21:30:51 +01:00
aggressive transformations, so the value returned may not be that of the obvious
2004-02-14 05:08:35 +01:00
source-language caller.
< / p >
< / div >
2006-01-13 03:03:13 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_stacksave" > '< tt > llvm.stacksave< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
declare sbyte *%llvm.stacksave()
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.stacksave< / tt > ' intrinsic is used to remember the current state of
the function stack, for use with < a href = "#i_stackrestore" >
< tt > llvm.stackrestore< / tt > < / a > . This is useful for implementing language
features like scoped automatic variable sized arrays in C99.
< / p >
< h5 > Semantics:< / h5 >
< p >
This intrinsic returns a opaque pointer value that can be passed to < a
href="#i_stackrestore">< tt > llvm.stackrestore< / tt > < / a > . When an
< tt > llvm.stackrestore< / tt > intrinsic is executed with a value saved from
< tt > llvm.stacksave< / tt > , it effectively restores the state of the stack to the
state it was in when the < tt > llvm.stacksave< / tt > intrinsic executed. In
practice, this pops any < a href = "#i_alloca" > alloca< / a > blocks from the stack
that were allocated after the < tt > llvm.stacksave< / tt > was executed.
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_stackrestore" > '< tt > llvm.stackrestore< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
declare void %llvm.stackrestore(sbyte* %ptr)
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.stackrestore< / tt > ' intrinsic is used to restore the state of
the function stack to the state it was in when the corresponding < a
href="#llvm.stacksave">< tt > llvm.stacksave< / tt > < / a > intrinsic executed. This is
useful for implementing language features like scoped automatic variable sized
arrays in C99.
< / p >
< h5 > Semantics:< / h5 >
< p >
See the description for < a href = "#i_stacksave" > < tt > llvm.stacksave< / tt > < / a > .
< / p >
< / div >
2005-02-28 20:24:19 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_prefetch" > '< tt > llvm.prefetch< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2005-04-26 22:50:44 +02:00
declare void %llvm.prefetch(sbyte * < address> ,
uint < rw> , uint < locality> )
2005-02-28 20:24:19 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.prefetch< / tt > ' intrinsic is a hint to the code generator to insert
2005-05-16 18:17:45 +02:00
a prefetch instruction if supported; otherwise, it is a noop. Prefetches have
no
effect on the behavior of the program but can change its performance
2005-02-28 20:47:14 +01:00
characteristics.
2005-02-28 20:24:19 +01:00
< / p >
< h5 > Arguments:< / h5 >
< p >
< tt > address< / tt > is the address to be prefetched, < tt > rw< / tt > is the specifier
determining if the fetch should be for a read (0) or write (1), and
< tt > locality< / tt > is a temporal locality specifier ranging from (0) - no
2005-03-07 21:31:38 +01:00
locality, to (3) - extremely local keep in cache. The < tt > rw< / tt > and
2005-02-28 20:24:19 +01:00
< tt > locality< / tt > arguments must be constant integers.
< / p >
< h5 > Semantics:< / h5 >
< p >
This intrinsic does not modify the behavior of the program. In particular,
prefetches cannot trap and do not produce a value. On targets that support this
intrinsic, the prefetch can provide hints to the processor cache for better
performance.
< / p >
< / div >
2005-03-28 22:05:49 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_pcmarker" > '< tt > llvm.pcmarker< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2005-04-26 22:50:44 +02:00
declare void %llvm.pcmarker( uint < id> )
2005-03-28 22:05:49 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2005-05-16 18:17:45 +02:00
The '< tt > llvm.pcmarker< / tt > ' intrinsic is a method to export a Program Counter
(PC) in a region of
2005-03-28 22:05:49 +02:00
code to simulators and other tools. The method is target specific, but it is
expected that the marker will use exported symbols to transmit the PC of the marker.
2005-11-11 03:15:27 +01:00
The marker makes no guarantees that it will remain with any specific instruction
2005-11-15 07:07:55 +01:00
after optimizations. It is possible that the presence of a marker will inhibit
2006-03-24 08:16:10 +01:00
optimizations. The intended use is to be inserted after optimizations to allow
2005-05-16 18:17:45 +02:00
correlations of simulation runs.
2005-03-28 22:05:49 +02:00
< / p >
< h5 > Arguments:< / h5 >
< p >
< tt > id< / tt > is a numerical id identifying the marker.
< / p >
< h5 > Semantics:< / h5 >
< p >
This intrinsic does not modify the behavior of the program. Backends that do not
support this intrinisic may ignore it.
< / p >
< / div >
2005-11-11 17:47:30 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_readcyclecounter" > '< tt > llvm.readcyclecounter< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
declare ulong %llvm.readcyclecounter( )
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.readcyclecounter< / tt > ' intrinsic provides access to the cycle
counter register (or similar low latency, high accuracy clocks) on those targets
that support it. On X86, it should map to RDTSC. On Alpha, it should map to RPCC.
As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
should only be used for small timings.
< / p >
< h5 > Semantics:< / h5 >
< p >
When directly supported, reading the cycle counter should not modify any memory.
Implementations are allowed to either return a application specific value or a
system wide value. On backends without support, this is lowered to a constant 0.
< / p >
< / div >
2004-02-14 05:08:35 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "int_libc" > Standard C Library Intrinsics< / a >
< / div >
2004-02-12 18:01:32 +01:00
2004-02-14 05:08:35 +01:00
< div class = "doc_text" >
< p >
LLVM provides intrinsics for a few important standard C library functions.
These intrinsics allow source-language front-ends to pass information about the
alignment of the pointer arguments to the code generator, providing opportunity
for more efficient code generation.
2004-02-12 18:01:32 +01:00
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_memcpy" > '< tt > llvm.memcpy< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-03-03 01:07:20 +01:00
declare void %llvm.memcpy.i32(sbyte* < dest> , sbyte* < src> ,
uint < len> , uint < align> )
declare void %llvm.memcpy.i64(sbyte* < dest> , sbyte* < src> ,
ulong < len> , uint < align> )
2004-02-12 18:01:32 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memcpy.*< / tt > ' intrinsics copy a block of memory from the source
2004-02-12 18:01:32 +01:00
location to the destination location.
< / p >
< p >
2006-03-03 01:07:20 +01:00
Note that, unlike the standard libc function, the < tt > llvm.memcpy.*< / tt >
intrinsics do not return a value, and takes an extra alignment argument.
2004-02-12 18:01:32 +01:00
< / p >
< h5 > Arguments:< / h5 >
< p >
The first argument is a pointer to the destination, the second is a pointer to
2006-03-03 01:07:20 +01:00
the source. The third argument is an integer argument
2004-02-12 18:01:32 +01:00
specifying the number of bytes to copy, and the fourth argument is the alignment
of the source and destination locations.
< / p >
2004-02-12 22:18:15 +01:00
< p >
If the call to this intrinisic has an alignment value that is not 0 or 1, then
2006-03-04 01:02:10 +01:00
the caller guarantees that both the source and destination pointers are aligned
to that boundary.
2004-02-12 22:18:15 +01:00
< / p >
2004-02-12 18:01:32 +01:00
< h5 > Semantics:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memcpy.*< / tt > ' intrinsics copy a block of memory from the source
2004-02-12 18:01:32 +01:00
location to the destination location, which are not allowed to overlap. It
copies "len" bytes of memory over. If the argument is known to be aligned to
some boundary, this can be specified as the fourth argument, otherwise it should
be set to 0 or 1.
< / p >
< / div >
2004-02-12 19:10:10 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_memmove" > '< tt > llvm.memmove< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-03-03 01:07:20 +01:00
declare void %llvm.memmove.i32(sbyte* < dest> , sbyte* < src> ,
uint < len> , uint < align> )
declare void %llvm.memmove.i64(sbyte* < dest> , sbyte* < src> ,
ulong < len> , uint < align> )
2004-02-12 19:10:10 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memmove.*< / tt > ' intrinsics move a block of memory from the source
location to the destination location. It is similar to the
'< tt > llvm.memcmp< / tt > ' intrinsic but allows the two memory locations to overlap.
2004-02-12 19:10:10 +01:00
< / p >
< p >
2006-03-03 01:07:20 +01:00
Note that, unlike the standard libc function, the < tt > llvm.memmove.*< / tt >
intrinsics do not return a value, and takes an extra alignment argument.
2004-02-12 19:10:10 +01:00
< / p >
< h5 > Arguments:< / h5 >
< p >
The first argument is a pointer to the destination, the second is a pointer to
2006-03-03 01:07:20 +01:00
the source. The third argument is an integer argument
2004-02-12 19:10:10 +01:00
specifying the number of bytes to copy, and the fourth argument is the alignment
of the source and destination locations.
< / p >
2004-02-12 22:18:15 +01:00
< p >
If the call to this intrinisic has an alignment value that is not 0 or 1, then
2006-03-04 01:02:10 +01:00
the caller guarantees that the source and destination pointers are aligned to
that boundary.
2004-02-12 22:18:15 +01:00
< / p >
2004-02-12 19:10:10 +01:00
< h5 > Semantics:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memmove.*< / tt > ' intrinsics copy a block of memory from the source
2004-02-12 19:10:10 +01:00
location to the destination location, which may overlap. It
copies "len" bytes of memory over. If the argument is known to be aligned to
some boundary, this can be specified as the fourth argument, otherwise it should
be set to 0 or 1.
< / p >
< / div >
2004-01-06 06:31:32 +01:00
2004-02-14 05:08:35 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-03-03 01:07:20 +01:00
< a name = "i_memset" > '< tt > llvm.memset.*< / tt > ' Intrinsics< / a >
2004-02-14 05:08:35 +01:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-03-03 01:07:20 +01:00
declare void %llvm.memset.i32(sbyte* < dest> , ubyte < val> ,
uint < len> , uint < align> )
declare void %llvm.memset.i64(sbyte* < dest> , ubyte < val> ,
ulong < len> , uint < align> )
2004-02-14 05:08:35 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memset.*< / tt > ' intrinsics fill a block of memory with a particular
2004-02-14 05:08:35 +01:00
byte value.
< / p >
< p >
Note that, unlike the standard libc function, the < tt > llvm.memset< / tt > intrinsic
does not return a value, and takes an extra alignment argument.
< / p >
< h5 > Arguments:< / h5 >
< p >
The first argument is a pointer to the destination to fill, the second is the
2006-03-03 01:07:20 +01:00
byte value to fill it with, the third argument is an integer
2004-02-14 05:08:35 +01:00
argument specifying the number of bytes to fill, and the fourth argument is the
known alignment of destination location.
< / p >
< p >
If the call to this intrinisic has an alignment value that is not 0 or 1, then
2006-03-04 01:02:10 +01:00
the caller guarantees that the destination pointer is aligned to that boundary.
2004-02-14 05:08:35 +01:00
< / p >
< h5 > Semantics:< / h5 >
< p >
2006-03-03 01:07:20 +01:00
The '< tt > llvm.memset.*< / tt > ' intrinsics fill "len" bytes of memory starting at
the
2004-02-14 05:08:35 +01:00
destination location. If the argument is known to be aligned to some boundary,
this can be specified as the fourth argument, otherwise it should be set to 0 or
1.
< / p >
< / div >
2004-06-13 03:16:15 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
< a name = "i_isunordered" > '< tt > llvm.isunordered.*< / tt > ' Intrinsic< / a >
2004-06-13 03:16:15 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
declare bool %llvm.isunordered.f32(float Val1, float Val2)
declare bool %llvm.isunordered.f64(double Val1, double Val2)
2004-06-13 03:16:15 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
The '< tt > llvm.isunordered< / tt > ' intrinsics return true if either or both of the
2004-06-13 03:16:15 +02:00
specified floating point values is a NAN.
< / p >
< h5 > Arguments:< / h5 >
< p >
The arguments are floating point numbers of the same type.
< / p >
< h5 > Semantics:< / h5 >
< p >
If either or both of the arguments is a SNAN or QNAN, it returns true, otherwise
false.
< / p >
< / div >
2005-07-21 03:29:16 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-01-16 23:38:59 +01:00
< a name = "i_sqrt" > '< tt > llvm.sqrt.*< / tt > ' Intrinsic< / a >
2005-07-21 03:29:16 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-09-08 08:34:02 +02:00
declare float %llvm.sqrt.f32(float %Val)
declare double %llvm.sqrt.f64(double %Val)
2005-07-21 03:29:16 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
The '< tt > llvm.sqrt< / tt > ' intrinsics return the sqrt of the specified operand,
2005-07-21 03:29:16 +02:00
returning the same value as the libm '< tt > sqrt< / tt > ' function would. Unlike
< tt > sqrt< / tt > in libm, however, < tt > llvm.sqrt< / tt > has undefined behavior for
negative numbers (which allows for better optimization).
< / p >
< h5 > Arguments:< / h5 >
< p >
The argument and return value are floating point numbers of the same type.
< / p >
< h5 > Semantics:< / h5 >
< p >
This function returns the sqrt of the specified operand if it is a positive
floating point number.
< / p >
< / div >
2006-09-08 08:34:02 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_powi" > '< tt > llvm.powi.*< / tt > ' Intrinsic< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
declare float %llvm.powi.f32(float %Val, int %power)
declare double %llvm.powi.f64(double %Val, int %power)
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.powi.*< / tt > ' intrinsics return the first operand raised to the
specified (positive or negative) power. The order of evaluation of
multiplications is not defined.
< / p >
< h5 > Arguments:< / h5 >
< p >
The second argument is an integer power, and the first is a value to raise to
that power.
< / p >
< h5 > Semantics:< / h5 >
< p >
This function returns the first value raised to the second power with an
unspecified sequence of rounding operations.< / p >
< / div >
2005-05-03 20:01:48 +02:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
2006-01-14 00:26:38 +01:00
< a name = "int_manip" > Bit Manipulation Intrinsics< / a >
2005-05-03 20:01:48 +02:00
< / div >
< div class = "doc_text" >
< p >
2006-01-14 00:26:38 +01:00
LLVM provides intrinsics for a few important bit manipulation operations.
2005-05-03 20:01:48 +02:00
These allow efficient code generation for some algorithms.
< / p >
< / div >
2006-01-14 00:26:38 +01:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
< a name = "i_bswap" > '< tt > llvm.bswap.*< / tt > ' Intrinsics< / a >
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-01-16 23:38:59 +01:00
declare ushort %llvm.bswap.i16(ushort < id> )
declare uint %llvm.bswap.i32(uint < id> )
declare ulong %llvm.bswap.i64(ulong < id> )
2006-01-14 00:26:38 +01:00
< / pre >
< h5 > Overview:< / h5 >
< p >
The '< tt > llvm.bwsap< / tt > ' family of intrinsics is used to byteswap a 16, 32 or
64 bit quantity. These are useful for performing operations on data that is not
in the target's native byte order.
< / p >
< h5 > Semantics:< / h5 >
< p >
2006-01-16 23:38:59 +01:00
The < tt > llvm.bswap.16< / tt > intrinsic returns a ushort value that has the high and low
byte of the input ushort swapped. Similarly, the < tt > llvm.bswap.i32< / tt > intrinsic
2006-01-14 00:26:38 +01:00
returns a uint value that has the four bytes of the input uint swapped, so that
if the input bytes are numbered 0, 1, 2, 3 then the returned uint will have its
2006-01-16 23:38:59 +01:00
bytes in 3, 2, 1, 0 order. The < tt > llvm.bswap.i64< / tt > intrinsic extends this concept
2006-01-14 00:26:38 +01:00
to 64 bits.
< / p >
< / div >
2005-05-03 20:01:48 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
< a name = "int_ctpop" > '< tt > llvm.ctpop.*< / tt > ' Intrinsic< / a >
2005-05-03 20:01:48 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-01-16 23:38:59 +01:00
declare ubyte %llvm.ctpop.i8 (ubyte < src> )
declare ushort %llvm.ctpop.i16(ushort < src> )
declare uint %llvm.ctpop.i32(uint < src> )
declare ulong %llvm.ctpop.i64(ulong < src> )
2005-05-03 20:01:48 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
2006-01-16 23:38:59 +01:00
The '< tt > llvm.ctpop< / tt > ' family of intrinsics counts the number of bits set in a
value.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Arguments:< / h5 >
< p >
2005-05-07 03:46:40 +02:00
The only argument is the value to be counted. The argument may be of any
2006-01-16 23:38:59 +01:00
unsigned integer type. The return type must match the argument type.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Semantics:< / h5 >
< p >
The '< tt > llvm.ctpop< / tt > ' intrinsic counts the 1's in a variable.
< / p >
< / div >
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-01-16 23:34:14 +01:00
< a name = "int_ctlz" > '< tt > llvm.ctlz.*< / tt > ' Intrinsic< / a >
2005-05-03 20:01:48 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-01-16 23:38:59 +01:00
declare ubyte %llvm.ctlz.i8 (ubyte < src> )
declare ushort %llvm.ctlz.i16(ushort < src> )
declare uint %llvm.ctlz.i32(uint < src> )
declare ulong %llvm.ctlz.i64(ulong < src> )
2005-05-03 20:01:48 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
The '< tt > llvm.ctlz< / tt > ' family of intrinsic functions counts the number of
leading zeros in a variable.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Arguments:< / h5 >
< p >
2005-05-07 03:46:40 +02:00
The only argument is the value to be counted. The argument may be of any
2006-01-16 23:38:59 +01:00
unsigned integer type. The return type must match the argument type.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Semantics:< / h5 >
< p >
2005-05-15 21:39:26 +02:00
The '< tt > llvm.ctlz< / tt > ' intrinsic counts the leading (most significant) zeros
in a variable. If the src == 0 then the result is the size in bits of the type
2006-04-21 23:37:40 +02:00
of src. For example, < tt > llvm.ctlz(int 2) = 30< / tt > .
2005-05-03 20:01:48 +02:00
< / p >
< / div >
2005-05-15 21:39:26 +02:00
2005-05-03 20:01:48 +02:00
<!-- _______________________________________________________________________ -->
< div class = "doc_subsubsection" >
2006-01-16 23:34:14 +01:00
< a name = "int_cttz" > '< tt > llvm.cttz.*< / tt > ' Intrinsic< / a >
2005-05-03 20:01:48 +02:00
< / div >
< div class = "doc_text" >
< h5 > Syntax:< / h5 >
< pre >
2006-01-16 23:38:59 +01:00
declare ubyte %llvm.cttz.i8 (ubyte < src> )
declare ushort %llvm.cttz.i16(ushort < src> )
declare uint %llvm.cttz.i32(uint < src> )
declare ulong %llvm.cttz.i64(ulong < src> )
2005-05-03 20:01:48 +02:00
< / pre >
< h5 > Overview:< / h5 >
< p >
For PR411:
This patch is an incremental step towards supporting a flat symbol table.
It de-overloads the intrinsic functions by providing type-specific intrinsics
and arranging for automatically upgrading from the old overloaded name to
the new non-overloaded name. Specifically:
llvm.isunordered -> llvm.isunordered.f32, llvm.isunordered.f64
llvm.sqrt -> llvm.sqrt.f32, llvm.sqrt.f64
llvm.ctpop -> llvm.ctpop.i8, llvm.ctpop.i16, llvm.ctpop.i32, llvm.ctpop.i64
llvm.ctlz -> llvm.ctlz.i8, llvm.ctlz.i16, llvm.ctlz.i32, llvm.ctlz.i64
llvm.cttz -> llvm.cttz.i8, llvm.cttz.i16, llvm.cttz.i32, llvm.cttz.i64
New code should not use the overloaded intrinsic names. Warnings will be
emitted if they are used.
llvm-svn: 25366
2006-01-16 22:12:35 +01:00
The '< tt > llvm.cttz< / tt > ' family of intrinsic functions counts the number of
trailing zeros.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Arguments:< / h5 >
< p >
2005-05-07 03:46:40 +02:00
The only argument is the value to be counted. The argument may be of any
2006-01-16 23:38:59 +01:00
unsigned integer type. The return type must match the argument type.
2005-05-03 20:01:48 +02:00
< / p >
< h5 > Semantics:< / h5 >
< p >
2005-05-15 21:39:26 +02:00
The '< tt > llvm.cttz< / tt > ' intrinsic counts the trailing (least significant) zeros
in a variable. If the src == 0 then the result is the size in bits of the type
of src. For example, < tt > llvm.cttz(2) = 1< / tt > .
2005-05-03 20:01:48 +02:00
< / p >
< / div >
2004-06-11 04:28:03 +02:00
2004-01-06 06:31:32 +01:00
<!-- ======================================================================= -->
< div class = "doc_subsection" >
< a name = "int_debugger" > Debugger Intrinsics< / a >
< / div >
< div class = "doc_text" >
< p >
The LLVM debugger intrinsics (which all start with < tt > llvm.dbg.< / tt > prefix),
are described in the < a
href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
Debugging< / a > document.
< / p >
< / div >
2001-06-06 22:29:01 +02:00
<!-- *********************************************************************** -->
< hr >
2004-03-01 18:47:27 +01:00
< address >
< a href = "http://jigsaw.w3.org/css-validator/check/referer" > < img
src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!">< / a >
< a href = "http://validator.w3.org/check/referer" > < img
src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" />< / a >
< a href = "mailto:sabre@nondot.org" > Chris Lattner< / a > < br >
2006-03-14 06:39:39 +01:00
< a href = "http://llvm.org" > The LLVM Compiler Infrastructure< / a > < br >
2004-03-01 18:47:27 +01:00
Last modified: $Date$
< / address >
2003-11-08 02:05:38 +01:00
< / body >
< / html >
