Blame - docs/LangRef.html - fp2-dev/platform/external/llvm

blob: 3f16e386c2beac5585b610cd89d758c930a9a7d8 [file] [log] [blame]

Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
				2	"http://www.w3.org/TR/html4/strict.dtd">
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3	<html>
				4	<head>
				5	<title>LLVM Assembly Language Reference Manual</title>
Reid Spencer	3921c74	2004-08-26 20:44:00 +0000	[diff] [blame]	6	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
				7	<meta name="author" content="Chris Lattner">
				8	<meta name="description"
				9	content="LLVM Assembly Language Reference Manual.">
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	10	<link rel="stylesheet" href="llvm.css" type="text/css">
				11	</head>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	12
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	13	<body>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	14
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	15	<div class="doc_title"> LLVM Language Reference Manual </div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	16	<ol>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	17	<li><a href="#abstract">Abstract</a></li>
				18	<li><a href="#introduction">Introduction</a></li>
				19	<li><a href="#identifiers">Identifiers</a></li>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	20	<li><a href="#highlevel">High Level Structure</a>
				21	<ol>
				22	<li><a href="#modulestructure">Module Structure</a></li>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	23	<li><a href="#linkage">Linkage Types</a></li>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	24	<li><a href="#callingconv">Calling Conventions</a></li>
Chris Lattner	e7886e4	2009-01-11 20:53:49 +0000	[diff] [blame]	25	<li><a href="#namedtypes">Named Types</a></li>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	26	<li><a href="#globalvars">Global Variables</a></li>
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	27	<li><a href="#functionstructure">Functions</a></li>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	28	<li><a href="#aliasstructure">Aliases</a></li>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	29	<li><a href="#paramattrs">Parameter Attributes</a></li>
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	30	<li><a href="#fnattrs">Function Attributes</a></li>
Gordon Henriksen	80a75bf	2007-12-10 03:18:06 +0000	[diff] [blame]	31	<li><a href="#gc">Garbage Collector Names</a></li>
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	32	<li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	33	<li><a href="#datalayout">Data Layout</a></li>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	34	</ol>
				35	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	36	<li><a href="#typesystem">Type System</a>
				37	<ol>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	38	<li><a href="#t_classifications">Type Classifications</a></li>
Robert Bocchino	7b81c75	2006-02-17 21:18:08 +0000	[diff] [blame]	39	<li><a href="#t_primitive">Primitive Types</a>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	40	<ol>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	41	<li><a href="#t_floating">Floating Point Types</a></li>
				42	<li><a href="#t_void">Void Type</a></li>
				43	<li><a href="#t_label">Label Type</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	44	</ol>
				45	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	46	<li><a href="#t_derived">Derived Types</a>
				47	<ol>
Chris Lattner	b9488a6	2007-12-18 06:18:21 +0000	[diff] [blame]	48	<li><a href="#t_integer">Integer Type</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	49	<li><a href="#t_array">Array Type</a></li>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	50	<li><a href="#t_function">Function Type</a></li>
				51	<li><a href="#t_pointer">Pointer Type</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	52	<li><a href="#t_struct">Structure Type</a></li>
Andrew Lenharth	75e1068	2006-12-08 17:13:00 +0000	[diff] [blame]	53	<li><a href="#t_pstruct">Packed Structure Type</a></li>
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	54	<li><a href="#t_vector">Vector Type</a></li>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	55	<li><a href="#t_opaque">Opaque Type</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	56	</ol>
				57	</li>
Chris Lattner	242d61d	2009-02-02 07:32:36 +0000	[diff] [blame]	58	<li><a href="#t_uprefs">Type Up-references</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	59	</ol>
				60	</li>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	61	<li><a href="#constants">Constants</a>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	62	<ol>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	63	<li><a href="#simpleconstants">Simple Constants</a></li>
Chris Lattner	7088279	2009-02-28 18:32:25 +0000	[diff] [blame]	64	<li><a href="#complexconstants">Complex Constants</a></li>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	65	<li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
				66	<li><a href="#undefvalues">Undefined Values</a></li>
				67	<li><a href="#constantexprs">Constant Expressions</a></li>
Nick Lewycky	21cc446	2009-04-04 07:22:01 +0000	[diff] [blame]	68	<li><a href="#metadata">Embedded Metadata</a></li>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	69	</ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	70	</li>
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	71	<li><a href="#othervalues">Other Values</a>
				72	<ol>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	73	<li><a href="#inlineasm">Inline Assembler Expressions</a></li>
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	74	</ol>
				75	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	76	<li><a href="#instref">Instruction Reference</a>
				77	<ol>
				78	<li><a href="#terminators">Terminator Instructions</a>
				79	<ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	80	<li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
				81	<li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	82	<li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
				83	<li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	84	<li><a href="#i_unwind">'<tt>unwind</tt>' Instruction</a></li>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	85	<li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	86	</ol>
				87	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	88	<li><a href="#binaryops">Binary Operations</a>
				89	<ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	90	<li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
				91	<li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
				92	<li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	93	<li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
				94	<li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
				95	<li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	96	<li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
				97	<li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
				98	<li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	99	</ol>
				100	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	101	<li><a href="#bitwiseops">Bitwise Binary Operations</a>
				102	<ol>
Reid Spencer	8e11bf8	2007-02-02 13:57:07 +0000	[diff] [blame]	103	<li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
				104	<li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
				105	<li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	106	<li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	107	<li><a href="#i_or">'<tt>or</tt>' Instruction</a></li>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	108	<li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	109	</ol>
				110	</li>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	111	<li><a href="#vectorops">Vector Operations</a>
				112	<ol>
				113	<li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
				114	<li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
				115	<li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	116	</ol>
				117	</li>
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	118	<li><a href="#aggregateops">Aggregate Operations</a>
				119	<ol>
				120	<li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
				121	<li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
				122	</ol>
				123	</li>
Chris Lattner	884a970	2006-08-15 00:45:58 +0000	[diff] [blame]	124	<li><a href="#memoryops">Memory Access and Addressing Operations</a>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	125	<ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	126	<li><a href="#i_malloc">'<tt>malloc</tt>' Instruction</a></li>
				127	<li><a href="#i_free">'<tt>free</tt>' Instruction</a></li>
				128	<li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
Robert Bocchino	7b81c75	2006-02-17 21:18:08 +0000	[diff] [blame]	129	<li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
				130	<li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
				131	<li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	132	</ol>
				133	</li>
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	134	<li><a href="#convertops">Conversion Operations</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	135	<ol>
				136	<li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
				137	<li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
				138	<li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
				139	<li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
				140	<li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	141	<li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
				142	<li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
				143	<li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
				144	<li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	145	<li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
				146	<li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	147	<li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	148	</ol>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	149	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	150	<li><a href="#otherops">Other Operations</a>
				151	<ol>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	152	<li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
				153	<li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	154	<li><a href="#i_vicmp">'<tt>vicmp</tt>' Instruction</a></li>
				155	<li><a href="#i_vfcmp">'<tt>vfcmp</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	156	<li><a href="#i_phi">'<tt>phi</tt>' Instruction</a></li>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	157	<li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	158	<li><a href="#i_call">'<tt>call</tt>' Instruction</a></li>
Chris Lattner	fb6977d	2006-01-13 23:26:01 +0000	[diff] [blame]	159	<li><a href="#i_va_arg">'<tt>va_arg</tt>' Instruction</a></li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	160	</ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	161	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	162	</ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	163	</li>
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	164	<li><a href="#intrinsics">Intrinsic Functions</a>
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	165	<ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	166	<li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
				167	<ol>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	168	<li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
				169	<li><a href="#int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a></li>
				170	<li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a></li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	171	</ol>
				172	</li>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	173	<li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
				174	<ol>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	175	<li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
				176	<li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
				177	<li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	178	</ol>
				179	</li>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	180	<li><a href="#int_codegen">Code Generator Intrinsics</a>
				181	<ol>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	182	<li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
				183	<li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a></li>
				184	<li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
				185	<li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
				186	<li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
				187	<li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
				188	<li><a href="#int_readcyclecounter"><tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
John Criswell	7123e27	2004-04-09 16:43:20 +0000	[diff] [blame]	189	</ol>
				190	</li>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	191	<li><a href="#int_libc">Standard C Library Intrinsics</a>
				192	<ol>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	193	<li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
				194	<li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
				195	<li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
				196	<li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
				197	<li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	198	<li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
				199	<li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
				200	<li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	201	</ol>
				202	</li>
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	203	<li><a href="#int_manip">Bit Manipulation Intrinsics</a>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	204	<ol>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	205	<li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
Chris Lattner	8a886be	2006-01-16 22:34:14 +0000	[diff] [blame]	206	<li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
				207	<li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
				208	<li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	209	<li><a href="#int_part_select">'<tt>llvm.part.select.*</tt>' Intrinsic </a></li>
				210	<li><a href="#int_part_set">'<tt>llvm.part.set.*</tt>' Intrinsic </a></li>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	211	</ol>
				212	</li>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	213	<li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
				214	<ol>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	215	<li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
				216	<li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
				217	<li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
				218	<li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
				219	<li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
Bill Wendling	41b485c	2009-02-08 23:00:09 +0000	[diff] [blame]	220	<li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	221	</ol>
				222	</li>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	223	<li><a href="#int_debugger">Debugger intrinsics</a></li>
Jim Laskey	dd4ef1b	2007-03-14 19:31:19 +0000	[diff] [blame]	224	<li><a href="#int_eh">Exception Handling intrinsics</a></li>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	225	<li><a href="#int_trampoline">Trampoline Intrinsic</a>
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	226	<ol>
				227	<li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	228	</ol>
				229	</li>
Bill Wendling	3c44f5b	2008-11-18 22:10:53 +0000	[diff] [blame]	230	<li><a href="#int_atomics">Atomic intrinsics</a>
				231	<ol>
				232	<li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
				233	<li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
				234	<li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
				235	<li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
				236	<li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
				237	<li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
				238	<li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
				239	<li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
				240	<li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
				241	<li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
				242	<li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
				243	<li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
				244	<li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
				245	</ol>
				246	</li>
Reid Spencer	2067764	2007-07-20 19:59:11 +0000	[diff] [blame]	247	<li><a href="#int_general">General intrinsics</a>
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	248	<ol>
Reid Spencer	2067764	2007-07-20 19:59:11 +0000	[diff] [blame]	249	<li><a href="#int_var_annotation">
Bill Wendling	69e4adb	2008-11-19 05:56:17 +0000	[diff] [blame]	250	'<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	251	<li><a href="#int_annotation">
Bill Wendling	69e4adb	2008-11-19 05:56:17 +0000	[diff] [blame]	252	'<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
Anton Korobeynikov	4cb8618	2008-01-15 22:31:34 +0000	[diff] [blame]	253	<li><a href="#int_trap">
Bill Wendling	69e4adb	2008-11-19 05:56:17 +0000	[diff] [blame]	254	'<tt>llvm.trap</tt>' Intrinsic</a></li>
				255	<li><a href="#int_stackprotector">
				256	'<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	257	</ol>
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	258	</li>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	259	</ol>
				260	</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	261	</ol>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	262
				263	<div class="doc_author">
				264	<p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
				265	and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	266	</div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	267
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	268	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	269	<div class="doc_section"> <a name="abstract">Abstract </a></div>
				270	<!-- *********************************************************************** -->
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	271
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	272	<div class="doc_text">
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	273	<p>This document is a reference manual for the LLVM assembly language.
Bill Wendling	837f39b	2008-08-05 22:29:16 +0000	[diff] [blame]	274	LLVM is a Static Single Assignment (SSA) based representation that provides
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	275	type safety, low-level operations, flexibility, and the capability of
				276	representing 'all' high-level languages cleanly. It is the common code
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	277	representation used throughout all phases of the LLVM compilation
				278	strategy.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	279	</div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	280
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	281	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	282	<div class="doc_section"> <a name="introduction">Introduction</a> </div>
				283	<!-- *********************************************************************** -->
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	284
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	285	<div class="doc_text">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	286
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	287	<p>The LLVM code representation is designed to be used in three
Gabor Greif	04367bf	2007-07-06 22:07:22 +0000	[diff] [blame]	288	different forms: as an in-memory compiler IR, as an on-disk bitcode
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	289	representation (suitable for fast loading by a Just-In-Time compiler),
				290	and as a human readable assembly language representation. This allows
				291	LLVM to provide a powerful intermediate representation for efficient
				292	compiler transformations and analysis, while providing a natural means
				293	to debug and visualize the transformations. The three different forms
				294	of LLVM are all equivalent. This document describes the human readable
				295	representation and notation.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	296
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	297	<p>The LLVM representation aims to be light-weight and low-level
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	298	while being expressive, typed, and extensible at the same time. It
				299	aims to be a "universal IR" of sorts, by being at a low enough level
				300	that high-level ideas may be cleanly mapped to it (similar to how
				301	microprocessors are "universal IR's", allowing many source languages to
				302	be mapped to them). By providing type information, LLVM can be used as
				303	the target of optimizations: for example, through pointer analysis, it
				304	can be proven that a C automatic variable is never accessed outside of
				305	the current function... allowing it to be promoted to a simple SSA
				306	value instead of a memory location.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	307
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	308	</div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	309
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	310	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	311	<div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	312
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	313	<div class="doc_text">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	314
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	315	<p>It is important to note that this document describes 'well formed'
				316	LLVM assembly language. There is a difference between what the parser
				317	accepts and what is considered 'well formed'. For example, the
				318	following instruction is syntactically okay, but not well formed:</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	319
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	320	<div class="doc_code">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	321	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	322	%x = <a href="#i_add">add</a> i32 1, %x
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	323	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	324	</div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	325
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	326	<p>...because the definition of <tt>%x</tt> does not dominate all of
				327	its uses. The LLVM infrastructure provides a verification pass that may
				328	be used to verify that an LLVM module is well formed. This pass is
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	329	automatically run by the parser after parsing input assembly and by
Gabor Greif	04367bf	2007-07-06 22:07:22 +0000	[diff] [blame]	330	the optimizer before it outputs bitcode. The violations pointed out
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	331	by the verifier pass indicate bugs in transformation passes or input to
				332	the parser.</p>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	333	</div>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	334
Chris Lattner	cc68939	2007-10-03 17:34:29 +0000	[diff] [blame]	335	<!-- Describe the typesetting conventions here. -->
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	336
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	337	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	338	<div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	339	<!-- *********************************************************************** -->
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	340
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	341	<div class="doc_text">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	342
Reid Spencer	2c45228	2007-08-07 14:34:28 +0000	[diff] [blame]	343	<p>LLVM identifiers come in two basic types: global and local. Global
				344	identifiers (functions, global variables) begin with the @ character. Local
				345	identifiers (register names, types) begin with the % character. Additionally,
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	346	there are three different formats for identifiers, for different purposes:</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	347
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	348	<ol>
Reid Spencer	2c45228	2007-08-07 14:34:28 +0000	[diff] [blame]	349	<li>Named values are represented as a string of characters with their prefix.
				350	For example, %foo, @DivisionByZero, %a.really.long.identifier. The actual
				351	regular expression used is '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	352	Identifiers which require other characters in their names can be surrounded
Daniel Dunbar	76dea95	2008-10-14 23:51:43 +0000	[diff] [blame]	353	with quotes. Special characters may be escaped using "\xx" where xx is the
				354	ASCII code for the character in hexadecimal. In this way, any character can
				355	be used in a name value, even quotes themselves.
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	356
Reid Spencer	2c45228	2007-08-07 14:34:28 +0000	[diff] [blame]	357	<li>Unnamed values are represented as an unsigned numeric value with their
				358	prefix. For example, %12, @2, %44.</li>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	359
Reid Spencer	cc16dc3	2004-12-09 18:02:53 +0000	[diff] [blame]	360	<li>Constants, which are described in a <a href="#constants">section about
				361	constants</a>, below.</li>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	362	</ol>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	363
Reid Spencer	2c45228	2007-08-07 14:34:28 +0000	[diff] [blame]	364	<p>LLVM requires that values start with a prefix for two reasons: Compilers
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	365	don't need to worry about name clashes with reserved words, and the set of
				366	reserved words may be expanded in the future without penalty. Additionally,
				367	unnamed identifiers allow a compiler to quickly come up with a temporary
				368	variable without having to avoid symbol table conflicts.</p>
				369
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	370	<p>Reserved words in LLVM are very similar to reserved words in other
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	371	languages. There are keywords for different opcodes
				372	('<tt><a href="#i_add">add</a></tt>',
				373	'<tt><a href="#i_bitcast">bitcast</a></tt>',
				374	'<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	375	href="#t_void">void</a></tt>', '<tt><a href="#t_primitive">i32</a></tt>', etc...),
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	376	and others. These reserved words cannot conflict with variable names, because
Reid Spencer	2c45228	2007-08-07 14:34:28 +0000	[diff] [blame]	377	none of them start with a prefix character ('%' or '@').</p>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	378
				379	<p>Here is an example of LLVM code to multiply the integer variable
				380	'<tt>%X</tt>' by 8:</p>
				381
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	382	<p>The easy way:</p>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	383
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	384	<div class="doc_code">
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	385	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	386	%result = <a href="#i_mul">mul</a> i32 %X, 8
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	387	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	388	</div>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	389
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	390	<p>After strength reduction:</p>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	391
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	392	<div class="doc_code">
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	393	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	394	%result = <a href="#i_shl">shl</a> i32 %X, i8 3
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	395	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	396	</div>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	397
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	398	<p>And the hard way:</p>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	399
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	400	<div class="doc_code">
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	401	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	402	<a href="#i_add">add</a> i32 %X, %X <i>; yields {i32}:%0</i>
				403	<a href="#i_add">add</a> i32 %0, %0 <i>; yields {i32}:%1</i>
				404	%result = <a href="#i_add">add</a> i32 %1, %1
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	405	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	406	</div>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	407
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	408	<p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
				409	important lexical features of LLVM:</p>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	410
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	411	<ol>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	412
				413	<li>Comments are delimited with a '<tt>;</tt>' and go until the end of
				414	line.</li>
				415
				416	<li>Unnamed temporaries are created when the result of a computation is not
				417	assigned to a named value.</li>
				418
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	419	<li>Unnamed temporaries are numbered sequentially</li>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	420
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	421	</ol>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	422
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	423	<p>...and it also shows a convention that we follow in this document. When
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	424	demonstrating instructions, we will follow an instruction with a comment that
				425	defines the type and name of value produced. Comments are shown in italic
				426	text.</p>
				427
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	428	</div>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	429
				430	<!-- *********************************************************************** -->
				431	<div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
				432	<!-- *********************************************************************** -->
				433
				434	<!-- ======================================================================= -->
				435	<div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
				436	</div>
				437
				438	<div class="doc_text">
				439
				440	<p>LLVM programs are composed of "Module"s, each of which is a
				441	translation unit of the input programs. Each module consists of
				442	functions, global variables, and symbol table entries. Modules may be
				443	combined together with the LLVM linker, which merges function (and
				444	global variable) definitions, resolves forward declarations, and merges
				445	symbol table entries. Here is an example of the "hello world" module:</p>
				446
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	447	<div class="doc_code">
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	448	<pre><i>; Declare the string constant as a global constant...</i>
Chris Lattner	a89e5f1	2007-06-12 17:00:26 +0000	[diff] [blame]	449	<a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a> <a
				450	href="#globalvars">constant</a> <a href="#t_array">[13 x i8]</a> c"hello world\0A\00" <i>; [13 x i8]*</i>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	451
				452	<i>; External declaration of the puts function</i>
Chris Lattner	a89e5f1	2007-06-12 17:00:26 +0000	[diff] [blame]	453	<a href="#functionstructure">declare</a> i32 @puts(i8 ) <i>; i32(i8 )* </i>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	454
				455	<i>; Definition of main function</i>
Chris Lattner	a89e5f1	2007-06-12 17:00:26 +0000	[diff] [blame]	456	define i32 @main() { <i>; i32()* </i>
Dan Gohman	2a08c53	2009-01-04 23:44:43 +0000	[diff] [blame]	457	<i>; Convert [13 x i8]* to i8 *...</i>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	458	%cast210 = <a
Dan Gohman	2a08c53	2009-01-04 23:44:43 +0000	[diff] [blame]	459	href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0 <i>; i8 *</i>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	460
				461	<i>; Call puts function to write out the string to stdout...</i>
				462	<a
Chris Lattner	a89e5f1	2007-06-12 17:00:26 +0000	[diff] [blame]	463	href="#i_call">call</a> i32 @puts(i8 * %cast210) <i>; i32</i>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	464	<a
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	465	href="#i_ret">ret</a> i32 0<br>}<br>
				466	</pre>
				467	</div>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	468
				469	<p>This example is made up of a <a href="#globalvars">global variable</a>
				470	named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
				471	function, and a <a href="#functionstructure">function definition</a>
				472	for "<tt>main</tt>".</p>
				473
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	474	<p>In general, a module is made up of a list of global values,
				475	where both functions and global variables are global values. Global values are
				476	represented by a pointer to a memory location (in this case, a pointer to an
				477	array of char, and a pointer to a function), and have one of the following <a
				478	href="#linkage">linkage types</a>.</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	479
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	480	</div>
				481
				482	<!-- ======================================================================= -->
				483	<div class="doc_subsection">
				484	<a name="linkage">Linkage Types</a>
				485	</div>
				486
				487	<div class="doc_text">
				488
				489	<p>
				490	All Global Variables and Functions have one of the following types of linkage:
				491	</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	492
				493	<dl>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	494
Rafael Espindola	bb46f52	2009-01-15 20:18:42 +0000	[diff] [blame]	495	<dt><tt><b><a name="linkage_private">private</a></b></tt>: </dt>
				496
				497	<dd>Global values with private linkage are only directly accessible by
				498	objects in the current module. In particular, linking code into a module with
				499	an private global value may cause the private to be renamed as necessary to
				500	avoid collisions. Because the symbol is private to the module, all
				501	references can be updated. This doesn't show up in any symbol table in the
				502	object file.
				503	</dd>
				504
Dale Johannesen	2307a7f	2008-05-23 23:13:41 +0000	[diff] [blame]	505	<dt><tt><b><a name="linkage_internal">internal</a></b></tt>: </dt>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	506
Duncan Sands	81d05c2	2009-01-16 09:29:46 +0000	[diff] [blame]	507	<dd> Similar to private, but the value shows as a local symbol (STB_LOCAL in
Rafael Espindola	bb46f52	2009-01-15 20:18:42 +0000	[diff] [blame]	508	the case of ELF) in the object file. This corresponds to the notion of the
Chris Lattner	4887bd8	2007-01-14 06:51:48 +0000	[diff] [blame]	509	'<tt>static</tt>' keyword in C.
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	510	</dd>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	511
Chris Lattner	266c7bb	2009-04-13 05:44:34 +0000	[diff] [blame]	512	<dt><tt><b><a name="available_externally">available_externally</a></b></tt>:
				513	</dt>
				514
				515	<dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
				516	into the object file corresponding to the LLVM module. They exist to
				517	allow inlining and other optimizations to take place given knowledge of the
				518	definition of the global, which is known to be somewhere outside the module.
				519	Globals with <tt>available_externally</tt> linkage are allowed to be discarded
				520	at will, and are otherwise the same as <tt>linkonce_odr</tt>. This linkage
				521	type is only allowed on definitions, not declarations.</dd>
				522
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	523	<dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	524
Chris Lattner	4887bd8	2007-01-14 06:51:48 +0000	[diff] [blame]	525	<dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
				526	the same name when linkage occurs. This is typically used to implement
				527	inline functions, templates, or other code which must be generated in each
				528	translation unit that uses it. Unreferenced <tt>linkonce</tt> globals are
				529	allowed to be discarded.
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	530	</dd>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	531
Dale Johannesen	2307a7f	2008-05-23 23:13:41 +0000	[diff] [blame]	532	<dt><tt><b><a name="linkage_common">common</a></b></tt>: </dt>
				533
				534	<dd>"<tt>common</tt>" linkage is exactly the same as <tt>linkonce</tt>
				535	linkage, except that unreferenced <tt>common</tt> globals may not be
				536	discarded. This is used for globals that may be emitted in multiple
				537	translation units, but that are not guaranteed to be emitted into every
				538	translation unit that uses them. One example of this is tentative
				539	definitions in C, such as "<tt>int X;</tt>" at global scope.
				540	</dd>
				541
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	542	<dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	543
Dale Johannesen	2307a7f	2008-05-23 23:13:41 +0000	[diff] [blame]	544	<dd>"<tt>weak</tt>" linkage is the same as <tt>common</tt> linkage, except
				545	that some targets may choose to emit different assembly sequences for them
				546	for target-dependent reasons. This is used for globals that are declared
				547	"weak" in C source code.
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	548	</dd>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	549
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	550	<dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	551
				552	<dd>"<tt>appending</tt>" linkage may only be applied to global variables of
				553	pointer to array type. When two global variables with appending linkage are
				554	linked together, the two global arrays are appended together. This is the
				555	LLVM, typesafe, equivalent of having the system linker append together
				556	"sections" with identical names when .o files are linked.
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	557	</dd>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	558
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	559	<dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt>: </dt>
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	560
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	561	<dd>The semantics of this linkage follow the ELF object file model: the
				562	symbol is weak until linked, if not linked, the symbol becomes null instead
				563	of being an undefined reference.
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	564	</dd>
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	565
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	566	<dt><tt><b><a name="linkage_linkonce">linkonce_odr</a></b></tt>: </dt>
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	567	<dt><tt><b><a name="linkage_weak">weak_odr</a></b></tt>: </dt>
Chris Lattner	266c7bb	2009-04-13 05:44:34 +0000	[diff] [blame]	568	<dd>Some languages allow differing globals to be merged, such as two
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	569	functions with different semantics. Other languages, such as <tt>C++</tt>,
				570	ensure that only equivalent globals are ever merged (the "one definition
Chris Lattner	266c7bb	2009-04-13 05:44:34 +0000	[diff] [blame]	571	rule" - "ODR"). Such languages can use the <tt>linkonce_odr</tt>
Duncan Sands	4dc2b39	2009-03-11 20:14:15 +0000	[diff] [blame]	572	and <tt>weak_odr</tt> linkage types to indicate that the global will only
				573	be merged with equivalent globals. These linkage types are otherwise the
				574	same as their non-<tt>odr</tt> versions.
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	575	</dd>
				576
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	577	<dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
Chris Lattner	e5d947b	2004-12-09 16:36:40 +0000	[diff] [blame]	578
				579	<dd>If none of the above identifiers are used, the global is externally
				580	visible, meaning that it participates in linkage and can be used to resolve
				581	external symbol references.
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	582	</dd>
Reid Spencer	c891084	2007-04-11 23:49:50 +0000	[diff] [blame]	583	</dl>
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	584
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	585	<p>
				586	The next two types of linkage are targeted for Microsoft Windows platform
				587	only. They are designed to support importing (exporting) symbols from (to)
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	588	DLLs (Dynamic Link Libraries).
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	589	</p>
				590
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	591	<dl>
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	592	<dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt>: </dt>
				593
				594	<dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
				595	or variable via a global pointer to a pointer that is set up by the DLL
				596	exporting the symbol. On Microsoft Windows targets, the pointer name is
Dan Gohman	7956412	2009-01-12 21:35:55 +0000	[diff] [blame]	597	formed by combining <code>__imp_</code> and the function or variable name.
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	598	</dd>
				599
				600	<dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt>: </dt>
				601
				602	<dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
				603	pointer to a pointer in a DLL, so that it can be referenced with the
				604	<tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
Dan Gohman	7956412	2009-01-12 21:35:55 +0000	[diff] [blame]	605	name is formed by combining <code>__imp_</code> and the function or variable
Anton Korobeynikov	b74ed07	2006-09-14 18:23:27 +0000	[diff] [blame]	606	name.
				607	</dd>
				608
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	609	</dl>
				610
Dan Gohman	f003276	2008-11-24 17:18:39 +0000	[diff] [blame]	611	<p>For example, since the "<tt>.LC0</tt>"
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	612	variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
				613	variable and was linked with this one, one of the two would be renamed,
				614	preventing a collision. Since "<tt>main</tt>" and "<tt>puts</tt>" are
				615	external (i.e., lacking any linkage declarations), they are accessible
Reid Spencer	ac8d276	2007-01-05 00:59:10 +0000	[diff] [blame]	616	outside of the current module.</p>
				617	<p>It is illegal for a function <i>declaration</i>
Duncan Sands	5f4ee1f	2009-03-11 08:08:06 +0000	[diff] [blame]	618	to have any linkage type other than "externally visible", <tt>dllimport</tt>
				619	or <tt>extern_weak</tt>.</p>
Duncan Sands	667d4b8	2009-03-07 15:45:40 +0000	[diff] [blame]	620	<p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
				621	or <tt>weak_odr</tt> linkages.</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	622	</div>
				623
				624	<!-- ======================================================================= -->
				625	<div class="doc_subsection">
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	626	<a name="callingconv">Calling Conventions</a>
				627	</div>
				628
				629	<div class="doc_text">
				630
				631	<p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
				632	and <a href="#i_invoke">invokes</a> can all have an optional calling convention
				633	specified for the call. The calling convention of any pair of dynamic
				634	caller/callee must match, or the behavior of the program is undefined. The
				635	following calling conventions are supported by LLVM, and more may be added in
				636	the future:</p>
				637
				638	<dl>
				639	<dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
				640
				641	<dd>This calling convention (the default if no other calling convention is
				642	specified) matches the target C calling conventions. This calling convention
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	643	supports varargs function calls and tolerates some mismatch in the declared
Reid Spencer	c28d2bc	2006-12-31 21:30:18 +0000	[diff] [blame]	644	prototype and implemented declaration of the function (as does normal C).
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	645	</dd>
				646
				647	<dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
				648
				649	<dd>This calling convention attempts to make calls as fast as possible
				650	(e.g. by passing things in registers). This calling convention allows the
				651	target to use whatever tricks it wants to produce fast code for the target,
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	652	without having to conform to an externally specified ABI (Application Binary
				653	Interface). Implementations of this convention should allow arbitrary
Arnold Schwaighofer	9097d14	2008-05-14 09:17:12 +0000	[diff] [blame]	654	<a href="CodeGenerator.html#tailcallopt">tail call optimization</a> to be
				655	supported. This calling convention does not support varargs and requires the
				656	prototype of all callees to exactly match the prototype of the function
				657	definition.
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	658	</dd>
				659
				660	<dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
				661
				662	<dd>This calling convention attempts to make code in the caller as efficient
				663	as possible under the assumption that the call is not commonly executed. As
				664	such, these calls often preserve all registers so that the call does not break
				665	any live ranges in the caller side. This calling convention does not support
				666	varargs and requires the prototype of all callees to exactly match the
				667	prototype of the function definition.
				668	</dd>
				669
Chris Lattner	cfe6b37	2005-05-07 01:46:40 +0000	[diff] [blame]	670	<dt><b>"<tt>cc <<em>n</em>></tt>" - Numbered convention</b>:</dt>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	671
				672	<dd>Any calling convention may be specified by number, allowing
				673	target-specific calling conventions to be used. Target specific calling
				674	conventions start at 64.
				675	</dd>
Chris Lattner	cfe6b37	2005-05-07 01:46:40 +0000	[diff] [blame]	676	</dl>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	677
				678	<p>More calling conventions can be added/defined on an as-needed basis, to
				679	support pascal conventions or any other well-known target-independent
				680	convention.</p>
				681
				682	</div>
				683
				684	<!-- ======================================================================= -->
				685	<div class="doc_subsection">
Anton Korobeynikov	8cea37b	2007-01-23 12:35:46 +0000	[diff] [blame]	686	<a name="visibility">Visibility Styles</a>
				687	</div>
				688
				689	<div class="doc_text">
				690
				691	<p>
				692	All Global Variables and Functions have one of the following visibility styles:
				693	</p>
				694
				695	<dl>
				696	<dt><b>"<tt>default</tt>" - Default style</b>:</dt>
				697
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	698	<dd>On targets that use the ELF object file format, default visibility means
				699	that the declaration is visible to other
Anton Korobeynikov	8cea37b	2007-01-23 12:35:46 +0000	[diff] [blame]	700	modules and, in shared libraries, means that the declared entity may be
				701	overridden. On Darwin, default visibility means that the declaration is
				702	visible to other modules. Default visibility corresponds to "external
				703	linkage" in the language.
				704	</dd>
				705
				706	<dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
				707
				708	<dd>Two declarations of an object with hidden visibility refer to the same
				709	object if they are in the same shared object. Usually, hidden visibility
				710	indicates that the symbol will not be placed into the dynamic symbol table,
				711	so no other module (executable or shared library) can reference it
				712	directly.
				713	</dd>
				714
Anton Korobeynikov	6f9896f	2007-04-29 18:35:00 +0000	[diff] [blame]	715	<dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
				716
				717	<dd>On ELF, protected visibility indicates that the symbol will be placed in
				718	the dynamic symbol table, but that references within the defining module will
				719	bind to the local symbol. That is, the symbol cannot be overridden by another
				720	module.
				721	</dd>
Anton Korobeynikov	8cea37b	2007-01-23 12:35:46 +0000	[diff] [blame]	722	</dl>
				723
				724	</div>
				725
				726	<!-- ======================================================================= -->
				727	<div class="doc_subsection">
Chris Lattner	e7886e4	2009-01-11 20:53:49 +0000	[diff] [blame]	728	<a name="namedtypes">Named Types</a>
				729	</div>
				730
				731	<div class="doc_text">
				732
				733	<p>LLVM IR allows you to specify name aliases for certain types. This can make
				734	it easier to read the IR and make the IR more condensed (particularly when
				735	recursive types are involved). An example of a name specification is:
				736	</p>
				737
				738	<div class="doc_code">
				739	<pre>
				740	%mytype = type { %mytype*, i32 }
				741	</pre>
				742	</div>
				743
				744	<p>You may give a name to any <a href="#typesystem">type</a> except "<a
				745	href="t_void">void</a>". Type name aliases may be used anywhere a type is
				746	expected with the syntax "%mytype".</p>
				747
				748	<p>Note that type names are aliases for the structural type that they indicate,
				749	and that you can therefore specify multiple names for the same type. This often
				750	leads to confusing behavior when dumping out a .ll file. Since LLVM IR uses
				751	structural typing, the name is not part of the type. When printing out LLVM IR,
				752	the printer will pick <em>one name</em> to render all types of a particular
				753	shape. This means that if you have code where two different source types end up
				754	having the same LLVM type, that the dumper will sometimes print the "wrong" or
				755	unexpected type. This is an important design point and isn't going to
				756	change.</p>
				757
				758	</div>
				759
Chris Lattner	e7886e4	2009-01-11 20:53:49 +0000	[diff] [blame]	760	<!-- ======================================================================= -->
				761	<div class="doc_subsection">
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	762	<a name="globalvars">Global Variables</a>
				763	</div>
				764
				765	<div class="doc_text">
				766
Chris Lattner	3689a34	2005-02-12 19:30:21 +0000	[diff] [blame]	767	<p>Global variables define regions of memory allocated at compilation time
Chris Lattner	88f6c46	2005-11-12 00:45:07 +0000	[diff] [blame]	768	instead of run-time. Global variables may optionally be initialized, may have
Anton Korobeynikov	8b0a8c8	2007-04-25 14:27:10 +0000	[diff] [blame]	769	an explicit section to be placed in, and may have an optional explicit alignment
				770	specified. A variable may be defined as "thread_local", which means that it
				771	will not be shared by threads (each thread will have a separated copy of the
				772	variable). A variable may be defined as a global "constant," which indicates
				773	that the contents of the variable will <b>never</b> be modified (enabling better
Chris Lattner	3689a34	2005-02-12 19:30:21 +0000	[diff] [blame]	774	optimization, allowing the global data to be placed in the read-only section of
				775	an executable, etc). Note that variables that need runtime initialization
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	776	cannot be marked "constant" as there is a store to the variable.</p>
Chris Lattner	3689a34	2005-02-12 19:30:21 +0000	[diff] [blame]	777
				778	<p>
				779	LLVM explicitly allows <em>declarations</em> of global variables to be marked
				780	constant, even if the final definition of the global is not. This capability
				781	can be used to enable slightly better optimization of the program, but requires
				782	the language definition to guarantee that optimizations based on the
				783	'constantness' are valid for the translation units that do not include the
				784	definition.
				785	</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	786
				787	<p>As SSA values, global variables define pointer values that are in
				788	scope (i.e. they dominate) all basic blocks in the program. Global
				789	variables always define a pointer to their "content" type because they
				790	describe a region of memory, and all memory objects in LLVM are
				791	accessed through pointers.</p>
				792
Christopher Lamb	284d992	2007-12-11 09:31:00 +0000	[diff] [blame]	793	<p>A global variable may be declared to reside in a target-specifc numbered
				794	address space. For targets that support them, address spaces may affect how
				795	optimizations are performed and/or what target instructions are used to access
Christopher Lamb	d49e18d	2007-12-12 08:44:39 +0000	[diff] [blame]	796	the variable. The default address space is zero. The address space qualifier
				797	must precede any other attributes.</p>
Christopher Lamb	284d992	2007-12-11 09:31:00 +0000	[diff] [blame]	798
Chris Lattner	88f6c46	2005-11-12 00:45:07 +0000	[diff] [blame]	799	<p>LLVM allows an explicit section to be specified for globals. If the target
				800	supports it, it will emit globals to the section specified.</p>
				801
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	802	<p>An explicit alignment may be specified for a global. If not present, or if
				803	the alignment is set to zero, the alignment of the global is set by the target
				804	to whatever it feels convenient. If an explicit alignment is specified, the
				805	global is forced to have at least that much alignment. All alignments must be
				806	a power of 2.</p>
				807
Christopher Lamb	284d992	2007-12-11 09:31:00 +0000	[diff] [blame]	808	<p>For example, the following defines a global in a numbered address space with
				809	an initializer, section, and alignment:</p>
Chris Lattner	68027ea	2007-01-14 00:27:09 +0000	[diff] [blame]	810
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	811	<div class="doc_code">
Chris Lattner	68027ea	2007-01-14 00:27:09 +0000	[diff] [blame]	812	<pre>
Dan Gohman	398873c	2009-01-11 00:40:00 +0000	[diff] [blame]	813	@G = addrspace(5) constant float 1.0, section "foo", align 4
Chris Lattner	68027ea	2007-01-14 00:27:09 +0000	[diff] [blame]	814	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	815	</div>
Chris Lattner	68027ea	2007-01-14 00:27:09 +0000	[diff] [blame]	816
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	817	</div>
				818
				819
				820	<!-- ======================================================================= -->
				821	<div class="doc_subsection">
				822	<a name="functionstructure">Functions</a>
				823	</div>
				824
				825	<div class="doc_text">
				826
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	827	<p>LLVM function definitions consist of the "<tt>define</tt>" keyord,
				828	an optional <a href="#linkage">linkage type</a>, an optional
Anton Korobeynikov	8cea37b	2007-01-23 12:35:46 +0000	[diff] [blame]	829	<a href="#visibility">visibility style</a>, an optional
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	830	<a href="#callingconv">calling convention</a>, a return type, an optional
				831	<a href="#paramattrs">parameter attribute</a> for the return type, a function
				832	name, a (possibly empty) argument list (each with optional
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	833	<a href="#paramattrs">parameter attributes</a>), optional
				834	<a href="#fnattrs">function attributes</a>, an optional section,
				835	an optional alignment, an optional <a href="#gc">garbage collector name</a>,
Chris Lattner	0c46a7d	2008-10-04 18:10:21 +0000	[diff] [blame]	836	an opening curly brace, a list of basic blocks, and a closing curly brace.
Anton Korobeynikov	8cea37b	2007-01-23 12:35:46 +0000	[diff] [blame]	837
				838	LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
				839	optional <a href="#linkage">linkage type</a>, an optional
				840	<a href="#visibility">visibility style</a>, an optional
				841	<a href="#callingconv">calling convention</a>, a return type, an optional
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	842	<a href="#paramattrs">parameter attribute</a> for the return type, a function
Gordon Henriksen	80a75bf	2007-12-10 03:18:06 +0000	[diff] [blame]	843	name, a possibly empty list of arguments, an optional alignment, and an optional
Gordon Henriksen	e754abe	2007-12-10 03:30:21 +0000	[diff] [blame]	844	<a href="#gc">garbage collector name</a>.</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	845
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	846	<p>A function definition contains a list of basic blocks, forming the CFG
				847	(Control Flow Graph) for
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	848	the function. Each basic block may optionally start with a label (giving the
				849	basic block a symbol table entry), contains a list of instructions, and ends
				850	with a <a href="#terminators">terminator</a> instruction (such as a branch or
				851	function return).</p>
				852
Chris Lattner	4a3c901	2007-06-08 16:52:14 +0000	[diff] [blame]	853	<p>The first basic block in a function is special in two ways: it is immediately
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	854	executed on entrance to the function, and it is not allowed to have predecessor
				855	basic blocks (i.e. there can not be any branches to the entry block of a
				856	function). Because the block can have no predecessors, it also cannot have any
				857	<a href="#i_phi">PHI nodes</a>.</p>
				858
Chris Lattner	88f6c46	2005-11-12 00:45:07 +0000	[diff] [blame]	859	<p>LLVM allows an explicit section to be specified for functions. If the target
				860	supports it, it will emit functions to the section specified.</p>
				861
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	862	<p>An explicit alignment may be specified for a function. If not present, or if
				863	the alignment is set to zero, the alignment of the function is set by the target
				864	to whatever it feels convenient. If an explicit alignment is specified, the
				865	function is forced to have at least that much alignment. All alignments must be
				866	a power of 2.</p>
				867
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	868	<h5>Syntax:</h5>
				869
				870	<div class="doc_code">
Chris Lattner	50ad45c	2008-10-13 16:55:18 +0000	[diff] [blame]	871	<tt>
				872	define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
				873	[<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
				874	<ResultType> @<FunctionName> ([argument list])
				875	[<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
				876	[<a href="#gc">gc</a>] { ... }
				877	</tt>
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	878	</div>
				879
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	880	</div>
				881
Anton Korobeynikov	8b0a8c8	2007-04-25 14:27:10 +0000	[diff] [blame]	882
				883	<!-- ======================================================================= -->
				884	<div class="doc_subsection">
				885	<a name="aliasstructure">Aliases</a>
				886	</div>
				887	<div class="doc_text">
				888	<p>Aliases act as "second name" for the aliasee value (which can be either
Anton Korobeynikov	726d45c	2008-03-22 08:36:14 +0000	[diff] [blame]	889	function, global variable, another alias or bitcast of global value). Aliases
				890	may have an optional <a href="#linkage">linkage type</a>, and an
Anton Korobeynikov	8b0a8c8	2007-04-25 14:27:10 +0000	[diff] [blame]	891	optional <a href="#visibility">visibility style</a>.</p>
				892
				893	<h5>Syntax:</h5>
				894
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	895	<div class="doc_code">
Bill Wendling	aac388b	2007-05-29 09:42:13 +0000	[diff] [blame]	896	<pre>
Duncan Sands	0b23ac1	2008-09-12 20:48:21 +0000	[diff] [blame]	897	@<Name> = alias [Linkage] [Visibility] <AliaseeTy> @<Aliasee>
Bill Wendling	aac388b	2007-05-29 09:42:13 +0000	[diff] [blame]	898	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	899	</div>
Anton Korobeynikov	8b0a8c8	2007-04-25 14:27:10 +0000	[diff] [blame]	900
				901	</div>
				902
				903
				904
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	905	<!-- ======================================================================= -->
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	906	<div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
				907	<div class="doc_text">
				908	<p>The return type and each parameter of a function type may have a set of
				909	<i>parameter attributes</i> associated with them. Parameter attributes are
				910	used to communicate additional information about the result or parameters of
Duncan Sands	dc02467	2007-11-27 13:23:08 +0000	[diff] [blame]	911	a function. Parameter attributes are considered to be part of the function,
				912	not of the function type, so functions with different parameter attributes
				913	can have the same function type.</p>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	914
Reid Spencer	950e9f8	2007-01-15 18:27:39 +0000	[diff] [blame]	915	<p>Parameter attributes are simple keywords that follow the type specified. If
				916	multiple parameter attributes are needed, they are space separated. For
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	917	example:</p>
				918
				919	<div class="doc_code">
				920	<pre>
Nick Lewycky	b6a7d25	2009-02-15 23:06:14 +0000	[diff] [blame]	921	declare i32 @printf(i8* noalias nocapture, ...)
Chris Lattner	66d922c	2008-10-04 18:33:34 +0000	[diff] [blame]	922	declare i32 @atoi(i8 zeroext)
				923	declare signext i8 @returns_signed_char()
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	924	</pre>
				925	</div>
				926
Duncan Sands	dc02467	2007-11-27 13:23:08 +0000	[diff] [blame]	927	<p>Note that any attributes for the function result (<tt>nounwind</tt>,
				928	<tt>readonly</tt>) come immediately after the argument list.</p>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	929
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	930	<p>Currently, only the following parameter attributes are defined:</p>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	931	<dl>
Reid Spencer	9445e9a	2007-07-19 23:13:04 +0000	[diff] [blame]	932	<dt><tt>zeroext</tt></dt>
Chris Lattner	66d922c	2008-10-04 18:33:34 +0000	[diff] [blame]	933	<dd>This indicates to the code generator that the parameter or return value
				934	should be zero-extended to a 32-bit value by the caller (for a parameter)
				935	or the callee (for a return value).</dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	936
Reid Spencer	9445e9a	2007-07-19 23:13:04 +0000	[diff] [blame]	937	<dt><tt>signext</tt></dt>
Chris Lattner	66d922c	2008-10-04 18:33:34 +0000	[diff] [blame]	938	<dd>This indicates to the code generator that the parameter or return value
				939	should be sign-extended to a 32-bit value by the caller (for a parameter)
				940	or the callee (for a return value).</dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	941
Anton Korobeynikov	34d6dea	2007-01-28 14:30:45 +0000	[diff] [blame]	942	<dt><tt>inreg</tt></dt>
Dale Johannesen	c9c6da6	2008-09-25 20:47:45 +0000	[diff] [blame]	943	<dd>This indicates that this parameter or return value should be treated
				944	in a special target-dependent fashion during while emitting code for a
				945	function call or return (usually, by putting it in a register as opposed
Chris Lattner	66d922c	2008-10-04 18:33:34 +0000	[diff] [blame]	946	to memory, though some targets use it to distinguish between two different
				947	kinds of registers). Use of this attribute is target-specific.</dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	948
Duncan Sands	edb05df	2008-10-06 08:14:18 +0000	[diff] [blame]	949	<dt><tt><a name="byval">byval</a></tt></dt>
Chris Lattner	0747baa	2008-01-15 04:34:22 +0000	[diff] [blame]	950	<dd>This indicates that the pointer parameter should really be passed by
				951	value to the function. The attribute implies that a hidden copy of the
				952	pointee is made between the caller and the callee, so the callee is unable
Chris Lattner	ebec678	2008-08-05 18:21:08 +0000	[diff] [blame]	953	to modify the value in the callee. This attribute is only valid on LLVM
Chris Lattner	0747baa	2008-01-15 04:34:22 +0000	[diff] [blame]	954	pointer arguments. It is generally used to pass structs and arrays by
Duncan Sands	edb05df	2008-10-06 08:14:18 +0000	[diff] [blame]	955	value, but is also valid on pointers to scalars. The copy is considered to
				956	belong to the caller not the callee (for example,
				957	<tt><a href="#readonly">readonly</a></tt> functions should not write to
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	958	<tt>byval</tt> parameters). This is not a valid attribute for return
Chris Lattner	ce459b1	2009-02-05 05:42:28 +0000	[diff] [blame]	959	values. The byval attribute also supports specifying an alignment with the
				960	align attribute. This has a target-specific effect on the code generator
				961	that usually indicates a desired alignment for the synthesized stack
				962	slot.</dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	963
Anton Korobeynikov	34d6dea	2007-01-28 14:30:45 +0000	[diff] [blame]	964	<dt><tt>sret</tt></dt>
Duncan Sands	e26dec6	2008-02-18 04:19:38 +0000	[diff] [blame]	965	<dd>This indicates that the pointer parameter specifies the address of a
				966	structure that is the return value of the function in the source program.
Chris Lattner	66d922c	2008-10-04 18:33:34 +0000	[diff] [blame]	967	This pointer must be guaranteed by the caller to be valid: loads and stores
				968	to the structure may be assumed by the callee to not to trap. This may only
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	969	be applied to the first parameter. This is not a valid attribute for
				970	return values. </dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	971
Zhou Sheng	febca34	2007-06-05 05:28:26 +0000	[diff] [blame]	972	<dt><tt>noalias</tt></dt>
Nick Lewycky	02ff308	2008-11-24 03:41:24 +0000	[diff] [blame]	973	<dd>This indicates that the pointer does not alias any global or any other
				974	parameter. The caller is responsible for ensuring that this is the
Nick Lewycky	b2b32fd	2008-11-24 05:00:44 +0000	[diff] [blame]	975	case. On a function return value, <tt>noalias</tt> additionally indicates
				976	that the pointer does not alias any other pointers visible to the
Nick Lewycky	f23d0d3	2008-12-19 06:39:12 +0000	[diff] [blame]	977	caller. For further details, please see the discussion of the NoAlias
				978	response in
				979	<a href="http://llvm.org/docs/AliasAnalysis.html#MustMayNo">alias
				980	analysis</a>.</dd>
				981
				982	<dt><tt>nocapture</tt></dt>
				983	<dd>This indicates that the callee does not make any copies of the pointer
				984	that outlive the callee itself. This is not a valid attribute for return
				985	values.</dd>
Chris Lattner	47507de	2008-01-11 06:20:47 +0000	[diff] [blame]	986
Duncan Sands	50f19f5	2007-07-27 19:57:41 +0000	[diff] [blame]	987	<dt><tt>nest</tt></dt>
Duncan Sands	0789b8b	2008-07-08 09:27:25 +0000	[diff] [blame]	988	<dd>This indicates that the pointer parameter can be excised using the
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	989	<a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
				990	attribute for return values.</dd>
Anton Korobeynikov	7f70559	2007-01-12 19:20:47 +0000	[diff] [blame]	991	</dl>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	992
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	993	</div>
				994
				995	<!-- ======================================================================= -->
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	996	<div class="doc_subsection">
Gordon Henriksen	80a75bf	2007-12-10 03:18:06 +0000	[diff] [blame]	997	<a name="gc">Garbage Collector Names</a>
				998	</div>
				999
				1000	<div class="doc_text">
				1001	<p>Each function may specify a garbage collector name, which is simply a
				1002	string.</p>
				1003
				1004	<div class="doc_code"><pre
				1005	>define void @f() gc "name" { ...</pre></div>
				1006
				1007	<p>The compiler declares the supported values of <i>name</i>. Specifying a
				1008	collector which will cause the compiler to alter its output in order to support
				1009	the named garbage collection algorithm.</p>
				1010	</div>
				1011
				1012	<!-- ======================================================================= -->
				1013	<div class="doc_subsection">
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1014	<a name="fnattrs">Function Attributes</a>
Devang Patel	f8b9481	2008-09-04 23:05:13 +0000	[diff] [blame]	1015	</div>
				1016
				1017	<div class="doc_text">
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1018
				1019	<p>Function attributes are set to communicate additional information about
				1020	a function. Function attributes are considered to be part of the function,
				1021	not of the function type, so functions with different parameter attributes
				1022	can have the same function type.</p>
				1023
				1024	<p>Function attributes are simple keywords that follow the type specified. If
				1025	multiple attributes are needed, they are space separated. For
				1026	example:</p>
Devang Patel	f8b9481	2008-09-04 23:05:13 +0000	[diff] [blame]	1027
				1028	<div class="doc_code">
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1029	<pre>
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1030	define void @f() noinline { ... }
				1031	define void @f() alwaysinline { ... }
				1032	define void @f() alwaysinline optsize { ... }
				1033	define void @f() optsize
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1034	</pre>
Devang Patel	f8b9481	2008-09-04 23:05:13 +0000	[diff] [blame]	1035	</div>
				1036
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1037	<dl>
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1038	<dt><tt>alwaysinline</tt></dt>
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1039	<dd>This attribute indicates that the inliner should attempt to inline this
				1040	function into callers whenever possible, ignoring any active inlining size
				1041	threshold for this caller.</dd>
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1042
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1043	<dt><tt>noinline</tt></dt>
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1044	<dd>This attribute indicates that the inliner should never inline this function
Chris Lattner	94b5f7d	2008-10-05 17:14:59 +0000	[diff] [blame]	1045	in any situation. This attribute may not be used together with the
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1046	<tt>alwaysinline</tt> attribute.</dd>
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1047
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1048	<dt><tt>optsize</tt></dt>
Devang Patel	66c6c65	2008-09-29 18:34:44 +0000	[diff] [blame]	1049	<dd>This attribute suggests that optimization passes and code generator passes
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1050	make choices that keep the code size of this function low, and otherwise do
				1051	optimizations specifically to reduce code size.</dd>
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1052
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1053	<dt><tt>noreturn</tt></dt>
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1054	<dd>This function attribute indicates that the function never returns normally.
				1055	This produces undefined behavior at runtime if the function ever does
				1056	dynamically return.</dd>
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1057
				1058	<dt><tt>nounwind</tt></dt>
Chris Lattner	88d4b59	2008-10-04 18:23:17 +0000	[diff] [blame]	1059	<dd>This function attribute indicates that the function never returns with an
				1060	unwind or exceptional control flow. If the function does unwind, its runtime
				1061	behavior is undefined.</dd>
				1062
				1063	<dt><tt>readnone</tt></dt>
Duncan Sands	7af1c78	2009-05-06 06:49:50 +0000	[diff] [blame]	1064	<dd>This attribute indicates that the function computes its result (or decides to
				1065	unwind an exception) based strictly on its arguments, without dereferencing any
Duncan Sands	edb05df	2008-10-06 08:14:18 +0000	[diff] [blame]	1066	pointer arguments or otherwise accessing any mutable state (e.g. memory, control
				1067	registers, etc) visible to caller functions. It does not write through any
				1068	pointer arguments (including <tt><a href="#byval">byval</a></tt> arguments) and
Duncan Sands	7af1c78	2009-05-06 06:49:50 +0000	[diff] [blame]	1069	never changes any state visible to callers. This means that it cannot unwind
				1070	exceptions by calling the <tt>C++</tt> exception throwing methods, but could
				1071	use the <tt>unwind</tt> instruction.</dd>
Devang Patel	2c9c3e7	2008-09-26 23:51:19 +0000	[diff] [blame]	1072
Duncan Sands	edb05df	2008-10-06 08:14:18 +0000	[diff] [blame]	1073	<dt><tt><a name="readonly">readonly</a></tt></dt>
				1074	<dd>This attribute indicates that the function does not write through any
				1075	pointer arguments (including <tt><a href="#byval">byval</a></tt> arguments)
				1076	or otherwise modify any state (e.g. memory, control registers, etc) visible to
				1077	caller functions. It may dereference pointer arguments and read state that may
Duncan Sands	7af1c78	2009-05-06 06:49:50 +0000	[diff] [blame]	1078	be set in the caller. A readonly function always returns the same value (or
				1079	unwinds an exception identically) when called with the same set of arguments
				1080	and global state. It cannot unwind an exception by calling the <tt>C++</tt>
				1081	exception throwing methods, but may use the <tt>unwind</tt> instruction.</dd>
Bill Wendling	31359ba	2008-11-13 01:02:51 +0000	[diff] [blame]	1082
				1083	<dt><tt><a name="ssp">ssp</a></tt></dt>
Bill Wendling	baa39d8	2008-11-26 19:19:05 +0000	[diff] [blame]	1084	<dd>This attribute indicates that the function should emit a stack smashing
Bill Wendling	31359ba	2008-11-13 01:02:51 +0000	[diff] [blame]	1085	protector. It is in the form of a "canary"—a random value placed on the
				1086	stack before the local variables that's checked upon return from the function to
				1087	see if it has been overwritten. A heuristic is used to determine if a function
Bill Wendling	baa39d8	2008-11-26 19:19:05 +0000	[diff] [blame]	1088	needs stack protectors or not.
Bill Wendling	31359ba	2008-11-13 01:02:51 +0000	[diff] [blame]	1089
Bill Wendling	fbaa7ed	2008-11-26 19:07:40 +0000	[diff] [blame]	1090	<p>If a function that has an <tt>ssp</tt> attribute is inlined into a function
				1091	that doesn't have an <tt>ssp</tt> attribute, then the resulting function will
				1092	have an <tt>ssp</tt> attribute.</p></dd>
				1093
				1094	<dt><tt>sspreq</tt></dt>
Bill Wendling	baa39d8	2008-11-26 19:19:05 +0000	[diff] [blame]	1095	<dd>This attribute indicates that the function should <em>always</em> emit a
Bill Wendling	31359ba	2008-11-13 01:02:51 +0000	[diff] [blame]	1096	stack smashing protector. This overrides the <tt><a href="#ssp">ssp</a></tt>
Bill Wendling	baa39d8	2008-11-26 19:19:05 +0000	[diff] [blame]	1097	function attribute.
Bill Wendling	fbaa7ed	2008-11-26 19:07:40 +0000	[diff] [blame]	1098
				1099	<p>If a function that has an <tt>sspreq</tt> attribute is inlined into a
				1100	function that doesn't have an <tt>sspreq</tt> attribute or which has
				1101	an <tt>ssp</tt> attribute, then the resulting function will have
				1102	an <tt>sspreq</tt> attribute.</p></dd>
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1103	</dl>
				1104
Devang Patel	f8b9481	2008-09-04 23:05:13 +0000	[diff] [blame]	1105	</div>
				1106
				1107	<!-- ======================================================================= -->
				1108	<div class="doc_subsection">
Chris Lattner	1eeeb0c	2006-04-08 04:40:53 +0000	[diff] [blame]	1109	<a name="moduleasm">Module-Level Inline Assembly</a>
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	1110	</div>
				1111
				1112	<div class="doc_text">
				1113	<p>
				1114	Modules may contain "module-level inline asm" blocks, which corresponds to the
				1115	GCC "file scope inline asm" blocks. These blocks are internally concatenated by
				1116	LLVM and treated as a single unit, but may be separated in the .ll file if
				1117	desired. The syntax is very simple:
				1118	</p>
				1119
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	1120	<div class="doc_code">
				1121	<pre>
				1122	module asm "inline asm code goes here"
				1123	module asm "more can go here"
				1124	</pre>
				1125	</div>
Chris Lattner	4e9aba7	2006-01-23 23:23:47 +0000	[diff] [blame]	1126
				1127	<p>The strings can contain any character by escaping non-printable characters.
				1128	The escape sequence used is simply "\xx" where "xx" is the two digit hex code
				1129	for the number.
				1130	</p>
				1131
				1132	<p>
				1133	The inline asm code is simply printed to the machine code .s file when
				1134	assembly code is generated.
				1135	</p>
				1136	</div>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	1137
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1138	<!-- ======================================================================= -->
				1139	<div class="doc_subsection">
				1140	<a name="datalayout">Data Layout</a>
				1141	</div>
				1142
				1143	<div class="doc_text">
				1144	<p>A module may specify a target specific data layout string that specifies how
Reid Spencer	c891084	2007-04-11 23:49:50 +0000	[diff] [blame]	1145	data is to be laid out in memory. The syntax for the data layout is simply:</p>
				1146	<pre> target datalayout = "<i>layout specification</i>"</pre>
				1147	<p>The <i>layout specification</i> consists of a list of specifications
				1148	separated by the minus sign character ('-'). Each specification starts with a
				1149	letter and may include other information after the letter to define some
				1150	aspect of the data layout. The specifications accepted are as follows: </p>
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1151	<dl>
				1152	<dt><tt>E</tt></dt>
				1153	<dd>Specifies that the target lays out data in big-endian form. That is, the
				1154	bits with the most significance have the lowest address location.</dd>
				1155	<dt><tt>e</tt></dt>
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	1156	<dd>Specifies that the target lays out data in little-endian form. That is,
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1157	the bits with the least significance have the lowest address location.</dd>
				1158	<dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
				1159	<dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
				1160	<i>preferred</i> alignments. All sizes are in bits. Specifying the <i>pref</i>
				1161	alignment is optional. If omitted, the preceding <tt>:</tt> should be omitted
				1162	too.</dd>
				1163	<dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
				1164	<dd>This specifies the alignment for an integer type of a given bit
				1165	<i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
				1166	<dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
				1167	<dd>This specifies the alignment for a vector type of a given bit
				1168	<i>size</i>.</dd>
				1169	<dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
				1170	<dd>This specifies the alignment for a floating point type of a given bit
				1171	<i>size</i>. The value of <i>size</i> must be either 32 (float) or 64
				1172	(double).</dd>
				1173	<dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
				1174	<dd>This specifies the alignment for an aggregate type of a given bit
				1175	<i>size</i>.</dd>
				1176	</dl>
				1177	<p>When constructing the data layout for a given target, LLVM starts with a
				1178	default set of specifications which are then (possibly) overriden by the
				1179	specifications in the <tt>datalayout</tt> keyword. The default specifications
				1180	are given in this list:</p>
				1181	<ul>
				1182	<li><tt>E</tt> - big endian</li>
				1183	<li><tt>p:32:64:64</tt> - 32-bit pointers with 64-bit alignment</li>
				1184	<li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
				1185	<li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
				1186	<li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
				1187	<li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	1188	<li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1189	alignment of 64-bits</li>
				1190	<li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
				1191	<li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
				1192	<li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
				1193	<li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
				1194	<li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
				1195	</ul>
Chris Lattner	ebec678	2008-08-05 18:21:08 +0000	[diff] [blame]	1196	<p>When LLVM is determining the alignment for a given type, it uses the
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	1197	following rules:</p>
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1198	<ol>
				1199	<li>If the type sought is an exact match for one of the specifications, that
				1200	specification is used.</li>
				1201	<li>If no match is found, and the type sought is an integer type, then the
				1202	smallest integer type that is larger than the bitwidth of the sought type is
				1203	used. If none of the specifications are larger than the bitwidth then the the
				1204	largest integer type is used. For example, given the default specifications
				1205	above, the i7 type will use the alignment of i8 (next largest) while both
				1206	i65 and i256 will use the alignment of i64 (largest specified).</li>
				1207	<li>If no match is found, and the type sought is a vector type, then the
				1208	largest vector type that is smaller than the sought vector type will be used
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	1209	as a fall back. This happens because <128 x double> can be implemented
				1210	in terms of 64 <2 x double>, for example.</li>
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	1211	</ol>
				1212	</div>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	1213
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1214	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1215	<div class="doc_section"> <a name="typesystem">Type System</a> </div>
				1216	<!-- *********************************************************************** -->
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	1217
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1218	<div class="doc_text">
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	1219
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1220	<p>The LLVM type system is one of the most important features of the
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1221	intermediate representation. Being typed enables a number of
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	1222	optimizations to be performed on the intermediate representation directly,
				1223	without having to do
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1224	extra analyses on the side before the transformation. A strong type
				1225	system makes it easier to read the generated code and enables novel
				1226	analyses and transformations that are not feasible to perform on normal
				1227	three address code representations.</p>
Chris Lattner	fa73021	2004-12-09 16:11:40 +0000	[diff] [blame]	1228
				1229	</div>
				1230
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1231	<!-- ======================================================================= -->
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1232	<div class="doc_subsection"> <a name="t_classifications">Type
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1233	Classifications</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1234	<div class="doc_text">
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1235	<p>The types fall into a few useful
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1236	classifications:</p>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	1237
				1238	<table border="1" cellspacing="0" cellpadding="4">
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1239	<tbody>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1240	<tr><th>Classification</th><th>Types</th></tr>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1241	<tr>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1242	<td><a href="#t_integer">integer</a></td>
Reid Spencer	2b91631	2007-05-16 18:44:01 +0000	[diff] [blame]	1243	<td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1244	</tr>
				1245	<tr>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1246	<td><a href="#t_floating">floating point</a></td>
				1247	<td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1248	</tr>
				1249	<tr>
				1250	<td><a name="t_firstclass">first class</a></td>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1251	<td><a href="#t_integer">integer</a>,
				1252	<a href="#t_floating">floating point</a>,
				1253	<a href="#t_pointer">pointer</a>,
Dan Gohman	0066db6	2008-06-18 18:42:13 +0000	[diff] [blame]	1254	<a href="#t_vector">vector</a>,
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	1255	<a href="#t_struct">structure</a>,
				1256	<a href="#t_array">array</a>,
Dan Gohman	ade5faa	2008-05-23 22:50:26 +0000	[diff] [blame]	1257	<a href="#t_label">label</a>.
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1258	</td>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1259	</tr>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1260	<tr>
				1261	<td><a href="#t_primitive">primitive</a></td>
				1262	<td><a href="#t_label">label</a>,
				1263	<a href="#t_void">void</a>,
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1264	<a href="#t_floating">floating point</a>.</td>
				1265	</tr>
				1266	<tr>
				1267	<td><a href="#t_derived">derived</a></td>
				1268	<td><a href="#t_integer">integer</a>,
				1269	<a href="#t_array">array</a>,
				1270	<a href="#t_function">function</a>,
				1271	<a href="#t_pointer">pointer</a>,
				1272	<a href="#t_struct">structure</a>,
				1273	<a href="#t_pstruct">packed structure</a>,
				1274	<a href="#t_vector">vector</a>,
				1275	<a href="#t_opaque">opaque</a>.
Dan Gohman	01ac101	2008-10-14 16:32:04 +0000	[diff] [blame]	1276	</td>
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1277	</tr>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1278	</tbody>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1279	</table>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	1280
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1281	<p>The <a href="#t_firstclass">first class</a> types are perhaps the
				1282	most important. Values of these types are the only ones which can be
				1283	produced by instructions, passed as arguments, or used as operands to
Dan Gohman	c4b49eb	2008-05-23 21:53:15 +0000	[diff] [blame]	1284	instructions.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1285	</div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1286
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1287	<!-- ======================================================================= -->
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1288	<div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
Chris Lattner	8f8c7b7	2008-01-04 04:34:14 +0000	[diff] [blame]	1289
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1290	<div class="doc_text">
				1291	<p>The primitive types are the fundamental building blocks of the LLVM
				1292	system.</p>
				1293
Chris Lattner	8f8c7b7	2008-01-04 04:34:14 +0000	[diff] [blame]	1294	</div>
				1295
Chris Lattner	4f69f46	2008-01-04 04:32:38 +0000	[diff] [blame]	1296	<!-- _______________________________________________________________________ -->
				1297	<div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
				1298
				1299	<div class="doc_text">
				1300	<table>
				1301	<tbody>
				1302	<tr><th>Type</th><th>Description</th></tr>
				1303	<tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
				1304	<tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
				1305	<tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
				1306	<tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
				1307	<tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
				1308	</tbody>
				1309	</table>
				1310	</div>
				1311
				1312	<!-- _______________________________________________________________________ -->
				1313	<div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
				1314
				1315	<div class="doc_text">
				1316	<h5>Overview:</h5>
				1317	<p>The void type does not represent any value and has no size.</p>
				1318
				1319	<h5>Syntax:</h5>
				1320
				1321	<pre>
				1322	void
				1323	</pre>
				1324	</div>
				1325
				1326	<!-- _______________________________________________________________________ -->
				1327	<div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
				1328
				1329	<div class="doc_text">
				1330	<h5>Overview:</h5>
				1331	<p>The label type represents code labels.</p>
				1332
				1333	<h5>Syntax:</h5>
				1334
				1335	<pre>
				1336	label
				1337	</pre>
				1338	</div>
				1339
				1340
				1341	<!-- ======================================================================= -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1342	<div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1343
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1344	<div class="doc_text">
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1345
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1346	<p>The real power in LLVM comes from the derived types in the system.
				1347	This is what allows a programmer to represent arrays, functions,
				1348	pointers, and other useful types. Note that these derived types may be
				1349	recursive: For example, it is possible to have a two dimensional array.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1350
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1351	</div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1352
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1353	<!-- _______________________________________________________________________ -->
Reid Spencer	2b91631	2007-05-16 18:44:01 +0000	[diff] [blame]	1354	<div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
				1355
				1356	<div class="doc_text">
				1357
				1358	<h5>Overview:</h5>
				1359	<p>The integer type is a very simple derived type that simply specifies an
				1360	arbitrary bit width for the integer type desired. Any bit width from 1 bit to
				1361	2^23-1 (about 8 million) can be specified.</p>
				1362
				1363	<h5>Syntax:</h5>
				1364
				1365	<pre>
				1366	iN
				1367	</pre>
				1368
				1369	<p>The number of bits the integer will occupy is specified by the <tt>N</tt>
				1370	value.</p>
				1371
				1372	<h5>Examples:</h5>
				1373	<table class="layout">
Chris Lattner	b9488a6	2007-12-18 06:18:21 +0000	[diff] [blame]	1374	<tbody>
				1375	<tr>
				1376	<td><tt>i1</tt></td>
				1377	<td>a single-bit integer.</td>
				1378	</tr><tr>
				1379	<td><tt>i32</tt></td>
				1380	<td>a 32-bit integer.</td>
				1381	</tr><tr>
				1382	<td><tt>i1942652</tt></td>
				1383	<td>a really big integer of over 1 million bits.</td>
Reid Spencer	2b91631	2007-05-16 18:44:01 +0000	[diff] [blame]	1384	</tr>
Chris Lattner	b9488a6	2007-12-18 06:18:21 +0000	[diff] [blame]	1385	</tbody>
Reid Spencer	2b91631	2007-05-16 18:44:01 +0000	[diff] [blame]	1386	</table>
Dan Gohman	d8791e5	2009-01-24 15:58:40 +0000	[diff] [blame]	1387
				1388	<p>Note that the code generator does not yet support large integer types
				1389	to be used as function return types. The specific limit on how large a
				1390	return type the code generator can currently handle is target-dependent;
				1391	currently it's often 64 bits for 32-bit targets and 128 bits for 64-bit
				1392	targets.</p>
				1393
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	1394	</div>
Reid Spencer	2b91631	2007-05-16 18:44:01 +0000	[diff] [blame]	1395
				1396	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1397	<div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1398
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1399	<div class="doc_text">
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1400
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1401	<h5>Overview:</h5>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1402
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1403	<p>The array type is a very simple derived type that arranges elements
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1404	sequentially in memory. The array type requires a size (number of
				1405	elements) and an underlying data type.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1406
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	1407	<h5>Syntax:</h5>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1408
				1409	<pre>
				1410	[<# elements> x <elementtype>]
				1411	</pre>
				1412
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	1413	<p>The number of elements is a constant integer value; elementtype may
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1414	be any type with a size.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1415
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	1416	<h5>Examples:</h5>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1417	<table class="layout">
				1418	<tr class="layout">
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1419	<td class="left"><tt>[40 x i32]</tt></td>
				1420	<td class="left">Array of 40 32-bit integer values.</td>
				1421	</tr>
				1422	<tr class="layout">
				1423	<td class="left"><tt>[41 x i32]</tt></td>
				1424	<td class="left">Array of 41 32-bit integer values.</td>
				1425	</tr>
				1426	<tr class="layout">
				1427	<td class="left"><tt>[4 x i8]</tt></td>
				1428	<td class="left">Array of 4 8-bit integer values.</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1429	</tr>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1430	</table>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1431	<p>Here are some examples of multidimensional arrays:</p>
				1432	<table class="layout">
				1433	<tr class="layout">
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1434	<td class="left"><tt>[3 x [4 x i32]]</tt></td>
				1435	<td class="left">3x4 array of 32-bit integer values.</td>
				1436	</tr>
				1437	<tr class="layout">
				1438	<td class="left"><tt>[12 x [10 x float]]</tt></td>
				1439	<td class="left">12x10 array of single precision floating point values.</td>
				1440	</tr>
				1441	<tr class="layout">
				1442	<td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
				1443	<td class="left">2x3x4 array of 16-bit integer values.</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1444	</tr>
				1445	</table>
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	1446
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	1447	<p>Note that 'variable sized arrays' can be implemented in LLVM with a zero
				1448	length array. Normally, accesses past the end of an array are undefined in
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	1449	LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
				1450	As a special case, however, zero length arrays are recognized to be variable
				1451	length. This allows implementation of 'pascal style arrays' with the LLVM
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1452	type "{ i32, [0 x float]}", for example.</p>
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	1453
Dan Gohman	d8791e5	2009-01-24 15:58:40 +0000	[diff] [blame]	1454	<p>Note that the code generator does not yet support large aggregate types
				1455	to be used as function return types. The specific limit on how large an
				1456	aggregate return type the code generator can currently handle is
				1457	target-dependent, and also dependent on the aggregate element types.</p>
				1458
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1459	</div>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1460
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1461	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1462	<div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1463	<div class="doc_text">
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1464
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1465	<h5>Overview:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1466
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1467	<p>The function type can be thought of as a function signature. It
Devang Patel	a582f40	2008-03-24 05:35:41 +0000	[diff] [blame]	1468	consists of a return type and a list of formal parameter types. The
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1469	return type of a function type is a scalar type, a void type, or a struct type.
Devang Patel	7a3ad1a	2008-03-24 20:52:42 +0000	[diff] [blame]	1470	If the return type is a struct type then all struct elements must be of first
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1471	class types, and the struct must have at least one element.</p>
Devang Patel	c3fc6df	2008-03-10 20:49:15 +0000	[diff] [blame]	1472
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1473	<h5>Syntax:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1474
				1475	<pre>
				1476	<returntype list> (<parameter list>)
				1477	</pre>
				1478
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	1479	<p>...where '<tt><parameter list></tt>' is a comma-separated list of type
Misha Brukman	c24b758	2004-08-12 20:16:08 +0000	[diff] [blame]	1480	specifiers. Optionally, the parameter list may include a type <tt>...</tt>,
Chris Lattner	27f71f2	2003-09-03 00:41:47 +0000	[diff] [blame]	1481	which indicates that the function takes a variable number of arguments.
				1482	Variable argument functions can access their arguments with the <a
Devang Patel	c3fc6df	2008-03-10 20:49:15 +0000	[diff] [blame]	1483	href="#int_varargs">variable argument handling intrinsic</a> functions.
				1484	'<tt><returntype list></tt>' is a comma-separated list of
				1485	<a href="#t_firstclass">first class</a> type specifiers.</p>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	1486
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1487	<h5>Examples:</h5>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1488	<table class="layout">
				1489	<tr class="layout">
Reid Spencer	92f8230	2006-12-31 07:18:34 +0000	[diff] [blame]	1490	<td class="left"><tt>i32 (i32)</tt></td>
				1491	<td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1492	</td>
Reid Spencer	92f8230	2006-12-31 07:18:34 +0000	[diff] [blame]	1493	</tr><tr class="layout">
Reid Spencer	9445e9a	2007-07-19 23:13:04 +0000	[diff] [blame]	1494	<td class="left"><tt>float (i16 signext, i32 )
Reid Spencer	f17a0b7	2006-12-31 07:20:23 +0000	[diff] [blame]	1495	</tt></td>
Reid Spencer	92f8230	2006-12-31 07:18:34 +0000	[diff] [blame]	1496	<td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
				1497	an <tt>i16</tt> that should be sign extended and a
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1498	<a href="#t_pointer">pointer</a> to <tt>i32</tt>, returning
Reid Spencer	92f8230	2006-12-31 07:18:34 +0000	[diff] [blame]	1499	<tt>float</tt>.
				1500	</td>
				1501	</tr><tr class="layout">
				1502	<td class="left"><tt>i32 (i8*, ...)</tt></td>
				1503	<td class="left">A vararg function that takes at least one
Reid Spencer	a517338	2007-01-04 16:43:23 +0000	[diff] [blame]	1504	<a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
Reid Spencer	92f8230	2006-12-31 07:18:34 +0000	[diff] [blame]	1505	which returns an integer. This is the signature for <tt>printf</tt> in
				1506	LLVM.
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1507	</td>
Devang Patel	a582f40	2008-03-24 05:35:41 +0000	[diff] [blame]	1508	</tr><tr class="layout">
				1509	<td class="left"><tt>{i32, i32} (i32)</tt></td>
Misha Brukman	b0a57aa	2008-11-27 06:41:20 +0000	[diff] [blame]	1510	<td class="left">A function taking an <tt>i32</tt>, returning two
				1511	<tt>i32</tt> values as an aggregate of type <tt>{ i32, i32 }</tt>
Devang Patel	a582f40	2008-03-24 05:35:41 +0000	[diff] [blame]	1512	</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1513	</tr>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1514	</table>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	1515
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1516	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1517	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1518	<div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1519	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1520	<h5>Overview:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1521	<p>The structure type is used to represent a collection of data members
				1522	together in memory. The packing of the field types is defined to match
				1523	the ABI of the underlying processor. The elements of a structure may
				1524	be any type that has a size.</p>
				1525	<p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
				1526	and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
				1527	field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
				1528	instruction.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1529	<h5>Syntax:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1530	<pre> { <type list> }<br></pre>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1531	<h5>Examples:</h5>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1532	<table class="layout">
				1533	<tr class="layout">
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	1534	<td class="left"><tt>{ i32, i32, i32 }</tt></td>
				1535	<td class="left">A triple of three <tt>i32</tt> values</td>
				1536	</tr><tr class="layout">
				1537	<td class="left"><tt>{ float, i32 (i32) * }</tt></td>
				1538	<td class="left">A pair, where the first element is a <tt>float</tt> and the
				1539	second element is a <a href="#t_pointer">pointer</a> to a
				1540	<a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
				1541	an <tt>i32</tt>.</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1542	</tr>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1543	</table>
Dan Gohman	d8791e5	2009-01-24 15:58:40 +0000	[diff] [blame]	1544
				1545	<p>Note that the code generator does not yet support large aggregate types
				1546	to be used as function return types. The specific limit on how large an
				1547	aggregate return type the code generator can currently handle is
				1548	target-dependent, and also dependent on the aggregate element types.</p>
				1549
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1550	</div>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1551
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	1552	<!-- _______________________________________________________________________ -->
Andrew Lenharth	75e1068	2006-12-08 17:13:00 +0000	[diff] [blame]	1553	<div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
				1554	</div>
				1555	<div class="doc_text">
				1556	<h5>Overview:</h5>
				1557	<p>The packed structure type is used to represent a collection of data members
				1558	together in memory. There is no padding between fields. Further, the alignment
				1559	of a packed structure is 1 byte. The elements of a packed structure may
				1560	be any type that has a size.</p>
				1561	<p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
				1562	and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
				1563	field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
				1564	instruction.</p>
				1565	<h5>Syntax:</h5>
				1566	<pre> < { <type list> } > <br></pre>
				1567	<h5>Examples:</h5>
				1568	<table class="layout">
				1569	<tr class="layout">
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	1570	<td class="left"><tt>< { i32, i32, i32 } ></tt></td>
				1571	<td class="left">A triple of three <tt>i32</tt> values</td>
				1572	</tr><tr class="layout">
Bill Wendling	e36dccc	2008-09-07 10:26:33 +0000	[diff] [blame]	1573	<td class="left">
				1574	<tt>< { float, i32 (i32)* } ></tt></td>
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	1575	<td class="left">A pair, where the first element is a <tt>float</tt> and the
				1576	second element is a <a href="#t_pointer">pointer</a> to a
				1577	<a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
				1578	an <tt>i32</tt>.</td>
Andrew Lenharth	75e1068	2006-12-08 17:13:00 +0000	[diff] [blame]	1579	</tr>
				1580	</table>
				1581	</div>
				1582
				1583	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1584	<div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1585	<div class="doc_text">
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	1586	<h5>Overview:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1587	<p>As in many languages, the pointer type represents a pointer or
Christopher Lamb	284d992	2007-12-11 09:31:00 +0000	[diff] [blame]	1588	reference to another object, which must live in memory. Pointer types may have
				1589	an optional address space attribute defining the target-specific numbered
				1590	address space where the pointed-to object resides. The default address space is
				1591	zero.</p>
Chris Lattner	0fd4a27	2009-02-08 19:53:29 +0000	[diff] [blame]	1592
				1593	<p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does
Chris Lattner	e220e8c	2009-02-08 22:21:28 +0000	[diff] [blame]	1594	it permit pointers to labels (<tt>label</tt>). Use <tt>i8</tt> instead.</p>
Chris Lattner	0fd4a27	2009-02-08 19:53:29 +0000	[diff] [blame]	1595
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	1596	<h5>Syntax:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	1597	<pre> <type> *<br></pre>
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	1598	<h5>Examples:</h5>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1599	<table class="layout">
				1600	<tr class="layout">
Dan Gohman	2a08c53	2009-01-04 23:44:43 +0000	[diff] [blame]	1601	<td class="left"><tt>[4 x i32]*</tt></td>
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1602	<td class="left">A <a href="#t_pointer">pointer</a> to <a
				1603	href="#t_array">array</a> of four <tt>i32</tt> values.</td>
				1604	</tr>
				1605	<tr class="layout">
				1606	<td class="left"><tt>i32 (i32 ) </tt></td>
				1607	<td class="left"> A <a href="#t_pointer">pointer</a> to a <a
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1608	href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1609	<tt>i32</tt>.</td>
				1610	</tr>
				1611	<tr class="layout">
				1612	<td class="left"><tt>i32 addrspace(5)*</tt></td>
				1613	<td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
				1614	that resides in address space #5.</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1615	</tr>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1616	</table>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1617	</div>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1618
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1619	<!-- _______________________________________________________________________ -->
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1620	<div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1621	<div class="doc_text">
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1622
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1623	<h5>Overview:</h5>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1624
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1625	<p>A vector type is a simple derived type that represents a vector
				1626	of elements. Vector types are used when multiple primitive data
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1627	are operated in parallel using a single instruction (SIMD).
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1628	A vector type requires a size (number of
Chris Lattner	b8d172f	2005-11-10 01:44:22 +0000	[diff] [blame]	1629	elements) and an underlying primitive data type. Vectors must have a power
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1630	of two length (1, 2, 4, 8, 16 ...). Vector types are
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1631	considered <a href="#t_firstclass">first class</a>.</p>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1632
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1633	<h5>Syntax:</h5>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1634
				1635	<pre>
				1636	< <# elements> x <elementtype> >
				1637	</pre>
				1638
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	1639	<p>The number of elements is a constant integer value; elementtype may
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	1640	be any integer or floating point type.</p>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1641
Chris Lattner	a58561b	2004-08-12 19:12:28 +0000	[diff] [blame]	1642	<h5>Examples:</h5>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1643
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1644	<table class="layout">
				1645	<tr class="layout">
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1646	<td class="left"><tt><4 x i32></tt></td>
				1647	<td class="left">Vector of 4 32-bit integer values.</td>
				1648	</tr>
				1649	<tr class="layout">
				1650	<td class="left"><tt><8 x float></tt></td>
				1651	<td class="left">Vector of 8 32-bit floating-point values.</td>
				1652	</tr>
				1653	<tr class="layout">
				1654	<td class="left"><tt><2 x i64></tt></td>
				1655	<td class="left">Vector of 2 64-bit integer values.</td>
Reid Spencer	d3f876c	2004-11-01 08:19:36 +0000	[diff] [blame]	1656	</tr>
				1657	</table>
Dan Gohman	d8791e5	2009-01-24 15:58:40 +0000	[diff] [blame]	1658
				1659	<p>Note that the code generator does not yet support large vector types
				1660	to be used as function return types. The specific limit on how large a
				1661	vector return type codegen can currently handle is target-dependent;
				1662	currently it's often a few times longer than a hardware vector register.</p>
				1663
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	1664	</div>
				1665
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1666	<!-- _______________________________________________________________________ -->
				1667	<div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
				1668	<div class="doc_text">
				1669
				1670	<h5>Overview:</h5>
				1671
				1672	<p>Opaque types are used to represent unknown types in the system. This
Gordon Henriksen	8ac04ff	2007-10-14 00:34:53 +0000	[diff] [blame]	1673	corresponds (for example) to the C notion of a forward declared structure type.
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1674	In LLVM, opaque types can eventually be resolved to any type (not just a
				1675	structure type).</p>
				1676
				1677	<h5>Syntax:</h5>
				1678
				1679	<pre>
				1680	opaque
				1681	</pre>
				1682
				1683	<h5>Examples:</h5>
				1684
				1685	<table class="layout">
				1686	<tr class="layout">
Chris Lattner	23ff1f9	2007-12-19 05:04:11 +0000	[diff] [blame]	1687	<td class="left"><tt>opaque</tt></td>
				1688	<td class="left">An opaque type.</td>
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1689	</tr>
				1690	</table>
				1691	</div>
				1692
Chris Lattner	242d61d	2009-02-02 07:32:36 +0000	[diff] [blame]	1693	<!-- ======================================================================= -->
				1694	<div class="doc_subsection">
				1695	<a name="t_uprefs">Type Up-references</a>
				1696	</div>
				1697
				1698	<div class="doc_text">
				1699	<h5>Overview:</h5>
				1700	<p>
				1701	An "up reference" allows you to refer to a lexically enclosing type without
				1702	requiring it to have a name. For instance, a structure declaration may contain a
				1703	pointer to any of the types it is lexically a member of. Example of up
				1704	references (with their equivalent as named type declarations) include:</p>
				1705
				1706	<pre>
Chris Lattner	3060f5b	2009-02-09 10:00:56 +0000	[diff] [blame]	1707	{ \2 * } %x = type { %x* }
Chris Lattner	242d61d	2009-02-02 07:32:36 +0000	[diff] [blame]	1708	{ \2 }* %y = type { %y }*
				1709	\1* %z = type %z*
				1710	</pre>
				1711
				1712	<p>
				1713	An up reference is needed by the asmprinter for printing out cyclic types when
				1714	there is no declared name for a type in the cycle. Because the asmprinter does
				1715	not want to print out an infinite type string, it needs a syntax to handle
				1716	recursive types that have no names (all names are optional in llvm IR).
				1717	</p>
				1718
				1719	<h5>Syntax:</h5>
				1720	<pre>
				1721	\<level>
				1722	</pre>
				1723
				1724	<p>
				1725	The level is the count of the lexical type that is being referred to.
				1726	</p>
				1727
				1728	<h5>Examples:</h5>
				1729
				1730	<table class="layout">
				1731	<tr class="layout">
				1732	<td class="left"><tt>\1*</tt></td>
				1733	<td class="left">Self-referential pointer.</td>
				1734	</tr>
				1735	<tr class="layout">
				1736	<td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
				1737	<td class="left">Recursive structure where the upref refers to the out-most
				1738	structure.</td>
				1739	</tr>
				1740	</table>
				1741	</div>
				1742
Chris Lattner	69c11bb	2005-04-25 17:34:15 +0000	[diff] [blame]	1743
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1744	<!-- *********************************************************************** -->
				1745	<div class="doc_section"> <a name="constants">Constants</a> </div>
				1746	<!-- *********************************************************************** -->
				1747
				1748	<div class="doc_text">
				1749
				1750	<p>LLVM has several different basic types of constants. This section describes
				1751	them all and their syntax.</p>
				1752
				1753	</div>
				1754
				1755	<!-- ======================================================================= -->
Reid Spencer	cc16dc3	2004-12-09 18:02:53 +0000	[diff] [blame]	1756	<div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1757
				1758	<div class="doc_text">
				1759
				1760	<dl>
				1761	<dt><b>Boolean constants</b></dt>
				1762
				1763	<dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	1764	constants of the <tt><a href="#t_primitive">i1</a></tt> type.
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1765	</dd>
				1766
				1767	<dt><b>Integer constants</b></dt>
				1768
Reid Spencer	cc16dc3	2004-12-09 18:02:53 +0000	[diff] [blame]	1769	<dd>Standard integers (such as '4') are constants of the <a
Reid Spencer	a517338	2007-01-04 16:43:23 +0000	[diff] [blame]	1770	href="#t_integer">integer</a> type. Negative numbers may be used with
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1771	integer types.
				1772	</dd>
				1773
				1774	<dt><b>Floating point constants</b></dt>
				1775
				1776	<dd>Floating point constants use standard decimal notation (e.g. 123.421),
				1777	exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
Chris Lattner	a73afe0	2008-04-01 18:45:27 +0000	[diff] [blame]	1778	notation (see below). The assembler requires the exact decimal value of
				1779	a floating-point constant. For example, the assembler accepts 1.25 but
				1780	rejects 1.3 because 1.3 is a repeating decimal in binary. Floating point
				1781	constants must have a <a href="#t_floating">floating point</a> type. </dd>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1782
				1783	<dt><b>Null pointer constants</b></dt>
				1784
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	1785	<dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1786	and must be of <a href="#t_pointer">pointer type</a>.</dd>
				1787
				1788	</dl>
				1789
Dale Johannesen	bd5e5a8	2009-02-11 22:14:51 +0000	[diff] [blame]	1790	<p>The one non-intuitive notation for constants is the hexadecimal form
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1791	of floating point constants. For example, the form '<tt>double
				1792	0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
				1793	4.5e+15</tt>'. The only time hexadecimal floating point constants are required
Reid Spencer	cc16dc3	2004-12-09 18:02:53 +0000	[diff] [blame]	1794	(and the only time that they are generated by the disassembler) is when a
				1795	floating point constant must be emitted but it cannot be represented as a
Dale Johannesen	bd5e5a8	2009-02-11 22:14:51 +0000	[diff] [blame]	1796	decimal floating point number in a reasonable number of digits. For example,
				1797	NaN's, infinities, and other
Reid Spencer	cc16dc3	2004-12-09 18:02:53 +0000	[diff] [blame]	1798	special values are represented in their IEEE hexadecimal format so that
				1799	assembly and disassembly do not cause any bits to change in the constants.</p>
Dale Johannesen	bd5e5a8	2009-02-11 22:14:51 +0000	[diff] [blame]	1800	<p>When using the hexadecimal form, constants of types float and double are
				1801	represented using the 16-digit form shown above (which matches the IEEE754
				1802	representation for double); float values must, however, be exactly representable
				1803	as IEE754 single precision.
				1804	Hexadecimal format is always used for long
				1805	double, and there are three forms of long double. The 80-bit
				1806	format used by x86 is represented as <tt>0xK</tt>
				1807	followed by 20 hexadecimal digits.
				1808	The 128-bit format used by PowerPC (two adjacent doubles) is represented
				1809	by <tt>0xM</tt> followed by 32 hexadecimal digits. The IEEE 128-bit
				1810	format is represented
				1811	by <tt>0xL</tt> followed by 32 hexadecimal digits; no currently supported
				1812	target uses this format. Long doubles will only work if they match
				1813	the long double format on your target. All hexadecimal formats are big-endian
				1814	(sign bit at the left).</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1815	</div>
				1816
				1817	<!-- ======================================================================= -->
Chris Lattner	7088279	2009-02-28 18:32:25 +0000	[diff] [blame]	1818	<div class="doc_subsection">
				1819	<a name="aggregateconstants"> <!-- old anchor -->
				1820	<a name="complexconstants">Complex Constants</a></a>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1821	</div>
				1822
				1823	<div class="doc_text">
Chris Lattner	7088279	2009-02-28 18:32:25 +0000	[diff] [blame]	1824	<p>Complex constants are a (potentially recursive) combination of simple
				1825	constants and smaller complex constants.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1826
				1827	<dl>
				1828	<dt><b>Structure constants</b></dt>
				1829
				1830	<dd>Structure constants are represented with notation similar to structure
				1831	type definitions (a comma separated list of elements, surrounded by braces
Chris Lattner	64910ee	2007-12-25 20:34:52 +0000	[diff] [blame]	1832	(<tt>{}</tt>)). For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
				1833	where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>". Structure constants
Chris Lattner	d4f6b17	2005-03-07 22:13:59 +0000	[diff] [blame]	1834	must have <a href="#t_struct">structure type</a>, and the number and
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1835	types of elements must match those specified by the type.
				1836	</dd>
				1837
				1838	<dt><b>Array constants</b></dt>
				1839
				1840	<dd>Array constants are represented with notation similar to array type
				1841	definitions (a comma separated list of elements, surrounded by square brackets
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1842	(<tt>[]</tt>)). For example: "<tt>[ i32 42, i32 11, i32 74 ]</tt>". Array
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1843	constants must have <a href="#t_array">array type</a>, and the number and
				1844	types of elements must match those specified by the type.
				1845	</dd>
				1846
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1847	<dt><b>Vector constants</b></dt>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1848
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1849	<dd>Vector constants are represented with notation similar to vector type
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1850	definitions (a comma separated list of elements, surrounded by
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	1851	less-than/greater-than's (<tt><></tt>)). For example: "<tt>< i32 42,
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	1852	i32 11, i32 74, i32 100 ></tt>". Vector constants must have <a
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	1853	href="#t_vector">vector type</a>, and the number and types of elements must
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1854	match those specified by the type.
				1855	</dd>
				1856
				1857	<dt><b>Zero initialization</b></dt>
				1858
				1859	<dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
				1860	value to zero of <em>any</em> type, including scalar and aggregate types.
				1861	This is often used to avoid having to print large zero initializers (e.g. for
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	1862	large arrays) and is always exactly equivalent to using explicit zero
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1863	initializers.
				1864	</dd>
Nick Lewycky	21cc446	2009-04-04 07:22:01 +0000	[diff] [blame]	1865
				1866	<dt><b>Metadata node</b></dt>
				1867
				1868	<dd>A metadata node is a structure-like constant with the type of an empty
				1869	struct. For example: "<tt>{ } !{ i32 0, { } !"test" }</tt>". Unlike other
				1870	constants that are meant to be interpreted as part of the instruction stream,
				1871	metadata is a place to attach additional information such as debug info.
				1872	</dd>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1873	</dl>
				1874
				1875	</div>
				1876
				1877	<!-- ======================================================================= -->
				1878	<div class="doc_subsection">
				1879	<a name="globalconstants">Global Variable and Function Addresses</a>
				1880	</div>
				1881
				1882	<div class="doc_text">
				1883
				1884	<p>The addresses of <a href="#globalvars">global variables</a> and <a
				1885	href="#functionstructure">functions</a> are always implicitly valid (link-time)
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	1886	constants. These constants are explicitly referenced when the <a
				1887	href="#identifiers">identifier for the global</a> is used and always have <a
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1888	href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
				1889	file:</p>
				1890
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	1891	<div class="doc_code">
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1892	<pre>
Chris Lattner	a18a424	2007-06-06 18:28:13 +0000	[diff] [blame]	1893	@X = global i32 17
				1894	@Y = global i32 42
				1895	@Z = global [2 x i32] [ i32 @X, i32* @Y ]
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1896	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	1897	</div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1898
				1899	</div>
				1900
				1901	<!-- ======================================================================= -->
Reid Spencer	2dc45b8	2004-12-09 18:13:12 +0000	[diff] [blame]	1902	<div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1903	<div class="doc_text">
Reid Spencer	2dc45b8	2004-12-09 18:13:12 +0000	[diff] [blame]	1904	<p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	1905	no specific value. Undefined values may be of any type and be used anywhere
Reid Spencer	2dc45b8	2004-12-09 18:13:12 +0000	[diff] [blame]	1906	a constant is permitted.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1907
Reid Spencer	2dc45b8	2004-12-09 18:13:12 +0000	[diff] [blame]	1908	<p>Undefined values indicate to the compiler that the program is well defined
				1909	no matter what value is used, giving the compiler more freedom to optimize.
				1910	</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1911	</div>
				1912
				1913	<!-- ======================================================================= -->
				1914	<div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
				1915	</div>
				1916
				1917	<div class="doc_text">
				1918
				1919	<p>Constant expressions are used to allow expressions involving other constants
				1920	to be used as constants. Constant expressions may be of any <a
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	1921	href="#t_firstclass">first class</a> type and may involve any LLVM operation
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1922	that does not have side effects (e.g. load and call are not supported). The
				1923	following is the syntax for constant expressions:</p>
				1924
				1925	<dl>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1926	<dt><b><tt>trunc ( CST to TYPE )</tt></b></dt>
				1927	<dd>Truncate a constant to another type. The bit size of CST must be larger
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	1928	than the bit size of TYPE. Both types must be integers.</dd>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1929
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1930	<dt><b><tt>zext ( CST to TYPE )</tt></b></dt>
				1931	<dd>Zero extend a constant to another type. The bit size of CST must be
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	1932	smaller or equal to the bit size of TYPE. Both types must be integers.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1933
				1934	<dt><b><tt>sext ( CST to TYPE )</tt></b></dt>
				1935	<dd>Sign extend a constant to another type. The bit size of CST must be
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	1936	smaller or equal to the bit size of TYPE. Both types must be integers.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1937
				1938	<dt><b><tt>fptrunc ( CST to TYPE )</tt></b></dt>
				1939	<dd>Truncate a floating point constant to another floating point type. The
				1940	size of CST must be larger than the size of TYPE. Both types must be
				1941	floating point.</dd>
				1942
				1943	<dt><b><tt>fpext ( CST to TYPE )</tt></b></dt>
				1944	<dd>Floating point extend a constant to another type. The size of CST must be
				1945	smaller or equal to the size of TYPE. Both types must be floating point.</dd>
				1946
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	1947	<dt><b><tt>fptoui ( CST to TYPE )</tt></b></dt>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1948	<dd>Convert a floating point constant to the corresponding unsigned integer
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	1949	constant. TYPE must be a scalar or vector integer type. CST must be of scalar
				1950	or vector floating point type. Both CST and TYPE must be scalars, or vectors
				1951	of the same number of elements. If the value won't fit in the integer type,
				1952	the results are undefined.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1953
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	1954	<dt><b><tt>fptosi ( CST to TYPE )</tt></b></dt>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1955	<dd>Convert a floating point constant to the corresponding signed integer
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	1956	constant. TYPE must be a scalar or vector integer type. CST must be of scalar
				1957	or vector floating point type. Both CST and TYPE must be scalars, or vectors
				1958	of the same number of elements. If the value won't fit in the integer type,
				1959	the results are undefined.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1960
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	1961	<dt><b><tt>uitofp ( CST to TYPE )</tt></b></dt>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1962	<dd>Convert an unsigned integer constant to the corresponding floating point
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	1963	constant. TYPE must be a scalar or vector floating point type. CST must be of
				1964	scalar or vector integer type. Both CST and TYPE must be scalars, or vectors
				1965	of the same number of elements. If the value won't fit in the floating point
				1966	type, the results are undefined.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1967
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	1968	<dt><b><tt>sitofp ( CST to TYPE )</tt></b></dt>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1969	<dd>Convert a signed integer constant to the corresponding floating point
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	1970	constant. TYPE must be a scalar or vector floating point type. CST must be of
				1971	scalar or vector integer type. Both CST and TYPE must be scalars, or vectors
				1972	of the same number of elements. If the value won't fit in the floating point
				1973	type, the results are undefined.</dd>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	1974
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	1975	<dt><b><tt>ptrtoint ( CST to TYPE )</tt></b></dt>
				1976	<dd>Convert a pointer typed constant to the corresponding integer constant
				1977	TYPE must be an integer type. CST must be of pointer type. The CST value is
				1978	zero extended, truncated, or unchanged to make it fit in TYPE.</dd>
				1979
				1980	<dt><b><tt>inttoptr ( CST to TYPE )</tt></b></dt>
				1981	<dd>Convert a integer constant to a pointer constant. TYPE must be a
				1982	pointer type. CST must be of integer type. The CST value is zero extended,
				1983	truncated, or unchanged to make it fit in a pointer size. This one is
				1984	<i>really</i> dangerous!</dd>
				1985
				1986	<dt><b><tt>bitcast ( CST to TYPE )</tt></b></dt>
Chris Lattner	03bbad6	2009-02-28 18:27:03 +0000	[diff] [blame]	1987	<dd>Convert a constant, CST, to another TYPE. The constraints of the operands
				1988	are the same as those for the <a href="#i_bitcast">bitcast
				1989	instruction</a>.</dd>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	1990
				1991	<dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
				1992
				1993	<dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
				1994	constants. As with the <a href="#i_getelementptr">getelementptr</a>
				1995	instruction, the index list may have zero or more indexes, which are required
				1996	to make sense for the type of "CSTPTR".</dd>
				1997
Robert Bocchino	9fbe145	2006-01-10 19:31:34 +0000	[diff] [blame]	1998	<dt><b><tt>select ( COND, VAL1, VAL2 )</tt></b></dt>
				1999
				2000	<dd>Perform the <a href="#i_select">select operation</a> on
Reid Spencer	01c4259	2006-12-04 19:23:19 +0000	[diff] [blame]	2001	constants.</dd>
				2002
				2003	<dt><b><tt>icmp COND ( VAL1, VAL2 )</tt></b></dt>
				2004	<dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
				2005
				2006	<dt><b><tt>fcmp COND ( VAL1, VAL2 )</tt></b></dt>
				2007	<dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
Robert Bocchino	9fbe145	2006-01-10 19:31:34 +0000	[diff] [blame]	2008
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	2009	<dt><b><tt>vicmp COND ( VAL1, VAL2 )</tt></b></dt>
				2010	<dd>Performs the <a href="#i_vicmp">vicmp operation</a> on constants.</dd>
				2011
				2012	<dt><b><tt>vfcmp COND ( VAL1, VAL2 )</tt></b></dt>
				2013	<dd>Performs the <a href="#i_vfcmp">vfcmp operation</a> on constants.</dd>
				2014
Robert Bocchino	9fbe145	2006-01-10 19:31:34 +0000	[diff] [blame]	2015	<dt><b><tt>extractelement ( VAL, IDX )</tt></b></dt>
				2016
				2017	<dd>Perform the <a href="#i_extractelement">extractelement
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	2018	operation</a> on constants.</dd>
Robert Bocchino	9fbe145	2006-01-10 19:31:34 +0000	[diff] [blame]	2019
Robert Bocchino	05ccd70	2006-01-15 20:48:27 +0000	[diff] [blame]	2020	<dt><b><tt>insertelement ( VAL, ELT, IDX )</tt></b></dt>
				2021
				2022	<dd>Perform the <a href="#i_insertelement">insertelement
Reid Spencer	01c4259	2006-12-04 19:23:19 +0000	[diff] [blame]	2023	operation</a> on constants.</dd>
Robert Bocchino	05ccd70	2006-01-15 20:48:27 +0000	[diff] [blame]	2024
Chris Lattner	c198954	2006-04-08 00:13:41 +0000	[diff] [blame]	2025
				2026	<dt><b><tt>shufflevector ( VEC1, VEC2, IDXMASK )</tt></b></dt>
				2027
				2028	<dd>Perform the <a href="#i_shufflevector">shufflevector
Reid Spencer	01c4259	2006-12-04 19:23:19 +0000	[diff] [blame]	2029	operation</a> on constants.</dd>
Chris Lattner	c198954	2006-04-08 00:13:41 +0000	[diff] [blame]	2030
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2031	<dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
				2032
Reid Spencer	2dc45b8	2004-12-09 18:13:12 +0000	[diff] [blame]	2033	<dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
				2034	be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2035	binary</a> operations. The constraints on operands are the same as those for
				2036	the corresponding instruction (e.g. no bitwise operations on floating point
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	2037	values are allowed).</dd>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2038	</dl>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2039	</div>
Chris Lattner	9ee5d22	2004-03-08 16:49:10 +0000	[diff] [blame]	2040
Nick Lewycky	21cc446	2009-04-04 07:22:01 +0000	[diff] [blame]	2041	<!-- ======================================================================= -->
				2042	<div class="doc_subsection"><a name="metadata">Embedded Metadata</a>
				2043	</div>
				2044
				2045	<div class="doc_text">
				2046
				2047	<p>Embedded metadata provides a way to attach arbitrary data to the
				2048	instruction stream without affecting the behaviour of the program. There are
				2049	two metadata primitives, strings and nodes. All metadata has the type of an
				2050	empty struct and is identified in syntax by a preceding exclamation point
				2051	('<tt>!</tt>').
				2052	</p>
				2053
				2054	<p>A metadata string is a string surrounded by double quotes. It can contain
				2055	any character by escaping non-printable characters with "\xx" where "xx" is
				2056	the two digit hex code. For example: "<tt>!"test\00"</tt>".
				2057	</p>
				2058
				2059	<p>Metadata nodes are represented with notation similar to structure constants
				2060	(a comma separated list of elements, surrounded by braces and preceeded by an
				2061	exclamation point). For example: "<tt>!{ { } !"test\00", i32 10}</tt>".
				2062	</p>
				2063
Nick Lewycky	cb33799	2009-05-10 20:57:05 +0000	[diff] [blame^]	2064	<p>A metadata node will attempt to track changes to the values it holds. In
				2065	the event that a value is deleted, it will be replaced with a typeless
				2066	"<tt>null</tt>", such as "<tt>{ } !{null, i32 0}</tt>".</p>
				2067
Nick Lewycky	21cc446	2009-04-04 07:22:01 +0000	[diff] [blame]	2068	<p>Optimizations may rely on metadata to provide additional information about
				2069	the program that isn't available in the instructions, or that isn't easily
				2070	computable. Similarly, the code generator may expect a certain metadata format
				2071	to be used to express debugging information.</p>
				2072	</div>
				2073
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2074	<!-- *********************************************************************** -->
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2075	<div class="doc_section"> <a name="othervalues">Other Values</a> </div>
				2076	<!-- *********************************************************************** -->
				2077
				2078	<!-- ======================================================================= -->
				2079	<div class="doc_subsection">
				2080	<a name="inlineasm">Inline Assembler Expressions</a>
				2081	</div>
				2082
				2083	<div class="doc_text">
				2084
				2085	<p>
				2086	LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm">
				2087	Module-Level Inline Assembly</a>) through the use of a special value. This
				2088	value represents the inline assembler as a string (containing the instructions
				2089	to emit), a list of operand constraints (stored as a string), and a flag that
				2090	indicates whether or not the inline asm expression has side effects. An example
				2091	inline assembler expression is:
				2092	</p>
				2093
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2094	<div class="doc_code">
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2095	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2096	i32 (i32) asm "bswap $0", "=r,r"
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2097	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2098	</div>
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2099
				2100	<p>
				2101	Inline assembler expressions may <b>only</b> be used as the callee operand of
				2102	a <a href="#i_call"><tt>call</tt> instruction</a>. Thus, typically we have:
				2103	</p>
				2104
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2105	<div class="doc_code">
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2106	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2107	%X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2108	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2109	</div>
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2110
				2111	<p>
				2112	Inline asms with side effects not visible in the constraint list must be marked
				2113	as having side effects. This is done through the use of the
				2114	'<tt>sideeffect</tt>' keyword, like so:
				2115	</p>
				2116
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2117	<div class="doc_code">
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2118	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2119	call void asm sideeffect "eieio", ""()
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2120	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	2121	</div>
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2122
				2123	<p>TODO: The format of the asm and constraints string still need to be
				2124	documented here. Constraints on what can be done (e.g. duplication, moving, etc
Chris Lattner	4f99335	2008-10-04 18:36:02 +0000	[diff] [blame]	2125	need to be documented). This is probably best done by reference to another
				2126	document that covers inline asm from a holistic perspective.
Chris Lattner	e87d653	2006-01-25 23:47:57 +0000	[diff] [blame]	2127	</p>
				2128
				2129	</div>
				2130
				2131	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2132	<div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
				2133	<!-- *********************************************************************** -->
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2134
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2135	<div class="doc_text">
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2136
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2137	<p>The LLVM instruction set consists of several different
				2138	classifications of instructions: <a href="#terminators">terminator
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	2139	instructions</a>, <a href="#binaryops">binary instructions</a>,
				2140	<a href="#bitwiseops">bitwise binary instructions</a>, <a
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2141	href="#memoryops">memory instructions</a>, and <a href="#otherops">other
				2142	instructions</a>.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2143
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2144	</div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2145
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2146	<!-- ======================================================================= -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2147	<div class="doc_subsection"> <a name="terminators">Terminator
				2148	Instructions</a> </div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2149
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2150	<div class="doc_text">
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2151
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2152	<p>As mentioned <a href="#functionstructure">previously</a>, every
				2153	basic block in a program ends with a "Terminator" instruction, which
				2154	indicates which block should be executed after the current block is
				2155	finished. These terminator instructions typically yield a '<tt>void</tt>'
				2156	value: they produce control flow, not values (the one exception being
				2157	the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	2158	<p>There are six different terminator instructions: the '<a
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2159	href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
				2160	instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2161	the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
				2162	href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
				2163	href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2164
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2165	</div>
Chris Lattner	c3f5976	2004-12-09 17:30:23 +0000	[diff] [blame]	2166
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2167	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2168	<div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
				2169	Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2170	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2171	<h5>Syntax:</h5>
Dan Gohman	b1e6b96	2008-10-04 19:00:07 +0000	[diff] [blame]	2172	<pre>
				2173	ret <type> <value> <i>; Return a value from a non-void function</i>
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	2174	ret void <i>; Return from void function</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2175	</pre>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2176
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2177	<h5>Overview:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2178
Dan Gohman	b1e6b96	2008-10-04 19:00:07 +0000	[diff] [blame]	2179	<p>The '<tt>ret</tt>' instruction is used to return control flow (and
				2180	optionally a value) from a function back to the caller.</p>
John Criswell	4457dc9	2004-04-09 16:48:45 +0000	[diff] [blame]	2181	<p>There are two forms of the '<tt>ret</tt>' instruction: one that
Dan Gohman	b1e6b96	2008-10-04 19:00:07 +0000	[diff] [blame]	2182	returns a value and then causes control flow, and one that just causes
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2183	control flow to occur.</p>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2184
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2185	<h5>Arguments:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2186
Dan Gohman	b1e6b96	2008-10-04 19:00:07 +0000	[diff] [blame]	2187	<p>The '<tt>ret</tt>' instruction optionally accepts a single argument,
				2188	the return value. The type of the return value must be a
				2189	'<a href="#t_firstclass">first class</a>' type.</p>
				2190
				2191	<p>A function is not <a href="#wellformed">well formed</a> if
				2192	it it has a non-void return type and contains a '<tt>ret</tt>'
				2193	instruction with no return value or a return value with a type that
				2194	does not match its type, or if it has a void return type and contains
				2195	a '<tt>ret</tt>' instruction with a return value.</p>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2196
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2197	<h5>Semantics:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2198
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2199	<p>When the '<tt>ret</tt>' instruction is executed, control flow
				2200	returns back to the calling function's context. If the caller is a "<a
John Criswell	fa08187	2004-06-25 15:16:57 +0000	[diff] [blame]	2201	href="#i_call"><tt>call</tt></a>" instruction, execution continues at
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2202	the instruction after the call. If the caller was an "<a
				2203	href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	2204	at the beginning of the "normal" destination block. If the instruction
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2205	returns a value, that value shall set the call or invoke instruction's
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	2206	return value.</p>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2207
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2208	<h5>Example:</h5>
Chris Lattner	f4cde4e	2008-04-23 04:59:35 +0000	[diff] [blame]	2209
				2210	<pre>
				2211	ret i32 5 <i>; Return an integer value of 5</i>
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	2212	ret void <i>; Return from a void function</i>
Bill Wendling	0a4bbbf	2009-02-28 22:12:54 +0000	[diff] [blame]	2213	ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2214	</pre>
Dan Gohman	f3e60bd	2009-01-12 23:12:39 +0000	[diff] [blame]	2215
Dan Gohman	d8791e5	2009-01-24 15:58:40 +0000	[diff] [blame]	2216	<p>Note that the code generator does not yet fully support large
				2217	return values. The specific sizes that are currently supported are
				2218	dependent on the target. For integers, on 32-bit targets the limit
				2219	is often 64 bits, and on 64-bit targets the limit is often 128 bits.
				2220	For aggregate types, the current limits are dependent on the element
				2221	types; for example targets are often limited to 2 total integer
				2222	elements and 2 total floating-point elements.</p>
Dan Gohman	f3e60bd	2009-01-12 23:12:39 +0000	[diff] [blame]	2223
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2224	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2225	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2226	<div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2227	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2228	<h5>Syntax:</h5>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	2229	<pre> br i1 <cond>, label <iftrue>, label <iffalse><br> br label <dest> <i>; Unconditional branch</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2230	</pre>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2231	<h5>Overview:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2232	<p>The '<tt>br</tt>' instruction is used to cause control flow to
				2233	transfer to a different basic block in the current function. There are
				2234	two forms of this instruction, corresponding to a conditional branch
				2235	and an unconditional branch.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2236	<h5>Arguments:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2237	<p>The conditional branch form of the '<tt>br</tt>' instruction takes a
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	2238	single '<tt>i1</tt>' value and two '<tt>label</tt>' values. The
Reid Spencer	de15194	2007-02-19 23:54:10 +0000	[diff] [blame]	2239	unconditional form of the '<tt>br</tt>' instruction takes a single
				2240	'<tt>label</tt>' value as a target.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2241	<h5>Semantics:</h5>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	2242	<p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2243	argument is evaluated. If the value is <tt>true</tt>, control flows
				2244	to the '<tt>iftrue</tt>' <tt>label</tt> argument. If "cond" is <tt>false</tt>,
				2245	control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2246	<h5>Example:</h5>
Chris Lattner	60150a3	2009-05-09 18:11:50 +0000	[diff] [blame]	2247	<pre>Test:<br> %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b<br> br i1 %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br> <a
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2248	href="#i_ret">ret</a> i32 1<br>IfUnequal:<br> <a href="#i_ret">ret</a> i32 0<br></pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2249	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2250	<!-- _______________________________________________________________________ -->
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2251	<div class="doc_subsubsection">
				2252	<a name="i_switch">'<tt>switch</tt>' Instruction</a>
				2253	</div>
				2254
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2255	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2256	<h5>Syntax:</h5>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2257
				2258	<pre>
				2259	switch <intty> <value>, label <defaultdest> [ <intty> <val>, label <dest> ... ]
				2260	</pre>
				2261
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2262	<h5>Overview:</h5>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2263
				2264	<p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
				2265	several different places. It is a generalization of the '<tt>br</tt>'
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2266	instruction, allowing a branch to occur to one of many possible
				2267	destinations.</p>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2268
				2269
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2270	<h5>Arguments:</h5>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2271
				2272	<p>The '<tt>switch</tt>' instruction uses three parameters: an integer
				2273	comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
				2274	an array of pairs of comparison value constants and '<tt>label</tt>'s. The
				2275	table is not allowed to contain duplicate constant entries.</p>
				2276
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2277	<h5>Semantics:</h5>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2278
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2279	<p>The <tt>switch</tt> instruction specifies a table of values and
				2280	destinations. When the '<tt>switch</tt>' instruction is executed, this
John Criswell	8411475	2004-06-25 16:05:06 +0000	[diff] [blame]	2281	table is searched for the given value. If the value is found, control flow is
				2282	transfered to the corresponding destination; otherwise, control flow is
				2283	transfered to the default destination.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2284
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2285	<h5>Implementation:</h5>
				2286
				2287	<p>Depending on properties of the target machine and the particular
				2288	<tt>switch</tt> instruction, this instruction may be code generated in different
John Criswell	8411475	2004-06-25 16:05:06 +0000	[diff] [blame]	2289	ways. For example, it could be generated as a series of chained conditional
				2290	branches or with a lookup table.</p>
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2291
				2292	<h5>Example:</h5>
				2293
				2294	<pre>
				2295	<i>; Emulate a conditional br instruction</i>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	2296	%Val = <a href="#i_zext">zext</a> i1 %value to i32
Dan Gohman	2a08c53	2009-01-04 23:44:43 +0000	[diff] [blame]	2297	switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2298
				2299	<i>; Emulate an unconditional br instruction</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2300	switch i32 0, label %dest [ ]
Chris Lattner	c88c17b	2004-02-24 04:54:45 +0000	[diff] [blame]	2301
				2302	<i>; Implement a jump table:</i>
Dan Gohman	2a08c53	2009-01-04 23:44:43 +0000	[diff] [blame]	2303	switch i32 %val, label %otherwise [ i32 0, label %onzero
				2304	i32 1, label %onone
				2305	i32 2, label %ontwo ]
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2306	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2307	</div>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2308
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2309	<!-- _______________________________________________________________________ -->
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2310	<div class="doc_subsubsection">
				2311	<a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
				2312	</div>
				2313
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2314	<div class="doc_text">
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2315
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2316	<h5>Syntax:</h5>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2317
				2318	<pre>
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	2319	<result> = invoke [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] <ptr to function ty> <function ptr val>(<function args>) [<a href="#fnattrs">fn attrs</a>]
Chris Lattner	76b8a33	2006-05-14 18:23:06 +0000	[diff] [blame]	2320	to label <normal label> unwind label <exception label>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2321	</pre>
				2322
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	2323	<h5>Overview:</h5>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2324
				2325	<p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
				2326	function, with the possibility of control flow transfer to either the
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	2327	'<tt>normal</tt>' label or the
				2328	'<tt>exception</tt>' label. If the callee function returns with the
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2329	"<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the
				2330	"normal" label. If the callee (or any indirect callees) returns with the "<a
John Criswell	e4c57cc	2005-05-12 16:52:32 +0000	[diff] [blame]	2331	href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	2332	continued at the dynamically nearest "exception" label.</p>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2333
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2334	<h5>Arguments:</h5>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2335
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2336	<p>This instruction requires several arguments:</p>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2337
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2338	<ol>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2339	<li>
Duncan Sands	8036ca4	2007-03-30 12:22:09 +0000	[diff] [blame]	2340	The optional "cconv" marker indicates which <a href="#callingconv">calling
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2341	convention</a> the call should use. If none is specified, the call defaults
				2342	to using C calling conventions.
				2343	</li>
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	2344
				2345	<li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
				2346	return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>',
				2347	and '<tt>inreg</tt>' attributes are valid here.</li>
				2348
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2349	<li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
				2350	function value being invoked. In most cases, this is a direct function
				2351	invocation, but indirect <tt>invoke</tt>s are just as possible, branching off
				2352	an arbitrary pointer to function value.
				2353	</li>
				2354
				2355	<li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
				2356	function to be invoked. </li>
				2357
				2358	<li>'<tt>function args</tt>': argument list whose types match the function
				2359	signature argument types. If the function signature indicates the function
				2360	accepts a variable number of arguments, the extra arguments can be
				2361	specified. </li>
				2362
				2363	<li>'<tt>normal label</tt>': the label reached when the called function
				2364	executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
				2365
				2366	<li>'<tt>exception label</tt>': the label reached when a callee returns with
				2367	the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
				2368
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	2369	<li>The optional <a href="#fnattrs">function attributes</a> list. Only
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	2370	'<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
				2371	'<tt>readnone</tt>' attributes are valid here.</li>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2372	</ol>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2373
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2374	<h5>Semantics:</h5>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2375
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2376	<p>This instruction is designed to operate as a standard '<tt><a
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2377	href="#i_call">call</a></tt>' instruction in most regards. The primary
				2378	difference is that it establishes an association with a label, which is used by
				2379	the runtime library to unwind the stack.</p>
				2380
				2381	<p>This instruction is used in languages with destructors to ensure that proper
				2382	cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
				2383	exception. Additionally, this is important for implementation of
				2384	'<tt>catch</tt>' clauses in high-level languages that support them.</p>
				2385
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2386	<h5>Example:</h5>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	2387	<pre>
Nick Lewycky	d703f65	2008-03-16 07:18:12 +0000	[diff] [blame]	2388	%retval = invoke i32 @Test(i32 15) to label %Continue
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	2389	unwind label %TestCleanup <i>; {i32}:retval set</i>
Nick Lewycky	d703f65	2008-03-16 07:18:12 +0000	[diff] [blame]	2390	%retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	2391	unwind label %TestCleanup <i>; {i32}:retval set</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2392	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2393	</div>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2394
				2395
Chris Lattner	27f71f2	2003-09-03 00:41:47 +0000	[diff] [blame]	2396	<!-- _______________________________________________________________________ -->
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2397
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2398	<div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
				2399	Instruction</a> </div>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2400
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2401	<div class="doc_text">
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2402
Chris Lattner	27f71f2	2003-09-03 00:41:47 +0000	[diff] [blame]	2403	<h5>Syntax:</h5>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2404	<pre>
				2405	unwind
				2406	</pre>
				2407
Chris Lattner	27f71f2	2003-09-03 00:41:47 +0000	[diff] [blame]	2408	<h5>Overview:</h5>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2409
				2410	<p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
				2411	at the first callee in the dynamic call stack which used an <a
				2412	href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call. This is
				2413	primarily used to implement exception handling.</p>
				2414
Chris Lattner	27f71f2	2003-09-03 00:41:47 +0000	[diff] [blame]	2415	<h5>Semantics:</h5>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2416
Chris Lattner	72ed200	2008-04-19 21:01:16 +0000	[diff] [blame]	2417	<p>The '<tt>unwind</tt>' instruction causes execution of the current function to
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2418	immediately halt. The dynamic call stack is then searched for the first <a
				2419	href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack. Once found,
				2420	execution continues at the "exceptional" destination block specified by the
				2421	<tt>invoke</tt> instruction. If there is no <tt>invoke</tt> instruction in the
				2422	dynamic call chain, undefined behavior results.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2423	</div>
Chris Lattner	35eca58	2004-10-16 18:04:13 +0000	[diff] [blame]	2424
				2425	<!-- _______________________________________________________________________ -->
				2426
				2427	<div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
				2428	Instruction</a> </div>
				2429
				2430	<div class="doc_text">
				2431
				2432	<h5>Syntax:</h5>
				2433	<pre>
				2434	unreachable
				2435	</pre>
				2436
				2437	<h5>Overview:</h5>
				2438
				2439	<p>The '<tt>unreachable</tt>' instruction has no defined semantics. This
				2440	instruction is used to inform the optimizer that a particular portion of the
				2441	code is not reachable. This can be used to indicate that the code after a
				2442	no-return function cannot be reached, and other facts.</p>
				2443
				2444	<h5>Semantics:</h5>
				2445
				2446	<p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
				2447	</div>
				2448
				2449
				2450
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2451	<!-- ======================================================================= -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2452	<div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2453	<div class="doc_text">
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2454	<p>Binary operators are used to do most of the computation in a
Chris Lattner	5a15814	2008-04-01 18:47:32 +0000	[diff] [blame]	2455	program. They require two operands of the same type, execute an operation on them, and
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	2456	produce a single value. The operands might represent
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	2457	multiple data, as is the case with the <a href="#t_vector">vector</a> data type.
Chris Lattner	5a15814	2008-04-01 18:47:32 +0000	[diff] [blame]	2458	The result value has the same type as its operands.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2459	<p>There are several different binary operators:</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2460	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2461	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2462	<div class="doc_subsubsection">
				2463	<a name="i_add">'<tt>add</tt>' Instruction</a>
				2464	</div>
				2465
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2466	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2467
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2468	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2469
				2470	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2471	<result> = add <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2472	</pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2473
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2474	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2475
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2476	<p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2477
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2478	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2479
				2480	<p>The two arguments to the '<tt>add</tt>' instruction must be <a
				2481	href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>, or
				2482	<a href="#t_vector">vector</a> values. Both arguments must have identical
				2483	types.</p>
				2484
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2485	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2486
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2487	<p>The value produced is the integer or floating point sum of the two
				2488	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2489
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2490	<p>If an integer sum has unsigned overflow, the result returned is the
				2491	mathematical result modulo 2<sup>n</sup>, where n is the bit width of
				2492	the result.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2493
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2494	<p>Because LLVM integers use a two's complement representation, this
				2495	instruction is appropriate for both signed and unsigned integers.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2496
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2497	<h5>Example:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2498
				2499	<pre>
				2500	<result> = add i32 4, %var <i>; yields {i32}:result = 4 + %var</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2501	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2502	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2503	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2504	<div class="doc_subsubsection">
				2505	<a name="i_sub">'<tt>sub</tt>' Instruction</a>
				2506	</div>
				2507
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2508	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2509
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2510	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2511
				2512	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2513	<result> = sub <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2514	</pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2515
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2516	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2517
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2518	<p>The '<tt>sub</tt>' instruction returns the difference of its two
				2519	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2520
				2521	<p>Note that the '<tt>sub</tt>' instruction is used to represent the
				2522	'<tt>neg</tt>' instruction present in most other intermediate
				2523	representations.</p>
				2524
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2525	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2526
				2527	<p>The two arguments to the '<tt>sub</tt>' instruction must be <a
				2528	href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>,
				2529	or <a href="#t_vector">vector</a> values. Both arguments must have identical
				2530	types.</p>
				2531
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2532	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2533
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2534	<p>The value produced is the integer or floating point difference of
				2535	the two operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2536
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2537	<p>If an integer difference has unsigned overflow, the result returned is the
				2538	mathematical result modulo 2<sup>n</sup>, where n is the bit width of
				2539	the result.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2540
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2541	<p>Because LLVM integers use a two's complement representation, this
				2542	instruction is appropriate for both signed and unsigned integers.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2543
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2544	<h5>Example:</h5>
Bill Wendling	aac388b	2007-05-29 09:42:13 +0000	[diff] [blame]	2545	<pre>
				2546	<result> = sub i32 4, %var <i>; yields {i32}:result = 4 - %var</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2547	<result> = sub i32 0, %val <i>; yields {i32}:result = -%var</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2548	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2549	</div>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2550
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2551	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2552	<div class="doc_subsubsection">
				2553	<a name="i_mul">'<tt>mul</tt>' Instruction</a>
				2554	</div>
				2555
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2556	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2557
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2558	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2559	<pre> <result> = mul <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2560	</pre>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2561	<h5>Overview:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2562	<p>The '<tt>mul</tt>' instruction returns the product of its two
				2563	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2564
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2565	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2566
				2567	<p>The two arguments to the '<tt>mul</tt>' instruction must be <a
				2568	href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>,
				2569	or <a href="#t_vector">vector</a> values. Both arguments must have identical
				2570	types.</p>
				2571
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2572	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2573
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2574	<p>The value produced is the integer or floating point product of the
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2575	two operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2576
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2577	<p>If the result of an integer multiplication has unsigned overflow,
				2578	the result returned is the mathematical result modulo
				2579	2<sup>n</sup>, where n is the bit width of the result.</p>
				2580	<p>Because LLVM integers use a two's complement representation, and the
				2581	result is the same width as the operands, this instruction returns the
				2582	correct result for both signed and unsigned integers. If a full product
				2583	(e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands
				2584	should be sign-extended or zero-extended as appropriate to the
				2585	width of the full product.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2586	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2587	<pre> <result> = mul i32 4, %var <i>; yields {i32}:result = 4 * %var</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2588	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2589	</div>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2590
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2591	<!-- _______________________________________________________________________ -->
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2592	<div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
				2593	</a></div>
				2594	<div class="doc_text">
				2595	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2596	<pre> <result> = udiv <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2597	</pre>
				2598	<h5>Overview:</h5>
				2599	<p>The '<tt>udiv</tt>' instruction returns the quotient of its two
				2600	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2601
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2602	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2603
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2604	<p>The two arguments to the '<tt>udiv</tt>' instruction must be
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2605	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2606	values. Both arguments must have identical types.</p>
				2607
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2608	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2609
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2610	<p>The value produced is the unsigned integer quotient of the two operands.</p>
				2611	<p>Note that unsigned integer division and signed integer division are distinct
				2612	operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
				2613	<p>Division by zero leads to undefined behavior.</p>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2614	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2615	<pre> <result> = udiv i32 4, %var <i>; yields {i32}:result = 4 / %var</i>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2616	</pre>
				2617	</div>
				2618	<!-- _______________________________________________________________________ -->
				2619	<div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
				2620	</a> </div>
				2621	<div class="doc_text">
				2622	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2623	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2624	<result> = sdiv <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2625	</pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2626
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2627	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2628
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2629	<p>The '<tt>sdiv</tt>' instruction returns the quotient of its two
				2630	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2631
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2632	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2633
				2634	<p>The two arguments to the '<tt>sdiv</tt>' instruction must be
				2635	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2636	values. Both arguments must have identical types.</p>
				2637
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2638	<h5>Semantics:</h5>
Chris Lattner	a73afe0	2008-04-01 18:45:27 +0000	[diff] [blame]	2639	<p>The value produced is the signed integer quotient of the two operands rounded towards zero.</p>
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2640	<p>Note that signed integer division and unsigned integer division are distinct
				2641	operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
				2642	<p>Division by zero leads to undefined behavior. Overflow also leads to
				2643	undefined behavior; this is a rare case, but can occur, for example,
				2644	by doing a 32-bit division of -2147483648 by -1.</p>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2645	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2646	<pre> <result> = sdiv i32 4, %var <i>; yields {i32}:result = 4 / %var</i>
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2647	</pre>
				2648	</div>
				2649	<!-- _______________________________________________________________________ -->
				2650	<div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2651	Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2652	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2653	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2654	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2655	<result> = fdiv <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2656	</pre>
				2657	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2658
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2659	<p>The '<tt>fdiv</tt>' instruction returns the quotient of its two
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2660	operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2661
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2662	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2663
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	2664	<p>The two arguments to the '<tt>fdiv</tt>' instruction must be
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2665	<a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a>
				2666	of floating point values. Both arguments must have identical types.</p>
				2667
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2668	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2669
Reid Spencer	1628cec	2006-10-26 06:15:43 +0000	[diff] [blame]	2670	<p>The value produced is the floating point quotient of the two operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2671
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2672	<h5>Example:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2673
				2674	<pre>
				2675	<result> = fdiv float 4.0, %var <i>; yields {float}:result = 4.0 / %var</i>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2676	</pre>
				2677	</div>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2678
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2679	<!-- _______________________________________________________________________ -->
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2680	<div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
				2681	</div>
				2682	<div class="doc_text">
				2683	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2684	<pre> <result> = urem <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2685	</pre>
				2686	<h5>Overview:</h5>
				2687	<p>The '<tt>urem</tt>' instruction returns the remainder from the
				2688	unsigned division of its two arguments.</p>
				2689	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2690	<p>The two arguments to the '<tt>urem</tt>' instruction must be
				2691	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2692	values. Both arguments must have identical types.</p>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2693	<h5>Semantics:</h5>
				2694	<p>This instruction returns the unsigned integer <i>remainder</i> of a division.
Chris Lattner	a73afe0	2008-04-01 18:45:27 +0000	[diff] [blame]	2695	This instruction always performs an unsigned division to get the remainder.</p>
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2696	<p>Note that unsigned integer remainder and signed integer remainder are
				2697	distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
				2698	<p>Taking the remainder of a division by zero leads to undefined behavior.</p>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2699	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2700	<pre> <result> = urem i32 4, %var <i>; yields {i32}:result = 4 % %var</i>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2701	</pre>
				2702
				2703	</div>
				2704	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2705	<div class="doc_subsubsection">
				2706	<a name="i_srem">'<tt>srem</tt>' Instruction</a>
				2707	</div>
				2708
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2709	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2710
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2711	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2712
				2713	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2714	<result> = srem <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2715	</pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2716
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2717	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2718
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2719	<p>The '<tt>srem</tt>' instruction returns the remainder from the
Dan Gohman	8017631	2007-11-05 23:35:22 +0000	[diff] [blame]	2720	signed division of its two operands. This instruction can also take
				2721	<a href="#t_vector">vector</a> versions of the values in which case
				2722	the elements must be integers.</p>
Chris Lattner	c7d3ab3	2008-01-04 04:33:49 +0000	[diff] [blame]	2723
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2724	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2725
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2726	<p>The two arguments to the '<tt>srem</tt>' instruction must be
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2727	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2728	values. Both arguments must have identical types.</p>
				2729
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2730	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2731
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2732	<p>This instruction returns the <i>remainder</i> of a division (where the result
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2733	has the same sign as the dividend, <tt>op1</tt>), not the <i>modulo</i>
				2734	operator (where the result has the same sign as the divisor, <tt>op2</tt>) of
Reid Spencer	c9fdfc8	2007-03-24 22:23:39 +0000	[diff] [blame]	2735	a value. For more information about the difference, see <a
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2736	href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
Reid Spencer	c9fdfc8	2007-03-24 22:23:39 +0000	[diff] [blame]	2737	Math Forum</a>. For a table of how this is implemented in various languages,
Reid Spencer	64f5c6c	2007-03-24 22:40:44 +0000	[diff] [blame]	2738	please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
Reid Spencer	c9fdfc8	2007-03-24 22:23:39 +0000	[diff] [blame]	2739	Wikipedia: modulo operation</a>.</p>
Chris Lattner	5ec8983	2008-01-28 00:36:27 +0000	[diff] [blame]	2740	<p>Note that signed integer remainder and unsigned integer remainder are
				2741	distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
				2742	<p>Taking the remainder of a division by zero leads to undefined behavior.
				2743	Overflow also leads to undefined behavior; this is a rare case, but can occur,
				2744	for example, by taking the remainder of a 32-bit division of -2147483648 by -1.
				2745	(The remainder doesn't actually overflow, but this rule lets srem be
				2746	implemented using instructions that return both the result of the division
				2747	and the remainder.)</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2748	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2749	<pre> <result> = srem i32 4, %var <i>; yields {i32}:result = 4 % %var</i>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2750	</pre>
				2751
				2752	</div>
				2753	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2754	<div class="doc_subsubsection">
				2755	<a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
				2756
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2757	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2758
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2759	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2760	<pre> <result> = frem <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2761	</pre>
				2762	<h5>Overview:</h5>
				2763	<p>The '<tt>frem</tt>' instruction returns the remainder from the
				2764	division of its two operands.</p>
				2765	<h5>Arguments:</h5>
				2766	<p>The two arguments to the '<tt>frem</tt>' instruction must be
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2767	<a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a>
				2768	of floating point values. Both arguments must have identical types.</p>
				2769
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2770	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2771
Chris Lattner	a73afe0	2008-04-01 18:45:27 +0000	[diff] [blame]	2772	<p>This instruction returns the <i>remainder</i> of a division.
				2773	The remainder has the same sign as the dividend.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2774
Reid Spencer	0a783f7	2006-11-02 01:53:59 +0000	[diff] [blame]	2775	<h5>Example:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2776
				2777	<pre>
				2778	<result> = frem float 4.0, %var <i>; yields {float}:result = 4.0 % %var</i>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2779	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2780	</div>
Robert Bocchino	7b81c75	2006-02-17 21:18:08 +0000	[diff] [blame]	2781
Reid Spencer	8e11bf8	2007-02-02 13:57:07 +0000	[diff] [blame]	2782	<!-- ======================================================================= -->
				2783	<div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
				2784	Operations</a> </div>
				2785	<div class="doc_text">
				2786	<p>Bitwise binary operators are used to do various forms of
				2787	bit-twiddling in a program. They are generally very efficient
				2788	instructions and can commonly be strength reduced from other
Chris Lattner	a73afe0	2008-04-01 18:45:27 +0000	[diff] [blame]	2789	instructions. They require two operands of the same type, execute an operation on them,
				2790	and produce a single value. The resulting value is the same type as its operands.</p>
Reid Spencer	8e11bf8	2007-02-02 13:57:07 +0000	[diff] [blame]	2791	</div>
				2792
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2793	<!-- _______________________________________________________________________ -->
				2794	<div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
				2795	Instruction</a> </div>
				2796	<div class="doc_text">
				2797	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2798	<pre> <result> = shl <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2799	</pre>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2800
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2801	<h5>Overview:</h5>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2802
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2803	<p>The '<tt>shl</tt>' instruction returns the first operand shifted to
				2804	the left a specified number of bits.</p>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2805
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2806	<h5>Arguments:</h5>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2807
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2808	<p>Both arguments to the '<tt>shl</tt>' instruction must be the same <a
Nate Begeman	5bc1ea0	2008-07-29 15:49:41 +0000	[diff] [blame]	2809	href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2810	type. '<tt>op2</tt>' is treated as an unsigned value.</p>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2811
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2812	<h5>Semantics:</h5>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2813
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2814	<p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod 2<sup>n</sup>,
				2815	where n is the width of the result. If <tt>op2</tt> is (statically or dynamically) negative or
Mon P Wang	01f8d09	2008-12-10 08:55:09 +0000	[diff] [blame]	2816	equal to or larger than the number of bits in <tt>op1</tt>, the result is undefined.
				2817	If the arguments are vectors, each vector element of <tt>op1</tt> is shifted by the
				2818	corresponding shift amount in <tt>op2</tt>.</p>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2819
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2820	<h5>Example:</h5><pre>
				2821	<result> = shl i32 4, %var <i>; yields {i32}: 4 << %var</i>
				2822	<result> = shl i32 4, 2 <i>; yields {i32}: 16</i>
				2823	<result> = shl i32 1, 10 <i>; yields {i32}: 1024</i>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2824	<result> = shl i32 1, 32 <i>; undefined</i>
Mon P Wang	e9f1015	2008-12-09 05:46:39 +0000	[diff] [blame]	2825	<result> = shl <2 x i32> < i32 1, i32 1>, < i32 1, i32 2> <i>; yields: result=<2 x i32> < i32 2, i32 4></i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2826	</pre>
				2827	</div>
				2828	<!-- _______________________________________________________________________ -->
				2829	<div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
				2830	Instruction</a> </div>
				2831	<div class="doc_text">
				2832	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2833	<pre> <result> = lshr <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2834	</pre>
				2835
				2836	<h5>Overview:</h5>
				2837	<p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	2838	operand shifted to the right a specified number of bits with zero fill.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2839
				2840	<h5>Arguments:</h5>
				2841	<p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
Nate Begeman	5bc1ea0	2008-07-29 15:49:41 +0000	[diff] [blame]	2842	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2843	type. '<tt>op2</tt>' is treated as an unsigned value.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2844
				2845	<h5>Semantics:</h5>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2846
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2847	<p>This instruction always performs a logical shift right operation. The most
				2848	significant bits of the result will be filled with zero bits after the
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2849	shift. If <tt>op2</tt> is (statically or dynamically) equal to or larger than
Mon P Wang	01f8d09	2008-12-10 08:55:09 +0000	[diff] [blame]	2850	the number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
				2851	vectors, each vector element of <tt>op1</tt> is shifted by the corresponding shift
				2852	amount in <tt>op2</tt>.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2853
				2854	<h5>Example:</h5>
				2855	<pre>
				2856	<result> = lshr i32 4, 1 <i>; yields {i32}:result = 2</i>
				2857	<result> = lshr i32 4, 2 <i>; yields {i32}:result = 1</i>
				2858	<result> = lshr i8 4, 3 <i>; yields {i8}:result = 0</i>
				2859	<result> = lshr i8 -2, 1 <i>; yields {i8}:result = 0x7FFFFFFF </i>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2860	<result> = lshr i32 1, 32 <i>; undefined</i>
Mon P Wang	e9f1015	2008-12-09 05:46:39 +0000	[diff] [blame]	2861	<result> = lshr <2 x i32> < i32 -2, i32 4>, < i32 1, i32 2> <i>; yields: result=<2 x i32> < i32 0x7FFFFFFF, i32 1></i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2862	</pre>
				2863	</div>
				2864
Reid Spencer	8e11bf8	2007-02-02 13:57:07 +0000	[diff] [blame]	2865	<!-- _______________________________________________________________________ -->
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2866	<div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
				2867	Instruction</a> </div>
				2868	<div class="doc_text">
				2869
				2870	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2871	<pre> <result> = ashr <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2872	</pre>
				2873
				2874	<h5>Overview:</h5>
				2875	<p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	2876	operand shifted to the right a specified number of bits with sign extension.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2877
				2878	<h5>Arguments:</h5>
				2879	<p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
Nate Begeman	5bc1ea0	2008-07-29 15:49:41 +0000	[diff] [blame]	2880	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2881	type. '<tt>op2</tt>' is treated as an unsigned value.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2882
				2883	<h5>Semantics:</h5>
				2884	<p>This instruction always performs an arithmetic shift right operation,
				2885	The most significant bits of the result will be filled with the sign bit
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2886	of <tt>op1</tt>. If <tt>op2</tt> is (statically or dynamically) equal to or
Mon P Wang	01f8d09	2008-12-10 08:55:09 +0000	[diff] [blame]	2887	larger than the number of bits in <tt>op1</tt>, the result is undefined. If the
				2888	arguments are vectors, each vector element of <tt>op1</tt> is shifted by the
				2889	corresponding shift amount in <tt>op2</tt>.</p>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2890
				2891	<h5>Example:</h5>
				2892	<pre>
				2893	<result> = ashr i32 4, 1 <i>; yields {i32}:result = 2</i>
				2894	<result> = ashr i32 4, 2 <i>; yields {i32}:result = 1</i>
				2895	<result> = ashr i8 4, 3 <i>; yields {i8}:result = 0</i>
				2896	<result> = ashr i8 -2, 1 <i>; yields {i8}:result = -1</i>
Chris Lattner	6ccc2d5	2007-10-03 21:01:14 +0000	[diff] [blame]	2897	<result> = ashr i32 1, 32 <i>; undefined</i>
Mon P Wang	e9f1015	2008-12-09 05:46:39 +0000	[diff] [blame]	2898	<result> = ashr <2 x i32> < i32 -2, i32 4>, < i32 1, i32 3> <i>; yields: result=<2 x i32> < i32 -1, i32 0></i>
Reid Spencer	569f2fa	2007-01-31 21:39:12 +0000	[diff] [blame]	2899	</pre>
				2900	</div>
				2901
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2902	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2903	<div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
				2904	Instruction</a> </div>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2905
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2906	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2907
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2908	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2909
				2910	<pre>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2911	<result> = and <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2912	</pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2913
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2914	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2915
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2916	<p>The '<tt>and</tt>' instruction returns the bitwise logical and of
				2917	its two operands.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2918
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2919	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2920
				2921	<p>The two arguments to the '<tt>and</tt>' instruction must be
				2922	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2923	values. Both arguments must have identical types.</p>
				2924
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2925	<h5>Semantics:</h5>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2926	<p>The truth table used for the '<tt>and</tt>' instruction is:</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2927	<p> </p>
Bill Wendling	c7e4c4d	2008-09-07 10:29:20 +0000	[diff] [blame]	2928	<div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2929	<table border="1" cellspacing="0" cellpadding="4">
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2930	<tbody>
				2931	<tr>
				2932	<td>In0</td>
				2933	<td>In1</td>
				2934	<td>Out</td>
				2935	</tr>
				2936	<tr>
				2937	<td>0</td>
				2938	<td>0</td>
				2939	<td>0</td>
				2940	</tr>
				2941	<tr>
				2942	<td>0</td>
				2943	<td>1</td>
				2944	<td>0</td>
				2945	</tr>
				2946	<tr>
				2947	<td>1</td>
				2948	<td>0</td>
				2949	<td>0</td>
				2950	</tr>
				2951	<tr>
				2952	<td>1</td>
				2953	<td>1</td>
				2954	<td>1</td>
				2955	</tr>
				2956	</tbody>
				2957	</table>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	2958	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2959	<h5>Example:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2960	<pre>
				2961	<result> = and i32 4, %var <i>; yields {i32}:result = 4 & %var</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	2962	<result> = and i32 15, 40 <i>; yields {i32}:result = 8</i>
				2963	<result> = and i32 4, 8 <i>; yields {i32}:result = 0</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2964	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2965	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2966	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2967	<div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2968	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2969	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	2970	<pre> <result> = or <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2971	</pre>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2972	<h5>Overview:</h5>
				2973	<p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
				2974	or of its two operands.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2975	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	2976
				2977	<p>The two arguments to the '<tt>or</tt>' instruction must be
				2978	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				2979	values. Both arguments must have identical types.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	2980	<h5>Semantics:</h5>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	2981	<p>The truth table used for the '<tt>or</tt>' instruction is:</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2982	<p> </p>
Bill Wendling	c7e4c4d	2008-09-07 10:29:20 +0000	[diff] [blame]	2983	<div>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	2984	<table border="1" cellspacing="0" cellpadding="4">
				2985	<tbody>
				2986	<tr>
				2987	<td>In0</td>
				2988	<td>In1</td>
				2989	<td>Out</td>
				2990	</tr>
				2991	<tr>
				2992	<td>0</td>
				2993	<td>0</td>
				2994	<td>0</td>
				2995	</tr>
				2996	<tr>
				2997	<td>0</td>
				2998	<td>1</td>
				2999	<td>1</td>
				3000	</tr>
				3001	<tr>
				3002	<td>1</td>
				3003	<td>0</td>
				3004	<td>1</td>
				3005	</tr>
				3006	<tr>
				3007	<td>1</td>
				3008	<td>1</td>
				3009	<td>1</td>
				3010	</tr>
				3011	</tbody>
				3012	</table>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	3013	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3014	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3015	<pre> <result> = or i32 4, %var <i>; yields {i32}:result = 4 \| %var</i>
				3016	<result> = or i32 15, 40 <i>; yields {i32}:result = 47</i>
				3017	<result> = or i32 4, 8 <i>; yields {i32}:result = 12</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3018	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3019	</div>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3020	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3021	<div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
				3022	Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3023	<div class="doc_text">
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3024	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	3025	<pre> <result> = xor <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3026	</pre>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3027	<h5>Overview:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3028	<p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
				3029	or of its two operands. The <tt>xor</tt> is used to implement the
				3030	"one's complement" operation, which is the "~" operator in C.</p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3031	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	3032	<p>The two arguments to the '<tt>xor</tt>' instruction must be
				3033	<a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
				3034	values. Both arguments must have identical types.</p>
				3035
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3036	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	3037
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3038	<p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3039	<p> </p>
Bill Wendling	c7e4c4d	2008-09-07 10:29:20 +0000	[diff] [blame]	3040	<div>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3041	<table border="1" cellspacing="0" cellpadding="4">
				3042	<tbody>
				3043	<tr>
				3044	<td>In0</td>
				3045	<td>In1</td>
				3046	<td>Out</td>
				3047	</tr>
				3048	<tr>
				3049	<td>0</td>
				3050	<td>0</td>
				3051	<td>0</td>
				3052	</tr>
				3053	<tr>
				3054	<td>0</td>
				3055	<td>1</td>
				3056	<td>1</td>
				3057	</tr>
				3058	<tr>
				3059	<td>1</td>
				3060	<td>0</td>
				3061	<td>1</td>
				3062	</tr>
				3063	<tr>
				3064	<td>1</td>
				3065	<td>1</td>
				3066	<td>0</td>
				3067	</tr>
				3068	</tbody>
				3069	</table>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	3070	</div>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3071	<p> </p>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3072	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3073	<pre> <result> = xor i32 4, %var <i>; yields {i32}:result = 4 ^ %var</i>
				3074	<result> = xor i32 15, 40 <i>; yields {i32}:result = 39</i>
				3075	<result> = xor i32 4, 8 <i>; yields {i32}:result = 12</i>
				3076	<result> = xor i32 %V, -1 <i>; yields {i32}:result = ~%V</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3077	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3078	</div>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3079
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3080	<!-- ======================================================================= -->
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3081	<div class="doc_subsection">
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3082	<a name="vectorops">Vector Operations</a>
				3083	</div>
				3084
				3085	<div class="doc_text">
				3086
				3087	<p>LLVM supports several instructions to represent vector operations in a
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	3088	target-independent manner. These instructions cover the element-access and
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3089	vector-specific operations needed to process vectors effectively. While LLVM
				3090	does directly support these vector operations, many sophisticated algorithms
				3091	will want to use target-specific intrinsics to take full advantage of a specific
				3092	target.</p>
				3093
				3094	</div>
				3095
				3096	<!-- _______________________________________________________________________ -->
				3097	<div class="doc_subsubsection">
				3098	<a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
				3099	</div>
				3100
				3101	<div class="doc_text">
				3102
				3103	<h5>Syntax:</h5>
				3104
				3105	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3106	<result> = extractelement <n x <ty>> <val>, i32 <idx> <i>; yields <ty></i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3107	</pre>
				3108
				3109	<h5>Overview:</h5>
				3110
				3111	<p>
				3112	The '<tt>extractelement</tt>' instruction extracts a single scalar
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	3113	element from a vector at a specified index.
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3114	</p>
				3115
				3116
				3117	<h5>Arguments:</h5>
				3118
				3119	<p>
				3120	The first operand of an '<tt>extractelement</tt>' instruction is a
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	3121	value of <a href="#t_vector">vector</a> type. The second operand is
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3122	an index indicating the position from which to extract the element.
				3123	The index may be a variable.</p>
				3124
				3125	<h5>Semantics:</h5>
				3126
				3127	<p>
				3128	The result is a scalar of the same type as the element type of
				3129	<tt>val</tt>. Its value is the value at position <tt>idx</tt> of
				3130	<tt>val</tt>. If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
				3131	results are undefined.
				3132	</p>
				3133
				3134	<h5>Example:</h5>
				3135
				3136	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3137	%result = extractelement <4 x i32> %vec, i32 0 <i>; yields i32</i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3138	</pre>
				3139	</div>
				3140
				3141
				3142	<!-- _______________________________________________________________________ -->
				3143	<div class="doc_subsubsection">
				3144	<a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
				3145	</div>
				3146
				3147	<div class="doc_text">
				3148
				3149	<h5>Syntax:</h5>
				3150
				3151	<pre>
Dan Gohman	f3480b9	2008-05-12 23:38:42 +0000	[diff] [blame]	3152	<result> = insertelement <n x <ty>> <val>, <ty> <elt>, i32 <idx> <i>; yields <n x <ty>></i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3153	</pre>
				3154
				3155	<h5>Overview:</h5>
				3156
				3157	<p>
				3158	The '<tt>insertelement</tt>' instruction inserts a scalar
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	3159	element into a vector at a specified index.
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3160	</p>
				3161
				3162
				3163	<h5>Arguments:</h5>
				3164
				3165	<p>
				3166	The first operand of an '<tt>insertelement</tt>' instruction is a
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	3167	value of <a href="#t_vector">vector</a> type. The second operand is a
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3168	scalar value whose type must equal the element type of the first
				3169	operand. The third operand is an index indicating the position at
				3170	which to insert the value. The index may be a variable.</p>
				3171
				3172	<h5>Semantics:</h5>
				3173
				3174	<p>
Reid Spencer	485bad1	2007-02-15 03:07:05 +0000	[diff] [blame]	3175	The result is a vector of the same type as <tt>val</tt>. Its
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3176	element values are those of <tt>val</tt> except at position
				3177	<tt>idx</tt>, where it gets the value <tt>elt</tt>. If <tt>idx</tt>
				3178	exceeds the length of <tt>val</tt>, the results are undefined.
				3179	</p>
				3180
				3181	<h5>Example:</h5>
				3182
				3183	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3184	%result = insertelement <4 x i32> %vec, i32 1, i32 0 <i>; yields <4 x i32></i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3185	</pre>
				3186	</div>
				3187
				3188	<!-- _______________________________________________________________________ -->
				3189	<div class="doc_subsubsection">
				3190	<a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
				3191	</div>
				3192
				3193	<div class="doc_text">
				3194
				3195	<h5>Syntax:</h5>
				3196
				3197	<pre>
Mon P Wang	aeb06d2	2008-11-10 04:46:22 +0000	[diff] [blame]	3198	<result> = shufflevector <n x <ty>> <v1>, <n x <ty>> <v2>, <m x i32> <mask> <i>; yields <m x <ty>></i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3199	</pre>
				3200
				3201	<h5>Overview:</h5>
				3202
				3203	<p>
				3204	The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
Mon P Wang	aeb06d2	2008-11-10 04:46:22 +0000	[diff] [blame]	3205	from two input vectors, returning a vector with the same element type as
				3206	the input and length that is the same as the shuffle mask.
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3207	</p>
				3208
				3209	<h5>Arguments:</h5>
				3210
				3211	<p>
Mon P Wang	aeb06d2	2008-11-10 04:46:22 +0000	[diff] [blame]	3212	The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
				3213	with types that match each other. The third argument is a shuffle mask whose
				3214	element type is always 'i32'. The result of the instruction is a vector whose
				3215	length is the same as the shuffle mask and whose element type is the same as
				3216	the element type of the first two operands.
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3217	</p>
				3218
				3219	<p>
				3220	The shuffle mask operand is required to be a constant vector with either
				3221	constant integer or undef values.
				3222	</p>
				3223
				3224	<h5>Semantics:</h5>
				3225
				3226	<p>
				3227	The elements of the two input vectors are numbered from left to right across
				3228	both of the vectors. The shuffle mask operand specifies, for each element of
Mon P Wang	aeb06d2	2008-11-10 04:46:22 +0000	[diff] [blame]	3229	the result vector, which element of the two input vectors the result element
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3230	gets. The element selector may be undef (meaning "don't care") and the second
				3231	operand may be undef if performing a shuffle from only one vector.
				3232	</p>
				3233
				3234	<h5>Example:</h5>
				3235
				3236	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3237	%result = shufflevector <4 x i32> %v1, <4 x i32> %v2,
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	3238	<4 x i32> <i32 0, i32 4, i32 1, i32 5> <i>; yields <4 x i32></i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3239	%result = shufflevector <4 x i32> %v1, <4 x i32> undef,
				3240	<4 x i32> <i32 0, i32 1, i32 2, i32 3> <i>; yields <4 x i32></i> - Identity shuffle.
Mon P Wang	aeb06d2	2008-11-10 04:46:22 +0000	[diff] [blame]	3241	%result = shufflevector <8 x i32> %v1, <8 x i32> undef,
				3242	<4 x i32> <i32 0, i32 1, i32 2, i32 3> <i>; yields <4 x i32></i>
				3243	%result = shufflevector <4 x i32> %v1, <4 x i32> %v2,
				3244	<8 x i32> <i32 0, i32 1, i32 2, i32 3, i32 4, i32 5, i32 6, i32 7 > <i>; yields <8 x i32></i>
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3245	</pre>
				3246	</div>
				3247
Tanya Lattner	0947429	2006-04-14 19:24:33 +0000	[diff] [blame]	3248
Chris Lattner	3df241e	2006-04-08 23:07:04 +0000	[diff] [blame]	3249	<!-- ======================================================================= -->
				3250	<div class="doc_subsection">
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3251	<a name="aggregateops">Aggregate Operations</a>
				3252	</div>
				3253
				3254	<div class="doc_text">
				3255
				3256	<p>LLVM supports several instructions for working with aggregate values.
				3257	</p>
				3258
				3259	</div>
				3260
				3261	<!-- _______________________________________________________________________ -->
				3262	<div class="doc_subsubsection">
				3263	<a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
				3264	</div>
				3265
				3266	<div class="doc_text">
				3267
				3268	<h5>Syntax:</h5>
				3269
				3270	<pre>
				3271	<result> = extractvalue <aggregate type> <val>, <idx>{, <idx>}*
				3272	</pre>
				3273
				3274	<h5>Overview:</h5>
				3275
				3276	<p>
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3277	The '<tt>extractvalue</tt>' instruction extracts the value of a struct field
				3278	or array element from an aggregate value.
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3279	</p>
				3280
				3281
				3282	<h5>Arguments:</h5>
				3283
				3284	<p>
				3285	The first operand of an '<tt>extractvalue</tt>' instruction is a
				3286	value of <a href="#t_struct">struct</a> or <a href="#t_array">array</a>
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3287	type. The operands are constant indices to specify which value to extract
Dan Gohman	81a0c0b	2008-05-31 00:58:22 +0000	[diff] [blame]	3288	in a similar manner as indices in a
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3289	'<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
				3290	</p>
				3291
				3292	<h5>Semantics:</h5>
				3293
				3294	<p>
				3295	The result is the value at the position in the aggregate specified by
				3296	the index operands.
				3297	</p>
				3298
				3299	<h5>Example:</h5>
				3300
				3301	<pre>
Dan Gohman	81a0c0b	2008-05-31 00:58:22 +0000	[diff] [blame]	3302	%result = extractvalue {i32, float} %agg, 0 <i>; yields i32</i>
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3303	</pre>
				3304	</div>
				3305
				3306
				3307	<!-- _______________________________________________________________________ -->
				3308	<div class="doc_subsubsection">
				3309	<a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
				3310	</div>
				3311
				3312	<div class="doc_text">
				3313
				3314	<h5>Syntax:</h5>
				3315
				3316	<pre>
Dan Gohman	81a0c0b	2008-05-31 00:58:22 +0000	[diff] [blame]	3317	<result> = insertvalue <aggregate type> <val>, <ty> <val>, <idx> <i>; yields <n x <ty>></i>
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3318	</pre>
				3319
				3320	<h5>Overview:</h5>
				3321
				3322	<p>
				3323	The '<tt>insertvalue</tt>' instruction inserts a value
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3324	into a struct field or array element in an aggregate.
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3325	</p>
				3326
				3327
				3328	<h5>Arguments:</h5>
				3329
				3330	<p>
				3331	The first operand of an '<tt>insertvalue</tt>' instruction is a
				3332	value of <a href="#t_struct">struct</a> or <a href="#t_array">array</a> type.
				3333	The second operand is a first-class value to insert.
Dan Gohman	c4b49eb	2008-05-23 21:53:15 +0000	[diff] [blame]	3334	The following operands are constant indices
Dan Gohman	81a0c0b	2008-05-31 00:58:22 +0000	[diff] [blame]	3335	indicating the position at which to insert the value in a similar manner as
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3336	indices in a
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3337	'<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
				3338	The value to insert must have the same type as the value identified
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3339	by the indices.
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	3340	</p>
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3341
				3342	<h5>Semantics:</h5>
				3343
				3344	<p>
				3345	The result is an aggregate of the same type as <tt>val</tt>. Its
				3346	value is that of <tt>val</tt> except that the value at the position
Dan Gohman	c3dac5c	2008-05-13 18:16:06 +0000	[diff] [blame]	3347	specified by the indices is that of <tt>elt</tt>.
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3348	</p>
				3349
				3350	<h5>Example:</h5>
				3351
				3352	<pre>
Dan Gohman	52bb2db	2008-06-23 15:26:37 +0000	[diff] [blame]	3353	%result = insertvalue {i32, float} %agg, i32 1, 0 <i>; yields {i32, float}</i>
Dan Gohman	a334d5f	2008-05-12 23:51:09 +0000	[diff] [blame]	3354	</pre>
				3355	</div>
				3356
				3357
				3358	<!-- ======================================================================= -->
				3359	<div class="doc_subsection">
Chris Lattner	884a970	2006-08-15 00:45:58 +0000	[diff] [blame]	3360	<a name="memoryops">Memory Access and Addressing Operations</a>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3361	</div>
				3362
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3363	<div class="doc_text">
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3364
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3365	<p>A key design point of an SSA-based representation is how it
				3366	represents memory. In LLVM, no memory locations are in SSA form, which
				3367	makes things very simple. This section describes how to read, write,
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	3368	allocate, and free memory in LLVM.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3369
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3370	</div>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3371
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3372	<!-- _______________________________________________________________________ -->
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3373	<div class="doc_subsubsection">
				3374	<a name="i_malloc">'<tt>malloc</tt>' Instruction</a>
				3375	</div>
				3376
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3377	<div class="doc_text">
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3378
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3379	<h5>Syntax:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3380
				3381	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3382	<result> = malloc <type>[, i32 <NumElements>][, align <alignment>] <i>; yields {type*}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3383	</pre>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3384
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3385	<h5>Overview:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3386
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3387	<p>The '<tt>malloc</tt>' instruction allocates memory from the system
Christopher Lamb	303dae9	2007-12-17 01:00:21 +0000	[diff] [blame]	3388	heap and returns a pointer to it. The object is always allocated in the generic
				3389	address space (address space zero).</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3390
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3391	<h5>Arguments:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3392
				3393	<p>The '<tt>malloc</tt>' instruction allocates
				3394	<tt>sizeof(<type>)*NumElements</tt>
John Criswell	6e4ca61	2004-02-24 16:13:56 +0000	[diff] [blame]	3395	bytes of memory from the operating system and returns a pointer of the
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3396	appropriate type to the program. If "NumElements" is specified, it is the
Gabor Greif	1acd2ee	2008-02-09 22:24:34 +0000	[diff] [blame]	3397	number of elements allocated, otherwise "NumElements" is defaulted to be one.
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3398	If a constant alignment is specified, the value result of the allocation is guaranteed to
Gabor Greif	1acd2ee	2008-02-09 22:24:34 +0000	[diff] [blame]	3399	be aligned to at least that boundary. If not specified, or if zero, the target can
				3400	choose to align the allocation on any convenient boundary.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3401
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3402	<p>'<tt>type</tt>' must be a sized type.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3403
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3404	<h5>Semantics:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3405
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3406	<p>Memory is allocated using the system "<tt>malloc</tt>" function, and
Nick Lewycky	02ff308	2008-11-24 03:41:24 +0000	[diff] [blame]	3407	a pointer is returned. The result of a zero byte allocation is undefined. The
Chris Lattner	72ed200	2008-04-19 21:01:16 +0000	[diff] [blame]	3408	result is null if there is insufficient memory available.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3409
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3410	<h5>Example:</h5>
				3411
				3412	<pre>
Dan Gohman	81e2167	2009-01-04 23:49:44 +0000	[diff] [blame]	3413	%array = malloc [4 x i8] <i>; yields {[%4 x i8]*}:array</i>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3414
Bill Wendling	aac388b	2007-05-29 09:42:13 +0000	[diff] [blame]	3415	%size = <a href="#i_add">add</a> i32 2, 2 <i>; yields {i32}:size = i32 4</i>
				3416	%array1 = malloc i8, i32 4 <i>; yields {i8*}:array1</i>
				3417	%array2 = malloc [12 x i8], i32 %size <i>; yields {[12 x i8]*}:array2</i>
				3418	%array3 = malloc i32, i32 4, align 1024 <i>; yields {i32*}:array3</i>
				3419	%array4 = malloc i32, align 1024 <i>; yields {i32*}:array4</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3420	</pre>
Dan Gohman	f3e60bd	2009-01-12 23:12:39 +0000	[diff] [blame]	3421
				3422	<p>Note that the code generator does not yet respect the
				3423	alignment value.</p>
				3424
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3425	</div>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3426
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3427	<!-- _______________________________________________________________________ -->
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3428	<div class="doc_subsubsection">
				3429	<a name="i_free">'<tt>free</tt>' Instruction</a>
				3430	</div>
				3431
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3432	<div class="doc_text">
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3433
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3434	<h5>Syntax:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3435
				3436	<pre>
Dan Gohman	81e2167	2009-01-04 23:49:44 +0000	[diff] [blame]	3437	free <type> <value> <i>; yields {void}</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3438	</pre>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3439
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3440	<h5>Overview:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3441
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3442	<p>The '<tt>free</tt>' instruction returns memory back to the unused
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	3443	memory heap to be reallocated in the future.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3444
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3445	<h5>Arguments:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3446
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3447	<p>'<tt>value</tt>' shall be a pointer value that points to a value
				3448	that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
				3449	instruction.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3450
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3451	<h5>Semantics:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3452
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	3453	<p>Access to the memory pointed to by the pointer is no longer defined
Chris Lattner	e0db56d	2008-04-19 22:41:32 +0000	[diff] [blame]	3454	after this instruction executes. If the pointer is null, the operation
				3455	is a noop.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3456
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3457	<h5>Example:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3458
				3459	<pre>
Dan Gohman	81e2167	2009-01-04 23:49:44 +0000	[diff] [blame]	3460	%array = <a href="#i_malloc">malloc</a> [4 x i8] <i>; yields {[4 x i8]*}:array</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3461	free [4 x i8]* %array
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3462	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3463	</div>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3464
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3465	<!-- _______________________________________________________________________ -->
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3466	<div class="doc_subsubsection">
				3467	<a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
				3468	</div>
				3469
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3470	<div class="doc_text">
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3471
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3472	<h5>Syntax:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3473
				3474	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3475	<result> = alloca <type>[, i32 <NumElements>][, align <alignment>] <i>; yields {type*}:result</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3476	</pre>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3477
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3478	<h5>Overview:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3479
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	3480	<p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
				3481	currently executing function, to be automatically released when this function
Christopher Lamb	303dae9	2007-12-17 01:00:21 +0000	[diff] [blame]	3482	returns to its caller. The object is always allocated in the generic address
				3483	space (address space zero).</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3484
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3485	<h5>Arguments:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3486
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	3487	<p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(<type>)*NumElements</tt>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3488	bytes of memory on the runtime stack, returning a pointer of the
Gabor Greif	1acd2ee	2008-02-09 22:24:34 +0000	[diff] [blame]	3489	appropriate type to the program. If "NumElements" is specified, it is the
				3490	number of elements allocated, otherwise "NumElements" is defaulted to be one.
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3491	If a constant alignment is specified, the value result of the allocation is guaranteed
Gabor Greif	1acd2ee	2008-02-09 22:24:34 +0000	[diff] [blame]	3492	to be aligned to at least that boundary. If not specified, or if zero, the target
				3493	can choose to align the allocation on any convenient boundary.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3494
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3495	<p>'<tt>type</tt>' may be any sized type.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3496
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3497	<h5>Semantics:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3498
Bill Wendling	871eb0a	2009-05-08 20:49:29 +0000	[diff] [blame]	3499	<p>Memory is allocated; a pointer is returned. The operation is undefined if
Chris Lattner	72ed200	2008-04-19 21:01:16 +0000	[diff] [blame]	3500	there is insufficient stack space for the allocation. '<tt>alloca</tt>'d
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3501	memory is automatically released when the function returns. The '<tt>alloca</tt>'
				3502	instruction is commonly used to represent automatic variables that must
				3503	have an address available. When the function returns (either with the <tt><a
John Criswell	dae2e93	2005-05-12 16:55:34 +0000	[diff] [blame]	3504	href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt>
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3505	instructions), the memory is reclaimed. Allocating zero bytes
				3506	is legal, but the result is undefined.</p>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3507
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3508	<h5>Example:</h5>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3509
				3510	<pre>
Dan Gohman	81e2167	2009-01-04 23:49:44 +0000	[diff] [blame]	3511	%ptr = alloca i32 <i>; yields {i32*}:ptr</i>
				3512	%ptr = alloca i32, i32 4 <i>; yields {i32*}:ptr</i>
				3513	%ptr = alloca i32, i32 4, align 1024 <i>; yields {i32*}:ptr</i>
				3514	%ptr = alloca i32, align 1024 <i>; yields {i32*}:ptr</i>
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3515	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3516	</div>
Chris Lattner	2cbdc45	2005-11-06 08:02:57 +0000	[diff] [blame]	3517
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3518	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3519	<div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
				3520	Instruction</a> </div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3521	<div class="doc_text">
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3522	<h5>Syntax:</h5>
Christopher Lamb	2330e4d	2007-04-21 08:16:25 +0000	[diff] [blame]	3523	<pre> <result> = load <ty>* <pointer>[, align <alignment>]<br> <result> = volatile load <ty>* <pointer>[, align <alignment>]<br></pre>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3524	<h5>Overview:</h5>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3525	<p>The '<tt>load</tt>' instruction is used to read from memory.</p>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3526	<h5>Arguments:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3527	<p>The argument to the '<tt>load</tt>' instruction specifies the memory
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	3528	address from which to load. The pointer must point to a <a
Chris Lattner	e53e508	2004-06-03 22:57:15 +0000	[diff] [blame]	3529	href="#t_firstclass">first class</a> type. If the <tt>load</tt> is
John Criswell	0ec250c	2005-10-24 16:17:18 +0000	[diff] [blame]	3530	marked as <tt>volatile</tt>, then the optimizer is not allowed to modify
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3531	the number or order of execution of this <tt>load</tt> with other
				3532	volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
				3533	instructions. </p>
Chris Lattner	a31d1d7	2008-01-06 21:04:43 +0000	[diff] [blame]	3534	<p>
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3535	The optional constant "align" argument specifies the alignment of the operation
Chris Lattner	a31d1d7	2008-01-06 21:04:43 +0000	[diff] [blame]	3536	(that is, the alignment of the memory address). A value of 0 or an
				3537	omitted "align" argument means that the operation has the preferential
				3538	alignment for the target. It is the responsibility of the code emitter
				3539	to ensure that the alignment information is correct. Overestimating
				3540	the alignment results in an undefined behavior. Underestimating the
				3541	alignment may produce less efficient code. An alignment of 1 is always
				3542	safe.
				3543	</p>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3544	<h5>Semantics:</h5>
Duncan Sands	19527c6	2009-03-22 11:33:16 +0000	[diff] [blame]	3545	<p>The location of memory pointed to is loaded. If the value being loaded
				3546	is of scalar type then the number of bytes read does not exceed the minimum
				3547	number of bytes needed to hold all bits of the type. For example, loading an
				3548	<tt>i24</tt> reads at most three bytes. When loading a value of a type like
				3549	<tt>i20</tt> with a size that is not an integral number of bytes, the result
				3550	is undefined if the value was not originally written using a store of the
				3551	same type.</p>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3552	<h5>Examples:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3553	<pre> %ptr = <a href="#i_alloca">alloca</a> i32 <i>; yields {i32*}:ptr</i>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3554	<a
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3555	href="#i_store">store</a> i32 3, i32* %ptr <i>; yields {void}</i>
				3556	%val = load i32* %ptr <i>; yields {i32}:val = i32 3</i>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3557	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3558	</div>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3559	<!-- _______________________________________________________________________ -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3560	<div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
				3561	Instruction</a> </div>
Reid Spencer	035ab57	2006-11-09 21:18:01 +0000	[diff] [blame]	3562	<div class="doc_text">
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3563	<h5>Syntax:</h5>
Christopher Lamb	2330e4d	2007-04-21 08:16:25 +0000	[diff] [blame]	3564	<pre> store <ty> <value>, <ty>* <pointer>[, align <alignment>] <i>; yields {void}</i>
				3565	volatile store <ty> <value>, <ty>* <pointer>[, align <alignment>] <i>; yields {void}</i>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3566	</pre>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3567	<h5>Overview:</h5>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3568	<p>The '<tt>store</tt>' instruction is used to write to memory.</p>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3569	<h5>Arguments:</h5>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3570	<p>There are two arguments to the '<tt>store</tt>' instruction: a value
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	3571	to store and an address at which to store it. The type of the '<tt><pointer></tt>'
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3572	operand must be a pointer to the <a href="#t_firstclass">first class</a> type
				3573	of the '<tt><value></tt>'
John Criswell	c1f786c	2005-05-13 22:25:59 +0000	[diff] [blame]	3574	operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3575	optimizer is not allowed to modify the number or order of execution of
				3576	this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
				3577	href="#i_store">store</a></tt> instructions.</p>
Chris Lattner	a31d1d7	2008-01-06 21:04:43 +0000	[diff] [blame]	3578	<p>
Chris Lattner	4316dec	2008-04-02 00:38:26 +0000	[diff] [blame]	3579	The optional constant "align" argument specifies the alignment of the operation
Chris Lattner	a31d1d7	2008-01-06 21:04:43 +0000	[diff] [blame]	3580	(that is, the alignment of the memory address). A value of 0 or an
				3581	omitted "align" argument means that the operation has the preferential
				3582	alignment for the target. It is the responsibility of the code emitter
				3583	to ensure that the alignment information is correct. Overestimating
				3584	the alignment results in an undefined behavior. Underestimating the
				3585	alignment may produce less efficient code. An alignment of 1 is always
				3586	safe.
				3587	</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3588	<h5>Semantics:</h5>
				3589	<p>The contents of memory are updated to contain '<tt><value></tt>'
Duncan Sands	19527c6	2009-03-22 11:33:16 +0000	[diff] [blame]	3590	at the location specified by the '<tt><pointer></tt>' operand.
				3591	If '<tt><value></tt>' is of scalar type then the number of bytes
				3592	written does not exceed the minimum number of bytes needed to hold all
				3593	bits of the type. For example, storing an <tt>i24</tt> writes at most
				3594	three bytes. When writing a value of a type like <tt>i20</tt> with a
				3595	size that is not an integral number of bytes, it is unspecified what
				3596	happens to the extra bits that do not belong to the type, but they will
				3597	typically be overwritten.</p>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3598	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3599	<pre> %ptr = <a href="#i_alloca">alloca</a> i32 <i>; yields {i32*}:ptr</i>
Bill Wendling	8c6c72d	2007-10-22 05:10:05 +0000	[diff] [blame]	3600	store i32 3, i32* %ptr <i>; yields {void}</i>
				3601	%val = <a href="#i_load">load</a> i32* %ptr <i>; yields {i32}:val = i32 3</i>
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3602	</pre>
Reid Spencer	47ce179	2006-11-09 21:15:49 +0000	[diff] [blame]	3603	</div>
				3604
Chris Lattner	2b7d320	2002-05-06 03:03:22 +0000	[diff] [blame]	3605	<!-- _______________________________________________________________________ -->
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3606	<div class="doc_subsubsection">
				3607	<a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
				3608	</div>
				3609
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3610	<div class="doc_text">
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	3611	<h5>Syntax:</h5>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3612	<pre>
Matthijs Kooijman	e49d0bc	2008-10-13 13:44:15 +0000	[diff] [blame]	3613	<result> = getelementptr <pty>* <ptrval>{, <ty> <idx>}*
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3614	</pre>
				3615
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	3616	<h5>Overview:</h5>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3617
				3618	<p>
				3619	The '<tt>getelementptr</tt>' instruction is used to get the address of a
Matthijs Kooijman	e49d0bc	2008-10-13 13:44:15 +0000	[diff] [blame]	3620	subelement of an aggregate data structure. It performs address calculation only
				3621	and does not access memory.</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3622
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	3623	<h5>Arguments:</h5>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3624
Matthijs Kooijman	e49d0bc	2008-10-13 13:44:15 +0000	[diff] [blame]	3625	<p>The first argument is always a pointer, and forms the basis of the
				3626	calculation. The remaining arguments are indices, that indicate which of the
				3627	elements of the aggregate object are indexed. The interpretation of each index
				3628	is dependent on the type being indexed into. The first index always indexes the
				3629	pointer value given as the first argument, the second index indexes a value of
				3630	the type pointed to (not necessarily the value directly pointed to, since the
				3631	first index can be non-zero), etc. The first type indexed into must be a pointer
				3632	value, subsequent types can be arrays, vectors and structs. Note that subsequent
				3633	types being indexed into can never be pointers, since that would require loading
				3634	the pointer before continuing calculation.</p>
				3635
				3636	<p>The type of each index argument depends on the type it is indexing into.
				3637	When indexing into a (packed) structure, only <tt>i32</tt> integer
				3638	<b>constants</b> are allowed. When indexing into an array, pointer or vector,
Sanjiv Gupta	23c70f4	2009-04-27 03:21:00 +0000	[diff] [blame]	3639	integers of any width are allowed (also non-constants).</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3640
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3641	<p>For example, let's consider a C code fragment and how it gets
				3642	compiled to LLVM:</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3643
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3644	<div class="doc_code">
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3645	<pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3646	struct RT {
				3647	char A;
Chris Lattner	cabc846	2007-05-29 15:43:56 +0000	[diff] [blame]	3648	int B[10][20];
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3649	char C;
				3650	};
				3651	struct ST {
Chris Lattner	cabc846	2007-05-29 15:43:56 +0000	[diff] [blame]	3652	int X;
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3653	double Y;
				3654	struct RT Z;
				3655	};
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3656
Chris Lattner	cabc846	2007-05-29 15:43:56 +0000	[diff] [blame]	3657	int foo(struct ST s) {
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3658	return &s[1].Z.B[5][13];
				3659	}
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3660	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3661	</div>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3662
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3663	<p>The LLVM code generated by the GCC frontend is:</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3664
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3665	<div class="doc_code">
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3666	<pre>
Chris Lattner	e7886e4	2009-01-11 20:53:49 +0000	[diff] [blame]	3667	%RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8 }
				3668	%ST = <a href="#namedtypes">type</a> { i32, double, %RT }
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3669
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3670	define i32* %foo(%ST* %s) {
				3671	entry:
				3672	%reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
				3673	ret i32* %reg
				3674	}
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3675	</pre>
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	3676	</div>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3677
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	3678	<h5>Semantics:</h5>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3679
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3680	<p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3681	type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3682	}</tt>' type, a structure. The second index indexes into the third element of
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3683	the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
				3684	i8 }</tt>' type, another structure. The third index indexes into the second
				3685	element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3686	array. The two dimensions of the array are subscripted into, yielding an
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3687	'<tt>i32</tt>' type. The '<tt>getelementptr</tt>' instruction returns a pointer
				3688	to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3689
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	3690	<p>Note that it is perfectly legal to index partially through a
				3691	structure, returning a pointer to an inner element. Because of this,
				3692	the LLVM code for the given testcase is equivalent to:</p>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3693
				3694	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3695	define i32* %foo(%ST* %s) {
				3696	%t1 = getelementptr %ST* %s, i32 1 <i>; yields %ST*:%t1</i>
Jeff Cohen	6f1cc77	2007-04-22 01:17:39 +0000	[diff] [blame]	3697	%t2 = getelementptr %ST* %t1, i32 0, i32 2 <i>; yields %RT*:%t2</i>
				3698	%t3 = getelementptr %RT* %t2, i32 0, i32 1 <i>; yields [10 x [20 x i32]]*:%t3</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3699	%t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5 <i>; yields [20 x i32]*:%t4</i>
				3700	%t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13 <i>; yields i32*:%t5</i>
				3701	ret i32* %t5
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3702	}
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	3703	</pre>
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	3704
Chris Lattner	8c0e62c	2009-03-09 20:55:18 +0000	[diff] [blame]	3705	<p>Note that it is undefined to access an array out of bounds: array
				3706	and pointer indexes must always be within the defined bounds of the
				3707	array type when accessed with an instruction that dereferences the
				3708	pointer (e.g. a load or store instruction). The one exception for
				3709	this rule is zero length arrays. These arrays are defined to be
				3710	accessible as variable length arrays, which requires access beyond the
				3711	zero'th element.</p>
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	3712
Chris Lattner	884a970	2006-08-15 00:45:58 +0000	[diff] [blame]	3713	<p>The getelementptr instruction is often confusing. For some more insight
				3714	into how it works, see <a href="GetElementPtr.html">the getelementptr
				3715	FAQ</a>.</p>
				3716
Chris Lattner	7faa883	2002-04-14 06:13:44 +0000	[diff] [blame]	3717	<h5>Example:</h5>
Chris Lattner	e67a951	2005-06-24 17:22:57 +0000	[diff] [blame]	3718
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3719	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3720	<i>; yields [12 x i8]*:aptr</i>
Matthijs Kooijman	e49d0bc	2008-10-13 13:44:15 +0000	[diff] [blame]	3721	%aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
				3722	<i>; yields i8*:vptr</i>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	3723	%vptr = getelementptr {i32, <2 x i8>}* %svptr, i64 0, i32 1, i32 1
Matthijs Kooijman	e49d0bc	2008-10-13 13:44:15 +0000	[diff] [blame]	3724	<i>; yields i8*:eptr</i>
				3725	%eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
Sanjiv Gupta	9f805c2	2009-04-25 07:27:44 +0000	[diff] [blame]	3726	<i>; yields i32*:iptr</i>
Sanjiv Gupta	16ffa80	2009-04-24 16:38:13 +0000	[diff] [blame]	3727	%iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3728	</pre>
Chris Lattner	f74d5c7	2004-04-05 01:30:49 +0000	[diff] [blame]	3729	</div>
Reid Spencer	47ce179	2006-11-09 21:15:49 +0000	[diff] [blame]	3730
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	3731	<!-- ======================================================================= -->
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	3732	<div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3733	</div>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3734	<div class="doc_text">
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	3735	<p>The instructions in this category are the conversion instructions (casting)
				3736	which all take a single operand and a type. They perform various bit conversions
				3737	on the operand.</p>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	3738	</div>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3739
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	3740	<!-- _______________________________________________________________________ -->
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3741	<div class="doc_subsubsection">
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3742	<a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
				3743	</div>
				3744	<div class="doc_text">
				3745
				3746	<h5>Syntax:</h5>
				3747	<pre>
				3748	<result> = trunc <ty> <value> to <ty2> <i>; yields ty2</i>
				3749	</pre>
				3750
				3751	<h5>Overview:</h5>
				3752	<p>
				3753	The '<tt>trunc</tt>' instruction truncates its operand to the type <tt>ty2</tt>.
				3754	</p>
				3755
				3756	<h5>Arguments:</h5>
				3757	<p>
				3758	The '<tt>trunc</tt>' instruction takes a <tt>value</tt> to trunc, which must
				3759	be an <a href="#t_integer">integer</a> type, and a type that specifies the size
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	3760	and type of the result, which must be an <a href="#t_integer">integer</a>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3761	type. The bit size of <tt>value</tt> must be larger than the bit size of
				3762	<tt>ty2</tt>. Equal sized types are not allowed.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3763
				3764	<h5>Semantics:</h5>
				3765	<p>
				3766	The '<tt>trunc</tt>' instruction truncates the high order bits in <tt>value</tt>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3767	and converts the remaining bits to <tt>ty2</tt>. Since the source size must be
				3768	larger than the destination size, <tt>trunc</tt> cannot be a <i>no-op cast</i>.
				3769	It will always truncate bits.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3770
				3771	<h5>Example:</h5>
				3772	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3773	%X = trunc i32 257 to i8 <i>; yields i8:1</i>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	3774	%Y = trunc i32 123 to i1 <i>; yields i1:true</i>
				3775	%Y = trunc i32 122 to i1 <i>; yields i1:false</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3776	</pre>
				3777	</div>
				3778
				3779	<!-- _______________________________________________________________________ -->
				3780	<div class="doc_subsubsection">
				3781	<a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
				3782	</div>
				3783	<div class="doc_text">
				3784
				3785	<h5>Syntax:</h5>
				3786	<pre>
				3787	<result> = zext <ty> <value> to <ty2> <i>; yields ty2</i>
				3788	</pre>
				3789
				3790	<h5>Overview:</h5>
				3791	<p>The '<tt>zext</tt>' instruction zero extends its operand to type
				3792	<tt>ty2</tt>.</p>
				3793
				3794
				3795	<h5>Arguments:</h5>
				3796	<p>The '<tt>zext</tt>' instruction takes a value to cast, which must be of
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	3797	<a href="#t_integer">integer</a> type, and a type to cast it to, which must
				3798	also be of <a href="#t_integer">integer</a> type. The bit size of the
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3799	<tt>value</tt> must be smaller than the bit size of the destination type,
				3800	<tt>ty2</tt>.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3801
				3802	<h5>Semantics:</h5>
				3803	<p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
Chris Lattner	d1d2517	2007-05-24 19:13:27 +0000	[diff] [blame]	3804	bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3805
Reid Spencer	b592952	2007-01-12 15:46:11 +0000	[diff] [blame]	3806	<p>When zero extending from i1, the result will always be either 0 or 1.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3807
				3808	<h5>Example:</h5>
				3809	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3810	%X = zext i32 257 to i64 <i>; yields i64:257</i>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	3811	%Y = zext i1 true to i32 <i>; yields i32:1</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3812	</pre>
				3813	</div>
				3814
				3815	<!-- _______________________________________________________________________ -->
				3816	<div class="doc_subsubsection">
				3817	<a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
				3818	</div>
				3819	<div class="doc_text">
				3820
				3821	<h5>Syntax:</h5>
				3822	<pre>
				3823	<result> = sext <ty> <value> to <ty2> <i>; yields ty2</i>
				3824	</pre>
				3825
				3826	<h5>Overview:</h5>
				3827	<p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
				3828
				3829	<h5>Arguments:</h5>
				3830	<p>
				3831	The '<tt>sext</tt>' instruction takes a value to cast, which must be of
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	3832	<a href="#t_integer">integer</a> type, and a type to cast it to, which must
				3833	also be of <a href="#t_integer">integer</a> type. The bit size of the
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3834	<tt>value</tt> must be smaller than the bit size of the destination type,
				3835	<tt>ty2</tt>.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3836
				3837	<h5>Semantics:</h5>
				3838	<p>
				3839	The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
				3840	bit (highest order bit) of the <tt>value</tt> until it reaches the bit size of
Chris Lattner	d1d2517	2007-05-24 19:13:27 +0000	[diff] [blame]	3841	the type <tt>ty2</tt>.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3842
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	3843	<p>When sign extending from i1, the extension always results in -1 or 0.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3844
				3845	<h5>Example:</h5>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3846	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3847	%X = sext i8 -1 to i16 <i>; yields i16 :65535</i>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	3848	%Y = sext i1 true to i32 <i>; yields i32:-1</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3849	</pre>
				3850	</div>
				3851
				3852	<!-- _______________________________________________________________________ -->
				3853	<div class="doc_subsubsection">
Reid Spencer	3fa91b0	2006-11-09 21:48:10 +0000	[diff] [blame]	3854	<a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
				3855	</div>
				3856
				3857	<div class="doc_text">
				3858
				3859	<h5>Syntax:</h5>
				3860
				3861	<pre>
				3862	<result> = fptrunc <ty> <value> to <ty2> <i>; yields ty2</i>
				3863	</pre>
				3864
				3865	<h5>Overview:</h5>
				3866	<p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
				3867	<tt>ty2</tt>.</p>
				3868
				3869
				3870	<h5>Arguments:</h5>
				3871	<p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
				3872	point</a> value to cast and a <a href="#t_floating">floating point</a> type to
				3873	cast it to. The size of <tt>value</tt> must be larger than the size of
				3874	<tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
				3875	<i>no-op cast</i>.</p>
				3876
				3877	<h5>Semantics:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3878	<p> The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
				3879	<a href="#t_floating">floating point</a> type to a smaller
				3880	<a href="#t_floating">floating point</a> type. If the value cannot fit within
				3881	the destination type, <tt>ty2</tt>, then the results are undefined.</p>
Reid Spencer	3fa91b0	2006-11-09 21:48:10 +0000	[diff] [blame]	3882
				3883	<h5>Example:</h5>
				3884	<pre>
				3885	%X = fptrunc double 123.0 to float <i>; yields float:123.0</i>
				3886	%Y = fptrunc double 1.0E+300 to float <i>; yields undefined</i>
				3887	</pre>
				3888	</div>
				3889
				3890	<!-- _______________________________________________________________________ -->
				3891	<div class="doc_subsubsection">
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3892	<a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
				3893	</div>
				3894	<div class="doc_text">
				3895
				3896	<h5>Syntax:</h5>
				3897	<pre>
				3898	<result> = fpext <ty> <value> to <ty2> <i>; yields ty2</i>
				3899	</pre>
				3900
				3901	<h5>Overview:</h5>
				3902	<p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
				3903	floating point value.</p>
				3904
				3905	<h5>Arguments:</h5>
				3906	<p>The '<tt>fpext</tt>' instruction takes a
				3907	<a href="#t_floating">floating point</a> <tt>value</tt> to cast,
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3908	and a <a href="#t_floating">floating point</a> type to cast it to. The source
				3909	type must be smaller than the destination type.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3910
				3911	<h5>Semantics:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3912	<p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
Duncan Sands	8036ca4	2007-03-30 12:22:09 +0000	[diff] [blame]	3913	<a href="#t_floating">floating point</a> type to a larger
				3914	<a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3915	used to make a <i>no-op cast</i> because it always changes bits. Use
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	3916	<tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3917
				3918	<h5>Example:</h5>
				3919	<pre>
				3920	%X = fpext float 3.1415 to double <i>; yields double:3.1415</i>
				3921	%Y = fpext float 1.0 to float <i>; yields float:1.0 (no-op)</i>
				3922	</pre>
				3923	</div>
				3924
				3925	<!-- _______________________________________________________________________ -->
				3926	<div class="doc_subsubsection">
Reid Spencer	24d6da5	2007-01-21 00:29:26 +0000	[diff] [blame]	3927	<a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3928	</div>
				3929	<div class="doc_text">
				3930
				3931	<h5>Syntax:</h5>
				3932	<pre>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3933	<result> = fptoui <ty> <value> to <ty2> <i>; yields ty2</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3934	</pre>
				3935
				3936	<h5>Overview:</h5>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3937	<p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3938	unsigned integer equivalent of type <tt>ty2</tt>.
				3939	</p>
				3940
				3941	<h5>Arguments:</h5>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3942	<p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	3943	scalar or vector <a href="#t_floating">floating point</a> value, and a type
				3944	to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
				3945	type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
				3946	vector integer type with the same number of elements as <tt>ty</tt></p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3947
				3948	<h5>Semantics:</h5>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3949	<p> The '<tt>fptoui</tt>' instruction converts its
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3950	<a href="#t_floating">floating point</a> operand into the nearest (rounding
				3951	towards zero) unsigned integer value. If the value cannot fit in <tt>ty2</tt>,
				3952	the results are undefined.</p>
				3953
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3954	<h5>Example:</h5>
				3955	<pre>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3956	%X = fptoui double 123.0 to i32 <i>; yields i32:123</i>
Chris Lattner	8851904	2007-09-22 03:17:52 +0000	[diff] [blame]	3957	%Y = fptoui float 1.0E+300 to i1 <i>; yields undefined:1</i>
Reid Spencer	1539a1c	2007-07-31 14:40:14 +0000	[diff] [blame]	3958	%X = fptoui float 1.04E+17 to i8 <i>; yields undefined:1</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3959	</pre>
				3960	</div>
				3961
				3962	<!-- _______________________________________________________________________ -->
				3963	<div class="doc_subsubsection">
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3964	<a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3965	</div>
				3966	<div class="doc_text">
				3967
				3968	<h5>Syntax:</h5>
				3969	<pre>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3970	<result> = fptosi <ty> <value> to <ty2> <i>; yields ty2</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3971	</pre>
				3972
				3973	<h5>Overview:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3974	<p>The '<tt>fptosi</tt>' instruction converts
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3975	<a href="#t_floating">floating point</a> <tt>value</tt> to type <tt>ty2</tt>.
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3976	</p>
				3977
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	3978	<h5>Arguments:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3979	<p> The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	3980	scalar or vector <a href="#t_floating">floating point</a> value, and a type
				3981	to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
				3982	type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
				3983	vector integer type with the same number of elements as <tt>ty</tt></p>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3984
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	3985	<h5>Semantics:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	3986	<p>The '<tt>fptosi</tt>' instruction converts its
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3987	<a href="#t_floating">floating point</a> operand into the nearest (rounding
				3988	towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
				3989	the results are undefined.</p>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3990
Chris Lattner	33ba0d9	2001-07-09 00:26:23 +0000	[diff] [blame]	3991	<h5>Example:</h5>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	3992	<pre>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	3993	%X = fptosi double -123.0 to i32 <i>; yields i32:-123</i>
Chris Lattner	8851904	2007-09-22 03:17:52 +0000	[diff] [blame]	3994	%Y = fptosi float 1.0E-247 to i1 <i>; yields undefined:1</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	3995	%X = fptosi float 1.04E+17 to i8 <i>; yields undefined:1</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	3996	</pre>
				3997	</div>
				3998
				3999	<!-- _______________________________________________________________________ -->
				4000	<div class="doc_subsubsection">
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4001	<a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4002	</div>
				4003	<div class="doc_text">
				4004
				4005	<h5>Syntax:</h5>
				4006	<pre>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4007	<result> = uitofp <ty> <value> to <ty2> <i>; yields ty2</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4008	</pre>
				4009
				4010	<h5>Overview:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4011	<p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4012	integer and converts that value to the <tt>ty2</tt> type.</p>
				4013
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4014	<h5>Arguments:</h5>
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	4015	<p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
				4016	scalar or vector <a href="#t_integer">integer</a> value, and a type to cast it
				4017	to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
				4018	type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
				4019	floating point type with the same number of elements as <tt>ty</tt></p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4020
				4021	<h5>Semantics:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4022	<p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4023	integer quantity and converts it to the corresponding floating point value. If
Jeff Cohen	cb75731	2007-04-22 14:56:37 +0000	[diff] [blame]	4024	the value cannot fit in the floating point value, the results are undefined.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4025
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4026	<h5>Example:</h5>
				4027	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	4028	%X = uitofp i32 257 to float <i>; yields float:257.0</i>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4029	%Y = uitofp i8 -1 to double <i>; yields double:255.0</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4030	</pre>
				4031	</div>
				4032
				4033	<!-- _______________________________________________________________________ -->
				4034	<div class="doc_subsubsection">
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4035	<a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4036	</div>
				4037	<div class="doc_text">
				4038
				4039	<h5>Syntax:</h5>
				4040	<pre>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4041	<result> = sitofp <ty> <value> to <ty2> <i>; yields ty2</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4042	</pre>
				4043
				4044	<h5>Overview:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4045	<p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4046	integer and converts that value to the <tt>ty2</tt> type.</p>
				4047
				4048	<h5>Arguments:</h5>
Nate Begeman	b348d18	2007-11-17 03:58:34 +0000	[diff] [blame]	4049	<p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
				4050	scalar or vector <a href="#t_integer">integer</a> value, and a type to cast it
				4051	to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
				4052	type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
				4053	floating point type with the same number of elements as <tt>ty</tt></p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4054
				4055	<h5>Semantics:</h5>
Reid Spencer	d444879	2006-11-09 23:03:26 +0000	[diff] [blame]	4056	<p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4057	integer quantity and converts it to the corresponding floating point value. If
Jeff Cohen	cb75731	2007-04-22 14:56:37 +0000	[diff] [blame]	4058	the value cannot fit in the floating point value, the results are undefined.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4059
				4060	<h5>Example:</h5>
				4061	<pre>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	4062	%X = sitofp i32 257 to float <i>; yields float:257.0</i>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4063	%Y = sitofp i8 -1 to double <i>; yields double:-1.0</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4064	</pre>
				4065	</div>
				4066
				4067	<!-- _______________________________________________________________________ -->
				4068	<div class="doc_subsubsection">
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4069	<a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
				4070	</div>
				4071	<div class="doc_text">
				4072
				4073	<h5>Syntax:</h5>
				4074	<pre>
				4075	<result> = ptrtoint <ty> <value> to <ty2> <i>; yields ty2</i>
				4076	</pre>
				4077
				4078	<h5>Overview:</h5>
				4079	<p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
				4080	the integer type <tt>ty2</tt>.</p>
				4081
				4082	<h5>Arguments:</h5>
				4083	<p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
Duncan Sands	8036ca4	2007-03-30 12:22:09 +0000	[diff] [blame]	4084	must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4085	<tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4086
				4087	<h5>Semantics:</h5>
				4088	<p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
				4089	<tt>ty2</tt> by interpreting the pointer value as an integer and either
				4090	truncating or zero extending that value to the size of the integer type. If
				4091	<tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
				4092	<tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4093	are the same size, then nothing is done (<i>no-op cast</i>) other than a type
				4094	change.</p>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4095
				4096	<h5>Example:</h5>
				4097	<pre>
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4098	%X = ptrtoint i32* %X to i8 <i>; yields truncation on 32-bit architecture</i>
				4099	%Y = ptrtoint i32* %x to i64 <i>; yields zero extension on 32-bit architecture</i>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4100	</pre>
				4101	</div>
				4102
				4103	<!-- _______________________________________________________________________ -->
				4104	<div class="doc_subsubsection">
				4105	<a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
				4106	</div>
				4107	<div class="doc_text">
				4108
				4109	<h5>Syntax:</h5>
				4110	<pre>
				4111	<result> = inttoptr <ty> <value> to <ty2> <i>; yields ty2</i>
				4112	</pre>
				4113
				4114	<h5>Overview:</h5>
				4115	<p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to
				4116	a pointer type, <tt>ty2</tt>.</p>
				4117
				4118	<h5>Arguments:</h5>
Duncan Sands	8036ca4	2007-03-30 12:22:09 +0000	[diff] [blame]	4119	<p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4120	value to cast, and a type to cast it to, which must be a
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4121	<a href="#t_pointer">pointer</a> type.</p>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4122
				4123	<h5>Semantics:</h5>
				4124	<p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
				4125	<tt>ty2</tt> by applying either a zero extension or a truncation depending on
				4126	the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
				4127	size of a pointer then a truncation is done. If <tt>value</tt> is smaller than
				4128	the size of a pointer then a zero extension is done. If they are the same size,
				4129	nothing is done (<i>no-op cast</i>).</p>
				4130
				4131	<h5>Example:</h5>
				4132	<pre>
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4133	%X = inttoptr i32 255 to i32* <i>; yields zero extension on 64-bit architecture</i>
				4134	%X = inttoptr i32 255 to i32* <i>; yields no-op on 32-bit architecture</i>
				4135	%Y = inttoptr i64 0 to i32* <i>; yields truncation on 32-bit architecture</i>
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4136	</pre>
				4137	</div>
				4138
				4139	<!-- _______________________________________________________________________ -->
				4140	<div class="doc_subsubsection">
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	4141	<a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4142	</div>
				4143	<div class="doc_text">
				4144
				4145	<h5>Syntax:</h5>
				4146	<pre>
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	4147	<result> = bitcast <ty> <value> to <ty2> <i>; yields ty2</i>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4148	</pre>
				4149
				4150	<h5>Overview:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4151
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	4152	<p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4153	<tt>ty2</tt> without changing any bits.</p>
				4154
				4155	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4156
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	4157	<p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be
Dan Gohman	500233a	2008-09-08 16:45:59 +0000	[diff] [blame]	4158	a non-aggregate first class value, and a type to cast it to, which must also be
				4159	a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes of
				4160	<tt>value</tt>
Reid Spencer	19b569f	2007-01-09 20:08:58 +0000	[diff] [blame]	4161	and the destination type, <tt>ty2</tt>, must be identical. If the source
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4162	type is a pointer, the destination type must also be a pointer. This
				4163	instruction supports bitwise conversion of vectors to integers and to vectors
				4164	of other types (as long as they have the same size).</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4165
				4166	<h5>Semantics:</h5>
Reid Spencer	5c0ef47	2006-11-11 23:08:07 +0000	[diff] [blame]	4167	<p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
Reid Spencer	7267925	2006-11-11 21:00:47 +0000	[diff] [blame]	4168	<tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
				4169	this conversion. The conversion is done as if the <tt>value</tt> had been
				4170	stored to memory and read back as type <tt>ty2</tt>. Pointer types may only be
				4171	converted to other pointer types with this instruction. To convert pointers to
				4172	other types, use the <a href="#i_inttoptr">inttoptr</a> or
				4173	<a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
Reid Spencer	9dee3ac	2006-11-08 01:11:31 +0000	[diff] [blame]	4174
				4175	<h5>Example:</h5>
				4176	<pre>
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4177	%X = bitcast i8 255 to i8 <i>; yields i8 :-1</i>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	4178	%Y = bitcast i32* %x to sint* <i>; yields sint*:%x</i>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4179	%Z = bitcast <2 x int> %V to i64; <i>; yields i64: %V</i>
Chris Lattner	33ba0d9	2001-07-09 00:26:23 +0000	[diff] [blame]	4180	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4181	</div>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4182
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4183	<!-- ======================================================================= -->
				4184	<div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
				4185	<div class="doc_text">
				4186	<p>The instructions in this category are the "miscellaneous"
				4187	instructions, which defy better classification.</p>
				4188	</div>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4189
				4190	<!-- _______________________________________________________________________ -->
				4191	<div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
				4192	</div>
				4193	<div class="doc_text">
				4194	<h5>Syntax:</h5>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4195	<pre> <result> = icmp <cond> <ty> <op1>, <op2> <i>; yields {i1} or {<N x i1>}:result</i>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4196	</pre>
				4197	<h5>Overview:</h5>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4198	<p>The '<tt>icmp</tt>' instruction returns a boolean value or
				4199	a vector of boolean values based on comparison
				4200	of its two integer, integer vector, or pointer operands.</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4201	<h5>Arguments:</h5>
				4202	<p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4203	the condition code indicating the kind of comparison to perform. It is not
				4204	a value, just a keyword. The possible condition code are:
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4205	</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4206	<ol>
				4207	<li><tt>eq</tt>: equal</li>
				4208	<li><tt>ne</tt>: not equal </li>
				4209	<li><tt>ugt</tt>: unsigned greater than</li>
				4210	<li><tt>uge</tt>: unsigned greater or equal</li>
				4211	<li><tt>ult</tt>: unsigned less than</li>
				4212	<li><tt>ule</tt>: unsigned less or equal</li>
				4213	<li><tt>sgt</tt>: signed greater than</li>
				4214	<li><tt>sge</tt>: signed greater or equal</li>
				4215	<li><tt>slt</tt>: signed less than</li>
				4216	<li><tt>sle</tt>: signed less or equal</li>
				4217	</ol>
Chris Lattner	3b19d65	2007-01-15 01:54:13 +0000	[diff] [blame]	4218	<p>The remaining two arguments must be <a href="#t_integer">integer</a> or
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4219	<a href="#t_pointer">pointer</a>
				4220	or integer <a href="#t_vector">vector</a> typed.
				4221	They must also be identical types.</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4222	<h5>Semantics:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4223	<p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4224	the condition code given as <tt>cond</tt>. The comparison performed always
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4225	yields either an <a href="#t_primitive"><tt>i1</tt></a> or vector of <tt>i1</tt> result, as follows:
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4226	</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4227	<ol>
				4228	<li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
				4229	<tt>false</tt> otherwise. No sign interpretation is necessary or performed.
				4230	</li>
				4231	<li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4232	<tt>false</tt> otherwise. No sign interpretation is necessary or performed.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4233	<li><tt>ugt</tt>: interprets the operands as unsigned values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4234	<tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4235	<li><tt>uge</tt>: interprets the operands as unsigned values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4236	<tt>true</tt> if <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4237	<li><tt>ult</tt>: interprets the operands as unsigned values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4238	<tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4239	<li><tt>ule</tt>: interprets the operands as unsigned values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4240	<tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4241	<li><tt>sgt</tt>: interprets the operands as signed values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4242	<tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4243	<li><tt>sge</tt>: interprets the operands as signed values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4244	<tt>true</tt> if <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4245	<li><tt>slt</tt>: interprets the operands as signed values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4246	<tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4247	<li><tt>sle</tt>: interprets the operands as signed values and yields
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4248	<tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4249	</ol>
				4250	<p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4251	values are compared as if they were integers.</p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4252	<p>If the operands are integer vectors, then they are compared
				4253	element by element. The result is an <tt>i1</tt> vector with
				4254	the same number of elements as the values being compared.
				4255	Otherwise, the result is an <tt>i1</tt>.
				4256	</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4257
				4258	<h5>Example:</h5>
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	4259	<pre> <result> = icmp eq i32 4, 5 <i>; yields: result=false</i>
				4260	<result> = icmp ne float* %X, %X <i>; yields: result=false</i>
				4261	<result> = icmp ult i16 4, 5 <i>; yields: result=true</i>
				4262	<result> = icmp sgt i16 4, 5 <i>; yields: result=false</i>
				4263	<result> = icmp ule i16 -4, 5 <i>; yields: result=false</i>
				4264	<result> = icmp sge i16 4, 5 <i>; yields: result=false</i>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4265	</pre>
Dan Gohman	c766f72	2009-01-22 01:39:38 +0000	[diff] [blame]	4266
				4267	<p>Note that the code generator does not yet support vector types with
				4268	the <tt>icmp</tt> instruction.</p>
				4269
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4270	</div>
				4271
				4272	<!-- _______________________________________________________________________ -->
				4273	<div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
				4274	</div>
				4275	<div class="doc_text">
				4276	<h5>Syntax:</h5>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4277	<pre> <result> = fcmp <cond> <ty> <op1>, <op2> <i>; yields {i1} or {<N x i1>}:result</i>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4278	</pre>
				4279	<h5>Overview:</h5>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4280	<p>The '<tt>fcmp</tt>' instruction returns a boolean value
				4281	or vector of boolean values based on comparison
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4282	of its operands.</p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4283	<p>
				4284	If the operands are floating point scalars, then the result
				4285	type is a boolean (<a href="#t_primitive"><tt>i1</tt></a>).
				4286	</p>
				4287	<p>If the operands are floating point vectors, then the result type
				4288	is a vector of boolean with the same number of elements as the
				4289	operands being compared.</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4290	<h5>Arguments:</h5>
				4291	<p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4292	the condition code indicating the kind of comparison to perform. It is not
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4293	a value, just a keyword. The possible condition code are:</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4294	<ol>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4295	<li><tt>false</tt>: no comparison, always returns false</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4296	<li><tt>oeq</tt>: ordered and equal</li>
				4297	<li><tt>ogt</tt>: ordered and greater than </li>
				4298	<li><tt>oge</tt>: ordered and greater than or equal</li>
				4299	<li><tt>olt</tt>: ordered and less than </li>
				4300	<li><tt>ole</tt>: ordered and less than or equal</li>
				4301	<li><tt>one</tt>: ordered and not equal</li>
				4302	<li><tt>ord</tt>: ordered (no nans)</li>
				4303	<li><tt>ueq</tt>: unordered or equal</li>
				4304	<li><tt>ugt</tt>: unordered or greater than </li>
				4305	<li><tt>uge</tt>: unordered or greater than or equal</li>
				4306	<li><tt>ult</tt>: unordered or less than </li>
				4307	<li><tt>ule</tt>: unordered or less than or equal</li>
				4308	<li><tt>une</tt>: unordered or not equal</li>
				4309	<li><tt>uno</tt>: unordered (either nans)</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4310	<li><tt>true</tt>: no comparison, always returns true</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4311	</ol>
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4312	<p><i>Ordered</i> means that neither operand is a QNAN while
Reid Spencer	93a4985	2006-12-06 07:08:07 +0000	[diff] [blame]	4313	<i>unordered</i> means that either operand may be a QNAN.</p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4314	<p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be
				4315	either a <a href="#t_floating">floating point</a> type
				4316	or a <a href="#t_vector">vector</a> of floating point type.
				4317	They must have identical types.</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4318	<h5>Semantics:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4319	<p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4320	according to the condition code given as <tt>cond</tt>.
				4321	If the operands are vectors, then the vectors are compared
				4322	element by element.
				4323	Each comparison performed
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4324	always yields an <a href="#t_primitive">i1</a> result, as follows:</p>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4325	<ol>
				4326	<li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4327	<li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4328	<tt>op1</tt> is equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4329	<li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4330	<tt>op1</tt> is greather than <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4331	<li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4332	<tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4333	<li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4334	<tt>op1</tt> is less than <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4335	<li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4336	<tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4337	<li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4338	<tt>op1</tt> is not equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4339	<li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
				4340	<li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4341	<tt>op1</tt> is equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4342	<li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4343	<tt>op1</tt> is greater than <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4344	<li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4345	<tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4346	<li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4347	<tt>op1</tt> is less than <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4348	<li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4349	<tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4350	<li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4351	<tt>op1</tt> is not equal to <tt>op2</tt>.</li>
Reid Spencer	b7f2628	2006-11-19 03:00:14 +0000	[diff] [blame]	4352	<li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4353	<li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
				4354	</ol>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4355
				4356	<h5>Example:</h5>
				4357	<pre> <result> = fcmp oeq float 4.0, 5.0 <i>; yields: result=false</i>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4358	<result> = fcmp one float 4.0, 5.0 <i>; yields: result=true</i>
				4359	<result> = fcmp olt float 4.0, 5.0 <i>; yields: result=true</i>
				4360	<result> = fcmp ueq double 1.0, 2.0 <i>; yields: result=false</i>
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4361	</pre>
Dan Gohman	c766f72	2009-01-22 01:39:38 +0000	[diff] [blame]	4362
				4363	<p>Note that the code generator does not yet support vector types with
				4364	the <tt>fcmp</tt> instruction.</p>
				4365
Reid Spencer	f3a70a6	2006-11-18 21:50:54 +0000	[diff] [blame]	4366	</div>
				4367
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4368	<!-- _______________________________________________________________________ -->
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4369	<div class="doc_subsubsection">
				4370	<a name="i_vicmp">'<tt>vicmp</tt>' Instruction</a>
				4371	</div>
				4372	<div class="doc_text">
				4373	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4374	<pre> <result> = vicmp <cond> <ty> <op1>, <op2> <i>; yields {ty}:result</i>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4375	</pre>
				4376	<h5>Overview:</h5>
				4377	<p>The '<tt>vicmp</tt>' instruction returns an integer vector value based on
				4378	element-wise comparison of its two integer vector operands.</p>
				4379	<h5>Arguments:</h5>
				4380	<p>The '<tt>vicmp</tt>' instruction takes three operands. The first operand is
				4381	the condition code indicating the kind of comparison to perform. It is not
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4382	a value, just a keyword. The possible condition code are:</p>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4383	<ol>
				4384	<li><tt>eq</tt>: equal</li>
				4385	<li><tt>ne</tt>: not equal </li>
				4386	<li><tt>ugt</tt>: unsigned greater than</li>
				4387	<li><tt>uge</tt>: unsigned greater or equal</li>
				4388	<li><tt>ult</tt>: unsigned less than</li>
				4389	<li><tt>ule</tt>: unsigned less or equal</li>
				4390	<li><tt>sgt</tt>: signed greater than</li>
				4391	<li><tt>sge</tt>: signed greater or equal</li>
				4392	<li><tt>slt</tt>: signed less than</li>
				4393	<li><tt>sle</tt>: signed less or equal</li>
				4394	</ol>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4395	<p>The remaining two arguments must be <a href="#t_vector">vector</a> or
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4396	<a href="#t_integer">integer</a> typed. They must also be identical types.</p>
				4397	<h5>Semantics:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4398	<p>The '<tt>vicmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4399	according to the condition code given as <tt>cond</tt>. The comparison yields a
				4400	<a href="#t_vector">vector</a> of <a href="#t_integer">integer</a> result, of
				4401	identical type as the values being compared. The most significant bit in each
				4402	element is 1 if the element-wise comparison evaluates to true, and is 0
				4403	otherwise. All other bits of the result are undefined. The condition codes
				4404	are evaluated identically to the <a href="#i_icmp">'<tt>icmp</tt>'
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4405	instruction</a>.</p>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4406
				4407	<h5>Example:</h5>
				4408	<pre>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4409	<result> = vicmp eq <2 x i32> < i32 4, i32 0>, < i32 5, i32 0> <i>; yields: result=<2 x i32> < i32 0, i32 -1 ></i>
				4410	<result> = vicmp ult <2 x i8 > < i8 1, i8 2>, < i8 2, i8 2 > <i>; yields: result=<2 x i8> < i8 -1, i8 0 ></i>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4411	</pre>
				4412	</div>
				4413
				4414	<!-- _______________________________________________________________________ -->
				4415	<div class="doc_subsubsection">
				4416	<a name="i_vfcmp">'<tt>vfcmp</tt>' Instruction</a>
				4417	</div>
				4418	<div class="doc_text">
				4419	<h5>Syntax:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4420	<pre> <result> = vfcmp <cond> <ty> <op1>, <op2></pre>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4421	<h5>Overview:</h5>
				4422	<p>The '<tt>vfcmp</tt>' instruction returns an integer vector value based on
				4423	element-wise comparison of its two floating point vector operands. The output
				4424	elements have the same width as the input elements.</p>
				4425	<h5>Arguments:</h5>
				4426	<p>The '<tt>vfcmp</tt>' instruction takes three operands. The first operand is
				4427	the condition code indicating the kind of comparison to perform. It is not
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4428	a value, just a keyword. The possible condition code are:</p>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4429	<ol>
				4430	<li><tt>false</tt>: no comparison, always returns false</li>
				4431	<li><tt>oeq</tt>: ordered and equal</li>
				4432	<li><tt>ogt</tt>: ordered and greater than </li>
				4433	<li><tt>oge</tt>: ordered and greater than or equal</li>
				4434	<li><tt>olt</tt>: ordered and less than </li>
				4435	<li><tt>ole</tt>: ordered and less than or equal</li>
				4436	<li><tt>one</tt>: ordered and not equal</li>
				4437	<li><tt>ord</tt>: ordered (no nans)</li>
				4438	<li><tt>ueq</tt>: unordered or equal</li>
				4439	<li><tt>ugt</tt>: unordered or greater than </li>
				4440	<li><tt>uge</tt>: unordered or greater than or equal</li>
				4441	<li><tt>ult</tt>: unordered or less than </li>
				4442	<li><tt>ule</tt>: unordered or less than or equal</li>
				4443	<li><tt>une</tt>: unordered or not equal</li>
				4444	<li><tt>uno</tt>: unordered (either nans)</li>
				4445	<li><tt>true</tt>: no comparison, always returns true</li>
				4446	</ol>
				4447	<p>The remaining two arguments must be <a href="#t_vector">vector</a> of
				4448	<a href="#t_floating">floating point</a> typed. They must also be identical
				4449	types.</p>
				4450	<h5>Semantics:</h5>
Gabor Greif	fb224a2	2008-08-07 21:46:00 +0000	[diff] [blame]	4451	<p>The '<tt>vfcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4452	according to the condition code given as <tt>cond</tt>. The comparison yields a
				4453	<a href="#t_vector">vector</a> of <a href="#t_integer">integer</a> result, with
				4454	an identical number of elements as the values being compared, and each element
				4455	having identical with to the width of the floating point elements. The most
				4456	significant bit in each element is 1 if the element-wise comparison evaluates to
				4457	true, and is 0 otherwise. All other bits of the result are undefined. The
				4458	condition codes are evaluated identically to the
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4459	<a href="#i_fcmp">'<tt>fcmp</tt>' instruction</a>.</p>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4460
				4461	<h5>Example:</h5>
				4462	<pre>
Chris Lattner	50ad45c	2008-10-13 16:55:18 +0000	[diff] [blame]	4463	<i>; yields: result=<2 x i32> < i32 0, i32 -1 ></i>
				4464	<result> = vfcmp oeq <2 x float> < float 4, float 0 >, < float 5, float 0 >
				4465
				4466	<i>; yields: result=<2 x i64> < i64 -1, i64 0 ></i>
				4467	<result> = vfcmp ult <2 x double> < double 1, double 2 >, < double 2, double 2>
Nate Begeman	ac80ade	2008-05-12 19:01:56 +0000	[diff] [blame]	4468	</pre>
				4469	</div>
				4470
				4471	<!-- _______________________________________________________________________ -->
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4472	<div class="doc_subsubsection">
				4473	<a name="i_phi">'<tt>phi</tt>' Instruction</a>
				4474	</div>
				4475
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4476	<div class="doc_text">
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4477
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4478	<h5>Syntax:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4479
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4480	<pre> <result> = phi <ty> [ <val0>, <label0>], ...<br></pre>
				4481	<h5>Overview:</h5>
				4482	<p>The '<tt>phi</tt>' instruction is used to implement the φ node in
				4483	the SSA graph representing the function.</p>
				4484	<h5>Arguments:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4485
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4486	<p>The type of the incoming values is specified with the first type
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4487	field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
				4488	as arguments, with one pair for each predecessor basic block of the
				4489	current block. Only values of <a href="#t_firstclass">first class</a>
				4490	type may be used as the value arguments to the PHI node. Only labels
				4491	may be used as the label arguments.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4492
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4493	<p>There must be no non-phi instructions between the start of a basic
				4494	block and the PHI instructions: i.e. PHI instructions must be first in
				4495	a basic block.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4496
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4497	<h5>Semantics:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4498
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4499	<p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
				4500	specified by the pair corresponding to the predecessor basic block that executed
				4501	just prior to the current block.</p>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4502
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4503	<h5>Example:</h5>
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4504	<pre>
				4505	Loop: ; Infinite loop that counts from 0 on up...
				4506	%indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
				4507	%nextindvar = add i32 %indvar, 1
				4508	br label %Loop
				4509	</pre>
Reid Spencer	2fd21e6	2006-11-08 01:18:52 +0000	[diff] [blame]	4510	</div>
				4511
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4512	<!-- _______________________________________________________________________ -->
				4513	<div class="doc_subsubsection">
				4514	<a name="i_select">'<tt>select</tt>' Instruction</a>
				4515	</div>
				4516
				4517	<div class="doc_text">
				4518
				4519	<h5>Syntax:</h5>
				4520
				4521	<pre>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4522	<result> = select <i>selty</i> <cond>, <ty> <val1>, <ty> <val2> <i>; yields ty</i>
				4523
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4524	<i>selty</i> is either i1 or {<N x i1>}
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4525	</pre>
				4526
				4527	<h5>Overview:</h5>
				4528
				4529	<p>
				4530	The '<tt>select</tt>' instruction is used to choose one value based on a
				4531	condition, without branching.
				4532	</p>
				4533
				4534
				4535	<h5>Arguments:</h5>
				4536
				4537	<p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4538	The '<tt>select</tt>' instruction requires an 'i1' value or
				4539	a vector of 'i1' values indicating the
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4540	condition, and two values of the same <a href="#t_firstclass">first class</a>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4541	type. If the val1/val2 are vectors and
				4542	the condition is a scalar, then entire vectors are selected, not
Chris Lattner	5568e94	2008-05-20 20:48:21 +0000	[diff] [blame]	4543	individual elements.
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4544	</p>
				4545
				4546	<h5>Semantics:</h5>
				4547
				4548	<p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4549	If the condition is an i1 and it evaluates to 1, the instruction returns the first
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	4550	value argument; otherwise, it returns the second value argument.
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4551	</p>
Dan Gohman	f72fb67	2008-09-09 01:02:47 +0000	[diff] [blame]	4552	<p>
				4553	If the condition is a vector of i1, then the value arguments must
				4554	be vectors of the same size, and the selection is done element
				4555	by element.
				4556	</p>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4557
				4558	<h5>Example:</h5>
				4559
				4560	<pre>
Reid Spencer	c78f337	2007-01-12 03:35:51 +0000	[diff] [blame]	4561	%X = select i1 true, i8 17, i8 42 <i>; yields i8:17</i>
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4562	</pre>
Dan Gohman	c766f72	2009-01-22 01:39:38 +0000	[diff] [blame]	4563
				4564	<p>Note that the code generator does not yet support conditions
				4565	with vector type.</p>
				4566
Chris Lattner	cc37aae	2004-03-12 05:50:16 +0000	[diff] [blame]	4567	</div>
				4568
Robert Bocchino	05ccd70	2006-01-15 20:48:27 +0000	[diff] [blame]	4569
				4570	<!-- _______________________________________________________________________ -->
				4571	<div class="doc_subsubsection">
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4572	<a name="i_call">'<tt>call</tt>' Instruction</a>
				4573	</div>
				4574
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4575	<div class="doc_text">
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4576
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	4577	<h5>Syntax:</h5>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4578	<pre>
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	4579	<result> = [tail] call [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] <ty> [<fnty>*] <fnptrval>(<function args>) [<a href="#fnattrs">fn attrs</a>]
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4580	</pre>
				4581
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	4582	<h5>Overview:</h5>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4583
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4584	<p>The '<tt>call</tt>' instruction represents a simple function call.</p>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4585
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	4586	<h5>Arguments:</h5>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4587
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4588	<p>This instruction requires several arguments:</p>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4589
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	4590	<ol>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4591	<li>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	4592	<p>The optional "tail" marker indicates whether the callee function accesses
				4593	any allocas or varargs in the caller. If the "tail" marker is present, the
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4594	function call is eligible for tail call optimization. Note that calls may
				4595	be marked "tail" even if they do not occur before a <a
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4596	href="#i_ret"><tt>ret</tt></a> instruction.</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4597	</li>
				4598	<li>
Duncan Sands	8036ca4	2007-03-30 12:22:09 +0000	[diff] [blame]	4599	<p>The optional "cconv" marker indicates which <a href="#callingconv">calling
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	4600	convention</a> the call should use. If none is specified, the call defaults
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4601	to using C calling conventions.</p>
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	4602	</li>
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	4603
				4604	<li>
				4605	<p>The optional <a href="#paramattrs">Parameter Attributes</a> list for
				4606	return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>',
				4607	and '<tt>inreg</tt>' attributes are valid here.</p>
				4608	</li>
				4609
Chris Lattner	bad10ee	2005-05-06 22:57:40 +0000	[diff] [blame]	4610	<li>
Nick Lewycky	db7e3c9	2007-09-08 13:57:50 +0000	[diff] [blame]	4611	<p>'<tt>ty</tt>': the type of the call instruction itself which is also
				4612	the type of the return value. Functions that return no value are marked
				4613	<tt><a href="#t_void">void</a></tt>.</p>
				4614	</li>
				4615	<li>
				4616	<p>'<tt>fnty</tt>': shall be the signature of the pointer to function
				4617	value being invoked. The argument types must match the types implied by
				4618	this signature. This type can be omitted if the function is not varargs
				4619	and if the function type does not return a pointer to a function.</p>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4620	</li>
				4621	<li>
				4622	<p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
				4623	be invoked. In most cases, this is a direct function invocation, but
				4624	indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	4625	to function value.</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4626	</li>
				4627	<li>
				4628	<p>'<tt>function args</tt>': argument list whose types match the
Reid Spencer	a7e302a	2005-05-01 22:22:57 +0000	[diff] [blame]	4629	function signature argument types. All arguments must be of
				4630	<a href="#t_firstclass">first class</a> type. If the function signature
				4631	indicates the function accepts a variable number of arguments, the extra
				4632	arguments can be specified.</p>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4633	</li>
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	4634	<li>
Devang Patel	307e8ab	2008-10-07 17:48:33 +0000	[diff] [blame]	4635	<p>The optional <a href="#fnattrs">function attributes</a> list. Only
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	4636	'<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
				4637	'<tt>readnone</tt>' attributes are valid here.</p>
				4638	</li>
Chris Lattner	6536cfe	2002-05-06 22:08:29 +0000	[diff] [blame]	4639	</ol>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4640
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	4641	<h5>Semantics:</h5>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4642
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4643	<p>The '<tt>call</tt>' instruction is used to cause control flow to
				4644	transfer to a specified function, with its incoming arguments bound to
				4645	the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
				4646	instruction in the called function, control flow continues with the
				4647	instruction after the function call, and the return value of the
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4648	function is bound to the result argument.</p>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4649
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	4650	<h5>Example:</h5>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4651
				4652	<pre>
Nick Lewycky	db7e3c9	2007-09-08 13:57:50 +0000	[diff] [blame]	4653	%retval = call i32 @test(i32 %argc)
Chris Lattner	772fccf	2008-03-21 17:24:17 +0000	[diff] [blame]	4654	call i32 (i8 , ...) @printf(i8 * %msg, i32 12, i8 42) <i>; yields i32</i>
				4655	%X = tail call i32 @foo() <i>; yields i32</i>
				4656	%Y = tail call <a href="#callingconv">fastcc</a> i32 @foo() <i>; yields i32</i>
				4657	call void %foo(i8 97 signext)
Devang Patel	c3fc6df	2008-03-10 20:49:15 +0000	[diff] [blame]	4658
				4659	%struct.A = type { i32, i8 }
Devang Patel	f642f47	2008-10-06 18:50:38 +0000	[diff] [blame]	4660	%r = call %struct.A @foo() <i>; yields { 32, i8 }</i>
Dan Gohman	b1e6b96	2008-10-04 19:00:07 +0000	[diff] [blame]	4661	%gr = extractvalue %struct.A %r, 0 <i>; yields i32</i>
				4662	%gr1 = extractvalue %struct.A %r, 1 <i>; yields i8</i>
Chris Lattner	85a350f	2008-10-08 06:26:11 +0000	[diff] [blame]	4663	%Z = call void @foo() noreturn <i>; indicates that %foo never returns normally</i>
Matthijs Kooijman	cb73d19	2008-10-07 10:03:45 +0000	[diff] [blame]	4664	%ZZ = call zeroext i32 @bar() <i>; Return value is %zero extended</i>
Chris Lattner	2bff524	2005-05-06 05:47:36 +0000	[diff] [blame]	4665	</pre>
				4666
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4667	</div>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4668
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4669	<!-- _______________________________________________________________________ -->
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4670	<div class="doc_subsubsection">
Chris Lattner	fb6977d	2006-01-13 23:26:01 +0000	[diff] [blame]	4671	<a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4672	</div>
				4673
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4674	<div class="doc_text">
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4675
Chris Lattner	8d1a81d	2003-10-18 05:51:36 +0000	[diff] [blame]	4676	<h5>Syntax:</h5>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4677
				4678	<pre>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4679	<resultval> = va_arg <va_list*> <arglist>, <argty>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4680	</pre>
				4681
Chris Lattner	8d1a81d	2003-10-18 05:51:36 +0000	[diff] [blame]	4682	<h5>Overview:</h5>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4683
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4684	<p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4685	the "variable argument" area of a function call. It is used to implement the
				4686	<tt>va_arg</tt> macro in C.</p>
				4687
Chris Lattner	8d1a81d	2003-10-18 05:51:36 +0000	[diff] [blame]	4688	<h5>Arguments:</h5>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4689
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4690	<p>This instruction takes a <tt>va_list*</tt> value and the type of
				4691	the argument. It returns a value of the specified argument type and
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4692	increments the <tt>va_list</tt> to point to the next argument. The
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4693	actual type of <tt>va_list</tt> is target specific.</p>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4694
Chris Lattner	8d1a81d	2003-10-18 05:51:36 +0000	[diff] [blame]	4695	<h5>Semantics:</h5>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4696
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4697	<p>The '<tt>va_arg</tt>' instruction loads an argument of the specified
				4698	type from the specified <tt>va_list</tt> and causes the
				4699	<tt>va_list</tt> to point to the next argument. For more information,
				4700	see the variable argument handling <a href="#int_varargs">Intrinsic
				4701	Functions</a>.</p>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4702
				4703	<p>It is legal for this instruction to be called in a function which does not
				4704	take a variable number of arguments, for example, the <tt>vfprintf</tt>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4705	function.</p>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4706
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4707	<p><tt>va_arg</tt> is an LLVM instruction instead of an <a
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	4708	href="#intrinsics">intrinsic function</a> because it takes a type as an
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4709	argument.</p>
				4710
Chris Lattner	8d1a81d	2003-10-18 05:51:36 +0000	[diff] [blame]	4711	<h5>Example:</h5>
Chris Lattner	e19d7a7	2004-09-27 21:51:25 +0000	[diff] [blame]	4712
				4713	<p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
				4714
Dan Gohman	f3e60bd	2009-01-12 23:12:39 +0000	[diff] [blame]	4715	<p>Note that the code generator does not yet fully support va_arg
				4716	on many targets. Also, it does not currently support va_arg with
				4717	aggregate types on any target.</p>
				4718
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4719	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4720
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4721	<!-- *********************************************************************** -->
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4722	<div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
				4723	<!-- *********************************************************************** -->
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4724
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4725	<div class="doc_text">
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4726
				4727	<p>LLVM supports the notion of an "intrinsic function". These functions have
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	4728	well known names and semantics and are required to follow certain restrictions.
				4729	Overall, these intrinsics represent an extension mechanism for the LLVM
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4730	language that does not require changing all of the transformations in LLVM when
Gabor Greif	04367bf	2007-07-06 22:07:22 +0000	[diff] [blame]	4731	adding to the language (or the bitcode reader/writer, the parser, etc...).</p>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4732
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	4733	<p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4734	prefix is reserved in LLVM for intrinsic names; thus, function names may not
				4735	begin with this prefix. Intrinsic functions must always be external functions:
				4736	you cannot define the body of intrinsic functions. Intrinsic functions may
				4737	only be used in call or invoke instructions: it is illegal to take the address
				4738	of an intrinsic function. Additionally, because intrinsic functions are part
				4739	of the LLVM language, it is required if any are added that they be documented
				4740	here.</p>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4741
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	4742	<p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents
				4743	a family of functions that perform the same operation but on different data
				4744	types. Because LLVM can represent over 8 million different integer types,
				4745	overloading is used commonly to allow an intrinsic function to operate on any
				4746	integer type. One or more of the argument types or the result type can be
				4747	overloaded to accept any integer type. Argument types may also be defined as
				4748	exactly matching a previous argument's type or the result type. This allows an
				4749	intrinsic function which accepts multiple arguments, but needs all of them to
				4750	be of the same type, to only be overloaded with respect to a single argument or
				4751	the result.</p>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4752
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	4753	<p>Overloaded intrinsics will have the names of its overloaded argument types
				4754	encoded into its function name, each preceded by a period. Only those types
				4755	which are overloaded result in a name suffix. Arguments whose type is matched
				4756	against another type do not. For example, the <tt>llvm.ctpop</tt> function can
				4757	take an integer of any width and returns an integer of exactly the same integer
				4758	width. This leads to a family of functions such as
				4759	<tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29 %val)</tt>.
				4760	Only one type, the return type, is overloaded, and only one type suffix is
				4761	required. Because the argument's type is matched against the return type, it
				4762	does not require its own name suffix.</p>
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	4763
				4764	<p>To learn how to add an intrinsic function, please see the
				4765	<a href="ExtendingLLVM.html">Extending LLVM Guide</a>.
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4766	</p>
				4767
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4768	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4769
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4770	<!-- ======================================================================= -->
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4771	<div class="doc_subsection">
				4772	<a name="int_varargs">Variable Argument Handling Intrinsics</a>
				4773	</div>
				4774
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4775	<div class="doc_text">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4776
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4777	<p>Variable argument support is defined in LLVM with the <a
Chris Lattner	fb6977d	2006-01-13 23:26:01 +0000	[diff] [blame]	4778	href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4779	intrinsic functions. These functions are related to the similarly
				4780	named macros defined in the <tt><stdarg.h></tt> header file.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4781
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4782	<p>All of these functions operate on arguments that use a
				4783	target-specific value type "<tt>va_list</tt>". The LLVM assembly
				4784	language reference manual does not define what this type is, so all
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4785	transformations should be prepared to handle these functions regardless of
				4786	the type used.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4787
Chris Lattner	374ab30	2006-05-15 17:26:46 +0000	[diff] [blame]	4788	<p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4789	instruction and the variable argument handling intrinsic functions are
				4790	used.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4791
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	4792	<div class="doc_code">
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4793	<pre>
Anton Korobeynikov	5d522f3	2007-03-21 23:58:04 +0000	[diff] [blame]	4794	define i32 @test(i32 %X, ...) {
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4795	; Initialize variable argument processing
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4796	%ap = alloca i8*
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4797	%ap2 = bitcast i8** %ap to i8*
Anton Korobeynikov	5d522f3	2007-03-21 23:58:04 +0000	[diff] [blame]	4798	call void @llvm.va_start(i8* %ap2)
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4799
				4800	; Read a single integer argument
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4801	%tmp = va_arg i8** %ap, i32
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4802
				4803	; Demonstrate usage of llvm.va_copy and llvm.va_end
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4804	%aq = alloca i8*
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4805	%aq2 = bitcast i8** %aq to i8*
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4806	call void @llvm.va_copy(i8* %aq2, i8* %ap2)
Anton Korobeynikov	5d522f3	2007-03-21 23:58:04 +0000	[diff] [blame]	4807	call void @llvm.va_end(i8* %aq2)
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4808
				4809	; Stop processing of arguments.
Anton Korobeynikov	5d522f3	2007-03-21 23:58:04 +0000	[diff] [blame]	4810	call void @llvm.va_end(i8* %ap2)
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	4811	ret i32 %tmp
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4812	}
Anton Korobeynikov	5d522f3	2007-03-21 23:58:04 +0000	[diff] [blame]	4813
				4814	declare void @llvm.va_start(i8*)
				4815	declare void @llvm.va_copy(i8, i8)
				4816	declare void @llvm.va_end(i8*)
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4817	</pre>
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4818	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4819
Bill Wendling	2f7a8b0	2007-05-29 09:04:49 +0000	[diff] [blame]	4820	</div>
				4821
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4822	<!-- _______________________________________________________________________ -->
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4823	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4824	<a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4825	</div>
				4826
				4827
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4828	<div class="doc_text">
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4829	<h5>Syntax:</h5>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4830	<pre> declare void %llvm.va_start(i8* <arglist>)<br></pre>
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4831	<h5>Overview:</h5>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4832	<p>The '<tt>llvm.va_start</tt>' intrinsic initializes
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4833	<tt>*<arglist></tt> for subsequent use by <tt><a
				4834	href="#i_va_arg">va_arg</a></tt>.</p>
				4835
				4836	<h5>Arguments:</h5>
				4837
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4838	<p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4839
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4840	<h5>Semantics:</h5>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4841
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	4842	<p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4843	macro available in C. In a target-dependent way, it initializes the
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4844	<tt>va_list</tt> element to which the argument points, so that the next call to
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4845	<tt>va_arg</tt> will produce the first variable argument passed to the function.
				4846	Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4847	last argument of the function as the compiler can figure that out.</p>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4848
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4849	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4850
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4851	<!-- _______________________________________________________________________ -->
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4852	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4853	<a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4854	</div>
				4855
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4856	<div class="doc_text">
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4857	<h5>Syntax:</h5>
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	4858	<pre> declare void @llvm.va_end(i8* <arglist>)<br></pre>
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4859	<h5>Overview:</h5>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4860
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4861	<p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*<arglist></tt>,
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4862	which has been initialized previously with <tt><a href="#int_va_start">llvm.va_start</a></tt>
Chris Lattner	261efe9	2003-11-25 01:02:51 +0000	[diff] [blame]	4863	or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4864
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4865	<h5>Arguments:</h5>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4866
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4867	<p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4868
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4869	<h5>Semantics:</h5>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4870
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4871	<p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4872	macro available in C. In a target-dependent way, it destroys the
				4873	<tt>va_list</tt> element to which the argument points. Calls to <a
				4874	href="#int_va_start"><tt>llvm.va_start</tt></a> and <a href="#int_va_copy">
				4875	<tt>llvm.va_copy</tt></a> must be matched exactly with calls to
				4876	<tt>llvm.va_end</tt>.</p>
Chris Lattner	b75137d	2007-01-08 07:55:15 +0000	[diff] [blame]	4877
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4878	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4879
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4880	<!-- _______________________________________________________________________ -->
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4881	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4882	<a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4883	</div>
				4884
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4885	<div class="doc_text">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4886
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4887	<h5>Syntax:</h5>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4888
				4889	<pre>
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	4890	declare void @llvm.va_copy(i8* <destarglist>, i8* <srcarglist>)
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4891	</pre>
				4892
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4893	<h5>Overview:</h5>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4894
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4895	<p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
				4896	from the source argument list to the destination argument list.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4897
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4898	<h5>Arguments:</h5>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4899
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4900	<p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
Andrew Lenharth	d0a4c62	2005-06-22 20:38:11 +0000	[diff] [blame]	4901	The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p>
Andrew Lenharth	8bf607a	2005-06-18 18:28:17 +0000	[diff] [blame]	4902
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4903
Chris Lattner	d9ad5b3	2003-05-08 04:57:36 +0000	[diff] [blame]	4904	<h5>Semantics:</h5>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4905
Jeff Cohen	b627eab	2007-04-29 01:07:00 +0000	[diff] [blame]	4906	<p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
				4907	macro available in C. In a target-dependent way, it copies the source
				4908	<tt>va_list</tt> element into the destination <tt>va_list</tt> element. This
				4909	intrinsic is necessary because the <tt><a href="#int_va_start">
				4910	llvm.va_start</a></tt> intrinsic may be arbitrarily complex and require, for
				4911	example, memory allocation.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4912
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	4913	</div>
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	4914
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	4915	<!-- ======================================================================= -->
				4916	<div class="doc_subsection">
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4917	<a name="int_gc">Accurate Garbage Collection Intrinsics</a>
				4918	</div>
				4919
				4920	<div class="doc_text">
				4921
				4922	<p>
				4923	LLVM support for <a href="GarbageCollection.html">Accurate Garbage
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	4924	Collection</a> (GC) requires the implementation and generation of these
				4925	intrinsics.
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4926	These intrinsics allow identification of <a href="#int_gcroot">GC roots on the
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4927	stack</a>, as well as garbage collector implementations that require <a
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4928	href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a> barriers.
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4929	Front-ends for type-safe garbage collected languages should generate these
				4930	intrinsics to make use of the LLVM garbage collectors. For more details, see <a
				4931	href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
				4932	</p>
Christopher Lamb	303dae9	2007-12-17 01:00:21 +0000	[diff] [blame]	4933
				4934	<p>The garbage collection intrinsics only operate on objects in the generic
				4935	address space (address space zero).</p>
				4936
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4937	</div>
				4938
				4939	<!-- _______________________________________________________________________ -->
				4940	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4941	<a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4942	</div>
				4943
				4944	<div class="doc_text">
				4945
				4946	<h5>Syntax:</h5>
				4947
				4948	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	4949	declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4950	</pre>
				4951
				4952	<h5>Overview:</h5>
				4953
John Criswell	9e2485c	2004-12-10 15:51:16 +0000	[diff] [blame]	4954	<p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4955	the code generator, and allows some metadata to be associated with it.</p>
				4956
				4957	<h5>Arguments:</h5>
				4958
				4959	<p>The first argument specifies the address of a stack object that contains the
				4960	root pointer. The second pointer (which must be either a constant or a global
				4961	value address) contains the meta-data to be associated with the root.</p>
				4962
				4963	<h5>Semantics:</h5>
				4964
Chris Lattner	05d6709	2008-04-24 05:59:56 +0000	[diff] [blame]	4965	<p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4966	location. At compile-time, the code generator generates information to allow
Gordon Henriksen	e1433f2	2007-12-25 02:31:26 +0000	[diff] [blame]	4967	the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
				4968	intrinsic may only be used in a function which <a href="#gc">specifies a GC
				4969	algorithm</a>.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4970
				4971	</div>
				4972
				4973
				4974	<!-- _______________________________________________________________________ -->
				4975	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	4976	<a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4977	</div>
				4978
				4979	<div class="doc_text">
				4980
				4981	<h5>Syntax:</h5>
				4982
				4983	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	4984	declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4985	</pre>
				4986
				4987	<h5>Overview:</h5>
				4988
				4989	<p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
				4990	locations, allowing garbage collector implementations that require read
				4991	barriers.</p>
				4992
				4993	<h5>Arguments:</h5>
				4994
Chris Lattner	80626e9	2006-03-14 20:02:51 +0000	[diff] [blame]	4995	<p>The second argument is the address to read from, which should be an address
				4996	allocated from the garbage collector. The first object is a pointer to the
				4997	start of the referenced object, if needed by the language runtime (otherwise
				4998	null).</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	4999
				5000	<h5>Semantics:</h5>
				5001
				5002	<p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
				5003	instruction, but may be replaced with substantially more complex code by the
Gordon Henriksen	e1433f2	2007-12-25 02:31:26 +0000	[diff] [blame]	5004	garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
				5005	may only be used in a function which <a href="#gc">specifies a GC
				5006	algorithm</a>.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	5007
				5008	</div>
				5009
				5010
				5011	<!-- _______________________________________________________________________ -->
				5012	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5013	<a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	5014	</div>
				5015
				5016	<div class="doc_text">
				5017
				5018	<h5>Syntax:</h5>
				5019
				5020	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	5021	declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	5022	</pre>
				5023
				5024	<h5>Overview:</h5>
				5025
				5026	<p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
				5027	locations, allowing garbage collector implementations that require write
				5028	barriers (such as generational or reference counting collectors).</p>
				5029
				5030	<h5>Arguments:</h5>
				5031
Chris Lattner	80626e9	2006-03-14 20:02:51 +0000	[diff] [blame]	5032	<p>The first argument is the reference to store, the second is the start of the
				5033	object to store it to, and the third is the address of the field of Obj to
				5034	store to. If the runtime does not require a pointer to the object, Obj may be
				5035	null.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	5036
				5037	<h5>Semantics:</h5>
				5038
				5039	<p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
				5040	instruction, but may be replaced with substantially more complex code by the
Gordon Henriksen	e1433f2	2007-12-25 02:31:26 +0000	[diff] [blame]	5041	garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
				5042	may only be used in a function which <a href="#gc">specifies a GC
				5043	algorithm</a>.</p>
Chris Lattner	d792391	2004-05-23 21:06:01 +0000	[diff] [blame]	5044
				5045	</div>
				5046
				5047
				5048
				5049	<!-- ======================================================================= -->
				5050	<div class="doc_subsection">
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5051	<a name="int_codegen">Code Generator Intrinsics</a>
				5052	</div>
				5053
				5054	<div class="doc_text">
				5055	<p>
				5056	These intrinsics are provided by LLVM to expose special features that may only
				5057	be implemented with code generator support.
				5058	</p>
				5059
				5060	</div>
				5061
				5062	<!-- _______________________________________________________________________ -->
				5063	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5064	<a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5065	</div>
				5066
				5067	<div class="doc_text">
				5068
				5069	<h5>Syntax:</h5>
				5070	<pre>
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5071	declare i8 *@llvm.returnaddress(i32 <level>)
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5072	</pre>
				5073
				5074	<h5>Overview:</h5>
				5075
				5076	<p>
Chris Lattner	32b5d71	2006-10-15 20:05:59 +0000	[diff] [blame]	5077	The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
				5078	target-specific value indicating the return address of the current function
				5079	or one of its callers.
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5080	</p>
				5081
				5082	<h5>Arguments:</h5>
				5083
				5084	<p>
				5085	The argument to this intrinsic indicates which function to return the address
				5086	for. Zero indicates the calling function, one indicates its caller, etc. The
				5087	argument is <b>required</b> to be a constant integer value.
				5088	</p>
				5089
				5090	<h5>Semantics:</h5>
				5091
				5092	<p>
				5093	The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
				5094	the return address of the specified call frame, or zero if it cannot be
				5095	identified. The value returned by this intrinsic is likely to be incorrect or 0
				5096	for arguments other than zero, so it should only be used for debugging purposes.
				5097	</p>
				5098
				5099	<p>
				5100	Note that calling this intrinsic does not prevent function inlining or other
Chris Lattner	b40bb38	2005-03-07 20:30:51 +0000	[diff] [blame]	5101	aggressive transformations, so the value returned may not be that of the obvious
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5102	source-language caller.
				5103	</p>
				5104	</div>
				5105
				5106
				5107	<!-- _______________________________________________________________________ -->
				5108	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5109	<a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5110	</div>
				5111
				5112	<div class="doc_text">
				5113
				5114	<h5>Syntax:</h5>
				5115	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	5116	declare i8 *@llvm.frameaddress(i32 <level>)
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5117	</pre>
				5118
				5119	<h5>Overview:</h5>
				5120
				5121	<p>
Chris Lattner	32b5d71	2006-10-15 20:05:59 +0000	[diff] [blame]	5122	The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
				5123	target-specific frame pointer value for the specified stack frame.
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5124	</p>
				5125
				5126	<h5>Arguments:</h5>
				5127
				5128	<p>
				5129	The argument to this intrinsic indicates which function to return the frame
				5130	pointer for. Zero indicates the calling function, one indicates its caller,
				5131	etc. The argument is <b>required</b> to be a constant integer value.
				5132	</p>
				5133
				5134	<h5>Semantics:</h5>
				5135
				5136	<p>
				5137	The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
				5138	the frame address of the specified call frame, or zero if it cannot be
				5139	identified. The value returned by this intrinsic is likely to be incorrect or 0
				5140	for arguments other than zero, so it should only be used for debugging purposes.
				5141	</p>
				5142
				5143	<p>
				5144	Note that calling this intrinsic does not prevent function inlining or other
Chris Lattner	b40bb38	2005-03-07 20:30:51 +0000	[diff] [blame]	5145	aggressive transformations, so the value returned may not be that of the obvious
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5146	source-language caller.
				5147	</p>
				5148	</div>
				5149
Chris Lattner	9a9d7ac	2005-02-28 19:24:19 +0000	[diff] [blame]	5150	<!-- _______________________________________________________________________ -->
				5151	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5152	<a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5153	</div>
				5154
				5155	<div class="doc_text">
				5156
				5157	<h5>Syntax:</h5>
				5158	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	5159	declare i8 *@llvm.stacksave()
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5160	</pre>
				5161
				5162	<h5>Overview:</h5>
				5163
				5164	<p>
				5165	The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state of
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5166	the function stack, for use with <a href="#int_stackrestore">
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5167	<tt>llvm.stackrestore</tt></a>. This is useful for implementing language
				5168	features like scoped automatic variable sized arrays in C99.
				5169	</p>
				5170
				5171	<h5>Semantics:</h5>
				5172
				5173	<p>
				5174	This intrinsic returns a opaque pointer value that can be passed to <a
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5175	href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>. When an
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5176	<tt>llvm.stackrestore</tt> intrinsic is executed with a value saved from
				5177	<tt>llvm.stacksave</tt>, it effectively restores the state of the stack to the
				5178	state it was in when the <tt>llvm.stacksave</tt> intrinsic executed. In
				5179	practice, this pops any <a href="#i_alloca">alloca</a> blocks from the stack
				5180	that were allocated after the <tt>llvm.stacksave</tt> was executed.
				5181	</p>
				5182
				5183	</div>
				5184
				5185	<!-- _______________________________________________________________________ -->
				5186	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5187	<a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5188	</div>
				5189
				5190	<div class="doc_text">
				5191
				5192	<h5>Syntax:</h5>
				5193	<pre>
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5194	declare void @llvm.stackrestore(i8 * %ptr)
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5195	</pre>
				5196
				5197	<h5>Overview:</h5>
				5198
				5199	<p>
				5200	The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
				5201	the function stack to the state it was in when the corresponding <a
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5202	href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic executed. This is
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5203	useful for implementing language features like scoped automatic variable sized
				5204	arrays in C99.
				5205	</p>
				5206
				5207	<h5>Semantics:</h5>
				5208
				5209	<p>
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5210	See the description for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.
Chris Lattner	57e1f39	2006-01-13 02:03:13 +0000	[diff] [blame]	5211	</p>
				5212
				5213	</div>
				5214
				5215
				5216	<!-- _______________________________________________________________________ -->
				5217	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5218	<a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
Chris Lattner	9a9d7ac	2005-02-28 19:24:19 +0000	[diff] [blame]	5219	</div>
				5220
				5221	<div class="doc_text">
				5222
				5223	<h5>Syntax:</h5>
				5224	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	5225	declare void @llvm.prefetch(i8* <address>, i32 <rw>, i32 <locality>)
Chris Lattner	9a9d7ac	2005-02-28 19:24:19 +0000	[diff] [blame]	5226	</pre>
				5227
				5228	<h5>Overview:</h5>
				5229
				5230
				5231	<p>
				5232	The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	5233	a prefetch instruction if supported; otherwise, it is a noop. Prefetches have
				5234	no
				5235	effect on the behavior of the program but can change its performance
Chris Lattner	2a61536	2005-02-28 19:47:14 +0000	[diff] [blame]	5236	characteristics.
Chris Lattner	9a9d7ac	2005-02-28 19:24:19 +0000	[diff] [blame]	5237	</p>
				5238
				5239	<h5>Arguments:</h5>
				5240
				5241	<p>
				5242	<tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
				5243	determining if the fetch should be for a read (0) or write (1), and
				5244	<tt>locality</tt> is a temporal locality specifier ranging from (0) - no
Chris Lattner	aeffb4a	2005-03-07 20:31:38 +0000	[diff] [blame]	5245	locality, to (3) - extremely local keep in cache. The <tt>rw</tt> and
Chris Lattner	9a9d7ac	2005-02-28 19:24:19 +0000	[diff] [blame]	5246	<tt>locality</tt> arguments must be constant integers.
				5247	</p>
				5248
				5249	<h5>Semantics:</h5>
				5250
				5251	<p>
				5252	This intrinsic does not modify the behavior of the program. In particular,
				5253	prefetches cannot trap and do not produce a value. On targets that support this
				5254	intrinsic, the prefetch can provide hints to the processor cache for better
				5255	performance.
				5256	</p>
				5257
				5258	</div>
				5259
Andrew Lenharth	7f4ec3b	2005-03-28 20:05:49 +0000	[diff] [blame]	5260	<!-- _______________________________________________________________________ -->
				5261	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5262	<a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
Andrew Lenharth	7f4ec3b	2005-03-28 20:05:49 +0000	[diff] [blame]	5263	</div>
				5264
				5265	<div class="doc_text">
				5266
				5267	<h5>Syntax:</h5>
				5268	<pre>
Chris Lattner	1df4f75	2007-09-21 17:30:40 +0000	[diff] [blame]	5269	declare void @llvm.pcmarker(i32 <id>)
Andrew Lenharth	7f4ec3b	2005-03-28 20:05:49 +0000	[diff] [blame]	5270	</pre>
				5271
				5272	<h5>Overview:</h5>
				5273
				5274
				5275	<p>
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	5276	The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	5277	(PC) in a region of
				5278	code to simulators and other tools. The method is target specific, but it is
				5279	expected that the marker will use exported symbols to transmit the PC of the
				5280	marker.
				5281	The marker makes no guarantees that it will remain with any specific instruction
				5282	after optimizations. It is possible that the presence of a marker will inhibit
Chris Lattner	b3e7afd	2006-03-24 07:16:10 +0000	[diff] [blame]	5283	optimizations. The intended use is to be inserted after optimizations to allow
John Criswell	fc6b895	2005-05-16 16:17:45 +0000	[diff] [blame]	5284	correlations of simulation runs.
Andrew Lenharth	7f4ec3b	2005-03-28 20:05:49 +0000	[diff] [blame]	5285	</p>
				5286
				5287	<h5>Arguments:</h5>
				5288
				5289	<p>
				5290	<tt>id</tt> is a numerical id identifying the marker.
				5291	</p>
				5292
				5293	<h5>Semantics:</h5>
				5294
				5295	<p>
				5296	This intrinsic does not modify the behavior of the program. Backends that do not
				5297	support this intrinisic may ignore it.
				5298	</p>
				5299
				5300	</div>
				5301
Andrew Lenharth	51b8d54	2005-11-11 16:47:30 +0000	[diff] [blame]	5302	<!-- _______________________________________________________________________ -->
				5303	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5304	<a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
Andrew Lenharth	51b8d54	2005-11-11 16:47:30 +0000	[diff] [blame]	5305	</div>
				5306
				5307	<div class="doc_text">
				5308
				5309	<h5>Syntax:</h5>
				5310	<pre>
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5311	declare i64 @llvm.readcyclecounter( )
Andrew Lenharth	51b8d54	2005-11-11 16:47:30 +0000	[diff] [blame]	5312	</pre>
				5313
				5314	<h5>Overview:</h5>
				5315
				5316
				5317	<p>
				5318	The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
				5319	counter register (or similar low latency, high accuracy clocks) on those targets
				5320	that support it. On X86, it should map to RDTSC. On Alpha, it should map to RPCC.
				5321	As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
				5322	should only be used for small timings.
				5323	</p>
				5324
				5325	<h5>Semantics:</h5>
				5326
				5327	<p>
				5328	When directly supported, reading the cycle counter should not modify any memory.
				5329	Implementations are allowed to either return a application specific value or a
				5330	system wide value. On backends without support, this is lowered to a constant 0.
				5331	</p>
				5332
				5333	</div>
				5334
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5335	<!-- ======================================================================= -->
				5336	<div class="doc_subsection">
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5337	<a name="int_libc">Standard C Library Intrinsics</a>
				5338	</div>
				5339
				5340	<div class="doc_text">
				5341	<p>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5342	LLVM provides intrinsics for a few important standard C library functions.
				5343	These intrinsics allow source-language front-ends to pass information about the
				5344	alignment of the pointer arguments to the code generator, providing opportunity
				5345	for more efficient code generation.
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5346	</p>
				5347
				5348	</div>
				5349
				5350	<!-- _______________________________________________________________________ -->
				5351	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5352	<a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5353	</div>
				5354
				5355	<div class="doc_text">
				5356
				5357	<h5>Syntax:</h5>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5358	<p>This is an overloaded intrinsic. You can use llvm.memcpy on any integer bit
				5359	width. Not all targets support all bit widths however.</p>
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5360	<pre>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5361	declare void @llvm.memcpy.i8(i8 * <dest>, i8 * <src>,
				5362	i8 <len>, i32 <align>)
				5363	declare void @llvm.memcpy.i16(i8 * <dest>, i8 * <src>,
				5364	i16 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5365	declare void @llvm.memcpy.i32(i8 * <dest>, i8 * <src>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5366	i32 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5367	declare void @llvm.memcpy.i64(i8 * <dest>, i8 * <src>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5368	i64 <len>, i32 <align>)
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5369	</pre>
				5370
				5371	<h5>Overview:</h5>
				5372
				5373	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5374	The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5375	location to the destination location.
				5376	</p>
				5377
				5378	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5379	Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
				5380	intrinsics do not return a value, and takes an extra alignment argument.
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5381	</p>
				5382
				5383	<h5>Arguments:</h5>
				5384
				5385	<p>
				5386	The first argument is a pointer to the destination, the second is a pointer to
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5387	the source. The third argument is an integer argument
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5388	specifying the number of bytes to copy, and the fourth argument is the alignment
				5389	of the source and destination locations.
				5390	</p>
				5391
Chris Lattner	3301ced	2004-02-12 21:18:15 +0000	[diff] [blame]	5392	<p>
				5393	If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattner	f0afc2c	2006-03-04 00:02:10 +0000	[diff] [blame]	5394	the caller guarantees that both the source and destination pointers are aligned
				5395	to that boundary.
Chris Lattner	3301ced	2004-02-12 21:18:15 +0000	[diff] [blame]	5396	</p>
				5397
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5398	<h5>Semantics:</h5>
				5399
				5400	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5401	The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner	33aec9e	2004-02-12 17:01:32 +0000	[diff] [blame]	5402	location to the destination location, which are not allowed to overlap. It
				5403	copies "len" bytes of memory over. If the argument is known to be aligned to
				5404	some boundary, this can be specified as the fourth argument, otherwise it should
				5405	be set to 0 or 1.
				5406	</p>
				5407	</div>
				5408
				5409
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5410	<!-- _______________________________________________________________________ -->
				5411	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5412	<a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5413	</div>
				5414
				5415	<div class="doc_text">
				5416
				5417	<h5>Syntax:</h5>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5418	<p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
				5419	width. Not all targets support all bit widths however.</p>
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5420	<pre>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5421	declare void @llvm.memmove.i8(i8 * <dest>, i8 * <src>,
				5422	i8 <len>, i32 <align>)
				5423	declare void @llvm.memmove.i16(i8 * <dest>, i8 * <src>,
				5424	i16 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5425	declare void @llvm.memmove.i32(i8 * <dest>, i8 * <src>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5426	i32 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5427	declare void @llvm.memmove.i64(i8 * <dest>, i8 * <src>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5428	i64 <len>, i32 <align>)
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5429	</pre>
				5430
				5431	<h5>Overview:</h5>
				5432
				5433	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5434	The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the source
				5435	location to the destination location. It is similar to the
Chris Lattner	4b2cbcf	2008-01-06 19:51:52 +0000	[diff] [blame]	5436	'<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to overlap.
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5437	</p>
				5438
				5439	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5440	Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
				5441	intrinsics do not return a value, and takes an extra alignment argument.
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5442	</p>
				5443
				5444	<h5>Arguments:</h5>
				5445
				5446	<p>
				5447	The first argument is a pointer to the destination, the second is a pointer to
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5448	the source. The third argument is an integer argument
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5449	specifying the number of bytes to copy, and the fourth argument is the alignment
				5450	of the source and destination locations.
				5451	</p>
				5452
Chris Lattner	3301ced	2004-02-12 21:18:15 +0000	[diff] [blame]	5453	<p>
				5454	If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattner	f0afc2c	2006-03-04 00:02:10 +0000	[diff] [blame]	5455	the caller guarantees that the source and destination pointers are aligned to
				5456	that boundary.
Chris Lattner	3301ced	2004-02-12 21:18:15 +0000	[diff] [blame]	5457	</p>
				5458
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5459	<h5>Semantics:</h5>
				5460
				5461	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5462	The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the source
Chris Lattner	0eb51b4	2004-02-12 18:10:10 +0000	[diff] [blame]	5463	location to the destination location, which may overlap. It
				5464	copies "len" bytes of memory over. If the argument is known to be aligned to
				5465	some boundary, this can be specified as the fourth argument, otherwise it should
				5466	be set to 0 or 1.
				5467	</p>
				5468	</div>
				5469
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	5470
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5471	<!-- _______________________________________________________________________ -->
				5472	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5473	<a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5474	</div>
				5475
				5476	<div class="doc_text">
				5477
				5478	<h5>Syntax:</h5>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5479	<p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
				5480	width. Not all targets support all bit widths however.</p>
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5481	<pre>
Chris Lattner	824b958	2008-11-21 16:42:48 +0000	[diff] [blame]	5482	declare void @llvm.memset.i8(i8 * <dest>, i8 <val>,
				5483	i8 <len>, i32 <align>)
				5484	declare void @llvm.memset.i16(i8 * <dest>, i8 <val>,
				5485	i16 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5486	declare void @llvm.memset.i32(i8 * <dest>, i8 <val>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5487	i32 <len>, i32 <align>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5488	declare void @llvm.memset.i64(i8 * <dest>, i8 <val>,
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5489	i64 <len>, i32 <align>)
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5490	</pre>
				5491
				5492	<h5>Overview:</h5>
				5493
				5494	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5495	The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a particular
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5496	byte value.
				5497	</p>
				5498
				5499	<p>
				5500	Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
				5501	does not return a value, and takes an extra alignment argument.
				5502	</p>
				5503
				5504	<h5>Arguments:</h5>
				5505
				5506	<p>
				5507	The first argument is a pointer to the destination to fill, the second is the
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5508	byte value to fill it with, the third argument is an integer
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5509	argument specifying the number of bytes to fill, and the fourth argument is the
				5510	known alignment of destination location.
				5511	</p>
				5512
				5513	<p>
				5514	If the call to this intrinisic has an alignment value that is not 0 or 1, then
Chris Lattner	f0afc2c	2006-03-04 00:02:10 +0000	[diff] [blame]	5515	the caller guarantees that the destination pointer is aligned to that boundary.
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5516	</p>
				5517
				5518	<h5>Semantics:</h5>
				5519
				5520	<p>
Chris Lattner	5b310c3	2006-03-03 00:07:20 +0000	[diff] [blame]	5521	The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting at
				5522	the
Chris Lattner	1061064	2004-02-14 04:08:35 +0000	[diff] [blame]	5523	destination location. If the argument is known to be aligned to some boundary,
				5524	this can be specified as the fourth argument, otherwise it should be set to 0 or
				5525	1.
				5526	</p>
				5527	</div>
				5528
				5529
Chris Lattner	3200628	2004-06-11 02:28:03 +0000	[diff] [blame]	5530	<!-- _______________________________________________________________________ -->
				5531	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5532	<a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5533	</div>
				5534
				5535	<div class="doc_text">
				5536
				5537	<h5>Syntax:</h5>
Dale Johannesen	408f9c1	2007-10-02 17:47:38 +0000	[diff] [blame]	5538	<p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5539	floating point or vector of floating point type. Not all targets support all
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5540	types however.</p>
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5541	<pre>
Dale Johannesen	408f9c1	2007-10-02 17:47:38 +0000	[diff] [blame]	5542	declare float @llvm.sqrt.f32(float %Val)
				5543	declare double @llvm.sqrt.f64(double %Val)
				5544	declare x86_fp80 @llvm.sqrt.f80(x86_fp80 %Val)
				5545	declare fp128 @llvm.sqrt.f128(fp128 %Val)
				5546	declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5547	</pre>
				5548
				5549	<h5>Overview:</h5>
				5550
				5551	<p>
Reid Spencer	0b11820	2006-01-16 21:12:35 +0000	[diff] [blame]	5552	The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5553	returning the same value as the libm '<tt>sqrt</tt>' functions would. Unlike
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5554	<tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for
Chris Lattner	103e2d7	2008-01-29 07:00:44 +0000	[diff] [blame]	5555	negative numbers other than -0.0 (which allows for better optimization, because
				5556	there is no need to worry about errno being set). <tt>llvm.sqrt(-0.0)</tt> is
				5557	defined to return -0.0 like IEEE sqrt.
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5558	</p>
				5559
				5560	<h5>Arguments:</h5>
				5561
				5562	<p>
				5563	The argument and return value are floating point numbers of the same type.
				5564	</p>
				5565
				5566	<h5>Semantics:</h5>
				5567
				5568	<p>
Dan Gohman	d6257fe	2007-07-16 14:37:41 +0000	[diff] [blame]	5569	This function returns the sqrt of the specified operand if it is a nonnegative
Chris Lattner	a4d7414	2005-07-21 01:29:16 +0000	[diff] [blame]	5570	floating point number.
				5571	</p>
				5572	</div>
				5573
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5574	<!-- _______________________________________________________________________ -->
				5575	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5576	<a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5577	</div>
				5578
				5579	<div class="doc_text">
				5580
				5581	<h5>Syntax:</h5>
Dale Johannesen	408f9c1	2007-10-02 17:47:38 +0000	[diff] [blame]	5582	<p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5583	floating point or vector of floating point type. Not all targets support all
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5584	types however.</p>
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5585	<pre>
Dale Johannesen	408f9c1	2007-10-02 17:47:38 +0000	[diff] [blame]	5586	declare float @llvm.powi.f32(float %Val, i32 %power)
				5587	declare double @llvm.powi.f64(double %Val, i32 %power)
				5588	declare x86_fp80 @llvm.powi.f80(x86_fp80 %Val, i32 %power)
				5589	declare fp128 @llvm.powi.f128(fp128 %Val, i32 %power)
				5590	declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128 %Val, i32 %power)
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5591	</pre>
				5592
				5593	<h5>Overview:</h5>
				5594
				5595	<p>
				5596	The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
				5597	specified (positive or negative) power. The order of evaluation of
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5598	multiplications is not defined. When a vector of floating point type is
				5599	used, the second argument remains a scalar integer value.
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5600	</p>
				5601
				5602	<h5>Arguments:</h5>
				5603
				5604	<p>
				5605	The second argument is an integer power, and the first is a value to raise to
				5606	that power.
				5607	</p>
				5608
				5609	<h5>Semantics:</h5>
				5610
				5611	<p>
				5612	This function returns the first value raised to the second power with an
				5613	unspecified sequence of rounding operations.</p>
				5614	</div>
				5615
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5616	<!-- _______________________________________________________________________ -->
				5617	<div class="doc_subsubsection">
				5618	<a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
				5619	</div>
				5620
				5621	<div class="doc_text">
				5622
				5623	<h5>Syntax:</h5>
				5624	<p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
				5625	floating point or vector of floating point type. Not all targets support all
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5626	types however.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5627	<pre>
				5628	declare float @llvm.sin.f32(float %Val)
				5629	declare double @llvm.sin.f64(double %Val)
				5630	declare x86_fp80 @llvm.sin.f80(x86_fp80 %Val)
				5631	declare fp128 @llvm.sin.f128(fp128 %Val)
				5632	declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128 %Val)
				5633	</pre>
				5634
				5635	<h5>Overview:</h5>
				5636
				5637	<p>
				5638	The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.
				5639	</p>
				5640
				5641	<h5>Arguments:</h5>
				5642
				5643	<p>
				5644	The argument and return value are floating point numbers of the same type.
				5645	</p>
				5646
				5647	<h5>Semantics:</h5>
				5648
				5649	<p>
				5650	This function returns the sine of the specified operand, returning the
				5651	same values as the libm <tt>sin</tt> functions would, and handles error
Dan Gohman	ba83b7e	2007-10-17 18:05:13 +0000	[diff] [blame]	5652	conditions in the same way.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5653	</div>
				5654
				5655	<!-- _______________________________________________________________________ -->
				5656	<div class="doc_subsubsection">
				5657	<a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
				5658	</div>
				5659
				5660	<div class="doc_text">
				5661
				5662	<h5>Syntax:</h5>
				5663	<p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
				5664	floating point or vector of floating point type. Not all targets support all
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5665	types however.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5666	<pre>
				5667	declare float @llvm.cos.f32(float %Val)
				5668	declare double @llvm.cos.f64(double %Val)
				5669	declare x86_fp80 @llvm.cos.f80(x86_fp80 %Val)
				5670	declare fp128 @llvm.cos.f128(fp128 %Val)
				5671	declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128 %Val)
				5672	</pre>
				5673
				5674	<h5>Overview:</h5>
				5675
				5676	<p>
				5677	The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.
				5678	</p>
				5679
				5680	<h5>Arguments:</h5>
				5681
				5682	<p>
				5683	The argument and return value are floating point numbers of the same type.
				5684	</p>
				5685
				5686	<h5>Semantics:</h5>
				5687
				5688	<p>
				5689	This function returns the cosine of the specified operand, returning the
				5690	same values as the libm <tt>cos</tt> functions would, and handles error
Dan Gohman	ba83b7e	2007-10-17 18:05:13 +0000	[diff] [blame]	5691	conditions in the same way.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5692	</div>
				5693
				5694	<!-- _______________________________________________________________________ -->
				5695	<div class="doc_subsubsection">
				5696	<a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
				5697	</div>
				5698
				5699	<div class="doc_text">
				5700
				5701	<h5>Syntax:</h5>
				5702	<p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
				5703	floating point or vector of floating point type. Not all targets support all
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5704	types however.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5705	<pre>
				5706	declare float @llvm.pow.f32(float %Val, float %Power)
				5707	declare double @llvm.pow.f64(double %Val, double %Power)
				5708	declare x86_fp80 @llvm.pow.f80(x86_fp80 %Val, x86_fp80 %Power)
				5709	declare fp128 @llvm.pow.f128(fp128 %Val, fp128 %Power)
				5710	declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128 %Val, ppc_fp128 Power)
				5711	</pre>
				5712
				5713	<h5>Overview:</h5>
				5714
				5715	<p>
				5716	The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
				5717	specified (positive or negative) power.
				5718	</p>
				5719
				5720	<h5>Arguments:</h5>
				5721
				5722	<p>
				5723	The second argument is a floating point power, and the first is a value to
				5724	raise to that power.
				5725	</p>
				5726
				5727	<h5>Semantics:</h5>
				5728
				5729	<p>
				5730	This function returns the first value raised to the second power,
				5731	returning the
				5732	same values as the libm <tt>pow</tt> functions would, and handles error
Dan Gohman	ba83b7e	2007-10-17 18:05:13 +0000	[diff] [blame]	5733	conditions in the same way.</p>
Dan Gohman	91c284c	2007-10-15 20:30:11 +0000	[diff] [blame]	5734	</div>
				5735
Chris Lattner	f4d252d	2006-09-08 06:34:02 +0000	[diff] [blame]	5736
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5737	<!-- ======================================================================= -->
				5738	<div class="doc_subsection">
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5739	<a name="int_manip">Bit Manipulation Intrinsics</a>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5740	</div>
				5741
				5742	<div class="doc_text">
				5743	<p>
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5744	LLVM provides intrinsics for a few important bit manipulation operations.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5745	These allow efficient code generation for some algorithms.
				5746	</p>
				5747
				5748	</div>
				5749
				5750	<!-- _______________________________________________________________________ -->
				5751	<div class="doc_subsubsection">
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5752	<a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5753	</div>
				5754
				5755	<div class="doc_text">
				5756
				5757	<h5>Syntax:</h5>
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5758	<p>This is an overloaded intrinsic function. You can use bswap on any integer
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5759	type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5760	<pre>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5761	declare i16 @llvm.bswap.i16(i16 <id>)
				5762	declare i32 @llvm.bswap.i32(i32 <id>)
				5763	declare i64 @llvm.bswap.i64(i64 <id>)
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5764	</pre>
				5765
				5766	<h5>Overview:</h5>
				5767
				5768	<p>
Reid Spencer	338ea09	2007-04-02 02:25:19 +0000	[diff] [blame]	5769	The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5770	values with an even number of bytes (positive multiple of 16 bits). These are
				5771	useful for performing operations on data that is not in the target's native
				5772	byte order.
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5773	</p>
				5774
				5775	<h5>Semantics:</h5>
				5776
				5777	<p>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5778	The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5779	and low byte of the input i16 swapped. Similarly, the <tt>llvm.bswap.i32</tt>
				5780	intrinsic returns an i32 value that has the four bytes of the input i32
				5781	swapped, so that if the input bytes are numbered 0, 1, 2, 3 then the returned
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5782	i32 will have its bytes in 3, 2, 1, 0 order. The <tt>llvm.bswap.i48</tt>,
				5783	<tt>llvm.bswap.i64</tt> and other intrinsics extend this concept to
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5784	additional even-byte lengths (6 bytes, 8 bytes and more, respectively).
Nate Begeman	7e36c47	2006-01-13 23:26:38 +0000	[diff] [blame]	5785	</p>
				5786
				5787	</div>
				5788
				5789	<!-- _______________________________________________________________________ -->
				5790	<div class="doc_subsubsection">
Reid Spencer	0b11820	2006-01-16 21:12:35 +0000	[diff] [blame]	5791	<a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5792	</div>
				5793
				5794	<div class="doc_text">
				5795
				5796	<h5>Syntax:</h5>
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5797	<p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5798	width. Not all targets support all bit widths however.</p>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5799	<pre>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	5800	declare i8 @llvm.ctpop.i8(i8 <src>)
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5801	declare i16 @llvm.ctpop.i16(i16 <src>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5802	declare i32 @llvm.ctpop.i32(i32 <src>)
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5803	declare i64 @llvm.ctpop.i64(i64 <src>)
				5804	declare i256 @llvm.ctpop.i256(i256 <src>)
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5805	</pre>
				5806
				5807	<h5>Overview:</h5>
				5808
				5809	<p>
Chris Lattner	ec6cb61	2006-01-16 22:38:59 +0000	[diff] [blame]	5810	The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set in a
				5811	value.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5812	</p>
				5813
				5814	<h5>Arguments:</h5>
				5815
				5816	<p>
Chris Lattner	cfe6b37	2005-05-07 01:46:40 +0000	[diff] [blame]	5817	The only argument is the value to be counted. The argument may be of any
Reid Spencer	a517338	2007-01-04 16:43:23 +0000	[diff] [blame]	5818	integer type. The return type must match the argument type.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5819	</p>
				5820
				5821	<h5>Semantics:</h5>
				5822
				5823	<p>
				5824	The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
				5825	</p>
				5826	</div>
				5827
				5828	<!-- _______________________________________________________________________ -->
				5829	<div class="doc_subsubsection">
Chris Lattner	8a886be	2006-01-16 22:34:14 +0000	[diff] [blame]	5830	<a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5831	</div>
				5832
				5833	<div class="doc_text">
				5834
				5835	<h5>Syntax:</h5>
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5836	<p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5837	integer bit width. Not all targets support all bit widths however.</p>
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5838	<pre>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5839	declare i8 @llvm.ctlz.i8 (i8 <src>)
				5840	declare i16 @llvm.ctlz.i16(i16 <src>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5841	declare i32 @llvm.ctlz.i32(i32 <src>)
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5842	declare i64 @llvm.ctlz.i64(i64 <src>)
				5843	declare i256 @llvm.ctlz.i256(i256 <src>)
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5844	</pre>
				5845
				5846	<h5>Overview:</h5>
				5847
				5848	<p>
Reid Spencer	0b11820	2006-01-16 21:12:35 +0000	[diff] [blame]	5849	The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
				5850	leading zeros in a variable.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5851	</p>
				5852
				5853	<h5>Arguments:</h5>
				5854
				5855	<p>
Chris Lattner	cfe6b37	2005-05-07 01:46:40 +0000	[diff] [blame]	5856	The only argument is the value to be counted. The argument may be of any
Reid Spencer	a517338	2007-01-04 16:43:23 +0000	[diff] [blame]	5857	integer type. The return type must match the argument type.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5858	</p>
				5859
				5860	<h5>Semantics:</h5>
				5861
				5862	<p>
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5863	The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros
				5864	in a variable. If the src == 0 then the result is the size in bits of the type
Reid Spencer	ca86e16	2006-12-31 07:07:53 +0000	[diff] [blame]	5865	of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.
Andrew Lenharth	ec370fd	2005-05-03 18:01:48 +0000	[diff] [blame]	5866	</p>
				5867	</div>
Chris Lattner	3200628	2004-06-11 02:28:03 +0000	[diff] [blame]	5868
				5869
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5870
				5871	<!-- _______________________________________________________________________ -->
				5872	<div class="doc_subsubsection">
Chris Lattner	8a886be	2006-01-16 22:34:14 +0000	[diff] [blame]	5873	<a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5874	</div>
				5875
				5876	<div class="doc_text">
				5877
				5878	<h5>Syntax:</h5>
Reid Spencer	409e28f	2007-04-01 08:04:23 +0000	[diff] [blame]	5879	<p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5880	integer bit width. Not all targets support all bit widths however.</p>
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5881	<pre>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5882	declare i8 @llvm.cttz.i8 (i8 <src>)
				5883	declare i16 @llvm.cttz.i16(i16 <src>)
Anton Korobeynikov	ec43a06	2007-03-22 00:02:17 +0000	[diff] [blame]	5884	declare i32 @llvm.cttz.i32(i32 <src>)
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5885	declare i64 @llvm.cttz.i64(i64 <src>)
				5886	declare i256 @llvm.cttz.i256(i256 <src>)
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5887	</pre>
				5888
				5889	<h5>Overview:</h5>
				5890
				5891	<p>
Reid Spencer	0b11820	2006-01-16 21:12:35 +0000	[diff] [blame]	5892	The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
				5893	trailing zeros.
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5894	</p>
				5895
				5896	<h5>Arguments:</h5>
				5897
				5898	<p>
				5899	The only argument is the value to be counted. The argument may be of any
Reid Spencer	a517338	2007-01-04 16:43:23 +0000	[diff] [blame]	5900	integer type. The return type must match the argument type.
Chris Lattner	eff29ab	2005-05-15 19:39:26 +0000	[diff] [blame]	5901	</p>
				5902
				5903	<h5>Semantics:</h5>
				5904
				5905	<p>
				5906	The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros
				5907	in a variable. If the src == 0 then the result is the size in bits of the type
				5908	of src. For example, <tt>llvm.cttz(2) = 1</tt>.
				5909	</p>
				5910	</div>
				5911
Reid Spencer	497d93e	2007-04-01 08:27:01 +0000	[diff] [blame]	5912	<!-- _______________________________________________________________________ -->
				5913	<div class="doc_subsubsection">
Reid Spencer	beacf66	2007-04-10 02:51:31 +0000	[diff] [blame]	5914	<a name="int_part_select">'<tt>llvm.part.select.*</tt>' Intrinsic</a>
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5915	</div>
				5916
				5917	<div class="doc_text">
				5918
				5919	<h5>Syntax:</h5>
Reid Spencer	beacf66	2007-04-10 02:51:31 +0000	[diff] [blame]	5920	<p>This is an overloaded intrinsic. You can use <tt>llvm.part.select</tt>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5921	on any integer bit width.</p>
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5922	<pre>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5923	declare i17 @llvm.part.select.i17 (i17 %val, i32 %loBit, i32 %hiBit)
				5924	declare i29 @llvm.part.select.i29 (i29 %val, i32 %loBit, i32 %hiBit)
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5925	</pre>
				5926
				5927	<h5>Overview:</h5>
Reid Spencer	beacf66	2007-04-10 02:51:31 +0000	[diff] [blame]	5928	<p>The '<tt>llvm.part.select</tt>' family of intrinsic functions selects a
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5929	range of bits from an integer value and returns them in the same bit width as
				5930	the original value.</p>
				5931
				5932	<h5>Arguments:</h5>
				5933	<p>The first argument, <tt>%val</tt> and the result may be integer types of
				5934	any bit width but they must have the same bit width. The second and third
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5935	arguments must be <tt>i32</tt> type since they specify only a bit index.</p>
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5936
				5937	<h5>Semantics:</h5>
Reid Spencer	beacf66	2007-04-10 02:51:31 +0000	[diff] [blame]	5938	<p>The operation of the '<tt>llvm.part.select</tt>' intrinsic has two modes
Reid Spencer	a3e435f	2007-04-04 02:42:35 +0000	[diff] [blame]	5939	of operation: forwards and reverse. If <tt>%loBit</tt> is greater than
				5940	<tt>%hiBits</tt> then the intrinsic operates in reverse mode. Otherwise it
				5941	operates in forward mode.</p>
				5942	<p>In forward mode, this intrinsic is the equivalent of shifting <tt>%val</tt>
				5943	right by <tt>%loBit</tt> bits and then ANDing it with a mask with
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5944	only the <tt>%hiBit - %loBit</tt> bits set, as follows:</p>
				5945	<ol>
				5946	<li>The <tt>%val</tt> is shifted right (LSHR) by the number of bits specified
				5947	by <tt>%loBits</tt>. This normalizes the value to the low order bits.</li>
				5948	<li>The <tt>%loBits</tt> value is subtracted from the <tt>%hiBits</tt> value
				5949	to determine the number of bits to retain.</li>
				5950	<li>A mask of the retained bits is created by shifting a -1 value.</li>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5951	<li>The mask is ANDed with <tt>%val</tt> to produce the result.</li>
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5952	</ol>
Reid Spencer	d6a85b5	2007-05-14 16:14:57 +0000	[diff] [blame]	5953	<p>In reverse mode, a similar computation is made except that the bits are
				5954	returned in the reverse order. So, for example, if <tt>X</tt> has the value
				5955	<tt>i16 0x0ACF (101011001111)</tt> and we apply
				5956	<tt>part.select(i16 X, 8, 3)</tt> to it, we get back the value
				5957	<tt>i16 0x0026 (000000100110)</tt>.</p>
Reid Spencer	a13ba7d	2007-04-01 19:00:37 +0000	[diff] [blame]	5958	</div>
				5959
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5960	<div class="doc_subsubsection">
				5961	<a name="int_part_set">'<tt>llvm.part.set.*</tt>' Intrinsic</a>
				5962	</div>
				5963
				5964	<div class="doc_text">
				5965
				5966	<h5>Syntax:</h5>
				5967	<p>This is an overloaded intrinsic. You can use <tt>llvm.part.set</tt>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5968	on any integer bit width.</p>
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5969	<pre>
Chandler Carruth	6994040	2007-08-04 01:51:18 +0000	[diff] [blame]	5970	declare i17 @llvm.part.set.i17.i9 (i17 %val, i9 %repl, i32 %lo, i32 %hi)
				5971	declare i29 @llvm.part.set.i29.i9 (i29 %val, i9 %repl, i32 %lo, i32 %hi)
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5972	</pre>
				5973
				5974	<h5>Overview:</h5>
				5975	<p>The '<tt>llvm.part.set</tt>' family of intrinsic functions replaces a range
				5976	of bits in an integer value with another integer value. It returns the integer
				5977	with the replaced bits.</p>
				5978
				5979	<h5>Arguments:</h5>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	5980	<p>The first argument, <tt>%val</tt>, and the result may be integer types of
				5981	any bit width, but they must have the same bit width. <tt>%val</tt> is the value
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5982	whose bits will be replaced. The second argument, <tt>%repl</tt> may be an
				5983	integer of any bit width. The third and fourth arguments must be <tt>i32</tt>
				5984	type since they specify only a bit index.</p>
				5985
				5986	<h5>Semantics:</h5>
				5987	<p>The operation of the '<tt>llvm.part.set</tt>' intrinsic has two modes
				5988	of operation: forwards and reverse. If <tt>%lo</tt> is greater than
				5989	<tt>%hi</tt> then the intrinsic operates in reverse mode. Otherwise it
				5990	operates in forward mode.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	5991
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5992	<p>For both modes, the <tt>%repl</tt> value is prepared for use by either
				5993	truncating it down to the size of the replacement area or zero extending it
				5994	up to that size.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	5995
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	5996	<p>In forward mode, the bits between <tt>%lo</tt> and <tt>%hi</tt> (inclusive)
				5997	are replaced with corresponding bits from <tt>%repl</tt>. That is the 0th bit
				5998	in <tt>%repl</tt> replaces the <tt>%lo</tt>th bit in <tt>%val</tt> and etc. up
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	5999	to the <tt>%hi</tt>th bit.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6000
Reid Spencer	c6749c4	2007-05-14 16:50:20 +0000	[diff] [blame]	6001	<p>In reverse mode, a similar computation is made except that the bits are
				6002	reversed. That is, the <tt>0</tt>th bit in <tt>%repl</tt> replaces the
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	6003	<tt>%hi</tt> bit in <tt>%val</tt> and etc. down to the <tt>%lo</tt>th bit.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6004
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	6005	<h5>Examples:</h5>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6006
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	6007	<pre>
Reid Spencer	f0dbf64	2007-04-12 01:03:03 +0000	[diff] [blame]	6008	llvm.part.set(0xFFFF, 0, 4, 7) -> 0xFF0F
Reid Spencer	c6749c4	2007-05-14 16:50:20 +0000	[diff] [blame]	6009	llvm.part.set(0xFFFF, 0, 7, 4) -> 0xFF0F
				6010	llvm.part.set(0xFFFF, 1, 7, 4) -> 0xFF8F
				6011	llvm.part.set(0xFFFF, F, 8, 3) -> 0xFFE7
Reid Spencer	f0dbf64	2007-04-12 01:03:03 +0000	[diff] [blame]	6012	llvm.part.set(0xFFFF, 0, 3, 8) -> 0xFE07
Reid Spencer	c891084	2007-04-11 23:49:50 +0000	[diff] [blame]	6013	</pre>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6014
				6015	</div>
				6016
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6017	<!-- ======================================================================= -->
				6018	<div class="doc_subsection">
				6019	<a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
				6020	</div>
				6021
				6022	<div class="doc_text">
				6023	<p>
				6024	LLVM provides intrinsics for some arithmetic with overflow operations.
				6025	</p>
				6026
				6027	</div>
				6028
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6029	<!-- _______________________________________________________________________ -->
				6030	<div class="doc_subsubsection">
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6031	<a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6032	</div>
				6033
				6034	<div class="doc_text">
				6035
				6036	<h5>Syntax:</h5>
				6037
				6038	<p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6039	on any integer bit width.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6040
				6041	<pre>
				6042	declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
				6043	declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
				6044	declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
				6045	</pre>
				6046
				6047	<h5>Overview:</h5>
				6048
				6049	<p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
				6050	a signed addition of the two arguments, and indicate whether an overflow
				6051	occurred during the signed summation.</p>
				6052
				6053	<h5>Arguments:</h5>
				6054
				6055	<p>The arguments (%a and %b) and the first element of the result structure may
				6056	be of integer types of any bit width, but they must have the same bit width. The
				6057	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6058	and <tt>%b</tt> are the two values that will undergo signed addition.</p>
				6059
				6060	<h5>Semantics:</h5>
				6061
				6062	<p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
				6063	a signed addition of the two variables. They return a structure — the
				6064	first element of which is the signed summation, and the second element of which
				6065	is a bit specifying if the signed summation resulted in an overflow.</p>
				6066
				6067	<h5>Examples:</h5>
				6068	<pre>
				6069	%res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
				6070	%sum = extractvalue {i32, i1} %res, 0
				6071	%obit = extractvalue {i32, i1} %res, 1
				6072	br i1 %obit, label %overflow, label %normal
				6073	</pre>
				6074
				6075	</div>
				6076
				6077	<!-- _______________________________________________________________________ -->
				6078	<div class="doc_subsubsection">
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6079	<a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6080	</div>
				6081
				6082	<div class="doc_text">
				6083
				6084	<h5>Syntax:</h5>
				6085
				6086	<p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6087	on any integer bit width.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6088
				6089	<pre>
				6090	declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
				6091	declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
				6092	declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
				6093	</pre>
				6094
				6095	<h5>Overview:</h5>
				6096
				6097	<p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
				6098	an unsigned addition of the two arguments, and indicate whether a carry occurred
				6099	during the unsigned summation.</p>
				6100
				6101	<h5>Arguments:</h5>
				6102
				6103	<p>The arguments (%a and %b) and the first element of the result structure may
				6104	be of integer types of any bit width, but they must have the same bit width. The
				6105	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6106	and <tt>%b</tt> are the two values that will undergo unsigned addition.</p>
				6107
				6108	<h5>Semantics:</h5>
				6109
				6110	<p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
				6111	an unsigned addition of the two arguments. They return a structure — the
				6112	first element of which is the sum, and the second element of which is a bit
				6113	specifying if the unsigned summation resulted in a carry.</p>
				6114
				6115	<h5>Examples:</h5>
				6116	<pre>
				6117	%res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
				6118	%sum = extractvalue {i32, i1} %res, 0
				6119	%obit = extractvalue {i32, i1} %res, 1
				6120	br i1 %obit, label %carry, label %normal
				6121	</pre>
				6122
				6123	</div>
				6124
				6125	<!-- _______________________________________________________________________ -->
				6126	<div class="doc_subsubsection">
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6127	<a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6128	</div>
				6129
				6130	<div class="doc_text">
				6131
				6132	<h5>Syntax:</h5>
				6133
				6134	<p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6135	on any integer bit width.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6136
				6137	<pre>
				6138	declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
				6139	declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
				6140	declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
				6141	</pre>
				6142
				6143	<h5>Overview:</h5>
				6144
				6145	<p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
				6146	a signed subtraction of the two arguments, and indicate whether an overflow
				6147	occurred during the signed subtraction.</p>
				6148
				6149	<h5>Arguments:</h5>
				6150
				6151	<p>The arguments (%a and %b) and the first element of the result structure may
				6152	be of integer types of any bit width, but they must have the same bit width. The
				6153	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6154	and <tt>%b</tt> are the two values that will undergo signed subtraction.</p>
				6155
				6156	<h5>Semantics:</h5>
				6157
				6158	<p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
				6159	a signed subtraction of the two arguments. They return a structure — the
				6160	first element of which is the subtraction, and the second element of which is a bit
				6161	specifying if the signed subtraction resulted in an overflow.</p>
				6162
				6163	<h5>Examples:</h5>
				6164	<pre>
				6165	%res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
				6166	%sum = extractvalue {i32, i1} %res, 0
				6167	%obit = extractvalue {i32, i1} %res, 1
				6168	br i1 %obit, label %overflow, label %normal
				6169	</pre>
				6170
				6171	</div>
				6172
				6173	<!-- _______________________________________________________________________ -->
				6174	<div class="doc_subsubsection">
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6175	<a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6176	</div>
				6177
				6178	<div class="doc_text">
				6179
				6180	<h5>Syntax:</h5>
				6181
				6182	<p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6183	on any integer bit width.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6184
				6185	<pre>
				6186	declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
				6187	declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
				6188	declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
				6189	</pre>
				6190
				6191	<h5>Overview:</h5>
				6192
				6193	<p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
				6194	an unsigned subtraction of the two arguments, and indicate whether an overflow
				6195	occurred during the unsigned subtraction.</p>
				6196
				6197	<h5>Arguments:</h5>
				6198
				6199	<p>The arguments (%a and %b) and the first element of the result structure may
				6200	be of integer types of any bit width, but they must have the same bit width. The
				6201	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6202	and <tt>%b</tt> are the two values that will undergo unsigned subtraction.</p>
				6203
				6204	<h5>Semantics:</h5>
				6205
				6206	<p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
				6207	an unsigned subtraction of the two arguments. They return a structure — the
				6208	first element of which is the subtraction, and the second element of which is a bit
				6209	specifying if the unsigned subtraction resulted in an overflow.</p>
				6210
				6211	<h5>Examples:</h5>
				6212	<pre>
				6213	%res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
				6214	%sum = extractvalue {i32, i1} %res, 0
				6215	%obit = extractvalue {i32, i1} %res, 1
				6216	br i1 %obit, label %overflow, label %normal
				6217	</pre>
				6218
				6219	</div>
				6220
				6221	<!-- _______________________________________________________________________ -->
				6222	<div class="doc_subsubsection">
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6223	<a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6224	</div>
				6225
				6226	<div class="doc_text">
				6227
				6228	<h5>Syntax:</h5>
				6229
				6230	<p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
Bill Wendling	da01af7	2009-02-08 04:04:40 +0000	[diff] [blame]	6231	on any integer bit width.</p>
Bill Wendling	ac1df8e	2009-02-08 01:40:31 +0000	[diff] [blame]	6232
				6233	<pre>
				6234	declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
				6235	declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
				6236	declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
				6237	</pre>
				6238
				6239	<h5>Overview:</h5>
				6240
				6241	<p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
				6242	a signed multiplication of the two arguments, and indicate whether an overflow
				6243	occurred during the signed multiplication.</p>
				6244
				6245	<h5>Arguments:</h5>
				6246
				6247	<p>The arguments (%a and %b) and the first element of the result structure may
				6248	be of integer types of any bit width, but they must have the same bit width. The
				6249	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6250	and <tt>%b</tt> are the two values that will undergo signed multiplication.</p>
				6251
				6252	<h5>Semantics:</h5>
				6253
				6254	<p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
				6255	a signed multiplication of the two arguments. They return a structure —
				6256	the first element of which is the multiplication, and the second element of
				6257	which is a bit specifying if the signed multiplication resulted in an
				6258	overflow.</p>
				6259
				6260	<h5>Examples:</h5>
				6261	<pre>
				6262	%res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
				6263	%sum = extractvalue {i32, i1} %res, 0
				6264	%obit = extractvalue {i32, i1} %res, 1
				6265	br i1 %obit, label %overflow, label %normal
				6266	</pre>
				6267
Reid Spencer	f86037f	2007-04-11 23:23:49 +0000	[diff] [blame]	6268	</div>
				6269
Bill Wendling	41b485c	2009-02-08 23:00:09 +0000	[diff] [blame]	6270	<!-- _______________________________________________________________________ -->
				6271	<div class="doc_subsubsection">
				6272	<a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a>
				6273	</div>
				6274
				6275	<div class="doc_text">
				6276
				6277	<h5>Syntax:</h5>
				6278
				6279	<p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
				6280	on any integer bit width.</p>
				6281
				6282	<pre>
				6283	declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
				6284	declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
				6285	declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
				6286	</pre>
				6287
				6288	<h5>Overview:</h5>
				6289
				6290	<p><i><b>Warning:</b> '<tt>llvm.umul.with.overflow</tt>' is badly broken. It is
				6291	actively being fixed, but it should not currently be used!</i></p>
				6292
				6293	<p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
				6294	a unsigned multiplication of the two arguments, and indicate whether an overflow
				6295	occurred during the unsigned multiplication.</p>
				6296
				6297	<h5>Arguments:</h5>
				6298
				6299	<p>The arguments (%a and %b) and the first element of the result structure may
				6300	be of integer types of any bit width, but they must have the same bit width. The
				6301	second element of the result structure must be of type <tt>i1</tt>. <tt>%a</tt>
				6302	and <tt>%b</tt> are the two values that will undergo unsigned
				6303	multiplication.</p>
				6304
				6305	<h5>Semantics:</h5>
				6306
				6307	<p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
				6308	an unsigned multiplication of the two arguments. They return a structure —
				6309	the first element of which is the multiplication, and the second element of
				6310	which is a bit specifying if the unsigned multiplication resulted in an
				6311	overflow.</p>
				6312
				6313	<h5>Examples:</h5>
				6314	<pre>
				6315	%res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
				6316	%sum = extractvalue {i32, i1} %res, 0
				6317	%obit = extractvalue {i32, i1} %res, 1
				6318	br i1 %obit, label %overflow, label %normal
				6319	</pre>
				6320
				6321	</div>
				6322
Chris Lattner	8ff7590	2004-01-06 05:31:32 +0000	[diff] [blame]	6323	<!-- ======================================================================= -->
				6324	<div class="doc_subsection">
				6325	<a name="int_debugger">Debugger Intrinsics</a>
				6326	</div>
				6327
				6328	<div class="doc_text">
				6329	<p>
				6330	The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
				6331	are described in the <a
				6332	href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
				6333	Debugging</a> document.
				6334	</p>
				6335	</div>
				6336
				6337
Jim Laskey	dd4ef1b	2007-03-14 19:31:19 +0000	[diff] [blame]	6338	<!-- ======================================================================= -->
				6339	<div class="doc_subsection">
				6340	<a name="int_eh">Exception Handling Intrinsics</a>
				6341	</div>
				6342
				6343	<div class="doc_text">
				6344	<p> The LLVM exception handling intrinsics (which all start with
				6345	<tt>llvm.eh.</tt> prefix), are described in the <a
				6346	href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
				6347	Handling</a> document. </p>
				6348	</div>
				6349
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6350	<!-- ======================================================================= -->
				6351	<div class="doc_subsection">
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6352	<a name="int_trampoline">Trampoline Intrinsic</a>
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6353	</div>
				6354
				6355	<div class="doc_text">
				6356	<p>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6357	This intrinsic makes it possible to excise one parameter, marked with
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6358	the <tt>nest</tt> attribute, from a function. The result is a callable
				6359	function pointer lacking the nest parameter - the caller does not need
				6360	to provide a value for it. Instead, the value to use is stored in
				6361	advance in a "trampoline", a block of memory usually allocated
				6362	on the stack, which also contains code to splice the nest value into the
				6363	argument list. This is used to implement the GCC nested function address
				6364	extension.
				6365	</p>
				6366	<p>
				6367	For example, if the function is
				6368	<tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
Bill Wendling	03295ca	2007-09-22 09:23:55 +0000	[diff] [blame]	6369	pointer has signature <tt>i32 (i32, i32)*</tt>. It can be created as follows:</p>
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6370	<pre>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6371	%tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
				6372	%tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
				6373	%p = call i8* @llvm.init.trampoline( i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8), i8 %nval )
				6374	%fp = bitcast i8* %p to i32 (i32, i32)*
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6375	</pre>
Bill Wendling	03295ca	2007-09-22 09:23:55 +0000	[diff] [blame]	6376	<p>The call <tt>%val = call i32 %fp( i32 %x, i32 %y )</tt> is then equivalent
				6377	to <tt>%val = call i32 %f( i8* %nval, i32 %x, i32 %y )</tt>.</p>
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6378	</div>
				6379
				6380	<!-- _______________________________________________________________________ -->
				6381	<div class="doc_subsubsection">
				6382	<a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
				6383	</div>
				6384	<div class="doc_text">
				6385	<h5>Syntax:</h5>
				6386	<pre>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6387	declare i8* @llvm.init.trampoline(i8* <tramp>, i8* <func>, i8* <nval>)
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6388	</pre>
				6389	<h5>Overview:</h5>
				6390	<p>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6391	This fills the memory pointed to by <tt>tramp</tt> with code
				6392	and returns a function pointer suitable for executing it.
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6393	</p>
				6394	<h5>Arguments:</h5>
				6395	<p>
				6396	The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
				6397	pointers. The <tt>tramp</tt> argument must point to a sufficiently large
				6398	and sufficiently aligned block of memory; this memory is written to by the
Duncan Sands	c00c2ba	2007-08-22 23:39:54 +0000	[diff] [blame]	6399	intrinsic. Note that the size and the alignment are target-specific - LLVM
				6400	currently provides no portable way of determining them, so a front-end that
				6401	generates this intrinsic needs to have some target-specific knowledge.
				6402	The <tt>func</tt> argument must hold a function bitcast to an <tt>i8*</tt>.
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6403	</p>
				6404	<h5>Semantics:</h5>
				6405	<p>
				6406	The block of memory pointed to by <tt>tramp</tt> is filled with target
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6407	dependent code, turning it into a function. A pointer to this function is
				6408	returned, but needs to be bitcast to an
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6409	<a href="#int_trampoline">appropriate function pointer type</a>
Duncan Sands	f7331b3	2007-09-11 14:10:23 +0000	[diff] [blame]	6410	before being called. The new function's signature is the same as that of
				6411	<tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
				6412	removed. At most one such <tt>nest</tt> argument is allowed, and it must be
				6413	of pointer type. Calling the new function is equivalent to calling
				6414	<tt>func</tt> with the same argument list, but with <tt>nval</tt> used for the
				6415	missing <tt>nest</tt> argument. If, after calling
				6416	<tt>llvm.init.trampoline</tt>, the memory pointed to by <tt>tramp</tt> is
				6417	modified, then the effect of any later call to the returned function pointer is
				6418	undefined.
Duncan Sands	36397f5	2007-07-27 12:58:54 +0000	[diff] [blame]	6419	</p>
				6420	</div>
				6421
				6422	<!-- ======================================================================= -->
				6423	<div class="doc_subsection">
Andrew Lenharth	22c5c1b	2008-02-16 01:24:58 +0000	[diff] [blame]	6424	<a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
				6425	</div>
				6426
				6427	<div class="doc_text">
				6428	<p>
				6429	These intrinsic functions expand the "universal IR" of LLVM to represent
				6430	hardware constructs for atomic operations and memory synchronization. This
				6431	provides an interface to the hardware, not an interface to the programmer. It
Chris Lattner	d3eda89	2008-08-05 18:29:16 +0000	[diff] [blame]	6432	is aimed at a low enough level to allow any programming models or APIs
				6433	(Application Programming Interfaces) which
Andrew Lenharth	22c5c1b	2008-02-16 01:24:58 +0000	[diff] [blame]	6434	need atomic behaviors to map cleanly onto it. It is also modeled primarily on
				6435	hardware behavior. Just as hardware provides a "universal IR" for source
				6436	languages, it also provides a starting point for developing a "universal"
				6437	atomic operation and synchronization IR.
				6438	</p>
				6439	<p>
				6440	These do <em>not</em> form an API such as high-level threading libraries,
				6441	software transaction memory systems, atomic primitives, and intrinsic
				6442	functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
				6443	application libraries. The hardware interface provided by LLVM should allow
				6444	a clean implementation of all of these APIs and parallel programming models.
				6445	No one model or paradigm should be selected above others unless the hardware
				6446	itself ubiquitously does so.
				6447
				6448	</p>
				6449	</div>
				6450
				6451	<!-- _______________________________________________________________________ -->
				6452	<div class="doc_subsubsection">
				6453	<a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
				6454	</div>
				6455	<div class="doc_text">
				6456	<h5>Syntax:</h5>
				6457	<pre>
				6458	declare void @llvm.memory.barrier( i1 <ll>, i1 <ls>, i1 <sl>, i1 <ss>,
				6459	i1 <device> )
				6460
				6461	</pre>
				6462	<h5>Overview:</h5>
				6463	<p>
				6464	The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
				6465	specific pairs of memory access types.
				6466	</p>
				6467	<h5>Arguments:</h5>
				6468	<p>
				6469	The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
				6470	The first four arguments enables a specific barrier as listed below. The fith
				6471	argument specifies that the barrier applies to io or device or uncached memory.
				6472
				6473	</p>
				6474	<ul>
				6475	<li><tt>ll</tt>: load-load barrier</li>
				6476	<li><tt>ls</tt>: load-store barrier</li>
				6477	<li><tt>sl</tt>: store-load barrier</li>
				6478	<li><tt>ss</tt>: store-store barrier</li>
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	6479	<li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
Andrew Lenharth	22c5c1b	2008-02-16 01:24:58 +0000	[diff] [blame]	6480	</ul>
				6481	<h5>Semantics:</h5>
				6482	<p>
				6483	This intrinsic causes the system to enforce some ordering constraints upon
				6484	the loads and stores of the program. This barrier does not indicate
				6485	<em>when</em> any events will occur, it only enforces an <em>order</em> in
				6486	which they occur. For any of the specified pairs of load and store operations
				6487	(f.ex. load-load, or store-load), all of the first operations preceding the
				6488	barrier will complete before any of the second operations succeeding the
				6489	barrier begin. Specifically the semantics for each pairing is as follows:
				6490	</p>
				6491	<ul>
				6492	<li><tt>ll</tt>: All loads before the barrier must complete before any load
				6493	after the barrier begins.</li>
				6494
				6495	<li><tt>ls</tt>: All loads before the barrier must complete before any
				6496	store after the barrier begins.</li>
				6497	<li><tt>ss</tt>: All stores before the barrier must complete before any
				6498	store after the barrier begins.</li>
				6499	<li><tt>sl</tt>: All stores before the barrier must complete before any
				6500	load after the barrier begins.</li>
				6501	</ul>
				6502	<p>
				6503	These semantics are applied with a logical "and" behavior when more than one
				6504	is enabled in a single memory barrier intrinsic.
				6505	</p>
				6506	<p>
				6507	Backends may implement stronger barriers than those requested when they do not
				6508	support as fine grained a barrier as requested. Some architectures do not
				6509	need all types of barriers and on such architectures, these become noops.
				6510	</p>
				6511	<h5>Example:</h5>
				6512	<pre>
				6513	%ptr = malloc i32
				6514	store i32 4, %ptr
				6515
				6516	%result1 = load i32* %ptr <i>; yields {i32}:result1 = 4</i>
				6517	call void @llvm.memory.barrier( i1 false, i1 true, i1 false, i1 false )
				6518	<i>; guarantee the above finishes</i>
				6519	store i32 8, %ptr <i>; before this begins</i>
				6520	</pre>
				6521	</div>
				6522
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6523	<!-- _______________________________________________________________________ -->
				6524	<div class="doc_subsubsection">
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6525	<a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6526	</div>
				6527	<div class="doc_text">
				6528	<h5>Syntax:</h5>
				6529	<p>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6530	This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
				6531	any integer bit width and for different address spaces. Not all targets
				6532	support all bit widths however.</p>
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6533
				6534	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6535	declare i8 @llvm.atomic.cmp.swap.i8.p0i8( i8* <ptr>, i8 <cmp>, i8 <val> )
				6536	declare i16 @llvm.atomic.cmp.swap.i16.p0i16( i16* <ptr>, i16 <cmp>, i16 <val> )
				6537	declare i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* <ptr>, i32 <cmp>, i32 <val> )
				6538	declare i64 @llvm.atomic.cmp.swap.i64.p0i64( i64* <ptr>, i64 <cmp>, i64 <val> )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6539
				6540	</pre>
				6541	<h5>Overview:</h5>
				6542	<p>
				6543	This loads a value in memory and compares it to a given value. If they are
				6544	equal, it stores a new value into the memory.
				6545	</p>
				6546	<h5>Arguments:</h5>
				6547	<p>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6548	The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result as
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6549	well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
				6550	same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
				6551	this integer type. While any bit width integer may be used, targets may only
				6552	lower representations they support in hardware.
				6553
				6554	</p>
				6555	<h5>Semantics:</h5>
				6556	<p>
				6557	This entire intrinsic must be executed atomically. It first loads the value
				6558	in memory pointed to by <tt>ptr</tt> and compares it with the value
				6559	<tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the memory. The
				6560	loaded value is yielded in all cases. This provides the equivalent of an
				6561	atomic compare-and-swap operation within the SSA framework.
				6562	</p>
				6563	<h5>Examples:</h5>
				6564
				6565	<pre>
				6566	%ptr = malloc i32
				6567	store i32 4, %ptr
				6568
				6569	%val1 = add i32 4, 4
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6570	%result1 = call i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* %ptr, i32 4, %val1 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6571	<i>; yields {i32}:result1 = 4</i>
				6572	%stored1 = icmp eq i32 %result1, 4 <i>; yields {i1}:stored1 = true</i>
				6573	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = 8</i>
				6574
				6575	%val2 = add i32 1, 1
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6576	%result2 = call i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* %ptr, i32 5, %val2 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6577	<i>; yields {i32}:result2 = 8</i>
				6578	%stored2 = icmp eq i32 %result2, 5 <i>; yields {i1}:stored2 = false</i>
				6579
				6580	%memval2 = load i32* %ptr <i>; yields {i32}:memval2 = 8</i>
				6581	</pre>
				6582	</div>
				6583
				6584	<!-- _______________________________________________________________________ -->
				6585	<div class="doc_subsubsection">
				6586	<a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
				6587	</div>
				6588	<div class="doc_text">
				6589	<h5>Syntax:</h5>
				6590
				6591	<p>
				6592	This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
				6593	integer bit width. Not all targets support all bit widths however.</p>
				6594	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6595	declare i8 @llvm.atomic.swap.i8.p0i8( i8* <ptr>, i8 <val> )
				6596	declare i16 @llvm.atomic.swap.i16.p0i16( i16* <ptr>, i16 <val> )
				6597	declare i32 @llvm.atomic.swap.i32.p0i32( i32* <ptr>, i32 <val> )
				6598	declare i64 @llvm.atomic.swap.i64.p0i64( i64* <ptr>, i64 <val> )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6599
				6600	</pre>
				6601	<h5>Overview:</h5>
				6602	<p>
				6603	This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
				6604	the value from memory. It then stores the value in <tt>val</tt> in the memory
				6605	at <tt>ptr</tt>.
				6606	</p>
				6607	<h5>Arguments:</h5>
				6608
				6609	<p>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6610	The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both the
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6611	<tt>val</tt> argument and the result must be integers of the same bit width.
				6612	The first argument, <tt>ptr</tt>, must be a pointer to a value of this
				6613	integer type. The targets may only lower integer representations they
				6614	support.
				6615	</p>
				6616	<h5>Semantics:</h5>
				6617	<p>
				6618	This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
				6619	stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
				6620	equivalent of an atomic swap operation within the SSA framework.
				6621
				6622	</p>
				6623	<h5>Examples:</h5>
				6624	<pre>
				6625	%ptr = malloc i32
				6626	store i32 4, %ptr
				6627
				6628	%val1 = add i32 4, 4
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6629	%result1 = call i32 @llvm.atomic.swap.i32.p0i32( i32* %ptr, i32 %val1 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6630	<i>; yields {i32}:result1 = 4</i>
				6631	%stored1 = icmp eq i32 %result1, 4 <i>; yields {i1}:stored1 = true</i>
				6632	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = 8</i>
				6633
				6634	%val2 = add i32 1, 1
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6635	%result2 = call i32 @llvm.atomic.swap.i32.p0i32( i32* %ptr, i32 %val2 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6636	<i>; yields {i32}:result2 = 8</i>
				6637
				6638	%stored2 = icmp eq i32 %result2, 8 <i>; yields {i1}:stored2 = true</i>
				6639	%memval2 = load i32* %ptr <i>; yields {i32}:memval2 = 2</i>
				6640	</pre>
				6641	</div>
				6642
				6643	<!-- _______________________________________________________________________ -->
				6644	<div class="doc_subsubsection">
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6645	<a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6646
				6647	</div>
				6648	<div class="doc_text">
				6649	<h5>Syntax:</h5>
				6650	<p>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6651	This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on any
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6652	integer bit width. Not all targets support all bit widths however.</p>
				6653	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6654	declare i8 @llvm.atomic.load.add.i8..p0i8( i8* <ptr>, i8 <delta> )
				6655	declare i16 @llvm.atomic.load.add.i16..p0i16( i16* <ptr>, i16 <delta> )
				6656	declare i32 @llvm.atomic.load.add.i32..p0i32( i32* <ptr>, i32 <delta> )
				6657	declare i64 @llvm.atomic.load.add.i64..p0i64( i64* <ptr>, i64 <delta> )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6658
				6659	</pre>
				6660	<h5>Overview:</h5>
				6661	<p>
				6662	This intrinsic adds <tt>delta</tt> to the value stored in memory at
				6663	<tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.
				6664	</p>
				6665	<h5>Arguments:</h5>
				6666	<p>
				6667
				6668	The intrinsic takes two arguments, the first a pointer to an integer value
				6669	and the second an integer value. The result is also an integer value. These
				6670	integer types can have any bit width, but they must all have the same bit
				6671	width. The targets may only lower integer representations they support.
				6672	</p>
				6673	<h5>Semantics:</h5>
				6674	<p>
				6675	This intrinsic does a series of operations atomically. It first loads the
				6676	value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
				6677	to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.
				6678	</p>
				6679
				6680	<h5>Examples:</h5>
				6681	<pre>
				6682	%ptr = malloc i32
				6683	store i32 4, %ptr
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6684	%result1 = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 4 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6685	<i>; yields {i32}:result1 = 4</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6686	%result2 = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 2 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6687	<i>; yields {i32}:result2 = 8</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6688	%result3 = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 5 )
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6689	<i>; yields {i32}:result3 = 10</i>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6690	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = 15</i>
Andrew Lenharth	ab0b949	2008-02-21 06:45:13 +0000	[diff] [blame]	6691	</pre>
				6692	</div>
				6693
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6694	<!-- _______________________________________________________________________ -->
				6695	<div class="doc_subsubsection">
				6696	<a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
				6697
				6698	</div>
				6699	<div class="doc_text">
				6700	<h5>Syntax:</h5>
				6701	<p>
				6702	This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6703	any integer bit width and for different address spaces. Not all targets
				6704	support all bit widths however.</p>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6705	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6706	declare i8 @llvm.atomic.load.sub.i8.p0i32( i8* <ptr>, i8 <delta> )
				6707	declare i16 @llvm.atomic.load.sub.i16.p0i32( i16* <ptr>, i16 <delta> )
				6708	declare i32 @llvm.atomic.load.sub.i32.p0i32( i32* <ptr>, i32 <delta> )
				6709	declare i64 @llvm.atomic.load.sub.i64.p0i32( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6710
				6711	</pre>
				6712	<h5>Overview:</h5>
				6713	<p>
				6714	This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
				6715	<tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.
				6716	</p>
				6717	<h5>Arguments:</h5>
				6718	<p>
				6719
				6720	The intrinsic takes two arguments, the first a pointer to an integer value
				6721	and the second an integer value. The result is also an integer value. These
				6722	integer types can have any bit width, but they must all have the same bit
				6723	width. The targets may only lower integer representations they support.
				6724	</p>
				6725	<h5>Semantics:</h5>
				6726	<p>
				6727	This intrinsic does a series of operations atomically. It first loads the
				6728	value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
				6729	result to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.
				6730	</p>
				6731
				6732	<h5>Examples:</h5>
				6733	<pre>
				6734	%ptr = malloc i32
				6735	store i32 8, %ptr
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6736	%result1 = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 4 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6737	<i>; yields {i32}:result1 = 8</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6738	%result2 = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 2 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6739	<i>; yields {i32}:result2 = 4</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6740	%result3 = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 5 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6741	<i>; yields {i32}:result3 = 2</i>
				6742	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = -3</i>
				6743	</pre>
				6744	</div>
				6745
				6746	<!-- _______________________________________________________________________ -->
				6747	<div class="doc_subsubsection">
				6748	<a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
				6749	<a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
				6750	<a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
				6751	<a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
				6752
				6753	</div>
				6754	<div class="doc_text">
				6755	<h5>Syntax:</h5>
				6756	<p>
				6757	These are overloaded intrinsics. You can use <tt>llvm.atomic.load_and</tt>,
				6758	<tt>llvm.atomic.load_nand</tt>, <tt>llvm.atomic.load_or</tt>, and
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6759	<tt>llvm.atomic.load_xor</tt> on any integer bit width and for different
				6760	address spaces. Not all targets support all bit widths however.</p>
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6761	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6762	declare i8 @llvm.atomic.load.and.i8.p0i8( i8* <ptr>, i8 <delta> )
				6763	declare i16 @llvm.atomic.load.and.i16.p0i16( i16* <ptr>, i16 <delta> )
				6764	declare i32 @llvm.atomic.load.and.i32.p0i32( i32* <ptr>, i32 <delta> )
				6765	declare i64 @llvm.atomic.load.and.i64.p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6766
				6767	</pre>
				6768
				6769	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6770	declare i8 @llvm.atomic.load.or.i8.p0i8( i8* <ptr>, i8 <delta> )
				6771	declare i16 @llvm.atomic.load.or.i16.p0i16( i16* <ptr>, i16 <delta> )
				6772	declare i32 @llvm.atomic.load.or.i32.p0i32( i32* <ptr>, i32 <delta> )
				6773	declare i64 @llvm.atomic.load.or.i64.p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6774
				6775	</pre>
				6776
				6777	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6778	declare i8 @llvm.atomic.load.nand.i8.p0i32( i8* <ptr>, i8 <delta> )
				6779	declare i16 @llvm.atomic.load.nand.i16.p0i32( i16* <ptr>, i16 <delta> )
				6780	declare i32 @llvm.atomic.load.nand.i32.p0i32( i32* <ptr>, i32 <delta> )
				6781	declare i64 @llvm.atomic.load.nand.i64.p0i32( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6782
				6783	</pre>
				6784
				6785	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6786	declare i8 @llvm.atomic.load.xor.i8.p0i32( i8* <ptr>, i8 <delta> )
				6787	declare i16 @llvm.atomic.load.xor.i16.p0i32( i16* <ptr>, i16 <delta> )
				6788	declare i32 @llvm.atomic.load.xor.i32.p0i32( i32* <ptr>, i32 <delta> )
				6789	declare i64 @llvm.atomic.load.xor.i64.p0i32( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6790
				6791	</pre>
				6792	<h5>Overview:</h5>
				6793	<p>
				6794	These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
				6795	the value stored in memory at <tt>ptr</tt>. It yields the original value
				6796	at <tt>ptr</tt>.
				6797	</p>
				6798	<h5>Arguments:</h5>
				6799	<p>
				6800
				6801	These intrinsics take two arguments, the first a pointer to an integer value
				6802	and the second an integer value. The result is also an integer value. These
				6803	integer types can have any bit width, but they must all have the same bit
				6804	width. The targets may only lower integer representations they support.
				6805	</p>
				6806	<h5>Semantics:</h5>
				6807	<p>
				6808	These intrinsics does a series of operations atomically. They first load the
				6809	value stored at <tt>ptr</tt>. They then do the bitwise operation
				6810	<tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the original
				6811	value stored at <tt>ptr</tt>.
				6812	</p>
				6813
				6814	<h5>Examples:</h5>
				6815	<pre>
				6816	%ptr = malloc i32
				6817	store i32 0x0F0F, %ptr
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6818	%result0 = call i32 @llvm.atomic.load.nand.i32.p0i32( i32* %ptr, i32 0xFF )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6819	<i>; yields {i32}:result0 = 0x0F0F</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6820	%result1 = call i32 @llvm.atomic.load.and.i32.p0i32( i32* %ptr, i32 0xFF )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6821	<i>; yields {i32}:result1 = 0xFFFFFFF0</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6822	%result2 = call i32 @llvm.atomic.load.or.i32.p0i32( i32* %ptr, i32 0F )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6823	<i>; yields {i32}:result2 = 0xF0</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6824	%result3 = call i32 @llvm.atomic.load.xor.i32.p0i32( i32* %ptr, i32 0F )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6825	<i>; yields {i32}:result3 = FF</i>
				6826	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = F0</i>
				6827	</pre>
				6828	</div>
				6829
				6830
				6831	<!-- _______________________________________________________________________ -->
				6832	<div class="doc_subsubsection">
				6833	<a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
				6834	<a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
				6835	<a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
				6836	<a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
				6837
				6838	</div>
				6839	<div class="doc_text">
				6840	<h5>Syntax:</h5>
				6841	<p>
				6842	These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
				6843	<tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6844	<tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
				6845	address spaces. Not all targets
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6846	support all bit widths however.</p>
				6847	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6848	declare i8 @llvm.atomic.load.max.i8.p0i8( i8* <ptr>, i8 <delta> )
				6849	declare i16 @llvm.atomic.load.max.i16.p0i16( i16* <ptr>, i16 <delta> )
				6850	declare i32 @llvm.atomic.load.max.i32.p0i32( i32* <ptr>, i32 <delta> )
				6851	declare i64 @llvm.atomic.load.max.i64.p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6852
				6853	</pre>
				6854
				6855	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6856	declare i8 @llvm.atomic.load.min.i8.p0i8( i8* <ptr>, i8 <delta> )
				6857	declare i16 @llvm.atomic.load.min.i16.p0i16( i16* <ptr>, i16 <delta> )
				6858	declare i32 @llvm.atomic.load.min.i32..p0i32( i32* <ptr>, i32 <delta> )
				6859	declare i64 @llvm.atomic.load.min.i64..p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6860
				6861	</pre>
				6862
				6863	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6864	declare i8 @llvm.atomic.load.umax.i8.p0i8( i8* <ptr>, i8 <delta> )
				6865	declare i16 @llvm.atomic.load.umax.i16.p0i16( i16* <ptr>, i16 <delta> )
				6866	declare i32 @llvm.atomic.load.umax.i32.p0i32( i32* <ptr>, i32 <delta> )
				6867	declare i64 @llvm.atomic.load.umax.i64.p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6868
				6869	</pre>
				6870
				6871	<pre>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6872	declare i8 @llvm.atomic.load.umin.i8..p0i8( i8* <ptr>, i8 <delta> )
				6873	declare i16 @llvm.atomic.load.umin.i16.p0i16( i16* <ptr>, i16 <delta> )
				6874	declare i32 @llvm.atomic.load.umin.i32..p0i32( i32* <ptr>, i32 <delta> )
				6875	declare i64 @llvm.atomic.load.umin.i64..p0i64( i64* <ptr>, i64 <delta> )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6876
				6877	</pre>
				6878	<h5>Overview:</h5>
				6879	<p>
				6880	These intrinsics takes the signed or unsigned minimum or maximum of
				6881	<tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
				6882	original value at <tt>ptr</tt>.
				6883	</p>
				6884	<h5>Arguments:</h5>
				6885	<p>
				6886
				6887	These intrinsics take two arguments, the first a pointer to an integer value
				6888	and the second an integer value. The result is also an integer value. These
				6889	integer types can have any bit width, but they must all have the same bit
				6890	width. The targets may only lower integer representations they support.
				6891	</p>
				6892	<h5>Semantics:</h5>
				6893	<p>
				6894	These intrinsics does a series of operations atomically. They first load the
				6895	value stored at <tt>ptr</tt>. They then do the signed or unsigned min or max
				6896	<tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They yield
				6897	the original value stored at <tt>ptr</tt>.
				6898	</p>
				6899
				6900	<h5>Examples:</h5>
				6901	<pre>
				6902	%ptr = malloc i32
				6903	store i32 7, %ptr
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6904	%result0 = call i32 @llvm.atomic.load.min.i32.p0i32( i32* %ptr, i32 -2 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6905	<i>; yields {i32}:result0 = 7</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6906	%result1 = call i32 @llvm.atomic.load.max.i32.p0i32( i32* %ptr, i32 8 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6907	<i>; yields {i32}:result1 = -2</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6908	%result2 = call i32 @llvm.atomic.load.umin.i32.p0i32( i32* %ptr, i32 10 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6909	<i>; yields {i32}:result2 = 8</i>
Mon P Wang	e3b3a72	2008-07-30 04:36:53 +0000	[diff] [blame]	6910	%result3 = call i32 @llvm.atomic.load.umax.i32.p0i32( i32* %ptr, i32 30 )
Mon P Wang	2887310	2008-06-25 08:15:39 +0000	[diff] [blame]	6911	<i>; yields {i32}:result3 = 8</i>
				6912	%memval1 = load i32* %ptr <i>; yields {i32}:memval1 = 30</i>
				6913	</pre>
				6914	</div>
Andrew Lenharth	22c5c1b	2008-02-16 01:24:58 +0000	[diff] [blame]	6915
				6916	<!-- ======================================================================= -->
				6917	<div class="doc_subsection">
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6918	<a name="int_general">General Intrinsics</a>
				6919	</div>
				6920
				6921	<div class="doc_text">
				6922	<p> This class of intrinsics is designed to be generic and has
				6923	no specific purpose. </p>
				6924	</div>
				6925
				6926	<!-- _______________________________________________________________________ -->
				6927	<div class="doc_subsubsection">
				6928	<a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
				6929	</div>
				6930
				6931	<div class="doc_text">
				6932
				6933	<h5>Syntax:</h5>
				6934	<pre>
Tanya Lattner	d2e8442	2007-06-18 23:42:37 +0000	[diff] [blame]	6935	declare void @llvm.var.annotation(i8* <val>, i8* <str>, i8* <str>, i32 <int> )
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6936	</pre>
				6937
				6938	<h5>Overview:</h5>
				6939
				6940	<p>
				6941	The '<tt>llvm.var.annotation</tt>' intrinsic
				6942	</p>
				6943
				6944	<h5>Arguments:</h5>
				6945
				6946	<p>
Tanya Lattner	d2e8442	2007-06-18 23:42:37 +0000	[diff] [blame]	6947	The first argument is a pointer to a value, the second is a pointer to a
				6948	global string, the third is a pointer to a global string which is the source
				6949	file name, and the last argument is the line number.
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6950	</p>
				6951
				6952	<h5>Semantics:</h5>
				6953
				6954	<p>
Anton Korobeynikov	4cb8618	2008-01-15 22:31:34 +0000	[diff] [blame]	6955	This intrinsic allows annotation of local variables with arbitrary strings.
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6956	This can be useful for special purpose optimizations that want to look for these
Anton Korobeynikov	4cb8618	2008-01-15 22:31:34 +0000	[diff] [blame]	6957	annotations. These have no other defined use, they are ignored by code
				6958	generation and optimization.
				6959	</p>
Tanya Lattner	6d806e9	2007-06-15 20:50:54 +0000	[diff] [blame]	6960	</div>
				6961
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6962	<!-- _______________________________________________________________________ -->
				6963	<div class="doc_subsubsection">
Tanya Lattner	e1a8da0	2007-09-21 23:57:59 +0000	[diff] [blame]	6964	<a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6965	</div>
				6966
				6967	<div class="doc_text">
				6968
				6969	<h5>Syntax:</h5>
Tanya Lattner	39cfba6	2007-09-21 23:56:27 +0000	[diff] [blame]	6970	<p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
				6971	any integer bit width.
				6972	</p>
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6973	<pre>
Tanya Lattner	d3989a8	2007-09-22 00:03:01 +0000	[diff] [blame]	6974	declare i8 @llvm.annotation.i8(i8 <val>, i8* <str>, i8* <str>, i32 <int> )
				6975	declare i16 @llvm.annotation.i16(i16 <val>, i8* <str>, i8* <str>, i32 <int> )
				6976	declare i32 @llvm.annotation.i32(i32 <val>, i8* <str>, i8* <str>, i32 <int> )
				6977	declare i64 @llvm.annotation.i64(i64 <val>, i8* <str>, i8* <str>, i32 <int> )
				6978	declare i256 @llvm.annotation.i256(i256 <val>, i8* <str>, i8* <str>, i32 <int> )
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6979	</pre>
				6980
				6981	<h5>Overview:</h5>
Tanya Lattner	39cfba6	2007-09-21 23:56:27 +0000	[diff] [blame]	6982
				6983	<p>
				6984	The '<tt>llvm.annotation</tt>' intrinsic.
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6985	</p>
				6986
				6987	<h5>Arguments:</h5>
				6988
				6989	<p>
				6990	The first argument is an integer value (result of some expression),
				6991	the second is a pointer to a global string, the third is a pointer to a global
				6992	string which is the source file name, and the last argument is the line number.
Tanya Lattner	39cfba6	2007-09-21 23:56:27 +0000	[diff] [blame]	6993	It returns the value of the first argument.
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	6994	</p>
				6995
				6996	<h5>Semantics:</h5>
				6997
				6998	<p>
				6999	This intrinsic allows annotations to be put on arbitrary expressions
				7000	with arbitrary strings. This can be useful for special purpose optimizations
				7001	that want to look for these annotations. These have no other defined use, they
				7002	are ignored by code generation and optimization.
Dan Gohman	0e451ce	2008-10-14 16:51:45 +0000	[diff] [blame]	7003	</p>
Tanya Lattner	b636788	2007-09-21 22:59:12 +0000	[diff] [blame]	7004	</div>
Jim Laskey	dd4ef1b	2007-03-14 19:31:19 +0000	[diff] [blame]	7005
Anton Korobeynikov	4cb8618	2008-01-15 22:31:34 +0000	[diff] [blame]	7006	<!-- _______________________________________________________________________ -->
				7007	<div class="doc_subsubsection">
				7008	<a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
				7009	</div>
				7010
				7011	<div class="doc_text">
				7012
				7013	<h5>Syntax:</h5>
				7014	<pre>
				7015	declare void @llvm.trap()
				7016	</pre>
				7017
				7018	<h5>Overview:</h5>
				7019
				7020	<p>
				7021	The '<tt>llvm.trap</tt>' intrinsic
				7022	</p>
				7023
				7024	<h5>Arguments:</h5>
				7025
				7026	<p>
				7027	None
				7028	</p>
				7029
				7030	<h5>Semantics:</h5>
				7031
				7032	<p>
				7033	This intrinsics is lowered to the target dependent trap instruction. If the
				7034	target does not have a trap instruction, this intrinsic will be lowered to the
				7035	call of the abort() function.
				7036	</p>
				7037	</div>
				7038
Bill Wendling	69e4adb	2008-11-19 05:56:17 +0000	[diff] [blame]	7039	<!-- _______________________________________________________________________ -->
				7040	<div class="doc_subsubsection">
Misha Brukman	dccb025	2008-11-22 23:55:29 +0000	[diff] [blame]	7041	<a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
Bill Wendling	69e4adb	2008-11-19 05:56:17 +0000	[diff] [blame]	7042	</div>
				7043	<div class="doc_text">
				7044	<h5>Syntax:</h5>
				7045	<pre>
				7046	declare void @llvm.stackprotector( i8* <guard>, i8** <slot> )
				7047
				7048	</pre>
				7049	<h5>Overview:</h5>
				7050	<p>
				7051	The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and stores
				7052	it onto the stack at <tt>slot</tt>. The stack slot is adjusted to ensure that
				7053	it is placed on the stack before local variables.
				7054	</p>
				7055	<h5>Arguments:</h5>
				7056	<p>
				7057	The <tt>llvm.stackprotector</tt> intrinsic requires two pointer arguments. The
				7058	first argument is the value loaded from the stack guard
				7059	<tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt> that
				7060	has enough space to hold the value of the guard.
				7061	</p>
				7062	<h5>Semantics:</h5>
				7063	<p>
				7064	This intrinsic causes the prologue/epilogue inserter to force the position of
				7065	the <tt>AllocaInst</tt> stack slot to be before local variables on the
				7066	stack. This is to ensure that if a local variable on the stack is overwritten,
				7067	it will destroy the value of the guard. When the function exits, the guard on
				7068	the stack is checked against the original guard. If they're different, then
				7069	the program aborts by calling the <tt>__stack_chk_fail()</tt> function.
				7070	</p>
				7071	</div>
				7072
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	7073	<!-- *********************************************************************** -->
Chris Lattner	0095054	2001-06-06 20:29:01 +0000	[diff] [blame]	7074	<hr>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	7075	<address>
				7076	<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman	4440870	2008-12-11 17:34:48 +0000	[diff] [blame]	7077	src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	7078	<a href="http://validator.w3.org/check/referer"><img
Misha Brukman	4440870	2008-12-11 17:34:48 +0000	[diff] [blame]	7079	src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	7080
				7081	<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer	05fe4b0	2006-03-14 05:39:39 +0000	[diff] [blame]	7082	<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman	daa4cb0	2004-03-01 17:47:27 +0000	[diff] [blame]	7083	Last modified: $Date$
				7084	</address>
Chris Lattner	c7d3ab3	2008-01-04 04:33:49 +0000	[diff] [blame]	7085
Misha Brukman	9d0919f	2003-11-08 01:05:38 +0000	[diff] [blame]	7086	</body>
				7087	</html>