Paths

Table of Contentst

Differential D50841

fs/squashfs: Add the squashfs file system
Needs ReviewPublic
Actions

Authored by chuck on Jun 14 2025, 12:43 PM.

Tags

None

Referenced Files

	Unknown Object (File)
	Mon, Nov 3, 4:42 PM

	Unknown Object (File)
	Mon, Nov 3, 2:27 PM

	Unknown Object (File)
	Sun, Nov 2, 9:36 AM

	Unknown Object (File)
	Sat, Nov 1, 1:19 AM

	Unknown Object (File)
	Fri, Oct 31, 10:04 PM

	Unknown Object (File)
	Fri, Oct 31, 2:46 PM

	Unknown Object (File)
	Tue, Oct 28, 5:13 AM

	Unknown Object (File)
	Tue, Oct 21, 6:32 AM

View All 53 Files

Subscribers

Details

Reviewers

Group Reviewers

Summary

Add a kernel file system driver for SquashFS. This was done as a part
of a Google Summer of Code project.

Relnotes: yes
Sponsored by: Google LLC (GSoC 2023)
Co-authored-by: Kyle Evans <kevans@FreeBSD.org>

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 64888
Build 61771: arc lint + arc unit

Event Timeline

chuck created this revision.Jun 14 2025, 12:43 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptJun 14 2025, 12:43 PM

chuck requested review of this revision.Jun 14 2025, 12:43 PM

Harbormaster completed remote builds in B64862: Diff 157017.Jun 14 2025, 12:43 PM

kevans added a reviewer: manpages.Jun 14 2025, 1:51 PM

ziaee added inline comments.Jun 14 2025, 3:44 PM

share/man/man4/squashfs.4
2–27
29
35–46	See vt, iwx, and some others. Would we need to load this in early boot instead of rc.conf? This has no kernel tunable options or sysctls?
51	Since this is a freebsd driver, freebsd is redundant here. Roff needs one sentence per line. Can it just mount and access them? Is creating possible?
55–60	+ .Pa lets people use `apropos Pa=sqfs` + putting the root prompt breaks copy paste and is implied for mount, you typically only want to use them for a complex multi line example where only some parts should be ran as root.
75	No blank lines in Roff

chuck marked 6 inline comments as done.Jun 14 2025, 5:28 PM

chuck added inline comments.

share/man/man4/squashfs.4
29	Du-oh!!
35–46	I could imagine both needing this driver at early boot as well as later in `rc.conf` And correct, no tunables or system controls at the moment.
51	Does this work better: The squashfs driver provides support for mounting and accessing SquashFS compressed file system images. SquashFS is a compressed read-only file system designed for general read-only file system use in constrained block device/memory systems. Use a program like mksquashfs or gensquashfs to create a suitable image. Should the man page annotate `mksquashfs` and `gensquashfs` in any particular manner?

ziaee added inline comments.Jun 14 2025, 9:32 PM

share/man/man4/squashfs.4
51	Yes, I really like that! I have no preference on order, but please use `.Sy utility` Or if possible `.Xr utility 8`.

Address doc feedback

Harbormaster completed remote builds in B64888: Diff 157064.Jun 15 2025, 1:34 PM

imp added inline comments.Jun 15 2025, 3:32 PM

share/man/man4/squashfs.4
40	Are either of the generators ports?

Oh, and I /think/ you need a man4/Makefile addition

share/man/man4/squashfs.4
33

chuck added inline comments.Jun 16 2025, 4:09 PM

share/man/man4/squashfs.4
40	Yes, both are in ports. It didn't sound like there was a standardized way to link to those, but perhaps I misunderstood.

Usually what doc does is

.Xr thing 1
.Pq Pa ports/category/thing

But ports doesn't like that because iiuc the category can change, but I think the utility of this notation is high enough that I'd rather just change it when it changes.

Revision Contents
Changeset List

Path

Size

include/

2 lines

share/

man/

man4/

63 lines

sys/

conf/

7 lines

4 lines

fs/

squashfs/

358 lines

squashfs_block.h

80 lines

squashfs_block.c

239 lines

squashfs_decompressor.h

44 lines

squashfs_decompressor.c

189 lines

61 lines

266 lines

squashfs_file.h

56 lines

squashfs_file.c

361 lines

squashfs_init.c

222 lines

squashfs_inode.h

107 lines

squashfs_inode.c

677 lines

38 lines

163 lines

squashfs_mount.h

73 lines

squashfs_vfsops.c

407 lines

squashfs_vnops.c

813 lines

squashfs_xattr.h

81 lines

squashfs_xattr.c

369 lines

modules/

1 line

squashfs/

33 lines

Diff 157064

include/Makefile

Loading...

share/man/man4/squashfs.4

Loading...

sys/conf/files

Loading...

sys/conf/options

Loading...

sys/fs/squashfs/squashfs.h

Loading...

sys/fs/squashfs/squashfs_block.h

Loading...

sys/fs/squashfs/squashfs_block.c

Loading...

sys/fs/squashfs/squashfs_decompressor.h

Loading...

sys/fs/squashfs/squashfs_decompressor.c

Loading...

sys/fs/squashfs/squashfs_dir.h

Loading...

sys/fs/squashfs/squashfs_dir.c

Loading...

sys/fs/squashfs/squashfs_file.h

Loading...

sys/fs/squashfs/squashfs_file.c

Loading...

sys/fs/squashfs/squashfs_init.c

Loading...

sys/fs/squashfs/squashfs_inode.h

Loading...

sys/fs/squashfs/squashfs_inode.c

Loading...

sys/fs/squashfs/squashfs_io.h

Loading...

sys/fs/squashfs/squashfs_io.c

Loading...

sys/fs/squashfs/squashfs_mount.h

Loading...

sys/fs/squashfs/squashfs_vfsops.c

Loading...

sys/fs/squashfs/squashfs_vnops.c

Loading...

sys/fs/squashfs/squashfs_xattr.h

Loading...

sys/fs/squashfs/squashfs_xattr.c

Loading...

sys/modules/Makefile

Loading...

sys/modules/squashfs/Makefile

Loading...