f2fs_fs.h 20 KB

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