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