[mirror_ubuntu-artful-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_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 */
	__u8 reserved[327];		/* 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
#define F2FS_INLINE_XATTR_ADDRS	50	/* 200 bytes for inline xattrs */
#define DEF_ADDRS_PER_INODE	923	/* Address Pointers in an 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 MAX_INLINE_DATA		(sizeof(__le32) * (DEF_ADDRS_PER_INODE - \
						F2FS_INLINE_XATTR_ADDRS - 1))

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 */

	__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
 *		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;

/* for inline dir */
#define NR_INLINE_DENTRY	(MAX_INLINE_DATA * BITS_PER_BYTE / \
				((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
				BITS_PER_BYTE + 1))
#define INLINE_DENTRY_BITMAP_SIZE	((NR_INLINE_DENTRY + \
					BITS_PER_BYTE - 1) / BITS_PER_BYTE)
#define INLINE_RESERVED_SIZE	(MAX_INLINE_DATA - \
				((SIZE_OF_DIR_ENTRY + F2FS_SLOT_LEN) * \
				NR_INLINE_DENTRY + INLINE_DENTRY_BITMAP_SIZE))

/* inline directory entry structure */
struct f2fs_inline_dentry {
	__u8 dentry_bitmap[INLINE_DENTRY_BITMAP_SIZE];
	__u8 reserved[INLINE_RESERVED_SIZE];
	struct f2fs_dir_entry dentry[NR_INLINE_DENTRY];
	__u8 filename[NR_INLINE_DENTRY][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

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