Skip to contentSkip to conversation

f2fs: protect gc task pointer during teardown

PATCH Superseded Zhang Cen 2 participants 3 messages Jun 30 F2FS file system

v6 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Zhang Cen

author
#0 lore raw

PATCH v6 1/1 f2fs: protect gc task pointer during teardown

This patch is based on the preceding patch "f2fs: embed f2fs_gc_kthread in f2fs_sb_info", which gives the GC waitqueues and thread tunables superblock lifetime. With that container lifetime fixed, f2fs_gc_task remains the running-state marker and the task_struct pointer that needs separate lifetime protection.

During shutdown, f2fs_stop_gc_thread() stops the GC task and wakes GC_MERGE foreground waiters while f2fs_balance_fs() can concurrently queue on gc_th->fggc_wq. The preceding embedded-gc_thread patch keeps that waitqueue storage alive for the superblock lifetime; this patch protects the remaining f2fs_gc_task pointer by publishing and detaching it under gc_task_lock, and by taking a task_struct reference for sysfs users that dereference the task.

The buggy scenario involves two paths, with each column showing the order within that path:

foreground f2fs_balance_fs() caller: shutdown path:
1. observes no checkpoint error 1. sets CP_ERROR_FLAG

  2. snapshots sbi->gc_thread           2. enters f2fs_stop_gc_thread()
  3. queues on gc_th->fggc_wq           3. stops gc_th->f2fs_gc_task
  4. wakes gc_wait_queue_head           4. wakes gc_th->fggc_wq
  5. sleeps for foreground GC           5. frees gc_th in the old layout

6. finish_wait() touches fggc_wq

GC_MERGE does not keep independent work_struct items that shutdown can cancel. Its pending foreground GC requests are waitqueue waiters. Drain them by withdrawing the GC task pointer, stopping the task, waking gc_th->fggc_wq, and leaving each waiter to remove its own wait entry with finish_wait().

Add gc_task_lock to struct f2fs_gc_kthread and use it to publish the GC task only after the new kthread has been created and its nice value has been set. The start path uses kthread_create() so the task is not woken until after f2fs_gc_task is visible to waiters. The stop path detaches f2fs_gc_task under the same lock before kthread_stop(), so later readers see that no new foreground GC work should be handed to the background thread.

f2fs_balance_fs() also rechecks both f2fs_cp_error() and f2fs_gc_task after prepare_to_wait(). If shutdown is visible or the GC task has already been withdrawn, the caller removes its wait entry without waking the GC thread or sleeping for new foreground GC work. Thus shutdown drains already queued waiters and stops accepting new foreground GC work once shutdown is visible to the caller.

Task pointer users are protected separately from the embedded container lifetime. A sysfs critical_task_priority store now snapshots the GC task under gc_task_lock and holds a task_struct reference while calling set_user_nice(). Boolean running-state checks that do not dereference the task_struct continue to use READ_ONCE().

One observed report was:

BUG: KASAN: slab-use-after-free in finish_wait+0x276/0x290
Write of size 8 at addr ffff8881150819b8 by task dd/802
The buggy address belongs to the object at ffff888115081900 which
belongs to the cache kmalloc-256 of size 256
The buggy address is located 184 bytes inside of freed 256-byte region
Call trace:
  finish_wait()
  f2fs_balance_fs()
  f2fs_write_single_data_page()
  f2fs_write_cache_pages()
  __f2fs_write_data_pages()
  do_writepages()
  filemap_fdatawrite_wbc()
  __filemap_fdatawrite_range()
  file_write_and_wait_range()
  f2fs_do_sync_file()
  f2fs_sync_file()
  do_fsync()
Freed by task stack:
  kfree()
  f2fs_stop_gc_thread()
  f2fs_do_shutdown()
  f2fs_shutdown()
  fs_bdev_mark_dead()
Fixes 5911d2d1d1a3 ("f2fs: introduce gc_merge mount option")
Assisted-by Codex:gpt-5.5

---
Based on:
- [PATCH] f2fs: embed f2fs_gc_kthread in f2fs_sb_info

 fs/f2fs/f2fs.h    | 37 +++++++++++++++++++++++++++++++++++++
 fs/f2fs/gc.c      | 12 ++++++++----
 fs/f2fs/segment.c |  2 +-
 fs/f2fs/super.c   |  1 +
 fs/f2fs/sysfs.c   |  6 ++++--
 5 files changed, 51 insertions(+), 7 deletions(-)
fs/f2fs/f2fs.h +37 -0
index 9ab196f65643..931d37f64bb3 100644
@@ -17,8 +17,10 @@
 #include <linux/magic.h>
 #include <linux/kobject.h>
 #include <linux/sched.h>
+#include <linux/sched/task.h>
 #include <linux/cred.h>
 #include <linux/sched/mm.h>
+#include <linux/spinlock.h>
 #include <linux/vmalloc.h>
 #include <linux/bio.h>
 #include <linux/blkdev.h>
@@ -430,6 +432,7 @@ struct ckpt_req_control {
 
 struct f2fs_gc_kthread {
 	struct task_struct *f2fs_gc_task;
+	spinlock_t gc_task_lock;		/* protects f2fs_gc_task */
 	wait_queue_head_t gc_wait_queue_head;
 
 	/* for gc sleep time */
@@ -455,6 +458,40 @@ struct f2fs_gc_kthread {
 	unsigned int boost_gc_greedy;
 };
 
+static inline struct task_struct *f2fs_get_gc_task(struct f2fs_gc_kthread *gc_th)
+{
+	struct task_struct *task;
+
+	spin_lock(&gc_th->gc_task_lock);
+	task = READ_ONCE(gc_th->f2fs_gc_task);
+	if (task)
+		get_task_struct(task);
+	spin_unlock(&gc_th->gc_task_lock);
+
+	return task;
+}
+
+static inline void f2fs_set_gc_task(struct f2fs_gc_kthread *gc_th,
+				    struct task_struct *task)
+{
+	spin_lock(&gc_th->gc_task_lock);
+	WRITE_ONCE(gc_th->f2fs_gc_task, task);
+	spin_unlock(&gc_th->gc_task_lock);
+}
+
+static inline struct task_struct *
+f2fs_detach_gc_task(struct f2fs_gc_kthread *gc_th)
+{
+	struct task_struct *task;
+
+	spin_lock(&gc_th->gc_task_lock);
+	task = READ_ONCE(gc_th->f2fs_gc_task);
+	WRITE_ONCE(gc_th->f2fs_gc_task, NULL);
+	spin_unlock(&gc_th->gc_task_lock);
+
+	return task;
+}
+
 /* a time threshold that checkpoint was blocked for, unit: ms */
 #define CP_LONG_LATENCY_THRESHOLD	5000
 
fs/f2fs/gc.c +8 -4
index 5a98754354b6..c26fcaffa986 100644
@@ -197,6 +197,9 @@ int f2fs_start_gc_thread(struct f2fs_sb_info *sbi)
 	struct task_struct *task;
 	dev_t dev = sbi->sb->s_bdev->bd_dev;
 
+	if (READ_ONCE(gc_th->f2fs_gc_task))
+		return 0;
+
 	gc_th->urgent_sleep_time = DEF_GC_THREAD_URGENT_SLEEP_TIME;
 	gc_th->valid_thresh_ratio = DEF_GC_THREAD_VALID_THRESH_RATIO;
 	gc_th->boost_gc_multiple = BOOST_GC_MULTIPLE;
@@ -218,16 +221,17 @@ int f2fs_start_gc_thread(struct f2fs_sb_info *sbi)
 
 	gc_th->gc_wake = false;
 
-	task = kthread_run(gc_thread_func, sbi, "f2fs_gc-%u:%u",
-			   MAJOR(dev), MINOR(dev));
+	task = kthread_create(gc_thread_func, sbi, "f2fs_gc-%u:%u",
+			      MAJOR(dev), MINOR(dev));
 	if (IS_ERR(task)) {
 		int err = PTR_ERR(task);
 
 		return err;
 	}
 
-	WRITE_ONCE(gc_th->f2fs_gc_task, task);
 	set_user_nice(task, PRIO_TO_NICE(sbi->critical_task_priority));
+	f2fs_set_gc_task(gc_th, task);
+	wake_up_process(task);
 	return 0;
 }
 
@@ -236,7 +240,7 @@ void f2fs_stop_gc_thread(struct f2fs_sb_info *sbi)
 	struct f2fs_gc_kthread *gc_th = &sbi->gc_thread;
 	struct task_struct *task;
 
-	task = xchg(&gc_th->f2fs_gc_task, NULL);
+	task = f2fs_detach_gc_task(gc_th);
 	if (!task)
 		return;
 	kthread_stop(task);
fs/f2fs/segment.c +1 -1
index 877b015e24cd..aeda8351398f 100644
@@ -451,7 +451,7 @@ void f2fs_balance_fs(struct f2fs_sb_info *sbi, bool need)
 
 		prepare_to_wait(&gc_th->fggc_wq, &wait,
 				TASK_UNINTERRUPTIBLE);
-		if (READ_ONCE(gc_th->f2fs_gc_task)) {
+		if (!f2fs_cp_error(sbi) && READ_ONCE(gc_th->f2fs_gc_task)) {
 			wake_up(&gc_th->gc_wait_queue_head);
 			io_schedule();
 		}
fs/f2fs/super.c +1 -0
index ec44c5be8ca0..ed1ce1266ce4 100644
@@ -4993,6 +4993,7 @@ static int f2fs_fill_super(struct super_block *sb, struct fs_context *fc)
 		spin_lock_init(&sbi->inode_lock[i]);
 	}
 	mutex_init(&sbi->flush_lock);
+	spin_lock_init(&sbi->gc_thread.gc_task_lock);
 	init_waitqueue_head(&sbi->gc_thread.gc_wait_queue_head);
 	init_waitqueue_head(&sbi->gc_thread.fggc_wq);
 
fs/f2fs/sysfs.c +4 -2
index 705563dfc560..87aa348f2a2b 100644
@@ -996,9 +996,11 @@ static ssize_t __sbi_store(struct f2fs_attr *a,
 		nice = PRIO_TO_NICE(sbi->critical_task_priority);
 		if (sbi->cprc_info.f2fs_issue_ckpt)
 			set_user_nice(sbi->cprc_info.f2fs_issue_ckpt, nice);
-		gc_task = READ_ONCE(sbi->gc_thread.f2fs_gc_task);
-		if (gc_task)
+		gc_task = f2fs_get_gc_task(&sbi->gc_thread);
+		if (gc_task) {
 			set_user_nice(gc_task, nice);
+			put_task_struct(gc_task);
+		}
 		return count;
 	}
 
Signature · 1 line
2.43.0
maintainer
#1 lore raw
Quoted 143 lines · Zhang Cen

This patch is based on the preceding patch "f2fs: embed f2fs_gc_kthread in f2fs_sb_info", which gives the GC waitqueues and thread tunables superblock lifetime. With that container lifetime fixed, f2fs_gc_task remains the running-state marker and the task_struct pointer that needs separate lifetime protection.

During shutdown, f2fs_stop_gc_thread() stops the GC task and wakes GC_MERGE foreground waiters while f2fs_balance_fs() can concurrently queue on gc_th->fggc_wq. The preceding embedded-gc_thread patch keeps that waitqueue storage alive for the superblock lifetime; this patch protects the remaining f2fs_gc_task pointer by publishing and detaching it under gc_task_lock, and by taking a task_struct reference for sysfs users that dereference the task.

The buggy scenario involves two paths, with each column showing the order within that path:

foreground f2fs_balance_fs() caller: shutdown path:
1. observes no checkpoint error 1. sets CP_ERROR_FLAG

  2. snapshots sbi->gc_thread           2. enters f2fs_stop_gc_thread()
  3. queues on gc_th->fggc_wq           3. stops gc_th->f2fs_gc_task
  4. wakes gc_wait_queue_head           4. wakes gc_th->fggc_wq
  5. sleeps for foreground GC           5. frees gc_th in the old layout

6. finish_wait() touches fggc_wq

GC_MERGE does not keep independent work_struct items that shutdown can cancel. Its pending foreground GC requests are waitqueue waiters. Drain them by withdrawing the GC task pointer, stopping the task, waking gc_th->fggc_wq, and leaving each waiter to remove its own wait entry with finish_wait().

Add gc_task_lock to struct f2fs_gc_kthread and use it to publish the GC task only after the new kthread has been created and its nice value has been set. The start path uses kthread_create() so the task is not woken until after f2fs_gc_task is visible to waiters. The stop path detaches f2fs_gc_task under the same lock before kthread_stop(), so later readers see that no new foreground GC work should be handed to the background thread.

f2fs_balance_fs() also rechecks both f2fs_cp_error() and f2fs_gc_task after prepare_to_wait(). If shutdown is visible or the GC task has already been withdrawn, the caller removes its wait entry without waking the GC thread or sleeping for new foreground GC work. Thus shutdown drains already queued waiters and stops accepting new foreground GC work once shutdown is visible to the caller.

Task pointer users are protected separately from the embedded container lifetime. A sysfs critical_task_priority store now snapshots the GC task under gc_task_lock and holds a task_struct reference while calling set_user_nice(). Boolean running-state checks that do not dereference the task_struct continue to use READ_ONCE().

One observed report was:

BUG: KASAN: slab-use-after-free in finish_wait+0x276/0x290
Write of size 8 at addr ffff8881150819b8 by task dd/802
The buggy address belongs to the object at ffff888115081900 which
belongs to the cache kmalloc-256 of size 256
The buggy address is located 184 bytes inside of freed 256-byte region
Call trace:
  finish_wait()
  f2fs_balance_fs()
  f2fs_write_single_data_page()
  f2fs_write_cache_pages()
  __f2fs_write_data_pages()
  do_writepages()
  filemap_fdatawrite_wbc()
  __filemap_fdatawrite_range()
  file_write_and_wait_range()
  f2fs_do_sync_file()
  f2fs_sync_file()
  do_fsync()
Freed by task stack:
  kfree()
  f2fs_stop_gc_thread()
  f2fs_do_shutdown()
  f2fs_shutdown()
  fs_bdev_mark_dead()
Fixes 5911d2d1d1a3 ("f2fs: introduce gc_merge mount option")
Assisted-by Codex:gpt-5.5

---
Based on:
- [PATCH] f2fs: embed f2fs_gc_kthread in f2fs_sb_info

 fs/f2fs/f2fs.h    | 37 +++++++++++++++++++++++++++++++++++++
 fs/f2fs/gc.c      | 12 ++++++++----
 fs/f2fs/segment.c |  2 +-
 fs/f2fs/super.c   |  1 +
 fs/f2fs/sysfs.c   |  6 ++++--
 5 files changed, 51 insertions(+), 7 deletions(-)
fs/f2fs/f2fs.h +26 -0
index 9ab196f65643..931d37f64bb3 100644
@@ -17,8 +17,10 @@
 #include <linux/magic.h>
 #include <linux/kobject.h>
 #include <linux/sched.h>
+#include <linux/sched/task.h>
 #include <linux/cred.h>
 #include <linux/sched/mm.h>
+#include <linux/spinlock.h>
 #include <linux/vmalloc.h>
 #include <linux/bio.h>
 #include <linux/blkdev.h>
@@ -430,6 +432,7 @@ struct ckpt_req_control {
 
 struct f2fs_gc_kthread {
 	struct task_struct *f2fs_gc_task;
+	spinlock_t gc_task_lock;		/* protects f2fs_gc_task */
 	wait_queue_head_t gc_wait_queue_head;
 
 	/* for gc sleep time */
@@ -455,6 +458,40 @@ struct f2fs_gc_kthread {
 	unsigned int boost_gc_greedy;
 };
 
+static inline struct task_struct *f2fs_get_gc_task(struct f2fs_gc_kthread *gc_th)
+{
+	struct task_struct *task;
+
+	spin_lock(&gc_th->gc_task_lock);
+	task = READ_ONCE(gc_th->f2fs_gc_task);
+	if (task)
+		get_task_struct(task);
+	spin_unlock(&gc_th->gc_task_lock);
+
+	return task;
+}
+
+static inline void f2fs_set_gc_task(struct f2fs_gc_kthread *gc_th,
+				    struct task_struct *task)
+{
+	spin_lock(&gc_th->gc_task_lock);
+	WRITE_ONCE(gc_th->f2fs_gc_task, task);
+	spin_unlock(&gc_th->gc_task_lock);
+}
+
+static inline struct task_struct *
+f2fs_detach_gc_task(struct f2fs_gc_kthread *gc_th)

fs/f2fs/f2fs.h struct f2fs_gc_kthread { · line 493

Quoted 10 lines
fs/f2fs/f2fs.h +10 -0
+{
+	struct task_struct *task;
+
+	spin_lock(&gc_th->gc_task_lock);
+	task = READ_ONCE(gc_th->f2fs_gc_task);
+	WRITE_ONCE(gc_th->f2fs_gc_task, NULL);
+	spin_unlock(&gc_th->gc_task_lock);
+
+	return task;
+}

How about introduce f2fs_update_gc_task()?

attach w/ f2fs_update_gc_task(, task), deattch w/ f2fs_update_gc_task(, NULL)?

Quoted 9 lines
fs/f2fs/f2fs.h +1 -0
+
 /* a time threshold that checkpoint was blocked for, unit: ms */
 #define CP_LONG_LATENCY_THRESHOLD	5000
 
fs/f2fs/gc.c +0 -0
index 5a98754354b6..c26fcaffa986 100644

fs/f2fs/gc.c int f2fs_start_gc_thread(struct f2fs_sb_info *sbi) · line 201

Quoted 5 lines
fs/f2fs/gc.c +2 -0
@@ -197,6 +197,9 @@ int f2fs_start_gc_thread(struct f2fs_sb_info *sbi)
 	struct task_struct *task;
 	dev_t dev = sbi->sb->s_bdev->bd_dev;
 
+	if (READ_ONCE(gc_th->f2fs_gc_task))
+		return 0;

Why we need to check this?

Quoted 26 lines
fs/f2fs/gc.c +5 -3
+
 	gc_th->urgent_sleep_time = DEF_GC_THREAD_URGENT_SLEEP_TIME;
 	gc_th->valid_thresh_ratio = DEF_GC_THREAD_VALID_THRESH_RATIO;
 	gc_th->boost_gc_multiple = BOOST_GC_MULTIPLE;
@@ -218,16 +221,17 @@ int f2fs_start_gc_thread(struct f2fs_sb_info *sbi)
 
 	gc_th->gc_wake = false;
 
-	task = kthread_run(gc_thread_func, sbi, "f2fs_gc-%u:%u",
-			   MAJOR(dev), MINOR(dev));
+	task = kthread_create(gc_thread_func, sbi, "f2fs_gc-%u:%u",
+			      MAJOR(dev), MINOR(dev));
 	if (IS_ERR(task)) {
 		int err = PTR_ERR(task);
 
 		return err;
 	}
 
-	WRITE_ONCE(gc_th->f2fs_gc_task, task);
 	set_user_nice(task, PRIO_TO_NICE(sbi->critical_task_priority));
+	f2fs_set_gc_task(gc_th, task);
+	wake_up_process(task);
 	return 0;
 }
 

fs/f2fs/gc.c void f2fs_stop_gc_thread(struct f2fs_sb_info *sbi) · line 239

Quoted 4 lines
fs/f2fs/gc.c +0 -1
@@ -236,7 +240,7 @@ void f2fs_stop_gc_thread(struct f2fs_sb_info *sbi)
 	struct f2fs_gc_kthread *gc_th = &sbi->gc_thread;
 	struct task_struct *task;
 
-	task = xchg(&gc_th->f2fs_gc_task, NULL);

I don't see this line in anywhere.

Quoted 9 lines
fs/f2fs/gc.c +1 -0
+	task = f2fs_detach_gc_task(gc_th);
 	if (!task)
 		return;
 	kthread_stop(task);
fs/f2fs/segment.c +0 -0
index 877b015e24cd..aeda8351398f 100644

fs/f2fs/segment.c void f2fs_balance_fs(struct f2fs_sb_info *sbi, bool need) · line 454

Quoted 5 lines
fs/f2fs/segment.c +1 -1
@@ -451,7 +451,7 @@ void f2fs_balance_fs(struct f2fs_sb_info *sbi, bool need)
 
 		prepare_to_wait(&gc_th->fggc_wq, &wait,
 				TASK_UNINTERRUPTIBLE);
-		if (READ_ONCE(gc_th->f2fs_gc_task)) {
+		if (!f2fs_cp_error(sbi) && READ_ONCE(gc_th->f2fs_gc_task)) {

It's a corner case, I guess we can skip to check cp_error.

Quoted 20 lines
fs/f2fs/segment.c +0 -0
 			wake_up(&gc_th->gc_wait_queue_head);
 			io_schedule();
 		}
fs/f2fs/super.c +1 -0
index ec44c5be8ca0..ed1ce1266ce4 100644
@@ -4993,6 +4993,7 @@ static int f2fs_fill_super(struct super_block *sb, struct fs_context *fc)
 		spin_lock_init(&sbi->inode_lock[i]);
 	}
 	mutex_init(&sbi->flush_lock);
+	spin_lock_init(&sbi->gc_thread.gc_task_lock);
 	init_waitqueue_head(&sbi->gc_thread.gc_wait_queue_head);
 	init_waitqueue_head(&sbi->gc_thread.fggc_wq);
 
fs/f2fs/sysfs.c +0 -0
index 705563dfc560..87aa348f2a2b 100644

fs/f2fs/sysfs.c static ssize_t __sbi_store(struct f2fs_attr *a, · line 1000

Quoted 7 lines
fs/f2fs/sysfs.c +2 -2
@@ -996,9 +996,11 @@ static ssize_t __sbi_store(struct f2fs_attr *a,
 		nice = PRIO_TO_NICE(sbi->critical_task_priority);
 		if (sbi->cprc_info.f2fs_issue_ckpt)
 			set_user_nice(sbi->cprc_info.f2fs_issue_ckpt, nice);
-		gc_task = READ_ONCE(sbi->gc_thread.f2fs_gc_task);
-		if (gc_task)
+		gc_task = f2fs_get_gc_task(&sbi->gc_thread);
+		if (gc_task) {

Can we do like this?

__sbi_store()

spin_lock
check f2fs_gc_task
set_user_nice
spin_unlock

Thanks,

Quoted 6 lines
fs/f2fs/sysfs.c +2 -0
 			set_user_nice(gc_task, nice);
+			put_task_struct(gc_task);
+		}
 		return count;
 	}
 
author
#2 lore raw

Hi, Chao

Thanks a lot for your patient review and detailed suggestions.

Quoted 3 lines

How about introduce f2fs_update_gc_task()?

attach w/ f2fs_update_gc_task(, task), deattch w/ f2fs_update_gc_task(, NULL)?

I will introduce f2fs_update_gc_task(gc_th, task). The start path uses f2fs_update_gc_task(gc_th, task), and the stop path uses f2fs_update_gc_task(gc_th, NULL).

Quoted 4 lines
fs/f2fs/gc.c +2 -0
+     if (READ_ONCE(gc_th->f2fs_gc_task))
+             return 0;

Why we need to check this?

Thanks, this check is unnecessary. I removed it.

Quoted 3 lines

- task = xchg(&gc_th->f2fs_gc_task, NULL);

I don't see this line in anywhere.

Sorry, this came from my local prerequisite tree, I will rebase the change onto right commit.

Quoted 3 lines

+ if (!f2fs_cp_error(sbi) && READ_ONCE(gc_th->f2fs_gc_task)) {

It's a corner case, I guess we can skip to check cp_error.

Agreed. I removed the added f2fs_cp_error() check and kept only the f2fs_gc_task recheck after prepare_to_wait().

Quoted 8 lines

Can we do like this?

__sbi_store()

spin_lock
check f2fs_gc_task
set_user_nice
spin_unlock

Yes, will updated it this way.

I'll send v7 soon.

Thanks again.

Best regards,
Zhang Cen