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