xref: /openbmc/linux/fs/squashfs/zstd_wrapper.c (revision 3e0a4e85)
13e0a4e85SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
287bf54bbSSean Purcell /*
387bf54bbSSean Purcell  * Squashfs - a compressed read only filesystem for Linux
487bf54bbSSean Purcell  *
587bf54bbSSean Purcell  * Copyright (c) 2016-present, Facebook, Inc.
687bf54bbSSean Purcell  * All rights reserved.
787bf54bbSSean Purcell  *
887bf54bbSSean Purcell  * zstd_wrapper.c
987bf54bbSSean Purcell  */
1087bf54bbSSean Purcell 
1187bf54bbSSean Purcell #include <linux/mutex.h>
1287bf54bbSSean Purcell #include <linux/buffer_head.h>
1387bf54bbSSean Purcell #include <linux/slab.h>
1487bf54bbSSean Purcell #include <linux/zstd.h>
1587bf54bbSSean Purcell #include <linux/vmalloc.h>
1687bf54bbSSean Purcell 
1787bf54bbSSean Purcell #include "squashfs_fs.h"
1887bf54bbSSean Purcell #include "squashfs_fs_sb.h"
1987bf54bbSSean Purcell #include "squashfs.h"
2087bf54bbSSean Purcell #include "decompressor.h"
2187bf54bbSSean Purcell #include "page_actor.h"
2287bf54bbSSean Purcell 
2387bf54bbSSean Purcell struct workspace {
2487bf54bbSSean Purcell 	void *mem;
2587bf54bbSSean Purcell 	size_t mem_size;
2687bf54bbSSean Purcell 	size_t window_size;
2787bf54bbSSean Purcell };
2887bf54bbSSean Purcell 
2987bf54bbSSean Purcell static void *zstd_init(struct squashfs_sb_info *msblk, void *buff)
3087bf54bbSSean Purcell {
3187bf54bbSSean Purcell 	struct workspace *wksp = kmalloc(sizeof(*wksp), GFP_KERNEL);
3287bf54bbSSean Purcell 
3387bf54bbSSean Purcell 	if (wksp == NULL)
3487bf54bbSSean Purcell 		goto failed;
3587bf54bbSSean Purcell 	wksp->window_size = max_t(size_t,
3687bf54bbSSean Purcell 			msblk->block_size, SQUASHFS_METADATA_SIZE);
3787bf54bbSSean Purcell 	wksp->mem_size = ZSTD_DStreamWorkspaceBound(wksp->window_size);
3887bf54bbSSean Purcell 	wksp->mem = vmalloc(wksp->mem_size);
3987bf54bbSSean Purcell 	if (wksp->mem == NULL)
4087bf54bbSSean Purcell 		goto failed;
4187bf54bbSSean Purcell 
4287bf54bbSSean Purcell 	return wksp;
4387bf54bbSSean Purcell 
4487bf54bbSSean Purcell failed:
4587bf54bbSSean Purcell 	ERROR("Failed to allocate zstd workspace\n");
4687bf54bbSSean Purcell 	kfree(wksp);
4787bf54bbSSean Purcell 	return ERR_PTR(-ENOMEM);
4887bf54bbSSean Purcell }
4987bf54bbSSean Purcell 
5087bf54bbSSean Purcell 
5187bf54bbSSean Purcell static void zstd_free(void *strm)
5287bf54bbSSean Purcell {
5387bf54bbSSean Purcell 	struct workspace *wksp = strm;
5487bf54bbSSean Purcell 
5587bf54bbSSean Purcell 	if (wksp)
5687bf54bbSSean Purcell 		vfree(wksp->mem);
5787bf54bbSSean Purcell 	kfree(wksp);
5887bf54bbSSean Purcell }
5987bf54bbSSean Purcell 
6087bf54bbSSean Purcell 
6187bf54bbSSean Purcell static int zstd_uncompress(struct squashfs_sb_info *msblk, void *strm,
6287bf54bbSSean Purcell 	struct buffer_head **bh, int b, int offset, int length,
6387bf54bbSSean Purcell 	struct squashfs_page_actor *output)
6487bf54bbSSean Purcell {
6587bf54bbSSean Purcell 	struct workspace *wksp = strm;
6687bf54bbSSean Purcell 	ZSTD_DStream *stream;
6787bf54bbSSean Purcell 	size_t total_out = 0;
6887bf54bbSSean Purcell 	size_t zstd_err;
6987bf54bbSSean Purcell 	int k = 0;
7087bf54bbSSean Purcell 	ZSTD_inBuffer in_buf = { NULL, 0, 0 };
7187bf54bbSSean Purcell 	ZSTD_outBuffer out_buf = { NULL, 0, 0 };
7287bf54bbSSean Purcell 
7387bf54bbSSean Purcell 	stream = ZSTD_initDStream(wksp->window_size, wksp->mem, wksp->mem_size);
7487bf54bbSSean Purcell 
7587bf54bbSSean Purcell 	if (!stream) {
7687bf54bbSSean Purcell 		ERROR("Failed to initialize zstd decompressor\n");
7787bf54bbSSean Purcell 		goto out;
7887bf54bbSSean Purcell 	}
7987bf54bbSSean Purcell 
8087bf54bbSSean Purcell 	out_buf.size = PAGE_SIZE;
8187bf54bbSSean Purcell 	out_buf.dst = squashfs_first_page(output);
8287bf54bbSSean Purcell 
8387bf54bbSSean Purcell 	do {
8487bf54bbSSean Purcell 		if (in_buf.pos == in_buf.size && k < b) {
8587bf54bbSSean Purcell 			int avail = min(length, msblk->devblksize - offset);
8687bf54bbSSean Purcell 
8787bf54bbSSean Purcell 			length -= avail;
8887bf54bbSSean Purcell 			in_buf.src = bh[k]->b_data + offset;
8987bf54bbSSean Purcell 			in_buf.size = avail;
9087bf54bbSSean Purcell 			in_buf.pos = 0;
9187bf54bbSSean Purcell 			offset = 0;
9287bf54bbSSean Purcell 		}
9387bf54bbSSean Purcell 
9487bf54bbSSean Purcell 		if (out_buf.pos == out_buf.size) {
9587bf54bbSSean Purcell 			out_buf.dst = squashfs_next_page(output);
9687bf54bbSSean Purcell 			if (out_buf.dst == NULL) {
9787bf54bbSSean Purcell 				/* Shouldn't run out of pages
9887bf54bbSSean Purcell 				 * before stream is done.
9987bf54bbSSean Purcell 				 */
10087bf54bbSSean Purcell 				squashfs_finish_page(output);
10187bf54bbSSean Purcell 				goto out;
10287bf54bbSSean Purcell 			}
10387bf54bbSSean Purcell 			out_buf.pos = 0;
10487bf54bbSSean Purcell 			out_buf.size = PAGE_SIZE;
10587bf54bbSSean Purcell 		}
10687bf54bbSSean Purcell 
10787bf54bbSSean Purcell 		total_out -= out_buf.pos;
10887bf54bbSSean Purcell 		zstd_err = ZSTD_decompressStream(stream, &out_buf, &in_buf);
10987bf54bbSSean Purcell 		total_out += out_buf.pos; /* add the additional data produced */
11087bf54bbSSean Purcell 
11187bf54bbSSean Purcell 		if (in_buf.pos == in_buf.size && k < b)
11287bf54bbSSean Purcell 			put_bh(bh[k++]);
11387bf54bbSSean Purcell 	} while (zstd_err != 0 && !ZSTD_isError(zstd_err));
11487bf54bbSSean Purcell 
11587bf54bbSSean Purcell 	squashfs_finish_page(output);
11687bf54bbSSean Purcell 
11787bf54bbSSean Purcell 	if (ZSTD_isError(zstd_err)) {
11887bf54bbSSean Purcell 		ERROR("zstd decompression error: %d\n",
11987bf54bbSSean Purcell 				(int)ZSTD_getErrorCode(zstd_err));
12087bf54bbSSean Purcell 		goto out;
12187bf54bbSSean Purcell 	}
12287bf54bbSSean Purcell 
12387bf54bbSSean Purcell 	if (k < b)
12487bf54bbSSean Purcell 		goto out;
12587bf54bbSSean Purcell 
12687bf54bbSSean Purcell 	return (int)total_out;
12787bf54bbSSean Purcell 
12887bf54bbSSean Purcell out:
12987bf54bbSSean Purcell 	for (; k < b; k++)
13087bf54bbSSean Purcell 		put_bh(bh[k]);
13187bf54bbSSean Purcell 
13287bf54bbSSean Purcell 	return -EIO;
13387bf54bbSSean Purcell }
13487bf54bbSSean Purcell 
13587bf54bbSSean Purcell const struct squashfs_decompressor squashfs_zstd_comp_ops = {
13687bf54bbSSean Purcell 	.init = zstd_init,
13787bf54bbSSean Purcell 	.free = zstd_free,
13887bf54bbSSean Purcell 	.decompress = zstd_uncompress,
13987bf54bbSSean Purcell 	.id = ZSTD_COMPRESSION,
14087bf54bbSSean Purcell 	.name = "zstd",
14187bf54bbSSean Purcell 	.supported = 1
14287bf54bbSSean Purcell };
143