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 <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0487a.h/index.html>`_ (authentication required, free sign-up). This document covers both AArch64 and ARM instructions
  20
  21 * `ARMv7-M Architecture Reference Manual <http://infocenter.arm.com/help/topic/com.arm.doc.ddi0403e.b/index.html>`_ (authentication required, free sign-up). This covers the Thumb2-only microcontrollers
  22
  23 * `ARMv6-M Architecture Reference Manual <http://infocenter.arm.com/help/topic/com.arm.doc.ddi0419c/index.html>`_ (authentication required, free sign-up). This covers the Thumb1-only microcontrollers
  24
  25 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053c/IHI0053C_acle_2_0.pdf>`_
  26
  27 * AArch32 `ABI Addenda and Errata <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0045d/IHI0045D_ABI_addenda.pdf>`_
  28
  29 Itanium (ia64)
  30 --------------
  31
  32 * `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
  33
  34 Lanai
  35 -----
  36
  37 * `Lanai Instruction Set Architecture <http://g.co/lanai/isa>`_
  38
  39
  40 MIPS
  41 ----
  42
  43 * `MIPS Processor Architecture <https://www.mips.com/products/>`_
  44
  45 * `MIPS 64-bit ELF Object File Specification <http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf>`_
  46
  47 PowerPC
  48 -------
  49
  50 IBM - Official manuals and docs
  51 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  52
  53 * `Power Instruction Set Architecture, Versions 2.03 through 2.06 (authentication required, free sign-up) <https://www.power.org/technology-introduction/standards-specifications>`_
  54
  55 * `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
  56
  57 * `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
  58
  59 * `PowerPC Processor Manuals (embedded) <http://www.ibm.com/chips/techlib/techlib.nsf/products/PowerPC>`_
  60
  61 * `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>`_
  62
  63 * `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
  64
  65 Other documents, collections, notes
  66 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  67
  68 * `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
  69 * `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
  70 * `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
  71
  72 AMDGPU
  73 ------
  74
  75 Refer to :doc:`AMDGPUUsage` for additional documentation.
  76
  77 RISC-V
  78 ------
  79 * `RISC-V User-Level ISA Specification <https://riscv.org/specifications/>`_
  80
  81 SPARC
  82 -----
  83
  84 * `SPARC standards <http://sparc.org/standards>`_
  85 * `SPARC V9 ABI <http://sparc.org/standards/64.psabi.1.35.ps.Z>`_
  86 * `SPARC V8 ABI <http://sparc.org/standards/psABI3rd.pdf>`_
  87
  88 SystemZ
  89 -------
  90
  91 * `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
  92
  93 X86
  94 ---
  95
  96 * `AMD processor manuals <http://developer.amd.com/resources/developer-guides-manuals/>`_
  97 * `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
  98 * `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
  99 * `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI>`_
 100 * `Calling conventions for different C++ compilers and operating systems  <http://www.agner.org/optimize/calling_conventions.pdf>`_
 101
 102 XCore
 103 -----
 104
 105 * `The XMOS XS1 Architecture (ISA) <https://www.xmos.com/en/download/public/The-XMOS-XS1-Architecture%28X7879A%29.pdf>`_
 106 * `Tools Development Guide (includes ABI) <https://www.xmos.com/download/public/Tools-Development-Guide%28X9114A%29.pdf>`_
 107
 108 Hexagon
 109 -------
 110
 111 * `Hexagon Programmer's Reference Manuals and Hexagon ABI Specification (registration required, free sign-up) <https://developer.qualcomm.com/software/hexagon-dsp-sdk/tools>`_
 112
 113 Other relevant lists
 114 --------------------
 115
 116 * `GCC reading list <http://gcc.gnu.org/readings.html>`_
 117
 118 ABI
 119 ===
 120
 121 * `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
 122 * `Itanium C++ ABI <http://itanium-cxx-abi.github.io/cxx-abi/>`_
 123
 124 Linux
 125 -----
 126
 127 * `Linux extensions to gabi <https://github.com/hjl-tools/linux-abi/wiki/Linux-Extensions-to-gABI>`_
 128 * `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
 129 * `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
 130 * `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf>`_
 131 * `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
 132 * `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
 133
 134 OS X
 135 ----
 136
 137 * `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
 138 * `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
 139
 140 Windows
 141 -------
 142
 143 * `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
 144
 145 NVPTX
 146 =====
 147
 148 * `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
 149   ISA and Driver API documentation
 150
 151 Miscellaneous Resources
 152 =======================
 153
 154 * `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
 155
 156 * `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
 157   good survey of the prefetching capabilities of a variety of modern
 158   processors.