[PATCH] SQUASH: update with Neil's comments

[Jeff Layton]

Signed-off-by: Jeff Layton <jlayton@xxxxxxxxxx>
---
 fs/locks.c | 31 ++++++++++++++++++++++---------
 1 file changed, 22 insertions(+), 9 deletions(-)

diff --git a/fs/locks.c b/fs/locks.c
index eaf754ecdaa8..e74075b0e8ec 100644
--- a/fs/locks.c
+++ b/fs/locks.c
@@ -741,8 +741,9 @@ static void __locks_wake_up_blocks(struct file_lock *blocker)
 			wake_up(&waiter->fl_wait);
 
 		/*
-		 * Tell the world we're done with it - see comment at
-		 * top of locks_delete_block().
+		 * The setting of fl_blocker to NULL marks the official "done"
+		 * point in deleting a block. Paired with acquire at the top
+		 * of locks_delete_block().
 		 */
 		smp_store_release(&waiter->fl_blocker, NULL);
 	}
@@ -761,11 +762,23 @@ int locks_delete_block(struct file_lock *waiter)
 	/*
 	 * If fl_blocker is NULL, it won't be set again as this thread "owns"
 	 * the lock and is the only one that might try to claim the lock.
-	 * Because fl_blocker is explicitly set last during a delete, it's
-	 * safe to locklessly test to see if it's NULL. If it is, then we know
-	 * that no new locks can be inserted into its fl_blocked_requests list,
-	 * and we can therefore avoid doing anything further as long as that
-	 * list is empty.
+	 *
+	 * We use acquire/release to manage fl_blocker so that we can
+	 * optimize away taking the blocked_lock_lock in many cases.
+	 *
+	 * The smp_load_acquire guarantees two things:
+	 *
+	 * 1/ that fl_blocked_requests can be tested locklessly. If something
+	 * was recently added to that list it must have been in a locked region
+	 * *before* the locked region when fl_blocker was set to NULL.
+	 *
+	 * 2/ that no other thread is accessing 'waiter', so it is safe to free
+	 * it.  __locks_wake_up_blocks is careful not to touch waiter after
+	 * fl_blocker is released.
+	 *
+	 * If a lockless check of fl_blocker shows it to be NULL, we know that
+	 * no new locks can be inserted into its fl_blocked_requests list, and
+	 * can avoid doing anything further if the list is empty.
 	 */
 	if (!smp_load_acquire(&waiter->fl_blocker) &&
 	    list_empty(&waiter->fl_blocked_requests))
@@ -778,8 +791,8 @@ int locks_delete_block(struct file_lock *waiter)
 	__locks_delete_block(waiter);
 
 	/*
-	 * Tell the world we're done with it - see comment at top
-	 * of this function
+	 * The setting of fl_blocker to NULL marks the official "done" point in
+	 * deleting a block. Paired with acquire at the top of this function.
 	 */
 	smp_store_release(&waiter->fl_blocker, NULL);
 	spin_unlock(&blocked_lock_lock);
-- 
2.24.1