Skip to contentSkip to conversation

Add support for the SquashFS filesystem

PATCH Superseded Joao Marcos Costa 1 participant 6 messages Jul 20, 2020

Subsystems (2)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover Add support for the SquashFS filesystem

Hello!

This series adds support for the SquashFS filesystem. For now, zlib is the only supported compression type. This is my first contribution to U-Boot as well as to a major Open Source project.

Changes in v2:
- Replace sqfs_ls() by U-Boot's fs_ls_generic()
- Add info. to MAINTAINERS
- Fix build failures
- Fix style problems

Best regards,
Joao Marcos Costa

Joao Marcos Costa (5):
fs/squashfs: new filesystem
fs/squashfs: add filesystem commands include/u-boot, lib/zlib: add sources for zlib decompression fs/squashfs: add support for zlib decompression fs/fs.c: add symbolic link case to fs_ls_generic()

 MAINTAINERS                     |    7 +
 cmd/Kconfig                     |    6 +
 cmd/Makefile                    |    1 +
 cmd/sqfs.c                      |   42 +
 common/spl/Kconfig              |    9 +
 fs/Kconfig                      |    2 +
 fs/Makefile                     |    2 +
 fs/fs.c                         |   18 +
 fs/squashfs/Kconfig             |   10 +
 fs/squashfs/Makefile            |    7 +
 fs/squashfs/sqfs.c              | 1521 +++++++++++++++++++++++++++++++
 fs/squashfs/sqfs_decompressor.c |   53 ++
 fs/squashfs/sqfs_decompressor.h |   58 ++
 fs/squashfs/sqfs_dir.c          |  107 +++
 fs/squashfs/sqfs_filesystem.h   |  300 ++++++
 fs/squashfs/sqfs_inode.c        |  142 +++
 fs/squashfs/sqfs_utils.h        |   49 +
 include/fs.h                    |    1 +
 include/squashfs.h              |   25 +
 include/u-boot/zlib.h           |   32 +
 lib/zlib/uncompr.c              |   97 ++
 lib/zlib/zlib.c                 |    1 +
 22 files changed, 2490 insertions(+)
 create mode 100644 cmd/sqfs.c
 create mode 100644 fs/squashfs/Kconfig
 create mode 100644 fs/squashfs/Makefile
 create mode 100644 fs/squashfs/sqfs.c
 create mode 100644 fs/squashfs/sqfs_decompressor.c
 create mode 100644 fs/squashfs/sqfs_decompressor.h
 create mode 100644 fs/squashfs/sqfs_dir.c
 create mode 100644 fs/squashfs/sqfs_filesystem.h
 create mode 100644 fs/squashfs/sqfs_inode.c
 create mode 100644 fs/squashfs/sqfs_utils.h
 create mode 100644 include/squashfs.h
 create mode 100644 lib/zlib/uncompr.c
Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/5 fs/squashfs: new filesystem

Add support for SquashFS filesystem. Right now, it does not support compression but support for zlib will be added in a follow-up commit.

---
Changes in v2:
- Add info. to MAINTAINERS
- Replace sqfs_ls() by U-Boot's fs_ls_generic()
- Improve string parsing when resolving symlink targets
- Replace cmd_tbl_t type by the cmd_tbl struct
- Add missing <command.h> in cmd/sqfs.c
- Fix build failures
- Replace "struct disk_partition_t" by "disk_partition"
- Remove CMD_RET* from the filesystem code
- Simplify superblock handling by adding "struct squashfs_ctxt", which encloses the complete global context (superblock, cur_dev and cur_part_info). The struct members are set up during probe() and cleaned up during close().

 MAINTAINERS                     |    6 +
 common/spl/Kconfig              |    9 +
 fs/Kconfig                      |    2 +
 fs/Makefile                     |    2 +
 fs/fs.c                         |   15 +
 fs/squashfs/Kconfig             |   10 +
 fs/squashfs/Makefile            |    7 +
 fs/squashfs/sqfs.c              | 1521 +++++++++++++++++++++++++++++++
 fs/squashfs/sqfs_decompressor.c |   29 +
 fs/squashfs/sqfs_decompressor.h |   58 ++
 fs/squashfs/sqfs_dir.c          |  107 +++
 fs/squashfs/sqfs_filesystem.h   |  300 ++++++
 fs/squashfs/sqfs_inode.c        |  142 +++
 fs/squashfs/sqfs_utils.h        |   49 +
 include/fs.h                    |    1 +
 include/squashfs.h              |   25 +
 16 files changed, 2283 insertions(+)
 create mode 100644 fs/squashfs/Kconfig
 create mode 100644 fs/squashfs/Makefile
 create mode 100644 fs/squashfs/sqfs.c
 create mode 100644 fs/squashfs/sqfs_decompressor.c
 create mode 100644 fs/squashfs/sqfs_decompressor.h
 create mode 100644 fs/squashfs/sqfs_dir.c
 create mode 100644 fs/squashfs/sqfs_filesystem.h
 create mode 100644 fs/squashfs/sqfs_inode.c
 create mode 100644 fs/squashfs/sqfs_utils.h
 create mode 100644 include/squashfs.h
MAINTAINERS +6 -0
index 6316c6ca00..198fe2b89e 100644
@@ -944,6 +944,12 @@ S:	Maintained
 F:	drivers/spmi/
 F:	include/spmi/
 
+SQUASHFS
+M:	Joao Marcos Costa <[email protected]>
+S:	Maintained
+F:	fs/squashfs/
+F:	include/sqfs.h
+
 TDA19988 HDMI ENCODER
 M:	Liviu Dudau <[email protected]>
 S:	Maintained
common/spl/Kconfig +9 -0
index d09e52e88b..d7a32ca40f 100644
@@ -577,6 +577,15 @@ config SPL_FS_EXT4
 	  filesystem from within SPL. Support for the underlying block
 	  device (e.g. MMC or USB) must be enabled separately.
 
+config SPL_FS_SQUASHFS
+	bool "Support SquashFS filesystems"
+	select FS_SQUASHFS
+	help
+	  Enable support for SquashFS filesystems with SPL. This permits
+	  U-Boot (or Linux in Falcon mode) to be loaded from a SquashFS
+	  filesystem from within SPL. Support for the underlying block
+	  device (e.g. MMC or USB) must be enabled separately.
+
 config SPL_FS_FAT
 	bool "Support FAT filesystems"
 	select FS_FAT
fs/Kconfig +2 -0
index 1cb9831be8..620af7f044 100644
@@ -22,4 +22,6 @@ source "fs/cramfs/Kconfig"
 
 source "fs/yaffs2/Kconfig"
 
+source "fs/squashfs/Kconfig"
+
 endmenu
fs/Makefile +2 -0
index 42e669c40c..937cbcf6e8 100644
@@ -9,6 +9,7 @@ obj-$(CONFIG_FS_LOADER) += fs.o
 obj-$(CONFIG_SPL_FS_FAT) += fat/
 obj-$(CONFIG_SPL_FS_EXT4) += ext4/
 obj-$(CONFIG_SPL_FS_CBFS) += cbfs/
+obj-$(CONFIG_SPL_FS_SQUASHFS) += squashfs/
 else
 obj-y				+= fs.o
 
@@ -23,5 +24,6 @@ obj-$(CONFIG_SANDBOX) += sandbox/
 obj-$(CONFIG_CMD_UBIFS) += ubifs/
 obj-$(CONFIG_YAFFS2) += yaffs2/
 obj-$(CONFIG_CMD_ZFS) += zfs/
+obj-$(CONFIG_FS_SQUASHFS) += squashfs/
 endif
 obj-y += fs_internal.o
fs/fs.c +15 -0
index edd8adc21b..6d776c676a 100644
@@ -22,6 +22,7 @@
 #include <div64.h>
 #include <linux/math64.h>
 #include <efi_loader.h>
+#include <squashfs.h>
 
 DECLARE_GLOBAL_DATA_PTR;
 
@@ -276,6 +277,20 @@ static struct fstype_info fstypes[] = {
 		.mkdir = fs_mkdir_unsupported,
 		.ln = fs_ln_unsupported,
 	},
+#endif
+#if CONFIG_IS_ENABLED(CONFIG_FS_SQUASHFS)
+	{
+		.fstype = FS_TYPE_SQUASHFS,
+		.name = "squashfs",
+		.probe = sqfs_probe,
+		.opendir = sqfs_opendir,
+		.readdir = sqfs_readdir,
+		.ls = fs_ls_generic,
+		.read = sqfs_read,
+		.size = sqfs_size,
+		.close = sqfs_close,
+		.closedir = sqfs_closedir,
+	},
 #endif
 	{
 		.fstype = FS_TYPE_ANY,
fs/squashfs/Kconfig new file +10 -0
new file mode 100644
index 0000000000..b9772e5619
@@ -0,0 +1,10 @@
+config FS_SQUASHFS
+	bool "Enable SquashFS filesystem support"
+	help
+	  This provides support for reading images from SquashFS filesystem.
+	  Squashfs is a compressed read-only filesystem for Linux.
+	  It uses zlib, lz4, lzo, or xz compression to compress files, inodes
+	  and directories. Squashfs is intended for general read-only
+	  filesystem use, for archival use (i.e. in cases where a .tar.gz file
+	  may be used), and in constrained block device/memory systems (e.g.
+	  embedded systems) where low overhead is needed.
fs/squashfs/Makefile new file +7 -0
new file mode 100644
index 0000000000..ba66ee821c
@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: GPL-2.0+
+#
+
+obj-$(CONFIG_$(SPL_)FS_SQUASHFS) = sqfs.o \
+				sqfs_inode.o \
+				sqfs_dir.o \
+				sqfs_decompressor.o
fs/squashfs/sqfs.c new file +1521 -0

1,521 lines not on this page · raw message

fs/squashfs/sqfs_decompressor.c new file +29 -0
new file mode 100644
index 0000000000..a899a5704b
@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (C) 2020 Bootlin
+ *
+ * Author: Joao Marcos Costa <[email protected]>
+ */
+
+#include <errno.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "sqfs_decompressor.h"
+#include "sqfs_filesystem.h"
+#include "sqfs_utils.h"
+
+int sqfs_decompress(u16 comp_type, void *dest, unsigned long *dest_len,
+		    void *source, u32 lenp)
+{
+	int ret = 0;
+
+	switch (comp_type) {
+	default:
+		printf("Error: unknown compression type.\n");
+		return -EINVAL;
+	}
+
+	return ret;
+}
fs/squashfs/sqfs_decompressor.h new file +58 -0

58 lines not on this page · raw message

fs/squashfs/sqfs_dir.c new file +107 -0

107 lines not on this page · raw message

fs/squashfs/sqfs_filesystem.h new file +300 -0

300 lines not on this page · raw message

fs/squashfs/sqfs_inode.c new file +142 -0

142 lines not on this page · raw message

fs/squashfs/sqfs_utils.h new file +49 -0

49 lines not on this page · raw message

include/fs.h +1 -0
index b08b1f40c5..0794b50d10 100644
@@ -15,6 +15,7 @@ struct cmd_tbl;
 #define FS_TYPE_SANDBOX	3
 #define FS_TYPE_UBIFS	4
 #define FS_TYPE_BTRFS	5
+#define FS_TYPE_SQUASHFS 6
 
 struct blk_desc;
 
include/squashfs.h new file +25 -0
new file mode 100644
index 0000000000..819cf8c2da
@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Copyright (C) 2020 Bootlin
+ *
+ * Author: Joao Marcos Costa <[email protected]>
+ *
+ * squashfs.h: SquashFS filesystem implementation.
+ */
+
+#ifndef _SQFS_H_
+#define _SQFS_H_
+
+struct disk_partition;
+
+int sqfs_opendir(const char *filename, struct fs_dir_stream **dirsp);
+int sqfs_readdir(struct fs_dir_stream *dirs, struct fs_dirent **dentp);
+int sqfs_probe(struct blk_desc *fs_dev_desc,
+	       struct disk_partition *fs_partition);
+int sqfs_read(const char *filename, void *buf, loff_t offset,
+	      loff_t len, loff_t *actread);
+int sqfs_size(const char *filename, loff_t *size);
+void sqfs_close(void);
+void sqfs_closedir(struct fs_dir_stream *dirs);
+
+#endif /* SQFS_H  */
Signature · 1 line
2.17.1
#2 lore raw

PATCH v2 2/5 fs/squashfs: add filesystem commands

In reply to Joao Marcos Costa

Add 'ls' and 'load' commands.

---
Changes in v2:
- Add info. to MAINTAINERS
- Add 'static' keyword to do_sqfs_*(). These functions' prototypes are no longer needed in include/fs.h.
- Change commit message.

 MAINTAINERS  |  1 +
 cmd/Kconfig  |  6 ++++++
 cmd/Makefile |  1 +
 cmd/sqfs.c   | 42 ++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 50 insertions(+)
 create mode 100644 cmd/sqfs.c
MAINTAINERS +1 -0
index 198fe2b89e..9a5f330148 100644
@@ -949,6 +949,7 @@ M:	Joao Marcos Costa <[email protected]>
 S:	Maintained
 F:	fs/squashfs/
 F:	include/sqfs.h
+F:	cmd/sqfs.c
 
 TDA19988 HDMI ENCODER
 M:	Liviu Dudau <[email protected]>
cmd/Kconfig +6 -0
index bfe6c163dc..c8f3d34b88 100644
@@ -2059,6 +2059,12 @@ config CMD_FAT
 	help
 	  Support for the FAT fs
 
+config CMD_SQUASHFS
+	bool "SquashFS command support"
+	select FS_SQUASHFS
+	help
+	  Enables SquashFS filesystem commands (e.g. load, ls).
+
 config CMD_FS_GENERIC
 	bool "filesystem commands"
 	help
cmd/Makefile +1 -0
index 7952138dc2..ef2da1c928 100644
@@ -62,6 +62,7 @@ obj-$(CONFIG_CMD_EXT4) += ext4.o
 obj-$(CONFIG_CMD_EXT2) += ext2.o
 obj-$(CONFIG_CMD_FAT) += fat.o
 obj-$(CONFIG_CMD_FDT) += fdt.o
+obj-$(CONFIG_CMD_SQUASHFS) += sqfs.o
 obj-$(CONFIG_CMD_FLASH) += flash.o
 obj-$(CONFIG_CMD_FPGA) += fpga.o
 obj-$(CONFIG_CMD_FPGAD) += fpgad.o
cmd/sqfs.c new file +42 -0

42 lines not on this page · raw message

Signature · 1 line
2.17.1
#3 lore raw

PATCH v2 3/5 include/u-boot, lib/zlib: add sources for zlib decompression

In reply to Joao Marcos Costa

Add zlib (v1.2.11) uncompr() function to U-Boot. SquashFS depends on this function to decompress data from a raw disk image. The actual support for zlib into SquashFS sources will be added in a follow-up commit.

---
Changes in v2:

	- Changed commit title and message, which were wrong and/or misleading
	in v1.
 include/u-boot/zlib.h | 32 ++++++++++++++
 lib/zlib/uncompr.c    | 97 +++++++++++++++++++++++++++++++++++++++++++
 lib/zlib/zlib.c       |  1 +
 3 files changed, 130 insertions(+)
 create mode 100644 lib/zlib/uncompr.c
include/u-boot/zlib.h +32 -0
index e23ceb50ca..a33cc8780d 100644
@@ -110,6 +110,12 @@ extern "C" {
 #  define voidp                 z_voidp
 #endif
 
+#if defined(ZLIB_CONST) && !defined(z_const)
+#  define z_const const
+#else
+#  define z_const
+#endif
+
 #if defined(__MSDOS__) && !defined(MSDOS)
 #  define MSDOS
 #endif
@@ -710,6 +716,32 @@ ZEXTERN  uInt ZEXPORT crc32  OF((uInt crc, const Bytef *buf, uInt len));
      if (crc != original_crc) error();
 */
 
+ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,
+				   const Bytef *source, uLong sourceLen));
+/*
+     Decompresses the source buffer into the destination buffer.  sourceLen is
+   the byte length of the source buffer.  Upon entry, destLen is the total size
+   of the destination buffer, which must be large enough to hold the entire
+   uncompressed data.  (The size of the uncompressed data must have been saved
+   previously by the compressor and transmitted to the decompressor by some
+   mechanism outside the scope of this compression library.) Upon exit, destLen
+   is the actual size of the uncompressed data.
+
+     uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
+   enough memory, Z_BUF_ERROR if there was not enough room in the output
+   buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete.  In
+   the case where there is not enough room, uncompress() will fill the output
+   buffer with the uncompressed data up to that point.
+*/
+
+ZEXTERN int ZEXPORT uncompress2 OF((Bytef *dest, uLongf *destLen,
+				    const Bytef *source, uLong *sourceLen));
+/*
+     Same as uncompress, except that sourceLen is a pointer, where the
+   length of the source is *sourceLen.  On return, *sourceLen is the number of
+   source bytes consumed.
+*/
+
 ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int  windowBits,
                                       const char *version, int stream_size));
 #define inflateInit(strm) \
lib/zlib/uncompr.c new file +97 -0

97 lines not on this page · raw message

lib/zlib/zlib.c +1 -0
index 7e1570292c..05a2734086 100644
@@ -30,3 +30,4 @@
 #include "inflate.c"
 #include "zutil.c"
 #include "adler32.c"
+#include "uncompr.c"
Signature · 1 line
2.17.1
#4 lore raw

PATCH v2 4/5 fs/squashfs: add support for zlib decompression

In reply to Joao Marcos Costa

Add call to zlib's 'uncompress' function. Add function to display the right error message depending on the decompression's return value.

---
Changes in v2:

	- Changed commit title and message, which were wrong and/or misleading
	in v1.
 fs/squashfs/sqfs_decompressor.c | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
fs/squashfs/sqfs_decompressor.c +24 -0
index a899a5704b..a8c37f73b7 100644
@@ -9,17 +9,41 @@
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <u-boot/zlib.h>
 
 #include "sqfs_decompressor.h"
 #include "sqfs_filesystem.h"
 #include "sqfs_utils.h"
 
+static void zlib_decompression_status(int ret)
+{
+	switch (ret) {
+	case Z_BUF_ERROR:
+		printf("Error: 'dest' buffer is not large enough.\n");
+		break;
+	case Z_DATA_ERROR:
+		printf("Error: corrupted compressed data.\n");
+		break;
+	case Z_MEM_ERROR:
+		printf("Error: insufficient memory.\n");
+		break;
+	}
+}
+
 int sqfs_decompress(u16 comp_type, void *dest, unsigned long *dest_len,
 		    void *source, u32 lenp)
 {
 	int ret = 0;
 
 	switch (comp_type) {
+	case SQFS_COMP_ZLIB:
+		ret = uncompress(dest, dest_len, source, lenp);
+		if (ret) {
+			zlib_decompression_status(ret);
+			return -EINVAL;
+		}
+
+		break;
 	default:
 		printf("Error: unknown compression type.\n");
 		return -EINVAL;
Signature · 1 line
2.17.1
#5 lore raw

PATCH v2 5/5 fs/fs.c: add symbolic link case to fs_ls_generic()

In reply to Joao Marcos Costa

Adds an 'else if' statement inside the loop to check for symbolic links.

---
Changes in v2:

	- Changed commit title and message, which were wrong and/or misleading
	in v1.
 fs/fs.c | 3 +++
 1 file changed, 3 insertions(+)
fs/fs.c +3 -0
index 6d776c676a..e06f87db99 100644
@@ -59,6 +59,9 @@ static int fs_ls_generic(const char *dirname)
 		if (dent->type == FS_DT_DIR) {
 			printf("            %s/\n", dent->name);
 			ndirs++;
+		} else if (dent->type == FS_DT_LNK) {
+			printf("    <SYM>   %s\n", dent->name);
+			nfiles++;
 		} else {
 			printf(" %8lld   %s\n", dent->size, dent->name);
 			nfiles++;
Signature · 1 line
2.17.1