llvm/docs/CompilerWriterInfo.rst

   1 ========================================================
   2 Architecture & Platform Information for Compiler Writers
   3 ========================================================
   4
   5 .. contents::
   6    :local:
   7
   8 .. note::
   9
  10   This document is a work-in-progress.  Additions and clarifications are
  11   welcome.
  12
  13 Hardware
  14 ========
  15
  16 AArch64 & ARM
  17 -------------
  18
  19 * `ARMv8-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0487/latest>`_ This document covers both AArch64 and ARM instructions
  20
  21 * `ARMv7-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0406/latest>`_ This has some useful info on what is supported by older architecture versions.
  22
  23 * `ARMv7-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0403/latest>`_ This covers the Thumb2-only microcontrollers
  24
  25 * `ARMv6-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0419/latest>`_ This covers the Thumb1-only microcontrollers
  26
  27 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053c/IHI0053C_acle_2_0.pdf>`_
  28
  29 * `ARM NEON Intrinsics Reference <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0073b/IHI0073B_arm_neon_intrinsics_ref.pdf>`_
  30
  31 * AArch32 `ABI Addenda and Errata <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0045d/IHI0045D_ABI_addenda.pdf>`_
  32
  33 * `Cortex-A57 Software Optimization Guide <http://infocenter.arm.com/help/topic/com.arm.doc.uan0015b/Cortex_A57_Software_Optimization_Guide_external.pdf>`_
  34
  35 * `Run-time ABI for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0043d/IHI0043D_rtabi.pdf>`_ This documents the __aeabi_* helper functions.
  36
  37 Itanium (ia64)
  38 --------------
  39
  40 * `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
  41
  42 Lanai
  43 -----
  44
  45 * `Lanai Instruction Set Architecture <http://g.co/lanai/isa>`_
  46
  47
  48 MIPS
  49 ----
  50
  51 * `MIPS Processor Architecture <https://www.mips.com/products/>`_
  52
  53 * `MIPS 64-bit ELF Object File Specification <https://www.linux-mips.org/pub/linux/mips/doc/ABI/elf64-2.4.pdf>`_
  54
  55 PowerPC
  56 -------
  57
  58 IBM - Official manuals and docs
  59 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  60
  61 * `Power Instruction Set Architecture, Version 3.0B <https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0>`_
  62
  63 * `POWER9 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power9-processor-users-manual>`_
  64
  65 * `Power Instruction Set Architecture, Version 2.07B <https://openpowerfoundation.org/?resource_lib=ibm-power-isa-version-2-07-b>`_
  66
  67 * `POWER8 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power8-processor-users-manual>`_
  68
  69 * `Power Instruction Set Architecture, Versions 2.03 through 2.06 (Internet Archive) <https://web.archive.org/web/20121124005736/https://www.power.org/technology-introduction/standards-specifications>`_
  70
  71 * `IBM AIX 7.2 POWER Assembly Reference <https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/assembler/alangref_kickoff.html>`_
  72
  73 * `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
  74
  75 Embedded PowerPC Processors manuals and docs
  76 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  77
  78 * `Book E: Enhanced PowerPC Architecture <https://www.nxp.com/docs/en/user-guide/BOOK_EUM.pdf>`_
  79
  80 * `EREF: A Programmer's Reference Manual for Freescale Embedded Processors (EREFRM) <https://www.nxp.com/files-static/32bit/doc/ref_manual/EREF_RM.pdf>`_
  81
  82 * `Signal Processing Engine (SPE) Programming Environments Manual: A Supplement to the EREF <https://www.nxp.com/docs/en/reference-manual/SPEPEM.pdf>`_
  83
  84 * `Variable-Length Encoding (VLE) Programming Environments Manual: A Supplement to the EREF <https://www.nxp.com/docs/en/reference-manual/VLEPEM.pdf>`_
  85
  86 Other documents, collections, notes
  87 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  88
  89 * `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
  90 * `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
  91 * `Various IBM specifications and white papers <https://www.power.org/documentation/?document_company=105&document_category=all&publish_year=all&grid_order=DESC&grid_sort=title>`_
  92 * `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
  93 * `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
  94 * `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
  95
  96 AMDGPU
  97 ------
  98
  99 Refer to :doc:`AMDGPUUsage` for additional documentation.
 100
 101 RISC-V
 102 ------
 103 * `RISC-V User-Level ISA Specification <https://riscv.org/specifications/>`_
 104
 105 C-SKY
 106 ------
 107 * `C-SKY Architecture User Guide <https://github.com/c-sky/csky-doc/blob/master/CSKY%20Architecture%20user_guide.pdf>`_
 108 * `C-SKY V2 ABI <https://github.com/c-sky/csky-doc/blob/master/C-SKY_V2_CPU_Applications_Binary_Interface_Standards_Manual.pdf>`_
 109
 110 LoongArch
 111 ---------
 112 * `LoongArch Reference Manual - Volume 1: Basic Architecture <https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol1-EN.html>`_
 113 * `LoongArch ELF ABI specification <https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-EN.html>`_
 114
 115 SPARC
 116 -----
 117
 118 * `SPARC standards <http://sparc.org/standards>`_
 119 * `SPARC V9 ABI <http://sparc.org/standards/64.psabi.1.35.ps.Z>`_
 120 * `SPARC V8 ABI <http://sparc.org/standards/psABI3rd.pdf>`_
 121
 122 SystemZ
 123 -------
 124
 125 * `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
 126
 127 VE
 128 --
 129
 130 * `NEC SX-Aurora TSUBASA ISA Guide <https://www.hpc.nec/documents/guide/pdfs/Aurora_ISA_guide.pdf>`_
 131 * `NEC SX-Aurora TSUBASA manuals and documentation <https://www.hpc.nec/documentation>`_
 132
 133 X86
 134 ---
 135
 136 * `AMD processor manuals <http://developer.amd.com/resources/developer-guides-manuals/>`_
 137 * `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
 138 * `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
 139 * `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI>`_
 140 * `Calling conventions for different C++ compilers and operating systems  <http://www.agner.org/optimize/calling_conventions.pdf>`_
 141
 142 XCore
 143 -----
 144
 145 * `The XMOS XS1 Architecture (ISA) <https://www.xmos.ai/download/The-XMOS-XS1-Architecture%281.0%29.pdf>`_
 146 * `The XMOS XS2 Architecture (ISA) <https://www.xmos.ai/download/xCORE-200:-The-XMOS-XS2-Architecture-%28ISA%29%281.1%29.pdf>`_
 147 * `Tools Development Guide (includes ABI) <https://www.xmos.ai/download/Tools-Development-Guide%282.1%29.pdf>`_
 148
 149 Hexagon
 150 -------
 151
 152 * `Hexagon Programmer's Reference Manuals and Hexagon ABI Specification (registration required, free sign-up) <https://developer.qualcomm.com/software/hexagon-dsp-sdk/tools>`_
 153
 154 Other relevant lists
 155 --------------------
 156
 157 * `GCC reading list <http://gcc.gnu.org/readings.html>`_
 158
 159 ABI
 160 ===
 161
 162 * `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
 163 * `Itanium C++ ABI <http://itanium-cxx-abi.github.io/cxx-abi/>`_ (This is used for all non-Windows targets.)
 164
 165 Linux
 166 -----
 167
 168 * `Linux extensions to gabi <https://github.com/hjl-tools/linux-abi/wiki/Linux-Extensions-to-gABI>`_
 169 * `64-Bit ELF V2 ABI Specification: Power Architecture <https://openpowerfoundation.org/?resource_lib=64-bit-elf-v2-abi-specification-power-architecture>`_
 170
 171 * `OpenPOWER ELFv2 Errata: ELFv2 ABI Version 1.4 <https://openpowerfoundation.org/?resource_lib=openpower-elfv2-errata-elfv2-abi-version-1-4>`_
 172 * `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
 173 * `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
 174 * `Procedure Call Standard for the ARM Architecture <https://developer.arm.com/docs/ihi0042/latest>`_
 175 * `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf>`_
 176 * `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
 177 * `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
 178
 179 macOS
 180 -----
 181
 182 * `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
 183 * `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
 184 * `ARM64 Function Calling Conventions <https://developer.apple.com/library/archive/documentation/Xcode/Conceptual/iPhoneOSABIReference/Articles/ARM64FunctionCallingConventions.html>`_
 185
 186 Windows
 187 -------
 188
 189 * `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
 190 * `ARM64 exception handling <https://docs.microsoft.com/en-us/cpp/build/arm64-exception-handling>`_
 191 * `ARM exception handling <https://docs.microsoft.com/en-us/cpp/build/arm-exception-handling>`_
 192 * `Overview of ARM64 ABI conventions <https://docs.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions>`_
 193 * `Overview of ARM32 ABI Conventions <https://docs.microsoft.com/en-us/cpp/build/overview-of-arm-abi-conventions>`_
 194
 195 NVPTX
 196 =====
 197
 198 * `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
 199   ISA and Driver API documentation
 200
 201 SPIR-V
 202 ======
 203
 204 * `SPIR-V documentation <https://www.khronos.org/registry/SPIR-V/>`_
 205
 206 Miscellaneous Resources
 207 =======================
 208
 209 * `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
 210
 211 * `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
 212   good survey of the prefetching capabilities of a variety of modern
 213   processors.