1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Squashfs - a compressed read only filesystem for Linux
5 * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
6 * Phillip Lougher <phillip@squashfs.org.uk>
12 * This file implements code to read the superblock, read and initialise
13 * in-memory structures at mount time, and all the VFS glue code to register
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/blkdev.h>
21 #include <linux/fs_context.h>
22 #include <linux/fs_parser.h>
23 #include <linux/vfs.h>
24 #include <linux/slab.h>
25 #include <linux/mutex.h>
26 #include <linux/seq_file.h>
27 #include <linux/pagemap.h>
28 #include <linux/init.h>
29 #include <linux/module.h>
30 #include <linux/magic.h>
31 #include <linux/xattr.h>
33 #include "squashfs_fs.h"
34 #include "squashfs_fs_sb.h"
35 #include "squashfs_fs_i.h"
37 #include "decompressor.h"
40 static struct file_system_type squashfs_fs_type
;
41 static const struct super_operations squashfs_super_ops
;
53 struct squashfs_mount_opts
{
54 enum Opt_errors errors
;
55 const struct squashfs_decompressor_thread_ops
*thread_ops
;
59 static const struct constant_table squashfs_param_errors
[] = {
60 {"continue", Opt_errors_continue
},
61 {"panic", Opt_errors_panic
},
65 static const struct fs_parameter_spec squashfs_fs_parameters
[] = {
66 fsparam_enum("errors", Opt_errors
, squashfs_param_errors
),
67 fsparam_string("threads", Opt_threads
),
72 static int squashfs_parse_param_threads_str(const char *str
, struct squashfs_mount_opts
*opts
)
74 #ifdef CONFIG_SQUASHFS_CHOICE_DECOMP_BY_MOUNT
75 if (strcmp(str
, "single") == 0) {
76 opts
->thread_ops
= &squashfs_decompressor_single
;
79 if (strcmp(str
, "multi") == 0) {
80 opts
->thread_ops
= &squashfs_decompressor_multi
;
83 if (strcmp(str
, "percpu") == 0) {
84 opts
->thread_ops
= &squashfs_decompressor_percpu
;
91 static int squashfs_parse_param_threads_num(const char *str
, struct squashfs_mount_opts
*opts
)
93 #ifdef CONFIG_SQUASHFS_MOUNT_DECOMP_THREADS
97 ret
= kstrtoul(str
, 0, &num
);
101 opts
->thread_ops
= &squashfs_decompressor_multi
;
102 if (num
> opts
->thread_ops
->max_decompressors())
104 opts
->thread_num
= (int)num
;
107 #ifdef CONFIG_SQUASHFS_DECOMP_SINGLE
109 opts
->thread_ops
= &squashfs_decompressor_single
;
110 opts
->thread_num
= 1;
114 #endif /* !CONFIG_SQUASHFS_MOUNT_DECOMP_THREADS */
118 static int squashfs_parse_param_threads(const char *str
, struct squashfs_mount_opts
*opts
)
120 int ret
= squashfs_parse_param_threads_str(str
, opts
);
124 return squashfs_parse_param_threads_num(str
, opts
);
127 static int squashfs_parse_param(struct fs_context
*fc
, struct fs_parameter
*param
)
129 struct squashfs_mount_opts
*opts
= fc
->fs_private
;
130 struct fs_parse_result result
;
133 opt
= fs_parse(fc
, squashfs_fs_parameters
, param
, &result
);
139 opts
->errors
= result
.uint_32
;
142 if (squashfs_parse_param_threads(param
->string
, opts
) != 0)
152 static const struct squashfs_decompressor
*supported_squashfs_filesystem(
153 struct fs_context
*fc
,
154 short major
, short minor
, short id
)
156 const struct squashfs_decompressor
*decompressor
;
158 if (major
< SQUASHFS_MAJOR
) {
159 errorf(fc
, "Major/Minor mismatch, older Squashfs %d.%d "
160 "filesystems are unsupported", major
, minor
);
162 } else if (major
> SQUASHFS_MAJOR
|| minor
> SQUASHFS_MINOR
) {
163 errorf(fc
, "Major/Minor mismatch, trying to mount newer "
164 "%d.%d filesystem", major
, minor
);
165 errorf(fc
, "Please update your kernel");
169 decompressor
= squashfs_lookup_decompressor(id
);
170 if (!decompressor
->supported
) {
171 errorf(fc
, "Filesystem uses \"%s\" compression. This is not supported",
180 static int squashfs_fill_super(struct super_block
*sb
, struct fs_context
*fc
)
182 struct squashfs_mount_opts
*opts
= fc
->fs_private
;
183 struct squashfs_sb_info
*msblk
;
184 struct squashfs_super_block
*sblk
= NULL
;
186 long long root_inode
;
187 unsigned short flags
;
188 unsigned int fragments
;
189 u64 lookup_table_start
, xattr_id_table_start
, next_table
;
192 TRACE("Entered squashfs_fill_superblock\n");
194 sb
->s_fs_info
= kzalloc(sizeof(*msblk
), GFP_KERNEL
);
195 if (sb
->s_fs_info
== NULL
) {
196 ERROR("Failed to allocate squashfs_sb_info\n");
199 msblk
= sb
->s_fs_info
;
200 msblk
->thread_ops
= opts
->thread_ops
;
202 msblk
->panic_on_errors
= (opts
->errors
== Opt_errors_panic
);
204 msblk
->devblksize
= sb_min_blocksize(sb
, SQUASHFS_DEVBLK_SIZE
);
205 msblk
->devblksize_log2
= ffz(~msblk
->devblksize
);
207 mutex_init(&msblk
->meta_index_mutex
);
210 * msblk->bytes_used is checked in squashfs_read_table to ensure reads
211 * are not beyond filesystem end. But as we're using
212 * squashfs_read_table here to read the superblock (including the value
213 * of bytes_used) we need to set it to an initial sensible dummy value
215 msblk
->bytes_used
= sizeof(*sblk
);
216 sblk
= squashfs_read_table(sb
, SQUASHFS_START
, sizeof(*sblk
));
219 errorf(fc
, "unable to read squashfs_super_block");
227 /* Check it is a SQUASHFS superblock */
228 sb
->s_magic
= le32_to_cpu(sblk
->s_magic
);
229 if (sb
->s_magic
!= SQUASHFS_MAGIC
) {
230 if (!(fc
->sb_flags
& SB_SILENT
))
231 errorf(fc
, "Can't find a SQUASHFS superblock on %pg",
236 if (opts
->thread_num
== 0) {
237 msblk
->max_thread_num
= msblk
->thread_ops
->max_decompressors();
239 msblk
->max_thread_num
= opts
->thread_num
;
242 /* Check the MAJOR & MINOR versions and lookup compression type */
243 msblk
->decompressor
= supported_squashfs_filesystem(
245 le16_to_cpu(sblk
->s_major
),
246 le16_to_cpu(sblk
->s_minor
),
247 le16_to_cpu(sblk
->compression
));
248 if (msblk
->decompressor
== NULL
)
251 /* Check the filesystem does not extend beyond the end of the
253 msblk
->bytes_used
= le64_to_cpu(sblk
->bytes_used
);
254 if (msblk
->bytes_used
< 0 ||
255 msblk
->bytes_used
> bdev_nr_bytes(sb
->s_bdev
))
258 /* Check block size for sanity */
259 msblk
->block_size
= le32_to_cpu(sblk
->block_size
);
260 if (msblk
->block_size
> SQUASHFS_FILE_MAX_SIZE
)
264 * Check the system page size is not larger than the filesystem
265 * block size (by default 128K). This is currently not supported.
267 if (PAGE_SIZE
> msblk
->block_size
) {
268 errorf(fc
, "Page size > filesystem block size (%d). This is "
269 "currently not supported!", msblk
->block_size
);
273 /* Check block log for sanity */
274 msblk
->block_log
= le16_to_cpu(sblk
->block_log
);
275 if (msblk
->block_log
> SQUASHFS_FILE_MAX_LOG
)
278 /* Check that block_size and block_log match */
279 if (msblk
->block_size
!= (1 << msblk
->block_log
))
282 /* Check the root inode for sanity */
283 root_inode
= le64_to_cpu(sblk
->root_inode
);
284 if (SQUASHFS_INODE_OFFSET(root_inode
) > SQUASHFS_METADATA_SIZE
)
287 msblk
->inode_table
= le64_to_cpu(sblk
->inode_table_start
);
288 msblk
->directory_table
= le64_to_cpu(sblk
->directory_table_start
);
289 msblk
->inodes
= le32_to_cpu(sblk
->inodes
);
290 msblk
->fragments
= le32_to_cpu(sblk
->fragments
);
291 msblk
->ids
= le16_to_cpu(sblk
->no_ids
);
292 flags
= le16_to_cpu(sblk
->flags
);
294 TRACE("Found valid superblock on %pg\n", sb
->s_bdev
);
295 TRACE("Inodes are %scompressed\n", SQUASHFS_UNCOMPRESSED_INODES(flags
)
297 TRACE("Data is %scompressed\n", SQUASHFS_UNCOMPRESSED_DATA(flags
)
299 TRACE("Filesystem size %lld bytes\n", msblk
->bytes_used
);
300 TRACE("Block size %d\n", msblk
->block_size
);
301 TRACE("Number of inodes %d\n", msblk
->inodes
);
302 TRACE("Number of fragments %d\n", msblk
->fragments
);
303 TRACE("Number of ids %d\n", msblk
->ids
);
304 TRACE("sblk->inode_table_start %llx\n", msblk
->inode_table
);
305 TRACE("sblk->directory_table_start %llx\n", msblk
->directory_table
);
306 TRACE("sblk->fragment_table_start %llx\n",
307 (u64
) le64_to_cpu(sblk
->fragment_table_start
));
308 TRACE("sblk->id_table_start %llx\n",
309 (u64
) le64_to_cpu(sblk
->id_table_start
));
311 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
313 sb
->s_time_max
= U32_MAX
;
314 sb
->s_flags
|= SB_RDONLY
;
315 sb
->s_op
= &squashfs_super_ops
;
317 msblk
->block_cache
= squashfs_cache_init("metadata",
318 SQUASHFS_CACHED_BLKS
, SQUASHFS_METADATA_SIZE
);
319 if (IS_ERR(msblk
->block_cache
)) {
320 err
= PTR_ERR(msblk
->block_cache
);
324 /* Allocate read_page block */
325 msblk
->read_page
= squashfs_cache_init("data",
326 SQUASHFS_READ_PAGES
, msblk
->block_size
);
327 if (IS_ERR(msblk
->read_page
)) {
328 errorf(fc
, "Failed to allocate read_page block");
329 err
= PTR_ERR(msblk
->read_page
);
333 if (msblk
->devblksize
== PAGE_SIZE
) {
334 struct inode
*cache
= new_inode(sb
);
342 cache
->i_size
= OFFSET_MAX
;
343 mapping_set_gfp_mask(cache
->i_mapping
, GFP_NOFS
);
345 msblk
->cache_mapping
= cache
->i_mapping
;
348 msblk
->stream
= squashfs_decompressor_setup(sb
, flags
);
349 if (IS_ERR(msblk
->stream
)) {
350 err
= PTR_ERR(msblk
->stream
);
351 msblk
->stream
= NULL
;
356 sb
->s_xattr
= squashfs_xattr_handlers
;
357 xattr_id_table_start
= le64_to_cpu(sblk
->xattr_id_table_start
);
358 if (xattr_id_table_start
== SQUASHFS_INVALID_BLK
) {
359 next_table
= msblk
->bytes_used
;
360 goto allocate_id_index_table
;
363 /* Allocate and read xattr id lookup table */
364 msblk
->xattr_id_table
= squashfs_read_xattr_id_table(sb
,
365 xattr_id_table_start
, &msblk
->xattr_table
, &msblk
->xattr_ids
);
366 if (IS_ERR(msblk
->xattr_id_table
)) {
367 errorf(fc
, "unable to read xattr id index table");
368 err
= PTR_ERR(msblk
->xattr_id_table
);
369 msblk
->xattr_id_table
= NULL
;
370 if (err
!= -ENOTSUPP
)
373 next_table
= msblk
->xattr_table
;
375 allocate_id_index_table
:
376 /* Allocate and read id index table */
377 msblk
->id_table
= squashfs_read_id_index_table(sb
,
378 le64_to_cpu(sblk
->id_table_start
), next_table
, msblk
->ids
);
379 if (IS_ERR(msblk
->id_table
)) {
380 errorf(fc
, "unable to read id index table");
381 err
= PTR_ERR(msblk
->id_table
);
382 msblk
->id_table
= NULL
;
385 next_table
= le64_to_cpu(msblk
->id_table
[0]);
387 /* Handle inode lookup table */
388 lookup_table_start
= le64_to_cpu(sblk
->lookup_table_start
);
389 if (lookup_table_start
== SQUASHFS_INVALID_BLK
)
390 goto handle_fragments
;
392 /* Allocate and read inode lookup table */
393 msblk
->inode_lookup_table
= squashfs_read_inode_lookup_table(sb
,
394 lookup_table_start
, next_table
, msblk
->inodes
);
395 if (IS_ERR(msblk
->inode_lookup_table
)) {
396 errorf(fc
, "unable to read inode lookup table");
397 err
= PTR_ERR(msblk
->inode_lookup_table
);
398 msblk
->inode_lookup_table
= NULL
;
401 next_table
= le64_to_cpu(msblk
->inode_lookup_table
[0]);
403 sb
->s_export_op
= &squashfs_export_ops
;
406 fragments
= msblk
->fragments
;
408 goto check_directory_table
;
410 msblk
->fragment_cache
= squashfs_cache_init("fragment",
411 min(SQUASHFS_CACHED_FRAGMENTS
, fragments
), msblk
->block_size
);
412 if (IS_ERR(msblk
->fragment_cache
)) {
413 err
= PTR_ERR(msblk
->fragment_cache
);
417 /* Allocate and read fragment index table */
418 msblk
->fragment_index
= squashfs_read_fragment_index_table(sb
,
419 le64_to_cpu(sblk
->fragment_table_start
), next_table
, fragments
);
420 if (IS_ERR(msblk
->fragment_index
)) {
421 errorf(fc
, "unable to read fragment index table");
422 err
= PTR_ERR(msblk
->fragment_index
);
423 msblk
->fragment_index
= NULL
;
426 next_table
= le64_to_cpu(msblk
->fragment_index
[0]);
428 check_directory_table
:
429 /* Sanity check directory_table */
430 if (msblk
->directory_table
> next_table
) {
435 /* Sanity check inode_table */
436 if (msblk
->inode_table
>= msblk
->directory_table
) {
442 root
= new_inode(sb
);
448 err
= squashfs_read_inode(root
, root_inode
);
450 make_bad_inode(root
);
454 insert_inode_hash(root
);
456 sb
->s_root
= d_make_root(root
);
457 if (sb
->s_root
== NULL
) {
458 ERROR("Root inode create failed\n");
463 TRACE("Leaving squashfs_fill_super\n");
468 errorf(fc
, "squashfs image failed sanity check");
470 squashfs_cache_delete(msblk
->block_cache
);
471 squashfs_cache_delete(msblk
->fragment_cache
);
472 squashfs_cache_delete(msblk
->read_page
);
473 if (msblk
->cache_mapping
)
474 iput(msblk
->cache_mapping
->host
);
475 msblk
->thread_ops
->destroy(msblk
);
476 kfree(msblk
->inode_lookup_table
);
477 kfree(msblk
->fragment_index
);
478 kfree(msblk
->id_table
);
479 kfree(msblk
->xattr_id_table
);
480 kfree(sb
->s_fs_info
);
481 sb
->s_fs_info
= NULL
;
486 static int squashfs_get_tree(struct fs_context
*fc
)
488 return get_tree_bdev(fc
, squashfs_fill_super
);
491 static int squashfs_reconfigure(struct fs_context
*fc
)
493 struct super_block
*sb
= fc
->root
->d_sb
;
494 struct squashfs_sb_info
*msblk
= sb
->s_fs_info
;
495 struct squashfs_mount_opts
*opts
= fc
->fs_private
;
497 sync_filesystem(fc
->root
->d_sb
);
498 fc
->sb_flags
|= SB_RDONLY
;
500 msblk
->panic_on_errors
= (opts
->errors
== Opt_errors_panic
);
505 static void squashfs_free_fs_context(struct fs_context
*fc
)
507 kfree(fc
->fs_private
);
510 static const struct fs_context_operations squashfs_context_ops
= {
511 .get_tree
= squashfs_get_tree
,
512 .free
= squashfs_free_fs_context
,
513 .parse_param
= squashfs_parse_param
,
514 .reconfigure
= squashfs_reconfigure
,
517 static int squashfs_show_options(struct seq_file
*s
, struct dentry
*root
)
519 struct super_block
*sb
= root
->d_sb
;
520 struct squashfs_sb_info
*msblk
= sb
->s_fs_info
;
522 if (msblk
->panic_on_errors
)
523 seq_puts(s
, ",errors=panic");
525 seq_puts(s
, ",errors=continue");
527 #ifdef CONFIG_SQUASHFS_CHOICE_DECOMP_BY_MOUNT
528 if (msblk
->thread_ops
== &squashfs_decompressor_single
) {
529 seq_puts(s
, ",threads=single");
532 if (msblk
->thread_ops
== &squashfs_decompressor_percpu
) {
533 seq_puts(s
, ",threads=percpu");
537 #ifdef CONFIG_SQUASHFS_MOUNT_DECOMP_THREADS
538 seq_printf(s
, ",threads=%d", msblk
->max_thread_num
);
543 static int squashfs_init_fs_context(struct fs_context
*fc
)
545 struct squashfs_mount_opts
*opts
;
547 opts
= kzalloc(sizeof(*opts
), GFP_KERNEL
);
551 #ifdef CONFIG_SQUASHFS_DECOMP_SINGLE
552 opts
->thread_ops
= &squashfs_decompressor_single
;
553 #elif defined(CONFIG_SQUASHFS_DECOMP_MULTI)
554 opts
->thread_ops
= &squashfs_decompressor_multi
;
555 #elif defined(CONFIG_SQUASHFS_DECOMP_MULTI_PERCPU)
556 opts
->thread_ops
= &squashfs_decompressor_percpu
;
558 #error "fail: unknown squashfs decompression thread mode?"
560 opts
->thread_num
= 0;
561 fc
->fs_private
= opts
;
562 fc
->ops
= &squashfs_context_ops
;
566 static int squashfs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
568 struct squashfs_sb_info
*msblk
= dentry
->d_sb
->s_fs_info
;
569 u64 id
= huge_encode_dev(dentry
->d_sb
->s_bdev
->bd_dev
);
571 TRACE("Entered squashfs_statfs\n");
573 buf
->f_type
= SQUASHFS_MAGIC
;
574 buf
->f_bsize
= msblk
->block_size
;
575 buf
->f_blocks
= ((msblk
->bytes_used
- 1) >> msblk
->block_log
) + 1;
576 buf
->f_bfree
= buf
->f_bavail
= 0;
577 buf
->f_files
= msblk
->inodes
;
579 buf
->f_namelen
= SQUASHFS_NAME_LEN
;
580 buf
->f_fsid
= u64_to_fsid(id
);
586 static void squashfs_put_super(struct super_block
*sb
)
589 struct squashfs_sb_info
*sbi
= sb
->s_fs_info
;
590 squashfs_cache_delete(sbi
->block_cache
);
591 squashfs_cache_delete(sbi
->fragment_cache
);
592 squashfs_cache_delete(sbi
->read_page
);
593 if (sbi
->cache_mapping
)
594 iput(sbi
->cache_mapping
->host
);
595 sbi
->thread_ops
->destroy(sbi
);
596 kfree(sbi
->id_table
);
597 kfree(sbi
->fragment_index
);
598 kfree(sbi
->meta_index
);
599 kfree(sbi
->inode_lookup_table
);
600 kfree(sbi
->xattr_id_table
);
601 kfree(sb
->s_fs_info
);
602 sb
->s_fs_info
= NULL
;
606 static struct kmem_cache
*squashfs_inode_cachep
;
609 static void init_once(void *foo
)
611 struct squashfs_inode_info
*ei
= foo
;
613 inode_init_once(&ei
->vfs_inode
);
617 static int __init
init_inodecache(void)
619 squashfs_inode_cachep
= kmem_cache_create("squashfs_inode_cache",
620 sizeof(struct squashfs_inode_info
), 0,
621 SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
|SLAB_ACCOUNT
,
624 return squashfs_inode_cachep
? 0 : -ENOMEM
;
628 static void destroy_inodecache(void)
631 * Make sure all delayed rcu free inodes are flushed before we
635 kmem_cache_destroy(squashfs_inode_cachep
);
639 static int __init
init_squashfs_fs(void)
641 int err
= init_inodecache();
646 err
= register_filesystem(&squashfs_fs_type
);
648 destroy_inodecache();
652 pr_info("version 4.0 (2009/01/31) Phillip Lougher\n");
658 static void __exit
exit_squashfs_fs(void)
660 unregister_filesystem(&squashfs_fs_type
);
661 destroy_inodecache();
665 static struct inode
*squashfs_alloc_inode(struct super_block
*sb
)
667 struct squashfs_inode_info
*ei
=
668 alloc_inode_sb(sb
, squashfs_inode_cachep
, GFP_KERNEL
);
670 return ei
? &ei
->vfs_inode
: NULL
;
674 static void squashfs_free_inode(struct inode
*inode
)
676 kmem_cache_free(squashfs_inode_cachep
, squashfs_i(inode
));
679 static struct file_system_type squashfs_fs_type
= {
680 .owner
= THIS_MODULE
,
682 .init_fs_context
= squashfs_init_fs_context
,
683 .parameters
= squashfs_fs_parameters
,
684 .kill_sb
= kill_block_super
,
685 .fs_flags
= FS_REQUIRES_DEV
| FS_ALLOW_IDMAP
,
687 MODULE_ALIAS_FS("squashfs");
689 static const struct super_operations squashfs_super_ops
= {
690 .alloc_inode
= squashfs_alloc_inode
,
691 .free_inode
= squashfs_free_inode
,
692 .statfs
= squashfs_statfs
,
693 .put_super
= squashfs_put_super
,
694 .show_options
= squashfs_show_options
,
697 module_init(init_squashfs_fs
);
698 module_exit(exit_squashfs_fs
);
699 MODULE_DESCRIPTION("squashfs 4.0, a compressed read-only filesystem");
700 MODULE_AUTHOR("Phillip Lougher <phillip@squashfs.org.uk>");
701 MODULE_LICENSE("GPL");