docs/Extensions.rst

   1 ===============
   2 LLVM Extensions
   3 ===============
   4
   5 .. contents::
   6    :local:
   7
   8 .. toctree::
   9    :hidden:
  10
  11 Introduction
  12 ============
  13
  14 This document describes extensions to tools and formats LLVM seeks compatibility
  15 with.
  16
  17 General Assembly Syntax
  18 ===========================
  19
  20 C99-style Hexadecimal Floating-point Constants
  21 ----------------------------------------------
  22
  23 LLVM's assemblers allow floating-point constants to be written in C99's
  24 hexadecimal format instead of decimal if desired.
  25
  26 .. code-block:: gas
  27
  28   .section .data
  29   .float 0x1c2.2ap3
  30
  31 Machine-specific Assembly Syntax
  32 ================================
  33
  34 X86/COFF-Dependent
  35 ------------------
  36
  37 Relocations
  38 ^^^^^^^^^^^
  39
  40 The following additional relocation types are supported:
  41
  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).
  45
  46 .. code-block:: text
  47
  48   .text
  49   fun:
  50     mov foo@IMGREL(%ebx, %ecx, 4), %eax
  51
  52   .section .pdata
  53     .long fun@IMGREL
  54     .long (fun@imgrel + 0x3F)
  55     .long $unwind$fun@imgrel
  56
  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).
  59
  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).
  63
  64 .. code-block:: none
  65
  66   .section .debug$S,"rn"
  67     .long 4
  68     .long 242
  69     .long 40
  70     .secrel32 _function_name + 0
  71     .secidx   _function_name
  72     ...
  73
  74 ``.linkonce`` Directive
  75 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  76
  77 Syntax:
  78
  79    ``.linkonce [ comdat type ]``
  80
  81 Supported COMDAT types:
  82
  83 ``discard``
  84    Discards duplicate sections with the same COMDAT symbol. This is the default
  85    if no type is specified.
  86
  87 ``one_only``
  88    If the symbol is defined multiple times, the linker issues an error.
  89
  90 ``same_size``
  91    Duplicates are discarded, but the linker issues an error if any have
  92    different sizes.
  93
  94 ``same_contents``
  95    Duplicates are discarded, but the linker issues an error if any duplicates
  96    do not have exactly the same content.
  97
  98 ``largest``
  99    Links the largest section from among the duplicates.
 100
 101 ``newest``
 102    Links the newest section from among the duplicates.
 103
 104
 105 .. code-block:: gas
 106
 107   .section .text$foo
 108   .linkonce
 109     ...
 110
 111 ``.section`` Directive
 112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 113
 114 MC supports passing the information in ``.linkonce`` at the end of
 115 ``.section``. For example,  these two codes are equivalent
 116
 117 .. code-block:: gas
 118
 119   .section secName, "dr", discard, "Symbol1"
 120   .globl Symbol1
 121   Symbol1:
 122   .long 1
 123
 124 .. code-block:: gas
 125
 126   .section secName, "dr"
 127   .linkonce discard
 128   .globl Symbol1
 129   Symbol1:
 130   .long 1
 131
 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:
 135
 136
 137 .. code-block:: gas
 138
 139   .section secName, "dr", discard, "Symbol1"
 140   .globl Symbol1
 141   Symbol1:
 142   .long 1
 143
 144   .section secName, "dr", discard, "Symbol2"
 145   .globl Symbol2
 146   Symbol2:
 147   .long 1
 148
 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.
 154
 155    The following restrictions apply to the associated section:
 156
 157    1. It must be a COMDAT section.
 158    2. It cannot be another associative COMDAT section.
 159
 160 In the following example the symobl ``sym`` is the comdat symbol of ``.foo``
 161 and ``.bar`` is associated to ``.foo``.
 162
 163 .. code-block:: gas
 164
 165         .section        .foo,"bw",discard, "sym"
 166         .section        .bar,"rd",associative, "sym"
 167
 168 MC supports these flags in the COFF ``.section`` directive:
 169
 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``)
 179
 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.
 183
 184
 185 ARM64/COFF-Dependent
 186 --------------------
 187
 188 Relocations
 189 ^^^^^^^^^^^
 190
 191 The following additional symbol variants are supported:
 192
 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``.
 195
 196 **:secrel_hi12:** generates a relocation that corresponds to the COFF relocation
 197 type ``IMAGE_REL_ARM64_SECREL_HIGH12A``.
 198
 199 .. code-block:: gas
 200
 201     add x0, x0, :secrel_hi12:symbol
 202     ldr x0, [x0, :secrel_lo12:symbol]
 203
 204     add x1, x1, :secrel_hi12:symbol
 205     add x1, x1, :secrel_lo12:symbol
 206     ...
 207
 208
 209 ELF-Dependent
 210 -------------
 211
 212 ``.section`` Directive
 213 ^^^^^^^^^^^^^^^^^^^^^^
 214
 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 ``.seciton`` directive.
 217 For example, the following code creates two sections named ``.text``.
 218
 219 .. code-block:: gas
 220
 221         .section        .text,"ax",@progbits,unique,1
 222         nop
 223
 224         .section        .text,"ax",@progbits,unique,2
 225         nop
 226
 227
 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.
 230
 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.
 234
 235 .. code-block:: gas
 236
 237         .section .foo,"a",@progbits
 238         .Ltmp:
 239         .section .bar,"ao",@progbits,.Ltmp
 240
 241 which is equivalent to just
 242
 243 .. code-block:: gas
 244
 245         .section .foo,"a",@progbits
 246         .section .bar,"ao",@progbits,.foo
 247
 248 ``.linker-options`` Section (linker options)
 249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 250
 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.
 260
 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.
 264
 265 This would be equivalent to the follow raw assembly:
 266
 267 .. code-block:: gas
 268
 269   .section ".linker-options","e",@llvm_linker_options
 270   .asciz "option 1"
 271   .asciz "value 1"
 272   .asciz "option 2"
 273   .asciz "value 2"
 274
 275 The following directives are specified:
 276
 277   - lib
 278
 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).
 282
 283   - libpath
 284
 285     The paramter identifies an additional library search path to be considered
 286     when looking up libraries after the inclusion of this option.
 287
 288 Target Specific Behaviour
 289 =========================
 290
 291 X86
 292 ---
 293
 294 Relocations
 295 ^^^^^^^^^^^
 296
 297 ``@ABS8`` can be applied to symbols which appear as immediate operands to
 298 instructions that have an 8-bit immediate form for that operand. It causes
 299 the assembler to use the 8-bit form and an 8-bit relocation (e.g. ``R_386_8``
 300 or ``R_X86_64_8``) for the symbol.
 301
 302 For example:
 303
 304 .. code-block:: gas
 305
 306   cmpq $foo@ABS8, %rdi
 307
 308 This causes the assembler to select the form of the 64-bit ``cmpq`` instruction
 309 that takes an 8-bit immediate operand that is sign extended to 64 bits, as
 310 opposed to ``cmpq $foo, %rdi`` which takes a 32-bit immediate operand. This
 311 is also not the same as ``cmpb $foo, %dil``, which is an 8-bit comparison.
 312
 313 Windows on ARM
 314 --------------
 315
 316 Stack Probe Emission
 317 ^^^^^^^^^^^^^^^^^^^^
 318
 319 The reference implementation (Microsoft Visual Studio 2012) emits stack probes
 320 in the following fashion:
 321
 322 .. code-block:: gas
 323
 324   movw r4, #constant
 325   bl __chkstk
 326   sub.w sp, sp, r4
 327
 328 However, this has the limitation of 32 MiB (±16MiB).  In order to accommodate
 329 larger binaries, LLVM supports the use of ``-mcode-model=large`` to allow a 4GiB
 330 range via a slight deviation.  It will generate an indirect jump as follows:
 331
 332 .. code-block:: gas
 333
 334   movw r4, #constant
 335   movw r12, :lower16:__chkstk
 336   movt r12, :upper16:__chkstk
 337   blx r12
 338   sub.w sp, sp, r4
 339
 340 Variable Length Arrays
 341 ^^^^^^^^^^^^^^^^^^^^^^
 342
 343 The reference implementation (Microsoft Visual Studio 2012) does not permit the
 344 emission of Variable Length Arrays (VLAs).
 345
 346 The Windows ARM Itanium ABI extends the base ABI by adding support for emitting
 347 a dynamic stack allocation.  When emitting a variable stack allocation, a call
 348 to ``__chkstk`` is emitted unconditionally to ensure that guard pages are setup
 349 properly.  The emission of this stack probe emission is handled similar to the
 350 standard stack probe emission.
 351
 352 The MSVC environment does not emit code for VLAs currently.
 353
 354 Windows on ARM64
 355 ----------------
 356
 357 Stack Probe Emission
 358 ^^^^^^^^^^^^^^^^^^^^
 359
 360 The reference implementation (Microsoft Visual Studio 2017) emits stack probes
 361 in the following fashion:
 362
 363 .. code-block:: gas
 364
 365   mov x15, #constant
 366   bl __chkstk
 367   sub sp, sp, x15, lsl #4
 368
 369 However, this has the limitation of 256 MiB (±128MiB).  In order to accommodate
 370 larger binaries, LLVM supports the use of ``-mcode-model=large`` to allow a 8GiB
 371 (±4GiB) range via a slight deviation.  It will generate an indirect jump as
 372 follows:
 373
 374 .. code-block:: gas
 375
 376   mov x15, #constant
 377   adrp x16, __chkstk
 378   add x16, x16, :lo12:__chkstk
 379   blr x16
 380   sub sp, sp, x15, lsl #4
 381