blob: 52af9ac164b4a880a584fa2a29abdc2c61ab710f [file] [log] [blame]
Chao Yu6d1a8322018-09-12 09:16:07 +08001// SPDX-License-Identifier: GPL-2.0
Jaegeuk Kimdd318662012-11-02 17:06:26 +09002/**
3 * include/linux/f2fs_fs.h
4 *
5 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
6 * http://www.samsung.com/
Jaegeuk Kimdd318662012-11-02 17:06:26 +09007 */
8#ifndef _LINUX_F2FS_FS_H
9#define _LINUX_F2FS_FS_H
10
11#include <linux/pagemap.h>
12#include <linux/types.h>
13
14#define F2FS_SUPER_OFFSET 1024 /* byte-size offset */
Chao Yu55cf9cb2014-09-15 18:01:10 +080015#define F2FS_MIN_LOG_SECTOR_SIZE 9 /* 9 bits for 512 bytes */
16#define F2FS_MAX_LOG_SECTOR_SIZE 12 /* 12 bits for 4096 bytes */
17#define F2FS_LOG_SECTORS_PER_BLOCK 3 /* log number for sector/blk */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090018#define F2FS_BLKSIZE 4096 /* support only 4KB block */
Jaegeuk Kimf7ef9b82015-02-09 12:02:44 -080019#define F2FS_BLKSIZE_BITS 12 /* bits for F2FS_BLKSIZE */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090020#define F2FS_MAX_EXTENSION 64 /* # of extension entries */
Chao Yu1e72cb22018-02-26 22:04:13 +080021#define F2FS_EXTENSION_LEN 8 /* max size of extension */
Jaegeuk Kim24b84912016-02-03 13:49:44 -080022#define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS)
Jaegeuk Kimdd318662012-11-02 17:06:26 +090023
Jaegeuk Kima9841c42013-05-24 12:41:04 +090024#define NULL_ADDR ((block_t)0) /* used as block_t addresses */
25#define NEW_ADDR ((block_t)-1) /* used as block_t addresses */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090026
Jaegeuk Kimf7ef9b82015-02-09 12:02:44 -080027#define F2FS_BYTES_TO_BLK(bytes) ((bytes) >> F2FS_BLKSIZE_BITS)
28#define F2FS_BLK_TO_BYTES(blk) ((blk) << F2FS_BLKSIZE_BITS)
29
Chao Yuc200b1a2014-08-20 18:36:46 +080030/* 0, 1(node nid), 2(meta nid) are reserved node id */
31#define F2FS_RESERVED_NODE_NUM 3
32
Jaegeuk Kime6b120d2017-07-10 12:55:09 -070033#define F2FS_ROOT_INO(sbi) ((sbi)->root_ino_num)
34#define F2FS_NODE_INO(sbi) ((sbi)->node_ino_num)
35#define F2FS_META_INO(sbi) ((sbi)->meta_ino_num)
36
Jaegeuk Kimd4c292d2017-10-05 21:03:06 -070037#define F2FS_MAX_QUOTAS 3
38
Chao Yue9a50e62018-03-08 14:22:56 +080039#define F2FS_IO_SIZE(sbi) (1 << F2FS_OPTION(sbi).write_io_size_bits) /* Blocks */
40#define F2FS_IO_SIZE_KB(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 2)) /* KB */
41#define F2FS_IO_SIZE_BYTES(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 12)) /* B */
42#define F2FS_IO_SIZE_BITS(sbi) (F2FS_OPTION(sbi).write_io_size_bits) /* power of 2 */
Jaegeuk Kime6b120d2017-07-10 12:55:09 -070043#define F2FS_IO_SIZE_MASK(sbi) (F2FS_IO_SIZE(sbi) - 1)
Chao Yuc6dd8be2019-07-12 16:55:42 +080044#define F2FS_IO_ALIGNED(sbi) (F2FS_IO_SIZE(sbi) > 1)
Jaegeuk Kimdd318662012-11-02 17:06:26 +090045
46/* This flag is used by node and meta inodes, and by recovery */
Jaegeuk Kima78186e2014-10-17 17:57:29 -070047#define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
Jaegeuk Kimdd318662012-11-02 17:06:26 +090048
49/*
50 * For further optimization on multi-head logs, on-disk layout supports maximum
51 * 16 logs by default. The number, 16, is expected to cover all the cases
52 * enoughly. The implementaion currently uses no more than 6 logs.
53 * Half the logs are used for nodes, and the other half are used for data.
54 */
55#define MAX_ACTIVE_LOGS 16
56#define MAX_ACTIVE_NODE_LOGS 8
57#define MAX_ACTIVE_DATA_LOGS 8
58
Jaegeuk Kim0040b932015-04-20 11:52:23 -070059#define VERSION_LEN 256
Jaegeuk Kima11fac32015-12-14 18:58:42 -080060#define MAX_VOLUME_NAME 512
Jaegeuk Kime6b120d2017-07-10 12:55:09 -070061#define MAX_PATH_LEN 64
62#define MAX_DEVICES 8
Jaegeuk Kim0040b932015-04-20 11:52:23 -070063
Jaegeuk Kimdd318662012-11-02 17:06:26 +090064/*
65 * For superblock
66 */
Jaegeuk Kime6b120d2017-07-10 12:55:09 -070067struct f2fs_device {
68 __u8 path[MAX_PATH_LEN];
69 __le32 total_segments;
70} __packed;
71
Jaegeuk Kimdd318662012-11-02 17:06:26 +090072struct f2fs_super_block {
73 __le32 magic; /* Magic Number */
74 __le16 major_ver; /* Major Version */
75 __le16 minor_ver; /* Minor Version */
76 __le32 log_sectorsize; /* log2 sector size in bytes */
77 __le32 log_sectors_per_block; /* log2 # of sectors per block */
78 __le32 log_blocksize; /* log2 block size in bytes */
79 __le32 log_blocks_per_seg; /* log2 # of blocks per segment */
80 __le32 segs_per_sec; /* # of segments per section */
81 __le32 secs_per_zone; /* # of sections per zone */
82 __le32 checksum_offset; /* checksum offset inside super block */
83 __le64 block_count; /* total # of user blocks */
84 __le32 section_count; /* total # of sections */
85 __le32 segment_count; /* total # of segments */
86 __le32 segment_count_ckpt; /* # of segments for checkpoint */
87 __le32 segment_count_sit; /* # of segments for SIT */
88 __le32 segment_count_nat; /* # of segments for NAT */
89 __le32 segment_count_ssa; /* # of segments for SSA */
90 __le32 segment_count_main; /* # of segments for main area */
91 __le32 segment0_blkaddr; /* start block address of segment 0 */
92 __le32 cp_blkaddr; /* start block address of checkpoint */
93 __le32 sit_blkaddr; /* start block address of SIT */
94 __le32 nat_blkaddr; /* start block address of NAT */
95 __le32 ssa_blkaddr; /* start block address of SSA */
96 __le32 main_blkaddr; /* start block address of main area */
97 __le32 root_ino; /* root inode number */
98 __le32 node_ino; /* node inode number */
99 __le32 meta_ino; /* meta inode number */
100 __u8 uuid[16]; /* 128-bit uuid for volume */
Jaegeuk Kima11fac32015-12-14 18:58:42 -0800101 __le16 volume_name[MAX_VOLUME_NAME]; /* volume name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900102 __le32 extension_count; /* # of extensions below */
Chao Yu1e72cb22018-02-26 22:04:13 +0800103 __u8 extension_list[F2FS_MAX_EXTENSION][F2FS_EXTENSION_LEN];/* extension array */
Changman Lee1dbe4152014-05-12 12:27:43 +0900104 __le32 cp_payload;
Jaegeuk Kim0040b932015-04-20 11:52:23 -0700105 __u8 version[VERSION_LEN]; /* the kernel version */
106 __u8 init_version[VERSION_LEN]; /* the initial kernel version */
Jaegeuk Kim76f105a2015-04-13 15:10:36 -0700107 __le32 feature; /* defined features */
Jaegeuk Kimcde4de12015-04-20 13:57:51 -0700108 __u8 encryption_level; /* versioning level for encryption */
109 __u8 encrypt_pw_salt[16]; /* Salt used for string2key algorithm */
Jaegeuk Kime6b120d2017-07-10 12:55:09 -0700110 struct f2fs_device devs[MAX_DEVICES]; /* device list */
Jaegeuk Kimd4c292d2017-10-05 21:03:06 -0700111 __le32 qf_ino[F2FS_MAX_QUOTAS]; /* quota inode numbers */
Chao Yuac734c42018-02-28 17:07:27 +0800112 __u8 hot_ext_count; /* # of hot file extension */
Junling Zheng0570b3f2018-09-28 20:25:56 +0800113 __u8 reserved[310]; /* valid reserved region */
114 __le32 crc; /* checksum of superblock */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900115} __packed;
116
117/*
118 * For checkpoint
119 */
Jaegeuk Kimf2cb9192019-01-24 17:48:38 -0800120#define CP_DISABLED_QUICK_FLAG 0x00002000
Daniel Rosenbergf22f93a2018-08-20 19:21:43 -0700121#define CP_DISABLED_FLAG 0x00001000
Chao Yud8312722018-09-20 20:05:00 +0800122#define CP_QUOTA_NEED_FSCK_FLAG 0x00000800
Chao Yua1afb552018-01-25 19:40:08 +0800123#define CP_LARGE_NAT_BITMAP_FLAG 0x00000400
Jaegeuk Kim111e8452018-01-19 13:42:33 -0800124#define CP_NOCRC_RECOVERY_FLAG 0x00000200
Jaegeuk Kime6b120d2017-07-10 12:55:09 -0700125#define CP_TRIMMED_FLAG 0x00000100
126#define CP_NAT_BITS_FLAG 0x00000080
Jaegeuk Kima468f0e2016-09-19 17:55:10 -0700127#define CP_CRC_RECOVERY_FLAG 0x00000040
Jaegeuk Kim119ee912015-01-29 11:45:33 -0800128#define CP_FASTBOOT_FLAG 0x00000020
Jaegeuk Kim2ae4c672014-09-02 15:43:52 -0700129#define CP_FSCK_FLAG 0x00000010
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900130#define CP_ERROR_FLAG 0x00000008
131#define CP_COMPACT_SUM_FLAG 0x00000004
132#define CP_ORPHAN_PRESENT_FLAG 0x00000002
133#define CP_UMOUNT_FLAG 0x00000001
134
Chao Yub5b82202014-08-22 16:17:38 +0800135#define F2FS_CP_PACKS 2 /* # of checkpoint packs */
136
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900137struct f2fs_checkpoint {
138 __le64 checkpoint_ver; /* checkpoint block version number */
139 __le64 user_block_count; /* # of user blocks */
140 __le64 valid_block_count; /* # of valid blocks in main area */
141 __le32 rsvd_segment_count; /* # of reserved segments for gc */
142 __le32 overprov_segment_count; /* # of overprovision segments */
143 __le32 free_segment_count; /* # of free segments in main area */
144
145 /* information of current node segments */
146 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
147 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
148 /* information of current data segments */
149 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
150 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
151 __le32 ckpt_flags; /* Flags : umount and journal_present */
152 __le32 cp_pack_total_block_count; /* total # of one cp pack */
153 __le32 cp_pack_start_sum; /* start block number of data summary */
154 __le32 valid_node_count; /* Total number of valid nodes */
155 __le32 valid_inode_count; /* Total number of valid inodes */
156 __le32 next_free_nid; /* Next free node number */
157 __le32 sit_ver_bitmap_bytesize; /* Default value 64 */
158 __le32 nat_ver_bitmap_bytesize; /* Default value 256 */
159 __le32 checksum_offset; /* checksum offset inside cp block */
160 __le64 elapsed_time; /* mounted time */
161 /* allocation type of current segment */
162 unsigned char alloc_type[MAX_ACTIVE_LOGS];
163
164 /* SIT and NAT version bitmap */
165 unsigned char sit_nat_version_bitmap[1];
166} __packed;
167
Chao Yude057132019-04-22 17:33:52 +0800168#define CP_CHKSUM_OFFSET 4092 /* default chksum offset in checkpoint */
169#define CP_MIN_CHKSUM_OFFSET \
170 (offsetof(struct f2fs_checkpoint, sit_nat_version_bitmap))
171
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900172/*
173 * For orphan inode management
174 */
175#define F2FS_ORPHANS_PER_BLOCK 1020
176
Jaegeuk Kime6b120d2017-07-10 12:55:09 -0700177#define GET_ORPHAN_BLOCKS(n) (((n) + F2FS_ORPHANS_PER_BLOCK - 1) / \
Chao Yub5b82202014-08-22 16:17:38 +0800178 F2FS_ORPHANS_PER_BLOCK)
179
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900180struct f2fs_orphan_block {
181 __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */
182 __le32 reserved; /* reserved */
183 __le16 blk_addr; /* block index in current CP */
184 __le16 blk_count; /* Number of orphan inode blocks in CP */
185 __le32 entry_count; /* Total number of orphan nodes in current CP */
186 __le32 check_sum; /* CRC32 for orphan inode block */
187} __packed;
188
189/*
190 * For NODE structure
191 */
192struct f2fs_extent {
193 __le32 fofs; /* start file offset of the extent */
Chao Yu4d0b0bd2015-02-05 17:47:25 +0800194 __le32 blk; /* start block address of the extent */
Geliang Tangd752b9e2019-01-25 15:35:01 +0800195 __le32 len; /* length of the extent */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900196} __packed;
197
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900198#define F2FS_NAME_LEN 255
Chao Yu50ffaa92017-09-06 21:59:50 +0800199/* 200 bytes for inline xattrs by default */
200#define DEFAULT_INLINE_XATTR_ADDRS 50
Jaegeuk Kimde936532013-08-12 21:08:03 +0900201#define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
Chao Yufbcf9312017-07-19 00:19:06 +0800202#define CUR_ADDRS_PER_INODE(inode) (DEF_ADDRS_PER_INODE - \
203 get_extra_isize(inode))
Chao Yub5b82202014-08-22 16:17:38 +0800204#define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
Chao Yu81ca7352016-01-26 15:39:35 +0800205#define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
Chao Yuaeb829e2019-03-25 21:08:19 +0800206#define DEF_ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
207#define ADDRS_PER_BLOCK(inode) addrs_per_block(inode)
Jaegeuk Kimde936532013-08-12 21:08:03 +0900208#define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
209
Chao Yu81ca7352016-01-26 15:39:35 +0800210#define ADDRS_PER_PAGE(page, inode) \
Chao Yuaeb829e2019-03-25 21:08:19 +0800211 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK(inode))
Chao Yu6403eb12014-04-26 19:59:52 +0800212
Jaegeuk Kimde936532013-08-12 21:08:03 +0900213#define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
214#define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
215#define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
216#define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
217#define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900218
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900219#define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
Huajun Li1001b342013-11-10 23:13:16 +0800220#define F2FS_INLINE_DATA 0x02 /* file inline data flag */
Chao Yu34d67de2014-09-24 18:15:19 +0800221#define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
Jaegeuk Kimb3d208f2014-10-23 19:48:09 -0700222#define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
Jaegeuk Kim510022a2015-03-30 15:07:16 -0700223#define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */
Chao Yufbcf9312017-07-19 00:19:06 +0800224#define F2FS_EXTRA_ATTR 0x20 /* file having extra attribute */
Jaegeuk Kim9ce3d6b2017-12-07 16:25:39 -0800225#define F2FS_PIN_FILE 0x40 /* file should not be gced */
Huajun Li1001b342013-11-10 23:13:16 +0800226
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900227struct f2fs_inode {
228 __le16 i_mode; /* file mode */
229 __u8 i_advise; /* file hints */
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900230 __u8 i_inline; /* file inline flags */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900231 __le32 i_uid; /* user ID */
232 __le32 i_gid; /* group ID */
233 __le32 i_links; /* links count */
234 __le64 i_size; /* file size in bytes */
235 __le64 i_blocks; /* file size in blocks */
236 __le64 i_atime; /* access time */
237 __le64 i_ctime; /* change time */
238 __le64 i_mtime; /* modification time */
239 __le32 i_atime_nsec; /* access time in nano scale */
240 __le32 i_ctime_nsec; /* change time in nano scale */
241 __le32 i_mtime_nsec; /* modification time in nano scale */
242 __le32 i_generation; /* file version (for NFS) */
Jaegeuk Kim9ce3d6b2017-12-07 16:25:39 -0800243 union {
244 __le32 i_current_depth; /* only for directory depth */
245 __le16 i_gc_failures; /*
246 * # of gc failures on pinned file.
247 * only for regular files.
248 */
249 };
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900250 __le32 i_xattr_nid; /* nid to save xattr */
251 __le32 i_flags; /* file attributes */
252 __le32 i_pino; /* parent inode number */
253 __le32 i_namelen; /* file name length */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900254 __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */
Jaegeuk Kim38431542014-02-27 18:20:00 +0900255 __u8 i_dir_level; /* dentry_level for large dir */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900256
257 struct f2fs_extent i_ext; /* caching a largest extent */
258
Chao Yufbcf9312017-07-19 00:19:06 +0800259 union {
260 struct {
261 __le16 i_extra_isize; /* extra inode attribute size */
Chao Yu50ffaa92017-09-06 21:59:50 +0800262 __le16 i_inline_xattr_size; /* inline xattr size, unit: 4 bytes */
Chao Yu5647b302017-07-26 00:01:41 +0800263 __le32 i_projid; /* project id */
Chao Yu43101252017-07-31 20:19:09 +0800264 __le32 i_inode_checksum;/* inode meta checksum */
Chao Yu71f8f042018-01-25 14:54:42 +0800265 __le64 i_crtime; /* creation time */
266 __le32 i_crtime_nsec; /* creation time in nano scale */
Chao Yufbcf9312017-07-19 00:19:06 +0800267 __le32 i_extra_end[0]; /* for attribute size calculation */
Chao Yu71f8f042018-01-25 14:54:42 +0800268 } __packed;
Chao Yufbcf9312017-07-19 00:19:06 +0800269 __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */
270 };
Chao Yub5b82202014-08-22 16:17:38 +0800271 __le32 i_nid[DEF_NIDS_PER_INODE]; /* direct(2), indirect(2),
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900272 double_indirect(1) node id */
273} __packed;
274
275struct direct_node {
Chao Yuaeb829e2019-03-25 21:08:19 +0800276 __le32 addr[DEF_ADDRS_PER_BLOCK]; /* array of data block address */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900277} __packed;
278
279struct indirect_node {
280 __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */
281} __packed;
282
283enum {
284 COLD_BIT_SHIFT = 0,
285 FSYNC_BIT_SHIFT,
286 DENT_BIT_SHIFT,
287 OFFSET_BIT_SHIFT
288};
289
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800290#define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
291
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900292struct node_footer {
293 __le32 nid; /* node id */
Zeng Guangyue6a9d45a2019-02-18 14:26:41 +0800294 __le32 ino; /* inode number */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900295 __le32 flag; /* include cold/fsync/dentry marks and offset */
296 __le64 cp_ver; /* checkpoint version */
297 __le32 next_blkaddr; /* next node page block address */
298} __packed;
299
300struct f2fs_node {
301 /* can be one of three types: inode, direct, and indirect types */
302 union {
303 struct f2fs_inode i;
304 struct direct_node dn;
305 struct indirect_node in;
306 };
307 struct node_footer footer;
308} __packed;
309
310/*
311 * For NAT entries
312 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300313#define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900314
315struct f2fs_nat_entry {
316 __u8 version; /* latest version of cached nat entry */
317 __le32 ino; /* inode number */
318 __le32 block_addr; /* block address */
319} __packed;
320
321struct f2fs_nat_block {
322 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
323} __packed;
324
325/*
326 * For SIT entries
327 *
328 * Each segment is 2MB in size by default so that a bitmap for validity of
329 * there-in blocks should occupy 64 bytes, 512 bits.
330 * Not allow to change this.
331 */
332#define SIT_VBLOCK_MAP_SIZE 64
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300333#define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900334
335/*
Jin Qian93862952017-04-25 16:28:48 -0700336 * F2FS uses 4 bytes to represent block address. As a result, supported size of
337 * disk is 16 TB and it equals to 16 * 1024 * 1024 / 2 segments.
338 */
339#define F2FS_MAX_SEGMENT ((16 * 1024 * 1024) / 2)
340
341/*
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900342 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
343 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
344 * [9:0] : valid block count
345 */
346#define SIT_VBLOCKS_SHIFT 10
347#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
348#define GET_SIT_VBLOCKS(raw_sit) \
349 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
350#define GET_SIT_TYPE(raw_sit) \
351 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
352 >> SIT_VBLOCKS_SHIFT)
353
354struct f2fs_sit_entry {
355 __le16 vblocks; /* reference above */
356 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */
357 __le64 mtime; /* segment age for cleaning */
358} __packed;
359
360struct f2fs_sit_block {
361 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
362} __packed;
363
364/*
365 * For segment summary
366 *
367 * One summary block contains exactly 512 summary entries, which represents
368 * exactly 2MB segment by default. Not allow to change the basic units.
369 *
370 * NOTE: For initializing fields, you must use set_summary
371 *
372 * - If data page, nid represents dnode's nid
373 * - If node page, nid represents the node page's nid.
374 *
375 * The ofs_in_node is used by only data page. It represents offset
376 * from node's page's beginning to get a data block address.
377 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
378 */
379#define ENTRIES_IN_SUM 512
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900380#define SUMMARY_SIZE (7) /* sizeof(struct summary) */
381#define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900382#define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
383
384/* a summary entry for a 4KB-sized block in a segment */
385struct f2fs_summary {
386 __le32 nid; /* parent node id */
387 union {
388 __u8 reserved[3];
389 struct {
390 __u8 version; /* node version number */
391 __le16 ofs_in_node; /* block index in parent node */
392 } __packed;
393 };
394} __packed;
395
396/* summary block type, node or data, is stored to the summary_footer */
397#define SUM_TYPE_NODE (1)
398#define SUM_TYPE_DATA (0)
399
400struct summary_footer {
401 unsigned char entry_type; /* SUM_TYPE_XXX */
Sheng Yong479c8bc2016-01-28 11:40:26 +0000402 __le32 check_sum; /* summary checksum */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900403} __packed;
404
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900405#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900406 SUM_ENTRY_SIZE)
407#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
408 sizeof(struct nat_journal_entry))
409#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
410 sizeof(struct nat_journal_entry))
411#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
412 sizeof(struct sit_journal_entry))
413#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
414 sizeof(struct sit_journal_entry))
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800415
416/* Reserved area should make size of f2fs_extra_info equals to
417 * that of nat_journal and sit_journal.
418 */
419#define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
420
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900421/*
422 * frequently updated NAT/SIT entries can be stored in the spare area in
423 * summary blocks
424 */
425enum {
426 NAT_JOURNAL = 0,
427 SIT_JOURNAL
428};
429
430struct nat_journal_entry {
431 __le32 nid;
432 struct f2fs_nat_entry ne;
433} __packed;
434
435struct nat_journal {
436 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
437 __u8 reserved[NAT_JOURNAL_RESERVED];
438} __packed;
439
440struct sit_journal_entry {
441 __le32 segno;
442 struct f2fs_sit_entry se;
443} __packed;
444
445struct sit_journal {
446 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
447 __u8 reserved[SIT_JOURNAL_RESERVED];
448} __packed;
449
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800450struct f2fs_extra_info {
451 __le64 kbytes_written;
452 __u8 reserved[EXTRA_INFO_RESERVED];
453} __packed;
454
Chao Yudfc08a12016-02-14 18:50:40 +0800455struct f2fs_journal {
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900456 union {
457 __le16 n_nats;
458 __le16 n_sits;
459 };
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800460 /* spare area is used by NAT or SIT journals or extra info */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900461 union {
462 struct nat_journal nat_j;
463 struct sit_journal sit_j;
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800464 struct f2fs_extra_info info;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900465 };
Chao Yudfc08a12016-02-14 18:50:40 +0800466} __packed;
467
468/* 4KB-sized summary block structure */
469struct f2fs_summary_block {
470 struct f2fs_summary entries[ENTRIES_IN_SUM];
471 struct f2fs_journal journal;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900472 struct summary_footer footer;
473} __packed;
474
475/*
476 * For directory operations
477 */
478#define F2FS_DOT_HASH 0
479#define F2FS_DDOT_HASH F2FS_DOT_HASH
480#define F2FS_MAX_HASH (~((0x3ULL) << 62))
481#define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
482
483typedef __le32 f2fs_hash_t;
484
485/* One directory entry slot covers 8bytes-long file name */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900486#define F2FS_SLOT_LEN 8
487#define F2FS_SLOT_LEN_BITS 3
Namjae Jeon457d08e2012-12-08 14:54:50 +0900488
Jaegeuk Kime6b120d2017-07-10 12:55:09 -0700489#define GET_DENTRY_SLOTS(x) (((x) + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900490
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900491/* MAX level for dir lookup */
492#define MAX_DIR_HASH_DEPTH 63
493
Chao Yubfec07d2014-05-28 08:56:09 +0800494/* MAX buckets in one level of dir */
495#define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
496
Chao Yuc031f6a2015-08-19 19:02:02 +0800497/*
Chao Yue84f88e2017-07-19 00:19:05 +0800498 * space utilization of regular dentry and inline dentry (w/o extra reservation)
Chao Yu4d8013e2019-02-15 00:08:25 +0800499 * regular dentry inline dentry (def) inline dentry (min)
500 * bitmap 1 * 27 = 27 1 * 23 = 23 1 * 1 = 1
501 * reserved 1 * 3 = 3 1 * 7 = 7 1 * 1 = 1
502 * dentry 11 * 214 = 2354 11 * 182 = 2002 11 * 2 = 22
503 * filename 8 * 214 = 1712 8 * 182 = 1456 8 * 2 = 16
504 * total 4096 3488 40
Chao Yuc031f6a2015-08-19 19:02:02 +0800505 *
506 * Note: there are more reserved space in inline dentry than in regular
507 * dentry, when converting inline dentry we should handle this carefully.
508 */
509#define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900510#define SIZE_OF_DIR_ENTRY 11 /* by byte */
511#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
512 BITS_PER_BYTE)
513#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900514 F2FS_SLOT_LEN) * \
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900515 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
Chao Yu4d8013e2019-02-15 00:08:25 +0800516#define MIN_INLINE_DENTRY_SIZE 40 /* just include '.' and '..' entries */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900517
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900518/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900519struct f2fs_dir_entry {
520 __le32 hash_code; /* hash code of file name */
521 __le32 ino; /* inode number */
Geliang Tangd752b9e2019-01-25 15:35:01 +0800522 __le16 name_len; /* length of file name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900523 __u8 file_type; /* file type */
524} __packed;
525
526/* 4KB-sized directory entry block */
527struct f2fs_dentry_block {
528 /* validity bitmap for directory entries in each block */
529 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
530 __u8 reserved[SIZE_OF_RESERVED];
531 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900532 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900533} __packed;
534
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900535/* file types used in inode_info->flags */
536enum {
537 F2FS_FT_UNKNOWN,
538 F2FS_FT_REG_FILE,
539 F2FS_FT_DIR,
540 F2FS_FT_CHRDEV,
541 F2FS_FT_BLKDEV,
542 F2FS_FT_FIFO,
543 F2FS_FT_SOCK,
544 F2FS_FT_SYMLINK,
545 F2FS_FT_MAX
546};
547
Chao Yu675f10b2016-02-22 18:29:18 +0800548#define S_SHIFT 12
549
Chao Yu5647b302017-07-26 00:01:41 +0800550#define F2FS_DEF_PROJID 0 /* default project ID */
551
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900552#endif /* _LINUX_F2FS_FS_H */