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_BLKSIZE_BITS 12 /* bits for F2FS_BLKSIZE */
23 #define F2FS_MAX_EXTENSION 64 /* # of extension entries */
24 #define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS)
26 #define NULL_ADDR ((block_t)0) /* used as block_t addresses */
27 #define NEW_ADDR ((block_t)-1) /* used as block_t addresses */
29 #define F2FS_BYTES_TO_BLK(bytes) ((bytes) >> F2FS_BLKSIZE_BITS)
30 #define F2FS_BLK_TO_BYTES(blk) ((blk) << F2FS_BLKSIZE_BITS)
32 /* 0, 1(node nid), 2(meta nid) are reserved node id */
33 #define F2FS_RESERVED_NODE_NUM 3
35 #define F2FS_ROOT_INO(sbi) (sbi->root_ino_num)
36 #define F2FS_NODE_INO(sbi) (sbi->node_ino_num)
37 #define F2FS_META_INO(sbi) (sbi->meta_ino_num)
39 #define F2FS_IO_SIZE(sbi) (1 << (sbi)->write_io_size_bits) /* Blocks */
40 #define F2FS_IO_SIZE_KB(sbi) (1 << ((sbi)->write_io_size_bits + 2)) /* KB */
41 #define F2FS_IO_SIZE_BYTES(sbi) (1 << ((sbi)->write_io_size_bits + 12)) /* B */
42 #define F2FS_IO_SIZE_BITS(sbi) ((sbi)->write_io_size_bits) /* power of 2 */
43 #define F2FS_IO_SIZE_MASK(sbi) (F2FS_IO_SIZE(sbi) - 1)
45 /* This flag is used by node and meta inodes, and by recovery */
46 #define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
47 #define GFP_F2FS_HIGH_ZERO (GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)
50 * For further optimization on multi-head logs, on-disk layout supports maximum
51 * 16 logs by default. The number, 16, is expected to cover all the cases
52 * enoughly. The implementaion currently uses no more than 6 logs.
53 * Half the logs are used for nodes, and the other half are used for data.
55 #define MAX_ACTIVE_LOGS 16
56 #define MAX_ACTIVE_NODE_LOGS 8
57 #define MAX_ACTIVE_DATA_LOGS 8
59 #define VERSION_LEN 256
60 #define MAX_VOLUME_NAME 512
61 #define MAX_PATH_LEN 64
68 __u8 path
[MAX_PATH_LEN
];
69 __le32 total_segments
;
72 struct f2fs_super_block
{
73 __le32 magic
; /* Magic Number */
74 __le16 major_ver
; /* Major Version */
75 __le16 minor_ver
; /* Minor Version */
76 __le32 log_sectorsize
; /* log2 sector size in bytes */
77 __le32 log_sectors_per_block
; /* log2 # of sectors per block */
78 __le32 log_blocksize
; /* log2 block size in bytes */
79 __le32 log_blocks_per_seg
; /* log2 # of blocks per segment */
80 __le32 segs_per_sec
; /* # of segments per section */
81 __le32 secs_per_zone
; /* # of sections per zone */
82 __le32 checksum_offset
; /* checksum offset inside super block */
83 __le64 block_count
; /* total # of user blocks */
84 __le32 section_count
; /* total # of sections */
85 __le32 segment_count
; /* total # of segments */
86 __le32 segment_count_ckpt
; /* # of segments for checkpoint */
87 __le32 segment_count_sit
; /* # of segments for SIT */
88 __le32 segment_count_nat
; /* # of segments for NAT */
89 __le32 segment_count_ssa
; /* # of segments for SSA */
90 __le32 segment_count_main
; /* # of segments for main area */
91 __le32 segment0_blkaddr
; /* start block address of segment 0 */
92 __le32 cp_blkaddr
; /* start block address of checkpoint */
93 __le32 sit_blkaddr
; /* start block address of SIT */
94 __le32 nat_blkaddr
; /* start block address of NAT */
95 __le32 ssa_blkaddr
; /* start block address of SSA */
96 __le32 main_blkaddr
; /* start block address of main area */
97 __le32 root_ino
; /* root inode number */
98 __le32 node_ino
; /* node inode number */
99 __le32 meta_ino
; /* meta inode number */
100 __u8 uuid
[16]; /* 128-bit uuid for volume */
101 __le16 volume_name
[MAX_VOLUME_NAME
]; /* volume name */
102 __le32 extension_count
; /* # of extensions below */
103 __u8 extension_list
[F2FS_MAX_EXTENSION
][8]; /* extension array */
105 __u8 version
[VERSION_LEN
]; /* the kernel version */
106 __u8 init_version
[VERSION_LEN
]; /* the initial kernel version */
107 __le32 feature
; /* defined features */
108 __u8 encryption_level
; /* versioning level for encryption */
109 __u8 encrypt_pw_salt
[16]; /* Salt used for string2key algorithm */
110 struct f2fs_device devs
[MAX_DEVICES
]; /* device list */
111 __u8 reserved
[327]; /* valid reserved region */
117 #define CP_NAT_BITS_FLAG 0x00000080
118 #define CP_CRC_RECOVERY_FLAG 0x00000040
119 #define CP_FASTBOOT_FLAG 0x00000020
120 #define CP_FSCK_FLAG 0x00000010
121 #define CP_ERROR_FLAG 0x00000008
122 #define CP_COMPACT_SUM_FLAG 0x00000004
123 #define CP_ORPHAN_PRESENT_FLAG 0x00000002
124 #define CP_UMOUNT_FLAG 0x00000001
126 #define F2FS_CP_PACKS 2 /* # of checkpoint packs */
128 struct f2fs_checkpoint
{
129 __le64 checkpoint_ver
; /* checkpoint block version number */
130 __le64 user_block_count
; /* # of user blocks */
131 __le64 valid_block_count
; /* # of valid blocks in main area */
132 __le32 rsvd_segment_count
; /* # of reserved segments for gc */
133 __le32 overprov_segment_count
; /* # of overprovision segments */
134 __le32 free_segment_count
; /* # of free segments in main area */
136 /* information of current node segments */
137 __le32 cur_node_segno
[MAX_ACTIVE_NODE_LOGS
];
138 __le16 cur_node_blkoff
[MAX_ACTIVE_NODE_LOGS
];
139 /* information of current data segments */
140 __le32 cur_data_segno
[MAX_ACTIVE_DATA_LOGS
];
141 __le16 cur_data_blkoff
[MAX_ACTIVE_DATA_LOGS
];
142 __le32 ckpt_flags
; /* Flags : umount and journal_present */
143 __le32 cp_pack_total_block_count
; /* total # of one cp pack */
144 __le32 cp_pack_start_sum
; /* start block number of data summary */
145 __le32 valid_node_count
; /* Total number of valid nodes */
146 __le32 valid_inode_count
; /* Total number of valid inodes */
147 __le32 next_free_nid
; /* Next free node number */
148 __le32 sit_ver_bitmap_bytesize
; /* Default value 64 */
149 __le32 nat_ver_bitmap_bytesize
; /* Default value 256 */
150 __le32 checksum_offset
; /* checksum offset inside cp block */
151 __le64 elapsed_time
; /* mounted time */
152 /* allocation type of current segment */
153 unsigned char alloc_type
[MAX_ACTIVE_LOGS
];
155 /* SIT and NAT version bitmap */
156 unsigned char sit_nat_version_bitmap
[1];
160 * For orphan inode management
162 #define F2FS_ORPHANS_PER_BLOCK 1020
164 #define GET_ORPHAN_BLOCKS(n) ((n + F2FS_ORPHANS_PER_BLOCK - 1) / \
165 F2FS_ORPHANS_PER_BLOCK)
167 struct f2fs_orphan_block
{
168 __le32 ino
[F2FS_ORPHANS_PER_BLOCK
]; /* inode numbers */
169 __le32 reserved
; /* reserved */
170 __le16 blk_addr
; /* block index in current CP */
171 __le16 blk_count
; /* Number of orphan inode blocks in CP */
172 __le32 entry_count
; /* Total number of orphan nodes in current CP */
173 __le32 check_sum
; /* CRC32 for orphan inode block */
180 __le32 fofs
; /* start file offset of the extent */
181 __le32 blk
; /* start block address of the extent */
182 __le32 len
; /* lengh of the extent */
185 #define F2FS_NAME_LEN 255
186 #define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */
187 #define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
188 #define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
189 #define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
190 #define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
191 #define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
193 #define ADDRS_PER_PAGE(page, inode) \
194 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK)
196 #define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
197 #define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
198 #define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
199 #define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
200 #define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
202 #define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
203 #define F2FS_INLINE_DATA 0x02 /* file inline data flag */
204 #define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
205 #define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
206 #define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */
208 #define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
209 F2FS_INLINE_XATTR_ADDRS - 1))
212 __le16 i_mode
; /* file mode */
213 __u8 i_advise
; /* file hints */
214 __u8 i_inline
; /* file inline flags */
215 __le32 i_uid
; /* user ID */
216 __le32 i_gid
; /* group ID */
217 __le32 i_links
; /* links count */
218 __le64 i_size
; /* file size in bytes */
219 __le64 i_blocks
; /* file size in blocks */
220 __le64 i_atime
; /* access time */
221 __le64 i_ctime
; /* change time */
222 __le64 i_mtime
; /* modification time */
223 __le32 i_atime_nsec
; /* access time in nano scale */
224 __le32 i_ctime_nsec
; /* change time in nano scale */
225 __le32 i_mtime_nsec
; /* modification time in nano scale */
226 __le32 i_generation
; /* file version (for NFS) */
227 __le32 i_current_depth
; /* only for directory depth */
228 __le32 i_xattr_nid
; /* nid to save xattr */
229 __le32 i_flags
; /* file attributes */
230 __le32 i_pino
; /* parent inode number */
231 __le32 i_namelen
; /* file name length */
232 __u8 i_name
[F2FS_NAME_LEN
]; /* file name for SPOR */
233 __u8 i_dir_level
; /* dentry_level for large dir */
235 struct f2fs_extent i_ext
; /* caching a largest extent */
237 __le32 i_addr
[DEF_ADDRS_PER_INODE
]; /* Pointers to data blocks */
239 __le32 i_nid
[DEF_NIDS_PER_INODE
]; /* direct(2), indirect(2),
240 double_indirect(1) node id */
244 __le32 addr
[ADDRS_PER_BLOCK
]; /* array of data block address */
247 struct indirect_node
{
248 __le32 nid
[NIDS_PER_BLOCK
]; /* array of data block address */
258 #define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
261 __le32 nid
; /* node id */
262 __le32 ino
; /* inode nunmber */
263 __le32 flag
; /* include cold/fsync/dentry marks and offset */
264 __le64 cp_ver
; /* checkpoint version */
265 __le32 next_blkaddr
; /* next node page block address */
269 /* can be one of three types: inode, direct, and indirect types */
272 struct direct_node dn
;
273 struct indirect_node in
;
275 struct node_footer footer
;
281 #define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
283 struct f2fs_nat_entry
{
284 __u8 version
; /* latest version of cached nat entry */
285 __le32 ino
; /* inode number */
286 __le32 block_addr
; /* block address */
289 struct f2fs_nat_block
{
290 struct f2fs_nat_entry entries
[NAT_ENTRY_PER_BLOCK
];
296 * Each segment is 2MB in size by default so that a bitmap for validity of
297 * there-in blocks should occupy 64 bytes, 512 bits.
298 * Not allow to change this.
300 #define SIT_VBLOCK_MAP_SIZE 64
301 #define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
304 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
305 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
306 * [9:0] : valid block count
308 #define SIT_VBLOCKS_SHIFT 10
309 #define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
310 #define GET_SIT_VBLOCKS(raw_sit) \
311 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
312 #define GET_SIT_TYPE(raw_sit) \
313 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
314 >> SIT_VBLOCKS_SHIFT)
316 struct f2fs_sit_entry
{
317 __le16 vblocks
; /* reference above */
318 __u8 valid_map
[SIT_VBLOCK_MAP_SIZE
]; /* bitmap for valid blocks */
319 __le64 mtime
; /* segment age for cleaning */
322 struct f2fs_sit_block
{
323 struct f2fs_sit_entry entries
[SIT_ENTRY_PER_BLOCK
];
327 * For segment summary
329 * One summary block contains exactly 512 summary entries, which represents
330 * exactly 2MB segment by default. Not allow to change the basic units.
332 * NOTE: For initializing fields, you must use set_summary
334 * - If data page, nid represents dnode's nid
335 * - If node page, nid represents the node page's nid.
337 * The ofs_in_node is used by only data page. It represents offset
338 * from node's page's beginning to get a data block address.
339 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
341 #define ENTRIES_IN_SUM 512
342 #define SUMMARY_SIZE (7) /* sizeof(struct summary) */
343 #define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
344 #define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
346 /* a summary entry for a 4KB-sized block in a segment */
347 struct f2fs_summary
{
348 __le32 nid
; /* parent node id */
352 __u8 version
; /* node version number */
353 __le16 ofs_in_node
; /* block index in parent node */
358 /* summary block type, node or data, is stored to the summary_footer */
359 #define SUM_TYPE_NODE (1)
360 #define SUM_TYPE_DATA (0)
362 struct summary_footer
{
363 unsigned char entry_type
; /* SUM_TYPE_XXX */
364 __le32 check_sum
; /* summary checksum */
367 #define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
369 #define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
370 sizeof(struct nat_journal_entry))
371 #define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
372 sizeof(struct nat_journal_entry))
373 #define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
374 sizeof(struct sit_journal_entry))
375 #define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
376 sizeof(struct sit_journal_entry))
378 /* Reserved area should make size of f2fs_extra_info equals to
379 * that of nat_journal and sit_journal.
381 #define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
384 * frequently updated NAT/SIT entries can be stored in the spare area in
392 struct nat_journal_entry
{
394 struct f2fs_nat_entry ne
;
398 struct nat_journal_entry entries
[NAT_JOURNAL_ENTRIES
];
399 __u8 reserved
[NAT_JOURNAL_RESERVED
];
402 struct sit_journal_entry
{
404 struct f2fs_sit_entry se
;
408 struct sit_journal_entry entries
[SIT_JOURNAL_ENTRIES
];
409 __u8 reserved
[SIT_JOURNAL_RESERVED
];
412 struct f2fs_extra_info
{
413 __le64 kbytes_written
;
414 __u8 reserved
[EXTRA_INFO_RESERVED
];
417 struct f2fs_journal
{
422 /* spare area is used by NAT or SIT journals or extra info */
424 struct nat_journal nat_j
;
425 struct sit_journal sit_j
;
426 struct f2fs_extra_info info
;
430 /* 4KB-sized summary block structure */
431 struct f2fs_summary_block
{
432 struct f2fs_summary entries
[ENTRIES_IN_SUM
];
433 struct f2fs_journal journal
;
434 struct summary_footer footer
;
438 * For directory operations
440 #define F2FS_DOT_HASH 0
441 #define F2FS_DDOT_HASH F2FS_DOT_HASH
442 #define F2FS_MAX_HASH (~((0x3ULL) << 62))
443 #define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
445 typedef __le32 f2fs_hash_t
;
447 /* One directory entry slot covers 8bytes-long file name */
448 #define F2FS_SLOT_LEN 8
449 #define F2FS_SLOT_LEN_BITS 3
451 #define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
453 /* MAX level for dir lookup */
454 #define MAX_DIR_HASH_DEPTH 63
456 /* MAX buckets in one level of dir */
457 #define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
460 * space utilization of regular dentry and inline dentry
461 * regular dentry inline dentry
462 * bitmap 1 * 27 = 27 1 * 23 = 23
463 * reserved 1 * 3 = 3 1 * 7 = 7
464 * dentry 11 * 214 = 2354 11 * 182 = 2002
465 * filename 8 * 214 = 1712 8 * 182 = 1456
468 * Note: there are more reserved space in inline dentry than in regular
469 * dentry, when converting inline dentry we should handle this carefully.
471 #define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */
472 #define SIZE_OF_DIR_ENTRY 11 /* by byte */
473 #define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
475 #define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
477 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
479 /* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
480 struct f2fs_dir_entry
{
481 __le32 hash_code
; /* hash code of file name */
482 __le32 ino
; /* inode number */
483 __le16 name_len
; /* lengh of file name */
484 __u8 file_type
; /* file type */
487 /* 4KB-sized directory entry block */
488 struct f2fs_dentry_block
{
489 /* validity bitmap for directory entries in each block */
490 __u8 dentry_bitmap
[SIZE_OF_DENTRY_BITMAP
];
491 __u8 reserved
[SIZE_OF_RESERVED
];
492 struct f2fs_dir_entry dentry
[NR_DENTRY_IN_BLOCK
];
493 __u8 filename
[NR_DENTRY_IN_BLOCK
][F2FS_SLOT_LEN
];
497 #define NR_INLINE_DENTRY (MAX_INLINE_DATA * BITS_PER_BYTE / \
498 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
500 #define INLINE_DENTRY_BITMAP_SIZE ((NR_INLINE_DENTRY + \
501 BITS_PER_BYTE - 1) / BITS_PER_BYTE)
502 #define INLINE_RESERVED_SIZE (MAX_INLINE_DATA - \
503 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
504 NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))
506 /* inline directory entry structure */
507 struct f2fs_inline_dentry
{
508 __u8 dentry_bitmap
[INLINE_DENTRY_BITMAP_SIZE
];
509 __u8 reserved
[INLINE_RESERVED_SIZE
];
510 struct f2fs_dir_entry dentry
[NR_INLINE_DENTRY
];
511 __u8 filename
[NR_INLINE_DENTRY
][F2FS_SLOT_LEN
];
514 /* file types used in inode_info->flags */
529 #endif /* _LINUX_F2FS_FS_H */