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