]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/f2fs/node.h
Merge tag 'sound-fix-4.15-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[mirror_ubuntu-bionic-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 */
57864ae5 143 INMEM_PAGES, /* indicates inmemory pages */
1e84371f 144 BASE_CHECK, /* check kernel status */
cdfc41c1
JK
145};
146
aec71382 147struct nat_entry_set {
309cc2b6 148 struct list_head set_list; /* link with other nat sets */
aec71382 149 struct list_head entry_list; /* link with dirty nat entries */
309cc2b6 150 nid_t set; /* set number*/
aec71382
CY
151 unsigned int entry_cnt; /* the # of nat entries in set */
152};
153
39a53e0c
JK
154struct free_nid {
155 struct list_head list; /* for free node id list */
156 nid_t nid; /* node id */
9a4ffdf5 157 int state; /* in use or not: FREE_NID or PREALLOC_NID */
39a53e0c
JK
158};
159
120c2cba 160static inline void next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
39a53e0c
JK
161{
162 struct f2fs_nm_info *nm_i = NM_I(sbi);
163 struct free_nid *fnid;
164
b8559dc2 165 spin_lock(&nm_i->nid_list_lock);
9a4ffdf5 166 if (nm_i->nid_cnt[FREE_NID] <= 0) {
b8559dc2 167 spin_unlock(&nm_i->nid_list_lock);
120c2cba 168 return;
c6e48930 169 }
9a4ffdf5 170 fnid = list_first_entry(&nm_i->free_nid_list, struct free_nid, list);
39a53e0c 171 *nid = fnid->nid;
b8559dc2 172 spin_unlock(&nm_i->nid_list_lock);
39a53e0c
JK
173}
174
175/*
176 * inline functions
177 */
178static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
179{
180 struct f2fs_nm_info *nm_i = NM_I(sbi);
599a09b2
CY
181
182#ifdef CONFIG_F2FS_CHECK_FS
183 if (memcmp(nm_i->nat_bitmap, nm_i->nat_bitmap_mir,
184 nm_i->bitmap_size))
185 f2fs_bug_on(sbi, 1);
186#endif
39a53e0c
JK
187 memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
188}
189
190static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
191{
192 struct f2fs_nm_info *nm_i = NM_I(sbi);
193 pgoff_t block_off;
194 pgoff_t block_addr;
39a53e0c 195
8a6aa325
FL
196 /*
197 * block_off = segment_off * 512 + off_in_segment
198 * OLD = (segment_off * 512) * 2 + off_in_segment
199 * NEW = 2 * (segment_off * 512 + off_in_segment) - off_in_segment
200 */
39a53e0c 201 block_off = NAT_BLOCK_OFFSET(start);
39a53e0c
JK
202
203 block_addr = (pgoff_t)(nm_i->nat_blkaddr +
8a6aa325 204 (block_off << 1) -
3519e3f9 205 (block_off & (sbi->blocks_per_seg - 1)));
39a53e0c
JK
206
207 if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
208 block_addr += sbi->blocks_per_seg;
209
210 return block_addr;
211}
212
213static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
214 pgoff_t block_addr)
215{
216 struct f2fs_nm_info *nm_i = NM_I(sbi);
217
218 block_addr -= nm_i->nat_blkaddr;
72fdbe2e 219 block_addr ^= 1 << sbi->log_blocks_per_seg;
39a53e0c
JK
220 return block_addr + nm_i->nat_blkaddr;
221}
222
223static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
224{
225 unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
226
c6ac4c0e 227 f2fs_change_bit(block_off, nm_i->nat_bitmap);
599a09b2
CY
228#ifdef CONFIG_F2FS_CHECK_FS
229 f2fs_change_bit(block_off, nm_i->nat_bitmap_mir);
230#endif
39a53e0c
JK
231}
232
a468f0ef
JK
233static inline nid_t ino_of_node(struct page *node_page)
234{
235 struct f2fs_node *rn = F2FS_NODE(node_page);
236 return le32_to_cpu(rn->footer.ino);
237}
238
239static inline nid_t nid_of_node(struct page *node_page)
240{
241 struct f2fs_node *rn = F2FS_NODE(node_page);
242 return le32_to_cpu(rn->footer.nid);
243}
244
245static inline unsigned int ofs_of_node(struct page *node_page)
246{
247 struct f2fs_node *rn = F2FS_NODE(node_page);
248 unsigned flag = le32_to_cpu(rn->footer.flag);
249 return flag >> OFFSET_BIT_SHIFT;
250}
251
252static inline __u64 cpver_of_node(struct page *node_page)
253{
254 struct f2fs_node *rn = F2FS_NODE(node_page);
255 return le64_to_cpu(rn->footer.cp_ver);
256}
257
258static inline block_t next_blkaddr_of_node(struct page *node_page)
259{
260 struct f2fs_node *rn = F2FS_NODE(node_page);
261 return le32_to_cpu(rn->footer.next_blkaddr);
262}
263
39a53e0c
JK
264static inline void fill_node_footer(struct page *page, nid_t nid,
265 nid_t ino, unsigned int ofs, bool reset)
266{
45590710 267 struct f2fs_node *rn = F2FS_NODE(page);
09eb483e
JK
268 unsigned int old_flag = 0;
269
39a53e0c
JK
270 if (reset)
271 memset(rn, 0, sizeof(*rn));
09eb483e
JK
272 else
273 old_flag = le32_to_cpu(rn->footer.flag);
274
39a53e0c
JK
275 rn->footer.nid = cpu_to_le32(nid);
276 rn->footer.ino = cpu_to_le32(ino);
09eb483e
JK
277
278 /* should remain old flag bits such as COLD_BIT_SHIFT */
279 rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) |
280 (old_flag & OFFSET_BIT_MASK));
39a53e0c
JK
281}
282
283static inline void copy_node_footer(struct page *dst, struct page *src)
284{
45590710
GZ
285 struct f2fs_node *src_rn = F2FS_NODE(src);
286 struct f2fs_node *dst_rn = F2FS_NODE(dst);
39a53e0c
JK
287 memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
288}
289
290static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
291{
4081363f 292 struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
45590710 293 struct f2fs_node *rn = F2FS_NODE(page);
ced2c7ea
KM
294 __u64 cp_ver = cur_cp_version(ckpt);
295
296 if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
297 cp_ver |= (cur_cp_crc(ckpt) << 32);
45590710 298
a468f0ef 299 rn->footer.cp_ver = cpu_to_le64(cp_ver);
25ca923b 300 rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
39a53e0c
JK
301}
302
a468f0ef 303static inline bool is_recoverable_dnode(struct page *page)
39a53e0c 304{
a468f0ef 305 struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
a468f0ef 306 __u64 cp_ver = cur_cp_version(ckpt);
39a53e0c 307
ced2c7ea
KM
308 if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
309 cp_ver |= (cur_cp_crc(ckpt) << 32);
310
0c0b471e 311 return cp_ver == cpver_of_node(page);
39a53e0c
JK
312}
313
314/*
315 * f2fs assigns the following node offsets described as (num).
316 * N = NIDS_PER_BLOCK
317 *
318 * Inode block (0)
319 * |- direct node (1)
320 * |- direct node (2)
321 * |- indirect node (3)
322 * | `- direct node (4 => 4 + N - 1)
323 * |- indirect node (4 + N)
324 * | `- direct node (5 + N => 5 + 2N - 1)
325 * `- double indirect node (5 + 2N)
326 * `- indirect node (6 + 2N)
4f4124d0
CY
327 * `- direct node
328 * ......
329 * `- indirect node ((6 + 2N) + x(N + 1))
330 * `- direct node
331 * ......
332 * `- indirect node ((6 + 2N) + (N - 1)(N + 1))
333 * `- direct node
39a53e0c
JK
334 */
335static inline bool IS_DNODE(struct page *node_page)
336{
337 unsigned int ofs = ofs_of_node(node_page);
dbe6a5ff 338
4bc8e9bc 339 if (f2fs_has_xattr_block(ofs))
d260081c 340 return true;
dbe6a5ff 341
39a53e0c
JK
342 if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
343 ofs == 5 + 2 * NIDS_PER_BLOCK)
344 return false;
345 if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
346 ofs -= 6 + 2 * NIDS_PER_BLOCK;
3315101f 347 if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
39a53e0c
JK
348 return false;
349 }
350 return true;
351}
352
12719ae1 353static inline int set_nid(struct page *p, int off, nid_t nid, bool i)
39a53e0c 354{
45590710 355 struct f2fs_node *rn = F2FS_NODE(p);
39a53e0c 356
fec1d657 357 f2fs_wait_on_page_writeback(p, NODE, true);
39a53e0c
JK
358
359 if (i)
360 rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
361 else
362 rn->in.nid[off] = cpu_to_le32(nid);
12719ae1 363 return set_page_dirty(p);
39a53e0c
JK
364}
365
366static inline nid_t get_nid(struct page *p, int off, bool i)
367{
45590710
GZ
368 struct f2fs_node *rn = F2FS_NODE(p);
369
39a53e0c
JK
370 if (i)
371 return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
372 return le32_to_cpu(rn->in.nid[off]);
373}
374
375/*
376 * Coldness identification:
377 * - Mark cold files in f2fs_inode_info
378 * - Mark cold node blocks in their node footer
379 * - Mark cold data pages in page cache
380 */
39a53e0c
JK
381static inline int is_cold_data(struct page *page)
382{
383 return PageChecked(page);
384}
385
386static inline void set_cold_data(struct page *page)
387{
388 SetPageChecked(page);
389}
390
391static inline void clear_cold_data(struct page *page)
392{
393 ClearPageChecked(page);
394}
395
a06a2416 396static inline int is_node(struct page *page, int type)
39a53e0c 397{
45590710 398 struct f2fs_node *rn = F2FS_NODE(page);
a06a2416 399 return le32_to_cpu(rn->footer.flag) & (1 << type);
39a53e0c
JK
400}
401
a06a2416
NJ
402#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
403#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
404#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
39a53e0c 405
2049d4fc
JK
406static inline int is_inline_node(struct page *page)
407{
408 return PageChecked(page);
409}
410
411static inline void set_inline_node(struct page *page)
412{
413 SetPageChecked(page);
414}
415
416static inline void clear_inline_node(struct page *page)
417{
418 ClearPageChecked(page);
419}
420
39a53e0c
JK
421static inline void set_cold_node(struct inode *inode, struct page *page)
422{
45590710 423 struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c
JK
424 unsigned int flag = le32_to_cpu(rn->footer.flag);
425
426 if (S_ISDIR(inode->i_mode))
427 flag &= ~(0x1 << COLD_BIT_SHIFT);
428 else
429 flag |= (0x1 << COLD_BIT_SHIFT);
430 rn->footer.flag = cpu_to_le32(flag);
431}
432
a06a2416 433static inline void set_mark(struct page *page, int mark, int type)
39a53e0c 434{
45590710 435 struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c
JK
436 unsigned int flag = le32_to_cpu(rn->footer.flag);
437 if (mark)
a06a2416 438 flag |= (0x1 << type);
39a53e0c 439 else
a06a2416 440 flag &= ~(0x1 << type);
39a53e0c
JK
441 rn->footer.flag = cpu_to_le32(flag);
442}
a06a2416
NJ
443#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
444#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)