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

source code of linux/include/linux/f2fs_fs.h