Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 972a73a3478617e00792ca7bf39a3a35a684162c / . / llvm / docs / CompilerWriterInfo.rst
blob: 41e17629519717dfeccae8141d4d56bd1c1c089c [file] [log] [blame]
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]1========================================================
2Architecture & 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
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]13Hardware
14========
15
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame]16AArch64 & ARM
17-------------
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]18
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]19* `ARMv8-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0487/latest>`_ This document covers both AArch64 and ARM instructions
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]20
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]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.
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]22
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]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
Joey Goulyb1b0dd82013-06-27 11:49:26 +0000[diff] [blame]26
Tim Northoverbebd2f42015-12-04 16:10:48 +0000[diff] [blame]27* `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053c/IHI0053C_acle_2_0.pdf>`_
Tim Northover85c19f52013-04-08 08:42:24 +0000[diff] [blame]28
Eli Friedmanaeedaef2019-01-17 00:31:35 +0000[diff] [blame]29* `ARM NEON Intrinsics Reference <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0073b/IHI0073B_arm_neon_intrinsics_ref.pdf>`_
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]30
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame]31* AArch32 `ABI Addenda and Errata <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0045d/IHI0045D_ABI_addenda.pdf>`_
Tim Northover85c19f52013-04-08 08:42:24 +0000[diff] [blame]32
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]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
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]37Itanium (ia64)
38--------------
39
40* `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
41
Jacques Pienaar2b257992016-08-18 21:25:17 +0000[diff] [blame]42Lanai
43-----
44
45* `Lanai Instruction Set Architecture <http://g.co/lanai/isa>`_
46
47
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]48MIPS
49----
50
Simon Dardisb4a43d62018-06-14 15:16:37 +0000[diff] [blame]51* `MIPS Processor Architecture <https://www.mips.com/products/>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]52
Simon Atanasyanc84cfaf2019-10-24 15:52:19 +0300[diff] [blame]53* `MIPS 64-bit ELF Object File Specification <https://www.linux-mips.org/pub/linux/mips/doc/ABI/elf64-2.4.pdf>`_
Simon Atanasyan4685c832015-01-25 16:20:30 +0000[diff] [blame]54
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]55PowerPC
56-------
57
58IBM - Official manuals and docs
59^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]61* `Power Instruction Set Architecture, Version 3.0B <https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]62
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]63* `POWER9 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power9-processor-users-manual>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]64
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]65* `Power Instruction Set Architecture, Version 2.07B <https://openpowerfoundation.org/?resource_lib=ibm-power-isa-version-2-07-b>`_
Bill Schmidt8c0a8e52013-02-11 14:14:32 +0000[diff] [blame]66
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]67* `POWER8 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power8-processor-users-manual>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]68
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]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>`_
Bill Schmidt995bc3f2013-02-08 21:08:22 +0000[diff] [blame]72
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]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
Jinsong Ji0bd3cc42019-12-30 20:21:46 +0000[diff] [blame]75Embedded 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
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]86Other documents, collections, notes
87^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]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/>`_
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]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>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]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
Tom Stellard45bb48e2015-06-13 03:28:10 +0000[diff] [blame]96AMDGPU
97------
Tom Stellard2d17f672013-07-12 18:14:40 +0000[diff] [blame]98
Tony Tyef16a45e2017-06-06 20:31:59 +0000[diff] [blame]99Refer to :doc:`AMDGPUUsage` for additional documentation.
Tom Stellard2d17f672013-07-12 18:14:40 +0000[diff] [blame]100
Alex Bradburyb2e54722016-11-01 17:27:54 +0000[diff] [blame]101RISC-V
102------
103* `RISC-V User-Level ISA Specification <https://riscv.org/specifications/>`_
104
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]105SPARC
106-----
107
Rafael Espindola694b2652013-12-19 20:54:33 +0000[diff] [blame]108* `SPARC standards <http://sparc.org/standards>`_
109* `SPARC V9 ABI <http://sparc.org/standards/64.psabi.1.35.ps.Z>`_
110* `SPARC V8 ABI <http://sparc.org/standards/psABI3rd.pdf>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]111
Richard Sandiford737b8802013-05-31 09:14:54 +0000[diff] [blame]112SystemZ
113-------
114
115* `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
116
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]117X86
118---
119
Sanjay Patel843b1712016-11-08 16:49:24 +0000[diff] [blame]120* `AMD processor manuals <http://developer.amd.com/resources/developer-guides-manuals/>`_
Dmitri Gribenko90fa0c62012-12-13 20:02:11 +0000[diff] [blame]121* `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]122* `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
James Y Knight7c7e73b2016-04-12 21:54:57 +0000[diff] [blame]123* `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI>`_
Jean-Daniel Dupas84705092012-11-12 23:43:34 +0000[diff] [blame]124* `Calling conventions for different C++ compilers and operating systems <http://www.agner.org/optimize/calling_conventions.pdf>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]125
Richard Osbornefdbd8e02014-03-14 15:53:50 +0000[diff] [blame]126XCore
127-----
128
129* `The XMOS XS1 Architecture (ISA) <https://www.xmos.com/en/download/public/The-XMOS-XS1-Architecture%28X7879A%29.pdf>`_
Alp Toker16f98b22014-04-09 14:47:27 +0000[diff] [blame]130* `Tools Development Guide (includes ABI) <https://www.xmos.com/download/public/Tools-Development-Guide%28X9114A%29.pdf>`_
Richard Osbornefdbd8e02014-03-14 15:53:50 +0000[diff] [blame]131
Krzysztof Parzyszek79a4fbc2016-07-26 18:40:25 +0000[diff] [blame]132Hexagon
133-------
134
135* `Hexagon Programmer's Reference Manuals and Hexagon ABI Specification (registration required, free sign-up) <https://developer.qualcomm.com/software/hexagon-dsp-sdk/tools>`_
136
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]137Other relevant lists
138--------------------
139
140* `GCC reading list <http://gcc.gnu.org/readings.html>`_
141
142ABI
143===
144
Sean Silvace4bb3c2013-06-05 21:11:11 +0000[diff] [blame]145* `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]146* `Itanium C++ ABI <http://itanium-cxx-abi.github.io/cxx-abi/>`_ (This is used for all non-Windows targets.)
Sean Silvace4bb3c2013-06-05 21:11:11 +0000[diff] [blame]147
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]148Linux
149-----
150
James Y Knight7c7e73b2016-04-12 21:54:57 +0000[diff] [blame]151* `Linux extensions to gabi <https://github.com/hjl-tools/linux-abi/wiki/Linux-Extensions-to-gABI>`_
Jinsong Ji26cd5c92019-10-10 19:25:30 +0000[diff] [blame]152* `64-Bit ELF V2 ABI Specification: Power Architecture <https://openpowerfoundation.org/?resource_lib=64-bit-elf-v2-abi-specification-power-architecture>`_
153
154* `OpenPOWER ELFv2 Errata: ELFv2 ABI Version 1.4 <https://openpowerfoundation.org/?resource_lib=openpower-elfv2-errata-elfv2-abi-version-1-4>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]155* `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
Tim Northovere0e3aef2013-01-31 12:12:40 +0000[diff] [blame]156* `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]157* `Procedure Call Standard for the ARM Architecture <https://developer.arm.com/docs/ihi0042/latest>`_
Sean Silva75c71852013-11-04 19:43:36 +0000[diff] [blame]158* `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf>`_
Tim Northovere0e3aef2013-01-31 12:12:40 +0000[diff] [blame]159* `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
Richard Sandiford737b8802013-05-31 09:14:54 +0000[diff] [blame]160* `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]161
J. Ryan Stinnettd45eaf92019-05-30 16:46:22 +0000[diff] [blame]162macOS
163-----
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]164
165* `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
166* `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]167* `ARM64 Function Calling Conventions <https://developer.apple.com/library/archive/documentation/Xcode/Conceptual/iPhoneOSABIReference/Articles/ARM64FunctionCallingConventions.html>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]168
Rui Ueyama1b0a9492013-06-07 20:30:27 +0000[diff] [blame]169Windows
170-------
171
172* `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
Eli Friedman82ceec52019-01-17 00:21:08 +0000[diff] [blame]173* `ARM64 exception handling <https://docs.microsoft.com/en-us/cpp/build/arm64-exception-handling>`_
174* `ARM exception handling <https://docs.microsoft.com/en-us/cpp/build/arm-exception-handling>`_
175* `Overview of ARM64 ABI conventions <https://docs.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions>`_
176* `Overview of ARM32 ABI Conventions <https://docs.microsoft.com/en-us/cpp/build/overview-of-arm-abi-conventions>`_
Rui Ueyama1b0a9492013-06-07 20:30:27 +0000[diff] [blame]177
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]178NVPTX
179=====
180
181* `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
182 ISA and Driver API documentation
183
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]184Miscellaneous Resources
185=======================
186
187* `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
188
189* `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
190 good survey of the prefetching capabilities of a variety of modern
191 processors.