[linux-2.6-block.git] / fs / squashfs / squashfs_fs.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef SQUASHFS_FS
#define SQUASHFS_FS
/*
 * Squashfs
 *
 * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
 * Phillip Lougher <phillip@squashfs.org.uk>
 *
 * squashfs_fs.h
 */

#define SQUASHFS_CACHED_FRAGMENTS	CONFIG_SQUASHFS_FRAGMENT_CACHE_SIZE
#define SQUASHFS_MAJOR			4
#define SQUASHFS_MINOR			0
#define SQUASHFS_START			0

/* size of metadata (inode and directory) blocks */
#define SQUASHFS_METADATA_SIZE		8192

/* default size of block device I/O */
#ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
#define SQUASHFS_DEVBLK_SIZE 4096
#else
#define SQUASHFS_DEVBLK_SIZE 1024
#endif

#define SQUASHFS_FILE_MAX_SIZE		1048576
#define SQUASHFS_FILE_MAX_LOG		20

/* Max length of filename (not 255) */
#define SQUASHFS_NAME_LEN		256

/* Max value for directory header count*/
#define SQUASHFS_DIR_COUNT		256

#define SQUASHFS_INVALID_FRAG		(0xffffffffU)
#define SQUASHFS_INVALID_XATTR		(0xffffffffU)
#define SQUASHFS_INVALID_BLK		(-1LL)

/* Filesystem flags */
#define SQUASHFS_NOI			0
#define SQUASHFS_NOD			1
#define SQUASHFS_NOF			3
#define SQUASHFS_NO_FRAG		4
#define SQUASHFS_ALWAYS_FRAG		5
#define SQUASHFS_DUPLICATE		6
#define SQUASHFS_EXPORT			7
#define SQUASHFS_COMP_OPT		10

#define SQUASHFS_BIT(flag, bit)		((flag >> bit) & 1)

#define SQUASHFS_UNCOMPRESSED_INODES(flags)	SQUASHFS_BIT(flags, \
						SQUASHFS_NOI)

#define SQUASHFS_UNCOMPRESSED_DATA(flags)	SQUASHFS_BIT(flags, \
						SQUASHFS_NOD)

#define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags)	SQUASHFS_BIT(flags, \
						SQUASHFS_NOF)

#define SQUASHFS_NO_FRAGMENTS(flags)		SQUASHFS_BIT(flags, \
						SQUASHFS_NO_FRAG)

#define SQUASHFS_ALWAYS_FRAGMENTS(flags)	SQUASHFS_BIT(flags, \
						SQUASHFS_ALWAYS_FRAG)

#define SQUASHFS_DUPLICATES(flags)		SQUASHFS_BIT(flags, \
						SQUASHFS_DUPLICATE)

#define SQUASHFS_EXPORTABLE(flags)		SQUASHFS_BIT(flags, \
						SQUASHFS_EXPORT)

#define SQUASHFS_COMP_OPTS(flags)		SQUASHFS_BIT(flags, \
						SQUASHFS_COMP_OPT)

/* Inode types including extended types */
#define SQUASHFS_DIR_TYPE		1
#define SQUASHFS_REG_TYPE		2
#define SQUASHFS_SYMLINK_TYPE		3
#define SQUASHFS_BLKDEV_TYPE		4
#define SQUASHFS_CHRDEV_TYPE		5
#define SQUASHFS_FIFO_TYPE		6
#define SQUASHFS_SOCKET_TYPE		7
#define SQUASHFS_LDIR_TYPE		8
#define SQUASHFS_LREG_TYPE		9
#define SQUASHFS_LSYMLINK_TYPE		10
#define SQUASHFS_LBLKDEV_TYPE		11
#define SQUASHFS_LCHRDEV_TYPE		12
#define SQUASHFS_LFIFO_TYPE		13
#define SQUASHFS_LSOCKET_TYPE		14

/* Max type value stored in directory entry */
#define SQUASHFS_MAX_DIR_TYPE		7

/* Xattr types */
#define SQUASHFS_XATTR_USER             0
#define SQUASHFS_XATTR_TRUSTED          1
#define SQUASHFS_XATTR_SECURITY         2
#define SQUASHFS_XATTR_VALUE_OOL        256
#define SQUASHFS_XATTR_PREFIX_MASK      0xff

/* Flag whether block is compressed or uncompressed, bit is set if block is
 * uncompressed */
#define SQUASHFS_COMPRESSED_BIT		(1 << 15)

#define SQUASHFS_COMPRESSED_SIZE(B)	(((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
		(B) & ~SQUASHFS_COMPRESSED_BIT :  SQUASHFS_COMPRESSED_BIT)

#define SQUASHFS_COMPRESSED(B)		(!((B) & SQUASHFS_COMPRESSED_BIT))

#define SQUASHFS_COMPRESSED_BIT_BLOCK	(1 << 24)

#define SQUASHFS_COMPRESSED_SIZE_BLOCK(B)	((B) & \
						~SQUASHFS_COMPRESSED_BIT_BLOCK)

#define SQUASHFS_COMPRESSED_BLOCK(B)	(!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))

static inline int squashfs_block_size(__le32 raw)
{
	u32 size = le32_to_cpu(raw);
	return (size >> 25) ? -EIO : size;
}

/*
 * Inode number ops.  Inodes consist of a compressed block number, and an
 * uncompressed offset within that block
 */
#define SQUASHFS_INODE_BLK(A)		((unsigned int) ((A) >> 16))

#define SQUASHFS_INODE_OFFSET(A)	((unsigned int) ((A) & 0xffff))

#define SQUASHFS_MKINODE(A, B)		((long long)(((long long) (A)\
					<< 16) + (B)))

/* fragment and fragment table defines */
#define SQUASHFS_FRAGMENT_BYTES(A)	\
				((A) * sizeof(struct squashfs_fragment_entry))

#define SQUASHFS_FRAGMENT_INDEX(A)	(SQUASHFS_FRAGMENT_BYTES(A) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_FRAGMENT_INDEX_OFFSET(A)	(SQUASHFS_FRAGMENT_BYTES(A) % \
						SQUASHFS_METADATA_SIZE)

#define SQUASHFS_FRAGMENT_INDEXES(A)	((SQUASHFS_FRAGMENT_BYTES(A) + \
					SQUASHFS_METADATA_SIZE - 1) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_FRAGMENT_INDEX_BYTES(A)	(SQUASHFS_FRAGMENT_INDEXES(A) *\
						sizeof(u64))

/* inode lookup table defines */
#define SQUASHFS_LOOKUP_BYTES(A)	((A) * sizeof(u64))

#define SQUASHFS_LOOKUP_BLOCK(A)	(SQUASHFS_LOOKUP_BYTES(A) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_LOOKUP_BLOCK_OFFSET(A)	(SQUASHFS_LOOKUP_BYTES(A) % \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_LOOKUP_BLOCKS(A)	((SQUASHFS_LOOKUP_BYTES(A) + \
					SQUASHFS_METADATA_SIZE - 1) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_LOOKUP_BLOCK_BYTES(A)	(SQUASHFS_LOOKUP_BLOCKS(A) *\
					sizeof(u64))

/* uid/gid lookup table defines */
#define SQUASHFS_ID_BYTES(A)		((A) * sizeof(unsigned int))

#define SQUASHFS_ID_BLOCK(A)		(SQUASHFS_ID_BYTES(A) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_ID_BLOCK_OFFSET(A)	(SQUASHFS_ID_BYTES(A) % \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_ID_BLOCKS(A)		((SQUASHFS_ID_BYTES(A) + \
					SQUASHFS_METADATA_SIZE - 1) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_ID_BLOCK_BYTES(A)	(SQUASHFS_ID_BLOCKS(A) *\
					sizeof(u64))
/* xattr id lookup table defines */
#define SQUASHFS_XATTR_BYTES(A)		((A) * sizeof(struct squashfs_xattr_id))

#define SQUASHFS_XATTR_BLOCK(A)		(SQUASHFS_XATTR_BYTES(A) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_XATTR_BLOCK_OFFSET(A)	(SQUASHFS_XATTR_BYTES(A) % \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_XATTR_BLOCKS(A)	((SQUASHFS_XATTR_BYTES(A) + \
					SQUASHFS_METADATA_SIZE - 1) / \
					SQUASHFS_METADATA_SIZE)

#define SQUASHFS_XATTR_BLOCK_BYTES(A)	(SQUASHFS_XATTR_BLOCKS(A) *\
					sizeof(u64))
#define SQUASHFS_XATTR_BLK(A)		((unsigned int) ((A) >> 16))

#define SQUASHFS_XATTR_OFFSET(A)	((unsigned int) ((A) & 0xffff))

/* cached data constants for filesystem */
#define SQUASHFS_CACHED_BLKS		8

/* meta index cache */
#define SQUASHFS_META_INDEXES	(SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
#define SQUASHFS_META_ENTRIES	127
#define SQUASHFS_META_SLOTS	8

struct meta_entry {
	u64			data_block;
	unsigned int		index_block;
	unsigned short		offset;
	unsigned short		pad;
};

struct meta_index {
	unsigned int		inode_number;
	unsigned int		offset;
	unsigned short		entries;
	unsigned short		skip;
	unsigned short		locked;
	unsigned short		pad;
	struct meta_entry	meta_entry[SQUASHFS_META_ENTRIES];
};


/*
 * definitions for structures on disk
 */
#define ZLIB_COMPRESSION	1
#define LZMA_COMPRESSION	2
#define LZO_COMPRESSION		3
#define XZ_COMPRESSION		4
#define LZ4_COMPRESSION		5
#define ZSTD_COMPRESSION	6

struct squashfs_super_block {
	__le32			s_magic;
	__le32			inodes;
	__le32			mkfs_time;
	__le32			block_size;
	__le32			fragments;
	__le16			compression;
	__le16			block_log;
	__le16			flags;
	__le16			no_ids;
	__le16			s_major;
	__le16			s_minor;
	__le64			root_inode;
	__le64			bytes_used;
	__le64			id_table_start;
	__le64			xattr_id_table_start;
	__le64			inode_table_start;
	__le64			directory_table_start;
	__le64			fragment_table_start;
	__le64			lookup_table_start;
};

struct squashfs_dir_index {
	__le32			index;
	__le32			start_block;
	__le32			size;
	unsigned char		name[0];
};

struct squashfs_base_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
};

struct squashfs_ipc_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
};

struct squashfs_lipc_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
	__le32			xattr;
};

struct squashfs_dev_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
	__le32			rdev;
};

struct squashfs_ldev_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
	__le32			rdev;
	__le32			xattr;
};

struct squashfs_symlink_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
	__le32			symlink_size;
	char			symlink[0];
};

struct squashfs_reg_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			start_block;
	__le32			fragment;
	__le32			offset;
	__le32			file_size;
	__le16			block_list[0];
};

struct squashfs_lreg_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le64			start_block;
	__le64			file_size;
	__le64			sparse;
	__le32			nlink;
	__le32			fragment;
	__le32			offset;
	__le32			xattr;
	__le16			block_list[0];
};

struct squashfs_dir_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			start_block;
	__le32			nlink;
	__le16			file_size;
	__le16			offset;
	__le32			parent_inode;
};

struct squashfs_ldir_inode {
	__le16			inode_type;
	__le16			mode;
	__le16			uid;
	__le16			guid;
	__le32			mtime;
	__le32			inode_number;
	__le32			nlink;
	__le32			file_size;
	__le32			start_block;
	__le32			parent_inode;
	__le16			i_count;
	__le16			offset;
	__le32			xattr;
	struct squashfs_dir_index	index[0];
};

union squashfs_inode {
	struct squashfs_base_inode		base;
	struct squashfs_dev_inode		dev;
	struct squashfs_ldev_inode		ldev;
	struct squashfs_symlink_inode		symlink;
	struct squashfs_reg_inode		reg;
	struct squashfs_lreg_inode		lreg;
	struct squashfs_dir_inode		dir;
	struct squashfs_ldir_inode		ldir;
	struct squashfs_ipc_inode		ipc;
	struct squashfs_lipc_inode		lipc;
};

struct squashfs_dir_entry {
	__le16			offset;
	__le16			inode_number;
	__le16			type;
	__le16			size;
	char			name[0];
};

struct squashfs_dir_header {
	__le32			count;
	__le32			start_block;
	__le32			inode_number;
};

struct squashfs_fragment_entry {
	__le64			start_block;
	__le32			size;
	unsigned int		unused;
};

struct squashfs_xattr_entry {
	__le16			type;
	__le16			size;
	char			data[0];
};

struct squashfs_xattr_val {
	__le32			vsize;
	char			value[0];
};

struct squashfs_xattr_id {
	__le64			xattr;
	__le32			count;
	__le32			size;
};

struct squashfs_xattr_id_table {
	__le64			xattr_table_start;
	__le32			xattr_ids;
	__le32			unused;
};

#endif
Commit	Line	Data
68252eb5	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
ffae2cd7 PL	2	#ifndef SQUASHFS_FS
	3	#define SQUASHFS_FS
	4	/*
	5	* Squashfs
	6	*
	7	* Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
d7f2ff67	8	* Phillip Lougher <phillip@squashfs.org.uk>
ffae2cd7	9	*
ffae2cd7 PL	10	* squashfs_fs.h
	11	*/
	12
	13	#define SQUASHFS_CACHED_FRAGMENTS CONFIG_SQUASHFS_FRAGMENT_CACHE_SIZE
	14	#define SQUASHFS_MAJOR 4
	15	#define SQUASHFS_MINOR 0
ffae2cd7 PL	16	#define SQUASHFS_START 0
	17
	18	/* size of metadata (inode and directory) blocks */
	19	#define SQUASHFS_METADATA_SIZE 8192
ffae2cd7	20
7657cacf PL	21	/* default size of block device I/O */
	22	#ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
	23	#define SQUASHFS_DEVBLK_SIZE 4096
	24	#else
	25	#define SQUASHFS_DEVBLK_SIZE 1024
	26	#endif
	27
ffae2cd7 PL	28	#define SQUASHFS_FILE_MAX_SIZE 1048576
	29	#define SQUASHFS_FILE_MAX_LOG 20
	30
ffae2cd7 PL	31	/* Max length of filename (not 255) */
	32	#define SQUASHFS_NAME_LEN 256
	33
4826d83d AY	34	/* Max value for directory header count*/
	35	#define SQUASHFS_DIR_COUNT 256
	36
ffae2cd7	37	#define SQUASHFS_INVALID_FRAG (0xffffffffU)
f41d207c	38	#define SQUASHFS_INVALID_XATTR (0xffffffffU)
ffae2cd7 PL	39	#define SQUASHFS_INVALID_BLK (-1LL)
	40
	41	/* Filesystem flags */
	42	#define SQUASHFS_NOI 0
	43	#define SQUASHFS_NOD 1
	44	#define SQUASHFS_NOF 3
	45	#define SQUASHFS_NO_FRAG 4
	46	#define SQUASHFS_ALWAYS_FRAG 5
	47	#define SQUASHFS_DUPLICATE 6
	48	#define SQUASHFS_EXPORT 7
b7fc0ff0	49	#define SQUASHFS_COMP_OPT 10
ffae2cd7 PL	50
	51	#define SQUASHFS_BIT(flag, bit) ((flag >> bit) & 1)
	52
	53	#define SQUASHFS_UNCOMPRESSED_INODES(flags) SQUASHFS_BIT(flags, \
	54	SQUASHFS_NOI)
	55
	56	#define SQUASHFS_UNCOMPRESSED_DATA(flags) SQUASHFS_BIT(flags, \
	57	SQUASHFS_NOD)
	58
	59	#define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
	60	SQUASHFS_NOF)
	61
	62	#define SQUASHFS_NO_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
	63	SQUASHFS_NO_FRAG)
	64
	65	#define SQUASHFS_ALWAYS_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
	66	SQUASHFS_ALWAYS_FRAG)
	67
	68	#define SQUASHFS_DUPLICATES(flags) SQUASHFS_BIT(flags, \
	69	SQUASHFS_DUPLICATE)
	70
	71	#define SQUASHFS_EXPORTABLE(flags) SQUASHFS_BIT(flags, \
	72	SQUASHFS_EXPORT)
	73
b7fc0ff0 PL	74	#define SQUASHFS_COMP_OPTS(flags) SQUASHFS_BIT(flags, \
	75	SQUASHFS_COMP_OPT)
	76
9e012423	77	/* Inode types including extended types */
ffae2cd7 PL	78	#define SQUASHFS_DIR_TYPE 1
	79	#define SQUASHFS_REG_TYPE 2
	80	#define SQUASHFS_SYMLINK_TYPE 3
	81	#define SQUASHFS_BLKDEV_TYPE 4
	82	#define SQUASHFS_CHRDEV_TYPE 5
	83	#define SQUASHFS_FIFO_TYPE 6
	84	#define SQUASHFS_SOCKET_TYPE 7
	85	#define SQUASHFS_LDIR_TYPE 8
	86	#define SQUASHFS_LREG_TYPE 9
	87	#define SQUASHFS_LSYMLINK_TYPE 10
	88	#define SQUASHFS_LBLKDEV_TYPE 11
	89	#define SQUASHFS_LCHRDEV_TYPE 12
	90	#define SQUASHFS_LFIFO_TYPE 13
	91	#define SQUASHFS_LSOCKET_TYPE 14
	92
9e012423 PL	93	/* Max type value stored in directory entry */
	94	#define SQUASHFS_MAX_DIR_TYPE 7
	95
f41d207c PL	96	/* Xattr types */
	97	#define SQUASHFS_XATTR_USER 0
	98	#define SQUASHFS_XATTR_TRUSTED 1
	99	#define SQUASHFS_XATTR_SECURITY 2
	100	#define SQUASHFS_XATTR_VALUE_OOL 256
	101	#define SQUASHFS_XATTR_PREFIX_MASK 0xff
	102
ffae2cd7 PL	103	/* Flag whether block is compressed or uncompressed, bit is set if block is
	104	* uncompressed */
	105	#define SQUASHFS_COMPRESSED_BIT (1 << 15)
	106
	107	#define SQUASHFS_COMPRESSED_SIZE(B) (((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
	108	(B) & ~SQUASHFS_COMPRESSED_BIT : SQUASHFS_COMPRESSED_BIT)
	109
	110	#define SQUASHFS_COMPRESSED(B) (!((B) & SQUASHFS_COMPRESSED_BIT))
	111
	112	#define SQUASHFS_COMPRESSED_BIT_BLOCK (1 << 24)
	113
	114	#define SQUASHFS_COMPRESSED_SIZE_BLOCK(B) ((B) & \
	115	~SQUASHFS_COMPRESSED_BIT_BLOCK)
	116
	117	#define SQUASHFS_COMPRESSED_BLOCK(B) (!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))
	118
01cfb793 LT	119	static inline int squashfs_block_size(__le32 raw)
	120	{
	121	u32 size = le32_to_cpu(raw);
	122	return (size >> 25) ? -EIO : size;
	123	}
	124
ffae2cd7 PL	125	/*
	126	* Inode number ops. Inodes consist of a compressed block number, and an
	127	* uncompressed offset within that block
	128	*/
	129	#define SQUASHFS_INODE_BLK(A) ((unsigned int) ((A) >> 16))
	130
	131	#define SQUASHFS_INODE_OFFSET(A) ((unsigned int) ((A) & 0xffff))
	132
	133	#define SQUASHFS_MKINODE(A, B) ((long long)(((long long) (A)\
	134	<< 16) + (B)))
	135
ffae2cd7 PL	136	/* fragment and fragment table defines */
	137	#define SQUASHFS_FRAGMENT_BYTES(A) \
	138	((A) * sizeof(struct squashfs_fragment_entry))
	139
	140	#define SQUASHFS_FRAGMENT_INDEX(A) (SQUASHFS_FRAGMENT_BYTES(A) / \
	141	SQUASHFS_METADATA_SIZE)
	142
	143	#define SQUASHFS_FRAGMENT_INDEX_OFFSET(A) (SQUASHFS_FRAGMENT_BYTES(A) % \
	144	SQUASHFS_METADATA_SIZE)
	145
	146	#define SQUASHFS_FRAGMENT_INDEXES(A) ((SQUASHFS_FRAGMENT_BYTES(A) + \
	147	SQUASHFS_METADATA_SIZE - 1) / \
	148	SQUASHFS_METADATA_SIZE)
	149
	150	#define SQUASHFS_FRAGMENT_INDEX_BYTES(A) (SQUASHFS_FRAGMENT_INDEXES(A) *\
	151	sizeof(u64))
	152
	153	/* inode lookup table defines */
	154	#define SQUASHFS_LOOKUP_BYTES(A) ((A) * sizeof(u64))
	155
	156	#define SQUASHFS_LOOKUP_BLOCK(A) (SQUASHFS_LOOKUP_BYTES(A) / \
	157	SQUASHFS_METADATA_SIZE)
	158
	159	#define SQUASHFS_LOOKUP_BLOCK_OFFSET(A) (SQUASHFS_LOOKUP_BYTES(A) % \
	160	SQUASHFS_METADATA_SIZE)
	161
	162	#define SQUASHFS_LOOKUP_BLOCKS(A) ((SQUASHFS_LOOKUP_BYTES(A) + \
	163	SQUASHFS_METADATA_SIZE - 1) / \
	164	SQUASHFS_METADATA_SIZE)
	165
	166	#define SQUASHFS_LOOKUP_BLOCK_BYTES(A) (SQUASHFS_LOOKUP_BLOCKS(A) *\
	167	sizeof(u64))
	168
	169	/* uid/gid lookup table defines */
	170	#define SQUASHFS_ID_BYTES(A) ((A) * sizeof(unsigned int))
	171
	172	#define SQUASHFS_ID_BLOCK(A) (SQUASHFS_ID_BYTES(A) / \
	173	SQUASHFS_METADATA_SIZE)
	174
	175	#define SQUASHFS_ID_BLOCK_OFFSET(A) (SQUASHFS_ID_BYTES(A) % \
	176	SQUASHFS_METADATA_SIZE)
	177
	178	#define SQUASHFS_ID_BLOCKS(A) ((SQUASHFS_ID_BYTES(A) + \
	179	SQUASHFS_METADATA_SIZE - 1) / \
	180	SQUASHFS_METADATA_SIZE)
	181
	182	#define SQUASHFS_ID_BLOCK_BYTES(A) (SQUASHFS_ID_BLOCKS(A) *\
	183	sizeof(u64))
4b5397dc PL	184	/* xattr id lookup table defines */
	185	#define SQUASHFS_XATTR_BYTES(A) ((A) * sizeof(struct squashfs_xattr_id))
	186
	187	#define SQUASHFS_XATTR_BLOCK(A) (SQUASHFS_XATTR_BYTES(A) / \
	188	SQUASHFS_METADATA_SIZE)
	189
	190	#define SQUASHFS_XATTR_BLOCK_OFFSET(A) (SQUASHFS_XATTR_BYTES(A) % \
	191	SQUASHFS_METADATA_SIZE)
	192
	193	#define SQUASHFS_XATTR_BLOCKS(A) ((SQUASHFS_XATTR_BYTES(A) + \
	194	SQUASHFS_METADATA_SIZE - 1) / \
	195	SQUASHFS_METADATA_SIZE)
	196
	197	#define SQUASHFS_XATTR_BLOCK_BYTES(A) (SQUASHFS_XATTR_BLOCKS(A) *\
	198	sizeof(u64))
	199	#define SQUASHFS_XATTR_BLK(A) ((unsigned int) ((A) >> 16))
	200
	201	#define SQUASHFS_XATTR_OFFSET(A) ((unsigned int) ((A) & 0xffff))
ffae2cd7 PL	202
	203	/* cached data constants for filesystem */
	204	#define SQUASHFS_CACHED_BLKS 8
	205
ffae2cd7 PL	206	/* meta index cache */
	207	#define SQUASHFS_META_INDEXES (SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
	208	#define SQUASHFS_META_ENTRIES 127
	209	#define SQUASHFS_META_SLOTS 8
	210
	211	struct meta_entry {
	212	u64 data_block;
	213	unsigned int index_block;
	214	unsigned short offset;
	215	unsigned short pad;
	216	};
	217
	218	struct meta_index {
	219	unsigned int inode_number;
	220	unsigned int offset;
	221	unsigned short entries;
	222	unsigned short skip;
	223	unsigned short locked;
	224	unsigned short pad;
	225	struct meta_entry meta_entry[SQUASHFS_META_ENTRIES];
	226	};
	227
	228
	229	/*
	230	* definitions for structures on disk
	231	*/
dc325678 PL	232	#define ZLIB_COMPRESSION 1
	233	#define LZMA_COMPRESSION 2
	234	#define LZO_COMPRESSION 3
81bb8deb	235	#define XZ_COMPRESSION 4
9c06a46f	236	#define LZ4_COMPRESSION 5
87bf54bb	237	#define ZSTD_COMPRESSION 6
ffae2cd7 PL	238
	239	struct squashfs_super_block {
	240	__le32 s_magic;
	241	__le32 inodes;
	242	__le32 mkfs_time;
	243	__le32 block_size;
	244	__le32 fragments;
	245	__le16 compression;
	246	__le16 block_log;
	247	__le16 flags;
	248	__le16 no_ids;
	249	__le16 s_major;
	250	__le16 s_minor;
	251	__le64 root_inode;
	252	__le64 bytes_used;
	253	__le64 id_table_start;
4b5397dc	254	__le64 xattr_id_table_start;
ffae2cd7 PL	255	__le64 inode_table_start;
	256	__le64 directory_table_start;
	257	__le64 fragment_table_start;
	258	__le64 lookup_table_start;
	259	};
	260
	261	struct squashfs_dir_index {
	262	__le32 index;
	263	__le32 start_block;
	264	__le32 size;
	265	unsigned char name[0];
	266	};
	267
	268	struct squashfs_base_inode {
	269	__le16 inode_type;
	270	__le16 mode;
	271	__le16 uid;
	272	__le16 guid;
	273	__le32 mtime;
66048c38	274	__le32 inode_number;
ffae2cd7 PL	275	};
	276
	277	struct squashfs_ipc_inode {
	278	__le16 inode_type;
	279	__le16 mode;
	280	__le16 uid;
	281	__le16 guid;
	282	__le32 mtime;
66048c38	283	__le32 inode_number;
ffae2cd7 PL	284	__le32 nlink;
	285	};
	286
67f66cc6 PL	287	struct squashfs_lipc_inode {
	288	__le16 inode_type;
	289	__le16 mode;
	290	__le16 uid;
	291	__le16 guid;
	292	__le32 mtime;
66048c38	293	__le32 inode_number;
67f66cc6 PL	294	__le32 nlink;
	295	__le32 xattr;
	296	};
	297
ffae2cd7 PL	298	struct squashfs_dev_inode {
	299	__le16 inode_type;
	300	__le16 mode;
	301	__le16 uid;
	302	__le16 guid;
	303	__le32 mtime;
66048c38	304	__le32 inode_number;
ffae2cd7 PL	305	__le32 nlink;
	306	__le32 rdev;
	307	};
	308
67f66cc6 PL	309	struct squashfs_ldev_inode {
	310	__le16 inode_type;
	311	__le16 mode;
	312	__le16 uid;
	313	__le16 guid;
	314	__le32 mtime;
66048c38	315	__le32 inode_number;
67f66cc6 PL	316	__le32 nlink;
	317	__le32 rdev;
	318	__le32 xattr;
	319	};
	320
ffae2cd7 PL	321	struct squashfs_symlink_inode {
	322	__le16 inode_type;
	323	__le16 mode;
	324	__le16 uid;
	325	__le16 guid;
	326	__le32 mtime;
66048c38	327	__le32 inode_number;
ffae2cd7 PL	328	__le32 nlink;
	329	__le32 symlink_size;
	330	char symlink[0];
	331	};
	332
	333	struct squashfs_reg_inode {
	334	__le16 inode_type;
	335	__le16 mode;
	336	__le16 uid;
	337	__le16 guid;
	338	__le32 mtime;
66048c38	339	__le32 inode_number;
ffae2cd7 PL	340	__le32 start_block;
	341	__le32 fragment;
	342	__le32 offset;
	343	__le32 file_size;
	344	__le16 block_list[0];
	345	};
	346
	347	struct squashfs_lreg_inode {
	348	__le16 inode_type;
	349	__le16 mode;
	350	__le16 uid;
	351	__le16 guid;
	352	__le32 mtime;
66048c38	353	__le32 inode_number;
ffae2cd7 PL	354	__le64 start_block;
	355	__le64 file_size;
	356	__le64 sparse;
	357	__le32 nlink;
	358	__le32 fragment;
	359	__le32 offset;
	360	__le32 xattr;
	361	__le16 block_list[0];
	362	};
	363
	364	struct squashfs_dir_inode {
	365	__le16 inode_type;
	366	__le16 mode;
	367	__le16 uid;
	368	__le16 guid;
	369	__le32 mtime;
66048c38	370	__le32 inode_number;
ffae2cd7 PL	371	__le32 start_block;
	372	__le32 nlink;
	373	__le16 file_size;
	374	__le16 offset;
	375	__le32 parent_inode;
	376	};
	377
	378	struct squashfs_ldir_inode {
	379	__le16 inode_type;
	380	__le16 mode;
	381	__le16 uid;
	382	__le16 guid;
	383	__le32 mtime;
66048c38	384	__le32 inode_number;
ffae2cd7 PL	385	__le32 nlink;
	386	__le32 file_size;
	387	__le32 start_block;
	388	__le32 parent_inode;
	389	__le16 i_count;
	390	__le16 offset;
	391	__le32 xattr;
	392	struct squashfs_dir_index index[0];
	393	};
	394
	395	union squashfs_inode {
	396	struct squashfs_base_inode base;
	397	struct squashfs_dev_inode dev;
67f66cc6	398	struct squashfs_ldev_inode ldev;
ffae2cd7 PL	399	struct squashfs_symlink_inode symlink;
	400	struct squashfs_reg_inode reg;
	401	struct squashfs_lreg_inode lreg;
	402	struct squashfs_dir_inode dir;
	403	struct squashfs_ldir_inode ldir;
	404	struct squashfs_ipc_inode ipc;
67f66cc6	405	struct squashfs_lipc_inode lipc;
ffae2cd7 PL	406	};
	407
	408	struct squashfs_dir_entry {
	409	__le16 offset;
	410	__le16 inode_number;
	411	__le16 type;
	412	__le16 size;
	413	char name[0];
	414	};
	415
	416	struct squashfs_dir_header {
	417	__le32 count;
	418	__le32 start_block;
	419	__le32 inode_number;
	420	};
	421
	422	struct squashfs_fragment_entry {
	423	__le64 start_block;
	424	__le32 size;
	425	unsigned int unused;
	426	};
	427
f41d207c PL	428	struct squashfs_xattr_entry {
	429	__le16 type;
	430	__le16 size;
	431	char data[0];
	432	};
	433
	434	struct squashfs_xattr_val {
	435	__le32 vsize;
	436	char value[0];
	437	};
	438
4b5397dc PL	439	struct squashfs_xattr_id {
	440	__le64 xattr;
	441	__le32 count;
	442	__le32 size;
	443	};
	444
	445	struct squashfs_xattr_id_table {
	446	__le64 xattr_table_start;
	447	__le32 xattr_ids;
	448	__le32 unused;
	449	};
	450
ffae2cd7	451	#endif