4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/module.h>
13 #include <linux/backing-dev.h>
14 #include <linux/init.h>
15 #include <linux/f2fs_fs.h>
16 #include <linux/kthread.h>
17 #include <linux/delay.h>
18 #include <linux/freezer.h>
19 #include <linux/blkdev.h>
25 #include <trace/events/f2fs.h>
27 static struct kmem_cache *winode_slab;
29 static int gc_thread_func(void *data)
31 struct f2fs_sb_info *sbi = data;
32 struct f2fs_gc_kthread *gc_th = sbi->gc_thread;
33 wait_queue_head_t *wq = &sbi->gc_thread->gc_wait_queue_head;
36 wait_ms = gc_th->min_sleep_time;
42 wait_event_interruptible_timeout(*wq,
43 kthread_should_stop(),
44 msecs_to_jiffies(wait_ms));
45 if (kthread_should_stop())
48 if (sbi->sb->s_writers.frozen >= SB_FREEZE_WRITE) {
49 wait_ms = increase_sleep_time(gc_th, wait_ms);
54 * [GC triggering condition]
55 * 0. GC is not conducted currently.
56 * 1. There are enough dirty segments.
57 * 2. IO subsystem is idle by checking the # of writeback pages.
58 * 3. IO subsystem is idle by checking the # of requests in
59 * bdev's request list.
61 * Note) We have to avoid triggering GCs too much frequently.
62 * Because it is possible that some segments can be
63 * invalidated soon after by user update or deletion.
64 * So, I'd like to wait some time to collect dirty segments.
66 if (!mutex_trylock(&sbi->gc_mutex))
70 wait_ms = increase_sleep_time(gc_th, wait_ms);
71 mutex_unlock(&sbi->gc_mutex);
75 if (has_enough_invalid_blocks(sbi))
76 wait_ms = decrease_sleep_time(gc_th, wait_ms);
78 wait_ms = increase_sleep_time(gc_th, wait_ms);
80 #ifdef CONFIG_F2FS_STAT_FS
84 /* if return value is not zero, no victim was selected */
86 wait_ms = gc_th->no_gc_sleep_time;
87 } while (!kthread_should_stop());
91 int start_gc_thread(struct f2fs_sb_info *sbi)
93 struct f2fs_gc_kthread *gc_th;
94 dev_t dev = sbi->sb->s_bdev->bd_dev;
97 if (!test_opt(sbi, BG_GC))
99 gc_th = kmalloc(sizeof(struct f2fs_gc_kthread), GFP_KERNEL);
105 gc_th->min_sleep_time = DEF_GC_THREAD_MIN_SLEEP_TIME;
106 gc_th->max_sleep_time = DEF_GC_THREAD_MAX_SLEEP_TIME;
107 gc_th->no_gc_sleep_time = DEF_GC_THREAD_NOGC_SLEEP_TIME;
109 sbi->gc_thread = gc_th;
110 init_waitqueue_head(&sbi->gc_thread->gc_wait_queue_head);
111 sbi->gc_thread->f2fs_gc_task = kthread_run(gc_thread_func, sbi,
112 "f2fs_gc-%u:%u", MAJOR(dev), MINOR(dev));
113 if (IS_ERR(gc_th->f2fs_gc_task)) {
114 err = PTR_ERR(gc_th->f2fs_gc_task);
116 sbi->gc_thread = NULL;
123 void stop_gc_thread(struct f2fs_sb_info *sbi)
125 struct f2fs_gc_kthread *gc_th = sbi->gc_thread;
128 kthread_stop(gc_th->f2fs_gc_task);
130 sbi->gc_thread = NULL;
133 static int select_gc_type(int gc_type)
135 return (gc_type == BG_GC) ? GC_CB : GC_GREEDY;
138 static void select_policy(struct f2fs_sb_info *sbi, int gc_type,
139 int type, struct victim_sel_policy *p)
141 struct dirty_seglist_info *dirty_i = DIRTY_I(sbi);
143 if (p->alloc_mode == SSR) {
144 p->gc_mode = GC_GREEDY;
145 p->dirty_segmap = dirty_i->dirty_segmap[type];
148 p->gc_mode = select_gc_type(gc_type);
149 p->dirty_segmap = dirty_i->dirty_segmap[DIRTY];
150 p->ofs_unit = sbi->segs_per_sec;
152 p->offset = sbi->last_victim[p->gc_mode];
155 static unsigned int get_max_cost(struct f2fs_sb_info *sbi,
156 struct victim_sel_policy *p)
158 /* SSR allocates in a segment unit */
159 if (p->alloc_mode == SSR)
160 return 1 << sbi->log_blocks_per_seg;
161 if (p->gc_mode == GC_GREEDY)
162 return (1 << sbi->log_blocks_per_seg) * p->ofs_unit;
163 else if (p->gc_mode == GC_CB)
165 else /* No other gc_mode */
169 static unsigned int check_bg_victims(struct f2fs_sb_info *sbi)
171 struct dirty_seglist_info *dirty_i = DIRTY_I(sbi);
172 unsigned int hint = 0;
176 * If the gc_type is FG_GC, we can select victim segments
177 * selected by background GC before.
178 * Those segments guarantee they have small valid blocks.
181 secno = find_next_bit(dirty_i->victim_secmap, TOTAL_SECS(sbi), hint++);
182 if (secno < TOTAL_SECS(sbi)) {
183 if (sec_usage_check(sbi, secno))
185 clear_bit(secno, dirty_i->victim_secmap);
186 return secno * sbi->segs_per_sec;
191 static unsigned int get_cb_cost(struct f2fs_sb_info *sbi, unsigned int segno)
193 struct sit_info *sit_i = SIT_I(sbi);
194 unsigned int secno = GET_SECNO(sbi, segno);
195 unsigned int start = secno * sbi->segs_per_sec;
196 unsigned long long mtime = 0;
197 unsigned int vblocks;
198 unsigned char age = 0;
202 for (i = 0; i < sbi->segs_per_sec; i++)
203 mtime += get_seg_entry(sbi, start + i)->mtime;
204 vblocks = get_valid_blocks(sbi, segno, sbi->segs_per_sec);
206 mtime = div_u64(mtime, sbi->segs_per_sec);
207 vblocks = div_u64(vblocks, sbi->segs_per_sec);
209 u = (vblocks * 100) >> sbi->log_blocks_per_seg;
211 /* Handle if the system time is changed by user */
212 if (mtime < sit_i->min_mtime)
213 sit_i->min_mtime = mtime;
214 if (mtime > sit_i->max_mtime)
215 sit_i->max_mtime = mtime;
216 if (sit_i->max_mtime != sit_i->min_mtime)
217 age = 100 - div64_u64(100 * (mtime - sit_i->min_mtime),
218 sit_i->max_mtime - sit_i->min_mtime);
220 return UINT_MAX - ((100 * (100 - u) * age) / (100 + u));
223 static unsigned int get_gc_cost(struct f2fs_sb_info *sbi, unsigned int segno,
224 struct victim_sel_policy *p)
226 if (p->alloc_mode == SSR)
227 return get_seg_entry(sbi, segno)->ckpt_valid_blocks;
229 /* alloc_mode == LFS */
230 if (p->gc_mode == GC_GREEDY)
231 return get_valid_blocks(sbi, segno, sbi->segs_per_sec);
233 return get_cb_cost(sbi, segno);
237 * This function is called from two paths.
238 * One is garbage collection and the other is SSR segment selection.
239 * When it is called during GC, it just gets a victim segment
240 * and it does not remove it from dirty seglist.
241 * When it is called from SSR segment selection, it finds a segment
242 * which has minimum valid blocks and removes it from dirty seglist.
244 static int get_victim_by_default(struct f2fs_sb_info *sbi,
245 unsigned int *result, int gc_type, int type, char alloc_mode)
247 struct dirty_seglist_info *dirty_i = DIRTY_I(sbi);
248 struct victim_sel_policy p;
249 unsigned int secno, max_cost;
252 p.alloc_mode = alloc_mode;
253 select_policy(sbi, gc_type, type, &p);
255 p.min_segno = NULL_SEGNO;
256 p.min_cost = max_cost = get_max_cost(sbi, &p);
258 mutex_lock(&dirty_i->seglist_lock);
260 if (p.alloc_mode == LFS && gc_type == FG_GC) {
261 p.min_segno = check_bg_victims(sbi);
262 if (p.min_segno != NULL_SEGNO)
270 segno = find_next_bit(p.dirty_segmap,
271 TOTAL_SEGS(sbi), p.offset);
272 if (segno >= TOTAL_SEGS(sbi)) {
273 if (sbi->last_victim[p.gc_mode]) {
274 sbi->last_victim[p.gc_mode] = 0;
280 p.offset = ((segno / p.ofs_unit) * p.ofs_unit) + p.ofs_unit;
281 secno = GET_SECNO(sbi, segno);
283 if (sec_usage_check(sbi, secno))
285 if (gc_type == BG_GC && test_bit(secno, dirty_i->victim_secmap))
288 cost = get_gc_cost(sbi, segno, &p);
290 if (p.min_cost > cost) {
295 if (cost == max_cost)
298 if (nsearched++ >= MAX_VICTIM_SEARCH) {
299 sbi->last_victim[p.gc_mode] = segno;
303 if (p.min_segno != NULL_SEGNO) {
305 if (p.alloc_mode == LFS) {
306 secno = GET_SECNO(sbi, p.min_segno);
307 if (gc_type == FG_GC)
308 sbi->cur_victim_sec = secno;
310 set_bit(secno, dirty_i->victim_secmap);
312 *result = (p.min_segno / p.ofs_unit) * p.ofs_unit;
314 trace_f2fs_get_victim(sbi->sb, type, gc_type, &p,
316 prefree_segments(sbi), free_segments(sbi));
318 mutex_unlock(&dirty_i->seglist_lock);
320 return (p.min_segno == NULL_SEGNO) ? 0 : 1;
323 static const struct victim_selection default_v_ops = {
324 .get_victim = get_victim_by_default,
327 static struct inode *find_gc_inode(nid_t ino, struct list_head *ilist)
329 struct inode_entry *ie;
331 list_for_each_entry(ie, ilist, list)
332 if (ie->inode->i_ino == ino)
337 static void add_gc_inode(struct inode *inode, struct list_head *ilist)
339 struct inode_entry *new_ie;
341 if (inode == find_gc_inode(inode->i_ino, ilist)) {
346 new_ie = kmem_cache_alloc(winode_slab, GFP_NOFS);
351 new_ie->inode = inode;
352 list_add_tail(&new_ie->list, ilist);
355 static void put_gc_inode(struct list_head *ilist)
357 struct inode_entry *ie, *next_ie;
358 list_for_each_entry_safe(ie, next_ie, ilist, list) {
361 kmem_cache_free(winode_slab, ie);
365 static int check_valid_map(struct f2fs_sb_info *sbi,
366 unsigned int segno, int offset)
368 struct sit_info *sit_i = SIT_I(sbi);
369 struct seg_entry *sentry;
372 mutex_lock(&sit_i->sentry_lock);
373 sentry = get_seg_entry(sbi, segno);
374 ret = f2fs_test_bit(offset, sentry->cur_valid_map);
375 mutex_unlock(&sit_i->sentry_lock);
380 * This function compares node address got in summary with that in NAT.
381 * On validity, copy that node with cold status, otherwise (invalid node)
384 static void gc_node_segment(struct f2fs_sb_info *sbi,
385 struct f2fs_summary *sum, unsigned int segno, int gc_type)
388 struct f2fs_summary *entry;
394 for (off = 0; off < sbi->blocks_per_seg; off++, entry++) {
395 nid_t nid = le32_to_cpu(entry->nid);
396 struct page *node_page;
398 /* stop BG_GC if there is not enough free sections. */
399 if (gc_type == BG_GC && has_not_enough_free_secs(sbi, 0))
402 if (check_valid_map(sbi, segno, off) == 0)
406 ra_node_page(sbi, nid);
409 node_page = get_node_page(sbi, nid);
410 if (IS_ERR(node_page))
413 /* set page dirty and write it */
414 if (gc_type == FG_GC) {
415 f2fs_submit_bio(sbi, NODE, true);
416 wait_on_page_writeback(node_page);
417 set_page_dirty(node_page);
419 if (!PageWriteback(node_page))
420 set_page_dirty(node_page);
422 f2fs_put_page(node_page, 1);
423 stat_inc_node_blk_count(sbi, 1);
431 if (gc_type == FG_GC) {
432 struct writeback_control wbc = {
433 .sync_mode = WB_SYNC_ALL,
434 .nr_to_write = LONG_MAX,
437 sync_node_pages(sbi, 0, &wbc);
440 * In the case of FG_GC, it'd be better to reclaim this victim
443 if (get_valid_blocks(sbi, segno, 1) != 0)
449 * Calculate start block index indicating the given node offset.
450 * Be careful, caller should give this node offset only indicating direct node
451 * blocks. If any node offsets, which point the other types of node blocks such
452 * as indirect or double indirect node blocks, are given, it must be a caller's
455 block_t start_bidx_of_node(unsigned int node_ofs)
457 unsigned int indirect_blks = 2 * NIDS_PER_BLOCK + 4;
465 } else if (node_ofs <= indirect_blks) {
466 int dec = (node_ofs - 4) / (NIDS_PER_BLOCK + 1);
467 bidx = node_ofs - 2 - dec;
469 int dec = (node_ofs - indirect_blks - 3) / (NIDS_PER_BLOCK + 1);
470 bidx = node_ofs - 5 - dec;
472 return bidx * ADDRS_PER_BLOCK + ADDRS_PER_INODE;
475 static int check_dnode(struct f2fs_sb_info *sbi, struct f2fs_summary *sum,
476 struct node_info *dni, block_t blkaddr, unsigned int *nofs)
478 struct page *node_page;
480 unsigned int ofs_in_node;
481 block_t source_blkaddr;
483 nid = le32_to_cpu(sum->nid);
484 ofs_in_node = le16_to_cpu(sum->ofs_in_node);
486 node_page = get_node_page(sbi, nid);
487 if (IS_ERR(node_page))
490 get_node_info(sbi, nid, dni);
492 if (sum->version != dni->version) {
493 f2fs_put_page(node_page, 1);
497 *nofs = ofs_of_node(node_page);
498 source_blkaddr = datablock_addr(node_page, ofs_in_node);
499 f2fs_put_page(node_page, 1);
501 if (source_blkaddr != blkaddr)
506 static void move_data_page(struct inode *inode, struct page *page, int gc_type)
508 if (gc_type == BG_GC) {
509 if (PageWriteback(page))
511 set_page_dirty(page);
514 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
516 if (PageWriteback(page)) {
517 f2fs_submit_bio(sbi, DATA, true);
518 wait_on_page_writeback(page);
521 if (clear_page_dirty_for_io(page) &&
522 S_ISDIR(inode->i_mode)) {
523 dec_page_count(sbi, F2FS_DIRTY_DENTS);
524 inode_dec_dirty_dents(inode);
527 do_write_data_page(page);
528 clear_cold_data(page);
531 f2fs_put_page(page, 1);
535 * This function tries to get parent node of victim data block, and identifies
536 * data block validity. If the block is valid, copy that with cold status and
537 * modify parent node.
538 * If the parent node is not valid or the data block address is different,
539 * the victim data block is ignored.
541 static void gc_data_segment(struct f2fs_sb_info *sbi, struct f2fs_summary *sum,
542 struct list_head *ilist, unsigned int segno, int gc_type)
544 struct super_block *sb = sbi->sb;
545 struct f2fs_summary *entry;
550 start_addr = START_BLOCK(sbi, segno);
555 for (off = 0; off < sbi->blocks_per_seg; off++, entry++) {
556 struct page *data_page;
558 struct node_info dni; /* dnode info for the data */
559 unsigned int ofs_in_node, nofs;
562 /* stop BG_GC if there is not enough free sections. */
563 if (gc_type == BG_GC && has_not_enough_free_secs(sbi, 0))
566 if (check_valid_map(sbi, segno, off) == 0)
570 ra_node_page(sbi, le32_to_cpu(entry->nid));
574 /* Get an inode by ino with checking validity */
575 if (check_dnode(sbi, entry, &dni, start_addr + off, &nofs) == 0)
579 ra_node_page(sbi, dni.ino);
583 start_bidx = start_bidx_of_node(nofs);
584 ofs_in_node = le16_to_cpu(entry->ofs_in_node);
587 inode = f2fs_iget(sb, dni.ino);
591 data_page = find_data_page(inode,
592 start_bidx + ofs_in_node, false);
593 if (IS_ERR(data_page))
596 f2fs_put_page(data_page, 0);
597 add_gc_inode(inode, ilist);
599 inode = find_gc_inode(dni.ino, ilist);
601 data_page = get_lock_data_page(inode,
602 start_bidx + ofs_in_node);
603 if (IS_ERR(data_page))
605 move_data_page(inode, data_page, gc_type);
606 stat_inc_data_blk_count(sbi, 1);
617 if (gc_type == FG_GC) {
618 f2fs_submit_bio(sbi, DATA, true);
621 * In the case of FG_GC, it'd be better to reclaim this victim
624 if (get_valid_blocks(sbi, segno, 1) != 0) {
631 static int __get_victim(struct f2fs_sb_info *sbi, unsigned int *victim,
632 int gc_type, int type)
634 struct sit_info *sit_i = SIT_I(sbi);
636 mutex_lock(&sit_i->sentry_lock);
637 ret = DIRTY_I(sbi)->v_ops->get_victim(sbi, victim, gc_type, type, LFS);
638 mutex_unlock(&sit_i->sentry_lock);
642 static void do_garbage_collect(struct f2fs_sb_info *sbi, unsigned int segno,
643 struct list_head *ilist, int gc_type)
645 struct page *sum_page;
646 struct f2fs_summary_block *sum;
647 struct blk_plug plug;
649 /* read segment summary of victim */
650 sum_page = get_sum_page(sbi, segno);
651 if (IS_ERR(sum_page))
654 blk_start_plug(&plug);
656 sum = page_address(sum_page);
658 switch (GET_SUM_TYPE((&sum->footer))) {
660 gc_node_segment(sbi, sum->entries, segno, gc_type);
663 gc_data_segment(sbi, sum->entries, ilist, segno, gc_type);
666 blk_finish_plug(&plug);
668 stat_inc_seg_count(sbi, GET_SUM_TYPE((&sum->footer)));
669 stat_inc_call_count(sbi->stat_info);
671 f2fs_put_page(sum_page, 1);
674 int f2fs_gc(struct f2fs_sb_info *sbi)
676 struct list_head ilist;
677 unsigned int segno, i;
682 INIT_LIST_HEAD(&ilist);
684 if (!(sbi->sb->s_flags & MS_ACTIVE))
687 if (gc_type == BG_GC && has_not_enough_free_secs(sbi, nfree)) {
689 write_checkpoint(sbi, false);
692 if (!__get_victim(sbi, &segno, gc_type, NO_CHECK_TYPE))
696 for (i = 0; i < sbi->segs_per_sec; i++)
697 do_garbage_collect(sbi, segno + i, &ilist, gc_type);
699 if (gc_type == FG_GC) {
700 sbi->cur_victim_sec = NULL_SEGNO;
702 WARN_ON(get_valid_blocks(sbi, segno, sbi->segs_per_sec));
705 if (has_not_enough_free_secs(sbi, nfree))
708 if (gc_type == FG_GC)
709 write_checkpoint(sbi, false);
711 mutex_unlock(&sbi->gc_mutex);
713 put_gc_inode(&ilist);
717 void build_gc_manager(struct f2fs_sb_info *sbi)
719 DIRTY_I(sbi)->v_ops = &default_v_ops;
722 int __init create_gc_caches(void)
724 winode_slab = f2fs_kmem_cache_create("f2fs_gc_inodes",
725 sizeof(struct inode_entry), NULL);
731 void destroy_gc_caches(void)
733 kmem_cache_destroy(winode_slab);