blob: e2d239ed4c60cb05fbf6072e1a3a3ea4e34594f3 [file] [log] [blame]
Jaegeuk Kimdd318662012-11-02 17:06:26 +09001/**
2 * include/linux/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 _LINUX_F2FS_FS_H
12#define _LINUX_F2FS_FS_H
13
14#include <linux/pagemap.h>
15#include <linux/types.h>
16
17#define F2FS_SUPER_OFFSET 1024 /* byte-size offset */
Chao Yu55cf9cb2014-09-15 18:01:10 +080018#define F2FS_MIN_LOG_SECTOR_SIZE 9 /* 9 bits for 512 bytes */
19#define F2FS_MAX_LOG_SECTOR_SIZE 12 /* 12 bits for 4096 bytes */
20#define F2FS_LOG_SECTORS_PER_BLOCK 3 /* log number for sector/blk */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090021#define F2FS_BLKSIZE 4096 /* support only 4KB block */
Jaegeuk Kimf7ef9b82015-02-09 12:02:44 -080022#define F2FS_BLKSIZE_BITS 12 /* bits for F2FS_BLKSIZE */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090023#define F2FS_MAX_EXTENSION 64 /* # of extension entries */
Jaegeuk Kim24b84912016-02-03 13:49:44 -080024#define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS)
Jaegeuk Kimdd318662012-11-02 17:06:26 +090025
Jaegeuk Kima9841c42013-05-24 12:41:04 +090026#define NULL_ADDR ((block_t)0) /* used as block_t addresses */
27#define NEW_ADDR ((block_t)-1) /* used as block_t addresses */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090028
Jaegeuk Kimf7ef9b82015-02-09 12:02:44 -080029#define F2FS_BYTES_TO_BLK(bytes) ((bytes) >> F2FS_BLKSIZE_BITS)
30#define F2FS_BLK_TO_BYTES(blk) ((blk) << F2FS_BLKSIZE_BITS)
31
Chao Yuc200b1a2014-08-20 18:36:46 +080032/* 0, 1(node nid), 2(meta nid) are reserved node id */
33#define F2FS_RESERVED_NODE_NUM 3
34
Jaegeuk Kimdd318662012-11-02 17:06:26 +090035#define F2FS_ROOT_INO(sbi) (sbi->root_ino_num)
36#define F2FS_NODE_INO(sbi) (sbi->node_ino_num)
37#define F2FS_META_INO(sbi) (sbi->meta_ino_num)
38
Jaegeuk Kim0a595eb2016-12-14 10:12:56 -080039#define F2FS_IO_SIZE(sbi) (1 << (sbi)->write_io_size_bits) /* Blocks */
40#define F2FS_IO_SIZE_KB(sbi) (1 << ((sbi)->write_io_size_bits + 2)) /* KB */
41#define F2FS_IO_SIZE_BYTES(sbi) (1 << ((sbi)->write_io_size_bits + 12)) /* B */
42#define F2FS_IO_SIZE_BITS(sbi) ((sbi)->write_io_size_bits) /* power of 2 */
43#define F2FS_IO_SIZE_MASK(sbi) (F2FS_IO_SIZE(sbi) - 1)
44
Jaegeuk Kimdd318662012-11-02 17:06:26 +090045/* This flag is used by node and meta inodes, and by recovery */
Jaegeuk Kima78186e2014-10-17 17:57:29 -070046#define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
47#define GFP_F2FS_HIGH_ZERO (GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)
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 Kim3c62be12016-10-06 19:02:05 -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 Kim3c62be12016-10-06 19:02:05 -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 */
103 __u8 extension_list[F2FS_MAX_EXTENSION][8]; /* 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 Kim3c62be12016-10-06 19:02:05 -0700110 struct f2fs_device devs[MAX_DEVICES]; /* device list */
111 __u8 reserved[327]; /* valid reserved region */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900112} __packed;
113
114/*
115 * For checkpoint
116 */
Jaegeuk Kim22ad0b62017-02-09 10:38:09 -0800117#define CP_NAT_BITS_FLAG 0x00000080
Jaegeuk Kima468f0e2016-09-19 17:55:10 -0700118#define CP_CRC_RECOVERY_FLAG 0x00000040
Jaegeuk Kim119ee912015-01-29 11:45:33 -0800119#define CP_FASTBOOT_FLAG 0x00000020
Jaegeuk Kim2ae4c672014-09-02 15:43:52 -0700120#define CP_FSCK_FLAG 0x00000010
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900121#define CP_ERROR_FLAG 0x00000008
122#define CP_COMPACT_SUM_FLAG 0x00000004
123#define CP_ORPHAN_PRESENT_FLAG 0x00000002
124#define CP_UMOUNT_FLAG 0x00000001
125
Chao Yub5b82202014-08-22 16:17:38 +0800126#define F2FS_CP_PACKS 2 /* # of checkpoint packs */
127
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900128struct f2fs_checkpoint {
129 __le64 checkpoint_ver; /* checkpoint block version number */
130 __le64 user_block_count; /* # of user blocks */
131 __le64 valid_block_count; /* # of valid blocks in main area */
132 __le32 rsvd_segment_count; /* # of reserved segments for gc */
133 __le32 overprov_segment_count; /* # of overprovision segments */
134 __le32 free_segment_count; /* # of free segments in main area */
135
136 /* information of current node segments */
137 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
138 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
139 /* information of current data segments */
140 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
141 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
142 __le32 ckpt_flags; /* Flags : umount and journal_present */
143 __le32 cp_pack_total_block_count; /* total # of one cp pack */
144 __le32 cp_pack_start_sum; /* start block number of data summary */
145 __le32 valid_node_count; /* Total number of valid nodes */
146 __le32 valid_inode_count; /* Total number of valid inodes */
147 __le32 next_free_nid; /* Next free node number */
148 __le32 sit_ver_bitmap_bytesize; /* Default value 64 */
149 __le32 nat_ver_bitmap_bytesize; /* Default value 256 */
150 __le32 checksum_offset; /* checksum offset inside cp block */
151 __le64 elapsed_time; /* mounted time */
152 /* allocation type of current segment */
153 unsigned char alloc_type[MAX_ACTIVE_LOGS];
154
155 /* SIT and NAT version bitmap */
156 unsigned char sit_nat_version_bitmap[1];
157} __packed;
158
159/*
160 * For orphan inode management
161 */
162#define F2FS_ORPHANS_PER_BLOCK 1020
163
Chao Yub5b82202014-08-22 16:17:38 +0800164#define GET_ORPHAN_BLOCKS(n) ((n + F2FS_ORPHANS_PER_BLOCK - 1) / \
165 F2FS_ORPHANS_PER_BLOCK)
166
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900167struct f2fs_orphan_block {
168 __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */
169 __le32 reserved; /* reserved */
170 __le16 blk_addr; /* block index in current CP */
171 __le16 blk_count; /* Number of orphan inode blocks in CP */
172 __le32 entry_count; /* Total number of orphan nodes in current CP */
173 __le32 check_sum; /* CRC32 for orphan inode block */
174} __packed;
175
176/*
177 * For NODE structure
178 */
179struct f2fs_extent {
180 __le32 fofs; /* start file offset of the extent */
Chao Yu4d0b0bd2015-02-05 17:47:25 +0800181 __le32 blk; /* start block address of the extent */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900182 __le32 len; /* lengh of the extent */
183} __packed;
184
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900185#define F2FS_NAME_LEN 255
Jaegeuk Kim65985d92013-08-14 21:57:27 +0900186#define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */
Jaegeuk Kimde936532013-08-12 21:08:03 +0900187#define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
Chao Yub5b82202014-08-22 16:17:38 +0800188#define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
Chao Yu81ca7352016-01-26 15:39:35 +0800189#define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
Jaegeuk Kimde936532013-08-12 21:08:03 +0900190#define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
191#define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
192
Chao Yu81ca7352016-01-26 15:39:35 +0800193#define ADDRS_PER_PAGE(page, inode) \
194 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK)
Chao Yu6403eb12014-04-26 19:59:52 +0800195
Jaegeuk Kimde936532013-08-12 21:08:03 +0900196#define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
197#define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
198#define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
199#define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
200#define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900201
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900202#define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
Huajun Li1001b342013-11-10 23:13:16 +0800203#define F2FS_INLINE_DATA 0x02 /* file inline data flag */
Chao Yu34d67de2014-09-24 18:15:19 +0800204#define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
Jaegeuk Kimb3d208f2014-10-23 19:48:09 -0700205#define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
Jaegeuk Kim510022a2015-03-30 15:07:16 -0700206#define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */
Huajun Li1001b342013-11-10 23:13:16 +0800207
Huajun Li1001b342013-11-10 23:13:16 +0800208#define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
209 F2FS_INLINE_XATTR_ADDRS - 1))
210
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900211struct f2fs_inode {
212 __le16 i_mode; /* file mode */
213 __u8 i_advise; /* file hints */
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900214 __u8 i_inline; /* file inline flags */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900215 __le32 i_uid; /* user ID */
216 __le32 i_gid; /* group ID */
217 __le32 i_links; /* links count */
218 __le64 i_size; /* file size in bytes */
219 __le64 i_blocks; /* file size in blocks */
220 __le64 i_atime; /* access time */
221 __le64 i_ctime; /* change time */
222 __le64 i_mtime; /* modification time */
223 __le32 i_atime_nsec; /* access time in nano scale */
224 __le32 i_ctime_nsec; /* change time in nano scale */
225 __le32 i_mtime_nsec; /* modification time in nano scale */
226 __le32 i_generation; /* file version (for NFS) */
227 __le32 i_current_depth; /* only for directory depth */
228 __le32 i_xattr_nid; /* nid to save xattr */
229 __le32 i_flags; /* file attributes */
230 __le32 i_pino; /* parent inode number */
231 __le32 i_namelen; /* file name length */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900232 __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */
Jaegeuk Kim38431542014-02-27 18:20:00 +0900233 __u8 i_dir_level; /* dentry_level for large dir */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900234
235 struct f2fs_extent i_ext; /* caching a largest extent */
236
Jaegeuk Kimde936532013-08-12 21:08:03 +0900237 __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900238
Chao Yub5b82202014-08-22 16:17:38 +0800239 __le32 i_nid[DEF_NIDS_PER_INODE]; /* direct(2), indirect(2),
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900240 double_indirect(1) node id */
241} __packed;
242
243struct direct_node {
244 __le32 addr[ADDRS_PER_BLOCK]; /* array of data block address */
245} __packed;
246
247struct indirect_node {
248 __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */
249} __packed;
250
251enum {
252 COLD_BIT_SHIFT = 0,
253 FSYNC_BIT_SHIFT,
254 DENT_BIT_SHIFT,
255 OFFSET_BIT_SHIFT
256};
257
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800258#define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
259
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900260struct node_footer {
261 __le32 nid; /* node id */
262 __le32 ino; /* inode nunmber */
263 __le32 flag; /* include cold/fsync/dentry marks and offset */
264 __le64 cp_ver; /* checkpoint version */
265 __le32 next_blkaddr; /* next node page block address */
266} __packed;
267
268struct f2fs_node {
269 /* can be one of three types: inode, direct, and indirect types */
270 union {
271 struct f2fs_inode i;
272 struct direct_node dn;
273 struct indirect_node in;
274 };
275 struct node_footer footer;
276} __packed;
277
278/*
279 * For NAT entries
280 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300281#define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
Chao Yu4ac91242017-02-23 10:53:49 +0800282#define NAT_ENTRY_BITMAP_SIZE ((NAT_ENTRY_PER_BLOCK + 7) / 8)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900283
284struct f2fs_nat_entry {
285 __u8 version; /* latest version of cached nat entry */
286 __le32 ino; /* inode number */
287 __le32 block_addr; /* block address */
288} __packed;
289
290struct f2fs_nat_block {
291 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
292} __packed;
293
294/*
295 * For SIT entries
296 *
297 * Each segment is 2MB in size by default so that a bitmap for validity of
298 * there-in blocks should occupy 64 bytes, 512 bits.
299 * Not allow to change this.
300 */
301#define SIT_VBLOCK_MAP_SIZE 64
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300302#define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900303
304/*
305 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
306 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
307 * [9:0] : valid block count
308 */
309#define SIT_VBLOCKS_SHIFT 10
310#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
311#define GET_SIT_VBLOCKS(raw_sit) \
312 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
313#define GET_SIT_TYPE(raw_sit) \
314 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
315 >> SIT_VBLOCKS_SHIFT)
316
317struct f2fs_sit_entry {
318 __le16 vblocks; /* reference above */
319 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */
320 __le64 mtime; /* segment age for cleaning */
321} __packed;
322
323struct f2fs_sit_block {
324 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
325} __packed;
326
327/*
328 * For segment summary
329 *
330 * One summary block contains exactly 512 summary entries, which represents
331 * exactly 2MB segment by default. Not allow to change the basic units.
332 *
333 * NOTE: For initializing fields, you must use set_summary
334 *
335 * - If data page, nid represents dnode's nid
336 * - If node page, nid represents the node page's nid.
337 *
338 * The ofs_in_node is used by only data page. It represents offset
339 * from node's page's beginning to get a data block address.
340 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
341 */
342#define ENTRIES_IN_SUM 512
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900343#define SUMMARY_SIZE (7) /* sizeof(struct summary) */
344#define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900345#define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
346
347/* a summary entry for a 4KB-sized block in a segment */
348struct f2fs_summary {
349 __le32 nid; /* parent node id */
350 union {
351 __u8 reserved[3];
352 struct {
353 __u8 version; /* node version number */
354 __le16 ofs_in_node; /* block index in parent node */
355 } __packed;
356 };
357} __packed;
358
359/* summary block type, node or data, is stored to the summary_footer */
360#define SUM_TYPE_NODE (1)
361#define SUM_TYPE_DATA (0)
362
363struct summary_footer {
364 unsigned char entry_type; /* SUM_TYPE_XXX */
Sheng Yong479c8bc2016-01-28 11:40:26 +0000365 __le32 check_sum; /* summary checksum */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900366} __packed;
367
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900368#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900369 SUM_ENTRY_SIZE)
370#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
371 sizeof(struct nat_journal_entry))
372#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
373 sizeof(struct nat_journal_entry))
374#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
375 sizeof(struct sit_journal_entry))
376#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
377 sizeof(struct sit_journal_entry))
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800378
379/* Reserved area should make size of f2fs_extra_info equals to
380 * that of nat_journal and sit_journal.
381 */
382#define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
383
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900384/*
385 * frequently updated NAT/SIT entries can be stored in the spare area in
386 * summary blocks
387 */
388enum {
389 NAT_JOURNAL = 0,
390 SIT_JOURNAL
391};
392
393struct nat_journal_entry {
394 __le32 nid;
395 struct f2fs_nat_entry ne;
396} __packed;
397
398struct nat_journal {
399 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
400 __u8 reserved[NAT_JOURNAL_RESERVED];
401} __packed;
402
403struct sit_journal_entry {
404 __le32 segno;
405 struct f2fs_sit_entry se;
406} __packed;
407
408struct sit_journal {
409 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
410 __u8 reserved[SIT_JOURNAL_RESERVED];
411} __packed;
412
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800413struct f2fs_extra_info {
414 __le64 kbytes_written;
415 __u8 reserved[EXTRA_INFO_RESERVED];
416} __packed;
417
Chao Yudfc08a12016-02-14 18:50:40 +0800418struct f2fs_journal {
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900419 union {
420 __le16 n_nats;
421 __le16 n_sits;
422 };
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800423 /* spare area is used by NAT or SIT journals or extra info */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900424 union {
425 struct nat_journal nat_j;
426 struct sit_journal sit_j;
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800427 struct f2fs_extra_info info;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900428 };
Chao Yudfc08a12016-02-14 18:50:40 +0800429} __packed;
430
431/* 4KB-sized summary block structure */
432struct f2fs_summary_block {
433 struct f2fs_summary entries[ENTRIES_IN_SUM];
434 struct f2fs_journal journal;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900435 struct summary_footer footer;
436} __packed;
437
438/*
439 * For directory operations
440 */
441#define F2FS_DOT_HASH 0
442#define F2FS_DDOT_HASH F2FS_DOT_HASH
443#define F2FS_MAX_HASH (~((0x3ULL) << 62))
444#define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
445
446typedef __le32 f2fs_hash_t;
447
448/* One directory entry slot covers 8bytes-long file name */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900449#define F2FS_SLOT_LEN 8
450#define F2FS_SLOT_LEN_BITS 3
Namjae Jeon457d08e2012-12-08 14:54:50 +0900451
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900452#define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900453
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900454/* MAX level for dir lookup */
455#define MAX_DIR_HASH_DEPTH 63
456
Chao Yubfec07d2014-05-28 08:56:09 +0800457/* MAX buckets in one level of dir */
458#define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
459
Chao Yuc031f6a2015-08-19 19:02:02 +0800460/*
461 * space utilization of regular dentry and inline dentry
462 * regular dentry inline dentry
463 * bitmap 1 * 27 = 27 1 * 23 = 23
464 * reserved 1 * 3 = 3 1 * 7 = 7
465 * dentry 11 * 214 = 2354 11 * 182 = 2002
466 * filename 8 * 214 = 1712 8 * 182 = 1456
467 * total 4096 3488
468 *
469 * Note: there are more reserved space in inline dentry than in regular
470 * dentry, when converting inline dentry we should handle this carefully.
471 */
472#define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900473#define SIZE_OF_DIR_ENTRY 11 /* by byte */
474#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
475 BITS_PER_BYTE)
476#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900477 F2FS_SLOT_LEN) * \
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900478 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
479
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900480/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900481struct f2fs_dir_entry {
482 __le32 hash_code; /* hash code of file name */
483 __le32 ino; /* inode number */
484 __le16 name_len; /* lengh of file name */
485 __u8 file_type; /* file type */
486} __packed;
487
488/* 4KB-sized directory entry block */
489struct f2fs_dentry_block {
490 /* validity bitmap for directory entries in each block */
491 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
492 __u8 reserved[SIZE_OF_RESERVED];
493 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900494 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900495} __packed;
496
Chao Yu34d67de2014-09-24 18:15:19 +0800497/* for inline dir */
498#define NR_INLINE_DENTRY (MAX_INLINE_DATA * BITS_PER_BYTE / \
499 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
500 BITS_PER_BYTE + 1))
501#define INLINE_DENTRY_BITMAP_SIZE ((NR_INLINE_DENTRY + \
502 BITS_PER_BYTE - 1) / BITS_PER_BYTE)
503#define INLINE_RESERVED_SIZE (MAX_INLINE_DATA - \
504 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
505 NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))
506
507/* inline directory entry structure */
508struct f2fs_inline_dentry {
509 __u8 dentry_bitmap[INLINE_DENTRY_BITMAP_SIZE];
510 __u8 reserved[INLINE_RESERVED_SIZE];
511 struct f2fs_dir_entry dentry[NR_INLINE_DENTRY];
512 __u8 filename[NR_INLINE_DENTRY][F2FS_SLOT_LEN];
513} __packed;
514
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900515/* file types used in inode_info->flags */
516enum {
517 F2FS_FT_UNKNOWN,
518 F2FS_FT_REG_FILE,
519 F2FS_FT_DIR,
520 F2FS_FT_CHRDEV,
521 F2FS_FT_BLKDEV,
522 F2FS_FT_FIFO,
523 F2FS_FT_SOCK,
524 F2FS_FT_SYMLINK,
525 F2FS_FT_MAX
526};
527
Chao Yu675f10b2016-02-22 18:29:18 +0800528#define S_SHIFT 12
529
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900530#endif /* _LINUX_F2FS_FS_H */