Skip to contentSkip to conversation

mm/slab: trivial fixup for SLAB_TYPESAFE_BY_RCU example code snippet

PATCH Superseded SeongJae Park 2 participants 6 messages Apr 15, 2023

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

cover mm/slab: trivial fixup for SLAB_TYPESAFE_BY_RCU example code snippet

This patchset is for trivial fixup for SLAB_TYPESAFE_BY_RCU example code snippet, namely adding missed semicolon and breaking RCU read-side critical section into smaller ones.

SeongJae Park (2):
mm/slab: add a missing semicolon on SLAB_TYPESAFE_BY_RCU example code mm/slab: break up RCU readers on SLAB_TYPESAFE_BY_RCU example code

 include/linux/slab.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/2 mm/slab: add a missing semicolon on SLAB_TYPESAFE_BY_RCU example code

An example code snippet for SLAB_TYPESAFE_BY_RCU is missing a semicolon. Add it.

---
 include/linux/slab.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/slab.h +1 -1
index f8b1d63c63a3..b18e56c6f06c 100644
@@ -53,7 +53,7 @@
  * stays valid, the trick to using this is relying on an independent
  * object validation pass. Something like:
  *
- *  rcu_read_lock()
+ *  rcu_read_lock();
  * again:
  *  obj = lockless_lookup(key);
  *  if (obj) {
Signature · 1 line
2.25.1
#2 lore raw

PATCH 2/2 mm/slab: break up RCU readers on SLAB_TYPESAFE_BY_RCU example code

In reply to SeongJae Park

The SLAB_TYPESAFE_BY_RCU example code snippet is having not tiny RCU read-side critical section. 'Documentation/RCU/rculist_nulls.rst' has similar example code snippet, and commit da82af04352b ("doc: Update and wordsmith rculist_nulls.rst") has broken it. Apply the change to SLAB_TYPESAFE_BY_RCU example code snippet, too.

---
 include/linux/slab.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
include/linux/slab.h +3 -2
index b18e56c6f06c..a2fd57322c9c 100644
@@ -53,15 +53,16 @@
  * stays valid, the trick to using this is relying on an independent
  * object validation pass. Something like:
  *
+ * begin:
  *  rcu_read_lock();
- * again:
  *  obj = lockless_lookup(key);
  *  if (obj) {
  *    if (!try_get_ref(obj)) // might fail for free objects
- *      goto again;
+ *      goto begin;
  *
  *    if (obj->key != key) { // not the object we expected
  *      put_ref(obj);
+ *      rcu_read_unlock();
  *      goto again;
  *    }
  *  }
Signature · 1 line
2.25.1
#3 lore raw

Re: [PATCH 2/2] mm/slab: break up RCU readers on SLAB_TYPESAFE_BY_RCU example code

Quoted 11 lines · SeongJae Park

*
+ * begin:
* rcu_read_lock();
- * again:
* obj = lockless_lookup(key);
* if (obj) {
* if (!try_get_ref(obj)) // might fail for free objects
- * goto again;
+ * goto begin;
*
* if (obj->key != key) { // not the object we expected

Quoted 3 lines
  *      put_ref(obj);
+ *      rcu_read_unlock();
  *      goto again;

- * goto again;
+ * goto begin;

#4 lore raw

Re: [PATCH 2/2] mm/slab: break up RCU readers on SLAB_TYPESAFE_BY_RCU example code

Quoted 16 lines · On Sat, 15 Apr 2023 03:51:54 +0100 Matthew Wilcox <[email protected]> wrote:
Quoted 11 lines · SeongJae Park

*
+ * begin:
* rcu_read_lock();
- * again:
* obj = lockless_lookup(key);
* if (obj) {
* if (!try_get_ref(obj)) // might fail for free objects
- * goto again;
+ * goto begin;
*
* if (obj->key != key) { // not the object we expected

Quoted 3 lines
  *      put_ref(obj);
+ *      rcu_read_unlock();
  *      goto again;
Quoted 2 lines

- * goto again;
+ * goto begin;

Oops, thank you for catching, Matthew!

Thanks,
SJ

#5 lore raw

Re: [PATCH 2/2] mm/slab: break up RCU readers on SLAB_TYPESAFE_BY_RCU example code

Quoted 12 lines · On Sat, 15 Apr 2023 03:04:52 +0000 SeongJae Park <[email protected]> wrote:
Quoted 10 lines · On Sat, 15 Apr 2023 03:51:54 +0100 Matthew Wilcox <[email protected]> wrote:
Quoted 9 lines · SeongJae Park

*
+ * begin:
* rcu_read_lock();
- * again:
* obj = lockless_lookup(key);
* if (obj) {
* if (!try_get_ref(obj)) // might fail for free objects
- * goto again;
+ * goto begin;

I simply followed the commit da82af04352b ("doc: Update and wordsmith rculist_nulls.rst") for this change, and I think I overlooked this part. If I'm not missing something, I think we should call rcu_read_unlock() here too, just before 'goto begin'.

I will post another patch for rculist_null.rst later.

Thanks,
SJ

Quoted 14 lines
Quoted 8 lines
Quoted 5 lines

*
* if (obj->key != key) { // not the object we expected

  *      put_ref(obj);
+ *      rcu_read_unlock();
  *      goto again;

- * goto again;
+ * goto begin;

Oops, thank you for catching, Matthew!

Thanks,
SJ