summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2006-08-15 03:57:05 +0000
committerReid Spencer <rspencer@reidspencer.com>2006-08-15 03:57:05 +0000
commit1c6f87d665502fb4481435970eacafb59c200ce0 (patch)
tree2e8d53b625335ebd22a24b5c98ec68c956f759b6 /docs
parent920baeee80bc2c381c4eb773297a716ad83d018f (diff)
downloadllvm-1c6f87d665502fb4481435970eacafb59c200ce0.tar.gz
llvm-1c6f87d665502fb4481435970eacafb59c200ce0.tar.bz2
llvm-1c6f87d665502fb4481435970eacafb59c200ce0.tar.xz
Some more correction to the examples, thanks to Chris Lattner.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29696 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/GetElementPtr.html11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/GetElementPtr.html b/docs/GetElementPtr.html
index e16e056d22..49c3e6563a 100644
--- a/docs/GetElementPtr.html
+++ b/docs/GetElementPtr.html
@@ -77,21 +77,24 @@
<pre>
AType* Foo;
...
- X = Foo[1];</pre>
+ X = &amp;Foo-&gt;F;</pre>
<p>it is natural to think that there is only one index, the constant value
<tt>1</tt>. This results from C allowing you to treat pointers and arrays as
equivalent. LLVM doesn't. In this example, Foo is a pointer. That pointer must
be indexed. To arrive at the same address location as the C code, you would
provide the GEP instruction with two indices. The first indexes through the
- pointer, the second index the second element of the array.</p>
+ pointer, the second index the element of the structure just as if it was:</p>
+ <pre>
+ X = &amp;Foo[0].F;</pre>
<p>Sometimes this question gets rephrased as:</p>
<blockquote><i>Why is it okay to index through the first pointer, but
subsequent pointers won't be dereferenced?</i></blockquote>
<p>The answer is simply because memory does not have to be accessed to
perform the computation. The first operand to the GEP instruction must be a
value of a pointer type. The value of the pointer is provided directly to
- the GEP instruction without any need for accessing memory. It must,
- therefore be indexed like any other operand. Consider this example:</p>
+ the GEP instruction as an operand without any need for accessing memory. It
+ must, therefore be indexed and requires an index operand. Consider this
+ example:</p>
<pre>
struct munger_struct {
int f1;