blob: 4c02c6521feff7c0bed85f312faebdd1e6c0cfb7 [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
39/* This flag is used by node and meta inodes, and by recovery */
Jaegeuk Kima78186e2014-10-17 17:57:29 -070040#define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
41#define GFP_F2FS_HIGH_ZERO (GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)
Jaegeuk Kimdd318662012-11-02 17:06:26 +090042
43/*
44 * For further optimization on multi-head logs, on-disk layout supports maximum
45 * 16 logs by default. The number, 16, is expected to cover all the cases
46 * enoughly. The implementaion currently uses no more than 6 logs.
47 * Half the logs are used for nodes, and the other half are used for data.
48 */
49#define MAX_ACTIVE_LOGS 16
50#define MAX_ACTIVE_NODE_LOGS 8
51#define MAX_ACTIVE_DATA_LOGS 8
52
Jaegeuk Kim0040b932015-04-20 11:52:23 -070053#define VERSION_LEN 256
Jaegeuk Kima11fac32015-12-14 18:58:42 -080054#define MAX_VOLUME_NAME 512
Jaegeuk Kim0040b932015-04-20 11:52:23 -070055
Jaegeuk Kimdd318662012-11-02 17:06:26 +090056/*
57 * For superblock
58 */
59struct f2fs_super_block {
60 __le32 magic; /* Magic Number */
61 __le16 major_ver; /* Major Version */
62 __le16 minor_ver; /* Minor Version */
63 __le32 log_sectorsize; /* log2 sector size in bytes */
64 __le32 log_sectors_per_block; /* log2 # of sectors per block */
65 __le32 log_blocksize; /* log2 block size in bytes */
66 __le32 log_blocks_per_seg; /* log2 # of blocks per segment */
67 __le32 segs_per_sec; /* # of segments per section */
68 __le32 secs_per_zone; /* # of sections per zone */
69 __le32 checksum_offset; /* checksum offset inside super block */
70 __le64 block_count; /* total # of user blocks */
71 __le32 section_count; /* total # of sections */
72 __le32 segment_count; /* total # of segments */
73 __le32 segment_count_ckpt; /* # of segments for checkpoint */
74 __le32 segment_count_sit; /* # of segments for SIT */
75 __le32 segment_count_nat; /* # of segments for NAT */
76 __le32 segment_count_ssa; /* # of segments for SSA */
77 __le32 segment_count_main; /* # of segments for main area */
78 __le32 segment0_blkaddr; /* start block address of segment 0 */
79 __le32 cp_blkaddr; /* start block address of checkpoint */
80 __le32 sit_blkaddr; /* start block address of SIT */
81 __le32 nat_blkaddr; /* start block address of NAT */
82 __le32 ssa_blkaddr; /* start block address of SSA */
83 __le32 main_blkaddr; /* start block address of main area */
84 __le32 root_ino; /* root inode number */
85 __le32 node_ino; /* node inode number */
86 __le32 meta_ino; /* meta inode number */
87 __u8 uuid[16]; /* 128-bit uuid for volume */
Jaegeuk Kima11fac32015-12-14 18:58:42 -080088 __le16 volume_name[MAX_VOLUME_NAME]; /* volume name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090089 __le32 extension_count; /* # of extensions below */
90 __u8 extension_list[F2FS_MAX_EXTENSION][8]; /* extension array */
Changman Lee1dbe4152014-05-12 12:27:43 +090091 __le32 cp_payload;
Jaegeuk Kim0040b932015-04-20 11:52:23 -070092 __u8 version[VERSION_LEN]; /* the kernel version */
93 __u8 init_version[VERSION_LEN]; /* the initial kernel version */
Jaegeuk Kim76f105a2015-04-13 15:10:36 -070094 __le32 feature; /* defined features */
Jaegeuk Kimcde4de12015-04-20 13:57:51 -070095 __u8 encryption_level; /* versioning level for encryption */
96 __u8 encrypt_pw_salt[16]; /* Salt used for string2key algorithm */
97 __u8 reserved[871]; /* valid reserved region */
Jaegeuk Kimdd318662012-11-02 17:06:26 +090098} __packed;
99
100/*
101 * For checkpoint
102 */
Jaegeuk Kim119ee912015-01-29 11:45:33 -0800103#define CP_FASTBOOT_FLAG 0x00000020
Jaegeuk Kim2ae4c672014-09-02 15:43:52 -0700104#define CP_FSCK_FLAG 0x00000010
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900105#define CP_ERROR_FLAG 0x00000008
106#define CP_COMPACT_SUM_FLAG 0x00000004
107#define CP_ORPHAN_PRESENT_FLAG 0x00000002
108#define CP_UMOUNT_FLAG 0x00000001
109
Chao Yub5b82202014-08-22 16:17:38 +0800110#define F2FS_CP_PACKS 2 /* # of checkpoint packs */
111
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900112struct f2fs_checkpoint {
113 __le64 checkpoint_ver; /* checkpoint block version number */
114 __le64 user_block_count; /* # of user blocks */
115 __le64 valid_block_count; /* # of valid blocks in main area */
116 __le32 rsvd_segment_count; /* # of reserved segments for gc */
117 __le32 overprov_segment_count; /* # of overprovision segments */
118 __le32 free_segment_count; /* # of free segments in main area */
119
120 /* information of current node segments */
121 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
122 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
123 /* information of current data segments */
124 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
125 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
126 __le32 ckpt_flags; /* Flags : umount and journal_present */
127 __le32 cp_pack_total_block_count; /* total # of one cp pack */
128 __le32 cp_pack_start_sum; /* start block number of data summary */
129 __le32 valid_node_count; /* Total number of valid nodes */
130 __le32 valid_inode_count; /* Total number of valid inodes */
131 __le32 next_free_nid; /* Next free node number */
132 __le32 sit_ver_bitmap_bytesize; /* Default value 64 */
133 __le32 nat_ver_bitmap_bytesize; /* Default value 256 */
134 __le32 checksum_offset; /* checksum offset inside cp block */
135 __le64 elapsed_time; /* mounted time */
136 /* allocation type of current segment */
137 unsigned char alloc_type[MAX_ACTIVE_LOGS];
138
139 /* SIT and NAT version bitmap */
140 unsigned char sit_nat_version_bitmap[1];
141} __packed;
142
143/*
144 * For orphan inode management
145 */
146#define F2FS_ORPHANS_PER_BLOCK 1020
147
Chao Yub5b82202014-08-22 16:17:38 +0800148#define GET_ORPHAN_BLOCKS(n) ((n + F2FS_ORPHANS_PER_BLOCK - 1) / \
149 F2FS_ORPHANS_PER_BLOCK)
150
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900151struct f2fs_orphan_block {
152 __le32 ino[F2FS_ORPHANS_PER_BLOCK]; /* inode numbers */
153 __le32 reserved; /* reserved */
154 __le16 blk_addr; /* block index in current CP */
155 __le16 blk_count; /* Number of orphan inode blocks in CP */
156 __le32 entry_count; /* Total number of orphan nodes in current CP */
157 __le32 check_sum; /* CRC32 for orphan inode block */
158} __packed;
159
160/*
161 * For NODE structure
162 */
163struct f2fs_extent {
164 __le32 fofs; /* start file offset of the extent */
Chao Yu4d0b0bd2015-02-05 17:47:25 +0800165 __le32 blk; /* start block address of the extent */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900166 __le32 len; /* lengh of the extent */
167} __packed;
168
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900169#define F2FS_NAME_LEN 255
Jaegeuk Kim65985d92013-08-14 21:57:27 +0900170#define F2FS_INLINE_XATTR_ADDRS 50 /* 200 bytes for inline xattrs */
Jaegeuk Kimde936532013-08-12 21:08:03 +0900171#define DEF_ADDRS_PER_INODE 923 /* Address Pointers in an Inode */
Chao Yub5b82202014-08-22 16:17:38 +0800172#define DEF_NIDS_PER_INODE 5 /* Node IDs in an Inode */
Chao Yu81ca7352016-01-26 15:39:35 +0800173#define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
Jaegeuk Kimde936532013-08-12 21:08:03 +0900174#define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */
175#define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */
176
Chao Yu81ca7352016-01-26 15:39:35 +0800177#define ADDRS_PER_PAGE(page, inode) \
178 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK)
Chao Yu6403eb12014-04-26 19:59:52 +0800179
Jaegeuk Kimde936532013-08-12 21:08:03 +0900180#define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
181#define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
182#define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
183#define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
184#define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900185
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900186#define F2FS_INLINE_XATTR 0x01 /* file inline xattr flag */
Huajun Li1001b342013-11-10 23:13:16 +0800187#define F2FS_INLINE_DATA 0x02 /* file inline data flag */
Chao Yu34d67de2014-09-24 18:15:19 +0800188#define F2FS_INLINE_DENTRY 0x04 /* file inline dentry flag */
Jaegeuk Kimb3d208f2014-10-23 19:48:09 -0700189#define F2FS_DATA_EXIST 0x08 /* file inline data exist flag */
Jaegeuk Kim510022a2015-03-30 15:07:16 -0700190#define F2FS_INLINE_DOTS 0x10 /* file having implicit dot dentries */
Huajun Li1001b342013-11-10 23:13:16 +0800191
Huajun Li1001b342013-11-10 23:13:16 +0800192#define MAX_INLINE_DATA (sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
193 F2FS_INLINE_XATTR_ADDRS - 1))
194
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900195struct f2fs_inode {
196 __le16 i_mode; /* file mode */
197 __u8 i_advise; /* file hints */
Jaegeuk Kim444c5802013-08-08 15:16:22 +0900198 __u8 i_inline; /* file inline flags */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900199 __le32 i_uid; /* user ID */
200 __le32 i_gid; /* group ID */
201 __le32 i_links; /* links count */
202 __le64 i_size; /* file size in bytes */
203 __le64 i_blocks; /* file size in blocks */
204 __le64 i_atime; /* access time */
205 __le64 i_ctime; /* change time */
206 __le64 i_mtime; /* modification time */
207 __le32 i_atime_nsec; /* access time in nano scale */
208 __le32 i_ctime_nsec; /* change time in nano scale */
209 __le32 i_mtime_nsec; /* modification time in nano scale */
210 __le32 i_generation; /* file version (for NFS) */
211 __le32 i_current_depth; /* only for directory depth */
212 __le32 i_xattr_nid; /* nid to save xattr */
213 __le32 i_flags; /* file attributes */
214 __le32 i_pino; /* parent inode number */
215 __le32 i_namelen; /* file name length */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900216 __u8 i_name[F2FS_NAME_LEN]; /* file name for SPOR */
Jaegeuk Kim38431542014-02-27 18:20:00 +0900217 __u8 i_dir_level; /* dentry_level for large dir */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900218
219 struct f2fs_extent i_ext; /* caching a largest extent */
220
Jaegeuk Kimde936532013-08-12 21:08:03 +0900221 __le32 i_addr[DEF_ADDRS_PER_INODE]; /* Pointers to data blocks */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900222
Chao Yub5b82202014-08-22 16:17:38 +0800223 __le32 i_nid[DEF_NIDS_PER_INODE]; /* direct(2), indirect(2),
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900224 double_indirect(1) node id */
225} __packed;
226
227struct direct_node {
228 __le32 addr[ADDRS_PER_BLOCK]; /* array of data block address */
229} __packed;
230
231struct indirect_node {
232 __le32 nid[NIDS_PER_BLOCK]; /* array of data block address */
233} __packed;
234
235enum {
236 COLD_BIT_SHIFT = 0,
237 FSYNC_BIT_SHIFT,
238 DENT_BIT_SHIFT,
239 OFFSET_BIT_SHIFT
240};
241
Jaegeuk Kim09eb4832014-12-23 16:26:31 -0800242#define OFFSET_BIT_MASK (0x07) /* (0x01 << OFFSET_BIT_SHIFT) - 1 */
243
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900244struct node_footer {
245 __le32 nid; /* node id */
246 __le32 ino; /* inode nunmber */
247 __le32 flag; /* include cold/fsync/dentry marks and offset */
248 __le64 cp_ver; /* checkpoint version */
249 __le32 next_blkaddr; /* next node page block address */
250} __packed;
251
252struct f2fs_node {
253 /* can be one of three types: inode, direct, and indirect types */
254 union {
255 struct f2fs_inode i;
256 struct direct_node dn;
257 struct indirect_node in;
258 };
259 struct node_footer footer;
260} __packed;
261
262/*
263 * For NAT entries
264 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300265#define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900266
267struct f2fs_nat_entry {
268 __u8 version; /* latest version of cached nat entry */
269 __le32 ino; /* inode number */
270 __le32 block_addr; /* block address */
271} __packed;
272
273struct f2fs_nat_block {
274 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
275} __packed;
276
277/*
278 * For SIT entries
279 *
280 * Each segment is 2MB in size by default so that a bitmap for validity of
281 * there-in blocks should occupy 64 bytes, 512 bits.
282 * Not allow to change this.
283 */
284#define SIT_VBLOCK_MAP_SIZE 64
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300285#define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900286
287/*
288 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
289 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
290 * [9:0] : valid block count
291 */
292#define SIT_VBLOCKS_SHIFT 10
293#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
294#define GET_SIT_VBLOCKS(raw_sit) \
295 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
296#define GET_SIT_TYPE(raw_sit) \
297 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
298 >> SIT_VBLOCKS_SHIFT)
299
300struct f2fs_sit_entry {
301 __le16 vblocks; /* reference above */
302 __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; /* bitmap for valid blocks */
303 __le64 mtime; /* segment age for cleaning */
304} __packed;
305
306struct f2fs_sit_block {
307 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
308} __packed;
309
310/*
311 * For segment summary
312 *
313 * One summary block contains exactly 512 summary entries, which represents
314 * exactly 2MB segment by default. Not allow to change the basic units.
315 *
316 * NOTE: For initializing fields, you must use set_summary
317 *
318 * - If data page, nid represents dnode's nid
319 * - If node page, nid represents the node page's nid.
320 *
321 * The ofs_in_node is used by only data page. It represents offset
322 * from node's page's beginning to get a data block address.
323 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
324 */
325#define ENTRIES_IN_SUM 512
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900326#define SUMMARY_SIZE (7) /* sizeof(struct summary) */
327#define SUM_FOOTER_SIZE (5) /* sizeof(struct summary_footer) */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900328#define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
329
330/* a summary entry for a 4KB-sized block in a segment */
331struct f2fs_summary {
332 __le32 nid; /* parent node id */
333 union {
334 __u8 reserved[3];
335 struct {
336 __u8 version; /* node version number */
337 __le16 ofs_in_node; /* block index in parent node */
338 } __packed;
339 };
340} __packed;
341
342/* summary block type, node or data, is stored to the summary_footer */
343#define SUM_TYPE_NODE (1)
344#define SUM_TYPE_DATA (0)
345
346struct summary_footer {
347 unsigned char entry_type; /* SUM_TYPE_XXX */
Sheng Yong479c8bc2016-01-28 11:40:26 +0000348 __le32 check_sum; /* summary checksum */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900349} __packed;
350
Jaegeuk Kim25ca9232012-11-28 16:12:41 +0900351#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900352 SUM_ENTRY_SIZE)
353#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
354 sizeof(struct nat_journal_entry))
355#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
356 sizeof(struct nat_journal_entry))
357#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
358 sizeof(struct sit_journal_entry))
359#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
360 sizeof(struct sit_journal_entry))
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800361
362/* Reserved area should make size of f2fs_extra_info equals to
363 * that of nat_journal and sit_journal.
364 */
365#define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
366
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900367/*
368 * frequently updated NAT/SIT entries can be stored in the spare area in
369 * summary blocks
370 */
371enum {
372 NAT_JOURNAL = 0,
373 SIT_JOURNAL
374};
375
376struct nat_journal_entry {
377 __le32 nid;
378 struct f2fs_nat_entry ne;
379} __packed;
380
381struct nat_journal {
382 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
383 __u8 reserved[NAT_JOURNAL_RESERVED];
384} __packed;
385
386struct sit_journal_entry {
387 __le32 segno;
388 struct f2fs_sit_entry se;
389} __packed;
390
391struct sit_journal {
392 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
393 __u8 reserved[SIT_JOURNAL_RESERVED];
394} __packed;
395
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800396struct f2fs_extra_info {
397 __le64 kbytes_written;
398 __u8 reserved[EXTRA_INFO_RESERVED];
399} __packed;
400
Chao Yudfc08a12016-02-14 18:50:40 +0800401struct f2fs_journal {
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900402 union {
403 __le16 n_nats;
404 __le16 n_sits;
405 };
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800406 /* spare area is used by NAT or SIT journals or extra info */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900407 union {
408 struct nat_journal nat_j;
409 struct sit_journal sit_j;
Shuoran Liu8f1dbbb2016-01-27 09:57:30 +0800410 struct f2fs_extra_info info;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900411 };
Chao Yudfc08a12016-02-14 18:50:40 +0800412} __packed;
413
414/* 4KB-sized summary block structure */
415struct f2fs_summary_block {
416 struct f2fs_summary entries[ENTRIES_IN_SUM];
417 struct f2fs_journal journal;
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900418 struct summary_footer footer;
419} __packed;
420
421/*
422 * For directory operations
423 */
424#define F2FS_DOT_HASH 0
425#define F2FS_DDOT_HASH F2FS_DOT_HASH
426#define F2FS_MAX_HASH (~((0x3ULL) << 62))
427#define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
428
429typedef __le32 f2fs_hash_t;
430
431/* One directory entry slot covers 8bytes-long file name */
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900432#define F2FS_SLOT_LEN 8
433#define F2FS_SLOT_LEN_BITS 3
Namjae Jeon457d08e2012-12-08 14:54:50 +0900434
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900435#define GET_DENTRY_SLOTS(x) ((x + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900436
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900437/* MAX level for dir lookup */
438#define MAX_DIR_HASH_DEPTH 63
439
Chao Yubfec07d2014-05-28 08:56:09 +0800440/* MAX buckets in one level of dir */
441#define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
442
Chao Yuc031f6a2015-08-19 19:02:02 +0800443/*
444 * space utilization of regular dentry and inline dentry
445 * regular dentry inline dentry
446 * bitmap 1 * 27 = 27 1 * 23 = 23
447 * reserved 1 * 3 = 3 1 * 7 = 7
448 * dentry 11 * 214 = 2354 11 * 182 = 2002
449 * filename 8 * 214 = 1712 8 * 182 = 1456
450 * total 4096 3488
451 *
452 * Note: there are more reserved space in inline dentry than in regular
453 * dentry, when converting inline dentry we should handle this carefully.
454 */
455#define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900456#define SIZE_OF_DIR_ENTRY 11 /* by byte */
457#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
458 BITS_PER_BYTE)
459#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900460 F2FS_SLOT_LEN) * \
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900461 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
462
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900463/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900464struct f2fs_dir_entry {
465 __le32 hash_code; /* hash code of file name */
466 __le32 ino; /* inode number */
467 __le16 name_len; /* lengh of file name */
468 __u8 file_type; /* file type */
469} __packed;
470
471/* 4KB-sized directory entry block */
472struct f2fs_dentry_block {
473 /* validity bitmap for directory entries in each block */
474 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
475 __u8 reserved[SIZE_OF_RESERVED];
476 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
Jaegeuk Kim5a20d332013-03-03 13:58:05 +0900477 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900478} __packed;
479
Chao Yu34d67de2014-09-24 18:15:19 +0800480/* for inline dir */
481#define NR_INLINE_DENTRY (MAX_INLINE_DATA * BITS_PER_BYTE / \
482 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
483 BITS_PER_BYTE + 1))
484#define INLINE_DENTRY_BITMAP_SIZE ((NR_INLINE_DENTRY + \
485 BITS_PER_BYTE - 1) / BITS_PER_BYTE)
486#define INLINE_RESERVED_SIZE (MAX_INLINE_DATA - \
487 ((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
488 NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))
489
490/* inline directory entry structure */
491struct f2fs_inline_dentry {
492 __u8 dentry_bitmap[INLINE_DENTRY_BITMAP_SIZE];
493 __u8 reserved[INLINE_RESERVED_SIZE];
494 struct f2fs_dir_entry dentry[NR_INLINE_DENTRY];
495 __u8 filename[NR_INLINE_DENTRY][F2FS_SLOT_LEN];
496} __packed;
497
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900498/* file types used in inode_info->flags */
499enum {
500 F2FS_FT_UNKNOWN,
501 F2FS_FT_REG_FILE,
502 F2FS_FT_DIR,
503 F2FS_FT_CHRDEV,
504 F2FS_FT_BLKDEV,
505 F2FS_FT_FIFO,
506 F2FS_FT_SOCK,
507 F2FS_FT_SYMLINK,
508 F2FS_FT_MAX
509};
510
Chao Yu675f10b2016-02-22 18:29:18 +0800511#define S_SHIFT 12
512
Jaegeuk Kimdd318662012-11-02 17:06:26 +0900513#endif /* _LINUX_F2FS_FS_H */