[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_MAX_EXTENSION		64	/* # of extension entries */
#define F2FS_BLK_ALIGN(x)	(((x) + F2FS_BLKSIZE - 1) / F2FS_BLKSIZE)

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

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

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

/*
 * For superblock
 */
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[512];	/* volume name */
	__le32 extension_count;		/* # of extensions below */
	__u8 extension_list[F2FS_MAX_EXTENSION][8];	/* extension array */
	__le32 cp_payload;
} __packed;

/*
 * For checkpoint
 */
#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_addr;	/* 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(fi)	addrs_per_inode(fi)
#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, fi)	\
	(IS_INODE(page) ? ADDRS_PER_INODE(fi) : 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 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_CACHE_SIZE / sizeof(struct f2fs_nat_entry))

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_CACHE_SIZE / sizeof(struct f2fs_sit_entry))

/*
 * 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 */
	__u32 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))
/*
 * 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;

/* 4KB-sized summary block structure */
struct f2fs_summary_block {
	struct f2fs_summary entries[ENTRIES_IN_SUM];
	union {
		__le16 n_nats;
		__le16 n_sits;
	};
	/* spare area is used by NAT or SIT journals */
	union {
		struct nat_journal nat_j;
		struct sit_journal sit_j;
	};
	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)

/* the number of dentry in a block */
#define NR_DENTRY_IN_BLOCK	214

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

#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
};

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