]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/f2fs/f2fs.h
f2fs: avoid RECLAIM_FS-ON-W: deadlock
[mirror_ubuntu-jammy-kernel.git] / fs / f2fs / f2fs.h
CommitLineData
0a8165d7 1/*
39a53e0c
JK
2 * fs/f2fs/f2fs.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#ifndef _LINUX_F2FS_H
12#define _LINUX_F2FS_H
13
14#include <linux/types.h>
15#include <linux/page-flags.h>
16#include <linux/buffer_head.h>
39a53e0c
JK
17#include <linux/slab.h>
18#include <linux/crc32.h>
19#include <linux/magic.h>
20
21/*
22 * For mount options
23 */
24#define F2FS_MOUNT_BG_GC 0x00000001
25#define F2FS_MOUNT_DISABLE_ROLL_FORWARD 0x00000002
26#define F2FS_MOUNT_DISCARD 0x00000004
27#define F2FS_MOUNT_NOHEAP 0x00000008
28#define F2FS_MOUNT_XATTR_USER 0x00000010
29#define F2FS_MOUNT_POSIX_ACL 0x00000020
30#define F2FS_MOUNT_DISABLE_EXT_IDENTIFY 0x00000040
31
32#define clear_opt(sbi, option) (sbi->mount_opt.opt &= ~F2FS_MOUNT_##option)
33#define set_opt(sbi, option) (sbi->mount_opt.opt |= F2FS_MOUNT_##option)
34#define test_opt(sbi, option) (sbi->mount_opt.opt & F2FS_MOUNT_##option)
35
36#define ver_after(a, b) (typecheck(unsigned long long, a) && \
37 typecheck(unsigned long long, b) && \
38 ((long long)((a) - (b)) > 0))
39
40typedef u64 block_t;
41typedef u32 nid_t;
42
43struct f2fs_mount_info {
44 unsigned int opt;
45};
46
47static inline __u32 f2fs_crc32(void *buff, size_t len)
48{
49 return crc32_le(F2FS_SUPER_MAGIC, buff, len);
50}
51
52static inline bool f2fs_crc_valid(__u32 blk_crc, void *buff, size_t buff_size)
53{
54 return f2fs_crc32(buff, buff_size) == blk_crc;
55}
56
57/*
58 * For checkpoint manager
59 */
60enum {
61 NAT_BITMAP,
62 SIT_BITMAP
63};
64
65/* for the list of orphan inodes */
66struct orphan_inode_entry {
67 struct list_head list; /* list head */
68 nid_t ino; /* inode number */
69};
70
71/* for the list of directory inodes */
72struct dir_inode_entry {
73 struct list_head list; /* list head */
74 struct inode *inode; /* vfs inode pointer */
75};
76
77/* for the list of fsync inodes, used only during recovery */
78struct fsync_inode_entry {
79 struct list_head list; /* list head */
80 struct inode *inode; /* vfs inode pointer */
81 block_t blkaddr; /* block address locating the last inode */
82};
83
84#define nats_in_cursum(sum) (le16_to_cpu(sum->n_nats))
85#define sits_in_cursum(sum) (le16_to_cpu(sum->n_sits))
86
87#define nat_in_journal(sum, i) (sum->nat_j.entries[i].ne)
88#define nid_in_journal(sum, i) (sum->nat_j.entries[i].nid)
89#define sit_in_journal(sum, i) (sum->sit_j.entries[i].se)
90#define segno_in_journal(sum, i) (sum->sit_j.entries[i].segno)
91
92static inline int update_nats_in_cursum(struct f2fs_summary_block *rs, int i)
93{
94 int before = nats_in_cursum(rs);
95 rs->n_nats = cpu_to_le16(before + i);
96 return before;
97}
98
99static inline int update_sits_in_cursum(struct f2fs_summary_block *rs, int i)
100{
101 int before = sits_in_cursum(rs);
102 rs->n_sits = cpu_to_le16(before + i);
103 return before;
104}
105
e9750824
NJ
106/*
107 * ioctl commands
108 */
109#define F2FS_IOC_GETFLAGS FS_IOC_GETFLAGS
110#define F2FS_IOC_SETFLAGS FS_IOC_SETFLAGS
111
112#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
113/*
114 * ioctl commands in 32 bit emulation
115 */
116#define F2FS_IOC32_GETFLAGS FS_IOC32_GETFLAGS
117#define F2FS_IOC32_SETFLAGS FS_IOC32_SETFLAGS
118#endif
119
39a53e0c
JK
120/*
121 * For INODE and NODE manager
122 */
123#define XATTR_NODE_OFFSET (-1) /*
124 * store xattrs to one node block per
125 * file keeping -1 as its node offset to
126 * distinguish from index node blocks.
127 */
266e97a8
JK
128enum {
129 ALLOC_NODE, /* allocate a new node page if needed */
130 LOOKUP_NODE, /* look up a node without readahead */
131 LOOKUP_NODE_RA, /*
132 * look up a node with readahead called
133 * by get_datablock_ro.
39a53e0c 134 */
266e97a8
JK
135};
136
39a53e0c
JK
137#define F2FS_LINK_MAX 32000 /* maximum link count per file */
138
139/* for in-memory extent cache entry */
140struct extent_info {
141 rwlock_t ext_lock; /* rwlock for consistency */
142 unsigned int fofs; /* start offset in a file */
143 u32 blk_addr; /* start block address of the extent */
111d2495 144 unsigned int len; /* length of the extent */
39a53e0c
JK
145};
146
147/*
148 * i_advise uses FADVISE_XXX_BIT. We can add additional hints later.
149 */
150#define FADVISE_COLD_BIT 0x01
953a3e27 151#define FADVISE_CP_BIT 0x02
39a53e0c
JK
152
153struct f2fs_inode_info {
154 struct inode vfs_inode; /* serve a vfs inode */
155 unsigned long i_flags; /* keep an inode flags for ioctl */
156 unsigned char i_advise; /* use to give file attribute hints */
157 unsigned int i_current_depth; /* use only in directory structure */
6666e6aa 158 unsigned int i_pino; /* parent inode number */
39a53e0c
JK
159 umode_t i_acl_mode; /* keep file acl mode temporarily */
160
161 /* Use below internally in f2fs*/
162 unsigned long flags; /* use to pass per-file flags */
39a53e0c
JK
163 atomic_t dirty_dents; /* # of dirty dentry pages */
164 f2fs_hash_t chash; /* hash value of given file name */
165 unsigned int clevel; /* maximum level of given file name */
166 nid_t i_xattr_nid; /* node id that contains xattrs */
167 struct extent_info ext; /* in-memory extent cache entry */
168};
169
170static inline void get_extent_info(struct extent_info *ext,
171 struct f2fs_extent i_ext)
172{
173 write_lock(&ext->ext_lock);
174 ext->fofs = le32_to_cpu(i_ext.fofs);
175 ext->blk_addr = le32_to_cpu(i_ext.blk_addr);
176 ext->len = le32_to_cpu(i_ext.len);
177 write_unlock(&ext->ext_lock);
178}
179
180static inline void set_raw_extent(struct extent_info *ext,
181 struct f2fs_extent *i_ext)
182{
183 read_lock(&ext->ext_lock);
184 i_ext->fofs = cpu_to_le32(ext->fofs);
185 i_ext->blk_addr = cpu_to_le32(ext->blk_addr);
186 i_ext->len = cpu_to_le32(ext->len);
187 read_unlock(&ext->ext_lock);
188}
189
190struct f2fs_nm_info {
191 block_t nat_blkaddr; /* base disk address of NAT */
192 nid_t max_nid; /* maximum possible node ids */
39a53e0c
JK
193 nid_t next_scan_nid; /* the next nid to be scanned */
194
195 /* NAT cache management */
196 struct radix_tree_root nat_root;/* root of the nat entry cache */
197 rwlock_t nat_tree_lock; /* protect nat_tree_lock */
198 unsigned int nat_cnt; /* the # of cached nat entries */
199 struct list_head nat_entries; /* cached nat entry list (clean) */
200 struct list_head dirty_nat_entries; /* cached nat entry list (dirty) */
201
202 /* free node ids management */
203 struct list_head free_nid_list; /* a list for free nids */
204 spinlock_t free_nid_list_lock; /* protect free nid list */
205 unsigned int fcnt; /* the number of free node id */
206 struct mutex build_lock; /* lock for build free nids */
207
208 /* for checkpoint */
209 char *nat_bitmap; /* NAT bitmap pointer */
210 int bitmap_size; /* bitmap size */
211};
212
213/*
214 * this structure is used as one of function parameters.
215 * all the information are dedicated to a given direct node block determined
216 * by the data offset in a file.
217 */
218struct dnode_of_data {
219 struct inode *inode; /* vfs inode pointer */
220 struct page *inode_page; /* its inode page, NULL is possible */
221 struct page *node_page; /* cached direct node page */
222 nid_t nid; /* node id of the direct node block */
223 unsigned int ofs_in_node; /* data offset in the node page */
224 bool inode_page_locked; /* inode page is locked or not */
225 block_t data_blkaddr; /* block address of the node block */
226};
227
228static inline void set_new_dnode(struct dnode_of_data *dn, struct inode *inode,
229 struct page *ipage, struct page *npage, nid_t nid)
230{
d66d1f76 231 memset(dn, 0, sizeof(*dn));
39a53e0c
JK
232 dn->inode = inode;
233 dn->inode_page = ipage;
234 dn->node_page = npage;
235 dn->nid = nid;
39a53e0c
JK
236}
237
238/*
239 * For SIT manager
240 *
241 * By default, there are 6 active log areas across the whole main area.
242 * When considering hot and cold data separation to reduce cleaning overhead,
243 * we split 3 for data logs and 3 for node logs as hot, warm, and cold types,
244 * respectively.
245 * In the current design, you should not change the numbers intentionally.
246 * Instead, as a mount option such as active_logs=x, you can use 2, 4, and 6
247 * logs individually according to the underlying devices. (default: 6)
248 * Just in case, on-disk layout covers maximum 16 logs that consist of 8 for
249 * data and 8 for node logs.
250 */
251#define NR_CURSEG_DATA_TYPE (3)
252#define NR_CURSEG_NODE_TYPE (3)
253#define NR_CURSEG_TYPE (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE)
254
255enum {
256 CURSEG_HOT_DATA = 0, /* directory entry blocks */
257 CURSEG_WARM_DATA, /* data blocks */
258 CURSEG_COLD_DATA, /* multimedia or GCed data blocks */
259 CURSEG_HOT_NODE, /* direct node blocks of directory files */
260 CURSEG_WARM_NODE, /* direct node blocks of normal files */
261 CURSEG_COLD_NODE, /* indirect node blocks */
262 NO_CHECK_TYPE
263};
264
265struct f2fs_sm_info {
266 struct sit_info *sit_info; /* whole segment information */
267 struct free_segmap_info *free_info; /* free segment information */
268 struct dirty_seglist_info *dirty_info; /* dirty segment information */
269 struct curseg_info *curseg_array; /* active segment information */
270
271 struct list_head wblist_head; /* list of under-writeback pages */
272 spinlock_t wblist_lock; /* lock for checkpoint */
273
274 block_t seg0_blkaddr; /* block address of 0'th segment */
275 block_t main_blkaddr; /* start block address of main area */
276 block_t ssa_blkaddr; /* start block address of SSA area */
277
278 unsigned int segment_count; /* total # of segments */
279 unsigned int main_segments; /* # of segments in main area */
280 unsigned int reserved_segments; /* # of reserved segments */
281 unsigned int ovp_segments; /* # of overprovision segments */
282};
283
284/*
285 * For directory operation
286 */
287#define NODE_DIR1_BLOCK (ADDRS_PER_INODE + 1)
288#define NODE_DIR2_BLOCK (ADDRS_PER_INODE + 2)
289#define NODE_IND1_BLOCK (ADDRS_PER_INODE + 3)
290#define NODE_IND2_BLOCK (ADDRS_PER_INODE + 4)
291#define NODE_DIND_BLOCK (ADDRS_PER_INODE + 5)
292
293/*
294 * For superblock
295 */
296/*
297 * COUNT_TYPE for monitoring
298 *
299 * f2fs monitors the number of several block types such as on-writeback,
300 * dirty dentry blocks, dirty node blocks, and dirty meta blocks.
301 */
302enum count_type {
303 F2FS_WRITEBACK,
304 F2FS_DIRTY_DENTS,
305 F2FS_DIRTY_NODES,
306 F2FS_DIRTY_META,
307 NR_COUNT_TYPE,
308};
309
310/*
39936837
JK
311 * Uses as sbi->fs_lock[NR_GLOBAL_LOCKS].
312 * The checkpoint procedure blocks all the locks in this fs_lock array.
313 * Some FS operations grab free locks, and if there is no free lock,
314 * then wait to grab a lock in a round-robin manner.
39a53e0c 315 */
39936837 316#define NR_GLOBAL_LOCKS 8
39a53e0c
JK
317
318/*
319 * The below are the page types of bios used in submti_bio().
320 * The available types are:
321 * DATA User data pages. It operates as async mode.
322 * NODE Node pages. It operates as async mode.
323 * META FS metadata pages such as SIT, NAT, CP.
324 * NR_PAGE_TYPE The number of page types.
325 * META_FLUSH Make sure the previous pages are written
326 * with waiting the bio's completion
327 * ... Only can be used with META.
328 */
329enum page_type {
330 DATA,
331 NODE,
332 META,
333 NR_PAGE_TYPE,
334 META_FLUSH,
335};
336
337struct f2fs_sb_info {
338 struct super_block *sb; /* pointer to VFS super block */
339 struct buffer_head *raw_super_buf; /* buffer head of raw sb */
340 struct f2fs_super_block *raw_super; /* raw super block pointer */
341 int s_dirty; /* dirty flag for checkpoint */
342
343 /* for node-related operations */
344 struct f2fs_nm_info *nm_info; /* node manager */
345 struct inode *node_inode; /* cache node blocks */
346
347 /* for segment-related operations */
348 struct f2fs_sm_info *sm_info; /* segment manager */
349 struct bio *bio[NR_PAGE_TYPE]; /* bios to merge */
350 sector_t last_block_in_bio[NR_PAGE_TYPE]; /* last block number */
351 struct rw_semaphore bio_sem; /* IO semaphore */
352
353 /* for checkpoint */
354 struct f2fs_checkpoint *ckpt; /* raw checkpoint pointer */
355 struct inode *meta_inode; /* cache meta blocks */
39936837
JK
356 struct mutex cp_mutex; /* checkpoint procedure lock */
357 struct mutex fs_lock[NR_GLOBAL_LOCKS]; /* blocking FS operations */
358 struct mutex node_write; /* locking node writes */
39a53e0c 359 struct mutex writepages; /* mutex for writepages() */
39936837 360 unsigned char next_lock_num; /* round-robin global locks */
39a53e0c 361 int por_doing; /* recovery is doing or not */
55008d84 362 int on_build_free_nids; /* build_free_nids is doing */
39a53e0c
JK
363
364 /* for orphan inode management */
365 struct list_head orphan_inode_list; /* orphan inode list */
366 struct mutex orphan_inode_mutex; /* for orphan inode list */
367 unsigned int n_orphans; /* # of orphan inodes */
368
369 /* for directory inode management */
370 struct list_head dir_inode_list; /* dir inode list */
371 spinlock_t dir_inode_lock; /* for dir inode list lock */
372 unsigned int n_dirty_dirs; /* # of dir inodes */
373
374 /* basic file system units */
375 unsigned int log_sectors_per_block; /* log2 sectors per block */
376 unsigned int log_blocksize; /* log2 block size */
377 unsigned int blocksize; /* block size */
378 unsigned int root_ino_num; /* root inode number*/
379 unsigned int node_ino_num; /* node inode number*/
380 unsigned int meta_ino_num; /* meta inode number*/
381 unsigned int log_blocks_per_seg; /* log2 blocks per segment */
382 unsigned int blocks_per_seg; /* blocks per segment */
383 unsigned int segs_per_sec; /* segments per section */
384 unsigned int secs_per_zone; /* sections per zone */
385 unsigned int total_sections; /* total section count */
386 unsigned int total_node_count; /* total node block count */
387 unsigned int total_valid_node_count; /* valid node block count */
388 unsigned int total_valid_inode_count; /* valid inode count */
389 int active_logs; /* # of active logs */
390
391 block_t user_block_count; /* # of user blocks */
392 block_t total_valid_block_count; /* # of valid blocks */
393 block_t alloc_valid_block_count; /* # of allocated blocks */
394 block_t last_valid_block_count; /* for recovery */
395 u32 s_next_generation; /* for NFS support */
396 atomic_t nr_pages[NR_COUNT_TYPE]; /* # of pages, see count_type */
397
398 struct f2fs_mount_info mount_opt; /* mount options */
399
400 /* for cleaning operations */
401 struct mutex gc_mutex; /* mutex for GC */
402 struct f2fs_gc_kthread *gc_thread; /* GC thread */
5ec4e49f 403 unsigned int cur_victim_sec; /* current victim section num */
39a53e0c
JK
404
405 /*
406 * for stat information.
407 * one is for the LFS mode, and the other is for the SSR mode.
408 */
409 struct f2fs_stat_info *stat_info; /* FS status information */
410 unsigned int segment_count[2]; /* # of allocated segments */
411 unsigned int block_count[2]; /* # of allocated blocks */
412 unsigned int last_victim[2]; /* last victim segment # */
413 int total_hit_ext, read_hit_ext; /* extent cache hit ratio */
414 int bg_gc; /* background gc calls */
415 spinlock_t stat_lock; /* lock for stat operations */
416};
417
418/*
419 * Inline functions
420 */
421static inline struct f2fs_inode_info *F2FS_I(struct inode *inode)
422{
423 return container_of(inode, struct f2fs_inode_info, vfs_inode);
424}
425
426static inline struct f2fs_sb_info *F2FS_SB(struct super_block *sb)
427{
428 return sb->s_fs_info;
429}
430
431static inline struct f2fs_super_block *F2FS_RAW_SUPER(struct f2fs_sb_info *sbi)
432{
433 return (struct f2fs_super_block *)(sbi->raw_super);
434}
435
436static inline struct f2fs_checkpoint *F2FS_CKPT(struct f2fs_sb_info *sbi)
437{
438 return (struct f2fs_checkpoint *)(sbi->ckpt);
439}
440
441static inline struct f2fs_nm_info *NM_I(struct f2fs_sb_info *sbi)
442{
443 return (struct f2fs_nm_info *)(sbi->nm_info);
444}
445
446static inline struct f2fs_sm_info *SM_I(struct f2fs_sb_info *sbi)
447{
448 return (struct f2fs_sm_info *)(sbi->sm_info);
449}
450
451static inline struct sit_info *SIT_I(struct f2fs_sb_info *sbi)
452{
453 return (struct sit_info *)(SM_I(sbi)->sit_info);
454}
455
456static inline struct free_segmap_info *FREE_I(struct f2fs_sb_info *sbi)
457{
458 return (struct free_segmap_info *)(SM_I(sbi)->free_info);
459}
460
461static inline struct dirty_seglist_info *DIRTY_I(struct f2fs_sb_info *sbi)
462{
463 return (struct dirty_seglist_info *)(SM_I(sbi)->dirty_info);
464}
465
466static inline void F2FS_SET_SB_DIRT(struct f2fs_sb_info *sbi)
467{
468 sbi->s_dirty = 1;
469}
470
471static inline void F2FS_RESET_SB_DIRT(struct f2fs_sb_info *sbi)
472{
473 sbi->s_dirty = 0;
474}
475
25ca923b
JK
476static inline bool is_set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
477{
478 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
479 return ckpt_flags & f;
480}
481
482static inline void set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
483{
484 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
485 ckpt_flags |= f;
486 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
487}
488
489static inline void clear_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
490{
491 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
492 ckpt_flags &= (~f);
493 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
494}
495
39936837
JK
496static inline void mutex_lock_all(struct f2fs_sb_info *sbi)
497{
bfe35965
PZ
498 int i;
499
500 for (i = 0; i < NR_GLOBAL_LOCKS; i++) {
501 /*
502 * This is the only time we take multiple fs_lock[]
503 * instances; the order is immaterial since we
504 * always hold cp_mutex, which serializes multiple
505 * such operations.
506 */
507 mutex_lock_nest_lock(&sbi->fs_lock[i], &sbi->cp_mutex);
508 }
39936837
JK
509}
510
511static inline void mutex_unlock_all(struct f2fs_sb_info *sbi)
39a53e0c 512{
39936837
JK
513 int i = 0;
514 for (; i < NR_GLOBAL_LOCKS; i++)
515 mutex_unlock(&sbi->fs_lock[i]);
39a53e0c
JK
516}
517
39936837 518static inline int mutex_lock_op(struct f2fs_sb_info *sbi)
39a53e0c 519{
39936837
JK
520 unsigned char next_lock = sbi->next_lock_num % NR_GLOBAL_LOCKS;
521 int i = 0;
522
523 for (; i < NR_GLOBAL_LOCKS; i++)
524 if (mutex_trylock(&sbi->fs_lock[i]))
525 return i;
526
527 mutex_lock(&sbi->fs_lock[next_lock]);
528 sbi->next_lock_num++;
529 return next_lock;
530}
531
532static inline void mutex_unlock_op(struct f2fs_sb_info *sbi, int ilock)
533{
534 if (ilock < 0)
535 return;
536 BUG_ON(ilock >= NR_GLOBAL_LOCKS);
537 mutex_unlock(&sbi->fs_lock[ilock]);
39a53e0c
JK
538}
539
540/*
541 * Check whether the given nid is within node id range.
542 */
064e0823 543static inline int check_nid_range(struct f2fs_sb_info *sbi, nid_t nid)
39a53e0c 544{
064e0823
NJ
545 WARN_ON((nid >= NM_I(sbi)->max_nid));
546 if (nid >= NM_I(sbi)->max_nid)
547 return -EINVAL;
548 return 0;
39a53e0c
JK
549}
550
551#define F2FS_DEFAULT_ALLOCATED_BLOCKS 1
552
553/*
554 * Check whether the inode has blocks or not
555 */
556static inline int F2FS_HAS_BLOCKS(struct inode *inode)
557{
558 if (F2FS_I(inode)->i_xattr_nid)
559 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS + 1);
560 else
561 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS);
562}
563
564static inline bool inc_valid_block_count(struct f2fs_sb_info *sbi,
565 struct inode *inode, blkcnt_t count)
566{
567 block_t valid_block_count;
568
569 spin_lock(&sbi->stat_lock);
570 valid_block_count =
571 sbi->total_valid_block_count + (block_t)count;
572 if (valid_block_count > sbi->user_block_count) {
573 spin_unlock(&sbi->stat_lock);
574 return false;
575 }
576 inode->i_blocks += count;
577 sbi->total_valid_block_count = valid_block_count;
578 sbi->alloc_valid_block_count += (block_t)count;
579 spin_unlock(&sbi->stat_lock);
580 return true;
581}
582
583static inline int dec_valid_block_count(struct f2fs_sb_info *sbi,
584 struct inode *inode,
585 blkcnt_t count)
586{
587 spin_lock(&sbi->stat_lock);
588 BUG_ON(sbi->total_valid_block_count < (block_t) count);
589 BUG_ON(inode->i_blocks < count);
590 inode->i_blocks -= count;
591 sbi->total_valid_block_count -= (block_t)count;
592 spin_unlock(&sbi->stat_lock);
593 return 0;
594}
595
596static inline void inc_page_count(struct f2fs_sb_info *sbi, int count_type)
597{
598 atomic_inc(&sbi->nr_pages[count_type]);
599 F2FS_SET_SB_DIRT(sbi);
600}
601
602static inline void inode_inc_dirty_dents(struct inode *inode)
603{
604 atomic_inc(&F2FS_I(inode)->dirty_dents);
605}
606
607static inline void dec_page_count(struct f2fs_sb_info *sbi, int count_type)
608{
609 atomic_dec(&sbi->nr_pages[count_type]);
610}
611
612static inline void inode_dec_dirty_dents(struct inode *inode)
613{
614 atomic_dec(&F2FS_I(inode)->dirty_dents);
615}
616
617static inline int get_pages(struct f2fs_sb_info *sbi, int count_type)
618{
619 return atomic_read(&sbi->nr_pages[count_type]);
620}
621
5ac206cf
NJ
622static inline int get_blocktype_secs(struct f2fs_sb_info *sbi, int block_type)
623{
624 unsigned int pages_per_sec = sbi->segs_per_sec *
625 (1 << sbi->log_blocks_per_seg);
626 return ((get_pages(sbi, block_type) + pages_per_sec - 1)
627 >> sbi->log_blocks_per_seg) / sbi->segs_per_sec;
628}
629
39a53e0c
JK
630static inline block_t valid_user_blocks(struct f2fs_sb_info *sbi)
631{
632 block_t ret;
633 spin_lock(&sbi->stat_lock);
634 ret = sbi->total_valid_block_count;
635 spin_unlock(&sbi->stat_lock);
636 return ret;
637}
638
639static inline unsigned long __bitmap_size(struct f2fs_sb_info *sbi, int flag)
640{
641 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
642
643 /* return NAT or SIT bitmap */
644 if (flag == NAT_BITMAP)
645 return le32_to_cpu(ckpt->nat_ver_bitmap_bytesize);
646 else if (flag == SIT_BITMAP)
647 return le32_to_cpu(ckpt->sit_ver_bitmap_bytesize);
648
649 return 0;
650}
651
652static inline void *__bitmap_ptr(struct f2fs_sb_info *sbi, int flag)
653{
654 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
25ca923b
JK
655 int offset = (flag == NAT_BITMAP) ?
656 le32_to_cpu(ckpt->sit_ver_bitmap_bytesize) : 0;
39a53e0c
JK
657 return &ckpt->sit_nat_version_bitmap + offset;
658}
659
660static inline block_t __start_cp_addr(struct f2fs_sb_info *sbi)
661{
662 block_t start_addr;
663 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
664 unsigned long long ckpt_version = le64_to_cpu(ckpt->checkpoint_ver);
665
25ca923b 666 start_addr = le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_blkaddr);
39a53e0c
JK
667
668 /*
669 * odd numbered checkpoint should at cp segment 0
670 * and even segent must be at cp segment 1
671 */
672 if (!(ckpt_version & 1))
673 start_addr += sbi->blocks_per_seg;
674
675 return start_addr;
676}
677
678static inline block_t __start_sum_addr(struct f2fs_sb_info *sbi)
679{
680 return le32_to_cpu(F2FS_CKPT(sbi)->cp_pack_start_sum);
681}
682
683static inline bool inc_valid_node_count(struct f2fs_sb_info *sbi,
684 struct inode *inode,
685 unsigned int count)
686{
687 block_t valid_block_count;
688 unsigned int valid_node_count;
689
690 spin_lock(&sbi->stat_lock);
691
692 valid_block_count = sbi->total_valid_block_count + (block_t)count;
693 sbi->alloc_valid_block_count += (block_t)count;
694 valid_node_count = sbi->total_valid_node_count + count;
695
696 if (valid_block_count > sbi->user_block_count) {
697 spin_unlock(&sbi->stat_lock);
698 return false;
699 }
700
701 if (valid_node_count > sbi->total_node_count) {
702 spin_unlock(&sbi->stat_lock);
703 return false;
704 }
705
706 if (inode)
707 inode->i_blocks += count;
708 sbi->total_valid_node_count = valid_node_count;
709 sbi->total_valid_block_count = valid_block_count;
710 spin_unlock(&sbi->stat_lock);
711
712 return true;
713}
714
715static inline void dec_valid_node_count(struct f2fs_sb_info *sbi,
716 struct inode *inode,
717 unsigned int count)
718{
719 spin_lock(&sbi->stat_lock);
720
721 BUG_ON(sbi->total_valid_block_count < count);
722 BUG_ON(sbi->total_valid_node_count < count);
723 BUG_ON(inode->i_blocks < count);
724
725 inode->i_blocks -= count;
726 sbi->total_valid_node_count -= count;
727 sbi->total_valid_block_count -= (block_t)count;
728
729 spin_unlock(&sbi->stat_lock);
730}
731
732static inline unsigned int valid_node_count(struct f2fs_sb_info *sbi)
733{
734 unsigned int ret;
735 spin_lock(&sbi->stat_lock);
736 ret = sbi->total_valid_node_count;
737 spin_unlock(&sbi->stat_lock);
738 return ret;
739}
740
741static inline void inc_valid_inode_count(struct f2fs_sb_info *sbi)
742{
743 spin_lock(&sbi->stat_lock);
744 BUG_ON(sbi->total_valid_inode_count == sbi->total_node_count);
745 sbi->total_valid_inode_count++;
746 spin_unlock(&sbi->stat_lock);
747}
748
749static inline int dec_valid_inode_count(struct f2fs_sb_info *sbi)
750{
751 spin_lock(&sbi->stat_lock);
752 BUG_ON(!sbi->total_valid_inode_count);
753 sbi->total_valid_inode_count--;
754 spin_unlock(&sbi->stat_lock);
755 return 0;
756}
757
758static inline unsigned int valid_inode_count(struct f2fs_sb_info *sbi)
759{
760 unsigned int ret;
761 spin_lock(&sbi->stat_lock);
762 ret = sbi->total_valid_inode_count;
763 spin_unlock(&sbi->stat_lock);
764 return ret;
765}
766
767static inline void f2fs_put_page(struct page *page, int unlock)
768{
769 if (!page || IS_ERR(page))
770 return;
771
772 if (unlock) {
773 BUG_ON(!PageLocked(page));
774 unlock_page(page);
775 }
776 page_cache_release(page);
777}
778
779static inline void f2fs_put_dnode(struct dnode_of_data *dn)
780{
781 if (dn->node_page)
782 f2fs_put_page(dn->node_page, 1);
783 if (dn->inode_page && dn->node_page != dn->inode_page)
784 f2fs_put_page(dn->inode_page, 0);
785 dn->node_page = NULL;
786 dn->inode_page = NULL;
787}
788
789static inline struct kmem_cache *f2fs_kmem_cache_create(const char *name,
790 size_t size, void (*ctor)(void *))
791{
792 return kmem_cache_create(name, size, 0, SLAB_RECLAIM_ACCOUNT, ctor);
793}
794
795#define RAW_IS_INODE(p) ((p)->footer.nid == (p)->footer.ino)
796
797static inline bool IS_INODE(struct page *page)
798{
799 struct f2fs_node *p = (struct f2fs_node *)page_address(page);
800 return RAW_IS_INODE(p);
801}
802
803static inline __le32 *blkaddr_in_node(struct f2fs_node *node)
804{
805 return RAW_IS_INODE(node) ? node->i.i_addr : node->dn.addr;
806}
807
808static inline block_t datablock_addr(struct page *node_page,
809 unsigned int offset)
810{
811 struct f2fs_node *raw_node;
812 __le32 *addr_array;
813 raw_node = (struct f2fs_node *)page_address(node_page);
814 addr_array = blkaddr_in_node(raw_node);
815 return le32_to_cpu(addr_array[offset]);
816}
817
818static inline int f2fs_test_bit(unsigned int nr, char *addr)
819{
820 int mask;
821
822 addr += (nr >> 3);
823 mask = 1 << (7 - (nr & 0x07));
824 return mask & *addr;
825}
826
827static inline int f2fs_set_bit(unsigned int nr, char *addr)
828{
829 int mask;
830 int ret;
831
832 addr += (nr >> 3);
833 mask = 1 << (7 - (nr & 0x07));
834 ret = mask & *addr;
835 *addr |= mask;
836 return ret;
837}
838
839static inline int f2fs_clear_bit(unsigned int nr, char *addr)
840{
841 int mask;
842 int ret;
843
844 addr += (nr >> 3);
845 mask = 1 << (7 - (nr & 0x07));
846 ret = mask & *addr;
847 *addr &= ~mask;
848 return ret;
849}
850
851/* used for f2fs_inode_info->flags */
852enum {
853 FI_NEW_INODE, /* indicate newly allocated inode */
39a53e0c
JK
854 FI_INC_LINK, /* need to increment i_nlink */
855 FI_ACL_MODE, /* indicate acl mode */
856 FI_NO_ALLOC, /* should not allocate any blocks */
74d0b917 857 FI_DELAY_IPUT, /* used for the recovery */
39a53e0c
JK
858};
859
860static inline void set_inode_flag(struct f2fs_inode_info *fi, int flag)
861{
862 set_bit(flag, &fi->flags);
863}
864
865static inline int is_inode_flag_set(struct f2fs_inode_info *fi, int flag)
866{
867 return test_bit(flag, &fi->flags);
868}
869
870static inline void clear_inode_flag(struct f2fs_inode_info *fi, int flag)
871{
872 clear_bit(flag, &fi->flags);
873}
874
875static inline void set_acl_inode(struct f2fs_inode_info *fi, umode_t mode)
876{
877 fi->i_acl_mode = mode;
878 set_inode_flag(fi, FI_ACL_MODE);
879}
880
881static inline int cond_clear_inode_flag(struct f2fs_inode_info *fi, int flag)
882{
883 if (is_inode_flag_set(fi, FI_ACL_MODE)) {
884 clear_inode_flag(fi, FI_ACL_MODE);
885 return 1;
886 }
887 return 0;
888}
889
890/*
891 * file.c
892 */
893int f2fs_sync_file(struct file *, loff_t, loff_t, int);
894void truncate_data_blocks(struct dnode_of_data *);
895void f2fs_truncate(struct inode *);
896int f2fs_setattr(struct dentry *, struct iattr *);
897int truncate_hole(struct inode *, pgoff_t, pgoff_t);
898long f2fs_ioctl(struct file *, unsigned int, unsigned long);
e9750824 899long f2fs_compat_ioctl(struct file *, unsigned int, unsigned long);
39a53e0c
JK
900
901/*
902 * inode.c
903 */
904void f2fs_set_inode_flags(struct inode *);
39a53e0c
JK
905struct inode *f2fs_iget(struct super_block *, unsigned long);
906void update_inode(struct inode *, struct page *);
39936837 907int update_inode_page(struct inode *);
39a53e0c
JK
908int f2fs_write_inode(struct inode *, struct writeback_control *);
909void f2fs_evict_inode(struct inode *);
910
911/*
912 * namei.c
913 */
914struct dentry *f2fs_get_parent(struct dentry *child);
915
916/*
917 * dir.c
918 */
919struct f2fs_dir_entry *f2fs_find_entry(struct inode *, struct qstr *,
920 struct page **);
921struct f2fs_dir_entry *f2fs_parent_dir(struct inode *, struct page **);
922ino_t f2fs_inode_by_name(struct inode *, struct qstr *);
923void f2fs_set_link(struct inode *, struct f2fs_dir_entry *,
924 struct page *, struct inode *);
b7f7a5e0 925int __f2fs_add_link(struct inode *, const struct qstr *, struct inode *);
39a53e0c
JK
926void f2fs_delete_entry(struct f2fs_dir_entry *, struct page *, struct inode *);
927int f2fs_make_empty(struct inode *, struct inode *);
928bool f2fs_empty_dir(struct inode *);
929
b7f7a5e0
AV
930static inline int f2fs_add_link(struct dentry *dentry, struct inode *inode)
931{
932 return __f2fs_add_link(dentry->d_parent->d_inode, &dentry->d_name,
933 inode);
934}
935
39a53e0c
JK
936/*
937 * super.c
938 */
939int f2fs_sync_fs(struct super_block *, int);
a07ef784
NJ
940extern __printf(3, 4)
941void f2fs_msg(struct super_block *, const char *, const char *, ...);
39a53e0c
JK
942
943/*
944 * hash.c
945 */
9836b8b9 946f2fs_hash_t f2fs_dentry_hash(const char *, size_t);
39a53e0c
JK
947
948/*
949 * node.c
950 */
951struct dnode_of_data;
952struct node_info;
953
954int is_checkpointed_node(struct f2fs_sb_info *, nid_t);
955void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
956int get_dnode_of_data(struct dnode_of_data *, pgoff_t, int);
957int truncate_inode_blocks(struct inode *, pgoff_t);
958int remove_inode_page(struct inode *);
44a83ff6 959struct page *new_inode_page(struct inode *, const struct qstr *);
39a53e0c
JK
960struct page *new_node_page(struct dnode_of_data *, unsigned int);
961void ra_node_page(struct f2fs_sb_info *, nid_t);
962struct page *get_node_page(struct f2fs_sb_info *, pgoff_t);
963struct page *get_node_page_ra(struct page *, int);
964void sync_inode_page(struct dnode_of_data *);
965int sync_node_pages(struct f2fs_sb_info *, nid_t, struct writeback_control *);
966bool alloc_nid(struct f2fs_sb_info *, nid_t *);
967void alloc_nid_done(struct f2fs_sb_info *, nid_t);
968void alloc_nid_failed(struct f2fs_sb_info *, nid_t);
969void recover_node_page(struct f2fs_sb_info *, struct page *,
970 struct f2fs_summary *, struct node_info *, block_t);
971int recover_inode_page(struct f2fs_sb_info *, struct page *);
972int restore_node_summary(struct f2fs_sb_info *, unsigned int,
973 struct f2fs_summary_block *);
974void flush_nat_entries(struct f2fs_sb_info *);
975int build_node_manager(struct f2fs_sb_info *);
976void destroy_node_manager(struct f2fs_sb_info *);
6e6093a8 977int __init create_node_manager_caches(void);
39a53e0c
JK
978void destroy_node_manager_caches(void);
979
980/*
981 * segment.c
982 */
983void f2fs_balance_fs(struct f2fs_sb_info *);
984void invalidate_blocks(struct f2fs_sb_info *, block_t);
985void locate_dirty_segment(struct f2fs_sb_info *, unsigned int);
986void clear_prefree_segments(struct f2fs_sb_info *);
987int npages_for_summary_flush(struct f2fs_sb_info *);
988void allocate_new_segments(struct f2fs_sb_info *);
989struct page *get_sum_page(struct f2fs_sb_info *, unsigned int);
3cd8a239 990struct bio *f2fs_bio_alloc(struct block_device *, int);
39a53e0c 991void f2fs_submit_bio(struct f2fs_sb_info *, enum page_type, bool sync);
577e3495 992void write_meta_page(struct f2fs_sb_info *, struct page *);
39a53e0c
JK
993void write_node_page(struct f2fs_sb_info *, struct page *, unsigned int,
994 block_t, block_t *);
995void write_data_page(struct inode *, struct page *, struct dnode_of_data*,
996 block_t, block_t *);
997void rewrite_data_page(struct f2fs_sb_info *, struct page *, block_t);
998void recover_data_page(struct f2fs_sb_info *, struct page *,
999 struct f2fs_summary *, block_t, block_t);
1000void rewrite_node_page(struct f2fs_sb_info *, struct page *,
1001 struct f2fs_summary *, block_t, block_t);
1002void write_data_summaries(struct f2fs_sb_info *, block_t);
1003void write_node_summaries(struct f2fs_sb_info *, block_t);
1004int lookup_journal_in_cursum(struct f2fs_summary_block *,
1005 int, unsigned int, int);
1006void flush_sit_entries(struct f2fs_sb_info *);
1007int build_segment_manager(struct f2fs_sb_info *);
39a53e0c
JK
1008void destroy_segment_manager(struct f2fs_sb_info *);
1009
1010/*
1011 * checkpoint.c
1012 */
1013struct page *grab_meta_page(struct f2fs_sb_info *, pgoff_t);
1014struct page *get_meta_page(struct f2fs_sb_info *, pgoff_t);
1015long sync_meta_pages(struct f2fs_sb_info *, enum page_type, long);
1016int check_orphan_space(struct f2fs_sb_info *);
1017void add_orphan_inode(struct f2fs_sb_info *, nid_t);
1018void remove_orphan_inode(struct f2fs_sb_info *, nid_t);
1019int recover_orphan_inodes(struct f2fs_sb_info *);
1020int get_valid_checkpoint(struct f2fs_sb_info *);
1021void set_dirty_dir_page(struct inode *, struct page *);
1022void remove_dirty_dir_inode(struct inode *);
74d0b917 1023struct inode *check_dirty_dir_inode(struct f2fs_sb_info *, nid_t);
39a53e0c 1024void sync_dirty_dir_inodes(struct f2fs_sb_info *);
43727527 1025void write_checkpoint(struct f2fs_sb_info *, bool);
39a53e0c 1026void init_orphan_info(struct f2fs_sb_info *);
6e6093a8 1027int __init create_checkpoint_caches(void);
39a53e0c
JK
1028void destroy_checkpoint_caches(void);
1029
1030/*
1031 * data.c
1032 */
1033int reserve_new_block(struct dnode_of_data *);
1034void update_extent_cache(block_t, struct dnode_of_data *);
c718379b 1035struct page *find_data_page(struct inode *, pgoff_t, bool);
39a53e0c 1036struct page *get_lock_data_page(struct inode *, pgoff_t);
64aa7ed9 1037struct page *get_new_data_page(struct inode *, struct page *, pgoff_t, bool);
39a53e0c
JK
1038int f2fs_readpage(struct f2fs_sb_info *, struct page *, block_t, int);
1039int do_write_data_page(struct page *);
1040
1041/*
1042 * gc.c
1043 */
1044int start_gc_thread(struct f2fs_sb_info *);
1045void stop_gc_thread(struct f2fs_sb_info *);
1046block_t start_bidx_of_node(unsigned int);
408e9375 1047int f2fs_gc(struct f2fs_sb_info *);
39a53e0c 1048void build_gc_manager(struct f2fs_sb_info *);
6e6093a8 1049int __init create_gc_caches(void);
39a53e0c
JK
1050void destroy_gc_caches(void);
1051
1052/*
1053 * recovery.c
1054 */
6ead1142 1055int recover_fsync_data(struct f2fs_sb_info *);
39a53e0c
JK
1056bool space_for_roll_forward(struct f2fs_sb_info *);
1057
1058/*
1059 * debug.c
1060 */
1061#ifdef CONFIG_F2FS_STAT_FS
1062struct f2fs_stat_info {
1063 struct list_head stat_list;
1064 struct f2fs_sb_info *sbi;
1065 struct mutex stat_lock;
1066 int all_area_segs, sit_area_segs, nat_area_segs, ssa_area_segs;
1067 int main_area_segs, main_area_sections, main_area_zones;
1068 int hit_ext, total_ext;
1069 int ndirty_node, ndirty_dent, ndirty_dirs, ndirty_meta;
1070 int nats, sits, fnids;
1071 int total_count, utilization;
1072 int bg_gc;
1073 unsigned int valid_count, valid_node_count, valid_inode_count;
1074 unsigned int bimodal, avg_vblocks;
1075 int util_free, util_valid, util_invalid;
1076 int rsvd_segs, overp_segs;
1077 int dirty_count, node_pages, meta_pages;
1078 int prefree_count, call_count;
1079 int tot_segs, node_segs, data_segs, free_segs, free_secs;
1080 int tot_blks, data_blks, node_blks;
1081 int curseg[NR_CURSEG_TYPE];
1082 int cursec[NR_CURSEG_TYPE];
1083 int curzone[NR_CURSEG_TYPE];
1084
1085 unsigned int segment_count[2];
1086 unsigned int block_count[2];
1087 unsigned base_mem, cache_mem;
1088};
1089
1090#define stat_inc_call_count(si) ((si)->call_count++)
1091
1092#define stat_inc_seg_count(sbi, type) \
1093 do { \
1094 struct f2fs_stat_info *si = sbi->stat_info; \
1095 (si)->tot_segs++; \
1096 if (type == SUM_TYPE_DATA) \
1097 si->data_segs++; \
1098 else \
1099 si->node_segs++; \
1100 } while (0)
1101
1102#define stat_inc_tot_blk_count(si, blks) \
1103 (si->tot_blks += (blks))
1104
1105#define stat_inc_data_blk_count(sbi, blks) \
1106 do { \
1107 struct f2fs_stat_info *si = sbi->stat_info; \
1108 stat_inc_tot_blk_count(si, blks); \
1109 si->data_blks += (blks); \
1110 } while (0)
1111
1112#define stat_inc_node_blk_count(sbi, blks) \
1113 do { \
1114 struct f2fs_stat_info *si = sbi->stat_info; \
1115 stat_inc_tot_blk_count(si, blks); \
1116 si->node_blks += (blks); \
1117 } while (0)
1118
1119int f2fs_build_stats(struct f2fs_sb_info *);
1120void f2fs_destroy_stats(struct f2fs_sb_info *);
6e6093a8 1121void __init f2fs_create_root_stats(void);
4589d25d 1122void f2fs_destroy_root_stats(void);
39a53e0c
JK
1123#else
1124#define stat_inc_call_count(si)
1125#define stat_inc_seg_count(si, type)
1126#define stat_inc_tot_blk_count(si, blks)
1127#define stat_inc_data_blk_count(si, blks)
1128#define stat_inc_node_blk_count(sbi, blks)
1129
1130static inline int f2fs_build_stats(struct f2fs_sb_info *sbi) { return 0; }
1131static inline void f2fs_destroy_stats(struct f2fs_sb_info *sbi) { }
6e6093a8 1132static inline void __init f2fs_create_root_stats(void) { }
4589d25d 1133static inline void f2fs_destroy_root_stats(void) { }
39a53e0c
JK
1134#endif
1135
1136extern const struct file_operations f2fs_dir_operations;
1137extern const struct file_operations f2fs_file_operations;
1138extern const struct inode_operations f2fs_file_inode_operations;
1139extern const struct address_space_operations f2fs_dblock_aops;
1140extern const struct address_space_operations f2fs_node_aops;
1141extern const struct address_space_operations f2fs_meta_aops;
1142extern const struct inode_operations f2fs_dir_inode_operations;
1143extern const struct inode_operations f2fs_symlink_inode_operations;
1144extern const struct inode_operations f2fs_special_inode_operations;
1145#endif