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