From 86947e47ad057d50209cf8a022f088c22089433f Mon Sep 17 00:00:00 2001
From: Eric Holk <eric.holk@gmail.com>
Date: Fri, 3 Aug 2012 15:20:38 -0700
Subject: [PATCH] More documentation on pipes, and moving assert in runtime.

---
 src/libcore/pipes.rs | 15 +++++++++++++++
 src/rt/rust_task.cpp |  4 ++--
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/src/libcore/pipes.rs b/src/libcore/pipes.rs
index f13ee96768a..cd4265ada8e 100644
--- a/src/libcore/pipes.rs
+++ b/src/libcore/pipes.rs
@@ -41,6 +41,21 @@ buffer that is carried along in the endpoint data structures.
 
 FIXME (#3072) - This is still incomplete
 
+
+
+## Invariants
+
+This section attempts to document the invariants that must hold to
+avoid races. These primarily deal with the state and blocked_task
+fields on packet_headers.
+
+1. If the sender reads a some(task) out of blocked_task, then the task
+that is pointed there will remain live for any events that the sender
+might signal.
+
+2. The sender may only read the blocked_task field if it first ensures
+that the packet's state field is blocked.
+
 */
 
 import unsafe::{forget, reinterpret_cast, transmute};
diff --git a/src/rt/rust_task.cpp b/src/rt/rust_task.cpp
index ad2e8a71ae5..58a0e3eae6c 100644
--- a/src/rt/rust_task.cpp
+++ b/src/rt/rust_task.cpp
@@ -678,11 +678,11 @@ MUST_CHECK bool rust_task::wait_event(void **result) {
 
 void
 rust_task::signal_event(void *event) {
-    scoped_lock with(lifecycle_lock);
-
     assert(task_state_blocked == state ||
            task_state_running == state);
 
+    scoped_lock with(lifecycle_lock);
+
     this->event = event;
     event_reject = true;
     if(task_state_blocked == state) {