Gitiles
Code Review Sign In
review.blissroms.org / platform_external_llvm / refs/heads/r / . / docs / CompilerWriterInfo.rst
blob: 838c36a4099c2537a4002edb0fbcb013d1be9f33 [file] [log] [blame]
Bill Wendling53960a62012-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 Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]13Hardware
14========
15
Tim Northoverb2a20ab2016-02-09 23:55:48 +0000[diff] [blame]16AArch64 & ARM
17-------------
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]18
Tim Northoverb2a20ab2016-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 Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]20
Jacques Pienaare4c3ea02016-08-18 22:10:06 +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 Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]22
Jacques Pienaare4c3ea02016-08-18 22:10:06 +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 Gouly31d2f082013-06-27 11:49:26 +0000[diff] [blame]24
Tim Northovere67b3e872015-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 Northoverc9662852013-04-08 08:42:24 +0000[diff] [blame]26
Tim Northoverb2a20ab2016-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 Northoverc9662852013-04-08 08:42:24 +0000[diff] [blame]28
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]29Itanium (ia64)
30--------------
31
32* `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm>`_
33
Jacques Pienaar56ae20a2016-08-18 21:25:17 +0000[diff] [blame]34Lanai
35-----
36
37* `Lanai Instruction Set Architecture <http://g.co/lanai/isa>`_
38
39
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]40MIPS
41----
42
Simon Dardis385d0da2018-06-14 15:16:37 +0000[diff] [blame]43* `MIPS Processor Architecture <https://www.mips.com/products/>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]44
Simon Atanasyan1029e9c2015-01-25 16:20:30 +0000[diff] [blame]45* `MIPS 64-bit ELF Object File Specification <http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf>`_
46
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]47PowerPC
48-------
49
50IBM - Official manuals and docs
51^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52
Bill Schmidt63c61e52013-02-08 21:08:22 +0000[diff] [blame]53* `Power Instruction Set Architecture, Versions 2.03 through 2.06 (authentication required, free sign-up) <https://www.power.org/technology-introduction/standards-specifications>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]54
Bill Schmidt63c61e52013-02-08 21:08:22 +0000[diff] [blame]55* `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]56
Bill Schmidtfd980722013-02-11 14:14:32 +0000[diff] [blame]57* `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/>`_
58
Bill Schmidt63c61e52013-02-08 21:08:22 +0000[diff] [blame]59* `PowerPC Processor Manuals (embedded) <http://www.ibm.com/chips/techlib/techlib.nsf/products/PowerPC>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]60
Bill Schmidt63c61e52013-02-08 21:08:22 +0000[diff] [blame]61* `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>`_
62
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]63* `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm>`_
64
65Other documents, collections, notes
66^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67
68* `PowerPC ABI documents <http://penguinppc.org/dev/#library>`_
69* `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html>`_
70* `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html>`_
71
Tom Stellard953c6812015-06-13 03:28:10 +0000[diff] [blame]72AMDGPU
73------
Tom Stellard7a88b652013-07-12 18:14:40 +0000[diff] [blame]74
Tony Tye69865532017-06-06 20:31:59 +0000[diff] [blame]75Refer to :doc:`AMDGPUUsage` for additional documentation.
Tom Stellard7a88b652013-07-12 18:14:40 +0000[diff] [blame]76
Alex Bradbury0ba26af2016-11-01 17:27:54 +0000[diff] [blame]77RISC-V
78------
79* `RISC-V User-Level ISA Specification <https://riscv.org/specifications/>`_
80
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]81SPARC
82-----
83
Rafael Espindola11919262013-12-19 20:54:33 +0000[diff] [blame]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>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]87
Richard Sandiford5434f122013-05-31 09:14:54 +0000[diff] [blame]88SystemZ
89-------
90
91* `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a>`_
92
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]93X86
94---
95
Sanjay Patela8977992016-11-08 16:49:24 +0000[diff] [blame]96* `AMD processor manuals <http://developer.amd.com/resources/developer-guides-manuals/>`_
Dmitri Gribenkodcd3a702012-12-13 20:02:11 +0000[diff] [blame]97* `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]98* `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs>`_
James Y Knight69f961c2016-04-12 21:54:57 +0000[diff] [blame]99* `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI>`_
Jean-Daniel Dupas5090b2d2012-11-12 23:43:34 +0000[diff] [blame]100* `Calling conventions for different C++ compilers and operating systems <http://www.agner.org/optimize/calling_conventions.pdf>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]101
Richard Osborne43cf3f02014-03-14 15:53:50 +0000[diff] [blame]102XCore
103-----
104
105* `The XMOS XS1 Architecture (ISA) <https://www.xmos.com/en/download/public/The-XMOS-XS1-Architecture%28X7879A%29.pdf>`_
Alp Toker46d36be2014-04-09 14:47:27 +0000[diff] [blame]106* `Tools Development Guide (includes ABI) <https://www.xmos.com/download/public/Tools-Development-Guide%28X9114A%29.pdf>`_
Richard Osborne43cf3f02014-03-14 15:53:50 +0000[diff] [blame]107
Krzysztof Parzyszekf39cea02016-07-26 18:40:25 +0000[diff] [blame]108Hexagon
109-------
110
111* `Hexagon Programmer's Reference Manuals and Hexagon ABI Specification (registration required, free sign-up) <https://developer.qualcomm.com/software/hexagon-dsp-sdk/tools>`_
112
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]113Other relevant lists
114--------------------
115
116* `GCC reading list <http://gcc.gnu.org/readings.html>`_
117
118ABI
119===
120
Sean Silvac85756f2013-06-05 21:11:11 +0000[diff] [blame]121* `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html>`_
Vlad Tsyrklevich30b47382017-09-12 00:19:11 +0000[diff] [blame]122* `Itanium C++ ABI <http://itanium-cxx-abi.github.io/cxx-abi/>`_
Sean Silvac85756f2013-06-05 21:11:11 +0000[diff] [blame]123
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]124Linux
125-----
126
James Y Knight69f961c2016-04-12 21:54:57 +0000[diff] [blame]127* `Linux extensions to gabi <https://github.com/hjl-tools/linux-abi/wiki/Linux-Extensions-to-gABI>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]128* `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/>`_
Tim Northover72062f52013-01-31 12:12:40 +0000[diff] [blame]129* `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf>`_
Sean Silvada666ab2013-11-04 19:43:36 +0000[diff] [blame]130* `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf>`_
Tim Northover72062f52013-01-31 12:12:40 +0000[diff] [blame]131* `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
Richard Sandiford5434f122013-05-31 09:14:54 +0000[diff] [blame]132* `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]133
134OS X
135----
136
137* `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
138* `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
139
Rui Ueyama8b0f77b2013-06-07 20:30:27 +0000[diff] [blame]140Windows
141-------
142
143* `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx>`_
144
Justin Holewinski531ebc82013-03-30 16:41:14 +0000[diff] [blame]145NVPTX
146=====
147
148* `CUDA Documentation <http://docs.nvidia.com/cuda/index.html>`_ includes the PTX
149 ISA and Driver API documentation
150
Bill Wendling53960a62012-10-07 04:34:10 +0000[diff] [blame]151Miscellaneous Resources
152=======================
153
154* `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/>`_
155
156* `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html>`_ page has a
157 good survey of the prefetching capabilities of a variety of modern
158 processors.