f2fs_fs.h revision dc530859c5e422b10ab70bc3b9d4b7ff0d004d57
1/** 2 * f2fs_fs.h 3 * 4 * Copyright (c) 2012 Samsung Electronics Co., Ltd. 5 * http://www.samsung.com/ 6 * 7 * Dual licensed under the GPL or LGPL version 2 licenses. 8 */ 9#ifndef __F2FS_FS_H__ 10#define __F2FS_FS_H__ 11 12#include <inttypes.h> 13#include <linux/types.h> 14#include <sys/types.h> 15 16#ifdef HAVE_CONFIG_H 17#include <config.h> 18#endif 19 20typedef u_int64_t u64; 21typedef u_int32_t u32; 22typedef u_int16_t u16; 23typedef u_int8_t u8; 24typedef u32 block_t; 25typedef u32 nid_t; 26typedef u8 bool; 27typedef unsigned long pgoff_t; 28 29#if __BYTE_ORDER == __LITTLE_ENDIAN 30#define le16_to_cpu(x) ((__u16)(x)) 31#define le32_to_cpu(x) ((__u32)(x)) 32#define le64_to_cpu(x) ((__u64)(x)) 33#define cpu_to_le16(x) ((__u16)(x)) 34#define cpu_to_le32(x) ((__u32)(x)) 35#define cpu_to_le64(x) ((__u64)(x)) 36#elif __BYTE_ORDER == __BIG_ENDIAN 37#define le16_to_cpu(x) bswap_16(x) 38#define le32_to_cpu(x) bswap_32(x) 39#define le64_to_cpu(x) bswap_64(x) 40#define cpu_to_le16(x) bswap_16(x) 41#define cpu_to_le32(x) bswap_32(x) 42#define cpu_to_le64(x) bswap_64(x) 43#endif 44 45#define typecheck(type,x) \ 46 ({ type __dummy; \ 47 typeof(x) __dummy2; \ 48 (void)(&__dummy == &__dummy2); \ 49 1; \ 50 }) 51 52#define NULL_SEGNO ((unsigned int)~0) 53 54/* 55 * Debugging interfaces 56 */ 57#define ASSERT_MSG(fmt, ...) \ 58 do { \ 59 printf("[ASSERT] (%s:%4d) ", __func__, __LINE__); \ 60 printf(" --> "fmt"\n", ##__VA_ARGS__); \ 61 config.bug_on = 1; \ 62 } while (0) 63 64#define ASSERT(exp) \ 65 do { \ 66 if (!(exp)) { \ 67 printf("[ASSERT] (%s:%4d) " #exp"\n", \ 68 __func__, __LINE__); \ 69 exit(-1); \ 70 } \ 71 } while (0) 72 73#define ERR_MSG(fmt, ...) \ 74 do { \ 75 printf("[%s:%d] " fmt, __func__, __LINE__, ##__VA_ARGS__); \ 76 } while (0) 77 78#define MSG(n, fmt, ...) \ 79 do { \ 80 if (config.dbg_lv >= n) { \ 81 printf(fmt, ##__VA_ARGS__); \ 82 } \ 83 } while (0) 84 85#define DBG(n, fmt, ...) \ 86 do { \ 87 if (config.dbg_lv >= n) { \ 88 printf("[%s:%4d] " fmt, \ 89 __func__, __LINE__, ##__VA_ARGS__); \ 90 } \ 91 } while (0) 92 93/* Display on console */ 94#define DISP(fmt, ptr, member) \ 95 do { \ 96 printf("%-30s" fmt, #member, ((ptr)->member)); \ 97 } while (0) 98 99#define DISP_u32(ptr, member) \ 100 do { \ 101 assert(sizeof((ptr)->member) <= 4); \ 102 printf("%-30s" "\t\t[0x%8x : %u]\n", \ 103 #member, ((ptr)->member), ((ptr)->member)); \ 104 } while (0) 105 106#define DISP_u64(ptr, member) \ 107 do { \ 108 assert(sizeof((ptr)->member) == 8); \ 109 printf("%-30s" "\t\t[0x%8llx : %llu]\n", \ 110 #member, ((ptr)->member), ((ptr)->member)); \ 111 } while (0) 112 113#define DISP_utf(ptr, member) \ 114 do { \ 115 printf("%-30s" "\t\t[%s]\n", #member, ((ptr)->member)); \ 116 } while (0) 117 118/* Display to buffer */ 119#define BUF_DISP_u32(buf, data, len, ptr, member) \ 120 do { \ 121 assert(sizeof((ptr)->member) <= 4); \ 122 snprintf(buf, len, #member); \ 123 snprintf(data, len, "0x%x : %u", ((ptr)->member), \ 124 ((ptr)->member)); \ 125 } while (0) 126 127#define BUF_DISP_u64(buf, data, len, ptr, member) \ 128 do { \ 129 assert(sizeof((ptr)->member) == 8); \ 130 snprintf(buf, len, #member); \ 131 snprintf(data, len, "0x%llx : %llu", ((ptr)->member), \ 132 ((ptr)->member)); \ 133 } while (0) 134 135#define BUF_DISP_utf(buf, data, len, ptr, member) \ 136 snprintf(buf, len, #member) 137 138/* these are defined in kernel */ 139#define PAGE_SIZE 4096 140#define PAGE_CACHE_SIZE 4096 141#define BITS_PER_BYTE 8 142#define F2FS_SUPER_MAGIC 0xF2F52010 /* F2FS Magic Number */ 143#define CHECKSUM_OFFSET 4092 144 145/* for mkfs */ 146#define F2FS_MIN_VOLUME_SIZE 104857600 147#define F2FS_NUMBER_OF_CHECKPOINT_PACK 2 148#define DEFAULT_SECTOR_SIZE 512 149#define DEFAULT_SECTORS_PER_BLOCK 8 150#define DEFAULT_BLOCKS_PER_SEGMENT 512 151#define DEFAULT_SEGMENTS_PER_SECTION 1 152 153enum f2fs_config_func { 154 FSCK, 155 DUMP, 156}; 157 158struct f2fs_configuration { 159 u_int32_t sector_size; 160 u_int32_t reserved_segments; 161 u_int32_t overprovision; 162 u_int32_t cur_seg[6]; 163 u_int32_t segs_per_sec; 164 u_int32_t secs_per_zone; 165 u_int32_t start_sector; 166 u_int64_t total_sectors; 167 u_int32_t sectors_per_blk; 168 u_int32_t blks_per_seg; 169 char *vol_label; 170 int heap; 171 int32_t fd; 172 int32_t dump_fd; 173 char *device_name; 174 char *extension_list; 175 int dbg_lv; 176 int trim; 177 int func; 178 void *private; 179 int fix_on; 180 int fix_cnt; 181 int bug_on; 182} __attribute__((packed)); 183 184#ifdef CONFIG_64BIT 185#define BITS_PER_LONG 64 186#else 187#define BITS_PER_LONG 32 188#endif 189 190#define BIT_MASK(nr) (1 << (nr % BITS_PER_LONG)) 191#define BIT_WORD(nr) (nr / BITS_PER_LONG) 192 193/* 194 * Copied from fs/f2fs/f2fs.h 195 */ 196#define NR_CURSEG_DATA_TYPE (3) 197#define NR_CURSEG_NODE_TYPE (3) 198#define NR_CURSEG_TYPE (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE) 199 200enum { 201 CURSEG_HOT_DATA = 0, /* directory entry blocks */ 202 CURSEG_WARM_DATA, /* data blocks */ 203 CURSEG_COLD_DATA, /* multimedia or GCed data blocks */ 204 CURSEG_HOT_NODE, /* direct node blocks of directory files */ 205 CURSEG_WARM_NODE, /* direct node blocks of normal files */ 206 CURSEG_COLD_NODE, /* indirect node blocks */ 207 NO_CHECK_TYPE 208}; 209 210/* 211 * Copied from fs/f2fs/segment.h 212 */ 213#define GET_SUM_TYPE(footer) ((footer)->entry_type) 214#define SET_SUM_TYPE(footer, type) ((footer)->entry_type = type) 215 216/* 217 * Copied from include/linux/f2fs_sb.h 218 */ 219#define F2FS_SUPER_OFFSET 1024 /* byte-size offset */ 220#define F2FS_LOG_SECTOR_SIZE 9 /* 9 bits for 512 byte */ 221#define F2FS_LOG_SECTORS_PER_BLOCK 3 /* 4KB: F2FS_BLKSIZE */ 222#define F2FS_BLKSIZE 4096 /* support only 4KB block */ 223#define F2FS_MAX_EXTENSION 64 /* # of extension entries */ 224#define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) / F2FS_BLKSIZE) 225 226#define NULL_ADDR 0x0U 227#define NEW_ADDR -1U 228 229#define F2FS_ROOT_INO(sbi) (sbi->root_ino_num) 230#define F2FS_NODE_INO(sbi) (sbi->node_ino_num) 231#define F2FS_META_INO(sbi) (sbi->meta_ino_num) 232 233/* This flag is used by node and meta inodes, and by recovery */ 234#define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO) 235 236/* 237 * For further optimization on multi-head logs, on-disk layout supports maximum 238 * 16 logs by default. The number, 16, is expected to cover all the cases 239 * enoughly. The implementaion currently uses no more than 6 logs. 240 * Half the logs are used for nodes, and the other half are used for data. 241 */ 242#define MAX_ACTIVE_LOGS 16 243#define MAX_ACTIVE_NODE_LOGS 8 244#define MAX_ACTIVE_DATA_LOGS 8 245 246/* 247 * For superblock 248 */ 249struct f2fs_super_block { 250 __le32 magic; /* Magic Number */ 251 __le16 major_ver; /* Major Version */ 252 __le16 minor_ver; /* Minor Version */ 253 __le32 log_sectorsize; /* log2 sector size in bytes */ 254 __le32 log_sectors_per_block; /* log2 # of sectors per block */ 255 __le32 log_blocksize; /* log2 block size in bytes */ 256 __le32 log_blocks_per_seg; /* log2 # of blocks per segment */ 257 __le32 segs_per_sec; /* # of segments per section */ 258 __le32 secs_per_zone; /* # of sections per zone */ 259 __le32 checksum_offset; /* checksum offset inside super block */ 260 __le64 block_count; /* total # of user blocks */ 261 __le32 section_count; /* total # of sections */ 262 __le32 segment_count; /* total # of segments */ 263 __le32 segment_count_ckpt; /* # of segments for checkpoint */ 264 __le32 segment_count_sit; /* # of segments for SIT */ 265 __le32 segment_count_nat; /* # of segments for NAT */ 266 __le32 segment_count_ssa; /* # of segments for SSA */ 267 __le32 segment_count_main; /* # of segments for main area */ 268 __le32 segment0_blkaddr; /* start block address of segment 0 */ 269 __le32 cp_blkaddr; /* start block address of checkpoint */ 270 __le32 sit_blkaddr; /* start block address of SIT */ 271 __le32 nat_blkaddr; /* start block address of NAT */ 272 __le32 ssa_blkaddr; /* start block address of SSA */ 273 __le32 main_blkaddr; /* start block address of main area */ 274 __le32 root_ino; /* root inode number */ 275 __le32 node_ino; /* node inode number */ 276 __le32 meta_ino; /* meta inode number */ 277 __u8 uuid[16]; /* 128-bit uuid for volume */ 278 __le16 volume_name[512]; /* volume name */ 279 __le32 extension_count; /* # of extensions below */ 280 __u8 extension_list[F2FS_MAX_EXTENSION][8]; /* extension array */ 281 __le32 cp_payload; 282} __attribute__((packed)); 283 284/* 285 * For checkpoint 286 */ 287#define CP_ERROR_FLAG 0x00000008 288#define CP_COMPACT_SUM_FLAG 0x00000004 289#define CP_ORPHAN_PRESENT_FLAG 0x00000002 290#define CP_UMOUNT_FLAG 0x00000001 291 292struct f2fs_checkpoint { 293 __le64 checkpoint_ver; /* checkpoint block version number */ 294 __le64 user_block_count; /* # of user blocks */ 295 __le64 valid_block_count; /* # of valid blocks in main area */ 296 __le32 rsvd_segment_count; /* # of reserved segments for gc */ 297 __le32 overprov_segment_count; /* # of overprovision segments */ 298 __le32 free_segment_count; /* # of free segments in main area */ 299 300 /* information of current node segments */ 301 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS]; 302 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS]; 303 /* information of current data segments */ 304 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS]; 305 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS]; 306 __le32 ckpt_flags; /* Flags : umount and journal_present */ 307 __le32 cp_pack_total_block_count; /* total # of one cp pack */ 308 __le32 cp_pack_start_sum; /* start block number of data summary */ 309 __le32 valid_node_count; /* Total number of valid nodes */ 310 __le32 valid_inode_count; /* Total number of valid inodes */ 311 __le32 next_free_nid; /* Next free node number */ 312 __le32 sit_ver_bitmap_bytesize; /* Default value 64 */ 313 __le32 nat_ver_bitmap_bytesize; /* Default value 256 */ 314 __le32 checksum_offset; /* checksum offset inside cp block */ 315 __le64 elapsed_time; /* mounted time */ 316 /* allocation type of current segment */ 317 unsigned char alloc_type[MAX_ACTIVE_LOGS]; 318 319 /* SIT and NAT version bitmap */ 320 unsigned char sit_nat_version_bitmap[1]; 321} __attribute__((packed)); 322 323/* 324 * For orphan inode management 325 */ 326#define F2FS_ORPHANS_PER_BLOCK 1020 327 328struct f2fs_orphan_block { 329 __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */ 330 __le32 reserved; /* reserved */ 331 __le16 blk_addr; /* block index in current CP */ 332 __le16 blk_count; /* Number of orphan inode blocks in CP */ 333 __le32 entry_count; /* Total number of orphan nodes in current CP */ 334 __le32 check_sum; /* CRC32 for orphan inode block */ 335} __attribute__((packed)); 336 337/* 338 * For NODE structure 339 */ 340struct f2fs_extent { 341 __le32 fofs; /* start file offset of the extent */ 342 __le32 blk_addr; /* start block address of the extent */ 343 __le32 len; /* lengh of the extent */ 344} __attribute__((packed)); 345 346#define F2FS_NAME_LEN 255 347#define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */ 348#define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */ 349#define ADDRS_PER_INODE(fi) addrs_per_inode(fi) 350#define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */ 351#define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */ 352 353#define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1) 354#define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2) 355#define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3) 356#define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4) 357#define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5) 358 359#define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */ 360#define F2FS_INLINE_DATA 0x02 /* file inline data flag */ 361#define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \ 362 F2FS_INLINE_XATTR_ADDRS - 1)) 363 364#define INLINE_DATA_OFFSET (PAGE_CACHE_SIZE - sizeof(struct node_footer) \ 365 - sizeof(__le32)*(DEF_ADDRS_PER_INODE + 5 - 1)) 366 367#define DEF_DIR_LEVEL 0 368 369struct f2fs_inode { 370 __le16 i_mode; /* file mode */ 371 __u8 i_advise; /* file hints */ 372 __u8 i_inline; /* file inline flags */ 373 __le32 i_uid; /* user ID */ 374 __le32 i_gid; /* group ID */ 375 __le32 i_links; /* links count */ 376 __le64 i_size; /* file size in bytes */ 377 __le64 i_blocks; /* file size in blocks */ 378 __le64 i_atime; /* access time */ 379 __le64 i_ctime; /* change time */ 380 __le64 i_mtime; /* modification time */ 381 __le32 i_atime_nsec; /* access time in nano scale */ 382 __le32 i_ctime_nsec; /* change time in nano scale */ 383 __le32 i_mtime_nsec; /* modification time in nano scale */ 384 __le32 i_generation; /* file version (for NFS) */ 385 __le32 i_current_depth; /* only for directory depth */ 386 __le32 i_xattr_nid; /* nid to save xattr */ 387 __le32 i_flags; /* file attributes */ 388 __le32 i_pino; /* parent inode number */ 389 __le32 i_namelen; /* file name length */ 390 __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */ 391 __u8 i_dir_level; /* dentry_level for large dir */ 392 393 struct f2fs_extent i_ext; /* caching a largest extent */ 394 395 __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */ 396 397 __le32 i_nid[5]; /* direct(2), indirect(2), 398 double_indirect(1) node id */ 399} __attribute__((packed)); 400 401struct direct_node { 402 __le32 addr[ADDRS_PER_BLOCK]; /* array of data block address */ 403} __attribute__((packed)); 404 405struct indirect_node { 406 __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */ 407} __attribute__((packed)); 408 409enum { 410 COLD_BIT_SHIFT = 0, 411 FSYNC_BIT_SHIFT, 412 DENT_BIT_SHIFT, 413 OFFSET_BIT_SHIFT 414}; 415 416#define XATTR_NODE_OFFSET ((((unsigned int)-1) << OFFSET_BIT_SHIFT) \ 417 >> OFFSET_BIT_SHIFT) 418 419struct node_footer { 420 __le32 nid; /* node id */ 421 __le32 ino; /* inode nunmber */ 422 __le32 flag; /* include cold/fsync/dentry marks and offset */ 423 __le64 cp_ver; /* checkpoint version */ 424 __le32 next_blkaddr; /* next node page block address */ 425} __attribute__((packed)); 426 427struct f2fs_node { 428 /* can be one of three types: inode, direct, and indirect types */ 429 union { 430 struct f2fs_inode i; 431 struct direct_node dn; 432 struct indirect_node in; 433 }; 434 struct node_footer footer; 435} __attribute__((packed)); 436 437/* 438 * For NAT entries 439 */ 440#define NAT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_nat_entry)) 441 442struct f2fs_nat_entry { 443 __u8 version; /* latest version of cached nat entry */ 444 __le32 ino; /* inode number */ 445 __le32 block_addr; /* block address */ 446} __attribute__((packed)); 447 448struct f2fs_nat_block { 449 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK]; 450} __attribute__((packed)); 451 452/* 453 * For SIT entries 454 * 455 * Each segment is 2MB in size by default so that a bitmap for validity of 456 * there-in blocks should occupy 64 bytes, 512 bits. 457 * Not allow to change this. 458 */ 459#define SIT_VBLOCK_MAP_SIZE 64 460#define SIT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_sit_entry)) 461 462/* 463 * F2FS uses 4 bytes to represent block address. As a result, supported size of 464 * disk is 16 TB and it equals to 16 * 1024 * 1024 / 2 segments. 465 */ 466#define F2FS_MAX_SEGMENT ((16 * 1024 * 1024) / 2) 467#define MAX_SIT_BITMAP_SIZE ((F2FS_MAX_SEGMENT / SIT_ENTRY_PER_BLOCK) / 8) 468 469/* 470 * Note that f2fs_sit_entry->vblocks has the following bit-field information. 471 * [15:10] : allocation type such as CURSEG_XXXX_TYPE 472 * [9:0] : valid block count 473 */ 474#define SIT_VBLOCKS_SHIFT 10 475#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1) 476#define GET_SIT_VBLOCKS(raw_sit) \ 477 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK) 478#define GET_SIT_TYPE(raw_sit) \ 479 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \ 480 >> SIT_VBLOCKS_SHIFT) 481 482struct f2fs_sit_entry { 483 __le16 vblocks; /* reference above */ 484 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */ 485 __le64 mtime; /* segment age for cleaning */ 486} __attribute__((packed)); 487 488struct f2fs_sit_block { 489 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK]; 490} __attribute__((packed)); 491 492/* 493 * For segment summary 494 * 495 * One summary block contains exactly 512 summary entries, which represents 496 * exactly 2MB segment by default. Not allow to change the basic units. 497 * 498 * NOTE: For initializing fields, you must use set_summary 499 * 500 * - If data page, nid represents dnode's nid 501 * - If node page, nid represents the node page's nid. 502 * 503 * The ofs_in_node is used by only data page. It represents offset 504 * from node's page's beginning to get a data block address. 505 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node) 506 */ 507#define ENTRIES_IN_SUM 512 508#define SUMMARY_SIZE (7) /* sizeof(struct summary) */ 509#define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */ 510#define SUM_ENTRIES_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM) 511 512/* a summary entry for a 4KB-sized block in a segment */ 513struct f2fs_summary { 514 __le32 nid; /* parent node id */ 515 union { 516 __u8 reserved[3]; 517 struct { 518 __u8 version; /* node version number */ 519 __le16 ofs_in_node; /* block index in parent node */ 520 } __attribute__((packed)); 521 }; 522} __attribute__((packed)); 523 524/* summary block type, node or data, is stored to the summary_footer */ 525#define SUM_TYPE_NODE (1) 526#define SUM_TYPE_DATA (0) 527 528struct summary_footer { 529 unsigned char entry_type; /* SUM_TYPE_XXX */ 530 __u32 check_sum; /* summary checksum */ 531} __attribute__((packed)); 532 533#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\ 534 SUM_ENTRIES_SIZE) 535#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 536 sizeof(struct nat_journal_entry)) 537#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 538 sizeof(struct nat_journal_entry)) 539#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 540 sizeof(struct sit_journal_entry)) 541#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 542 sizeof(struct sit_journal_entry)) 543/* 544 * frequently updated NAT/SIT entries can be stored in the spare area in 545 * summary blocks 546 */ 547enum { 548 NAT_JOURNAL = 0, 549 SIT_JOURNAL 550}; 551 552struct nat_journal_entry { 553 __le32 nid; 554 struct f2fs_nat_entry ne; 555} __attribute__((packed)); 556 557struct nat_journal { 558 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES]; 559 __u8 reserved[NAT_JOURNAL_RESERVED]; 560} __attribute__((packed)); 561 562struct sit_journal_entry { 563 __le32 segno; 564 struct f2fs_sit_entry se; 565} __attribute__((packed)); 566 567struct sit_journal { 568 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES]; 569 __u8 reserved[SIT_JOURNAL_RESERVED]; 570} __attribute__((packed)); 571 572/* 4KB-sized summary block structure */ 573struct f2fs_summary_block { 574 struct f2fs_summary entries[ENTRIES_IN_SUM]; 575 union { 576 __le16 n_nats; 577 __le16 n_sits; 578 }; 579 /* spare area is used by NAT or SIT journals */ 580 union { 581 struct nat_journal nat_j; 582 struct sit_journal sit_j; 583 }; 584 struct summary_footer footer; 585} __attribute__((packed)); 586 587/* 588 * For directory operations 589 */ 590#define F2FS_DOT_HASH 0 591#define F2FS_DDOT_HASH F2FS_DOT_HASH 592#define F2FS_MAX_HASH (~((0x3ULL) << 62)) 593#define F2FS_HASH_COL_BIT ((0x1ULL) << 63) 594 595typedef __le32 f2fs_hash_t; 596 597/* One directory entry slot covers 8bytes-long file name */ 598#define F2FS_SLOT_LEN 8 599#define F2FS_SLOT_LEN_BITS 3 600 601#define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS) 602 603/* the number of dentry in a block */ 604#define NR_DENTRY_IN_BLOCK 214 605 606/* MAX level for dir lookup */ 607#define MAX_DIR_HASH_DEPTH 63 608 609#define SIZE_OF_DIR_ENTRY 11 /* by byte */ 610#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \ 611 BITS_PER_BYTE) 612#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \ 613 F2FS_SLOT_LEN) * \ 614 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP)) 615 616/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */ 617struct f2fs_dir_entry { 618 __le32 hash_code; /* hash code of file name */ 619 __le32 ino; /* inode number */ 620 __le16 name_len; /* lengh of file name */ 621 __u8 file_type; /* file type */ 622} __attribute__((packed)); 623 624/* 4KB-sized directory entry block */ 625struct f2fs_dentry_block { 626 /* validity bitmap for directory entries in each block */ 627 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP]; 628 __u8 reserved[SIZE_OF_RESERVED]; 629 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK]; 630 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN]; 631} __attribute__((packed)); 632 633/* file types used in inode_info->flags */ 634enum FILE_TYPE { 635 F2FS_FT_UNKNOWN, 636 F2FS_FT_REG_FILE, 637 F2FS_FT_DIR, 638 F2FS_FT_CHRDEV, 639 F2FS_FT_BLKDEV, 640 F2FS_FT_FIFO, 641 F2FS_FT_SOCK, 642 F2FS_FT_SYMLINK, 643 F2FS_FT_MAX, 644 /* added for fsck */ 645 F2FS_FT_ORPHAN, 646 F2FS_FT_XATTR, 647}; 648 649/* from f2fs/segment.h */ 650enum { 651 LFS = 0, 652 SSR 653}; 654 655extern void ASCIIToUNICODE(u_int16_t *, u_int8_t *); 656extern int log_base_2(u_int32_t); 657extern unsigned int addrs_per_inode(struct f2fs_inode *); 658 659extern int get_bits_in_byte(unsigned char n); 660extern int set_bit(unsigned int nr,void * addr); 661extern int clear_bit(unsigned int nr, void * addr); 662extern int test_bit(unsigned int nr, const void * addr); 663extern int f2fs_test_bit(unsigned int, const char *); 664extern int f2fs_set_bit(unsigned int, char *); 665extern int f2fs_clear_bit(unsigned int, char *); 666extern unsigned long find_next_bit(const unsigned long *, 667 unsigned long, unsigned long); 668 669extern u_int32_t f2fs_cal_crc32(u_int32_t, void *, int); 670extern int f2fs_crc_valid(u_int32_t blk_crc, void *buf, int len); 671 672extern void f2fs_init_configuration(struct f2fs_configuration *); 673extern int f2fs_dev_is_umounted(struct f2fs_configuration *); 674extern int f2fs_get_device_info(struct f2fs_configuration *); 675extern void f2fs_finalize_device(struct f2fs_configuration *); 676 677extern int dev_read(void *, __u64, size_t); 678extern int dev_write(void *, __u64, size_t); 679extern int dev_write_block(void *, __u64); 680extern int dev_write_dump(void *, __u64, size_t); 681/* All bytes in the buffer must be 0 use dev_fill(). */ 682extern int dev_fill(void *, __u64, size_t); 683 684extern int dev_read_block(void *, __u64); 685extern int dev_read_blocks(void *, __u64, __u32 ); 686 687f2fs_hash_t f2fs_dentry_hash(const unsigned char *, int); 688 689extern struct f2fs_configuration config; 690 691#endif /*__F2FS_FS_H */ 692