Fix a docs build break introduced by rL236888.
[oota-llvm.git] / docs / Statepoints.rst
1 =====================================
2 Garbage Collection Safepoints in LLVM
3 =====================================
4
5 .. contents::
6    :local:
7    :depth: 2
8
9 Status
10 =======
11
12 This document describes a set of experimental extensions to LLVM. Use
13 with caution.  Because the intrinsics have experimental status,
14 compatibility across LLVM releases is not guaranteed.
15
16 LLVM currently supports an alternate mechanism for conservative
17 garbage collection support using the ``gcroot`` intrinsic.  The mechanism
18 described here shares little in common with the alternate ``gcroot``
19 implementation and it is hoped that this mechanism will eventually
20 replace the gc_root mechanism.
21
22 Overview
23 ========
24
25 To collect dead objects, garbage collectors must be able to identify
26 any references to objects contained within executing code, and,
27 depending on the collector, potentially update them.  The collector
28 does not need this information at all points in code - that would make
29 the problem much harder - but only at well-defined points in the
30 execution known as 'safepoints' For most collectors, it is sufficient
31 to track at least one copy of each unique pointer value.  However, for
32 a collector which wishes to relocate objects directly reachable from
33 running code, a higher standard is required.
34
35 One additional challenge is that the compiler may compute intermediate
36 results ("derived pointers") which point outside of the allocation or
37 even into the middle of another allocation.  The eventual use of this
38 intermediate value must yield an address within the bounds of the
39 allocation, but such "exterior derived pointers" may be visible to the
40 collector.  Given this, a garbage collector can not safely rely on the
41 runtime value of an address to indicate the object it is associated
42 with.  If the garbage collector wishes to move any object, the
43 compiler must provide a mapping, for each pointer, to an indication of
44 its allocation.
45
46 To simplify the interaction between a collector and the compiled code,
47 most garbage collectors are organized in terms of three abstractions:
48 load barriers, store barriers, and safepoints.
49
50 #. A load barrier is a bit of code executed immediately after the
51    machine load instruction, but before any use of the value loaded.
52    Depending on the collector, such a barrier may be needed for all
53    loads, merely loads of a particular type (in the original source
54    language), or none at all.
55
56 #. Analogously, a store barrier is a code fragement that runs
57    immediately before the machine store instruction, but after the
58    computation of the value stored.  The most common use of a store
59    barrier is to update a 'card table' in a generational garbage
60    collector.
61
62 #. A safepoint is a location at which pointers visible to the compiled
63    code (i.e. currently in registers or on the stack) are allowed to
64    change.  After the safepoint completes, the actual pointer value
65    may differ, but the 'object' (as seen by the source language)
66    pointed to will not.
67
68   Note that the term 'safepoint' is somewhat overloaded.  It refers to
69   both the location at which the machine state is parsable and the
70   coordination protocol involved in bring application threads to a
71   point at which the collector can safely use that information.  The
72   term "statepoint" as used in this document refers exclusively to the
73   former.
74
75 This document focuses on the last item - compiler support for
76 safepoints in generated code.  We will assume that an outside
77 mechanism has decided where to place safepoints.  From our
78 perspective, all safepoints will be function calls.  To support
79 relocation of objects directly reachable from values in compiled code,
80 the collector must be able to:
81
82 #. identify every copy of a pointer (including copies introduced by
83    the compiler itself) at the safepoint,
84 #. identify which object each pointer relates to, and
85 #. potentially update each of those copies.
86
87 This document describes the mechanism by which an LLVM based compiler
88 can provide this information to a language runtime/collector, and
89 ensure that all pointers can be read and updated if desired.  The
90 heart of the approach is to construct (or rewrite) the IR in a manner
91 where the possible updates performed by the garbage collector are
92 explicitly visible in the IR.  Doing so requires that we:
93
94 #. create a new SSA value for each potentially relocated pointer, and
95    ensure that no uses of the original (non relocated) value is
96    reachable after the safepoint,
97 #. specify the relocation in a way which is opaque to the compiler to
98    ensure that the optimizer can not introduce new uses of an
99    unrelocated value after a statepoint. This prevents the optimizer
100    from performing unsound optimizations.
101 #. recording a mapping of live pointers (and the allocation they're
102    associated with) for each statepoint.
103
104 At the most abstract level, inserting a safepoint can be thought of as
105 replacing a call instruction with a call to a multiple return value
106 function which both calls the original target of the call, returns
107 it's result, and returns updated values for any live pointers to
108 garbage collected objects.
109
110   Note that the task of identifying all live pointers to garbage
111   collected values, transforming the IR to expose a pointer giving the
112   base object for every such live pointer, and inserting all the
113   intrinsics correctly is explicitly out of scope for this document.
114   The recommended approach is to use the :ref:`utility passes 
115   <statepoint-utilities>` described below. 
116
117 This abstract function call is concretely represented by a sequence of
118 intrinsic calls known collectively as a "statepoint relocation sequence".
119
120 Let's consider a simple call in LLVM IR:
121
122 .. code-block:: llvm
123
124   define i8 addrspace(1)* @test1(i8 addrspace(1)* %obj) 
125          gc "statepoint-example" {
126     call void ()* @foo()
127     ret i8 addrspace(1)* %obj
128   }
129
130 Depending on our language we may need to allow a safepoint during the execution 
131 of ``foo``. If so, we need to let the collector update local values in the 
132 current frame.  If we don't, we'll be accessing a potential invalid reference 
133 once we eventually return from the call.
134
135 In this example, we need to relocate the SSA value ``%obj``.  Since we can't 
136 actually change the value in the SSA value ``%obj``, we need to introduce a new 
137 SSA value ``%obj.relocated`` which represents the potentially changed value of
138 ``%obj`` after the safepoint and update any following uses appropriately.  The 
139 resulting relocation sequence is:
140
141 .. code-block:: llvm
142
143   define i8 addrspace(1)* @test1(i8 addrspace(1)* %obj) 
144          gc "statepoint-example" {
145     %0 = call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @foo, i32 0, i32 0, i32 0, i8 addrspace(1)* %obj)
146     %obj.relocated = call coldcc i8 addrspace(1)* @llvm.experimental.gc.relocate.p1i8(i32 %0, i32 4, i32 4)
147     ret i8 addrspace(1)* %obj.relocated
148   }
149
150 Ideally, this sequence would have been represented as a M argument, N
151 return value function (where M is the number of values being
152 relocated + the original call arguments and N is the original return
153 value + each relocated value), but LLVM does not easily support such a
154 representation.
155
156 Instead, the statepoint intrinsic marks the actual site of the
157 safepoint or statepoint.  The statepoint returns a token value (which
158 exists only at compile time).  To get back the original return value
159 of the call, we use the ``gc.result`` intrinsic.  To get the relocation
160 of each pointer in turn, we use the ``gc.relocate`` intrinsic with the
161 appropriate index.  Note that both the ``gc.relocate`` and ``gc.result`` are
162 tied to the statepoint.  The combination forms a "statepoint relocation 
163 sequence" and represents the entitety of a parseable call or 'statepoint'.
164
165 When lowered, this example would generate the following x86 assembly:
166
167 .. code-block:: gas
168   
169           .globl        test1
170           .align        16, 0x90
171           pushq %rax
172           callq foo
173   .Ltmp1:
174           movq  (%rsp), %rax  # This load is redundant (oops!)
175           popq  %rdx
176           retq
177
178 Each of the potentially relocated values has been spilled to the
179 stack, and a record of that location has been recorded to the
180 :ref:`Stack Map section <stackmap-section>`.  If the garbage collector
181 needs to update any of these pointers during the call, it knows
182 exactly what to change.
183
184 The relevant parts of the StackMap section for our example are:
185
186 .. code-block:: gas
187   
188   # This describes the call site
189   # Stack Maps: callsite 2882400000
190           .quad 2882400000
191           .long .Ltmp1-test1
192           .short        0
193   # .. 8 entries skipped ..
194   # This entry describes the spill slot which is directly addressable
195   # off RSP with offset 0.  Given the value was spilled with a pushq, 
196   # that makes sense.
197   # Stack Maps:   Loc 8: Direct RSP     [encoding: .byte 2, .byte 8, .short 7, .int 0]
198           .byte 2
199           .byte 8
200           .short        7
201           .long 0
202
203 This example was taken from the tests for the :ref:`RewriteStatepointsForGC` utility pass.  As such, it's full StackMap can be easily examined with the following command.
204
205 .. code-block:: bash
206
207   opt -rewrite-statepoints-for-gc test/Transforms/RewriteStatepointsForGC/basics.ll -S | llc -debug-only=stackmaps
208
209
210 GC Transitions
211 ^^^^^^^^^^^^^^^^^^
212
213 As a practical consideration, many garbage-collected systems allow code that is
214 collector-aware ("managed code") to call code that is not collector-aware
215 ("unmanaged code"). It is common that such calls must also be safepoints, since
216 it is desirable to allow the collector to run during the execution of
217 unmanaged code. Futhermore, it is common that coordinating the transition from
218 managed to unmanaged code requires extra code generation at the call site to
219 inform the collector of the transition. In order to support these needs, a
220 statepoint may be marked as a GC transition, and data that is necessary to
221 perform the transition (if any) may be provided as additional arguments to the
222 statepoint.
223
224   Note that although in many cases statepoints may be inferred to be GC
225   transitions based on the function symbols involved (e.g. a call from a
226   function with GC strategy "foo" to a function with GC strategy "bar"),
227   indirect calls that are also GC transitions must also be supported. This
228   requirement is the driving force behing the decision to require that GC
229   transitions are explicitly marked.
230
231 Let's revisit the sample given above, this time treating the call to ``@foo``
232 as a GC transition. Depending on our target, the transition code may need to
233 access some extra state in order to inform the collector of the transition.
234 Let's assume a hypothetical GC--somewhat unimaginatively named "hypothetical-gc"
235 --that requires that a TLS variable must be written to before and after a call
236 to unmanaged code. The resulting relocation sequence is:
237
238 .. code-block:: llvm
239
240   @flag = thread_local global i32 0, align 4
241
242   define i8 addrspace(1)* @test1(i8 addrspace(1) *%obj)
243          gc "hypothetical-gc" {
244
245     %0 = call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @foo, i32 0, i32 1, i32* @Flag, i32 0, i8 addrspace(1)* %obj)
246     %obj.relocated = call coldcc i8 addrspace(1)* @llvm.experimental.gc.relocate.p1i8(i32 %0, i32 4, i32 4)
247     ret i8 addrspace(1)* %obj.relocated
248   }
249
250 During lowering, this will result in a instruction selection DAG that looks
251 something like:
252
253 ::
254
255   CALLSEQ_START
256   ...
257   GC_TRANSITION_START (lowered i32 *@Flag), SRCVALUE i32* Flag
258   STATEPOINT
259   GC_TRANSITION_END (lowered i32 *@Flag), SRCVALUE i32 *Flag
260   ...
261   CALLSEQ_END
262
263 In order to generate the necessary transition code, the backend for each target
264 supported by "hypothetical-gc" must be modified to lower ``GC_TRANSITION_START``
265 and ``GC_TRANSITION_END`` nodes appropriately when the "hypothetical-gc"
266 strategy is in use for a particular function. Assuming that such lowering has
267 been added for X86, the generated assembly would be:
268
269 .. code-block:: gas
270
271           .globl        test1
272           .align        16, 0x90
273           pushq %rax
274           movl $1, %fs:Flag@TPOFF
275           callq foo
276           movl $0, %fs:Flag@TPOFF
277   .Ltmp1:
278           movq  (%rsp), %rax  # This load is redundant (oops!)
279           popq  %rdx
280           retq
281
282 Note that the design as presented above is not fully implemented: in particular,
283 strategy-specific lowering is not present, and all GC transitions are emitted as
284 as single no-op before and after the call instruction. These no-ops are often
285 removed by the backend during dead machine instruction elimination.
286
287
288 Intrinsics
289 ===========
290
291 'llvm.experimental.gc.statepoint' Intrinsic
292 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
293
294 Syntax:
295 """""""
296
297 ::
298
299       declare i32
300         @llvm.experimental.gc.statepoint(func_type <target>, 
301                        i64 <#call args>. i64 <flags>,
302                        ... (call parameters),
303                        i64 <# transition args>, ... (transition parameters),
304                        i64 <# deopt args>, ... (deopt parameters),
305                        ... (gc parameters))
306
307 Overview:
308 """""""""
309
310 The statepoint intrinsic represents a call which is parse-able by the
311 runtime.
312
313 Operands:
314 """""""""
315
316 The 'target' operand is the function actually being called.  The
317 target can be specified as either a symbolic LLVM function, or as an
318 arbitrary Value of appropriate function type.  Note that the function
319 type must match the signature of the callee and the types of the 'call
320 parameters' arguments.
321
322 The '#call args' operand is the number of arguments to the actual
323 call.  It must exactly match the number of arguments passed in the
324 'call parameters' variable length section.
325
326 The 'flags' operand is used to specify extra information about the
327 statepoint. This is currently only used to mark certain statepoints
328 as GC transitions. This operand is a 64-bit integer with the following
329 layout, where bit 0 is the least significant bit:
330
331   +-------+---------------------------------------------------+
332   | Bit # | Usage                                             |
333   +=======+===================================================+
334   |     0 | Set if the statepoint is a GC transition, cleared |
335   |       | otherwise.                                        |
336   +-------+---------------------------------------------------+
337   |  1-63 | Reserved for future use; must be cleared.         |
338   +-------+---------------------------------------------------+
339
340 The 'call parameters' arguments are simply the arguments which need to
341 be passed to the call target.  They will be lowered according to the
342 specified calling convention and otherwise handled like a normal call
343 instruction.  The number of arguments must exactly match what is
344 specified in '# call args'.  The types must match the signature of
345 'target'.
346
347 The 'transition parameters' arguments contain an arbitrary list of
348 Values which need to be passed to GC transition code. They will be
349 lowered and passed as operands to the appropriate GC_TRANSITION nodes
350 in the selection DAG. It is assumed that these arguments must be
351 available before and after (but not necessarily during) the execution
352 of the callee. The '# transition args' field indicates how many operands
353 are to be interpreted as 'transition parameters'.
354
355 The 'deopt parameters' arguments contain an arbitrary list of Values
356 which is meaningful to the runtime.  The runtime may read any of these
357 values, but is assumed not to modify them.  If the garbage collector
358 might need to modify one of these values, it must also be listed in
359 the 'gc pointer' argument list.  The '# deopt args' field indicates
360 how many operands are to be interpreted as 'deopt parameters'.
361
362 The 'gc parameters' arguments contain every pointer to a garbage
363 collector object which potentially needs to be updated by the garbage
364 collector.  Note that the argument list must explicitly contain a base
365 pointer for every derived pointer listed.  The order of arguments is
366 unimportant.  Unlike the other variable length parameter sets, this
367 list is not length prefixed.
368
369 Semantics:
370 """"""""""
371
372 A statepoint is assumed to read and write all memory.  As a result,
373 memory operations can not be reordered past a statepoint.  It is
374 illegal to mark a statepoint as being either 'readonly' or 'readnone'.
375
376 Note that legal IR can not perform any memory operation on a 'gc
377 pointer' argument of the statepoint in a location statically reachable
378 from the statepoint.  Instead, the explicitly relocated value (from a
379 ``gc.relocate``) must be used.
380
381 'llvm.experimental.gc.result' Intrinsic
382 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
383
384 Syntax:
385 """""""
386
387 ::
388
389       declare type*
390         @llvm.experimental.gc.result(i32 %statepoint_token)
391
392 Overview:
393 """""""""
394
395 ``gc.result`` extracts the result of the original call instruction
396 which was replaced by the ``gc.statepoint``.  The ``gc.result``
397 intrinsic is actually a family of three intrinsics due to an
398 implementation limitation.  Other than the type of the return value,
399 the semantics are the same.
400
401 Operands:
402 """""""""
403
404 The first and only argument is the ``gc.statepoint`` which starts
405 the safepoint sequence of which this ``gc.result`` is a part.
406 Despite the typing of this as a generic i32, *only* the value defined
407 by a ``gc.statepoint`` is legal here.
408
409 Semantics:
410 """"""""""
411
412 The ``gc.result`` represents the return value of the call target of
413 the ``statepoint``.  The type of the ``gc.result`` must exactly match
414 the type of the target.  If the call target returns void, there will
415 be no ``gc.result``.
416
417 A ``gc.result`` is modeled as a 'readnone' pure function.  It has no
418 side effects since it is just a projection of the return value of the
419 previous call represented by the ``gc.statepoint``.
420
421 'llvm.experimental.gc.relocate' Intrinsic
422 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
423
424 Syntax:
425 """""""
426
427 ::
428
429       declare <pointer type>
430         @llvm.experimental.gc.relocate(i32 %statepoint_token, 
431                                        i32 %base_offset, 
432                                        i32 %pointer_offset)
433
434 Overview:
435 """""""""
436
437 A ``gc.relocate`` returns the potentially relocated value of a pointer
438 at the safepoint.
439
440 Operands:
441 """""""""
442
443 The first argument is the ``gc.statepoint`` which starts the
444 safepoint sequence of which this ``gc.relocation`` is a part.
445 Despite the typing of this as a generic i32, *only* the value defined
446 by a ``gc.statepoint`` is legal here.
447
448 The second argument is an index into the statepoints list of arguments
449 which specifies the base pointer for the pointer being relocated.
450 This index must land within the 'gc parameter' section of the
451 statepoint's argument list.
452
453 The third argument is an index into the statepoint's list of arguments
454 which specify the (potentially) derived pointer being relocated.  It
455 is legal for this index to be the same as the second argument
456 if-and-only-if a base pointer is being relocated. This index must land
457 within the 'gc parameter' section of the statepoint's argument list.
458
459 Semantics:
460 """"""""""
461
462 The return value of ``gc.relocate`` is the potentially relocated value
463 of the pointer specified by it's arguments.  It is unspecified how the
464 value of the returned pointer relates to the argument to the
465 ``gc.statepoint`` other than that a) it points to the same source
466 language object with the same offset, and b) the 'based-on'
467 relationship of the newly relocated pointers is a projection of the
468 unrelocated pointers.  In particular, the integer value of the pointer
469 returned is unspecified.
470
471 A ``gc.relocate`` is modeled as a ``readnone`` pure function.  It has no
472 side effects since it is just a way to extract information about work
473 done during the actual call modeled by the ``gc.statepoint``.
474
475 .. _statepoint-stackmap-format:
476
477 Stack Map Format
478 ================
479
480 Locations for each pointer value which may need read and/or updated by
481 the runtime or collector are provided via the :ref:`Stack Map format
482 <stackmap-format>` specified in the PatchPoint documentation.
483
484 Each statepoint generates the following Locations:
485
486 * Constant which describes number of following deopt *Locations* (not
487   operands)
488 * Variable number of Locations, one for each deopt parameter listed in
489   the IR statepoint (same number as described by previous Constant)
490 * Variable number of Locations pairs, one pair for each unique pointer
491   which needs relocated.  The first Location in each pair describes
492   the base pointer for the object.  The second is the derived pointer
493   actually being relocated.  It is guaranteed that the base pointer
494   must also appear explicitly as a relocation pair if used after the
495   statepoint. There may be fewer pairs then gc parameters in the IR
496   statepoint. Each *unique* pair will occur at least once; duplicates
497   are possible.
498
499 Note that the Locations used in each section may describe the same
500 physical location.  e.g. A stack slot may appear as a deopt location,
501 a gc base pointer, and a gc derived pointer.
502
503 The ID field of the 'StkMapRecord' for a statepoint is meaningless and
504 it's value is explicitly unspecified.
505
506 The LiveOut section of the StkMapRecord will be empty for a statepoint
507 record.
508
509 Safepoint Semantics & Verification
510 ==================================
511
512 The fundamental correctness property for the compiled code's
513 correctness w.r.t. the garbage collector is a dynamic one.  It must be
514 the case that there is no dynamic trace such that a operation
515 involving a potentially relocated pointer is observably-after a
516 safepoint which could relocate it.  'observably-after' is this usage
517 means that an outside observer could observe this sequence of events
518 in a way which precludes the operation being performed before the
519 safepoint.
520
521 To understand why this 'observable-after' property is required,
522 consider a null comparison performed on the original copy of a
523 relocated pointer.  Assuming that control flow follows the safepoint,
524 there is no way to observe externally whether the null comparison is
525 performed before or after the safepoint.  (Remember, the original
526 Value is unmodified by the safepoint.)  The compiler is free to make
527 either scheduling choice.
528
529 The actual correctness property implemented is slightly stronger than
530 this.  We require that there be no *static path* on which a
531 potentially relocated pointer is 'observably-after' it may have been
532 relocated.  This is slightly stronger than is strictly necessary (and
533 thus may disallow some otherwise valid programs), but greatly
534 simplifies reasoning about correctness of the compiled code.
535
536 By construction, this property will be upheld by the optimizer if
537 correctly established in the source IR.  This is a key invariant of
538 the design.
539
540 The existing IR Verifier pass has been extended to check most of the
541 local restrictions on the intrinsics mentioned in their respective
542 documentation.  The current implementation in LLVM does not check the
543 key relocation invariant, but this is ongoing work on developing such
544 a verifier.  Please ask on llvmdev if you're interested in
545 experimenting with the current version.
546
547 .. _statepoint-utilities:
548
549 Utility Passes for Safepoint Insertion
550 ======================================
551
552 .. _RewriteStatepointsForGC:
553
554 RewriteStatepointsForGC
555 ^^^^^^^^^^^^^^^^^^^^^^^^
556
557 The pass RewriteStatepointsForGC transforms a functions IR by replacing a 
558 ``gc.statepoint`` (with an optional ``gc.result``) with a full relocation 
559 sequence, including all required ``gc.relocates``.  To function, the pass 
560 requires that the GC strategy specified for the function be able to reliably 
561 distinguish between GC references and non-GC references in IR it is given.
562
563 As an example, given this code:
564
565 .. code-block:: llvm
566
567   define i8 addrspace(1)* @test1(i8 addrspace(1)* %obj) 
568          gc "statepoint-example" {
569     call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @foo, i32 0, i32 0, i32 0, i32 5, i32 0, i32 -1, i32 0, i32 0, i32 0)
570     ret i8 addrspace(1)* %obj
571   }
572
573 The pass would produce this IR:
574
575 .. code-block:: llvm
576
577   define i8 addrspace(1)* @test1(i8 addrspace(1)* %obj) 
578          gc "statepoint-example" {
579     %0 = call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @foo, i32 0, i32 0, i32 0, i32 5, i32 0, i32 -1, i32 0, i32 0, i32 0, i8 addrspace(1)* %obj)
580     %obj.relocated = call coldcc i8 addrspace(1)* @llvm.experimental.gc.relocate.p1i8(i32 %0, i32 9, i32 9)
581     ret i8 addrspace(1)* %obj.relocated
582   }
583
584 In the above examples, the addrspace(1) marker on the pointers is the mechanism
585 that the ``statepoint-example`` GC strategy uses to distinguish references from
586 non references.  Address space 1 is not globally reserved for this purpose.
587
588 This pass can be used an utility function by a language frontend that doesn't 
589 want to manually reason about liveness, base pointers, or relocation when 
590 constructing IR.  As currently implemented, RewriteStatepointsForGC must be 
591 run after SSA construction (i.e. mem2ref).  
592
593
594 In practice, RewriteStatepointsForGC can be run much later in the pass 
595 pipeline, after most optimization is already done.  This helps to improve 
596 the quality of the generated code when compiled with garbage collection support.
597 In the long run, this is the intended usage model.  At this time, a few details
598 have yet to be worked out about the semantic model required to guarantee this 
599 is always correct.  As such, please use with caution and report bugs.
600
601 .. _PlaceSafepoints:
602
603 PlaceSafepoints
604 ^^^^^^^^^^^^^^^^
605
606 The pass PlaceSafepoints transforms a function's IR by replacing any call or 
607 invoke instructions with appropriate ``gc.statepoint`` and ``gc.result`` pairs,
608 and inserting safepoint polls sufficient to ensure running code checks for a 
609 safepoint request on a timely manner.  This pass is expected to be run before 
610 RewriteStatepointsForGC and thus does not produce full relocation sequences.  
611
612 As an example, given input IR of the following:
613
614 .. code-block:: llvm
615
616   define void @test() gc "statepoint-example" {
617     call void @foo()
618     ret void
619   }
620
621   declare void @do_safepoint()
622   define void @gc.safepoint_poll() {
623     call void @do_safepoint()
624     ret void
625   }
626
627
628 This pass would produce the following IR:
629
630 .. code-block:: llvm
631
632   define void @test() gc "statepoint-example" {
633     %safepoint_token = call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @do_safepoint, i32 0, i32 0, i32 0, i32 0)
634     %safepoint_token1 = call i32 (void ()*, i32, i32, ...)* @llvm.experimental.gc.statepoint.p0f_isVoidf(void ()* @foo, i32 0, i32 0, i32 0, i32 0)
635     ret void
636   }
637
638 In this case, we've added an (unconditional) entry safepoint poll and converted the call into a ``gc.statepoint``.  Note that despite appearances, the entry poll is not necessarily redundant.  We'd have to know that ``foo`` and ``test`` were not mutually recursive for the poll to be redundant.  In practice, you'd probably want to your poll definition to contain a conditional branch of some form.
639
640
641 At the moment, PlaceSafepoints can insert safepoint polls at method entry and 
642 loop backedges locations.  Extending this to work with return polls would be 
643 straight forward if desired.
644
645 PlaceSafepoints includes a number of optimizations to avoid placing safepoint 
646 polls at particular sites unless needed to ensure timely execution of a poll 
647 under normal conditions.  PlaceSafepoints does not attempt to ensure timely 
648 execution of a poll under worst case conditions such as heavy system paging.
649
650 The implementation of a safepoint poll action is specified by looking up a 
651 function of the name ``gc.safepoint_poll`` in the containing Module.  The body
652 of this function is inserted at each poll site desired.  While calls or invokes
653 inside this method are transformed to a ``gc.statepoints``, recursive poll 
654 insertion is not performed.
655
656 If you are scheduling the RewriteStatepointsForGC pass late in the pass order,
657 you should probably schedule this pass immediately before it.  The exception 
658 would be if you need to preserve abstract frame information (e.g. for
659 deoptimization or introspection) at safepoints.  In that case, ask on the 
660 llvmdev mailing list for suggestions.
661
662
663 Bugs and Enhancements
664 =====================
665
666 Currently known bugs and enhancements under consideration can be
667 tracked by performing a `bugzilla search
668 <http://llvm.org/bugs/buglist.cgi?cmdtype=runnamed&namedcmd=Statepoint%20Bugs&list_id=64342>`_
669 for [Statepoint] in the summary field. When filing new bugs, please
670 use this tag so that interested parties see the newly filed bug.  As
671 with most LLVM features, design discussions take place on `llvmdev
672 <http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_, and patches
673 should be sent to `llvm-commits
674 <http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits>`_ for review.
675