2 * include/linux/f2fs_fs.h
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
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.
11 #ifndef _LINUX_F2FS_FS_H
12 #define _LINUX_F2FS_FS_H
14 #include <linux/pagemap.h>
15 #include <linux/types.h>
17 #define F2FS_SUPER_OFFSET 1024 /* byte-size offset */
18 #define F2FS_MIN_LOG_SECTOR_SIZE 9 /* 9 bits for 512 bytes */
19 #define F2FS_MAX_LOG_SECTOR_SIZE 12 /* 12 bits for 4096 bytes */
20 #define F2FS_LOG_SECTORS_PER_BLOCK 3 /* log number for sector/blk */
21 #define F2FS_BLKSIZE 4096 /* support only 4KB block */
22 #define F2FS_MAX_EXTENSION 64 /* # of extension entries */
23 #define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) / F2FS_BLKSIZE)
25 #define NULL_ADDR ((block_t)0) /* used as block_t addresses */
26 #define NEW_ADDR ((block_t)-1) /* used as block_t addresses */
28 /* 0, 1(node nid), 2(meta nid) are reserved node id */
29 #define F2FS_RESERVED_NODE_NUM 3
31 #define F2FS_ROOT_INO(sbi) (sbi->root_ino_num)
32 #define F2FS_NODE_INO(sbi) (sbi->node_ino_num)
33 #define F2FS_META_INO(sbi) (sbi->meta_ino_num)
35 /* This flag is used by node and meta inodes, and by recovery */
36 #define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
37 #define GFP_F2FS_HIGH_ZERO (GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)
40 * For further optimization on multi-head logs, on-disk layout supports maximum
41 * 16 logs by default. The number, 16, is expected to cover all the cases
42 * enoughly. The implementaion currently uses no more than 6 logs.
43 * Half the logs are used for nodes, and the other half are used for data.
45 #define MAX_ACTIVE_LOGS 16
46 #define MAX_ACTIVE_NODE_LOGS 8
47 #define MAX_ACTIVE_DATA_LOGS 8
52 struct f2fs_super_block {
53 __le32 magic; /* Magic Number */
54 __le16 major_ver; /* Major Version */
55 __le16 minor_ver; /* Minor Version */
56 __le32 log_sectorsize; /* log2 sector size in bytes */
57 __le32 log_sectors_per_block; /* log2 # of sectors per block */
58 __le32 log_blocksize; /* log2 block size in bytes */
59 __le32 log_blocks_per_seg; /* log2 # of blocks per segment */
60 __le32 segs_per_sec; /* # of segments per section */
61 __le32 secs_per_zone; /* # of sections per zone */
62 __le32 checksum_offset; /* checksum offset inside super block */
63 __le64 block_count; /* total # of user blocks */
64 __le32 section_count; /* total # of sections */
65 __le32 segment_count; /* total # of segments */
66 __le32 segment_count_ckpt; /* # of segments for checkpoint */
67 __le32 segment_count_sit; /* # of segments for SIT */
68 __le32 segment_count_nat; /* # of segments for NAT */
69 __le32 segment_count_ssa; /* # of segments for SSA */
70 __le32 segment_count_main; /* # of segments for main area */
71 __le32 segment0_blkaddr; /* start block address of segment 0 */
72 __le32 cp_blkaddr; /* start block address of checkpoint */
73 __le32 sit_blkaddr; /* start block address of SIT */
74 __le32 nat_blkaddr; /* start block address of NAT */
75 __le32 ssa_blkaddr; /* start block address of SSA */
76 __le32 main_blkaddr; /* start block address of main area */
77 __le32 root_ino; /* root inode number */
78 __le32 node_ino; /* node inode number */
79 __le32 meta_ino; /* meta inode number */
80 __u8 uuid[16]; /* 128-bit uuid for volume */
81 __le16 volume_name[512]; /* volume name */
82 __le32 extension_count; /* # of extensions below */
83 __u8 extension_list[F2FS_MAX_EXTENSION][8]; /* extension array */
90 #define CP_FASTBOOT_FLAG 0x00000020
91 #define CP_FSCK_FLAG 0x00000010
92 #define CP_ERROR_FLAG 0x00000008
93 #define CP_COMPACT_SUM_FLAG 0x00000004
94 #define CP_ORPHAN_PRESENT_FLAG 0x00000002
95 #define CP_UMOUNT_FLAG 0x00000001
97 #define F2FS_CP_PACKS 2 /* # of checkpoint packs */
99 struct f2fs_checkpoint {
100 __le64 checkpoint_ver; /* checkpoint block version number */
101 __le64 user_block_count; /* # of user blocks */
102 __le64 valid_block_count; /* # of valid blocks in main area */
103 __le32 rsvd_segment_count; /* # of reserved segments for gc */
104 __le32 overprov_segment_count; /* # of overprovision segments */
105 __le32 free_segment_count; /* # of free segments in main area */
107 /* information of current node segments */
108 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
109 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
110 /* information of current data segments */
111 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
112 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
113 __le32 ckpt_flags; /* Flags : umount and journal_present */
114 __le32 cp_pack_total_block_count; /* total # of one cp pack */
115 __le32 cp_pack_start_sum; /* start block number of data summary */
116 __le32 valid_node_count; /* Total number of valid nodes */
117 __le32 valid_inode_count; /* Total number of valid inodes */
118 __le32 next_free_nid; /* Next free node number */
119 __le32 sit_ver_bitmap_bytesize; /* Default value 64 */
120 __le32 nat_ver_bitmap_bytesize; /* Default value 256 */
121 __le32 checksum_offset; /* checksum offset inside cp block */
122 __le64 elapsed_time; /* mounted time */
123 /* allocation type of current segment */
124 unsigned char alloc_type[MAX_ACTIVE_LOGS];
126 /* SIT and NAT version bitmap */
127 unsigned char sit_nat_version_bitmap[1];
131 * For orphan inode management
133 #define F2FS_ORPHANS_PER_BLOCK 1020
135 #define GET_ORPHAN_BLOCKS(n) ((n + F2FS_ORPHANS_PER_BLOCK - 1) / \
136 F2FS_ORPHANS_PER_BLOCK)
138 struct f2fs_orphan_block {
139 __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */
140 __le32 reserved; /* reserved */
141 __le16 blk_addr; /* block index in current CP */
142 __le16 blk_count; /* Number of orphan inode blocks in CP */
143 __le32 entry_count; /* Total number of orphan nodes in current CP */
144 __le32 check_sum; /* CRC32 for orphan inode block */
151 __le32 fofs; /* start file offset of the extent */
152 __le32 blk_addr; /* start block address of the extent */
153 __le32 len; /* lengh of the extent */
156 #define F2FS_NAME_LEN 255
157 #define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */
158 #define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
159 #define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
160 #define ADDRS_PER_INODE(fi) addrs_per_inode(fi)
161 #define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
162 #define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
164 #define ADDRS_PER_PAGE(page, fi) \
165 (IS_INODE(page) ? ADDRS_PER_INODE(fi) : ADDRS_PER_BLOCK)
167 #define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
168 #define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
169 #define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
170 #define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
171 #define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
173 #define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
174 #define F2FS_INLINE_DATA 0x02 /* file inline data flag */
175 #define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
176 #define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
178 #define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
179 F2FS_INLINE_XATTR_ADDRS - 1))
182 __le16 i_mode; /* file mode */
183 __u8 i_advise; /* file hints */
184 __u8 i_inline; /* file inline flags */
185 __le32 i_uid; /* user ID */
186 __le32 i_gid; /* group ID */
187 __le32 i_links; /* links count */
188 __le64 i_size; /* file size in bytes */
189 __le64 i_blocks; /* file size in blocks */
190 __le64 i_atime; /* access time */
191 __le64 i_ctime; /* change time */
192 __le64 i_mtime; /* modification time */
193 __le32 i_atime_nsec; /* access time in nano scale */
194 __le32 i_ctime_nsec; /* change time in nano scale */
195 __le32 i_mtime_nsec; /* modification time in nano scale */
196 __le32 i_generation; /* file version (for NFS) */
197 __le32 i_current_depth; /* only for directory depth */
198 __le32 i_xattr_nid; /* nid to save xattr */
199 __le32 i_flags; /* file attributes */
200 __le32 i_pino; /* parent inode number */
201 __le32 i_namelen; /* file name length */
202 __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */
203 __u8 i_dir_level; /* dentry_level for large dir */
205 struct f2fs_extent i_ext; /* caching a largest extent */
207 __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */
209 __le32 i_nid[DEF_NIDS_PER_INODE]; /* direct(2), indirect(2),
210 double_indirect(1) node id */
214 __le32 addr[ADDRS_PER_BLOCK]; /* array of data block address */
217 struct indirect_node {
218 __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */
228 #define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
231 __le32 nid; /* node id */
232 __le32 ino; /* inode nunmber */
233 __le32 flag; /* include cold/fsync/dentry marks and offset */
234 __le64 cp_ver; /* checkpoint version */
235 __le32 next_blkaddr; /* next node page block address */
239 /* can be one of three types: inode, direct, and indirect types */
242 struct direct_node dn;
243 struct indirect_node in;
245 struct node_footer footer;
251 #define NAT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_nat_entry))
253 struct f2fs_nat_entry {
254 __u8 version; /* latest version of cached nat entry */
255 __le32 ino; /* inode number */
256 __le32 block_addr; /* block address */
259 struct f2fs_nat_block {
260 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
266 * Each segment is 2MB in size by default so that a bitmap for validity of
267 * there-in blocks should occupy 64 bytes, 512 bits.
268 * Not allow to change this.
270 #define SIT_VBLOCK_MAP_SIZE 64
271 #define SIT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_sit_entry))
274 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
275 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
276 * [9:0] : valid block count
278 #define SIT_VBLOCKS_SHIFT 10
279 #define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
280 #define GET_SIT_VBLOCKS(raw_sit) \
281 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
282 #define GET_SIT_TYPE(raw_sit) \
283 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
284 >> SIT_VBLOCKS_SHIFT)
286 struct f2fs_sit_entry {
287 __le16 vblocks; /* reference above */
288 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */
289 __le64 mtime; /* segment age for cleaning */
292 struct f2fs_sit_block {
293 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
297 * For segment summary
299 * One summary block contains exactly 512 summary entries, which represents
300 * exactly 2MB segment by default. Not allow to change the basic units.
302 * NOTE: For initializing fields, you must use set_summary
304 * - If data page, nid represents dnode's nid
305 * - If node page, nid represents the node page's nid.
307 * The ofs_in_node is used by only data page. It represents offset
308 * from node's page's beginning to get a data block address.
309 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
311 #define ENTRIES_IN_SUM 512
312 #define SUMMARY_SIZE (7) /* sizeof(struct summary) */
313 #define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
314 #define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
316 /* a summary entry for a 4KB-sized block in a segment */
317 struct f2fs_summary {
318 __le32 nid; /* parent node id */
322 __u8 version; /* node version number */
323 __le16 ofs_in_node; /* block index in parent node */
328 /* summary block type, node or data, is stored to the summary_footer */
329 #define SUM_TYPE_NODE (1)
330 #define SUM_TYPE_DATA (0)
332 struct summary_footer {
333 unsigned char entry_type; /* SUM_TYPE_XXX */
334 __u32 check_sum; /* summary checksum */
337 #define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
339 #define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
340 sizeof(struct nat_journal_entry))
341 #define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
342 sizeof(struct nat_journal_entry))
343 #define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
344 sizeof(struct sit_journal_entry))
345 #define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
346 sizeof(struct sit_journal_entry))
348 * frequently updated NAT/SIT entries can be stored in the spare area in
356 struct nat_journal_entry {
358 struct f2fs_nat_entry ne;
362 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
363 __u8 reserved[NAT_JOURNAL_RESERVED];
366 struct sit_journal_entry {
368 struct f2fs_sit_entry se;
372 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
373 __u8 reserved[SIT_JOURNAL_RESERVED];
376 /* 4KB-sized summary block structure */
377 struct f2fs_summary_block {
378 struct f2fs_summary entries[ENTRIES_IN_SUM];
383 /* spare area is used by NAT or SIT journals */
385 struct nat_journal nat_j;
386 struct sit_journal sit_j;
388 struct summary_footer footer;
392 * For directory operations
394 #define F2FS_DOT_HASH 0
395 #define F2FS_DDOT_HASH F2FS_DOT_HASH
396 #define F2FS_MAX_HASH (~((0x3ULL) << 62))
397 #define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
399 typedef __le32 f2fs_hash_t;
401 /* One directory entry slot covers 8bytes-long file name */
402 #define F2FS_SLOT_LEN 8
403 #define F2FS_SLOT_LEN_BITS 3
405 #define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
407 /* the number of dentry in a block */
408 #define NR_DENTRY_IN_BLOCK 214
410 /* MAX level for dir lookup */
411 #define MAX_DIR_HASH_DEPTH 63
413 /* MAX buckets in one level of dir */
414 #define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
416 #define SIZE_OF_DIR_ENTRY 11 /* by byte */
417 #define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
419 #define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
421 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
423 /* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
424 struct f2fs_dir_entry {
425 __le32 hash_code; /* hash code of file name */
426 __le32 ino; /* inode number */
427 __le16 name_len; /* lengh of file name */
428 __u8 file_type; /* file type */
431 /* 4KB-sized directory entry block */
432 struct f2fs_dentry_block {
433 /* validity bitmap for directory entries in each block */
434 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
435 __u8 reserved[SIZE_OF_RESERVED];
436 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
437 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
441 #define NR_INLINE_DENTRY (MAX_INLINE_DATA * BITS_PER_BYTE / \
442 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
444 #define INLINE_DENTRY_BITMAP_SIZE ((NR_INLINE_DENTRY + \
445 BITS_PER_BYTE - 1) / BITS_PER_BYTE)
446 #define INLINE_RESERVED_SIZE (MAX_INLINE_DATA - \
447 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
448 NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))
450 /* inline directory entry structure */
451 struct f2fs_inline_dentry {
452 __u8 dentry_bitmap[INLINE_DENTRY_BITMAP_SIZE];
453 __u8 reserved[INLINE_RESERVED_SIZE];
454 struct f2fs_dir_entry dentry[NR_INLINE_DENTRY];
455 __u8 filename[NR_INLINE_DENTRY][F2FS_SLOT_LEN];
458 /* file types used in inode_info->flags */
471 #endif /* _LINUX_F2FS_FS_H */