]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/f2fs/node.h
f2fs: support issuing/waiting discard in range
[mirror_ubuntu-jammy-kernel.git] / fs / f2fs / node.h
CommitLineData
0a8165d7 1/*
39a53e0c
JK
2 * fs/f2fs/node.h
3 *
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
6 *
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.
10 */
11/* start node id of a node block dedicated to the given node id */
68afcf2d 12#define START_NID(nid) (((nid) / NAT_ENTRY_PER_BLOCK) * NAT_ENTRY_PER_BLOCK)
39a53e0c
JK
13
14/* node block offset on the NAT area dedicated to the given start node id */
68afcf2d 15#define NAT_BLOCK_OFFSET(start_nid) ((start_nid) / NAT_ENTRY_PER_BLOCK)
39a53e0c 16
ea1a29a0 17/* # of pages to perform synchronous readahead before building free nids */
ad4edb83
JK
18#define FREE_NID_PAGES 8
19#define MAX_FREE_NIDS (NAT_ENTRY_PER_BLOCK * FREE_NID_PAGES)
39a53e0c 20
ad4edb83 21#define DEF_RA_NID_PAGES 0 /* # of nid pages to be readaheaded */
ea1a29a0 22
39a53e0c
JK
23/* maximum readahead size for node during getting data blocks */
24#define MAX_RA_NODE 128
25
cdfc41c1 26/* control the memory footprint threshold (10MB per 1GB ram) */
29710bcf 27#define DEF_RAM_THRESHOLD 1
cdfc41c1 28
7d768d2c
CY
29/* control dirty nats ratio threshold (default: 10% over max nid count) */
30#define DEF_DIRTY_NAT_RATIO_THRESHOLD 10
e589c2c4
JK
31/* control total # of nats */
32#define DEF_NAT_CACHE_THRESHOLD 100000
7d768d2c 33
39a53e0c
JK
34/* vector size for gang look-up from nat cache that consists of radix tree */
35#define NATVEC_SIZE 64
7aed0d45 36#define SETVEC_SIZE 32
39a53e0c 37
56ae674c
JK
38/* return value for read_node_page */
39#define LOCKED_PAGE 1
40
5c27f4ee
CY
41/* For flag in struct node_info */
42enum {
43 IS_CHECKPOINTED, /* is it checkpointed before? */
44 HAS_FSYNCED_INODE, /* is the inode fsynced before? */
45 HAS_LAST_FSYNC, /* has the latest node fsync mark? */
46 IS_DIRTY, /* this nat entry is dirty? */
47};
48
39a53e0c
JK
49/*
50 * For node information
51 */
52struct node_info {
53 nid_t nid; /* node id */
54 nid_t ino; /* inode number of the node's owner */
55 block_t blk_addr; /* block address of the node */
56 unsigned char version; /* version of the node */
5c27f4ee 57 unsigned char flag; /* for node information bits */
7ef35e3b
JK
58};
59
39a53e0c
JK
60struct nat_entry {
61 struct list_head list; /* for clean or dirty nat list */
39a53e0c
JK
62 struct node_info ni; /* in-memory node information */
63};
64
68afcf2d
TK
65#define nat_get_nid(nat) ((nat)->ni.nid)
66#define nat_set_nid(nat, n) ((nat)->ni.nid = (n))
67#define nat_get_blkaddr(nat) ((nat)->ni.blk_addr)
68#define nat_set_blkaddr(nat, b) ((nat)->ni.blk_addr = (b))
69#define nat_get_ino(nat) ((nat)->ni.ino)
70#define nat_set_ino(nat, i) ((nat)->ni.ino = (i))
71#define nat_get_version(nat) ((nat)->ni.version)
72#define nat_set_version(nat, v) ((nat)->ni.version = (v))
39a53e0c 73
68afcf2d 74#define inc_node_version(version) (++(version))
39a53e0c 75
5c27f4ee
CY
76static inline void copy_node_info(struct node_info *dst,
77 struct node_info *src)
78{
79 dst->nid = src->nid;
80 dst->ino = src->ino;
81 dst->blk_addr = src->blk_addr;
82 dst->version = src->version;
83 /* should not copy flag here */
84}
85
7ef35e3b
JK
86static inline void set_nat_flag(struct nat_entry *ne,
87 unsigned int type, bool set)
88{
89 unsigned char mask = 0x01 << type;
90 if (set)
5c27f4ee 91 ne->ni.flag |= mask;
7ef35e3b 92 else
5c27f4ee 93 ne->ni.flag &= ~mask;
7ef35e3b
JK
94}
95
96static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
97{
98 unsigned char mask = 0x01 << type;
5c27f4ee 99 return ne->ni.flag & mask;
7ef35e3b
JK
100}
101
88bd02c9
JK
102static inline void nat_reset_flag(struct nat_entry *ne)
103{
104 /* these states can be set only after checkpoint was done */
105 set_nat_flag(ne, IS_CHECKPOINTED, true);
106 set_nat_flag(ne, HAS_FSYNCED_INODE, false);
107 set_nat_flag(ne, HAS_LAST_FSYNC, true);
108}
109
39a53e0c
JK
110static inline void node_info_from_raw_nat(struct node_info *ni,
111 struct f2fs_nat_entry *raw_ne)
112{
113 ni->ino = le32_to_cpu(raw_ne->ino);
114 ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
115 ni->version = raw_ne->version;
116}
117
94dac22e
CY
118static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
119 struct node_info *ni)
120{
121 raw_ne->ino = cpu_to_le32(ni->ino);
122 raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
123 raw_ne->version = ni->version;
124}
125
7d768d2c
CY
126static inline bool excess_dirty_nats(struct f2fs_sb_info *sbi)
127{
128 return NM_I(sbi)->dirty_nat_cnt >= NM_I(sbi)->max_nid *
2304cb0c 129 NM_I(sbi)->dirty_nats_ratio / 100;
7d768d2c
CY
130}
131
e589c2c4
JK
132static inline bool excess_cached_nats(struct f2fs_sb_info *sbi)
133{
134 return NM_I(sbi)->nat_cnt >= DEF_NAT_CACHE_THRESHOLD;
135}
136
6fb03f3a 137enum mem_type {
cdfc41c1 138 FREE_NIDS, /* indicates the free nid list */
6fb03f3a 139 NAT_ENTRIES, /* indicates the cached nat entry */
a1257023 140 DIRTY_DENTS, /* indicates dirty dentry pages */
e5e7ea3c 141 INO_ENTRIES, /* indicates inode entries */
13054c54 142 EXTENT_CACHE, /* indicates extent cache */
1e84371f 143 BASE_CHECK, /* check kernel status */
cdfc41c1
JK
144};
145
aec71382 146struct nat_entry_set {
309cc2b6 147 struct list_head set_list; /* link with other nat sets */
aec71382 148 struct list_head entry_list; /* link with dirty nat entries */
309cc2b6 149 nid_t set; /* set number*/
aec71382
CY
150 unsigned int entry_cnt; /* the # of nat entries in set */
151};
152
39a53e0c
JK
153struct free_nid {
154 struct list_head list; /* for free node id list */
155 nid_t nid; /* node id */
9a4ffdf5 156 int state; /* in use or not: FREE_NID or PREALLOC_NID */
39a53e0c
JK
157};
158
120c2cba 159static inline void next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
39a53e0c
JK
160{
161 struct f2fs_nm_info *nm_i = NM_I(sbi);
162 struct free_nid *fnid;
163
b8559dc2 164 spin_lock(&nm_i->nid_list_lock);
9a4ffdf5 165 if (nm_i->nid_cnt[FREE_NID] <= 0) {
b8559dc2 166 spin_unlock(&nm_i->nid_list_lock);
120c2cba 167 return;
c6e48930 168 }
9a4ffdf5 169 fnid = list_first_entry(&nm_i->free_nid_list, struct free_nid, list);
39a53e0c 170 *nid = fnid->nid;
b8559dc2 171 spin_unlock(&nm_i->nid_list_lock);
39a53e0c
JK
172}
173
174/*
175 * inline functions
176 */
177static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
178{
179 struct f2fs_nm_info *nm_i = NM_I(sbi);
599a09b2
CY
180
181#ifdef CONFIG_F2FS_CHECK_FS
182 if (memcmp(nm_i->nat_bitmap, nm_i->nat_bitmap_mir,
183 nm_i->bitmap_size))
184 f2fs_bug_on(sbi, 1);
185#endif
39a53e0c
JK
186 memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
187}
188
189static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
190{
191 struct f2fs_nm_info *nm_i = NM_I(sbi);
192 pgoff_t block_off;
193 pgoff_t block_addr;
39a53e0c 194
8a6aa325
FL
195 /*
196 * block_off = segment_off * 512 + off_in_segment
197 * OLD = (segment_off * 512) * 2 + off_in_segment
198 * NEW = 2 * (segment_off * 512 + off_in_segment) - off_in_segment
199 */
39a53e0c 200 block_off = NAT_BLOCK_OFFSET(start);
39a53e0c
JK
201
202 block_addr = (pgoff_t)(nm_i->nat_blkaddr +
8a6aa325 203 (block_off << 1) -
3519e3f9 204 (block_off & (sbi->blocks_per_seg - 1)));
39a53e0c
JK
205
206 if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
207 block_addr += sbi->blocks_per_seg;
208
209 return block_addr;
210}
211
212static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
213 pgoff_t block_addr)
214{
215 struct f2fs_nm_info *nm_i = NM_I(sbi);
216
217 block_addr -= nm_i->nat_blkaddr;
72fdbe2e 218 block_addr ^= 1 << sbi->log_blocks_per_seg;
39a53e0c
JK
219 return block_addr + nm_i->nat_blkaddr;
220}
221
222static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
223{
224 unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
225
c6ac4c0e 226 f2fs_change_bit(block_off, nm_i->nat_bitmap);
599a09b2
CY
227#ifdef CONFIG_F2FS_CHECK_FS
228 f2fs_change_bit(block_off, nm_i->nat_bitmap_mir);
229#endif
39a53e0c
JK
230}
231
a468f0ef
JK
232static inline nid_t ino_of_node(struct page *node_page)
233{
234 struct f2fs_node *rn = F2FS_NODE(node_page);
235 return le32_to_cpu(rn->footer.ino);
236}
237
238static inline nid_t nid_of_node(struct page *node_page)
239{
240 struct f2fs_node *rn = F2FS_NODE(node_page);
241 return le32_to_cpu(rn->footer.nid);
242}
243
244static inline unsigned int ofs_of_node(struct page *node_page)
245{
246 struct f2fs_node *rn = F2FS_NODE(node_page);
247 unsigned flag = le32_to_cpu(rn->footer.flag);
248 return flag >> OFFSET_BIT_SHIFT;
249}
250
251static inline __u64 cpver_of_node(struct page *node_page)
252{
253 struct f2fs_node *rn = F2FS_NODE(node_page);
254 return le64_to_cpu(rn->footer.cp_ver);
255}
256
257static inline block_t next_blkaddr_of_node(struct page *node_page)
258{
259 struct f2fs_node *rn = F2FS_NODE(node_page);
260 return le32_to_cpu(rn->footer.next_blkaddr);
261}
262
39a53e0c
JK
263static inline void fill_node_footer(struct page *page, nid_t nid,
264 nid_t ino, unsigned int ofs, bool reset)
265{
45590710 266 struct f2fs_node *rn = F2FS_NODE(page);
09eb483e
JK
267 unsigned int old_flag = 0;
268
39a53e0c
JK
269 if (reset)
270 memset(rn, 0, sizeof(*rn));
09eb483e
JK
271 else
272 old_flag = le32_to_cpu(rn->footer.flag);
273
39a53e0c
JK
274 rn->footer.nid = cpu_to_le32(nid);
275 rn->footer.ino = cpu_to_le32(ino);
09eb483e
JK
276
277 /* should remain old flag bits such as COLD_BIT_SHIFT */
278 rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) |
279 (old_flag & OFFSET_BIT_MASK));
39a53e0c
JK
280}
281
282static inline void copy_node_footer(struct page *dst, struct page *src)
283{
45590710
GZ
284 struct f2fs_node *src_rn = F2FS_NODE(src);
285 struct f2fs_node *dst_rn = F2FS_NODE(dst);
39a53e0c
JK
286 memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
287}
288
289static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
290{
4081363f 291 struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
45590710 292 struct f2fs_node *rn = F2FS_NODE(page);
ced2c7ea
KM
293 __u64 cp_ver = cur_cp_version(ckpt);
294
295 if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
296 cp_ver |= (cur_cp_crc(ckpt) << 32);
45590710 297
a468f0ef 298 rn->footer.cp_ver = cpu_to_le64(cp_ver);
25ca923b 299 rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
39a53e0c
JK
300}
301
a468f0ef 302static inline bool is_recoverable_dnode(struct page *page)
39a53e0c 303{
a468f0ef 304 struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
a468f0ef 305 __u64 cp_ver = cur_cp_version(ckpt);
39a53e0c 306
ced2c7ea
KM
307 if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
308 cp_ver |= (cur_cp_crc(ckpt) << 32);
309
0c0b471e 310 return cp_ver == cpver_of_node(page);
39a53e0c
JK
311}
312
313/*
314 * f2fs assigns the following node offsets described as (num).
315 * N = NIDS_PER_BLOCK
316 *
317 * Inode block (0)
318 * |- direct node (1)
319 * |- direct node (2)
320 * |- indirect node (3)
321 * | `- direct node (4 => 4 + N - 1)
322 * |- indirect node (4 + N)
323 * | `- direct node (5 + N => 5 + 2N - 1)
324 * `- double indirect node (5 + 2N)
325 * `- indirect node (6 + 2N)
4f4124d0
CY
326 * `- direct node
327 * ......
328 * `- indirect node ((6 + 2N) + x(N + 1))
329 * `- direct node
330 * ......
331 * `- indirect node ((6 + 2N) + (N - 1)(N + 1))
332 * `- direct node
39a53e0c
JK
333 */
334static inline bool IS_DNODE(struct page *node_page)
335{
336 unsigned int ofs = ofs_of_node(node_page);
dbe6a5ff 337
4bc8e9bc 338 if (f2fs_has_xattr_block(ofs))
d260081c 339 return true;
dbe6a5ff 340
39a53e0c
JK
341 if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
342 ofs == 5 + 2 * NIDS_PER_BLOCK)
343 return false;
344 if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
345 ofs -= 6 + 2 * NIDS_PER_BLOCK;
3315101f 346 if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
39a53e0c
JK
347 return false;
348 }
349 return true;
350}
351
12719ae1 352static inline int set_nid(struct page *p, int off, nid_t nid, bool i)
39a53e0c 353{
45590710 354 struct f2fs_node *rn = F2FS_NODE(p);
39a53e0c 355
fec1d657 356 f2fs_wait_on_page_writeback(p, NODE, true);
39a53e0c
JK
357
358 if (i)
359 rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
360 else
361 rn->in.nid[off] = cpu_to_le32(nid);
12719ae1 362 return set_page_dirty(p);
39a53e0c
JK
363}
364
365static inline nid_t get_nid(struct page *p, int off, bool i)
366{
45590710
GZ
367 struct f2fs_node *rn = F2FS_NODE(p);
368
39a53e0c
JK
369 if (i)
370 return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
371 return le32_to_cpu(rn->in.nid[off]);
372}
373
374/*
375 * Coldness identification:
376 * - Mark cold files in f2fs_inode_info
377 * - Mark cold node blocks in their node footer
378 * - Mark cold data pages in page cache
379 */
39a53e0c
JK
380static inline int is_cold_data(struct page *page)
381{
382 return PageChecked(page);
383}
384
385static inline void set_cold_data(struct page *page)
386{
387 SetPageChecked(page);
388}
389
390static inline void clear_cold_data(struct page *page)
391{
392 ClearPageChecked(page);
393}
394
a06a2416 395static inline int is_node(struct page *page, int type)
39a53e0c 396{
45590710 397 struct f2fs_node *rn = F2FS_NODE(page);
a06a2416 398 return le32_to_cpu(rn->footer.flag) & (1 << type);
39a53e0c
JK
399}
400
a06a2416
NJ
401#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
402#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
403#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
39a53e0c 404
2049d4fc
JK
405static inline int is_inline_node(struct page *page)
406{
407 return PageChecked(page);
408}
409
410static inline void set_inline_node(struct page *page)
411{
412 SetPageChecked(page);
413}
414
415static inline void clear_inline_node(struct page *page)
416{
417 ClearPageChecked(page);
418}
419
39a53e0c
JK
420static inline void set_cold_node(struct inode *inode, struct page *page)
421{
45590710 422 struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c
JK
423 unsigned int flag = le32_to_cpu(rn->footer.flag);
424
425 if (S_ISDIR(inode->i_mode))
426 flag &= ~(0x1 << COLD_BIT_SHIFT);
427 else
428 flag |= (0x1 << COLD_BIT_SHIFT);
429 rn->footer.flag = cpu_to_le32(flag);
430}
431
a06a2416 432static inline void set_mark(struct page *page, int mark, int type)
39a53e0c 433{
45590710 434 struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c
JK
435 unsigned int flag = le32_to_cpu(rn->footer.flag);
436 if (mark)
a06a2416 437 flag |= (0x1 << type);
39a53e0c 438 else
a06a2416 439 flag &= ~(0x1 << type);
39a53e0c
JK
440 rn->footer.flag = cpu_to_le32(flag);
441}
a06a2416
NJ
442#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
443#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)