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