[Hexagon] Handle all compares of i1 and vNi1
[llvm-project.git] / llvm / docs / Extensions.rst
blobb4ea741fdfe7b9c93cc8f4631512abc777b10740
1 ===============
2 LLVM Extensions
3 ===============
5 .. contents::
6    :local:
8 .. toctree::
9    :hidden:
11 Introduction
12 ============
14 This document describes extensions to tools and formats LLVM seeks compatibility
15 with.
17 General Assembly Syntax
18 ===========================
20 C99-style Hexadecimal Floating-point Constants
21 ----------------------------------------------
23 LLVM's assemblers allow floating-point constants to be written in C99's
24 hexadecimal format instead of decimal if desired.
26 .. code-block:: gas
28   .section .data
29   .float 0x1c2.2ap3
31 Machine-specific Assembly Syntax
32 ================================
34 X86/COFF-Dependent
35 ------------------
37 Relocations
38 ^^^^^^^^^^^
40 The following additional relocation types are supported:
42 **@IMGREL** (AT&T syntax only) generates an image-relative relocation that
43 corresponds to the COFF relocation types ``IMAGE_REL_I386_DIR32NB`` (32-bit) or
44 ``IMAGE_REL_AMD64_ADDR32NB`` (64-bit).
46 .. code-block:: text
48   .text
49   fun:
50     mov foo@IMGREL(%ebx, %ecx, 4), %eax
52   .section .pdata
53     .long fun@IMGREL
54     .long (fun@imgrel + 0x3F)
55     .long $unwind$fun@imgrel
57 **.secrel32** generates a relocation that corresponds to the COFF relocation
58 types ``IMAGE_REL_I386_SECREL`` (32-bit) or ``IMAGE_REL_AMD64_SECREL`` (64-bit).
60 **.secidx** relocation generates an index of the section that contains
61 the target.  It corresponds to the COFF relocation types
62 ``IMAGE_REL_I386_SECTION`` (32-bit) or ``IMAGE_REL_AMD64_SECTION`` (64-bit).
64 .. code-block:: none
66   .section .debug$S,"rn"
67     .long 4
68     .long 242
69     .long 40
70     .secrel32 _function_name + 0
71     .secidx   _function_name
72     ...
74 ``.linkonce`` Directive
75 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77 Syntax:
79    ``.linkonce [ comdat type ]``
81 Supported COMDAT types:
83 ``discard``
84    Discards duplicate sections with the same COMDAT symbol. This is the default
85    if no type is specified.
87 ``one_only``
88    If the symbol is defined multiple times, the linker issues an error.
90 ``same_size``
91    Duplicates are discarded, but the linker issues an error if any have
92    different sizes.
94 ``same_contents``
95    Duplicates are discarded, but the linker issues an error if any duplicates
96    do not have exactly the same content.
98 ``largest``
99    Links the largest section from among the duplicates.
101 ``newest``
102    Links the newest section from among the duplicates.
105 .. code-block:: gas
107   .section .text$foo
108   .linkonce
109     ...
111 ``.section`` Directive
112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114 MC supports passing the information in ``.linkonce`` at the end of
115 ``.section``. For example,  these two codes are equivalent
117 .. code-block:: gas
119   .section secName, "dr", discard, "Symbol1"
120   .globl Symbol1
121   Symbol1:
122   .long 1
124 .. code-block:: gas
126   .section secName, "dr"
127   .linkonce discard
128   .globl Symbol1
129   Symbol1:
130   .long 1
132 Note that in the combined form the COMDAT symbol is explicit. This
133 extension exists to support multiple sections with the same name in
134 different COMDATs:
137 .. code-block:: gas
139   .section secName, "dr", discard, "Symbol1"
140   .globl Symbol1
141   Symbol1:
142   .long 1
144   .section secName, "dr", discard, "Symbol2"
145   .globl Symbol2
146   Symbol2:
147   .long 1
149 In addition to the types allowed with ``.linkonce``, ``.section`` also accepts
150 ``associative``. The meaning is that the section is linked  if a certain other
151 COMDAT section is linked. This other section is indicated by the comdat symbol
152 in this directive. It can be any symbol defined in the associated section, but
153 is usually the associated section's comdat.
155    The following restrictions apply to the associated section:
157    1. It must be a COMDAT section.
158    2. It cannot be another associative COMDAT section.
160 In the following example the symbol ``sym`` is the comdat symbol of ``.foo``
161 and ``.bar`` is associated to ``.foo``.
163 .. code-block:: gas
165         .section        .foo,"bw",discard, "sym"
166         .section        .bar,"rd",associative, "sym"
168 MC supports these flags in the COFF ``.section`` directive:
170   - ``b``: BSS section (``IMAGE_SCN_CNT_INITIALIZED_DATA``)
171   - ``d``: Data section (``IMAGE_SCN_CNT_UNINITIALIZED_DATA``)
172   - ``n``: Section is not loaded (``IMAGE_SCN_LNK_REMOVE``)
173   - ``r``: Read-only
174   - ``s``: Shared section
175   - ``w``: Writable
176   - ``x``: Executable section
177   - ``y``: Not readable
178   - ``D``: Discardable (``IMAGE_SCN_MEM_DISCARDABLE``)
180 These flags are all compatible with gas, with the exception of the ``D`` flag,
181 which gnu as does not support. For gas compatibility, sections with a name
182 starting with ".debug" are implicitly discardable.
185 ARM64/COFF-Dependent
186 --------------------
188 Relocations
189 ^^^^^^^^^^^
191 The following additional symbol variants are supported:
193 **:secrel_lo12:** generates a relocation that corresponds to the COFF relocation
194 types ``IMAGE_REL_ARM64_SECREL_LOW12A`` or ``IMAGE_REL_ARM64_SECREL_LOW12L``.
196 **:secrel_hi12:** generates a relocation that corresponds to the COFF relocation
197 type ``IMAGE_REL_ARM64_SECREL_HIGH12A``.
199 .. code-block:: gas
201     add x0, x0, :secrel_hi12:symbol
202     ldr x0, [x0, :secrel_lo12:symbol]
204     add x1, x1, :secrel_hi12:symbol
205     add x1, x1, :secrel_lo12:symbol
206     ...
209 ELF-Dependent
210 -------------
212 ``.section`` Directive
213 ^^^^^^^^^^^^^^^^^^^^^^
215 In order to support creating multiple sections with the same name and comdat,
216 it is possible to add an unique number at the end of the ``.section`` directive.
217 For example, the following code creates two sections named ``.text``.
219 .. code-block:: gas
221         .section        .text,"ax",@progbits,unique,1
222         nop
224         .section        .text,"ax",@progbits,unique,2
225         nop
228 The unique number is not present in the resulting object at all. It is just used
229 in the assembler to differentiate the sections.
231 The 'o' flag is mapped to SHF_LINK_ORDER. If it is present, a symbol
232 must be given that identifies the section to be placed is the
233 .sh_link.
235 .. code-block:: gas
237         .section .foo,"a",@progbits
238         .Ltmp:
239         .section .bar,"ao",@progbits,.Ltmp
241 which is equivalent to just
243 .. code-block:: gas
245         .section .foo,"a",@progbits
246         .section .bar,"ao",@progbits,.foo
248 ``.linker-options`` Section (linker options)
249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
251 In order to support passing linker options from the frontend to the linker, a
252 special section of type ``SHT_LLVM_LINKER_OPTIONS`` (usually named
253 ``.linker-options`` though the name is not significant as it is identified by
254 the type).  The contents of this section is a simple pair-wise encoding of
255 directives for consideration by the linker.  The strings are encoded as standard
256 null-terminated UTF-8 strings.  They are emitted inline to avoid having the
257 linker traverse the object file for retrieving the value.  The linker is
258 permitted to not honour the option and instead provide a warning/error to the
259 user that the requested option was not honoured.
261 The section has type ``SHT_LLVM_LINKER_OPTIONS`` and has the ``SHF_EXCLUDE``
262 flag to ensure that the section is treated as opaque by linkers which do not
263 support the feature and will not be emitted into the final linked binary.
265 This would be equivalent to the follow raw assembly:
267 .. code-block:: gas
269   .section ".linker-options","e",@llvm_linker_options
270   .asciz "option 1"
271   .asciz "value 1"
272   .asciz "option 2"
273   .asciz "value 2"
275 The following directives are specified:
277   - lib
279     The parameter identifies a library to be linked against.  The library will
280     be looked up in the default and any specified library search paths
281     (specified to this point).
283   - libpath
285     The parameter identifies an additional library search path to be considered
286     when looking up libraries after the inclusion of this option.
288 ``SHT_LLVM_DEPENDENT_LIBRARIES`` Section (Dependent Libraries)
289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
291 This section contains strings specifying libraries to be added to the link by
292 the linker.
294 The section should be consumed by the linker and not written to the output.
296 The strings are encoded as standard null-terminated UTF-8 strings.
298 For example:
300 .. code-block:: gas
302   .section ".deplibs","MS",@llvm_dependent_libraries,1
303   .asciz "library specifier 1"
304   .asciz "library specifier 2"
306 The interpretation of the library specifiers is defined by the consuming linker.
308 ``SHT_LLVM_CALL_GRAPH_PROFILE`` Section (Call Graph Profile)
309 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
311 This section is used to pass a call graph profile to the linker which can be
312 used to optimize the placement of sections.  It contains a sequence of
313 (from symbol, to symbol, weight) tuples.
315 It shall have a type of ``SHT_LLVM_CALL_GRAPH_PROFILE`` (0x6fff4c02), shall
316 have the ``SHF_EXCLUDE`` flag set, the ``sh_link`` member shall hold the section
317 header index of the associated symbol table, and shall have a ``sh_entsize`` of
318 16.  It should be named ``.llvm.call-graph-profile``.
320 The contents of the section shall be a sequence of ``Elf_CGProfile`` entries.
322 .. code-block:: c
324   typedef struct {
325     Elf_Word cgp_from;
326     Elf_Word cgp_to;
327     Elf_Xword cgp_weight;
328   } Elf_CGProfile;
330 cgp_from
331   The symbol index of the source of the edge.
333 cgp_to
334   The symbol index of the destination of the edge.
336 cgp_weight
337   The weight of the edge.
339 This is represented in assembly as:
341 .. code-block:: gas
343   .cg_profile from, to, 42
345 ``.cg_profile`` directives are processed at the end of the file.  It is an error
346 if either ``from`` or ``to`` are undefined temporary symbols.  If either symbol
347 is a temporary symbol, then the section symbol is used instead.  If either
348 symbol is undefined, then that symbol is defined as if ``.weak symbol`` has been
349 written at the end of the file.  This forces the symbol to show up in the symbol
350 table.
352 ``SHT_LLVM_ADDRSIG`` Section (address-significance table)
353 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
355 This section is used to mark symbols as address-significant, i.e. the address
356 of the symbol is used in a comparison or leaks outside the translation unit. It
357 has the same meaning as the absence of the LLVM attributes ``unnamed_addr``
358 and ``local_unnamed_addr``.
360 Any sections referred to by symbols that are not marked as address-significant
361 in any object file may be safely merged by a linker without breaking the
362 address uniqueness guarantee provided by the C and C++ language standards.
364 The contents of the section are a sequence of ULEB128-encoded integers
365 referring to the symbol table indexes of the address-significant symbols.
367 There are two associated assembly directives:
369 .. code-block:: gas
371   .addrsig
373 This instructs the assembler to emit an address-significance table. Without
374 this directive, all symbols are considered address-significant.
376 .. code-block:: gas
378   .addrsig_sym sym
380 If ``sym`` is not otherwise referenced or defined anywhere else in the file,
381 this directive is a no-op. Otherwise, mark ``sym`` as address-significant.
383 ``SHT_LLVM_SYMPART`` Section (symbol partition specification)
384 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
386 This section is used to mark symbols with the `partition`_ that they
387 belong to. An ``.llvm_sympart`` section consists of a null-terminated string
388 specifying the name of the partition followed by a relocation referring to
389 the symbol that belongs to the partition. It may be constructed as follows:
391 .. code-block:: gas
393   .section ".llvm_sympart","",@llvm_sympart
394   .asciz "libpartition.so"
395   .word symbol_in_partition
397 .. _partition: https://lld.llvm.org/Partitions.html
399 ``SHT_LLVM_BB_ADDR_MAP`` Section (basic block address map)
400 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
401 This section stores the binary address of basic blocks along with other related
402 metadata. This information can be used to map binary profiles (like perf
403 profiles) directly to machine basic blocks.
404 This section is emitted with ``-basic-block-sections=labels`` and will contain
405 a BB address map table for every function.
407 The ``SHT_LLVM_BB_ADDR_MAP`` type provides backward compatibility to allow
408 reading older versions of the BB address map generated by older compilers. Each
409 function entry starts with a version byte which specifies the encoding version
410 to use. The following versioning schemes are currently supported.
412 Version 1 (newest): basic block address offsets are computed relative to the end
413 of previous blocks.
415 Example:
417 .. code-block:: gas
419   .section  ".llvm_bb_addr_map","",@llvm_bb_addr_map
420   .byte     1                             # version number
421   .byte     0                             # feature byte (reserved for future use)
422   .quad     .Lfunc_begin0                 # address of the function
423   .byte     2                             # number of basic blocks
424   # BB record for BB_0
425    .uleb128  .Lfunc_beign0-.Lfunc_begin0  # BB_0 offset relative to function entry (always zero)
426    .uleb128  .LBB_END0_0-.Lfunc_begin0    # BB_0 size
427    .byte     x                            # BB_0 metadata
428   # BB record for BB_1
429    .uleb128  .LBB0_1-.LBB_END0_0          # BB_1 offset relative to the end of last block (BB_0).
430    .uleb128  .LBB_END0_1-.LBB0_1          # BB_1 size
431    .byte     y                            # BB_1 metadata
433 Version 0: basic block address offsets are computed relative to the function
434 address. This uses the unversioned ``SHT_LLVM_BB_ADDR_MAP_V0`` section type and
435 is semantically equivalent to using ``SHT_LLVM_BB_ADDR_MAP`` with a zero
436 version field.
438 Example:
440 .. code-block:: gas
442   .section  ".llvm_bb_addr_map","",@llvm_bb_addr_map_v0
443   .quad     .Lfunc_begin0                 # address of the function
444   .byte     2                             # number of basic blocks
445   # BB record for BB_0
446    .uleb128  .Lfunc_beign0-.Lfunc_begin0  # BB_0 offset relative to the function entry (always zero)
447    .uleb128  .LBB_END0_0-.Lfunc_begin0    # BB_0 size
448    .byte     x                            # BB_0 metadata
449   # BB record for BB_1
450    .uleb128  .LBB0_1-.Lfunc_begin0        # BB_1 offset relative to the function entry
451    .uleb128  .LBB_END0_1-.LBB0_1          # BB_1 size
452    .byte     y                            # BB_1 metadata
454 ``SHT_LLVM_OFFLOADING`` Section (offloading data)
455 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
456 This section stores the binary data used to perform offloading device linking
457 and execution, creating a fat binary. This section is emitted during compilation
458 of offloading languages such as OpenMP or CUDA. If the data is intended to be
459 used by the device linker only, it should use the ``SHF_EXCLUDE`` flag so it is
460 automatically stripped from the final executable or shared library.
462 The binary data stored in this section conforms to a custom binary format used
463 for storing offloading metadata. This format is effectively a string table
464 containing metadata accompanied by a device image.
466 CodeView-Dependent
467 ------------------
469 ``.cv_file`` Directive
470 ^^^^^^^^^^^^^^^^^^^^^^
471 Syntax:
472   ``.cv_file`` *FileNumber FileName* [ *checksum* ] [ *checksumkind* ]
474 ``.cv_func_id`` Directive
475 ^^^^^^^^^^^^^^^^^^^^^^^^^
476 Introduces a function ID that can be used with ``.cv_loc``.
478 Syntax:
479   ``.cv_func_id`` *FunctionId*
481 ``.cv_inline_site_id`` Directive
482 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
483 Introduces a function ID that can be used with ``.cv_loc``. Includes
484 ``inlined at`` source location information for use in the line table of the
485 caller, whether the caller is a real function or another inlined call site.
487 Syntax:
488   ``.cv_inline_site_id`` *FunctionId* ``within`` *Function* ``inlined_at`` *FileNumber Line* [ *Column* ]
490 ``.cv_loc`` Directive
491 ^^^^^^^^^^^^^^^^^^^^^
492 The first number is a file number, must have been previously assigned with a
493 ``.file`` directive, the second number is the line number and optionally the
494 third number is a column position (zero if not specified).  The remaining
495 optional items are ``.loc`` sub-directives.
497 Syntax:
498   ``.cv_loc`` *FunctionId FileNumber* [ *Line* ] [ *Column* ] [ *prologue_end* ] [ ``is_stmt`` *value* ]
500 ``.cv_linetable`` Directive
501 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
502 Syntax:
503   ``.cv_linetable`` *FunctionId* ``,`` *FunctionStart* ``,`` *FunctionEnd*
505 ``.cv_inline_linetable`` Directive
506 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
507 Syntax:
508   ``.cv_inline_linetable`` *PrimaryFunctionId* ``,`` *FileNumber Line FunctionStart FunctionEnd*
510 ``.cv_def_range`` Directive
511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
512 The *GapStart* and *GapEnd* options may be repeated as needed.
514 Syntax:
515   ``.cv_def_range`` *RangeStart RangeEnd* [ *GapStart GapEnd* ] ``,`` *bytes*
517 ``.cv_stringtable`` Directive
518 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
520 ``.cv_filechecksums`` Directive
521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
523 ``.cv_filechecksumoffset`` Directive
524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
525 Syntax:
526   ``.cv_filechecksumoffset`` *FileNumber*
528 ``.cv_fpo_data`` Directive
529 ^^^^^^^^^^^^^^^^^^^^^^^^^^
530 Syntax:
531   ``.cv_fpo_data`` *procsym*
533 Target Specific Behaviour
534 =========================
539 Relocations
540 ^^^^^^^^^^^
542 **@ABS8** can be applied to symbols which appear as immediate operands to
543 instructions that have an 8-bit immediate form for that operand. It causes
544 the assembler to use the 8-bit form and an 8-bit relocation (e.g. ``R_386_8``
545 or ``R_X86_64_8``) for the symbol.
547 For example:
549 .. code-block:: gas
551   cmpq $foo@ABS8, %rdi
553 This causes the assembler to select the form of the 64-bit ``cmpq`` instruction
554 that takes an 8-bit immediate operand that is sign extended to 64 bits, as
555 opposed to ``cmpq $foo, %rdi`` which takes a 32-bit immediate operand. This
556 is also not the same as ``cmpb $foo, %dil``, which is an 8-bit comparison.
559 **@GOTPCREL_NORELAX** can be used in place of ``@GOTPCREL`` to guarantee that
560 the assembler emits an ``R_X86_64_GOTPCREL`` relocation instead of a relaxable
561 ``R_X86_64[_REX]_GOTPCRELX`` relocation.
563 Windows on ARM
564 --------------
566 Stack Probe Emission
567 ^^^^^^^^^^^^^^^^^^^^
569 The reference implementation (Microsoft Visual Studio 2012) emits stack probes
570 in the following fashion:
572 .. code-block:: gas
574   movw r4, #constant
575   bl __chkstk
576   sub.w sp, sp, r4
578 However, this has the limitation of 32 MiB (±16MiB).  In order to accommodate
579 larger binaries, LLVM supports the use of ``-mcmodel=large`` to allow a 4GiB
580 range via a slight deviation.  It will generate an indirect jump as follows:
582 .. code-block:: gas
584   movw r4, #constant
585   movw r12, :lower16:__chkstk
586   movt r12, :upper16:__chkstk
587   blx r12
588   sub.w sp, sp, r4
590 Variable Length Arrays
591 ^^^^^^^^^^^^^^^^^^^^^^
593 The reference implementation (Microsoft Visual Studio 2012) does not permit the
594 emission of Variable Length Arrays (VLAs).
596 The Windows ARM Itanium ABI extends the base ABI by adding support for emitting
597 a dynamic stack allocation.  When emitting a variable stack allocation, a call
598 to ``__chkstk`` is emitted unconditionally to ensure that guard pages are setup
599 properly.  The emission of this stack probe emission is handled similar to the
600 standard stack probe emission.
602 The MSVC environment does not emit code for VLAs currently.
604 Windows on ARM64
605 ----------------
607 Stack Probe Emission
608 ^^^^^^^^^^^^^^^^^^^^
610 The reference implementation (Microsoft Visual Studio 2017) emits stack probes
611 in the following fashion:
613 .. code-block:: gas
615   mov x15, #constant
616   bl __chkstk
617   sub sp, sp, x15, lsl #4
619 However, this has the limitation of 256 MiB (±128MiB).  In order to accommodate
620 larger binaries, LLVM supports the use of ``-mcmodel=large`` to allow a 8GiB
621 (±4GiB) range via a slight deviation.  It will generate an indirect jump as
622 follows:
624 .. code-block:: gas
626   mov x15, #constant
627   adrp x16, __chkstk
628   add x16, x16, :lo12:__chkstk
629   blr x16
630   sub sp, sp, x15, lsl #4