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