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