[llvm-commits] CVS: llvm/docs/GarbageCollection.html

[Chris Lattner]

Changes in directory llvm/docs:

GarbageCollection.html updated: 1.6 -> 1.7

---
Log message:

Update documentation for gc intrinsics change.  Contributed by
Tobias Nurmiranta


---
Diffs of the changes:  (+9 -8)

Index: llvm/docs/GarbageCollection.html
diff -u llvm/docs/GarbageCollection.html:1.6 llvm/docs/GarbageCollection.html:1.7
--- llvm/docs/GarbageCollection.html:1.6	Fri Jul  9 00:03:54 2004
+++ llvm/docs/GarbageCollection.html	Thu Jul 22 00:49:38 2004
@@ -234,8 +234,8 @@
 <div class="doc_text">
 
 <div class="doc_code"><tt>
-  sbyte *%llvm.gcread(sbyte **)<br>
-  void %llvm.gcwrite(sbyte*, sbyte**)
+  sbyte *%llvm.gcread(sbyte *, sbyte **)<br>
+  void %llvm.gcwrite(sbyte*, sbyte*, sbyte**)
 </tt></div>
 
 <p>Several of the more interesting garbage collectors (e.g., generational
@@ -250,7 +250,9 @@
 <p>To support garbage collectors that use read or write barriers, LLVM provides
 the <tt>llvm.gcread</tt> and <tt>llvm.gcwrite</tt> intrinsics.  The first
 intrinsic has exactly the same semantics as a non-volatile LLVM load and the
-second has the same semantics as a non-volatile LLVM store.  At code generation
+second has the same semantics as a non-volatile LLVM store, with the
+additions that they also take a pointer to the start of the memory
+object as an argument.  At code generation
 time, these intrinsics are replaced with calls into the garbage collector
 (<tt><a href="#llvm_gc_readwrite">llvm_gc_read</a></tt> and <tt><a
 href="#llvm_gc_readwrite">llvm_gc_write</a></tt> respectively), which are then
@@ -341,8 +343,8 @@
 
 <div class="doc_text">
   <div class="doc_code"><tt>
-    void *llvm_gc_read(void **)<br>
-    void llvm_gc_write(void*, void**)
+    void *llvm_gc_read(void*, void **)<br>
+    void llvm_gc_write(void*, void *, void**)
  </tt></div>
 
 <p>
@@ -353,8 +355,7 @@
 
 <p>
 If an actual read or write barrier is needed, it should be straight-forward to
-implement it.  Note that we may add a pointer to the start of the memory object
-as a parameter in the future, if needed.
+implement it.
 </p>
 
 </div>
@@ -525,7 +526,7 @@
 
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2004/07/09 05:03:54 $
+  Last modified: $Date: 2004/07/22 05:49:38 $
 </address>
 
 </body>