Add links to the System z architecture manual and ABI
[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 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053a/IHI0053A_acle.pdf>`_
24
25 AArch64
26 -------
27
28 * `ARMv8 Instruction Set Overview <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.genc010197a/index.html>`_
29
30 * `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053a/IHI0053A_acle.pdf>`_
31
32 Itanium (ia64)
33 --------------
34
35 * `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
36
37 MIPS
38 ----
39
40 * `MIPS Processor Architecture <http://mips.com/content/Documentation/MIPSDocumentation/ProcessorArchitecture/doclibrary>`_
41
42 PowerPC
43 -------
44
45 IBM - Official manuals and docs
46 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
47
48 * `Power Instruction Set Architecture, Versions 2.03 through 2.06 (authentication required, free sign-up) <https://www.power.org/technology-introduction/standards-specifications>`_
49
50 * `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
51
52 * `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
53
54 * `PowerPC Processor Manuals (embedded) <http://www.ibm.com/chips/techlib/techlib.nsf/products/PowerPC>`_
55
56 * `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>`_
57
58 * `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
59
60 Other documents, collections, notes
61 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62
63 * `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
64 * `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
65 * `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
66
67 SPARC
68 -----
69
70 * `SPARC resources <http://www.sparc.org/resource.htm>`_
71 * `SPARC standards <http://www.sparc.org/standards.html>`_
72
73 SystemZ
74 -------
75
76 * `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
77
78 X86
79 ---
80
81 AMD - Official manuals and docs
82 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83
84 * `AMD processor manuals <http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.html>`_
85 * `X86-64 ABI <http://www.x86-64.org/documentation>`_
86
87 Intel - Official manuals and docs
88 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
89
90 * `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
91 * `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
92
93 Other x86-specific information
94 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95
96 * `Calling conventions for different C++ compilers and operating systems  <http://www.agner.org/optimize/calling_conventions.pdf>`_
97
98 Other relevant lists
99 --------------------
100
101 * `GCC reading list <http://gcc.gnu.org/readings.html>`_
102
103 ABI
104 ===
105
106 Linux
107 -----
108
109 * `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
110 * `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
111 * `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
112 * `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
113
114 OS X
115 ----
116
117 * `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
118 * `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
119
120 NVPTX
121 =====
122
123 * `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
124   ISA and Driver API documentation
125
126 Miscellaneous Resources
127 =======================
128
129 * `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
130
131 * `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
132   good survey of the prefetching capabilities of a variety of modern
133   processors.