1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0 2*4882a593Smuzhiyun /** 3*4882a593Smuzhiyun * include/linux/f2fs_fs.h 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright (c) 2012 Samsung Electronics Co., Ltd. 6*4882a593Smuzhiyun * http://www.samsung.com/ 7*4882a593Smuzhiyun */ 8*4882a593Smuzhiyun #ifndef _LINUX_F2FS_FS_H 9*4882a593Smuzhiyun #define _LINUX_F2FS_FS_H 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #include <linux/pagemap.h> 12*4882a593Smuzhiyun #include <linux/types.h> 13*4882a593Smuzhiyun 14*4882a593Smuzhiyun #define F2FS_SUPER_OFFSET 1024 /* byte-size offset */ 15*4882a593Smuzhiyun #define F2FS_MIN_LOG_SECTOR_SIZE 9 /* 9 bits for 512 bytes */ 16*4882a593Smuzhiyun #define F2FS_MAX_LOG_SECTOR_SIZE 12 /* 12 bits for 4096 bytes */ 17*4882a593Smuzhiyun #define F2FS_LOG_SECTORS_PER_BLOCK 3 /* log number for sector/blk */ 18*4882a593Smuzhiyun #define F2FS_BLKSIZE 4096 /* support only 4KB block */ 19*4882a593Smuzhiyun #define F2FS_BLKSIZE_BITS 12 /* bits for F2FS_BLKSIZE */ 20*4882a593Smuzhiyun #define F2FS_MAX_EXTENSION 64 /* # of extension entries */ 21*4882a593Smuzhiyun #define F2FS_EXTENSION_LEN 8 /* max size of extension */ 22*4882a593Smuzhiyun #define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS) 23*4882a593Smuzhiyun 24*4882a593Smuzhiyun #define NULL_ADDR ((block_t)0) /* used as block_t addresses */ 25*4882a593Smuzhiyun #define NEW_ADDR ((block_t)-1) /* used as block_t addresses */ 26*4882a593Smuzhiyun #define COMPRESS_ADDR ((block_t)-2) /* used as compressed data flag */ 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun #define F2FS_BYTES_TO_BLK(bytes) ((bytes) >> F2FS_BLKSIZE_BITS) 29*4882a593Smuzhiyun #define F2FS_BLK_TO_BYTES(blk) ((blk) << F2FS_BLKSIZE_BITS) 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun /* 0, 1(node nid), 2(meta nid) are reserved node id */ 32*4882a593Smuzhiyun #define F2FS_RESERVED_NODE_NUM 3 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun #define F2FS_ROOT_INO(sbi) ((sbi)->root_ino_num) 35*4882a593Smuzhiyun #define F2FS_NODE_INO(sbi) ((sbi)->node_ino_num) 36*4882a593Smuzhiyun #define F2FS_META_INO(sbi) ((sbi)->meta_ino_num) 37*4882a593Smuzhiyun #define F2FS_COMPRESS_INO(sbi) (NM_I(sbi)->max_nid) 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun #define F2FS_MAX_QUOTAS 3 40*4882a593Smuzhiyun 41*4882a593Smuzhiyun #define F2FS_ENC_UTF8_12_1 1 42*4882a593Smuzhiyun 43*4882a593Smuzhiyun #define F2FS_IO_SIZE(sbi) (1 << F2FS_OPTION(sbi).write_io_size_bits) /* Blocks */ 44*4882a593Smuzhiyun #define F2FS_IO_SIZE_KB(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 2)) /* KB */ 45*4882a593Smuzhiyun #define F2FS_IO_SIZE_BYTES(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 12)) /* B */ 46*4882a593Smuzhiyun #define F2FS_IO_SIZE_BITS(sbi) (F2FS_OPTION(sbi).write_io_size_bits) /* power of 2 */ 47*4882a593Smuzhiyun #define F2FS_IO_SIZE_MASK(sbi) (F2FS_IO_SIZE(sbi) - 1) 48*4882a593Smuzhiyun #define F2FS_IO_ALIGNED(sbi) (F2FS_IO_SIZE(sbi) > 1) 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun /* This flag is used by node and meta inodes, and by recovery */ 51*4882a593Smuzhiyun #define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO) 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun /* 54*4882a593Smuzhiyun * For further optimization on multi-head logs, on-disk layout supports maximum 55*4882a593Smuzhiyun * 16 logs by default. The number, 16, is expected to cover all the cases 56*4882a593Smuzhiyun * enoughly. The implementaion currently uses no more than 6 logs. 57*4882a593Smuzhiyun * Half the logs are used for nodes, and the other half are used for data. 58*4882a593Smuzhiyun */ 59*4882a593Smuzhiyun #define MAX_ACTIVE_LOGS 16 60*4882a593Smuzhiyun #define MAX_ACTIVE_NODE_LOGS 8 61*4882a593Smuzhiyun #define MAX_ACTIVE_DATA_LOGS 8 62*4882a593Smuzhiyun 63*4882a593Smuzhiyun #define VERSION_LEN 256 64*4882a593Smuzhiyun #define MAX_VOLUME_NAME 512 65*4882a593Smuzhiyun #define MAX_PATH_LEN 64 66*4882a593Smuzhiyun #define MAX_DEVICES 8 67*4882a593Smuzhiyun 68*4882a593Smuzhiyun /* 69*4882a593Smuzhiyun * For superblock 70*4882a593Smuzhiyun */ 71*4882a593Smuzhiyun struct f2fs_device { 72*4882a593Smuzhiyun __u8 path[MAX_PATH_LEN]; 73*4882a593Smuzhiyun __le32 total_segments; 74*4882a593Smuzhiyun } __packed; 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun /* reason of stop_checkpoint */ 77*4882a593Smuzhiyun enum stop_cp_reason { 78*4882a593Smuzhiyun STOP_CP_REASON_SHUTDOWN, 79*4882a593Smuzhiyun STOP_CP_REASON_FAULT_INJECT, 80*4882a593Smuzhiyun STOP_CP_REASON_META_PAGE, 81*4882a593Smuzhiyun STOP_CP_REASON_WRITE_FAIL, 82*4882a593Smuzhiyun STOP_CP_REASON_CORRUPTED_SUMMARY, 83*4882a593Smuzhiyun STOP_CP_REASON_UPDATE_INODE, 84*4882a593Smuzhiyun STOP_CP_REASON_FLUSH_FAIL, 85*4882a593Smuzhiyun STOP_CP_REASON_MAX, 86*4882a593Smuzhiyun }; 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun #define MAX_STOP_REASON 32 89*4882a593Smuzhiyun 90*4882a593Smuzhiyun struct f2fs_super_block { 91*4882a593Smuzhiyun __le32 magic; /* Magic Number */ 92*4882a593Smuzhiyun __le16 major_ver; /* Major Version */ 93*4882a593Smuzhiyun __le16 minor_ver; /* Minor Version */ 94*4882a593Smuzhiyun __le32 log_sectorsize; /* log2 sector size in bytes */ 95*4882a593Smuzhiyun __le32 log_sectors_per_block; /* log2 # of sectors per block */ 96*4882a593Smuzhiyun __le32 log_blocksize; /* log2 block size in bytes */ 97*4882a593Smuzhiyun __le32 log_blocks_per_seg; /* log2 # of blocks per segment */ 98*4882a593Smuzhiyun __le32 segs_per_sec; /* # of segments per section */ 99*4882a593Smuzhiyun __le32 secs_per_zone; /* # of sections per zone */ 100*4882a593Smuzhiyun __le32 checksum_offset; /* checksum offset inside super block */ 101*4882a593Smuzhiyun __le64 block_count; /* total # of user blocks */ 102*4882a593Smuzhiyun __le32 section_count; /* total # of sections */ 103*4882a593Smuzhiyun __le32 segment_count; /* total # of segments */ 104*4882a593Smuzhiyun __le32 segment_count_ckpt; /* # of segments for checkpoint */ 105*4882a593Smuzhiyun __le32 segment_count_sit; /* # of segments for SIT */ 106*4882a593Smuzhiyun __le32 segment_count_nat; /* # of segments for NAT */ 107*4882a593Smuzhiyun __le32 segment_count_ssa; /* # of segments for SSA */ 108*4882a593Smuzhiyun __le32 segment_count_main; /* # of segments for main area */ 109*4882a593Smuzhiyun __le32 segment0_blkaddr; /* start block address of segment 0 */ 110*4882a593Smuzhiyun __le32 cp_blkaddr; /* start block address of checkpoint */ 111*4882a593Smuzhiyun __le32 sit_blkaddr; /* start block address of SIT */ 112*4882a593Smuzhiyun __le32 nat_blkaddr; /* start block address of NAT */ 113*4882a593Smuzhiyun __le32 ssa_blkaddr; /* start block address of SSA */ 114*4882a593Smuzhiyun __le32 main_blkaddr; /* start block address of main area */ 115*4882a593Smuzhiyun __le32 root_ino; /* root inode number */ 116*4882a593Smuzhiyun __le32 node_ino; /* node inode number */ 117*4882a593Smuzhiyun __le32 meta_ino; /* meta inode number */ 118*4882a593Smuzhiyun __u8 uuid[16]; /* 128-bit uuid for volume */ 119*4882a593Smuzhiyun __le16 volume_name[MAX_VOLUME_NAME]; /* volume name */ 120*4882a593Smuzhiyun __le32 extension_count; /* # of extensions below */ 121*4882a593Smuzhiyun __u8 extension_list[F2FS_MAX_EXTENSION][F2FS_EXTENSION_LEN];/* extension array */ 122*4882a593Smuzhiyun __le32 cp_payload; 123*4882a593Smuzhiyun __u8 version[VERSION_LEN]; /* the kernel version */ 124*4882a593Smuzhiyun __u8 init_version[VERSION_LEN]; /* the initial kernel version */ 125*4882a593Smuzhiyun __le32 feature; /* defined features */ 126*4882a593Smuzhiyun __u8 encryption_level; /* versioning level for encryption */ 127*4882a593Smuzhiyun __u8 encrypt_pw_salt[16]; /* Salt used for string2key algorithm */ 128*4882a593Smuzhiyun struct f2fs_device devs[MAX_DEVICES]; /* device list */ 129*4882a593Smuzhiyun __le32 qf_ino[F2FS_MAX_QUOTAS]; /* quota inode numbers */ 130*4882a593Smuzhiyun __u8 hot_ext_count; /* # of hot file extension */ 131*4882a593Smuzhiyun __le16 s_encoding; /* Filename charset encoding */ 132*4882a593Smuzhiyun __le16 s_encoding_flags; /* Filename charset encoding flags */ 133*4882a593Smuzhiyun __u8 s_stop_reason[MAX_STOP_REASON]; /* stop checkpoint reason */ 134*4882a593Smuzhiyun __u8 reserved[274]; /* valid reserved region */ 135*4882a593Smuzhiyun __le32 crc; /* checksum of superblock */ 136*4882a593Smuzhiyun } __packed; 137*4882a593Smuzhiyun 138*4882a593Smuzhiyun /* 139*4882a593Smuzhiyun * For checkpoint 140*4882a593Smuzhiyun */ 141*4882a593Smuzhiyun #define CP_RESIZEFS_FLAG 0x00004000 142*4882a593Smuzhiyun #define CP_DISABLED_QUICK_FLAG 0x00002000 143*4882a593Smuzhiyun #define CP_DISABLED_FLAG 0x00001000 144*4882a593Smuzhiyun #define CP_QUOTA_NEED_FSCK_FLAG 0x00000800 145*4882a593Smuzhiyun #define CP_LARGE_NAT_BITMAP_FLAG 0x00000400 146*4882a593Smuzhiyun #define CP_NOCRC_RECOVERY_FLAG 0x00000200 147*4882a593Smuzhiyun #define CP_TRIMMED_FLAG 0x00000100 148*4882a593Smuzhiyun #define CP_NAT_BITS_FLAG 0x00000080 149*4882a593Smuzhiyun #define CP_CRC_RECOVERY_FLAG 0x00000040 150*4882a593Smuzhiyun #define CP_FASTBOOT_FLAG 0x00000020 151*4882a593Smuzhiyun #define CP_FSCK_FLAG 0x00000010 152*4882a593Smuzhiyun #define CP_ERROR_FLAG 0x00000008 153*4882a593Smuzhiyun #define CP_COMPACT_SUM_FLAG 0x00000004 154*4882a593Smuzhiyun #define CP_ORPHAN_PRESENT_FLAG 0x00000002 155*4882a593Smuzhiyun #define CP_UMOUNT_FLAG 0x00000001 156*4882a593Smuzhiyun 157*4882a593Smuzhiyun #define F2FS_CP_PACKS 2 /* # of checkpoint packs */ 158*4882a593Smuzhiyun 159*4882a593Smuzhiyun struct f2fs_checkpoint { 160*4882a593Smuzhiyun __le64 checkpoint_ver; /* checkpoint block version number */ 161*4882a593Smuzhiyun __le64 user_block_count; /* # of user blocks */ 162*4882a593Smuzhiyun __le64 valid_block_count; /* # of valid blocks in main area */ 163*4882a593Smuzhiyun __le32 rsvd_segment_count; /* # of reserved segments for gc */ 164*4882a593Smuzhiyun __le32 overprov_segment_count; /* # of overprovision segments */ 165*4882a593Smuzhiyun __le32 free_segment_count; /* # of free segments in main area */ 166*4882a593Smuzhiyun 167*4882a593Smuzhiyun /* information of current node segments */ 168*4882a593Smuzhiyun __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS]; 169*4882a593Smuzhiyun __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS]; 170*4882a593Smuzhiyun /* information of current data segments */ 171*4882a593Smuzhiyun __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS]; 172*4882a593Smuzhiyun __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS]; 173*4882a593Smuzhiyun __le32 ckpt_flags; /* Flags : umount and journal_present */ 174*4882a593Smuzhiyun __le32 cp_pack_total_block_count; /* total # of one cp pack */ 175*4882a593Smuzhiyun __le32 cp_pack_start_sum; /* start block number of data summary */ 176*4882a593Smuzhiyun __le32 valid_node_count; /* Total number of valid nodes */ 177*4882a593Smuzhiyun __le32 valid_inode_count; /* Total number of valid inodes */ 178*4882a593Smuzhiyun __le32 next_free_nid; /* Next free node number */ 179*4882a593Smuzhiyun __le32 sit_ver_bitmap_bytesize; /* Default value 64 */ 180*4882a593Smuzhiyun __le32 nat_ver_bitmap_bytesize; /* Default value 256 */ 181*4882a593Smuzhiyun __le32 checksum_offset; /* checksum offset inside cp block */ 182*4882a593Smuzhiyun __le64 elapsed_time; /* mounted time */ 183*4882a593Smuzhiyun /* allocation type of current segment */ 184*4882a593Smuzhiyun unsigned char alloc_type[MAX_ACTIVE_LOGS]; 185*4882a593Smuzhiyun 186*4882a593Smuzhiyun /* SIT and NAT version bitmap */ 187*4882a593Smuzhiyun unsigned char sit_nat_version_bitmap[]; 188*4882a593Smuzhiyun } __packed; 189*4882a593Smuzhiyun 190*4882a593Smuzhiyun #define CP_CHKSUM_OFFSET 4092 /* default chksum offset in checkpoint */ 191*4882a593Smuzhiyun #define CP_MIN_CHKSUM_OFFSET \ 192*4882a593Smuzhiyun (offsetof(struct f2fs_checkpoint, sit_nat_version_bitmap)) 193*4882a593Smuzhiyun 194*4882a593Smuzhiyun /* 195*4882a593Smuzhiyun * For orphan inode management 196*4882a593Smuzhiyun */ 197*4882a593Smuzhiyun #define F2FS_ORPHANS_PER_BLOCK 1020 198*4882a593Smuzhiyun 199*4882a593Smuzhiyun #define GET_ORPHAN_BLOCKS(n) (((n) + F2FS_ORPHANS_PER_BLOCK - 1) / \ 200*4882a593Smuzhiyun F2FS_ORPHANS_PER_BLOCK) 201*4882a593Smuzhiyun 202*4882a593Smuzhiyun struct f2fs_orphan_block { 203*4882a593Smuzhiyun __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */ 204*4882a593Smuzhiyun __le32 reserved; /* reserved */ 205*4882a593Smuzhiyun __le16 blk_addr; /* block index in current CP */ 206*4882a593Smuzhiyun __le16 blk_count; /* Number of orphan inode blocks in CP */ 207*4882a593Smuzhiyun __le32 entry_count; /* Total number of orphan nodes in current CP */ 208*4882a593Smuzhiyun __le32 check_sum; /* CRC32 for orphan inode block */ 209*4882a593Smuzhiyun } __packed; 210*4882a593Smuzhiyun 211*4882a593Smuzhiyun /* 212*4882a593Smuzhiyun * For NODE structure 213*4882a593Smuzhiyun */ 214*4882a593Smuzhiyun struct f2fs_extent { 215*4882a593Smuzhiyun __le32 fofs; /* start file offset of the extent */ 216*4882a593Smuzhiyun __le32 blk; /* start block address of the extent */ 217*4882a593Smuzhiyun __le32 len; /* length of the extent */ 218*4882a593Smuzhiyun } __packed; 219*4882a593Smuzhiyun 220*4882a593Smuzhiyun #define F2FS_NAME_LEN 255 221*4882a593Smuzhiyun /* 200 bytes for inline xattrs by default */ 222*4882a593Smuzhiyun #define DEFAULT_INLINE_XATTR_ADDRS 50 223*4882a593Smuzhiyun #define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */ 224*4882a593Smuzhiyun #define CUR_ADDRS_PER_INODE(inode) (DEF_ADDRS_PER_INODE - \ 225*4882a593Smuzhiyun get_extra_isize(inode)) 226*4882a593Smuzhiyun #define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */ 227*4882a593Smuzhiyun #define ADDRS_PER_INODE(inode) addrs_per_inode(inode) 228*4882a593Smuzhiyun #define DEF_ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */ 229*4882a593Smuzhiyun #define ADDRS_PER_BLOCK(inode) addrs_per_block(inode) 230*4882a593Smuzhiyun #define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */ 231*4882a593Smuzhiyun 232*4882a593Smuzhiyun #define ADDRS_PER_PAGE(page, inode) \ 233*4882a593Smuzhiyun (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK(inode)) 234*4882a593Smuzhiyun 235*4882a593Smuzhiyun #define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1) 236*4882a593Smuzhiyun #define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2) 237*4882a593Smuzhiyun #define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3) 238*4882a593Smuzhiyun #define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4) 239*4882a593Smuzhiyun #define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5) 240*4882a593Smuzhiyun 241*4882a593Smuzhiyun #define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */ 242*4882a593Smuzhiyun #define F2FS_INLINE_DATA 0x02 /* file inline data flag */ 243*4882a593Smuzhiyun #define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */ 244*4882a593Smuzhiyun #define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */ 245*4882a593Smuzhiyun #define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */ 246*4882a593Smuzhiyun #define F2FS_EXTRA_ATTR 0x20 /* file having extra attribute */ 247*4882a593Smuzhiyun #define F2FS_PIN_FILE 0x40 /* file should not be gced */ 248*4882a593Smuzhiyun #define F2FS_COMPRESS_RELEASED 0x80 /* file released compressed blocks */ 249*4882a593Smuzhiyun 250*4882a593Smuzhiyun struct f2fs_inode { 251*4882a593Smuzhiyun __le16 i_mode; /* file mode */ 252*4882a593Smuzhiyun __u8 i_advise; /* file hints */ 253*4882a593Smuzhiyun __u8 i_inline; /* file inline flags */ 254*4882a593Smuzhiyun __le32 i_uid; /* user ID */ 255*4882a593Smuzhiyun __le32 i_gid; /* group ID */ 256*4882a593Smuzhiyun __le32 i_links; /* links count */ 257*4882a593Smuzhiyun __le64 i_size; /* file size in bytes */ 258*4882a593Smuzhiyun __le64 i_blocks; /* file size in blocks */ 259*4882a593Smuzhiyun __le64 i_atime; /* access time */ 260*4882a593Smuzhiyun __le64 i_ctime; /* change time */ 261*4882a593Smuzhiyun __le64 i_mtime; /* modification time */ 262*4882a593Smuzhiyun __le32 i_atime_nsec; /* access time in nano scale */ 263*4882a593Smuzhiyun __le32 i_ctime_nsec; /* change time in nano scale */ 264*4882a593Smuzhiyun __le32 i_mtime_nsec; /* modification time in nano scale */ 265*4882a593Smuzhiyun __le32 i_generation; /* file version (for NFS) */ 266*4882a593Smuzhiyun union { 267*4882a593Smuzhiyun __le32 i_current_depth; /* only for directory depth */ 268*4882a593Smuzhiyun __le16 i_gc_failures; /* 269*4882a593Smuzhiyun * # of gc failures on pinned file. 270*4882a593Smuzhiyun * only for regular files. 271*4882a593Smuzhiyun */ 272*4882a593Smuzhiyun }; 273*4882a593Smuzhiyun __le32 i_xattr_nid; /* nid to save xattr */ 274*4882a593Smuzhiyun __le32 i_flags; /* file attributes */ 275*4882a593Smuzhiyun __le32 i_pino; /* parent inode number */ 276*4882a593Smuzhiyun __le32 i_namelen; /* file name length */ 277*4882a593Smuzhiyun __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */ 278*4882a593Smuzhiyun __u8 i_dir_level; /* dentry_level for large dir */ 279*4882a593Smuzhiyun 280*4882a593Smuzhiyun struct f2fs_extent i_ext; /* caching a largest extent */ 281*4882a593Smuzhiyun 282*4882a593Smuzhiyun union { 283*4882a593Smuzhiyun struct { 284*4882a593Smuzhiyun __le16 i_extra_isize; /* extra inode attribute size */ 285*4882a593Smuzhiyun __le16 i_inline_xattr_size; /* inline xattr size, unit: 4 bytes */ 286*4882a593Smuzhiyun __le32 i_projid; /* project id */ 287*4882a593Smuzhiyun __le32 i_inode_checksum;/* inode meta checksum */ 288*4882a593Smuzhiyun __le64 i_crtime; /* creation time */ 289*4882a593Smuzhiyun __le32 i_crtime_nsec; /* creation time in nano scale */ 290*4882a593Smuzhiyun __le64 i_compr_blocks; /* # of compressed blocks */ 291*4882a593Smuzhiyun __u8 i_compress_algorithm; /* compress algorithm */ 292*4882a593Smuzhiyun __u8 i_log_cluster_size; /* log of cluster size */ 293*4882a593Smuzhiyun __le16 i_compress_flag; /* compress flag */ 294*4882a593Smuzhiyun /* 0 bit: chksum flag 295*4882a593Smuzhiyun * [10,15] bits: compress level 296*4882a593Smuzhiyun */ 297*4882a593Smuzhiyun __le32 i_extra_end[0]; /* for attribute size calculation */ 298*4882a593Smuzhiyun } __packed; 299*4882a593Smuzhiyun __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */ 300*4882a593Smuzhiyun }; 301*4882a593Smuzhiyun __le32 i_nid[DEF_NIDS_PER_INODE]; /* direct(2), indirect(2), 302*4882a593Smuzhiyun double_indirect(1) node id */ 303*4882a593Smuzhiyun } __packed; 304*4882a593Smuzhiyun 305*4882a593Smuzhiyun struct direct_node { 306*4882a593Smuzhiyun __le32 addr[DEF_ADDRS_PER_BLOCK]; /* array of data block address */ 307*4882a593Smuzhiyun } __packed; 308*4882a593Smuzhiyun 309*4882a593Smuzhiyun struct indirect_node { 310*4882a593Smuzhiyun __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */ 311*4882a593Smuzhiyun } __packed; 312*4882a593Smuzhiyun 313*4882a593Smuzhiyun enum { 314*4882a593Smuzhiyun COLD_BIT_SHIFT = 0, 315*4882a593Smuzhiyun FSYNC_BIT_SHIFT, 316*4882a593Smuzhiyun DENT_BIT_SHIFT, 317*4882a593Smuzhiyun OFFSET_BIT_SHIFT 318*4882a593Smuzhiyun }; 319*4882a593Smuzhiyun 320*4882a593Smuzhiyun #define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */ 321*4882a593Smuzhiyun 322*4882a593Smuzhiyun struct node_footer { 323*4882a593Smuzhiyun __le32 nid; /* node id */ 324*4882a593Smuzhiyun __le32 ino; /* inode number */ 325*4882a593Smuzhiyun __le32 flag; /* include cold/fsync/dentry marks and offset */ 326*4882a593Smuzhiyun __le64 cp_ver; /* checkpoint version */ 327*4882a593Smuzhiyun __le32 next_blkaddr; /* next node page block address */ 328*4882a593Smuzhiyun } __packed; 329*4882a593Smuzhiyun 330*4882a593Smuzhiyun struct f2fs_node { 331*4882a593Smuzhiyun /* can be one of three types: inode, direct, and indirect types */ 332*4882a593Smuzhiyun union { 333*4882a593Smuzhiyun struct f2fs_inode i; 334*4882a593Smuzhiyun struct direct_node dn; 335*4882a593Smuzhiyun struct indirect_node in; 336*4882a593Smuzhiyun }; 337*4882a593Smuzhiyun struct node_footer footer; 338*4882a593Smuzhiyun } __packed; 339*4882a593Smuzhiyun 340*4882a593Smuzhiyun /* 341*4882a593Smuzhiyun * For NAT entries 342*4882a593Smuzhiyun */ 343*4882a593Smuzhiyun #define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry)) 344*4882a593Smuzhiyun 345*4882a593Smuzhiyun struct f2fs_nat_entry { 346*4882a593Smuzhiyun __u8 version; /* latest version of cached nat entry */ 347*4882a593Smuzhiyun __le32 ino; /* inode number */ 348*4882a593Smuzhiyun __le32 block_addr; /* block address */ 349*4882a593Smuzhiyun } __packed; 350*4882a593Smuzhiyun 351*4882a593Smuzhiyun struct f2fs_nat_block { 352*4882a593Smuzhiyun struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK]; 353*4882a593Smuzhiyun } __packed; 354*4882a593Smuzhiyun 355*4882a593Smuzhiyun /* 356*4882a593Smuzhiyun * For SIT entries 357*4882a593Smuzhiyun * 358*4882a593Smuzhiyun * Each segment is 2MB in size by default so that a bitmap for validity of 359*4882a593Smuzhiyun * there-in blocks should occupy 64 bytes, 512 bits. 360*4882a593Smuzhiyun * Not allow to change this. 361*4882a593Smuzhiyun */ 362*4882a593Smuzhiyun #define SIT_VBLOCK_MAP_SIZE 64 363*4882a593Smuzhiyun #define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry)) 364*4882a593Smuzhiyun 365*4882a593Smuzhiyun /* 366*4882a593Smuzhiyun * F2FS uses 4 bytes to represent block address. As a result, supported size of 367*4882a593Smuzhiyun * disk is 16 TB and it equals to 16 * 1024 * 1024 / 2 segments. 368*4882a593Smuzhiyun */ 369*4882a593Smuzhiyun #define F2FS_MAX_SEGMENT ((16 * 1024 * 1024) / 2) 370*4882a593Smuzhiyun 371*4882a593Smuzhiyun /* 372*4882a593Smuzhiyun * Note that f2fs_sit_entry->vblocks has the following bit-field information. 373*4882a593Smuzhiyun * [15:10] : allocation type such as CURSEG_XXXX_TYPE 374*4882a593Smuzhiyun * [9:0] : valid block count 375*4882a593Smuzhiyun */ 376*4882a593Smuzhiyun #define SIT_VBLOCKS_SHIFT 10 377*4882a593Smuzhiyun #define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1) 378*4882a593Smuzhiyun #define GET_SIT_VBLOCKS(raw_sit) \ 379*4882a593Smuzhiyun (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK) 380*4882a593Smuzhiyun #define GET_SIT_TYPE(raw_sit) \ 381*4882a593Smuzhiyun ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \ 382*4882a593Smuzhiyun >> SIT_VBLOCKS_SHIFT) 383*4882a593Smuzhiyun 384*4882a593Smuzhiyun struct f2fs_sit_entry { 385*4882a593Smuzhiyun __le16 vblocks; /* reference above */ 386*4882a593Smuzhiyun __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */ 387*4882a593Smuzhiyun __le64 mtime; /* segment age for cleaning */ 388*4882a593Smuzhiyun } __packed; 389*4882a593Smuzhiyun 390*4882a593Smuzhiyun struct f2fs_sit_block { 391*4882a593Smuzhiyun struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK]; 392*4882a593Smuzhiyun } __packed; 393*4882a593Smuzhiyun 394*4882a593Smuzhiyun /* 395*4882a593Smuzhiyun * For segment summary 396*4882a593Smuzhiyun * 397*4882a593Smuzhiyun * One summary block contains exactly 512 summary entries, which represents 398*4882a593Smuzhiyun * exactly 2MB segment by default. Not allow to change the basic units. 399*4882a593Smuzhiyun * 400*4882a593Smuzhiyun * NOTE: For initializing fields, you must use set_summary 401*4882a593Smuzhiyun * 402*4882a593Smuzhiyun * - If data page, nid represents dnode's nid 403*4882a593Smuzhiyun * - If node page, nid represents the node page's nid. 404*4882a593Smuzhiyun * 405*4882a593Smuzhiyun * The ofs_in_node is used by only data page. It represents offset 406*4882a593Smuzhiyun * from node's page's beginning to get a data block address. 407*4882a593Smuzhiyun * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node) 408*4882a593Smuzhiyun */ 409*4882a593Smuzhiyun #define ENTRIES_IN_SUM 512 410*4882a593Smuzhiyun #define SUMMARY_SIZE (7) /* sizeof(struct summary) */ 411*4882a593Smuzhiyun #define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */ 412*4882a593Smuzhiyun #define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM) 413*4882a593Smuzhiyun 414*4882a593Smuzhiyun /* a summary entry for a 4KB-sized block in a segment */ 415*4882a593Smuzhiyun struct f2fs_summary { 416*4882a593Smuzhiyun __le32 nid; /* parent node id */ 417*4882a593Smuzhiyun union { 418*4882a593Smuzhiyun __u8 reserved[3]; 419*4882a593Smuzhiyun struct { 420*4882a593Smuzhiyun __u8 version; /* node version number */ 421*4882a593Smuzhiyun __le16 ofs_in_node; /* block index in parent node */ 422*4882a593Smuzhiyun } __packed; 423*4882a593Smuzhiyun }; 424*4882a593Smuzhiyun } __packed; 425*4882a593Smuzhiyun 426*4882a593Smuzhiyun /* summary block type, node or data, is stored to the summary_footer */ 427*4882a593Smuzhiyun #define SUM_TYPE_NODE (1) 428*4882a593Smuzhiyun #define SUM_TYPE_DATA (0) 429*4882a593Smuzhiyun 430*4882a593Smuzhiyun struct summary_footer { 431*4882a593Smuzhiyun unsigned char entry_type; /* SUM_TYPE_XXX */ 432*4882a593Smuzhiyun __le32 check_sum; /* summary checksum */ 433*4882a593Smuzhiyun } __packed; 434*4882a593Smuzhiyun 435*4882a593Smuzhiyun #define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\ 436*4882a593Smuzhiyun SUM_ENTRY_SIZE) 437*4882a593Smuzhiyun #define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 438*4882a593Smuzhiyun sizeof(struct nat_journal_entry)) 439*4882a593Smuzhiyun #define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 440*4882a593Smuzhiyun sizeof(struct nat_journal_entry)) 441*4882a593Smuzhiyun #define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 442*4882a593Smuzhiyun sizeof(struct sit_journal_entry)) 443*4882a593Smuzhiyun #define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 444*4882a593Smuzhiyun sizeof(struct sit_journal_entry)) 445*4882a593Smuzhiyun 446*4882a593Smuzhiyun /* Reserved area should make size of f2fs_extra_info equals to 447*4882a593Smuzhiyun * that of nat_journal and sit_journal. 448*4882a593Smuzhiyun */ 449*4882a593Smuzhiyun #define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8) 450*4882a593Smuzhiyun 451*4882a593Smuzhiyun /* 452*4882a593Smuzhiyun * frequently updated NAT/SIT entries can be stored in the spare area in 453*4882a593Smuzhiyun * summary blocks 454*4882a593Smuzhiyun */ 455*4882a593Smuzhiyun enum { 456*4882a593Smuzhiyun NAT_JOURNAL = 0, 457*4882a593Smuzhiyun SIT_JOURNAL 458*4882a593Smuzhiyun }; 459*4882a593Smuzhiyun 460*4882a593Smuzhiyun struct nat_journal_entry { 461*4882a593Smuzhiyun __le32 nid; 462*4882a593Smuzhiyun struct f2fs_nat_entry ne; 463*4882a593Smuzhiyun } __packed; 464*4882a593Smuzhiyun 465*4882a593Smuzhiyun struct nat_journal { 466*4882a593Smuzhiyun struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES]; 467*4882a593Smuzhiyun __u8 reserved[NAT_JOURNAL_RESERVED]; 468*4882a593Smuzhiyun } __packed; 469*4882a593Smuzhiyun 470*4882a593Smuzhiyun struct sit_journal_entry { 471*4882a593Smuzhiyun __le32 segno; 472*4882a593Smuzhiyun struct f2fs_sit_entry se; 473*4882a593Smuzhiyun } __packed; 474*4882a593Smuzhiyun 475*4882a593Smuzhiyun struct sit_journal { 476*4882a593Smuzhiyun struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES]; 477*4882a593Smuzhiyun __u8 reserved[SIT_JOURNAL_RESERVED]; 478*4882a593Smuzhiyun } __packed; 479*4882a593Smuzhiyun 480*4882a593Smuzhiyun struct f2fs_extra_info { 481*4882a593Smuzhiyun __le64 kbytes_written; 482*4882a593Smuzhiyun __u8 reserved[EXTRA_INFO_RESERVED]; 483*4882a593Smuzhiyun } __packed; 484*4882a593Smuzhiyun 485*4882a593Smuzhiyun struct f2fs_journal { 486*4882a593Smuzhiyun union { 487*4882a593Smuzhiyun __le16 n_nats; 488*4882a593Smuzhiyun __le16 n_sits; 489*4882a593Smuzhiyun }; 490*4882a593Smuzhiyun /* spare area is used by NAT or SIT journals or extra info */ 491*4882a593Smuzhiyun union { 492*4882a593Smuzhiyun struct nat_journal nat_j; 493*4882a593Smuzhiyun struct sit_journal sit_j; 494*4882a593Smuzhiyun struct f2fs_extra_info info; 495*4882a593Smuzhiyun }; 496*4882a593Smuzhiyun } __packed; 497*4882a593Smuzhiyun 498*4882a593Smuzhiyun /* 4KB-sized summary block structure */ 499*4882a593Smuzhiyun struct f2fs_summary_block { 500*4882a593Smuzhiyun struct f2fs_summary entries[ENTRIES_IN_SUM]; 501*4882a593Smuzhiyun struct f2fs_journal journal; 502*4882a593Smuzhiyun struct summary_footer footer; 503*4882a593Smuzhiyun } __packed; 504*4882a593Smuzhiyun 505*4882a593Smuzhiyun /* 506*4882a593Smuzhiyun * For directory operations 507*4882a593Smuzhiyun */ 508*4882a593Smuzhiyun #define F2FS_DOT_HASH 0 509*4882a593Smuzhiyun #define F2FS_DDOT_HASH F2FS_DOT_HASH 510*4882a593Smuzhiyun #define F2FS_MAX_HASH (~((0x3ULL) << 62)) 511*4882a593Smuzhiyun #define F2FS_HASH_COL_BIT ((0x1ULL) << 63) 512*4882a593Smuzhiyun 513*4882a593Smuzhiyun typedef __le32 f2fs_hash_t; 514*4882a593Smuzhiyun 515*4882a593Smuzhiyun /* One directory entry slot covers 8bytes-long file name */ 516*4882a593Smuzhiyun #define F2FS_SLOT_LEN 8 517*4882a593Smuzhiyun #define F2FS_SLOT_LEN_BITS 3 518*4882a593Smuzhiyun 519*4882a593Smuzhiyun #define GET_DENTRY_SLOTS(x) (((x) + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS) 520*4882a593Smuzhiyun 521*4882a593Smuzhiyun /* MAX level for dir lookup */ 522*4882a593Smuzhiyun #define MAX_DIR_HASH_DEPTH 63 523*4882a593Smuzhiyun 524*4882a593Smuzhiyun /* MAX buckets in one level of dir */ 525*4882a593Smuzhiyun #define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1)) 526*4882a593Smuzhiyun 527*4882a593Smuzhiyun /* 528*4882a593Smuzhiyun * space utilization of regular dentry and inline dentry (w/o extra reservation) 529*4882a593Smuzhiyun * regular dentry inline dentry (def) inline dentry (min) 530*4882a593Smuzhiyun * bitmap 1 * 27 = 27 1 * 23 = 23 1 * 1 = 1 531*4882a593Smuzhiyun * reserved 1 * 3 = 3 1 * 7 = 7 1 * 1 = 1 532*4882a593Smuzhiyun * dentry 11 * 214 = 2354 11 * 182 = 2002 11 * 2 = 22 533*4882a593Smuzhiyun * filename 8 * 214 = 1712 8 * 182 = 1456 8 * 2 = 16 534*4882a593Smuzhiyun * total 4096 3488 40 535*4882a593Smuzhiyun * 536*4882a593Smuzhiyun * Note: there are more reserved space in inline dentry than in regular 537*4882a593Smuzhiyun * dentry, when converting inline dentry we should handle this carefully. 538*4882a593Smuzhiyun */ 539*4882a593Smuzhiyun #define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */ 540*4882a593Smuzhiyun #define SIZE_OF_DIR_ENTRY 11 /* by byte */ 541*4882a593Smuzhiyun #define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \ 542*4882a593Smuzhiyun BITS_PER_BYTE) 543*4882a593Smuzhiyun #define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \ 544*4882a593Smuzhiyun F2FS_SLOT_LEN) * \ 545*4882a593Smuzhiyun NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP)) 546*4882a593Smuzhiyun #define MIN_INLINE_DENTRY_SIZE 40 /* just include '.' and '..' entries */ 547*4882a593Smuzhiyun 548*4882a593Smuzhiyun /* One directory entry slot representing F2FS_SLOT_LEN-sized file name */ 549*4882a593Smuzhiyun struct f2fs_dir_entry { 550*4882a593Smuzhiyun __le32 hash_code; /* hash code of file name */ 551*4882a593Smuzhiyun __le32 ino; /* inode number */ 552*4882a593Smuzhiyun __le16 name_len; /* length of file name */ 553*4882a593Smuzhiyun __u8 file_type; /* file type */ 554*4882a593Smuzhiyun } __packed; 555*4882a593Smuzhiyun 556*4882a593Smuzhiyun /* 4KB-sized directory entry block */ 557*4882a593Smuzhiyun struct f2fs_dentry_block { 558*4882a593Smuzhiyun /* validity bitmap for directory entries in each block */ 559*4882a593Smuzhiyun __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP]; 560*4882a593Smuzhiyun __u8 reserved[SIZE_OF_RESERVED]; 561*4882a593Smuzhiyun struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK]; 562*4882a593Smuzhiyun __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN]; 563*4882a593Smuzhiyun } __packed; 564*4882a593Smuzhiyun 565*4882a593Smuzhiyun /* file types used in inode_info->flags */ 566*4882a593Smuzhiyun enum { 567*4882a593Smuzhiyun F2FS_FT_UNKNOWN, 568*4882a593Smuzhiyun F2FS_FT_REG_FILE, 569*4882a593Smuzhiyun F2FS_FT_DIR, 570*4882a593Smuzhiyun F2FS_FT_CHRDEV, 571*4882a593Smuzhiyun F2FS_FT_BLKDEV, 572*4882a593Smuzhiyun F2FS_FT_FIFO, 573*4882a593Smuzhiyun F2FS_FT_SOCK, 574*4882a593Smuzhiyun F2FS_FT_SYMLINK, 575*4882a593Smuzhiyun F2FS_FT_MAX 576*4882a593Smuzhiyun }; 577*4882a593Smuzhiyun 578*4882a593Smuzhiyun #define S_SHIFT 12 579*4882a593Smuzhiyun 580*4882a593Smuzhiyun #define F2FS_DEF_PROJID 0 /* default project ID */ 581*4882a593Smuzhiyun 582*4882a593Smuzhiyun #endif /* _LINUX_F2FS_FS_H */ 583