linux-kernel - Re: [PATCH v2] rcu: Fix description of kvfree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20211201143735.GE641268@paulmck-ThinkPad-P17-Gen-1>
Date:   Wed, 1 Dec 2021 06:37:35 -0800
From:   "Paul E. McKenney" <paulmck@...nel.org>
To:     "Uladzislau Rezki (Sony)" <urezki@...il.com>
Cc:     LKML <linux-kernel@...r.kernel.org>, RCU <rcu@...r.kernel.org>,
        Michal Hocko <mhocko@...e.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Daniel Axtens <dja@...ens.net>,
        Frederic Weisbecker <frederic@...nel.org>,
        Neeraj Upadhyay <neeraju@...eaurora.org>,
        Joel Fernandes <joel@...lfernandes.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        "Theodore Y . Ts'o" <tytso@....edu>,
        Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
        Oleksiy Avramchenko <oleksiy.avramchenko@...ymobile.com>,
        Steven Rostedt <rostedt@...dmis.org>
Subject: Re: [PATCH v2] rcu: Fix description of kvfree_rcu()

On Wed, Dec 01, 2021 at 10:20:53AM +0100, Uladzislau Rezki (Sony) wrote:
> The passed "ptr" parameter might be wrongly interpreted
> therefore rephrase it to prevent people from being confused.
> 
> Reported-by: Steven Rostedt <rostedt@...dmis.org>
> Signed-off-by: Uladzislau Rezki (Sony) <urezki@...il.com>

Thank you both!  Queued with wordsmithed commit log as shown below,
so please check to see if I messed anything up.

							Thanx, Paul

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

commit 59ef229194204b023bb7bde95ce769d4e94a4b62
Author: Uladzislau Rezki (Sony) <urezki@...il.com>
Date:   Wed Dec 1 10:20:53 2021 +0100

    rcu: Fix description of kvfree_rcu()
    
    The kvfree_rcu() header comment's description of the "ptr" parameter
    is unclear, therefore rephrase it to make it clear that it is a pointer
    to the memory to eventually be passed to kvfree().
    
    Reported-by: Steven Rostedt <rostedt@...dmis.org>
    Signed-off-by: Uladzislau Rezki (Sony) <urezki@...il.com>
    Signed-off-by: Paul E. McKenney <paulmck@...nel.org>

diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
index 88b42eb464068..9d7df8d36af07 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -924,7 +924,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
  *
  *     kvfree_rcu(ptr);
  *
- * where @ptr is a pointer to kvfree().
+ * where @ptr is the pointer to be freed by kvfree().
  *
  * Please note, head-less way of freeing is permitted to
  * use from a context that has to follow might_sleep()