6 * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
7 * Phillip Lougher <phillip@squashfs.org.uk>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2,
12 * or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 #define SQUASHFS_CACHED_FRAGMENTS CONFIG_SQUASHFS_FRAGMENT_CACHE_SIZE
27 #define SQUASHFS_MAJOR 4
28 #define SQUASHFS_MINOR 0
29 #define SQUASHFS_START 0
31 /* size of metadata (inode and directory) blocks */
32 #define SQUASHFS_METADATA_SIZE 8192
34 /* default size of block device I/O */
35 #ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
36 #define SQUASHFS_DEVBLK_SIZE 4096
38 #define SQUASHFS_DEVBLK_SIZE 1024
41 #define SQUASHFS_FILE_MAX_SIZE 1048576
42 #define SQUASHFS_FILE_MAX_LOG 20
44 /* Max length of filename (not 255) */
45 #define SQUASHFS_NAME_LEN 256
47 /* Max value for directory header count*/
48 #define SQUASHFS_DIR_COUNT 256
50 #define SQUASHFS_INVALID_FRAG (0xffffffffU)
51 #define SQUASHFS_INVALID_XATTR (0xffffffffU)
52 #define SQUASHFS_INVALID_BLK (-1LL)
54 /* Filesystem flags */
55 #define SQUASHFS_NOI 0
56 #define SQUASHFS_NOD 1
57 #define SQUASHFS_NOF 3
58 #define SQUASHFS_NO_FRAG 4
59 #define SQUASHFS_ALWAYS_FRAG 5
60 #define SQUASHFS_DUPLICATE 6
61 #define SQUASHFS_EXPORT 7
62 #define SQUASHFS_COMP_OPT 10
64 #define SQUASHFS_BIT(flag, bit) ((flag >> bit) & 1)
66 #define SQUASHFS_UNCOMPRESSED_INODES(flags) SQUASHFS_BIT(flags, \
69 #define SQUASHFS_UNCOMPRESSED_DATA(flags) SQUASHFS_BIT(flags, \
72 #define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
75 #define SQUASHFS_NO_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
78 #define SQUASHFS_ALWAYS_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
81 #define SQUASHFS_DUPLICATES(flags) SQUASHFS_BIT(flags, \
84 #define SQUASHFS_EXPORTABLE(flags) SQUASHFS_BIT(flags, \
87 #define SQUASHFS_COMP_OPTS(flags) SQUASHFS_BIT(flags, \
90 /* Inode types including extended types */
91 #define SQUASHFS_DIR_TYPE 1
92 #define SQUASHFS_REG_TYPE 2
93 #define SQUASHFS_SYMLINK_TYPE 3
94 #define SQUASHFS_BLKDEV_TYPE 4
95 #define SQUASHFS_CHRDEV_TYPE 5
96 #define SQUASHFS_FIFO_TYPE 6
97 #define SQUASHFS_SOCKET_TYPE 7
98 #define SQUASHFS_LDIR_TYPE 8
99 #define SQUASHFS_LREG_TYPE 9
100 #define SQUASHFS_LSYMLINK_TYPE 10
101 #define SQUASHFS_LBLKDEV_TYPE 11
102 #define SQUASHFS_LCHRDEV_TYPE 12
103 #define SQUASHFS_LFIFO_TYPE 13
104 #define SQUASHFS_LSOCKET_TYPE 14
106 /* Max type value stored in directory entry */
107 #define SQUASHFS_MAX_DIR_TYPE 7
110 #define SQUASHFS_XATTR_USER 0
111 #define SQUASHFS_XATTR_TRUSTED 1
112 #define SQUASHFS_XATTR_SECURITY 2
113 #define SQUASHFS_XATTR_VALUE_OOL 256
114 #define SQUASHFS_XATTR_PREFIX_MASK 0xff
116 /* Flag whether block is compressed or uncompressed, bit is set if block is
118 #define SQUASHFS_COMPRESSED_BIT (1 << 15)
120 #define SQUASHFS_COMPRESSED_SIZE(B) (((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
121 (B) & ~SQUASHFS_COMPRESSED_BIT : SQUASHFS_COMPRESSED_BIT)
123 #define SQUASHFS_COMPRESSED(B) (!((B) & SQUASHFS_COMPRESSED_BIT))
125 #define SQUASHFS_COMPRESSED_BIT_BLOCK (1 << 24)
127 #define SQUASHFS_COMPRESSED_SIZE_BLOCK(B) ((B) & \
128 ~SQUASHFS_COMPRESSED_BIT_BLOCK)
130 #define SQUASHFS_COMPRESSED_BLOCK(B) (!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))
133 * Inode number ops. Inodes consist of a compressed block number, and an
134 * uncompressed offset within that block
136 #define SQUASHFS_INODE_BLK(A) ((unsigned int) ((A) >> 16))
138 #define SQUASHFS_INODE_OFFSET(A) ((unsigned int) ((A) & 0xffff))
140 #define SQUASHFS_MKINODE(A, B) ((long long)(((long long) (A)\
143 /* fragment and fragment table defines */
144 #define SQUASHFS_FRAGMENT_BYTES(A) \
145 ((A) * sizeof(struct squashfs_fragment_entry))
147 #define SQUASHFS_FRAGMENT_INDEX(A) (SQUASHFS_FRAGMENT_BYTES(A) / \
148 SQUASHFS_METADATA_SIZE)
150 #define SQUASHFS_FRAGMENT_INDEX_OFFSET(A) (SQUASHFS_FRAGMENT_BYTES(A) % \
151 SQUASHFS_METADATA_SIZE)
153 #define SQUASHFS_FRAGMENT_INDEXES(A) ((SQUASHFS_FRAGMENT_BYTES(A) + \
154 SQUASHFS_METADATA_SIZE - 1) / \
155 SQUASHFS_METADATA_SIZE)
157 #define SQUASHFS_FRAGMENT_INDEX_BYTES(A) (SQUASHFS_FRAGMENT_INDEXES(A) *\
160 /* inode lookup table defines */
161 #define SQUASHFS_LOOKUP_BYTES(A) ((A) * sizeof(u64))
163 #define SQUASHFS_LOOKUP_BLOCK(A) (SQUASHFS_LOOKUP_BYTES(A) / \
164 SQUASHFS_METADATA_SIZE)
166 #define SQUASHFS_LOOKUP_BLOCK_OFFSET(A) (SQUASHFS_LOOKUP_BYTES(A) % \
167 SQUASHFS_METADATA_SIZE)
169 #define SQUASHFS_LOOKUP_BLOCKS(A) ((SQUASHFS_LOOKUP_BYTES(A) + \
170 SQUASHFS_METADATA_SIZE - 1) / \
171 SQUASHFS_METADATA_SIZE)
173 #define SQUASHFS_LOOKUP_BLOCK_BYTES(A) (SQUASHFS_LOOKUP_BLOCKS(A) *\
176 /* uid/gid lookup table defines */
177 #define SQUASHFS_ID_BYTES(A) ((A) * sizeof(unsigned int))
179 #define SQUASHFS_ID_BLOCK(A) (SQUASHFS_ID_BYTES(A) / \
180 SQUASHFS_METADATA_SIZE)
182 #define SQUASHFS_ID_BLOCK_OFFSET(A) (SQUASHFS_ID_BYTES(A) % \
183 SQUASHFS_METADATA_SIZE)
185 #define SQUASHFS_ID_BLOCKS(A) ((SQUASHFS_ID_BYTES(A) + \
186 SQUASHFS_METADATA_SIZE - 1) / \
187 SQUASHFS_METADATA_SIZE)
189 #define SQUASHFS_ID_BLOCK_BYTES(A) (SQUASHFS_ID_BLOCKS(A) *\
191 /* xattr id lookup table defines */
192 #define SQUASHFS_XATTR_BYTES(A) ((A) * sizeof(struct squashfs_xattr_id))
194 #define SQUASHFS_XATTR_BLOCK(A) (SQUASHFS_XATTR_BYTES(A) / \
195 SQUASHFS_METADATA_SIZE)
197 #define SQUASHFS_XATTR_BLOCK_OFFSET(A) (SQUASHFS_XATTR_BYTES(A) % \
198 SQUASHFS_METADATA_SIZE)
200 #define SQUASHFS_XATTR_BLOCKS(A) ((SQUASHFS_XATTR_BYTES(A) + \
201 SQUASHFS_METADATA_SIZE - 1) / \
202 SQUASHFS_METADATA_SIZE)
204 #define SQUASHFS_XATTR_BLOCK_BYTES(A) (SQUASHFS_XATTR_BLOCKS(A) *\
206 #define SQUASHFS_XATTR_BLK(A) ((unsigned int) ((A) >> 16))
208 #define SQUASHFS_XATTR_OFFSET(A) ((unsigned int) ((A) & 0xffff))
210 /* cached data constants for filesystem */
211 #define SQUASHFS_CACHED_BLKS 8
213 /* meta index cache */
214 #define SQUASHFS_META_INDEXES (SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
215 #define SQUASHFS_META_ENTRIES 127
216 #define SQUASHFS_META_SLOTS 8
220 unsigned int index_block
;
221 unsigned short offset
;
226 unsigned int inode_number
;
228 unsigned short entries
;
230 unsigned short locked
;
232 struct meta_entry meta_entry
[SQUASHFS_META_ENTRIES
];
237 * definitions for structures on disk
239 #define ZLIB_COMPRESSION 1
240 #define LZMA_COMPRESSION 2
241 #define LZO_COMPRESSION 3
242 #define XZ_COMPRESSION 4
243 #define LZ4_COMPRESSION 5
244 #define ZSTD_COMPRESSION 6
246 struct squashfs_super_block
{
260 __le64 id_table_start
;
261 __le64 xattr_id_table_start
;
262 __le64 inode_table_start
;
263 __le64 directory_table_start
;
264 __le64 fragment_table_start
;
265 __le64 lookup_table_start
;
268 struct squashfs_dir_index
{
272 unsigned char name
[0];
275 struct squashfs_base_inode
{
284 struct squashfs_ipc_inode
{
294 struct squashfs_lipc_inode
{
305 struct squashfs_dev_inode
{
316 struct squashfs_ldev_inode
{
328 struct squashfs_symlink_inode
{
340 struct squashfs_reg_inode
{
351 __le16 block_list
[0];
354 struct squashfs_lreg_inode
{
368 __le16 block_list
[0];
371 struct squashfs_dir_inode
{
385 struct squashfs_ldir_inode
{
399 struct squashfs_dir_index index
[0];
402 union squashfs_inode
{
403 struct squashfs_base_inode base
;
404 struct squashfs_dev_inode dev
;
405 struct squashfs_ldev_inode ldev
;
406 struct squashfs_symlink_inode symlink
;
407 struct squashfs_reg_inode reg
;
408 struct squashfs_lreg_inode lreg
;
409 struct squashfs_dir_inode dir
;
410 struct squashfs_ldir_inode ldir
;
411 struct squashfs_ipc_inode ipc
;
412 struct squashfs_lipc_inode lipc
;
415 struct squashfs_dir_entry
{
423 struct squashfs_dir_header
{
429 struct squashfs_fragment_entry
{
435 struct squashfs_xattr_entry
{
441 struct squashfs_xattr_val
{
446 struct squashfs_xattr_id
{
452 struct squashfs_xattr_id_table
{
453 __le64 xattr_table_start
;