summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2005-07-19 01:36:35 +0000
committerReid Spencer <rspencer@reidspencer.com>2005-07-19 01:36:35 +0000
commit627cd0005c1ff00bb88eb89051c233cf1de67cea (patch)
tree3ff4c3ee7d74e99241d4f647d38b84020b0fdba9 /docs
parent7911f036266fc9cd63534b9bb225523d021bab7c (diff)
downloadllvm-627cd0005c1ff00bb88eb89051c233cf1de67cea.tar.gz
llvm-627cd0005c1ff00bb88eb89051c233cf1de67cea.tar.bz2
llvm-627cd0005c1ff00bb88eb89051c233cf1de67cea.tar.xz
Provide descriptions for the TargetInstrInfo and TargetFrameInfo classes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22466 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/CodeGenerator.html20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/CodeGenerator.html b/docs/CodeGenerator.html
index 700a4fcf22..c7ffbc6f96 100644
--- a/docs/CodeGenerator.html
+++ b/docs/CodeGenerator.html
@@ -383,11 +383,31 @@ href="TableGenFundamentals.html">TableGen</a> description of the register file.
<a name="targetinstrinfo">The <tt>TargetInstrInfo</tt> class</a>
</div>
+<div class="doc_text">
+ <p>The <tt>TargetInstrInfo</tt> class is used to describe the machine
+ instructions supported by the target. It is essentially an array of
+ <tt>TargetInstrDescriptor</tt> objects, each of which describes one
+ instruction the target supports. Descriptors define things like the mnemonic
+ for the opcode, the number of operands, the size of the largets immediate
+ field the instruction can contain, the latency of the instruction in machine
+ cycles, etc.</p>
+</div>
+
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="targetframeinfo">The <tt>TargetFrameInfo</tt> class</a>
</div>
+<div class="doc_text">
+ <p>The <tt>TargetFrameInfo</tt> class is used to provide information about the
+ stack frame layout of the target. It holds the direction of stack growth,
+ the known stack alignment on entry to each function, and the offset to the
+ locals area. The offset to the local area is the offset from the stack
+ pointer on function entry to the first location where function data (local
+ variables, spill locations) can be stored.</p>
+ <p>The class also provides several functions for computing alignment and
+ offsets for various situations.</p>
+</div>
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="targetjitinfo">The <tt>TargetJITInfo</tt> class</a>