docs: Correct wording in LangRef relating to available_externally linkage.
[oota-llvm.git] / docs / LangRef.rst
1 ==============================
2 LLVM Language Reference Manual
3 ==============================
4
5 .. contents::
6    :local:
7    :depth: 4
8
9 Abstract
10 ========
11
12 This document is a reference manual for the LLVM assembly language. LLVM
13 is a Static Single Assignment (SSA) based representation that provides
14 type safety, low-level operations, flexibility, and the capability of
15 representing 'all' high-level languages cleanly. It is the common code
16 representation used throughout all phases of the LLVM compilation
17 strategy.
18
19 Introduction
20 ============
21
22 The LLVM code representation is designed to be used in three different
23 forms: as an in-memory compiler IR, as an on-disk bitcode representation
24 (suitable for fast loading by a Just-In-Time compiler), and as a human
25 readable assembly language representation. This allows LLVM to provide a
26 powerful intermediate representation for efficient compiler
27 transformations and analysis, while providing a natural means to debug
28 and visualize the transformations. The three different forms of LLVM are
29 all equivalent. This document describes the human readable
30 representation and notation.
31
32 The LLVM representation aims to be light-weight and low-level while
33 being expressive, typed, and extensible at the same time. It aims to be
34 a "universal IR" of sorts, by being at a low enough level that
35 high-level ideas may be cleanly mapped to it (similar to how
36 microprocessors are "universal IR's", allowing many source languages to
37 be mapped to them). By providing type information, LLVM can be used as
38 the target of optimizations: for example, through pointer analysis, it
39 can be proven that a C automatic variable is never accessed outside of
40 the current function, allowing it to be promoted to a simple SSA value
41 instead of a memory location.
42
43 .. _wellformed:
44
45 Well-Formedness
46 ---------------
47
48 It is important to note that this document describes 'well formed' LLVM
49 assembly language. There is a difference between what the parser accepts
50 and what is considered 'well formed'. For example, the following
51 instruction is syntactically okay, but not well formed:
52
53 .. code-block:: llvm
54
55     %x = add i32 1, %x
56
57 because the definition of ``%x`` does not dominate all of its uses. The
58 LLVM infrastructure provides a verification pass that may be used to
59 verify that an LLVM module is well formed. This pass is automatically
60 run by the parser after parsing input assembly and by the optimizer
61 before it outputs bitcode. The violations pointed out by the verifier
62 pass indicate bugs in transformation passes or input to the parser.
63
64 .. _identifiers:
65
66 Identifiers
67 ===========
68
69 LLVM identifiers come in two basic types: global and local. Global
70 identifiers (functions, global variables) begin with the ``'@'``
71 character. Local identifiers (register names, types) begin with the
72 ``'%'`` character. Additionally, there are three different formats for
73 identifiers, for different purposes:
74
75 #. Named values are represented as a string of characters with their
76    prefix. For example, ``%foo``, ``@DivisionByZero``,
77    ``%a.really.long.identifier``. The actual regular expression used is
78    '``[%@][-a-zA-Z$._][-a-zA-Z$._0-9]*``'. Identifiers that require other
79    characters in their names can be surrounded with quotes. Special
80    characters may be escaped using ``"\xx"`` where ``xx`` is the ASCII
81    code for the character in hexadecimal. In this way, any character can
82    be used in a name value, even quotes themselves. The ``"\01"`` prefix
83    can be used on global variables to suppress mangling.
84 #. Unnamed values are represented as an unsigned numeric value with
85    their prefix. For example, ``%12``, ``@2``, ``%44``.
86 #. Constants, which are described in the section Constants_ below.
87
88 LLVM requires that values start with a prefix for two reasons: Compilers
89 don't need to worry about name clashes with reserved words, and the set
90 of reserved words may be expanded in the future without penalty.
91 Additionally, unnamed identifiers allow a compiler to quickly come up
92 with a temporary variable without having to avoid symbol table
93 conflicts.
94
95 Reserved words in LLVM are very similar to reserved words in other
96 languages. There are keywords for different opcodes ('``add``',
97 '``bitcast``', '``ret``', etc...), for primitive type names ('``void``',
98 '``i32``', etc...), and others. These reserved words cannot conflict
99 with variable names, because none of them start with a prefix character
100 (``'%'`` or ``'@'``).
101
102 Here is an example of LLVM code to multiply the integer variable
103 '``%X``' by 8:
104
105 The easy way:
106
107 .. code-block:: llvm
108
109     %result = mul i32 %X, 8
110
111 After strength reduction:
112
113 .. code-block:: llvm
114
115     %result = shl i32 %X, 3
116
117 And the hard way:
118
119 .. code-block:: llvm
120
121     %0 = add i32 %X, %X           ; yields i32:%0
122     %1 = add i32 %0, %0           ; yields i32:%1
123     %result = add i32 %1, %1
124
125 This last way of multiplying ``%X`` by 8 illustrates several important
126 lexical features of LLVM:
127
128 #. Comments are delimited with a '``;``' and go until the end of line.
129 #. Unnamed temporaries are created when the result of a computation is
130    not assigned to a named value.
131 #. Unnamed temporaries are numbered sequentially (using a per-function
132    incrementing counter, starting with 0). Note that basic blocks and unnamed
133    function parameters are included in this numbering. For example, if the
134    entry basic block is not given a label name and all function parameters are
135    named, then it will get number 0.
136
137 It also shows a convention that we follow in this document. When
138 demonstrating instructions, we will follow an instruction with a comment
139 that defines the type and name of value produced.
140
141 High Level Structure
142 ====================
143
144 Module Structure
145 ----------------
146
147 LLVM programs are composed of ``Module``'s, each of which is a
148 translation unit of the input programs. Each module consists of
149 functions, global variables, and symbol table entries. Modules may be
150 combined together with the LLVM linker, which merges function (and
151 global variable) definitions, resolves forward declarations, and merges
152 symbol table entries. Here is an example of the "hello world" module:
153
154 .. code-block:: llvm
155
156     ; Declare the string constant as a global constant.
157     @.str = private unnamed_addr constant [13 x i8] c"hello world\0A\00"
158
159     ; External declaration of the puts function
160     declare i32 @puts(i8* nocapture) nounwind
161
162     ; Definition of main function
163     define i32 @main() {   ; i32()*
164       ; Convert [13 x i8]* to i8  *...
165       %cast210 = getelementptr [13 x i8], [13 x i8]* @.str, i64 0, i64 0
166
167       ; Call puts function to write out the string to stdout.
168       call i32 @puts(i8* %cast210)
169       ret i32 0
170     }
171
172     ; Named metadata
173     !0 = !{i32 42, null, !"string"}
174     !foo = !{!0}
175
176 This example is made up of a :ref:`global variable <globalvars>` named
177 "``.str``", an external declaration of the "``puts``" function, a
178 :ref:`function definition <functionstructure>` for "``main``" and
179 :ref:`named metadata <namedmetadatastructure>` "``foo``".
180
181 In general, a module is made up of a list of global values (where both
182 functions and global variables are global values). Global values are
183 represented by a pointer to a memory location (in this case, a pointer
184 to an array of char, and a pointer to a function), and have one of the
185 following :ref:`linkage types <linkage>`.
186
187 .. _linkage:
188
189 Linkage Types
190 -------------
191
192 All Global Variables and Functions have one of the following types of
193 linkage:
194
195 ``private``
196     Global values with "``private``" linkage are only directly
197     accessible by objects in the current module. In particular, linking
198     code into a module with an private global value may cause the
199     private to be renamed as necessary to avoid collisions. Because the
200     symbol is private to the module, all references can be updated. This
201     doesn't show up in any symbol table in the object file.
202 ``internal``
203     Similar to private, but the value shows as a local symbol
204     (``STB_LOCAL`` in the case of ELF) in the object file. This
205     corresponds to the notion of the '``static``' keyword in C.
206 ``available_externally``
207     Globals with "``available_externally``" linkage are never emitted into
208     the object file corresponding to the LLVM module. From the linker's
209     perspective, an ``available_externally`` global is equivalent to
210     an external declaration. They exist to allow inlining and other
211     optimizations to take place given knowledge of the definition of the
212     global, which is known to be somewhere outside the module. Globals
213     with ``available_externally`` linkage are allowed to be discarded at
214     will, and allow inlining and other optimizations. This linkage type is
215     only allowed on definitions, not declarations.
216 ``linkonce``
217     Globals with "``linkonce``" linkage are merged with other globals of
218     the same name when linkage occurs. This can be used to implement
219     some forms of inline functions, templates, or other code which must
220     be generated in each translation unit that uses it, but where the
221     body may be overridden with a more definitive definition later.
222     Unreferenced ``linkonce`` globals are allowed to be discarded. Note
223     that ``linkonce`` linkage does not actually allow the optimizer to
224     inline the body of this function into callers because it doesn't
225     know if this definition of the function is the definitive definition
226     within the program or whether it will be overridden by a stronger
227     definition. To enable inlining and other optimizations, use
228     "``linkonce_odr``" linkage.
229 ``weak``
230     "``weak``" linkage has the same merging semantics as ``linkonce``
231     linkage, except that unreferenced globals with ``weak`` linkage may
232     not be discarded. This is used for globals that are declared "weak"
233     in C source code.
234 ``common``
235     "``common``" linkage is most similar to "``weak``" linkage, but they
236     are used for tentative definitions in C, such as "``int X;``" at
237     global scope. Symbols with "``common``" linkage are merged in the
238     same way as ``weak symbols``, and they may not be deleted if
239     unreferenced. ``common`` symbols may not have an explicit section,
240     must have a zero initializer, and may not be marked
241     ':ref:`constant <globalvars>`'. Functions and aliases may not have
242     common linkage.
243
244 .. _linkage_appending:
245
246 ``appending``
247     "``appending``" linkage may only be applied to global variables of
248     pointer to array type. When two global variables with appending
249     linkage are linked together, the two global arrays are appended
250     together. This is the LLVM, typesafe, equivalent of having the
251     system linker append together "sections" with identical names when
252     .o files are linked.
253 ``extern_weak``
254     The semantics of this linkage follow the ELF object file model: the
255     symbol is weak until linked, if not linked, the symbol becomes null
256     instead of being an undefined reference.
257 ``linkonce_odr``, ``weak_odr``
258     Some languages allow differing globals to be merged, such as two
259     functions with different semantics. Other languages, such as
260     ``C++``, ensure that only equivalent globals are ever merged (the
261     "one definition rule" --- "ODR"). Such languages can use the
262     ``linkonce_odr`` and ``weak_odr`` linkage types to indicate that the
263     global will only be merged with equivalent globals. These linkage
264     types are otherwise the same as their non-``odr`` versions.
265 ``external``
266     If none of the above identifiers are used, the global is externally
267     visible, meaning that it participates in linkage and can be used to
268     resolve external symbol references.
269
270 It is illegal for a function *declaration* to have any linkage type
271 other than ``external`` or ``extern_weak``.
272
273 .. _callingconv:
274
275 Calling Conventions
276 -------------------
277
278 LLVM :ref:`functions <functionstructure>`, :ref:`calls <i_call>` and
279 :ref:`invokes <i_invoke>` can all have an optional calling convention
280 specified for the call. The calling convention of any pair of dynamic
281 caller/callee must match, or the behavior of the program is undefined.
282 The following calling conventions are supported by LLVM, and more may be
283 added in the future:
284
285 "``ccc``" - The C calling convention
286     This calling convention (the default if no other calling convention
287     is specified) matches the target C calling conventions. This calling
288     convention supports varargs function calls and tolerates some
289     mismatch in the declared prototype and implemented declaration of
290     the function (as does normal C).
291 "``fastcc``" - The fast calling convention
292     This calling convention attempts to make calls as fast as possible
293     (e.g. by passing things in registers). This calling convention
294     allows the target to use whatever tricks it wants to produce fast
295     code for the target, without having to conform to an externally
296     specified ABI (Application Binary Interface). `Tail calls can only
297     be optimized when this, the GHC or the HiPE convention is
298     used. <CodeGenerator.html#id80>`_ This calling convention does not
299     support varargs and requires the prototype of all callees to exactly
300     match the prototype of the function definition.
301 "``coldcc``" - The cold calling convention
302     This calling convention attempts to make code in the caller as
303     efficient as possible under the assumption that the call is not
304     commonly executed. As such, these calls often preserve all registers
305     so that the call does not break any live ranges in the caller side.
306     This calling convention does not support varargs and requires the
307     prototype of all callees to exactly match the prototype of the
308     function definition. Furthermore the inliner doesn't consider such function
309     calls for inlining.
310 "``cc 10``" - GHC convention
311     This calling convention has been implemented specifically for use by
312     the `Glasgow Haskell Compiler (GHC) <http://www.haskell.org/ghc>`_.
313     It passes everything in registers, going to extremes to achieve this
314     by disabling callee save registers. This calling convention should
315     not be used lightly but only for specific situations such as an
316     alternative to the *register pinning* performance technique often
317     used when implementing functional programming languages. At the
318     moment only X86 supports this convention and it has the following
319     limitations:
320
321     -  On *X86-32* only supports up to 4 bit type parameters. No
322        floating point types are supported.
323     -  On *X86-64* only supports up to 10 bit type parameters and 6
324        floating point parameters.
325
326     This calling convention supports `tail call
327     optimization <CodeGenerator.html#id80>`_ but requires both the
328     caller and callee are using it.
329 "``cc 11``" - The HiPE calling convention
330     This calling convention has been implemented specifically for use by
331     the `High-Performance Erlang
332     (HiPE) <http://www.it.uu.se/research/group/hipe/>`_ compiler, *the*
333     native code compiler of the `Ericsson's Open Source Erlang/OTP
334     system <http://www.erlang.org/download.shtml>`_. It uses more
335     registers for argument passing than the ordinary C calling
336     convention and defines no callee-saved registers. The calling
337     convention properly supports `tail call
338     optimization <CodeGenerator.html#id80>`_ but requires that both the
339     caller and the callee use it. It uses a *register pinning*
340     mechanism, similar to GHC's convention, for keeping frequently
341     accessed runtime components pinned to specific hardware registers.
342     At the moment only X86 supports this convention (both 32 and 64
343     bit).
344 "``webkit_jscc``" - WebKit's JavaScript calling convention
345     This calling convention has been implemented for `WebKit FTL JIT
346     <https://trac.webkit.org/wiki/FTLJIT>`_. It passes arguments on the
347     stack right to left (as cdecl does), and returns a value in the
348     platform's customary return register.
349 "``anyregcc``" - Dynamic calling convention for code patching
350     This is a special convention that supports patching an arbitrary code
351     sequence in place of a call site. This convention forces the call
352     arguments into registers but allows them to be dynamically
353     allocated. This can currently only be used with calls to
354     llvm.experimental.patchpoint because only this intrinsic records
355     the location of its arguments in a side table. See :doc:`StackMaps`.
356 "``preserve_mostcc``" - The `PreserveMost` calling convention
357     This calling convention attempts to make the code in the caller as
358     unintrusive as possible. This convention behaves identically to the `C`
359     calling convention on how arguments and return values are passed, but it
360     uses a different set of caller/callee-saved registers. This alleviates the
361     burden of saving and recovering a large register set before and after the
362     call in the caller. If the arguments are passed in callee-saved registers,
363     then they will be preserved by the callee across the call. This doesn't
364     apply for values returned in callee-saved registers.
365
366     - On X86-64 the callee preserves all general purpose registers, except for
367       R11. R11 can be used as a scratch register. Floating-point registers
368       (XMMs/YMMs) are not preserved and need to be saved by the caller.
369
370     The idea behind this convention is to support calls to runtime functions
371     that have a hot path and a cold path. The hot path is usually a small piece
372     of code that doesn't use many registers. The cold path might need to call out to
373     another function and therefore only needs to preserve the caller-saved
374     registers, which haven't already been saved by the caller. The
375     `PreserveMost` calling convention is very similar to the `cold` calling
376     convention in terms of caller/callee-saved registers, but they are used for
377     different types of function calls. `coldcc` is for function calls that are
378     rarely executed, whereas `preserve_mostcc` function calls are intended to be
379     on the hot path and definitely executed a lot. Furthermore `preserve_mostcc`
380     doesn't prevent the inliner from inlining the function call.
381
382     This calling convention will be used by a future version of the ObjectiveC
383     runtime and should therefore still be considered experimental at this time.
384     Although this convention was created to optimize certain runtime calls to
385     the ObjectiveC runtime, it is not limited to this runtime and might be used
386     by other runtimes in the future too. The current implementation only
387     supports X86-64, but the intention is to support more architectures in the
388     future.
389 "``preserve_allcc``" - The `PreserveAll` calling convention
390     This calling convention attempts to make the code in the caller even less
391     intrusive than the `PreserveMost` calling convention. This calling
392     convention also behaves identical to the `C` calling convention on how
393     arguments and return values are passed, but it uses a different set of
394     caller/callee-saved registers. This removes the burden of saving and
395     recovering a large register set before and after the call in the caller. If
396     the arguments are passed in callee-saved registers, then they will be
397     preserved by the callee across the call. This doesn't apply for values
398     returned in callee-saved registers.
399
400     - On X86-64 the callee preserves all general purpose registers, except for
401       R11. R11 can be used as a scratch register. Furthermore it also preserves
402       all floating-point registers (XMMs/YMMs).
403
404     The idea behind this convention is to support calls to runtime functions
405     that don't need to call out to any other functions.
406
407     This calling convention, like the `PreserveMost` calling convention, will be
408     used by a future version of the ObjectiveC runtime and should be considered
409     experimental at this time.
410 "``cxx_fast_tlscc``" - The `CXX_FAST_TLS` calling convention for access functions
411     Clang generates an access function to access C++-style TLS. The access
412     function generally has an entry block, an exit block and an initialization
413     block that is run at the first time. The entry and exit blocks can access
414     a few TLS IR variables, each access will be lowered to a platform-specific
415     sequence.
416
417     This calling convention aims to minimize overhead in the caller by
418     preserving as many registers as possible (all the registers that are
419     perserved on the fast path, composed of the entry and exit blocks).
420
421     This calling convention behaves identical to the `C` calling convention on
422     how arguments and return values are passed, but it uses a different set of
423     caller/callee-saved registers.
424
425     Given that each platform has its own lowering sequence, hence its own set
426     of preserved registers, we can't use the existing `PreserveMost`.
427
428     - On X86-64 the callee preserves all general purpose registers, except for
429       RDI and RAX.
430 "``cc <n>``" - Numbered convention
431     Any calling convention may be specified by number, allowing
432     target-specific calling conventions to be used. Target specific
433     calling conventions start at 64.
434
435 More calling conventions can be added/defined on an as-needed basis, to
436 support Pascal conventions or any other well-known target-independent
437 convention.
438
439 .. _visibilitystyles:
440
441 Visibility Styles
442 -----------------
443
444 All Global Variables and Functions have one of the following visibility
445 styles:
446
447 "``default``" - Default style
448     On targets that use the ELF object file format, default visibility
449     means that the declaration is visible to other modules and, in
450     shared libraries, means that the declared entity may be overridden.
451     On Darwin, default visibility means that the declaration is visible
452     to other modules. Default visibility corresponds to "external
453     linkage" in the language.
454 "``hidden``" - Hidden style
455     Two declarations of an object with hidden visibility refer to the
456     same object if they are in the same shared object. Usually, hidden
457     visibility indicates that the symbol will not be placed into the
458     dynamic symbol table, so no other module (executable or shared
459     library) can reference it directly.
460 "``protected``" - Protected style
461     On ELF, protected visibility indicates that the symbol will be
462     placed in the dynamic symbol table, but that references within the
463     defining module will bind to the local symbol. That is, the symbol
464     cannot be overridden by another module.
465
466 A symbol with ``internal`` or ``private`` linkage must have ``default``
467 visibility.
468
469 .. _dllstorageclass:
470
471 DLL Storage Classes
472 -------------------
473
474 All Global Variables, Functions and Aliases can have one of the following
475 DLL storage class:
476
477 ``dllimport``
478     "``dllimport``" causes the compiler to reference a function or variable via
479     a global pointer to a pointer that is set up by the DLL exporting the
480     symbol. On Microsoft Windows targets, the pointer name is formed by
481     combining ``__imp_`` and the function or variable name.
482 ``dllexport``
483     "``dllexport``" causes the compiler to provide a global pointer to a pointer
484     in a DLL, so that it can be referenced with the ``dllimport`` attribute. On
485     Microsoft Windows targets, the pointer name is formed by combining
486     ``__imp_`` and the function or variable name. Since this storage class
487     exists for defining a dll interface, the compiler, assembler and linker know
488     it is externally referenced and must refrain from deleting the symbol.
489
490 .. _tls_model:
491
492 Thread Local Storage Models
493 ---------------------------
494
495 A variable may be defined as ``thread_local``, which means that it will
496 not be shared by threads (each thread will have a separated copy of the
497 variable). Not all targets support thread-local variables. Optionally, a
498 TLS model may be specified:
499
500 ``localdynamic``
501     For variables that are only used within the current shared library.
502 ``initialexec``
503     For variables in modules that will not be loaded dynamically.
504 ``localexec``
505     For variables defined in the executable and only used within it.
506
507 If no explicit model is given, the "general dynamic" model is used.
508
509 The models correspond to the ELF TLS models; see `ELF Handling For
510 Thread-Local Storage <http://people.redhat.com/drepper/tls.pdf>`_ for
511 more information on under which circumstances the different models may
512 be used. The target may choose a different TLS model if the specified
513 model is not supported, or if a better choice of model can be made.
514
515 A model can also be specified in an alias, but then it only governs how
516 the alias is accessed. It will not have any effect in the aliasee.
517
518 For platforms without linker support of ELF TLS model, the -femulated-tls
519 flag can be used to generate GCC compatible emulated TLS code.
520
521 .. _namedtypes:
522
523 Structure Types
524 ---------------
525
526 LLVM IR allows you to specify both "identified" and "literal" :ref:`structure
527 types <t_struct>`. Literal types are uniqued structurally, but identified types
528 are never uniqued. An :ref:`opaque structural type <t_opaque>` can also be used
529 to forward declare a type that is not yet available.
530
531 An example of an identified structure specification is:
532
533 .. code-block:: llvm
534
535     %mytype = type { %mytype*, i32 }
536
537 Prior to the LLVM 3.0 release, identified types were structurally uniqued. Only
538 literal types are uniqued in recent versions of LLVM.
539
540 .. _globalvars:
541
542 Global Variables
543 ----------------
544
545 Global variables define regions of memory allocated at compilation time
546 instead of run-time.
547
548 Global variable definitions must be initialized.
549
550 Global variables in other translation units can also be declared, in which
551 case they don't have an initializer.
552
553 Either global variable definitions or declarations may have an explicit section
554 to be placed in and may have an optional explicit alignment specified.
555
556 A variable may be defined as a global ``constant``, which indicates that
557 the contents of the variable will **never** be modified (enabling better
558 optimization, allowing the global data to be placed in the read-only
559 section of an executable, etc). Note that variables that need runtime
560 initialization cannot be marked ``constant`` as there is a store to the
561 variable.
562
563 LLVM explicitly allows *declarations* of global variables to be marked
564 constant, even if the final definition of the global is not. This
565 capability can be used to enable slightly better optimization of the
566 program, but requires the language definition to guarantee that
567 optimizations based on the 'constantness' are valid for the translation
568 units that do not include the definition.
569
570 As SSA values, global variables define pointer values that are in scope
571 (i.e. they dominate) all basic blocks in the program. Global variables
572 always define a pointer to their "content" type because they describe a
573 region of memory, and all memory objects in LLVM are accessed through
574 pointers.
575
576 Global variables can be marked with ``unnamed_addr`` which indicates
577 that the address is not significant, only the content. Constants marked
578 like this can be merged with other constants if they have the same
579 initializer. Note that a constant with significant address *can* be
580 merged with a ``unnamed_addr`` constant, the result being a constant
581 whose address is significant.
582
583 A global variable may be declared to reside in a target-specific
584 numbered address space. For targets that support them, address spaces
585 may affect how optimizations are performed and/or what target
586 instructions are used to access the variable. The default address space
587 is zero. The address space qualifier must precede any other attributes.
588
589 LLVM allows an explicit section to be specified for globals. If the
590 target supports it, it will emit globals to the section specified.
591 Additionally, the global can placed in a comdat if the target has the necessary
592 support.
593
594 By default, global initializers are optimized by assuming that global
595 variables defined within the module are not modified from their
596 initial values before the start of the global initializer. This is
597 true even for variables potentially accessible from outside the
598 module, including those with external linkage or appearing in
599 ``@llvm.used`` or dllexported variables. This assumption may be suppressed
600 by marking the variable with ``externally_initialized``.
601
602 An explicit alignment may be specified for a global, which must be a
603 power of 2. If not present, or if the alignment is set to zero, the
604 alignment of the global is set by the target to whatever it feels
605 convenient. If an explicit alignment is specified, the global is forced
606 to have exactly that alignment. Targets and optimizers are not allowed
607 to over-align the global if the global has an assigned section. In this
608 case, the extra alignment could be observable: for example, code could
609 assume that the globals are densely packed in their section and try to
610 iterate over them as an array, alignment padding would break this
611 iteration. The maximum alignment is ``1 << 29``.
612
613 Globals can also have a :ref:`DLL storage class <dllstorageclass>`.
614
615 Variables and aliases can have a
616 :ref:`Thread Local Storage Model <tls_model>`.
617
618 Syntax::
619
620     [@<GlobalVarName> =] [Linkage] [Visibility] [DLLStorageClass] [ThreadLocal]
621                          [unnamed_addr] [AddrSpace] [ExternallyInitialized]
622                          <global | constant> <Type> [<InitializerConstant>]
623                          [, section "name"] [, comdat [($name)]]
624                          [, align <Alignment>]
625
626 For example, the following defines a global in a numbered address space
627 with an initializer, section, and alignment:
628
629 .. code-block:: llvm
630
631     @G = addrspace(5) constant float 1.0, section "foo", align 4
632
633 The following example just declares a global variable
634
635 .. code-block:: llvm
636
637    @G = external global i32
638
639 The following example defines a thread-local global with the
640 ``initialexec`` TLS model:
641
642 .. code-block:: llvm
643
644     @G = thread_local(initialexec) global i32 0, align 4
645
646 .. _functionstructure:
647
648 Functions
649 ---------
650
651 LLVM function definitions consist of the "``define``" keyword, an
652 optional :ref:`linkage type <linkage>`, an optional :ref:`visibility
653 style <visibility>`, an optional :ref:`DLL storage class <dllstorageclass>`,
654 an optional :ref:`calling convention <callingconv>`,
655 an optional ``unnamed_addr`` attribute, a return type, an optional
656 :ref:`parameter attribute <paramattrs>` for the return type, a function
657 name, a (possibly empty) argument list (each with optional :ref:`parameter
658 attributes <paramattrs>`), optional :ref:`function attributes <fnattrs>`,
659 an optional section, an optional alignment,
660 an optional :ref:`comdat <langref_comdats>`,
661 an optional :ref:`garbage collector name <gc>`, an optional :ref:`prefix <prefixdata>`,
662 an optional :ref:`prologue <prologuedata>`,
663 an optional :ref:`personality <personalityfn>`,
664 an optional list of attached :ref:`metadata <metadata>`,
665 an opening curly brace, a list of basic blocks, and a closing curly brace.
666
667 LLVM function declarations consist of the "``declare``" keyword, an
668 optional :ref:`linkage type <linkage>`, an optional :ref:`visibility
669 style <visibility>`, an optional :ref:`DLL storage class <dllstorageclass>`,
670 an optional :ref:`calling convention <callingconv>`,
671 an optional ``unnamed_addr`` attribute, a return type, an optional
672 :ref:`parameter attribute <paramattrs>` for the return type, a function
673 name, a possibly empty list of arguments, an optional alignment, an optional
674 :ref:`garbage collector name <gc>`, an optional :ref:`prefix <prefixdata>`,
675 and an optional :ref:`prologue <prologuedata>`.
676
677 A function definition contains a list of basic blocks, forming the CFG (Control
678 Flow Graph) for the function. Each basic block may optionally start with a label
679 (giving the basic block a symbol table entry), contains a list of instructions,
680 and ends with a :ref:`terminator <terminators>` instruction (such as a branch or
681 function return). If an explicit label is not provided, a block is assigned an
682 implicit numbered label, using the next value from the same counter as used for
683 unnamed temporaries (:ref:`see above<identifiers>`). For example, if a function
684 entry block does not have an explicit label, it will be assigned label "%0",
685 then the first unnamed temporary in that block will be "%1", etc.
686
687 The first basic block in a function is special in two ways: it is
688 immediately executed on entrance to the function, and it is not allowed
689 to have predecessor basic blocks (i.e. there can not be any branches to
690 the entry block of a function). Because the block can have no
691 predecessors, it also cannot have any :ref:`PHI nodes <i_phi>`.
692
693 LLVM allows an explicit section to be specified for functions. If the
694 target supports it, it will emit functions to the section specified.
695 Additionally, the function can be placed in a COMDAT.
696
697 An explicit alignment may be specified for a function. If not present,
698 or if the alignment is set to zero, the alignment of the function is set
699 by the target to whatever it feels convenient. If an explicit alignment
700 is specified, the function is forced to have at least that much
701 alignment. All alignments must be a power of 2.
702
703 If the ``unnamed_addr`` attribute is given, the address is known to not
704 be significant and two identical functions can be merged.
705
706 Syntax::
707
708     define [linkage] [visibility] [DLLStorageClass]
709            [cconv] [ret attrs]
710            <ResultType> @<FunctionName> ([argument list])
711            [unnamed_addr] [fn Attrs] [section "name"] [comdat [($name)]]
712            [align N] [gc] [prefix Constant] [prologue Constant]
713            [personality Constant] (!name !N)* { ... }
714
715 The argument list is a comma separated sequence of arguments where each
716 argument is of the following form:
717
718 Syntax::
719
720    <type> [parameter Attrs] [name]
721
722
723 .. _langref_aliases:
724
725 Aliases
726 -------
727
728 Aliases, unlike function or variables, don't create any new data. They
729 are just a new symbol and metadata for an existing position.
730
731 Aliases have a name and an aliasee that is either a global value or a
732 constant expression.
733
734 Aliases may have an optional :ref:`linkage type <linkage>`, an optional
735 :ref:`visibility style <visibility>`, an optional :ref:`DLL storage class
736 <dllstorageclass>` and an optional :ref:`tls model <tls_model>`.
737
738 Syntax::
739
740     @<Name> = [Linkage] [Visibility] [DLLStorageClass] [ThreadLocal] [unnamed_addr] alias <AliaseeTy>, <AliaseeTy>* @<Aliasee>
741
742 The linkage must be one of ``private``, ``internal``, ``linkonce``, ``weak``,
743 ``linkonce_odr``, ``weak_odr``, ``external``. Note that some system linkers
744 might not correctly handle dropping a weak symbol that is aliased.
745
746 Aliases that are not ``unnamed_addr`` are guaranteed to have the same address as
747 the aliasee expression. ``unnamed_addr`` ones are only guaranteed to point
748 to the same content.
749
750 Since aliases are only a second name, some restrictions apply, of which
751 some can only be checked when producing an object file:
752
753 * The expression defining the aliasee must be computable at assembly
754   time. Since it is just a name, no relocations can be used.
755
756 * No alias in the expression can be weak as the possibility of the
757   intermediate alias being overridden cannot be represented in an
758   object file.
759
760 * No global value in the expression can be a declaration, since that
761   would require a relocation, which is not possible.
762
763 .. _langref_comdats:
764
765 Comdats
766 -------
767
768 Comdat IR provides access to COFF and ELF object file COMDAT functionality.
769
770 Comdats have a name which represents the COMDAT key. All global objects that
771 specify this key will only end up in the final object file if the linker chooses
772 that key over some other key. Aliases are placed in the same COMDAT that their
773 aliasee computes to, if any.
774
775 Comdats have a selection kind to provide input on how the linker should
776 choose between keys in two different object files.
777
778 Syntax::
779
780     $<Name> = comdat SelectionKind
781
782 The selection kind must be one of the following:
783
784 ``any``
785     The linker may choose any COMDAT key, the choice is arbitrary.
786 ``exactmatch``
787     The linker may choose any COMDAT key but the sections must contain the
788     same data.
789 ``largest``
790     The linker will choose the section containing the largest COMDAT key.
791 ``noduplicates``
792     The linker requires that only section with this COMDAT key exist.
793 ``samesize``
794     The linker may choose any COMDAT key but the sections must contain the
795     same amount of data.
796
797 Note that the Mach-O platform doesn't support COMDATs and ELF only supports
798 ``any`` as a selection kind.
799
800 Here is an example of a COMDAT group where a function will only be selected if
801 the COMDAT key's section is the largest:
802
803 .. code-block:: llvm
804
805    $foo = comdat largest
806    @foo = global i32 2, comdat($foo)
807
808    define void @bar() comdat($foo) {
809      ret void
810    }
811
812 As a syntactic sugar the ``$name`` can be omitted if the name is the same as
813 the global name:
814
815 .. code-block:: llvm
816
817   $foo = comdat any
818   @foo = global i32 2, comdat
819
820
821 In a COFF object file, this will create a COMDAT section with selection kind
822 ``IMAGE_COMDAT_SELECT_LARGEST`` containing the contents of the ``@foo`` symbol
823 and another COMDAT section with selection kind
824 ``IMAGE_COMDAT_SELECT_ASSOCIATIVE`` which is associated with the first COMDAT
825 section and contains the contents of the ``@bar`` symbol.
826
827 There are some restrictions on the properties of the global object.
828 It, or an alias to it, must have the same name as the COMDAT group when
829 targeting COFF.
830 The contents and size of this object may be used during link-time to determine
831 which COMDAT groups get selected depending on the selection kind.
832 Because the name of the object must match the name of the COMDAT group, the
833 linkage of the global object must not be local; local symbols can get renamed
834 if a collision occurs in the symbol table.
835
836 The combined use of COMDATS and section attributes may yield surprising results.
837 For example:
838
839 .. code-block:: llvm
840
841    $foo = comdat any
842    $bar = comdat any
843    @g1 = global i32 42, section "sec", comdat($foo)
844    @g2 = global i32 42, section "sec", comdat($bar)
845
846 From the object file perspective, this requires the creation of two sections
847 with the same name. This is necessary because both globals belong to different
848 COMDAT groups and COMDATs, at the object file level, are represented by
849 sections.
850
851 Note that certain IR constructs like global variables and functions may
852 create COMDATs in the object file in addition to any which are specified using
853 COMDAT IR. This arises when the code generator is configured to emit globals
854 in individual sections (e.g. when `-data-sections` or `-function-sections`
855 is supplied to `llc`).
856
857 .. _namedmetadatastructure:
858
859 Named Metadata
860 --------------
861
862 Named metadata is a collection of metadata. :ref:`Metadata
863 nodes <metadata>` (but not metadata strings) are the only valid
864 operands for a named metadata.
865
866 #. Named metadata are represented as a string of characters with the
867    metadata prefix. The rules for metadata names are the same as for
868    identifiers, but quoted names are not allowed. ``"\xx"`` type escapes
869    are still valid, which allows any character to be part of a name.
870
871 Syntax::
872
873     ; Some unnamed metadata nodes, which are referenced by the named metadata.
874     !0 = !{!"zero"}
875     !1 = !{!"one"}
876     !2 = !{!"two"}
877     ; A named metadata.
878     !name = !{!0, !1, !2}
879
880 .. _paramattrs:
881
882 Parameter Attributes
883 --------------------
884
885 The return type and each parameter of a function type may have a set of
886 *parameter attributes* associated with them. Parameter attributes are
887 used to communicate additional information about the result or
888 parameters of a function. Parameter attributes are considered to be part
889 of the function, not of the function type, so functions with different
890 parameter attributes can have the same function type.
891
892 Parameter attributes are simple keywords that follow the type specified.
893 If multiple parameter attributes are needed, they are space separated.
894 For example:
895
896 .. code-block:: llvm
897
898     declare i32 @printf(i8* noalias nocapture, ...)
899     declare i32 @atoi(i8 zeroext)
900     declare signext i8 @returns_signed_char()
901
902 Note that any attributes for the function result (``nounwind``,
903 ``readonly``) come immediately after the argument list.
904
905 Currently, only the following parameter attributes are defined:
906
907 ``zeroext``
908     This indicates to the code generator that the parameter or return
909     value should be zero-extended to the extent required by the target's
910     ABI (which is usually 32-bits, but is 8-bits for a i1 on x86-64) by
911     the caller (for a parameter) or the callee (for a return value).
912 ``signext``
913     This indicates to the code generator that the parameter or return
914     value should be sign-extended to the extent required by the target's
915     ABI (which is usually 32-bits) by the caller (for a parameter) or
916     the callee (for a return value).
917 ``inreg``
918     This indicates that this parameter or return value should be treated
919     in a special target-dependent fashion while emitting code for
920     a function call or return (usually, by putting it in a register as
921     opposed to memory, though some targets use it to distinguish between
922     two different kinds of registers). Use of this attribute is
923     target-specific.
924 ``byval``
925     This indicates that the pointer parameter should really be passed by
926     value to the function. The attribute implies that a hidden copy of
927     the pointee is made between the caller and the callee, so the callee
928     is unable to modify the value in the caller. This attribute is only
929     valid on LLVM pointer arguments. It is generally used to pass
930     structs and arrays by value, but is also valid on pointers to
931     scalars. The copy is considered to belong to the caller not the
932     callee (for example, ``readonly`` functions should not write to
933     ``byval`` parameters). This is not a valid attribute for return
934     values.
935
936     The byval attribute also supports specifying an alignment with the
937     align attribute. It indicates the alignment of the stack slot to
938     form and the known alignment of the pointer specified to the call
939     site. If the alignment is not specified, then the code generator
940     makes a target-specific assumption.
941
942 .. _attr_inalloca:
943
944 ``inalloca``
945
946     The ``inalloca`` argument attribute allows the caller to take the
947     address of outgoing stack arguments. An ``inalloca`` argument must
948     be a pointer to stack memory produced by an ``alloca`` instruction.
949     The alloca, or argument allocation, must also be tagged with the
950     inalloca keyword. Only the last argument may have the ``inalloca``
951     attribute, and that argument is guaranteed to be passed in memory.
952
953     An argument allocation may be used by a call at most once because
954     the call may deallocate it. The ``inalloca`` attribute cannot be
955     used in conjunction with other attributes that affect argument
956     storage, like ``inreg``, ``nest``, ``sret``, or ``byval``. The
957     ``inalloca`` attribute also disables LLVM's implicit lowering of
958     large aggregate return values, which means that frontend authors
959     must lower them with ``sret`` pointers.
960
961     When the call site is reached, the argument allocation must have
962     been the most recent stack allocation that is still live, or the
963     results are undefined. It is possible to allocate additional stack
964     space after an argument allocation and before its call site, but it
965     must be cleared off with :ref:`llvm.stackrestore
966     <int_stackrestore>`.
967
968     See :doc:`InAlloca` for more information on how to use this
969     attribute.
970
971 ``sret``
972     This indicates that the pointer parameter specifies the address of a
973     structure that is the return value of the function in the source
974     program. This pointer must be guaranteed by the caller to be valid:
975     loads and stores to the structure may be assumed by the callee
976     not to trap and to be properly aligned. This may only be applied to
977     the first parameter. This is not a valid attribute for return
978     values.
979
980 ``align <n>``
981     This indicates that the pointer value may be assumed by the optimizer to
982     have the specified alignment.
983
984     Note that this attribute has additional semantics when combined with the
985     ``byval`` attribute.
986
987 .. _noalias:
988
989 ``noalias``
990     This indicates that objects accessed via pointer values
991     :ref:`based <pointeraliasing>` on the argument or return value are not also
992     accessed, during the execution of the function, via pointer values not
993     *based* on the argument or return value. The attribute on a return value
994     also has additional semantics described below. The caller shares the
995     responsibility with the callee for ensuring that these requirements are met.
996     For further details, please see the discussion of the NoAlias response in
997     :ref:`alias analysis <Must, May, or No>`.
998
999     Note that this definition of ``noalias`` is intentionally similar
1000     to the definition of ``restrict`` in C99 for function arguments.
1001
1002     For function return values, C99's ``restrict`` is not meaningful,
1003     while LLVM's ``noalias`` is. Furthermore, the semantics of the ``noalias``
1004     attribute on return values are stronger than the semantics of the attribute
1005     when used on function arguments. On function return values, the ``noalias``
1006     attribute indicates that the function acts like a system memory allocation
1007     function, returning a pointer to allocated storage disjoint from the
1008     storage for any other object accessible to the caller.
1009
1010 ``nocapture``
1011     This indicates that the callee does not make any copies of the
1012     pointer that outlive the callee itself. This is not a valid
1013     attribute for return values.
1014
1015 .. _nest:
1016
1017 ``nest``
1018     This indicates that the pointer parameter can be excised using the
1019     :ref:`trampoline intrinsics <int_trampoline>`. This is not a valid
1020     attribute for return values and can only be applied to one parameter.
1021
1022 ``returned``
1023     This indicates that the function always returns the argument as its return
1024     value. This is an optimization hint to the code generator when generating
1025     the caller, allowing tail call optimization and omission of register saves
1026     and restores in some cases; it is not checked or enforced when generating
1027     the callee. The parameter and the function return type must be valid
1028     operands for the :ref:`bitcast instruction <i_bitcast>`. This is not a
1029     valid attribute for return values and can only be applied to one parameter.
1030
1031 ``nonnull``
1032     This indicates that the parameter or return pointer is not null. This
1033     attribute may only be applied to pointer typed parameters. This is not
1034     checked or enforced by LLVM, the caller must ensure that the pointer
1035     passed in is non-null, or the callee must ensure that the returned pointer
1036     is non-null.
1037
1038 ``dereferenceable(<n>)``
1039     This indicates that the parameter or return pointer is dereferenceable. This
1040     attribute may only be applied to pointer typed parameters. A pointer that
1041     is dereferenceable can be loaded from speculatively without a risk of
1042     trapping. The number of bytes known to be dereferenceable must be provided
1043     in parentheses. It is legal for the number of bytes to be less than the
1044     size of the pointee type. The ``nonnull`` attribute does not imply
1045     dereferenceability (consider a pointer to one element past the end of an
1046     array), however ``dereferenceable(<n>)`` does imply ``nonnull`` in
1047     ``addrspace(0)`` (which is the default address space).
1048
1049 ``dereferenceable_or_null(<n>)``
1050     This indicates that the parameter or return value isn't both
1051     non-null and non-dereferenceable (up to ``<n>`` bytes) at the same
1052     time. All non-null pointers tagged with
1053     ``dereferenceable_or_null(<n>)`` are ``dereferenceable(<n>)``.
1054     For address space 0 ``dereferenceable_or_null(<n>)`` implies that
1055     a pointer is exactly one of ``dereferenceable(<n>)`` or ``null``,
1056     and in other address spaces ``dereferenceable_or_null(<n>)``
1057     implies that a pointer is at least one of ``dereferenceable(<n>)``
1058     or ``null`` (i.e. it may be both ``null`` and
1059     ``dereferenceable(<n>)``). This attribute may only be applied to
1060     pointer typed parameters.
1061
1062 .. _gc:
1063
1064 Garbage Collector Strategy Names
1065 --------------------------------
1066
1067 Each function may specify a garbage collector strategy name, which is simply a
1068 string:
1069
1070 .. code-block:: llvm
1071
1072     define void @f() gc "name" { ... }
1073
1074 The supported values of *name* includes those :ref:`built in to LLVM
1075 <builtin-gc-strategies>` and any provided by loaded plugins. Specifying a GC
1076 strategy will cause the compiler to alter its output in order to support the
1077 named garbage collection algorithm. Note that LLVM itself does not contain a
1078 garbage collector, this functionality is restricted to generating machine code
1079 which can interoperate with a collector provided externally.
1080
1081 .. _prefixdata:
1082
1083 Prefix Data
1084 -----------
1085
1086 Prefix data is data associated with a function which the code
1087 generator will emit immediately before the function's entrypoint.
1088 The purpose of this feature is to allow frontends to associate
1089 language-specific runtime metadata with specific functions and make it
1090 available through the function pointer while still allowing the
1091 function pointer to be called.
1092
1093 To access the data for a given function, a program may bitcast the
1094 function pointer to a pointer to the constant's type and dereference
1095 index -1. This implies that the IR symbol points just past the end of
1096 the prefix data. For instance, take the example of a function annotated
1097 with a single ``i32``,
1098
1099 .. code-block:: llvm
1100
1101     define void @f() prefix i32 123 { ... }
1102
1103 The prefix data can be referenced as,
1104
1105 .. code-block:: llvm
1106
1107     %0 = bitcast void* () @f to i32*
1108     %a = getelementptr inbounds i32, i32* %0, i32 -1
1109     %b = load i32, i32* %a
1110
1111 Prefix data is laid out as if it were an initializer for a global variable
1112 of the prefix data's type. The function will be placed such that the
1113 beginning of the prefix data is aligned. This means that if the size
1114 of the prefix data is not a multiple of the alignment size, the
1115 function's entrypoint will not be aligned. If alignment of the
1116 function's entrypoint is desired, padding must be added to the prefix
1117 data.
1118
1119 A function may have prefix data but no body. This has similar semantics
1120 to the ``available_externally`` linkage in that the data may be used by the
1121 optimizers but will not be emitted in the object file.
1122
1123 .. _prologuedata:
1124
1125 Prologue Data
1126 -------------
1127
1128 The ``prologue`` attribute allows arbitrary code (encoded as bytes) to
1129 be inserted prior to the function body. This can be used for enabling
1130 function hot-patching and instrumentation.
1131
1132 To maintain the semantics of ordinary function calls, the prologue data must
1133 have a particular format. Specifically, it must begin with a sequence of
1134 bytes which decode to a sequence of machine instructions, valid for the
1135 module's target, which transfer control to the point immediately succeeding
1136 the prologue data, without performing any other visible action. This allows
1137 the inliner and other passes to reason about the semantics of the function
1138 definition without needing to reason about the prologue data. Obviously this
1139 makes the format of the prologue data highly target dependent.
1140
1141 A trivial example of valid prologue data for the x86 architecture is ``i8 144``,
1142 which encodes the ``nop`` instruction:
1143
1144 .. code-block:: llvm
1145
1146     define void @f() prologue i8 144 { ... }
1147
1148 Generally prologue data can be formed by encoding a relative branch instruction
1149 which skips the metadata, as in this example of valid prologue data for the
1150 x86_64 architecture, where the first two bytes encode ``jmp .+10``:
1151
1152 .. code-block:: llvm
1153
1154     %0 = type <{ i8, i8, i8* }>
1155
1156     define void @f() prologue %0 <{ i8 235, i8 8, i8* @md}> { ... }
1157
1158 A function may have prologue data but no body. This has similar semantics
1159 to the ``available_externally`` linkage in that the data may be used by the
1160 optimizers but will not be emitted in the object file.
1161
1162 .. _personalityfn:
1163
1164 Personality Function
1165 --------------------
1166
1167 The ``personality`` attribute permits functions to specify what function
1168 to use for exception handling.
1169
1170 .. _attrgrp:
1171
1172 Attribute Groups
1173 ----------------
1174
1175 Attribute groups are groups of attributes that are referenced by objects within
1176 the IR. They are important for keeping ``.ll`` files readable, because a lot of
1177 functions will use the same set of attributes. In the degenerative case of a
1178 ``.ll`` file that corresponds to a single ``.c`` file, the single attribute
1179 group will capture the important command line flags used to build that file.
1180
1181 An attribute group is a module-level object. To use an attribute group, an
1182 object references the attribute group's ID (e.g. ``#37``). An object may refer
1183 to more than one attribute group. In that situation, the attributes from the
1184 different groups are merged.
1185
1186 Here is an example of attribute groups for a function that should always be
1187 inlined, has a stack alignment of 4, and which shouldn't use SSE instructions:
1188
1189 .. code-block:: llvm
1190
1191    ; Target-independent attributes:
1192    attributes #0 = { alwaysinline alignstack=4 }
1193
1194    ; Target-dependent attributes:
1195    attributes #1 = { "no-sse" }
1196
1197    ; Function @f has attributes: alwaysinline, alignstack=4, and "no-sse".
1198    define void @f() #0 #1 { ... }
1199
1200 .. _fnattrs:
1201
1202 Function Attributes
1203 -------------------
1204
1205 Function attributes are set to communicate additional information about
1206 a function. Function attributes are considered to be part of the
1207 function, not of the function type, so functions with different function
1208 attributes can have the same function type.
1209
1210 Function attributes are simple keywords that follow the type specified.
1211 If multiple attributes are needed, they are space separated. For
1212 example:
1213
1214 .. code-block:: llvm
1215
1216     define void @f() noinline { ... }
1217     define void @f() alwaysinline { ... }
1218     define void @f() alwaysinline optsize { ... }
1219     define void @f() optsize { ... }
1220
1221 ``alignstack(<n>)``
1222     This attribute indicates that, when emitting the prologue and
1223     epilogue, the backend should forcibly align the stack pointer.
1224     Specify the desired alignment, which must be a power of two, in
1225     parentheses.
1226 ``alwaysinline``
1227     This attribute indicates that the inliner should attempt to inline
1228     this function into callers whenever possible, ignoring any active
1229     inlining size threshold for this caller.
1230 ``builtin``
1231     This indicates that the callee function at a call site should be
1232     recognized as a built-in function, even though the function's declaration
1233     uses the ``nobuiltin`` attribute. This is only valid at call sites for
1234     direct calls to functions that are declared with the ``nobuiltin``
1235     attribute.
1236 ``cold``
1237     This attribute indicates that this function is rarely called. When
1238     computing edge weights, basic blocks post-dominated by a cold
1239     function call are also considered to be cold; and, thus, given low
1240     weight.
1241 ``convergent``
1242     This attribute indicates that the callee is dependent on a convergent
1243     thread execution pattern under certain parallel execution models.
1244     Transformations that are execution model agnostic may not make the execution
1245     of a convergent operation control dependent on any additional values.
1246 ``inlinehint``
1247     This attribute indicates that the source code contained a hint that
1248     inlining this function is desirable (such as the "inline" keyword in
1249     C/C++). It is just a hint; it imposes no requirements on the
1250     inliner.
1251 ``jumptable``
1252     This attribute indicates that the function should be added to a
1253     jump-instruction table at code-generation time, and that all address-taken
1254     references to this function should be replaced with a reference to the
1255     appropriate jump-instruction-table function pointer. Note that this creates
1256     a new pointer for the original function, which means that code that depends
1257     on function-pointer identity can break. So, any function annotated with
1258     ``jumptable`` must also be ``unnamed_addr``.
1259 ``minsize``
1260     This attribute suggests that optimization passes and code generator
1261     passes make choices that keep the code size of this function as small
1262     as possible and perform optimizations that may sacrifice runtime
1263     performance in order to minimize the size of the generated code.
1264 ``naked``
1265     This attribute disables prologue / epilogue emission for the
1266     function. This can have very system-specific consequences.
1267 ``nobuiltin``
1268     This indicates that the callee function at a call site is not recognized as
1269     a built-in function. LLVM will retain the original call and not replace it
1270     with equivalent code based on the semantics of the built-in function, unless
1271     the call site uses the ``builtin`` attribute. This is valid at call sites
1272     and on function declarations and definitions.
1273 ``noduplicate``
1274     This attribute indicates that calls to the function cannot be
1275     duplicated. A call to a ``noduplicate`` function may be moved
1276     within its parent function, but may not be duplicated within
1277     its parent function.
1278
1279     A function containing a ``noduplicate`` call may still
1280     be an inlining candidate, provided that the call is not
1281     duplicated by inlining. That implies that the function has
1282     internal linkage and only has one call site, so the original
1283     call is dead after inlining.
1284 ``noimplicitfloat``
1285     This attributes disables implicit floating point instructions.
1286 ``noinline``
1287     This attribute indicates that the inliner should never inline this
1288     function in any situation. This attribute may not be used together
1289     with the ``alwaysinline`` attribute.
1290 ``nonlazybind``
1291     This attribute suppresses lazy symbol binding for the function. This
1292     may make calls to the function faster, at the cost of extra program
1293     startup time if the function is not called during program startup.
1294 ``noredzone``
1295     This attribute indicates that the code generator should not use a
1296     red zone, even if the target-specific ABI normally permits it.
1297 ``noreturn``
1298     This function attribute indicates that the function never returns
1299     normally. This produces undefined behavior at runtime if the
1300     function ever does dynamically return.
1301 ``norecurse``
1302     This function attribute indicates that the function does not call itself
1303     either directly or indirectly down any possible call path. This produces
1304     undefined behavior at runtime if the function ever does recurse.
1305 ``nounwind``
1306     This function attribute indicates that the function never raises an
1307     exception. If the function does raise an exception, its runtime
1308     behavior is undefined. However, functions marked nounwind may still
1309     trap or generate asynchronous exceptions. Exception handling schemes
1310     that are recognized by LLVM to handle asynchronous exceptions, such
1311     as SEH, will still provide their implementation defined semantics.
1312 ``optnone``
1313     This function attribute indicates that most optimization passes will skip
1314     this function, with the exception of interprocedural optimization passes.
1315     Code generation defaults to the "fast" instruction selector.
1316     This attribute cannot be used together with the ``alwaysinline``
1317     attribute; this attribute is also incompatible
1318     with the ``minsize`` attribute and the ``optsize`` attribute.
1319
1320     This attribute requires the ``noinline`` attribute to be specified on
1321     the function as well, so the function is never inlined into any caller.
1322     Only functions with the ``alwaysinline`` attribute are valid
1323     candidates for inlining into the body of this function.
1324 ``optsize``
1325     This attribute suggests that optimization passes and code generator
1326     passes make choices that keep the code size of this function low,
1327     and otherwise do optimizations specifically to reduce code size as
1328     long as they do not significantly impact runtime performance.
1329 ``readnone``
1330     On a function, this attribute indicates that the function computes its
1331     result (or decides to unwind an exception) based strictly on its arguments,
1332     without dereferencing any pointer arguments or otherwise accessing
1333     any mutable state (e.g. memory, control registers, etc) visible to
1334     caller functions. It does not write through any pointer arguments
1335     (including ``byval`` arguments) and never changes any state visible
1336     to callers. This means that it cannot unwind exceptions by calling
1337     the ``C++`` exception throwing methods.
1338
1339     On an argument, this attribute indicates that the function does not
1340     dereference that pointer argument, even though it may read or write the
1341     memory that the pointer points to if accessed through other pointers.
1342 ``readonly``
1343     On a function, this attribute indicates that the function does not write
1344     through any pointer arguments (including ``byval`` arguments) or otherwise
1345     modify any state (e.g. memory, control registers, etc) visible to
1346     caller functions. It may dereference pointer arguments and read
1347     state that may be set in the caller. A readonly function always
1348     returns the same value (or unwinds an exception identically) when
1349     called with the same set of arguments and global state. It cannot
1350     unwind an exception by calling the ``C++`` exception throwing
1351     methods.
1352
1353     On an argument, this attribute indicates that the function does not write
1354     through this pointer argument, even though it may write to the memory that
1355     the pointer points to.
1356 ``argmemonly``
1357     This attribute indicates that the only memory accesses inside function are
1358     loads and stores from objects pointed to by its pointer-typed arguments,
1359     with arbitrary offsets. Or in other words, all memory operations in the
1360     function can refer to memory only using pointers based on its function
1361     arguments.
1362     Note that ``argmemonly`` can be used together with ``readonly`` attribute
1363     in order to specify that function reads only from its arguments.
1364 ``returns_twice``
1365     This attribute indicates that this function can return twice. The C
1366     ``setjmp`` is an example of such a function. The compiler disables
1367     some optimizations (like tail calls) in the caller of these
1368     functions.
1369 ``safestack``
1370     This attribute indicates that
1371     `SafeStack <http://clang.llvm.org/docs/SafeStack.html>`_
1372     protection is enabled for this function.
1373
1374     If a function that has a ``safestack`` attribute is inlined into a
1375     function that doesn't have a ``safestack`` attribute or which has an
1376     ``ssp``, ``sspstrong`` or ``sspreq`` attribute, then the resulting
1377     function will have a ``safestack`` attribute.
1378 ``sanitize_address``
1379     This attribute indicates that AddressSanitizer checks
1380     (dynamic address safety analysis) are enabled for this function.
1381 ``sanitize_memory``
1382     This attribute indicates that MemorySanitizer checks (dynamic detection
1383     of accesses to uninitialized memory) are enabled for this function.
1384 ``sanitize_thread``
1385     This attribute indicates that ThreadSanitizer checks
1386     (dynamic thread safety analysis) are enabled for this function.
1387 ``ssp``
1388     This attribute indicates that the function should emit a stack
1389     smashing protector. It is in the form of a "canary" --- a random value
1390     placed on the stack before the local variables that's checked upon
1391     return from the function to see if it has been overwritten. A
1392     heuristic is used to determine if a function needs stack protectors
1393     or not. The heuristic used will enable protectors for functions with:
1394
1395     - Character arrays larger than ``ssp-buffer-size`` (default 8).
1396     - Aggregates containing character arrays larger than ``ssp-buffer-size``.
1397     - Calls to alloca() with variable sizes or constant sizes greater than
1398       ``ssp-buffer-size``.
1399
1400     Variables that are identified as requiring a protector will be arranged
1401     on the stack such that they are adjacent to the stack protector guard.
1402
1403     If a function that has an ``ssp`` attribute is inlined into a
1404     function that doesn't have an ``ssp`` attribute, then the resulting
1405     function will have an ``ssp`` attribute.
1406 ``sspreq``
1407     This attribute indicates that the function should *always* emit a
1408     stack smashing protector. This overrides the ``ssp`` function
1409     attribute.
1410
1411     Variables that are identified as requiring a protector will be arranged
1412     on the stack such that they are adjacent to the stack protector guard.
1413     The specific layout rules are:
1414
1415     #. Large arrays and structures containing large arrays
1416        (``>= ssp-buffer-size``) are closest to the stack protector.
1417     #. Small arrays and structures containing small arrays
1418        (``< ssp-buffer-size``) are 2nd closest to the protector.
1419     #. Variables that have had their address taken are 3rd closest to the
1420        protector.
1421
1422     If a function that has an ``sspreq`` attribute is inlined into a
1423     function that doesn't have an ``sspreq`` attribute or which has an
1424     ``ssp`` or ``sspstrong`` attribute, then the resulting function will have
1425     an ``sspreq`` attribute.
1426 ``sspstrong``
1427     This attribute indicates that the function should emit a stack smashing
1428     protector. This attribute causes a strong heuristic to be used when
1429     determining if a function needs stack protectors. The strong heuristic
1430     will enable protectors for functions with:
1431
1432     - Arrays of any size and type
1433     - Aggregates containing an array of any size and type.
1434     - Calls to alloca().
1435     - Local variables that have had their address taken.
1436
1437     Variables that are identified as requiring a protector will be arranged
1438     on the stack such that they are adjacent to the stack protector guard.
1439     The specific layout rules are:
1440
1441     #. Large arrays and structures containing large arrays
1442        (``>= ssp-buffer-size``) are closest to the stack protector.
1443     #. Small arrays and structures containing small arrays
1444        (``< ssp-buffer-size``) are 2nd closest to the protector.
1445     #. Variables that have had their address taken are 3rd closest to the
1446        protector.
1447
1448     This overrides the ``ssp`` function attribute.
1449
1450     If a function that has an ``sspstrong`` attribute is inlined into a
1451     function that doesn't have an ``sspstrong`` attribute, then the
1452     resulting function will have an ``sspstrong`` attribute.
1453 ``"thunk"``
1454     This attribute indicates that the function will delegate to some other
1455     function with a tail call. The prototype of a thunk should not be used for
1456     optimization purposes. The caller is expected to cast the thunk prototype to
1457     match the thunk target prototype.
1458 ``uwtable``
1459     This attribute indicates that the ABI being targeted requires that
1460     an unwind table entry be produced for this function even if we can
1461     show that no exceptions passes by it. This is normally the case for
1462     the ELF x86-64 abi, but it can be disabled for some compilation
1463     units.
1464
1465
1466 .. _opbundles:
1467
1468 Operand Bundles
1469 ---------------
1470
1471 Note: operand bundles are a work in progress, and they should be
1472 considered experimental at this time.
1473
1474 Operand bundles are tagged sets of SSA values that can be associated
1475 with certain LLVM instructions (currently only ``call`` s and
1476 ``invoke`` s).  In a way they are like metadata, but dropping them is
1477 incorrect and will change program semantics.
1478
1479 Syntax::
1480
1481     operand bundle set ::= '[' operand bundle (, operand bundle )* ']'
1482     operand bundle ::= tag '(' [ bundle operand ] (, bundle operand )* ')'
1483     bundle operand ::= SSA value
1484     tag ::= string constant
1485
1486 Operand bundles are **not** part of a function's signature, and a
1487 given function may be called from multiple places with different kinds
1488 of operand bundles.  This reflects the fact that the operand bundles
1489 are conceptually a part of the ``call`` (or ``invoke``), not the
1490 callee being dispatched to.
1491
1492 Operand bundles are a generic mechanism intended to support
1493 runtime-introspection-like functionality for managed languages.  While
1494 the exact semantics of an operand bundle depend on the bundle tag,
1495 there are certain limitations to how much the presence of an operand
1496 bundle can influence the semantics of a program.  These restrictions
1497 are described as the semantics of an "unknown" operand bundle.  As
1498 long as the behavior of an operand bundle is describable within these
1499 restrictions, LLVM does not need to have special knowledge of the
1500 operand bundle to not miscompile programs containing it.
1501
1502 - The bundle operands for an unknown operand bundle escape in unknown
1503   ways before control is transferred to the callee or invokee.
1504 - Calls and invokes with operand bundles have unknown read / write
1505   effect on the heap on entry and exit (even if the call target is
1506   ``readnone`` or ``readonly``), unless they're overriden with
1507   callsite specific attributes.
1508 - An operand bundle at a call site cannot change the implementation
1509   of the called function.  Inter-procedural optimizations work as
1510   usual as long as they take into account the first two properties.
1511
1512 More specific types of operand bundles are described below.
1513
1514 Deoptimization Operand Bundles
1515 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1516
1517 Deoptimization operand bundles are characterized by the ``"deopt"``
1518 operand bundle tag.  These operand bundles represent an alternate
1519 "safe" continuation for the call site they're attached to, and can be
1520 used by a suitable runtime to deoptimize the compiled frame at the
1521 specified call site.  There can be at most one ``"deopt"`` operand
1522 bundle attached to a call site.  Exact details of deoptimization is
1523 out of scope for the language reference, but it usually involves
1524 rewriting a compiled frame into a set of interpreted frames.
1525
1526 From the compiler's perspective, deoptimization operand bundles make
1527 the call sites they're attached to at least ``readonly``.  They read
1528 through all of their pointer typed operands (even if they're not
1529 otherwise escaped) and the entire visible heap.  Deoptimization
1530 operand bundles do not capture their operands except during
1531 deoptimization, in which case control will not be returned to the
1532 compiled frame.
1533
1534 The inliner knows how to inline through calls that have deoptimization
1535 operand bundles.  Just like inlining through a normal call site
1536 involves composing the normal and exceptional continuations, inlining
1537 through a call site with a deoptimization operand bundle needs to
1538 appropriately compose the "safe" deoptimization continuation.  The
1539 inliner does this by prepending the parent's deoptimization
1540 continuation to every deoptimization continuation in the inlined body.
1541 E.g. inlining ``@f`` into ``@g`` in the following example
1542
1543 .. code-block:: llvm
1544
1545     define void @f() {
1546       call void @x()  ;; no deopt state
1547       call void @y() [ "deopt"(i32 10) ]
1548       call void @y() [ "deopt"(i32 10), "unknown"(i8* null) ]
1549       ret void
1550     }
1551
1552     define void @g() {
1553       call void @f() [ "deopt"(i32 20) ]
1554       ret void
1555     }
1556
1557 will result in
1558
1559 .. code-block:: llvm
1560
1561     define void @g() {
1562       call void @x()  ;; still no deopt state
1563       call void @y() [ "deopt"(i32 20, i32 10) ]
1564       call void @y() [ "deopt"(i32 20, i32 10), "unknown"(i8* null) ]
1565       ret void
1566     }
1567
1568 It is the frontend's responsibility to structure or encode the
1569 deoptimization state in a way that syntactically prepending the
1570 caller's deoptimization state to the callee's deoptimization state is
1571 semantically equivalent to composing the caller's deoptimization
1572 continuation after the callee's deoptimization continuation.
1573
1574 .. _moduleasm:
1575
1576 Module-Level Inline Assembly
1577 ----------------------------
1578
1579 Modules may contain "module-level inline asm" blocks, which corresponds
1580 to the GCC "file scope inline asm" blocks. These blocks are internally
1581 concatenated by LLVM and treated as a single unit, but may be separated
1582 in the ``.ll`` file if desired. The syntax is very simple:
1583
1584 .. code-block:: llvm
1585
1586     module asm "inline asm code goes here"
1587     module asm "more can go here"
1588
1589 The strings can contain any character by escaping non-printable
1590 characters. The escape sequence used is simply "\\xx" where "xx" is the
1591 two digit hex code for the number.
1592
1593 Note that the assembly string *must* be parseable by LLVM's integrated assembler
1594 (unless it is disabled), even when emitting a ``.s`` file.
1595
1596 .. _langref_datalayout:
1597
1598 Data Layout
1599 -----------
1600
1601 A module may specify a target specific data layout string that specifies
1602 how data is to be laid out in memory. The syntax for the data layout is
1603 simply:
1604
1605 .. code-block:: llvm
1606
1607     target datalayout = "layout specification"
1608
1609 The *layout specification* consists of a list of specifications
1610 separated by the minus sign character ('-'). Each specification starts
1611 with a letter and may include other information after the letter to
1612 define some aspect of the data layout. The specifications accepted are
1613 as follows:
1614
1615 ``E``
1616     Specifies that the target lays out data in big-endian form. That is,
1617     the bits with the most significance have the lowest address
1618     location.
1619 ``e``
1620     Specifies that the target lays out data in little-endian form. That
1621     is, the bits with the least significance have the lowest address
1622     location.
1623 ``S<size>``
1624     Specifies the natural alignment of the stack in bits. Alignment
1625     promotion of stack variables is limited to the natural stack
1626     alignment to avoid dynamic stack realignment. The stack alignment
1627     must be a multiple of 8-bits. If omitted, the natural stack
1628     alignment defaults to "unspecified", which does not prevent any
1629     alignment promotions.
1630 ``p[n]:<size>:<abi>:<pref>``
1631     This specifies the *size* of a pointer and its ``<abi>`` and
1632     ``<pref>``\erred alignments for address space ``n``. All sizes are in
1633     bits. The address space, ``n``, is optional, and if not specified,
1634     denotes the default address space 0. The value of ``n`` must be
1635     in the range [1,2^23).
1636 ``i<size>:<abi>:<pref>``
1637     This specifies the alignment for an integer type of a given bit
1638     ``<size>``. The value of ``<size>`` must be in the range [1,2^23).
1639 ``v<size>:<abi>:<pref>``
1640     This specifies the alignment for a vector type of a given bit
1641     ``<size>``.
1642 ``f<size>:<abi>:<pref>``
1643     This specifies the alignment for a floating point type of a given bit
1644     ``<size>``. Only values of ``<size>`` that are supported by the target
1645     will work. 32 (float) and 64 (double) are supported on all targets; 80
1646     or 128 (different flavors of long double) are also supported on some
1647     targets.
1648 ``a:<abi>:<pref>``
1649     This specifies the alignment for an object of aggregate type.
1650 ``m:<mangling>``
1651     If present, specifies that llvm names are mangled in the output. The
1652     options are
1653
1654     * ``e``: ELF mangling: Private symbols get a ``.L`` prefix.
1655     * ``m``: Mips mangling: Private symbols get a ``$`` prefix.
1656     * ``o``: Mach-O mangling: Private symbols get ``L`` prefix. Other
1657       symbols get a ``_`` prefix.
1658     * ``w``: Windows COFF prefix:  Similar to Mach-O, but stdcall and fastcall
1659       functions also get a suffix based on the frame size.
1660     * ``x``: Windows x86 COFF prefix:  Similar to Windows COFF, but use a ``_``
1661       prefix for ``__cdecl`` functions.
1662 ``n<size1>:<size2>:<size3>...``
1663     This specifies a set of native integer widths for the target CPU in
1664     bits. For example, it might contain ``n32`` for 32-bit PowerPC,
1665     ``n32:64`` for PowerPC 64, or ``n8:16:32:64`` for X86-64. Elements of
1666     this set are considered to support most general arithmetic operations
1667     efficiently.
1668
1669 On every specification that takes a ``<abi>:<pref>``, specifying the
1670 ``<pref>`` alignment is optional. If omitted, the preceding ``:``
1671 should be omitted too and ``<pref>`` will be equal to ``<abi>``.
1672
1673 When constructing the data layout for a given target, LLVM starts with a
1674 default set of specifications which are then (possibly) overridden by
1675 the specifications in the ``datalayout`` keyword. The default
1676 specifications are given in this list:
1677
1678 -  ``E`` - big endian
1679 -  ``p:64:64:64`` - 64-bit pointers with 64-bit alignment.
1680 -  ``p[n]:64:64:64`` - Other address spaces are assumed to be the
1681    same as the default address space.
1682 -  ``S0`` - natural stack alignment is unspecified
1683 -  ``i1:8:8`` - i1 is 8-bit (byte) aligned
1684 -  ``i8:8:8`` - i8 is 8-bit (byte) aligned
1685 -  ``i16:16:16`` - i16 is 16-bit aligned
1686 -  ``i32:32:32`` - i32 is 32-bit aligned
1687 -  ``i64:32:64`` - i64 has ABI alignment of 32-bits but preferred
1688    alignment of 64-bits
1689 -  ``f16:16:16`` - half is 16-bit aligned
1690 -  ``f32:32:32`` - float is 32-bit aligned
1691 -  ``f64:64:64`` - double is 64-bit aligned
1692 -  ``f128:128:128`` - quad is 128-bit aligned
1693 -  ``v64:64:64`` - 64-bit vector is 64-bit aligned
1694 -  ``v128:128:128`` - 128-bit vector is 128-bit aligned
1695 -  ``a:0:64`` - aggregates are 64-bit aligned
1696
1697 When LLVM is determining the alignment for a given type, it uses the
1698 following rules:
1699
1700 #. If the type sought is an exact match for one of the specifications,
1701    that specification is used.
1702 #. If no match is found, and the type sought is an integer type, then
1703    the smallest integer type that is larger than the bitwidth of the
1704    sought type is used. If none of the specifications are larger than
1705    the bitwidth then the largest integer type is used. For example,
1706    given the default specifications above, the i7 type will use the
1707    alignment of i8 (next largest) while both i65 and i256 will use the
1708    alignment of i64 (largest specified).
1709 #. If no match is found, and the type sought is a vector type, then the
1710    largest vector type that is smaller than the sought vector type will
1711    be used as a fall back. This happens because <128 x double> can be
1712    implemented in terms of 64 <2 x double>, for example.
1713
1714 The function of the data layout string may not be what you expect.
1715 Notably, this is not a specification from the frontend of what alignment
1716 the code generator should use.
1717
1718 Instead, if specified, the target data layout is required to match what
1719 the ultimate *code generator* expects. This string is used by the
1720 mid-level optimizers to improve code, and this only works if it matches
1721 what the ultimate code generator uses. There is no way to generate IR
1722 that does not embed this target-specific detail into the IR. If you
1723 don't specify the string, the default specifications will be used to
1724 generate a Data Layout and the optimization phases will operate
1725 accordingly and introduce target specificity into the IR with respect to
1726 these default specifications.
1727
1728 .. _langref_triple:
1729
1730 Target Triple
1731 -------------
1732
1733 A module may specify a target triple string that describes the target
1734 host. The syntax for the target triple is simply:
1735
1736 .. code-block:: llvm
1737
1738     target triple = "x86_64-apple-macosx10.7.0"
1739
1740 The *target triple* string consists of a series of identifiers delimited
1741 by the minus sign character ('-'). The canonical forms are:
1742
1743 ::
1744
1745     ARCHITECTURE-VENDOR-OPERATING_SYSTEM
1746     ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
1747
1748 This information is passed along to the backend so that it generates
1749 code for the proper architecture. It's possible to override this on the
1750 command line with the ``-mtriple`` command line option.
1751
1752 .. _pointeraliasing:
1753
1754 Pointer Aliasing Rules
1755 ----------------------
1756
1757 Any memory access must be done through a pointer value associated with
1758 an address range of the memory access, otherwise the behavior is
1759 undefined. Pointer values are associated with address ranges according
1760 to the following rules:
1761
1762 -  A pointer value is associated with the addresses associated with any
1763    value it is *based* on.
1764 -  An address of a global variable is associated with the address range
1765    of the variable's storage.
1766 -  The result value of an allocation instruction is associated with the
1767    address range of the allocated storage.
1768 -  A null pointer in the default address-space is associated with no
1769    address.
1770 -  An integer constant other than zero or a pointer value returned from
1771    a function not defined within LLVM may be associated with address
1772    ranges allocated through mechanisms other than those provided by
1773    LLVM. Such ranges shall not overlap with any ranges of addresses
1774    allocated by mechanisms provided by LLVM.
1775
1776 A pointer value is *based* on another pointer value according to the
1777 following rules:
1778
1779 -  A pointer value formed from a ``getelementptr`` operation is *based*
1780    on the first value operand of the ``getelementptr``.
1781 -  The result value of a ``bitcast`` is *based* on the operand of the
1782    ``bitcast``.
1783 -  A pointer value formed by an ``inttoptr`` is *based* on all pointer
1784    values that contribute (directly or indirectly) to the computation of
1785    the pointer's value.
1786 -  The "*based* on" relationship is transitive.
1787
1788 Note that this definition of *"based"* is intentionally similar to the
1789 definition of *"based"* in C99, though it is slightly weaker.
1790
1791 LLVM IR does not associate types with memory. The result type of a
1792 ``load`` merely indicates the size and alignment of the memory from
1793 which to load, as well as the interpretation of the value. The first
1794 operand type of a ``store`` similarly only indicates the size and
1795 alignment of the store.
1796
1797 Consequently, type-based alias analysis, aka TBAA, aka
1798 ``-fstrict-aliasing``, is not applicable to general unadorned LLVM IR.
1799 :ref:`Metadata <metadata>` may be used to encode additional information
1800 which specialized optimization passes may use to implement type-based
1801 alias analysis.
1802
1803 .. _volatile:
1804
1805 Volatile Memory Accesses
1806 ------------------------
1807
1808 Certain memory accesses, such as :ref:`load <i_load>`'s,
1809 :ref:`store <i_store>`'s, and :ref:`llvm.memcpy <int_memcpy>`'s may be
1810 marked ``volatile``. The optimizers must not change the number of
1811 volatile operations or change their order of execution relative to other
1812 volatile operations. The optimizers *may* change the order of volatile
1813 operations relative to non-volatile operations. This is not Java's
1814 "volatile" and has no cross-thread synchronization behavior.
1815
1816 IR-level volatile loads and stores cannot safely be optimized into
1817 llvm.memcpy or llvm.memmove intrinsics even when those intrinsics are
1818 flagged volatile. Likewise, the backend should never split or merge
1819 target-legal volatile load/store instructions.
1820
1821 .. admonition:: Rationale
1822
1823  Platforms may rely on volatile loads and stores of natively supported
1824  data width to be executed as single instruction. For example, in C
1825  this holds for an l-value of volatile primitive type with native
1826  hardware support, but not necessarily for aggregate types. The
1827  frontend upholds these expectations, which are intentionally
1828  unspecified in the IR. The rules above ensure that IR transformations
1829  do not violate the frontend's contract with the language.
1830
1831 .. _memmodel:
1832
1833 Memory Model for Concurrent Operations
1834 --------------------------------------
1835
1836 The LLVM IR does not define any way to start parallel threads of
1837 execution or to register signal handlers. Nonetheless, there are
1838 platform-specific ways to create them, and we define LLVM IR's behavior
1839 in their presence. This model is inspired by the C++0x memory model.
1840
1841 For a more informal introduction to this model, see the :doc:`Atomics`.
1842
1843 We define a *happens-before* partial order as the least partial order
1844 that
1845
1846 -  Is a superset of single-thread program order, and
1847 -  When a *synchronizes-with* ``b``, includes an edge from ``a`` to
1848    ``b``. *Synchronizes-with* pairs are introduced by platform-specific
1849    techniques, like pthread locks, thread creation, thread joining,
1850    etc., and by atomic instructions. (See also :ref:`Atomic Memory Ordering
1851    Constraints <ordering>`).
1852
1853 Note that program order does not introduce *happens-before* edges
1854 between a thread and signals executing inside that thread.
1855
1856 Every (defined) read operation (load instructions, memcpy, atomic
1857 loads/read-modify-writes, etc.) R reads a series of bytes written by
1858 (defined) write operations (store instructions, atomic
1859 stores/read-modify-writes, memcpy, etc.). For the purposes of this
1860 section, initialized globals are considered to have a write of the
1861 initializer which is atomic and happens before any other read or write
1862 of the memory in question. For each byte of a read R, R\ :sub:`byte`
1863 may see any write to the same byte, except:
1864
1865 -  If write\ :sub:`1`  happens before write\ :sub:`2`, and
1866    write\ :sub:`2` happens before R\ :sub:`byte`, then
1867    R\ :sub:`byte` does not see write\ :sub:`1`.
1868 -  If R\ :sub:`byte` happens before write\ :sub:`3`, then
1869    R\ :sub:`byte` does not see write\ :sub:`3`.
1870
1871 Given that definition, R\ :sub:`byte` is defined as follows:
1872
1873 -  If R is volatile, the result is target-dependent. (Volatile is
1874    supposed to give guarantees which can support ``sig_atomic_t`` in
1875    C/C++, and may be used for accesses to addresses that do not behave
1876    like normal memory. It does not generally provide cross-thread
1877    synchronization.)
1878 -  Otherwise, if there is no write to the same byte that happens before
1879    R\ :sub:`byte`, R\ :sub:`byte` returns ``undef`` for that byte.
1880 -  Otherwise, if R\ :sub:`byte` may see exactly one write,
1881    R\ :sub:`byte` returns the value written by that write.
1882 -  Otherwise, if R is atomic, and all the writes R\ :sub:`byte` may
1883    see are atomic, it chooses one of the values written. See the :ref:`Atomic
1884    Memory Ordering Constraints <ordering>` section for additional
1885    constraints on how the choice is made.
1886 -  Otherwise R\ :sub:`byte` returns ``undef``.
1887
1888 R returns the value composed of the series of bytes it read. This
1889 implies that some bytes within the value may be ``undef`` **without**
1890 the entire value being ``undef``. Note that this only defines the
1891 semantics of the operation; it doesn't mean that targets will emit more
1892 than one instruction to read the series of bytes.
1893
1894 Note that in cases where none of the atomic intrinsics are used, this
1895 model places only one restriction on IR transformations on top of what
1896 is required for single-threaded execution: introducing a store to a byte
1897 which might not otherwise be stored is not allowed in general.
1898 (Specifically, in the case where another thread might write to and read
1899 from an address, introducing a store can change a load that may see
1900 exactly one write into a load that may see multiple writes.)
1901
1902 .. _ordering:
1903
1904 Atomic Memory Ordering Constraints
1905 ----------------------------------
1906
1907 Atomic instructions (:ref:`cmpxchg <i_cmpxchg>`,
1908 :ref:`atomicrmw <i_atomicrmw>`, :ref:`fence <i_fence>`,
1909 :ref:`atomic load <i_load>`, and :ref:`atomic store <i_store>`) take
1910 ordering parameters that determine which other atomic instructions on
1911 the same address they *synchronize with*. These semantics are borrowed
1912 from Java and C++0x, but are somewhat more colloquial. If these
1913 descriptions aren't precise enough, check those specs (see spec
1914 references in the :doc:`atomics guide <Atomics>`).
1915 :ref:`fence <i_fence>` instructions treat these orderings somewhat
1916 differently since they don't take an address. See that instruction's
1917 documentation for details.
1918
1919 For a simpler introduction to the ordering constraints, see the
1920 :doc:`Atomics`.
1921
1922 ``unordered``
1923     The set of values that can be read is governed by the happens-before
1924     partial order. A value cannot be read unless some operation wrote
1925     it. This is intended to provide a guarantee strong enough to model
1926     Java's non-volatile shared variables. This ordering cannot be
1927     specified for read-modify-write operations; it is not strong enough
1928     to make them atomic in any interesting way.
1929 ``monotonic``
1930     In addition to the guarantees of ``unordered``, there is a single
1931     total order for modifications by ``monotonic`` operations on each
1932     address. All modification orders must be compatible with the
1933     happens-before order. There is no guarantee that the modification
1934     orders can be combined to a global total order for the whole program
1935     (and this often will not be possible). The read in an atomic
1936     read-modify-write operation (:ref:`cmpxchg <i_cmpxchg>` and
1937     :ref:`atomicrmw <i_atomicrmw>`) reads the value in the modification
1938     order immediately before the value it writes. If one atomic read
1939     happens before another atomic read of the same address, the later
1940     read must see the same value or a later value in the address's
1941     modification order. This disallows reordering of ``monotonic`` (or
1942     stronger) operations on the same address. If an address is written
1943     ``monotonic``-ally by one thread, and other threads ``monotonic``-ally
1944     read that address repeatedly, the other threads must eventually see
1945     the write. This corresponds to the C++0x/C1x
1946     ``memory_order_relaxed``.
1947 ``acquire``
1948     In addition to the guarantees of ``monotonic``, a
1949     *synchronizes-with* edge may be formed with a ``release`` operation.
1950     This is intended to model C++'s ``memory_order_acquire``.
1951 ``release``
1952     In addition to the guarantees of ``monotonic``, if this operation
1953     writes a value which is subsequently read by an ``acquire``
1954     operation, it *synchronizes-with* that operation. (This isn't a
1955     complete description; see the C++0x definition of a release
1956     sequence.) This corresponds to the C++0x/C1x
1957     ``memory_order_release``.
1958 ``acq_rel`` (acquire+release)
1959     Acts as both an ``acquire`` and ``release`` operation on its
1960     address. This corresponds to the C++0x/C1x ``memory_order_acq_rel``.
1961 ``seq_cst`` (sequentially consistent)
1962     In addition to the guarantees of ``acq_rel`` (``acquire`` for an
1963     operation that only reads, ``release`` for an operation that only
1964     writes), there is a global total order on all
1965     sequentially-consistent operations on all addresses, which is
1966     consistent with the *happens-before* partial order and with the
1967     modification orders of all the affected addresses. Each
1968     sequentially-consistent read sees the last preceding write to the
1969     same address in this global order. This corresponds to the C++0x/C1x
1970     ``memory_order_seq_cst`` and Java volatile.
1971
1972 .. _singlethread:
1973
1974 If an atomic operation is marked ``singlethread``, it only *synchronizes
1975 with* or participates in modification and seq\_cst total orderings with
1976 other operations running in the same thread (for example, in signal
1977 handlers).
1978
1979 .. _fastmath:
1980
1981 Fast-Math Flags
1982 ---------------
1983
1984 LLVM IR floating-point binary ops (:ref:`fadd <i_fadd>`,
1985 :ref:`fsub <i_fsub>`, :ref:`fmul <i_fmul>`, :ref:`fdiv <i_fdiv>`,
1986 :ref:`frem <i_frem>`, :ref:`fcmp <i_fcmp>`) have the following flags that can
1987 be set to enable otherwise unsafe floating point operations
1988
1989 ``nnan``
1990    No NaNs - Allow optimizations to assume the arguments and result are not
1991    NaN. Such optimizations are required to retain defined behavior over
1992    NaNs, but the value of the result is undefined.
1993
1994 ``ninf``
1995    No Infs - Allow optimizations to assume the arguments and result are not
1996    +/-Inf. Such optimizations are required to retain defined behavior over
1997    +/-Inf, but the value of the result is undefined.
1998
1999 ``nsz``
2000    No Signed Zeros - Allow optimizations to treat the sign of a zero
2001    argument or result as insignificant.
2002
2003 ``arcp``
2004    Allow Reciprocal - Allow optimizations to use the reciprocal of an
2005    argument rather than perform division.
2006
2007 ``fast``
2008    Fast - Allow algebraically equivalent transformations that may
2009    dramatically change results in floating point (e.g. reassociate). This
2010    flag implies all the others.
2011
2012 .. _uselistorder:
2013
2014 Use-list Order Directives
2015 -------------------------
2016
2017 Use-list directives encode the in-memory order of each use-list, allowing the
2018 order to be recreated. ``<order-indexes>`` is a comma-separated list of
2019 indexes that are assigned to the referenced value's uses. The referenced
2020 value's use-list is immediately sorted by these indexes.
2021
2022 Use-list directives may appear at function scope or global scope. They are not
2023 instructions, and have no effect on the semantics of the IR. When they're at
2024 function scope, they must appear after the terminator of the final basic block.
2025
2026 If basic blocks have their address taken via ``blockaddress()`` expressions,
2027 ``uselistorder_bb`` can be used to reorder their use-lists from outside their
2028 function's scope.
2029
2030 :Syntax:
2031
2032 ::
2033
2034     uselistorder <ty> <value>, { <order-indexes> }
2035     uselistorder_bb @function, %block { <order-indexes> }
2036
2037 :Examples:
2038
2039 ::
2040
2041     define void @foo(i32 %arg1, i32 %arg2) {
2042     entry:
2043       ; ... instructions ...
2044     bb:
2045       ; ... instructions ...
2046
2047       ; At function scope.
2048       uselistorder i32 %arg1, { 1, 0, 2 }
2049       uselistorder label %bb, { 1, 0 }
2050     }
2051
2052     ; At global scope.
2053     uselistorder i32* @global, { 1, 2, 0 }
2054     uselistorder i32 7, { 1, 0 }
2055     uselistorder i32 (i32) @bar, { 1, 0 }
2056     uselistorder_bb @foo, %bb, { 5, 1, 3, 2, 0, 4 }
2057
2058 .. _typesystem:
2059
2060 Type System
2061 ===========
2062
2063 The LLVM type system is one of the most important features of the
2064 intermediate representation. Being typed enables a number of
2065 optimizations to be performed on the intermediate representation
2066 directly, without having to do extra analyses on the side before the
2067 transformation. A strong type system makes it easier to read the
2068 generated code and enables novel analyses and transformations that are
2069 not feasible to perform on normal three address code representations.
2070
2071 .. _t_void:
2072
2073 Void Type
2074 ---------
2075
2076 :Overview:
2077
2078
2079 The void type does not represent any value and has no size.
2080
2081 :Syntax:
2082
2083
2084 ::
2085
2086       void
2087
2088
2089 .. _t_function:
2090
2091 Function Type
2092 -------------
2093
2094 :Overview:
2095
2096
2097 The function type can be thought of as a function signature. It consists of a
2098 return type and a list of formal parameter types. The return type of a function
2099 type is a void type or first class type --- except for :ref:`label <t_label>`
2100 and :ref:`metadata <t_metadata>` types.
2101
2102 :Syntax:
2103
2104 ::
2105
2106       <returntype> (<parameter list>)
2107
2108 ...where '``<parameter list>``' is a comma-separated list of type
2109 specifiers. Optionally, the parameter list may include a type ``...``, which
2110 indicates that the function takes a variable number of arguments. Variable
2111 argument functions can access their arguments with the :ref:`variable argument
2112 handling intrinsic <int_varargs>` functions. '``<returntype>``' is any type
2113 except :ref:`label <t_label>` and :ref:`metadata <t_metadata>`.
2114
2115 :Examples:
2116
2117 +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2118 | ``i32 (i32)``                   | function taking an ``i32``, returning an ``i32``                                                                                                                    |
2119 +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2120 | ``float (i16, i32 *) *``        | :ref:`Pointer <t_pointer>` to a function that takes an ``i16`` and a :ref:`pointer <t_pointer>` to ``i32``, returning ``float``.                                    |
2121 +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2122 | ``i32 (i8*, ...)``              | A vararg function that takes at least one :ref:`pointer <t_pointer>` to ``i8`` (char in C), which returns an integer. This is the signature for ``printf`` in LLVM. |
2123 +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2124 | ``{i32, i32} (i32)``            | A function taking an ``i32``, returning a :ref:`structure <t_struct>` containing two ``i32`` values                                                                 |
2125 +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2126
2127 .. _t_firstclass:
2128
2129 First Class Types
2130 -----------------
2131
2132 The :ref:`first class <t_firstclass>` types are perhaps the most important.
2133 Values of these types are the only ones which can be produced by
2134 instructions.
2135
2136 .. _t_single_value:
2137
2138 Single Value Types
2139 ^^^^^^^^^^^^^^^^^^
2140
2141 These are the types that are valid in registers from CodeGen's perspective.
2142
2143 .. _t_integer:
2144
2145 Integer Type
2146 """"""""""""
2147
2148 :Overview:
2149
2150 The integer type is a very simple type that simply specifies an
2151 arbitrary bit width for the integer type desired. Any bit width from 1
2152 bit to 2\ :sup:`23`\ -1 (about 8 million) can be specified.
2153
2154 :Syntax:
2155
2156 ::
2157
2158       iN
2159
2160 The number of bits the integer will occupy is specified by the ``N``
2161 value.
2162
2163 Examples:
2164 *********
2165
2166 +----------------+------------------------------------------------+
2167 | ``i1``         | a single-bit integer.                          |
2168 +----------------+------------------------------------------------+
2169 | ``i32``        | a 32-bit integer.                              |
2170 +----------------+------------------------------------------------+
2171 | ``i1942652``   | a really big integer of over 1 million bits.   |
2172 +----------------+------------------------------------------------+
2173
2174 .. _t_floating:
2175
2176 Floating Point Types
2177 """"""""""""""""""""
2178
2179 .. list-table::
2180    :header-rows: 1
2181
2182    * - Type
2183      - Description
2184
2185    * - ``half``
2186      - 16-bit floating point value
2187
2188    * - ``float``
2189      - 32-bit floating point value
2190
2191    * - ``double``
2192      - 64-bit floating point value
2193
2194    * - ``fp128``
2195      - 128-bit floating point value (112-bit mantissa)
2196
2197    * - ``x86_fp80``
2198      -  80-bit floating point value (X87)
2199
2200    * - ``ppc_fp128``
2201      - 128-bit floating point value (two 64-bits)
2202
2203 X86_mmx Type
2204 """"""""""""
2205
2206 :Overview:
2207
2208 The x86_mmx type represents a value held in an MMX register on an x86
2209 machine. The operations allowed on it are quite limited: parameters and
2210 return values, load and store, and bitcast. User-specified MMX
2211 instructions are represented as intrinsic or asm calls with arguments
2212 and/or results of this type. There are no arrays, vectors or constants
2213 of this type.
2214
2215 :Syntax:
2216
2217 ::
2218
2219       x86_mmx
2220
2221
2222 .. _t_pointer:
2223
2224 Pointer Type
2225 """"""""""""
2226
2227 :Overview:
2228
2229 The pointer type is used to specify memory locations. Pointers are
2230 commonly used to reference objects in memory.
2231
2232 Pointer types may have an optional address space attribute defining the
2233 numbered address space where the pointed-to object resides. The default
2234 address space is number zero. The semantics of non-zero address spaces
2235 are target-specific.
2236
2237 Note that LLVM does not permit pointers to void (``void*``) nor does it
2238 permit pointers to labels (``label*``). Use ``i8*`` instead.
2239
2240 :Syntax:
2241
2242 ::
2243
2244       <type> *
2245
2246 :Examples:
2247
2248 +-------------------------+--------------------------------------------------------------------------------------------------------------+
2249 | ``[4 x i32]*``          | A :ref:`pointer <t_pointer>` to :ref:`array <t_array>` of four ``i32`` values.                               |
2250 +-------------------------+--------------------------------------------------------------------------------------------------------------+
2251 | ``i32 (i32*) *``        | A :ref:`pointer <t_pointer>` to a :ref:`function <t_function>` that takes an ``i32*``, returning an ``i32``. |
2252 +-------------------------+--------------------------------------------------------------------------------------------------------------+
2253 | ``i32 addrspace(5)*``   | A :ref:`pointer <t_pointer>` to an ``i32`` value that resides in address space #5.                           |
2254 +-------------------------+--------------------------------------------------------------------------------------------------------------+
2255
2256 .. _t_vector:
2257
2258 Vector Type
2259 """""""""""
2260
2261 :Overview:
2262
2263 A vector type is a simple derived type that represents a vector of
2264 elements. Vector types are used when multiple primitive data are
2265 operated in parallel using a single instruction (SIMD). A vector type
2266 requires a size (number of elements) and an underlying primitive data
2267 type. Vector types are considered :ref:`first class <t_firstclass>`.
2268
2269 :Syntax:
2270
2271 ::
2272
2273       < <# elements> x <elementtype> >
2274
2275 The number of elements is a constant integer value larger than 0;
2276 elementtype may be any integer, floating point or pointer type. Vectors
2277 of size zero are not allowed.
2278
2279 :Examples:
2280
2281 +-------------------+--------------------------------------------------+
2282 | ``<4 x i32>``     | Vector of 4 32-bit integer values.               |
2283 +-------------------+--------------------------------------------------+
2284 | ``<8 x float>``   | Vector of 8 32-bit floating-point values.        |
2285 +-------------------+--------------------------------------------------+
2286 | ``<2 x i64>``     | Vector of 2 64-bit integer values.               |
2287 +-------------------+--------------------------------------------------+
2288 | ``<4 x i64*>``    | Vector of 4 pointers to 64-bit integer values.   |
2289 +-------------------+--------------------------------------------------+
2290
2291 .. _t_label:
2292
2293 Label Type
2294 ^^^^^^^^^^
2295
2296 :Overview:
2297
2298 The label type represents code labels.
2299
2300 :Syntax:
2301
2302 ::
2303
2304       label
2305
2306 .. _t_token:
2307
2308 Token Type
2309 ^^^^^^^^^^
2310
2311 :Overview:
2312
2313 The token type is used when a value is associated with an instruction
2314 but all uses of the value must not attempt to introspect or obscure it.
2315 As such, it is not appropriate to have a :ref:`phi <i_phi>` or
2316 :ref:`select <i_select>` of type token.
2317
2318 :Syntax:
2319
2320 ::
2321
2322       token
2323
2324
2325
2326 .. _t_metadata:
2327
2328 Metadata Type
2329 ^^^^^^^^^^^^^
2330
2331 :Overview:
2332
2333 The metadata type represents embedded metadata. No derived types may be
2334 created from metadata except for :ref:`function <t_function>` arguments.
2335
2336 :Syntax:
2337
2338 ::
2339
2340       metadata
2341
2342 .. _t_aggregate:
2343
2344 Aggregate Types
2345 ^^^^^^^^^^^^^^^
2346
2347 Aggregate Types are a subset of derived types that can contain multiple
2348 member types. :ref:`Arrays <t_array>` and :ref:`structs <t_struct>` are
2349 aggregate types. :ref:`Vectors <t_vector>` are not considered to be
2350 aggregate types.
2351
2352 .. _t_array:
2353
2354 Array Type
2355 """"""""""
2356
2357 :Overview:
2358
2359 The array type is a very simple derived type that arranges elements
2360 sequentially in memory. The array type requires a size (number of
2361 elements) and an underlying data type.
2362
2363 :Syntax:
2364
2365 ::
2366
2367       [<# elements> x <elementtype>]
2368
2369 The number of elements is a constant integer value; ``elementtype`` may
2370 be any type with a size.
2371
2372 :Examples:
2373
2374 +------------------+--------------------------------------+
2375 | ``[40 x i32]``   | Array of 40 32-bit integer values.   |
2376 +------------------+--------------------------------------+
2377 | ``[41 x i32]``   | Array of 41 32-bit integer values.   |
2378 +------------------+--------------------------------------+
2379 | ``[4 x i8]``     | Array of 4 8-bit integer values.     |
2380 +------------------+--------------------------------------+
2381
2382 Here are some examples of multidimensional arrays:
2383
2384 +-----------------------------+----------------------------------------------------------+
2385 | ``[3 x [4 x i32]]``         | 3x4 array of 32-bit integer values.                      |
2386 +-----------------------------+----------------------------------------------------------+
2387 | ``[12 x [10 x float]]``     | 12x10 array of single precision floating point values.   |
2388 +-----------------------------+----------------------------------------------------------+
2389 | ``[2 x [3 x [4 x i16]]]``   | 2x3x4 array of 16-bit integer values.                    |
2390 +-----------------------------+----------------------------------------------------------+
2391
2392 There is no restriction on indexing beyond the end of the array implied
2393 by a static type (though there are restrictions on indexing beyond the
2394 bounds of an allocated object in some cases). This means that
2395 single-dimension 'variable sized array' addressing can be implemented in
2396 LLVM with a zero length array type. An implementation of 'pascal style
2397 arrays' in LLVM could use the type "``{ i32, [0 x float]}``", for
2398 example.
2399
2400 .. _t_struct:
2401
2402 Structure Type
2403 """"""""""""""
2404
2405 :Overview:
2406
2407 The structure type is used to represent a collection of data members
2408 together in memory. The elements of a structure may be any type that has
2409 a size.
2410
2411 Structures in memory are accessed using '``load``' and '``store``' by
2412 getting a pointer to a field with the '``getelementptr``' instruction.
2413 Structures in registers are accessed using the '``extractvalue``' and
2414 '``insertvalue``' instructions.
2415
2416 Structures may optionally be "packed" structures, which indicate that
2417 the alignment of the struct is one byte, and that there is no padding
2418 between the elements. In non-packed structs, padding between field types
2419 is inserted as defined by the DataLayout string in the module, which is
2420 required to match what the underlying code generator expects.
2421
2422 Structures can either be "literal" or "identified". A literal structure
2423 is defined inline with other types (e.g. ``{i32, i32}*``) whereas
2424 identified types are always defined at the top level with a name.
2425 Literal types are uniqued by their contents and can never be recursive
2426 or opaque since there is no way to write one. Identified types can be
2427 recursive, can be opaqued, and are never uniqued.
2428
2429 :Syntax:
2430
2431 ::
2432
2433       %T1 = type { <type list> }     ; Identified normal struct type
2434       %T2 = type <{ <type list> }>   ; Identified packed struct type
2435
2436 :Examples:
2437
2438 +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2439 | ``{ i32, i32, i32 }``        | A triple of three ``i32`` values                                                                                                                                                      |
2440 +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2441 | ``{ float, i32 (i32) * }``   | A pair, where the first element is a ``float`` and the second element is a :ref:`pointer <t_pointer>` to a :ref:`function <t_function>` that takes an ``i32``, returning an ``i32``.  |
2442 +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2443 | ``<{ i8, i32 }>``            | A packed struct known to be 5 bytes in size.                                                                                                                                          |
2444 +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2445
2446 .. _t_opaque:
2447
2448 Opaque Structure Types
2449 """"""""""""""""""""""
2450
2451 :Overview:
2452
2453 Opaque structure types are used to represent named structure types that
2454 do not have a body specified. This corresponds (for example) to the C
2455 notion of a forward declared structure.
2456
2457 :Syntax:
2458
2459 ::
2460
2461       %X = type opaque
2462       %52 = type opaque
2463
2464 :Examples:
2465
2466 +--------------+-------------------+
2467 | ``opaque``   | An opaque type.   |
2468 +--------------+-------------------+
2469
2470 .. _constants:
2471
2472 Constants
2473 =========
2474
2475 LLVM has several different basic types of constants. This section
2476 describes them all and their syntax.
2477
2478 Simple Constants
2479 ----------------
2480
2481 **Boolean constants**
2482     The two strings '``true``' and '``false``' are both valid constants
2483     of the ``i1`` type.
2484 **Integer constants**
2485     Standard integers (such as '4') are constants of the
2486     :ref:`integer <t_integer>` type. Negative numbers may be used with
2487     integer types.
2488 **Floating point constants**
2489     Floating point constants use standard decimal notation (e.g.
2490     123.421), exponential notation (e.g. 1.23421e+2), or a more precise
2491     hexadecimal notation (see below). The assembler requires the exact
2492     decimal value of a floating-point constant. For example, the
2493     assembler accepts 1.25 but rejects 1.3 because 1.3 is a repeating
2494     decimal in binary. Floating point constants must have a :ref:`floating
2495     point <t_floating>` type.
2496 **Null pointer constants**
2497     The identifier '``null``' is recognized as a null pointer constant
2498     and must be of :ref:`pointer type <t_pointer>`.
2499 **Token constants**
2500     The identifier '``none``' is recognized as an empty token constant
2501     and must be of :ref:`token type <t_token>`.
2502
2503 The one non-intuitive notation for constants is the hexadecimal form of
2504 floating point constants. For example, the form
2505 '``double    0x432ff973cafa8000``' is equivalent to (but harder to read
2506 than) '``double 4.5e+15``'. The only time hexadecimal floating point
2507 constants are required (and the only time that they are generated by the
2508 disassembler) is when a floating point constant must be emitted but it
2509 cannot be represented as a decimal floating point number in a reasonable
2510 number of digits. For example, NaN's, infinities, and other special
2511 values are represented in their IEEE hexadecimal format so that assembly
2512 and disassembly do not cause any bits to change in the constants.
2513
2514 When using the hexadecimal form, constants of types half, float, and
2515 double are represented using the 16-digit form shown above (which
2516 matches the IEEE754 representation for double); half and float values
2517 must, however, be exactly representable as IEEE 754 half and single
2518 precision, respectively. Hexadecimal format is always used for long
2519 double, and there are three forms of long double. The 80-bit format used
2520 by x86 is represented as ``0xK`` followed by 20 hexadecimal digits. The
2521 128-bit format used by PowerPC (two adjacent doubles) is represented by
2522 ``0xM`` followed by 32 hexadecimal digits. The IEEE 128-bit format is
2523 represented by ``0xL`` followed by 32 hexadecimal digits. Long doubles
2524 will only work if they match the long double format on your target.
2525 The IEEE 16-bit format (half precision) is represented by ``0xH``
2526 followed by 4 hexadecimal digits. All hexadecimal formats are big-endian
2527 (sign bit at the left).
2528
2529 There are no constants of type x86_mmx.
2530
2531 .. _complexconstants:
2532
2533 Complex Constants
2534 -----------------
2535
2536 Complex constants are a (potentially recursive) combination of simple
2537 constants and smaller complex constants.
2538
2539 **Structure constants**
2540     Structure constants are represented with notation similar to
2541     structure type definitions (a comma separated list of elements,
2542     surrounded by braces (``{}``)). For example:
2543     "``{ i32 4, float 17.0, i32* @G }``", where "``@G``" is declared as
2544     "``@G = external global i32``". Structure constants must have
2545     :ref:`structure type <t_struct>`, and the number and types of elements
2546     must match those specified by the type.
2547 **Array constants**
2548     Array constants are represented with notation similar to array type
2549     definitions (a comma separated list of elements, surrounded by
2550     square brackets (``[]``)). For example:
2551     "``[ i32 42, i32 11, i32 74 ]``". Array constants must have
2552     :ref:`array type <t_array>`, and the number and types of elements must
2553     match those specified by the type. As a special case, character array
2554     constants may also be represented as a double-quoted string using the ``c``
2555     prefix. For example: "``c"Hello World\0A\00"``".
2556 **Vector constants**
2557     Vector constants are represented with notation similar to vector
2558     type definitions (a comma separated list of elements, surrounded by
2559     less-than/greater-than's (``<>``)). For example:
2560     "``< i32 42, i32 11, i32 74, i32 100 >``". Vector constants
2561     must have :ref:`vector type <t_vector>`, and the number and types of
2562     elements must match those specified by the type.
2563 **Zero initialization**
2564     The string '``zeroinitializer``' can be used to zero initialize a
2565     value to zero of *any* type, including scalar and
2566     :ref:`aggregate <t_aggregate>` types. This is often used to avoid
2567     having to print large zero initializers (e.g. for large arrays) and
2568     is always exactly equivalent to using explicit zero initializers.
2569 **Metadata node**
2570     A metadata node is a constant tuple without types. For example:
2571     "``!{!0, !{!2, !0}, !"test"}``". Metadata can reference constant values,
2572     for example: "``!{!0, i32 0, i8* @global, i64 (i64)* @function, !"str"}``".
2573     Unlike other typed constants that are meant to be interpreted as part of
2574     the instruction stream, metadata is a place to attach additional
2575     information such as debug info.
2576
2577 Global Variable and Function Addresses
2578 --------------------------------------
2579
2580 The addresses of :ref:`global variables <globalvars>` and
2581 :ref:`functions <functionstructure>` are always implicitly valid
2582 (link-time) constants. These constants are explicitly referenced when
2583 the :ref:`identifier for the global <identifiers>` is used and always have
2584 :ref:`pointer <t_pointer>` type. For example, the following is a legal LLVM
2585 file:
2586
2587 .. code-block:: llvm
2588
2589     @X = global i32 17
2590     @Y = global i32 42
2591     @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2592
2593 .. _undefvalues:
2594
2595 Undefined Values
2596 ----------------
2597
2598 The string '``undef``' can be used anywhere a constant is expected, and
2599 indicates that the user of the value may receive an unspecified
2600 bit-pattern. Undefined values may be of any type (other than '``label``'
2601 or '``void``') and be used anywhere a constant is permitted.
2602
2603 Undefined values are useful because they indicate to the compiler that
2604 the program is well defined no matter what value is used. This gives the
2605 compiler more freedom to optimize. Here are some examples of
2606 (potentially surprising) transformations that are valid (in pseudo IR):
2607
2608 .. code-block:: llvm
2609
2610       %A = add %X, undef
2611       %B = sub %X, undef
2612       %C = xor %X, undef
2613     Safe:
2614       %A = undef
2615       %B = undef
2616       %C = undef
2617
2618 This is safe because all of the output bits are affected by the undef
2619 bits. Any output bit can have a zero or one depending on the input bits.
2620
2621 .. code-block:: llvm
2622
2623       %A = or %X, undef
2624       %B = and %X, undef
2625     Safe:
2626       %A = -1
2627       %B = 0
2628     Unsafe:
2629       %A = undef
2630       %B = undef
2631
2632 These logical operations have bits that are not always affected by the
2633 input. For example, if ``%X`` has a zero bit, then the output of the
2634 '``and``' operation will always be a zero for that bit, no matter what
2635 the corresponding bit from the '``undef``' is. As such, it is unsafe to
2636 optimize or assume that the result of the '``and``' is '``undef``'.
2637 However, it is safe to assume that all bits of the '``undef``' could be
2638 0, and optimize the '``and``' to 0. Likewise, it is safe to assume that
2639 all the bits of the '``undef``' operand to the '``or``' could be set,
2640 allowing the '``or``' to be folded to -1.
2641
2642 .. code-block:: llvm
2643
2644       %A = select undef, %X, %Y
2645       %B = select undef, 42, %Y
2646       %C = select %X, %Y, undef
2647     Safe:
2648       %A = %X     (or %Y)
2649       %B = 42     (or %Y)
2650       %C = %Y
2651     Unsafe:
2652       %A = undef
2653       %B = undef
2654       %C = undef
2655
2656 This set of examples shows that undefined '``select``' (and conditional
2657 branch) conditions can go *either way*, but they have to come from one
2658 of the two operands. In the ``%A`` example, if ``%X`` and ``%Y`` were
2659 both known to have a clear low bit, then ``%A`` would have to have a
2660 cleared low bit. However, in the ``%C`` example, the optimizer is
2661 allowed to assume that the '``undef``' operand could be the same as
2662 ``%Y``, allowing the whole '``select``' to be eliminated.
2663
2664 .. code-block:: llvm
2665
2666       %A = xor undef, undef
2667
2668       %B = undef
2669       %C = xor %B, %B
2670
2671       %D = undef
2672       %E = icmp slt %D, 4
2673       %F = icmp gte %D, 4
2674
2675     Safe:
2676       %A = undef
2677       %B = undef
2678       %C = undef
2679       %D = undef
2680       %E = undef
2681       %F = undef
2682
2683 This example points out that two '``undef``' operands are not
2684 necessarily the same. This can be surprising to people (and also matches
2685 C semantics) where they assume that "``X^X``" is always zero, even if
2686 ``X`` is undefined. This isn't true for a number of reasons, but the
2687 short answer is that an '``undef``' "variable" can arbitrarily change
2688 its value over its "live range". This is true because the variable
2689 doesn't actually *have a live range*. Instead, the value is logically
2690 read from arbitrary registers that happen to be around when needed, so
2691 the value is not necessarily consistent over time. In fact, ``%A`` and
2692 ``%C`` need to have the same semantics or the core LLVM "replace all
2693 uses with" concept would not hold.
2694
2695 .. code-block:: llvm
2696
2697       %A = fdiv undef, %X
2698       %B = fdiv %X, undef
2699     Safe:
2700       %A = undef
2701     b: unreachable
2702
2703 These examples show the crucial difference between an *undefined value*
2704 and *undefined behavior*. An undefined value (like '``undef``') is
2705 allowed to have an arbitrary bit-pattern. This means that the ``%A``
2706 operation can be constant folded to '``undef``', because the '``undef``'
2707 could be an SNaN, and ``fdiv`` is not (currently) defined on SNaN's.
2708 However, in the second example, we can make a more aggressive
2709 assumption: because the ``undef`` is allowed to be an arbitrary value,
2710 we are allowed to assume that it could be zero. Since a divide by zero
2711 has *undefined behavior*, we are allowed to assume that the operation
2712 does not execute at all. This allows us to delete the divide and all
2713 code after it. Because the undefined operation "can't happen", the
2714 optimizer can assume that it occurs in dead code.
2715
2716 .. code-block:: llvm
2717
2718     a:  store undef -> %X
2719     b:  store %X -> undef
2720     Safe:
2721     a: <deleted>
2722     b: unreachable
2723
2724 These examples reiterate the ``fdiv`` example: a store *of* an undefined
2725 value can be assumed to not have any effect; we can assume that the
2726 value is overwritten with bits that happen to match what was already
2727 there. However, a store *to* an undefined location could clobber
2728 arbitrary memory, therefore, it has undefined behavior.
2729
2730 .. _poisonvalues:
2731
2732 Poison Values
2733 -------------
2734
2735 Poison values are similar to :ref:`undef values <undefvalues>`, however
2736 they also represent the fact that an instruction or constant expression
2737 that cannot evoke side effects has nevertheless detected a condition
2738 that results in undefined behavior.
2739
2740 There is currently no way of representing a poison value in the IR; they
2741 only exist when produced by operations such as :ref:`add <i_add>` with
2742 the ``nsw`` flag.
2743
2744 Poison value behavior is defined in terms of value *dependence*:
2745
2746 -  Values other than :ref:`phi <i_phi>` nodes depend on their operands.
2747 -  :ref:`Phi <i_phi>` nodes depend on the operand corresponding to
2748    their dynamic predecessor basic block.
2749 -  Function arguments depend on the corresponding actual argument values
2750    in the dynamic callers of their functions.
2751 -  :ref:`Call <i_call>` instructions depend on the :ref:`ret <i_ret>`
2752    instructions that dynamically transfer control back to them.
2753 -  :ref:`Invoke <i_invoke>` instructions depend on the
2754    :ref:`ret <i_ret>`, :ref:`resume <i_resume>`, or exception-throwing
2755    call instructions that dynamically transfer control back to them.
2756 -  Non-volatile loads and stores depend on the most recent stores to all
2757    of the referenced memory addresses, following the order in the IR
2758    (including loads and stores implied by intrinsics such as
2759    :ref:`@llvm.memcpy <int_memcpy>`.)
2760 -  An instruction with externally visible side effects depends on the
2761    most recent preceding instruction with externally visible side
2762    effects, following the order in the IR. (This includes :ref:`volatile
2763    operations <volatile>`.)
2764 -  An instruction *control-depends* on a :ref:`terminator
2765    instruction <terminators>` if the terminator instruction has
2766    multiple successors and the instruction is always executed when
2767    control transfers to one of the successors, and may not be executed
2768    when control is transferred to another.
2769 -  Additionally, an instruction also *control-depends* on a terminator
2770    instruction if the set of instructions it otherwise depends on would
2771    be different if the terminator had transferred control to a different
2772    successor.
2773 -  Dependence is transitive.
2774
2775 Poison values have the same behavior as :ref:`undef values <undefvalues>`,
2776 with the additional effect that any instruction that has a *dependence*
2777 on a poison value has undefined behavior.
2778
2779 Here are some examples:
2780
2781 .. code-block:: llvm
2782
2783     entry:
2784       %poison = sub nuw i32 0, 1           ; Results in a poison value.
2785       %still_poison = and i32 %poison, 0   ; 0, but also poison.
2786       %poison_yet_again = getelementptr i32, i32* @h, i32 %still_poison
2787       store i32 0, i32* %poison_yet_again  ; memory at @h[0] is poisoned
2788
2789       store i32 %poison, i32* @g           ; Poison value stored to memory.
2790       %poison2 = load i32, i32* @g         ; Poison value loaded back from memory.
2791
2792       store volatile i32 %poison, i32* @g  ; External observation; undefined behavior.
2793
2794       %narrowaddr = bitcast i32* @g to i16*
2795       %wideaddr = bitcast i32* @g to i64*
2796       %poison3 = load i16, i16* %narrowaddr ; Returns a poison value.
2797       %poison4 = load i64, i64* %wideaddr  ; Returns a poison value.
2798
2799       %cmp = icmp slt i32 %poison, 0       ; Returns a poison value.
2800       br i1 %cmp, label %true, label %end  ; Branch to either destination.
2801
2802     true:
2803       store volatile i32 0, i32* @g        ; This is control-dependent on %cmp, so
2804                                            ; it has undefined behavior.
2805       br label %end
2806
2807     end:
2808       %p = phi i32 [ 0, %entry ], [ 1, %true ]
2809                                            ; Both edges into this PHI are
2810                                            ; control-dependent on %cmp, so this
2811                                            ; always results in a poison value.
2812
2813       store volatile i32 0, i32* @g        ; This would depend on the store in %true
2814                                            ; if %cmp is true, or the store in %entry
2815                                            ; otherwise, so this is undefined behavior.
2816
2817       br i1 %cmp, label %second_true, label %second_end
2818                                            ; The same branch again, but this time the
2819                                            ; true block doesn't have side effects.
2820
2821     second_true:
2822       ; No side effects!
2823       ret void
2824
2825     second_end:
2826       store volatile i32 0, i32* @g        ; This time, the instruction always depends
2827                                            ; on the store in %end. Also, it is
2828                                            ; control-equivalent to %end, so this is
2829                                            ; well-defined (ignoring earlier undefined
2830                                            ; behavior in this example).
2831
2832 .. _blockaddress:
2833
2834 Addresses of Basic Blocks
2835 -------------------------
2836
2837 ``blockaddress(@function, %block)``
2838
2839 The '``blockaddress``' constant computes the address of the specified
2840 basic block in the specified function, and always has an ``i8*`` type.
2841 Taking the address of the entry block is illegal.
2842
2843 This value only has defined behavior when used as an operand to the
2844 ':ref:`indirectbr <i_indirectbr>`' instruction, or for comparisons
2845 against null. Pointer equality tests between labels addresses results in
2846 undefined behavior --- though, again, comparison against null is ok, and
2847 no label is equal to the null pointer. This may be passed around as an
2848 opaque pointer sized value as long as the bits are not inspected. This
2849 allows ``ptrtoint`` and arithmetic to be performed on these values so
2850 long as the original value is reconstituted before the ``indirectbr``
2851 instruction.
2852
2853 Finally, some targets may provide defined semantics when using the value
2854 as the operand to an inline assembly, but that is target specific.
2855
2856 .. _constantexprs:
2857
2858 Constant Expressions
2859 --------------------
2860
2861 Constant expressions are used to allow expressions involving other
2862 constants to be used as constants. Constant expressions may be of any
2863 :ref:`first class <t_firstclass>` type and may involve any LLVM operation
2864 that does not have side effects (e.g. load and call are not supported).
2865 The following is the syntax for constant expressions:
2866
2867 ``trunc (CST to TYPE)``
2868     Truncate a constant to another type. The bit size of CST must be
2869     larger than the bit size of TYPE. Both types must be integers.
2870 ``zext (CST to TYPE)``
2871     Zero extend a constant to another type. The bit size of CST must be
2872     smaller than the bit size of TYPE. Both types must be integers.
2873 ``sext (CST to TYPE)``
2874     Sign extend a constant to another type. The bit size of CST must be
2875     smaller than the bit size of TYPE. Both types must be integers.
2876 ``fptrunc (CST to TYPE)``
2877     Truncate a floating point constant to another floating point type.
2878     The size of CST must be larger than the size of TYPE. Both types
2879     must be floating point.
2880 ``fpext (CST to TYPE)``
2881     Floating point extend a constant to another type. The size of CST
2882     must be smaller or equal to the size of TYPE. Both types must be
2883     floating point.
2884 ``fptoui (CST to TYPE)``
2885     Convert a floating point constant to the corresponding unsigned
2886     integer constant. TYPE must be a scalar or vector integer type. CST
2887     must be of scalar or vector floating point type. Both CST and TYPE
2888     must be scalars, or vectors of the same number of elements. If the
2889     value won't fit in the integer type, the results are undefined.
2890 ``fptosi (CST to TYPE)``
2891     Convert a floating point constant to the corresponding signed
2892     integer constant. TYPE must be a scalar or vector integer type. CST
2893     must be of scalar or vector floating point type. Both CST and TYPE
2894     must be scalars, or vectors of the same number of elements. If the
2895     value won't fit in the integer type, the results are undefined.
2896 ``uitofp (CST to TYPE)``
2897     Convert an unsigned integer constant to the corresponding floating
2898     point constant. TYPE must be a scalar or vector floating point type.
2899     CST must be of scalar or vector integer type. Both CST and TYPE must
2900     be scalars, or vectors of the same number of elements. If the value
2901     won't fit in the floating point type, the results are undefined.
2902 ``sitofp (CST to TYPE)``
2903     Convert a signed integer constant to the corresponding floating
2904     point constant. TYPE must be a scalar or vector floating point type.
2905     CST must be of scalar or vector integer type. Both CST and TYPE must
2906     be scalars, or vectors of the same number of elements. If the value
2907     won't fit in the floating point type, the results are undefined.
2908 ``ptrtoint (CST to TYPE)``
2909     Convert a pointer typed constant to the corresponding integer
2910     constant. ``TYPE`` must be an integer type. ``CST`` must be of
2911     pointer type. The ``CST`` value is zero extended, truncated, or
2912     unchanged to make it fit in ``TYPE``.
2913 ``inttoptr (CST to TYPE)``
2914     Convert an integer constant to a pointer constant. TYPE must be a
2915     pointer type. CST must be of integer type. The CST value is zero
2916     extended, truncated, or unchanged to make it fit in a pointer size.
2917     This one is *really* dangerous!
2918 ``bitcast (CST to TYPE)``
2919     Convert a constant, CST, to another TYPE. The constraints of the
2920     operands are the same as those for the :ref:`bitcast
2921     instruction <i_bitcast>`.
2922 ``addrspacecast (CST to TYPE)``
2923     Convert a constant pointer or constant vector of pointer, CST, to another
2924     TYPE in a different address space. The constraints of the operands are the
2925     same as those for the :ref:`addrspacecast instruction <i_addrspacecast>`.
2926 ``getelementptr (TY, CSTPTR, IDX0, IDX1, ...)``, ``getelementptr inbounds (TY, CSTPTR, IDX0, IDX1, ...)``
2927     Perform the :ref:`getelementptr operation <i_getelementptr>` on
2928     constants. As with the :ref:`getelementptr <i_getelementptr>`
2929     instruction, the index list may have zero or more indexes, which are
2930     required to make sense for the type of "pointer to TY".
2931 ``select (COND, VAL1, VAL2)``
2932     Perform the :ref:`select operation <i_select>` on constants.
2933 ``icmp COND (VAL1, VAL2)``
2934     Performs the :ref:`icmp operation <i_icmp>` on constants.
2935 ``fcmp COND (VAL1, VAL2)``
2936     Performs the :ref:`fcmp operation <i_fcmp>` on constants.
2937 ``extractelement (VAL, IDX)``
2938     Perform the :ref:`extractelement operation <i_extractelement>` on
2939     constants.
2940 ``insertelement (VAL, ELT, IDX)``
2941     Perform the :ref:`insertelement operation <i_insertelement>` on
2942     constants.
2943 ``shufflevector (VEC1, VEC2, IDXMASK)``
2944     Perform the :ref:`shufflevector operation <i_shufflevector>` on
2945     constants.
2946 ``extractvalue (VAL, IDX0, IDX1, ...)``
2947     Perform the :ref:`extractvalue operation <i_extractvalue>` on
2948     constants. The index list is interpreted in a similar manner as
2949     indices in a ':ref:`getelementptr <i_getelementptr>`' operation. At
2950     least one index value must be specified.
2951 ``insertvalue (VAL, ELT, IDX0, IDX1, ...)``
2952     Perform the :ref:`insertvalue operation <i_insertvalue>` on constants.
2953     The index list is interpreted in a similar manner as indices in a
2954     ':ref:`getelementptr <i_getelementptr>`' operation. At least one index
2955     value must be specified.
2956 ``OPCODE (LHS, RHS)``
2957     Perform the specified operation of the LHS and RHS constants. OPCODE
2958     may be any of the :ref:`binary <binaryops>` or :ref:`bitwise
2959     binary <bitwiseops>` operations. The constraints on operands are
2960     the same as those for the corresponding instruction (e.g. no bitwise
2961     operations on floating point values are allowed).
2962
2963 Other Values
2964 ============
2965
2966 .. _inlineasmexprs:
2967
2968 Inline Assembler Expressions
2969 ----------------------------
2970
2971 LLVM supports inline assembler expressions (as opposed to :ref:`Module-Level
2972 Inline Assembly <moduleasm>`) through the use of a special value. This value
2973 represents the inline assembler as a template string (containing the
2974 instructions to emit), a list of operand constraints (stored as a string), a
2975 flag that indicates whether or not the inline asm expression has side effects,
2976 and a flag indicating whether the function containing the asm needs to align its
2977 stack conservatively.
2978
2979 The template string supports argument substitution of the operands using "``$``"
2980 followed by a number, to indicate substitution of the given register/memory
2981 location, as specified by the constraint string. "``${NUM:MODIFIER}``" may also
2982 be used, where ``MODIFIER`` is a target-specific annotation for how to print the
2983 operand (See :ref:`inline-asm-modifiers`).
2984
2985 A literal "``$``" may be included by using "``$$``" in the template. To include
2986 other special characters into the output, the usual "``\XX``" escapes may be
2987 used, just as in other strings. Note that after template substitution, the
2988 resulting assembly string is parsed by LLVM's integrated assembler unless it is
2989 disabled -- even when emitting a ``.s`` file -- and thus must contain assembly
2990 syntax known to LLVM.
2991
2992 LLVM's support for inline asm is modeled closely on the requirements of Clang's
2993 GCC-compatible inline-asm support. Thus, the feature-set and the constraint and
2994 modifier codes listed here are similar or identical to those in GCC's inline asm
2995 support. However, to be clear, the syntax of the template and constraint strings
2996 described here is *not* the same as the syntax accepted by GCC and Clang, and,
2997 while most constraint letters are passed through as-is by Clang, some get
2998 translated to other codes when converting from the C source to the LLVM
2999 assembly.
3000
3001 An example inline assembler expression is:
3002
3003 .. code-block:: llvm
3004
3005     i32 (i32) asm "bswap $0", "=r,r"
3006
3007 Inline assembler expressions may **only** be used as the callee operand
3008 of a :ref:`call <i_call>` or an :ref:`invoke <i_invoke>` instruction.
3009 Thus, typically we have:
3010
3011 .. code-block:: llvm
3012
3013     %X = call i32 asm "bswap $0", "=r,r"(i32 %Y)
3014
3015 Inline asms with side effects not visible in the constraint list must be
3016 marked as having side effects. This is done through the use of the
3017 '``sideeffect``' keyword, like so:
3018
3019 .. code-block:: llvm
3020
3021     call void asm sideeffect "eieio", ""()
3022
3023 In some cases inline asms will contain code that will not work unless
3024 the stack is aligned in some way, such as calls or SSE instructions on
3025 x86, yet will not contain code that does that alignment within the asm.
3026 The compiler should make conservative assumptions about what the asm
3027 might contain and should generate its usual stack alignment code in the
3028 prologue if the '``alignstack``' keyword is present:
3029
3030 .. code-block:: llvm
3031
3032     call void asm alignstack "eieio", ""()
3033
3034 Inline asms also support using non-standard assembly dialects. The
3035 assumed dialect is ATT. When the '``inteldialect``' keyword is present,
3036 the inline asm is using the Intel dialect. Currently, ATT and Intel are
3037 the only supported dialects. An example is:
3038
3039 .. code-block:: llvm
3040
3041     call void asm inteldialect "eieio", ""()
3042
3043 If multiple keywords appear the '``sideeffect``' keyword must come
3044 first, the '``alignstack``' keyword second and the '``inteldialect``'
3045 keyword last.
3046
3047 Inline Asm Constraint String
3048 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3049
3050 The constraint list is a comma-separated string, each element containing one or
3051 more constraint codes.
3052
3053 For each element in the constraint list an appropriate register or memory
3054 operand will be chosen, and it will be made available to assembly template
3055 string expansion as ``$0`` for the first constraint in the list, ``$1`` for the
3056 second, etc.
3057
3058 There are three different types of constraints, which are distinguished by a
3059 prefix symbol in front of the constraint code: Output, Input, and Clobber. The
3060 constraints must always be given in that order: outputs first, then inputs, then
3061 clobbers. They cannot be intermingled.
3062
3063 There are also three different categories of constraint codes:
3064
3065 - Register constraint. This is either a register class, or a fixed physical
3066   register. This kind of constraint will allocate a register, and if necessary,
3067   bitcast the argument or result to the appropriate type.
3068 - Memory constraint. This kind of constraint is for use with an instruction
3069   taking a memory operand. Different constraints allow for different addressing
3070   modes used by the target.
3071 - Immediate value constraint. This kind of constraint is for an integer or other
3072   immediate value which can be rendered directly into an instruction. The
3073   various target-specific constraints allow the selection of a value in the
3074   proper range for the instruction you wish to use it with.
3075
3076 Output constraints
3077 """"""""""""""""""
3078
3079 Output constraints are specified by an "``=``" prefix (e.g. "``=r``"). This
3080 indicates that the assembly will write to this operand, and the operand will
3081 then be made available as a return value of the ``asm`` expression. Output
3082 constraints do not consume an argument from the call instruction. (Except, see
3083 below about indirect outputs).
3084
3085 Normally, it is expected that no output locations are written to by the assembly
3086 expression until *all* of the inputs have been read. As such, LLVM may assign
3087 the same register to an output and an input. If this is not safe (e.g. if the
3088 assembly contains two instructions, where the first writes to one output, and
3089 the second reads an input and writes to a second output), then the "``&``"
3090 modifier must be used (e.g. "``=&r``") to specify that the output is an
3091 "early-clobber" output. Marking an ouput as "early-clobber" ensures that LLVM
3092 will not use the same register for any inputs (other than an input tied to this
3093 output).
3094
3095 Input constraints
3096 """""""""""""""""
3097
3098 Input constraints do not have a prefix -- just the constraint codes. Each input
3099 constraint will consume one argument from the call instruction. It is not
3100 permitted for the asm to write to any input register or memory location (unless
3101 that input is tied to an output). Note also that multiple inputs may all be
3102 assigned to the same register, if LLVM can determine that they necessarily all
3103 contain the same value.
3104
3105 Instead of providing a Constraint Code, input constraints may also "tie"
3106 themselves to an output constraint, by providing an integer as the constraint
3107 string. Tied inputs still consume an argument from the call instruction, and
3108 take up a position in the asm template numbering as is usual -- they will simply
3109 be constrained to always use the same register as the output they've been tied
3110 to. For example, a constraint string of "``=r,0``" says to assign a register for
3111 output, and use that register as an input as well (it being the 0'th
3112 constraint).
3113
3114 It is permitted to tie an input to an "early-clobber" output. In that case, no
3115 *other* input may share the same register as the input tied to the early-clobber
3116 (even when the other input has the same value).
3117
3118 You may only tie an input to an output which has a register constraint, not a
3119 memory constraint. Only a single input may be tied to an output.
3120
3121 There is also an "interesting" feature which deserves a bit of explanation: if a
3122 register class constraint allocates a register which is too small for the value
3123 type operand provided as input, the input value will be split into multiple
3124 registers, and all of them passed to the inline asm.
3125
3126 However, this feature is often not as useful as you might think.
3127
3128 Firstly, the registers are *not* guaranteed to be consecutive. So, on those
3129 architectures that have instructions which operate on multiple consecutive
3130 instructions, this is not an appropriate way to support them. (e.g. the 32-bit
3131 SparcV8 has a 64-bit load, which instruction takes a single 32-bit register. The
3132 hardware then loads into both the named register, and the next register. This
3133 feature of inline asm would not be useful to support that.)
3134
3135 A few of the targets provide a template string modifier allowing explicit access
3136 to the second register of a two-register operand (e.g. MIPS ``L``, ``M``, and
3137 ``D``). On such an architecture, you can actually access the second allocated
3138 register (yet, still, not any subsequent ones). But, in that case, you're still
3139 probably better off simply splitting the value into two separate operands, for
3140 clarity. (e.g. see the description of the ``A`` constraint on X86, which,
3141 despite existing only for use with this feature, is not really a good idea to
3142 use)
3143
3144 Indirect inputs and outputs
3145 """""""""""""""""""""""""""
3146
3147 Indirect output or input constraints can be specified by the "``*``" modifier
3148 (which goes after the "``=``" in case of an output). This indicates that the asm
3149 will write to or read from the contents of an *address* provided as an input
3150 argument. (Note that in this way, indirect outputs act more like an *input* than
3151 an output: just like an input, they consume an argument of the call expression,
3152 rather than producing a return value. An indirect output constraint is an
3153 "output" only in that the asm is expected to write to the contents of the input
3154 memory location, instead of just read from it).
3155
3156 This is most typically used for memory constraint, e.g. "``=*m``", to pass the
3157 address of a variable as a value.
3158
3159 It is also possible to use an indirect *register* constraint, but only on output
3160 (e.g. "``=*r``"). This will cause LLVM to allocate a register for an output
3161 value normally, and then, separately emit a store to the address provided as
3162 input, after the provided inline asm. (It's not clear what value this
3163 functionality provides, compared to writing the store explicitly after the asm
3164 statement, and it can only produce worse code, since it bypasses many
3165 optimization passes. I would recommend not using it.)
3166
3167
3168 Clobber constraints
3169 """""""""""""""""""
3170
3171 A clobber constraint is indicated by a "``~``" prefix. A clobber does not
3172 consume an input operand, nor generate an output. Clobbers cannot use any of the
3173 general constraint code letters -- they may use only explicit register
3174 constraints, e.g. "``~{eax}``". The one exception is that a clobber string of
3175 "``~{memory}``" indicates that the assembly writes to arbitrary undeclared
3176 memory locations -- not only the memory pointed to by a declared indirect
3177 output.
3178
3179
3180 Constraint Codes
3181 """"""""""""""""
3182 After a potential prefix comes constraint code, or codes.
3183
3184 A Constraint Code is either a single letter (e.g. "``r``"), a "``^``" character
3185 followed by two letters (e.g. "``^wc``"), or "``{``" register-name "``}``"
3186 (e.g. "``{eax}``").
3187
3188 The one and two letter constraint codes are typically chosen to be the same as
3189 GCC's constraint codes.
3190
3191 A single constraint may include one or more than constraint code in it, leaving
3192 it up to LLVM to choose which one to use. This is included mainly for
3193 compatibility with the translation of GCC inline asm coming from clang.
3194
3195 There are two ways to specify alternatives, and either or both may be used in an
3196 inline asm constraint list:
3197
3198 1) Append the codes to each other, making a constraint code set. E.g. "``im``"
3199    or "``{eax}m``". This means "choose any of the options in the set". The
3200    choice of constraint is made independently for each constraint in the
3201    constraint list.
3202
3203 2) Use "``|``" between constraint code sets, creating alternatives. Every
3204    constraint in the constraint list must have the same number of alternative
3205    sets. With this syntax, the same alternative in *all* of the items in the
3206    constraint list will be chosen together.
3207
3208 Putting those together, you might have a two operand constraint string like
3209 ``"rm|r,ri|rm"``. This indicates that if operand 0 is ``r`` or ``m``, then
3210 operand 1 may be one of ``r`` or ``i``. If operand 0 is ``r``, then operand 1
3211 may be one of ``r`` or ``m``. But, operand 0 and 1 cannot both be of type m.
3212
3213 However, the use of either of the alternatives features is *NOT* recommended, as
3214 LLVM is not able to make an intelligent choice about which one to use. (At the
3215 point it currently needs to choose, not enough information is available to do so
3216 in a smart way.) Thus, it simply tries to make a choice that's most likely to
3217 compile, not one that will be optimal performance. (e.g., given "``rm``", it'll
3218 always choose to use memory, not registers). And, if given multiple registers,
3219 or multiple register classes, it will simply choose the first one. (In fact, it
3220 doesn't currently even ensure explicitly specified physical registers are
3221 unique, so specifying multiple physical registers as alternatives, like
3222 ``{r11}{r12},{r11}{r12}``, will assign r11 to both operands, not at all what was
3223 intended.)
3224
3225 Supported Constraint Code List
3226 """"""""""""""""""""""""""""""
3227
3228 The constraint codes are, in general, expected to behave the same way they do in
3229 GCC. LLVM's support is often implemented on an 'as-needed' basis, to support C
3230 inline asm code which was supported by GCC. A mismatch in behavior between LLVM
3231 and GCC likely indicates a bug in LLVM.
3232
3233 Some constraint codes are typically supported by all targets:
3234
3235 - ``r``: A register in the target's general purpose register class.
3236 - ``m``: A memory address operand. It is target-specific what addressing modes
3237   are supported, typical examples are register, or register + register offset,
3238   or register + immediate offset (of some target-specific size).
3239 - ``i``: An integer constant (of target-specific width). Allows either a simple
3240   immediate, or a relocatable value.
3241 - ``n``: An integer constant -- *not* including relocatable values.
3242 - ``s``: An integer constant, but allowing *only* relocatable values.
3243 - ``X``: Allows an operand of any kind, no constraint whatsoever. Typically
3244   useful to pass a label for an asm branch or call.
3245
3246   .. FIXME: but that surely isn't actually okay to jump out of an asm
3247      block without telling llvm about the control transfer???)
3248
3249 - ``{register-name}``: Requires exactly the named physical register.
3250
3251 Other constraints are target-specific:
3252
3253 AArch64:
3254
3255 - ``z``: An immediate integer 0. Outputs ``WZR`` or ``XZR``, as appropriate.
3256 - ``I``: An immediate integer valid for an ``ADD`` or ``SUB`` instruction,
3257   i.e. 0 to 4095 with optional shift by 12.
3258 - ``J``: An immediate integer that, when negated, is valid for an ``ADD`` or
3259   ``SUB`` instruction, i.e. -1 to -4095 with optional left shift by 12.
3260 - ``K``: An immediate integer that is valid for the 'bitmask immediate 32' of a
3261   logical instruction like ``AND``, ``EOR``, or ``ORR`` with a 32-bit register.
3262 - ``L``: An immediate integer that is valid for the 'bitmask immediate 64' of a
3263   logical instruction like ``AND``, ``EOR``, or ``ORR`` with a 64-bit register.
3264 - ``M``: An immediate integer for use with the ``MOV`` assembly alias on a
3265   32-bit register. This is a superset of ``K``: in addition to the bitmask
3266   immediate, also allows immediate integers which can be loaded with a single
3267   ``MOVZ`` or ``MOVL`` instruction.
3268 - ``N``: An immediate integer for use with the ``MOV`` assembly alias on a
3269   64-bit register. This is a superset of ``L``.
3270 - ``Q``: Memory address operand must be in a single register (no
3271   offsets). (However, LLVM currently does this for the ``m`` constraint as
3272   well.)
3273 - ``r``: A 32 or 64-bit integer register (W* or X*).
3274 - ``w``: A 32, 64, or 128-bit floating-point/SIMD register.
3275 - ``x``: A lower 128-bit floating-point/SIMD register (``V0`` to ``V15``).
3276
3277 AMDGPU:
3278
3279 - ``r``: A 32 or 64-bit integer register.
3280 - ``[0-9]v``: The 32-bit VGPR register, number 0-9.
3281 - ``[0-9]s``: The 32-bit SGPR register, number 0-9.
3282
3283
3284 All ARM modes:
3285
3286 - ``Q``, ``Um``, ``Un``, ``Uq``, ``Us``, ``Ut``, ``Uv``, ``Uy``: Memory address
3287   operand. Treated the same as operand ``m``, at the moment.
3288
3289 ARM and ARM's Thumb2 mode:
3290
3291 - ``j``: An immediate integer between 0 and 65535 (valid for ``MOVW``)
3292 - ``I``: An immediate integer valid for a data-processing instruction.
3293 - ``J``: An immediate integer between -4095 and 4095.
3294 - ``K``: An immediate integer whose bitwise inverse is valid for a
3295   data-processing instruction. (Can be used with template modifier "``B``" to
3296   print the inverted value).
3297 - ``L``: An immediate integer whose negation is valid for a data-processing
3298   instruction. (Can be used with template modifier "``n``" to print the negated
3299   value).
3300 - ``M``: A power of two or a integer between 0 and 32.
3301 - ``N``: Invalid immediate constraint.
3302 - ``O``: Invalid immediate constraint.
3303 - ``r``: A general-purpose 32-bit integer register (``r0-r15``).
3304 - ``l``: In Thumb2 mode, low 32-bit GPR registers (``r0-r7``). In ARM mode, same
3305   as ``r``.
3306 - ``h``: In Thumb2 mode, a high 32-bit GPR register (``r8-r15``). In ARM mode,
3307   invalid.
3308 - ``w``: A 32, 64, or 128-bit floating-point/SIMD register: ``s0-s31``,
3309   ``d0-d31``, or ``q0-q15``.
3310 - ``x``: A 32, 64, or 128-bit floating-point/SIMD register: ``s0-s15``,
3311   ``d0-d7``, or ``q0-q3``.
3312 - ``t``: A floating-point/SIMD register, only supports 32-bit values:
3313   ``s0-s31``.
3314
3315 ARM's Thumb1 mode:
3316
3317 - ``I``: An immediate integer between 0 and 255.
3318 - ``J``: An immediate integer between -255 and -1.
3319 - ``K``: An immediate integer between 0 and 255, with optional left-shift by
3320   some amount.
3321 - ``L``: An immediate integer between -7 and 7.
3322 - ``M``: An immediate integer which is a multiple of 4 between 0 and 1020.
3323 - ``N``: An immediate integer between 0 and 31.
3324 - ``O``: An immediate integer which is a multiple of 4 between -508 and 508.
3325 - ``r``: A low 32-bit GPR register (``r0-r7``).
3326 - ``l``: A low 32-bit GPR register (``r0-r7``).
3327 - ``h``: A high GPR register (``r0-r7``).
3328 - ``w``: A 32, 64, or 128-bit floating-point/SIMD register: ``s0-s31``,
3329   ``d0-d31``, or ``q0-q15``.
3330 - ``x``: A 32, 64, or 128-bit floating-point/SIMD register: ``s0-s15``,
3331   ``d0-d7``, or ``q0-q3``.
3332 - ``t``: A floating-point/SIMD register, only supports 32-bit values:
3333   ``s0-s31``.
3334
3335
3336 Hexagon:
3337
3338 - ``o``, ``v``: A memory address operand, treated the same as constraint ``m``,
3339   at the moment.
3340 - ``r``: A 32 or 64-bit register.
3341
3342 MSP430:
3343
3344 - ``r``: An 8 or 16-bit register.
3345
3346 MIPS:
3347
3348 - ``I``: An immediate signed 16-bit integer.
3349 - ``J``: An immediate integer zero.
3350 - ``K``: An immediate unsigned 16-bit integer.
3351 - ``L``: An immediate 32-bit integer, where the lower 16 bits are 0.
3352 - ``N``: An immediate integer between -65535 and -1.
3353 - ``O``: An immediate signed 15-bit integer.
3354 - ``P``: An immediate integer between 1 and 65535.
3355 - ``m``: A memory address operand. In MIPS-SE mode, allows a base address
3356   register plus 16-bit immediate offset. In MIPS mode, just a base register.
3357 - ``R``: A memory address operand. In MIPS-SE mode, allows a base address
3358   register plus a 9-bit signed offset. In MIPS mode, the same as constraint
3359   ``m``.
3360 - ``ZC``: A memory address operand, suitable for use in a ``pref``, ``ll``, or
3361   ``sc`` instruction on the given subtarget (details vary).
3362 - ``r``, ``d``,  ``y``: A 32 or 64-bit GPR register.
3363 - ``f``: A 32 or 64-bit FPU register (``F0-F31``), or a 128-bit MSA register
3364   (``W0-W31``). In the case of MSA registers, it is recommended to use the ``w``
3365   argument modifier for compatibility with GCC.
3366 - ``c``: A 32-bit or 64-bit GPR register suitable for indirect jump (always
3367   ``25``).
3368 - ``l``: The ``lo`` register, 32 or 64-bit.
3369 - ``x``: Invalid.
3370
3371 NVPTX:
3372
3373 - ``b``: A 1-bit integer register.
3374 - ``c`` or ``h``: A 16-bit integer register.
3375 - ``r``: A 32-bit integer register.
3376 - ``l`` or ``N``: A 64-bit integer register.
3377 - ``f``: A 32-bit float register.
3378 - ``d``: A 64-bit float register.
3379
3380
3381 PowerPC:
3382
3383 - ``I``: An immediate signed 16-bit integer.
3384 - ``J``: An immediate unsigned 16-bit integer, shifted left 16 bits.
3385 - ``K``: An immediate unsigned 16-bit integer.
3386 - ``L``: An immediate signed 16-bit integer, shifted left 16 bits.
3387 - ``M``: An immediate integer greater than 31.
3388 - ``N``: An immediate integer that is an exact power of 2.
3389 - ``O``: The immediate integer constant 0.
3390 - ``P``: An immediate integer constant whose negation is a signed 16-bit
3391   constant.
3392 - ``es``, ``o``, ``Q``, ``Z``, ``Zy``: A memory address operand, currently
3393   treated the same as ``m``.
3394 - ``r``: A 32 or 64-bit integer register.
3395 - ``b``: A 32 or 64-bit integer register, excluding ``R0`` (that is:
3396   ``R1-R31``).
3397 - ``f``: A 32 or 64-bit float register (``F0-F31``), or when QPX is enabled, a
3398   128 or 256-bit QPX register (``Q0-Q31``; aliases the ``F`` registers).
3399 - ``v``: For ``4 x f32`` or ``4 x f64`` types, when QPX is enabled, a
3400   128 or 256-bit QPX register (``Q0-Q31``), otherwise a 128-bit
3401   altivec vector register (``V0-V31``).
3402
3403   .. FIXME: is this a bug that v accepts QPX registers? I think this
3404      is supposed to only use the altivec vector registers?
3405
3406 - ``y``: Condition register (``CR0-CR7``).
3407 - ``wc``: An individual CR bit in a CR register.
3408 - ``wa``, ``wd``, ``wf``: Any 128-bit VSX vector register, from the full VSX
3409   register set (overlapping both the floating-point and vector register files).
3410 - ``ws``: A 32 or 64-bit floating point register, from the full VSX register
3411   set.
3412
3413 Sparc:
3414
3415 - ``I``: An immediate 13-bit signed integer.
3416 - ``r``: A 32-bit integer register.
3417
3418 SystemZ:
3419
3420 - ``I``: An immediate unsigned 8-bit integer.
3421 - ``J``: An immediate unsigned 12-bit integer.
3422 - ``K``: An immediate signed 16-bit integer.
3423 - ``L``: An immediate signed 20-bit integer.
3424 - ``M``: An immediate integer 0x7fffffff.
3425 - ``Q``, ``R``, ``S``, ``T``: A memory address operand, treated the same as
3426   ``m``, at the moment.
3427 - ``r`` or ``d``: A 32, 64, or 128-bit integer register.
3428 - ``a``: A 32, 64, or 128-bit integer address register (excludes R0, which in an
3429   address context evaluates as zero).
3430 - ``h``: A 32-bit value in the high part of a 64bit data register
3431   (LLVM-specific)
3432 - ``f``: A 32, 64, or 128-bit floating point register.
3433
3434 X86:
3435
3436 - ``I``: An immediate integer between 0 and 31.
3437 - ``J``: An immediate integer between 0 and 64.
3438 - ``K``: An immediate signed 8-bit integer.
3439 - ``L``: An immediate integer, 0xff or 0xffff or (in 64-bit mode only)
3440   0xffffffff.
3441 - ``M``: An immediate integer between 0 and 3.
3442 - ``N``: An immediate unsigned 8-bit integer.
3443 - ``O``: An immediate integer between 0 and 127.
3444 - ``e``: An immediate 32-bit signed integer.
3445 - ``Z``: An immediate 32-bit unsigned integer.
3446 - ``o``, ``v``: Treated the same as ``m``, at the moment.
3447 - ``q``: An 8, 16, 32, or 64-bit register which can be accessed as an 8-bit
3448   ``l`` integer register. On X86-32, this is the ``a``, ``b``, ``c``, and ``d``
3449   registers, and on X86-64, it is all of the integer registers.
3450 - ``Q``: An 8, 16, 32, or 64-bit register which can be accessed as an 8-bit
3451   ``h`` integer register. This is the ``a``, ``b``, ``c``, and ``d`` registers.
3452 - ``r`` or ``l``: An 8, 16, 32, or 64-bit integer register.
3453 - ``R``: An 8, 16, 32, or 64-bit "legacy" integer register -- one which has
3454   existed since i386, and can be accessed without the REX prefix.
3455 - ``f``: A 32, 64, or 80-bit '387 FPU stack pseudo-register.
3456 - ``y``: A 64-bit MMX register, if MMX is enabled.
3457 - ``x``: If SSE is enabled: a 32 or 64-bit scalar operand, or 128-bit vector
3458   operand in a SSE register. If AVX is also enabled, can also be a 256-bit
3459   vector operand in an AVX register. If AVX-512 is also enabled, can also be a
3460   512-bit vector operand in an AVX512 register, Otherwise, an error.
3461 - ``Y``: The same as ``x``, if *SSE2* is enabled, otherwise an error.
3462 - ``A``: Special case: allocates EAX first, then EDX, for a single operand (in
3463   32-bit mode, a 64-bit integer operand will get split into two registers). It
3464   is not recommended to use this constraint, as in 64-bit mode, the 64-bit
3465   operand will get allocated only to RAX -- if two 32-bit operands are needed,
3466   you're better off splitting it yourself, before passing it to the asm
3467   statement.
3468
3469 XCore:
3470
3471 - ``r``: A 32-bit integer register.
3472
3473
3474 .. _inline-asm-modifiers:
3475
3476 Asm template argument modifiers
3477 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3478
3479 In the asm template string, modifiers can be used on the operand reference, like
3480 "``${0:n}``".
3481
3482 The modifiers are, in general, expected to behave the same way they do in
3483 GCC. LLVM's support is often implemented on an 'as-needed' basis, to support C
3484 inline asm code which was supported by GCC. A mismatch in behavior between LLVM
3485 and GCC likely indicates a bug in LLVM.
3486
3487 Target-independent:
3488
3489 - ``c``: Print an immediate integer constant unadorned, without
3490   the target-specific immediate punctuation (e.g. no ``$`` prefix).
3491 - ``n``: Negate and print immediate integer constant unadorned, without the
3492   target-specific immediate punctuation (e.g. no ``$`` prefix).
3493 - ``l``: Print as an unadorned label, without the target-specific label
3494   punctuation (e.g. no ``$`` prefix).
3495
3496 AArch64:
3497
3498 - ``w``: Print a GPR register with a ``w*`` name instead of ``x*`` name. E.g.,
3499   instead of ``x30``, print ``w30``.
3500 - ``x``: Print a GPR register with a ``x*`` name. (this is the default, anyhow).
3501 - ``b``, ``h``, ``s``, ``d``, ``q``: Print a floating-point/SIMD register with a
3502   ``b*``, ``h*``, ``s*``, ``d*``, or ``q*`` name, rather than the default of
3503   ``v*``.
3504
3505 AMDGPU:
3506
3507 - ``r``: No effect.
3508
3509 ARM:
3510
3511 - ``a``: Print an operand as an address (with ``[`` and ``]`` surrounding a
3512   register).
3513 - ``P``: No effect.
3514 - ``q``: No effect.
3515 - ``y``: Print a VFP single-precision register as an indexed double (e.g. print
3516   as ``d4[1]`` instead of ``s9``)
3517 - ``B``: Bitwise invert and print an immediate integer constant without ``#``
3518   prefix.
3519 - ``L``: Print the low 16-bits of an immediate integer constant.
3520 - ``M``: Print as a register set suitable for ldm/stm. Also prints *all*
3521   register operands subsequent to the specified one (!), so use carefully.
3522 - ``Q``: Print the low-order register of a register-pair, or the low-order
3523   register of a two-register operand.
3524 - ``R``: Print the high-order register of a register-pair, or the high-order
3525   register of a two-register operand.
3526 - ``H``: Print the second register of a register-pair. (On a big-endian system,
3527   ``H`` is equivalent to ``Q``, and on little-endian system, ``H`` is equivalent
3528   to ``R``.)
3529
3530   .. FIXME: H doesn't currently support printing the second register
3531      of a two-register operand.
3532
3533 - ``e``: Print the low doubleword register of a NEON quad register.
3534 - ``f``: Print the high doubleword register of a NEON quad register.
3535 - ``m``: Print the base register of a memory operand without the ``[`` and ``]``
3536   adornment.
3537
3538 Hexagon:
3539
3540 - ``L``: Print the second register of a two-register operand. Requires that it
3541   has been allocated consecutively to the first.
3542
3543   .. FIXME: why is it restricted to consecutive ones? And there's
3544      nothing that ensures that happens, is there?
3545
3546 - ``I``: Print the letter 'i' if the operand is an integer constant, otherwise
3547   nothing. Used to print 'addi' vs 'add' instructions.
3548
3549 MSP430:
3550
3551 No additional modifiers.
3552
3553 MIPS:
3554
3555 - ``X``: Print an immediate integer as hexadecimal
3556 - ``x``: Print the low 16 bits of an immediate integer as hexadecimal.
3557 - ``d``: Print an immediate integer as decimal.
3558 - ``m``: Subtract one and print an immediate integer as decimal.
3559 - ``z``: Print $0 if an immediate zero, otherwise print normally.
3560 - ``L``: Print the low-order register of a two-register operand, or prints the
3561   address of the low-order word of a double-word memory operand.
3562
3563   .. FIXME: L seems to be missing memory operand support.
3564
3565 - ``M``: Print the high-order register of a two-register operand, or prints the
3566   address of the high-order word of a double-word memory operand.
3567
3568   .. FIXME: M seems to be missing memory operand support.
3569
3570 - ``D``: Print the second register of a two-register operand, or prints the
3571   second word of a double-word memory operand. (On a big-endian system, ``D`` is
3572   equivalent to ``L``, and on little-endian system, ``D`` is equivalent to
3573   ``M``.)
3574 - ``w``: No effect. Provided for compatibility with GCC which requires this
3575   modifier in order to print MSA registers (``W0-W31``) with the ``f``
3576   constraint.
3577
3578 NVPTX:
3579
3580 - ``r``: No effect.
3581
3582 PowerPC:
3583
3584 - ``L``: Print the second register of a two-register operand. Requires that it
3585   has been allocated consecutively to the first.
3586
3587   .. FIXME: why is it restricted to consecutive ones? And there's
3588      nothing that ensures that happens, is there?
3589
3590 - ``I``: Print the letter 'i' if the operand is an integer constant, otherwise
3591   nothing. Used to print 'addi' vs 'add' instructions.
3592 - ``y``: For a memory operand, prints formatter for a two-register X-form
3593   instruction. (Currently always prints ``r0,OPERAND``).
3594 - ``U``: Prints 'u' if the memory operand is an update form, and nothing
3595   otherwise. (NOTE: LLVM does not support update form, so this will currently
3596   always print nothing)
3597 - ``X``: Prints 'x' if the memory operand is