blob: e4fffd2d98c4b99f88a64e447395fe3f907d6dbc [file] [log] [blame]
Jaegeuk Kim0a8165d2012-11-29 13:28:09 +09001/*
Jaegeuk Kim39a53e02012-11-28 13:37:31 +09002 * 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
Chao Yuea1a29a02015-10-12 17:08:48 +080017/* # of pages to perform synchronous readahead before building free nids */
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090018#define FREE_NID_PAGES 4
19
Chao Yuea1a29a02015-10-12 17:08:48 +080020#define DEF_RA_NID_PAGES 4 /* # of nid pages to be readaheaded */
21
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090022/* maximum readahead size for node during getting data blocks */
23#define MAX_RA_NODE 128
24
Jaegeuk Kimcdfc41c2014-03-19 13:31:37 +090025/* control the memory footprint threshold (10MB per 1GB ram) */
26#define DEF_RAM_THRESHOLD 10
27
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090028/* vector size for gang look-up from nat cache that consists of radix tree */
29#define NATVEC_SIZE 64
Jaegeuk Kim7aed0d42015-01-07 10:47:57 -080030#define SETVEC_SIZE 32
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090031
Jaegeuk Kim56ae6742013-03-31 12:47:20 +090032/* return value for read_node_page */
33#define LOCKED_PAGE 1
34
Chao Yu5c27f4e2014-12-18 17:37:21 +080035/* For flag in struct node_info */
36enum {
37 IS_CHECKPOINTED, /* is it checkpointed before? */
38 HAS_FSYNCED_INODE, /* is the inode fsynced before? */
39 HAS_LAST_FSYNC, /* has the latest node fsync mark? */
40 IS_DIRTY, /* this nat entry is dirty? */
41};
42
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090043/*
44 * For node information
45 */
46struct node_info {
47 nid_t nid; /* node id */
48 nid_t ino; /* inode number of the node's owner */
49 block_t blk_addr; /* block address of the node */
50 unsigned char version; /* version of the node */
Chao Yu5c27f4e2014-12-18 17:37:21 +080051 unsigned char flag; /* for node information bits */
Jaegeuk Kim7ef35e32014-09-15 12:07:13 -070052};
53
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090054struct nat_entry {
55 struct list_head list; /* for clean or dirty nat list */
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090056 struct node_info ni; /* in-memory node information */
57};
58
59#define nat_get_nid(nat) (nat->ni.nid)
60#define nat_set_nid(nat, n) (nat->ni.nid = n)
61#define nat_get_blkaddr(nat) (nat->ni.blk_addr)
62#define nat_set_blkaddr(nat, b) (nat->ni.blk_addr = b)
63#define nat_get_ino(nat) (nat->ni.ino)
64#define nat_set_ino(nat, i) (nat->ni.ino = i)
65#define nat_get_version(nat) (nat->ni.version)
66#define nat_set_version(nat, v) (nat->ni.version = v)
67
Jaegeuk Kim39a53e02012-11-28 13:37:31 +090068#define inc_node_version(version) (++version)
69
Chao Yu5c27f4e2014-12-18 17:37:21 +080070static inline void copy_node_info(struct node_info *dst,
71 struct node_info *src)
72{
73 dst->nid = src->nid;
74 dst->ino = src->ino;
75 dst->blk_addr = src->blk_addr;
76 dst->version = src->version;
77 /* should not copy flag here */
78}
79
Jaegeuk Kim7ef35e32014-09-15 12:07:13 -070080static inline void set_nat_flag(struct nat_entry *ne,
81 unsigned int type, bool set)
82{
83 unsigned char mask = 0x01 << type;
84 if (set)
Chao Yu5c27f4e2014-12-18 17:37:21 +080085 ne->ni.flag |= mask;
Jaegeuk Kim7ef35e32014-09-15 12:07:13 -070086 else
Chao Yu5c27f4e2014-12-18 17:37:21 +080087 ne->ni.flag &= ~mask;
Jaegeuk Kim7ef35e32014-09-15 12:07:13 -070088}
89
90static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
91{
92 unsigned char mask = 0x01 << type;
Chao Yu5c27f4e2014-12-18 17:37:21 +080093 return ne->ni.flag & mask;
Jaegeuk Kim7ef35e32014-09-15 12:07:13 -070094}
95
Jaegeuk Kim88bd02c2014-09-15 14:50:48 -070096static inline void nat_reset_flag(struct nat_entry *ne)
97{
98 /* these states can be set only after checkpoint was done */
99 set_nat_flag(ne, IS_CHECKPOINTED, true);
100 set_nat_flag(ne, HAS_FSYNCED_INODE, false);
101 set_nat_flag(ne, HAS_LAST_FSYNC, true);
102}
103
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900104static inline void node_info_from_raw_nat(struct node_info *ni,
105 struct f2fs_nat_entry *raw_ne)
106{
107 ni->ino = le32_to_cpu(raw_ne->ino);
108 ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
109 ni->version = raw_ne->version;
110}
111
Chao Yu94dac222014-04-17 10:51:05 +0800112static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
113 struct node_info *ni)
114{
115 raw_ne->ino = cpu_to_le32(ni->ino);
116 raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
117 raw_ne->version = ni->version;
118}
119
Jaegeuk Kim6fb03f32014-04-16 10:47:06 +0900120enum mem_type {
Jaegeuk Kimcdfc41c2014-03-19 13:31:37 +0900121 FREE_NIDS, /* indicates the free nid list */
Jaegeuk Kim6fb03f32014-04-16 10:47:06 +0900122 NAT_ENTRIES, /* indicates the cached nat entry */
Jaegeuk Kima1257022015-10-08 10:40:07 -0700123 DIRTY_DENTS, /* indicates dirty dentry pages */
Jaegeuk Kime5e7ea32014-11-06 15:24:46 -0800124 INO_ENTRIES, /* indicates inode entries */
Chao Yu13054c52015-02-05 17:52:58 +0800125 EXTENT_CACHE, /* indicates extent cache */
Jaegeuk Kim1e843712014-12-09 06:08:59 -0800126 BASE_CHECK, /* check kernel status */
Jaegeuk Kimcdfc41c2014-03-19 13:31:37 +0900127};
128
Chao Yuaec71382014-06-24 09:18:20 +0800129struct nat_entry_set {
Jaegeuk Kim309cc2b2014-09-22 11:40:48 -0700130 struct list_head set_list; /* link with other nat sets */
Chao Yuaec71382014-06-24 09:18:20 +0800131 struct list_head entry_list; /* link with dirty nat entries */
Jaegeuk Kim309cc2b2014-09-22 11:40:48 -0700132 nid_t set; /* set number*/
Chao Yuaec71382014-06-24 09:18:20 +0800133 unsigned int entry_cnt; /* the # of nat entries in set */
134};
135
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900136/*
137 * For free nid mangement
138 */
139enum nid_state {
140 NID_NEW, /* newly added to free nid list */
141 NID_ALLOC /* it is allocated */
142};
143
144struct free_nid {
145 struct list_head list; /* for free node id list */
146 nid_t nid; /* node id */
147 int state; /* in use or not: NID_NEW or NID_ALLOC */
148};
149
Jaegeuk Kim120c2cb2014-10-03 15:12:42 -0700150static inline void next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900151{
152 struct f2fs_nm_info *nm_i = NM_I(sbi);
153 struct free_nid *fnid;
154
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900155 spin_lock(&nm_i->free_nid_list_lock);
Huang Yingc6e48932014-09-12 19:21:11 +0800156 if (nm_i->fcnt <= 0) {
157 spin_unlock(&nm_i->free_nid_list_lock);
Jaegeuk Kim120c2cb2014-10-03 15:12:42 -0700158 return;
Huang Yingc6e48932014-09-12 19:21:11 +0800159 }
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900160 fnid = list_entry(nm_i->free_nid_list.next, struct free_nid, list);
161 *nid = fnid->nid;
162 spin_unlock(&nm_i->free_nid_list_lock);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900163}
164
165/*
166 * inline functions
167 */
168static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
169{
170 struct f2fs_nm_info *nm_i = NM_I(sbi);
171 memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
172}
173
174static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
175{
176 struct f2fs_nm_info *nm_i = NM_I(sbi);
177 pgoff_t block_off;
178 pgoff_t block_addr;
179 int seg_off;
180
181 block_off = NAT_BLOCK_OFFSET(start);
182 seg_off = block_off >> sbi->log_blocks_per_seg;
183
184 block_addr = (pgoff_t)(nm_i->nat_blkaddr +
185 (seg_off << sbi->log_blocks_per_seg << 1) +
186 (block_off & ((1 << sbi->log_blocks_per_seg) - 1)));
187
188 if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
189 block_addr += sbi->blocks_per_seg;
190
191 return block_addr;
192}
193
194static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
195 pgoff_t block_addr)
196{
197 struct f2fs_nm_info *nm_i = NM_I(sbi);
198
199 block_addr -= nm_i->nat_blkaddr;
200 if ((block_addr >> sbi->log_blocks_per_seg) % 2)
201 block_addr -= sbi->blocks_per_seg;
202 else
203 block_addr += sbi->blocks_per_seg;
204
205 return block_addr + nm_i->nat_blkaddr;
206}
207
208static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
209{
210 unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
211
Gu Zhengc6ac4c02014-10-20 17:45:50 +0800212 f2fs_change_bit(block_off, nm_i->nat_bitmap);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900213}
214
215static inline void fill_node_footer(struct page *page, nid_t nid,
216 nid_t ino, unsigned int ofs, bool reset)
217{
Gu Zheng45590712013-07-15 17:57:38 +0800218 struct f2fs_node *rn = F2FS_NODE(page);
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800219 unsigned int old_flag = 0;
220
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900221 if (reset)
222 memset(rn, 0, sizeof(*rn));
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800223 else
224 old_flag = le32_to_cpu(rn->footer.flag);
225
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900226 rn->footer.nid = cpu_to_le32(nid);
227 rn->footer.ino = cpu_to_le32(ino);
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800228
229 /* should remain old flag bits such as COLD_BIT_SHIFT */
230 rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) |
231 (old_flag & OFFSET_BIT_MASK));
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900232}
233
234static inline void copy_node_footer(struct page *dst, struct page *src)
235{
Gu Zheng45590712013-07-15 17:57:38 +0800236 struct f2fs_node *src_rn = F2FS_NODE(src);
237 struct f2fs_node *dst_rn = F2FS_NODE(dst);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900238 memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
239}
240
241static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
242{
Jaegeuk Kim40813632014-09-02 15:31:18 -0700243 struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
Gu Zheng45590712013-07-15 17:57:38 +0800244 struct f2fs_node *rn = F2FS_NODE(page);
245
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900246 rn->footer.cp_ver = ckpt->checkpoint_ver;
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900247 rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900248}
249
250static inline nid_t ino_of_node(struct page *node_page)
251{
Gu Zheng45590712013-07-15 17:57:38 +0800252 struct f2fs_node *rn = F2FS_NODE(node_page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900253 return le32_to_cpu(rn->footer.ino);
254}
255
256static inline nid_t nid_of_node(struct page *node_page)
257{
Gu Zheng45590712013-07-15 17:57:38 +0800258 struct f2fs_node *rn = F2FS_NODE(node_page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900259 return le32_to_cpu(rn->footer.nid);
260}
261
262static inline unsigned int ofs_of_node(struct page *node_page)
263{
Gu Zheng45590712013-07-15 17:57:38 +0800264 struct f2fs_node *rn = F2FS_NODE(node_page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900265 unsigned flag = le32_to_cpu(rn->footer.flag);
266 return flag >> OFFSET_BIT_SHIFT;
267}
268
269static inline unsigned long long cpver_of_node(struct page *node_page)
270{
Gu Zheng45590712013-07-15 17:57:38 +0800271 struct f2fs_node *rn = F2FS_NODE(node_page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900272 return le64_to_cpu(rn->footer.cp_ver);
273}
274
275static inline block_t next_blkaddr_of_node(struct page *node_page)
276{
Gu Zheng45590712013-07-15 17:57:38 +0800277 struct f2fs_node *rn = F2FS_NODE(node_page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900278 return le32_to_cpu(rn->footer.next_blkaddr);
279}
280
281/*
282 * f2fs assigns the following node offsets described as (num).
283 * N = NIDS_PER_BLOCK
284 *
285 * Inode block (0)
286 * |- direct node (1)
287 * |- direct node (2)
288 * |- indirect node (3)
289 * | `- direct node (4 => 4 + N - 1)
290 * |- indirect node (4 + N)
291 * | `- direct node (5 + N => 5 + 2N - 1)
292 * `- double indirect node (5 + 2N)
293 * `- indirect node (6 + 2N)
Chao Yu4f4124d2013-12-21 18:02:14 +0800294 * `- direct node
295 * ......
296 * `- indirect node ((6 + 2N) + x(N + 1))
297 * `- direct node
298 * ......
299 * `- indirect node ((6 + 2N) + (N - 1)(N + 1))
300 * `- direct node
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900301 */
302static inline bool IS_DNODE(struct page *node_page)
303{
304 unsigned int ofs = ofs_of_node(node_page);
Jaegeuk Kimdbe6a5f2013-08-09 08:14:06 +0900305
Chao Yu4bc8e9b2014-03-17 16:35:06 +0800306 if (f2fs_has_xattr_block(ofs))
Jaegeuk Kimdbe6a5f2013-08-09 08:14:06 +0900307 return false;
308
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900309 if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
310 ofs == 5 + 2 * NIDS_PER_BLOCK)
311 return false;
312 if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
313 ofs -= 6 + 2 * NIDS_PER_BLOCK;
Zhihui Zhang33151012013-04-07 12:57:04 -0400314 if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900315 return false;
316 }
317 return true;
318}
319
320static inline void set_nid(struct page *p, int off, nid_t nid, bool i)
321{
Gu Zheng45590712013-07-15 17:57:38 +0800322 struct f2fs_node *rn = F2FS_NODE(p);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900323
Jaegeuk Kim54b591d2014-04-29 17:28:32 +0900324 f2fs_wait_on_page_writeback(p, NODE);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900325
326 if (i)
327 rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
328 else
329 rn->in.nid[off] = cpu_to_le32(nid);
330 set_page_dirty(p);
331}
332
333static inline nid_t get_nid(struct page *p, int off, bool i)
334{
Gu Zheng45590712013-07-15 17:57:38 +0800335 struct f2fs_node *rn = F2FS_NODE(p);
336
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900337 if (i)
338 return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
339 return le32_to_cpu(rn->in.nid[off]);
340}
341
342/*
343 * Coldness identification:
344 * - Mark cold files in f2fs_inode_info
345 * - Mark cold node blocks in their node footer
346 * - Mark cold data pages in page cache
347 */
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900348static inline int is_cold_data(struct page *page)
349{
350 return PageChecked(page);
351}
352
353static inline void set_cold_data(struct page *page)
354{
355 SetPageChecked(page);
356}
357
358static inline void clear_cold_data(struct page *page)
359{
360 ClearPageChecked(page);
361}
362
Namjae Jeona06a2412013-05-23 22:58:40 +0900363static inline int is_node(struct page *page, int type)
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900364{
Gu Zheng45590712013-07-15 17:57:38 +0800365 struct f2fs_node *rn = F2FS_NODE(page);
Namjae Jeona06a2412013-05-23 22:58:40 +0900366 return le32_to_cpu(rn->footer.flag) & (1 << type);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900367}
368
Namjae Jeona06a2412013-05-23 22:58:40 +0900369#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
370#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
371#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900372
373static inline void set_cold_node(struct inode *inode, struct page *page)
374{
Gu Zheng45590712013-07-15 17:57:38 +0800375 struct f2fs_node *rn = F2FS_NODE(page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900376 unsigned int flag = le32_to_cpu(rn->footer.flag);
377
378 if (S_ISDIR(inode->i_mode))
379 flag &= ~(0x1 << COLD_BIT_SHIFT);
380 else
381 flag |= (0x1 << COLD_BIT_SHIFT);
382 rn->footer.flag = cpu_to_le32(flag);
383}
384
Namjae Jeona06a2412013-05-23 22:58:40 +0900385static inline void set_mark(struct page *page, int mark, int type)
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900386{
Gu Zheng45590712013-07-15 17:57:38 +0800387 struct f2fs_node *rn = F2FS_NODE(page);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900388 unsigned int flag = le32_to_cpu(rn->footer.flag);
389 if (mark)
Namjae Jeona06a2412013-05-23 22:58:40 +0900390 flag |= (0x1 << type);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900391 else
Namjae Jeona06a2412013-05-23 22:58:40 +0900392 flag &= ~(0x1 << type);
Jaegeuk Kim39a53e02012-11-28 13:37:31 +0900393 rn->footer.flag = cpu_to_le32(flag);
394}
Namjae Jeona06a2412013-05-23 22:58:40 +0900395#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
396#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)