Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 762b6e702db4089e6195cbc0168487f48ff2294a / . / llvm / docs / CompilerWriterInfo.rst
blob: 9b4b4f8cce34bab609b72b619dbe058d1172ef9a [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
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame^]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
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]20
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame^]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
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]22
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame^]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
Joey Goulyb1b0dd82013-06-27 11:49:26 +0000[diff] [blame]24
Tim Northoverbebd2f42015-12-04 16:10:48 +0000[diff] [blame]25* `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]26
Tim Northover762b6e72016-02-09 23:55:48 +0000[diff] [blame^]27* 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]28
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]29Itanium (ia64)
30--------------
31
32* `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
33
34MIPS
35----
36
Daniel Sanderscc0a0562013-09-30 09:35:37 +0000[diff] [blame]37* `MIPS Processor Architecture <http://imgtec.com/mips/mips-architectures.asp>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]38
Simon Atanasyan4685c832015-01-25 16:20:30 +0000[diff] [blame]39* `MIPS 64-bit ELF Object File Specification <http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf>`_
40
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]41PowerPC
42-------
43
44IBM - Official manuals and docs
45^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46
Bill Schmidt995bc3f2013-02-08 21:08:22 +0000[diff] [blame]47* `Power Instruction Set Architecture, Versions 2.03 through 2.06 (authentication required, free sign-up) <https://www.power.org/technology-introduction/standards-specifications>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]48
Bill Schmidt995bc3f2013-02-08 21:08:22 +0000[diff] [blame]49* `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]50
Bill Schmidt8c0a8e52013-02-11 14:14:32 +0000[diff] [blame]51* `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
52
Bill Schmidt995bc3f2013-02-08 21:08:22 +0000[diff] [blame]53* `PowerPC Processor Manuals (embedded) <http://www.ibm.com/chips/techlib/techlib.nsf/products/PowerPC>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]54
Bill Schmidt995bc3f2013-02-08 21:08:22 +0000[diff] [blame]55* `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>`_
56
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]57* `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
58
59Other documents, collections, notes
60^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61
62* `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
63* `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
64* `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
65
Tom Stellard45bb48e2015-06-13 03:28:10 +0000[diff] [blame]66AMDGPU
67------
Tom Stellard2d17f672013-07-12 18:14:40 +0000[diff] [blame]68
69* `AMD R6xx shader ISA <http://developer.amd.com/wordpress/media/2012/10/R600_Instruction_Set_Architecture.pdf>`_
70* `AMD R7xx shader ISA <http://developer.amd.com/wordpress/media/2012/10/R700-Family_Instruction_Set_Architecture.pdf>`_
71* `AMD Evergreen shader ISA <http://developer.amd.com/wordpress/media/2012/10/AMD_Evergreen-Family_Instruction_Set_Architecture.pdf>`_
72* `AMD Cayman/Trinity shader ISA <http://developer.amd.com/wordpress/media/2012/10/AMD_HD_6900_Series_Instruction_Set_Architecture.pdf>`_
73* `AMD Southern Islands Series ISA <http://developer.amd.com/wordpress/media/2012/12/AMD_Southern_Islands_Instruction_Set_Architecture.pdf>`_
Matt Arsenaultc8a82172014-10-06 18:31:09 +0000[diff] [blame]74* `AMD Sea Islands Series ISA <http://developer.amd.com/wordpress/media/2013/07/AMD_Sea_Islands_Instruction_Set_Architecture.pdf>`_
Tom Stellard2d17f672013-07-12 18:14:40 +0000[diff] [blame]75* `AMD GPU Programming Guide <http://developer.amd.com/download/AMD_Accelerated_Parallel_Processing_OpenCL_Programming_Guide.pdf>`_
76* `AMD Compute Resources <http://developer.amd.com/tools/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/documentation/>`_
77
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]78SPARC
79-----
80
Rafael Espindola694b2652013-12-19 20:54:33 +0000[diff] [blame]81* `SPARC standards <http://sparc.org/standards>`_
82* `SPARC V9 ABI <http://sparc.org/standards/64.psabi.1.35.ps.Z>`_
83* `SPARC V8 ABI <http://sparc.org/standards/psABI3rd.pdf>`_
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]84
Richard Sandiford737b8802013-05-31 09:14:54 +0000[diff] [blame]85SystemZ
86-------
87
88* `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
89
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]90X86
91---
92
93AMD - Official manuals and docs
94^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95
96* `AMD processor manuals <http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.html>`_
97* `X86-64 ABI <http://www.x86-64.org/documentation>`_
98
99Intel - Official manuals and docs
100^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
101
Dmitri Gribenko90fa0c62012-12-13 20:02:11 +0000[diff] [blame]102* `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]103* `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
104
105Other x86-specific information
106^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107
Jean-Daniel Dupas84705092012-11-12 23:43:34 +0000[diff] [blame]108* `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]109
Richard Osbornefdbd8e02014-03-14 15:53:50 +0000[diff] [blame]110XCore
111-----
112
113* `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]114* `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]115
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]116Other relevant lists
117--------------------
118
119* `GCC reading list <http://gcc.gnu.org/readings.html>`_
120
121ABI
122===
123
Sean Silvace4bb3c2013-06-05 21:11:11 +0000[diff] [blame]124* `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
Sean Silva69fd25782013-06-05 21:11:16 +0000[diff] [blame]125* `Itanium C++ ABI <http://mentorembedded.github.io/cxx-abi/>`_
Sean Silvace4bb3c2013-06-05 21:11:11 +0000[diff] [blame]126
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]127Linux
128-----
129
130* `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
Tim Northovere0e3aef2013-01-31 12:12:40 +0000[diff] [blame]131* `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
Sean Silva75c71852013-11-04 19:43:36 +0000[diff] [blame]132* `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]133* `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]134* `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]135
136OS X
137----
138
139* `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
140* `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
141
Rui Ueyama1b0a9492013-06-07 20:30:27 +0000[diff] [blame]142Windows
143-------
144
145* `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
146
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]147NVPTX
148=====
149
150* `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
151 ISA and Driver API documentation
152
Bill Wendling668043f2012-10-07 04:34:10 +0000[diff] [blame]153Miscellaneous Resources
154=======================
155
156* `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
157
158* `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
159 good survey of the prefetching capabilities of a variety of modern
160 processors.