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