2012-10-07 12:34:10 +08:00
========================================================
Architecture & Platform Information for Compiler Writers
========================================================
.. contents ::
:local:
.. note ::
This document is a work-in-progress. Additions and clarifications are
welcome.
Hardware
========
2016-02-10 07:55:48 +08:00
AArch64 & ARM
-------------
2012-10-07 12:34:10 +08:00
2019-01-17 08:21:08 +08:00
* `ARMv8-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0487/latest> `_ This document covers both AArch64 and ARM instructions
2012-10-07 12:34:10 +08:00
2019-01-17 08:21:08 +08:00
* `ARMv7-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0406/latest> `_ This has some useful info on what is supported by older architecture versions.
2012-10-07 12:34:10 +08:00
2019-01-17 08:21:08 +08:00
* `ARMv7-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0403/latest> `_ This covers the Thumb2-only microcontrollers
* `ARMv6-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0419/latest> `_ This covers the Thumb1-only microcontrollers
2013-06-27 19:49:26 +08:00
2015-12-05 00:10:48 +08:00
* `ARM C Language Extensions <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053c/IHI0053C_acle_2_0.pdf> `_
2013-04-08 16:42:24 +08:00
2019-01-17 08:31:35 +08:00
* `ARM NEON Intrinsics Reference <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0073b/IHI0073B_arm_neon_intrinsics_ref.pdf> `_
2019-01-17 08:21:08 +08:00
2016-02-10 07:55:48 +08:00
* AArch32 `ABI Addenda and Errata <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0045d/IHI0045D_ABI_addenda.pdf> `_
2013-04-08 16:42:24 +08:00
2019-01-17 08:21:08 +08:00
* `Cortex-A57 Software Optimization Guide <http://infocenter.arm.com/help/topic/com.arm.doc.uan0015b/Cortex_A57_Software_Optimization_Guide_external.pdf> `_
* `Run-time ABI for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0043d/IHI0043D_rtabi.pdf> `_ This documents the __aeabi_* helper functions.
2012-10-07 12:34:10 +08:00
Itanium (ia64)
--------------
* `Itanium documentation <http://developer.intel.com/design/itanium2/documentation.htm> `_
2016-08-19 05:25:17 +08:00
Lanai
-----
* `Lanai Instruction Set Architecture <http://g.co/lanai/isa> `_
2012-10-07 12:34:10 +08:00
MIPS
----
2018-06-14 23:16:37 +08:00
* `MIPS Processor Architecture <https://www.mips.com/products/> `_
2012-10-07 12:34:10 +08:00
2019-10-24 20:52:19 +08:00
* `MIPS 64-bit ELF Object File Specification <https://www.linux-mips.org/pub/linux/mips/doc/ABI/elf64-2.4.pdf> `_
2015-01-26 00:20:30 +08:00
2012-10-07 12:34:10 +08:00
PowerPC
-------
IBM - Official manuals and docs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2019-10-11 03:25:30 +08:00
* `Power Instruction Set Architecture, Version 3.0B <https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0> `_
2012-10-07 12:34:10 +08:00
2019-10-11 03:25:30 +08:00
* `POWER9 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power9-processor-users-manual> `_
2012-10-07 12:34:10 +08:00
2019-10-11 03:25:30 +08:00
* `Power Instruction Set Architecture, Version 2.07B <https://openpowerfoundation.org/?resource_lib=ibm-power-isa-version-2-07-b> `_
2013-02-11 22:14:32 +08:00
2019-10-11 03:25:30 +08:00
* `POWER8 Processor User's Manual <https://openpowerfoundation.org/?resource_lib=power8-processor-users-manual> `_
2012-10-07 12:34:10 +08:00
2019-10-11 03:25:30 +08:00
* `Power Instruction Set Architecture, Versions 2.03 through 2.06 (Internet Archive) <https://web.archive.org/web/20121124005736/https://www.power.org/technology-introduction/standards-specifications> `_
* `IBM AIX 7.2 POWER Assembly Reference <https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/assembler/alangref_kickoff.html> `_
2013-02-09 05:08:22 +08:00
2012-10-07 12:34:10 +08:00
* `IBM AIX/5L for POWER Assembly Reference <http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixassem/alangref/alangreftfrm.htm> `_
2019-12-31 04:21:46 +08:00
Embedded PowerPC Processors manuals and docs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* `Book E: Enhanced PowerPC Architecture <https://www.nxp.com/docs/en/user-guide/BOOK_EUM.pdf> `_
* `EREF: A Programmer's Reference Manual for Freescale Embedded Processors (EREFRM) <https://www.nxp.com/files-static/32bit/doc/ref_manual/EREF_RM.pdf> `_
* `Signal Processing Engine (SPE) Programming Environments Manual: A Supplement to the EREF <https://www.nxp.com/docs/en/reference-manual/SPEPEM.pdf> `_
* `Variable-Length Encoding (VLE) Programming Environments Manual: A Supplement to the EREF <https://www.nxp.com/docs/en/reference-manual/VLEPEM.pdf> `_
2012-10-07 12:34:10 +08:00
Other documents, collections, notes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2019-10-11 03:25:30 +08:00
* `PowerPC Compiler Writer's Guide <http://www.ibm.com/chips/techlib/techlib.nsf/techdocs/852569B20050FF7785256996007558C6> `_
* `Intro to PowerPC Architecture <http://www.ibm.com/developerworks/linux/library/l-powarch/> `_
* `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> `_
2012-10-07 12:34:10 +08:00
* `PowerPC ABI documents <http://penguinppc.org/dev/#library> `_
* `PowerPC64 alignment of long doubles (from GCC) <http://gcc.gnu.org/ml/gcc-patches/2003-09/msg00997.html> `_
* `Long branch stubs for powerpc64-linux (from binutils) <http://sources.redhat.com/ml/binutils/2002-04/msg00573.html> `_
2015-06-13 11:28:10 +08:00
AMDGPU
------
2013-07-13 02:14:40 +08:00
2017-06-07 04:31:59 +08:00
Refer to :doc: `AMDGPUUsage` for additional documentation.
2013-07-13 02:14:40 +08:00
2016-11-02 01:27:54 +08:00
RISC-V
------
* `RISC-V User-Level ISA Specification <https://riscv.org/specifications/> `_
2020-09-29 12:31:36 +08:00
C-SKY
------
* `C-SKY Architecture User Guide <https://github.com/c-sky/csky-doc/blob/master/CSKY%20Architecture%20user_guide.pdf> `_
* `C-SKY V2 ABI <https://github.com/c-sky/csky-doc/blob/master/C-SKY_V2_CPU_Applications_Binary_Interface_Standards_Manual.pdf> `_
2012-10-07 12:34:10 +08:00
SPARC
-----
2013-12-20 04:54:33 +08:00
* `SPARC standards <http://sparc.org/standards> `_
* `SPARC V9 ABI <http://sparc.org/standards/64.psabi.1.35.ps.Z> `_
* `SPARC V8 ABI <http://sparc.org/standards/psABI3rd.pdf> `_
2012-10-07 12:34:10 +08:00
2013-05-31 17:14:54 +08:00
SystemZ
-------
* `z/Architecture Principles of Operation (registration required, free sign-up) <http://www-01.ibm.com/support/docview.wss?uid=isg2b9de5f05a9d57819852571c500428f9a> `_
2012-10-07 12:34:10 +08:00
X86
---
2016-11-09 00:49:24 +08:00
* `AMD processor manuals <http://developer.amd.com/resources/developer-guides-manuals/> `_
2012-12-14 04:02:11 +08:00
* `Intel 64 and IA-32 manuals <http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html> `_
2012-10-07 12:34:10 +08:00
* `Intel Itanium documentation <http://www.intel.com/design/itanium/documentation.htm?iid=ipp_srvr_proc_itanium2+techdocs> `_
2016-04-13 05:54:57 +08:00
* `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI> `_
2012-11-13 07:43:34 +08:00
* `Calling conventions for different C++ compilers and operating systems <http://www.agner.org/optimize/calling_conventions.pdf> `_
2012-10-07 12:34:10 +08:00
2014-03-14 23:53:50 +08:00
XCore
-----
2020-12-08 20:19:20 +08:00
* `The XMOS XS1 Architecture (ISA) <https://www.xmos.ai/download/The-XMOS-XS1-Architecture%281.0%29.pdf> `_
* `The XMOS XS2 Architecture (ISA) <https://www.xmos.ai/download/xCORE-200:-The-XMOS-XS2-Architecture-%28ISA%29%281.1%29.pdf> `_
* `Tools Development Guide (includes ABI) <https://www.xmos.ai/download/Tools-Development-Guide%282.1%29.pdf> `_
2014-03-14 23:53:50 +08:00
2016-07-27 02:40:25 +08:00
Hexagon
-------
* `Hexagon Programmer's Reference Manuals and Hexagon ABI Specification (registration required, free sign-up) <https://developer.qualcomm.com/software/hexagon-dsp-sdk/tools> `_
2012-10-07 12:34:10 +08:00
Other relevant lists
--------------------
* `GCC reading list <http://gcc.gnu.org/readings.html> `_
ABI
===
2013-06-06 05:11:11 +08:00
* `System V Application Binary Interface <http://www.sco.com/developers/gabi/latest/contents.html> `_
2019-01-17 08:21:08 +08:00
* `Itanium C++ ABI <http://itanium-cxx-abi.github.io/cxx-abi/> `_ (This is used for all non-Windows targets.)
2013-06-06 05:11:11 +08:00
2012-10-07 12:34:10 +08:00
Linux
-----
2016-04-13 05:54:57 +08:00
* `Linux extensions to gabi <https://github.com/hjl-tools/linux-abi/wiki/Linux-Extensions-to-gABI> `_
2019-10-11 03:25:30 +08:00
* `64-Bit ELF V2 ABI Specification: Power Architecture <https://openpowerfoundation.org/?resource_lib=64-bit-elf-v2-abi-specification-power-architecture> `_
* `OpenPOWER ELFv2 Errata: ELFv2 ABI Version 1.4 <https://openpowerfoundation.org/?resource_lib=openpower-elfv2-errata-elfv2-abi-version-1-4> `_
2012-10-07 12:34:10 +08:00
* `PowerPC 64-bit ELF ABI Supplement <http://www.linuxbase.org/spec/ELF/ppc64/> `_
2013-01-31 20:12:40 +08:00
* `Procedure Call Standard for the AArch64 Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0055a/IHI0055A_aapcs64.pdf> `_
2019-01-17 08:21:08 +08:00
* `Procedure Call Standard for the ARM Architecture <https://developer.arm.com/docs/ihi0042/latest> `_
2013-11-05 03:43:36 +08:00
* `ELF for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf> `_
2013-01-31 20:12:40 +08:00
* `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf> `_
2013-05-31 17:14:54 +08:00
* `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf> `_
2012-10-07 12:34:10 +08:00
[Docs] Modernize references to macOS
Summary:
This updates all places in documentation that refer to "Mac OS X", "OS X", etc.
to instead use the modern name "macOS" when no specific version number is
mentioned.
If a specific version is mentioned, this attempts to use the OS name at the time
of that version:
* Mac OS X for 10.0 - 10.7
* OS X for 10.8 - 10.11
* macOS for 10.12 - present
Reviewers: JDevlieghere
Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits
Tags: #clang, #lldb, #libc, #llvm
Differential Revision: https://reviews.llvm.org/D62654
llvm-svn: 362113
2019-05-31 00:46:22 +08:00
macOS
-----
2012-10-07 12:34:10 +08:00
* `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html> `_
* `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php> `_
2019-01-17 08:21:08 +08:00
* `ARM64 Function Calling Conventions <https://developer.apple.com/library/archive/documentation/Xcode/Conceptual/iPhoneOSABIReference/Articles/ARM64FunctionCallingConventions.html> `_
2012-10-07 12:34:10 +08:00
2013-06-08 04:30:27 +08:00
Windows
-------
* `Microsoft PE/COFF Specification <http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx> `_
2019-01-17 08:21:08 +08:00
* `ARM64 exception handling <https://docs.microsoft.com/en-us/cpp/build/arm64-exception-handling> `_
* `ARM exception handling <https://docs.microsoft.com/en-us/cpp/build/arm-exception-handling> `_
* `Overview of ARM64 ABI conventions <https://docs.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions> `_
* `Overview of ARM32 ABI Conventions <https://docs.microsoft.com/en-us/cpp/build/overview-of-arm-abi-conventions> `_
2013-06-08 04:30:27 +08:00
2013-03-31 00:41:14 +08:00
NVPTX
=====
* `CUDA Documentation <http://docs.nvidia.com/cuda/index.html> `_ includes the PTX
ISA and Driver API documentation
2012-10-07 12:34:10 +08:00
Miscellaneous Resources
=======================
* `Executable File Format library <http://www.nondot.org/sabre/os/articles/ExecutableFileFormats/> `_
* `GCC prefetch project <http://gcc.gnu.org/projects/prefetch.html> `_ page has a
good survey of the prefetching capabilities of a variety of modern
processors.
