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 /* This flag is used by node and meta inodes, and by recovery */
40 #define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
41 #define GFP_F2FS_HIGH_ZERO (GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)
44 * For further optimization on multi-head logs, on-disk layout supports maximum
45 * 16 logs by default. The number, 16, is expected to cover all the cases
46 * enoughly. The implementaion currently uses no more than 6 logs.
47 * Half the logs are used for nodes, and the other half are used for data.
49 #define MAX_ACTIVE_LOGS 16
50 #define MAX_ACTIVE_NODE_LOGS 8
51 #define MAX_ACTIVE_DATA_LOGS 8
53 #define VERSION_LEN 256
54 #define MAX_VOLUME_NAME 512
55 #define MAX_PATH_LEN 64
62 __u8 path
[MAX_PATH_LEN
];
63 __le32 total_segments
;
66 struct f2fs_super_block
{
67 __le32 magic
; /* Magic Number */
68 __le16 major_ver
; /* Major Version */
69 __le16 minor_ver
; /* Minor Version */
70 __le32 log_sectorsize
; /* log2 sector size in bytes */
71 __le32 log_sectors_per_block
; /* log2 # of sectors per block */
72 __le32 log_blocksize
; /* log2 block size in bytes */
73 __le32 log_blocks_per_seg
; /* log2 # of blocks per segment */
74 __le32 segs_per_sec
; /* # of segments per section */
75 __le32 secs_per_zone
; /* # of sections per zone */
76 __le32 checksum_offset
; /* checksum offset inside super block */
77 __le64 block_count
; /* total # of user blocks */
78 __le32 section_count
; /* total # of sections */
79 __le32 segment_count
; /* total # of segments */
80 __le32 segment_count_ckpt
; /* # of segments for checkpoint */
81 __le32 segment_count_sit
; /* # of segments for SIT */
82 __le32 segment_count_nat
; /* # of segments for NAT */
83 __le32 segment_count_ssa
; /* # of segments for SSA */
84 __le32 segment_count_main
; /* # of segments for main area */
85 __le32 segment0_blkaddr
; /* start block address of segment 0 */
86 __le32 cp_blkaddr
; /* start block address of checkpoint */
87 __le32 sit_blkaddr
; /* start block address of SIT */
88 __le32 nat_blkaddr
; /* start block address of NAT */
89 __le32 ssa_blkaddr
; /* start block address of SSA */
90 __le32 main_blkaddr
; /* start block address of main area */
91 __le32 root_ino
; /* root inode number */
92 __le32 node_ino
; /* node inode number */
93 __le32 meta_ino
; /* meta inode number */
94 __u8 uuid
[16]; /* 128-bit uuid for volume */
95 __le16 volume_name
[MAX_VOLUME_NAME
]; /* volume name */
96 __le32 extension_count
; /* # of extensions below */
97 __u8 extension_list
[F2FS_MAX_EXTENSION
][8]; /* extension array */
99 __u8 version
[VERSION_LEN
]; /* the kernel version */
100 __u8 init_version
[VERSION_LEN
]; /* the initial kernel version */
101 __le32 feature
; /* defined features */
102 __u8 encryption_level
; /* versioning level for encryption */
103 __u8 encrypt_pw_salt
[16]; /* Salt used for string2key algorithm */
104 struct f2fs_device devs
[MAX_DEVICES
]; /* device list */
105 __u8 reserved
[327]; /* valid reserved region */
111 #define CP_CRC_RECOVERY_FLAG 0x00000040
112 #define CP_FASTBOOT_FLAG 0x00000020
113 #define CP_FSCK_FLAG 0x00000010
114 #define CP_ERROR_FLAG 0x00000008
115 #define CP_COMPACT_SUM_FLAG 0x00000004
116 #define CP_ORPHAN_PRESENT_FLAG 0x00000002
117 #define CP_UMOUNT_FLAG 0x00000001
119 #define F2FS_CP_PACKS 2 /* # of checkpoint packs */
121 struct f2fs_checkpoint
{
122 __le64 checkpoint_ver
; /* checkpoint block version number */
123 __le64 user_block_count
; /* # of user blocks */
124 __le64 valid_block_count
; /* # of valid blocks in main area */
125 __le32 rsvd_segment_count
; /* # of reserved segments for gc */
126 __le32 overprov_segment_count
; /* # of overprovision segments */
127 __le32 free_segment_count
; /* # of free segments in main area */
129 /* information of current node segments */
130 __le32 cur_node_segno
[MAX_ACTIVE_NODE_LOGS
];
131 __le16 cur_node_blkoff
[MAX_ACTIVE_NODE_LOGS
];
132 /* information of current data segments */
133 __le32 cur_data_segno
[MAX_ACTIVE_DATA_LOGS
];
134 __le16 cur_data_blkoff
[MAX_ACTIVE_DATA_LOGS
];
135 __le32 ckpt_flags
; /* Flags : umount and journal_present */
136 __le32 cp_pack_total_block_count
; /* total # of one cp pack */
137 __le32 cp_pack_start_sum
; /* start block number of data summary */
138 __le32 valid_node_count
; /* Total number of valid nodes */
139 __le32 valid_inode_count
; /* Total number of valid inodes */
140 __le32 next_free_nid
; /* Next free node number */
141 __le32 sit_ver_bitmap_bytesize
; /* Default value 64 */
142 __le32 nat_ver_bitmap_bytesize
; /* Default value 256 */
143 __le32 checksum_offset
; /* checksum offset inside cp block */
144 __le64 elapsed_time
; /* mounted time */
145 /* allocation type of current segment */
146 unsigned char alloc_type
[MAX_ACTIVE_LOGS
];
148 /* SIT and NAT version bitmap */
149 unsigned char sit_nat_version_bitmap
[1];
153 * For orphan inode management
155 #define F2FS_ORPHANS_PER_BLOCK 1020
157 #define GET_ORPHAN_BLOCKS(n) ((n + F2FS_ORPHANS_PER_BLOCK - 1) / \
158 F2FS_ORPHANS_PER_BLOCK)
160 struct f2fs_orphan_block
{
161 __le32 ino
[F2FS_ORPHANS_PER_BLOCK
]; /* inode numbers */
162 __le32 reserved
; /* reserved */
163 __le16 blk_addr
; /* block index in current CP */
164 __le16 blk_count
; /* Number of orphan inode blocks in CP */
165 __le32 entry_count
; /* Total number of orphan nodes in current CP */
166 __le32 check_sum
; /* CRC32 for orphan inode block */
173 __le32 fofs
; /* start file offset of the extent */
174 __le32 blk
; /* start block address of the extent */
175 __le32 len
; /* lengh of the extent */
178 #define F2FS_NAME_LEN 255
179 #define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */
180 #define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
181 #define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
182 #define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
183 #define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
184 #define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
186 #define ADDRS_PER_PAGE(page, inode) \
187 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK)
189 #define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
190 #define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
191 #define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
192 #define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
193 #define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
195 #define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
196 #define F2FS_INLINE_DATA 0x02 /* file inline data flag */
197 #define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
198 #define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
199 #define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */
201 #define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
202 F2FS_INLINE_XATTR_ADDRS - 1))
205 __le16 i_mode
; /* file mode */
206 __u8 i_advise
; /* file hints */
207 __u8 i_inline
; /* file inline flags */
208 __le32 i_uid
; /* user ID */
209 __le32 i_gid
; /* group ID */
210 __le32 i_links
; /* links count */
211 __le64 i_size
; /* file size in bytes */
212 __le64 i_blocks
; /* file size in blocks */
213 __le64 i_atime
; /* access time */
214 __le64 i_ctime
; /* change time */
215 __le64 i_mtime
; /* modification time */
216 __le32 i_atime_nsec
; /* access time in nano scale */
217 __le32 i_ctime_nsec
; /* change time in nano scale */
218 __le32 i_mtime_nsec
; /* modification time in nano scale */
219 __le32 i_generation
; /* file version (for NFS) */
220 __le32 i_current_depth
; /* only for directory depth */
221 __le32 i_xattr_nid
; /* nid to save xattr */
222 __le32 i_flags
; /* file attributes */
223 __le32 i_pino
; /* parent inode number */
224 __le32 i_namelen
; /* file name length */
225 __u8 i_name
[F2FS_NAME_LEN
]; /* file name for SPOR */
226 __u8 i_dir_level
; /* dentry_level for large dir */
228 struct f2fs_extent i_ext
; /* caching a largest extent */
230 __le32 i_addr
[DEF_ADDRS_PER_INODE
]; /* Pointers to data blocks */
232 __le32 i_nid
[DEF_NIDS_PER_INODE
]; /* direct(2), indirect(2),
233 double_indirect(1) node id */
237 __le32 addr
[ADDRS_PER_BLOCK
]; /* array of data block address */
240 struct indirect_node
{
241 __le32 nid
[NIDS_PER_BLOCK
]; /* array of data block address */
251 #define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
254 __le32 nid
; /* node id */
255 __le32 ino
; /* inode nunmber */
256 __le32 flag
; /* include cold/fsync/dentry marks and offset */
257 __le64 cp_ver
; /* checkpoint version */
258 __le32 next_blkaddr
; /* next node page block address */
262 /* can be one of three types: inode, direct, and indirect types */
265 struct direct_node dn
;
266 struct indirect_node in
;
268 struct node_footer footer
;
274 #define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
276 struct f2fs_nat_entry
{
277 __u8 version
; /* latest version of cached nat entry */
278 __le32 ino
; /* inode number */
279 __le32 block_addr
; /* block address */
282 struct f2fs_nat_block
{
283 struct f2fs_nat_entry entries
[NAT_ENTRY_PER_BLOCK
];
289 * Each segment is 2MB in size by default so that a bitmap for validity of
290 * there-in blocks should occupy 64 bytes, 512 bits.
291 * Not allow to change this.
293 #define SIT_VBLOCK_MAP_SIZE 64
294 #define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
297 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
298 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
299 * [9:0] : valid block count
301 #define SIT_VBLOCKS_SHIFT 10
302 #define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
303 #define GET_SIT_VBLOCKS(raw_sit) \
304 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
305 #define GET_SIT_TYPE(raw_sit) \
306 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
307 >> SIT_VBLOCKS_SHIFT)
309 struct f2fs_sit_entry
{
310 __le16 vblocks
; /* reference above */
311 __u8 valid_map
[SIT_VBLOCK_MAP_SIZE
]; /* bitmap for valid blocks */
312 __le64 mtime
; /* segment age for cleaning */
315 struct f2fs_sit_block
{
316 struct f2fs_sit_entry entries
[SIT_ENTRY_PER_BLOCK
];
320 * For segment summary
322 * One summary block contains exactly 512 summary entries, which represents
323 * exactly 2MB segment by default. Not allow to change the basic units.
325 * NOTE: For initializing fields, you must use set_summary
327 * - If data page, nid represents dnode's nid
328 * - If node page, nid represents the node page's nid.
330 * The ofs_in_node is used by only data page. It represents offset
331 * from node's page's beginning to get a data block address.
332 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
334 #define ENTRIES_IN_SUM 512
335 #define SUMMARY_SIZE (7) /* sizeof(struct summary) */
336 #define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
337 #define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
339 /* a summary entry for a 4KB-sized block in a segment */
340 struct f2fs_summary
{
341 __le32 nid
; /* parent node id */
345 __u8 version
; /* node version number */
346 __le16 ofs_in_node
; /* block index in parent node */
351 /* summary block type, node or data, is stored to the summary_footer */
352 #define SUM_TYPE_NODE (1)
353 #define SUM_TYPE_DATA (0)
355 struct summary_footer
{
356 unsigned char entry_type
; /* SUM_TYPE_XXX */
357 __le32 check_sum
; /* summary checksum */
360 #define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
362 #define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
363 sizeof(struct nat_journal_entry))
364 #define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
365 sizeof(struct nat_journal_entry))
366 #define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
367 sizeof(struct sit_journal_entry))
368 #define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
369 sizeof(struct sit_journal_entry))
371 /* Reserved area should make size of f2fs_extra_info equals to
372 * that of nat_journal and sit_journal.
374 #define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
377 * frequently updated NAT/SIT entries can be stored in the spare area in
385 struct nat_journal_entry
{
387 struct f2fs_nat_entry ne
;
391 struct nat_journal_entry entries
[NAT_JOURNAL_ENTRIES
];
392 __u8 reserved
[NAT_JOURNAL_RESERVED
];
395 struct sit_journal_entry
{
397 struct f2fs_sit_entry se
;
401 struct sit_journal_entry entries
[SIT_JOURNAL_ENTRIES
];
402 __u8 reserved
[SIT_JOURNAL_RESERVED
];
405 struct f2fs_extra_info
{
406 __le64 kbytes_written
;
407 __u8 reserved
[EXTRA_INFO_RESERVED
];
410 struct f2fs_journal
{
415 /* spare area is used by NAT or SIT journals or extra info */
417 struct nat_journal nat_j
;
418 struct sit_journal sit_j
;
419 struct f2fs_extra_info info
;
423 /* 4KB-sized summary block structure */
424 struct f2fs_summary_block
{
425 struct f2fs_summary entries
[ENTRIES_IN_SUM
];
426 struct f2fs_journal journal
;
427 struct summary_footer footer
;
431 * For directory operations
433 #define F2FS_DOT_HASH 0
434 #define F2FS_DDOT_HASH F2FS_DOT_HASH
435 #define F2FS_MAX_HASH (~((0x3ULL) << 62))
436 #define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
438 typedef __le32 f2fs_hash_t
;
440 /* One directory entry slot covers 8bytes-long file name */
441 #define F2FS_SLOT_LEN 8
442 #define F2FS_SLOT_LEN_BITS 3
444 #define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
446 /* MAX level for dir lookup */
447 #define MAX_DIR_HASH_DEPTH 63
449 /* MAX buckets in one level of dir */
450 #define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
453 * space utilization of regular dentry and inline dentry
454 * regular dentry inline dentry
455 * bitmap 1 * 27 = 27 1 * 23 = 23
456 * reserved 1 * 3 = 3 1 * 7 = 7
457 * dentry 11 * 214 = 2354 11 * 182 = 2002
458 * filename 8 * 214 = 1712 8 * 182 = 1456
461 * Note: there are more reserved space in inline dentry than in regular
462 * dentry, when converting inline dentry we should handle this carefully.
464 #define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */
465 #define SIZE_OF_DIR_ENTRY 11 /* by byte */
466 #define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
468 #define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
470 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
472 /* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
473 struct f2fs_dir_entry
{
474 __le32 hash_code
; /* hash code of file name */
475 __le32 ino
; /* inode number */
476 __le16 name_len
; /* lengh of file name */
477 __u8 file_type
; /* file type */
480 /* 4KB-sized directory entry block */
481 struct f2fs_dentry_block
{
482 /* validity bitmap for directory entries in each block */
483 __u8 dentry_bitmap
[SIZE_OF_DENTRY_BITMAP
];
484 __u8 reserved
[SIZE_OF_RESERVED
];
485 struct f2fs_dir_entry dentry
[NR_DENTRY_IN_BLOCK
];
486 __u8 filename
[NR_DENTRY_IN_BLOCK
][F2FS_SLOT_LEN
];
490 #define NR_INLINE_DENTRY (MAX_INLINE_DATA * BITS_PER_BYTE / \
491 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
493 #define INLINE_DENTRY_BITMAP_SIZE ((NR_INLINE_DENTRY + \
494 BITS_PER_BYTE - 1) / BITS_PER_BYTE)
495 #define INLINE_RESERVED_SIZE (MAX_INLINE_DATA - \
496 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
497 NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))
499 /* inline directory entry structure */
500 struct f2fs_inline_dentry
{
501 __u8 dentry_bitmap
[INLINE_DENTRY_BITMAP_SIZE
];
502 __u8 reserved
[INLINE_RESERVED_SIZE
];
503 struct f2fs_dir_entry dentry
[NR_INLINE_DENTRY
];
504 __u8 filename
[NR_INLINE_DENTRY
][F2FS_SLOT_LEN
];
507 /* file types used in inode_info->flags */
522 #endif /* _LINUX_F2FS_FS_H */