summaryrefslogtreecommitdiffstats
path: root/llvm/docs
diff options
context:
space:
mode:
authorCraig Topper <craig.topper@intel.com>2018-03-20 20:24:10 +0000
committerCraig Topper <craig.topper@intel.com>2018-03-20 20:24:10 +0000
commitb5ed275025efc9d96a6a24ad9f27db62880fa32d (patch)
tree84973302b90e961565ac5b773a3b557711985988 /llvm/docs
parent858a7dd6d70bfed500e0e2a5137f25dd71b90f19 (diff)
downloadbcm5719-llvm-b5ed275025efc9d96a6a24ad9f27db62880fa32d.tar.gz
bcm5719-llvm-b5ed275025efc9d96a6a24ad9f27db62880fa32d.zip
[TableGen] Pass result of std::unique to vector::erase instead of calculating a size and calling resize.
llvm-svn: 328031
Diffstat (limited to 'llvm/docs')
-rw-r--r--llvm/docs/AMDGPUUsage.rst2
-rw-r--r--llvm/docs/CodeGenerator.rst6
-rw-r--r--llvm/docs/CompilerWriterInfo.rst2
-rw-r--r--llvm/docs/X86Usage.rst85
-rw-r--r--llvm/docs/index.rst4
5 files changed, 98 insertions, 1 deletions
diff --git a/llvm/docs/AMDGPUUsage.rst b/llvm/docs/AMDGPUUsage.rst
index d0671b0a74e..6d70cfa9c45 100644
--- a/llvm/docs/AMDGPUUsage.rst
+++ b/llvm/docs/AMDGPUUsage.rst
@@ -1,4 +1,4 @@
-=============================
+============================
User Guide for AMDGPU Backend
=============================
diff --git a/llvm/docs/CodeGenerator.rst b/llvm/docs/CodeGenerator.rst
index 7329f3d1fe6..a9e50707382 100644
--- a/llvm/docs/CodeGenerator.rst
+++ b/llvm/docs/CodeGenerator.rst
@@ -2656,3 +2656,9 @@ The AMDGPU backend
The AMDGPU code generator lives in the ``lib/Target/AMDGPU``
directory. This code generator is capable of targeting a variety of
AMD GPU processors. Refer to :doc:`AMDGPUUsage` for more information.
+
+The X86 backend
+------------------
+
+The X86 code generator lives in the ``lib/Target/X86``
+directory. Refer to :doc:`X86Usage` for more information.
diff --git a/llvm/docs/CompilerWriterInfo.rst b/llvm/docs/CompilerWriterInfo.rst
index 60f102472c6..9148ff0aa89 100644
--- a/llvm/docs/CompilerWriterInfo.rst
+++ b/llvm/docs/CompilerWriterInfo.rst
@@ -99,6 +99,8 @@ X86
* `X86 and X86-64 SysV psABI <https://github.com/hjl-tools/x86-psABI/wiki/X86-psABI>`_
* `Calling conventions for different C++ compilers and operating systems <http://www.agner.org/optimize/calling_conventions.pdf>`_
+Refer to :doc:`X86Usage` for additional documentation.
+
XCore
-----
diff --git a/llvm/docs/X86Usage.rst b/llvm/docs/X86Usage.rst
new file mode 100644
index 00000000000..a8197d5e4ee
--- /dev/null
+++ b/llvm/docs/X86Usage.rst
@@ -0,0 +1,85 @@
+=============================
+User Guide for X86 Backend
+=============================
+
+.. contents::
+ :local:
+
+Introduction
+============
+
+The X86 backend provides ISA code generation for X86 CPUs. It lives in the
+``lib/Target/X86`` directory.
+
+LLVM
+====
+
+.. _x86-processors
+
+Processors
+----------
+
+Use the ``clang -march=<Processor>`` option to specify the X86 processor.
+
+ .. table:: X86 processors
+ :name: x86-processor-table
+
+ ================== ===================
+ Processor Alternative
+ Name
+ ``i386``
+ ``i486``
+ ``i586``
+ ``pentium``
+ ``pentium-mmx``
+ ``i686``
+ ``pentiumpro``
+ ``pentium2``
+ ``pentium3`` - ``pentium3m``
+ ``pentium-m``
+ ``pentium4`` - ``pentium4m``
+ ``lakemont``
+ ``yonah``
+ ``prescott``
+ ``nocona``
+ ``core2``
+ ``penryn``
+ ``bonnell`` - ``atom``
+ ``silvermont`` - ``slm``
+ ``goldmont``
+ ``nehalem`` - ``corei7``
+ ``westmere``
+ ``sandybridge`` - ``corei7-avx``
+ ``ivybridge`` - ``core-avx-i``
+ ``haswell`` - ``core-avx2``
+ ``broadwell`` - ``skylake``
+ ``knl``
+ ``knm``
+ ``skylake-avx512`` - ``skx``
+ ``cannonlake``
+ ``icelake``
+ ``k6``
+ ``k6-2``
+ ``k6-3``
+ ``athlon`` - ``athlon-tbird``
+ ``athlon-4`` - ``athlon-xp``
+ - ``athlon-mp``
+ ``k8`` - ``opteron``
+ - ``athlon64``
+ - ``athlon-fx``
+ ``k8-sse3`` - ``opteron-sse3``
+ - ``athlon64-sse3``
+ ``amdfam10h`` - ``barcelona``
+ ``btver1``
+ ``btver2``
+ ``bdver1``
+ ``bdver2``
+ ``bdver3``
+ ``bdver4``
+ ``znver1``
+ ``geode``
+ ``winchip-c6``
+ ``winchip2``
+ ``c3``
+ ``c3-2``
+ ================== ===================
diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst
index 2173f94459d..84c7ccb1021 100644
--- a/llvm/docs/index.rst
+++ b/llvm/docs/index.rst
@@ -276,6 +276,7 @@ For API clients and LLVM developers.
HowToUseAttributes
NVPTXUsage
AMDGPUUsage
+ X86Usage
StackMaps
InAlloca
BigEndianNEON
@@ -380,6 +381,9 @@ For API clients and LLVM developers.
:doc:`AMDGPUUsage`
This document describes using the AMDGPU backend to compile GPU kernels.
+:doc:`X86Usage`
+ This document describes using the X86 backend.
+
:doc:`StackMaps`
LLVM support for mapping instruction addresses to the location of
values and allowing code to be patched.
OpenPOWER on IntegriCloud