docs/GetElementPtr.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6   <title>The Often Misunderstood GEP Instruction</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8   <style type="text/css">
   9     TABLE   { text-align: left; border: 1px solid black; border-collapse: collapse; margin: 0 0 0 0; }
  10   </style>
  11 </head>
  12 <body>
  13
  14 <div class="doc_title">
  15   The Often Misunderstood GEP Instruction
  16 </div>
  17
  18 <ol>
  19   <li><a href="#intro">Introduction</a></li>
  20   <li><a href="#addresses">Address Computation</a>
  21   <ol>
  22     <li><a href="#extra_index">Why is the extra 0 index required?</a></li>
  23     <li><a href="#deref">What is dereferenced by GEP?</a></li>
  24     <li><a href="#firstptr">Why can you index through the first pointer but not
  25       subsequent ones?</a></li>
  26     <li><a href="#lead0">Why don't GEP x,0,0,1 and GEP x,1 alias? </a></li>
  27     <li><a href="#trail0">Why do GEP x,1,0,0 and GEP x,1 alias? </a></li>
  28     <li><a href="#vectors">Can GEP index into vector elements?</a>
  29     <li><a href="#addrspace">What effect do address spaces have on GEPs?</a>
  30     <li><a href="#int">How is GEP different from ptrtoint, arithmetic, and inttoptr?</a></li>
  31     <li><a href="#be">I'm writing a backend for a target which needs custom lowering for GEP. How do I do this?</a>
  32     <li><a href="#vla">How does VLA addressing work with GEPs?</a>
  33   </ol></li>
  34   <li><a href="#rules">Rules</a>
  35   <ol>
  36     <li><a href="#bounds">What happens if an array index is out of bounds?</a>
  37     <li><a href="#negative">Can array indices be negative?</a>
  38     <li><a href="#compare">Can I compare two values computed with GEPs?</a>
  39     <li><a href="#types">Can I do GEP with a different pointer type than the type of the underlying object?</a>
  40     <li><a href="#null">Can I cast an object's address to integer and add it to null?</a>
  41     <li><a href="#ptrdiff">Can I compute the distance between two objects, and add that value to one address to compute the other address?</a>
  42     <li><a href="#tbaa">Can I do type-based alias analysis on LLVM IR?</a>
  43     <li><a href="#overflow">What happens if a GEP computation overflows?</a>
  44     <li><a href="#check">How can I tell if my front-end is following the rules?</a>
  45   </ol></li>
  46   <li><a href="#rationale">Rationale</a>
  47   <ol>
  48     <li><a href="#goals">Why is GEP designed this way?</a></li>
  49     <li><a href="#i32">Why do struct member indices always use i32?</a></li>
  50     <li><a href="#uglygep">What's an uglygep?</a>
  51   </ol></li>
  52   <li><a href="#summary">Summary</a></li>
  53 </ol>
  54
  55 <div class="doc_author">
  56   <p>Written by: <a href="mailto:rspencer@reidspencer.com">Reid Spencer</a>.</p>
  57 </div>
  58
  59
  60 <!-- *********************************************************************** -->
  61 <div class="doc_section"><a name="intro"><b>Introduction</b></a></div>
  62 <!-- *********************************************************************** -->
  63
  64 <div class="doc_text">
  65   <p>This document seeks to dispel the mystery and confusion surrounding LLVM's
  66   <a href="LangRef.html#i_getelementptr">GetElementPtr</a> (GEP) instruction.
  67   Questions about the wily GEP instruction are
  68   probably the most frequently occurring questions once a developer gets down to
  69   coding with LLVM. Here we lay out the sources of confusion and show that the
  70   GEP instruction is really quite simple.
  71   </p>
  72 </div>
  73
  74 <!-- *********************************************************************** -->
  75 <div class="doc_section"><a name="addresses"><b>Address Computation</b></a></div>
  76 <!-- *********************************************************************** -->
  77 <div class="doc_text">
  78   <p>When people are first confronted with the GEP instruction, they tend to
  79   relate it to known concepts from other programming paradigms, most notably C
  80   array indexing and field selection. GEP closely resembles C array indexing
  81   and field selection, however it's is a little different and this leads to
  82   the following questions.</p>
  83 </div>
  84
  85 <!-- *********************************************************************** -->
  86 <div class="doc_subsection">
  87   <a name="firstptr"><b>What is the first index of the GEP instruction?</b></a>
  88 </div>
  89 <div class="doc_text">
  90   <p>Quick answer: The index stepping through the first operand.</p>
  91   <p>The confusion with the first index usually arises from thinking about
  92   the GetElementPtr instruction as if it was a C index operator. They aren't the
  93   same. For example, when we write, in "C":</p>
  94
  95 <div class="doc_code">
  96 <pre>
  97 AType *Foo;
  98 ...
  99 X = &amp;Foo-&gt;F;
 100 </pre>
 101 </div>
 102
 103   <p>it is natural to think that there is only one index, the selection of the
 104   field <tt>F</tt>.  However, in this example, <tt>Foo</tt> is a pointer. That
 105   pointer must be indexed explicitly in LLVM. C, on the other hand, indices
 106   through it transparently.  To arrive at the same address location as the C
 107   code, you would provide the GEP instruction with two index operands. The
 108   first operand indexes through the pointer; the second operand indexes the
 109   field <tt>F</tt> of the structure, just as if you wrote:</p>
 110
 111 <div class="doc_code">
 112 <pre>
 113 X = &amp;Foo[0].F;
 114 </pre>
 115 </div>
 116
 117   <p>Sometimes this question gets rephrased as:</p>
 118   <blockquote><p><i>Why is it okay to index through the first pointer, but
 119       subsequent pointers won't be dereferenced?</i></p></blockquote>
 120   <p>The answer is simply because memory does not have to be accessed to
 121   perform the computation. The first operand to the GEP instruction must be a
 122   value of a pointer type. The value of the pointer is provided directly to
 123   the GEP instruction as an operand without any need for accessing memory. It
 124   must, therefore be indexed and requires an index operand. Consider this
 125   example:</p>
 126
 127 <div class="doc_code">
 128 <pre>
 129 struct munger_struct {
 130   int f1;
 131   int f2;
 132 };
 133 void munge(struct munger_struct *P) {
 134   P[0].f1 = P[1].f1 + P[2].f2;
 135 }
 136 ...
 137 munger_struct Array[3];
 138 ...
 139 munge(Array);
 140 </pre>
 141 </div>
 142
 143   <p>In this "C" example, the front end compiler (llvm-gcc) will generate three
 144   GEP instructions for the three indices through "P" in the assignment
 145   statement.  The function argument <tt>P</tt> will be the first operand of each
 146   of these GEP instructions.  The second operand indexes through that pointer.
 147   The third operand will be the field offset into the
 148   <tt>struct munger_struct</tt> type,  for either the <tt>f1</tt> or
 149   <tt>f2</tt> field. So, in LLVM assembly the <tt>munge</tt> function looks
 150   like:</p>
 151
 152 <div class="doc_code">
 153 <pre>
 154 void %munge(%struct.munger_struct* %P) {
 155 entry:
 156   %tmp = getelementptr %struct.munger_struct* %P, i32 1, i32 0
 157   %tmp = load i32* %tmp
 158   %tmp6 = getelementptr %struct.munger_struct* %P, i32 2, i32 1
 159   %tmp7 = load i32* %tmp6
 160   %tmp8 = add i32 %tmp7, %tmp
 161   %tmp9 = getelementptr %struct.munger_struct* %P, i32 0, i32 0
 162   store i32 %tmp8, i32* %tmp9
 163   ret void
 164 }
 165 </pre>
 166 </div>
 167
 168   <p>In each case the first operand is the pointer through which the GEP
 169   instruction starts. The same is true whether the first operand is an
 170   argument, allocated memory, or a global variable. </p>
 171   <p>To make this clear, let's consider a more obtuse example:</p>
 172
 173 <div class="doc_code">
 174 <pre>
 175 %MyVar = uninitialized global i32
 176 ...
 177 %idx1 = getelementptr i32* %MyVar, i64 0
 178 %idx2 = getelementptr i32* %MyVar, i64 1
 179 %idx3 = getelementptr i32* %MyVar, i64 2
 180 </pre>
 181 </div>
 182
 183   <p>These GEP instructions are simply making address computations from the
 184   base address of <tt>MyVar</tt>.  They compute, as follows (using C syntax):
 185   </p>
 186
 187 <div class="doc_code">
 188 <pre>
 189 idx1 = (char*) &amp;MyVar + 0
 190 idx2 = (char*) &amp;MyVar + 4
 191 idx3 = (char*) &amp;MyVar + 8
 192 </pre>
 193 </div>
 194
 195   <p>Since the type <tt>i32</tt> is known to be four bytes long, the indices
 196   0, 1 and 2 translate into memory offsets of 0, 4, and 8, respectively. No
 197   memory is accessed to make these computations because the address of
 198   <tt>%MyVar</tt> is passed directly to the GEP instructions.</p>
 199   <p>The obtuse part of this example is in the cases of <tt>%idx2</tt> and
 200   <tt>%idx3</tt>. They result in the computation of addresses that point to
 201   memory past the end of the <tt>%MyVar</tt> global, which is only one
 202   <tt>i32</tt> long, not three <tt>i32</tt>s long.  While this is legal in LLVM,
 203   it is inadvisable because any load or store with the pointer that results
 204   from these GEP instructions would produce undefined results.</p>
 205 </div>
 206
 207 <!-- *********************************************************************** -->
 208 <div class="doc_subsection">
 209   <a name="extra_index"><b>Why is the extra 0 index required?</b></a>
 210 </div>
 211 <!-- *********************************************************************** -->
 212 <div class="doc_text">
 213   <p>Quick answer: there are no superfluous indices.</p>
 214   <p>This question arises most often when the GEP instruction is applied to a
 215   global variable which is always a pointer type. For example, consider
 216   this:</p>
 217
 218 <div class="doc_code">
 219 <pre>
 220 %MyStruct = uninitialized global { float*, i32 }
 221 ...
 222 %idx = getelementptr { float*, i32 }* %MyStruct, i64 0, i32 1
 223 </pre>
 224 </div>
 225
 226   <p>The GEP above yields an <tt>i32*</tt> by indexing the <tt>i32</tt> typed
 227   field of the structure <tt>%MyStruct</tt>. When people first look at it, they
 228   wonder why the <tt>i64 0</tt> index is needed. However, a closer inspection
 229   of how globals and GEPs work reveals the need. Becoming aware of the following
 230   facts will dispel the confusion:</p>
 231   <ol>
 232     <li>The type of <tt>%MyStruct</tt> is <i>not</i> <tt>{ float*, i32 }</tt>
 233     but rather <tt>{ float*, i32 }*</tt>. That is, <tt>%MyStruct</tt> is a
 234     pointer to a structure containing a pointer to a <tt>float</tt> and an
 235     <tt>i32</tt>.</li>
 236     <li>Point #1 is evidenced by noticing the type of the first operand of
 237     the GEP instruction (<tt>%MyStruct</tt>) which is
 238     <tt>{ float*, i32 }*</tt>.</li>
 239     <li>The first index, <tt>i64 0</tt> is required to step over the global
 240     variable <tt>%MyStruct</tt>.  Since the first argument to the GEP
 241     instruction must always be a value of pointer type, the first index
 242     steps through that pointer. A value of 0 means 0 elements offset from that
 243     pointer.</li>
 244     <li>The second index, <tt>i32 1</tt> selects the second field of the
 245     structure (the <tt>i32</tt>). </li>
 246   </ol>
 247 </div>
 248
 249 <!-- *********************************************************************** -->
 250 <div class="doc_subsection">
 251   <a name="deref"><b>What is dereferenced by GEP?</b></a>
 252 </div>
 253 <div class="doc_text">
 254   <p>Quick answer: nothing.</p>
 255   <p>The GetElementPtr instruction dereferences nothing. That is, it doesn't
 256   access memory in any way. That's what the Load and Store instructions are for.
 257   GEP is only involved in the computation of addresses. For example, consider
 258   this:</p>
 259
 260 <div class="doc_code">
 261 <pre>
 262 %MyVar = uninitialized global { [40 x i32 ]* }
 263 ...
 264 %idx = getelementptr { [40 x i32]* }* %MyVar, i64 0, i32 0, i64 0, i64 17
 265 </pre>
 266 </div>
 267
 268   <p>In this example, we have a global variable, <tt>%MyVar</tt> that is a
 269   pointer to a structure containing a pointer to an array of 40 ints. The
 270   GEP instruction seems to be accessing the 18th integer of the structure's
 271   array of ints. However, this is actually an illegal GEP instruction. It
 272   won't compile. The reason is that the pointer in the structure <i>must</i>
 273   be dereferenced in order to index into the array of 40 ints. Since the
 274   GEP instruction never accesses memory, it is illegal.</p>
 275   <p>In order to access the 18th integer in the array, you would need to do the
 276   following:</p>
 277
 278 <div class="doc_code">
 279 <pre>
 280 %idx = getelementptr { [40 x i32]* }* %, i64 0, i32 0
 281 %arr = load [40 x i32]** %idx
 282 %idx = getelementptr [40 x i32]* %arr, i64 0, i64 17
 283 </pre>
 284 </div>
 285
 286   <p>In this case, we have to load the pointer in the structure with a load
 287   instruction before we can index into the array. If the example was changed
 288   to:</p>
 289
 290 <div class="doc_code">
 291 <pre>
 292 %MyVar = uninitialized global { [40 x i32 ] }
 293 ...
 294 %idx = getelementptr { [40 x i32] }*, i64 0, i32 0, i64 17
 295 </pre>
 296 </div>
 297
 298   <p>then everything works fine. In this case, the structure does not contain a
 299   pointer and the GEP instruction can index through the global variable,
 300   into the first field of the structure and access the 18th <tt>i32</tt> in the
 301   array there.</p>
 302 </div>
 303
 304 <!-- *********************************************************************** -->
 305 <div class="doc_subsection">
 306   <a name="lead0"><b>Why don't GEP x,0,0,1 and GEP x,1 alias?</b></a>
 307 </div>
 308 <div class="doc_text">
 309   <p>Quick Answer: They compute different address locations.</p>
 310   <p>If you look at the first indices in these GEP
 311   instructions you find that they are different (0 and 1), therefore the address
 312   computation diverges with that index. Consider this example:</p>
 313
 314 <div class="doc_code">
 315 <pre>
 316 %MyVar = global { [10 x i32 ] }
 317 %idx1 = getelementptr { [10 x i32 ] }* %MyVar, i64 0, i32 0, i64 1
 318 %idx2 = getelementptr { [10 x i32 ] }* %MyVar, i64 1
 319 </pre>
 320 </div>
 321
 322   <p>In this example, <tt>idx1</tt> computes the address of the second integer
 323   in the array that is in the structure in <tt>%MyVar</tt>, that is
 324   <tt>MyVar+4</tt>. The type of <tt>idx1</tt> is <tt>i32*</tt>. However,
 325   <tt>idx2</tt> computes the address of <i>the next</i> structure after
 326   <tt>%MyVar</tt>. The type of <tt>idx2</tt> is <tt>{ [10 x i32] }*</tt> and its
 327   value is equivalent to <tt>MyVar + 40</tt> because it indexes past the ten
 328   4-byte integers in <tt>MyVar</tt>. Obviously, in such a situation, the
 329   pointers don't alias.</p>
 330
 331 </div>
 332
 333 <!-- *********************************************************************** -->
 334 <div class="doc_subsection">
 335   <a name="trail0"><b>Why do GEP x,1,0,0 and GEP x,1 alias?</b></a>
 336 </div>
 337 <div class="doc_text">
 338   <p>Quick Answer: They compute the same address location.</p>
 339   <p>These two GEP instructions will compute the same address because indexing
 340   through the 0th element does not change the address. However, it does change
 341   the type. Consider this example:</p>
 342
 343 <div class="doc_code">
 344 <pre>
 345 %MyVar = global { [10 x i32 ] }
 346 %idx1 = getelementptr { [10 x i32 ] }* %MyVar, i64 1, i32 0, i64 0
 347 %idx2 = getelementptr { [10 x i32 ] }* %MyVar, i64 1
 348 </pre>
 349 </div>
 350
 351   <p>In this example, the value of <tt>%idx1</tt> is <tt>%MyVar+40</tt> and
 352   its type is <tt>i32*</tt>. The value of <tt>%idx2</tt> is also
 353   <tt>MyVar+40</tt> but its type is <tt>{ [10 x i32] }*</tt>.</p>
 354 </div>
 355
 356 <!-- *********************************************************************** -->
 357
 358 <div class="doc_subsection">
 359   <a name="vectors"><b>Can GEP index into vector elements?</b></a>
 360 </div>
 361 <div class="doc_text">
 362   <p>This hasn't always been forcefully disallowed, though it's not recommended.
 363      It leads to awkward special cases in the optimizers, and fundamental
 364      inconsistency in the IR. In the future, it will probably be outright
 365      disallowed.</p>
 366
 367 </div>
 368
 369 <!-- *********************************************************************** -->
 370
 371 <div class="doc_subsection">
 372   <a name="addrspace"><b>What effect do address spaces have on GEPs?</b></a>
 373 </div>
 374 <div class="doc_text">
 375    <p>None, except that the address space qualifier on the first operand pointer
 376       type always matches the address space qualifier on the result type.</p>
 377
 378 </div>
 379
 380 <!-- *********************************************************************** -->
 381
 382 <div class="doc_subsection">
 383   <a name="int"><b>How is GEP different from ptrtoint, arithmetic,
 384                    and inttoptr?</b></a>
 385 </div>
 386 <div class="doc_text">
 387   <p>It's very similar; there are only subtle differences.</p>
 388
 389   <p>With ptrtoint, you have to pick an integer type. One approach is to pick i64;
 390      this is safe on everything LLVM supports (LLVM internally assumes pointers
 391      are never wider than 64 bits in many places), and the optimizer will actually
 392      narrow the i64 arithmetic down to the actual pointer size on targets which
 393      don't support 64-bit arithmetic in most cases. However, there are some cases
 394      where it doesn't do this. With GEP you can avoid this problem.
 395
 396   <p>Also, GEP carries additional pointer aliasing rules. It's invalid to take a
 397      GEP from one object, address into a different separately allocated
 398      object, and dereference it. IR producers (front-ends) must follow this rule,
 399      and consumers (optimizers, specifically alias analysis) benefit from being
 400      able to rely on it. See the <a href="#rules">Rules</a> section for more
 401      information.</p>
 402
 403   <p>And, GEP is more concise in common cases.</p>
 404
 405   <p>However, for the underlying integer computation implied, there
 406      is no difference.</p>
 407
 408 </div>
 409
 410 <!-- *********************************************************************** -->
 411
 412 <div class="doc_subsection">
 413   <a name="be"><b>I'm writing a backend for a target which needs custom
 414                   lowering for GEP. How do I do this?</b></a>
 415 </div>
 416 <div class="doc_text">
 417   <p>You don't. The integer computation implied by a GEP is target-independent.
 418      Typically what you'll need to do is make your backend pattern-match
 419      expressions trees involving ADD, MUL, etc., which are what GEP is lowered
 420      into. This has the advantage of letting your code work correctly in more
 421      cases.</p>
 422
 423   <p>GEP does use target-dependent parameters for the size and layout of data
 424      types, which targets can customize.</p>
 425
 426   <p>If you require support for addressing units which are not 8 bits, you'll
 427      need to fix a lot of code in the backend, with GEP lowering being only a
 428      small piece of the overall picture.</p>
 429
 430 </div>
 431
 432 <!-- *********************************************************************** -->
 433
 434 <div class="doc_subsection">
 435   <a name="vla"><b>How does VLA addressing work with GEPs?</b></a>
 436 </div>
 437 <div class="doc_text">
 438   <p>GEPs don't natively support VLAs. LLVM's type system is entirely static,
 439      and GEP address computations are guided by an LLVM type.</p>
 440
 441   <p>VLA indices can be implemented as linearized indices. For example, an
 442      expression like X[a][b][c], must be effectively lowered into a form
 443      like X[a*m+b*n+c], so that it appears to the GEP as a single-dimensional
 444      array reference.</p>
 445
 446   <p>This means if you want to write an analysis which understands array
 447      indices and you want to support VLAs, your code will have to be
 448      prepared to reverse-engineer the linearization. One way to solve this
 449      problem is to use the ScalarEvolution library, which always presents
 450      VLA and non-VLA indexing in the same manner.</p>
 451 </div>
 452
 453 <!-- *********************************************************************** -->
 454 <div class="doc_section"><a name="rules"><b>Rules</b></a></div>
 455 <!-- *********************************************************************** -->
 456
 457 <!-- *********************************************************************** -->
 458
 459 <div class="doc_subsection">
 460   <a name="bounds"><b>What happens if an array index is out of bounds?</b></a>
 461 </div>
 462 <div class="doc_text">
 463   <p>There are two senses in which an array index can be out of bounds.</p>
 464
 465   <p>First, there's the array type which comes from the (static) type of
 466      the first operand to the GEP. Indices greater than the number of elements
 467      in the corresponding static array type are valid. There is no problem with
 468      out of bounds indices in this sense. Indexing into an array only depends
 469      on the size of the array element, not the number of elements.</p>
 470
 471   <p>A common example of how this is used is arrays where the size is not known.
 472      It's common to use array types with zero length to represent these. The
 473      fact that the static type says there are zero elements is irrelevant; it's
 474      perfectly valid to compute arbitrary element indices, as the computation
 475      only depends on the size of the array element, not the number of
 476      elements. Note that zero-sized arrays are not a special case here.</p>
 477
 478   <p>This sense is unconnected with <tt>inbounds</tt> keyword. The
 479      <tt>inbounds</tt> keyword is designed to describe low-level pointer
 480      arithmetic overflow conditions, rather than high-level array
 481      indexing rules.
 482
 483   <p>Analysis passes which wish to understand array indexing should not
 484      assume that the static array type bounds are respected.</p>
 485
 486   <p>The second sense of being out of bounds is computing an address that's
 487      beyond the actual underlying allocated object.</p>
 488
 489   <p>With the <tt>inbounds</tt> keyword, the result value of the GEP is
 490      undefined if the address is outside the actual underlying allocated
 491      object and not the address one-past-the-end.</p>
 492
 493   <p>Without the <tt>inbounds</tt> keyword, there are no restrictions
 494      on computing out-of-bounds addresses. Obviously, performing a load or
 495      a store requires an address of allocated and sufficiently aligned
 496      memory. But the GEP itself is only concerned with computing addresses.</p>
 497
 498 </div>
 499
 500 <!-- *********************************************************************** -->
 501 <div class="doc_subsection">
 502   <a name="negative"><b>Can array indices be negative?</b></a>
 503 </div>
 504 <div class="doc_text">
 505   <p>Yes. This is basically a special case of array indices being out
 506      of bounds.</p>
 507
 508 </div>
 509
 510 <!-- *********************************************************************** -->
 511 <div class="doc_subsection">
 512   <a name="compare"><b>Can I compare two values computed with GEPs?</b></a>
 513 </div>
 514 <div class="doc_text">
 515   <p>Yes. If both addresses are within the same allocated object, or
 516      one-past-the-end, you'll get the comparison result you expect. If either
 517      is outside of it, integer arithmetic wrapping may occur, so the
 518      comparison may not be meaningful.</p>
 519
 520 </div>
 521
 522 <!-- *********************************************************************** -->
 523 <div class="doc_subsection">
 524   <a name="types"><b>Can I do GEP with a different pointer type than the type of
 525                      the underlying object?</b></a>
 526 </div>
 527 <div class="doc_text">
 528   <p>Yes. There are no restrictions on bitcasting a pointer value to an arbitrary
 529      pointer type. The types in a GEP serve only to define the parameters for the
 530      underlying integer computation. They need not correspond with the actual
 531      type of the underlying object.</p>
 532
 533   <p>Furthermore, loads and stores don't have to use the same types as the type
 534      of the underlying object. Types in this context serve only to specify
 535      memory size and alignment. Beyond that there are merely a hint to the
 536      optimizer indicating how the value will likely be used.</p>
 537
 538 </div>
 539
 540 <!-- *********************************************************************** -->
 541 <div class="doc_subsection">
 542   <a name="null"><b>Can I cast an object's address to integer and add it
 543                     to null?</b></a>
 544 </div>
 545 <div class="doc_text">
 546   <p>You can compute an address that way, but if you use GEP to do the add,
 547      you can't use that pointer to actually access the object, unless the
 548      object is managed outside of LLVM.</p>
 549
 550   <p>The underlying integer computation is sufficiently defined; null has a
 551      defined value -- zero -- and you can add whatever value you want to it.</p>
 552
 553   <p>However, it's invalid to access (load from or store to) an LLVM-aware
 554      object with such a pointer. This includes GlobalVariables, Allocas, and
 555      objects pointed to by noalias pointers.</p>
 556
 557   <p>If you really need this functionality, you can do the arithmetic with
 558      explicit integer instructions, and use inttoptr to convert the result to
 559      an address. Most of GEP's special aliasing rules do not apply to pointers
 560      computed from ptrtoint, arithmetic, and inttoptr sequences.</p>
 561
 562 </div>
 563
 564 <!-- *********************************************************************** -->
 565 <div class="doc_subsection">
 566   <a name="ptrdiff"><b>Can I compute the distance between two objects, and add
 567                        that value to one address to compute the other address?</b></a>
 568 </div>
 569 <div class="doc_text">
 570   <p>As with arithmetic on null, You can use GEP to compute an address that
 571      way, but you can't use that pointer to actually access the object if you
 572      do, unless the object is managed outside of LLVM.</p>
 573
 574   <p>Also as above, ptrtoint and inttoptr provide an alternative way to do this
 575      which do not have this restriction.</p>
 576
 577 </div>
 578
 579 <!-- *********************************************************************** -->
 580 <div class="doc_subsection">
 581   <a name="tbaa"><b>Can I do type-based alias analysis on LLVM IR?</b></a>
 582 </div>
 583 <div class="doc_text">
 584   <p>You can't do type-based alias analysis using LLVM's built-in type system,
 585      because LLVM has no restrictions on mixing types in addressing, loads or
 586      stores.</p>
 587
 588   <p>It would be possible to add special annotations to the IR, probably using
 589      metadata, to describe a different type system (such as the C type system),
 590      and do type-based aliasing on top of that. This is a much bigger
 591      undertaking though.</p>
 592
 593 </div>
 594
 595 <!-- *********************************************************************** -->
 596
 597 <div class="doc_subsection">
 598   <a name="overflow"><b>What happens if a GEP computation overflows?</b></a>
 599 </div>
 600 <div class="doc_text">
 601    <p>If the GEP lacks the <tt>inbounds</tt> keyword, the value is the result
 602       from evaluating the implied two's complement integer computation. However,
 603       since there's no guarantee of where an object will be allocated in the
 604       address space, such values have limited meaning.</p>
 605
 606   <p>If the GEP has the <tt>inbounds</tt> keyword, the result value is
 607      undefined (a "<a href="LangRef.html#trapvalues">trap value</a>") if the GEP
 608      overflows (i.e. wraps around the end of the address space).</p>
 609
 610   <p>As such, there are some ramifications of this for inbounds GEPs: scales
 611      implied by array/vector/pointer indices are always known to be "nsw" since
 612      they are signed values that are scaled by the element size.  These values
 613      are also allowed to be negative (e.g. "gep i32 *%P, i32 -1") but the
 614      pointer itself is logically treated as an unsigned value.  This means that
 615      GEPs have an asymmetric relation between the pointer base (which is treated
 616      as unsigned) and the offset applied to it (which is treated as signed). The
 617      result of the additions within the offset calculation cannot have signed
 618      overflow, but when applied to the base pointer, there can be signed
 619      overflow.
 620   </p>
 621
 622
 623 </div>
 624
 625 <!-- *********************************************************************** -->
 626
 627 <div class="doc_subsection">
 628   <a name="check"><b>How can I tell if my front-end is following the
 629                      rules?</b></a>
 630 </div>
 631 <div class="doc_text">
 632    <p>There is currently no checker for the getelementptr rules. Currently,
 633       the only way to do this is to manually check each place in your front-end
 634       where GetElementPtr operators are created.</p>
 635
 636    <p>It's not possible to write a checker which could find all rule
 637       violations statically. It would be possible to write a checker which
 638       works by instrumenting the code with dynamic checks though. Alternatively,
 639       it would be possible to write a static checker which catches a subset of
 640       possible problems. However, no such checker exists today.</p>
 641
 642 </div>
 643
 644 <!-- *********************************************************************** -->
 645 <div class="doc_section"><a name="rationale"><b>Rationale</b></a></div>
 646 <!-- *********************************************************************** -->
 647
 648 <!-- *********************************************************************** -->
 649
 650 <div class="doc_subsection">
 651   <a name="goals"><b>Why is GEP designed this way?</b></a>
 652 </div>
 653 <div class="doc_text">
 654    <p>The design of GEP has the following goals, in rough unofficial
 655       order of priority:</p>
 656    <ul>
 657      <li>Support C, C-like languages, and languages which can be
 658          conceptually lowered into C (this covers a lot).</li>
 659      <li>Support optimizations such as those that are common in
 660          C compilers. In particular, GEP is a cornerstone of LLVM's
 661          <a href="LangRef.html#pointeraliasing">pointer aliasing model</a>.</li>
 662      <li>Provide a consistent method for computing addresses so that
 663          address computations don't need to be a part of load and
 664          store instructions in the IR.</li>
 665      <li>Support non-C-like languages, to the extent that it doesn't
 666          interfere with other goals.</li>
 667      <li>Minimize target-specific information in the IR.</li>
 668    </ul>
 669 </div>
 670
 671 <!-- *********************************************************************** -->
 672 <div class="doc_subsection">
 673   <a name="i32"><b>Why do struct member indices always use i32?</b></a>
 674 </div>
 675 <div class="doc_text">
 676   <p>The specific type i32 is probably just a historical artifact, however it's
 677      wide enough for all practical purposes, so there's been no need to change it.
 678      It doesn't necessarily imply i32 address arithmetic; it's just an identifier
 679      which identifies a field in a struct. Requiring that all struct indices be
 680      the same reduces the range of possibilities for cases where two GEPs are
 681      effectively the same but have distinct operand types.</p>
 682
 683 </div>
 684
 685 <!-- *********************************************************************** -->
 686
 687 <div class="doc_subsection">
 688   <a name="uglygep"><b>What's an uglygep?</b></a>
 689 </div>
 690 <div class="doc_text">
 691   <p>Some LLVM optimizers operate on GEPs by internally lowering them into
 692      more primitive integer expressions, which allows them to be combined
 693      with other integer expressions and/or split into multiple separate
 694      integer expressions. If they've made non-trivial changes, translating
 695      back into LLVM IR can involve reverse-engineering the structure of
 696      the addressing in order to fit it into the static type of the original
 697      first operand. It isn't always possibly to fully reconstruct this
 698      structure; sometimes the underlying addressing doesn't correspond with
 699      the static type at all. In such cases the optimizer instead will emit
 700      a GEP with the base pointer casted to a simple address-unit pointer,
 701      using the name "uglygep". This isn't pretty, but it's just as
 702      valid, and it's sufficient to preserve the pointer aliasing guarantees
 703      that GEP provides.</p>
 704
 705 </div>
 706
 707 <!-- *********************************************************************** -->
 708 <div class="doc_section"><a name="summary"><b>Summary</b></a></div>
 709 <!-- *********************************************************************** -->
 710
 711 <div class="doc_text">
 712   <p>In summary, here's some things to always remember about the GetElementPtr
 713   instruction:</p>
 714   <ol>
 715     <li>The GEP instruction never accesses memory, it only provides pointer
 716     computations.</li>
 717     <li>The first operand to the GEP instruction is always a pointer and it must
 718     be indexed.</li>
 719     <li>There are no superfluous indices for the GEP instruction.</li>
 720     <li>Trailing zero indices are superfluous for pointer aliasing, but not for
 721     the types of the pointers.</li>
 722     <li>Leading zero indices are not superfluous for pointer aliasing nor the
 723     types of the pointers.</li>
 724   </ol>
 725 </div>
 726
 727 <!-- *********************************************************************** -->
 728
 729 <hr>
 730 <address>
 731   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 732   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 733   <a href="http://validator.w3.org/check/referer"><img
 734   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 735   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br/>
 736   Last modified: $Date$
 737 </address>
 738 </body>
 739 </html>