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