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_METADATA_LOG 13
35 /* default size of data blocks */
36 #define SQUASHFS_FILE_SIZE 131072
37 #define SQUASHFS_FILE_LOG 17
39 /* default size of block device I/O */
40 #ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
41 #define SQUASHFS_DEVBLK_SIZE 4096
43 #define SQUASHFS_DEVBLK_SIZE 1024
46 #define SQUASHFS_FILE_MAX_SIZE 1048576
47 #define SQUASHFS_FILE_MAX_LOG 20
49 /* Max number of uids and gids */
50 #define SQUASHFS_IDS 65536
52 /* Max length of filename (not 255) */
53 #define SQUASHFS_NAME_LEN 256
55 /* Max value for directory header count*/
56 #define SQUASHFS_DIR_COUNT 256
58 #define SQUASHFS_INVALID_FRAG (0xffffffffU)
59 #define SQUASHFS_INVALID_XATTR (0xffffffffU)
60 #define SQUASHFS_INVALID_BLK (-1LL)
62 /* Filesystem flags */
63 #define SQUASHFS_NOI 0
64 #define SQUASHFS_NOD 1
65 #define SQUASHFS_NOF 3
66 #define SQUASHFS_NO_FRAG 4
67 #define SQUASHFS_ALWAYS_FRAG 5
68 #define SQUASHFS_DUPLICATE 6
69 #define SQUASHFS_EXPORT 7
70 #define SQUASHFS_COMP_OPT 10
72 #define SQUASHFS_BIT(flag, bit) ((flag >> bit) & 1)
74 #define SQUASHFS_UNCOMPRESSED_INODES(flags) SQUASHFS_BIT(flags, \
77 #define SQUASHFS_UNCOMPRESSED_DATA(flags) SQUASHFS_BIT(flags, \
80 #define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
83 #define SQUASHFS_NO_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
86 #define SQUASHFS_ALWAYS_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
89 #define SQUASHFS_DUPLICATES(flags) SQUASHFS_BIT(flags, \
92 #define SQUASHFS_EXPORTABLE(flags) SQUASHFS_BIT(flags, \
95 #define SQUASHFS_COMP_OPTS(flags) SQUASHFS_BIT(flags, \
98 /* Max number of types and file types */
99 #define SQUASHFS_DIR_TYPE 1
100 #define SQUASHFS_REG_TYPE 2
101 #define SQUASHFS_SYMLINK_TYPE 3
102 #define SQUASHFS_BLKDEV_TYPE 4
103 #define SQUASHFS_CHRDEV_TYPE 5
104 #define SQUASHFS_FIFO_TYPE 6
105 #define SQUASHFS_SOCKET_TYPE 7
106 #define SQUASHFS_LDIR_TYPE 8
107 #define SQUASHFS_LREG_TYPE 9
108 #define SQUASHFS_LSYMLINK_TYPE 10
109 #define SQUASHFS_LBLKDEV_TYPE 11
110 #define SQUASHFS_LCHRDEV_TYPE 12
111 #define SQUASHFS_LFIFO_TYPE 13
112 #define SQUASHFS_LSOCKET_TYPE 14
115 #define SQUASHFS_XATTR_USER 0
116 #define SQUASHFS_XATTR_TRUSTED 1
117 #define SQUASHFS_XATTR_SECURITY 2
118 #define SQUASHFS_XATTR_VALUE_OOL 256
119 #define SQUASHFS_XATTR_PREFIX_MASK 0xff
121 /* Flag whether block is compressed or uncompressed, bit is set if block is
123 #define SQUASHFS_COMPRESSED_BIT (1 << 15)
125 #define SQUASHFS_COMPRESSED_SIZE(B) (((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
126 (B) & ~SQUASHFS_COMPRESSED_BIT : SQUASHFS_COMPRESSED_BIT)
128 #define SQUASHFS_COMPRESSED(B) (!((B) & SQUASHFS_COMPRESSED_BIT))
130 #define SQUASHFS_COMPRESSED_BIT_BLOCK (1 << 24)
132 #define SQUASHFS_COMPRESSED_SIZE_BLOCK(B) ((B) & \
133 ~SQUASHFS_COMPRESSED_BIT_BLOCK)
135 #define SQUASHFS_COMPRESSED_BLOCK(B) (!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))
138 * Inode number ops. Inodes consist of a compressed block number, and an
139 * uncompressed offset within that block
141 #define SQUASHFS_INODE_BLK(A) ((unsigned int) ((A) >> 16))
143 #define SQUASHFS_INODE_OFFSET(A) ((unsigned int) ((A) & 0xffff))
145 #define SQUASHFS_MKINODE(A, B) ((long long)(((long long) (A)\
148 /* Translate between VFS mode and squashfs mode */
149 #define SQUASHFS_MODE(A) ((A) & 0xfff)
151 /* fragment and fragment table defines */
152 #define SQUASHFS_FRAGMENT_BYTES(A) \
153 ((A) * sizeof(struct squashfs_fragment_entry))
155 #define SQUASHFS_FRAGMENT_INDEX(A) (SQUASHFS_FRAGMENT_BYTES(A) / \
156 SQUASHFS_METADATA_SIZE)
158 #define SQUASHFS_FRAGMENT_INDEX_OFFSET(A) (SQUASHFS_FRAGMENT_BYTES(A) % \
159 SQUASHFS_METADATA_SIZE)
161 #define SQUASHFS_FRAGMENT_INDEXES(A) ((SQUASHFS_FRAGMENT_BYTES(A) + \
162 SQUASHFS_METADATA_SIZE - 1) / \
163 SQUASHFS_METADATA_SIZE)
165 #define SQUASHFS_FRAGMENT_INDEX_BYTES(A) (SQUASHFS_FRAGMENT_INDEXES(A) *\
168 /* inode lookup table defines */
169 #define SQUASHFS_LOOKUP_BYTES(A) ((A) * sizeof(u64))
171 #define SQUASHFS_LOOKUP_BLOCK(A) (SQUASHFS_LOOKUP_BYTES(A) / \
172 SQUASHFS_METADATA_SIZE)
174 #define SQUASHFS_LOOKUP_BLOCK_OFFSET(A) (SQUASHFS_LOOKUP_BYTES(A) % \
175 SQUASHFS_METADATA_SIZE)
177 #define SQUASHFS_LOOKUP_BLOCKS(A) ((SQUASHFS_LOOKUP_BYTES(A) + \
178 SQUASHFS_METADATA_SIZE - 1) / \
179 SQUASHFS_METADATA_SIZE)
181 #define SQUASHFS_LOOKUP_BLOCK_BYTES(A) (SQUASHFS_LOOKUP_BLOCKS(A) *\
184 /* uid/gid lookup table defines */
185 #define SQUASHFS_ID_BYTES(A) ((A) * sizeof(unsigned int))
187 #define SQUASHFS_ID_BLOCK(A) (SQUASHFS_ID_BYTES(A) / \
188 SQUASHFS_METADATA_SIZE)
190 #define SQUASHFS_ID_BLOCK_OFFSET(A) (SQUASHFS_ID_BYTES(A) % \
191 SQUASHFS_METADATA_SIZE)
193 #define SQUASHFS_ID_BLOCKS(A) ((SQUASHFS_ID_BYTES(A) + \
194 SQUASHFS_METADATA_SIZE - 1) / \
195 SQUASHFS_METADATA_SIZE)
197 #define SQUASHFS_ID_BLOCK_BYTES(A) (SQUASHFS_ID_BLOCKS(A) *\
199 /* xattr id lookup table defines */
200 #define SQUASHFS_XATTR_BYTES(A) ((A) * sizeof(struct squashfs_xattr_id))
202 #define SQUASHFS_XATTR_BLOCK(A) (SQUASHFS_XATTR_BYTES(A) / \
203 SQUASHFS_METADATA_SIZE)
205 #define SQUASHFS_XATTR_BLOCK_OFFSET(A) (SQUASHFS_XATTR_BYTES(A) % \
206 SQUASHFS_METADATA_SIZE)
208 #define SQUASHFS_XATTR_BLOCKS(A) ((SQUASHFS_XATTR_BYTES(A) + \
209 SQUASHFS_METADATA_SIZE - 1) / \
210 SQUASHFS_METADATA_SIZE)
212 #define SQUASHFS_XATTR_BLOCK_BYTES(A) (SQUASHFS_XATTR_BLOCKS(A) *\
214 #define SQUASHFS_XATTR_BLK(A) ((unsigned int) ((A) >> 16))
216 #define SQUASHFS_XATTR_OFFSET(A) ((unsigned int) ((A) & 0xffff))
218 /* cached data constants for filesystem */
219 #define SQUASHFS_CACHED_BLKS 8
221 #define SQUASHFS_MAX_FILE_SIZE_LOG 64
223 #define SQUASHFS_MAX_FILE_SIZE (1LL << \
224 (SQUASHFS_MAX_FILE_SIZE_LOG - 2))
226 /* meta index cache */
227 #define SQUASHFS_META_INDEXES (SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
228 #define SQUASHFS_META_ENTRIES 127
229 #define SQUASHFS_META_SLOTS 8
233 unsigned int index_block
;
234 unsigned short offset
;
239 unsigned int inode_number
;
241 unsigned short entries
;
243 unsigned short locked
;
245 struct meta_entry meta_entry
[SQUASHFS_META_ENTRIES
];
250 * definitions for structures on disk
252 #define ZLIB_COMPRESSION 1
253 #define LZMA_COMPRESSION 2
254 #define LZO_COMPRESSION 3
255 #define XZ_COMPRESSION 4
257 struct squashfs_super_block
{
271 __le64 id_table_start
;
272 __le64 xattr_id_table_start
;
273 __le64 inode_table_start
;
274 __le64 directory_table_start
;
275 __le64 fragment_table_start
;
276 __le64 lookup_table_start
;
279 struct squashfs_dir_index
{
283 unsigned char name
[0];
286 struct squashfs_base_inode
{
295 struct squashfs_ipc_inode
{
305 struct squashfs_lipc_inode
{
316 struct squashfs_dev_inode
{
327 struct squashfs_ldev_inode
{
339 struct squashfs_symlink_inode
{
351 struct squashfs_reg_inode
{
362 __le16 block_list
[0];
365 struct squashfs_lreg_inode
{
379 __le16 block_list
[0];
382 struct squashfs_dir_inode
{
396 struct squashfs_ldir_inode
{
410 struct squashfs_dir_index index
[0];
413 union squashfs_inode
{
414 struct squashfs_base_inode base
;
415 struct squashfs_dev_inode dev
;
416 struct squashfs_ldev_inode ldev
;
417 struct squashfs_symlink_inode symlink
;
418 struct squashfs_reg_inode reg
;
419 struct squashfs_lreg_inode lreg
;
420 struct squashfs_dir_inode dir
;
421 struct squashfs_ldir_inode ldir
;
422 struct squashfs_ipc_inode ipc
;
423 struct squashfs_lipc_inode lipc
;
426 struct squashfs_dir_entry
{
434 struct squashfs_dir_header
{
440 struct squashfs_fragment_entry
{
446 struct squashfs_xattr_entry
{
452 struct squashfs_xattr_val
{
457 struct squashfs_xattr_id
{
463 struct squashfs_xattr_id_table
{
464 __le64 xattr_table_start
;