---

yaml
---
r: 14191
b: refs/heads/try
c: b9e0ee8
h: refs/heads/master
i:
  14189: 43c8aaf
  14187: 337e9a5
  14183: 959631f
  14175: e4eba97
v: v3

Author: brson

[refs]

@@ -2,5 +2,5 @@
 refs/heads/master: 61b1875c16de39c166b0f4d54bba19f9c6777d1a
 refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
 refs/heads/snap-stage3: 4a81779abd786ff22d71434c6d9a5917ea4cdfff
-refs/heads/try: 3af4b2c998b90eed5baaf033f92cf5aae06cfc4b
+refs/heads/try: b9e0ee8e7ec0cbc6d194fe220c71a5c39a2560e7
 refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105

branches/try/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);