f2fs_fs.h revision 1ddf6367a3b5e8e586dee1bcbf9c363439ea3ec8
1/** 2 * 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 __F2FS_FS_H__ 12#define __F2FS_FS_H__ 13 14#include <inttypes.h> 15#include <linux/types.h> 16#include <sys/types.h> 17 18#ifdef HAVE_CONFIG_H 19#include <config.h> 20#endif 21 22typedef u_int64_t u64; 23typedef u_int32_t u32; 24typedef u_int16_t u16; 25typedef u_int8_t u8; 26typedef u32 block_t; 27typedef u32 nid_t; 28typedef u8 bool; 29typedef unsigned long pgoff_t; 30 31#if __BYTE_ORDER == __LITTLE_ENDIAN 32#define le16_to_cpu(x) ((__u16)(x)) 33#define le32_to_cpu(x) ((__u32)(x)) 34#define le64_to_cpu(x) ((__u64)(x)) 35#define cpu_to_le16(x) ((__u16)(x)) 36#define cpu_to_le32(x) ((__u32)(x)) 37#define cpu_to_le64(x) ((__u64)(x)) 38#elif __BYTE_ORDER == __BIG_ENDIAN 39#define le16_to_cpu(x) bswap_16(x) 40#define le32_to_cpu(x) bswap_32(x) 41#define le64_to_cpu(x) bswap_64(x) 42#define cpu_to_le16(x) bswap_16(x) 43#define cpu_to_le32(x) bswap_32(x) 44#define cpu_to_le64(x) bswap_64(x) 45#endif 46 47#define typecheck(type,x) \ 48 ({ type __dummy; \ 49 typeof(x) __dummy2; \ 50 (void)(&__dummy == &__dummy2); \ 51 1; \ 52 }) 53 54#define NULL_SEGNO ((unsigned int)~0) 55 56/* 57 * Debugging interfaces 58 */ 59#define ASSERT_MSG(exp, fmt, ...) \ 60 do { \ 61 if (!(exp)) { \ 62 printf("\nAssertion failed!\n"); \ 63 printf("[%s:%4d] " #exp, __func__, __LINE__); \ 64 printf("\n --> "fmt, ##__VA_ARGS__); \ 65 exit(-1); \ 66 } \ 67 } while (0); 68 69#define ASSERT(exp) \ 70 do { \ 71 if (!(exp)) { \ 72 printf("\nAssertion failed!\n"); \ 73 printf("[%s:%4d] " #exp"\n", __func__, __LINE__);\ 74 exit(-1); \ 75 } \ 76 } while (0); 77 78#define ERR_MSG(fmt, ...) \ 79 do { \ 80 printf("[%s:%d] " fmt, __func__, __LINE__, ##__VA_ARGS__); \ 81 } while (0); 82 83 84#define MSG(n, fmt, ...) \ 85 do { \ 86 if (config.dbg_lv >= n) { \ 87 printf(fmt, ##__VA_ARGS__); \ 88 } \ 89 } while (0); 90 91#define DBG(n, fmt, ...) \ 92 do { \ 93 if (config.dbg_lv >= n) { \ 94 printf("[%s:%4d] " fmt, \ 95 __func__, __LINE__, ##__VA_ARGS__); \ 96 } \ 97 } while (0); 98 99/* Display on console */ 100#define DISP(fmt, ptr, member) \ 101 do { \ 102 printf("%-30s" fmt, #member, ((ptr)->member)); \ 103 } while (0); 104 105#define DISP_u32(ptr, member) \ 106 do { \ 107 assert(sizeof((ptr)->member) <= 4); \ 108 printf("%-30s" "\t\t[0x%8x : %u]\n", \ 109 #member, ((ptr)->member), ((ptr)->member) ); \ 110 } while (0); 111 112#define DISP_u64(ptr, member) \ 113 do { \ 114 assert(sizeof((ptr)->member) == 8); \ 115 printf("%-30s" "\t\t[0x%8llx : %llu]\n", \ 116 #member, ((ptr)->member), ((ptr)->member) ); \ 117 } while (0); 118 119#define DISP_utf(ptr, member) \ 120 do { \ 121 printf("%-30s" "\t\t[%s]\n", #member, ((ptr)->member) ); \ 122 } while (0); 123 124/* Display to buffer */ 125#define BUF_DISP_u32(buf, data, len, ptr, member) \ 126 do { \ 127 assert(sizeof((ptr)->member) <= 4); \ 128 snprintf(buf, len, #member); \ 129 snprintf(data, len, "0x%x : %u", ((ptr)->member), ((ptr)->member)); \ 130 } while (0); 131 132#define BUF_DISP_u64(buf, data, len, ptr, member) \ 133 do { \ 134 assert(sizeof((ptr)->member) == 8); \ 135 snprintf(buf, len, #member); \ 136 snprintf(data, len, "0x%llx : %llu", ((ptr)->member), ((ptr)->member)); \ 137 } while (0); 138 139#define BUF_DISP_utf(buf, data, len, ptr, member) \ 140 do { \ 141 snprintf(buf, len, #member); \ 142 } while (0); 143 144/* these are defined in kernel */ 145#define PAGE_SIZE 4096 146#define PAGE_CACHE_SIZE 4096 147#define BITS_PER_BYTE 8 148#define F2FS_SUPER_MAGIC 0xF2F52010 /* F2FS Magic Number */ 149#define CHECKSUM_OFFSET 4092 150 151/* for mkfs */ 152#define F2FS_MIN_VOLUME_SIZE 104857600 153#define F2FS_NUMBER_OF_CHECKPOINT_PACK 2 154#define DEFAULT_SECTOR_SIZE 512 155#define DEFAULT_SECTORS_PER_BLOCK 8 156#define DEFAULT_BLOCKS_PER_SEGMENT 512 157#define DEFAULT_SEGMENTS_PER_SECTION 1 158 159enum f2fs_config_func { 160 FSCK, 161 DUMP, 162}; 163 164struct f2fs_configuration { 165 u_int32_t sector_size; 166 u_int32_t reserved_segments; 167 u_int32_t overprovision; 168 u_int32_t cur_seg[6]; 169 u_int32_t segs_per_sec; 170 u_int32_t secs_per_zone; 171 u_int32_t start_sector; 172 u_int64_t total_sectors; 173 u_int32_t sectors_per_blk; 174 u_int32_t blks_per_seg; 175 char *vol_label; 176 int heap; 177 int32_t fd; 178 char *device_name; 179 char *extension_list; 180 int dbg_lv; 181 int trim; 182 int func; 183 void *private; 184} __attribute__((packed)); 185 186#ifdef CONFIG_64BIT 187#define BITS_PER_LONG 64 188#else 189#define BITS_PER_LONG 32 190#endif 191 192#define BIT_MASK(nr) (1 << (nr % BITS_PER_LONG)) 193#define BIT_WORD(nr) (nr / BITS_PER_LONG) 194 195/* 196 * Copied from fs/f2fs/f2fs.h 197 */ 198#define NR_CURSEG_DATA_TYPE (3) 199#define NR_CURSEG_NODE_TYPE (3) 200#define NR_CURSEG_TYPE (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE) 201 202enum { 203 CURSEG_HOT_DATA = 0, /* directory entry blocks */ 204 CURSEG_WARM_DATA, /* data blocks */ 205 CURSEG_COLD_DATA, /* multimedia or GCed data blocks */ 206 CURSEG_HOT_NODE, /* direct node blocks of directory files */ 207 CURSEG_WARM_NODE, /* direct node blocks of normal files */ 208 CURSEG_COLD_NODE, /* indirect node blocks */ 209 NO_CHECK_TYPE 210}; 211 212/* 213 * Copied from fs/f2fs/segment.h 214 */ 215#define GET_SUM_TYPE(footer) ((footer)->entry_type) 216#define SET_SUM_TYPE(footer, type) ((footer)->entry_type = type) 217 218/* 219 * Copied from include/linux/f2fs_sb.h 220 */ 221#define F2FS_SUPER_OFFSET 1024 /* byte-size offset */ 222#define F2FS_LOG_SECTOR_SIZE 9 /* 9 bits for 512 byte */ 223#define F2FS_LOG_SECTORS_PER_BLOCK 3 /* 4KB: F2FS_BLKSIZE */ 224#define F2FS_BLKSIZE 4096 /* support only 4KB block */ 225#define F2FS_MAX_EXTENSION 64 /* # of extension entries */ 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} __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 416struct node_footer { 417 __le32 nid; /* node id */ 418 __le32 ino; /* inode nunmber */ 419 __le32 flag; /* include cold/fsync/dentry marks and offset */ 420 __le64 cp_ver; /* checkpoint version */ 421 __le32 next_blkaddr; /* next node page block address */ 422} __attribute__((packed)); 423 424struct f2fs_node { 425 /* can be one of three types: inode, direct, and indirect types */ 426 union { 427 struct f2fs_inode i; 428 struct direct_node dn; 429 struct indirect_node in; 430 }; 431 struct node_footer footer; 432} __attribute__((packed)); 433 434/* 435 * For NAT entries 436 */ 437#define NAT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_nat_entry)) 438 439struct f2fs_nat_entry { 440 __u8 version; /* latest version of cached nat entry */ 441 __le32 ino; /* inode number */ 442 __le32 block_addr; /* block address */ 443} __attribute__((packed)); 444 445struct f2fs_nat_block { 446 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK]; 447} __attribute__((packed)); 448 449/* 450 * For SIT entries 451 * 452 * Each segment is 2MB in size by default so that a bitmap for validity of 453 * there-in blocks should occupy 64 bytes, 512 bits. 454 * Not allow to change this. 455 */ 456#define SIT_VBLOCK_MAP_SIZE 64 457#define SIT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_sit_entry)) 458 459/* 460 * Note that f2fs_sit_entry->vblocks has the following bit-field information. 461 * [15:10] : allocation type such as CURSEG_XXXX_TYPE 462 * [9:0] : valid block count 463 */ 464#define SIT_VBLOCKS_SHIFT 10 465#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1) 466#define GET_SIT_VBLOCKS(raw_sit) \ 467 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK) 468#define GET_SIT_TYPE(raw_sit) \ 469 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \ 470 >> SIT_VBLOCKS_SHIFT) 471 472struct f2fs_sit_entry { 473 __le16 vblocks; /* reference above */ 474 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */ 475 __le64 mtime; /* segment age for cleaning */ 476} __attribute__((packed)); 477 478struct f2fs_sit_block { 479 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK]; 480} __attribute__((packed)); 481 482/* 483 * For segment summary 484 * 485 * One summary block contains exactly 512 summary entries, which represents 486 * exactly 2MB segment by default. Not allow to change the basic units. 487 * 488 * NOTE: For initializing fields, you must use set_summary 489 * 490 * - If data page, nid represents dnode's nid 491 * - If node page, nid represents the node page's nid. 492 * 493 * The ofs_in_node is used by only data page. It represents offset 494 * from node's page's beginning to get a data block address. 495 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node) 496 */ 497#define ENTRIES_IN_SUM 512 498#define SUMMARY_SIZE (7) /* sizeof(struct summary) */ 499#define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */ 500#define SUM_ENTRIES_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM) 501 502/* a summary entry for a 4KB-sized block in a segment */ 503struct f2fs_summary { 504 __le32 nid; /* parent node id */ 505 union { 506 __u8 reserved[3]; 507 struct { 508 __u8 version; /* node version number */ 509 __le16 ofs_in_node; /* block index in parent node */ 510 } __attribute__((packed)); 511 }; 512} __attribute__((packed)); 513 514/* summary block type, node or data, is stored to the summary_footer */ 515#define SUM_TYPE_NODE (1) 516#define SUM_TYPE_DATA (0) 517 518struct summary_footer { 519 unsigned char entry_type; /* SUM_TYPE_XXX */ 520 __u32 check_sum; /* summary checksum */ 521} __attribute__((packed)); 522 523#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\ 524 SUM_ENTRIES_SIZE) 525#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 526 sizeof(struct nat_journal_entry)) 527#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 528 sizeof(struct nat_journal_entry)) 529#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ 530 sizeof(struct sit_journal_entry)) 531#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ 532 sizeof(struct sit_journal_entry)) 533/* 534 * frequently updated NAT/SIT entries can be stored in the spare area in 535 * summary blocks 536 */ 537enum { 538 NAT_JOURNAL = 0, 539 SIT_JOURNAL 540}; 541 542struct nat_journal_entry { 543 __le32 nid; 544 struct f2fs_nat_entry ne; 545} __attribute__((packed)); 546 547struct nat_journal { 548 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES]; 549 __u8 reserved[NAT_JOURNAL_RESERVED]; 550} __attribute__((packed)); 551 552struct sit_journal_entry { 553 __le32 segno; 554 struct f2fs_sit_entry se; 555} __attribute__((packed)); 556 557struct sit_journal { 558 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES]; 559 __u8 reserved[SIT_JOURNAL_RESERVED]; 560} __attribute__((packed)); 561 562/* 4KB-sized summary block structure */ 563struct f2fs_summary_block { 564 struct f2fs_summary entries[ENTRIES_IN_SUM]; 565 union { 566 __le16 n_nats; 567 __le16 n_sits; 568 }; 569 /* spare area is used by NAT or SIT journals */ 570 union { 571 struct nat_journal nat_j; 572 struct sit_journal sit_j; 573 }; 574 struct summary_footer footer; 575} __attribute__((packed)); 576 577/* 578 * For directory operations 579 */ 580#define F2FS_DOT_HASH 0 581#define F2FS_DDOT_HASH F2FS_DOT_HASH 582#define F2FS_MAX_HASH (~((0x3ULL) << 62)) 583#define F2FS_HASH_COL_BIT ((0x1ULL) << 63) 584 585typedef __le32 f2fs_hash_t; 586 587/* One directory entry slot covers 8bytes-long file name */ 588#define F2FS_SLOT_LEN 8 589#define F2FS_SLOT_LEN_BITS 3 590 591#define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS) 592 593/* the number of dentry in a block */ 594#define NR_DENTRY_IN_BLOCK 214 595 596/* MAX level for dir lookup */ 597#define MAX_DIR_HASH_DEPTH 63 598 599#define SIZE_OF_DIR_ENTRY 11 /* by byte */ 600#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \ 601 BITS_PER_BYTE) 602#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \ 603 F2FS_SLOT_LEN) * \ 604 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP)) 605 606/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */ 607struct f2fs_dir_entry { 608 __le32 hash_code; /* hash code of file name */ 609 __le32 ino; /* inode number */ 610 __le16 name_len; /* lengh of file name */ 611 __u8 file_type; /* file type */ 612} __attribute__((packed)); 613 614/* 4KB-sized directory entry block */ 615struct f2fs_dentry_block { 616 /* validity bitmap for directory entries in each block */ 617 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP]; 618 __u8 reserved[SIZE_OF_RESERVED]; 619 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK]; 620 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN]; 621} __attribute__((packed)); 622 623/* file types used in inode_info->flags */ 624enum FILE_TYPE { 625 F2FS_FT_UNKNOWN, 626 F2FS_FT_REG_FILE, 627 F2FS_FT_DIR, 628 F2FS_FT_CHRDEV, 629 F2FS_FT_BLKDEV, 630 F2FS_FT_FIFO, 631 F2FS_FT_SOCK, 632 F2FS_FT_SYMLINK, 633 F2FS_FT_MAX, 634 /* added for fsck */ 635 F2FS_FT_ORPHAN, 636}; 637 638/* from f2fs/segment.h */ 639enum { 640 LFS = 0, 641 SSR 642}; 643 644extern void ASCIIToUNICODE(u_int16_t *, u_int8_t *); 645extern int log_base_2(u_int32_t); 646extern unsigned int addrs_per_inode(struct f2fs_inode *); 647 648extern int get_bits_in_byte(unsigned char n); 649extern int set_bit(unsigned int nr,void * addr); 650extern int clear_bit(unsigned int nr, void * addr); 651extern int test_bit(unsigned int nr, const void * addr); 652extern int f2fs_test_bit(unsigned int, const char *); 653extern int f2fs_set_bit(unsigned int, char *); 654extern int f2fs_clear_bit(unsigned int, char *); 655extern unsigned long find_next_bit(const unsigned long *, unsigned long, unsigned long); 656 657extern u_int32_t f2fs_cal_crc32(u_int32_t, void *, int); 658extern int f2fs_crc_valid(u_int32_t blk_crc, void *buf, int len); 659 660extern void f2fs_init_configuration(struct f2fs_configuration *); 661extern int f2fs_dev_is_umounted(struct f2fs_configuration *); 662extern int f2fs_get_device_info(struct f2fs_configuration *); 663extern void f2fs_finalize_device(struct f2fs_configuration *); 664 665extern int dev_read(void *, __u64, size_t); 666extern int dev_write(void *, __u64, size_t); 667/* All bytes in the buffer must be 0 use dev_fill(). */ 668extern int dev_fill(void *, __u64, size_t); 669 670extern int dev_read_block(void *, __u64); 671extern int dev_read_blocks(void *, __u64, __u32 ); 672 673f2fs_hash_t f2fs_dentry_hash(const char *, int); 674 675extern struct f2fs_configuration config; 676 677#endif /*__F2FS_FS_H */ 678