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