about summary refs log tree commit diff
path: root/src/rt/rust_stack.h
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-02-10 11:42:33 -0800
committerBrian Anderson <banderson@mozilla.com>2012-02-10 12:58:35 -0800
commitb9e0ee8e7ec0cbc6d194fe220c71a5c39a2560e7 (patch)
tree601e1d59c99988dfb5b4ef3f10429e781b93d17f /src/rt/rust_stack.h
parent3af4b2c998b90eed5baaf033f92cf5aae06cfc4b (diff)
downloadrust-b9e0ee8e7ec0cbc6d194fe220c71a5c39a2560e7.tar.gz
rust-b9e0ee8e7ec0cbc6d194fe220c71a5c39a2560e7.zip
rt: Add docs to stack functions
Diffstat (limited to 'src/rt/rust_stack.h')
-rw-r--r--src/rt/rust_stack.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/rt/rust_stack.h b/src/rt/rust_stack.h
index f310b044acb..f6704a9f0eb 100644
--- a/src/rt/rust_stack.h
+++ b/src/rt/rust_stack.h
@@ -19,12 +19,15 @@ const uint8_t stack_canary[] = {0xAB, 0xCD, 0xAB, 0xCD,
                                 0xAB, 0xCD, 0xAB, 0xCD,
                                 0xAB, 0xCD, 0xAB, 0xCD};
 
+// Used by create_stack
 void
 register_valgrind_stack(stk_seg *stk);
 
+// Used by destroy_stack
 void
 deregister_valgrind_stack(stk_seg *stk);
 
+// Used by create_stack
 void
 add_stack_canary(stk_seg *stk);
 
@@ -47,9 +50,12 @@ destroy_stack(T allocer, stk_seg *stk) {
   allocer->free(stk);
 }
 
+// Must be called before each time a stack is reused to tell valgrind
+// that the stack is accessible.
 void
 prepare_valgrind_stack(stk_seg *stk);
 
+// Run a sanity check
 void
 check_stack_canary(stk_seg *stk);