1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * fs/f2fs/gc.h
4 *
5 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
6 * http://www.samsung.com/
7 */
8 #define GC_THREAD_MIN_WB_PAGES 1 /*
9 * a threshold to determine
10 * whether IO subsystem is idle
11 * or not
12 */
13 #define DEF_GC_THREAD_URGENT_SLEEP_TIME 500 /* 500 ms */
14 #define DEF_GC_THREAD_MIN_SLEEP_TIME 30000 /* milliseconds */
15 #define DEF_GC_THREAD_MAX_SLEEP_TIME 60000
16 #define DEF_GC_THREAD_NOGC_SLEEP_TIME 300000 /* wait 5 min */
17
18 /* GC sleep parameters for zoned deivces */
19 #define DEF_GC_THREAD_MIN_SLEEP_TIME_ZONED 10
20 #define DEF_GC_THREAD_MAX_SLEEP_TIME_ZONED 20
21 #define DEF_GC_THREAD_NOGC_SLEEP_TIME_ZONED 60000
22
23 /* choose candidates from sections which has age of more than 7 days */
24 #define DEF_GC_THREAD_AGE_THRESHOLD (60 * 60 * 24 * 7)
25 #define DEF_GC_THREAD_CANDIDATE_RATIO 20 /* select 20% oldest sections as candidates */
26 #define DEF_GC_THREAD_MAX_CANDIDATE_COUNT 10 /* select at most 10 sections as candidates */
27 #define DEF_GC_THREAD_AGE_WEIGHT 60 /* age weight */
28 #define DEF_GC_THREAD_VALID_THRESH_RATIO 80 /* do not GC over 80% valid block ratio for one time GC */
29 #define DEFAULT_ACCURACY_CLASS 10000 /* accuracy class */
30
31 #define LIMIT_INVALID_BLOCK 40 /* percentage over total user space */
32 #define LIMIT_FREE_BLOCK 40 /* percentage over invalid + free space */
33
34 #define LIMIT_NO_ZONED_GC 60 /* percentage over total user space of no gc for zoned devices */
35 #define LIMIT_BOOST_ZONED_GC 25 /* percentage over total user space of boosted gc for zoned devices */
36 #define DEF_MIGRATION_WINDOW_GRANULARITY_ZONED 3
37 #define BOOST_GC_MULTIPLE 5
38 #define ZONED_PIN_SEC_REQUIRED_COUNT 1
39
40 #define DEF_GC_FAILED_PINNED_FILES 2048
41 #define MAX_GC_FAILED_PINNED_FILES USHRT_MAX
42
43 /* Search max. number of dirty segments to select a victim segment */
44 #define DEF_MAX_VICTIM_SEARCH 4096 /* covers 8GB */
45
46 #define NR_GC_CHECKPOINT_SECS (3) /* data/node/dentry sections */
47
48
49
50 struct gc_inode_list {
51 struct list_head ilist;
52 struct radix_tree_root iroot;
53 };
54
55 struct victim_entry {
56 struct rb_node rb_node; /* rb node located in rb-tree */
57 unsigned long long mtime; /* mtime of section */
58 unsigned int segno; /* segment No. */
59 struct list_head list;
60 };
61
62 /*
63 * inline functions
64 */
65
66 /*
67 * On a Zoned device zone-capacity can be less than zone-size and if
68 * zone-capacity is not aligned to f2fs segment size(2MB), then the segment
69 * starting just before zone-capacity has some blocks spanning across the
70 * zone-capacity, these blocks are not usable.
71 * Such spanning segments can be in free list so calculate the sum of usable
72 * blocks in currently free segments including normal and spanning segments.
73 */
free_segs_blk_count_zoned(struct f2fs_sb_info * sbi)74 static inline block_t free_segs_blk_count_zoned(struct f2fs_sb_info *sbi)
75 {
76 block_t free_seg_blks = 0;
77 struct free_segmap_info *free_i = FREE_I(sbi);
78 int j;
79
80 spin_lock(&free_i->segmap_lock);
81 for (j = 0; j < MAIN_SEGS(sbi); j++)
82 if (!test_bit(j, free_i->free_segmap))
83 free_seg_blks += f2fs_usable_blks_in_seg(sbi, j);
84 spin_unlock(&free_i->segmap_lock);
85
86 return free_seg_blks;
87 }
88
free_segs_blk_count(struct f2fs_sb_info * sbi)89 static inline block_t free_segs_blk_count(struct f2fs_sb_info *sbi)
90 {
91 if (f2fs_sb_has_blkzoned(sbi))
92 return free_segs_blk_count_zoned(sbi);
93
94 return SEGS_TO_BLKS(sbi, free_segments(sbi));
95 }
96
free_user_blocks(struct f2fs_sb_info * sbi)97 static inline block_t free_user_blocks(struct f2fs_sb_info *sbi)
98 {
99 block_t free_blks, ovp_blks;
100
101 free_blks = free_segs_blk_count(sbi);
102 ovp_blks = SEGS_TO_BLKS(sbi, overprovision_segments(sbi));
103
104 if (free_blks < ovp_blks)
105 return 0;
106
107 return free_blks - ovp_blks;
108 }
109
limit_invalid_user_blocks(block_t user_block_count)110 static inline block_t limit_invalid_user_blocks(block_t user_block_count)
111 {
112 return (long)(user_block_count * LIMIT_INVALID_BLOCK) / 100;
113 }
114
limit_free_user_blocks(block_t reclaimable_user_blocks)115 static inline block_t limit_free_user_blocks(block_t reclaimable_user_blocks)
116 {
117 return (long)(reclaimable_user_blocks * LIMIT_FREE_BLOCK) / 100;
118 }
119
increase_sleep_time(struct f2fs_gc_kthread * gc_th,unsigned int * wait)120 static inline void increase_sleep_time(struct f2fs_gc_kthread *gc_th,
121 unsigned int *wait)
122 {
123 unsigned int min_time = gc_th->min_sleep_time;
124 unsigned int max_time = gc_th->max_sleep_time;
125
126 if (*wait == gc_th->no_gc_sleep_time)
127 return;
128
129 if ((long long)*wait + (long long)min_time > (long long)max_time)
130 *wait = max_time;
131 else
132 *wait += min_time;
133 }
134
decrease_sleep_time(struct f2fs_gc_kthread * gc_th,unsigned int * wait)135 static inline void decrease_sleep_time(struct f2fs_gc_kthread *gc_th,
136 unsigned int *wait)
137 {
138 unsigned int min_time = gc_th->min_sleep_time;
139
140 if (*wait == gc_th->no_gc_sleep_time)
141 *wait = gc_th->max_sleep_time;
142
143 if ((long long)*wait - (long long)min_time < (long long)min_time)
144 *wait = min_time;
145 else
146 *wait -= min_time;
147 }
148
has_enough_free_blocks(struct f2fs_sb_info * sbi,unsigned int limit_perc)149 static inline bool has_enough_free_blocks(struct f2fs_sb_info *sbi,
150 unsigned int limit_perc)
151 {
152 return free_sections(sbi) > ((sbi->total_sections * limit_perc) / 100);
153 }
154
has_enough_invalid_blocks(struct f2fs_sb_info * sbi)155 static inline bool has_enough_invalid_blocks(struct f2fs_sb_info *sbi)
156 {
157 block_t user_block_count = sbi->user_block_count;
158 block_t invalid_user_blocks = user_block_count -
159 written_block_count(sbi);
160 /*
161 * Background GC is triggered with the following conditions.
162 * 1. There are a number of invalid blocks.
163 * 2. There is not enough free space.
164 */
165 return (invalid_user_blocks >
166 limit_invalid_user_blocks(user_block_count) &&
167 free_user_blocks(sbi) <
168 limit_free_user_blocks(invalid_user_blocks));
169 }
170
need_to_boost_gc(struct f2fs_sb_info * sbi)171 static inline bool need_to_boost_gc(struct f2fs_sb_info *sbi)
172 {
173 if (f2fs_sb_has_blkzoned(sbi))
174 return !has_enough_free_blocks(sbi,
175 sbi->gc_thread.boost_zoned_gc_percent);
176 return has_enough_invalid_blocks(sbi);
177 }
178