]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - fs/f2fs/f2fs.h
f2fs: introduce FITRIM in f2fs_ioctl
[mirror_ubuntu-focal-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>
c2d715d1 20#include <linux/kobject.h>
7bd59381 21#include <linux/sched.h>
39a53e0c 22
5d56b671 23#ifdef CONFIG_F2FS_CHECK_FS
9850cf4a 24#define f2fs_bug_on(sbi, condition) BUG_ON(condition)
0daaad97 25#define f2fs_down_write(x, y) down_write_nest_lock(x, y)
5d56b671 26#else
9850cf4a
JK
27#define f2fs_bug_on(sbi, condition) \
28 do { \
29 if (unlikely(condition)) { \
30 WARN_ON(1); \
31 sbi->need_fsck = true; \
32 } \
33 } while (0)
0daaad97 34#define f2fs_down_write(x, y) down_write(x)
5d56b671
JK
35#endif
36
39a53e0c
JK
37/*
38 * For mount options
39 */
40#define F2FS_MOUNT_BG_GC 0x00000001
41#define F2FS_MOUNT_DISABLE_ROLL_FORWARD 0x00000002
42#define F2FS_MOUNT_DISCARD 0x00000004
43#define F2FS_MOUNT_NOHEAP 0x00000008
44#define F2FS_MOUNT_XATTR_USER 0x00000010
45#define F2FS_MOUNT_POSIX_ACL 0x00000020
46#define F2FS_MOUNT_DISABLE_EXT_IDENTIFY 0x00000040
444c580f 47#define F2FS_MOUNT_INLINE_XATTR 0x00000080
1001b347 48#define F2FS_MOUNT_INLINE_DATA 0x00000100
6b4afdd7 49#define F2FS_MOUNT_FLUSH_MERGE 0x00000200
0f7b2abd 50#define F2FS_MOUNT_NOBARRIER 0x00000400
39a53e0c
JK
51
52#define clear_opt(sbi, option) (sbi->mount_opt.opt &= ~F2FS_MOUNT_##option)
53#define set_opt(sbi, option) (sbi->mount_opt.opt |= F2FS_MOUNT_##option)
54#define test_opt(sbi, option) (sbi->mount_opt.opt & F2FS_MOUNT_##option)
55
56#define ver_after(a, b) (typecheck(unsigned long long, a) && \
57 typecheck(unsigned long long, b) && \
58 ((long long)((a) - (b)) > 0))
59
a9841c4d
JK
60typedef u32 block_t; /*
61 * should not change u32, since it is the on-disk block
62 * address format, __le32.
63 */
39a53e0c
JK
64typedef u32 nid_t;
65
66struct f2fs_mount_info {
67 unsigned int opt;
68};
69
7e586fa0
JK
70#define CRCPOLY_LE 0xedb88320
71
72static inline __u32 f2fs_crc32(void *buf, size_t len)
39a53e0c 73{
7e586fa0
JK
74 unsigned char *p = (unsigned char *)buf;
75 __u32 crc = F2FS_SUPER_MAGIC;
76 int i;
77
78 while (len--) {
79 crc ^= *p++;
80 for (i = 0; i < 8; i++)
81 crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
82 }
83 return crc;
39a53e0c
JK
84}
85
7e586fa0 86static inline bool f2fs_crc_valid(__u32 blk_crc, void *buf, size_t buf_size)
39a53e0c 87{
7e586fa0 88 return f2fs_crc32(buf, buf_size) == blk_crc;
39a53e0c
JK
89}
90
91/*
92 * For checkpoint manager
93 */
94enum {
95 NAT_BITMAP,
96 SIT_BITMAP
97};
98
75ab4cb8
JK
99enum {
100 CP_UMOUNT,
101 CP_SYNC,
4b2fecc8 102 CP_DISCARD,
75ab4cb8
JK
103};
104
105struct cp_control {
106 int reason;
4b2fecc8
JK
107 __u64 trim_start;
108 __u64 trim_end;
109 __u64 trim_minlen;
110 __u64 trimmed;
75ab4cb8
JK
111};
112
662befda 113/*
81c1a0f1 114 * For CP/NAT/SIT/SSA readahead
662befda
CY
115 */
116enum {
117 META_CP,
118 META_NAT,
81c1a0f1 119 META_SIT,
4c521f49
JK
120 META_SSA,
121 META_POR,
662befda
CY
122};
123
6451e041
JK
124/* for the list of ino */
125enum {
126 ORPHAN_INO, /* for orphan ino list */
fff04f90
JK
127 APPEND_INO, /* for append ino list */
128 UPDATE_INO, /* for update ino list */
6451e041
JK
129 MAX_INO_ENTRY, /* max. list */
130};
131
132struct ino_entry {
39a53e0c
JK
133 struct list_head list; /* list head */
134 nid_t ino; /* inode number */
135};
136
137/* for the list of directory inodes */
138struct dir_inode_entry {
139 struct list_head list; /* list head */
140 struct inode *inode; /* vfs inode pointer */
141};
142
7fd9e544
JK
143/* for the list of blockaddresses to be discarded */
144struct discard_entry {
145 struct list_head list; /* list head */
146 block_t blkaddr; /* block address to be discarded */
147 int len; /* # of consecutive blocks of the discard */
148};
149
39a53e0c
JK
150/* for the list of fsync inodes, used only during recovery */
151struct fsync_inode_entry {
152 struct list_head list; /* list head */
153 struct inode *inode; /* vfs inode pointer */
c52e1b10
JK
154 block_t blkaddr; /* block address locating the last fsync */
155 block_t last_dentry; /* block address locating the last dentry */
156 block_t last_inode; /* block address locating the last inode */
39a53e0c
JK
157};
158
159#define nats_in_cursum(sum) (le16_to_cpu(sum->n_nats))
160#define sits_in_cursum(sum) (le16_to_cpu(sum->n_sits))
161
162#define nat_in_journal(sum, i) (sum->nat_j.entries[i].ne)
163#define nid_in_journal(sum, i) (sum->nat_j.entries[i].nid)
164#define sit_in_journal(sum, i) (sum->sit_j.entries[i].se)
165#define segno_in_journal(sum, i) (sum->sit_j.entries[i].segno)
166
167static inline int update_nats_in_cursum(struct f2fs_summary_block *rs, int i)
168{
169 int before = nats_in_cursum(rs);
170 rs->n_nats = cpu_to_le16(before + i);
171 return before;
172}
173
174static inline int update_sits_in_cursum(struct f2fs_summary_block *rs, int i)
175{
176 int before = sits_in_cursum(rs);
177 rs->n_sits = cpu_to_le16(before + i);
178 return before;
179}
180
184a5cd2
CY
181static inline bool __has_cursum_space(struct f2fs_summary_block *sum, int size,
182 int type)
183{
184 if (type == NAT_JOURNAL)
185 return nats_in_cursum(sum) + size <= NAT_JOURNAL_ENTRIES;
186
187 return sits_in_cursum(sum) + size <= SIT_JOURNAL_ENTRIES;
188}
189
e9750824
NJ
190/*
191 * ioctl commands
192 */
193#define F2FS_IOC_GETFLAGS FS_IOC_GETFLAGS
194#define F2FS_IOC_SETFLAGS FS_IOC_SETFLAGS
195
196#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
197/*
198 * ioctl commands in 32 bit emulation
199 */
200#define F2FS_IOC32_GETFLAGS FS_IOC32_GETFLAGS
201#define F2FS_IOC32_SETFLAGS FS_IOC32_SETFLAGS
202#endif
203
39a53e0c
JK
204/*
205 * For INODE and NODE manager
206 */
dbe6a5ff
JK
207/*
208 * XATTR_NODE_OFFSET stores xattrs to one node block per file keeping -1
209 * as its node offset to distinguish from index node blocks.
210 * But some bits are used to mark the node block.
211 */
212#define XATTR_NODE_OFFSET ((((unsigned int)-1) << OFFSET_BIT_SHIFT) \
213 >> OFFSET_BIT_SHIFT)
266e97a8
JK
214enum {
215 ALLOC_NODE, /* allocate a new node page if needed */
216 LOOKUP_NODE, /* look up a node without readahead */
217 LOOKUP_NODE_RA, /*
218 * look up a node with readahead called
4f4124d0 219 * by get_data_block.
39a53e0c 220 */
266e97a8
JK
221};
222
39a53e0c
JK
223#define F2FS_LINK_MAX 32000 /* maximum link count per file */
224
817202d9
CY
225#define MAX_DIR_RA_PAGES 4 /* maximum ra pages of dir */
226
39a53e0c 227/* for in-memory extent cache entry */
c11abd1a
JK
228#define F2FS_MIN_EXTENT_LEN 16 /* minimum extent length */
229
39a53e0c
JK
230struct extent_info {
231 rwlock_t ext_lock; /* rwlock for consistency */
232 unsigned int fofs; /* start offset in a file */
233 u32 blk_addr; /* start block address of the extent */
111d2495 234 unsigned int len; /* length of the extent */
39a53e0c
JK
235};
236
237/*
238 * i_advise uses FADVISE_XXX_BIT. We can add additional hints later.
239 */
240#define FADVISE_COLD_BIT 0x01
354a3399 241#define FADVISE_LOST_PINO_BIT 0x02
39a53e0c 242
ab9fa662
JK
243#define DEF_DIR_LEVEL 0
244
39a53e0c
JK
245struct f2fs_inode_info {
246 struct inode vfs_inode; /* serve a vfs inode */
247 unsigned long i_flags; /* keep an inode flags for ioctl */
248 unsigned char i_advise; /* use to give file attribute hints */
38431545 249 unsigned char i_dir_level; /* use for dentry level for large dir */
39a53e0c 250 unsigned int i_current_depth; /* use only in directory structure */
6666e6aa 251 unsigned int i_pino; /* parent inode number */
39a53e0c
JK
252 umode_t i_acl_mode; /* keep file acl mode temporarily */
253
254 /* Use below internally in f2fs*/
255 unsigned long flags; /* use to pass per-file flags */
d928bfbf 256 struct rw_semaphore i_sem; /* protect fi info */
a7ffdbe2 257 atomic_t dirty_pages; /* # of dirty pages */
39a53e0c
JK
258 f2fs_hash_t chash; /* hash value of given file name */
259 unsigned int clevel; /* maximum level of given file name */
260 nid_t i_xattr_nid; /* node id that contains xattrs */
e518ff81 261 unsigned long long xattr_ver; /* cp version of xattr modification */
39a53e0c 262 struct extent_info ext; /* in-memory extent cache entry */
ed57c27f 263 struct dir_inode_entry *dirty_dir; /* the pointer of dirty dir */
39a53e0c
JK
264};
265
266static inline void get_extent_info(struct extent_info *ext,
267 struct f2fs_extent i_ext)
268{
269 write_lock(&ext->ext_lock);
270 ext->fofs = le32_to_cpu(i_ext.fofs);
271 ext->blk_addr = le32_to_cpu(i_ext.blk_addr);
272 ext->len = le32_to_cpu(i_ext.len);
273 write_unlock(&ext->ext_lock);
274}
275
276static inline void set_raw_extent(struct extent_info *ext,
277 struct f2fs_extent *i_ext)
278{
279 read_lock(&ext->ext_lock);
280 i_ext->fofs = cpu_to_le32(ext->fofs);
281 i_ext->blk_addr = cpu_to_le32(ext->blk_addr);
282 i_ext->len = cpu_to_le32(ext->len);
283 read_unlock(&ext->ext_lock);
284}
285
286struct f2fs_nm_info {
287 block_t nat_blkaddr; /* base disk address of NAT */
288 nid_t max_nid; /* maximum possible node ids */
7ee0eeab 289 nid_t available_nids; /* maximum available node ids */
39a53e0c 290 nid_t next_scan_nid; /* the next nid to be scanned */
cdfc41c1 291 unsigned int ram_thresh; /* control the memory footprint */
39a53e0c
JK
292
293 /* NAT cache management */
294 struct radix_tree_root nat_root;/* root of the nat entry cache */
295 rwlock_t nat_tree_lock; /* protect nat_tree_lock */
296 unsigned int nat_cnt; /* the # of cached nat entries */
297 struct list_head nat_entries; /* cached nat entry list (clean) */
298 struct list_head dirty_nat_entries; /* cached nat entry list (dirty) */
aec71382
CY
299 struct list_head nat_entry_set; /* nat entry set list */
300 unsigned int dirty_nat_cnt; /* total num of nat entries in set */
39a53e0c
JK
301
302 /* free node ids management */
8a7ed66a 303 struct radix_tree_root free_nid_root;/* root of the free_nid cache */
39a53e0c
JK
304 struct list_head free_nid_list; /* a list for free nids */
305 spinlock_t free_nid_list_lock; /* protect free nid list */
306 unsigned int fcnt; /* the number of free node id */
307 struct mutex build_lock; /* lock for build free nids */
308
309 /* for checkpoint */
310 char *nat_bitmap; /* NAT bitmap pointer */
311 int bitmap_size; /* bitmap size */
312};
313
314/*
315 * this structure is used as one of function parameters.
316 * all the information are dedicated to a given direct node block determined
317 * by the data offset in a file.
318 */
319struct dnode_of_data {
320 struct inode *inode; /* vfs inode pointer */
321 struct page *inode_page; /* its inode page, NULL is possible */
322 struct page *node_page; /* cached direct node page */
323 nid_t nid; /* node id of the direct node block */
324 unsigned int ofs_in_node; /* data offset in the node page */
325 bool inode_page_locked; /* inode page is locked or not */
326 block_t data_blkaddr; /* block address of the node block */
327};
328
329static inline void set_new_dnode(struct dnode_of_data *dn, struct inode *inode,
330 struct page *ipage, struct page *npage, nid_t nid)
331{
d66d1f76 332 memset(dn, 0, sizeof(*dn));
39a53e0c
JK
333 dn->inode = inode;
334 dn->inode_page = ipage;
335 dn->node_page = npage;
336 dn->nid = nid;
39a53e0c
JK
337}
338
339/*
340 * For SIT manager
341 *
342 * By default, there are 6 active log areas across the whole main area.
343 * When considering hot and cold data separation to reduce cleaning overhead,
344 * we split 3 for data logs and 3 for node logs as hot, warm, and cold types,
345 * respectively.
346 * In the current design, you should not change the numbers intentionally.
347 * Instead, as a mount option such as active_logs=x, you can use 2, 4, and 6
348 * logs individually according to the underlying devices. (default: 6)
349 * Just in case, on-disk layout covers maximum 16 logs that consist of 8 for
350 * data and 8 for node logs.
351 */
352#define NR_CURSEG_DATA_TYPE (3)
353#define NR_CURSEG_NODE_TYPE (3)
354#define NR_CURSEG_TYPE (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE)
355
356enum {
357 CURSEG_HOT_DATA = 0, /* directory entry blocks */
358 CURSEG_WARM_DATA, /* data blocks */
359 CURSEG_COLD_DATA, /* multimedia or GCed data blocks */
360 CURSEG_HOT_NODE, /* direct node blocks of directory files */
361 CURSEG_WARM_NODE, /* direct node blocks of normal files */
362 CURSEG_COLD_NODE, /* indirect node blocks */
363 NO_CHECK_TYPE
364};
365
6b4afdd7 366struct flush_cmd {
6b4afdd7 367 struct completion wait;
721bd4d5 368 struct llist_node llnode;
6b4afdd7
JK
369 int ret;
370};
371
a688b9d9
GZ
372struct flush_cmd_control {
373 struct task_struct *f2fs_issue_flush; /* flush thread */
374 wait_queue_head_t flush_wait_queue; /* waiting queue for wake-up */
721bd4d5
GZ
375 struct llist_head issue_list; /* list for command issue */
376 struct llist_node *dispatch_list; /* list for command dispatch */
a688b9d9
GZ
377};
378
39a53e0c
JK
379struct f2fs_sm_info {
380 struct sit_info *sit_info; /* whole segment information */
381 struct free_segmap_info *free_info; /* free segment information */
382 struct dirty_seglist_info *dirty_info; /* dirty segment information */
383 struct curseg_info *curseg_array; /* active segment information */
384
39a53e0c
JK
385 block_t seg0_blkaddr; /* block address of 0'th segment */
386 block_t main_blkaddr; /* start block address of main area */
387 block_t ssa_blkaddr; /* start block address of SSA area */
388
389 unsigned int segment_count; /* total # of segments */
390 unsigned int main_segments; /* # of segments in main area */
391 unsigned int reserved_segments; /* # of reserved segments */
392 unsigned int ovp_segments; /* # of overprovision segments */
81eb8d6e
JK
393
394 /* a threshold to reclaim prefree segments */
395 unsigned int rec_prefree_segments;
7fd9e544
JK
396
397 /* for small discard management */
398 struct list_head discard_list; /* 4KB discard list */
399 int nr_discards; /* # of discards in the list */
400 int max_discards; /* max. discards to be issued */
216fbd64 401
184a5cd2
CY
402 struct list_head sit_entry_set; /* sit entry set list */
403
216fbd64
JK
404 unsigned int ipu_policy; /* in-place-update policy */
405 unsigned int min_ipu_util; /* in-place-update threshold */
c1ce1b02 406 unsigned int min_fsync_blocks; /* threshold for fsync */
6b4afdd7
JK
407
408 /* for flush command control */
a688b9d9
GZ
409 struct flush_cmd_control *cmd_control_info;
410
39a53e0c
JK
411};
412
39a53e0c
JK
413/*
414 * For superblock
415 */
416/*
417 * COUNT_TYPE for monitoring
418 *
419 * f2fs monitors the number of several block types such as on-writeback,
420 * dirty dentry blocks, dirty node blocks, and dirty meta blocks.
421 */
422enum count_type {
423 F2FS_WRITEBACK,
424 F2FS_DIRTY_DENTS,
425 F2FS_DIRTY_NODES,
426 F2FS_DIRTY_META,
427 NR_COUNT_TYPE,
428};
429
39a53e0c 430/*
e1c42045 431 * The below are the page types of bios used in submit_bio().
39a53e0c
JK
432 * The available types are:
433 * DATA User data pages. It operates as async mode.
434 * NODE Node pages. It operates as async mode.
435 * META FS metadata pages such as SIT, NAT, CP.
436 * NR_PAGE_TYPE The number of page types.
437 * META_FLUSH Make sure the previous pages are written
438 * with waiting the bio's completion
439 * ... Only can be used with META.
440 */
7d5e5109 441#define PAGE_TYPE_OF_BIO(type) ((type) > META ? META : (type))
39a53e0c
JK
442enum page_type {
443 DATA,
444 NODE,
445 META,
446 NR_PAGE_TYPE,
447 META_FLUSH,
448};
449
458e6197 450struct f2fs_io_info {
7e8f2308
GZ
451 enum page_type type; /* contains DATA/NODE/META/META_FLUSH */
452 int rw; /* contains R/RS/W/WS with REQ_META/REQ_PRIO */
458e6197
JK
453};
454
93dfe2ac 455#define is_read_io(rw) (((rw) & 1) == READ)
1ff7bd3b 456struct f2fs_bio_info {
458e6197 457 struct f2fs_sb_info *sbi; /* f2fs superblock */
1ff7bd3b
JK
458 struct bio *bio; /* bios to merge */
459 sector_t last_block_in_bio; /* last block number */
458e6197 460 struct f2fs_io_info fio; /* store buffered io info. */
df0f8dc0 461 struct rw_semaphore io_rwsem; /* blocking op for bio */
1ff7bd3b
JK
462};
463
39a53e0c
JK
464struct f2fs_sb_info {
465 struct super_block *sb; /* pointer to VFS super block */
5e176d54 466 struct proc_dir_entry *s_proc; /* proc entry */
39a53e0c
JK
467 struct buffer_head *raw_super_buf; /* buffer head of raw sb */
468 struct f2fs_super_block *raw_super; /* raw super block pointer */
469 int s_dirty; /* dirty flag for checkpoint */
2ae4c673 470 bool need_fsck; /* need fsck.f2fs to fix */
39a53e0c
JK
471
472 /* for node-related operations */
473 struct f2fs_nm_info *nm_info; /* node manager */
474 struct inode *node_inode; /* cache node blocks */
475
476 /* for segment-related operations */
477 struct f2fs_sm_info *sm_info; /* segment manager */
1ff7bd3b
JK
478
479 /* for bio operations */
924b720b 480 struct f2fs_bio_info read_io; /* for read bios */
1ff7bd3b 481 struct f2fs_bio_info write_io[NR_PAGE_TYPE]; /* for write bios */
1b1f559f 482 struct completion *wait_io; /* for completion bios */
39a53e0c
JK
483
484 /* for checkpoint */
485 struct f2fs_checkpoint *ckpt; /* raw checkpoint pointer */
486 struct inode *meta_inode; /* cache meta blocks */
39936837 487 struct mutex cp_mutex; /* checkpoint procedure lock */
e479556b 488 struct rw_semaphore cp_rwsem; /* blocking FS operations */
b3582c68 489 struct rw_semaphore node_write; /* locking node writes */
39a53e0c 490 struct mutex writepages; /* mutex for writepages() */
aabe5136 491 bool por_doing; /* recovery is doing or not */
fb51b5ef 492 wait_queue_head_t cp_wait;
39a53e0c 493
6451e041 494 /* for inode management */
39efac41 495 struct radix_tree_root ino_root[MAX_INO_ENTRY]; /* ino entry array */
6451e041
JK
496 spinlock_t ino_lock[MAX_INO_ENTRY]; /* for ino entry lock */
497 struct list_head ino_list[MAX_INO_ENTRY]; /* inode list head */
498
499 /* for orphan inode, use 0'th array */
39a53e0c 500 unsigned int n_orphans; /* # of orphan inodes */
0d47c1ad 501 unsigned int max_orphans; /* max orphan inodes */
39a53e0c
JK
502
503 /* for directory inode management */
504 struct list_head dir_inode_list; /* dir inode list */
505 spinlock_t dir_inode_lock; /* for dir inode list lock */
39a53e0c 506
e1c42045 507 /* basic filesystem units */
39a53e0c
JK
508 unsigned int log_sectors_per_block; /* log2 sectors per block */
509 unsigned int log_blocksize; /* log2 block size */
510 unsigned int blocksize; /* block size */
511 unsigned int root_ino_num; /* root inode number*/
512 unsigned int node_ino_num; /* node inode number*/
513 unsigned int meta_ino_num; /* meta inode number*/
514 unsigned int log_blocks_per_seg; /* log2 blocks per segment */
515 unsigned int blocks_per_seg; /* blocks per segment */
516 unsigned int segs_per_sec; /* segments per section */
517 unsigned int secs_per_zone; /* sections per zone */
518 unsigned int total_sections; /* total section count */
519 unsigned int total_node_count; /* total node block count */
520 unsigned int total_valid_node_count; /* valid node block count */
521 unsigned int total_valid_inode_count; /* valid inode count */
522 int active_logs; /* # of active logs */
ab9fa662 523 int dir_level; /* directory level */
39a53e0c
JK
524
525 block_t user_block_count; /* # of user blocks */
526 block_t total_valid_block_count; /* # of valid blocks */
527 block_t alloc_valid_block_count; /* # of allocated blocks */
528 block_t last_valid_block_count; /* for recovery */
529 u32 s_next_generation; /* for NFS support */
530 atomic_t nr_pages[NR_COUNT_TYPE]; /* # of pages, see count_type */
531
532 struct f2fs_mount_info mount_opt; /* mount options */
533
534 /* for cleaning operations */
535 struct mutex gc_mutex; /* mutex for GC */
536 struct f2fs_gc_kthread *gc_thread; /* GC thread */
5ec4e49f 537 unsigned int cur_victim_sec; /* current victim section num */
39a53e0c 538
b1c57c1c
JK
539 /* maximum # of trials to find a victim segment for SSR and GC */
540 unsigned int max_victim_search;
541
39a53e0c
JK
542 /*
543 * for stat information.
544 * one is for the LFS mode, and the other is for the SSR mode.
545 */
35b09d82 546#ifdef CONFIG_F2FS_STAT_FS
39a53e0c
JK
547 struct f2fs_stat_info *stat_info; /* FS status information */
548 unsigned int segment_count[2]; /* # of allocated segments */
549 unsigned int block_count[2]; /* # of allocated blocks */
39a53e0c 550 int total_hit_ext, read_hit_ext; /* extent cache hit ratio */
0dbdc2ae 551 int inline_inode; /* # of inline_data inodes */
39a53e0c 552 int bg_gc; /* background gc calls */
35b09d82
NJ
553 unsigned int n_dirty_dirs; /* # of dir inodes */
554#endif
555 unsigned int last_victim[2]; /* last victim segment # */
39a53e0c 556 spinlock_t stat_lock; /* lock for stat operations */
b59d0bae
NJ
557
558 /* For sysfs suppport */
559 struct kobject s_kobj;
560 struct completion s_kobj_unregister;
39a53e0c
JK
561};
562
563/*
564 * Inline functions
565 */
566static inline struct f2fs_inode_info *F2FS_I(struct inode *inode)
567{
568 return container_of(inode, struct f2fs_inode_info, vfs_inode);
569}
570
571static inline struct f2fs_sb_info *F2FS_SB(struct super_block *sb)
572{
573 return sb->s_fs_info;
574}
575
4081363f
JK
576static inline struct f2fs_sb_info *F2FS_I_SB(struct inode *inode)
577{
578 return F2FS_SB(inode->i_sb);
579}
580
581static inline struct f2fs_sb_info *F2FS_M_SB(struct address_space *mapping)
582{
583 return F2FS_I_SB(mapping->host);
584}
585
586static inline struct f2fs_sb_info *F2FS_P_SB(struct page *page)
587{
588 return F2FS_M_SB(page->mapping);
589}
590
39a53e0c
JK
591static inline struct f2fs_super_block *F2FS_RAW_SUPER(struct f2fs_sb_info *sbi)
592{
593 return (struct f2fs_super_block *)(sbi->raw_super);
594}
595
596static inline struct f2fs_checkpoint *F2FS_CKPT(struct f2fs_sb_info *sbi)
597{
598 return (struct f2fs_checkpoint *)(sbi->ckpt);
599}
600
45590710
GZ
601static inline struct f2fs_node *F2FS_NODE(struct page *page)
602{
603 return (struct f2fs_node *)page_address(page);
604}
605
58bfaf44
JK
606static inline struct f2fs_inode *F2FS_INODE(struct page *page)
607{
608 return &((struct f2fs_node *)page_address(page))->i;
609}
610
39a53e0c
JK
611static inline struct f2fs_nm_info *NM_I(struct f2fs_sb_info *sbi)
612{
613 return (struct f2fs_nm_info *)(sbi->nm_info);
614}
615
616static inline struct f2fs_sm_info *SM_I(struct f2fs_sb_info *sbi)
617{
618 return (struct f2fs_sm_info *)(sbi->sm_info);
619}
620
621static inline struct sit_info *SIT_I(struct f2fs_sb_info *sbi)
622{
623 return (struct sit_info *)(SM_I(sbi)->sit_info);
624}
625
626static inline struct free_segmap_info *FREE_I(struct f2fs_sb_info *sbi)
627{
628 return (struct free_segmap_info *)(SM_I(sbi)->free_info);
629}
630
631static inline struct dirty_seglist_info *DIRTY_I(struct f2fs_sb_info *sbi)
632{
633 return (struct dirty_seglist_info *)(SM_I(sbi)->dirty_info);
634}
635
9df27d98
GZ
636static inline struct address_space *META_MAPPING(struct f2fs_sb_info *sbi)
637{
638 return sbi->meta_inode->i_mapping;
639}
640
4ef51a8f
JK
641static inline struct address_space *NODE_MAPPING(struct f2fs_sb_info *sbi)
642{
643 return sbi->node_inode->i_mapping;
644}
645
39a53e0c
JK
646static inline void F2FS_SET_SB_DIRT(struct f2fs_sb_info *sbi)
647{
648 sbi->s_dirty = 1;
649}
650
651static inline void F2FS_RESET_SB_DIRT(struct f2fs_sb_info *sbi)
652{
653 sbi->s_dirty = 0;
654}
655
d71b5564
JK
656static inline unsigned long long cur_cp_version(struct f2fs_checkpoint *cp)
657{
658 return le64_to_cpu(cp->checkpoint_ver);
659}
660
25ca923b
JK
661static inline bool is_set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
662{
663 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
664 return ckpt_flags & f;
665}
666
667static inline void set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
668{
669 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
670 ckpt_flags |= f;
671 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
672}
673
674static inline void clear_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
675{
676 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
677 ckpt_flags &= (~f);
678 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
679}
680
e479556b 681static inline void f2fs_lock_op(struct f2fs_sb_info *sbi)
39936837 682{
e479556b 683 down_read(&sbi->cp_rwsem);
39936837
JK
684}
685
e479556b 686static inline void f2fs_unlock_op(struct f2fs_sb_info *sbi)
39a53e0c 687{
e479556b 688 up_read(&sbi->cp_rwsem);
39a53e0c
JK
689}
690
e479556b 691static inline void f2fs_lock_all(struct f2fs_sb_info *sbi)
39a53e0c 692{
0daaad97 693 f2fs_down_write(&sbi->cp_rwsem, &sbi->cp_mutex);
39936837
JK
694}
695
e479556b 696static inline void f2fs_unlock_all(struct f2fs_sb_info *sbi)
39936837 697{
e479556b 698 up_write(&sbi->cp_rwsem);
39a53e0c
JK
699}
700
701/*
702 * Check whether the given nid is within node id range.
703 */
064e0823 704static inline int check_nid_range(struct f2fs_sb_info *sbi, nid_t nid)
39a53e0c 705{
d6b7d4b3
CY
706 if (unlikely(nid < F2FS_ROOT_INO(sbi)))
707 return -EINVAL;
cfb271d4 708 if (unlikely(nid >= NM_I(sbi)->max_nid))
064e0823
NJ
709 return -EINVAL;
710 return 0;
39a53e0c
JK
711}
712
713#define F2FS_DEFAULT_ALLOCATED_BLOCKS 1
714
715/*
716 * Check whether the inode has blocks or not
717 */
718static inline int F2FS_HAS_BLOCKS(struct inode *inode)
719{
720 if (F2FS_I(inode)->i_xattr_nid)
6c311ec6 721 return inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS + 1;
39a53e0c 722 else
6c311ec6 723 return inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS;
39a53e0c
JK
724}
725
4bc8e9bc
CY
726static inline bool f2fs_has_xattr_block(unsigned int ofs)
727{
728 return ofs == XATTR_NODE_OFFSET;
729}
730
39a53e0c
JK
731static inline bool inc_valid_block_count(struct f2fs_sb_info *sbi,
732 struct inode *inode, blkcnt_t count)
733{
734 block_t valid_block_count;
735
736 spin_lock(&sbi->stat_lock);
737 valid_block_count =
738 sbi->total_valid_block_count + (block_t)count;
cfb271d4 739 if (unlikely(valid_block_count > sbi->user_block_count)) {
39a53e0c
JK
740 spin_unlock(&sbi->stat_lock);
741 return false;
742 }
743 inode->i_blocks += count;
744 sbi->total_valid_block_count = valid_block_count;
745 sbi->alloc_valid_block_count += (block_t)count;
746 spin_unlock(&sbi->stat_lock);
747 return true;
748}
749
da19b0dc 750static inline void dec_valid_block_count(struct f2fs_sb_info *sbi,
39a53e0c
JK
751 struct inode *inode,
752 blkcnt_t count)
753{
754 spin_lock(&sbi->stat_lock);
9850cf4a
JK
755 f2fs_bug_on(sbi, sbi->total_valid_block_count < (block_t) count);
756 f2fs_bug_on(sbi, inode->i_blocks < count);
39a53e0c
JK
757 inode->i_blocks -= count;
758 sbi->total_valid_block_count -= (block_t)count;
759 spin_unlock(&sbi->stat_lock);
39a53e0c
JK
760}
761
762static inline void inc_page_count(struct f2fs_sb_info *sbi, int count_type)
763{
764 atomic_inc(&sbi->nr_pages[count_type]);
765 F2FS_SET_SB_DIRT(sbi);
766}
767
a7ffdbe2 768static inline void inode_inc_dirty_pages(struct inode *inode)
39a53e0c 769{
a7ffdbe2
JK
770 atomic_inc(&F2FS_I(inode)->dirty_pages);
771 if (S_ISDIR(inode->i_mode))
772 inc_page_count(F2FS_I_SB(inode), F2FS_DIRTY_DENTS);
39a53e0c
JK
773}
774
775static inline void dec_page_count(struct f2fs_sb_info *sbi, int count_type)
776{
777 atomic_dec(&sbi->nr_pages[count_type]);
778}
779
a7ffdbe2 780static inline void inode_dec_dirty_pages(struct inode *inode)
39a53e0c 781{
a7ffdbe2 782 if (!S_ISDIR(inode->i_mode) && !S_ISREG(inode->i_mode))
1fe54f9d
JK
783 return;
784
a7ffdbe2
JK
785 atomic_dec(&F2FS_I(inode)->dirty_pages);
786
787 if (S_ISDIR(inode->i_mode))
788 dec_page_count(F2FS_I_SB(inode), F2FS_DIRTY_DENTS);
39a53e0c
JK
789}
790
791static inline int get_pages(struct f2fs_sb_info *sbi, int count_type)
792{
793 return atomic_read(&sbi->nr_pages[count_type]);
794}
795
a7ffdbe2 796static inline int get_dirty_pages(struct inode *inode)
f8b2c1f9 797{
a7ffdbe2 798 return atomic_read(&F2FS_I(inode)->dirty_pages);
f8b2c1f9
JK
799}
800
5ac206cf
NJ
801static inline int get_blocktype_secs(struct f2fs_sb_info *sbi, int block_type)
802{
803 unsigned int pages_per_sec = sbi->segs_per_sec *
804 (1 << sbi->log_blocks_per_seg);
805 return ((get_pages(sbi, block_type) + pages_per_sec - 1)
806 >> sbi->log_blocks_per_seg) / sbi->segs_per_sec;
807}
808
39a53e0c
JK
809static inline block_t valid_user_blocks(struct f2fs_sb_info *sbi)
810{
8b8343fa 811 return sbi->total_valid_block_count;
39a53e0c
JK
812}
813
814static inline unsigned long __bitmap_size(struct f2fs_sb_info *sbi, int flag)
815{
816 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
817
818 /* return NAT or SIT bitmap */
819 if (flag == NAT_BITMAP)
820 return le32_to_cpu(ckpt->nat_ver_bitmap_bytesize);
821 else if (flag == SIT_BITMAP)
822 return le32_to_cpu(ckpt->sit_ver_bitmap_bytesize);
823
824 return 0;
825}
826
827static inline void *__bitmap_ptr(struct f2fs_sb_info *sbi, int flag)
828{
829 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
1dbe4152
CL
830 int offset;
831
832 if (le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_payload) > 0) {
833 if (flag == NAT_BITMAP)
834 return &ckpt->sit_nat_version_bitmap;
835 else
65b85ccc 836 return (unsigned char *)ckpt + F2FS_BLKSIZE;
1dbe4152
CL
837 } else {
838 offset = (flag == NAT_BITMAP) ?
25ca923b 839 le32_to_cpu(ckpt->sit_ver_bitmap_bytesize) : 0;
1dbe4152
CL
840 return &ckpt->sit_nat_version_bitmap + offset;
841 }
39a53e0c
JK
842}
843
844static inline block_t __start_cp_addr(struct f2fs_sb_info *sbi)
845{
846 block_t start_addr;
847 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
d71b5564 848 unsigned long long ckpt_version = cur_cp_version(ckpt);
39a53e0c 849
25ca923b 850 start_addr = le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_blkaddr);
39a53e0c
JK
851
852 /*
853 * odd numbered checkpoint should at cp segment 0
e1c42045 854 * and even segment must be at cp segment 1
39a53e0c
JK
855 */
856 if (!(ckpt_version & 1))
857 start_addr += sbi->blocks_per_seg;
858
859 return start_addr;
860}
861
862static inline block_t __start_sum_addr(struct f2fs_sb_info *sbi)
863{
864 return le32_to_cpu(F2FS_CKPT(sbi)->cp_pack_start_sum);
865}
866
867static inline bool inc_valid_node_count(struct f2fs_sb_info *sbi,
ef86d709 868 struct inode *inode)
39a53e0c
JK
869{
870 block_t valid_block_count;
871 unsigned int valid_node_count;
872
873 spin_lock(&sbi->stat_lock);
874
ef86d709 875 valid_block_count = sbi->total_valid_block_count + 1;
cfb271d4 876 if (unlikely(valid_block_count > sbi->user_block_count)) {
39a53e0c
JK
877 spin_unlock(&sbi->stat_lock);
878 return false;
879 }
880
ef86d709 881 valid_node_count = sbi->total_valid_node_count + 1;
cfb271d4 882 if (unlikely(valid_node_count > sbi->total_node_count)) {
39a53e0c
JK
883 spin_unlock(&sbi->stat_lock);
884 return false;
885 }
886
887 if (inode)
ef86d709
GZ
888 inode->i_blocks++;
889
890 sbi->alloc_valid_block_count++;
891 sbi->total_valid_node_count++;
892 sbi->total_valid_block_count++;
39a53e0c
JK
893 spin_unlock(&sbi->stat_lock);
894
895 return true;
896}
897
898static inline void dec_valid_node_count(struct f2fs_sb_info *sbi,
ef86d709 899 struct inode *inode)
39a53e0c
JK
900{
901 spin_lock(&sbi->stat_lock);
902
9850cf4a
JK
903 f2fs_bug_on(sbi, !sbi->total_valid_block_count);
904 f2fs_bug_on(sbi, !sbi->total_valid_node_count);
905 f2fs_bug_on(sbi, !inode->i_blocks);
39a53e0c 906
ef86d709
GZ
907 inode->i_blocks--;
908 sbi->total_valid_node_count--;
909 sbi->total_valid_block_count--;
39a53e0c
JK
910
911 spin_unlock(&sbi->stat_lock);
912}
913
914static inline unsigned int valid_node_count(struct f2fs_sb_info *sbi)
915{
8b8343fa 916 return sbi->total_valid_node_count;
39a53e0c
JK
917}
918
919static inline void inc_valid_inode_count(struct f2fs_sb_info *sbi)
920{
921 spin_lock(&sbi->stat_lock);
9850cf4a 922 f2fs_bug_on(sbi, sbi->total_valid_inode_count == sbi->total_node_count);
39a53e0c
JK
923 sbi->total_valid_inode_count++;
924 spin_unlock(&sbi->stat_lock);
925}
926
0e80220a 927static inline void dec_valid_inode_count(struct f2fs_sb_info *sbi)
39a53e0c
JK
928{
929 spin_lock(&sbi->stat_lock);
9850cf4a 930 f2fs_bug_on(sbi, !sbi->total_valid_inode_count);
39a53e0c
JK
931 sbi->total_valid_inode_count--;
932 spin_unlock(&sbi->stat_lock);
39a53e0c
JK
933}
934
935static inline unsigned int valid_inode_count(struct f2fs_sb_info *sbi)
936{
8b8343fa 937 return sbi->total_valid_inode_count;
39a53e0c
JK
938}
939
940static inline void f2fs_put_page(struct page *page, int unlock)
941{
031fa8cc 942 if (!page)
39a53e0c
JK
943 return;
944
945 if (unlock) {
9850cf4a 946 f2fs_bug_on(F2FS_P_SB(page), !PageLocked(page));
39a53e0c
JK
947 unlock_page(page);
948 }
949 page_cache_release(page);
950}
951
952static inline void f2fs_put_dnode(struct dnode_of_data *dn)
953{
954 if (dn->node_page)
955 f2fs_put_page(dn->node_page, 1);
956 if (dn->inode_page && dn->node_page != dn->inode_page)
957 f2fs_put_page(dn->inode_page, 0);
958 dn->node_page = NULL;
959 dn->inode_page = NULL;
960}
961
962static inline struct kmem_cache *f2fs_kmem_cache_create(const char *name,
e8512d2e 963 size_t size)
39a53e0c 964{
e8512d2e 965 return kmem_cache_create(name, size, 0, SLAB_RECLAIM_ACCOUNT, NULL);
39a53e0c
JK
966}
967
7bd59381
GZ
968static inline void *f2fs_kmem_cache_alloc(struct kmem_cache *cachep,
969 gfp_t flags)
970{
971 void *entry;
972retry:
973 entry = kmem_cache_alloc(cachep, flags);
974 if (!entry) {
975 cond_resched();
976 goto retry;
977 }
978
979 return entry;
980}
981
39a53e0c
JK
982#define RAW_IS_INODE(p) ((p)->footer.nid == (p)->footer.ino)
983
984static inline bool IS_INODE(struct page *page)
985{
45590710 986 struct f2fs_node *p = F2FS_NODE(page);
39a53e0c
JK
987 return RAW_IS_INODE(p);
988}
989
990static inline __le32 *blkaddr_in_node(struct f2fs_node *node)
991{
992 return RAW_IS_INODE(node) ? node->i.i_addr : node->dn.addr;
993}
994
995static inline block_t datablock_addr(struct page *node_page,
996 unsigned int offset)
997{
998 struct f2fs_node *raw_node;
999 __le32 *addr_array;
45590710 1000 raw_node = F2FS_NODE(node_page);
39a53e0c
JK
1001 addr_array = blkaddr_in_node(raw_node);
1002 return le32_to_cpu(addr_array[offset]);
1003}
1004
1005static inline int f2fs_test_bit(unsigned int nr, char *addr)
1006{
1007 int mask;
1008
1009 addr += (nr >> 3);
1010 mask = 1 << (7 - (nr & 0x07));
1011 return mask & *addr;
1012}
1013
1014static inline int f2fs_set_bit(unsigned int nr, char *addr)
1015{
1016 int mask;
1017 int ret;
1018
1019 addr += (nr >> 3);
1020 mask = 1 << (7 - (nr & 0x07));
1021 ret = mask & *addr;
1022 *addr |= mask;
1023 return ret;
1024}
1025
1026static inline int f2fs_clear_bit(unsigned int nr, char *addr)
1027{
1028 int mask;
1029 int ret;
1030
1031 addr += (nr >> 3);
1032 mask = 1 << (7 - (nr & 0x07));
1033 ret = mask & *addr;
1034 *addr &= ~mask;
1035 return ret;
1036}
1037
1038/* used for f2fs_inode_info->flags */
1039enum {
1040 FI_NEW_INODE, /* indicate newly allocated inode */
b3783873 1041 FI_DIRTY_INODE, /* indicate inode is dirty or not */
ed57c27f 1042 FI_DIRTY_DIR, /* indicate directory has dirty pages */
39a53e0c
JK
1043 FI_INC_LINK, /* need to increment i_nlink */
1044 FI_ACL_MODE, /* indicate acl mode */
1045 FI_NO_ALLOC, /* should not allocate any blocks */
699489bb 1046 FI_UPDATE_DIR, /* should update inode block for consistency */
74d0b917 1047 FI_DELAY_IPUT, /* used for the recovery */
c11abd1a 1048 FI_NO_EXTENT, /* not to use the extent cache */
444c580f 1049 FI_INLINE_XATTR, /* used for inline xattr */
1001b347 1050 FI_INLINE_DATA, /* used for inline data*/
fff04f90
JK
1051 FI_APPEND_WRITE, /* inode has appended data */
1052 FI_UPDATE_WRITE, /* inode has in-place-update data */
ea1aa12c 1053 FI_NEED_IPU, /* used fo ipu for fdatasync */
39a53e0c
JK
1054};
1055
1056static inline void set_inode_flag(struct f2fs_inode_info *fi, int flag)
1057{
61e0f2d0
JK
1058 if (!test_bit(flag, &fi->flags))
1059 set_bit(flag, &fi->flags);
39a53e0c
JK
1060}
1061
1062static inline int is_inode_flag_set(struct f2fs_inode_info *fi, int flag)
1063{
1064 return test_bit(flag, &fi->flags);
1065}
1066
1067static inline void clear_inode_flag(struct f2fs_inode_info *fi, int flag)
1068{
61e0f2d0
JK
1069 if (test_bit(flag, &fi->flags))
1070 clear_bit(flag, &fi->flags);
39a53e0c
JK
1071}
1072
1073static inline void set_acl_inode(struct f2fs_inode_info *fi, umode_t mode)
1074{
1075 fi->i_acl_mode = mode;
1076 set_inode_flag(fi, FI_ACL_MODE);
1077}
1078
1079static inline int cond_clear_inode_flag(struct f2fs_inode_info *fi, int flag)
1080{
1081 if (is_inode_flag_set(fi, FI_ACL_MODE)) {
1082 clear_inode_flag(fi, FI_ACL_MODE);
1083 return 1;
1084 }
1085 return 0;
1086}
1087
444c580f
JK
1088static inline void get_inline_info(struct f2fs_inode_info *fi,
1089 struct f2fs_inode *ri)
1090{
1091 if (ri->i_inline & F2FS_INLINE_XATTR)
1092 set_inode_flag(fi, FI_INLINE_XATTR);
1001b347
HL
1093 if (ri->i_inline & F2FS_INLINE_DATA)
1094 set_inode_flag(fi, FI_INLINE_DATA);
444c580f
JK
1095}
1096
1097static inline void set_raw_inline(struct f2fs_inode_info *fi,
1098 struct f2fs_inode *ri)
1099{
1100 ri->i_inline = 0;
1101
1102 if (is_inode_flag_set(fi, FI_INLINE_XATTR))
1103 ri->i_inline |= F2FS_INLINE_XATTR;
1001b347
HL
1104 if (is_inode_flag_set(fi, FI_INLINE_DATA))
1105 ri->i_inline |= F2FS_INLINE_DATA;
444c580f
JK
1106}
1107
987c7c31
CY
1108static inline int f2fs_has_inline_xattr(struct inode *inode)
1109{
1110 return is_inode_flag_set(F2FS_I(inode), FI_INLINE_XATTR);
1111}
1112
de93653f
JK
1113static inline unsigned int addrs_per_inode(struct f2fs_inode_info *fi)
1114{
987c7c31 1115 if (f2fs_has_inline_xattr(&fi->vfs_inode))
de93653f
JK
1116 return DEF_ADDRS_PER_INODE - F2FS_INLINE_XATTR_ADDRS;
1117 return DEF_ADDRS_PER_INODE;
1118}
1119
65985d93
JK
1120static inline void *inline_xattr_addr(struct page *page)
1121{
695fd1ed 1122 struct f2fs_inode *ri = F2FS_INODE(page);
65985d93
JK
1123 return (void *)&(ri->i_addr[DEF_ADDRS_PER_INODE -
1124 F2FS_INLINE_XATTR_ADDRS]);
1125}
1126
1127static inline int inline_xattr_size(struct inode *inode)
1128{
987c7c31 1129 if (f2fs_has_inline_xattr(inode))
65985d93
JK
1130 return F2FS_INLINE_XATTR_ADDRS << 2;
1131 else
1132 return 0;
1133}
1134
0dbdc2ae
JK
1135static inline int f2fs_has_inline_data(struct inode *inode)
1136{
1137 return is_inode_flag_set(F2FS_I(inode), FI_INLINE_DATA);
1138}
1139
1001b347
HL
1140static inline void *inline_data_addr(struct page *page)
1141{
695fd1ed 1142 struct f2fs_inode *ri = F2FS_INODE(page);
1001b347
HL
1143 return (void *)&(ri->i_addr[1]);
1144}
1145
77888c1e
JK
1146static inline int f2fs_readonly(struct super_block *sb)
1147{
1148 return sb->s_flags & MS_RDONLY;
1149}
1150
1e968fdf
JK
1151static inline bool f2fs_cp_error(struct f2fs_sb_info *sbi)
1152{
1153 return is_set_ckpt_flags(sbi->ckpt, CP_ERROR_FLAG);
1154}
1155
744602cf
JK
1156static inline void f2fs_stop_checkpoint(struct f2fs_sb_info *sbi)
1157{
1158 set_ckpt_flags(sbi->ckpt, CP_ERROR_FLAG);
1159 sbi->sb->s_flags |= MS_RDONLY;
1160}
1161
a6dda0e6
CH
1162#define get_inode_mode(i) \
1163 ((is_inode_flag_set(F2FS_I(i), FI_ACL_MODE)) ? \
1164 (F2FS_I(i)->i_acl_mode) : ((i)->i_mode))
1165
267378d4
CY
1166/* get offset of first page in next direct node */
1167#define PGOFS_OF_NEXT_DNODE(pgofs, fi) \
1168 ((pgofs < ADDRS_PER_INODE(fi)) ? ADDRS_PER_INODE(fi) : \
1169 (pgofs - ADDRS_PER_INODE(fi) + ADDRS_PER_BLOCK) / \
1170 ADDRS_PER_BLOCK * ADDRS_PER_BLOCK + ADDRS_PER_INODE(fi))
1171
39a53e0c
JK
1172/*
1173 * file.c
1174 */
1175int f2fs_sync_file(struct file *, loff_t, loff_t, int);
1176void truncate_data_blocks(struct dnode_of_data *);
764aa3e9 1177int truncate_blocks(struct inode *, u64, bool);
39a53e0c 1178void f2fs_truncate(struct inode *);
2d4d9fb5 1179int f2fs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
39a53e0c
JK
1180int f2fs_setattr(struct dentry *, struct iattr *);
1181int truncate_hole(struct inode *, pgoff_t, pgoff_t);
b292dcab 1182int truncate_data_blocks_range(struct dnode_of_data *, int);
39a53e0c 1183long f2fs_ioctl(struct file *, unsigned int, unsigned long);
e9750824 1184long f2fs_compat_ioctl(struct file *, unsigned int, unsigned long);
39a53e0c
JK
1185
1186/*
1187 * inode.c
1188 */
1189void f2fs_set_inode_flags(struct inode *);
39a53e0c 1190struct inode *f2fs_iget(struct super_block *, unsigned long);
4660f9c0 1191int try_to_free_nats(struct f2fs_sb_info *, int);
39a53e0c 1192void update_inode(struct inode *, struct page *);
744602cf 1193void update_inode_page(struct inode *);
39a53e0c
JK
1194int f2fs_write_inode(struct inode *, struct writeback_control *);
1195void f2fs_evict_inode(struct inode *);
1196
1197/*
1198 * namei.c
1199 */
1200struct dentry *f2fs_get_parent(struct dentry *child);
1201
1202/*
1203 * dir.c
1204 */
1205struct f2fs_dir_entry *f2fs_find_entry(struct inode *, struct qstr *,
1206 struct page **);
1207struct f2fs_dir_entry *f2fs_parent_dir(struct inode *, struct page **);
1208ino_t f2fs_inode_by_name(struct inode *, struct qstr *);
1209void f2fs_set_link(struct inode *, struct f2fs_dir_entry *,
1210 struct page *, struct inode *);
1cd14caf 1211int update_dent_inode(struct inode *, const struct qstr *);
b7f7a5e0 1212int __f2fs_add_link(struct inode *, const struct qstr *, struct inode *);
39a53e0c 1213void f2fs_delete_entry(struct f2fs_dir_entry *, struct page *, struct inode *);
b97a9b5d 1214int f2fs_do_tmpfile(struct inode *, struct inode *);
39a53e0c
JK
1215int f2fs_make_empty(struct inode *, struct inode *);
1216bool f2fs_empty_dir(struct inode *);
1217
b7f7a5e0
AV
1218static inline int f2fs_add_link(struct dentry *dentry, struct inode *inode)
1219{
1220 return __f2fs_add_link(dentry->d_parent->d_inode, &dentry->d_name,
1221 inode);
1222}
1223
39a53e0c
JK
1224/*
1225 * super.c
1226 */
1227int f2fs_sync_fs(struct super_block *, int);
a07ef784
NJ
1228extern __printf(3, 4)
1229void f2fs_msg(struct super_block *, const char *, const char *, ...);
39a53e0c
JK
1230
1231/*
1232 * hash.c
1233 */
eee6160f 1234f2fs_hash_t f2fs_dentry_hash(const struct qstr *);
39a53e0c
JK
1235
1236/*
1237 * node.c
1238 */
1239struct dnode_of_data;
1240struct node_info;
1241
6fb03f3a 1242bool available_free_memory(struct f2fs_sb_info *, int);
88bd02c9
JK
1243bool is_checkpointed_node(struct f2fs_sb_info *, nid_t);
1244bool has_fsynced_inode(struct f2fs_sb_info *, nid_t);
1245bool need_inode_block_update(struct f2fs_sb_info *, nid_t);
39a53e0c
JK
1246void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
1247int get_dnode_of_data(struct dnode_of_data *, pgoff_t, int);
1248int truncate_inode_blocks(struct inode *, pgoff_t);
4f16fb0f 1249int truncate_xattr_node(struct inode *, struct page *);
cfe58f9d 1250int wait_on_node_pages_writeback(struct f2fs_sb_info *, nid_t);
58e674d6 1251void remove_inode_page(struct inode *);
a014e037 1252struct page *new_inode_page(struct inode *);
8ae8f162 1253struct page *new_node_page(struct dnode_of_data *, unsigned int, struct page *);
39a53e0c
JK
1254void ra_node_page(struct f2fs_sb_info *, nid_t);
1255struct page *get_node_page(struct f2fs_sb_info *, pgoff_t);
1256struct page *get_node_page_ra(struct page *, int);
1257void sync_inode_page(struct dnode_of_data *);
1258int sync_node_pages(struct f2fs_sb_info *, nid_t, struct writeback_control *);
1259bool alloc_nid(struct f2fs_sb_info *, nid_t *);
1260void alloc_nid_done(struct f2fs_sb_info *, nid_t);
1261void alloc_nid_failed(struct f2fs_sb_info *, nid_t);
70cfed88 1262void recover_inline_xattr(struct inode *, struct page *);
1c35a90e 1263void recover_xattr_data(struct inode *, struct page *, block_t);
39a53e0c
JK
1264int recover_inode_page(struct f2fs_sb_info *, struct page *);
1265int restore_node_summary(struct f2fs_sb_info *, unsigned int,
1266 struct f2fs_summary_block *);
1267void flush_nat_entries(struct f2fs_sb_info *);
1268int build_node_manager(struct f2fs_sb_info *);
1269void destroy_node_manager(struct f2fs_sb_info *);
6e6093a8 1270int __init create_node_manager_caches(void);
39a53e0c
JK
1271void destroy_node_manager_caches(void);
1272
1273/*
1274 * segment.c
1275 */
1276void f2fs_balance_fs(struct f2fs_sb_info *);
4660f9c0 1277void f2fs_balance_fs_bg(struct f2fs_sb_info *);
6b4afdd7 1278int f2fs_issue_flush(struct f2fs_sb_info *);
2163d198
GZ
1279int create_flush_cmd_control(struct f2fs_sb_info *);
1280void destroy_flush_cmd_control(struct f2fs_sb_info *);
39a53e0c 1281void invalidate_blocks(struct f2fs_sb_info *, block_t);
5e443818 1282void refresh_sit_entry(struct f2fs_sb_info *, block_t, block_t);
39a53e0c 1283void clear_prefree_segments(struct f2fs_sb_info *);
4b2fecc8 1284void release_discard_addrs(struct f2fs_sb_info *);
cf2271e7 1285void discard_next_dnode(struct f2fs_sb_info *, block_t);
39a53e0c
JK
1286int npages_for_summary_flush(struct f2fs_sb_info *);
1287void allocate_new_segments(struct f2fs_sb_info *);
4b2fecc8 1288int f2fs_trim_fs(struct f2fs_sb_info *, struct fstrim_range *);
39a53e0c 1289struct page *get_sum_page(struct f2fs_sb_info *, unsigned int);
577e3495 1290void write_meta_page(struct f2fs_sb_info *, struct page *);
fb5566da
JK
1291void write_node_page(struct f2fs_sb_info *, struct page *,
1292 struct f2fs_io_info *, unsigned int, block_t, block_t *);
458e6197
JK
1293void write_data_page(struct page *, struct dnode_of_data *, block_t *,
1294 struct f2fs_io_info *);
1295void rewrite_data_page(struct page *, block_t, struct f2fs_io_info *);
39a53e0c
JK
1296void recover_data_page(struct f2fs_sb_info *, struct page *,
1297 struct f2fs_summary *, block_t, block_t);
bfad7c2d
JK
1298void allocate_data_block(struct f2fs_sb_info *, struct page *,
1299 block_t, block_t *, struct f2fs_summary *, int);
5514f0aa 1300void f2fs_wait_on_page_writeback(struct page *, enum page_type);
39a53e0c
JK
1301void write_data_summaries(struct f2fs_sb_info *, block_t);
1302void write_node_summaries(struct f2fs_sb_info *, block_t);
1303int lookup_journal_in_cursum(struct f2fs_summary_block *,
1304 int, unsigned int, int);
4b2fecc8 1305void flush_sit_entries(struct f2fs_sb_info *, struct cp_control *);
39a53e0c 1306int build_segment_manager(struct f2fs_sb_info *);
39a53e0c 1307void destroy_segment_manager(struct f2fs_sb_info *);
7fd9e544
JK
1308int __init create_segment_manager_caches(void);
1309void destroy_segment_manager_caches(void);
39a53e0c
JK
1310
1311/*
1312 * checkpoint.c
1313 */
1314struct page *grab_meta_page(struct f2fs_sb_info *, pgoff_t);
1315struct page *get_meta_page(struct f2fs_sb_info *, pgoff_t);
4c521f49
JK
1316struct page *get_meta_page_ra(struct f2fs_sb_info *, pgoff_t);
1317int ra_meta_pages(struct f2fs_sb_info *, block_t, int, int);
39a53e0c 1318long sync_meta_pages(struct f2fs_sb_info *, enum page_type, long);
fff04f90
JK
1319void add_dirty_inode(struct f2fs_sb_info *, nid_t, int type);
1320void remove_dirty_inode(struct f2fs_sb_info *, nid_t, int type);
6f12ac25 1321void release_dirty_inode(struct f2fs_sb_info *);
fff04f90 1322bool exist_written_data(struct f2fs_sb_info *, nid_t, int);
cbd56e7d
JK
1323int acquire_orphan_inode(struct f2fs_sb_info *);
1324void release_orphan_inode(struct f2fs_sb_info *);
39a53e0c
JK
1325void add_orphan_inode(struct f2fs_sb_info *, nid_t);
1326void remove_orphan_inode(struct f2fs_sb_info *, nid_t);
8f99a946 1327void recover_orphan_inodes(struct f2fs_sb_info *);
39a53e0c 1328int get_valid_checkpoint(struct f2fs_sb_info *);
a7ffdbe2 1329void update_dirty_page(struct inode *, struct page *);
5deb8267 1330void add_dirty_dir_inode(struct inode *);
39a53e0c
JK
1331void remove_dirty_dir_inode(struct inode *);
1332void sync_dirty_dir_inodes(struct f2fs_sb_info *);
75ab4cb8 1333void write_checkpoint(struct f2fs_sb_info *, struct cp_control *);
6451e041 1334void init_ino_entry_info(struct f2fs_sb_info *);
6e6093a8 1335int __init create_checkpoint_caches(void);
39a53e0c
JK
1336void destroy_checkpoint_caches(void);
1337
1338/*
1339 * data.c
1340 */
458e6197 1341void f2fs_submit_merged_bio(struct f2fs_sb_info *, enum page_type, int);
93dfe2ac
JK
1342int f2fs_submit_page_bio(struct f2fs_sb_info *, struct page *, block_t, int);
1343void f2fs_submit_page_mbio(struct f2fs_sb_info *, struct page *, block_t,
458e6197 1344 struct f2fs_io_info *);
39a53e0c 1345int reserve_new_block(struct dnode_of_data *);
b600965c 1346int f2fs_reserve_block(struct dnode_of_data *, pgoff_t);
39a53e0c 1347void update_extent_cache(block_t, struct dnode_of_data *);
c718379b 1348struct page *find_data_page(struct inode *, pgoff_t, bool);
39a53e0c 1349struct page *get_lock_data_page(struct inode *, pgoff_t);
64aa7ed9 1350struct page *get_new_data_page(struct inode *, struct page *, pgoff_t, bool);
458e6197 1351int do_write_data_page(struct page *, struct f2fs_io_info *);
9ab70134 1352int f2fs_fiemap(struct inode *inode, struct fiemap_extent_info *, u64, u64);
39a53e0c
JK
1353
1354/*
1355 * gc.c
1356 */
1357int start_gc_thread(struct f2fs_sb_info *);
1358void stop_gc_thread(struct f2fs_sb_info *);
de93653f 1359block_t start_bidx_of_node(unsigned int, struct f2fs_inode_info *);
408e9375 1360int f2fs_gc(struct f2fs_sb_info *);
39a53e0c 1361void build_gc_manager(struct f2fs_sb_info *);
6e6093a8 1362int __init create_gc_caches(void);
39a53e0c
JK
1363void destroy_gc_caches(void);
1364
1365/*
1366 * recovery.c
1367 */
6ead1142 1368int recover_fsync_data(struct f2fs_sb_info *);
39a53e0c
JK
1369bool space_for_roll_forward(struct f2fs_sb_info *);
1370
1371/*
1372 * debug.c
1373 */
1374#ifdef CONFIG_F2FS_STAT_FS
1375struct f2fs_stat_info {
1376 struct list_head stat_list;
1377 struct f2fs_sb_info *sbi;
39a53e0c
JK
1378 int all_area_segs, sit_area_segs, nat_area_segs, ssa_area_segs;
1379 int main_area_segs, main_area_sections, main_area_zones;
1380 int hit_ext, total_ext;
1381 int ndirty_node, ndirty_dent, ndirty_dirs, ndirty_meta;
1382 int nats, sits, fnids;
1383 int total_count, utilization;
0dbdc2ae 1384 int bg_gc, inline_inode;
39a53e0c
JK
1385 unsigned int valid_count, valid_node_count, valid_inode_count;
1386 unsigned int bimodal, avg_vblocks;
1387 int util_free, util_valid, util_invalid;
1388 int rsvd_segs, overp_segs;
1389 int dirty_count, node_pages, meta_pages;
942e0be6 1390 int prefree_count, call_count, cp_count;
39a53e0c
JK
1391 int tot_segs, node_segs, data_segs, free_segs, free_secs;
1392 int tot_blks, data_blks, node_blks;
1393 int curseg[NR_CURSEG_TYPE];
1394 int cursec[NR_CURSEG_TYPE];
1395 int curzone[NR_CURSEG_TYPE];
1396
1397 unsigned int segment_count[2];
1398 unsigned int block_count[2];
1399 unsigned base_mem, cache_mem;
1400};
1401
963d4f7d
GZ
1402static inline struct f2fs_stat_info *F2FS_STAT(struct f2fs_sb_info *sbi)
1403{
6c311ec6 1404 return (struct f2fs_stat_info *)sbi->stat_info;
963d4f7d
GZ
1405}
1406
942e0be6 1407#define stat_inc_cp_count(si) ((si)->cp_count++)
dcdfff65
JK
1408#define stat_inc_call_count(si) ((si)->call_count++)
1409#define stat_inc_bggc_count(sbi) ((sbi)->bg_gc++)
1410#define stat_inc_dirty_dir(sbi) ((sbi)->n_dirty_dirs++)
1411#define stat_dec_dirty_dir(sbi) ((sbi)->n_dirty_dirs--)
1412#define stat_inc_total_hit(sb) ((F2FS_SB(sb))->total_hit_ext++)
1413#define stat_inc_read_hit(sb) ((F2FS_SB(sb))->read_hit_ext++)
0dbdc2ae
JK
1414#define stat_inc_inline_inode(inode) \
1415 do { \
1416 if (f2fs_has_inline_data(inode)) \
4081363f 1417 ((F2FS_I_SB(inode))->inline_inode++); \
0dbdc2ae
JK
1418 } while (0)
1419#define stat_dec_inline_inode(inode) \
1420 do { \
1421 if (f2fs_has_inline_data(inode)) \
4081363f 1422 ((F2FS_I_SB(inode))->inline_inode--); \
0dbdc2ae
JK
1423 } while (0)
1424
dcdfff65
JK
1425#define stat_inc_seg_type(sbi, curseg) \
1426 ((sbi)->segment_count[(curseg)->alloc_type]++)
1427#define stat_inc_block_count(sbi, curseg) \
1428 ((sbi)->block_count[(curseg)->alloc_type]++)
39a53e0c
JK
1429
1430#define stat_inc_seg_count(sbi, type) \
1431 do { \
963d4f7d 1432 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
39a53e0c
JK
1433 (si)->tot_segs++; \
1434 if (type == SUM_TYPE_DATA) \
1435 si->data_segs++; \
1436 else \
1437 si->node_segs++; \
1438 } while (0)
1439
1440#define stat_inc_tot_blk_count(si, blks) \
1441 (si->tot_blks += (blks))
1442
1443#define stat_inc_data_blk_count(sbi, blks) \
1444 do { \
963d4f7d 1445 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
39a53e0c
JK
1446 stat_inc_tot_blk_count(si, blks); \
1447 si->data_blks += (blks); \
1448 } while (0)
1449
1450#define stat_inc_node_blk_count(sbi, blks) \
1451 do { \
963d4f7d 1452 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
39a53e0c
JK
1453 stat_inc_tot_blk_count(si, blks); \
1454 si->node_blks += (blks); \
1455 } while (0)
1456
1457int f2fs_build_stats(struct f2fs_sb_info *);
1458void f2fs_destroy_stats(struct f2fs_sb_info *);
6e6093a8 1459void __init f2fs_create_root_stats(void);
4589d25d 1460void f2fs_destroy_root_stats(void);
39a53e0c 1461#else
942e0be6 1462#define stat_inc_cp_count(si)
39a53e0c 1463#define stat_inc_call_count(si)
dcdfff65
JK
1464#define stat_inc_bggc_count(si)
1465#define stat_inc_dirty_dir(sbi)
1466#define stat_dec_dirty_dir(sbi)
1467#define stat_inc_total_hit(sb)
1468#define stat_inc_read_hit(sb)
0dbdc2ae
JK
1469#define stat_inc_inline_inode(inode)
1470#define stat_dec_inline_inode(inode)
dcdfff65
JK
1471#define stat_inc_seg_type(sbi, curseg)
1472#define stat_inc_block_count(sbi, curseg)
39a53e0c
JK
1473#define stat_inc_seg_count(si, type)
1474#define stat_inc_tot_blk_count(si, blks)
1475#define stat_inc_data_blk_count(si, blks)
1476#define stat_inc_node_blk_count(sbi, blks)
1477
1478static inline int f2fs_build_stats(struct f2fs_sb_info *sbi) { return 0; }
1479static inline void f2fs_destroy_stats(struct f2fs_sb_info *sbi) { }
6e6093a8 1480static inline void __init f2fs_create_root_stats(void) { }
4589d25d 1481static inline void f2fs_destroy_root_stats(void) { }
39a53e0c
JK
1482#endif
1483
1484extern const struct file_operations f2fs_dir_operations;
1485extern const struct file_operations f2fs_file_operations;
1486extern const struct inode_operations f2fs_file_inode_operations;
1487extern const struct address_space_operations f2fs_dblock_aops;
1488extern const struct address_space_operations f2fs_node_aops;
1489extern const struct address_space_operations f2fs_meta_aops;
1490extern const struct inode_operations f2fs_dir_inode_operations;
1491extern const struct inode_operations f2fs_symlink_inode_operations;
1492extern const struct inode_operations f2fs_special_inode_operations;
1001b347 1493
e18c65b2
HL
1494/*
1495 * inline.c
1496 */
e18c65b2
HL
1497bool f2fs_may_inline(struct inode *);
1498int f2fs_read_inline_data(struct inode *, struct page *);
b067ba1f 1499int f2fs_convert_inline_data(struct inode *, pgoff_t, struct page *);
e18c65b2 1500int f2fs_write_inline_data(struct inode *, struct page *, unsigned int);
8aa6f1c5 1501void truncate_inline_data(struct inode *, u64);
0342fd30 1502bool recover_inline_data(struct inode *, struct page *);
39a53e0c 1503#endif