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