f2fs_fs.h 19 KB

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