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 | ||
39a53e0c JK |
32 | /* |
33 | * For node information | |
34 | */ | |
35 | struct node_info { | |
36 | nid_t nid; /* node id */ | |
37 | nid_t ino; /* inode number of the node's owner */ | |
38 | block_t blk_addr; /* block address of the node */ | |
39 | unsigned char version; /* version of the node */ | |
40 | }; | |
41 | ||
42 | struct nat_entry { | |
43 | struct list_head list; /* for clean or dirty nat list */ | |
44 | bool checkpointed; /* whether it is checkpointed or not */ | |
479f40c4 | 45 | bool fsync_done; /* whether the latest node has fsync mark */ |
39a53e0c JK |
46 | struct node_info ni; /* in-memory node information */ |
47 | }; | |
48 | ||
49 | #define nat_get_nid(nat) (nat->ni.nid) | |
50 | #define nat_set_nid(nat, n) (nat->ni.nid = n) | |
51 | #define nat_get_blkaddr(nat) (nat->ni.blk_addr) | |
52 | #define nat_set_blkaddr(nat, b) (nat->ni.blk_addr = b) | |
53 | #define nat_get_ino(nat) (nat->ni.ino) | |
54 | #define nat_set_ino(nat, i) (nat->ni.ino = i) | |
55 | #define nat_get_version(nat) (nat->ni.version) | |
56 | #define nat_set_version(nat, v) (nat->ni.version = v) | |
57 | ||
58 | #define __set_nat_cache_dirty(nm_i, ne) \ | |
fffc2a00 JK |
59 | do { \ |
60 | ne->checkpointed = false; \ | |
61 | list_move_tail(&ne->list, &nm_i->dirty_nat_entries); \ | |
62 | } while (0); | |
39a53e0c | 63 | #define __clear_nat_cache_dirty(nm_i, ne) \ |
fffc2a00 JK |
64 | do { \ |
65 | ne->checkpointed = true; \ | |
66 | list_move_tail(&ne->list, &nm_i->nat_entries); \ | |
67 | } while (0); | |
39a53e0c JK |
68 | #define inc_node_version(version) (++version) |
69 | ||
70 | static inline void node_info_from_raw_nat(struct node_info *ni, | |
71 | struct f2fs_nat_entry *raw_ne) | |
72 | { | |
73 | ni->ino = le32_to_cpu(raw_ne->ino); | |
74 | ni->blk_addr = le32_to_cpu(raw_ne->block_addr); | |
75 | ni->version = raw_ne->version; | |
76 | } | |
77 | ||
94dac22e CY |
78 | static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne, |
79 | struct node_info *ni) | |
80 | { | |
81 | raw_ne->ino = cpu_to_le32(ni->ino); | |
82 | raw_ne->block_addr = cpu_to_le32(ni->blk_addr); | |
83 | raw_ne->version = ni->version; | |
84 | } | |
85 | ||
cdfc41c1 JK |
86 | enum nid_type { |
87 | FREE_NIDS, /* indicates the free nid list */ | |
88 | NAT_ENTRIES /* indicates the cached nat entry */ | |
89 | }; | |
90 | ||
39a53e0c JK |
91 | /* |
92 | * For free nid mangement | |
93 | */ | |
94 | enum nid_state { | |
95 | NID_NEW, /* newly added to free nid list */ | |
96 | NID_ALLOC /* it is allocated */ | |
97 | }; | |
98 | ||
99 | struct free_nid { | |
100 | struct list_head list; /* for free node id list */ | |
101 | nid_t nid; /* node id */ | |
102 | int state; /* in use or not: NID_NEW or NID_ALLOC */ | |
103 | }; | |
104 | ||
105 | static inline int next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid) | |
106 | { | |
107 | struct f2fs_nm_info *nm_i = NM_I(sbi); | |
108 | struct free_nid *fnid; | |
109 | ||
110 | if (nm_i->fcnt <= 0) | |
111 | return -1; | |
112 | spin_lock(&nm_i->free_nid_list_lock); | |
113 | fnid = list_entry(nm_i->free_nid_list.next, struct free_nid, list); | |
114 | *nid = fnid->nid; | |
115 | spin_unlock(&nm_i->free_nid_list_lock); | |
116 | return 0; | |
117 | } | |
118 | ||
119 | /* | |
120 | * inline functions | |
121 | */ | |
122 | static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr) | |
123 | { | |
124 | struct f2fs_nm_info *nm_i = NM_I(sbi); | |
125 | memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size); | |
126 | } | |
127 | ||
128 | static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start) | |
129 | { | |
130 | struct f2fs_nm_info *nm_i = NM_I(sbi); | |
131 | pgoff_t block_off; | |
132 | pgoff_t block_addr; | |
133 | int seg_off; | |
134 | ||
135 | block_off = NAT_BLOCK_OFFSET(start); | |
136 | seg_off = block_off >> sbi->log_blocks_per_seg; | |
137 | ||
138 | block_addr = (pgoff_t)(nm_i->nat_blkaddr + | |
139 | (seg_off << sbi->log_blocks_per_seg << 1) + | |
140 | (block_off & ((1 << sbi->log_blocks_per_seg) - 1))); | |
141 | ||
142 | if (f2fs_test_bit(block_off, nm_i->nat_bitmap)) | |
143 | block_addr += sbi->blocks_per_seg; | |
144 | ||
145 | return block_addr; | |
146 | } | |
147 | ||
148 | static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi, | |
149 | pgoff_t block_addr) | |
150 | { | |
151 | struct f2fs_nm_info *nm_i = NM_I(sbi); | |
152 | ||
153 | block_addr -= nm_i->nat_blkaddr; | |
154 | if ((block_addr >> sbi->log_blocks_per_seg) % 2) | |
155 | block_addr -= sbi->blocks_per_seg; | |
156 | else | |
157 | block_addr += sbi->blocks_per_seg; | |
158 | ||
159 | return block_addr + nm_i->nat_blkaddr; | |
160 | } | |
161 | ||
162 | static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid) | |
163 | { | |
164 | unsigned int block_off = NAT_BLOCK_OFFSET(start_nid); | |
165 | ||
166 | if (f2fs_test_bit(block_off, nm_i->nat_bitmap)) | |
167 | f2fs_clear_bit(block_off, nm_i->nat_bitmap); | |
168 | else | |
169 | f2fs_set_bit(block_off, nm_i->nat_bitmap); | |
170 | } | |
171 | ||
172 | static inline void fill_node_footer(struct page *page, nid_t nid, | |
173 | nid_t ino, unsigned int ofs, bool reset) | |
174 | { | |
45590710 | 175 | struct f2fs_node *rn = F2FS_NODE(page); |
39a53e0c JK |
176 | if (reset) |
177 | memset(rn, 0, sizeof(*rn)); | |
178 | rn->footer.nid = cpu_to_le32(nid); | |
179 | rn->footer.ino = cpu_to_le32(ino); | |
180 | rn->footer.flag = cpu_to_le32(ofs << OFFSET_BIT_SHIFT); | |
181 | } | |
182 | ||
183 | static inline void copy_node_footer(struct page *dst, struct page *src) | |
184 | { | |
45590710 GZ |
185 | struct f2fs_node *src_rn = F2FS_NODE(src); |
186 | struct f2fs_node *dst_rn = F2FS_NODE(dst); | |
39a53e0c JK |
187 | memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer)); |
188 | } | |
189 | ||
190 | static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr) | |
191 | { | |
192 | struct f2fs_sb_info *sbi = F2FS_SB(page->mapping->host->i_sb); | |
193 | struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi); | |
45590710 GZ |
194 | struct f2fs_node *rn = F2FS_NODE(page); |
195 | ||
39a53e0c | 196 | rn->footer.cp_ver = ckpt->checkpoint_ver; |
25ca923b | 197 | rn->footer.next_blkaddr = cpu_to_le32(blkaddr); |
39a53e0c JK |
198 | } |
199 | ||
200 | static inline nid_t ino_of_node(struct page *node_page) | |
201 | { | |
45590710 | 202 | struct f2fs_node *rn = F2FS_NODE(node_page); |
39a53e0c JK |
203 | return le32_to_cpu(rn->footer.ino); |
204 | } | |
205 | ||
206 | static inline nid_t nid_of_node(struct page *node_page) | |
207 | { | |
45590710 | 208 | struct f2fs_node *rn = F2FS_NODE(node_page); |
39a53e0c JK |
209 | return le32_to_cpu(rn->footer.nid); |
210 | } | |
211 | ||
212 | static inline unsigned int ofs_of_node(struct page *node_page) | |
213 | { | |
45590710 | 214 | struct f2fs_node *rn = F2FS_NODE(node_page); |
39a53e0c JK |
215 | unsigned flag = le32_to_cpu(rn->footer.flag); |
216 | return flag >> OFFSET_BIT_SHIFT; | |
217 | } | |
218 | ||
219 | static inline unsigned long long cpver_of_node(struct page *node_page) | |
220 | { | |
45590710 | 221 | struct f2fs_node *rn = F2FS_NODE(node_page); |
39a53e0c JK |
222 | return le64_to_cpu(rn->footer.cp_ver); |
223 | } | |
224 | ||
225 | static inline block_t next_blkaddr_of_node(struct page *node_page) | |
226 | { | |
45590710 | 227 | struct f2fs_node *rn = F2FS_NODE(node_page); |
39a53e0c JK |
228 | return le32_to_cpu(rn->footer.next_blkaddr); |
229 | } | |
230 | ||
231 | /* | |
232 | * f2fs assigns the following node offsets described as (num). | |
233 | * N = NIDS_PER_BLOCK | |
234 | * | |
235 | * Inode block (0) | |
236 | * |- direct node (1) | |
237 | * |- direct node (2) | |
238 | * |- indirect node (3) | |
239 | * | `- direct node (4 => 4 + N - 1) | |
240 | * |- indirect node (4 + N) | |
241 | * | `- direct node (5 + N => 5 + 2N - 1) | |
242 | * `- double indirect node (5 + 2N) | |
243 | * `- indirect node (6 + 2N) | |
4f4124d0 CY |
244 | * `- direct node |
245 | * ...... | |
246 | * `- indirect node ((6 + 2N) + x(N + 1)) | |
247 | * `- direct node | |
248 | * ...... | |
249 | * `- indirect node ((6 + 2N) + (N - 1)(N + 1)) | |
250 | * `- direct node | |
39a53e0c JK |
251 | */ |
252 | static inline bool IS_DNODE(struct page *node_page) | |
253 | { | |
254 | unsigned int ofs = ofs_of_node(node_page); | |
dbe6a5ff | 255 | |
4bc8e9bc | 256 | if (f2fs_has_xattr_block(ofs)) |
dbe6a5ff JK |
257 | return false; |
258 | ||
39a53e0c JK |
259 | if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK || |
260 | ofs == 5 + 2 * NIDS_PER_BLOCK) | |
261 | return false; | |
262 | if (ofs >= 6 + 2 * NIDS_PER_BLOCK) { | |
263 | ofs -= 6 + 2 * NIDS_PER_BLOCK; | |
3315101f | 264 | if (!((long int)ofs % (NIDS_PER_BLOCK + 1))) |
39a53e0c JK |
265 | return false; |
266 | } | |
267 | return true; | |
268 | } | |
269 | ||
270 | static inline void set_nid(struct page *p, int off, nid_t nid, bool i) | |
271 | { | |
45590710 | 272 | struct f2fs_node *rn = F2FS_NODE(p); |
39a53e0c JK |
273 | |
274 | wait_on_page_writeback(p); | |
275 | ||
276 | if (i) | |
277 | rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid); | |
278 | else | |
279 | rn->in.nid[off] = cpu_to_le32(nid); | |
280 | set_page_dirty(p); | |
281 | } | |
282 | ||
283 | static inline nid_t get_nid(struct page *p, int off, bool i) | |
284 | { | |
45590710 GZ |
285 | struct f2fs_node *rn = F2FS_NODE(p); |
286 | ||
39a53e0c JK |
287 | if (i) |
288 | return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]); | |
289 | return le32_to_cpu(rn->in.nid[off]); | |
290 | } | |
291 | ||
292 | /* | |
293 | * Coldness identification: | |
294 | * - Mark cold files in f2fs_inode_info | |
295 | * - Mark cold node blocks in their node footer | |
296 | * - Mark cold data pages in page cache | |
297 | */ | |
a06a2416 | 298 | static inline int is_file(struct inode *inode, int type) |
39a53e0c | 299 | { |
a06a2416 | 300 | return F2FS_I(inode)->i_advise & type; |
39a53e0c JK |
301 | } |
302 | ||
a06a2416 | 303 | static inline void set_file(struct inode *inode, int type) |
953a3e27 | 304 | { |
a06a2416 | 305 | F2FS_I(inode)->i_advise |= type; |
953a3e27 JK |
306 | } |
307 | ||
354a3399 JK |
308 | static inline void clear_file(struct inode *inode, int type) |
309 | { | |
310 | F2FS_I(inode)->i_advise &= ~type; | |
311 | } | |
312 | ||
313 | #define file_is_cold(inode) is_file(inode, FADVISE_COLD_BIT) | |
314 | #define file_wrong_pino(inode) is_file(inode, FADVISE_LOST_PINO_BIT) | |
315 | #define file_set_cold(inode) set_file(inode, FADVISE_COLD_BIT) | |
316 | #define file_lost_pino(inode) set_file(inode, FADVISE_LOST_PINO_BIT) | |
317 | #define file_clear_cold(inode) clear_file(inode, FADVISE_COLD_BIT) | |
318 | #define file_got_pino(inode) clear_file(inode, FADVISE_LOST_PINO_BIT) | |
953a3e27 | 319 | |
39a53e0c JK |
320 | static inline int is_cold_data(struct page *page) |
321 | { | |
322 | return PageChecked(page); | |
323 | } | |
324 | ||
325 | static inline void set_cold_data(struct page *page) | |
326 | { | |
327 | SetPageChecked(page); | |
328 | } | |
329 | ||
330 | static inline void clear_cold_data(struct page *page) | |
331 | { | |
332 | ClearPageChecked(page); | |
333 | } | |
334 | ||
a06a2416 | 335 | static inline int is_node(struct page *page, int type) |
39a53e0c | 336 | { |
45590710 | 337 | struct f2fs_node *rn = F2FS_NODE(page); |
a06a2416 | 338 | return le32_to_cpu(rn->footer.flag) & (1 << type); |
39a53e0c JK |
339 | } |
340 | ||
a06a2416 NJ |
341 | #define is_cold_node(page) is_node(page, COLD_BIT_SHIFT) |
342 | #define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT) | |
343 | #define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT) | |
39a53e0c JK |
344 | |
345 | static inline void set_cold_node(struct inode *inode, struct page *page) | |
346 | { | |
45590710 | 347 | struct f2fs_node *rn = F2FS_NODE(page); |
39a53e0c JK |
348 | unsigned int flag = le32_to_cpu(rn->footer.flag); |
349 | ||
350 | if (S_ISDIR(inode->i_mode)) | |
351 | flag &= ~(0x1 << COLD_BIT_SHIFT); | |
352 | else | |
353 | flag |= (0x1 << COLD_BIT_SHIFT); | |
354 | rn->footer.flag = cpu_to_le32(flag); | |
355 | } | |
356 | ||
a06a2416 | 357 | static inline void set_mark(struct page *page, int mark, int type) |
39a53e0c | 358 | { |
45590710 | 359 | struct f2fs_node *rn = F2FS_NODE(page); |
39a53e0c JK |
360 | unsigned int flag = le32_to_cpu(rn->footer.flag); |
361 | if (mark) | |
a06a2416 | 362 | flag |= (0x1 << type); |
39a53e0c | 363 | else |
a06a2416 | 364 | flag &= ~(0x1 << type); |
39a53e0c JK |
365 | rn->footer.flag = cpu_to_le32(flag); |
366 | } | |
a06a2416 NJ |
367 | #define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT) |
368 | #define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT) |