[mirror_ubuntu-bionic-kernel.git] / include / linux / f2fs_fs.h

/**
 * include/linux/f2fs_fs.h
 *
 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *             http://www.samsung.com/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef _LINUX_F2FS_FS_H
#define _LINUX_F2FS_FS_H

#include <linux/pagemap.h>
#include <linux/types.h>

#define F2FS_SUPER_OFFSET		1024	/* byte-size offset */
#define F2FS_MIN_LOG_SECTOR_SIZE	9	/* 9 bits for 512 bytes */
#define F2FS_MAX_LOG_SECTOR_SIZE	12	/* 12 bits for 4096 bytes */
#define F2FS_LOG_SECTORS_PER_BLOCK	3	/* log number for sector/blk */
#define F2FS_BLKSIZE			4096	/* support only 4KB block */
#define F2FS_BLKSIZE_BITS		12	/* bits for F2FS_BLKSIZE */
#define F2FS_MAX_EXTENSION		64	/* # of extension entries */
#define F2FS_BLK_ALIGN(x)	(((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS)

#define NULL_ADDR		((block_t)0)	/* used as block_t addresses */
#define NEW_ADDR		((block_t)-1)	/* used as block_t addresses */

#define F2FS_BYTES_TO_BLK(bytes)	((bytes) >> F2FS_BLKSIZE_BITS)
#define F2FS_BLK_TO_BYTES(blk)		((blk) << F2FS_BLKSIZE_BITS)

/* 0, 1(node nid), 2(meta nid) are reserved node id */
#define F2FS_RESERVED_NODE_NUM		3

#define F2FS_ROOT_INO(sbi)	((sbi)->root_ino_num)
#define F2FS_NODE_INO(sbi)	((sbi)->node_ino_num)
#define F2FS_META_INO(sbi)	((sbi)->meta_ino_num)

#define F2FS_MAX_QUOTAS		3

#define F2FS_IO_SIZE(sbi)	(1 << (sbi)->write_io_size_bits) /* Blocks */
#define F2FS_IO_SIZE_KB(sbi)	(1 << ((sbi)->write_io_size_bits + 2)) /* KB */
#define F2FS_IO_SIZE_BYTES(sbi)	(1 << ((sbi)->write_io_size_bits + 12)) /* B */
#define F2FS_IO_SIZE_BITS(sbi)	((sbi)->write_io_size_bits) /* power of 2 */
#define F2FS_IO_SIZE_MASK(sbi)	(F2FS_IO_SIZE(sbi) - 1)

/* This flag is used by node and meta inodes, and by recovery */
#define GFP_F2FS_ZERO		(GFP_NOFS | __GFP_ZERO)
#define GFP_F2FS_HIGH_ZERO	(GFP_NOFS | __GFP_ZERO | __GFP_HIGHMEM)

/*
 * For further optimization on multi-head logs, on-disk layout supports maximum
 * 16 logs by default. The number, 16, is expected to cover all the cases
 * enoughly. The implementaion currently uses no more than 6 logs.
 * Half the logs are used for nodes, and the other half are used for data.
 */
#define MAX_ACTIVE_LOGS	16
#define MAX_ACTIVE_NODE_LOGS	8
#define MAX_ACTIVE_DATA_LOGS	8

#define VERSION_LEN	256
#define MAX_VOLUME_NAME		512
#define MAX_PATH_LEN		64
#define MAX_DEVICES		8

/*
 * For superblock
 */
struct f2fs_device {
	__u8 path[MAX_PATH_LEN];
	__le32 total_segments;
} __packed;

struct f2fs_super_block {
	__le32 magic;			/* Magic Number */
	__le16 major_ver;		/* Major Version */
	__le16 minor_ver;		/* Minor Version */
	__le32 log_sectorsize;		/* log2 sector size in bytes */
	__le32 log_sectors_per_block;	/* log2 # of sectors per block */
	__le32 log_blocksize;		/* log2 block size in bytes */
	__le32 log_blocks_per_seg;	/* log2 # of blocks per segment */
	__le32 segs_per_sec;		/* # of segments per section */
	__le32 secs_per_zone;		/* # of sections per zone */
	__le32 checksum_offset;		/* checksum offset inside super block */
	__le64 block_count;		/* total # of user blocks */
	__le32 section_count;		/* total # of sections */
	__le32 segment_count;		/* total # of segments */
	__le32 segment_count_ckpt;	/* # of segments for checkpoint */
	__le32 segment_count_sit;	/* # of segments for SIT */
	__le32 segment_count_nat;	/* # of segments for NAT */
	__le32 segment_count_ssa;	/* # of segments for SSA */
	__le32 segment_count_main;	/* # of segments for main area */
	__le32 segment0_blkaddr;	/* start block address of segment 0 */
	__le32 cp_blkaddr;		/* start block address of checkpoint */
	__le32 sit_blkaddr;		/* start block address of SIT */
	__le32 nat_blkaddr;		/* start block address of NAT */
	__le32 ssa_blkaddr;		/* start block address of SSA */
	__le32 main_blkaddr;		/* start block address of main area */
	__le32 root_ino;		/* root inode number */
	__le32 node_ino;		/* node inode number */
	__le32 meta_ino;		/* meta inode number */
	__u8 uuid[16];			/* 128-bit uuid for volume */
	__le16 volume_name[MAX_VOLUME_NAME];	/* volume name */
	__le32 extension_count;		/* # of extensions below */
	__u8 extension_list[F2FS_MAX_EXTENSION][8];	/* extension array */
	__le32 cp_payload;
	__u8 version[VERSION_LEN];	/* the kernel version */
	__u8 init_version[VERSION_LEN];	/* the initial kernel version */
	__le32 feature;			/* defined features */
	__u8 encryption_level;		/* versioning level for encryption */
	__u8 encrypt_pw_salt[16];	/* Salt used for string2key algorithm */
	struct f2fs_device devs[MAX_DEVICES];	/* device list */
	__le32 qf_ino[F2FS_MAX_QUOTAS];	/* quota inode numbers */
	__u8 reserved[315];		/* valid reserved region */
} __packed;

/*
 * For checkpoint
 */
#define CP_TRIMMED_FLAG		0x00000100
#define CP_NAT_BITS_FLAG	0x00000080
#define CP_CRC_RECOVERY_FLAG	0x00000040
#define CP_FASTBOOT_FLAG	0x00000020
#define CP_FSCK_FLAG		0x00000010
#define CP_ERROR_FLAG		0x00000008
#define CP_COMPACT_SUM_FLAG	0x00000004
#define CP_ORPHAN_PRESENT_FLAG	0x00000002
#define CP_UMOUNT_FLAG		0x00000001

#define F2FS_CP_PACKS		2	/* # of checkpoint packs */

struct f2fs_checkpoint {
	__le64 checkpoint_ver;		/* checkpoint block version number */
	__le64 user_block_count;	/* # of user blocks */
	__le64 valid_block_count;	/* # of valid blocks in main area */
	__le32 rsvd_segment_count;	/* # of reserved segments for gc */
	__le32 overprov_segment_count;	/* # of overprovision segments */
	__le32 free_segment_count;	/* # of free segments in main area */

	/* information of current node segments */
	__le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
	__le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
	/* information of current data segments */
	__le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
	__le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
	__le32 ckpt_flags;		/* Flags : umount and journal_present */
	__le32 cp_pack_total_block_count;	/* total # of one cp pack */
	__le32 cp_pack_start_sum;	/* start block number of data summary */
	__le32 valid_node_count;	/* Total number of valid nodes */
	__le32 valid_inode_count;	/* Total number of valid inodes */
	__le32 next_free_nid;		/* Next free node number */
	__le32 sit_ver_bitmap_bytesize;	/* Default value 64 */
	__le32 nat_ver_bitmap_bytesize; /* Default value 256 */
	__le32 checksum_offset;		/* checksum offset inside cp block */
	__le64 elapsed_time;		/* mounted time */
	/* allocation type of current segment */
	unsigned char alloc_type[MAX_ACTIVE_LOGS];

	/* SIT and NAT version bitmap */
	unsigned char sit_nat_version_bitmap[1];
} __packed;

/*
 * For orphan inode management
 */
#define F2FS_ORPHANS_PER_BLOCK	1020

#define GET_ORPHAN_BLOCKS(n)	(((n) + F2FS_ORPHANS_PER_BLOCK - 1) / \
					F2FS_ORPHANS_PER_BLOCK)

struct f2fs_orphan_block {
	__le32 ino[F2FS_ORPHANS_PER_BLOCK];	/* inode numbers */
	__le32 reserved;	/* reserved */
	__le16 blk_addr;	/* block index in current CP */
	__le16 blk_count;	/* Number of orphan inode blocks in CP */
	__le32 entry_count;	/* Total number of orphan nodes in current CP */
	__le32 check_sum;	/* CRC32 for orphan inode block */
} __packed;

/*
 * For NODE structure
 */
struct f2fs_extent {
	__le32 fofs;		/* start file offset of the extent */
	__le32 blk;		/* start block address of the extent */
	__le32 len;		/* lengh of the extent */
} __packed;

#define F2FS_NAME_LEN		255
/* 200 bytes for inline xattrs by default */
#define DEFAULT_INLINE_XATTR_ADDRS	50
#define DEF_ADDRS_PER_INODE	923	/* Address Pointers in an Inode */
#define CUR_ADDRS_PER_INODE(inode)	(DEF_ADDRS_PER_INODE - \
					get_extra_isize(inode))
#define DEF_NIDS_PER_INODE	5	/* Node IDs in an Inode */
#define ADDRS_PER_INODE(inode)	addrs_per_inode(inode)
#define ADDRS_PER_BLOCK		1018	/* Address Pointers in a Direct Block */
#define NIDS_PER_BLOCK		1018	/* Node IDs in an Indirect Block */

#define ADDRS_PER_PAGE(page, inode)	\
	(IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK)

#define	NODE_DIR1_BLOCK		(DEF_ADDRS_PER_INODE + 1)
#define	NODE_DIR2_BLOCK		(DEF_ADDRS_PER_INODE + 2)
#define	NODE_IND1_BLOCK		(DEF_ADDRS_PER_INODE + 3)
#define	NODE_IND2_BLOCK		(DEF_ADDRS_PER_INODE + 4)
#define	NODE_DIND_BLOCK		(DEF_ADDRS_PER_INODE + 5)

#define F2FS_INLINE_XATTR	0x01	/* file inline xattr flag */
#define F2FS_INLINE_DATA	0x02	/* file inline data flag */
#define F2FS_INLINE_DENTRY	0x04	/* file inline dentry flag */
#define F2FS_DATA_EXIST		0x08	/* file inline data exist flag */
#define F2FS_INLINE_DOTS	0x10	/* file having implicit dot dentries */
#define F2FS_EXTRA_ATTR		0x20	/* file having extra attribute */

struct f2fs_inode {
	__le16 i_mode;			/* file mode */
	__u8 i_advise;			/* file hints */
	__u8 i_inline;			/* file inline flags */
	__le32 i_uid;			/* user ID */
	__le32 i_gid;			/* group ID */
	__le32 i_links;			/* links count */
	__le64 i_size;			/* file size in bytes */
	__le64 i_blocks;		/* file size in blocks */
	__le64 i_atime;			/* access time */
	__le64 i_ctime;			/* change time */
	__le64 i_mtime;			/* modification time */
	__le32 i_atime_nsec;		/* access time in nano scale */
	__le32 i_ctime_nsec;		/* change time in nano scale */
	__le32 i_mtime_nsec;		/* modification time in nano scale */
	__le32 i_generation;		/* file version (for NFS) */
	__le32 i_current_depth;		/* only for directory depth */
	__le32 i_xattr_nid;		/* nid to save xattr */
	__le32 i_flags;			/* file attributes */
	__le32 i_pino;			/* parent inode number */
	__le32 i_namelen;		/* file name length */
	__u8 i_name[F2FS_NAME_LEN];	/* file name for SPOR */
	__u8 i_dir_level;		/* dentry_level for large dir */

	struct f2fs_extent i_ext;	/* caching a largest extent */

	union {
		struct {
			__le16 i_extra_isize;	/* extra inode attribute size */
			__le16 i_inline_xattr_size;	/* inline xattr size, unit: 4 bytes */
			__le32 i_projid;	/* project id */
			__le32 i_inode_checksum;/* inode meta checksum */
			__le32 i_extra_end[0];	/* for attribute size calculation */
		};
		__le32 i_addr[DEF_ADDRS_PER_INODE];	/* Pointers to data blocks */
	};
	__le32 i_nid[DEF_NIDS_PER_INODE];	/* direct(2), indirect(2),
						double_indirect(1) node id */
} __packed;

struct direct_node {
	__le32 addr[ADDRS_PER_BLOCK];	/* array of data block address */
} __packed;

struct indirect_node {
	__le32 nid[NIDS_PER_BLOCK];	/* array of data block address */
} __packed;

enum {
	COLD_BIT_SHIFT = 0,
	FSYNC_BIT_SHIFT,
	DENT_BIT_SHIFT,
	OFFSET_BIT_SHIFT
};

#define OFFSET_BIT_MASK		(0x07)	/* (0x01 << OFFSET_BIT_SHIFT) - 1 */

struct node_footer {
	__le32 nid;		/* node id */
	__le32 ino;		/* inode nunmber */
	__le32 flag;		/* include cold/fsync/dentry marks and offset */
	__le64 cp_ver;		/* checkpoint version */
	__le32 next_blkaddr;	/* next node page block address */
} __packed;

struct f2fs_node {
	/* can be one of three types: inode, direct, and indirect types */
	union {
		struct f2fs_inode i;
		struct direct_node dn;
		struct indirect_node in;
	};
	struct node_footer footer;
} __packed;

/*
 * For NAT entries
 */
#define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
#define NAT_ENTRY_BITMAP_SIZE	((NAT_ENTRY_PER_BLOCK + 7) / 8)

struct f2fs_nat_entry {
	__u8 version;		/* latest version of cached nat entry */
	__le32 ino;		/* inode number */
	__le32 block_addr;	/* block address */
} __packed;

struct f2fs_nat_block {
	struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
} __packed;

/*
 * For SIT entries
 *
 * Each segment is 2MB in size by default so that a bitmap for validity of
 * there-in blocks should occupy 64 bytes, 512 bits.
 * Not allow to change this.
 */
#define SIT_VBLOCK_MAP_SIZE 64
#define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))

/*
 * F2FS uses 4 bytes to represent block address. As a result, supported size of
 * disk is 16 TB and it equals to 16 * 1024 * 1024 / 2 segments.
 */
#define F2FS_MAX_SEGMENT       ((16 * 1024 * 1024) / 2)

/*
 * Note that f2fs_sit_entry->vblocks has the following bit-field information.
 * [15:10] : allocation type such as CURSEG_XXXX_TYPE
 * [9:0] : valid block count
 */
#define SIT_VBLOCKS_SHIFT	10
#define SIT_VBLOCKS_MASK	((1 << SIT_VBLOCKS_SHIFT) - 1)
#define GET_SIT_VBLOCKS(raw_sit)				\
	(le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
#define GET_SIT_TYPE(raw_sit)					\
	((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK)	\
	 >> SIT_VBLOCKS_SHIFT)

struct f2fs_sit_entry {
	__le16 vblocks;				/* reference above */
	__u8 valid_map[SIT_VBLOCK_MAP_SIZE];	/* bitmap for valid blocks */
	__le64 mtime;				/* segment age for cleaning */
} __packed;

struct f2fs_sit_block {
	struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
} __packed;

/*
 * For segment summary
 *
 * One summary block contains exactly 512 summary entries, which represents
 * exactly 2MB segment by default. Not allow to change the basic units.
 *
 * NOTE: For initializing fields, you must use set_summary
 *
 * - If data page, nid represents dnode's nid
 * - If node page, nid represents the node page's nid.
 *
 * The ofs_in_node is used by only data page. It represents offset
 * from node's page's beginning to get a data block address.
 * ex) data_blkaddr = (block_t)(nodepage_start_address + ofs_in_node)
 */
#define ENTRIES_IN_SUM		512
#define	SUMMARY_SIZE		(7)	/* sizeof(struct summary) */
#define	SUM_FOOTER_SIZE		(5)	/* sizeof(struct summary_footer) */
#define SUM_ENTRY_SIZE		(SUMMARY_SIZE * ENTRIES_IN_SUM)

/* a summary entry for a 4KB-sized block in a segment */
struct f2fs_summary {
	__le32 nid;		/* parent node id */
	union {
		__u8 reserved[3];
		struct {
			__u8 version;		/* node version number */
			__le16 ofs_in_node;	/* block index in parent node */
		} __packed;
	};
} __packed;

/* summary block type, node or data, is stored to the summary_footer */
#define SUM_TYPE_NODE		(1)
#define SUM_TYPE_DATA		(0)

struct summary_footer {
	unsigned char entry_type;	/* SUM_TYPE_XXX */
	__le32 check_sum;		/* summary checksum */
} __packed;

#define SUM_JOURNAL_SIZE	(F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
				SUM_ENTRY_SIZE)
#define NAT_JOURNAL_ENTRIES	((SUM_JOURNAL_SIZE - 2) /\
				sizeof(struct nat_journal_entry))
#define NAT_JOURNAL_RESERVED	((SUM_JOURNAL_SIZE - 2) %\
				sizeof(struct nat_journal_entry))
#define SIT_JOURNAL_ENTRIES	((SUM_JOURNAL_SIZE - 2) /\
				sizeof(struct sit_journal_entry))
#define SIT_JOURNAL_RESERVED	((SUM_JOURNAL_SIZE - 2) %\
				sizeof(struct sit_journal_entry))

/* Reserved area should make size of f2fs_extra_info equals to
 * that of nat_journal and sit_journal.
 */
#define EXTRA_INFO_RESERVED	(SUM_JOURNAL_SIZE - 2 - 8)

/*
 * frequently updated NAT/SIT entries can be stored in the spare area in
 * summary blocks
 */
enum {
	NAT_JOURNAL = 0,
	SIT_JOURNAL
};

struct nat_journal_entry {
	__le32 nid;
	struct f2fs_nat_entry ne;
} __packed;

struct nat_journal {
	struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
	__u8 reserved[NAT_JOURNAL_RESERVED];
} __packed;

struct sit_journal_entry {
	__le32 segno;
	struct f2fs_sit_entry se;
} __packed;

struct sit_journal {
	struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
	__u8 reserved[SIT_JOURNAL_RESERVED];
} __packed;

struct f2fs_extra_info {
	__le64 kbytes_written;
	__u8 reserved[EXTRA_INFO_RESERVED];
} __packed;

struct f2fs_journal {
	union {
		__le16 n_nats;
		__le16 n_sits;
	};
	/* spare area is used by NAT or SIT journals or extra info */
	union {
		struct nat_journal nat_j;
		struct sit_journal sit_j;
		struct f2fs_extra_info info;
	};
} __packed;

/* 4KB-sized summary block structure */
struct f2fs_summary_block {
	struct f2fs_summary entries[ENTRIES_IN_SUM];
	struct f2fs_journal journal;
	struct summary_footer footer;
} __packed;

/*
 * For directory operations
 */
#define F2FS_DOT_HASH		0
#define F2FS_DDOT_HASH		F2FS_DOT_HASH
#define F2FS_MAX_HASH		(~((0x3ULL) << 62))
#define F2FS_HASH_COL_BIT	((0x1ULL) << 63)

typedef __le32	f2fs_hash_t;

/* One directory entry slot covers 8bytes-long file name */
#define F2FS_SLOT_LEN		8
#define F2FS_SLOT_LEN_BITS	3

#define GET_DENTRY_SLOTS(x) (((x) + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)

/* MAX level for dir lookup */
#define MAX_DIR_HASH_DEPTH	63

/* MAX buckets in one level of dir */
#define MAX_DIR_BUCKETS		(1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))

/*
 * space utilization of regular dentry and inline dentry (w/o extra reservation)
 *		regular dentry			inline dentry
 * bitmap	1 * 27 = 27			1 * 23 = 23
 * reserved	1 * 3 = 3			1 * 7 = 7
 * dentry	11 * 214 = 2354			11 * 182 = 2002
 * filename	8 * 214 = 1712			8 * 182 = 1456
 * total	4096				3488
 *
 * Note: there are more reserved space in inline dentry than in regular
 * dentry, when converting inline dentry we should handle this carefully.
 */
#define NR_DENTRY_IN_BLOCK	214	/* the number of dentry in a block */
#define SIZE_OF_DIR_ENTRY	11	/* by byte */
#define SIZE_OF_DENTRY_BITMAP	((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
					BITS_PER_BYTE)
#define SIZE_OF_RESERVED	(PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
				F2FS_SLOT_LEN) * \
				NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))

/* One directory entry slot representing F2FS_SLOT_LEN-sized file name */
struct f2fs_dir_entry {
	__le32 hash_code;	/* hash code of file name */
	__le32 ino;		/* inode number */
	__le16 name_len;	/* lengh of file name */
	__u8 file_type;		/* file type */
} __packed;

/* 4KB-sized directory entry block */
struct f2fs_dentry_block {
	/* validity bitmap for directory entries in each block */
	__u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
	__u8 reserved[SIZE_OF_RESERVED];
	struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
	__u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
} __packed;

/* file types used in inode_info->flags */
enum {
	F2FS_FT_UNKNOWN,
	F2FS_FT_REG_FILE,
	F2FS_FT_DIR,
	F2FS_FT_CHRDEV,
	F2FS_FT_BLKDEV,
	F2FS_FT_FIFO,
	F2FS_FT_SOCK,
	F2FS_FT_SYMLINK,
	F2FS_FT_MAX
};

#define S_SHIFT 12

#define	F2FS_DEF_PROJID		0	/* default project ID */

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