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
33 #define SQUASHFS_BLOCK_OFFSET 2
35 /* default size of block device I/O */
36 #ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
37 #define SQUASHFS_DEVBLK_SIZE 4096
39 #define SQUASHFS_DEVBLK_SIZE 1024
42 #define SQUASHFS_FILE_MAX_SIZE 1048576
43 #define SQUASHFS_FILE_MAX_LOG 20
45 /* Max length of filename (not 255) */
46 #define SQUASHFS_NAME_LEN 256
48 /* Max value for directory header count*/
49 #define SQUASHFS_DIR_COUNT 256
51 #define SQUASHFS_INVALID_FRAG (0xffffffffU)
52 #define SQUASHFS_INVALID_XATTR (0xffffffffU)
53 #define SQUASHFS_INVALID_BLK (-1LL)
55 /* Filesystem flags */
56 #define SQUASHFS_NOI 0
57 #define SQUASHFS_NOD 1
58 #define SQUASHFS_NOF 3
59 #define SQUASHFS_NO_FRAG 4
60 #define SQUASHFS_ALWAYS_FRAG 5
61 #define SQUASHFS_DUPLICATE 6
62 #define SQUASHFS_EXPORT 7
63 #define SQUASHFS_COMP_OPT 10
65 #define SQUASHFS_BIT(flag, bit) ((flag >> bit) & 1)
67 #define SQUASHFS_UNCOMPRESSED_INODES(flags) SQUASHFS_BIT(flags, \
70 #define SQUASHFS_UNCOMPRESSED_DATA(flags) SQUASHFS_BIT(flags, \
73 #define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
76 #define SQUASHFS_NO_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
79 #define SQUASHFS_ALWAYS_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
82 #define SQUASHFS_DUPLICATES(flags) SQUASHFS_BIT(flags, \
85 #define SQUASHFS_EXPORTABLE(flags) SQUASHFS_BIT(flags, \
88 #define SQUASHFS_COMP_OPTS(flags) SQUASHFS_BIT(flags, \
91 /* Inode types including extended types */
92 #define SQUASHFS_DIR_TYPE 1
93 #define SQUASHFS_REG_TYPE 2
94 #define SQUASHFS_SYMLINK_TYPE 3
95 #define SQUASHFS_BLKDEV_TYPE 4
96 #define SQUASHFS_CHRDEV_TYPE 5
97 #define SQUASHFS_FIFO_TYPE 6
98 #define SQUASHFS_SOCKET_TYPE 7
99 #define SQUASHFS_LDIR_TYPE 8
100 #define SQUASHFS_LREG_TYPE 9
101 #define SQUASHFS_LSYMLINK_TYPE 10
102 #define SQUASHFS_LBLKDEV_TYPE 11
103 #define SQUASHFS_LCHRDEV_TYPE 12
104 #define SQUASHFS_LFIFO_TYPE 13
105 #define SQUASHFS_LSOCKET_TYPE 14
107 /* Max type value stored in directory entry */
108 #define SQUASHFS_MAX_DIR_TYPE 7
111 #define SQUASHFS_XATTR_USER 0
112 #define SQUASHFS_XATTR_TRUSTED 1
113 #define SQUASHFS_XATTR_SECURITY 2
114 #define SQUASHFS_XATTR_VALUE_OOL 256
115 #define SQUASHFS_XATTR_PREFIX_MASK 0xff
117 /* Flag whether block is compressed or uncompressed, bit is set if block is
119 #define SQUASHFS_COMPRESSED_BIT (1 << 15)
121 #define SQUASHFS_COMPRESSED_SIZE(B) (((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
122 (B) & ~SQUASHFS_COMPRESSED_BIT : SQUASHFS_COMPRESSED_BIT)
124 #define SQUASHFS_COMPRESSED(B) (!((B) & SQUASHFS_COMPRESSED_BIT))
126 #define SQUASHFS_COMPRESSED_BIT_BLOCK (1 << 24)
128 #define SQUASHFS_COMPRESSED_SIZE_BLOCK(B) ((B) & \
129 ~SQUASHFS_COMPRESSED_BIT_BLOCK)
131 #define SQUASHFS_COMPRESSED_BLOCK(B) (!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))
133 static inline int squashfs_block_size(__le32 raw)
135 u32 size = le32_to_cpu(raw);
136 return (size >> 25) ? -EIO : size;
140 * Inode number ops. Inodes consist of a compressed block number, and an
141 * uncompressed offset within that block
143 #define SQUASHFS_INODE_BLK(A) ((unsigned int) ((A) >> 16))
145 #define SQUASHFS_INODE_OFFSET(A) ((unsigned int) ((A) & 0xffff))
147 #define SQUASHFS_MKINODE(A, B) ((long long)(((long long) (A)\
150 /* fragment and fragment table defines */
151 #define SQUASHFS_FRAGMENT_BYTES(A) \
152 ((A) * sizeof(struct squashfs_fragment_entry))
154 #define SQUASHFS_FRAGMENT_INDEX(A) (SQUASHFS_FRAGMENT_BYTES(A) / \
155 SQUASHFS_METADATA_SIZE)
157 #define SQUASHFS_FRAGMENT_INDEX_OFFSET(A) (SQUASHFS_FRAGMENT_BYTES(A) % \
158 SQUASHFS_METADATA_SIZE)
160 #define SQUASHFS_FRAGMENT_INDEXES(A) ((SQUASHFS_FRAGMENT_BYTES(A) + \
161 SQUASHFS_METADATA_SIZE - 1) / \
162 SQUASHFS_METADATA_SIZE)
164 #define SQUASHFS_FRAGMENT_INDEX_BYTES(A) (SQUASHFS_FRAGMENT_INDEXES(A) *\
167 /* inode lookup table defines */
168 #define SQUASHFS_LOOKUP_BYTES(A) ((A) * sizeof(u64))
170 #define SQUASHFS_LOOKUP_BLOCK(A) (SQUASHFS_LOOKUP_BYTES(A) / \
171 SQUASHFS_METADATA_SIZE)
173 #define SQUASHFS_LOOKUP_BLOCK_OFFSET(A) (SQUASHFS_LOOKUP_BYTES(A) % \
174 SQUASHFS_METADATA_SIZE)
176 #define SQUASHFS_LOOKUP_BLOCKS(A) ((SQUASHFS_LOOKUP_BYTES(A) + \
177 SQUASHFS_METADATA_SIZE - 1) / \
178 SQUASHFS_METADATA_SIZE)
180 #define SQUASHFS_LOOKUP_BLOCK_BYTES(A) (SQUASHFS_LOOKUP_BLOCKS(A) *\
183 /* uid/gid lookup table defines */
184 #define SQUASHFS_ID_BYTES(A) ((A) * sizeof(unsigned int))
186 #define SQUASHFS_ID_BLOCK(A) (SQUASHFS_ID_BYTES(A) / \
187 SQUASHFS_METADATA_SIZE)
189 #define SQUASHFS_ID_BLOCK_OFFSET(A) (SQUASHFS_ID_BYTES(A) % \
190 SQUASHFS_METADATA_SIZE)
192 #define SQUASHFS_ID_BLOCKS(A) ((SQUASHFS_ID_BYTES(A) + \
193 SQUASHFS_METADATA_SIZE - 1) / \
194 SQUASHFS_METADATA_SIZE)
196 #define SQUASHFS_ID_BLOCK_BYTES(A) (SQUASHFS_ID_BLOCKS(A) *\
198 /* xattr id lookup table defines */
199 #define SQUASHFS_XATTR_BYTES(A) ((A) * sizeof(struct squashfs_xattr_id))
201 #define SQUASHFS_XATTR_BLOCK(A) (SQUASHFS_XATTR_BYTES(A) / \
202 SQUASHFS_METADATA_SIZE)
204 #define SQUASHFS_XATTR_BLOCK_OFFSET(A) (SQUASHFS_XATTR_BYTES(A) % \
205 SQUASHFS_METADATA_SIZE)
207 #define SQUASHFS_XATTR_BLOCKS(A) ((SQUASHFS_XATTR_BYTES(A) + \
208 SQUASHFS_METADATA_SIZE - 1) / \
209 SQUASHFS_METADATA_SIZE)
211 #define SQUASHFS_XATTR_BLOCK_BYTES(A) (SQUASHFS_XATTR_BLOCKS(A) *\
213 #define SQUASHFS_XATTR_BLK(A) ((unsigned int) ((A) >> 16))
215 #define SQUASHFS_XATTR_OFFSET(A) ((unsigned int) ((A) & 0xffff))
217 /* cached data constants for filesystem */
218 #define SQUASHFS_CACHED_BLKS 8
220 /* meta index cache */
221 #define SQUASHFS_META_INDEXES (SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
222 #define SQUASHFS_META_ENTRIES 127
223 #define SQUASHFS_META_SLOTS 8
227 unsigned int index_block;
228 unsigned short offset;
233 unsigned int inode_number;
235 unsigned short entries;
237 unsigned short locked;
239 struct meta_entry meta_entry[SQUASHFS_META_ENTRIES];
244 * definitions for structures on disk
246 #define ZLIB_COMPRESSION 1
247 #define LZMA_COMPRESSION 2
248 #define LZO_COMPRESSION 3
249 #define XZ_COMPRESSION 4
250 #define LZ4_COMPRESSION 5
251 #define ZSTD_COMPRESSION 6
253 struct squashfs_super_block {
267 __le64 id_table_start;
268 __le64 xattr_id_table_start;
269 __le64 inode_table_start;
270 __le64 directory_table_start;
271 __le64 fragment_table_start;
272 __le64 lookup_table_start;
275 struct squashfs_dir_index {
279 unsigned char name[0];
282 struct squashfs_base_inode {
291 struct squashfs_ipc_inode {
301 struct squashfs_lipc_inode {
312 struct squashfs_dev_inode {
323 struct squashfs_ldev_inode {
335 struct squashfs_symlink_inode {
347 struct squashfs_reg_inode {
358 __le16 block_list[0];
361 struct squashfs_lreg_inode {
375 __le16 block_list[0];
378 struct squashfs_dir_inode {
392 struct squashfs_ldir_inode {
406 struct squashfs_dir_index index[0];
409 union squashfs_inode {
410 struct squashfs_base_inode base;
411 struct squashfs_dev_inode dev;
412 struct squashfs_ldev_inode ldev;
413 struct squashfs_symlink_inode symlink;
414 struct squashfs_reg_inode reg;
415 struct squashfs_lreg_inode lreg;
416 struct squashfs_dir_inode dir;
417 struct squashfs_ldir_inode ldir;
418 struct squashfs_ipc_inode ipc;
419 struct squashfs_lipc_inode lipc;
422 struct squashfs_dir_entry {
430 struct squashfs_dir_header {
436 struct squashfs_fragment_entry {
442 struct squashfs_xattr_entry {
448 struct squashfs_xattr_val {
453 struct squashfs_xattr_id {
459 struct squashfs_xattr_id_table {
460 __le64 xattr_table_start;