Update documentation with link to Sea Islands documentation
[oota-llvm.git] / 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 ARM
17 ---
18
19 * `ARM documentation <http://www.arm.com/documentation/>`_ (`Processor Cores <http://www.arm.com/documentation/ARMProcessor_Cores/>`_ Cores)
20
21 * `ABI <http://www.arm.com/products/DevTools/ABI.html>`_
22
23 * `ABI Addenda and Errata <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0045d/IHI0045D_ABI_addenda.pdf>`_
24
25 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053a/IHI0053A_acle.pdf>`_
26
27 AArch64
28 -------
29
30 * `ARMv8 Instruction Set Overview <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.genc010197a/index.html>`_
31
32 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053a/IHI0053A_acle.pdf>`_
33
34 Itanium (ia64)
35 --------------
36
37 * `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
38
39 MIPS
40 ----
41
42 * `MIPS Processor Architecture <http://imgtec.com/mips/mips-architectures.asp>`_
43
44 PowerPC
45 -------
46
47 IBM - Official manuals and docs
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49
50 * `Power Instruction Set Architecture, Versions 2.03 through 2.06 (authentication required, free sign-up) <https://www.power.org/technology-introduction/standards-specifications>`_
51
52 * `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
53
54 * `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
55
56 * `PowerPC Processor Manuals (embedded) <http://www.ibm.com/chips/techlib/techlib.nsf/products/PowerPC>`_
57
58 * `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>`_
59
60 * `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
61
62 Other documents, collections, notes
63 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64
65 * `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
66 * `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
67 * `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
68
69 R600
70 ----
71
72 * `AMD R6xx shader ISA <http://developer.amd.com/wordpress/media/2012/10/R600_Instruction_Set_Architecture.pdf>`_
73 * `AMD R7xx shader ISA <http://developer.amd.com/wordpress/media/2012/10/R700-Family_Instruction_Set_Architecture.pdf>`_
74 * `AMD Evergreen shader ISA <http://developer.amd.com/wordpress/media/2012/10/AMD_Evergreen-Family_Instruction_Set_Architecture.pdf>`_
75 * `AMD Cayman/Trinity shader ISA <http://developer.amd.com/wordpress/media/2012/10/AMD_HD_6900_Series_Instruction_Set_Architecture.pdf>`_
76 * `AMD Southern Islands Series ISA <http://developer.amd.com/wordpress/media/2012/12/AMD_Southern_Islands_Instruction_Set_Architecture.pdf>`_
77 * `AMD Sea Islands Series ISA <http://developer.amd.com/wordpress/media/2013/07/AMD_Sea_Islands_Instruction_Set_Architecture.pdf>`_
78 * `AMD GPU Programming Guide <http://developer.amd.com/download/AMD_Accelerated_Parallel_Processing_OpenCL_Programming_Guide.pdf>`_
79 * `AMD Compute Resources <http://developer.amd.com/tools/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/documentation/>`_
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 - Official manuals and docs
97 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98
99 * `AMD processor manuals <http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.html>`_
100 * `X86-64 ABI <http://www.x86-64.org/documentation>`_
101
102 Intel - Official manuals and docs
103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104
105 * `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
106 * `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
107
108 Other x86-specific information
109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
110
111 * `Calling conventions for different C++ compilers and operating systems  <http://www.agner.org/optimize/calling_conventions.pdf>`_
112
113 XCore
114 -----
115
116 * `The XMOS XS1 Architecture (ISA) <https://www.xmos.com/en/download/public/The-XMOS-XS1-Architecture%28X7879A%29.pdf>`_
117 * `Tools Development Guide (includes ABI) <https://www.xmos.com/download/public/Tools-Development-Guide%28X9114A%29.pdf>`_
118
119 Other relevant lists
120 --------------------
121
122 * `GCC reading list <http://gcc.gnu.org/readings.html>`_
123
124 ABI
125 ===
126
127 * `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
128 * `Itanium C++ ABI <http://mentorembedded.github.io/cxx-abi/>`_
129
130 Linux
131 -----
132
133 * `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
134 * `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
135 * `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf>`_
136 * `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
137 * `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
138
139 OS X
140 ----
141
142 * `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
143 * `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
144
145 Windows
146 -------
147
148 * `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
149
150 NVPTX
151 =====
152
153 * `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
154   ISA and Driver API documentation
155
156 Miscellaneous Resources
157 =======================
158
159 * `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
160
161 * `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
162   good survey of the prefetching capabilities of a variety of modern
163   processors.