Re: [PATCH v1 5/5] kvfree_rcu: Fix comments according to current code

["Paul E. McKenney" <paulmck@kernel.org>]

On Wed, Apr 28, 2021 at 03:44:22PM +0200, Uladzislau Rezki (Sony) wrote:
> We used to have an "emergency path" and comments related
> to it. According to current kvfree_rcu() design that path
> is not considered as emergency anymore.
> 
> This patch rephrases and updates comments regarding this.
> 
> Signed-off-by: Uladzislau Rezki (Sony) <urezki@gmail.com>

Queued as follows, thank you!  Please check my usual wordsmithing to
make sure that I did not mess anything up.

							Thanx, Paul

------------------------------------------------------------------------

commit 06c2113c4b1ce9ded69cd0ac4da9a00ed6be8834
Author: Uladzislau Rezki (Sony) <urezki@gmail.com>
Date:   Wed Apr 28 15:44:22 2021 +0200

    kvfree_rcu: Fix comments according to current code
    
    The kvfree_rcu() function now defers allocations in the common
    case due to the fact that there is no lockless access to the
    memory-allocator caches/pools.  In addition, in CONFIG_PREEMPT_NONE=y
    and in CONFIG_PREEMPT_VOLUNTARY=y kernels, there is no reliable way to
    determine if spinlocks are held.  As a result, allocation is deferred in
    the common case, and the two-argument form of kvfree_rcu() thus uses the
    "channel 3" queue through all the rcu_head structures.  This channel
    is called referred to as the emergency case in comments, and these
    comments are now obsolete.
    
    This commit therefore updates these comments to reflect the new
    common-case nature of such emergencies.
    
    Signed-off-by: Uladzislau Rezki (Sony) <urezki@gmail.com>
    Signed-off-by: Paul E. McKenney <paulmck@kernel.org>

diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 9089c23e80dc..4d93c6985d3f 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -3338,9 +3338,11 @@ static void kfree_rcu_work(struct work_struct *work)
 	}
 
 	/*
-	 * Emergency case only. It can happen under low memory
-	 * condition when an allocation gets failed, so the "bulk"
-	 * path can not be temporary maintained.
+	 * This is used when the "bulk" path can not be used for the
+	 * double-argument of kvfree_rcu().  This happens when the
+	 * page-cache is empty, which means that objects are instead
+	 * queued on a linked list through their rcu_head structures.
+	 * This list is named "Channel 3".
 	 */
 	for (; head; head = next) {
 		unsigned long offset = (unsigned long)head->func;
@@ -3386,8 +3388,8 @@ static inline bool queue_kfree_rcu_work(struct kfree_rcu_cpu *krcp)
 		if ((krcp->bkvhead[0] && !krwp->bkvhead_free[0]) ||
 			(krcp->bkvhead[1] && !krwp->bkvhead_free[1]) ||
 				(krcp->head && !krwp->head_free)) {
-			// Channel 1 corresponds to SLAB ptrs.
-			// Channel 2 corresponds to vmalloc ptrs.
+			// Channel 1 corresponds to the SLAB-pointer bulk path.
+			// Channel 2 corresponds to vmalloc-pointer bulk path.
 			for (j = 0; j < FREE_N_CHANNELS; j++) {
 				if (!krwp->bkvhead_free[j]) {
 					krwp->bkvhead_free[j] = krcp->bkvhead[j];
@@ -3395,7 +3397,8 @@ static inline bool queue_kfree_rcu_work(struct kfree_rcu_cpu *krcp)
 				}
 			}
 
-			// Channel 3 corresponds to emergency path.
+			// Channel 3 corresponds to both SLAB and vmalloc
+			// objects queued on the linked list.
 			if (!krwp->head_free) {
 				krwp->head_free = krcp->head;
 				krcp->head = NULL;